1(*  Title:      Pure/sign.ML
2    Author:     Lawrence C Paulson and Markus Wenzel
3
4Logical signature content: naming conventions, concrete syntax, type
5signature, polymorphic constants.
6*)
7
8signature SIGN =
9sig
10  val change_begin: theory -> theory
11  val change_end: theory -> theory
12  val change_end_local: Proof.context -> Proof.context
13  val change_check: theory -> theory
14  val syn_of: theory -> Syntax.syntax
15  val tsig_of: theory -> Type.tsig
16  val classes_of: theory -> Sorts.algebra
17  val all_classes: theory -> class list
18  val super_classes: theory -> class -> class list
19  val minimize_sort: theory -> sort -> sort
20  val complete_sort: theory -> sort -> sort
21  val set_defsort: sort -> theory -> theory
22  val defaultS: theory -> sort
23  val subsort: theory -> sort * sort -> bool
24  val of_sort: theory -> typ * sort -> bool
25  val inter_sort: theory -> sort * sort -> sort
26  val witness_sorts: theory -> (typ * sort) list -> sort list -> (typ * sort) list
27  val logical_types: theory -> string list
28  val typ_instance: theory -> typ * typ -> bool
29  val typ_equiv: theory -> typ * typ -> bool
30  val typ_match: theory -> typ * typ -> Type.tyenv -> Type.tyenv
31  val typ_unify: theory -> typ * typ -> Type.tyenv * int -> Type.tyenv * int
32  val consts_of: theory -> Consts.T
33  val the_const_constraint: theory -> string -> typ
34  val const_type: theory -> string -> typ option
35  val the_const_type: theory -> string -> typ
36  val declared_tyname: theory -> string -> bool
37  val declared_const: theory -> string -> bool
38  val naming_of: theory -> Name_Space.naming
39  val map_naming: (Name_Space.naming -> Name_Space.naming) -> theory -> theory
40  val restore_naming: theory -> theory -> theory
41  val inherit_naming: theory -> Proof.context -> Context.generic
42  val full_name: theory -> binding -> string
43  val full_name_path: theory -> string -> binding -> string
44  val full_bname: theory -> bstring -> string
45  val full_bname_path: theory -> string -> bstring -> string
46  val const_monomorphic: theory -> string -> bool
47  val const_typargs: theory -> string * typ -> typ list
48  val const_instance: theory -> string * typ list -> typ
49  val mk_const: theory -> string * typ list -> term
50  val class_space: theory -> Name_Space.T
51  val type_space: theory -> Name_Space.T
52  val const_space: theory -> Name_Space.T
53  val intern_class: theory -> xstring -> string
54  val intern_type: theory -> xstring -> string
55  val intern_const: theory -> xstring -> string
56  val type_alias: binding -> string -> theory -> theory
57  val const_alias: binding -> string -> theory -> theory
58  val arity_number: theory -> string -> int
59  val arity_sorts: theory -> string -> sort -> sort list
60  val certify_class: theory -> class -> class
61  val certify_sort: theory -> sort -> sort
62  val certify_typ: theory -> typ -> typ
63  val certify_typ_mode: Type.mode -> theory -> typ -> typ
64  val certify': bool -> Context.generic -> bool -> Consts.T -> theory -> term -> term * typ * int
65  val certify_term: theory -> term -> term * typ * int
66  val cert_term: theory -> term -> term
67  val cert_prop: theory -> term -> term
68  val no_frees: Proof.context -> term -> term
69  val no_vars: Proof.context -> term -> term
70  val add_type: Proof.context -> binding * int * mixfix -> theory -> theory
71  val add_types_global: (binding * int * mixfix) list -> theory -> theory
72  val add_nonterminals: Proof.context -> binding list -> theory -> theory
73  val add_nonterminals_global: binding list -> theory -> theory
74  val add_type_abbrev: Proof.context -> binding * string list * typ -> theory -> theory
75  val add_syntax: Syntax.mode -> (string * typ * mixfix) list -> theory -> theory
76  val add_syntax_cmd: Syntax.mode -> (string * string * mixfix) list -> theory -> theory
77  val del_syntax: Syntax.mode -> (string * typ * mixfix) list -> theory -> theory
78  val del_syntax_cmd: Syntax.mode -> (string * string * mixfix) list -> theory -> theory
79  val type_notation: bool -> Syntax.mode -> (typ * mixfix) list -> theory -> theory
80  val notation: bool -> Syntax.mode -> (term * mixfix) list -> theory -> theory
81  val declare_const: Proof.context -> (binding * typ) * mixfix -> theory -> term * theory
82  val declare_const_global: (binding * typ) * mixfix -> theory -> term * theory
83  val add_consts: (binding * typ * mixfix) list -> theory -> theory
84  val add_consts_cmd: (binding * string * mixfix) list -> theory -> theory
85  val add_abbrev: string -> binding * term -> theory -> (term * term) * theory
86  val revert_abbrev: string -> string -> theory -> theory
87  val add_const_constraint: string * typ option -> theory -> theory
88  val primitive_class: binding * class list -> theory -> theory
89  val primitive_classrel: class * class -> theory -> theory
90  val primitive_arity: arity -> theory -> theory
91  val parse_ast_translation:
92    (string * (Proof.context -> Ast.ast list -> Ast.ast)) list -> theory -> theory
93  val parse_translation:
94    (string * (Proof.context -> term list -> term)) list -> theory -> theory
95  val print_translation:
96    (string * (Proof.context -> term list -> term)) list -> theory -> theory
97  val typed_print_translation:
98    (string * (Proof.context -> typ -> term list -> term)) list -> theory -> theory
99  val print_ast_translation:
100    (string * (Proof.context -> Ast.ast list -> Ast.ast)) list -> theory -> theory
101  val add_trrules: Ast.ast Syntax.trrule list -> theory -> theory
102  val del_trrules: Ast.ast Syntax.trrule list -> theory -> theory
103  val get_scope: theory -> Binding.scope option
104  val new_scope: theory -> Binding.scope * theory
105  val new_group: theory -> theory
106  val reset_group: theory -> theory
107  val add_path: string -> theory -> theory
108  val root_path: theory -> theory
109  val parent_path: theory -> theory
110  val mandatory_path: string -> theory -> theory
111  val qualified_path: bool -> binding -> theory -> theory
112  val local_path: theory -> theory
113  val theory_naming: theory -> theory
114  val private_scope: Binding.scope -> theory -> theory
115  val private: Position.T -> theory -> theory
116  val qualified_scope: Binding.scope -> theory -> theory
117  val qualified: Position.T -> theory -> theory
118  val concealed: theory -> theory
119  val hide_class: bool -> string -> theory -> theory
120  val hide_type: bool -> string -> theory -> theory
121  val hide_const: bool -> string -> theory -> theory
122end
123
124structure Sign: SIGN =
125struct
126
127(** datatype sign **)
128
129datatype sign = Sign of
130 {syn: Syntax.syntax,           (*concrete syntax for terms, types, sorts*)
131  tsig: Type.tsig,              (*order-sorted signature of types*)
132  consts: Consts.T};            (*polymorphic constants*)
133
134fun make_sign (syn, tsig, consts) = Sign {syn = syn, tsig = tsig, consts = consts};
135
136structure Data = Theory_Data'
137(
138  type T = sign;
139  fun extend (Sign {syn, tsig, consts, ...}) = make_sign (syn, tsig, consts);
140
141  val empty = make_sign (Syntax.empty_syntax, Type.empty_tsig, Consts.empty);
142
143  fun merge old_thys (sign1, sign2) =
144    let
145      val Sign {syn = syn1, tsig = tsig1, consts = consts1} = sign1;
146      val Sign {syn = syn2, tsig = tsig2, consts = consts2} = sign2;
147
148      val syn = Syntax.merge_syntax (syn1, syn2);
149      val tsig = Type.merge_tsig (Context.Theory (fst old_thys)) (tsig1, tsig2);
150      val consts = Consts.merge (consts1, consts2);
151    in make_sign (syn, tsig, consts) end;
152);
153
154fun rep_sg thy = Data.get thy |> (fn Sign args => args);
155
156fun map_sign f = Data.map (fn Sign {syn, tsig, consts} => make_sign (f (syn, tsig, consts)));
157
158fun map_syn f = map_sign (fn (syn, tsig, consts) => (f syn, tsig, consts));
159fun map_tsig f = map_sign (fn (syn, tsig, consts) => (syn, f tsig, consts));
160fun map_consts f = map_sign (fn (syn, tsig, consts) => (syn, tsig, f consts));
161
162
163(* linear change discipline *)
164
165fun change_base begin = map_sign (fn (syn, tsig, consts) =>
166  (syn, Type.change_base begin tsig, Consts.change_base begin consts));
167
168val change_begin = change_base true;
169val change_end = change_base false;
170
171fun change_end_local ctxt =
172  Context.raw_transfer (change_end (Proof_Context.theory_of ctxt)) ctxt;
173
174fun change_check thy =
175  if can change_end thy
176  then raise Fail "Unfinished linear change of theory content" else thy;
177
178
179(* syntax *)
180
181val syn_of = #syn o rep_sg;
182
183
184(* type signature *)
185
186val tsig_of = #tsig o rep_sg;
187
188val classes_of = #2 o #classes o Type.rep_tsig o tsig_of;
189val all_classes = Sorts.all_classes o classes_of;
190val super_classes = Sorts.super_classes o classes_of;
191val minimize_sort = Sorts.minimize_sort o classes_of;
192val complete_sort = Sorts.complete_sort o classes_of;
193
194val set_defsort = map_tsig o Type.set_defsort;
195val defaultS = Type.defaultS o tsig_of;
196val subsort = Type.subsort o tsig_of;
197val of_sort = Type.of_sort o tsig_of;
198val inter_sort = Type.inter_sort o tsig_of;
199val witness_sorts = Type.witness_sorts o tsig_of;
200val logical_types = Type.logical_types o tsig_of;
201
202val typ_instance = Type.typ_instance o tsig_of;
203fun typ_equiv thy (T, U) = typ_instance thy (T, U) andalso typ_instance thy (U, T);
204val typ_match = Type.typ_match o tsig_of;
205val typ_unify = Type.unify o tsig_of;
206
207
208(* polymorphic constants *)
209
210val consts_of = #consts o rep_sg;
211val the_const_constraint = Consts.the_constraint o consts_of;
212val the_const_type = #2 oo (Consts.the_const o consts_of);
213val const_type = try o the_const_type;
214val const_monomorphic = Consts.is_monomorphic o consts_of;
215val const_typargs = Consts.typargs o consts_of;
216val const_instance = Consts.instance o consts_of;
217
218fun mk_const thy (c, Ts) = Const (c, const_instance thy (c, Ts));
219
220fun declared_tyname ctxt c = can (Type.the_decl (tsig_of ctxt)) (c, Position.none);
221val declared_const = can o the_const_constraint;
222
223
224(* naming *)
225
226val naming_of = Name_Space.naming_of o Context.Theory;
227val map_naming = Context.theory_map o Name_Space.map_naming;
228val restore_naming = map_naming o K o naming_of;
229fun inherit_naming thy = Name_Space.map_naming (K (naming_of thy)) o Context.Proof;
230
231val full_name = Name_Space.full_name o naming_of;
232fun full_name_path thy path = Name_Space.full_name (Name_Space.add_path path (naming_of thy));
233
234fun full_bname thy = Name_Space.full_name (naming_of thy) o Binding.name;
235fun full_bname_path thy path = full_name_path thy path o Binding.name;
236
237
238
239(** name spaces **)
240
241val class_space = Type.class_space o tsig_of;
242val type_space = Type.type_space o tsig_of;
243val const_space = Consts.space_of o consts_of;
244
245val intern_class = Name_Space.intern o class_space;
246val intern_type = Name_Space.intern o type_space;
247val intern_const = Name_Space.intern o const_space;
248
249fun type_alias b c thy = map_tsig (Type.type_alias (naming_of thy) b c) thy;
250fun const_alias b c thy = map_consts (Consts.alias (naming_of thy) b c) thy;
251
252
253
254(** certify entities **)    (*exception TYPE*)
255
256(* certify wrt. type signature *)
257
258val arity_number = Type.arity_number o tsig_of;
259fun arity_sorts thy = Type.arity_sorts (Context.Theory thy) (tsig_of thy);
260
261val certify_class = Type.cert_class o tsig_of;
262val certify_sort = Type.cert_sort o tsig_of;
263val certify_typ = Type.cert_typ o tsig_of;
264fun certify_typ_mode mode = Type.cert_typ_mode mode o tsig_of;
265
266
267(* certify term/prop *)
268
269local
270
271fun type_check context tm =
272  let
273    fun err_appl bs t T u U =
274      let
275        val xs = map Free bs;           (*we do not rename here*)
276        val t' = subst_bounds (xs, t);
277        val u' = subst_bounds (xs, u);
278        val msg = Type.appl_error (Syntax.init_pretty context) t' T u' U;
279      in raise TYPE (msg, [T, U], [t', u']) end;
280
281    fun typ_of (_, Const (_, T)) = T
282      | typ_of (_, Free  (_, T)) = T
283      | typ_of (_, Var (_, T)) = T
284      | typ_of (bs, Bound i) = snd (nth bs i handle General.Subscript =>
285          raise TYPE ("Loose bound variable: B." ^ string_of_int i, [], [Bound i]))
286      | typ_of (bs, Abs (x, T, body)) = T --> typ_of ((x, T) :: bs, body)
287      | typ_of (bs, t $ u) =
288          let val T = typ_of (bs, t) and U = typ_of (bs, u) in
289            (case T of
290              Type ("fun", [T1, T2]) =>
291                if T1 = U then T2 else err_appl bs t T u U
292            | _ => err_appl bs t T u U)
293          end;
294  in typ_of ([], tm) end;
295
296fun err msg = raise TYPE (msg, [], []);
297
298fun check_vars (t $ u) = (check_vars t; check_vars u)
299  | check_vars (Abs (_, _, t)) = check_vars t
300  | check_vars (Free (x, _)) =
301      if Long_Name.is_qualified x then err ("Malformed variable: " ^ quote x) else ()
302  | check_vars (Var (xi as (_, i), _)) =
303      if i < 0 then err ("Malformed variable: " ^ quote (Term.string_of_vname xi)) else ()
304  | check_vars _ = ();
305
306in
307
308fun certify' prop context do_expand consts thy tm =
309  let
310    val _ = check_vars tm;
311    val tm' = Term.map_types (certify_typ thy) tm;
312    val T = type_check context tm';
313    val _ = if prop andalso T <> propT then err "Term not of type prop" else ();
314    val tm'' = tm'
315      |> Consts.certify context (tsig_of thy) do_expand consts
316      |> Soft_Type_System.global_purge thy;
317  in (if tm = tm'' then tm else tm'', T, Term.maxidx_of_term tm'') end;
318
319fun certify_term thy = certify' false (Context.Theory thy) true (consts_of thy) thy;
320fun cert_term_abbrev thy = #1 o certify' false (Context.Theory thy) false (consts_of thy) thy;
321val cert_term = #1 oo certify_term;
322fun cert_prop thy = #1 o certify' true (Context.Theory thy) true (consts_of thy) thy;
323
324end;
325
326
327(* specifications *)
328
329fun no_variables kind add addT mk mkT ctxt tm =
330  (case (add tm [], addT tm []) of
331    ([], []) => tm
332  | (frees, tfrees) => error (Pretty.string_of (Pretty.block
333      (Pretty.str ("Illegal " ^ kind ^ " variable(s) in term:") :: Pretty.brk 1 ::
334       Pretty.commas
335        (map (Syntax.pretty_term ctxt o mk) frees @ map (Syntax.pretty_typ ctxt o mkT) tfrees)))));
336
337val no_frees = no_variables "free" Term.add_frees Term.add_tfrees Free TFree;
338val no_vars = no_variables "schematic" Term.add_vars Term.add_tvars Var TVar;
339
340
341
342(** signature extension functions **)  (*exception ERROR/TYPE*)
343
344(* add type constructors *)
345
346fun add_type ctxt (b, n, mx) thy = thy |> map_sign (fn (syn, tsig, consts) =>
347  let
348    val type_syntax = (Lexicon.mark_type (full_name thy b), Mixfix.make_type n, mx);
349    val syn' = Syntax.update_type_gram true Syntax.mode_default [type_syntax] syn;
350    val tsig' = Type.add_type (inherit_naming thy ctxt) (b, n) tsig;
351  in (syn', tsig', consts) end);
352
353fun add_types_global types thy =
354  fold (add_type (Syntax.init_pretty_global thy)) types thy;
355
356
357(* add nonterminals *)
358
359fun add_nonterminals ctxt ns thy = thy |> map_sign (fn (syn, tsig, consts) =>
360  (syn, fold (Type.add_nonterminal (inherit_naming thy ctxt)) ns tsig, consts));
361
362fun add_nonterminals_global ns thy =
363  add_nonterminals (Syntax.init_pretty_global thy) ns thy;
364
365
366(* add type abbreviations *)
367
368fun add_type_abbrev ctxt abbr thy = thy |> map_sign (fn (syn, tsig, consts) =>
369  (syn, Type.add_abbrev (inherit_naming thy ctxt) abbr tsig, consts));
370
371
372(* modify syntax *)
373
374fun gen_syntax change_gram parse_typ mode args thy =
375  let
376    val ctxt = Type.set_mode Type.mode_syntax (Proof_Context.init_global thy);
377    fun prep (c, T, mx) = (c, certify_typ_mode Type.mode_syntax thy (parse_typ ctxt T), mx)
378      handle ERROR msg => cat_error msg ("in syntax declaration " ^ quote c);
379  in thy |> map_syn (change_gram (logical_types thy) mode (map prep args)) end;
380
381fun gen_add_syntax x = gen_syntax (Syntax.update_const_gram true) x;
382
383val add_syntax = gen_add_syntax (K I);
384val add_syntax_cmd = gen_add_syntax Syntax.read_typ;
385val del_syntax = gen_syntax (Syntax.update_const_gram false) (K I);
386val del_syntax_cmd = gen_syntax (Syntax.update_const_gram false) Syntax.read_typ;
387
388fun type_notation add mode args =
389  let
390    fun type_syntax (Type (c, args), mx) =
391          SOME (Lexicon.mark_type c, Mixfix.make_type (length args), mx)
392      | type_syntax _ = NONE;
393  in map_syn (Syntax.update_type_gram add mode (map_filter type_syntax args)) end;
394
395fun notation add mode args thy =
396  let
397    fun const_syntax (Const (c, _), mx) =
398          (case try (Consts.type_scheme (consts_of thy)) c of
399            SOME T => SOME (Lexicon.mark_const c, T, mx)
400          | NONE => NONE)
401      | const_syntax _ = NONE;
402  in gen_syntax (Syntax.update_const_gram add) (K I) mode (map_filter const_syntax args) thy end;
403
404
405(* add constants *)
406
407local
408
409fun gen_add_consts prep_typ ctxt raw_args thy =
410  let
411    val prepT = Type.no_tvars o Term.no_dummyT o certify_typ thy o prep_typ ctxt;
412    fun prep (b, raw_T, mx) =
413      let
414        val c = full_name thy b;
415        val T = (prepT raw_T handle TYPE (msg, _, _) => error msg) handle ERROR msg =>
416          cat_error msg ("in declaration of constant " ^ Binding.print b);
417        val T' = Logic.varifyT_global T;
418      in ((b, T'), (Lexicon.mark_const c, T', mx), Const (c, T)) end;
419    val args = map prep raw_args;
420  in
421    thy
422    |> map_consts (fold (Consts.declare (inherit_naming thy ctxt) o #1) args)
423    |> add_syntax Syntax.mode_default (map #2 args)
424    |> pair (map #3 args)
425  end;
426
427in
428
429fun add_consts args thy =
430  #2 (gen_add_consts (K I) (Proof_Context.init_global thy) args thy);
431
432fun add_consts_cmd args thy =
433  #2 (gen_add_consts Syntax.read_typ (Proof_Context.init_global thy) args thy);
434
435fun declare_const ctxt ((b, T), mx) = yield_singleton (gen_add_consts (K I) ctxt) (b, T, mx);
436fun declare_const_global arg thy = declare_const (Proof_Context.init_global thy) arg thy;
437
438end;
439
440
441(* abbreviations *)
442
443fun add_abbrev mode (b, raw_t) thy =  (* FIXME proper ctxt (?) *)
444  let
445    val ctxt = Syntax.init_pretty_global thy;
446    val prep_tm = no_frees ctxt o Term.no_dummy_patterns o cert_term_abbrev thy;
447    val t = (prep_tm raw_t handle TYPE (msg, _, _) => error msg | TERM (msg, _) => error msg)
448      handle ERROR msg => cat_error msg ("in constant abbreviation " ^ Binding.print b);
449    val (res, consts') = consts_of thy
450      |> Consts.abbreviate (inherit_naming thy ctxt) (tsig_of thy) mode (b, t);
451  in (res, thy |> map_consts (K consts')) end;
452
453fun revert_abbrev mode c = map_consts (Consts.revert_abbrev mode c);
454
455
456(* add constraints *)
457
458fun add_const_constraint (c, opt_T) thy =
459  let
460    fun prepT raw_T =
461      let val T = Logic.varifyT_global (Type.no_tvars (Term.no_dummyT (certify_typ thy raw_T)))
462      in cert_term thy (Const (c, T)); T end
463      handle TYPE (msg, _, _) => error msg;
464  in thy |> map_consts (Consts.constrain (c, Option.map prepT opt_T)) end;
465
466
467(* primitive classes and arities *)
468
469fun primitive_class (bclass, classes) thy =
470  thy
471  |> map_sign (fn (syn, tsig, consts) =>
472      let val tsig' = Type.add_class (Context.Theory thy) (bclass, classes) tsig;
473      in (syn, tsig', consts) end)
474  |> add_consts [(Binding.map_name Logic.const_of_class bclass, Term.a_itselfT --> propT, NoSyn)];
475
476fun primitive_classrel arg thy =
477  thy |> map_tsig (Type.add_classrel (Context.Theory thy) arg);
478
479fun primitive_arity arg thy =
480  thy |> map_tsig (Type.add_arity (Context.Theory thy) arg);
481
482
483(* add translation functions *)
484
485local
486
487fun mk trs = map Syntax_Ext.mk_trfun trs;
488
489in
490
491fun parse_ast_translation atrs = map_syn (Syntax.update_trfuns (mk atrs, [], [], []));
492fun parse_translation trs = map_syn (Syntax.update_trfuns ([], mk trs, [], []));
493fun print_translation tr's =
494  map_syn (Syntax.update_trfuns ([], [], mk (map (apsnd Syntax_Trans.non_typed_tr') tr's), []));
495fun typed_print_translation tr's = map_syn (Syntax.update_trfuns ([], [], mk tr's, []));
496fun print_ast_translation atr's = map_syn (Syntax.update_trfuns ([], [], [], mk atr's));
497
498end;
499
500
501(* translation rules *)
502
503val add_trrules = map_syn o Syntax.update_trrules;
504val del_trrules = map_syn o Syntax.remove_trrules;
505
506
507(* naming *)
508
509val get_scope = Name_Space.get_scope o naming_of;
510
511fun new_scope thy =
512  let
513    val (scope, naming') = Name_Space.new_scope (naming_of thy);
514    val thy' = map_naming (K naming') thy;
515  in (scope, thy') end;
516
517val new_group = map_naming Name_Space.new_group;
518val reset_group = map_naming Name_Space.reset_group;
519
520val add_path = map_naming o Name_Space.add_path;
521val root_path = map_naming Name_Space.root_path;
522val parent_path = map_naming Name_Space.parent_path;
523val mandatory_path = map_naming o Name_Space.mandatory_path;
524val qualified_path = map_naming oo Name_Space.qualified_path;
525
526fun local_path thy = thy |> root_path |> add_path (Context.theory_name thy);
527
528fun theory_naming thy = thy
529  |> map_naming (Name_Space.set_theory_long_name (Context.theory_long_name thy));
530
531val private_scope = map_naming o Name_Space.private_scope;
532val private = map_naming o Name_Space.private;
533val qualified_scope = map_naming o Name_Space.qualified_scope;
534val qualified = map_naming o Name_Space.qualified;
535val concealed = map_naming Name_Space.concealed;
536
537
538(* hide names *)
539
540val hide_class = map_tsig oo Type.hide_class;
541val hide_type = map_tsig oo Type.hide_type;
542val hide_const = map_consts oo Consts.hide;
543
544end;
545