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
|
(**************************************************************************)
(* *)
(* OCaml *)
(* *)
(* 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 GNU Lesser General Public License version 2.1, with the *)
(* special exception on linking described in the file LICENSE. *)
(* *)
(**************************************************************************)
(** Analysis of comments. *)
open Odoc_types
(** This variable contains the regular expression representing a blank but not a '\n'.*)
let simple_blank = "[ \013\009\012]"
module type Texter =
sig
(** Return a text structure from a string. *)
val text_of_string : string -> text
end
module Info_retriever =
functor (MyTexter : Texter) ->
struct
let create_see _file s =
try
let lexbuf = Lexing.from_string s in
let (see_ref, s) = Odoc_parser.see_info Odoc_see_lexer.main lexbuf in
(see_ref, MyTexter.text_of_string s)
with
| Odoc_text.Text_syntax (l, c, s) ->
raise (Failure (Odoc_messages.text_parse_error l c s))
| _ ->
raise (Failure ("Unknown error while parsing @see tag: "^s))
let retrieve_info fun_lex file (s : string) =
try
Odoc_comments_global.init ();
Odoc_lexer.comments_level := 0;
let lexbuf = Lexing.from_string s in
match Odoc_parser.main fun_lex lexbuf with
None ->
(0, None)
| Some (desc, remain_opt) ->
let mem_nb_chars = !Odoc_comments_global.nb_chars in
begin match remain_opt with
None ->
()
| Some s ->
let lexbuf2 = Lexing.from_string s in
Odoc_parser.info_part2 Odoc_lexer.elements lexbuf2
end;
(mem_nb_chars,
Some
{
i_desc = (match desc with "" -> None | _ -> Some (MyTexter.text_of_string desc));
i_authors = !Odoc_comments_global.authors;
i_version = !Odoc_comments_global.version;
i_sees = (List.map (create_see file) !Odoc_comments_global.sees) ;
i_since = !Odoc_comments_global.since;
i_before = Odoc_merge.merge_before_tags
(List.map (fun (n, s) ->
(n, MyTexter.text_of_string s)) !Odoc_comments_global.before)
;
i_deprecated =
(match !Odoc_comments_global.deprecated with
None -> None | Some s -> Some (MyTexter.text_of_string s));
i_params =
(List.map (fun (n, s) ->
(n, MyTexter.text_of_string s)) !Odoc_comments_global.params);
i_raised_exceptions =
(List.map (fun (n, s) ->
(n, MyTexter.text_of_string s)) !Odoc_comments_global.raised_exceptions);
i_return_value =
(match !Odoc_comments_global.return_value with
None -> None | Some s -> Some (MyTexter.text_of_string s)) ;
i_custom = (List.map
(fun (tag, s) -> (tag, MyTexter.text_of_string s))
!Odoc_comments_global.customs)
}
)
with e ->
let (l, c, message) = match e with
| Failure s -> (!Odoc_lexer.line_number + 1, 0, s)
| Odoc_text.Text_syntax (l, c, s) -> (l, c, Odoc_messages.text_parse_error l c s)
| _other -> (0, 0, Odoc_messages.parse_error)
in begin
incr Odoc_global.errors;
prerr_endline (Odoc_messages.error_location file l c ^ message);
(0, None)
end
(** Return true if the given string contains a blank line. *)
let blank_line s =
try
let _ = Str.search_forward (Str.regexp ("['\n']"^simple_blank^"*['\n']")) s 0 in
(* a blank line was before the comment *)
true
with
Not_found ->
false
let retrieve_info_special file (s : string) =
retrieve_info Odoc_lexer.main file s
let retrieve_info_simple _file (s : string) =
Odoc_comments_global.init ();
Odoc_lexer.comments_level := 0;
let lexbuf = Lexing.from_string s in
match Odoc_parser.main Odoc_lexer.simple lexbuf with
None ->
(0, None)
| Some _ ->
(!Odoc_comments_global.nb_chars, Some Odoc_types.dummy_info)
(** Return true if the given string contains a blank line outside a simple comment. *)
let blank_line_outside_simple file s =
let rec iter s2 =
match retrieve_info_simple file s2 with
(_, None) ->
blank_line s2
| (len, Some _) ->
try
let pos = Str.search_forward (Str.regexp_string "(*") s2 0 in
let s_before = String.sub s2 0 pos in
let s_after = String.sub s2 len ((String.length s2) - len) in
(blank_line s_before) || (iter s_after)
with
Not_found ->
(* we shouldn't get here *)
false
in
iter s
let all_special file s =
let rec iter acc n s2 =
match retrieve_info_special file s2 with
(_, None) ->
(n, acc)
| (n2, Some i) ->
let new_s = String.sub s2 n2 ((String.length s2) - n2) in
iter (acc @ [i]) (n + n2) new_s
in
iter [] 0 s
let just_after_special file s =
match retrieve_info_special file s with
(_, None) ->
(0, None)
| (len, Some d) ->
(* we must not have a simple comment or a blank line before. *)
match retrieve_info_simple file (String.sub s 0 len) with
(_, None) ->
(
try
(* if the special comment is the stop comment (**/**),
then we must not associate it. *)
let pos = Str.search_forward (Str.regexp_string "(**") s 0 in
if blank_line (String.sub s 0 pos) ||
d.Odoc_types.i_desc = Some [Odoc_types.Raw "/*"]
then
(0, None)
else
(len, Some d)
with
Not_found ->
(* should not occur *)
(0, None)
)
| (_, Some _) ->
(0, None)
let first_special file s =
retrieve_info_special file s
let get_comments f_create_ele file s =
let (assoc_com, ele_coms) =
(* get the comments *)
let (len, special_coms) = all_special file s in
(* if there is no blank line after the special comments, and
if the last special comment is not the stop special comment, then the
last special comments must be associated to the element. *)
match List.rev special_coms with
[] ->
(None, [])
| h :: q ->
if (blank_line_outside_simple file
(String.sub s len ((String.length s) - len)) )
|| h.Odoc_types.i_desc = Some [Odoc_types.Raw "/*"]
then
(None, special_coms)
else
(Some h, List.rev q)
in
let ele_comments =
List.fold_left
(fun acc -> fun sc ->
match sc.Odoc_types.i_desc with
None ->
acc
| Some t ->
acc @ [f_create_ele t])
[]
ele_coms
in
(assoc_com, ele_comments)
end
module Basic_info_retriever = Info_retriever (Odoc_text.Texter)
let info_of_string s =
let dummy =
{
i_desc = None ;
i_authors = [] ;
i_version = None ;
i_sees = [] ;
i_since = None ;
i_before = [] ;
i_deprecated = None ;
i_params = [] ;
i_raised_exceptions = [] ;
i_return_value = None ;
i_custom = [] ;
}
in
let s2 = Printf.sprintf "(** %s *)" s in
let (_, i_opt) = Basic_info_retriever.first_special "-" s2 in
match i_opt with
None -> dummy
| Some i -> i
let info_of_comment_file modlist f =
try
let s = Odoc_misc.input_file_as_string f in
let i = info_of_string s in
Odoc_cross.assoc_comments_info "" modlist i
with
Sys_error s ->
failwith s
|
