theory.mli 5.86 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
(**************************************************************************)
(*                                                                        *)
(*  Copyright (C) 2010-                                                   *)
(*    Francois Bobot                                                      *)
(*    Jean-Christophe Filliatre                                           *)
(*    Johannes Kanig                                                      *)
(*    Andrei Paskevich                                                    *)
(*                                                                        *)
(*  This software is free software; you can redistribute it and/or        *)
(*  modify it under the terms of the GNU Library General Public           *)
(*  License version 2.1, with the special exception on linking            *)
(*  described in file LICENSE.                                            *)
(*                                                                        *)
(*  This software is distributed in the hope that it will be useful,      *)
(*  but WITHOUT ANY WARRANTY; without even the implied warranty of        *)
(*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *)
(*                                                                        *)
(**************************************************************************)

François Bobot's avatar
François Bobot committed
20 21
open Stdlib

MARCHE Claude's avatar
MARCHE Claude committed
22 23
(** Theories and Namespaces *)

24 25 26
open Ident
open Ty
open Term
27
open Decl
28 29

module Mnm : Map.S with type key = string
30
module Snm : Mnm.Set
31

32
type namespace = private {
33 34
  ns_ts : tysymbol Mnm.t;   (* type symbols *)
  ns_ls : lsymbol Mnm.t;    (* logic symbols *)
35
  ns_pr : prsymbol Mnm.t;   (* propositions *)
36 37 38
  ns_ns : namespace Mnm.t;  (* inner namespaces *)
}

39 40 41
val ns_find_ts : namespace -> string list -> tysymbol
val ns_find_ls : namespace -> string list -> lsymbol
val ns_find_pr : namespace -> string list -> prsymbol
42
val ns_find_ns : namespace -> string list -> namespace
43

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
(** Meta properties *)

type meta_arg_type =
  | MTtysymbol
  | MTlsymbol
  | MTprsymbol
  | MTstring
  | MTint

type meta_arg =
  | MAts  of tysymbol
  | MAls  of lsymbol
  | MApr  of prsymbol
  | MAstr of string
  | MAint of int

60 61 62 63 64 65
type meta = private {
  meta_name : string;
  meta_type : meta_arg_type list;
  meta_excl : bool;
  meta_tag  : int;
}
66

67
module Mmeta : Map.S with type key = meta
68
module Smeta : Mmeta.Set
69
module Hmeta : Hashtbl.S with type key = meta
70

71
val meta_equal : meta -> meta -> bool
Andrei Paskevich's avatar
Andrei Paskevich committed
72
val meta_hash : meta -> int
73 74 75

val register_meta      : string -> meta_arg_type list -> meta
val register_meta_excl : string -> meta_arg_type list -> meta
François Bobot's avatar
Api doc  
François Bobot committed
76 77
(** Register exclusive meta, each new setting remove the previous one.
Useful for transformation or printer parameters *)
78

79 80
val lookup_meta : string -> meta
val list_metas  : unit -> meta list
81

82
(** Theory *)
83

84
type theory = private {
85 86 87 88 89 90 91 92 93 94 95
  th_name   : ident;      (* theory name *)
  th_decls  : tdecl list; (* theory declarations *)
  th_export : namespace;  (* exported namespace *)
  th_known  : known_map;  (* known identifiers *)
  th_local  : Sid.t;      (* locally declared idents *)
  th_used   : Sid.t;      (* used theories *)
}

and tdecl = private {
  td_node : tdecl_node;
  td_tag  : int;
96
}
97

98
and tdecl_node = private
99 100
  | Decl  of decl
  | Use   of theory
101
  | Clone of theory * symbol_map
102
  | Meta  of meta * meta_arg list
103

104 105 106 107 108 109
and symbol_map = {
  sm_ts : tysymbol Mts.t;
  sm_ls : lsymbol Mls.t;
  sm_pr : prsymbol Mpr.t;
}

110
module Mtdecl : Map.S with type key = tdecl
111
module Stdecl : Mtdecl.Set
112
module Htdecl : Hashtbl.S with type key = tdecl
113

114
val td_equal : tdecl -> tdecl -> bool
Andrei Paskevich's avatar
Andrei Paskevich committed
115
val td_hash : tdecl -> int
116

117
(** Constructors and utilities *)
118

119
type theory_uc  (* a theory under construction *)
120

121 122
val create_theory : preid -> theory_uc
val close_theory  : theory_uc -> theory
123

124 125
val open_namespace  : theory_uc -> theory_uc
val close_namespace : theory_uc -> bool -> string option -> theory_uc
126

127
val get_namespace : theory_uc -> namespace
128 129 130
val get_known : theory_uc -> known_map

(** Declaration constructors *)
131

132 133 134
val create_decl : decl -> tdecl

val add_decl : theory_uc -> decl -> theory_uc
135 136 137 138 139 140

val add_ty_decl : theory_uc -> ty_decl list -> theory_uc
val add_logic_decl : theory_uc -> logic_decl list -> theory_uc
val add_ind_decl : theory_uc -> ind_decl list -> theory_uc
val add_prop_decl : theory_uc -> prop_kind -> prsymbol -> fmla -> theory_uc

141 142 143 144 145
(** Use *)

val create_use : theory -> tdecl
val use_export : theory_uc -> theory -> theory_uc

Andrei Paskevich's avatar
Andrei Paskevich committed
146
(** Clone *)
147 148

type th_inst = {
Francois Bobot's avatar
 
Francois Bobot committed
149
  inst_ts    : tysymbol Mts.t; (* old to new *)
150 151 152 153 154 155 156
  inst_ls    : lsymbol  Mls.t;
  inst_lemma : Spr.t;
  inst_goal  : Spr.t;
}

val empty_inst : th_inst

Andrei Paskevich's avatar
Andrei Paskevich committed
157 158 159 160 161 162
val create_inst :
  ts    : (tysymbol * tysymbol) list ->
  ls    : (lsymbol  * lsymbol)  list ->
  lemma : prsymbol list ->
  goal  : prsymbol list -> th_inst

163
val clone_theory : ('a -> tdecl -> 'a) -> 'a -> theory -> th_inst -> 'a
164 165 166

val create_clone : tdecl list -> theory -> th_inst -> tdecl list

167
val clone_export : theory_uc -> theory -> th_inst -> theory_uc
168 169 170

val create_null_clone : theory -> tdecl

171 172
val is_empty_sm : symbol_map -> bool

173 174
(** Meta *)

175
val create_meta : meta -> meta_arg list -> tdecl
176

177
val add_meta : theory_uc -> meta -> meta_arg list -> theory_uc
178 179 180 181 182 183 184 185 186 187

val clone_meta : tdecl -> theory -> tdecl -> tdecl
(* [clone_meta td_meta th td_clone] produces from [td_meta]
 * a new Meta tdecl instantiated with respect to [td_clone].
 * The [th] argument must be the same as in [td_clone]. *)

(** Base theories *)

val builtin_theory : theory

188 189
val highord_theory : theory

190
val tuple_theory : int -> theory
191

192 193
val tuple_theory_name : string -> int option

194
(* exceptions *)
195

196 197 198
exception NonLocal of ident
exception CannotInstantiate of ident
exception BadInstance of ident * ident
199

200 201 202
exception CloseTheory
exception NoOpenedNamespace
exception ClashSymbol of string
203

204
exception KnownMeta of meta
205
exception UnknownMeta of string
206 207
exception BadMetaArity of meta * int * int
exception MetaTypeMismatch of meta * meta_arg_type * meta_arg_type
208