types.mli 4.75 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
val compare_const: const -> const -> int
val hash_const: const -> int
9
val equal_const: const -> const -> bool
10

11 12
(** Algebra **)

13 14
type node
type descr
15

16 17
val make: unit -> node
val define: node -> descr -> unit
18

19 20
val cons: descr -> node
val internalize: node -> node
21

22 23
val id: node -> int
val descr: node -> descr
24

25 26
val equal_descr: descr -> descr -> bool
val hash_descr: descr -> int
27
val compare_descr: descr -> descr -> int
28

29
module DescrHash: Hashtbl.S with type key = descr
30
module DescrSList: SortedList.S with type 'a elem = descr
31 32
module DescrMap: Map.S with type key = descr

33 34
(** Boolean connectives **)

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

42 43
val any_node : node

44 45
(** Constructors **)

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

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

58 59 60 61 62 63 64
(** Positive systems and least solutions **)

module Positive :
sig
  type v
  val forward: unit -> v
  val define: v -> v -> unit
65
  val ty: descr -> v
66 67
  val cup: v list -> v
  val times: v -> v -> v
68
  val xml: v -> v -> v
69

70
  val solve: v -> node
71 72 73 74 75
end

(** Normalization **)

module Product : sig
76
  val any : descr
77 78 79
  val any_xml : descr
  val other : ?kind:pair_kind -> descr -> descr
  val is_product : ?kind:pair_kind -> descr -> bool
80 81 82

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

  val need_second: t -> bool
    (* Is there more than a single rectangle ? *)
99 100 101
end

module Record : sig
102 103 104 105 106 107 108 109 110 111 112 113 114
  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 *)

115 116 117 118 119 120
  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


121 122 123 124
  val first_label: descr -> label

  val empty_cases: descr -> bool * bool

125 126
  val merge: descr -> descr -> descr
  val remove_field: descr -> label -> descr
127 128
end

129 130
module Arrow : sig
  val any : descr
131

132 133 134 135 136 137 138 139
  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.
    *)

140 141
  val check_iface: (descr * descr) list -> descr -> bool

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

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

  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
156 157 158
end


159
module Int : sig
160
  val has_int : descr -> Intervals.v -> bool
161

162 163 164 165 166 167 168
  val any : descr

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

169
module Atom : sig
170
  val has_atom : descr -> Atoms.v -> bool
171
  val get: descr -> Atoms.t
172 173
end

174
module Char : sig
175
  val has_char : descr -> Chars.v -> bool
176
  val any : descr
177
  val get: descr -> Chars.t
178 179
end

180
val normalize : descr -> descr
181

182
(** Subtyping and sample values **)
183

184 185 186
val is_empty : descr -> bool
val non_empty: descr -> bool
val subtype  : descr -> descr -> bool
187

188 189
module Sample :
sig
190
  type t 
191 192 193 194 195 196

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

  val print : Format.formatter -> t -> unit
199 200
end

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

209
val print_stat: Format.formatter -> unit