291 lines
12 KiB
OCaml
291 lines
12 KiB
OCaml
(***********************************************************************)
|
|
(* OCamldoc *)
|
|
(* *)
|
|
(* Maxence Guesdon, projet Cristal, INRIA Rocquencourt *)
|
|
(* *)
|
|
(* Copyright 2001 Institut National de Recherche en Informatique et *)
|
|
(* en Automatique. All rights reserved. This file is distributed *)
|
|
(* under the terms of the Q Public License version 1.0. *)
|
|
(* *)
|
|
(***********************************************************************)
|
|
|
|
|
|
(** Command-line arguments. *)
|
|
open Clflags
|
|
|
|
let include_dirs = Clflags.include_dirs
|
|
|
|
class type doc_generator =
|
|
object
|
|
method generate : Odoc_module.t_module list -> unit
|
|
end
|
|
|
|
let doc_generator = ref (None : doc_generator option)
|
|
|
|
let merge_options = ref ([] : Odoc_types.merge_option list)
|
|
|
|
let iso_type_options = ref ([] : Odoc_types.iso_check list)
|
|
let iso_val_options = ref ([] : Odoc_types.iso_check list)
|
|
let iso_exception_options = ref ([] : Odoc_types.iso_check list)
|
|
let iso_class_options = ref ([] : Odoc_types.iso_check list)
|
|
let iso_module_options = ref ([] : Odoc_types.iso_check list)
|
|
|
|
let dot_file = ref Odoc_messages.default_dot_file
|
|
|
|
let dot_include_all = ref false
|
|
|
|
let dot_types = ref false
|
|
|
|
let dot_reduce = ref false
|
|
|
|
let dot_colors = ref Odoc_messages.default_dot_colors
|
|
|
|
(** Analysis of a string defining options. Return the list of
|
|
options according to the list giving associations between
|
|
[(character, _)] and a list of options. *)
|
|
let analyse_option_string l s =
|
|
List.fold_left
|
|
(fun acc -> fun ((c,_), v) ->
|
|
if String.contains s c then
|
|
acc @ v
|
|
else
|
|
acc)
|
|
[]
|
|
l
|
|
|
|
(** Analysis of a string defining the merge options to be used.
|
|
Returns the list of options specified.*)
|
|
let analyse_merge_options s =
|
|
let l = [
|
|
(Odoc_messages.merge_description, [Odoc_types.Merge_description]) ;
|
|
(Odoc_messages.merge_author, [Odoc_types.Merge_author]) ;
|
|
(Odoc_messages.merge_version, [Odoc_types.Merge_version]) ;
|
|
(Odoc_messages.merge_see, [Odoc_types.Merge_see]) ;
|
|
(Odoc_messages.merge_since, [Odoc_types.Merge_since]) ;
|
|
(Odoc_messages.merge_deprecated, [Odoc_types.Merge_deprecated]) ;
|
|
(Odoc_messages.merge_param, [Odoc_types.Merge_param]) ;
|
|
(Odoc_messages.merge_raised_exception, [Odoc_types.Merge_raised_exception]) ;
|
|
(Odoc_messages.merge_return_value, [Odoc_types.Merge_return_value]) ;
|
|
(Odoc_messages.merge_custom, [Odoc_types.Merge_custom]) ;
|
|
(Odoc_messages.merge_all, Odoc_types.all_merge_options)
|
|
]
|
|
in
|
|
analyse_option_string l s
|
|
|
|
(** Analysis of a string defining the iso checks to perform.
|
|
Return the list of checks specified.*)
|
|
let analyse_iso_checks s =
|
|
let l = [
|
|
(Odoc_messages.iso_description, [Odoc_types.Has_description]) ;
|
|
(Odoc_messages.iso_author, [Odoc_types.Has_author]) ;
|
|
(Odoc_messages.iso_since, [Odoc_types.Has_since]) ;
|
|
(Odoc_messages.iso_version, [Odoc_types.Has_version]) ;
|
|
(Odoc_messages.iso_return, [Odoc_types.Has_return]) ;
|
|
(Odoc_messages.iso_params, [Odoc_types.Has_params]) ;
|
|
(Odoc_messages.iso_fields_described, [Odoc_types.Has_fields_decribed]) ;
|
|
(Odoc_messages.iso_constructors_described, [Odoc_types.Has_constructors_decribed]) ;
|
|
(Odoc_messages.iso_all, Odoc_types.all_iso_checks)
|
|
]
|
|
in
|
|
analyse_option_string l s
|
|
|
|
|
|
let classic = Clflags.classic
|
|
|
|
let dump = ref (None : string option)
|
|
|
|
let load = ref ([] : string list)
|
|
|
|
(** Allow arbitrary recursive types. *)
|
|
let recursive_types = Clflags.recursive_types
|
|
|
|
let verbose = ref false
|
|
|
|
(** Optional preprocessor command. *)
|
|
let preprocessor = Clflags.preprocessor
|
|
|
|
let sort_modules = ref false
|
|
|
|
let no_custom_tags = ref false
|
|
|
|
let no_stop = ref false
|
|
|
|
let remove_stars = ref false
|
|
|
|
let keep_code = ref false
|
|
|
|
let inverse_merge_ml_mli = ref false
|
|
|
|
let title = ref (None : string option)
|
|
|
|
let with_parameter_list = ref false
|
|
|
|
let hidden_modules = ref ([] : string list)
|
|
|
|
let target_dir = ref Filename.current_dir_name
|
|
|
|
let css_style = ref None
|
|
|
|
let index_only = ref false
|
|
|
|
let colorize_code = ref false
|
|
|
|
let with_header = ref true
|
|
|
|
let with_trailer = ref true
|
|
|
|
let separate_files = ref false
|
|
|
|
let latex_titles = ref [
|
|
1, "section" ;
|
|
2, "subsection" ;
|
|
3, "subsubsection" ;
|
|
4, "paragraph" ;
|
|
5, "subparagraph" ;
|
|
]
|
|
|
|
let with_toc = ref true
|
|
|
|
let with_index = ref true
|
|
|
|
let esc_8bits = ref false
|
|
|
|
let files = ref []
|
|
|
|
let f_latex_title s =
|
|
try
|
|
let pos = String.index s ',' in
|
|
let n = int_of_string (String.sub s 0 pos) in
|
|
let len = String.length s in
|
|
let command = String.sub s (pos + 1) (len - pos - 1) in
|
|
latex_titles := List.remove_assoc n !latex_titles ;
|
|
latex_titles := (n, command) :: !latex_titles
|
|
with
|
|
Not_found
|
|
| Invalid_argument _ ->
|
|
incr Odoc_global.errors ;
|
|
prerr_endline (Odoc_messages.wrong_format s)
|
|
|
|
let add_hidden_modules s =
|
|
let l = Str.split (Str.regexp ",") s in
|
|
List.iter
|
|
(fun n ->
|
|
let name = Str.global_replace (Str.regexp "[ \n\r\t]+") "" n in
|
|
match name with
|
|
"" -> ()
|
|
| _ ->
|
|
match name.[0] with
|
|
'A'..'Z' -> hidden_modules := name :: !hidden_modules
|
|
| _ ->
|
|
incr Odoc_global.errors;
|
|
prerr_endline (Odoc_messages.not_a_module_name name)
|
|
)
|
|
l
|
|
|
|
let set_doc_generator (dg_opt : doc_generator option) = doc_generator := dg_opt
|
|
|
|
(** The default html generator. Initialized in the parse function, to be used during the command line analysis.*)
|
|
let default_html_generator = ref (None : doc_generator option)
|
|
|
|
(** The default latex generator. Initialized in the parse function, to be used during the command line analysis.*)
|
|
let default_latex_generator = ref (None : doc_generator option)
|
|
|
|
(** The default texinfo generator. Initialized in the parse function, to be used during the command line analysis.*)
|
|
let default_texi_generator = ref (None : doc_generator option)
|
|
|
|
(** The default man pages generator. Initialized in the parse function, to be used during the command line analysis.*)
|
|
let default_man_generator = ref (None : doc_generator option)
|
|
|
|
(** The default iso check generator. Initialized in the parse function, to be used during the command line analysis.*)
|
|
let default_iso_generator = ref (None : doc_generator option)
|
|
|
|
(** The default dot generator. Initialized in the parse function, to be used during the command line analysis.*)
|
|
let default_dot_generator = ref (None : doc_generator option)
|
|
|
|
(** The default option list *)
|
|
let options = ref [
|
|
"-version", Arg.Unit (fun () -> print_string Odoc_messages.message_version ; print_newline () ; exit 0) , Odoc_messages.option_version ;
|
|
"-v", Arg.Unit (fun () -> verbose := true), Odoc_messages.verbose_mode ;
|
|
"-I", Arg.String (fun s -> include_dirs := (Misc.expand_directory Config.standard_library s) :: !include_dirs), Odoc_messages.include_dirs ;
|
|
"-pp", Arg.String (fun s -> preprocessor := Some s), Odoc_messages.preprocess ;
|
|
"-rectypes", Arg.Set recursive_types, Odoc_messages.rectypes ;
|
|
"-nolabels", Arg.Unit (fun () -> classic := true), Odoc_messages.nolabels ;
|
|
"-warn-error", Arg.Set Odoc_global.warn_error, Odoc_messages.werr ;
|
|
"-d", Arg.String (fun s -> target_dir := s), Odoc_messages.target_dir ;
|
|
"-sort", Arg.Unit (fun () -> sort_modules := true), Odoc_messages.sort_modules ;
|
|
"-no-stop", Arg.Set no_stop, Odoc_messages.no_stop ;
|
|
"-no-custom-tags", Arg.Set no_custom_tags, Odoc_messages.no_custom_tags ;
|
|
"-stars", Arg.Set remove_stars, Odoc_messages.remove_stars ;
|
|
"-inv-merge-ml-mli", Arg.Set inverse_merge_ml_mli, Odoc_messages.inverse_merge_ml_mli ;
|
|
"-keep-code", Arg.Set keep_code, Odoc_messages.keep_code^"\n" ;
|
|
|
|
"-dump", Arg.String (fun s -> dump := Some s), Odoc_messages.dump ;
|
|
"-load", Arg.String (fun s -> load := !load @ [s]), Odoc_messages.load^"\n" ;
|
|
|
|
"-t", Arg.String (fun s -> title := Some s), Odoc_messages.option_title ;
|
|
"-hide", Arg.String add_hidden_modules, Odoc_messages.hide_modules ;
|
|
"-m", Arg.String (fun s -> merge_options := !merge_options @ (analyse_merge_options s)), Odoc_messages.merge_options^"\n" ;
|
|
|
|
(* generators *)
|
|
"-html", Arg.Unit (fun () -> set_doc_generator !default_html_generator), Odoc_messages.generate_html ;
|
|
"-latex", Arg.Unit (fun () -> set_doc_generator !default_latex_generator), Odoc_messages.generate_latex ;
|
|
"-texi", Arg.Unit (fun () -> set_doc_generator !default_texi_generator), Odoc_messages.generate_texinfo ;
|
|
"-man", Arg.Unit (fun () -> set_doc_generator !default_man_generator), Odoc_messages.generate_man ;
|
|
"-iso", Arg.Unit (fun () -> set_doc_generator !default_iso_generator), Odoc_messages.generate_iso ;
|
|
"-dot", Arg.Unit (fun () -> set_doc_generator !default_dot_generator), Odoc_messages.generate_dot ;
|
|
"-g", Arg.String (fun s -> ()), Odoc_messages.load_file^"\n" ;
|
|
|
|
|
|
(* html only options *)
|
|
"-all-params", Arg.Set with_parameter_list, Odoc_messages.with_parameter_list ;
|
|
"-css-style", Arg.String (fun s -> css_style := Some s), Odoc_messages.css_style ;
|
|
"-index-only", Arg.Set index_only, Odoc_messages.index_only ;
|
|
"-colorize-code", Arg.Set colorize_code, Odoc_messages.colorize_code^"\n" ;
|
|
|
|
(* latex only options *)
|
|
"-noheader", Arg.Unit (fun () -> with_header := false), Odoc_messages.no_header ;
|
|
"-notrailer", Arg.Unit (fun () -> with_trailer := false), Odoc_messages.no_trailer ;
|
|
"-sepfiles", Arg.Set separate_files, Odoc_messages.separate_files ;
|
|
"-latextitle", Arg.String f_latex_title, Odoc_messages.latex_title latex_titles ;
|
|
"-notoc", Arg.Unit (fun () -> with_toc := false), Odoc_messages.no_toc^"\n" ;
|
|
|
|
(* tex only options *)
|
|
"-noindex", Arg.Clear with_index, Odoc_messages.no_index ;
|
|
"-esc8", Arg.Set esc_8bits, Odoc_messages.esc_8bits ;
|
|
|
|
(* iso only options *)
|
|
"-iso-val", Arg.String (fun s -> iso_val_options := analyse_iso_checks s), Odoc_messages.iso_val_met_att_options ;
|
|
"-iso-cl", Arg.String (fun s -> iso_class_options := analyse_iso_checks s), Odoc_messages.iso_class_options ;
|
|
"-iso-mod", Arg.String (fun s -> iso_module_options := analyse_iso_checks s), Odoc_messages.iso_module_options ;
|
|
"-iso-ex", Arg.String (fun s -> iso_exception_options := analyse_iso_checks s), Odoc_messages.iso_exception_options ;
|
|
"-iso-ty", Arg.String (fun s -> iso_type_options := analyse_iso_checks s), Odoc_messages.iso_type_options^"\n" ;
|
|
|
|
(* dot only options *)
|
|
"-dot-file", Arg.String (fun s -> dot_file := s), Odoc_messages.dot_file ;
|
|
"-dot-colors", Arg.String (fun s -> dot_colors := Str.split (Str.regexp_string ",") s), Odoc_messages.dot_colors ;
|
|
"-dot-include-all", Arg.Set dot_include_all, Odoc_messages.dot_include_all ;
|
|
"-dot-types", Arg.Set dot_types, Odoc_messages.dot_types ;
|
|
"-dot-reduce", Arg.Set dot_reduce, Odoc_messages.dot_reduce ;
|
|
|
|
]
|
|
|
|
let add_option o = options := !options @ [o]
|
|
|
|
let parse ~html_generator ~latex_generator ~texi_generator ~man_generator ~iso_generator ~dot_generator =
|
|
default_html_generator := Some html_generator ;
|
|
default_latex_generator := Some latex_generator ;
|
|
default_texi_generator := Some texi_generator ;
|
|
default_man_generator := Some man_generator ;
|
|
default_iso_generator := Some iso_generator ;
|
|
default_dot_generator := Some dot_generator ;
|
|
let _ = Arg.parse !options
|
|
(fun s -> files := !files @ [s])
|
|
(Odoc_messages.usage^Odoc_messages.options_are)
|
|
in
|
|
(* we sort the hidden modules by name, to be sure that for example,
|
|
A.B is before A, so we will match against A.B before A in
|
|
Odoc_name.hide_modules.*)
|
|
hidden_modules := List.sort (fun a -> fun b -> - (compare a b)) !hidden_modules
|
|
|
|
|