src/HOL/Tools/Datatype/datatype_aux.ML
author haftmann
Fri Oct 09 13:34:40 2009 +0200 (2009-10-09 ago)
changeset 32900 dc883c6126d4
parent 32733 71618deaf777
child 32952 aeb1e44fbc19
permissions -rw-r--r--
dropped simproc_dist formally
berghofe@5177
     1
(*  Title:      HOL/Tools/datatype_aux.ML
wenzelm@11539
     2
    Author:     Stefan Berghofer, TU Muenchen
berghofe@5177
     3
wenzelm@11539
     4
Auxiliary functions for defining datatypes.
berghofe@5177
     5
*)
berghofe@5177
     6
haftmann@31737
     7
signature DATATYPE_COMMON =
haftmann@31737
     8
sig
haftmann@31737
     9
  type config
haftmann@31737
    10
  val default_config : config
haftmann@31737
    11
  datatype dtyp =
haftmann@31737
    12
      DtTFree of string
haftmann@31737
    13
    | DtType of string * (dtyp list)
haftmann@31737
    14
    | DtRec of int;
haftmann@31737
    15
  type descr
haftmann@31737
    16
  type info
haftmann@31737
    17
end
haftmann@31737
    18
berghofe@5177
    19
signature DATATYPE_AUX =
berghofe@5177
    20
sig
haftmann@31737
    21
  include DATATYPE_COMMON
haftmann@31737
    22
haftmann@31737
    23
  val message : config -> string -> unit
berghofe@5661
    24
  
wenzelm@18728
    25
  val store_thmss_atts : string -> string list -> attribute list list -> thm list list
berghofe@18349
    26
    -> theory -> thm list list * theory
haftmann@18314
    27
  val store_thmss : string -> string list -> thm list list -> theory -> thm list list * theory
wenzelm@18728
    28
  val store_thms_atts : string -> string list -> attribute list list -> thm list
haftmann@18314
    29
    -> theory -> thm list * theory
haftmann@18314
    30
  val store_thms : string -> string list -> thm list -> theory -> thm list * theory
berghofe@5177
    31
berghofe@5177
    32
  val split_conj_thm : thm -> thm list
berghofe@5177
    33
  val mk_conj : term list -> term
berghofe@5177
    34
  val mk_disj : term list -> term
berghofe@5177
    35
berghofe@13641
    36
  val app_bnds : term -> int -> term
berghofe@13641
    37
berghofe@25676
    38
  val indtac : thm -> string list -> int -> tactic
berghofe@5177
    39
  val exh_tac : (string -> thm) -> int -> tactic
berghofe@5177
    40
berghofe@7015
    41
  exception Datatype
berghofe@14887
    42
  exception Datatype_Empty of string
berghofe@9740
    43
  val name_of_typ : typ -> string
berghofe@5177
    44
  val dtyp_of_typ : (string * string list) list -> typ -> dtyp
berghofe@5177
    45
  val mk_Free : string -> typ -> int -> term
berghofe@5177
    46
  val is_rec_type : dtyp -> bool
berghofe@13641
    47
  val typ_of_dtyp : descr -> (string * sort) list -> dtyp -> typ
berghofe@5177
    48
  val dest_DtTFree : dtyp -> string
berghofe@5177
    49
  val dest_DtRec : dtyp -> int
berghofe@13641
    50
  val strip_dtyp : dtyp -> dtyp list * dtyp
berghofe@13641
    51
  val body_index : dtyp -> int
berghofe@13641
    52
  val mk_fun_dtyp : dtyp list -> dtyp -> dtyp
berghofe@13641
    53
  val get_nonrec_types : descr -> (string * sort) list -> typ list
berghofe@13641
    54
  val get_branching_types : descr -> (string * sort) list -> typ list
berghofe@13641
    55
  val get_arities : descr -> int list
berghofe@13641
    56
  val get_rec_types : descr -> (string * sort) list -> typ list
haftmann@31605
    57
  val interpret_construction : descr -> (string * sort) list
haftmann@31605
    58
    -> { atyp: typ -> 'a, dtyp: typ list -> int * bool -> string * typ list -> 'a }
haftmann@31605
    59
    -> ((string * Term.typ list) * (string * 'a list) list) list
berghofe@13641
    60
  val check_nonempty : descr list -> unit
berghofe@5177
    61
  val unfold_datatypes : 
haftmann@31737
    62
    theory -> descr -> (string * sort) list -> info Symtab.table ->
berghofe@13641
    63
      descr -> int -> descr list * int
berghofe@5177
    64
end;
berghofe@5177
    65
berghofe@5177
    66
structure DatatypeAux : DATATYPE_AUX =
berghofe@5177
    67
struct
berghofe@5177
    68
haftmann@31668
    69
(* datatype option flags *)
haftmann@31668
    70
haftmann@32124
    71
type config = { strict: bool, quiet: bool };
haftmann@31737
    72
val default_config : config =
haftmann@32124
    73
  { strict = true, quiet = false };
haftmann@31737
    74
fun message ({ quiet, ...} : config) s =
haftmann@31668
    75
  if quiet then () else writeln s;
berghofe@5661
    76
wenzelm@8435
    77
berghofe@5177
    78
(* store theorems in theory *)
berghofe@5177
    79
haftmann@18377
    80
fun store_thmss_atts label tnames attss thmss =
haftmann@18377
    81
  fold_map (fn ((tname, atts), thms) =>
wenzelm@24712
    82
    Sign.add_path tname
haftmann@29579
    83
    #> PureThy.add_thmss [((Binding.name label, thms), atts)]
wenzelm@28361
    84
    #-> (fn thm::_ => Sign.parent_path #> pair thm)) (tnames ~~ attss ~~ thmss)
wenzelm@28361
    85
  ##> Theory.checkpoint;
berghofe@5177
    86
berghofe@18101
    87
fun store_thmss label tnames = store_thmss_atts label tnames (replicate (length tnames) []);
berghofe@18101
    88
haftmann@18377
    89
fun store_thms_atts label tnames attss thmss =
haftmann@18377
    90
  fold_map (fn ((tname, atts), thms) =>
wenzelm@24712
    91
    Sign.add_path tname
haftmann@29579
    92
    #> PureThy.add_thms [((Binding.name label, thms), atts)]
wenzelm@28361
    93
    #-> (fn thm::_ => Sign.parent_path #> pair thm)) (tnames ~~ attss ~~ thmss)
wenzelm@28361
    94
  ##> Theory.checkpoint;
wenzelm@8435
    95
wenzelm@8435
    96
fun store_thms label tnames = store_thms_atts label tnames (replicate (length tnames) []);
wenzelm@8435
    97
berghofe@5177
    98
berghofe@5177
    99
(* split theorem thm_1 & ... & thm_n into n theorems *)
berghofe@5177
   100
berghofe@5177
   101
fun split_conj_thm th =
berghofe@7015
   102
  ((th RS conjunct1)::(split_conj_thm (th RS conjunct2))) handle THM _ => [th];
berghofe@5177
   103
berghofe@5177
   104
val mk_conj = foldr1 (HOLogic.mk_binop "op &");
berghofe@5177
   105
val mk_disj = foldr1 (HOLogic.mk_binop "op |");
berghofe@5177
   106
berghofe@13641
   107
fun app_bnds t i = list_comb (t, map Bound (i - 1 downto 0));
berghofe@13641
   108
berghofe@13641
   109
berghofe@5177
   110
(* instantiate induction rule *)
berghofe@5177
   111
berghofe@25676
   112
fun indtac indrule indnames i st =
berghofe@5177
   113
  let
wenzelm@8305
   114
    val ts = HOLogic.dest_conj (HOLogic.dest_Trueprop (concl_of indrule));
wenzelm@8305
   115
    val ts' = HOLogic.dest_conj (HOLogic.dest_Trueprop
skalberg@15570
   116
      (Logic.strip_imp_concl (List.nth (prems_of st, i - 1))));
berghofe@5177
   117
    val getP = if can HOLogic.dest_imp (hd ts) then
skalberg@15531
   118
      (apfst SOME) o HOLogic.dest_imp else pair NONE;
berghofe@25676
   119
    val flt = if null indnames then I else
berghofe@25676
   120
      filter (fn Free (s, _) => s mem indnames | _ => false);
berghofe@5177
   121
    fun abstr (t1, t2) = (case t1 of
wenzelm@29265
   122
        NONE => (case flt (OldTerm.term_frees t2) of
berghofe@25676
   123
            [Free (s, T)] => SOME (absfree (s, T, t2))
berghofe@25676
   124
          | _ => NONE)
berghofe@25676
   125
      | SOME (_ $ t') => SOME (Abs ("x", fastype_of t', abstract_over (t', t2))))
wenzelm@22578
   126
    val cert = cterm_of (Thm.theory_of_thm st);
berghofe@25676
   127
    val insts = List.mapPartial (fn (t, u) => case abstr (getP u) of
berghofe@25676
   128
        NONE => NONE
berghofe@25676
   129
      | SOME u' => SOME (t |> getP |> snd |> head_of |> cert, cert u')) (ts ~~ ts');
berghofe@25676
   130
    val indrule' = cterm_instantiate insts indrule
berghofe@5177
   131
  in
berghofe@5177
   132
    rtac indrule' i st
berghofe@5177
   133
  end;
berghofe@5177
   134
berghofe@5177
   135
(* perform exhaustive case analysis on last parameter of subgoal i *)
berghofe@5177
   136
berghofe@5177
   137
fun exh_tac exh_thm_of i state =
berghofe@5177
   138
  let
wenzelm@22578
   139
    val thy = Thm.theory_of_thm state;
haftmann@21420
   140
    val prem = nth (prems_of state) (i - 1);
berghofe@5177
   141
    val params = Logic.strip_params prem;
berghofe@5177
   142
    val (_, Type (tname, _)) = hd (rev params);
wenzelm@18145
   143
    val exhaustion = Thm.lift_rule (Thm.cprem_of state i) (exh_thm_of tname);
berghofe@5177
   144
    val prem' = hd (prems_of exhaustion);
berghofe@5177
   145
    val _ $ (_ $ lhs $ _) = hd (rev (Logic.strip_assums_hyp prem'));
haftmann@21420
   146
    val exhaustion' = cterm_instantiate [(cterm_of thy (head_of lhs),
wenzelm@30190
   147
      cterm_of thy (List.foldr (fn ((_, T), t) => Abs ("z", T, t))
skalberg@15574
   148
        (Bound 0) params))] exhaustion
berghofe@5177
   149
  in compose_tac (false, exhaustion', nprems_of exhaustion) i state
berghofe@5177
   150
  end;
berghofe@5177
   151
berghofe@7015
   152
berghofe@5177
   153
(********************** Internal description of datatypes *********************)
berghofe@5177
   154
berghofe@5177
   155
datatype dtyp =
berghofe@5177
   156
    DtTFree of string
berghofe@5177
   157
  | DtType of string * (dtyp list)
berghofe@5177
   158
  | DtRec of int;
berghofe@5177
   159
berghofe@5177
   160
(* information about datatypes *)
berghofe@5177
   161
berghofe@16901
   162
(* index, datatype name, type arguments, constructor name, types of constructor's arguments *)
wenzelm@8404
   163
type descr = (int * (string * dtyp list * (string * dtyp list) list)) list;
wenzelm@8404
   164
haftmann@31737
   165
type info =
berghofe@5177
   166
  {index : int,
berghofe@25676
   167
   alt_names : string list option,
wenzelm@8404
   168
   descr : descr,
berghofe@18319
   169
   sorts : (string * sort) list,
haftmann@32718
   170
   inject : thm list,
haftmann@32900
   171
   distinct : thm list,
haftmann@32727
   172
   induct : thm,
haftmann@32727
   173
   inducts : thm list,
haftmann@32718
   174
   exhaust : thm,
haftmann@32718
   175
   nchotomy : thm,
berghofe@5177
   176
   rec_names : string list,
berghofe@5177
   177
   rec_rewrites : thm list,
berghofe@5177
   178
   case_name : string,
berghofe@5177
   179
   case_rewrites : thm list,
wenzelm@10120
   180
   case_cong : thm,
haftmann@32718
   181
   weak_case_cong : thm,
haftmann@32727
   182
   split : thm,
haftmann@32727
   183
   split_asm: thm};
berghofe@5177
   184
berghofe@5177
   185
fun mk_Free s T i = Free (s ^ (string_of_int i), T);
berghofe@5177
   186
berghofe@5177
   187
fun subst_DtTFree _ substs (T as (DtTFree name)) =
haftmann@17485
   188
      AList.lookup (op =) substs name |> the_default T
berghofe@5177
   189
  | subst_DtTFree i substs (DtType (name, ts)) =
berghofe@5177
   190
      DtType (name, map (subst_DtTFree i substs) ts)
berghofe@5177
   191
  | subst_DtTFree i _ (DtRec j) = DtRec (i + j);
berghofe@5177
   192
berghofe@7015
   193
exception Datatype;
berghofe@14887
   194
exception Datatype_Empty of string;
berghofe@7015
   195
berghofe@7015
   196
fun dest_DtTFree (DtTFree a) = a
berghofe@7015
   197
  | dest_DtTFree _ = raise Datatype;
berghofe@7015
   198
berghofe@7015
   199
fun dest_DtRec (DtRec i) = i
berghofe@7015
   200
  | dest_DtRec _ = raise Datatype;
berghofe@5177
   201
berghofe@5177
   202
fun is_rec_type (DtType (_, dts)) = exists is_rec_type dts
berghofe@5177
   203
  | is_rec_type (DtRec _) = true
berghofe@5177
   204
  | is_rec_type _ = false;
berghofe@5177
   205
berghofe@13641
   206
fun strip_dtyp (DtType ("fun", [T, U])) = apfst (cons T) (strip_dtyp U)
berghofe@13641
   207
  | strip_dtyp T = ([], T);
berghofe@13641
   208
berghofe@13641
   209
val body_index = dest_DtRec o snd o strip_dtyp;
berghofe@13641
   210
berghofe@13641
   211
fun mk_fun_dtyp [] U = U
berghofe@13641
   212
  | mk_fun_dtyp (T :: Ts) U = DtType ("fun", [T, mk_fun_dtyp Ts U]);
berghofe@13641
   213
berghofe@13707
   214
fun name_of_typ (Type (s, Ts)) =
wenzelm@30364
   215
      let val s' = Long_Name.base_name s
skalberg@15570
   216
      in space_implode "_" (List.filter (not o equal "") (map name_of_typ Ts) @
wenzelm@14673
   217
        [if Syntax.is_identifier s' then s' else "x"])
berghofe@13707
   218
      end
berghofe@9740
   219
  | name_of_typ _ = "";
berghofe@9740
   220
berghofe@5177
   221
fun dtyp_of_typ _ (TFree (n, _)) = DtTFree n
berghofe@5177
   222
  | dtyp_of_typ _ (TVar _) = error "Illegal schematic type variable(s)"
berghofe@5177
   223
  | dtyp_of_typ new_dts (Type (tname, Ts)) =
haftmann@17485
   224
      (case AList.lookup (op =) new_dts tname of
skalberg@15531
   225
         NONE => DtType (tname, map (dtyp_of_typ new_dts) Ts)
berghofe@25888
   226
       | SOME vs => if map (try (fst o dest_TFree)) Ts = map SOME vs then
berghofe@5177
   227
             DtRec (find_index (curry op = tname o fst) new_dts)
huffman@18069
   228
           else error ("Illegal occurrence of recursive type " ^ tname));
berghofe@5177
   229
haftmann@17485
   230
fun typ_of_dtyp descr sorts (DtTFree a) = TFree (a, (the o AList.lookup (op =) sorts) a)
berghofe@5177
   231
  | typ_of_dtyp descr sorts (DtRec i) =
haftmann@17485
   232
      let val (s, ds, _) = (the o AList.lookup (op =) descr) i
berghofe@5177
   233
      in Type (s, map (typ_of_dtyp descr sorts) ds) end
berghofe@5177
   234
  | typ_of_dtyp descr sorts (DtType (s, ds)) =
berghofe@5177
   235
      Type (s, map (typ_of_dtyp descr sorts) ds);
berghofe@5177
   236
berghofe@5177
   237
(* find all non-recursive types in datatype description *)
berghofe@5177
   238
berghofe@5177
   239
fun get_nonrec_types descr sorts =
skalberg@15570
   240
  map (typ_of_dtyp descr sorts) (Library.foldl (fn (Ts, (_, (_, _, constrs))) =>
skalberg@15570
   241
    Library.foldl (fn (Ts', (_, cargs)) =>
berghofe@13641
   242
      filter_out is_rec_type cargs union Ts') (Ts, constrs)) ([], descr));
berghofe@5177
   243
berghofe@5177
   244
(* get all recursive types in datatype description *)
berghofe@5177
   245
berghofe@5177
   246
fun get_rec_types descr sorts = map (fn (_ , (s, ds, _)) =>
berghofe@5177
   247
  Type (s, map (typ_of_dtyp descr sorts) ds)) descr;
berghofe@5177
   248
berghofe@7015
   249
(* get all branching types *)
berghofe@7015
   250
berghofe@13641
   251
fun get_branching_types descr sorts =
berghofe@26823
   252
  map (typ_of_dtyp descr sorts) (fold (fn (_, (_, _, constrs)) =>
berghofe@26823
   253
    fold (fn (_, cargs) => fold (strip_dtyp #> fst #> fold (insert op =)) cargs)
berghofe@26823
   254
      constrs) descr []);
berghofe@13641
   255
berghofe@26823
   256
fun get_arities descr = fold (fn (_, (_, _, constrs)) =>
berghofe@26823
   257
  fold (fn (_, cargs) => fold (insert op =) (map (length o fst o strip_dtyp)
berghofe@26823
   258
    (List.filter is_rec_type cargs))) constrs) descr [];
berghofe@7015
   259
haftmann@31605
   260
(* interpret construction of datatype *)
haftmann@31605
   261
haftmann@31605
   262
fun interpret_construction descr vs { atyp, dtyp } =
haftmann@31605
   263
  let
haftmann@31605
   264
    val typ_of_dtyp = typ_of_dtyp descr vs;
haftmann@31605
   265
    fun interpT dT = case strip_dtyp dT
haftmann@31605
   266
     of (dTs, DtRec l) =>
haftmann@31605
   267
          let
haftmann@31605
   268
            val (tyco, dTs', _) = (the o AList.lookup (op =) descr) l;
haftmann@31605
   269
            val Ts = map typ_of_dtyp dTs;
haftmann@31605
   270
            val Ts' = map typ_of_dtyp dTs';
haftmann@31605
   271
            val is_proper = forall (can dest_TFree) Ts';
haftmann@31605
   272
          in dtyp Ts (l, is_proper) (tyco, Ts') end
haftmann@31605
   273
      | _ => atyp (typ_of_dtyp dT);
haftmann@31605
   274
    fun interpC (c, dTs) = (c, map interpT dTs);
haftmann@31605
   275
    fun interpD (_, (tyco, dTs, cs)) = ((tyco, map typ_of_dtyp dTs), map interpC cs);
haftmann@31605
   276
  in map interpD descr end;
haftmann@31605
   277
berghofe@5177
   278
(* nonemptiness check for datatypes *)
berghofe@5177
   279
berghofe@5177
   280
fun check_nonempty descr =
berghofe@5177
   281
  let
skalberg@15570
   282
    val descr' = List.concat descr;
berghofe@5177
   283
    fun is_nonempty_dt is i =
berghofe@5177
   284
      let
haftmann@17485
   285
        val (_, _, constrs) = (the o AList.lookup (op =) descr') i;
berghofe@13641
   286
        fun arg_nonempty (_, DtRec i) = if i mem is then false
berghofe@5177
   287
              else is_nonempty_dt (i::is) i
berghofe@5177
   288
          | arg_nonempty _ = true;
berghofe@13641
   289
      in exists ((forall (arg_nonempty o strip_dtyp)) o snd) constrs
berghofe@5177
   290
      end
berghofe@5177
   291
  in assert_all (fn (i, _) => is_nonempty_dt [i] i) (hd descr)
berghofe@14887
   292
    (fn (_, (s, _, _)) => raise Datatype_Empty s)
berghofe@5177
   293
  end;
berghofe@5177
   294
berghofe@5177
   295
(* unfold a list of mutually recursive datatype specifications *)
berghofe@5177
   296
(* all types of the form DtType (dt_name, [..., DtRec _, ...]) *)
berghofe@5177
   297
(* need to be unfolded                                         *)
berghofe@5177
   298
haftmann@31737
   299
fun unfold_datatypes sign orig_descr sorts (dt_info : info Symtab.table) descr i =
berghofe@5177
   300
  let
berghofe@7015
   301
    fun typ_error T msg = error ("Non-admissible type expression\n" ^
wenzelm@26939
   302
      Syntax.string_of_typ_global sign (typ_of_dtyp (orig_descr @ descr) sorts T) ^ "\n" ^ msg);
berghofe@7015
   303
berghofe@7015
   304
    fun get_dt_descr T i tname dts =
wenzelm@17412
   305
      (case Symtab.lookup dt_info tname of
skalberg@15531
   306
         NONE => typ_error T (tname ^ " is not a datatype - can't use it in\
berghofe@7015
   307
           \ nested recursion")
skalberg@15531
   308
       | (SOME {index, descr, ...}) =>
haftmann@17485
   309
           let val (_, vars, _) = (the o AList.lookup (op =) descr) index;
wenzelm@19841
   310
               val subst = ((map dest_DtTFree vars) ~~ dts) handle Library.UnequalLengths =>
berghofe@7015
   311
                 typ_error T ("Type constructor " ^ tname ^ " used with wrong\
berghofe@5177
   312
                  \ number of arguments")
berghofe@5177
   313
           in (i + index, map (fn (j, (tn, args, cs)) => (i + j,
berghofe@5177
   314
             (tn, map (subst_DtTFree i subst) args,
berghofe@5177
   315
              map (apsnd (map (subst_DtTFree i subst))) cs))) descr)
berghofe@5177
   316
           end);
berghofe@5177
   317
berghofe@5177
   318
    (* unfold a single constructor argument *)
berghofe@5177
   319
berghofe@13641
   320
    fun unfold_arg ((i, Ts, descrs), T) =
berghofe@13641
   321
      if is_rec_type T then
berghofe@13641
   322
        let val (Us, U) = strip_dtyp T
berghofe@13641
   323
        in if exists is_rec_type Us then
berghofe@13641
   324
            typ_error T "Non-strictly positive recursive occurrence of type"
berghofe@13641
   325
          else (case U of
berghofe@13641
   326
              DtType (tname, dts) =>  
berghofe@13641
   327
                let
berghofe@13641
   328
                  val (index, descr) = get_dt_descr T i tname dts;
berghofe@13641
   329
                  val (descr', i') = unfold_datatypes sign orig_descr sorts
berghofe@13641
   330
                    dt_info descr (i + length descr)
berghofe@13641
   331
                in (i', Ts @ [mk_fun_dtyp Us (DtRec index)], descrs @ descr') end
berghofe@13641
   332
            | _ => (i, Ts @ [T], descrs))
berghofe@13641
   333
        end
berghofe@13641
   334
      else (i, Ts @ [T], descrs);
berghofe@5177
   335
berghofe@5177
   336
    (* unfold a constructor *)
berghofe@5177
   337
berghofe@5177
   338
    fun unfold_constr ((i, constrs, descrs), (cname, cargs)) =
skalberg@15570
   339
      let val (i', cargs', descrs') = Library.foldl unfold_arg ((i, [], descrs), cargs)
berghofe@5177
   340
      in (i', constrs @ [(cname, cargs')], descrs') end;
berghofe@5177
   341
berghofe@5177
   342
    (* unfold a single datatype *)
berghofe@5177
   343
berghofe@5177
   344
    fun unfold_datatype ((i, dtypes, descrs), (j, (tname, tvars, constrs))) =
berghofe@5177
   345
      let val (i', constrs', descrs') =
skalberg@15570
   346
        Library.foldl unfold_constr ((i, [], descrs), constrs)
berghofe@5177
   347
      in (i', dtypes @ [(j, (tname, tvars, constrs'))], descrs')
berghofe@5177
   348
      end;
berghofe@5177
   349
skalberg@15570
   350
    val (i', descr', descrs) = Library.foldl unfold_datatype ((i, [],[]), descr);
berghofe@5177
   351
berghofe@5177
   352
  in (descr' :: descrs, i') end;
berghofe@5177
   353
berghofe@5177
   354
end;