src/Tools/Code/code_runtime.ML
author haftmann
Thu Sep 16 16:51:34 2010 +0200 (2010-09-16)
changeset 39473 33638f4883ac
parent 39422 9019b6afaa4a
child 39482 1c37d19e3d58
permissions -rw-r--r--
dynamic and static value computation; built-in evaluation of propositions
     1 (*  Title:      Tools/Code/code_runtime.ML
     2     Author:     Florian Haftmann, TU Muenchen
     3 
     4 Runtime services building on code generation into implementation language SML.
     5 *)
     6 
     7 signature CODE_RUNTIME =
     8 sig
     9   val target: string
    10   type 'a cookie = (Proof.context -> unit -> 'a) * ((unit -> 'a) -> Proof.context -> Proof.context) * string
    11   val dynamic_value: 'a cookie -> theory -> string option
    12     -> ((term -> term) -> 'a -> 'a) -> term -> string list -> 'a option
    13   val dynamic_value_strict: 'a cookie -> theory -> string option
    14     -> ((term -> term) -> 'a -> 'a) -> term -> string list -> 'a
    15   val dynamic_value_exn: 'a cookie -> theory -> string option
    16     -> ((term -> term) -> 'a -> 'a) -> term -> string list -> 'a Exn.result
    17   val static_value: 'a cookie -> theory -> string option
    18     -> ((term -> term) -> 'a -> 'a) -> string list -> term -> 'a option
    19   val static_value_strict: 'a cookie -> theory -> string option
    20     -> ((term -> term) -> 'a -> 'a) -> string list -> term -> 'a
    21   val static_value_exn: 'a cookie -> theory -> string option
    22     -> ((term -> term) -> 'a -> 'a) -> string list -> term -> 'a Exn.result
    23   val dynamic_holds_conv: conv
    24   val static_holds_conv: theory -> string list -> conv
    25   val code_reflect: (string * string list) list -> string list -> string -> string option
    26     -> theory -> theory
    27   datatype truth = Holds
    28   val put_truth: (unit -> truth) -> Proof.context -> Proof.context
    29 end;
    30 
    31 structure Code_Runtime : CODE_RUNTIME =
    32 struct
    33 
    34 open Basic_Code_Thingol;
    35 
    36 (** evaluation **)
    37 
    38 (* technical prerequisites *)
    39 
    40 val this = "Code_Runtime";
    41 val s_truth = Long_Name.append this "truth";
    42 val s_Holds = Long_Name.append this "Holds";
    43 
    44 val target = "Eval";
    45 
    46 datatype truth = Holds;
    47 
    48 val _ = Context.>> (Context.map_theory
    49   (Code_Target.extend_target (target, (Code_ML.target_SML, K I))
    50   #> Code_Target.add_tyco_syntax target @{type_name prop} (SOME (0, (K o K o K) (Code_Printer.str s_truth)))
    51   #> Code_Target.add_const_syntax target @{const_name Code_Generator.holds} (SOME (Code_Printer.plain_const_syntax s_Holds))
    52   #> Code_Target.add_reserved target this
    53   #> fold (Code_Target.add_reserved target) ["oo", "ooo", "oooo", "upto", "downto", "orf", "andf"])); (*avoid further pervasive infix names*)
    54 
    55 
    56 (* evaluation into target language values *)
    57 
    58 type 'a cookie = (Proof.context -> unit -> 'a) * ((unit -> 'a) -> Proof.context -> Proof.context) * string;
    59 
    60 fun base_evaluator cookie thy some_target naming program ((_, (vs, ty)), t) deps args =
    61   let
    62     val ctxt = ProofContext.init_global thy;
    63     val _ = if Code_Thingol.contains_dictvar t then
    64       error "Term to be evaluated contains free dictionaries" else ();
    65     val v' = Name.variant (map fst vs) "a";
    66     val vs' = (v', []) :: vs
    67     val ty' = Code_Thingol.fun_tyco `%% [ITyVar v', ty];
    68     val value_name = "Value.value.value"
    69     val program' = program
    70       |> Graph.new_node (value_name,
    71           Code_Thingol.Fun (Term.dummy_patternN, (((vs', ty'), [(([IVar NONE], t), (NONE, true))]), NONE)))
    72       |> fold (curry Graph.add_edge value_name) deps;
    73     val (program_code, [SOME value_name']) = Code_Target.produce_code_for thy
    74       (the_default target some_target) NONE "Code" [] naming program' [value_name];
    75     val value_code = space_implode " "
    76       (value_name' :: "()" :: map (enclose "(" ")") args);
    77   in Exn.capture (ML_Context.value ctxt cookie) (program_code, value_code) end;
    78 
    79 fun partiality_as_none e = SOME (Exn.release e)
    80   handle General.Match => NONE
    81     | General.Bind => NONE
    82     | General.Fail _ => NONE;
    83 
    84 fun dynamic_value_exn cookie thy some_target postproc t args =
    85   let
    86     fun evaluator naming program expr deps =
    87       base_evaluator cookie thy some_target naming program expr deps args;
    88   in Code_Thingol.dynamic_eval_value thy (Exn.map_result o postproc) evaluator t end;
    89 
    90 fun dynamic_value_strict cookie thy some_target postproc t args =
    91   Exn.release (dynamic_value_exn cookie thy some_target postproc t args);
    92 
    93 fun dynamic_value cookie thy some_target postproc t args =
    94   partiality_as_none (dynamic_value_exn cookie thy some_target postproc t args);
    95 
    96 fun static_value_exn cookie thy some_target postproc consts =
    97   let
    98     fun evaluator naming program thy expr deps =
    99       base_evaluator cookie thy some_target naming program expr deps [];
   100   in Code_Thingol.static_eval_value thy (Exn.map_result o postproc) consts evaluator end;
   101 
   102 fun static_value_strict cookie thy some_target postproc consts t =
   103   Exn.release (static_value_exn cookie thy some_target postproc consts t);
   104 
   105 fun static_value cookie thy some_target postproc consts t =
   106   partiality_as_none (static_value_exn cookie thy some_target postproc consts t);
   107 
   108 
   109 (* evaluation for truth or nothing *)
   110 
   111 structure Truth_Result = Proof_Data (
   112   type T = unit -> truth
   113   fun init _ () = error "Truth_Result"
   114 );
   115 val put_truth = Truth_Result.put;
   116 val truth_cookie = (Truth_Result.get, put_truth, Long_Name.append this "put_truth");
   117 
   118 fun check_holds thy naming program expr deps ct =
   119   let
   120     val t = Thm.term_of ct;
   121     val _ = if fastype_of t <> propT
   122       then error ("Not a proposition: " ^ Syntax.string_of_term_global thy t)
   123       else ();
   124     val iff = Thm.cterm_of thy (Term.Const ("==", propT --> propT --> propT));
   125     val result = case partiality_as_none (base_evaluator truth_cookie thy NONE naming program expr deps [])
   126      of SOME Holds => true
   127       | _ => false;
   128   in
   129     Thm.mk_binop iff ct (if result then @{cprop "PROP Code_Generator.holds"} else ct)
   130   end;
   131 
   132 val (_, raw_check_holds_oracle) = Context.>>> (Context.map_theory_result
   133   (Thm.add_oracle (Binding.name "holds_by_evaluation",
   134   fn (thy, naming, program, expr, deps, ct) => check_holds thy naming program expr deps ct)));
   135 
   136 fun check_holds_oracle thy naming program expr deps ct =
   137   raw_check_holds_oracle (thy, naming, program, expr, deps, ct);
   138 
   139 val dynamic_holds_conv = Conv.tap_thy (fn thy => Code_Thingol.dynamic_eval_conv thy (check_holds_oracle thy));
   140 
   141 fun static_holds_conv thy consts = Code_Thingol.static_eval_conv thy consts
   142   (fn naming => fn program => fn thy => check_holds_oracle thy naming program);
   143 
   144 
   145 (** instrumentalization **)
   146 
   147 fun evaluation_code thy module_name tycos consts =
   148   let
   149     val (consts', (naming, program)) = Code_Thingol.consts_program thy false consts;
   150     val tycos' = map (the o Code_Thingol.lookup_tyco naming) tycos;
   151     val (ml_code, target_names) = Code_Target.produce_code_for thy
   152       target NONE module_name [] naming program (consts' @ tycos');
   153     val (consts'', tycos'') = chop (length consts') target_names;
   154     val consts_map = map2 (fn const => fn NONE =>
   155         error ("Constant " ^ (quote o Code.string_of_const thy) const
   156           ^ "\nhas a user-defined serialization")
   157       | SOME const'' => (const, const'')) consts consts''
   158     val tycos_map = map2 (fn tyco => fn NONE =>
   159         error ("Type " ^ (quote o Sign.extern_type thy) tyco
   160           ^ "\nhas a user-defined serialization")
   161       | SOME tyco'' => (tyco, tyco'')) tycos tycos'';
   162   in (ml_code, (tycos_map, consts_map)) end;
   163 
   164 
   165 (* by antiquotation *)
   166 
   167 local
   168 
   169 structure Code_Antiq_Data = Proof_Data
   170 (
   171   type T = (string list * string list) * (bool
   172     * (string * ((string * string) list * (string * string) list)) lazy);
   173   fun init _ = (([], []), (true, (Lazy.value ("", ([], [])))));
   174 );
   175 
   176 val is_first_occ = fst o snd o Code_Antiq_Data.get;
   177 
   178 fun register_code new_tycos new_consts ctxt =
   179   let
   180     val ((tycos, consts), _) = Code_Antiq_Data.get ctxt;
   181     val tycos' = fold (insert (op =)) new_tycos tycos;
   182     val consts' = fold (insert (op =)) new_consts consts;
   183     val acc_code = Lazy.lazy (fn () =>
   184       evaluation_code (ProofContext.theory_of ctxt) "Code" tycos' consts');
   185   in Code_Antiq_Data.put ((tycos', consts'), (false, acc_code)) ctxt end;
   186 
   187 fun register_const const = register_code [] [const];
   188 
   189 fun register_datatype tyco constrs = register_code [tyco] constrs;
   190 
   191 fun print_const const all_struct_name tycos_map consts_map =
   192   (Long_Name.append all_struct_name o the o AList.lookup (op =) consts_map) const;
   193 
   194 fun print_code is_first print_it ctxt =
   195   let
   196     val (_, (_, acc_code)) = Code_Antiq_Data.get ctxt;
   197     val (ml_code, (tycos_map, consts_map)) = Lazy.force acc_code;
   198     val ml_code = if is_first then ml_code
   199       else "";
   200     val all_struct_name = "Isabelle";
   201   in (ml_code, print_it all_struct_name tycos_map consts_map) end;
   202 
   203 in
   204 
   205 fun ml_code_antiq raw_const background =
   206   let
   207     val const = Code.check_const (ProofContext.theory_of background) raw_const;
   208     val is_first = is_first_occ background;
   209     val background' = register_const const background;
   210   in (print_code is_first (print_const const), background') end;
   211 
   212 end; (*local*)
   213 
   214 
   215 (* reflection support *)
   216 
   217 fun check_datatype thy tyco consts =
   218   let
   219     val constrs = (map (fst o fst) o snd o Code.get_type thy) tyco;
   220     val missing_constrs = subtract (op =) consts constrs;
   221     val _ = if null missing_constrs then []
   222       else error ("Missing constructor(s) " ^ commas (map quote missing_constrs)
   223         ^ " for datatype " ^ quote tyco);
   224     val false_constrs = subtract (op =) constrs consts;
   225     val _ = if null false_constrs then []
   226       else error ("Non-constructor(s) " ^ commas (map quote false_constrs)
   227         ^ " for datatype " ^ quote tyco);
   228   in () end;
   229 
   230 fun add_eval_tyco (tyco, tyco') thy =
   231   let
   232     val k = Sign.arity_number thy tyco;
   233     fun pr pr' fxy [] = tyco'
   234       | pr pr' fxy [ty] =
   235           Code_Printer.concat [pr' Code_Printer.BR ty, tyco']
   236       | pr pr' fxy tys =
   237           Code_Printer.concat [Code_Printer.enum "," "(" ")" (map (pr' Code_Printer.BR) tys), tyco']
   238   in
   239     thy
   240     |> Code_Target.add_tyco_syntax target tyco (SOME (k, pr))
   241   end;
   242 
   243 fun add_eval_constr (const, const') thy =
   244   let
   245     val k = Code.args_number thy const;
   246     fun pr pr' fxy ts = Code_Printer.brackify fxy
   247       (const' :: the_list (Code_Printer.tuplify pr' Code_Printer.BR (map fst ts)));
   248   in
   249     thy
   250     |> Code_Target.add_const_syntax target const (SOME (Code_Printer.simple_const_syntax (k, pr)))
   251   end;
   252 
   253 fun add_eval_const (const, const') = Code_Target.add_const_syntax target
   254   const (SOME (Code_Printer.simple_const_syntax (0, (K o K o K) const')));
   255 
   256 fun process (code_body, (tyco_map, (constr_map, const_map))) module_name NONE thy =
   257       thy
   258       |> Code_Target.add_reserved target module_name
   259       |> Context.theory_map
   260         (ML_Context.exec (fn () => ML_Context.eval_text true Position.none code_body))
   261       |> fold (add_eval_tyco o apsnd Code_Printer.str) tyco_map
   262       |> fold (add_eval_constr o apsnd Code_Printer.str) constr_map
   263       |> fold (add_eval_const o apsnd Code_Printer.str) const_map
   264   | process (code_body, _) _ (SOME file_name) thy =
   265       let
   266         val preamble =
   267           "(* Generated from " ^ Path.implode (Thy_Header.thy_path (Context.theory_name thy))
   268           ^ "; DO NOT EDIT! *)";
   269         val _ = File.write (Path.explode file_name) (preamble ^ "\n\n" ^ code_body);
   270       in
   271         thy
   272       end;
   273 
   274 fun gen_code_reflect prep_type prep_const raw_datatypes raw_functions module_name some_file thy  =
   275   let
   276     val datatypes = map (fn (raw_tyco, raw_cos) =>
   277       (prep_type thy raw_tyco, map (prep_const thy) raw_cos)) raw_datatypes;
   278     val _ = map (uncurry (check_datatype thy)) datatypes;
   279     val tycos = map fst datatypes;
   280     val constrs = maps snd datatypes;
   281     val functions = map (prep_const thy) raw_functions;
   282     val result = evaluation_code thy module_name tycos (constrs @ functions)
   283       |> (apsnd o apsnd) (chop (length constrs));
   284   in
   285     thy
   286     |> process result module_name some_file
   287   end;
   288 
   289 val code_reflect = gen_code_reflect Code_Target.cert_tyco (K I);
   290 val code_reflect_cmd = gen_code_reflect Code_Target.read_tyco Code.read_const;
   291 
   292 
   293 (** Isar setup **)
   294 
   295 val _ = ML_Context.add_antiq "code" (fn _ => Args.term >> ml_code_antiq);
   296 
   297 local
   298 
   299 val datatypesK = "datatypes";
   300 val functionsK = "functions";
   301 val fileK = "file";
   302 val andK = "and"
   303 
   304 val _ = List.app Keyword.keyword [datatypesK, functionsK];
   305 
   306 val parse_datatype =
   307   Parse.name --| Parse.$$$ "=" -- (Parse.term ::: (Scan.repeat (Parse.$$$ "|" |-- Parse.term)));
   308 
   309 in
   310 
   311 val _ =
   312   Outer_Syntax.command "code_reflect" "enrich runtime environment with generated code"
   313     Keyword.thy_decl (Parse.name -- Scan.optional (Parse.$$$ datatypesK |-- (parse_datatype
   314       ::: Scan.repeat (Parse.$$$ andK |-- parse_datatype))) []
   315     -- Scan.optional (Parse.$$$ functionsK |-- Scan.repeat1 Parse.name) []
   316     -- Scan.option (Parse.$$$ fileK |-- Parse.name)
   317   >> (fn (((module_name, raw_datatypes), raw_functions), some_file) => Toplevel.theory
   318     (code_reflect_cmd raw_datatypes raw_functions module_name some_file)));
   319 
   320 end; (*local*)
   321 
   322 end; (*struct*)