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