forked from
jonmsterling.com/ocaml-forester
ocaml
Add Base.mli to make docs more readable
authored by
Kento Okura
and committed by
Jon Sterling
33cbeb09
d0d1730e
+78
+78
lib/core/Base.mli
+78
lib/core/Base.mli
···
1
+
(*
2
+
* SPDX-FileCopyrightText: 2024 The Forester Project Contributors
3
+
*
4
+
* SPDX-License-Identifier: GPL-3.0-or-later
5
+
*)
6
+
7
+
(** {1 Base} *)
8
+
9
+
(** {2 IRIs} *)
10
+
11
+
type iri = Iri.t
12
+
val iri_t : Iri.t Repr.t
13
+
val pp_iri : Format.formatter -> Iri.t -> unit
14
+
module Iri_ord : sig type t = Iri.t val compare : Iri.t -> Iri.t -> int end
15
+
16
+
module Iri_hash :
17
+
sig
18
+
type t = Iri.t
19
+
val compare : Iri.t -> Iri.t -> int
20
+
val equal : Iri.t -> Iri.t -> bool
21
+
val hash : 'a -> int
22
+
end
23
+
24
+
module Iri_map : Map.S with type key = iri
25
+
26
+
(** {2 Delimiters} *)
27
+
28
+
type delim = Braces | Squares | Parens
29
+
val pp_delim :
30
+
Format.formatter -> delim -> unit
31
+
val show_delim : delim -> string
32
+
val delim_t : delim Repr.t
33
+
val delim_to_strings : delim -> string * string
34
+
35
+
(** {2 Variable binding} *)
36
+
37
+
type binding_strategy = Lazy | Strict
38
+
val pp_binding_strategy :
39
+
Format.formatter ->
40
+
binding_strategy ->
41
+
unit
42
+
val show_binding_strategy : binding_strategy -> string
43
+
val binding_strategy_t : binding_strategy Repr.t
44
+
type 'a binding = binding_strategy * 'a
45
+
val pp_binding :
46
+
(Format.formatter -> 'a -> unit) ->
47
+
Format.formatter ->
48
+
'a binding ->
49
+
unit
50
+
val show_binding :
51
+
(Format.formatter -> 'a -> unit) ->
52
+
'a binding ->
53
+
string
54
+
val binding_t : 'a Repr.t -> (binding_strategy * 'a) Repr.t
55
+
56
+
(** {2 Math modes} *)
57
+
58
+
type math_mode = Inline | Display
59
+
60
+
val pp_math_mode :
61
+
Format.formatter ->
62
+
math_mode ->
63
+
unit
64
+
65
+
val show_math_mode : math_mode -> string
66
+
67
+
val math_mode_t : math_mode Repr.t
68
+
69
+
(** {2 Import visibility} *)
70
+
71
+
type visibility = Private | Public
72
+
73
+
val pp_visibility :
74
+
Format.formatter ->
75
+
visibility ->
76
+
unit
77
+
val show_visibility : visibility -> string
78
+
val visibility_t : visibility Repr.t