src/Pure/Isar/locale.ML
author wenzelm
Sat Oct 24 19:47:37 2009 +0200 (2009-10-24)
changeset 33095 bbd52d2f8696
parent 33092 c859019d3ac5
child 33096 db3c18fd9708
permissions -rw-r--r--
renamed NameSpace to Name_Space -- also to emphasize its subtle change in semantics;
haftmann@29361
     1
(*  Title:      Pure/Isar/locale.ML
haftmann@29361
     2
    Author:     Clemens Ballarin, TU Muenchen
haftmann@29361
     3
wenzelm@30725
     4
Locales -- managed Isar proof contexts, based on Pure predicates.
haftmann@29361
     5
haftmann@29361
     6
Draws basic ideas from Florian Kammueller's original version of
haftmann@29361
     7
locales, but uses the richer infrastructure of Isar instead of the raw
haftmann@29361
     8
meta-logic.  Furthermore, structured import of contexts (with merge
haftmann@29361
     9
and rename operations) are provided, as well as type-inference of the
haftmann@29361
    10
signature parts, and predicate definitions of the specification text.
haftmann@29361
    11
haftmann@29361
    12
Interpretation enables the reuse of theorems of locales in other
haftmann@29361
    13
contexts, namely those defined by theories, structured proofs and
haftmann@29361
    14
locales themselves.
haftmann@29361
    15
haftmann@29361
    16
See also:
haftmann@29361
    17
haftmann@29361
    18
[1] Clemens Ballarin. Locales and Locale Expressions in Isabelle/Isar.
haftmann@29361
    19
    In Stefano Berardi et al., Types for Proofs and Programs: International
haftmann@29361
    20
    Workshop, TYPES 2003, Torino, Italy, LNCS 3085, pages 34-50, 2004.
haftmann@29361
    21
[2] Clemens Ballarin. Interpretation of Locales in Isabelle: Managing
haftmann@29361
    22
    Dependencies between Locales. Technical Report TUM-I0607, Technische
haftmann@29361
    23
    Universitaet Muenchen, 2006.
haftmann@29361
    24
[3] Clemens Ballarin. Interpretation of Locales in Isabelle: Theories and
haftmann@29361
    25
    Proof Contexts. In J.M. Borwein and W.M. Farmer, MKM 2006, LNAI 4108,
haftmann@29361
    26
    pages 31-43, 2006.
haftmann@29361
    27
*)
haftmann@29361
    28
haftmann@29361
    29
signature LOCALE =
haftmann@29361
    30
sig
haftmann@29576
    31
  (* Locale specification *)
wenzelm@30344
    32
  val register_locale: binding ->
wenzelm@30755
    33
    (string * sort) list * ((string * typ) * mixfix) list ->
haftmann@29361
    34
    term option * term list ->
haftmann@29441
    35
    thm option * thm option -> thm list ->
wenzelm@30725
    36
    declaration list * declaration list ->
wenzelm@30725
    37
    (string * (Attrib.binding * (thm list * Attrib.src list) list) list) list ->
wenzelm@30725
    38
    (string * morphism) list -> theory -> theory
haftmann@29361
    39
  val intern: theory -> xstring -> string
haftmann@29361
    40
  val extern: theory -> string -> xstring
haftmann@29392
    41
  val defined: theory -> string -> bool
wenzelm@30755
    42
  val params_of: theory -> string -> ((string * typ) * mixfix) list
haftmann@29441
    43
  val intros_of: theory -> string -> thm option * thm option
haftmann@29441
    44
  val axioms_of: theory -> string -> thm list
haftmann@29544
    45
  val instance_of: theory -> string -> morphism -> term list
haftmann@29361
    46
  val specification_of: theory -> string -> term option * term list
haftmann@29361
    47
  val declarations_of: theory -> string -> declaration list * declaration list
haftmann@29361
    48
haftmann@29361
    49
  (* Storing results *)
haftmann@29361
    50
  val add_thmss: string -> string -> (Attrib.binding * (thm list * Attrib.src list) list) list ->
haftmann@29361
    51
    Proof.context -> Proof.context
haftmann@29361
    52
  val add_type_syntax: string -> declaration -> Proof.context -> Proof.context
haftmann@29361
    53
  val add_term_syntax: string -> declaration -> Proof.context -> Proof.context
haftmann@29361
    54
  val add_declaration: string -> declaration -> Proof.context -> Proof.context
haftmann@29361
    55
haftmann@29361
    56
  (* Activation *)
wenzelm@30764
    57
  val activate_declarations: string * morphism -> Proof.context -> Proof.context
wenzelm@30764
    58
  val activate_facts: string * morphism -> Context.generic -> Context.generic
haftmann@29361
    59
  val init: string -> theory -> Proof.context
haftmann@29361
    60
haftmann@29361
    61
  (* Reasoning about locales *)
wenzelm@30725
    62
  val get_witnesses: Proof.context -> thm list
wenzelm@30725
    63
  val get_intros: Proof.context -> thm list
wenzelm@30725
    64
  val get_unfolds: Proof.context -> thm list
wenzelm@30725
    65
  val witness_add: attribute
wenzelm@30725
    66
  val intro_add: attribute
wenzelm@30725
    67
  val unfold_add: attribute
haftmann@29361
    68
  val intro_locales_tac: bool -> Proof.context -> thm list -> tactic
haftmann@29361
    69
haftmann@31988
    70
  (* Registrations and dependencies *)
ballarin@32845
    71
  val add_registration: string * morphism -> (morphism * bool) option ->
ballarin@32845
    72
    morphism -> theory -> theory
ballarin@32845
    73
  val amend_registration: string * morphism -> morphism * bool ->
ballarin@32845
    74
    morphism -> theory -> theory
haftmann@32113
    75
  val add_registration_eqs: string * morphism -> thm list -> morphism -> theory -> theory
ballarin@32800
    76
  val amend_registration_legacy: morphism -> string * morphism -> theory -> theory
haftmann@32074
    77
  val add_dependency: string -> string * morphism -> morphism -> theory -> theory
haftmann@29361
    78
haftmann@29361
    79
  (* Diagnostic *)
haftmann@29361
    80
  val print_locales: theory -> unit
wenzelm@30344
    81
  val print_locale: theory -> bool -> xstring -> unit
ballarin@32804
    82
  val print_registrations: theory -> string -> unit
haftmann@29361
    83
end;
haftmann@29361
    84
haftmann@29361
    85
structure Locale: LOCALE =
haftmann@29361
    86
struct
haftmann@29361
    87
haftmann@29361
    88
datatype ctxt = datatype Element.ctxt;
haftmann@29361
    89
haftmann@29392
    90
haftmann@29392
    91
(*** Theory data ***)
haftmann@29361
    92
haftmann@29361
    93
datatype locale = Loc of {
haftmann@29392
    94
  (** static part **)
wenzelm@30755
    95
  parameters: (string * sort) list * ((string * typ) * mixfix) list,
haftmann@29361
    96
    (* type and term parameters *)
haftmann@29361
    97
  spec: term option * term list,
haftmann@29361
    98
    (* assumptions (as a single predicate expression) and defines *)
haftmann@29441
    99
  intros: thm option * thm option,
haftmann@29441
   100
  axioms: thm list,
haftmann@29392
   101
  (** dynamic part **)
haftmann@29361
   102
  decls: (declaration * stamp) list * (declaration * stamp) list,
haftmann@29361
   103
    (* type and term syntax declarations *)
haftmann@29361
   104
  notes: ((string * (Attrib.binding * (thm list * Attrib.src list) list) list) * stamp) list,
haftmann@29361
   105
    (* theorem declarations *)
haftmann@29544
   106
  dependencies: ((string * morphism) * stamp) list
haftmann@29361
   107
    (* locale dependencies (sublocale relation) *)
haftmann@29392
   108
};
haftmann@29361
   109
haftmann@29441
   110
fun mk_locale ((parameters, spec, intros, axioms), ((decls, notes), dependencies)) =
haftmann@29441
   111
  Loc {parameters = parameters, intros = intros, axioms = axioms, spec = spec,
haftmann@29441
   112
    decls = decls, notes = notes, dependencies = dependencies};
wenzelm@30754
   113
haftmann@29441
   114
fun map_locale f (Loc {parameters, spec, intros, axioms, decls, notes, dependencies}) =
haftmann@29441
   115
  mk_locale (f ((parameters, spec, intros, axioms), ((decls, notes), dependencies)));
wenzelm@30754
   116
haftmann@29441
   117
fun merge_locale (Loc {parameters, spec, intros, axioms, decls = (decls1, decls2),
haftmann@29441
   118
  notes, dependencies}, Loc {decls = (decls1', decls2'), notes = notes',
haftmann@29441
   119
    dependencies = dependencies', ...}) = mk_locale
haftmann@29441
   120
      ((parameters, spec, intros, axioms),
haftmann@29441
   121
        (((merge (eq_snd op =) (decls1, decls1'), merge (eq_snd op =) (decls2, decls2')),
haftmann@29441
   122
          merge (eq_snd op =) (notes, notes')),
haftmann@29441
   123
            merge (eq_snd op =) (dependencies, dependencies')));
haftmann@29361
   124
wenzelm@30725
   125
structure Locales = TheoryDataFun
haftmann@29361
   126
(
wenzelm@33095
   127
  type T = locale Name_Space.table;
wenzelm@33095
   128
  val empty = Name_Space.empty_table;
haftmann@29361
   129
  val copy = I;
haftmann@29361
   130
  val extend = I;
wenzelm@33095
   131
  fun merge _ = Name_Space.join_tables (K merge_locale);
haftmann@29361
   132
);
haftmann@29361
   133
wenzelm@33095
   134
val intern = Name_Space.intern o #1 o Locales.get;
wenzelm@33095
   135
val extern = Name_Space.extern o #1 o Locales.get;
haftmann@29392
   136
wenzelm@30725
   137
val get_locale = Symtab.lookup o #2 o Locales.get;
wenzelm@30725
   138
val defined = Symtab.defined o #2 o Locales.get;
haftmann@29361
   139
wenzelm@30725
   140
fun the_locale thy name =
wenzelm@30725
   141
  (case get_locale thy name of
wenzelm@30725
   142
    SOME (Loc loc) => loc
wenzelm@30725
   143
  | NONE => error ("Unknown locale " ^ quote name));
haftmann@29361
   144
wenzelm@30344
   145
fun register_locale binding parameters spec intros axioms decls notes dependencies thy =
wenzelm@33095
   146
  thy |> Locales.map (Name_Space.define true (Sign.naming_of thy)
wenzelm@30725
   147
    (binding,
wenzelm@30725
   148
      mk_locale ((parameters, spec, intros, axioms),
wenzelm@30725
   149
        ((pairself (map (fn decl => (decl, stamp ()))) decls, map (fn n => (n, stamp ())) notes),
wenzelm@30725
   150
          map (fn d => (d, stamp ())) dependencies))) #> snd);
haftmann@29361
   151
haftmann@29392
   152
fun change_locale name =
wenzelm@30725
   153
  Locales.map o apsnd o Symtab.map_entry name o map_locale o apsnd;
haftmann@29361
   154
haftmann@29361
   155
fun print_locales thy =
wenzelm@33095
   156
  Pretty.strs ("locales:" :: map #1 (Name_Space.extern_table (Locales.get thy)))
haftmann@29392
   157
  |> Pretty.writeln;
haftmann@29361
   158
haftmann@29361
   159
haftmann@29361
   160
(*** Primitive operations ***)
haftmann@29361
   161
haftmann@29392
   162
fun params_of thy = snd o #parameters o the_locale thy;
haftmann@29361
   163
haftmann@29441
   164
fun intros_of thy = #intros o the_locale thy;
haftmann@29441
   165
haftmann@29441
   166
fun axioms_of thy = #axioms o the_locale thy;
haftmann@29441
   167
haftmann@29392
   168
fun instance_of thy name morph = params_of thy name |>
wenzelm@30755
   169
  map (Morphism.term morph o Free o #1);
haftmann@29361
   170
haftmann@29392
   171
fun specification_of thy = #spec o the_locale thy;
haftmann@29361
   172
haftmann@29392
   173
fun declarations_of thy name = the_locale thy name |>
wenzelm@30725
   174
  #decls |> pairself (map fst);
haftmann@29361
   175
haftmann@29544
   176
fun dependencies_of thy name = the_locale thy name |>
haftmann@29544
   177
  #dependencies |> map fst;
haftmann@29544
   178
haftmann@29361
   179
haftmann@29361
   180
(*** Activate context elements of locale ***)
haftmann@29361
   181
haftmann@29361
   182
(** Identifiers: activated locales in theory or proof context **)
haftmann@29361
   183
haftmann@29361
   184
fun ident_eq thy ((n: string, ts), (m, ss)) = (m = n) andalso Pattern.matchess thy (ss, ts);
ballarin@32804
   185
(* FIXME: this is ident_le, smaller term is more general *)
haftmann@29361
   186
haftmann@29361
   187
local
haftmann@29361
   188
wenzelm@30754
   189
datatype 'a delayed = Ready of 'a | ToDo of 'a delayed * 'a delayed;
haftmann@29361
   190
wenzelm@30725
   191
structure Identifiers = GenericDataFun
haftmann@29361
   192
(
wenzelm@30754
   193
  type T = (string * term list) list delayed;
wenzelm@30754
   194
  val empty = Ready [];
haftmann@29361
   195
  val extend = I;
haftmann@29361
   196
  fun merge _ = ToDo;
haftmann@29361
   197
);
haftmann@29361
   198
haftmann@29361
   199
fun finish thy (ToDo (i1, i2)) = merge (ident_eq thy) (finish thy i1, finish thy i2)
haftmann@29361
   200
  | finish _ (Ready ids) = ids;
haftmann@29361
   201
haftmann@29361
   202
val _ = Context.>> (Context.map_theory (Theory.at_begin (fn thy =>
wenzelm@30725
   203
  (case Identifiers.get (Context.Theory thy) of
wenzelm@30725
   204
    Ready _ => NONE
wenzelm@30725
   205
  | ids => SOME (Context.theory_map (Identifiers.put (Ready (finish thy ids))) thy)))));
haftmann@29361
   206
wenzelm@30764
   207
in
haftmann@29361
   208
wenzelm@30764
   209
val get_idents = (fn Ready ids => ids) o Identifiers.get;
wenzelm@30764
   210
val put_idents = Identifiers.put o Ready;
haftmann@29361
   211
haftmann@29361
   212
end;
haftmann@29361
   213
haftmann@29361
   214
haftmann@29361
   215
(** Resolve locale dependencies in a depth-first fashion **)
haftmann@29361
   216
haftmann@29361
   217
local
haftmann@29361
   218
haftmann@29361
   219
val roundup_bound = 120;
haftmann@29361
   220
ballarin@32803
   221
fun add thy depth export (name, morph) (deps, marked) =
haftmann@29361
   222
  if depth > roundup_bound
haftmann@29361
   223
  then error "Roundup bound exceeded (sublocale relation probably not terminating)."
haftmann@29361
   224
  else
haftmann@29361
   225
    let
wenzelm@30754
   226
      val dependencies = dependencies_of thy name;
ballarin@32803
   227
      val instance = instance_of thy name (morph $> export);
haftmann@29361
   228
    in
haftmann@29361
   229
      if member (ident_eq thy) marked (name, instance)
haftmann@29361
   230
      then (deps, marked)
haftmann@29361
   231
      else
haftmann@29361
   232
        let
wenzelm@30754
   233
          val dependencies' = map (fn (name, morph') => (name, morph' $> morph)) dependencies;
haftmann@29361
   234
          val marked' = (name, instance) :: marked;
ballarin@32803
   235
          val (deps', marked'') = fold_rev (add thy (depth + 1) export) dependencies' ([], marked');
haftmann@29361
   236
        in
haftmann@29361
   237
          ((name, morph) :: deps' @ deps, marked'')
haftmann@29361
   238
        end
haftmann@29361
   239
    end;
haftmann@29361
   240
haftmann@29361
   241
in
haftmann@29361
   242
ballarin@32804
   243
(* Note that while identifiers always have the external (exported) view, activate_dep is
ballarin@32803
   244
  is presented with the internal view. *)
ballarin@32803
   245
ballarin@32803
   246
fun roundup thy activate_dep export (name, morph) (marked, input) =
haftmann@29361
   247
  let
haftmann@29361
   248
    (* Find all dependencies incuding new ones (which are dependencies enriching
haftmann@29361
   249
      existing registrations). *)
ballarin@32803
   250
    val (dependencies, marked') = add thy 0 export (name, morph) ([], []);
ballarin@32800
   251
    (* Filter out fragments from marked; these won't be activated. *)
haftmann@29361
   252
    val dependencies' = filter_out (fn (name, morph) =>
ballarin@32803
   253
      member (ident_eq thy) marked (name, instance_of thy name (morph $> export))) dependencies;
haftmann@29361
   254
  in
wenzelm@30773
   255
    (merge (ident_eq thy) (marked, marked'), input |> fold_rev activate_dep dependencies')
haftmann@29361
   256
  end;
haftmann@29361
   257
haftmann@29361
   258
end;
haftmann@29361
   259
haftmann@29361
   260
haftmann@29361
   261
(* Declarations, facts and entire locale content *)
haftmann@29361
   262
wenzelm@30764
   263
fun activate_decls (name, morph) context =
haftmann@29361
   264
  let
wenzelm@30764
   265
    val thy = Context.theory_of context;
haftmann@29392
   266
    val {decls = (typ_decls, term_decls), ...} = the_locale thy name;
haftmann@29361
   267
  in
wenzelm@30764
   268
    context
wenzelm@30764
   269
    |> fold_rev (fn (decl, _) => decl morph) typ_decls
wenzelm@30764
   270
    |> fold_rev (fn (decl, _) => decl morph) term_decls
haftmann@29361
   271
  end;
haftmann@29361
   272
haftmann@29361
   273
fun activate_notes activ_elem transfer thy (name, morph) input =
haftmann@29361
   274
  let
haftmann@29392
   275
    val {notes, ...} = the_locale thy name;
haftmann@29361
   276
    fun activate ((kind, facts), _) input =
haftmann@29361
   277
      let
haftmann@29361
   278
        val facts' = facts |> Element.facts_map (Element.morph_ctxt (transfer input $> morph))
haftmann@29361
   279
      in activ_elem (Notes (kind, facts')) input end;
haftmann@29361
   280
  in
haftmann@29361
   281
    fold_rev activate notes input
haftmann@29361
   282
  end;
haftmann@29361
   283
haftmann@29361
   284
fun activate_all name thy activ_elem transfer (marked, input) =
haftmann@29361
   285
  let
wenzelm@30764
   286
    val {parameters = (_, params), spec = (asm, defs), ...} = the_locale thy name;
wenzelm@30764
   287
    val input' = input |>
wenzelm@30755
   288
      (not (null params) ?
wenzelm@30755
   289
        activ_elem (Fixes (map (fn ((x, T), mx) => (Binding.name x, SOME T, mx)) params))) |>
haftmann@29361
   290
      (* FIXME type parameters *)
wenzelm@30764
   291
      (case asm of SOME A => activ_elem (Assumes [(Attrib.empty_binding, [(A, [])])]) | _ => I) |>
haftmann@29361
   292
      (if not (null defs)
haftmann@29361
   293
        then activ_elem (Defines (map (fn def => (Attrib.empty_binding, (def, []))) defs))
wenzelm@30764
   294
        else I);
wenzelm@30773
   295
    val activate = activate_notes activ_elem transfer thy;
wenzelm@30764
   296
  in
ballarin@32803
   297
    roundup thy activate Morphism.identity (name, Morphism.identity) (marked, input')
haftmann@29361
   298
  end;
haftmann@29361
   299
haftmann@29361
   300
haftmann@29361
   301
(** Public activation functions **)
haftmann@29361
   302
wenzelm@30775
   303
fun activate_declarations dep = Context.proof_map (fn context =>
wenzelm@30764
   304
  let
wenzelm@30764
   305
    val thy = Context.theory_of context;
ballarin@32803
   306
  in roundup thy activate_decls Morphism.identity dep (get_idents context, context) |-> put_idents end);
haftmann@29361
   307
wenzelm@30764
   308
fun activate_facts dep context =
wenzelm@30764
   309
  let
wenzelm@30764
   310
    val thy = Context.theory_of context;
wenzelm@30775
   311
    val activate = activate_notes Element.init (Element.transfer_morphism o Context.theory_of) thy;
ballarin@32803
   312
  in roundup thy activate Morphism.identity dep (get_idents context, context) |-> put_idents end;
haftmann@29361
   313
haftmann@29361
   314
fun init name thy =
wenzelm@30775
   315
  activate_all name thy Element.init (Element.transfer_morphism o Context.theory_of)
wenzelm@30764
   316
    ([], Context.Proof (ProofContext.init thy)) |-> put_idents |> Context.proof_of;
haftmann@29361
   317
wenzelm@30764
   318
fun print_locale thy show_facts raw_name =
haftmann@29361
   319
  let
wenzelm@30764
   320
    val name = intern thy raw_name;
wenzelm@30764
   321
    val ctxt = init name thy;
wenzelm@30764
   322
    fun cons_elem (elem as Notes _) = show_facts ? cons elem
wenzelm@30764
   323
      | cons_elem elem = cons elem;
wenzelm@30764
   324
    val elems =
wenzelm@30764
   325
      activate_all name thy cons_elem (K (Element.transfer_morphism thy)) ([], [])
wenzelm@30764
   326
      |> snd |> rev;
haftmann@29361
   327
  in
wenzelm@30764
   328
    Pretty.big_list "locale elements:" (map (Pretty.chunks o Element.pretty_ctxt ctxt) elems)
wenzelm@30764
   329
    |> Pretty.writeln
wenzelm@30764
   330
  end;
haftmann@29361
   331
haftmann@29361
   332
haftmann@29361
   333
(*** Registrations: interpretations in theories ***)
haftmann@29361
   334
wenzelm@30725
   335
structure Registrations = TheoryDataFun
haftmann@29361
   336
(
ballarin@32801
   337
  type T = ((string * (morphism * morphism)) * stamp) list *
haftmann@29361
   338
    (* registrations, in reverse order of declaration *)
ballarin@32801
   339
    (stamp * ((morphism * bool) * stamp) list) list;
ballarin@32801
   340
    (* alist of mixin lists, per list mixins in reverse order of declaration *)
ballarin@32801
   341
  val empty = ([], []);
haftmann@29361
   342
  val extend = I;
haftmann@29392
   343
  val copy = I;
ballarin@32801
   344
  fun merge _ ((r1, m1), (r2, m2)) : T =
ballarin@32801
   345
    (Library.merge (eq_snd op =) (r1, r2),
ballarin@32801
   346
      AList.join (op =) (K (Library.merge (eq_snd op =))) (m1, m2));
haftmann@29361
   347
    (* FIXME consolidate with dependencies, consider one data slot only *)
haftmann@29361
   348
);
haftmann@29361
   349
ballarin@32801
   350
ballarin@32801
   351
(* Primitive operations *)
ballarin@32801
   352
ballarin@32801
   353
fun compose_mixins mixins =
ballarin@32801
   354
  fold_rev Morphism.compose (map (fst o fst) mixins) Morphism.identity;
ballarin@32801
   355
ballarin@32801
   356
fun reg_morph mixins ((name, (base, export)), stamp) =
ballarin@32801
   357
  let val mix = the_default [] (AList.lookup (op =) mixins stamp) |> compose_mixins;
ballarin@32801
   358
  in (name, base $> mix $> export) end;
haftmann@31988
   359
haftmann@31988
   360
fun these_registrations thy name = Registrations.get thy
ballarin@32801
   361
  |>> filter (curry (op =) name o fst o fst)
ballarin@32801
   362
  |-> (fn regs => fn mixins => map (reg_morph mixins) regs);
haftmann@31988
   363
haftmann@31988
   364
fun all_registrations thy = Registrations.get thy
ballarin@32801
   365
  |-> (fn regs => fn mixins => map (reg_morph mixins) regs);
ballarin@32801
   366
ballarin@32804
   367
fun get_mixins thy (name, morph) =
ballarin@32804
   368
  let
ballarin@32804
   369
    val (regs, mixins) = Registrations.get thy;
ballarin@32804
   370
  in
ballarin@32804
   371
    case find_first (fn ((name', (morph', export')), _) => ident_eq thy
ballarin@32804
   372
      ((name', instance_of thy name' (morph' $> export')), (name, instance_of thy name morph))) (rev regs) of
ballarin@32804
   373
      NONE => []
ballarin@32804
   374
    | SOME (_, stamp) => the_default [] (AList.lookup (op =) mixins stamp)
ballarin@32804
   375
  end;
ballarin@32804
   376
ballarin@32804
   377
fun collect_mixins thy (name, morph) =
ballarin@32804
   378
  roundup thy (fn dep => fn mixins =>
ballarin@32804
   379
    merge (eq_snd op =) (mixins, get_mixins thy dep)) Morphism.identity (name, morph) ([], [])
ballarin@32804
   380
  |> snd |> filter (snd o fst);  (* only inheritable mixins *)
ballarin@32804
   381
ballarin@32804
   382
fun activate_notes' activ_elem transfer thy export (name, morph) input =
ballarin@32804
   383
  let
ballarin@32804
   384
    val {notes, ...} = the_locale thy name;
ballarin@32804
   385
    fun activate ((kind, facts), _) input =
ballarin@32804
   386
      let
ballarin@32804
   387
        val mixin = collect_mixins thy (name, morph $> export) |> compose_mixins;
ballarin@32804
   388
        val facts' = facts |> Element.facts_map (Element.morph_ctxt (transfer input $> morph $> mixin $> export))
ballarin@32804
   389
      in activ_elem (Notes (kind, facts')) input end;
ballarin@32804
   390
  in
ballarin@32804
   391
    fold_rev activate notes input
ballarin@32804
   392
  end;
ballarin@32804
   393
ballarin@32804
   394
fun activate_facts' export dep context =
ballarin@32804
   395
  let
ballarin@32804
   396
    val thy = Context.theory_of context;
ballarin@32804
   397
    val activate = activate_notes' Element.init (Element.transfer_morphism o Context.theory_of) thy export;
ballarin@32804
   398
  in roundup thy activate export dep (get_idents context, context) |-> put_idents end;
ballarin@32804
   399
ballarin@32804
   400
ballarin@32804
   401
(* Diagnostic *)
ballarin@32804
   402
ballarin@32804
   403
fun print_registrations thy raw_name =
ballarin@32804
   404
  let
ballarin@32804
   405
    val name = intern thy raw_name;
ballarin@32804
   406
    val name' = extern thy name;
ballarin@32804
   407
    val ctxt = ProofContext.init thy;
ballarin@32804
   408
    fun prt_qual (qual, mand) = Pretty.str (qual ^ (if mand then "!" else "?"));
ballarin@32804
   409
    fun prt_quals qs = Pretty.separate "." (map prt_qual qs) |> Pretty.block;
ballarin@32804
   410
    val prt_term = Pretty.quote o Syntax.pretty_term ctxt;
ballarin@32804
   411
    fun prt_term' t = if !show_types
ballarin@32804
   412
      then Pretty.block [prt_term t, Pretty.brk 1, Pretty.str "::",
ballarin@32804
   413
        Pretty.brk 1, (Pretty.quote o Syntax.pretty_typ ctxt) (type_of t)]
ballarin@32804
   414
      else prt_term t;
ballarin@32804
   415
    fun prt_inst ts =
ballarin@32804
   416
      Pretty.block (Pretty.breaks (Pretty.str name' :: map prt_term' ts));
ballarin@32804
   417
    fun prt_reg (name, morph) =
ballarin@32804
   418
      let
ballarin@32804
   419
        val qs = Binding.name "x" |> Morphism.binding morph |> Binding.prefix_of;
ballarin@32804
   420
        val ts = instance_of thy name morph;
ballarin@32804
   421
      in
ballarin@32804
   422
        case qs of
ballarin@32804
   423
           [] => prt_inst ts
ballarin@32804
   424
         | qs => Pretty.block [prt_quals qs, Pretty.brk 1, Pretty.str ":",
ballarin@32804
   425
             Pretty.brk 1, prt_inst ts]
ballarin@32804
   426
      end;
ballarin@32804
   427
  in
ballarin@32804
   428
    (case these_registrations thy name of
ballarin@32804
   429
        [] => Pretty.str ("no interpretations")
ballarin@32980
   430
      | regs => Pretty.big_list "interpretations:" (map prt_reg (rev regs)))
ballarin@32804
   431
    |> Pretty.writeln
ballarin@32804
   432
  end;
ballarin@32801
   433
ballarin@32801
   434
ballarin@32801
   435
(* Add and extend registrations *)
ballarin@32801
   436
ballarin@32804
   437
fun amend_registration (name, morph) mixin export thy =
ballarin@32804
   438
  let
ballarin@32804
   439
    val regs = Registrations.get thy |> fst;
ballarin@32804
   440
    val base = instance_of thy name (morph $> export);
ballarin@32804
   441
    fun match ((name', (morph', export')), _) =
ballarin@32804
   442
      name = name' andalso eq_list (op aconv) (base, instance_of thy name' (morph' $> export'));
ballarin@32804
   443
  in
ballarin@32804
   444
    case find_first match (rev regs) of
ballarin@32804
   445
        NONE => error ("No interpretation of locale " ^
ballarin@32804
   446
          quote (extern thy name) ^ " and\nparameter instantiation " ^
ballarin@32804
   447
          space_implode " " (map (quote o Syntax.string_of_term_global thy) base) ^
ballarin@32804
   448
          " available")
ballarin@32804
   449
      | SOME (_, stamp') => Registrations.map 
ballarin@32804
   450
          (apsnd (AList.map_default (op =) (stamp', []) (cons (mixin, stamp ())))) thy
ballarin@32804
   451
    (* FIXME deal with inheritance: propagate to existing children *)
ballarin@32804
   452
  end;
ballarin@32804
   453
ballarin@32801
   454
(* Note that a registration that would be subsumed by an existing one will not be
ballarin@32801
   455
   generated, and it will not be possible to amend it. *)
ballarin@32801
   456
ballarin@32804
   457
fun add_registration (name, base_morph) mixin export thy =
ballarin@32801
   458
  let
ballarin@32801
   459
    val base = instance_of thy name base_morph;
ballarin@32801
   460
  in
ballarin@32801
   461
    if member (ident_eq thy) (get_idents (Context.Theory thy)) (name, base)
ballarin@32801
   462
    then thy
ballarin@32801
   463
    else
ballarin@32801
   464
      let
ballarin@32804
   465
        fun add_reg (dep', morph') =
ballarin@32804
   466
          let
ballarin@32804
   467
            val mixins = collect_mixins thy (dep', morph' $> export);
ballarin@32804
   468
            val stamp = stamp ();
ballarin@32804
   469
          in
ballarin@32804
   470
            Registrations.map (apfst (cons ((dep', (morph', export)), stamp))
ballarin@32804
   471
              #> apsnd (cons (stamp, mixins)))
ballarin@32804
   472
          end
ballarin@32801
   473
      in
ballarin@32804
   474
        (get_idents (Context.Theory thy), thy)
ballarin@32804
   475
        (* add new registrations with inherited mixins *)
ballarin@32804
   476
        |> roundup thy add_reg export (name, base_morph)
ballarin@32804
   477
        |> snd
ballarin@32804
   478
        (* add mixin *)
ballarin@32845
   479
        |> (case mixin of NONE => I
ballarin@32845
   480
             | SOME mixin => amend_registration (name, base_morph) mixin export)
ballarin@32801
   481
        (* activate import hierarchy as far as not already active *)
ballarin@32804
   482
        |> Context.theory_map (activate_facts' export (name, base_morph))
ballarin@32801
   483
      end
ballarin@32801
   484
  end;
ballarin@32801
   485
ballarin@32800
   486
fun amend_registration_legacy morph (name, base_morph) thy =
ballarin@32800
   487
  (* legacy, never modify base morphism *)
haftmann@29361
   488
  let
ballarin@32801
   489
    val regs = Registrations.get thy |> fst |> map fst;
haftmann@29361
   490
    val base = instance_of thy name base_morph;
haftmann@29361
   491
    fun match (name', (morph', _)) =
haftmann@29361
   492
      name = name' andalso eq_list (op aconv) (base, instance_of thy name' morph');
haftmann@29361
   493
    val i = find_index match (rev regs);
wenzelm@30764
   494
    val _ =
wenzelm@30764
   495
      if i = ~1 then error ("No registration of locale " ^
haftmann@29361
   496
        quote (extern thy name) ^ " and parameter instantiation " ^
wenzelm@30764
   497
        space_implode " " (map (quote o Syntax.string_of_term_global thy) base) ^ " available")
haftmann@29361
   498
      else ();
haftmann@29361
   499
  in
ballarin@32801
   500
    Registrations.map ((apfst o nth_map (length regs - 1 - i))
haftmann@29361
   501
      (fn ((name, (base, export)), stamp) => ((name, (base $> morph, export)), stamp))) thy
haftmann@29361
   502
  end;
haftmann@29361
   503
haftmann@32074
   504
fun add_registration_eqs (dep, proto_morph) eqns export thy =
haftmann@32074
   505
  let
haftmann@32074
   506
    val morph = if null eqns then proto_morph
haftmann@32074
   507
      else proto_morph $> Element.eq_morphism thy eqns;
haftmann@32074
   508
  in
haftmann@32113
   509
    (get_idents (Context.Theory thy), thy)
haftmann@32113
   510
    |> roundup thy (fn (dep', morph') =>
ballarin@32804
   511
        Registrations.map (apfst (cons ((dep', (morph', export)), stamp ())))) export (dep, morph)
haftmann@32113
   512
    |> snd
haftmann@32074
   513
    |> Context.theory_map (activate_facts (dep, morph $> export))
haftmann@32074
   514
  end;
haftmann@32074
   515
haftmann@29361
   516
haftmann@31988
   517
(*** Dependencies ***)
haftmann@31988
   518
haftmann@32074
   519
fun add_dependency loc (dep, morph) export thy =
haftmann@31988
   520
  thy
haftmann@32074
   521
  |> (change_locale loc o apsnd) (cons ((dep, morph $> export), stamp ()))
ballarin@32804
   522
  |> (fn thy => fold_rev (Context.theory_map o activate_facts' export)
haftmann@31988
   523
      (all_registrations thy) thy);
ballarin@32801
   524
  (* FIXME deal with inheritance: propagate mixins to new children *)
haftmann@31988
   525
haftmann@31988
   526
haftmann@29361
   527
(*** Storing results ***)
haftmann@29361
   528
haftmann@29361
   529
(* Theorems *)
haftmann@29361
   530
haftmann@29361
   531
fun add_thmss loc kind args ctxt =
haftmann@29361
   532
  let
wenzelm@30777
   533
    val (Notes args', ctxt') = Element.activate_i (Notes (kind, args)) ctxt;
haftmann@29361
   534
    val ctxt'' = ctxt' |> ProofContext.theory (
haftmann@29392
   535
      (change_locale loc o apfst o apsnd) (cons (args', stamp ()))
haftmann@29392
   536
        #>
haftmann@29361
   537
      (* Registrations *)
haftmann@31988
   538
      (fn thy => fold_rev (fn (_, morph) =>
haftmann@29361
   539
            let
haftmann@29361
   540
              val args'' = snd args' |> Element.facts_map (Element.morph_ctxt morph) |>
haftmann@29361
   541
                Attrib.map_facts (Attrib.attribute_i thy)
wenzelm@30438
   542
            in PureThy.note_thmss kind args'' #> snd end)
haftmann@31988
   543
        (these_registrations thy loc) thy))
haftmann@29361
   544
  in ctxt'' end;
haftmann@29361
   545
haftmann@29361
   546
haftmann@29361
   547
(* Declarations *)
haftmann@29361
   548
haftmann@29361
   549
local
haftmann@29361
   550
haftmann@29361
   551
fun decl_attrib decl phi = Thm.declaration_attribute (K (decl phi));
haftmann@29361
   552
haftmann@29361
   553
fun add_decls add loc decl =
wenzelm@30223
   554
  ProofContext.theory ((change_locale loc o apfst o apfst) (add (decl, stamp ()))) #>
haftmann@29361
   555
  add_thmss loc Thm.internalK
haftmann@29361
   556
    [((Binding.empty, [Attrib.internal (decl_attrib decl)]), [([Drule.dummy_thm], [])])];
haftmann@29361
   557
haftmann@29361
   558
in
haftmann@29361
   559
haftmann@29361
   560
val add_type_syntax = add_decls (apfst o cons);
haftmann@29361
   561
val add_term_syntax = add_decls (apsnd o cons);
haftmann@29361
   562
val add_declaration = add_decls (K I);
haftmann@29361
   563
haftmann@29361
   564
end;
haftmann@29361
   565
wenzelm@30725
   566
haftmann@29361
   567
(*** Reasoning about locales ***)
haftmann@29361
   568
wenzelm@30725
   569
(* Storage for witnesses, intro and unfold rules *)
haftmann@29361
   570
wenzelm@30725
   571
structure Thms = GenericDataFun
wenzelm@30725
   572
(
wenzelm@30725
   573
  type T = thm list * thm list * thm list;
wenzelm@30725
   574
  val empty = ([], [], []);
wenzelm@30725
   575
  val extend = I;
wenzelm@30725
   576
  fun merge _ ((witnesses1, intros1, unfolds1), (witnesses2, intros2, unfolds2)) =
wenzelm@30725
   577
   (Thm.merge_thms (witnesses1, witnesses2),
wenzelm@30725
   578
    Thm.merge_thms (intros1, intros2),
wenzelm@30725
   579
    Thm.merge_thms (unfolds1, unfolds2));
wenzelm@30725
   580
);
haftmann@29361
   581
wenzelm@30725
   582
val get_witnesses = #1 o Thms.get o Context.Proof;
wenzelm@30725
   583
val get_intros = #2 o Thms.get o Context.Proof;
wenzelm@30725
   584
val get_unfolds = #3 o Thms.get o Context.Proof;
haftmann@29361
   585
wenzelm@30725
   586
val witness_add =
wenzelm@30725
   587
  Thm.declaration_attribute (fn th => Thms.map (fn (x, y, z) => (Thm.add_thm th x, y, z)));
wenzelm@30725
   588
val intro_add =
wenzelm@30725
   589
  Thm.declaration_attribute (fn th => Thms.map (fn (x, y, z) => (x, Thm.add_thm th y, z)));
wenzelm@30725
   590
val unfold_add =
wenzelm@30725
   591
  Thm.declaration_attribute (fn th => Thms.map (fn (x, y, z) => (x, y, Thm.add_thm th z)));
haftmann@29361
   592
wenzelm@30725
   593
wenzelm@30725
   594
(* Tactic *)
wenzelm@30725
   595
wenzelm@30725
   596
fun intro_locales_tac eager ctxt =
haftmann@29361
   597
  Method.intros_tac
wenzelm@30725
   598
    (get_witnesses ctxt @ get_intros ctxt @ (if eager then get_unfolds ctxt else []));
haftmann@29361
   599
haftmann@29361
   600
val _ = Context.>> (Context.map_theory
wenzelm@30515
   601
 (Method.setup (Binding.name "intro_locales") (Scan.succeed (METHOD o intro_locales_tac false))
wenzelm@30515
   602
    "back-chain introduction rules of locales without unfolding predicates" #>
wenzelm@30515
   603
  Method.setup (Binding.name "unfold_locales") (Scan.succeed (METHOD o intro_locales_tac true))
wenzelm@30515
   604
    "back-chain all introduction rules of locales"));
haftmann@29361
   605
haftmann@29361
   606
end;
haftmann@29361
   607