1 (* Title: HOL/Nominal/nominal_primrec.ML
3 Author: Stefan Berghofer, TU Muenchen and Norbert Voelker, FernUni Hagen
5 Package for defining functions on nominal datatypes by primitive recursion.
6 Taken from HOL/Tools/primrec_package.ML
9 signature NOMINAL_PRIMREC =
11 val add_primrec: string -> string list option -> string option ->
12 ((Binding.T * string) * Attrib.src list) list -> theory -> Proof.state
13 val add_primrec_unchecked: string -> string list option -> string option ->
14 ((Binding.T * string) * Attrib.src list) list -> theory -> Proof.state
15 val add_primrec_i: string -> term list option -> term option ->
16 ((Binding.T * term) * attribute list) list -> theory -> Proof.state
17 val add_primrec_unchecked_i: string -> term list option -> term option ->
18 ((Binding.T * term) * attribute list) list -> theory -> Proof.state
21 structure NominalPrimrec : NOMINAL_PRIMREC =
26 exception RecError of string;
28 fun primrec_err s = error ("Nominal primrec definition error:\n" ^ s);
29 fun primrec_eq_err thy s eq =
30 primrec_err (s ^ "\nin\n" ^ quote (Syntax.string_of_term_global thy eq));
33 (* preprocessing of equations *)
35 fun process_eqn thy eq rec_fns =
38 if null (term_vars eq) then
39 HOLogic.dest_eq (HOLogic.dest_Trueprop (Logic.strip_imp_concl eq))
40 handle TERM _ => raise RecError "not a proper equation"
41 else raise RecError "illegal schematic variable(s)";
43 val (recfun, args) = strip_comb lhs;
44 val fnameT = dest_Const recfun handle TERM _ =>
45 raise RecError "function is not declared as constant in theory";
47 val (ls', rest) = take_prefix is_Free args;
48 val (middle, rs') = take_suffix is_Free rest;
49 val rpos = length ls';
51 val (constr, cargs') = if null middle then raise RecError "constructor missing"
52 else strip_comb (hd middle);
53 val (cname, T) = dest_Const constr
54 handle TERM _ => raise RecError "ill-formed constructor";
55 val (tname, _) = dest_Type (body_type T) handle TYPE _ =>
56 raise RecError "cannot determine datatype associated with function"
59 (map dest_Free ls', map dest_Free cargs', map dest_Free rs')
60 handle TERM _ => raise RecError "illegal argument in pattern";
61 val lfrees = ls @ rs @ cargs;
63 fun check_vars _ [] = ()
64 | check_vars s vars = raise RecError (s ^ commas_quote (map fst vars))
66 if length middle > 1 then
67 raise RecError "more than one non-variable in pattern"
69 (check_vars "repeated variable names in pattern: " (duplicates (op =) lfrees);
70 check_vars "extra variables on rhs: "
71 (map dest_Free (term_frees rhs) \\ lfrees);
72 case AList.lookup (op =) rec_fns fnameT of
74 (fnameT, (tname, rpos, [(cname, (ls, cargs, rs, rhs, eq))]))::rec_fns
75 | SOME (_, rpos', eqns) =>
76 if AList.defined (op =) eqns cname then
77 raise RecError "constructor already occurred as pattern"
78 else if rpos <> rpos' then
79 raise RecError "position of recursive argument inconsistent"
81 AList.update (op =) (fnameT, (tname, rpos, (cname, (ls, cargs, rs, rhs, eq))::eqns))
84 handle RecError s => primrec_eq_err thy s eq;
86 val param_err = "Parameters must be the same for all recursive functions";
88 fun process_fun thy descr rec_eqns (i, fnameT as (fname, _)) (fnameTs, fnss) =
90 val (_, (tname, _, constrs)) = List.nth (descr, i);
92 (* substitute "fname ls x rs" by "y" for (x, (_, y)) in subs *)
94 fun subst [] t fs = (t, fs)
95 | subst subs (Abs (a, T, t)) fs =
98 |-> (fn t' => pair (Abs (a, T, t')))
99 | subst subs (t as (_ $ _)) fs =
101 val (f, ts) = strip_comb t;
103 if is_Const f andalso dest_Const f mem map fst rec_eqns then
105 val fnameT' as (fname', _) = dest_Const f;
106 val (_, rpos, eqns) = the (AList.lookup (op =) rec_eqns fnameT');
107 val ls = Library.take (rpos, ts);
108 val rest = Library.drop (rpos, ts);
109 val (x', rs) = (hd rest, tl rest)
110 handle Empty => raise RecError ("not enough arguments\
111 \ in recursive application\nof function " ^ quote fname' ^ " on rhs");
112 val rs' = (case eqns of
113 (_, (ls', _, rs', _, _)) :: _ =>
114 let val (rs1, rs2) = chop (length rs') rs
116 if ls = map Free ls' andalso rs1 = map Free rs' then rs2
117 else raise RecError param_err
119 | _ => raise RecError ("no equations for " ^ quote fname'));
120 val (x, xs) = strip_comb x'
121 in case AList.lookup (op =) subs x
124 |> fold_map (subst subs) ts
125 |-> (fn ts' => pair (list_comb (f, ts')))
128 |> fold_map (subst subs) (xs @ rs')
129 ||> process_fun thy descr rec_eqns (i', fnameT')
130 |-> (fn ts' => pair (list_comb (y, ts')))
134 |> fold_map (subst subs) (f :: ts)
135 |-> (fn (f'::ts') => pair (list_comb (f', ts')))
137 | subst _ t fs = (t, fs);
139 (* translate rec equations into function arguments suitable for rec comb *)
141 fun trans eqns (cname, cargs) (fnameTs', fnss', fns) =
142 (case AList.lookup (op =) eqns cname of
143 NONE => (warning ("No equation for constructor " ^ quote cname ^
144 "\nin definition of function " ^ quote fname);
145 (fnameTs', fnss', (Const (@{const_name undefined}, dummyT))::fns))
146 | SOME (ls, cargs', rs, rhs, eq) =>
148 val recs = filter (is_rec_type o snd) (cargs' ~~ cargs);
149 val rargs = map fst recs;
150 val subs = map (rpair dummyT o fst)
151 (rev (rename_wrt_term rhs rargs));
152 val (rhs', (fnameTs'', fnss'')) =
153 (subst (map (fn ((x, y), z) =>
154 (Free x, (body_index y, Free z)))
155 (recs ~~ subs)) rhs (fnameTs', fnss'))
156 handle RecError s => primrec_eq_err thy s eq
157 in (fnameTs'', fnss'',
158 (list_abs_free (cargs' @ subs, rhs'))::fns)
161 in (case AList.lookup (op =) fnameTs i of
163 if exists (equal fnameT o snd) fnameTs then
164 raise RecError ("inconsistent functions for datatype " ^ quote tname)
167 val SOME (_, _, eqns as (_, (ls, _, rs, _, _)) :: _) =
168 AList.lookup (op =) rec_eqns fnameT;
169 val (fnameTs', fnss', fns) = fold_rev (trans eqns) constrs
170 ((i, fnameT)::fnameTs, fnss, [])
172 (fnameTs', (i, (fname, ls, rs, fns))::fnss')
175 if fnameT = fnameT' then (fnameTs, fnss)
176 else raise RecError ("inconsistent functions for datatype " ^ quote tname))
180 (* prepare functions needed for definitions *)
182 fun get_fns fns ((i : int, (tname, _, constrs)), rec_name) (fs, defs) =
183 case AList.lookup (op =) fns i of
186 val dummy_fns = map (fn (_, cargs) => Const (@{const_name undefined},
187 replicate ((length cargs) + (length (List.filter is_rec_type cargs)))
188 dummyT ---> HOLogic.unitT)) constrs;
189 val _ = warning ("No function definition for datatype " ^ quote tname)
191 (dummy_fns @ fs, defs)
193 | SOME (fname, ls, rs, fs') => (fs' @ fs, (fname, ls, rs, rec_name, tname) :: defs);
196 (* make definition *)
198 fun make_def thy fs (fname, ls, rs, rec_name, tname) =
200 val used = map fst (fold Term.add_frees fs []);
201 val x = (Name.variant used "x", dummyT);
202 val frees = ls @ x :: rs;
203 val rhs = list_abs_free (frees,
204 list_comb (Const (rec_name, dummyT), fs @ [Free x]))
205 val def_name = Sign.base_name fname ^ "_" ^ Sign.base_name tname ^ "_def";
206 val def_prop as _ $ _ $ t =
207 singleton (Syntax.check_terms (ProofContext.init thy))
208 (Logic.mk_equals (Const (fname, dummyT), rhs));
209 in ((def_name, def_prop), subst_bounds (rev (map Free frees), strip_abs_body t)) end;
212 (* find datatypes which contain all datatypes in tnames' *)
214 fun find_dts (dt_info : NominalPackage.nominal_datatype_info Symtab.table) _ [] = []
215 | find_dts dt_info tnames' (tname::tnames) =
216 (case Symtab.lookup dt_info tname of
217 NONE => primrec_err (quote tname ^ " is not a nominal datatype")
219 if tnames' subset (map (#1 o snd) (#descr dt)) then
220 (tname, dt)::(find_dts dt_info tnames' tnames)
221 else find_dts dt_info tnames' tnames);
223 fun common_prefix eq ([], _) = []
224 | common_prefix eq (_, []) = []
225 | common_prefix eq (x :: xs, y :: ys) =
226 if eq (x, y) then x :: common_prefix eq (xs, ys) else [];
230 fun gen_primrec_i note def alt_name invs fctxt eqns_atts thy =
232 val (raw_eqns, atts) = split_list eqns_atts;
233 val eqns = map (apfst Binding.base_name) raw_eqns;
234 val dt_info = NominalPackage.get_nominal_datatypes thy;
235 val rec_eqns = fold_rev (process_eqn thy o snd) eqns [];
236 val lsrs :: lsrss = maps (fn (_, (_, _, eqns)) =>
237 map (fn (_, (ls, _, rs, _, _)) => ls @ rs) eqns) rec_eqns
239 (if forall (curry eq_set lsrs) lsrss andalso forall
240 (fn (_, (_, _, (_, (ls, _, rs, _, _)) :: eqns)) =>
241 forall (fn (_, (ls', _, rs', _, _)) =>
242 ls = ls' andalso rs = rs') eqns
243 | _ => true) rec_eqns
244 then () else primrec_err param_err);
245 val tnames = distinct (op =) (map (#1 o snd) rec_eqns);
246 val dts = find_dts dt_info tnames tnames;
248 map (fn (tname, {index, ...}) =>
250 (fst o the o find_first (fn f => (#1 o snd) f = tname)) rec_eqns))
252 val {descr, rec_names, rec_rewrites, ...} =
254 primrec_err ("datatypes " ^ commas_quote tnames ^ "\nare not mutually recursive")
256 val descr = map (fn (i, (tname, args, constrs)) => (i, (tname, args,
257 map (fn (cname, cargs) => (cname, fold (fn (dTs, dT) => fn dTs' =>
258 dTs' @ dTs @ [dT]) cargs [])) constrs))) descr;
259 val (fnameTs, fnss) =
260 fold_rev (process_fun thy descr rec_eqns) main_fns ([], []);
261 val (fs, defs) = fold_rev (get_fns fnss) (descr ~~ rec_names) ([], []);
262 val defs' = map (make_def thy fs) defs;
263 val nameTs1 = map snd fnameTs;
264 val nameTs2 = map fst rec_eqns;
265 val _ = if gen_eq_set (op =) (nameTs1, nameTs2) then ()
266 else primrec_err ("functions " ^ commas_quote (map fst nameTs2) ^
267 "\nare not mutually recursive");
269 if alt_name = "" then (space_implode "_" (map (Sign.base_name o #1) defs)) else alt_name;
270 val (defs_thms', thy') =
272 |> Sign.add_path primrec_name
273 |> fold_map def (map (fn ((name, t), _) => ((name, []), t)) defs');
274 val cert = cterm_of thy';
278 val Const c = head_of (fst (HOLogic.dest_eq (HOLogic.dest_Trueprop
279 (Logic.strip_imp_concl eq))));
280 val SOME i = AList.lookup op = (map swap fnameTs) c;
281 val SOME (_, _, constrs) = AList.lookup op = descr i;
282 val SOME (_, _, eqns) = AList.lookup op = rec_eqns c;
283 val SOME (cname, (_, cargs, _, _, _)) = find_first
284 (fn (_, (_, _, _, _, eq')) => eq = eq') eqns
285 in (i, find_index (fn (cname', _) => cname = cname') constrs, cargs) end;
288 unflat (map (fn (_, (_, _, constrs)) => constrs) descr) rec_rewrites;
289 val fvars = rec_rewrites |> hd |> concl_of |> HOLogic.dest_Trueprop |>
290 HOLogic.dest_eq |> fst |> strip_comb |> snd |> take_prefix is_Var |> fst;
291 val (pvars, ctxtvars) = List.partition
292 (equal HOLogic.boolT o body_type o snd)
293 (fold_rev Term.add_vars (map Logic.strip_assums_concl
294 (prems_of (hd rec_rewrites))) [] \\ map dest_Var fvars);
295 val cfs = defs' |> hd |> snd |> strip_comb |> snd |>
296 curry (List.take o swap) (length fvars) |> map cert;
297 val invs' = (case invs of
298 NONE => map (fn (i, _) =>
300 val SOME (_, T) = AList.lookup op = fnameTs i
301 val (Ts, U) = strip_type T
303 Abs ("x", List.drop (Ts, length lsrs + 1) ---> U, HOLogic.true_const)
305 | SOME invs' => invs');
306 val inst = (map cert fvars ~~ cfs) @
307 (map (cert o Var) pvars ~~ map cert invs') @
309 [ctxtvar] => [(cert (Var ctxtvar), cert (the_default HOLogic.unit fctxt))]
311 val rec_rewrites' = map (fn (_, eq) =>
313 val (i, j, cargs) = mk_idx eq
314 val th = nth (nth rec_rewritess i) j;
315 val cargs' = th |> concl_of |> HOLogic.dest_Trueprop |>
316 HOLogic.dest_eq |> fst |> strip_comb |> snd |> split_last |> snd |>
318 in (cargs, Logic.strip_imp_prems eq,
319 Drule.cterm_instantiate (inst @
320 (map (cterm_of thy') cargs' ~~ map (cterm_of thy' o Free) cargs)) th)
323 val prems = foldr1 (common_prefix op aconv) (map (prems_of o #3) rec_rewrites');
324 val cprems = map cert prems;
325 val asms = map Thm.assume cprems;
326 val premss = map (fn (cargs, eprems, eqn) =>
327 map (fn t => list_all_free (cargs, Logic.list_implies (eprems, t)))
328 (List.drop (prems_of eqn, length prems))) rec_rewrites';
329 val cpremss = map (map cert) premss;
330 val asmss = map (map Thm.assume) cpremss;
332 fun mk_eqn ((cargs, eprems, eqn), asms') =
334 val ceprems = map cert eprems;
335 val asms'' = map Thm.assume ceprems;
336 val ccargs = map (cert o Free) cargs;
337 val asms''' = map (fn th => implies_elim_list
338 (forall_elim_list ccargs th) asms'') asms'
340 implies_elim_list eqn (asms @ asms''') |>
341 implies_intr_list ceprems |>
342 forall_intr_list ccargs
345 val rule_prems = cprems @ flat cpremss;
346 val rule = implies_intr_list rule_prems
347 (Conjunction.intr_balanced (map mk_eqn (rec_rewrites' ~~ asmss)));
349 val goals = map (fn ((cargs, _, _), (_, eqn)) =>
350 (list_all_free (cargs, eqn), [])) (rec_rewrites' ~~ eqns);
356 (fn thss => ProofContext.theory (fn thy =>
358 val simps = map standard (flat thss);
360 fold_map note ((map fst eqns ~~ atts) ~~ map single simps) thy;
361 val simps'' = maps snd simps'
364 |> note (("simps", [Simplifier.simp_add]), simps'')
369 Proof.apply (Method.Basic (fn _ => Method.RAW_METHOD (fn _ =>
370 rewrite_goals_tac (map snd defs_thms') THEN
371 compose_tac (false, rule, length rule_prems) 1), Position.none)) |>
375 fun gen_primrec note def alt_name invs fctxt eqns thy =
377 val ((names, strings), srcss) = apfst split_list (split_list eqns);
378 val atts = map (map (Attrib.attribute thy)) srcss;
379 val eqn_ts = map (fn s => Syntax.read_prop_global thy s
380 handle ERROR msg => cat_error msg ("The error(s) above occurred for " ^ s)) strings;
381 val rec_ts = map (fn eq => head_of (fst (HOLogic.dest_eq
382 (HOLogic.dest_Trueprop (Logic.strip_imp_concl eq))))
383 handle TERM _ => primrec_eq_err thy "not a proper equation" eq) eqn_ts;
384 val (_, eqn_ts') = OldPrimrecPackage.unify_consts thy rec_ts eqn_ts
386 gen_primrec_i note def alt_name
387 (Option.map (map (Syntax.read_term_global thy)) invs)
388 (Option.map (Syntax.read_term_global thy) fctxt)
389 (names ~~ eqn_ts' ~~ atts) thy
392 fun thy_note ((name, atts), thms) =
393 PureThy.add_thmss [((name, thms), atts)] #-> (fn [thms] => pair (name, thms));
394 fun thy_def false ((name, atts), t) =
395 PureThy.add_defs false [((name, t), atts)] #-> (fn [thm] => pair (name, thm))
396 | thy_def true ((name, atts), t) =
397 PureThy.add_defs_unchecked false [((name, t), atts)] #-> (fn [thm] => pair (name, thm));
401 val add_primrec = gen_primrec thy_note (thy_def false);
402 val add_primrec_unchecked = gen_primrec thy_note (thy_def true);
403 val add_primrec_i = gen_primrec_i thy_note (thy_def false);
404 val add_primrec_unchecked_i = gen_primrec_i thy_note (thy_def true);
411 local structure P = OuterParse and K = OuterKeyword in
413 val freshness_context = P.reserved "freshness_context";
414 val invariant = P.reserved "invariant";
416 fun unless_flag scan = Scan.unless ((freshness_context || invariant) -- P.$$$ ":") scan;
418 val parser1 = (freshness_context -- P.$$$ ":") |-- unless_flag P.term >> SOME;
419 val parser2 = (invariant -- P.$$$ ":") |--
420 (Scan.repeat1 (unless_flag P.term) >> SOME) -- Scan.optional parser1 NONE ||
421 (parser1 >> pair NONE);
423 unless_flag P.name -- Scan.optional parser2 (NONE, NONE) ||
424 (parser2 >> pair "");
426 (P.$$$ "unchecked" >> K true) -- Scan.optional parser3 ("", (NONE, NONE)) ||
427 (parser3 >> pair false);
429 Scan.optional (P.$$$ "(" |-- P.!!!
430 (parser4 --| P.$$$ ")")) (false, ("", (NONE, NONE)));
433 options -- Scan.repeat1 (SpecParse.opt_thm_name ":" -- P.prop);
436 OuterSyntax.command "nominal_primrec" "define primitive recursive functions on nominal datatypes" K.thy_goal
437 (primrec_decl >> (fn ((unchecked, (alt_name, (invs, fctxt))), eqns) =>
438 Toplevel.print o Toplevel.theory_to_proof
439 ((if unchecked then add_primrec_unchecked else add_primrec) alt_name invs fctxt
440 (map P.triple_swap eqns))));