haftmann@39401: (*  Title:      Tools/Code/code_runtime.ML
haftmann@28054:     Author:     Florian Haftmann, TU Muenchen
haftmann@28054: 
haftmann@34028: Runtime services building on code generation into implementation language SML.
haftmann@28054: *)
haftmann@28054: 
haftmann@39401: signature CODE_RUNTIME =
haftmann@28054: sig
haftmann@34028:   val target: string
haftmann@39473:   type 'a cookie = (Proof.context -> unit -> 'a) * ((unit -> 'a) -> Proof.context -> Proof.context) * string
haftmann@39473:   val dynamic_value: 'a cookie -> theory -> string option
haftmann@39473:     -> ((term -> term) -> 'a -> 'a) -> term -> string list -> 'a option
haftmann@39473:   val dynamic_value_strict: 'a cookie -> theory -> string option
haftmann@39473:     -> ((term -> term) -> 'a -> 'a) -> term -> string list -> 'a
haftmann@39473:   val dynamic_value_exn: 'a cookie -> theory -> string option
haftmann@39473:     -> ((term -> term) -> 'a -> 'a) -> term -> string list -> 'a Exn.result
haftmann@39473:   val static_value: 'a cookie -> theory -> string option
haftmann@39473:     -> ((term -> term) -> 'a -> 'a) -> string list -> term -> 'a option
haftmann@39473:   val static_value_strict: 'a cookie -> theory -> string option
haftmann@39473:     -> ((term -> term) -> 'a -> 'a) -> string list -> term -> 'a
haftmann@39473:   val static_value_exn: 'a cookie -> theory -> string option
haftmann@39473:     -> ((term -> term) -> 'a -> 'a) -> string list -> term -> 'a Exn.result
haftmann@39473:   val dynamic_holds_conv: conv
haftmann@39473:   val static_holds_conv: theory -> string list -> conv
haftmann@39422:   val code_reflect: (string * string list) list -> string list -> string -> string option
haftmann@39422:     -> theory -> theory
haftmann@39473:   datatype truth = Holds
haftmann@39473:   val put_truth: (unit -> truth) -> Proof.context -> Proof.context
haftmann@28054: end;
haftmann@28054: 
haftmann@39401: structure Code_Runtime : CODE_RUNTIME =
haftmann@28054: struct
haftmann@28054: 
haftmann@39473: open Basic_Code_Thingol;
haftmann@39473: 
haftmann@39404: (** evaluation **)
haftmann@33992: 
haftmann@39473: (* technical prerequisites *)
haftmann@39473: 
haftmann@39473: val this = "Code_Runtime";
haftmann@39473: val s_truth = Long_Name.append this "truth";
haftmann@39473: val s_Holds = Long_Name.append this "Holds";
haftmann@39473: 
haftmann@34028: val target = "Eval";
haftmann@28054: 
haftmann@39473: datatype truth = Holds;
haftmann@39422: 
haftmann@39473: val _ = Context.>> (Context.map_theory
haftmann@39473:   (Code_Target.extend_target (target, (Code_ML.target_SML, K I))
haftmann@39485:   #> Code_Target.add_tyco_syntax target @{type_name prop}
haftmann@39485:        (SOME (0, (K o K o K) (Code_Printer.str s_truth)))
haftmann@39485:   #> Code_Target.add_const_syntax target @{const_name Code_Generator.holds}
haftmann@39485:        (SOME (Code_Printer.plain_const_syntax s_Holds))
haftmann@39473:   #> Code_Target.add_reserved target this
haftmann@39485:   #> fold (Code_Target.add_reserved target) ["oo", "ooo", "oooo", "upto", "downto", "orf", "andf"]));
haftmann@39485:        (*avoid further pervasive infix names*)
haftmann@39473: 
haftmann@39473: 
haftmann@39473: (* evaluation into target language values *)
haftmann@39473: 
haftmann@39473: type 'a cookie = (Proof.context -> unit -> 'a) * ((unit -> 'a) -> Proof.context -> Proof.context) * string;
haftmann@39473: 
haftmann@39485: fun obtain_serializer thy some_target = Code_Target.produce_code_for thy
haftmann@39485:   (the_default target some_target) NONE "Code" [];
haftmann@39485: 
haftmann@39485: fun base_evaluator cookie serializer naming thy program ((vs, ty), t) deps args =
haftmann@39404:   let
haftmann@39404:     val ctxt = ProofContext.init_global thy;
haftmann@39473:     val _ = if Code_Thingol.contains_dictvar t then
haftmann@39473:       error "Term to be evaluated contains free dictionaries" else ();
haftmann@39473:     val v' = Name.variant (map fst vs) "a";
haftmann@39473:     val vs' = (v', []) :: vs
haftmann@39473:     val ty' = Code_Thingol.fun_tyco `%% [ITyVar v', ty];
haftmann@39473:     val value_name = "Value.value.value"
haftmann@39473:     val program' = program
haftmann@39473:       |> Graph.new_node (value_name,
haftmann@39473:           Code_Thingol.Fun (Term.dummy_patternN, (((vs', ty'), [(([IVar NONE], t), (NONE, true))]), NONE)))
haftmann@39473:       |> fold (curry Graph.add_edge value_name) deps;
haftmann@39485:     val (program_code, [SOME value_name']) = serializer naming program' [value_name];
haftmann@39473:     val value_code = space_implode " "
haftmann@39473:       (value_name' :: "()" :: map (enclose "(" ")") args);
haftmann@39473:   in Exn.capture (ML_Context.value ctxt cookie) (program_code, value_code) end;
haftmann@39473: 
haftmann@39473: fun partiality_as_none e = SOME (Exn.release e)
haftmann@39473:   handle General.Match => NONE
haftmann@39473:     | General.Bind => NONE
haftmann@39473:     | General.Fail _ => NONE;
haftmann@39473: 
haftmann@39473: fun dynamic_value_exn cookie thy some_target postproc t args =
haftmann@39473:   let
haftmann@39482:     fun evaluator naming program ((_, vs_ty), t) deps =
haftmann@39485:       base_evaluator cookie (obtain_serializer thy some_target) naming thy program (vs_ty, t) deps args;
haftmann@39473:   in Code_Thingol.dynamic_eval_value thy (Exn.map_result o postproc) evaluator t end;
haftmann@39473: 
haftmann@39473: fun dynamic_value_strict cookie thy some_target postproc t args =
haftmann@39473:   Exn.release (dynamic_value_exn cookie thy some_target postproc t args);
haftmann@39473: 
haftmann@39473: fun dynamic_value cookie thy some_target postproc t args =
haftmann@39473:   partiality_as_none (dynamic_value_exn cookie thy some_target postproc t args);
haftmann@39473: 
haftmann@39473: fun static_value_exn cookie thy some_target postproc consts =
haftmann@39473:   let
haftmann@39485:     val serializer = obtain_serializer thy some_target;
haftmann@39482:     fun evaluator naming program thy ((_, vs_ty), t) deps =
haftmann@39485:       base_evaluator cookie serializer naming thy program (vs_ty, t) deps [];
haftmann@39473:   in Code_Thingol.static_eval_value thy (Exn.map_result o postproc) consts evaluator end;
haftmann@39473: 
haftmann@39473: fun static_value_strict cookie thy some_target postproc consts t =
haftmann@39473:   Exn.release (static_value_exn cookie thy some_target postproc consts t);
haftmann@39473: 
haftmann@39473: fun static_value cookie thy some_target postproc consts t =
haftmann@39473:   partiality_as_none (static_value_exn cookie thy some_target postproc consts t);
haftmann@39473: 
haftmann@39473: 
haftmann@39473: (* evaluation for truth or nothing *)
haftmann@39473: 
haftmann@39473: structure Truth_Result = Proof_Data (
haftmann@39473:   type T = unit -> truth
haftmann@39473:   fun init _ () = error "Truth_Result"
haftmann@39473: );
haftmann@39473: val put_truth = Truth_Result.put;
haftmann@39473: val truth_cookie = (Truth_Result.get, put_truth, Long_Name.append this "put_truth");
haftmann@39473: 
haftmann@39485: fun check_holds serializer naming thy program vs_t deps ct =
haftmann@39473:   let
haftmann@39473:     val t = Thm.term_of ct;
haftmann@39473:     val _ = if fastype_of t <> propT
haftmann@39473:       then error ("Not a proposition: " ^ Syntax.string_of_term_global thy t)
haftmann@39473:       else ();
haftmann@39473:     val iff = Thm.cterm_of thy (Term.Const ("==", propT --> propT --> propT));
haftmann@39485:     val result = case partiality_as_none (base_evaluator truth_cookie serializer naming thy program vs_t deps [])
haftmann@39473:      of SOME Holds => true
haftmann@39473:       | _ => false;
haftmann@39473:   in
haftmann@39473:     Thm.mk_binop iff ct (if result then @{cprop "PROP Code_Generator.holds"} else ct)
haftmann@39473:   end;
haftmann@39473: 
haftmann@39473: val (_, raw_check_holds_oracle) = Context.>>> (Context.map_theory_result
haftmann@39473:   (Thm.add_oracle (Binding.name "holds_by_evaluation",
haftmann@39485:   fn (serializer, naming, thy, program, vs_t, deps, ct) => check_holds serializer naming thy program vs_t deps ct)));
haftmann@39473: 
haftmann@39485: fun check_holds_oracle serializer naming thy program ((_, vs_ty), t) deps ct =
haftmann@39485:   raw_check_holds_oracle (serializer, naming, thy, program, (vs_ty, t), deps, ct);
haftmann@39485: 
haftmann@39485: val dynamic_holds_conv = Conv.tap_thy (fn thy => Code_Thingol.dynamic_eval_conv thy
haftmann@39485:   (fn naming => check_holds_oracle (obtain_serializer thy NONE) naming thy));
haftmann@39473: 
haftmann@39485: fun static_holds_conv thy consts =
haftmann@39485:   let
haftmann@39485:     val serializer = obtain_serializer thy NONE;
haftmann@39485:   in
haftmann@39485:     Code_Thingol.static_eval_conv thy consts
haftmann@39485:       (fn naming => fn program => fn thy => check_holds_oracle serializer naming thy program)
haftmann@39485:   end;
haftmann@39404: 
haftmann@39404: 
haftmann@39404: (** instrumentalization **)
haftmann@39404: 
haftmann@38930: fun evaluation_code thy module_name tycos consts =
haftmann@33992:   let
haftmann@36271:     val (consts', (naming, program)) = Code_Thingol.consts_program thy false consts;
haftmann@34028:     val tycos' = map (the o Code_Thingol.lookup_tyco naming) tycos;
haftmann@38921:     val (ml_code, target_names) = Code_Target.produce_code_for thy
haftmann@38933:       target NONE module_name [] naming program (consts' @ tycos');
haftmann@34028:     val (consts'', tycos'') = chop (length consts') target_names;
haftmann@34028:     val consts_map = map2 (fn const => fn NONE =>
haftmann@34028:         error ("Constant " ^ (quote o Code.string_of_const thy) const
haftmann@34028:           ^ "\nhas a user-defined serialization")
haftmann@34028:       | SOME const'' => (const, const'')) consts consts''
haftmann@34028:     val tycos_map = map2 (fn tyco => fn NONE =>
haftmann@34028:         error ("Type " ^ (quote o Sign.extern_type thy) tyco
haftmann@34028:           ^ "\nhas a user-defined serialization")
haftmann@34028:       | SOME tyco'' => (tyco, tyco'')) tycos tycos'';
haftmann@34028:   in (ml_code, (tycos_map, consts_map)) end;
haftmann@28054: 
haftmann@28054: 
haftmann@39404: (* by antiquotation *)
haftmann@28054: 
haftmann@28054: local
haftmann@28054: 
haftmann@38930: structure Code_Antiq_Data = Proof_Data
haftmann@28054: (
haftmann@38930:   type T = (string list * string list) * (bool
haftmann@38930:     * (string * ((string * string) list * (string * string) list)) lazy);
haftmann@38930:   fun init _ = (([], []), (true, (Lazy.value ("", ([], [])))));
haftmann@28054: );
haftmann@28054: 
haftmann@38930: val is_first_occ = fst o snd o Code_Antiq_Data.get;
haftmann@28054: 
haftmann@30962: fun register_code new_tycos new_consts ctxt =
haftmann@28054:   let
haftmann@38930:     val ((tycos, consts), _) = Code_Antiq_Data.get ctxt;
haftmann@30962:     val tycos' = fold (insert (op =)) new_tycos tycos;
haftmann@30962:     val consts' = fold (insert (op =)) new_consts consts;
haftmann@38930:     val acc_code = Lazy.lazy (fn () =>
haftmann@38930:       evaluation_code (ProofContext.theory_of ctxt) "Code" tycos' consts');
haftmann@38930:   in Code_Antiq_Data.put ((tycos', consts'), (false, acc_code)) ctxt end;
haftmann@30962: 
haftmann@30962: fun register_const const = register_code [] [const];
haftmann@28054: 
haftmann@30962: fun register_datatype tyco constrs = register_code [tyco] constrs;
haftmann@30962: 
haftmann@30962: fun print_const const all_struct_name tycos_map consts_map =
haftmann@30962:   (Long_Name.append all_struct_name o the o AList.lookup (op =) consts_map) const;
haftmann@30962: 
wenzelm@35019: fun print_code is_first print_it ctxt =
haftmann@30962:   let
haftmann@38930:     val (_, (_, acc_code)) = Code_Antiq_Data.get ctxt;
haftmann@33992:     val (ml_code, (tycos_map, consts_map)) = Lazy.force acc_code;
haftmann@33992:     val ml_code = if is_first then ml_code
haftmann@28054:       else "";
haftmann@38930:     val all_struct_name = "Isabelle";
haftmann@30962:   in (ml_code, print_it all_struct_name tycos_map consts_map) end;
haftmann@28054: 
haftmann@28054: in
haftmann@28054: 
wenzelm@35019: fun ml_code_antiq raw_const background =
haftmann@28054:   let
haftmann@31156:     val const = Code.check_const (ProofContext.theory_of background) raw_const;
haftmann@28054:     val is_first = is_first_occ background;
haftmann@28054:     val background' = register_const const background;
wenzelm@35019:   in (print_code is_first (print_const const), background') end;
haftmann@30962: 
haftmann@28054: end; (*local*)
haftmann@28054: 
haftmann@28054: 
haftmann@39404: (* reflection support *)
haftmann@36470: 
haftmann@36470: fun check_datatype thy tyco consts =
haftmann@36470:   let
haftmann@37448:     val constrs = (map (fst o fst) o snd o Code.get_type thy) tyco;
haftmann@36470:     val missing_constrs = subtract (op =) consts constrs;
haftmann@36470:     val _ = if null missing_constrs then []
haftmann@36470:       else error ("Missing constructor(s) " ^ commas (map quote missing_constrs)
haftmann@36470:         ^ " for datatype " ^ quote tyco);
haftmann@36470:     val false_constrs = subtract (op =) constrs consts;
haftmann@36470:     val _ = if null false_constrs then []
haftmann@36470:       else error ("Non-constructor(s) " ^ commas (map quote false_constrs)
haftmann@36470:         ^ " for datatype " ^ quote tyco);
haftmann@36470:   in () end;
haftmann@36470: 
haftmann@36470: fun add_eval_tyco (tyco, tyco') thy =
haftmann@36470:   let
haftmann@36470:     val k = Sign.arity_number thy tyco;
haftmann@36470:     fun pr pr' fxy [] = tyco'
haftmann@36470:       | pr pr' fxy [ty] =
haftmann@36470:           Code_Printer.concat [pr' Code_Printer.BR ty, tyco']
haftmann@36470:       | pr pr' fxy tys =
haftmann@36470:           Code_Printer.concat [Code_Printer.enum "," "(" ")" (map (pr' Code_Printer.BR) tys), tyco']
haftmann@36470:   in
haftmann@36470:     thy
haftmann@38923:     |> Code_Target.add_tyco_syntax target tyco (SOME (k, pr))
haftmann@36470:   end;
haftmann@36470: 
haftmann@36514: fun add_eval_constr (const, const') thy =
haftmann@36514:   let
haftmann@36514:     val k = Code.args_number thy const;
haftmann@36514:     fun pr pr' fxy ts = Code_Printer.brackify fxy
haftmann@38922:       (const' :: the_list (Code_Printer.tuplify pr' Code_Printer.BR (map fst ts)));
haftmann@36514:   in
haftmann@36514:     thy
haftmann@38923:     |> Code_Target.add_const_syntax target const (SOME (Code_Printer.simple_const_syntax (k, pr)))
haftmann@36514:   end;
haftmann@36514: 
haftmann@38923: fun add_eval_const (const, const') = Code_Target.add_const_syntax target
haftmann@36470:   const (SOME (Code_Printer.simple_const_syntax (0, (K o K o K) const')));
haftmann@36470: 
haftmann@39485: fun process_reflection (code_body, (tyco_map, (constr_map, const_map))) module_name NONE thy =
haftmann@38935:       thy
haftmann@38935:       |> Code_Target.add_reserved target module_name
haftmann@38935:       |> Context.theory_map
haftmann@38935:         (ML_Context.exec (fn () => ML_Context.eval_text true Position.none code_body))
haftmann@38935:       |> fold (add_eval_tyco o apsnd Code_Printer.str) tyco_map
haftmann@38935:       |> fold (add_eval_constr o apsnd Code_Printer.str) constr_map
haftmann@38935:       |> fold (add_eval_const o apsnd Code_Printer.str) const_map
haftmann@39485:   | process_reflection (code_body, _) _ (SOME file_name) thy =
haftmann@36470:       let
wenzelm@37950:         val preamble =
wenzelm@37950:           "(* Generated from " ^ Path.implode (Thy_Header.thy_path (Context.theory_name thy))
haftmann@36470:           ^ "; DO NOT EDIT! *)";
haftmann@36470:         val _ = File.write (Path.explode file_name) (preamble ^ "\n\n" ^ code_body);
haftmann@36470:       in
haftmann@36470:         thy
haftmann@36470:       end;
haftmann@36470: 
haftmann@36470: fun gen_code_reflect prep_type prep_const raw_datatypes raw_functions module_name some_file thy  =
haftmann@36470:   let
haftmann@36470:     val datatypes = map (fn (raw_tyco, raw_cos) =>
haftmann@36470:       (prep_type thy raw_tyco, map (prep_const thy) raw_cos)) raw_datatypes;
haftmann@36514:     val _ = map (uncurry (check_datatype thy)) datatypes;
haftmann@36514:     val tycos = map fst datatypes;
haftmann@36514:     val constrs = maps snd datatypes;
haftmann@36470:     val functions = map (prep_const thy) raw_functions;
haftmann@36514:     val result = evaluation_code thy module_name tycos (constrs @ functions)
haftmann@36514:       |> (apsnd o apsnd) (chop (length constrs));
haftmann@36470:   in
haftmann@36470:     thy
haftmann@39485:     |> process_reflection result module_name some_file
haftmann@36470:   end;
haftmann@36470: 
haftmann@39422: val code_reflect = gen_code_reflect Code_Target.cert_tyco (K I);
haftmann@36470: val code_reflect_cmd = gen_code_reflect Code_Target.read_tyco Code.read_const;
haftmann@36470: 
haftmann@36470: 
haftmann@28054: (** Isar setup **)
haftmann@28054: 
haftmann@28054: val _ = ML_Context.add_antiq "code" (fn _ => Args.term >> ml_code_antiq);
haftmann@28054: 
haftmann@36470: local
haftmann@36470: 
haftmann@36470: val datatypesK = "datatypes";
haftmann@36470: val functionsK = "functions";
haftmann@36470: val fileK = "file";
haftmann@36470: val andK = "and"
haftmann@36470: 
wenzelm@36960: val _ = List.app Keyword.keyword [datatypesK, functionsK];
haftmann@36470: 
wenzelm@36960: val parse_datatype =
wenzelm@36960:   Parse.name --| Parse.$$$ "=" -- (Parse.term ::: (Scan.repeat (Parse.$$$ "|" |-- Parse.term)));
haftmann@36470: 
haftmann@36470: in
haftmann@36470: 
haftmann@36470: val _ =
wenzelm@36960:   Outer_Syntax.command "code_reflect" "enrich runtime environment with generated code"
wenzelm@36960:     Keyword.thy_decl (Parse.name -- Scan.optional (Parse.$$$ datatypesK |-- (parse_datatype
wenzelm@36960:       ::: Scan.repeat (Parse.$$$ andK |-- parse_datatype))) []
wenzelm@36960:     -- Scan.optional (Parse.$$$ functionsK |-- Scan.repeat1 Parse.name) []
wenzelm@36960:     -- Scan.option (Parse.$$$ fileK |-- Parse.name)
haftmann@36534:   >> (fn (((module_name, raw_datatypes), raw_functions), some_file) => Toplevel.theory
haftmann@36470:     (code_reflect_cmd raw_datatypes raw_functions module_name some_file)));
haftmann@36470: 
haftmann@36470: end; (*local*)
haftmann@36470: 
haftmann@28054: end; (*struct*)