summaryrefslogtreecommitdiff
path: root/lib/store.mli
blob: 8eab314ed7fda0862516114a558fc7baae7493b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
(***********************************************************************)
(*  v      *   The Coq Proof Assistant  /  The Coq Development Team    *)
(* <O___,, *        INRIA-Rocquencourt  &  LRI-CNRS-Orsay              *)
(*   \VV/  *************************************************************)
(*    //   *      This file is distributed under the terms of the      *)
(*         *       GNU Lesser General Public License Version 2.1       *)
(***********************************************************************)

(*** This module implements an "untyped store", in this particular case we
        see it as an extensible record whose fields are left unspecified. ***)

module type T =
sig
(** FIXME: Waiting for first-class modules... *)
end

module type S =
sig
  type t
  (** Type of stores *)

  type 'a field
  (** Type of field of such stores *)

  val empty : t
  (** Empty store *)

  val set : t -> 'a field -> 'a -> t
  (** Set a field *)

  val get : t -> 'a field -> 'a option
  (** Get the value of a field, if any *)

  val remove : t -> 'a field -> t
  (** Unset the value of the field *)

  val merge : t -> t -> t
  (** [merge s1 s2] adds all the fields of [s1] into [s2]. *)

  val field : unit -> 'a field
  (** Create a new field *)

end

module Make (M : T) : S
(** Create a new store type. *)