/usr/lib/ocaml/atd/atd_annot.mli is in libatd-ocaml-dev 1.1.2-1build4.
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 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | (**
Utilities for interpreting annotations of type {!Atd_ast.annot}
*)
type t = Atd_ast.annot
(**
Sample annotation in ATD syntax with legend:
{v
section a section b
----------- ------
<a a1="x1"> <b b1>
| | | |
| | | +- field without a value
| | |
| | +- field value
| |
| +- field name
|
+- section name
v}
The following rules must be followed for a proper use of this module:
- There may not be two sections with the same name. The [merge] function
can be used to merge sections.
- Section order doesn't matter as long as section names are unique.
- Field names within a section should be unique. If not, only the
first occurrence of each field is meaningful.
- Field values may be arbitrary strings.
*)
val has_section : string -> t -> bool
(** Return true if such a section (first-level key) exists. *)
val has_field : string list -> string -> t -> bool
(** [has_field section_names field_name annotations]
returns true if at least one section exists with
a name in [section_names] and one of its fields named
[field_name].
Each section should be unique.
*)
val get_flag : string list -> string -> t -> bool
(** [get_flag section_names field_name]
looks sequentially into the sections specified by [section_names]
for a field named [field_name].
If no such field can be found in any section, the result is [false].
Otherwise, the search stops with the first field matching
one of the section names and the field name.
If the field has no associated value, the result is [true].
If the field value is ["true"] then [true] is returned.
Likewise, if the field value is ["false"] then [false] is returned.
If the field value is anything else, a [Failure] exception is raised.
Each section should be unique.
Given the following annotations in the ATD syntax noted [a]:
{v
<ocaml openin="false"> <ocaml_312 openin>
v}
We obtain the following results:
{v
# get_flag \["ocaml_312"; "ocaml"\] "openin" a;;
\- : true
# get_flag \["ocaml_311"; "ocaml"\] "openin" a;;
\- : false
# get_flag \["ocaml_312"\] "openin" a;;
\- : true
# get_flag \["ocaml_311"\] "openin" a;;
\- : false
# get_flag \["ocaml"\] "openin" a;;
\- : false
v}
*)
val get_field : (string -> 'a option) -> 'a -> string list -> string -> t -> 'a
(** [get_field parse default section_names field_name annotations]
looks sequentially into the sections specified by [section_names]
for a field named [field_name].
If no such field exists, the [default] value is returned.
If the field is present, the associated value is parsed using
the given function [parse] which should return [None]
in order to indicate an invalid value.
If the field is present without an associated value
or if [parse] returns [None], a [Failure] exception is raised.
Each section should be unique.
*)
val set_field : Atd_ast.loc -> string -> string -> string option -> t -> t
(** [set_field loc section_name field_name value annotations]
sets a field, reusing existing section [section_name]
if it exists, preserving the position of field [field_name]
and overwriting its value if it exists.
*)
val merge : t -> t
(** Merge sections of the same name together,
and keeps only the first occurrence of each
field.
{v
<a a1="x1"> <b> <a a2="x3" a1="x2">
v}
becomes
{v
<a a1="x1" a2="x3"> <b>
v}
*)
val create_id : unit -> string
(** Create a unique numeric ID *)
|