1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
(* $Id$ *)
(*
Copyright 2002-2004 S�bastien Ailleret
Copyright 2004-2007, 2010 Martin Jambon
This file is distributed under the terms of the GNU Public License
http://www.gnu.org/licenses/gpl.txt
*)
open Printf
open Output
let line_numbers = ref default_param.line_numbers
let title = ref default_param.title
let tab_size = ref default_param.tab_size
let footnote = ref default_param.footnote
let style = ref default_param.style
let raw_comments = ref default_param.html_comments
let charset = ref default_param.charset
let annot_filter = ref default_param.annot_filter
let no_annot = ref default_param.no_annot
let ie7 = ref default_param.ie7
let out_format = ref (`Html : [`Html | `Latex ])
let body_only = ref false
let get_html_param () = {
Output.line_numbers = !line_numbers;
title = !title;
body_only = !body_only;
tab_size = !tab_size;
footnote = !footnote;
style = !style;
html_comments = !raw_comments;
charset = !charset;
annot_filter = !annot_filter;
no_annot = !no_annot;
ie7 = !ie7
}
let get_latex_param () = {
Output_latex.line_numbers = !line_numbers;
title = !title;
body_only = !body_only;
tab_size = !tab_size;
latex_comments = !raw_comments;
defs = Output_latex.default_param.Output_latex.defs
}
let get_param () =
match !out_format with
`Html -> `Html (get_html_param ())
| `Latex -> `Latex (get_latex_param ())
(* output file *)
let res_file = ref ""
(* output directory *)
let res_dir = ref ""
let usage =
"
Caml2html colorizes a set of OCaml source files (.ml, .mli, .mll, .mly, ...).
Type annotations will be shown when the mouse pointer passes over
an expression if the corresponding .annot file is available.
To obtain a .annot file, compile with ocamlc -dtypes or ocamlopt -dtypes.
Usage: " ^ (Filename.basename Sys.argv.(0)) ^ " [options] file1 ... fileN
Options:"
let speclist =
[
("-annotfilter",
Arg.Symbol (["innermost"; "outermost"],
(function
"innermost" -> annot_filter := `Innermost
| "outermost" -> annot_filter := `Outermost
| _ -> assert false)),
"
choose whether innermost or outermost type annotations
should be used (default: innermost)");
("-charset", Arg.String (fun s -> charset := s),
sprintf "\
<charset>
specify charset to use (default: %s)" default_param.charset);
("-css", Arg.Unit (fun () -> style := `Url "style.css"),
"
use CSS named style.css for styling");
("-cssurl", Arg.String (fun s -> style := `Url s),
"<URL>
use the given URL as CSS for styling");
("-inhead", Arg.Unit (fun () -> style := `Inhead Output.default_style),
"
use default styling and place it in the <head> section
of the document (default when applicable)");
("-inline", Arg.Unit (fun () -> style := `Inline),
"
use inline styling (HTML only, default fallback
if -inhead is not applicable)");
("-body", Arg.Set body_only,
"
output only document's body, for inclusion into an
existing document (see also -make-css and -make-latex-defs)");
("-ln", Arg.Unit (fun () -> line_numbers := true),
"
add line number at the beginning of each line");
("-hc", Arg.Unit (fun () -> raw_comments := true),
"
comments are treated as raw HTML or LaTeX code
(no newlines inside of tags)");
("-t", Arg.Unit (fun () -> title := true),
"
add a title to the HTML page");
("-nf", Arg.Unit (fun () -> footnote := false),
"
do not add footnotes to the HTML page");
("-ie7", Arg.Set ie7,
"
drop support for type annotations on Internet Explorer 6 and older");
("-noannot", Arg.Set no_annot,
"
do not insert type annotations as read from .annot files
(HTML output only)");
("-notab", Arg.Unit (fun () -> tab_size := -1),
"
do not replace tabs by spaces");
("-tab", Arg.Set_int tab_size,
"<integer>
replace tab by n spaces (default = 8)");
("-d", Arg.String (fun s -> res_dir := s),
"<directory>
generate files in directory dir, rather than in current directory");
("-o", Arg.String (fun s -> res_file := s),
"<filename>
output file");
("-v", Arg.Unit (fun () -> Printf.printf "%s\n" version; exit 0),
"
print version number to stdout and exit");
("-make-css", Arg.String (fun s -> Output.make_css s; exit 0),
"<filename>
create CSS file with default color definitions and exit");
("-ext", Arg.String Plugin.register_command,
"<NAME:CMD>
use the given external command CMD to handle comments that start
with (*NAME. NAME must be a lowercase identifier.");
("-latex", Arg.Unit (fun () -> out_format := `Latex),
"
output LaTeX code instead of HTML.");
("-make-latex-defs",
Arg.String (fun s -> Output_latex.make_defs_file s; exit 0),
"<filename>
create a file containing the default LaTeX color definitions
and matching highlighting commands, and exit.
\\usepackage{alltt,color} is not included.");
]
let handle_stdin_to_stdout out_format =
let buf = Buffer.create 8192 in
let l = Input.channel stdin in
(match out_format with
`Html param ->
if not param.Output.body_only then
Output.begin_document ~param buf [];
Output.ocaml_file ~param buf l;
if not param.Output.body_only then
Output.end_document ~param buf
| `Latex param ->
if not param.Output_latex.body_only then
Output_latex.begin_document ~param buf [];
Output_latex.ocaml_file ~param buf l;
if not param.Output_latex.body_only then
Output_latex.end_document ~param buf
);
Buffer.output_buffer stdout buf
let manage_files out_format files =
match out_format with
`Html param ->
if !res_file = "" then
(* handles files separately *)
let manage_one file =
let buf = Buffer.create 8192 in
if not param.Output.body_only then
Output.begin_document ~param buf [file];
Output.handle_file ~param buf file;
if not param.Output.body_only then
Output.end_document ~param buf;
Output.save_file ~dir:!res_dir buf (file ^ ".html")
in
List.iter manage_one files
else
(* groups all files into one *)
Output.ocaml_document ~param ~dir: !res_dir files !res_file
| `Latex param ->
if !res_file = "" then
let manage_one file =
let buf = Buffer.create 8192 in
if not param.Output_latex.body_only then
Output_latex.begin_document ~param buf [file];
Output_latex.handle_file ~param buf file;
if not param.Output_latex.body_only then
Output_latex.end_document ~param buf;
Output_latex.save_file ~dir:!res_dir buf (file ^ ".tex")
in
List.iter manage_one files
else
Output_latex.ocaml_document ~param ~dir: !res_dir files !res_file
let () =
let files = ref [] in
Arg.parse
speclist
(fun x -> files := x :: !files)
usage;
if !res_file = "" && !files = [] then
(title := false;
handle_stdin_to_stdout (get_param ()))
else
(if !res_file <> "" && ((List.length !files) >= 2) then
title := true;
(manage_files (get_param ())) (List.rev !files))
|
