types.mli 5.04 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 14
val compare_const: const -> const -> int
val hash_const: const -> int
15
val equal_const: const -> const -> bool
16

17 18
(** Algebra **)

19 20 21
include Custom.T
module Node : Custom.T
type descr = t
22

23 24
val make: unit -> Node.t
val define: Node.t -> t -> unit
25

26 27
val cons: t -> Node.t
val internalize: Node.t -> Node.t
28

29 30
val id: Node.t -> int
val descr: Node.t -> t
31

32 33
(** Boolean connectives **)

34 35 36 37 38 39
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
40

41
val any_node : Node.t
42

43
val non_constructed : t
44

45 46
(** Constructors **)

47 48
type pair_kind = [ `Normal | `XML ]

49 50 51 52 53 54
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
55
  (* bool = true -> open record; bool = false -> closed record *)
56 57 58
val record'  : bool * Node.t label_map -> t
val char     : Chars.t -> t
val constant : const -> t
59

60 61 62
(** Helpers *)

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

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

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

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

77 78
val empty_closed_record: t
val empty_opened_record: t
79

80 81 82 83 84 85 86
(** Positive systems and least solutions **)

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

92
  val solve: v -> Node.t
93 94 95 96 97
end

(** Normalization **)

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

  (* List of non-empty rectangles *)
  type t = (descr * descr) list
105
  val is_empty: t -> bool
106
  val get: ?kind:pair_kind -> descr -> t
107 108
  val pi1: t -> descr
  val pi2: t -> descr
109
  val pi2_restricted: descr -> t -> descr
110 111 112 113 114 115 116
    
  (* 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
117
  val normal: ?kind:pair_kind -> descr -> normal
118

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

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

module Record : sig
128 129 130
  val any : t
  val or_absent: t -> t
  val any_or_absent: t
131

132 133
  val has_absent: t -> bool
  val has_record: t -> bool
134

135 136
  val split : t -> label -> Product.t
  val split_normal : t -> label -> Product.normal
137

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

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


147
  val first_label: t -> label
148

149
  val empty_cases: t -> bool * bool
150

151 152
  val merge: t -> t -> t
  val remove_field: t -> label -> t
153

154
  val get: t -> ((bool * t) label_map * bool * bool) list
155 156
end

157
module Arrow : sig
158
  val any : t
159

160
  val sample: t -> t
161

162
  val check_strenghten: t -> t -> t
163 164 165 166 167 168 169
    (* [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.
    *)

170
  val check_iface: (t * t) list -> t -> bool
171

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

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

  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
186 187 188
end


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

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

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

208
val normalize : t -> t
209

210
(** Subtyping  **)
211

212 213 214
val is_empty : t -> bool
val non_empty: t -> bool
val subtype  : t -> t -> bool
215

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