src/HOL/Tools/primrec_package.ML
author wenzelm
Fri Aug 31 18:46:48 2001 +0200 (2001-08-31)
changeset 11539 0f17da240450
parent 10525 3e21ab3e5114
child 11834 02825c735938
permissions -rw-r--r--
tuned headers;
berghofe@5719
     1
(*  Title:      HOL/Tools/primrec_package.ML
berghofe@5178
     2
    ID:         $Id$
wenzelm@11539
     3
    Author:     Stefan Berghofer, TU Muenchen and Norbert Voelker, FernUni Hagen
berghofe@5178
     4
wenzelm@6359
     5
Package for defining functions on datatypes by primitive recursion.
berghofe@5178
     6
*)
berghofe@5178
     7
berghofe@5178
     8
signature PRIMREC_PACKAGE =
berghofe@5178
     9
sig
wenzelm@6427
    10
  val quiet_mode: bool ref
berghofe@8480
    11
  val print_primrecs: theory -> unit
berghofe@8480
    12
  val get_primrec: theory -> string -> (string * thm list) list option
wenzelm@6425
    13
  val add_primrec: string -> ((bstring * string) * Args.src list) list
wenzelm@6359
    14
    -> theory -> theory * thm list
wenzelm@6425
    15
  val add_primrec_i: string -> ((bstring * term) * theory attribute list) list
wenzelm@6359
    16
    -> theory -> theory * thm list
berghofe@8480
    17
  val setup: (theory -> theory) list
berghofe@5178
    18
end;
berghofe@5178
    19
berghofe@5178
    20
structure PrimrecPackage : PRIMREC_PACKAGE =
berghofe@5178
    21
struct
berghofe@5178
    22
berghofe@5178
    23
open DatatypeAux;
berghofe@5178
    24
berghofe@5178
    25
exception RecError of string;
berghofe@5178
    26
berghofe@5178
    27
fun primrec_err s = error ("Primrec definition error:\n" ^ s);
berghofe@5178
    28
fun primrec_eq_err sign s eq =
berghofe@7544
    29
  primrec_err (s ^ "\nin\n" ^ quote (Sign.string_of_term sign eq));
wenzelm@6427
    30
wenzelm@6427
    31
wenzelm@6427
    32
(* messages *)
wenzelm@6427
    33
wenzelm@6427
    34
val quiet_mode = ref false;
wenzelm@6427
    35
fun message s = if ! quiet_mode then () else writeln s;
berghofe@5178
    36
wenzelm@6359
    37
berghofe@8480
    38
(** theory data **)
berghofe@8480
    39
berghofe@8480
    40
(* data kind 'HOL/primrec' *)
berghofe@8480
    41
berghofe@8480
    42
structure PrimrecArgs =
berghofe@8480
    43
struct
berghofe@8480
    44
  val name = "HOL/primrec";
berghofe@8480
    45
  type T = (string * thm list) list Symtab.table;
berghofe@8480
    46
berghofe@8480
    47
  val empty = Symtab.empty;
berghofe@8480
    48
  val copy = I;
berghofe@8480
    49
  val prep_ext = I;
berghofe@8480
    50
  val merge: T * T -> T = Symtab.merge (K true);
berghofe@8480
    51
berghofe@8480
    52
  fun print sg tab =
berghofe@8480
    53
    Pretty.writeln (Pretty.strs ("primrecs:" ::
berghofe@8480
    54
      map #1 (Sign.cond_extern_table sg Sign.constK tab)));
berghofe@8480
    55
end;
berghofe@8480
    56
berghofe@8480
    57
structure PrimrecData = TheoryDataFun(PrimrecArgs);
berghofe@8480
    58
val print_primrecs = PrimrecData.print;
berghofe@8480
    59
berghofe@8480
    60
berghofe@8480
    61
(* get and put data *)
berghofe@8480
    62
berghofe@8480
    63
fun get_primrec thy name = Symtab.lookup (PrimrecData.get thy, name);
berghofe@8480
    64
berghofe@8480
    65
fun put_primrec name info thy =
berghofe@8480
    66
  let val tab = PrimrecData.get thy
berghofe@8480
    67
  in 
berghofe@8480
    68
    PrimrecData.put (case Symtab.lookup (tab, name) of
berghofe@8480
    69
       None => Symtab.update_new ((name, [info]), tab)
berghofe@8480
    70
     | Some infos => Symtab.update ((name, info::infos), tab)) thy end;
berghofe@8480
    71
berghofe@8480
    72
berghofe@5178
    73
(* preprocessing of equations *)
berghofe@5178
    74
berghofe@5178
    75
fun process_eqn sign (eq, rec_fns) = 
berghofe@5178
    76
  let
paulson@6032
    77
    val (lhs, rhs) = 
paulson@6032
    78
	if null (term_vars eq) then
paulson@6032
    79
	    HOLogic.dest_eq (HOLogic.dest_Trueprop eq)
berghofe@7016
    80
	      handle TERM _ => raise RecError "not a proper equation"
paulson@6032
    81
	else raise RecError "illegal schematic variable(s)";
berghofe@5178
    82
berghofe@5178
    83
    val (recfun, args) = strip_comb lhs;
berghofe@7016
    84
    val (fname, _) = dest_Const recfun handle TERM _ => 
berghofe@5178
    85
      raise RecError "function is not declared as constant in theory";
berghofe@5178
    86
berghofe@5178
    87
    val (ls', rest)  = take_prefix is_Free args;
berghofe@5178
    88
    val (middle, rs') = take_suffix is_Free rest;
berghofe@5178
    89
    val rpos = length ls';
berghofe@5178
    90
berghofe@5178
    91
    val (constr, cargs') = if null middle then raise RecError "constructor missing"
berghofe@5178
    92
      else strip_comb (hd middle);
berghofe@5178
    93
    val (cname, T) = dest_Const constr
berghofe@7016
    94
      handle TERM _ => raise RecError "ill-formed constructor";
berghofe@7016
    95
    val (tname, _) = dest_Type (body_type T) handle TYPE _ =>
berghofe@5178
    96
      raise RecError "cannot determine datatype associated with function"
berghofe@5178
    97
paulson@6037
    98
    val (ls, cargs, rs) = (map dest_Free ls', 
paulson@6037
    99
			   map dest_Free cargs', 
paulson@6037
   100
			   map dest_Free rs')
berghofe@7016
   101
      handle TERM _ => raise RecError "illegal argument in pattern";
berghofe@5178
   102
    val lfrees = ls @ rs @ cargs;
berghofe@5178
   103
paulson@8973
   104
    val _ = case duplicates lfrees of
paulson@8973
   105
	       [] => ()
paulson@8973
   106
	     | vars => raise RecError("repeated variable names in pattern: " ^ 
paulson@8973
   107
				      commas_quote (map #1 vars))
paulson@8973
   108
 
paulson@8973
   109
    val _ =  case (map dest_Free (term_frees rhs)) \\ lfrees of
paulson@8973
   110
		[] => ()
paulson@8973
   111
	      | vars => raise RecError 
paulson@8973
   112
		      ("extra variables on rhs: " ^ 
paulson@8973
   113
		       commas_quote (map #1 vars))
berghofe@5178
   114
  in
paulson@8973
   115
    if length middle > 1 then 
berghofe@5178
   116
      raise RecError "more than one non-variable in pattern"
berghofe@5178
   117
    else (case assoc (rec_fns, fname) of
berghofe@5178
   118
        None =>
berghofe@5178
   119
          (fname, (tname, rpos, [(cname, (ls, cargs, rs, rhs, eq))]))::rec_fns
berghofe@5178
   120
      | Some (_, rpos', eqns) =>
berghofe@5178
   121
          if is_some (assoc (eqns, cname)) then
paulson@6037
   122
            raise RecError "constructor already occurred as pattern"
berghofe@5178
   123
          else if rpos <> rpos' then
berghofe@5178
   124
            raise RecError "position of recursive argument inconsistent"
berghofe@5178
   125
          else
paulson@6037
   126
            overwrite (rec_fns, 
paulson@6037
   127
		       (fname, 
paulson@6037
   128
			(tname, rpos,
paulson@6037
   129
			 (cname, (ls, cargs, rs, rhs, eq))::eqns))))
berghofe@5178
   130
  end
berghofe@5178
   131
  handle RecError s => primrec_eq_err sign s eq;
berghofe@5178
   132
berghofe@5178
   133
fun process_fun sign descr rec_eqns ((i, fname), (fnames, fnss)) =
berghofe@5178
   134
  let
berghofe@5178
   135
    val (_, (tname, _, constrs)) = nth_elem (i, descr);
berghofe@5178
   136
berghofe@5178
   137
    (* substitute "fname ls x rs" by "y ls rs" for (x, (_, y)) in subs *)
berghofe@5178
   138
berghofe@5178
   139
    fun subst [] x = x
berghofe@5178
   140
      | subst subs (fs, Abs (a, T, t)) =
berghofe@5178
   141
          let val (fs', t') = subst subs (fs, t)
berghofe@5178
   142
          in (fs', Abs (a, T, t')) end
berghofe@5178
   143
      | subst subs (fs, t as (_ $ _)) =
berghofe@5178
   144
          let val (f, ts) = strip_comb t;
berghofe@5178
   145
          in
berghofe@5178
   146
            if is_Const f andalso (fst (dest_Const f)) mem (map fst rec_eqns) then
berghofe@5178
   147
              let
berghofe@5178
   148
                val (fname', _) = dest_Const f;
berghofe@5178
   149
                val (_, rpos, _) = the (assoc (rec_eqns, fname'));
berghofe@5178
   150
                val ls = take (rpos, ts);
berghofe@5178
   151
                val rest = drop (rpos, ts);
berghofe@7016
   152
                val (x', rs) = (hd rest, tl rest)
berghofe@7016
   153
                  handle LIST _ => raise RecError ("not enough arguments\
berghofe@7016
   154
                   \ in recursive application\nof function " ^ quote fname' ^ " on rhs");
berghofe@7016
   155
                val (x, xs) = strip_comb x'
berghofe@5178
   156
              in 
berghofe@5178
   157
                (case assoc (subs, x) of
berghofe@5178
   158
                    None =>
berghofe@5178
   159
                      let
berghofe@5178
   160
                        val (fs', ts') = foldl_map (subst subs) (fs, ts)
berghofe@5178
   161
                      in (fs', list_comb (f, ts')) end
berghofe@5178
   162
                  | Some (i', y) =>
berghofe@5178
   163
                      let
berghofe@7016
   164
                        val (fs', ts') = foldl_map (subst subs) (fs, xs @ ls @ rs);
berghofe@5178
   165
                        val fs'' = process_fun sign descr rec_eqns ((i', fname'), fs')
berghofe@5178
   166
                      in (fs'', list_comb (y, ts'))
berghofe@5178
   167
                      end)
berghofe@5178
   168
              end
berghofe@5178
   169
            else
berghofe@5178
   170
              let
berghofe@5178
   171
                val (fs', f'::ts') = foldl_map (subst subs) (fs, f::ts)
berghofe@5178
   172
              in (fs', list_comb (f', ts')) end
berghofe@5178
   173
          end
berghofe@5178
   174
      | subst _ x = x;
berghofe@5178
   175
berghofe@5178
   176
    (* translate rec equations into function arguments suitable for rec comb *)
berghofe@5178
   177
berghofe@5178
   178
    fun trans eqns ((cname, cargs), (fnames', fnss', fns)) =
berghofe@5178
   179
      (case assoc (eqns, cname) of
wenzelm@6427
   180
          None => (warning ("no equation for constructor " ^ quote cname ^
wenzelm@6427
   181
            "\nin definition of function " ^ quote fname);
berghofe@5178
   182
              (fnames', fnss', (Const ("arbitrary", dummyT))::fns))
berghofe@5178
   183
        | Some (ls, cargs', rs, rhs, eq) =>
berghofe@5178
   184
            let
berghofe@7016
   185
              fun rec_index (DtRec k) = k
berghofe@7016
   186
                | rec_index (DtType ("fun", [_, DtRec k])) = k;
berghofe@7016
   187
berghofe@5178
   188
              val recs = filter (is_rec_type o snd) (cargs' ~~ cargs);
berghofe@5178
   189
              val rargs = map fst recs;
paulson@6037
   190
              val subs = map (rpair dummyT o fst) 
paulson@6037
   191
		             (rev (rename_wrt_term rhs rargs));
paulson@6037
   192
              val ((fnames'', fnss''), rhs') = 
paulson@6037
   193
		  (subst (map (fn ((x, y), z) =>
berghofe@7016
   194
			       (Free x, (rec_index y, Free z)))
paulson@6037
   195
			  (recs ~~ subs))
paulson@6037
   196
		   ((fnames', fnss'), rhs))
berghofe@5178
   197
                  handle RecError s => primrec_eq_err sign s eq
paulson@6037
   198
            in (fnames'', fnss'', 
paulson@6037
   199
		(list_abs_free (cargs' @ subs @ ls @ rs, rhs'))::fns)
berghofe@5178
   200
            end)
berghofe@5178
   201
berghofe@5178
   202
  in (case assoc (fnames, i) of
berghofe@5178
   203
      None =>
berghofe@5178
   204
        if exists (equal fname o snd) fnames then
wenzelm@6427
   205
          raise RecError ("inconsistent functions for datatype " ^ quote tname)
berghofe@5178
   206
        else
berghofe@5178
   207
          let
berghofe@5178
   208
            val (_, _, eqns) = the (assoc (rec_eqns, fname));
berghofe@5178
   209
            val (fnames', fnss', fns) = foldr (trans eqns)
berghofe@5178
   210
              (constrs, ((i, fname)::fnames, fnss, []))
berghofe@5178
   211
          in
berghofe@5178
   212
            (fnames', (i, (fname, #1 (snd (hd eqns)), fns))::fnss')
berghofe@5178
   213
          end
berghofe@5178
   214
    | Some fname' =>
berghofe@5178
   215
        if fname = fname' then (fnames, fnss)
wenzelm@6427
   216
        else raise RecError ("inconsistent functions for datatype " ^ quote tname))
berghofe@5178
   217
  end;
berghofe@5178
   218
wenzelm@6359
   219
berghofe@5178
   220
(* prepare functions needed for definitions *)
berghofe@5178
   221
berghofe@5178
   222
fun get_fns fns (((i, (tname, _, constrs)), rec_name), (fs, defs)) =
berghofe@5178
   223
  case assoc (fns, i) of
berghofe@5178
   224
     None =>
berghofe@5178
   225
       let
berghofe@5178
   226
         val dummy_fns = map (fn (_, cargs) => Const ("arbitrary",
berghofe@5178
   227
           replicate ((length cargs) + (length (filter is_rec_type cargs)))
berghofe@5178
   228
             dummyT ---> HOLogic.unitT)) constrs;
wenzelm@6427
   229
         val _ = warning ("No function definition for datatype " ^ quote tname)
berghofe@5178
   230
       in
berghofe@5178
   231
         (dummy_fns @ fs, defs)
berghofe@5178
   232
       end
berghofe@5178
   233
   | Some (fname, ls, fs') => (fs' @ fs, (fname, ls, rec_name, tname)::defs);
berghofe@5178
   234
wenzelm@6359
   235
berghofe@5178
   236
(* make definition *)
berghofe@5178
   237
berghofe@5178
   238
fun make_def sign fs (fname, ls, rec_name, tname) =
berghofe@5178
   239
  let
paulson@6037
   240
    val rhs = foldr (fn (T, t) => Abs ("", T, t)) 
paulson@6037
   241
	            ((map snd ls) @ [dummyT],
paulson@6037
   242
		     list_comb (Const (rec_name, dummyT),
paulson@6037
   243
				fs @ map Bound (0 ::(length ls downto 1))));
berghofe@5178
   244
    val defpair = (Sign.base_name fname ^ "_" ^ Sign.base_name tname ^ "_def",
paulson@6037
   245
		   Logic.mk_equals (Const (fname, dummyT), rhs))
wenzelm@6394
   246
  in Theory.inferT_axm sign defpair end;
berghofe@5178
   247
wenzelm@6359
   248
berghofe@5178
   249
(* find datatypes which contain all datatypes in tnames' *)
berghofe@5178
   250
berghofe@5178
   251
fun find_dts (dt_info : datatype_info Symtab.table) _ [] = []
berghofe@5178
   252
  | find_dts dt_info tnames' (tname::tnames) =
berghofe@5178
   253
      (case Symtab.lookup (dt_info, tname) of
wenzelm@6427
   254
          None => primrec_err (quote tname ^ " is not a datatype")
berghofe@5178
   255
        | Some dt =>
berghofe@5178
   256
            if tnames' subset (map (#1 o snd) (#descr dt)) then
berghofe@5178
   257
              (tname, dt)::(find_dts dt_info tnames' tnames)
berghofe@5178
   258
            else find_dts dt_info tnames' tnames);
berghofe@5178
   259
wenzelm@8432
   260
fun prepare_induct ({descr, induction, ...}: datatype_info) rec_eqns =
wenzelm@8432
   261
  let
wenzelm@8432
   262
    fun constrs_of (_, (_, _, cs)) =
wenzelm@8432
   263
      map (fn (cname:string, (_, cargs, _, _, _)) => (cname, map fst cargs)) cs;
wenzelm@8432
   264
    val params_of = Library.assocs (flat (map constrs_of rec_eqns));
wenzelm@8432
   265
  in
wenzelm@8432
   266
    induction
wenzelm@8432
   267
    |> RuleCases.rename_params (map params_of (flat (map (map #1 o #3 o #2) descr)))
wenzelm@10525
   268
    |> RuleCases.save induction
wenzelm@8432
   269
  end;
wenzelm@8432
   270
wenzelm@6359
   271
fun add_primrec_i alt_name eqns_atts thy =
berghofe@5178
   272
  let
wenzelm@6359
   273
    val (eqns, atts) = split_list eqns_atts;
wenzelm@6394
   274
    val sg = Theory.sign_of thy;
berghofe@5178
   275
    val dt_info = DatatypePackage.get_datatypes thy;
berghofe@5719
   276
    val rec_eqns = foldr (process_eqn sg) (map snd eqns, []);
berghofe@5178
   277
    val tnames = distinct (map (#1 o snd) rec_eqns);
berghofe@5178
   278
    val dts = find_dts dt_info tnames tnames;
paulson@6037
   279
    val main_fns = 
paulson@6037
   280
	map (fn (tname, {index, ...}) =>
paulson@6037
   281
	     (index, 
paulson@6037
   282
	      fst (the (find_first (fn f => #1 (snd f) = tname) rec_eqns))))
paulson@6037
   283
	dts;
paulson@6037
   284
    val {descr, rec_names, rec_rewrites, ...} = 
paulson@6037
   285
	if null dts then
wenzelm@6359
   286
	    primrec_err ("datatypes " ^ commas_quote tnames ^ 
paulson@6037
   287
			 "\nare not mutually recursive")
paulson@6037
   288
	else snd (hd dts);
paulson@6037
   289
    val (fnames, fnss) = foldr (process_fun sg descr rec_eqns)
paulson@6037
   290
	                       (main_fns, ([], []));
berghofe@5178
   291
    val (fs, defs) = foldr (get_fns fnss) (descr ~~ rec_names, ([], []));
berghofe@5178
   292
    val defs' = map (make_def sg fs) defs;
berghofe@5178
   293
    val names1 = map snd fnames;
berghofe@5178
   294
    val names2 = map fst rec_eqns;
wenzelm@8432
   295
    val primrec_name =
wenzelm@8432
   296
      if alt_name = "" then (space_implode "_" (map (Sign.base_name o #1) defs)) else alt_name;
wenzelm@8432
   297
    val (thy', defs_thms') = thy |> Theory.add_path primrec_name |>
wenzelm@9315
   298
      (if eq_set (names1, names2) then (PureThy.add_defs_i false o map Thm.no_attributes) defs'
wenzelm@6359
   299
       else primrec_err ("functions " ^ commas_quote names2 ^
berghofe@5216
   300
         "\nare not mutually recursive"));
wenzelm@8432
   301
    val rewrites = o_def :: (map mk_meta_eq rec_rewrites) @ defs_thms';
wenzelm@6427
   302
    val _ = message ("Proving equations for primrec function(s) " ^ commas_quote names1 ^ " ...");
berghofe@8480
   303
    val simps = map (fn (_, t) => prove_goalw_cterm rewrites (cterm_of (Theory.sign_of thy') t)
berghofe@5178
   304
        (fn _ => [rtac refl 1])) eqns;
berghofe@9575
   305
    val (thy'', simps') = PureThy.add_thms ((map fst eqns ~~ simps) ~~ atts) thy';
berghofe@9575
   306
    val thy''' = thy''
berghofe@9575
   307
      |> (#1 o PureThy.add_thmss [(("simps", simps'), [Simplifier.simp_add_global])])
berghofe@9575
   308
      |> (#1 o PureThy.add_thms [(("induct", prepare_induct (#2 (hd dts)) rec_eqns), [])])
berghofe@9575
   309
      |> Theory.parent_path
berghofe@8480
   310
  in
berghofe@8480
   311
    (foldl (fn (thy, (fname, _, _, tname)) =>
berghofe@9575
   312
       put_primrec fname (tname, simps') thy) (thy''', defs), simps')
berghofe@8480
   313
  end;
wenzelm@6359
   314
wenzelm@6359
   315
berghofe@7016
   316
fun add_primrec alt_name eqns thy =
berghofe@7016
   317
  let
berghofe@7544
   318
    val sign = Theory.sign_of thy;
berghofe@7016
   319
    val ((names, strings), srcss) = apfst split_list (split_list eqns);
berghofe@7016
   320
    val atts = map (map (Attrib.global_attribute thy)) srcss;
berghofe@7722
   321
    val eqn_ts = map (term_of o Thm.read_cterm sign o rpair propT) strings;
berghofe@7016
   322
    val rec_ts = map (fn eq => head_of (fst (HOLogic.dest_eq (HOLogic.dest_Trueprop eq)))
berghofe@7544
   323
      handle TERM _ => primrec_eq_err sign "not a proper equation" eq) eqn_ts;
berghofe@7016
   324
    val (_, eqn_ts') = InductivePackage.unify_consts (sign_of thy) rec_ts eqn_ts
berghofe@7016
   325
  in
berghofe@7016
   326
    add_primrec_i alt_name (names ~~ eqn_ts' ~~ atts) thy
berghofe@7016
   327
  end;
wenzelm@6359
   328
berghofe@5178
   329
berghofe@8480
   330
(** package setup **)
berghofe@8480
   331
berghofe@8480
   332
val setup = [PrimrecData.init];
berghofe@8480
   333
wenzelm@6359
   334
(* outer syntax *)
wenzelm@6359
   335
wenzelm@6723
   336
local structure P = OuterParse and K = OuterSyntax.Keyword in
wenzelm@6359
   337
wenzelm@6359
   338
val primrec_decl =
wenzelm@6723
   339
  Scan.optional (P.$$$ "(" |-- P.name --| P.$$$ ")") "" --
wenzelm@7152
   340
    Scan.repeat1 (P.opt_thm_name ":" -- P.prop --| P.marg_comment);
wenzelm@6359
   341
wenzelm@6359
   342
val primrecP =
wenzelm@6723
   343
  OuterSyntax.command "primrec" "define primitive recursive functions on datatypes" K.thy_decl
wenzelm@6359
   344
    (primrec_decl >> (fn (alt_name, eqns) =>
wenzelm@6723
   345
      Toplevel.theory (#1 o add_primrec alt_name (map P.triple_swap eqns))));
wenzelm@6359
   346
wenzelm@6359
   347
val _ = OuterSyntax.add_parsers [primrecP];
berghofe@5178
   348
berghofe@5178
   349
end;
wenzelm@6384
   350
wenzelm@6384
   351
wenzelm@6384
   352
end;