types.mli 4.67 KB
Newer Older
1 2
open Ident

3 4 5
type const = | Integer of Intervals.v
	     | Atom of Atoms.v 
	     | Char of Chars.v
6

7 8
(** Algebra **)

9 10
type node
type descr
11

12 13
val make: unit -> node
val define: node -> descr -> unit
14

15 16
val cons: descr -> node
val internalize: node -> node
17

18 19
val id: node -> int
val descr: node -> descr
20

21 22 23
val equal_descr: descr -> descr -> bool
val hash_descr: descr -> int

24
module DescrHash: Hashtbl.S with type key = descr
25 26 27 28
module DescrMap: Map.S with type key = descr

(* Note: it seems that even for non-functional data, DescrMap
is more efficient than DescrHash ... *)
29

30 31
(** Boolean connectives **)

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

39 40
val any_node : node

41 42
(** Constructors **)

43 44
type pair_kind = [ `Normal | `XML ]

45
val interval : Intervals.t -> descr
46
val atom     : Atoms.t -> descr
47
val times    : node -> node -> descr
48
val xml      : node -> node -> descr
49
val arrow    : node -> node -> descr
50
val record   : label -> node -> descr
51
val record'  : bool * node label_map -> descr
52
val char     : Chars.t -> descr
53
val constant : const -> descr
54

55 56 57 58 59 60 61
(** Positive systems and least solutions **)

module Positive :
sig
  type v
  val forward: unit -> v
  val define: v -> v -> unit
62
  val ty: descr -> v
63 64
  val cup: v list -> v
  val times: v -> v -> v
65
  val xml: v -> v -> v
66

67
  val solve: v -> node
68 69 70 71 72
end

(** Normalization **)

module Product : sig
73
  val any : descr
74 75 76
  val any_xml : descr
  val other : ?kind:pair_kind -> descr -> descr
  val is_product : ?kind:pair_kind -> descr -> bool
77 78 79

  (* List of non-empty rectangles *)
  type t = (descr * descr) list
80
  val is_empty: t -> bool
81
  val get: ?kind:pair_kind -> descr -> t
82 83
  val pi1: t -> descr
  val pi2: t -> descr
84
  val pi2_restricted: descr -> t -> descr
85 86 87 88 89 90 91
    
  (* 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
92
  val normal: ?kind:pair_kind -> descr -> normal
93 94 95

  val need_second: t -> bool
    (* Is there more than a single rectangle ? *)
96 97 98
end

module Record : sig
99 100 101 102 103 104 105 106 107 108 109 110 111
  val any : descr
  val or_absent: descr -> descr
  val any_or_absent: descr

  val has_absent: descr -> bool
  val has_record: descr -> bool

  val split : descr -> label -> Product.t
  val split_normal : descr -> label -> Product.normal

  val project : descr -> label -> descr
    (* Raise Not_found if label is not necessarily present *)

112 113 114 115 116 117
  val condition : descr -> label -> descr -> descr
    (* condition t1 l t2 : What must follow if field l hash type t2 *)
  val project_opt : descr -> label -> descr
  val has_empty_record: descr -> bool


118 119 120 121
  val first_label: descr -> label

  val empty_cases: descr -> bool * bool

122 123
  val merge: descr -> descr -> descr
  val remove_field: descr -> label -> descr
124 125
end

126 127
module Arrow : sig
  val any : descr
128

129 130 131 132 133 134 135 136
  val check_strenghten: descr -> descr -> descr
    (* [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.
    *)

137 138
  val check_iface: (descr * descr) list -> descr -> bool

139
  type t
140
  val is_empty: t -> bool
141 142
  val get: descr -> t
    (* Always succeed; no check <= Arrow.any *)
143

144 145 146
  val domain: t -> descr
  val apply: t -> descr -> descr
    (* Always succeed; no check on the domain *)
147 148 149 150 151 152

  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
153 154 155
end


156
module Int : sig
157
  val has_int : descr -> Intervals.v -> bool
158

159 160 161 162 163 164 165
  val any : descr

  val is_int : descr -> bool
  val get: descr -> Intervals.t
  val put: Intervals.t -> descr
end

166
module Atom : sig
167
  val has_atom : descr -> Atoms.v -> bool
168
  val get: descr -> Atoms.t
169 170
end

171
module Char : sig
172
  val has_char : descr -> Chars.v -> bool
173
  val any : descr
174
  val get: descr -> Chars.t
175 176
end

177
val normalize : descr -> descr
178

179
(** Subtyping and sample values **)
180

181 182 183
val is_empty : descr -> bool
val non_empty: descr -> bool
val subtype  : descr -> descr -> bool
184

185 186
module Sample :
sig
187
  type t 
188 189 190 191 192 193

  val get : descr -> t
	(** 
	  Extract a sample value from a non empty type;
	  raise Not_found for an empty type
	**)
194 195

  val print : Format.formatter -> t -> unit
196 197
end

198 199
module Print :
sig
200
  val register_global : string -> descr -> unit
201
  val print_const : Format.formatter -> const -> unit
202 203
  val print : Format.formatter -> node -> unit
  val print_descr: Format.formatter -> descr -> unit
204
end
205

206
val check: descr -> unit
207
val print_stat: Format.formatter -> unit