types.mli 4.98 KB
Newer Older
1 2
open Ident

3 4 5 6 7 8 9 10 11
type const = 
  | Integer of Intervals.V.t
  | Atom of Atoms.V.t 
  | Char of Chars.V.t
  | Pair of const * const
  | Xml of const * const
  | Record of const label_map
  | String of U.uindex * U.uindex * U.t * const

12

13
module Const: Custom.T with type t = const
14

15 16
(** Algebra **)

17 18 19
include Custom.T
module Node : Custom.T
type descr = t
20

21 22
val make: unit -> Node.t
val define: Node.t -> t -> unit
23

24 25
val cons: t -> Node.t
val internalize: Node.t -> Node.t
26

27 28
val id: Node.t -> int
val descr: Node.t -> t
29

30 31
(** Boolean connectives **)

32 33 34 35 36 37
val cup    : t -> t -> t
val cap    : t -> t -> t
val diff   : t -> t -> t
val neg    : t -> t
val empty  : t
val any    : t
38

39
val any_node : Node.t
40

41
val non_constructed : t
42

43 44
(** Constructors **)

45 46
type pair_kind = [ `Normal | `XML ]

47 48 49 50 51 52
val interval : Intervals.t -> t
val atom     : Atoms.t -> t
val times    : Node.t -> Node.t -> t
val xml      : Node.t -> Node.t -> t
val arrow    : Node.t -> Node.t -> t
val record   : label -> Node.t -> t
53
  (* bool = true -> open record; bool = false -> closed record *)
54 55 56
val record'  : bool * Node.t label_map -> t
val char     : Chars.t -> t
val constant : const -> t
57

58 59 60
(** Helpers *)

  (** given a list of descrs create an OR type including all descrs *)
61
val choice_of_list: t list -> t
62 63 64

  (** do it yourself: create an Xml type from three types (tag type, attribute
  type, content type) *)
65
val xml': t -> t -> t -> t
66

67
  (** Build a record from a list of <name,t> pairs. Open defaults to true.
68
  All specified fields are required. *)
69
val rec_of_list: ?opened:bool -> (string * t) list -> t
70 71 72

  (** Similiar to rec_of_list, the additional boolean value specify whether the
  specified field is optional (true) or not (false. *)
73
val rec_of_list': ?opened:bool -> (bool * string * t) list -> t
74

75 76
val empty_closed_record: t
val empty_opened_record: t
77

78 79 80 81 82 83 84
(** Positive systems and least solutions **)

module Positive :
sig
  type v
  val forward: unit -> v
  val define: v -> v -> unit
85
  val ty: t -> v
86 87
  val cup: v list -> v
  val times: v -> v -> v
88
  val xml: v -> v -> v
89

90
  val solve: v -> Node.t
91 92 93 94 95
end

(** Normalization **)

module Product : sig
96 97 98 99
  val any : t
  val any_xml : t
  val other : ?kind:pair_kind -> t -> t
  val is_product : ?kind:pair_kind -> t -> bool
100 101 102

  (* List of non-empty rectangles *)
  type t = (descr * descr) list
103
  val is_empty: t -> bool
104
  val get: ?kind:pair_kind -> descr -> t
105 106
  val pi1: t -> descr
  val pi2: t -> descr
107
  val pi2_restricted: descr -> t -> descr
108 109 110 111 112 113 114
    
  (* Intersection with (pi1,Any) *)
  val restrict_1: t -> descr -> t

  (* List of non-empty rectangles whose first projection
     are pair-wise disjunct *)
  type normal = t
115
  val normal: ?kind:pair_kind -> descr -> normal
116

117 118 119 120
  val constraint_on_2: normal -> descr -> descr
    (* constraint_on_2 n t1:  maximal t2 such that (t1,t2) <= n *)
    (* Assumption: t1 <= pi1(n) *)

121 122
  val need_second: t -> bool
    (* Is there more than a single rectangle ? *)
123 124 125
end

module Record : sig
126 127 128
  val any : t
  val or_absent: t -> t
  val any_or_absent: t
129

130 131
  val has_absent: t -> bool
  val has_record: t -> bool
132

133 134
  val split : t -> label -> Product.t
  val split_normal : t -> label -> Product.normal
135

136
  val project : t -> label -> t
137 138
    (* Raise Not_found if label is not necessarily present *)

139
  val condition : t -> label -> t -> t
140
    (* condition t1 l t2 : What must follow if field l hash type t2 *)
141 142
  val project_opt : t -> label -> t
  val has_empty_record: t -> bool
143 144


145
  val first_label: t -> label
146

147
  val empty_cases: t -> bool * bool
148

149 150
  val merge: t -> t -> t
  val remove_field: t -> label -> t
151

152
  val get: t -> ((bool * t) label_map * bool * bool) list
153 154
end

155
module Arrow : sig
156
  val any : t
157

158
  val sample: t -> t
159

160
  val check_strenghten: t -> t -> t
161 162 163 164 165 166 167
    (* [check_strenghten t s]
       Assume that [t] is an intersection of arrow types
       representing the interface of an abstraction;
       check that this abstraction has type [s] (otherwise raise Not_found)
       and returns a refined type for this abstraction.
    *)

168
  val check_iface: (t * t) list -> t -> bool
169

170
  type t
171
  val is_empty: t -> bool
172 173
  val get: descr -> t
    (* Always succeed; no check <= Arrow.any *)
174

175 176 177
  val domain: t -> descr
  val apply: t -> descr -> descr
    (* Always succeed; no check on the domain *)
178 179 180 181 182 183

  val need_arg : t -> bool
    (* True if the type of the argument is needed to obtain
       the type of the result (must use [apply]; otherwise,
       [apply_noarg] is enough *)
  val apply_noarg : t -> descr
184 185 186
end


187
module Int : sig
188
  val has_int : t -> Intervals.V.t -> bool
189 190
  val get: t -> Intervals.t
  val any : t
191 192
end

193
module Atom : sig
194
  val has_atom : t -> Atoms.V.t -> bool
195 196
  val get: t -> Atoms.t
  val any : t
197 198
end

199
module Char : sig
200
  val has_char : t -> Chars.V.t -> bool
201 202 203
  val is_empty : t -> bool
  val get: t -> Chars.t
  val any : t
204 205
end

206
val normalize : t -> t
207

208
(** Subtyping  **)
209

210 211 212
val is_empty : t -> bool
val non_empty: t -> bool
val subtype  : t -> t -> bool
213

214 215
module Print :
sig
216
  val register_global : U.t -> t -> unit
217
  val print_const : Format.formatter -> const -> unit
218
  val print: Format.formatter -> t -> unit
219
end
220