src/HOL/Tools/datatype_aux.ML
author berghofe
Fri Jul 16 12:14:04 1999 +0200 (1999-07-16)
changeset 7015 85be09eb136c
parent 6394 3d9fd50fcc43
child 8305 93aa21ec5494
permissions -rw-r--r--
- Datatype package now also supports arbitrarily branching datatypes
(using function types).
- Added new simplification procedure for proving distinctness of
constructors.
- dtK is now a reference.
berghofe@5177
     1
(*  Title:      HOL/Tools/datatype_aux.ML
berghofe@5177
     2
    ID:         $Id$
berghofe@5177
     3
    Author:     Stefan Berghofer
berghofe@5177
     4
    Copyright   1998  TU Muenchen
berghofe@5177
     5
berghofe@5177
     6
Auxiliary functions for defining datatypes
berghofe@5177
     7
*)
berghofe@5177
     8
berghofe@5177
     9
signature DATATYPE_AUX =
berghofe@5177
    10
sig
berghofe@5661
    11
  val quiet_mode : bool ref
berghofe@5661
    12
  val message : string -> unit
berghofe@5661
    13
  
berghofe@5177
    14
  val foldl1 : ('a * 'a -> 'a) -> 'a list -> 'a
berghofe@5177
    15
berghofe@5661
    16
  val add_path : bool -> string -> theory -> theory
berghofe@5661
    17
  val parent_path : bool -> theory -> theory
berghofe@5661
    18
berghofe@5177
    19
  val store_thmss : string -> string list -> thm list list -> theory -> theory
berghofe@5177
    20
  val store_thms : string -> string list -> thm list -> theory -> 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@5177
    26
  val indtac : thm -> int -> tactic
berghofe@5177
    27
  val exh_tac : (string -> thm) -> int -> tactic
berghofe@5177
    28
berghofe@7015
    29
  datatype simproc_dist = QuickAndDirty
berghofe@7015
    30
                        | FewConstrs of thm list
berghofe@7015
    31
                        | ManyConstrs of thm * simpset;
berghofe@7015
    32
berghofe@5177
    33
  datatype dtyp =
berghofe@5177
    34
      DtTFree of string
berghofe@5177
    35
    | DtType of string * (dtyp list)
berghofe@5177
    36
    | DtRec of int;
berghofe@5177
    37
berghofe@5177
    38
  type datatype_info
berghofe@5177
    39
berghofe@7015
    40
  exception Datatype
berghofe@5177
    41
  val dtyp_of_typ : (string * string list) list -> typ -> dtyp
berghofe@5177
    42
  val mk_Free : string -> typ -> int -> term
berghofe@5177
    43
  val is_rec_type : dtyp -> bool
berghofe@5177
    44
  val typ_of_dtyp : (int * (string * dtyp list *
berghofe@5177
    45
    (string * dtyp list) list)) list -> (string * sort) list -> dtyp -> typ
berghofe@5177
    46
  val dest_DtTFree : dtyp -> string
berghofe@5177
    47
  val dest_DtRec : dtyp -> int
berghofe@5177
    48
  val dest_TFree : typ -> string
berghofe@5177
    49
  val dest_conj : term -> term list
berghofe@5177
    50
  val get_nonrec_types : (int * (string * dtyp list *
berghofe@5177
    51
    (string * dtyp list) list)) list -> (string * sort) list -> typ list
berghofe@7015
    52
  val get_branching_types : (int * (string * dtyp list *
berghofe@7015
    53
    (string * dtyp list) list)) list -> (string * sort) list -> typ list
berghofe@5177
    54
  val get_rec_types : (int * (string * dtyp list *
berghofe@5177
    55
    (string * dtyp list) list)) list -> (string * sort) list -> typ list
berghofe@5177
    56
  val check_nonempty : (int * (string * dtyp list *
berghofe@5177
    57
    (string * dtyp list) list)) list list -> unit
berghofe@5177
    58
  val unfold_datatypes : 
berghofe@7015
    59
    Sign.sg -> (int * (string * dtyp list * (string * dtyp list) list)) list ->
berghofe@7015
    60
      (string * sort) list -> datatype_info Symtab.table ->
berghofe@7015
    61
        (int * (string * dtyp list * (string * dtyp list) list)) list -> int ->
berghofe@5177
    62
          (int * (string * dtyp list *
berghofe@5177
    63
            (string * dtyp list) list)) list list * int
berghofe@5177
    64
end;
berghofe@5177
    65
berghofe@5177
    66
structure DatatypeAux : DATATYPE_AUX =
berghofe@5177
    67
struct
berghofe@5177
    68
berghofe@5661
    69
val quiet_mode = ref false;
berghofe@5661
    70
fun message s = if !quiet_mode then () else writeln s;
berghofe@5661
    71
berghofe@5177
    72
(* FIXME: move to library ? *)
berghofe@5177
    73
fun foldl1 f (x::xs) = foldl f (x, xs);
berghofe@5177
    74
berghofe@5661
    75
fun add_path flat_names s = if flat_names then I else Theory.add_path s;
berghofe@5661
    76
fun parent_path flat_names = if flat_names then I else Theory.parent_path;
berghofe@5661
    77
berghofe@5177
    78
(* store theorems in theory *)
berghofe@5177
    79
berghofe@5177
    80
fun store_thmss label tnames thmss thy =
berghofe@5177
    81
  foldr (fn ((tname, thms), thy') => thy' |>
berghofe@5661
    82
    Theory.add_path tname |>
wenzelm@6092
    83
    PureThy.add_thmss [((label, thms), [])] |>
berghofe@5661
    84
    Theory.parent_path)
berghofe@5661
    85
      (tnames ~~ thmss, thy);
berghofe@5177
    86
berghofe@5177
    87
fun store_thms label tnames thms thy =
berghofe@5177
    88
  foldr (fn ((tname, thm), thy') => thy' |>
berghofe@5661
    89
    Theory.add_path tname |>
wenzelm@6092
    90
    PureThy.add_thms [((label, thm), [])] |>
berghofe@5661
    91
    Theory.parent_path)
berghofe@5661
    92
      (tnames ~~ thms, thy);
berghofe@5177
    93
berghofe@5177
    94
(* split theorem thm_1 & ... & thm_n into n theorems *)
berghofe@5177
    95
berghofe@5177
    96
fun split_conj_thm th =
berghofe@7015
    97
  ((th RS conjunct1)::(split_conj_thm (th RS conjunct2))) handle THM _ => [th];
berghofe@5177
    98
berghofe@5177
    99
val mk_conj = foldr1 (HOLogic.mk_binop "op &");
berghofe@5177
   100
val mk_disj = foldr1 (HOLogic.mk_binop "op |");
berghofe@5177
   101
berghofe@5177
   102
fun dest_conj (Const ("op &", _) $ t $ t') = t::(dest_conj t')
berghofe@5177
   103
  | dest_conj t = [t];
berghofe@5177
   104
berghofe@5177
   105
(* instantiate induction rule *)
berghofe@5177
   106
berghofe@5177
   107
fun indtac indrule i st =
berghofe@5177
   108
  let
berghofe@5177
   109
    val ts = dest_conj (HOLogic.dest_Trueprop (concl_of indrule));
berghofe@5177
   110
    val ts' = dest_conj (HOLogic.dest_Trueprop
berghofe@5177
   111
      (Logic.strip_imp_concl (nth_elem (i - 1, prems_of st))));
berghofe@5177
   112
    val getP = if can HOLogic.dest_imp (hd ts) then
berghofe@5177
   113
      (apfst Some) o HOLogic.dest_imp else pair None;
berghofe@5177
   114
    fun abstr (t1, t2) = (case t1 of
berghofe@5177
   115
        None => let val [Free (s, T)] = add_term_frees (t2, [])
berghofe@5177
   116
          in absfree (s, T, t2) end
berghofe@5177
   117
      | Some (_ $ t' $ _) => Abs ("x", fastype_of t', abstract_over (t', t2)))
wenzelm@6394
   118
    val cert = cterm_of (Thm.sign_of_thm st);
berghofe@5177
   119
    val Ps = map (cert o head_of o snd o getP) ts;
berghofe@5177
   120
    val indrule' = cterm_instantiate (Ps ~~
berghofe@5177
   121
      (map (cert o abstr o getP) ts')) indrule
berghofe@5177
   122
  in
berghofe@5177
   123
    rtac indrule' i st
berghofe@5177
   124
  end;
berghofe@5177
   125
berghofe@5177
   126
(* perform exhaustive case analysis on last parameter of subgoal i *)
berghofe@5177
   127
berghofe@5177
   128
fun exh_tac exh_thm_of i state =
berghofe@5177
   129
  let
wenzelm@6394
   130
    val sg = Thm.sign_of_thm state;
berghofe@5177
   131
    val prem = nth_elem (i - 1, prems_of state);
berghofe@5177
   132
    val params = Logic.strip_params prem;
berghofe@5177
   133
    val (_, Type (tname, _)) = hd (rev params);
berghofe@5177
   134
    val exhaustion = lift_rule (state, i) (exh_thm_of tname);
berghofe@5177
   135
    val prem' = hd (prems_of exhaustion);
berghofe@5177
   136
    val _ $ (_ $ lhs $ _) = hd (rev (Logic.strip_assums_hyp prem'));
berghofe@5177
   137
    val exhaustion' = cterm_instantiate [(cterm_of sg (head_of lhs),
berghofe@5177
   138
      cterm_of sg (foldr (fn ((_, T), t) => Abs ("z", T, t))
berghofe@5177
   139
        (params, Bound 0)))] exhaustion
berghofe@5177
   140
  in compose_tac (false, exhaustion', nprems_of exhaustion) i state
berghofe@5177
   141
  end;
berghofe@5177
   142
berghofe@7015
   143
(* handling of distinctness theorems *)
berghofe@7015
   144
berghofe@7015
   145
datatype simproc_dist = QuickAndDirty
berghofe@7015
   146
                      | FewConstrs of thm list
berghofe@7015
   147
                      | ManyConstrs of thm * simpset;
berghofe@7015
   148
berghofe@5177
   149
(********************** Internal description of datatypes *********************)
berghofe@5177
   150
berghofe@5177
   151
datatype dtyp =
berghofe@5177
   152
    DtTFree of string
berghofe@5177
   153
  | DtType of string * (dtyp list)
berghofe@5177
   154
  | DtRec of int;
berghofe@5177
   155
berghofe@5177
   156
(* information about datatypes *)
berghofe@5177
   157
berghofe@5177
   158
type datatype_info =
berghofe@5177
   159
  {index : int,
berghofe@5177
   160
   descr : (int * (string * dtyp list *
berghofe@5177
   161
     (string * dtyp list) list)) list,
berghofe@5177
   162
   rec_names : string list,
berghofe@5177
   163
   rec_rewrites : thm list,
berghofe@5177
   164
   case_name : string,
berghofe@5177
   165
   case_rewrites : thm list,
berghofe@5177
   166
   induction : thm,
berghofe@5177
   167
   exhaustion : thm,
berghofe@7015
   168
   distinct : simproc_dist,
berghofe@5177
   169
   inject : thm list,
berghofe@5177
   170
   nchotomy : thm,
berghofe@5177
   171
   case_cong : thm};
berghofe@5177
   172
berghofe@5177
   173
fun mk_Free s T i = Free (s ^ (string_of_int i), T);
berghofe@5177
   174
berghofe@5177
   175
fun subst_DtTFree _ substs (T as (DtTFree name)) =
berghofe@5177
   176
      (case assoc (substs, name) of
berghofe@5177
   177
         None => T
berghofe@5177
   178
       | Some U => U)
berghofe@5177
   179
  | subst_DtTFree i substs (DtType (name, ts)) =
berghofe@5177
   180
      DtType (name, map (subst_DtTFree i substs) ts)
berghofe@5177
   181
  | subst_DtTFree i _ (DtRec j) = DtRec (i + j);
berghofe@5177
   182
berghofe@7015
   183
exception Datatype;
berghofe@7015
   184
berghofe@7015
   185
fun dest_DtTFree (DtTFree a) = a
berghofe@7015
   186
  | dest_DtTFree _ = raise Datatype;
berghofe@7015
   187
berghofe@7015
   188
fun dest_DtRec (DtRec i) = i
berghofe@7015
   189
  | dest_DtRec _ = raise Datatype;
berghofe@5177
   190
berghofe@5177
   191
fun is_rec_type (DtType (_, dts)) = exists is_rec_type dts
berghofe@5177
   192
  | is_rec_type (DtRec _) = true
berghofe@5177
   193
  | is_rec_type _ = false;
berghofe@5177
   194
berghofe@5177
   195
fun dest_TFree (TFree (n, _)) = n;
berghofe@5177
   196
berghofe@5177
   197
fun dtyp_of_typ _ (TFree (n, _)) = DtTFree n
berghofe@5177
   198
  | dtyp_of_typ _ (TVar _) = error "Illegal schematic type variable(s)"
berghofe@5177
   199
  | dtyp_of_typ new_dts (Type (tname, Ts)) =
berghofe@5177
   200
      (case assoc (new_dts, tname) of
berghofe@5177
   201
         None => DtType (tname, map (dtyp_of_typ new_dts) Ts)
berghofe@5177
   202
       | Some vs => if map (try dest_TFree) Ts = map Some vs then
berghofe@5177
   203
             DtRec (find_index (curry op = tname o fst) new_dts)
berghofe@5177
   204
           else error ("Illegal occurence of recursive type " ^ tname));
berghofe@5177
   205
berghofe@5177
   206
fun typ_of_dtyp descr sorts (DtTFree a) = TFree (a, the (assoc (sorts, a)))
berghofe@5177
   207
  | typ_of_dtyp descr sorts (DtRec i) =
berghofe@5177
   208
      let val (s, ds, _) = the (assoc (descr, i))
berghofe@5177
   209
      in Type (s, map (typ_of_dtyp descr sorts) ds) end
berghofe@5177
   210
  | typ_of_dtyp descr sorts (DtType (s, ds)) =
berghofe@5177
   211
      Type (s, map (typ_of_dtyp descr sorts) ds);
berghofe@5177
   212
berghofe@5177
   213
(* find all non-recursive types in datatype description *)
berghofe@5177
   214
berghofe@5177
   215
fun get_nonrec_types descr sorts =
berghofe@5177
   216
  let fun add (Ts, T as DtTFree _) = T ins Ts
berghofe@7015
   217
        | add (Ts, T as DtType ("fun", [_, DtRec _])) = Ts
berghofe@5177
   218
        | add (Ts, T as DtType _) = T ins Ts
berghofe@5177
   219
        | add (Ts, _) = Ts
berghofe@5177
   220
  in map (typ_of_dtyp descr sorts) (foldl (fn (Ts, (_, (_, _, constrs))) =>
berghofe@5177
   221
    foldl (fn (Ts', (_, cargs)) =>
berghofe@5177
   222
      foldl add (Ts', cargs)) (Ts, constrs)) ([], descr))
berghofe@5177
   223
  end;
berghofe@5177
   224
berghofe@5177
   225
(* get all recursive types in datatype description *)
berghofe@5177
   226
berghofe@5177
   227
fun get_rec_types descr sorts = map (fn (_ , (s, ds, _)) =>
berghofe@5177
   228
  Type (s, map (typ_of_dtyp descr sorts) ds)) descr;
berghofe@5177
   229
berghofe@7015
   230
(* get all branching types *)
berghofe@7015
   231
berghofe@7015
   232
fun get_branching_types descr sorts = 
berghofe@7015
   233
  let fun add (Ts, DtType ("fun", [T, DtRec _])) = T ins Ts
berghofe@7015
   234
        | add (Ts, _) = Ts
berghofe@7015
   235
  in map (typ_of_dtyp descr sorts) (foldl (fn (Ts, (_, (_, _, constrs))) =>
berghofe@7015
   236
    foldl (fn (Ts', (_, cargs)) =>
berghofe@7015
   237
      foldl add (Ts', cargs)) (Ts, constrs)) ([], descr))
berghofe@7015
   238
  end;
berghofe@7015
   239
berghofe@5177
   240
(* nonemptiness check for datatypes *)
berghofe@5177
   241
berghofe@5177
   242
fun check_nonempty descr =
berghofe@5177
   243
  let
berghofe@5177
   244
    val descr' = flat descr;
berghofe@5177
   245
    fun is_nonempty_dt is i =
berghofe@5177
   246
      let
berghofe@5177
   247
        val (_, _, constrs) = the (assoc (descr', i));
berghofe@5177
   248
        fun arg_nonempty (DtRec i) = if i mem is then false
berghofe@5177
   249
              else is_nonempty_dt (i::is) i
berghofe@7015
   250
          | arg_nonempty (DtType ("fun", [_, T])) = arg_nonempty T
berghofe@5177
   251
          | arg_nonempty _ = true;
berghofe@5177
   252
      in exists ((forall arg_nonempty) o snd) constrs
berghofe@5177
   253
      end
berghofe@5177
   254
  in assert_all (fn (i, _) => is_nonempty_dt [i] i) (hd descr)
berghofe@5177
   255
    (fn (_, (s, _, _)) => "Nonemptiness check failed for datatype " ^ s)
berghofe@5177
   256
  end;
berghofe@5177
   257
berghofe@5177
   258
(* unfold a list of mutually recursive datatype specifications *)
berghofe@5177
   259
(* all types of the form DtType (dt_name, [..., DtRec _, ...]) *)
berghofe@5177
   260
(* need to be unfolded                                         *)
berghofe@5177
   261
berghofe@7015
   262
fun unfold_datatypes sign orig_descr sorts (dt_info : datatype_info Symtab.table) descr i =
berghofe@5177
   263
  let
berghofe@7015
   264
    fun typ_error T msg = error ("Non-admissible type expression\n" ^
berghofe@7015
   265
      Sign.string_of_typ sign (typ_of_dtyp (orig_descr @ descr) sorts T) ^ "\n" ^ msg);
berghofe@7015
   266
berghofe@7015
   267
    fun get_dt_descr T i tname dts =
berghofe@5177
   268
      (case Symtab.lookup (dt_info, tname) of
berghofe@7015
   269
         None => typ_error T (tname ^ " is not a datatype - can't use it in\
berghofe@7015
   270
           \ nested recursion")
berghofe@5177
   271
       | (Some {index, descr, ...}) =>
berghofe@5177
   272
           let val (_, vars, _) = the (assoc (descr, index));
berghofe@7015
   273
               val subst = ((map dest_DtTFree vars) ~~ dts) handle LIST _ =>
berghofe@7015
   274
                 typ_error T ("Type constructor " ^ tname ^ " used with wrong\
berghofe@5177
   275
                  \ number of arguments")
berghofe@5177
   276
           in (i + index, map (fn (j, (tn, args, cs)) => (i + j,
berghofe@5177
   277
             (tn, map (subst_DtTFree i subst) args,
berghofe@5177
   278
              map (apsnd (map (subst_DtTFree i subst))) cs))) descr)
berghofe@5177
   279
           end);
berghofe@5177
   280
berghofe@5177
   281
    (* unfold a single constructor argument *)
berghofe@5177
   282
berghofe@5177
   283
    fun unfold_arg ((i, Ts, descrs), T as (DtType (tname, dts))) =
berghofe@5177
   284
          if is_rec_type T then
berghofe@7015
   285
            if tname = "fun" then
berghofe@7015
   286
              if is_rec_type (hd dts) then
berghofe@7015
   287
                typ_error T "Non-strictly positive recursive occurrence of type"
berghofe@7015
   288
              else
berghofe@7015
   289
                (case hd (tl dts) of
berghofe@7015
   290
                   DtType ("fun", _) => typ_error T "Curried function types not allowed"
berghofe@7015
   291
                 | T' => let val (i', [T''], descrs') = unfold_arg ((i, [], descrs), T')
berghofe@7015
   292
                         in (i', Ts @ [DtType (tname, [hd dts, T''])], descrs') end)
berghofe@7015
   293
            else
berghofe@7015
   294
              let val (index, descr) = get_dt_descr T i tname dts;
berghofe@7015
   295
                  val (descr', i') = unfold_datatypes sign orig_descr sorts dt_info descr (i + length descr)
berghofe@7015
   296
              in (i', Ts @ [DtRec index], descrs @ descr') end
berghofe@5177
   297
          else (i, Ts @ [T], descrs)
berghofe@5177
   298
      | unfold_arg ((i, Ts, descrs), T) = (i, Ts @ [T], descrs);
berghofe@5177
   299
berghofe@5177
   300
    (* unfold a constructor *)
berghofe@5177
   301
berghofe@5177
   302
    fun unfold_constr ((i, constrs, descrs), (cname, cargs)) =
berghofe@5177
   303
      let val (i', cargs', descrs') = foldl unfold_arg ((i, [], descrs), cargs)
berghofe@5177
   304
      in (i', constrs @ [(cname, cargs')], descrs') end;
berghofe@5177
   305
berghofe@5177
   306
    (* unfold a single datatype *)
berghofe@5177
   307
berghofe@5177
   308
    fun unfold_datatype ((i, dtypes, descrs), (j, (tname, tvars, constrs))) =
berghofe@5177
   309
      let val (i', constrs', descrs') =
berghofe@5177
   310
        foldl unfold_constr ((i, [], descrs), constrs)
berghofe@5177
   311
      in (i', dtypes @ [(j, (tname, tvars, constrs'))], descrs')
berghofe@5177
   312
      end;
berghofe@5177
   313
berghofe@5177
   314
    val (i', descr', descrs) = foldl unfold_datatype ((i, [],[]), descr);
berghofe@5177
   315
berghofe@5177
   316
  in (descr' :: descrs, i') end;
berghofe@5177
   317
berghofe@5177
   318
end;