src/HOL/Tools/typedef_package.ML
author paulson
Fri Nov 24 16:38:42 2006 +0100 (2006-11-24)
changeset 21513 9e9fff87dc6c
parent 21434 944f80576be0
child 21565 bd28361f4c5b
permissions -rw-r--r--
Conversion of "equal" to "=" for TSTP format; big tidy-up
wenzelm@4866
     1
(*  Title:      HOL/Tools/typedef_package.ML
wenzelm@4866
     2
    ID:         $Id$
wenzelm@16458
     3
    Author:     Markus Wenzel and Stefan Berghofer, TU Muenchen
wenzelm@4866
     4
wenzelm@21352
     5
Gordon/HOL-style type definitions: create a new syntactic type
wenzelm@21352
     6
represented by a non-empty subset.
wenzelm@4866
     7
*)
wenzelm@4866
     8
wenzelm@4866
     9
signature TYPEDEF_PACKAGE =
wenzelm@4866
    10
sig
wenzelm@5697
    11
  val quiet_mode: bool ref
wenzelm@5104
    12
  val add_typedecls: (bstring * string list * mixfix) list -> theory -> theory
wenzelm@19705
    13
  type info =
wenzelm@19705
    14
   {rep_type: typ, abs_type: typ, Rep_name: string, Abs_name: string,
wenzelm@19705
    15
    type_definition: thm, set_def: thm option, Rep: thm, Rep_inverse: thm,
wenzelm@19705
    16
    Abs_inverse: thm, Rep_inject: thm, Abs_inject: thm, Rep_cases: thm,
wenzelm@19705
    17
    Abs_cases: thm, Rep_induct: thm, Abs_induct: thm};
wenzelm@19705
    18
  val get_info: theory -> string -> info option
wenzelm@11827
    19
  val add_typedef: bool -> string option -> bstring * string list * mixfix ->
haftmann@20483
    20
    string -> (bstring * bstring) option -> tactic -> theory -> (string * info) * theory
wenzelm@11827
    21
  val add_typedef_i: bool -> string option -> bstring * string list * mixfix ->
haftmann@20483
    22
    term -> (bstring * bstring) option -> tactic -> theory -> (string * info) * theory
wenzelm@17339
    23
  val typedef: (bool * string) * (bstring * string list * mixfix) * string
wenzelm@17339
    24
    * (string * string) option -> theory -> Proof.state
wenzelm@17339
    25
  val typedef_i: (bool * string) * (bstring * string list * mixfix) * term
wenzelm@17339
    26
    * (string * string) option -> theory -> Proof.state
wenzelm@18708
    27
  val setup: theory -> theory
wenzelm@4866
    28
end;
wenzelm@4866
    29
wenzelm@4866
    30
structure TypedefPackage: TYPEDEF_PACKAGE =
wenzelm@4866
    31
struct
wenzelm@4866
    32
wenzelm@10280
    33
(** theory context references **)
wenzelm@10280
    34
wenzelm@11608
    35
val type_definitionN = "Typedef.type_definition";
wenzelm@10280
    36
wenzelm@13413
    37
val Rep = thm "type_definition.Rep";
wenzelm@13413
    38
val Rep_inverse = thm "type_definition.Rep_inverse";
wenzelm@13413
    39
val Abs_inverse = thm "type_definition.Abs_inverse";
wenzelm@13413
    40
val Rep_inject = thm "type_definition.Rep_inject";
wenzelm@13413
    41
val Abs_inject = thm "type_definition.Abs_inject";
wenzelm@13413
    42
val Rep_cases = thm "type_definition.Rep_cases";
wenzelm@13413
    43
val Abs_cases = thm "type_definition.Abs_cases";
wenzelm@13413
    44
val Rep_induct = thm "type_definition.Rep_induct";
wenzelm@13413
    45
val Abs_induct = thm "type_definition.Abs_induct";
wenzelm@10280
    46
wenzelm@10280
    47
wenzelm@10280
    48
wenzelm@17922
    49
(** type declarations **)
wenzelm@17922
    50
wenzelm@19510
    51
fun HOL_arity (raw_name, args, mx) thy =
wenzelm@19510
    52
  thy |> AxClass.axiomatize_arity_i
wenzelm@19510
    53
    (Sign.full_name thy (Syntax.type_name raw_name mx),
wenzelm@19510
    54
      replicate (length args) HOLogic.typeS, HOLogic.typeS);
wenzelm@19510
    55
wenzelm@17922
    56
fun add_typedecls decls thy =
wenzelm@19510
    57
  thy
wenzelm@19510
    58
  |> Theory.add_typedecls decls
wenzelm@19510
    59
  |> can (Theory.assert_super HOL.thy) ? fold HOL_arity decls;
wenzelm@17922
    60
wenzelm@17922
    61
wenzelm@17922
    62
wenzelm@17922
    63
(** type definitions **)
wenzelm@17922
    64
wenzelm@17922
    65
(* messages *)
wenzelm@17922
    66
wenzelm@17922
    67
val quiet_mode = ref false;
wenzelm@17922
    68
fun message s = if ! quiet_mode then () else writeln s;
wenzelm@17922
    69
wenzelm@17922
    70
wenzelm@17922
    71
(* theory data *)
berghofe@15259
    72
wenzelm@19705
    73
type info =
wenzelm@19705
    74
 {rep_type: typ, abs_type: typ, Rep_name: string, Abs_name: string,
wenzelm@19705
    75
  type_definition: thm, set_def: thm option, Rep: thm, Rep_inverse: thm,
wenzelm@19705
    76
  Abs_inverse: thm, Rep_inject: thm, Abs_inject: thm, Rep_cases: thm,
wenzelm@19705
    77
  Abs_cases: thm, Rep_induct: thm, Abs_induct: thm};
haftmann@19459
    78
wenzelm@16458
    79
structure TypedefData = TheoryDataFun
wenzelm@16458
    80
(struct
berghofe@15259
    81
  val name = "HOL/typedef";
wenzelm@19705
    82
  type T = info Symtab.table;
berghofe@15259
    83
  val empty = Symtab.empty;
berghofe@15259
    84
  val copy = I;
wenzelm@16458
    85
  val extend = I;
wenzelm@19617
    86
  fun merge _ tabs : T = Symtab.merge (K true) tabs;
wenzelm@16458
    87
  fun print _ _ = ();
wenzelm@16458
    88
end);
berghofe@15259
    89
wenzelm@19705
    90
val get_info = Symtab.lookup o TypedefData.get;
wenzelm@19705
    91
fun put_info name info = TypedefData.map (Symtab.update (name, info));
berghofe@15259
    92
berghofe@15259
    93
wenzelm@6383
    94
(* prepare_typedef *)
wenzelm@6383
    95
wenzelm@18678
    96
fun err_in_typedef msg name =
wenzelm@18678
    97
  cat_error msg ("The error(s) above occurred in typedef " ^ quote name);
wenzelm@6383
    98
wenzelm@21352
    99
fun declare_type_name a = Variable.declare_constraints (Logic.mk_type (TFree (a, dummyS)));
wenzelm@21352
   100
wenzelm@11822
   101
fun prepare_typedef prep_term def name (t, vs, mx) raw_set opt_morphs thy =
wenzelm@4866
   102
  let
wenzelm@11608
   103
    val _ = Theory.requires thy "Typedef" "typedefs";
wenzelm@21352
   104
    val ctxt = ProofContext.init thy;
wenzelm@16458
   105
    val full = Sign.full_name thy;
wenzelm@4866
   106
wenzelm@4866
   107
    (*rhs*)
wenzelm@10280
   108
    val full_name = full name;
wenzelm@21352
   109
    val set = prep_term (ctxt |> fold declare_type_name vs) raw_set;
wenzelm@21352
   110
    val setT = Term.fastype_of set;
wenzelm@17280
   111
    val rhs_tfrees = Term.add_tfrees set [];
wenzelm@17280
   112
    val rhs_tfreesT = Term.add_tfreesT setT [];
wenzelm@4866
   113
    val oldT = HOLogic.dest_setT setT handle TYPE _ =>
wenzelm@21352
   114
      error ("Not a set type: " ^ quote (ProofContext.string_of_typ ctxt setT));
wenzelm@11426
   115
    fun mk_nonempty A =
wenzelm@11426
   116
      HOLogic.mk_Trueprop (HOLogic.mk_exists ("x", oldT, HOLogic.mk_mem (Free ("x", oldT), A)));
wenzelm@11426
   117
    val goal = mk_nonempty set;
wenzelm@19473
   118
    val goal_pat = mk_nonempty (Var (the_default (name, 0) (Syntax.read_variable name), setT));
wenzelm@4866
   119
wenzelm@4866
   120
    (*lhs*)
wenzelm@17280
   121
    val defS = Sign.defaultS thy;
wenzelm@19473
   122
    val lhs_tfrees = map (fn v => (v, the_default defS (AList.lookup (op =) rhs_tfrees v))) vs;
wenzelm@17280
   123
    val args_setT = lhs_tfrees
wenzelm@17280
   124
      |> filter (member (op =) rhs_tfrees andf (not o member (op =) rhs_tfreesT))
wenzelm@17280
   125
      |> map TFree;
wenzelm@17280
   126
wenzelm@4866
   127
    val tname = Syntax.type_name t mx;
wenzelm@10280
   128
    val full_tname = full tname;
wenzelm@10280
   129
    val newT = Type (full_tname, map TFree lhs_tfrees);
wenzelm@4866
   130
wenzelm@19473
   131
    val (Rep_name, Abs_name) = the_default ("Rep_" ^ name, "Abs_" ^ name) opt_morphs;
wenzelm@19391
   132
    val setT' = map Term.itselfT args_setT ---> setT;
wenzelm@17280
   133
    val setC = Term.list_comb (Const (full_name, setT'), map Logic.mk_type args_setT);
wenzelm@10280
   134
    val RepC = Const (full Rep_name, newT --> oldT);
wenzelm@10280
   135
    val AbsC = Const (full Abs_name, oldT --> newT);
wenzelm@4866
   136
    val x_new = Free ("x", newT);
wenzelm@4866
   137
    val y_old = Free ("y", oldT);
wenzelm@10280
   138
wenzelm@11822
   139
    val set' = if def then setC else set;
wenzelm@4866
   140
wenzelm@10280
   141
    val typedef_name = "type_definition_" ^ name;
wenzelm@10280
   142
    val typedefC =
wenzelm@10280
   143
      Const (type_definitionN, (newT --> oldT) --> (oldT --> newT) --> setT --> HOLogic.boolT);
wenzelm@11426
   144
    val typedef_prop =
wenzelm@11426
   145
      Logic.mk_implies (goal, HOLogic.mk_Trueprop (typedefC $ RepC $ AbsC $ set'));
wenzelm@19705
   146
    val typedef_deps = Term.fold_aterms (fn Const c => insert (op =) c | _ => I) set' [];
wenzelm@4866
   147
wenzelm@19705
   148
    fun add_def eq thy =
wenzelm@19705
   149
      if def then
haftmann@18358
   150
        thy
wenzelm@19705
   151
        |> PureThy.add_defs_i false [Thm.no_attributes eq]
wenzelm@19705
   152
        |-> (fn [th] => pair (SOME th))
wenzelm@19705
   153
      else (NONE, thy);
haftmann@18358
   154
wenzelm@21352
   155
    fun typedef_result nonempty =
wenzelm@21352
   156
      add_typedecls [(t, vs, mx)]
wenzelm@21352
   157
      #> Theory.add_consts_i
wenzelm@17280
   158
       ((if def then [(name, setT', NoSyn)] else []) @
wenzelm@6383
   159
        [(Rep_name, newT --> oldT, NoSyn),
wenzelm@6383
   160
         (Abs_name, oldT --> newT, NoSyn)])
wenzelm@21352
   161
      #> add_def (Logic.mk_defpair (setC, set))
wenzelm@21352
   162
      ##>> PureThy.add_axioms_i [((typedef_name, typedef_prop),
wenzelm@20046
   163
          [apsnd (fn cond_axm => nonempty RS cond_axm)])]
wenzelm@21352
   164
      ##> Theory.add_deps "" (dest_Const RepC) typedef_deps
wenzelm@21352
   165
      ##> Theory.add_deps "" (dest_Const AbsC) typedef_deps
wenzelm@21352
   166
      #-> (fn (set_def, [type_definition]) => fn thy1 =>
wenzelm@11822
   167
        let
wenzelm@11822
   168
          fun make th = Drule.standard (th OF [type_definition]);
haftmann@19342
   169
          val abs_inject = make Abs_inject;
haftmann@19342
   170
          val abs_inverse = make Abs_inverse;
haftmann@18377
   171
          val ([Rep, Rep_inverse, Abs_inverse, Rep_inject, Abs_inject,
wenzelm@19705
   172
              Rep_cases, Abs_cases, Rep_induct, Abs_induct], thy2) =
wenzelm@19705
   173
            thy1
wenzelm@12338
   174
            |> Theory.add_path name
wenzelm@12338
   175
            |> PureThy.add_thms
wenzelm@11822
   176
              ([((Rep_name, make Rep), []),
wenzelm@11822
   177
                ((Rep_name ^ "_inverse", make Rep_inverse), []),
haftmann@19342
   178
                ((Abs_name ^ "_inverse", abs_inverse), []),
wenzelm@11822
   179
                ((Rep_name ^ "_inject", make Rep_inject), []),
haftmann@19342
   180
                ((Abs_name ^ "_inject", abs_inject), []),
wenzelm@11822
   181
                ((Rep_name ^ "_cases", make Rep_cases),
wenzelm@18728
   182
                  [RuleCases.case_names [Rep_name], InductAttrib.cases_set full_name]),
wenzelm@11822
   183
                ((Abs_name ^ "_cases", make Abs_cases),
wenzelm@18728
   184
                  [RuleCases.case_names [Abs_name], InductAttrib.cases_type full_tname]),
wenzelm@11822
   185
                ((Rep_name ^ "_induct", make Rep_induct),
wenzelm@18728
   186
                  [RuleCases.case_names [Rep_name], InductAttrib.induct_set full_name]),
wenzelm@11822
   187
                ((Abs_name ^ "_induct", make Abs_induct),
wenzelm@18728
   188
                  [RuleCases.case_names [Abs_name], InductAttrib.induct_type full_tname])])
wenzelm@19705
   189
            ||> Theory.parent_path;
wenzelm@19705
   190
          val info = {rep_type = oldT, abs_type = newT,
wenzelm@19705
   191
            Rep_name = full Rep_name, Abs_name = full Abs_name,
wenzelm@19705
   192
              type_definition = type_definition, set_def = set_def,
wenzelm@19705
   193
              Rep = Rep, Rep_inverse = Rep_inverse, Abs_inverse = Abs_inverse,
wenzelm@19705
   194
              Rep_inject = Rep_inject, Abs_inject = Abs_inject, Rep_cases = Rep_cases,
wenzelm@11822
   195
            Abs_cases = Abs_cases, Rep_induct = Rep_induct, Abs_induct = Abs_induct};
wenzelm@19705
   196
          val thy3 = thy2 |> put_info full_tname info;
wenzelm@21352
   197
        in ((full_tname, info), thy3) end);
wenzelm@6383
   198
wenzelm@4866
   199
wenzelm@4866
   200
    (* errors *)
wenzelm@4866
   201
wenzelm@4866
   202
    fun show_names pairs = commas_quote (map fst pairs);
wenzelm@4866
   203
wenzelm@4866
   204
    val illegal_vars =
wenzelm@4866
   205
      if null (term_vars set) andalso null (term_tvars set) then []
wenzelm@4866
   206
      else ["Illegal schematic variable(s) on rhs"];
wenzelm@4866
   207
wenzelm@4866
   208
    val dup_lhs_tfrees =
wenzelm@18964
   209
      (case duplicates (op =) lhs_tfrees of [] => []
wenzelm@4866
   210
      | dups => ["Duplicate type variables on lhs: " ^ show_names dups]);
wenzelm@4866
   211
wenzelm@4866
   212
    val extra_rhs_tfrees =
wenzelm@17280
   213
      (case fold (remove (op =)) lhs_tfrees rhs_tfrees of [] => []
wenzelm@4866
   214
      | extras => ["Extra type variables on rhs: " ^ show_names extras]);
wenzelm@4866
   215
wenzelm@4866
   216
    val illegal_frees =
wenzelm@4866
   217
      (case term_frees set of [] => []
wenzelm@4866
   218
      | xs => ["Illegal variables on rhs: " ^ show_names (map dest_Free xs)]);
wenzelm@4866
   219
wenzelm@4866
   220
    val errs = illegal_vars @ dup_lhs_tfrees @ extra_rhs_tfrees @ illegal_frees;
wenzelm@11426
   221
    val _ = if null errs then () else error (cat_lines errs);
wenzelm@11426
   222
wenzelm@11426
   223
    (*test theory errors now!*)
wenzelm@11426
   224
    val test_thy = Theory.copy thy;
wenzelm@21352
   225
    val _ = test_thy
haftmann@19342
   226
      |> typedef_result (setmp quick_and_dirty true (SkipProof.make_thm test_thy) goal);
wenzelm@11426
   227
wenzelm@21352
   228
  in (set, goal, goal_pat, typedef_result) end
wenzelm@18678
   229
  handle ERROR msg => err_in_typedef msg name;
wenzelm@4866
   230
wenzelm@4866
   231
wenzelm@6383
   232
(* add_typedef interfaces *)
wenzelm@4866
   233
wenzelm@17339
   234
local
wenzelm@17339
   235
wenzelm@17922
   236
fun gen_typedef prep_term def opt_name typ set opt_morphs tac thy =
wenzelm@6383
   237
  let
wenzelm@21352
   238
    val string_of_term = ProofContext.string_of_term (ProofContext.init thy);
wenzelm@17922
   239
    val name = the_default (#1 typ) opt_name;
wenzelm@21352
   240
    val (set, goal, _, typedef_result) =
wenzelm@11822
   241
      prepare_typedef prep_term def name typ set opt_morphs thy;
wenzelm@21352
   242
    val _ = message ("Proving non-emptiness of set " ^ quote (string_of_term set) ^ " ...");
wenzelm@20046
   243
    val non_empty = Goal.prove_global thy [] [] goal (K tac) handle ERROR msg =>
wenzelm@21352
   244
      cat_error msg ("Failed to prove non-emptiness of " ^ quote (string_of_term set));
wenzelm@21352
   245
  in typedef_result non_empty thy end;
wenzelm@4866
   246
wenzelm@17339
   247
in
wenzelm@17339
   248
wenzelm@21352
   249
val add_typedef = gen_typedef ProofContext.read_term;
wenzelm@21352
   250
val add_typedef_i = gen_typedef ProofContext.cert_term;
wenzelm@4866
   251
wenzelm@17339
   252
end;
wenzelm@4866
   253
wenzelm@17339
   254
wenzelm@17339
   255
(* Isar typedef interface *)
wenzelm@6383
   256
wenzelm@17339
   257
local
wenzelm@17339
   258
wenzelm@17339
   259
fun gen_typedef prep_term ((def, name), typ, set, opt_morphs) thy =
wenzelm@11822
   260
  let
wenzelm@19705
   261
    val (_, goal, goal_pat, typedef_result) =
wenzelm@13443
   262
      prepare_typedef prep_term def name typ set opt_morphs thy;
wenzelm@21352
   263
    fun after_qed [[th]] = ProofContext.theory (snd o typedef_result th);
wenzelm@21434
   264
  in Proof.theorem_i NONE after_qed [[(goal, [goal_pat])]] (ProofContext.init thy) end;
wenzelm@17339
   265
wenzelm@17339
   266
in
wenzelm@6383
   267
wenzelm@21352
   268
val typedef = gen_typedef ProofContext.read_term;
wenzelm@21352
   269
val typedef_i = gen_typedef ProofContext.cert_term;
wenzelm@17339
   270
wenzelm@19705
   271
end;
berghofe@15259
   272
haftmann@19459
   273
val setup = TypedefData.init;
berghofe@15259
   274
berghofe@15259
   275
berghofe@15259
   276
wenzelm@6383
   277
(** outer syntax **)
wenzelm@6383
   278
wenzelm@17057
   279
local structure P = OuterParse and K = OuterKeyword in
wenzelm@6383
   280
wenzelm@6357
   281
val typedeclP =
wenzelm@12624
   282
  OuterSyntax.command "typedecl" "type declaration (HOL)" K.thy_decl
wenzelm@12876
   283
    (P.type_args -- P.name -- P.opt_infix >> (fn ((vs, t), mx) =>
wenzelm@6357
   284
      Toplevel.theory (add_typedecls [(t, vs, mx)])));
wenzelm@6357
   285
wenzelm@6723
   286
wenzelm@17339
   287
val typedef_decl =
wenzelm@16126
   288
  Scan.optional (P.$$$ "(" |--
wenzelm@16126
   289
      ((P.$$$ "open" >> K false) -- Scan.option P.name || P.name >> (fn s => (true, SOME s)))
wenzelm@16126
   290
        --| P.$$$ ")") (true, NONE) --
wenzelm@11744
   291
    (P.type_args -- P.name) -- P.opt_infix -- (P.$$$ "=" |-- P.term) --
wenzelm@12876
   292
    Scan.option (P.$$$ "morphisms" |-- P.!!! (P.name -- P.name));
wenzelm@6357
   293
wenzelm@17339
   294
fun mk_typedef ((((((def, opt_name), (vs, t)), mx), A), morphs)) =
wenzelm@19473
   295
  typedef ((def, the_default (Syntax.type_name t mx) opt_name), (t, vs, mx), A, morphs);
wenzelm@6357
   296
wenzelm@6357
   297
val typedefP =
wenzelm@6723
   298
  OuterSyntax.command "typedef" "HOL type definition (requires non-emptiness proof)" K.thy_goal
wenzelm@17339
   299
    (typedef_decl >> (Toplevel.print oo (Toplevel.theory_to_proof o mk_typedef)));
wenzelm@6357
   300
wenzelm@6723
   301
wenzelm@11744
   302
val _ = OuterSyntax.add_keywords ["morphisms"];
wenzelm@6357
   303
val _ = OuterSyntax.add_parsers [typedeclP, typedefP];
wenzelm@6357
   304
wenzelm@4866
   305
end;
wenzelm@6383
   306
wenzelm@6383
   307
end;