ocaml/ocamldoc/odoc_name.ml

163 lines
4.1 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. *)
(* *)
(***********************************************************************)
(* $Id$ *)
(** Representation of element names. *)
let infix_chars = [ '|' ;
'<' ;
'>' ;
'@' ;
'^' ;
'&' ;
'+' ;
'-' ;
'*' ;
'/' ;
'$' ;
'%' ;
'=' ;
':' ;
'~' ;
'!' ;
]
type t = string
let parens_if_infix name =
match name with
"" -> ""
| s ->
if List.mem s.[0] infix_chars then
"("^s^")"
else
s
let cut name =
match name with
"" -> ("", "")
| s ->
let len = String.length s in
match s.[len-1] with
')' ->
(
let j = ref 0 in
let buf = [|Buffer.create len ; Buffer.create len |] in
for i = 0 to len - 1 do
match s.[i] with
'.' when !j = 0 ->
if i < len - 1 then
match s.[i+1] with
'(' ->
j := 1
| _ ->
Buffer.add_char buf.(!j) '('
else
Buffer.add_char buf.(!j) s.[i]
| c ->
Buffer.add_char buf.(!j) c
done;
(Buffer.contents buf.(0), Buffer.contents buf.(1))
)
| _ ->
match List.rev (Str.split (Str.regexp_string ".") s) with
[] -> ("", "")
| h :: q ->
(String.concat "." (List.rev q), h)
let simple name = snd (cut name)
let father name = fst (cut name)
let concat n1 n2 = n1^"."^n2
let head n =
match Str.split (Str.regexp "\\.") n with
[] -> n
| h :: _ -> h
let depth name =
try
List.length (Str.split (Str.regexp "\\.") name)
with
_ -> 1
let prefix n1 n2 =
(n1 <> n2) &
(try
let len1 = String.length n1 in
((String.sub n2 0 len1) = n1) &
(n2.[len1] = '.')
with _ -> false)
let get_relative n1 n2 =
if prefix n1 n2 then
let len1 = String.length n1 in
try
String.sub n2 (len1+1) ((String.length n2) - len1 - 1)
with
_ -> n2
else
n2
let hide_given_modules l s =
let rec iter = function
[] -> s
| h :: q ->
let s2 = get_relative h s in
if s = s2 then
iter q
else
s2
in
iter l
let qualified name = String.contains name '.'
let from_ident ident = Ident.name ident
let from_path path = Path.name path
let to_path n =
match
List.fold_left
(fun acc_opt -> fun s ->
match acc_opt with
None -> Some (Path.Pident (Ident.create s))
| Some acc -> Some (Path.Pdot (acc, s, 0)))
None
(Str.split (Str.regexp "\\.") n)
with
None -> raise (Failure "to_path")
| Some p -> p
let from_longident longident = String.concat "." (Longident.flatten longident)
let name_alias name cpl_aliases =
let rec f n1 = function
[] -> raise Not_found
| (n2, n3) :: q ->
if n2 = n1 then
n3
else
if prefix n2 n1 then
let ln2 = String.length n2 in
n3^(String.sub n1 ln2 ((String.length n1) - ln2))
else
f n1 q
in
let rec iter n =
try iter (f n cpl_aliases)
with Not_found -> n
in
iter name