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