src/HOL/Tools/primrec_package.ML
author haftmann
Sat, 30 May 2009 08:17:05 +0200
changeset 31296 ba296a58d813
parent 31269 dcbe1f9fe2cd
permissions -rw-r--r--
simps with mandatory name prefix
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5719
2aed60cdb9f2 Changed interface.
berghofe
parents: 5553
diff changeset
     1
(*  Title:      HOL/Tools/primrec_package.ML
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
     2
    Author:     Stefan Berghofer, TU Muenchen; Norbert Voelker, FernUni Hagen;
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
     3
                Florian Haftmann, TU Muenchen
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
     4
6359
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
     5
Package for defining functions on datatypes by primitive recursion.
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
     6
*)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
     7
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
     8
signature PRIMREC_PACKAGE =
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
     9
sig
29581
b3b33e0298eb binding is alias for Binding.T
haftmann
parents: 29276
diff changeset
    10
  val add_primrec: (binding * typ option * mixfix) list ->
28084
a05ca48ef263 type Attrib.binding abbreviates Name.binding without attributes;
wenzelm
parents: 28083
diff changeset
    11
    (Attrib.binding * term) list -> local_theory -> thm list * local_theory
30487
a14ff49d3083 simplified preparation and outer parsing of specification;
wenzelm
parents: 30455
diff changeset
    12
  val add_primrec_cmd: (binding * string option * mixfix) list ->
a14ff49d3083 simplified preparation and outer parsing of specification;
wenzelm
parents: 30455
diff changeset
    13
    (Attrib.binding * string) list -> local_theory -> thm list * local_theory
29581
b3b33e0298eb binding is alias for Binding.T
haftmann
parents: 29276
diff changeset
    14
  val add_primrec_global: (binding * typ option * mixfix) list ->
28084
a05ca48ef263 type Attrib.binding abbreviates Name.binding without attributes;
wenzelm
parents: 28083
diff changeset
    15
    (Attrib.binding * term) list -> theory -> thm list * theory
26679
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
    16
  val add_primrec_overloaded: (string * (string * typ) * bool) list ->
29581
b3b33e0298eb binding is alias for Binding.T
haftmann
parents: 29276
diff changeset
    17
    (binding * typ option * mixfix) list ->
28084
a05ca48ef263 type Attrib.binding abbreviates Name.binding without attributes;
wenzelm
parents: 28083
diff changeset
    18
    (Attrib.binding * term) list -> theory -> thm list * theory
31269
dcbe1f9fe2cd tuned signature of add_primrec_simple
haftmann
parents: 31262
diff changeset
    19
  val add_primrec_simple: ((binding * typ) * mixfix) list -> term list ->
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
    20
    local_theory -> (string * thm list list) * local_theory
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    21
end;
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    22
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    23
structure PrimrecPackage : PRIMREC_PACKAGE =
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    24
struct
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    25
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    26
open DatatypeAux;
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    27
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    28
exception PrimrecError of string * term option;
6359
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
    29
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    30
fun primrec_error msg = raise PrimrecError (msg, NONE);
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    31
fun primrec_error_eqn msg eqn = raise PrimrecError (msg, SOME eqn);
23765
997e5fe47532 Function unify_consts moved from OldInductivePackage to PrimrecPackage.
berghofe
parents: 22728
diff changeset
    32
30451
11e5e8bb28f9 corrected type inference of primitive definitions
haftmann
parents: 30364
diff changeset
    33
fun message s = if ! Toplevel.debug then tracing s else ();
23765
997e5fe47532 Function unify_consts moved from OldInductivePackage to PrimrecPackage.
berghofe
parents: 22728
diff changeset
    34
997e5fe47532 Function unify_consts moved from OldInductivePackage to PrimrecPackage.
berghofe
parents: 22728
diff changeset
    35
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    36
(* preprocessing of equations *)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    37
25559
f14305fb698c authentic primrec
haftmann
parents: 25557
diff changeset
    38
fun process_eqn is_fixed spec rec_fns =
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    39
  let
25566
33f740c5e022 tuned further
haftmann
parents: 25562
diff changeset
    40
    val (vs, Ts) = split_list (strip_qnt_vars "all" spec);
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    41
    val body = strip_qnt_body "all" spec;
25566
33f740c5e022 tuned further
haftmann
parents: 25562
diff changeset
    42
    val (vs', _) = Name.variants vs (Name.make_context (fold_aterms
33f740c5e022 tuned further
haftmann
parents: 25562
diff changeset
    43
      (fn Free (v, _) => insert (op =) v | _ => I) body []));
33f740c5e022 tuned further
haftmann
parents: 25562
diff changeset
    44
    val eqn = curry subst_bounds (map2 (curry Free) vs' Ts |> rev) body;
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    45
    val (lhs, rhs) = HOLogic.dest_eq (HOLogic.dest_Trueprop eqn)
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    46
      handle TERM _ => primrec_error "not a proper equation";
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    47
    val (recfun, args) = strip_comb lhs;
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    48
    val fname = case recfun of Free (v, _) => if is_fixed v then v
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    49
          else primrec_error "illegal head of function equation"
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    50
      | _ => primrec_error "illegal head of function equation";
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    51
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    52
    val (ls', rest)  = take_prefix is_Free args;
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    53
    val (middle, rs') = take_suffix is_Free rest;
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    54
    val rpos = length ls';
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    55
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    56
    val (constr, cargs') = if null middle then primrec_error "constructor missing"
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    57
      else strip_comb (hd middle);
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    58
    val (cname, T) = dest_Const constr
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    59
      handle TERM _ => primrec_error "ill-formed constructor";
7016
df54b5365477 - Now also supports arbitrarily branching datatypes.
berghofe
parents: 6729
diff changeset
    60
    val (tname, _) = dest_Type (body_type T) handle TYPE _ =>
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    61
      primrec_error "cannot determine datatype associated with function"
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    62
20176
36737fb58614 exported equation transformator
haftmann
parents: 20046
diff changeset
    63
    val (ls, cargs, rs) =
36737fb58614 exported equation transformator
haftmann
parents: 20046
diff changeset
    64
      (map dest_Free ls', map dest_Free cargs', map dest_Free rs')
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    65
      handle TERM _ => primrec_error "illegal argument in pattern";
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    66
    val lfrees = ls @ rs @ cargs;
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    67
12474
0404454d97df Improved error messages.
berghofe
parents: 12448
diff changeset
    68
    fun check_vars _ [] = ()
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    69
      | check_vars s vars = primrec_error (s ^ commas_quote (map fst vars)) eqn;
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    70
  in
22692
1e057a3f087d proper ProofContext.infer_types;
wenzelm
parents: 22480
diff changeset
    71
    if length middle > 1 then
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    72
      primrec_error "more than one non-variable in pattern"
12474
0404454d97df Improved error messages.
berghofe
parents: 12448
diff changeset
    73
    else
18964
67f572e03236 renamed gen_duplicates to duplicates;
wenzelm
parents: 18928
diff changeset
    74
     (check_vars "repeated variable names in pattern: " (duplicates (op =) lfrees);
12474
0404454d97df Improved error messages.
berghofe
parents: 12448
diff changeset
    75
      check_vars "extra variables on rhs: "
29265
5b4247055bd7 moved old add_term_vars, add_term_frees etc. to structure OldTerm;
wenzelm
parents: 29006
diff changeset
    76
        (map dest_Free (OldTerm.term_frees rhs) |> subtract (op =) lfrees
25559
f14305fb698c authentic primrec
haftmann
parents: 25557
diff changeset
    77
          |> filter_out (is_fixed o fst));
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    78
      case AList.lookup (op =) rec_fns fname of
15531
08c8dad8e399 Deleted Library.option type.
skalberg
parents: 14981
diff changeset
    79
        NONE =>
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    80
          (fname, (tname, rpos, [(cname, (ls, cargs, rs, rhs, eqn))]))::rec_fns
15531
08c8dad8e399 Deleted Library.option type.
skalberg
parents: 14981
diff changeset
    81
      | SOME (_, rpos', eqns) =>
17184
3d80209e9a53 use AList operations;
wenzelm
parents: 17057
diff changeset
    82
          if AList.defined (op =) eqns cname then
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    83
            primrec_error "constructor already occurred as pattern"
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    84
          else if rpos <> rpos' then
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    85
            primrec_error "position of recursive argument inconsistent"
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    86
          else
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    87
            AList.update (op =)
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    88
              (fname, (tname, rpos, (cname, (ls, cargs, rs, rhs, eqn))::eqns))
17314
04e21a27c0ad introduces some modern-style AList operations
haftmann
parents: 17261
diff changeset
    89
              rec_fns)
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    90
  end handle PrimrecError (msg, NONE) => primrec_error_eqn msg spec;
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    91
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    92
fun process_fun descr eqns (i, fname) (fnames, fnss) =
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    93
  let
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
    94
    val (_, (tname, _, constrs)) = nth descr i;
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    95
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    96
    (* substitute "fname ls x rs" by "y ls rs" for (x, (_, y)) in subs *)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
    97
21064
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
    98
    fun subst [] t fs = (t, fs)
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
    99
      | subst subs (Abs (a, T, t)) fs =
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   100
          fs
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   101
          |> subst subs t
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   102
          |-> (fn t' => pair (Abs (a, T, t')))
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   103
      | subst subs (t as (_ $ _)) fs =
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   104
          let
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   105
            val (f, ts) = strip_comb t;
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   106
          in
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   107
            if is_Free f
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   108
              andalso member (fn ((v, _), (w, _)) => v = w) eqns (dest_Free f) then
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   109
              let
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   110
                val (fname', _) = dest_Free f;
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   111
                val (_, rpos, _) = the (AList.lookup (op =) eqns fname');
27301
bf7d82193a2e fixed bind error for malformed primrec specifications
haftmann
parents: 26679
diff changeset
   112
                val (ls, rs) = chop rpos ts
bf7d82193a2e fixed bind error for malformed primrec specifications
haftmann
parents: 26679
diff changeset
   113
                val (x', rs') = case rs
bf7d82193a2e fixed bind error for malformed primrec specifications
haftmann
parents: 26679
diff changeset
   114
                 of x' :: rs => (x', rs)
bf7d82193a2e fixed bind error for malformed primrec specifications
haftmann
parents: 26679
diff changeset
   115
                  | [] => primrec_error ("not enough arguments in recursive application\n"
bf7d82193a2e fixed bind error for malformed primrec specifications
haftmann
parents: 26679
diff changeset
   116
                      ^ "of function " ^ quote fname' ^ " on rhs");
bf7d82193a2e fixed bind error for malformed primrec specifications
haftmann
parents: 26679
diff changeset
   117
                val (x, xs) = strip_comb x';
21064
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   118
              in case AList.lookup (op =) subs x
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   119
               of NONE =>
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   120
                    fs
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   121
                    |> fold_map (subst subs) ts
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   122
                    |-> (fn ts' => pair (list_comb (f, ts')))
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   123
                | SOME (i', y) =>
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   124
                    fs
27301
bf7d82193a2e fixed bind error for malformed primrec specifications
haftmann
parents: 26679
diff changeset
   125
                    |> fold_map (subst subs) (xs @ ls @ rs')
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   126
                    ||> process_fun descr eqns (i', fname')
21064
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   127
                    |-> (fn ts' => pair (list_comb (y, ts')))
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   128
              end
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   129
            else
21064
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   130
              fs
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   131
              |> fold_map (subst subs) (f :: ts)
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   132
              |-> (fn (f'::ts') => pair (list_comb (f', ts')))
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   133
          end
21064
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   134
      | subst _ t fs = (t, fs);
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   135
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   136
    (* translate rec equations into function arguments suitable for rec comb *)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   137
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   138
    fun trans eqns (cname, cargs) (fnames', fnss', fns) =
17184
3d80209e9a53 use AList operations;
wenzelm
parents: 17057
diff changeset
   139
      (case AList.lookup (op =) eqns cname of
15531
08c8dad8e399 Deleted Library.option type.
skalberg
parents: 14981
diff changeset
   140
          NONE => (warning ("No equation for constructor " ^ quote cname ^
6427
fd36b2e7d80e tuned messages;
wenzelm
parents: 6425
diff changeset
   141
            "\nin definition of function " ^ quote fname);
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   142
              (fnames', fnss', (Const ("HOL.undefined", dummyT))::fns))
15531
08c8dad8e399 Deleted Library.option type.
skalberg
parents: 14981
diff changeset
   143
        | SOME (ls, cargs', rs, rhs, eq) =>
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   144
            let
21064
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   145
              val recs = filter (is_rec_type o snd) (cargs' ~~ cargs);
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   146
              val rargs = map fst recs;
22692
1e057a3f087d proper ProofContext.infer_types;
wenzelm
parents: 22480
diff changeset
   147
              val subs = map (rpair dummyT o fst)
29276
94b1ffec9201 qualified Term.rename_wrt_term;
wenzelm
parents: 29265
diff changeset
   148
                (rev (Term.rename_wrt_term rhs rargs));
27301
bf7d82193a2e fixed bind error for malformed primrec specifications
haftmann
parents: 26679
diff changeset
   149
              val (rhs', (fnames'', fnss'')) = subst (map2 (fn (x, y) => fn z =>
bf7d82193a2e fixed bind error for malformed primrec specifications
haftmann
parents: 26679
diff changeset
   150
                (Free x, (body_index y, Free z))) recs subs) rhs (fnames', fnss')
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   151
                  handle PrimrecError (s, NONE) => primrec_error_eqn s eq
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   152
            in (fnames'', fnss'',
20176
36737fb58614 exported equation transformator
haftmann
parents: 20046
diff changeset
   153
                (list_abs_free (cargs' @ subs @ ls @ rs, rhs'))::fns)
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   154
            end)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   155
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   156
  in (case AList.lookup (op =) fnames i of
15531
08c8dad8e399 Deleted Library.option type.
skalberg
parents: 14981
diff changeset
   157
      NONE =>
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   158
        if exists (fn (_, v) => fname = v) fnames then
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   159
          primrec_error ("inconsistent functions for datatype " ^ quote tname)
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   160
        else
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   161
          let
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   162
            val (_, _, eqns) = the (AList.lookup (op =) eqns fname);
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   163
            val (fnames', fnss', fns) = fold_rev (trans eqns) constrs
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   164
              ((i, fname)::fnames, fnss, [])
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   165
          in
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   166
            (fnames', (i, (fname, #1 (snd (hd eqns)), fns))::fnss')
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   167
          end
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   168
    | SOME fname' =>
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   169
        if fname = fname' then (fnames, fnss)
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   170
        else primrec_error ("inconsistent functions for datatype " ^ quote tname))
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   171
  end;
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   172
6359
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
   173
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   174
(* prepare functions needed for definitions *)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   175
21064
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   176
fun get_fns fns ((i : int, (tname, _, constrs)), rec_name) (fs, defs) =
17184
3d80209e9a53 use AList operations;
wenzelm
parents: 17057
diff changeset
   177
  case AList.lookup (op =) fns i of
15531
08c8dad8e399 Deleted Library.option type.
skalberg
parents: 14981
diff changeset
   178
     NONE =>
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   179
       let
22480
b20bc8029edb switched exception from arbitrary to undefined
haftmann
parents: 22101
diff changeset
   180
         val dummy_fns = map (fn (_, cargs) => Const ("HOL.undefined",
15570
8d8c70b41bab Move towards standard functions.
skalberg
parents: 15531
diff changeset
   181
           replicate ((length cargs) + (length (List.filter is_rec_type cargs)))
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   182
             dummyT ---> HOLogic.unitT)) constrs;
6427
fd36b2e7d80e tuned messages;
wenzelm
parents: 6425
diff changeset
   183
         val _ = warning ("No function definition for datatype " ^ quote tname)
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   184
       in
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   185
         (dummy_fns @ fs, defs)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   186
       end
21064
9684dd7c81b5 fold cleanup
haftmann
parents: 21022
diff changeset
   187
   | SOME (fname, ls, fs') => (fs' @ fs, (fname, ls, rec_name, tname) :: defs);
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   188
6359
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
   189
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   190
(* make definition *)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   191
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   192
fun make_def ctxt fixes fs (fname, ls, rec_name, tname) =
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   193
  let
30451
11e5e8bb28f9 corrected type inference of primitive definitions
haftmann
parents: 30364
diff changeset
   194
    val SOME (var, varT) = get_first (fn ((b, T), mx) =>
11e5e8bb28f9 corrected type inference of primitive definitions
haftmann
parents: 30364
diff changeset
   195
      if Binding.name_of b = fname then SOME ((b, mx), T) else NONE) fixes;
30364
577edc39b501 moved basic algebra of long names from structure NameSpace to Long_Name;
wenzelm
parents: 30280
diff changeset
   196
    val def_name = Thm.def_name (Long_Name.base_name fname);
30451
11e5e8bb28f9 corrected type inference of primitive definitions
haftmann
parents: 30364
diff changeset
   197
    val raw_rhs = fold_rev (fn T => fn t => Abs ("", T, t)) (map snd ls @ [dummyT])
11e5e8bb28f9 corrected type inference of primitive definitions
haftmann
parents: 30364
diff changeset
   198
      (list_comb (Const (rec_name, dummyT), fs @ map Bound (0 :: (length ls downto 1))))
11e5e8bb28f9 corrected type inference of primitive definitions
haftmann
parents: 30364
diff changeset
   199
    val rhs = singleton (Syntax.check_terms ctxt)
11e5e8bb28f9 corrected type inference of primitive definitions
haftmann
parents: 30364
diff changeset
   200
      (TypeInfer.constrain varT raw_rhs);
28965
1de908189869 cleaned up binding module and related code
haftmann
parents: 28703
diff changeset
   201
  in (var, ((Binding.name def_name, []), rhs)) end;
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   202
6359
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
   203
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   204
(* find datatypes which contain all datatypes in tnames' *)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   205
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   206
fun find_dts (dt_info : datatype_info Symtab.table) _ [] = []
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   207
  | find_dts dt_info tnames' (tname::tnames) =
17412
e26cb20ef0cc TableFun/Symtab: curried lookup and update;
wenzelm
parents: 17314
diff changeset
   208
      (case Symtab.lookup dt_info tname of
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   209
          NONE => primrec_error (quote tname ^ " is not a datatype")
15531
08c8dad8e399 Deleted Library.option type.
skalberg
parents: 14981
diff changeset
   210
        | SOME dt =>
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   211
            if tnames' subset (map (#1 o snd) (#descr dt)) then
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   212
              (tname, dt)::(find_dts dt_info tnames' tnames)
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   213
            else find_dts dt_info tnames' tnames);
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   214
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   215
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   216
(* distill primitive definition(s) from primrec specification *)
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   217
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   218
fun distill lthy fixes eqs = 
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   219
  let
25559
f14305fb698c authentic primrec
haftmann
parents: 25557
diff changeset
   220
    val eqns = fold_rev (process_eqn (fn v => Variable.is_fixed lthy v
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   221
      orelse exists (fn ((w, _), _) => v = Binding.name_of w) fixes)) eqs [];
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   222
    val tnames = distinct (op =) (map (#1 o snd) eqns);
28083
103d9282a946 explicit type Name.binding for higher-specification elements;
wenzelm
parents: 27301
diff changeset
   223
    val dts = find_dts (DatatypePackage.get_datatypes (ProofContext.theory_of lthy)) tnames tnames;
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   224
    val main_fns = map (fn (tname, {index, ...}) =>
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   225
      (index, (fst o the o find_first (fn (_, x) => #1 x = tname)) eqns)) dts;
22692
1e057a3f087d proper ProofContext.infer_types;
wenzelm
parents: 22480
diff changeset
   226
    val {descr, rec_names, rec_rewrites, ...} =
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   227
      if null dts then primrec_error
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   228
        ("datatypes " ^ commas_quote tnames ^ "\nare not mutually recursive")
18362
e8b7e0a22727 removed thms 'swap' and 'nth_map' from ML toplevel
haftmann
parents: 18358
diff changeset
   229
      else snd (hd dts);
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   230
    val (fnames, fnss) = fold_rev (process_fun descr eqns) main_fns ([], []);
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   231
    val (fs, raw_defs) = fold_rev (get_fns fnss) (descr ~~ rec_names) ([], []);
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   232
    val defs = map (make_def lthy fixes fs) raw_defs;
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   233
    val names = map snd fnames;
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   234
    val names_eqns = map fst eqns;
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   235
    val _ = if gen_eq_set (op =) (names, names_eqns) then ()
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   236
      else primrec_error ("functions " ^ commas_quote names_eqns ^
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   237
        "\nare not mutually recursive");
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   238
    val rec_rewrites' = map mk_meta_eq rec_rewrites;
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   239
    val prefix = space_implode "_" (map (Long_Name.base_name o #1) raw_defs);
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   240
    fun prove lthy defs =
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   241
      let
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   242
        val rewrites = rec_rewrites' @ map (snd o snd) defs;
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   243
        fun tac _ = EVERY [rewrite_goals_tac rewrites, rtac refl 1];
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   244
        val _ = message ("Proving equations for primrec function(s) " ^ commas_quote names);
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   245
      in map (fn eq => [Goal.prove lthy [] [] eq tac]) eqs end;
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   246
  in ((prefix, (fs, defs)), prove) end
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   247
  handle PrimrecError (msg, some_eqn) =>
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   248
    error ("Primrec definition error:\n" ^ msg ^ (case some_eqn
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   249
     of SOME eqn => "\nin\n" ^ quote (Syntax.string_of_term lthy eqn)
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   250
      | NONE => ""));
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   251
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   252
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   253
(* primrec definition *)
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   254
31269
dcbe1f9fe2cd tuned signature of add_primrec_simple
haftmann
parents: 31262
diff changeset
   255
fun add_primrec_simple fixes ts lthy =
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   256
  let
31269
dcbe1f9fe2cd tuned signature of add_primrec_simple
haftmann
parents: 31262
diff changeset
   257
    val ((prefix, (fs, defs)), prove) = distill lthy fixes ts;
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   258
  in
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   259
    lthy
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   260
    |> fold_map (LocalTheory.define Thm.definitionK) defs
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   261
    |-> (fn defs => `(fn lthy => (prefix, prove lthy defs)))
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   262
  end;
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   263
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   264
local
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   265
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   266
fun gen_primrec set_group prep_spec raw_fixes raw_spec lthy =
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   267
  let
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   268
    val (fixes, spec) = fst (prep_spec raw_fixes raw_spec lthy);
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   269
    fun attr_bindings prefix = map (fn ((b, attrs), _) =>
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   270
      (Binding.qualify false prefix b, Code.add_default_eqn_attrib :: attrs)) spec;
31296
ba296a58d813 simps with mandatory name prefix
haftmann
parents: 31269
diff changeset
   271
    fun simp_attr_binding prefix = (Binding.qualify true prefix (Binding.name "simps"),
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   272
      map (Attrib.internal o K)
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   273
        [Simplifier.simp_add, Nitpick_Const_Simp_Thms.add, Quickcheck_RecFun_Simp_Thms.add]);
8480
50266d517b0c Added new theory data slot for primrec equations.
berghofe
parents: 8432
diff changeset
   274
  in
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   275
    lthy
26129
14f6dbb195c4 LocalTheory.set_group for user command;
wenzelm
parents: 25604
diff changeset
   276
    |> set_group ? LocalTheory.set_group (serial_string ())
31269
dcbe1f9fe2cd tuned signature of add_primrec_simple
haftmann
parents: 31262
diff changeset
   277
    |> add_primrec_simple fixes (map snd spec)
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   278
    |-> (fn (prefix, simps) => fold_map (LocalTheory.note Thm.generatedK)
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   279
          (attr_bindings prefix ~~ simps)
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   280
    #-> (fn simps' => LocalTheory.note Thm.generatedK
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   281
          (simp_attr_binding prefix, maps snd simps')))
25604
6c1714b9b805 dropped induction rule
haftmann
parents: 25570
diff changeset
   282
    |>> snd
31262
580510315dda add_primrec_simple
haftmann
parents: 31177
diff changeset
   283
  end;
20841
d4f94d2a3414 added gen_primrec
haftmann
parents: 20176
diff changeset
   284
d4f94d2a3414 added gen_primrec
haftmann
parents: 20176
diff changeset
   285
in
d4f94d2a3414 added gen_primrec
haftmann
parents: 20176
diff changeset
   286
30487
a14ff49d3083 simplified preparation and outer parsing of specification;
wenzelm
parents: 30455
diff changeset
   287
val add_primrec = gen_primrec false Specification.check_spec;
a14ff49d3083 simplified preparation and outer parsing of specification;
wenzelm
parents: 30455
diff changeset
   288
val add_primrec_cmd = gen_primrec true Specification.read_spec;
20841
d4f94d2a3414 added gen_primrec
haftmann
parents: 20176
diff changeset
   289
22692
1e057a3f087d proper ProofContext.infer_types;
wenzelm
parents: 22480
diff changeset
   290
end;
19688
877b763ded7e added syntax for 'unchecked';
wenzelm
parents: 19636
diff changeset
   291
26679
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   292
fun add_primrec_global fixes specs thy =
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   293
  let
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   294
    val lthy = TheoryTarget.init NONE thy;
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   295
    val (simps, lthy') = add_primrec fixes specs lthy;
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   296
    val simps' = ProofContext.export lthy' lthy simps;
28394
b9c8e3a12a98 LocalTheory.exit_global;
wenzelm
parents: 28107
diff changeset
   297
  in (simps', LocalTheory.exit_global lthy') end;
26679
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   298
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   299
fun add_primrec_overloaded ops fixes specs thy =
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   300
  let
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   301
    val lthy = TheoryTarget.overloading ops thy;
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   302
    val (simps, lthy') = add_primrec fixes specs lthy;
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   303
    val simps' = ProofContext.export lthy' lthy simps;
28394
b9c8e3a12a98 LocalTheory.exit_global;
wenzelm
parents: 28107
diff changeset
   304
  in (simps', LocalTheory.exit_global lthy') end;
26679
447f4872b7ee Added add_primrec_global and add_primrec_overloaded functions (thanks to Markus).
berghofe
parents: 26556
diff changeset
   305
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   306
6359
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
   307
(* outer syntax *)
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
   308
17057
0934ac31985f OuterKeyword;
wenzelm
parents: 16765
diff changeset
   309
local structure P = OuterParse and K = OuterKeyword in
6359
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
   310
19688
877b763ded7e added syntax for 'unchecked';
wenzelm
parents: 19636
diff changeset
   311
val opt_unchecked_name =
877b763ded7e added syntax for 'unchecked';
wenzelm
parents: 19636
diff changeset
   312
  Scan.optional (P.$$$ "(" |-- P.!!!
877b763ded7e added syntax for 'unchecked';
wenzelm
parents: 19636
diff changeset
   313
    (((P.$$$ "unchecked" >> K true) -- Scan.optional P.name "" ||
877b763ded7e added syntax for 'unchecked';
wenzelm
parents: 19636
diff changeset
   314
      P.name >> pair false) --| P.$$$ ")")) (false, "");
877b763ded7e added syntax for 'unchecked';
wenzelm
parents: 19636
diff changeset
   315
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   316
val old_primrec_decl =
30223
24d975352879 renamed Binding.name_pos to Binding.make, renamed Binding.base_name to Binding.name_of, renamed Binding.map_base to Binding.map_name, added mandatory flag to Binding.qualify;
wenzelm
parents: 29866
diff changeset
   317
  opt_unchecked_name -- Scan.repeat1 ((SpecParse.opt_thm_name ":" >> apfst Binding.name_of) -- P.prop);
6359
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
   318
30487
a14ff49d3083 simplified preparation and outer parsing of specification;
wenzelm
parents: 30455
diff changeset
   319
val primrec_decl = P.opt_target -- P.fixes -- SpecParse.where_alt_specs;
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   320
24867
e5b55d7be9bb simplified interfaces for outer syntax;
wenzelm
parents: 24712
diff changeset
   321
val _ =
6723
f342449d73ca outer syntax keyword classification;
wenzelm
parents: 6430
diff changeset
   322
  OuterSyntax.command "primrec" "define primitive recursive functions on datatypes" K.thy_decl
30487
a14ff49d3083 simplified preparation and outer parsing of specification;
wenzelm
parents: 30455
diff changeset
   323
    ((primrec_decl >> (fn ((opt_target, fixes), specs) =>
a14ff49d3083 simplified preparation and outer parsing of specification;
wenzelm
parents: 30455
diff changeset
   324
      Toplevel.local_theory opt_target (add_primrec_cmd fixes specs #> snd)))
25557
ea6b11021e79 added new primrec package
haftmann
parents: 24867
diff changeset
   325
    || (old_primrec_decl >> (fn ((unchecked, alt_name), eqns) =>
20176
36737fb58614 exported equation transformator
haftmann
parents: 20046
diff changeset
   326
      Toplevel.theory (snd o
30487
a14ff49d3083 simplified preparation and outer parsing of specification;
wenzelm
parents: 30455
diff changeset
   327
        (if unchecked then OldPrimrecPackage.add_primrec_unchecked else OldPrimrecPackage.add_primrec)
a14ff49d3083 simplified preparation and outer parsing of specification;
wenzelm
parents: 30455
diff changeset
   328
          alt_name (map P.triple_swap eqns)))));
6359
6fdb0badc6f4 add_primrec(_i): attributes;
wenzelm
parents: 6092
diff changeset
   329
5178
9337b230ff15 New primrec function definition package
berghofe
parents:
diff changeset
   330
end;
6384
eed1273c9146 local open OuterParse;
wenzelm
parents: 6359
diff changeset
   331
eed1273c9146 local open OuterParse;
wenzelm
parents: 6359
diff changeset
   332
end;