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