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 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
|
(***********************************************************************)
(* *)
(* 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. *)
(* *)
(***********************************************************************)
let no_blanks s =
let len = String.length s in
let buf = Buffer.create len in
for i = 0 to len - 1 do
match s.[i] with
' ' | '\n' | '\t' | '\r' -> ()
| c -> Buffer.add_char buf c
done;
Buffer.contents buf
let input_file_as_string nom =
let chanin = open_in_bin nom in
let len = 1024 in
let s = Bytes.create len in
let buf = Buffer.create len in
let rec iter () =
try
let n = input chanin s 0 len in
if n = 0 then
()
else
(
Buffer.add_subbytes buf s 0 n;
iter ()
)
with
End_of_file -> ()
in
iter ();
close_in chanin;
Buffer.contents buf
let split_string s chars =
let len = String.length s in
let rec iter acc pos =
if pos >= len then
match acc with
"" -> []
| _ -> [acc]
else
if List.mem s.[pos] chars then
match acc with
"" -> iter "" (pos + 1)
| _ -> acc :: (iter "" (pos + 1))
else
iter (Printf.sprintf "%s%c" acc s.[pos]) (pos + 1)
in
iter "" 0
let split_with_blanks s = split_string s [' ' ; '\n' ; '\r' ; '\t' ]
let list_concat sep =
let rec iter = function
[] -> []
| [h] -> [h]
| h :: q -> h :: sep :: q
in
iter
let rec string_of_longident li =
match li with
| Longident.Lident s -> s
| Longident.Ldot(li, s) -> string_of_longident li ^ "." ^ s
| Longident.Lapply(l1, l2) ->
string_of_longident l1 ^ "(" ^ string_of_longident l2 ^ ")"
let get_fields type_expr =
let (fields, _) = Ctype.flatten_fields (Ctype.object_fields type_expr) in
List.fold_left
(fun acc -> fun (label, field_kind, typ) ->
match field_kind with
Types.Fabsent ->
acc
| _ ->
if label = "*dummy method*" then
acc
else
acc @ [label, typ]
)
[]
fields
let rec string_of_text t =
let rec iter t_ele =
match t_ele with
| Odoc_types.Raw s
| Odoc_types.Code s
| Odoc_types.CodePre s
| Odoc_types.Verbatim s -> s
| Odoc_types.Bold t
| Odoc_types.Italic t
| Odoc_types.Center t
| Odoc_types.Left t
| Odoc_types.Right t
| Odoc_types.Emphasize t -> string_of_text t
| Odoc_types.List l ->
(String.concat ""
(List.map (fun t -> "\n- "^(string_of_text t)) l))^
"\n"
| Odoc_types.Enum l ->
let rec f n = function
[] -> "\n"
| t :: q ->
"\n"^(string_of_int n)^". "^(string_of_text t)^
(f (n + 1) q)
in
f 1 l
| Odoc_types.Newline -> "\n"
| Odoc_types.Block t -> "\t"^(string_of_text t)^"\n"
| Odoc_types.Title (_, _, t) -> "\n"^(string_of_text t)^"\n"
| Odoc_types.Latex s -> "{% "^s^" %}"
| Odoc_types.Link (s, t) ->
"["^s^"]"^(string_of_text t)
| Odoc_types.Ref (name, _, Some text) ->
Printf.sprintf "[%s]" (string_of_text text)
| Odoc_types.Ref (name, _, None) ->
iter (Odoc_types.Code name)
| Odoc_types.Superscript t ->
"^{"^(string_of_text t)^"}"
| Odoc_types.Subscript t ->
"^{"^(string_of_text t)^"}"
| Odoc_types.Module_list l ->
string_of_text
(list_concat (Odoc_types.Raw ", ")
(List.map (fun s -> Odoc_types.Code s) l)
)
| Odoc_types.Index_list ->
""
| Odoc_types.Custom (_, t) -> string_of_text t
| Odoc_types.Target _ -> ""
in
String.concat "" (List.map iter t)
let string_of_author_list l =
match l with
[] ->
""
| _ ->
"* "^Odoc_messages.authors^":\n"^
(String.concat ", " l)^
"\n"
let string_of_version_opt v_opt =
match v_opt with
None -> ""
| Some v -> Odoc_messages.version^": "^v^"\n"
let string_of_since_opt s_opt =
match s_opt with
None -> ""
| Some s -> Odoc_messages.since^" "^s^"\n"
let string_of_raised_exceptions l =
match l with
[] -> ""
| (s, t) :: [] -> Odoc_messages.raises^" "^s^" "^(string_of_text t)^"\n"
| _ ->
Odoc_messages.raises^"\n"^
(String.concat ""
(List.map
(fun (ex, desc) -> "- "^ex^" "^(string_of_text desc)^"\n")
l
)
)^"\n"
let string_of_see (see_ref, t) =
let t_ref =
match see_ref with
Odoc_types.See_url s -> [ Odoc_types.Link (s, t) ]
| Odoc_types.See_file s -> (Odoc_types.Code s) :: (Odoc_types.Raw " ") :: t
| Odoc_types.See_doc s -> (Odoc_types.Italic [Odoc_types.Raw s]) :: (Odoc_types.Raw " ") :: t
in
string_of_text t_ref
let string_of_sees l =
match l with
[] -> ""
| see :: [] -> Odoc_messages.see_also^" "^(string_of_see see)^" \n"
| _ ->
Odoc_messages.see_also^"\n"^
(String.concat ""
(List.map
(fun see -> "- "^(string_of_see see)^"\n")
l
)
)^"\n"
let string_of_return_opt return_opt =
match return_opt with
None -> ""
| Some s -> Odoc_messages.returns^" "^(string_of_text s)^"\n"
let string_of_info i =
let module M = Odoc_types in
(match i.M.i_deprecated with
None -> ""
| Some d -> Odoc_messages.deprecated^"! "^(string_of_text d)^"\n")^
(match i.M.i_desc with
None -> ""
| Some d when d = [Odoc_types.Raw ""] -> ""
| Some d -> (string_of_text d)^"\n"
)^
(string_of_author_list i.M.i_authors)^
(string_of_version_opt i.M.i_version)^
(string_of_since_opt i.M.i_since)^
(string_of_raised_exceptions i.M.i_raised_exceptions)^
(string_of_return_opt i.M.i_return_value)
let apply_opt f v_opt =
match v_opt with
None -> None
| Some v -> Some (f v)
let string_of_date ?(absolute=false) ?(hour=true) d =
let add_0 s = if String.length s < 2 then "0"^s else s in
let t = (if absolute then Unix.gmtime else Unix.localtime) d in
(string_of_int (t.Unix.tm_year + 1900))^"-"^
(add_0 (string_of_int (t.Unix.tm_mon + 1)))^"-"^
(add_0 (string_of_int t.Unix.tm_mday))^
(
if hour then
" "^
(add_0 (string_of_int t.Unix.tm_hour))^":"^
(add_0 (string_of_int t.Unix.tm_min))
else
""
)
let current_date =
let time =
try
float_of_string (Sys.getenv "SOURCE_DATE_EPOCH")
with
Not_found -> Unix.time ()
in string_of_date ~absolute: true ~hour: false time
let rec text_list_concat sep l =
match l with
[] -> []
| [t] -> t
| t :: q ->
t @ (sep :: (text_list_concat sep q))
let rec text_no_title_no_list t =
let rec iter t_ele =
match t_ele with
| Odoc_types.Title (_,_,t) -> text_no_title_no_list t
| Odoc_types.List l
| Odoc_types.Enum l ->
(Odoc_types.Raw " ") ::
(text_list_concat
(Odoc_types.Raw ", ")
(List.map text_no_title_no_list l))
| Odoc_types.Raw _
| Odoc_types.Code _
| Odoc_types.CodePre _
| Odoc_types.Verbatim _
| Odoc_types.Ref _
| Odoc_types.Target _ -> [t_ele]
| Odoc_types.Newline -> [Odoc_types.Newline]
| Odoc_types.Block t -> [Odoc_types.Block (text_no_title_no_list t)]
| Odoc_types.Bold t -> [Odoc_types.Bold (text_no_title_no_list t)]
| Odoc_types.Italic t -> [Odoc_types.Italic (text_no_title_no_list t)]
| Odoc_types.Center t -> [Odoc_types.Center (text_no_title_no_list t)]
| Odoc_types.Left t -> [Odoc_types.Left (text_no_title_no_list t)]
| Odoc_types.Right t -> [Odoc_types.Right (text_no_title_no_list t)]
| Odoc_types.Emphasize t -> [Odoc_types.Emphasize (text_no_title_no_list t)]
| Odoc_types.Latex s -> [Odoc_types.Latex s]
| Odoc_types.Link (s, t) -> [Odoc_types.Link (s, (text_no_title_no_list t))]
| Odoc_types.Superscript t -> [Odoc_types.Superscript (text_no_title_no_list t)]
| Odoc_types.Subscript t -> [Odoc_types.Subscript (text_no_title_no_list t)]
| Odoc_types.Module_list l ->
list_concat (Odoc_types.Raw ", ")
(List.map
(fun s -> Odoc_types.Ref (s, Some Odoc_types.RK_module, None))
l
)
| Odoc_types.Index_list -> []
| Odoc_types.Custom (s,t) -> [Odoc_types.Custom (s, text_no_title_no_list t)]
in
List.flatten (List.map iter t)
let get_titles_in_text t =
let l = ref [] in
let rec iter_ele ele =
match ele with
| Odoc_types.Title (n,lopt,t) -> l := (n,lopt,t) :: !l
| Odoc_types.List l
| Odoc_types.Enum l -> List.iter iter_text l
| Odoc_types.Raw _
| Odoc_types.Code _
| Odoc_types.CodePre _
| Odoc_types.Verbatim _
| Odoc_types.Ref _ -> ()
| Odoc_types.Newline -> ()
| Odoc_types.Block t
| Odoc_types.Bold t
| Odoc_types.Italic t
| Odoc_types.Center t
| Odoc_types.Left t
| Odoc_types.Right t
| Odoc_types.Emphasize t -> iter_text t
| Odoc_types.Latex s -> ()
| Odoc_types.Link (_, t)
| Odoc_types.Superscript t
| Odoc_types.Subscript t -> iter_text t
| Odoc_types.Module_list _ -> ()
| Odoc_types.Index_list -> ()
| Odoc_types.Custom (_, t) -> iter_text t
| Odoc_types.Target _ -> ()
and iter_text txt =
List.iter iter_ele txt
in
iter_text t;
List.rev !l
let text_concat (sep : Odoc_types.text) l =
let rec iter = function
[] -> []
| [last] -> last
| h :: q -> h @ sep @ (iter q)
in
iter l
(*********************************************************)
let rec get_before_dot s =
try
let len = String.length s in
let n = String.index s '.' in
if n + 1 >= len then
(* le point est le dernier caractere *)
(true, s, "")
else
match s.[n+1] with
' ' | '\n' | '\r' | '\t' ->
(true, String.sub s 0 (n+1),
String.sub s (n+1) (len - n - 1))
| _ ->
let b, s2, s_after = get_before_dot (String.sub s (n + 1) (len - n - 1)) in
(b, (String.sub s 0 (n+1))^s2, s_after)
with
Not_found -> (false, s, "")
let rec first_sentence_text t =
match t with
[] -> (false, [], [])
| ele :: q ->
let (stop, ele2, ele3_opt) = first_sentence_text_ele ele in
if stop then
(stop, [ele2],
match ele3_opt with None -> q | Some e -> e :: q)
else
let (stop2, q2, rest) = first_sentence_text q in
(stop2, ele2 :: q2, rest)
and first_sentence_text_ele text_ele =
match text_ele with
| Odoc_types.Raw s ->
let b, s2, s_after = get_before_dot s in
(b, Odoc_types.Raw s2, Some (Odoc_types.Raw s_after))
| Odoc_types.Code _
| Odoc_types.CodePre _
| Odoc_types.Verbatim _ -> (false, text_ele, None)
| Odoc_types.Bold t ->
let (b, t2, t3) = first_sentence_text t in
(b, Odoc_types.Bold t2, Some (Odoc_types.Bold t3))
| Odoc_types.Italic t ->
let (b, t2, t3) = first_sentence_text t in
(b, Odoc_types.Italic t2, Some (Odoc_types.Italic t3))
| Odoc_types.Center t ->
let (b, t2, t3) = first_sentence_text t in
(b, Odoc_types.Center t2, Some (Odoc_types.Center t3))
| Odoc_types.Left t ->
let (b, t2, t3) = first_sentence_text t in
(b, Odoc_types.Left t2, Some (Odoc_types.Left t3))
| Odoc_types.Right t ->
let (b, t2, t3) = first_sentence_text t in
(b, Odoc_types.Right t2, Some (Odoc_types.Right t3))
| Odoc_types.Emphasize t ->
let (b, t2, t3) = first_sentence_text t in
(b, Odoc_types.Emphasize t2, Some (Odoc_types.Emphasize t3))
| Odoc_types.Block t ->
let (b, t2, t3) = first_sentence_text t in
(b, Odoc_types.Block t2, Some (Odoc_types.Block t3))
| Odoc_types.Title (n, l_opt, t) ->
let (b, t2, t3) = first_sentence_text t in
(b,
Odoc_types.Title (n, l_opt, t2),
Some (Odoc_types.Title (n, l_opt, t3)))
| Odoc_types.Newline ->
(true, Odoc_types.Raw "", Some Odoc_types.Newline)
| Odoc_types.List _
| Odoc_types.Enum _
| Odoc_types.Latex _
| Odoc_types.Link _
| Odoc_types.Ref _
| Odoc_types.Superscript _
| Odoc_types.Subscript _
| Odoc_types.Module_list _
| Odoc_types.Index_list -> (false, text_ele, None)
| Odoc_types.Custom _
| Odoc_types.Target _ -> (false, text_ele, None)
let first_sentence_of_text t =
let (_,t2,_) = first_sentence_text t in
t2
let first_sentence_and_rest_of_text t =
let (_,t1, t2) = first_sentence_text t in
(t1, t2)
let remove_ending_newline s =
let len = String.length s in
if len <= 0 then
s
else
match s.[len-1] with
'\n' -> String.sub s 0 (len-1)
| _ -> s
let search_string_backward ~pat =
let lenp = String.length pat in
let rec iter s =
let len = String.length s in
match compare len lenp with
-1 -> raise Not_found
| 0 -> if pat = s then 0 else raise Not_found
| _ ->
let pos = len - lenp in
let s2 = String.sub s pos lenp in
if s2 = pat then
pos
else
iter (String.sub s 0 pos)
in
fun ~s -> iter s
(*********************************************************)
let create_index_lists elements string_of_ele =
let rec f current acc0 acc1 acc2 = function
[] -> (acc0 :: acc1) @ [acc2]
| ele :: q ->
let s = string_of_ele ele in
match s with
"" -> f current acc0 acc1 (acc2 @ [ele]) q
| _ ->
let first = Char.uppercase s.[0] in
match first with
'A' .. 'Z' ->
if current = first then
f current acc0 acc1 (acc2 @ [ele]) q
else
f first acc0 (acc1 @ [acc2]) [ele] q
| _ ->
f current (acc0 @ [ele]) acc1 acc2 q
in
f '_' [] [] [] elements
(*** for labels *)
let is_optional = Btype.is_optional
let label_name = Btype.label_name
let remove_option typ =
let rec iter t =
match t with
| Types.Tconstr(path, [ty], _) when Path.same path Predef.path_option -> ty.Types.desc
| Types.Tconstr _
| Types.Tvar _
| Types.Tunivar _
| Types.Tpoly _
| Types.Tarrow _
| Types.Ttuple _
| Types.Tobject _
| Types.Tfield _
| Types.Tnil
| Types.Tvariant _
| Types.Tpackage _ -> t
| Types.Tlink t2
| Types.Tsubst t2 -> iter t2.Types.desc
in
{ typ with Types.desc = iter typ.Types.desc }
|