1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/HOL/Tools/record_package.ML Wed Apr 29 11:40:37 1998 +0200
1.3 @@ -0,0 +1,572 @@
1.4 +(* Title: HOL/Tools/record_package.ML
1.5 + ID: $Id$
1.6 + Author: Wolfgang Naraschewski and Markus Wenzel, TU Muenchen
1.7 +
1.8 +Extensible records with structural subtyping in HOL.
1.9 +
1.10 +TODO:
1.11 + - record_info: tr' funs;
1.12 + - trfuns for record types;
1.13 + - field types: typedef;
1.14 + - make selector types as general as possible (no!?);
1.15 +*)
1.16 +
1.17 +signature RECORD_PACKAGE =
1.18 +sig
1.19 + val print_records: theory -> unit
1.20 + val add_record: (string list * bstring) -> string option
1.21 + -> (bstring * string) list -> theory -> theory
1.22 + val add_record_i: (string list * bstring) -> (typ list * string) option
1.23 + -> (bstring * typ) list -> theory -> theory
1.24 + val setup: (theory -> theory) list
1.25 +end;
1.26 +
1.27 +structure RecordPackage: RECORD_PACKAGE =
1.28 +struct
1.29 +
1.30 +
1.31 +(*** syntax operations ***)
1.32 +
1.33 +(** names **)
1.34 +
1.35 +(* name components *)
1.36 +
1.37 +val moreN = "more";
1.38 +val schemeN = "_scheme";
1.39 +val fieldN = "_field";
1.40 +val field_typeN = "_field_type";
1.41 +val fstN = "_val";
1.42 +val sndN = "_more";
1.43 +val updateN = "_update";
1.44 +val makeN = "make";
1.45 +val make_schemeN = "make_scheme";
1.46 +
1.47 +
1.48 +(* suffixes *)
1.49 +
1.50 +fun suffix sfx s = s ^ sfx;
1.51 +
1.52 +fun unsuffix sfx s =
1.53 + let
1.54 + val cs = explode s;
1.55 + val prfx_len = size s - size sfx;
1.56 + in
1.57 + if prfx_len >= 0 andalso implode (drop (prfx_len, cs)) = sfx then
1.58 + implode (take (prfx_len, cs))
1.59 + else raise LIST "unsuffix"
1.60 + end;
1.61 +
1.62 +
1.63 +
1.64 +(** tuple operations **)
1.65 +
1.66 +(* more type class *)
1.67 +
1.68 +val moreS = ["more"];
1.69 +
1.70 +
1.71 +(* types *)
1.72 +
1.73 +fun mk_fieldT ((c, T), U) = Type (suffix field_typeN c, [T, U]);
1.74 +
1.75 +fun dest_fieldT (typ as Type (c_field_type, [T, U])) =
1.76 + (case try (unsuffix field_typeN) c_field_type of
1.77 + None => raise TYPE ("dest_fieldT", [typ], [])
1.78 + | Some c => ((c, T), U))
1.79 + | dest_fieldT typ = raise TYPE ("dest_fieldT", [typ], []);
1.80 +
1.81 +
1.82 +(* constructors *)
1.83 +
1.84 +fun mk_fieldC U (c, T) = (suffix fieldN c, T --> U --> mk_fieldT ((c, T), U));
1.85 +
1.86 +fun mk_field ((c, t), u) =
1.87 + let val T = fastype_of t and U = fastype_of u
1.88 + in Const (suffix fieldN c, [T, U] ---> mk_fieldT ((c, T), U)) $ t $ u end;
1.89 +
1.90 +
1.91 +(* destructors *)
1.92 +
1.93 +fun mk_fstC U (c, T) = (suffix fstN c, mk_fieldT ((c, T), U) --> T);
1.94 +fun mk_sndC U (c, T) = (suffix sndN c, mk_fieldT ((c, T), U) --> U);
1.95 +
1.96 +fun dest_field fst_or_snd p =
1.97 + let
1.98 + val pT = fastype_of p;
1.99 + val ((c, T), U) = dest_fieldT pT;
1.100 + val (destN, destT) = if fst_or_snd then (fstN, T) else (sndN, U);
1.101 + in Const (suffix destN c, pT --> destT) $ p end;
1.102 +
1.103 +val mk_fst = dest_field true;
1.104 +val mk_snd = dest_field false;
1.105 +
1.106 +
1.107 +
1.108 +(** record operations **)
1.109 +
1.110 +(* types *)
1.111 +
1.112 +val mk_recordT = foldr mk_fieldT;
1.113 +
1.114 +fun dest_recordT T =
1.115 + (case try dest_fieldT T of
1.116 + None => ([], T)
1.117 + | Some (c_T, U) => apfst (cons c_T) (dest_recordT U));
1.118 +
1.119 +fun find_fieldT c rT =
1.120 + (case assoc (fst (dest_recordT rT), c) of
1.121 + None => raise TYPE ("find_field: " ^ c, [rT], [])
1.122 + | Some T => T);
1.123 +
1.124 +
1.125 +(* constructors *)
1.126 +
1.127 +val mk_record = foldr mk_field;
1.128 +
1.129 +
1.130 +(* selectors *)
1.131 +
1.132 +fun mk_selC rT (c, T) = (c, rT --> T);
1.133 +
1.134 +fun mk_sel c r =
1.135 + let val rT = fastype_of r
1.136 + in Const (mk_selC rT (c, find_fieldT c rT)) $ r end;
1.137 +
1.138 +
1.139 +(* updates *)
1.140 +
1.141 +fun mk_updateC rT (c, T) = (suffix updateN c, T --> rT --> rT);
1.142 +
1.143 +fun mk_update c x r =
1.144 + let val rT = fastype_of r
1.145 + in Const (mk_updateC rT (c, find_fieldT c rT)) $ x $ r end;
1.146 +
1.147 +
1.148 +
1.149 +(** concrete syntax for records **)
1.150 +
1.151 +(* parse translations *)
1.152 +
1.153 +fun field_tr (Const ("_field", _) $ Free (name, _) $ arg) =
1.154 + Syntax.const (suffix fieldN name) $ arg
1.155 + | field_tr t = raise TERM ("field_tr", [t]);
1.156 +
1.157 +fun fields_tr (Const ("_fields", _) $ field $ fields) =
1.158 + field_tr field :: fields_tr fields
1.159 + | fields_tr field = [field_tr field];
1.160 +
1.161 +fun record_tr (*"_record"*) [fields] =
1.162 + foldr (op $) (fields_tr fields, HOLogic.unit)
1.163 + | record_tr (*"_record"*) ts = raise TERM ("record_tr", ts);
1.164 +
1.165 +fun record_scheme_tr (*"_record_scheme"*) [fields, more] =
1.166 + foldr (op $) (fields_tr fields, more)
1.167 + | record_scheme_tr (*"_record_scheme"*) ts = raise TERM ("record_scheme_tr", ts);
1.168 +
1.169 +
1.170 +(* print translations *) (* FIXME tune, activate *)
1.171 +
1.172 +(* FIXME ... :: tms *)
1.173 +fun fields_tr' (tm as Const (name_field, _) $ arg $ more) =
1.174 + (case try (unsuffix fieldN) name_field of
1.175 + Some name =>
1.176 + apfst (cons (Syntax.const "_field" $ Syntax.free name $ arg)) (fields_tr' more)
1.177 + | None => ([], tm))
1.178 + | fields_tr' tm = ([], tm);
1.179 +
1.180 +fun record_tr' tm =
1.181 + let
1.182 + val mk_fields = foldr (fn (field, fields) => Syntax.const "_fields" $ field $ fields);
1.183 + val (fields, more) = fields_tr' tm;
1.184 + in
1.185 + if HOLogic.is_unit more then
1.186 + Syntax.const "_record" $ mk_fields (split_last fields)
1.187 + else Syntax.const "_record_scheme" $ mk_fields (fields, more)
1.188 + end;
1.189 +
1.190 +fun field_tr' name [arg, more] = record_tr' (Syntax.const name $ arg $ more)
1.191 + | field_tr' _ _ = raise Match;
1.192 +
1.193 +
1.194 +
1.195 +(*** extend theory by record definition ***)
1.196 +
1.197 +(** record info **)
1.198 +
1.199 +(* type record_info and parent_info *)
1.200 +
1.201 +type record_info =
1.202 + {args: (string * sort) list,
1.203 + parent: (typ list * string) option,
1.204 + fields: (string * typ) list,
1.205 + simps: tthm list};
1.206 +
1.207 +type parent_info =
1.208 + {name: string,
1.209 + fields: (string * typ) list,
1.210 + simps: tthm list};
1.211 +
1.212 +
1.213 +(* theory data *)
1.214 +
1.215 +val recordsK = "HOL/records";
1.216 +exception Records of record_info Symtab.table;
1.217 +
1.218 +fun print_records thy = Display.print_data thy recordsK;
1.219 +
1.220 +local
1.221 + val empty = Records Symtab.empty;
1.222 +
1.223 + fun prep_ext (x as Records _) = x;
1.224 +
1.225 + fun merge (Records tab1, Records tab2) =
1.226 + Records (Symtab.merge (K true) (tab1, tab2));
1.227 +
1.228 + fun print sg (Records tab) =
1.229 + let
1.230 + val prt_typ = Sign.pretty_typ sg;
1.231 + val ext_const = Sign.cond_extern sg Sign.constK;
1.232 +
1.233 + fun pretty_parent None = []
1.234 + | pretty_parent (Some (Ts, name)) =
1.235 + [Pretty.block [prt_typ (Type (name, Ts)), Pretty.str " +"]];
1.236 +
1.237 + fun pretty_field (c, T) = Pretty.block
1.238 + [Pretty.str (ext_const c), Pretty.str " ::", Pretty.brk 1, Pretty.quote (prt_typ T)];
1.239 +
1.240 + fun pretty_record (name, {args, parent, fields, simps = _}) = Pretty.block (Pretty.fbreaks
1.241 + (Pretty.block [prt_typ (Type (name, map TFree args)), Pretty.str " = "] ::
1.242 + pretty_parent parent @ map pretty_field fields));
1.243 + in
1.244 + seq (Pretty.writeln o pretty_record) (Symtab.dest tab)
1.245 + end;
1.246 +in
1.247 + val record_thy_data = (recordsK, (empty, prep_ext, merge, print));
1.248 +end;
1.249 +
1.250 +
1.251 +(* get and put records *)
1.252 +
1.253 +fun get_records thy =
1.254 + (case Theory.get_data thy recordsK of
1.255 + Records tab => tab
1.256 + | _ => type_error recordsK);
1.257 +
1.258 +fun get_record thy name = Symtab.lookup (get_records thy, name);
1.259 +
1.260 +
1.261 +fun put_records tab thy =
1.262 + Theory.put_data (recordsK, Records tab) thy;
1.263 +
1.264 +fun put_new_record name info thy =
1.265 + thy |> put_records
1.266 + (Symtab.update_new ((name, info), get_records thy)
1.267 + handle Symtab.DUP _ => error ("Duplicate definition of record " ^ quote name));
1.268 +
1.269 +
1.270 +(* parent records *)
1.271 +
1.272 +fun inst_record thy (types, name) =
1.273 + let
1.274 + val sign = Theory.sign_of thy;
1.275 + fun err msg = error (msg ^ " parent record " ^ quote name);
1.276 +
1.277 + val {args, parent, fields, simps} =
1.278 + (case get_record thy name of Some info => info | None => err "Unknown");
1.279 +
1.280 + fun bad_inst ((x, S), T) =
1.281 + if Sign.of_sort sign (T, S) then None else Some x
1.282 + val bads = mapfilter bad_inst (args ~~ types);
1.283 +
1.284 + val inst = map fst args ~~ types;
1.285 + val subst = Term.map_type_tfree (fn (x, _) => the (assoc (inst, x)));
1.286 + in
1.287 + if length types <> length args then
1.288 + err "Bad number of arguments for"
1.289 + else if not (null bads) then
1.290 + err ("Ill-sorted instantiation of " ^ commas bads ^ " in")
1.291 + else (apsome (apfst (map subst)) parent, map (apsnd subst) fields, simps)
1.292 + end;
1.293 +
1.294 +fun add_parents thy (None, parents) = parents
1.295 + | add_parents thy (Some (types, name), parents) =
1.296 + let val (pparent, pfields, psimps) = inst_record thy (types, name)
1.297 + in add_parents thy (pparent, {name = name, fields = pfields, simps = psimps} :: parents) end;
1.298 +
1.299 +
1.300 +
1.301 +(** record theorems **)
1.302 +
1.303 +(* proof by simplification *)
1.304 +
1.305 +fun prove_simp thy opt_ss simps =
1.306 + let val ss = if_none opt_ss HOL_basic_ss addsimps simps in
1.307 + fn goal => Goals.prove_goalw_cterm [] (Thm.cterm_of (sign_of thy) goal)
1.308 + (K [ALLGOALS (Simplifier.simp_tac ss)])
1.309 + end;
1.310 +
1.311 +
1.312 +
1.313 +(** internal theory extender **)
1.314 +
1.315 +(*do the actual record definition, assuming that all arguments are
1.316 + well-formed*)
1.317 +
1.318 +fun record_definition (args, bname) parent (parents: parent_info list) bfields thy =
1.319 + let
1.320 + val sign = Theory.sign_of thy;
1.321 + val full = Sign.full_name_path sign bname;
1.322 +
1.323 +
1.324 + (* input *)
1.325 +
1.326 + val alphas = map fst args;
1.327 + val name = Sign.full_name sign bname; (* FIXME !? *)
1.328 + val parent_fields = flat (map #fields parents);
1.329 + val fields = map (apfst full) bfields;
1.330 +
1.331 + val all_fields = parent_fields @ fields;
1.332 + val all_types = map snd all_fields;
1.333 +
1.334 +
1.335 + (* term / type components *)
1.336 +
1.337 + val zeta = variant alphas "'z";
1.338 + val moreT = TFree (zeta, moreS);
1.339 +
1.340 + val xs = variantlist (map fst bfields, []);
1.341 + val vars = map2 Free (xs, map snd fields);
1.342 + val more = Free (variant xs moreN, moreT);
1.343 +
1.344 + val rec_schemeT = mk_recordT (all_fields, moreT);
1.345 + val recT = mk_recordT (all_fields, HOLogic.unitT);
1.346 +
1.347 + (* FIXME tune *)
1.348 + val make_schemeT = all_types ---> moreT --> rec_schemeT;
1.349 + val make_scheme = Const (full make_schemeN, make_schemeT);
1.350 + val makeT = all_types ---> recT;
1.351 + val make = Const (full makeN, makeT);
1.352 +
1.353 + val parent_more = funpow (length parent_fields) mk_snd;
1.354 +
1.355 +
1.356 + (* prepare type definitions *)
1.357 +
1.358 + (*field types*)
1.359 + fun mk_fieldT_spec ((c, T), a) =
1.360 + (suffix field_typeN c, [a, zeta],
1.361 + HOLogic.mk_prodT (TFree (a, HOLogic.termS), moreT), Syntax.NoSyn);
1.362 + val fieldT_specs = map2 mk_fieldT_spec (bfields, alphas);
1.363 +
1.364 + (*record types*)
1.365 + val recordT_specs =
1.366 + [(suffix schemeN bname, alphas @ [zeta], rec_schemeT, Syntax.NoSyn),
1.367 + (bname, alphas, recT, Syntax.NoSyn)];
1.368 +
1.369 +
1.370 + (* prepare declarations *)
1.371 +
1.372 + val field_decls = map (mk_fieldC moreT) fields;
1.373 + val dest_decls = map (mk_fstC moreT) fields @ map (mk_sndC moreT) fields;
1.374 + val sel_decls = map (mk_selC rec_schemeT) fields;
1.375 + val update_decls = map (mk_updateC rec_schemeT) fields;
1.376 + val make_decls = [(make_schemeN, make_schemeT), (makeN, makeT)];
1.377 +
1.378 +
1.379 + (* prepare definitions *)
1.380 +
1.381 + (*field constructors*)
1.382 + fun mk_field_spec ((c, _), v) =
1.383 + Logic.mk_defpair (mk_field ((c, v), more), HOLogic.mk_prod (v, more));
1.384 + val field_specs = map2 mk_field_spec (fields, vars);
1.385 +
1.386 + (*field destructors*)
1.387 + fun mk_dest_spec dest dest' (c, T) =
1.388 + let
1.389 + val p = Free ("p", mk_fieldT ((c, T), moreT));
1.390 + val p' = Free ("p", HOLogic.mk_prodT (T, moreT)); (*Note: field types are abbreviations*)
1.391 + in Logic.mk_defpair (dest p, dest' p') end;
1.392 + val dest_specs =
1.393 + map (mk_dest_spec mk_fst HOLogic.mk_fst) fields @
1.394 + map (mk_dest_spec mk_snd HOLogic.mk_snd) fields;
1.395 +
1.396 + (*field selectors*) (* FIXME tune *)
1.397 + fun mk_sel_specs _ [] specs = rev specs
1.398 + | mk_sel_specs prfx ((c, T) :: fs) specs =
1.399 + let
1.400 + val prfx' = prfx @ [(c, T)];
1.401 + val r = Free ("r", mk_recordT (prfx' @ fs, moreT));
1.402 + val spec = Logic.mk_defpair (mk_sel c r, mk_fst (funpow (length prfx) mk_snd r));
1.403 + in mk_sel_specs prfx' fs (spec :: specs) end;
1.404 + val sel_specs = mk_sel_specs parent_fields fields [];
1.405 +
1.406 + (*updates*)
1.407 + val update_specs = []; (* FIXME *)
1.408 +
1.409 + (*makes*)
1.410 + val make_specs =
1.411 + map Logic.mk_defpair
1.412 + [(list_comb (make_scheme, vars) $ more, mk_record (map fst fields ~~ vars, more)),
1.413 + (list_comb (make, vars), mk_record (map fst fields ~~ vars, HOLogic.unit))];
1.414 +
1.415 +
1.416 + (* 1st stage: defs_thy *)
1.417 +
1.418 + val defs_thy =
1.419 + thy
1.420 + |> Theory.add_path bname
1.421 + |> Theory.add_tyabbrs_i (fieldT_specs @ recordT_specs)
1.422 + |> (Theory.add_consts_i o map (Syntax.no_syn o apfst Sign.base_name))
1.423 + (field_decls @ dest_decls @ sel_decls @ update_decls @ make_decls)
1.424 + |> (PureThy.add_defs_i o map Attribute.none)
1.425 + (field_specs @ dest_specs @ sel_specs @ update_specs @ make_specs);
1.426 +
1.427 + local fun get_defs specs = map (PureThy.get_tthm defs_thy o fst) specs in
1.428 + val make_defs = get_defs make_specs;
1.429 + val field_defs = get_defs field_specs;
1.430 + val sel_defs = get_defs sel_specs;
1.431 + val update_defs = get_defs update_specs;
1.432 + end;
1.433 +
1.434 +
1.435 + (* 2nd stage: thms_thy *)
1.436 +
1.437 + val thms_thy =
1.438 + defs_thy
1.439 + |> (PureThy.add_tthmss o map Attribute.none)
1.440 + [("make_defs", make_defs),
1.441 + ("field_defs", field_defs),
1.442 + ("sel_defs", sel_defs),
1.443 + ("update_defs", update_defs)]
1.444 +(* |> record_theorems FIXME *)
1.445 +
1.446 +
1.447 + (* 3rd stage: final_thy *)
1.448 +
1.449 + val final_thy =
1.450 + thms_thy
1.451 + |> put_new_record name
1.452 + {args = args, parent = parent, fields = fields, simps = [] (* FIXME *)}
1.453 + |> Theory.parent_path;
1.454 +
1.455 + in final_thy end;
1.456 +
1.457 +
1.458 +
1.459 +(** theory extender interface **)
1.460 +
1.461 +(*do all preparations and error checks here, deferring the real work
1.462 + to record_definition above*)
1.463 +
1.464 +
1.465 +(* prepare arguments *)
1.466 +
1.467 +(*Note: read_raw_typ avoids expanding type abbreviations*)
1.468 +fun read_raw_parent sign s =
1.469 + (case Sign.read_raw_typ (sign, K None) s handle TYPE (msg, _, _) => error msg of
1.470 + Type (name, Ts) => (Ts, name)
1.471 + | _ => error ("Bad parent record specification: " ^ quote s));
1.472 +
1.473 +fun read_typ sign (env, s) =
1.474 + let
1.475 + fun def_type (x, ~1) = assoc (env, x)
1.476 + | def_type _ = None;
1.477 + val T = Type.no_tvars (Sign.read_typ (sign, def_type) s) handle TYPE (msg, _, _) => error msg;
1.478 + in (Term.add_typ_tfrees (T, env), T) end;
1.479 +
1.480 +fun cert_typ sign (env, raw_T) =
1.481 + let val T = Type.no_tvars (Sign.certify_typ sign raw_T) handle TYPE (msg, _, _) => error msg
1.482 + in (Term.add_typ_tfrees (T, env), T) end;
1.483 +
1.484 +
1.485 +(* add_record *)
1.486 +
1.487 +fun gen_add_record prep_typ prep_raw_parent (params, bname) raw_parent raw_fields thy =
1.488 + let
1.489 + val _ = Theory.require thy "Record" "record definitions";
1.490 + val sign = Theory.sign_of thy;
1.491 +
1.492 +
1.493 + (* parents *)
1.494 +
1.495 + fun prep_inst T = snd (cert_typ sign ([], T));
1.496 +
1.497 + val parent = apsome (apfst (map prep_inst) o prep_raw_parent sign) raw_parent
1.498 + handle ERROR => error ("The error(s) above in parent record specification");
1.499 + val parents = add_parents thy (parent, []);
1.500 +
1.501 + val init_env =
1.502 + (case parent of
1.503 + None => []
1.504 + | Some (types, _) => foldr Term.add_typ_tfrees (types, []));
1.505 +
1.506 +
1.507 + (* fields *)
1.508 +
1.509 + fun prep_fields (env, []) = (env, [])
1.510 + | prep_fields (env, (c, raw_T) :: fs) =
1.511 + let
1.512 + val (env', T) = prep_typ sign (env, raw_T) handle ERROR =>
1.513 + error ("The error(s) above occured in field " ^ quote c);
1.514 + val (env'', fs') = prep_fields (env', fs);
1.515 + in (env'', (c, T) :: fs') end;
1.516 +
1.517 + val (envir, bfields) = prep_fields (init_env, raw_fields);
1.518 + val envir_names = map fst envir;
1.519 +
1.520 +
1.521 + (* args *)
1.522 +
1.523 + val defaultS = Sign.defaultS sign;
1.524 + val args = map (fn x => (x, if_none (assoc (envir, x)) defaultS)) params;
1.525 +
1.526 +
1.527 + (* errors *)
1.528 +
1.529 + val err_dup_parms =
1.530 + (case duplicates params of
1.531 + [] => []
1.532 + | dups => ["Duplicate parameters " ^ commas params]);
1.533 +
1.534 + val err_extra_frees =
1.535 + (case gen_rems (op =) (envir_names, params) of
1.536 + [] => []
1.537 + | extras => ["Extraneous free type variables " ^ commas extras]);
1.538 +
1.539 + val err_no_fields = if null bfields then ["No fields"] else [];
1.540 +
1.541 + val err_dup_fields =
1.542 + (case duplicates (map fst bfields) of
1.543 + [] => []
1.544 + | dups => ["Duplicate fields " ^ commas_quote dups]);
1.545 +
1.546 + val err_dup_sorts =
1.547 + (case duplicates envir_names of
1.548 + [] => []
1.549 + | dups => ["Inconsistent sort constraints for " ^ commas dups]);
1.550 +
1.551 + val errs =
1.552 + err_dup_parms @ err_extra_frees @ err_no_fields @ err_dup_fields @ err_dup_sorts;
1.553 + in
1.554 + if null errs then ()
1.555 + else error (cat_lines errs);
1.556 +
1.557 + writeln ("Defining record " ^ quote bname ^ " ...");
1.558 + thy |> record_definition (args, bname) parent parents bfields
1.559 + end
1.560 + handle ERROR => error ("Failed to define record " ^ quote bname);
1.561 +
1.562 +val add_record = gen_add_record read_typ read_raw_parent;
1.563 +val add_record_i = gen_add_record cert_typ (K I);
1.564 +
1.565 +
1.566 +
1.567 +(** setup theory **)
1.568 +
1.569 +val setup =
1.570 + [Theory.init_data [record_thy_data],
1.571 + Theory.add_trfuns
1.572 + ([], [("_record", record_tr), ("_record_scheme", record_scheme_tr)], [], [])];
1.573 +
1.574 +
1.575 +end;