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