Ekdohibs
/
ocaml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

intégration nouvelle version olivier 

git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@4793 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
master
Maxence Guesdon 2002-05-08 12:39:32 +00:00
parent 287fa2f2ac
commit 9cabf29c34
1 changed files with 137 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

211
ocamldoc/odoc_texi.ml
View File

@ -119,15 +119,15 @@ let indices = function
| `Module_type -> "mt" | `Module_type -> "mt"
let indices_names = [ let indices_names = [
"Types", "ty" ; "Types" , "ty" ;
"Exceptions", "ex" ; "Exceptions" , "ex" ;
"Values", "va" ; "Values" , "va" ;
"Class attributes", "ca" ; "Class attributes", "ca" ;
"Methods", "me" ; "Methods" , "me" ;
"Classes", "cl" ; "Classes" , "cl" ;
"Class types", "ct" ; "Class types" , "ct" ;
"Modules", "mo" ; "Modules" , "mo" ;
"Module types", "mt" ; ] "Module types" , "mt" ; ]
@ -208,11 +208,13 @@ struct
puts_nl chan "@end menu" puts_nl chan "@end menu"
end end
(** cross reference to node [name] *)
let xref ?xname name = let xref ?xname name =
"@xref{" ^ (fix_nodename name) ^ "@xref{" ^ (fix_nodename name) ^
(match xname with | None -> "" | Some s -> "," ^ s) ^ (match xname with | None -> "" | Some s -> "," ^ s) ^
"}." "}."
(** enclose the string between [\@ifinfo] tags *)
let ifinfo s = let ifinfo s =
String.concat "\n" String.concat "\n"
[ "@ifinfo" ; s ; "@end ifinfo" ; "" ] [ "@ifinfo" ; s ; "@end ifinfo" ; "" ]
@ -222,11 +224,13 @@ end
(** Generation of Texinfo code from text structures *) (** {2 Generation of Texinfo code} *)
(** This class generates Texinfo code from text structures *)
class text = class text =
object(self) object(self)
(** Associations between a title number and functions to get texinfo code. *) (** Associations between a title number and texinfo code. *)
val titles = [ val titles = [
1, "@chapter " ; 1, "@chapter " ;
2, "@section " ; 2, "@section " ;
@ -250,6 +254,8 @@ class text =
method escape = method escape =
Texi.escape Texi.escape
(** this method is not used here but is virtual
in a class we will inherit later *)
method label ?(no_ : bool option) (_ : string) = method label ?(no_ : bool option) (_ : string) =
failwith "gni" ; "" failwith "gni" ; ""
@ -258,6 +264,10 @@ class text =
String.concat "" String.concat ""
(List.map self#texi_of_text_element t) (List.map self#texi_of_text_element t)
(** {3 Conversion methods}
[texi_of_????] converts a [text_element] to a Texinfo string. *)
(** Return the Texinfo code for the [text_element] in parameter. *) (** Return the Texinfo code for the [text_element] in parameter. *)
method texi_of_text_element = function method texi_of_text_element = function
| Verbatim s | Latex s -> self#texi_of_Verbatim s | Verbatim s | Latex s -> self#texi_of_Verbatim s
@ -361,7 +371,7 @@ class texi =
inherit text as to_texi inherit text as to_texi
inherit Odoc_to_text.to_text as to_text inherit Odoc_to_text.to_text as to_text
(** quelques machins utiles qui se trouvent bien ici *) (** {3 Small helper stuff.} *)
val maxdepth = 4 val maxdepth = 4
@ -383,81 +393,126 @@ class texi =
else "") else "")
(** grosse bidouille infame *) (** Two hacks to fix linebreaks in the descriptions.*)
method private fix_linebreaks t = method private fix_linebreaks =
let re = Str.regexp "\n[ \t]*" in let re = Str.regexp "\n[ \t]*" in
List.map fun t ->
(function List.map
| Newline -> Raw "\n" (function
| Raw s -> Raw (Str.global_replace re "\n" s) | Newline -> Raw "\n"
| List tel | Enum tel -> List (List.map self#fix_linebreaks tel) | Raw s -> Raw (Str.global_replace re "\n" s)
| te -> te) t | List tel | Enum tel -> List (List.map self#fix_linebreaks tel)
| te -> te) t
(** autre bidouille du meme acabit. Elles ont tellement honte method private soft_fix_linebreaks =
qu'elle se cachent. *)
method private soft_fix_linebreaks ind t =
let re = Str.regexp "\n[ \t]*" in let re = Str.regexp "\n[ \t]*" in
let rep = String.make (succ ind) ' ' in fun ind t ->
rep.[0] <- '\n' ; let rep = String.make (succ ind) ' ' in
List.map rep.[0] <- '\n' ;
(function List.map
| Raw s -> Raw (Str.global_replace re rep s) (function
| te -> te) t | Raw s -> Raw (Str.global_replace re rep s)
| te -> te) t
(** {3 [text] values generation}
Generates [text] values out of description parts.
Redefines some of methods of {! Odoc_to_text.to_text}. *)
method text_of_desc = function method text_of_desc = function
| None -> [] | None -> []
| Some [ Raw "" ] -> [] | Some [ Raw "" ] -> []
| Some t -> (self#fix_linebreaks t) @ [ Newline ] | Some t -> (self#fix_linebreaks t) @ [ Newline ]
(** ça je l'ai rajouté *) method text_of_sees_opt see_l =
method text_of_sees_opt = function List.concat
| [] -> [] (List.map
| (See_url s, t) :: n -> (function
[ Bold [ Raw Odoc_messages.see_also ] ; | (See_url s, t) ->
Raw " " ; Link (s, t) ; Newline ] @ (self#text_of_sees_opt n) [ linebreak ; Bold [ Raw Odoc_messages.see_also ] ;
| (See_file s, t) :: n Raw " " ; Link (s, t) ; Newline ]
| (See_doc s, t) :: n -> | (See_file s, t)
[ Bold [ Raw Odoc_messages.see_also ] ; | (See_doc s, t) ->
Raw " " ; Raw s ] @ t @ [ Newline ] @ (self#text_of_sees_opt n) [ linebreak ; Bold [ Raw Odoc_messages.see_also ] ;
Raw " " ; Raw s ] @ t @ [ Newline ])
see_l)
(** ça aussi je l'ai rajouté *) method text_of_params params_list =
method text_of_params = function List.concat
| [] -> [] (List.map
| (s, t) :: n -> (fun (s, t) ->
[ Bold [ Raw Odoc_messages.parameters ] ; [ linebreak ;
Raw " " ; Raw s ; Raw ": " ] @ t @ Bold [ Raw Odoc_messages.parameters ] ;
[ Newline ] @ (self#text_of_params n) Raw " " ; Raw s ; Raw ": " ] @ t @ [ Newline ] )
params_list)
method text_of_raised_exceptions = function
| [] -> []
| (s, t) :: [] ->
[ linebreak ;
Bold [ Raw Odoc_messages.raises ] ;
Raw " " ; Code s ; Raw " " ]
@ t @ [ Newline ]
| l ->
[ linebreak ;
Bold [ Raw Odoc_messages.raises ] ;
Raw " :" ;
List
(List.map
(fun (ex, desc) ->(Code ex) :: (Raw " ") :: desc ) l ) ;
Newline ]
(** plouf plouf *)
method text_of_return_opt = function method text_of_return_opt = function
| None -> [] | None -> []
| Some t -> | Some t ->
(Bold [ Raw Odoc_messages.returns ]) (Bold [Raw Odoc_messages.returns ]) :: Raw " " :: t @ [ Newline ]
:: (Raw " ") :: t @ [ Newline ]
method text_of_custom c_l =
List.flatten
(List.rev
(List.fold_left
(fun acc -> fun (tag, text) ->
try
let f = List.assoc tag tag_functions in
( linebreak :: (f text) @ [ Newline ] ) :: acc
with
Not_found ->
Odoc_info.warning (Odoc_messages.tag_not_handled tag) ;
acc
) [] c_l))
(** redéfinition de text_of_info de Odoc_to_text.to_text
dans le seul but d'introduire la précédente bidouille
@raise Exit pas d'exceptions, aucunes ! *)
method text_of_info ?(block=false) = function method text_of_info ?(block=false) = function
| None -> [] | None -> []
| Some info -> | Some info ->
let t = let t =
List.flatten [ List.concat
( match info.i_deprecated with [ ( match info.i_deprecated with
| None -> [] | None -> []
| Some t -> | Some t ->
(Raw (Odoc_messages.deprecated ^ " ")) :: (Raw (Odoc_messages.deprecated ^ " ")) ::
(self#fix_linebreaks t) (self#fix_linebreaks t)
@ [ Newline ; Newline ] ) ; @ [ Newline ; Newline ] ) ;
self#text_of_desc info.i_desc ; self#text_of_desc info.i_desc ;
self#text_of_author_list info.i_authors ; if info.i_authors <> []
self#text_of_version_opt info.i_version ; then ( linebreak ::
self#text_of_sees_opt info.i_sees ; self#text_of_author_list info.i_authors )
self#text_of_since_opt info.i_since ; else [] ;
self#text_of_params info.i_params ; if is info.i_version
self#text_of_raised_exceptions info.i_raised_exceptions ; then ( linebreak ::
self#text_of_return_opt info.i_return_value ; self#text_of_version_opt info.i_version )
] in else [] ;
self#text_of_sees_opt info.i_sees ;
if is info.i_since
then ( linebreak ::
self#text_of_since_opt info.i_since )
else [] ;
self#text_of_params info.i_params ;
self#text_of_raised_exceptions info.i_raised_exceptions ;
if is info.i_return_value
then ( linebreak ::
self#text_of_return_opt info.i_return_value )
else [] ;
self#text_of_custom info.i_custom ;
] in
if block if block
then [ Block t ] then [ Block t ]
else (t @ [ Newline ] ) else (t @ [ Newline ] )
@ -465,13 +520,16 @@ class texi =
method texi_of_info i = method texi_of_info i =
self#texi_of_text (self#text_of_info i) self#texi_of_text (self#text_of_info i)
(** {3 Conversion of [module_elements] into Texinfo strings}
The following functions convert [module_elements] and their
description to [text] values then to Texinfo strings using the
functions above. *)
method text_el_of_type_expr m_name typ = method text_el_of_type_expr m_name typ =
Raw (indent 5 Raw (indent 5
(self#relative_idents m_name (self#relative_idents m_name
(Odoc_info.string_of_type_expr typ))) (Odoc_info.string_of_type_expr typ)))
(** je l'ai redéfini pcq to_text mettait un [Code]
et moi je veux un [Raw] sinon c'est moche *)
method text_of_short_type_expr m_name typ = method text_of_short_type_expr m_name typ =
[ Raw (self#normal_type m_name typ) ] [ Raw (self#normal_type m_name typ) ]
@ -713,9 +771,13 @@ class texi =
| Element_value v -> self#texi_of_value v | Element_value v -> self#texi_of_value v
| Element_exception e -> self#texi_of_exception e | Element_exception e -> self#texi_of_exception e
| Element_type t -> self#texi_of_type t | Element_type t -> self#texi_of_type t
| Element_module_comment t -> self#texi_of_text (t @ [Newline]) | Element_module_comment t ->
self#texi_of_text (Newline :: t @ [Newline])
) )
(** {3 Generating methods }
These methods write Texinfo code to an [out_channel] *)
(** Generate the Texinfo code for the given list of inherited classes.*) (** Generate the Texinfo code for the given list of inherited classes.*)
method generate_inheritance_info chanout inher_l = method generate_inheritance_info chanout inher_l =
let f inh = let f inh =
@ -927,7 +989,7 @@ class texi =
(** Return the header of the TeX document. *) (** Writes the header of the TeX document. *)
method generate_texi_header chan m_list = method generate_texi_header chan m_list =
let title, filename = let title, filename =
match !Odoc_args.title with match !Odoc_args.title with
@ -981,7 +1043,7 @@ class texi =
else [] )) else [] ))
(** Writes the header of the TeX document. *)
method generate_texi_trailer chan = method generate_texi_trailer chan =
nl chan ; nl chan ;
if !with_index if !with_index
@ -1000,7 +1062,8 @@ class texi =
(** Generate the Texinfo file from a module list, in the {!Odoc_args.out_file} file. *) (** Generate the Texinfo file from a module list,
in the {!Odoc_args.out_file} file. *)
method generate module_list = method generate module_list =
try try
let chanout = open_out let chanout = open_out