/usr/lib/ocaml/atd/atd_util.mli is in libatd-ocaml-dev 1.0.1-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | (* $Id: atd_util.mli 51425 2010-11-08 06:30:55Z martin $ *)
(** Top-level utilities *)
val read_lexbuf :
?expand:bool ->
?keep_poly:bool ->
?xdebug:bool ->
?inherit_fields:bool ->
?inherit_variants:bool ->
?pos_fname:string ->
?pos_lnum:int ->
Lexing.lexbuf -> Atd_ast.full_module
(** Read an ATD file from a lexbuf. See also [read_channel], [load_file]
and [load_string].
@param expand
Perform monomorphization by creating specialized
type definitions starting with an underscore.
Default is false. See also {!Atd_expand}.
This corresponds to the [-x] option of [atdcat].
@param keep_poly
Preserve left-hand-side of all original type definitions
instead of removing parametrized definitions.
This option only applies when [expand = true].
Default is false. See also {!Atd_expand}.
This corresponds to the [-xk] option of [atdcat].
@param xdebug
Debugging option producing meaningful but non ATD-compliant
type names when new types names are created.
Default is false.
This corresponds to the [-xd] option of [atdcat].
@param inherit_fields
Expand [inherit] statements in record types.
Default is false. See also {!Atd_inherit}.
This corresponds to the [-if] option of [atdcat].
@param inherit_variants
Expand [inherit] statements in sum types.
Default is false. See also {!Atd_inherit}.
This corresponds to the [-iv] option of [atdcat].
@param pos_fname
Set the file name for use in error messages.
Default is [""].
@param pos_lnum
Set the number of the first line for use in error messages.
Default is [1].
*)
val read_channel :
?expand:bool ->
?keep_poly:bool ->
?xdebug:bool ->
?inherit_fields:bool ->
?inherit_variants:bool ->
?pos_fname:string ->
?pos_lnum:int ->
in_channel -> Atd_ast.full_module
(** Read an ATD file from an [in_channel]. Options: see [read_lexbuf].
The default [pos_fname] is set to ["<stdin>"] when appropriate. *)
val load_file :
?expand:bool ->
?keep_poly:bool ->
?xdebug:bool ->
?inherit_fields:bool ->
?inherit_variants:bool ->
?pos_fname:string ->
?pos_lnum:int ->
string -> Atd_ast.full_module
(** Read an ATD file. Options: see [read_lexbuf].
The default [pos_fname] is the given input file name. *)
val load_string :
?expand:bool ->
?keep_poly:bool ->
?xdebug:bool ->
?inherit_fields:bool ->
?inherit_variants:bool ->
?pos_fname:string ->
?pos_lnum:int ->
string -> Atd_ast.full_module
(** Read ATD data from a string. Options: see [read_lexbuf]. *)
val tsort :
Atd_ast.module_body -> (bool * Atd_ast.module_body) list
(**
Topological sort for dependency analysis.
[tsort] splits definitions into mutually-recursive groups,
ordered such that each group may only depend on type definitions
of its own group or previous groups.
The boolean flags indicate groups of one or more
mutually recursive definitions.
*)
|