src/Tools/Code/code_target.ML
author haftmann
Tue, 28 Sep 2010 09:14:37 +0200
changeset 39983 c0099428ca7b
parent 39903 d36864e3f06c
child 40059 5228c6b20273
permissions -rw-r--r--
consider quick_and_dirty option before loading theory
haftmann@37744
     1
(*  Title:      Tools/Code/code_target.ML
haftmann@24219
     2
    Author:     Florian Haftmann, TU Muenchen
haftmann@24219
     3
haftmann@39136
     4
Generic infrastructure for target language data.
haftmann@24219
     5
*)
haftmann@24219
     6
haftmann@24219
     7
signature CODE_TARGET =
haftmann@24219
     8
sig
haftmann@36467
     9
  val cert_tyco: theory -> string -> string
haftmann@36467
    10
  val read_tyco: theory -> string -> string
haftmann@39291
    11
  val read_const_exprs: theory -> string list -> string list
haftmann@36467
    12
haftmann@39159
    13
  val export_code_for: theory -> Path.T option -> string -> int option -> string -> Token.T list
haftmann@39144
    14
    -> Code_Thingol.naming -> Code_Thingol.program -> string list -> unit
haftmann@39159
    15
  val produce_code_for: theory -> string -> int option -> string -> Token.T list
haftmann@39155
    16
    -> Code_Thingol.naming -> Code_Thingol.program -> string list -> string * string option list
haftmann@39159
    17
  val present_code_for: theory -> string -> int option -> string -> Token.T list
haftmann@39155
    18
    -> Code_Thingol.naming -> Code_Thingol.program -> string list * string list -> string
haftmann@39144
    19
  val check_code_for: theory -> string -> bool -> Token.T list
haftmann@39144
    20
    -> Code_Thingol.naming -> Code_Thingol.program -> string list -> unit
haftmann@39144
    21
haftmann@39144
    22
  val export_code: theory -> string list
haftmann@39159
    23
    -> (((string * string) * Path.T option) * Token.T list) list -> unit
haftmann@39155
    24
  val produce_code: theory -> string list
haftmann@39159
    25
    -> string -> int option -> string -> Token.T list -> string * string option list
haftmann@39155
    26
  val present_code: theory -> string list -> (Code_Thingol.naming -> string list)
haftmann@39159
    27
    -> string -> int option -> string -> Token.T list -> string
haftmann@39144
    28
  val check_code: theory -> string list
haftmann@39144
    29
    -> ((string * bool) * Token.T list) list -> unit
haftmann@39144
    30
haftmann@28054
    31
  type serializer
haftmann@34141
    32
  type literals = Code_Printer.literals
haftmann@37822
    33
  val add_target: string * { serializer: serializer, literals: literals,
haftmann@37822
    34
    check: { env_var: string, make_destination: Path.T -> Path.T,
haftmann@39092
    35
      make_command: string -> string -> string } } -> theory -> theory
haftmann@28663
    36
  val extend_target: string *
haftmann@28663
    37
      (string * (Code_Thingol.naming -> Code_Thingol.program -> Code_Thingol.program))
haftmann@28054
    38
    -> theory -> theory
haftmann@28054
    39
  val assert_target: theory -> string -> string
haftmann@39144
    40
  val the_literals: theory -> string -> literals
haftmann@28054
    41
  type serialization
wenzelm@36969
    42
  val parse_args: 'a parser -> Token.T list -> 'a
haftmann@39142
    43
  val serialization: (int -> Path.T option -> 'a -> unit)
haftmann@39336
    44
    -> (string list -> int -> 'a -> string * (string -> string option))
haftmann@39151
    45
    -> 'a -> serialization
haftmann@39144
    46
  val set_default_code_width: int -> theory -> theory
haftmann@39143
    47
haftmann@28054
    48
  val allow_abort: string -> theory -> theory
haftmann@34141
    49
  type tyco_syntax = Code_Printer.tyco_syntax
haftmann@37849
    50
  type const_syntax = Code_Printer.const_syntax
haftmann@39149
    51
  val add_class_syntax: string -> class -> string option -> theory -> theory
haftmann@39149
    52
  val add_instance_syntax: string -> class * string -> unit option -> theory -> theory
haftmann@39149
    53
  val add_tyco_syntax: string -> string -> tyco_syntax option -> theory -> theory
haftmann@39149
    54
  val add_const_syntax: string -> string -> const_syntax option -> theory -> theory
haftmann@28054
    55
  val add_reserved: string -> string -> theory -> theory
haftmann@33968
    56
  val add_include: string -> string * (string * string list) option -> theory -> theory
haftmann@39870
    57
haftmann@39983
    58
  val codegen_tool: string (*theory name*) -> string (*export_code expr*) -> unit
haftmann@24219
    59
end;
haftmann@24219
    60
haftmann@28054
    61
structure Code_Target : CODE_TARGET =
haftmann@24219
    62
struct
haftmann@24219
    63
haftmann@28054
    64
open Basic_Code_Thingol;
haftmann@34141
    65
haftmann@34141
    66
type literals = Code_Printer.literals;
haftmann@34141
    67
type tyco_syntax = Code_Printer.tyco_syntax;
haftmann@37849
    68
type const_syntax = Code_Printer.const_syntax;
haftmann@34141
    69
haftmann@24219
    70
haftmann@39149
    71
(** abstract nonsense **)
haftmann@24219
    72
haftmann@39155
    73
datatype destination = Export of Path.T option | Produce | Present of string list;
haftmann@39336
    74
type serialization = int -> destination -> (string * (string -> string option)) option;
haftmann@27014
    75
haftmann@39885
    76
fun serialization output _ content width (Export some_path) =
haftmann@39885
    77
      (output width some_path content; NONE)
haftmann@39885
    78
  | serialization _ string content width Produce =
haftmann@39885
    79
      string [] width content |> SOME
haftmann@39885
    80
  | serialization _ string content width (Present stmt_names) =
haftmann@39885
    81
     string stmt_names width content
haftmann@39885
    82
     |> apfst (Pretty.output (SOME width) o Pretty.str)
haftmann@39885
    83
     |> SOME;
haftmann@24219
    84
haftmann@39885
    85
fun export some_path f = (f (Export some_path); ());
haftmann@39885
    86
fun produce f = the (f Produce);
haftmann@39885
    87
fun present stmt_names f = fst (the (f (Present stmt_names)));
haftmann@39143
    88
haftmann@24219
    89
haftmann@28054
    90
(** theory data **)
haftmann@27000
    91
haftmann@39149
    92
datatype symbol_syntax_data = Symbol_Syntax_Data of {
haftmann@28690
    93
  class: string Symtab.table,
haftmann@30636
    94
  instance: unit Symreltab.table,
haftmann@34141
    95
  tyco: Code_Printer.tyco_syntax Symtab.table,
haftmann@37849
    96
  const: Code_Printer.const_syntax Symtab.table
haftmann@28054
    97
};
haftmann@27000
    98
haftmann@39149
    99
fun make_symbol_syntax_data ((class, instance), (tyco, const)) =
haftmann@39149
   100
  Symbol_Syntax_Data { class = class, instance = instance, tyco = tyco, const = const };
haftmann@39149
   101
fun map_symbol_syntax_data f (Symbol_Syntax_Data { class, instance, tyco, const }) =
haftmann@39149
   102
  make_symbol_syntax_data (f ((class, instance), (tyco, const)));
haftmann@39149
   103
fun merge_symbol_syntax_data
haftmann@39149
   104
  (Symbol_Syntax_Data { class = class1, instance = instance1, tyco = tyco1, const = const1 },
haftmann@39149
   105
    Symbol_Syntax_Data { class = class2, instance = instance2, tyco = tyco2, const = const2 }) =
haftmann@39149
   106
  make_symbol_syntax_data (
haftmann@28054
   107
    (Symtab.join (K snd) (class1, class2),
haftmann@30636
   108
       Symreltab.join (K snd) (instance1, instance2)),
haftmann@28054
   109
    (Symtab.join (K snd) (tyco1, tyco2),
haftmann@28054
   110
       Symtab.join (K snd) (const1, const2))
haftmann@28054
   111
  );
haftmann@27103
   112
haftmann@39381
   113
type serializer = Token.T list
haftmann@39381
   114
  -> {
haftmann@39152
   115
    labelled_name: string -> string,
haftmann@39152
   116
    reserved_syms: string list,
haftmann@39152
   117
    includes: (string * Pretty.T) list,
haftmann@39152
   118
    module_alias: string -> string option,
haftmann@39152
   119
    class_syntax: string -> string option,
haftmann@39152
   120
    tyco_syntax: string -> Code_Printer.tyco_syntax option,
haftmann@39152
   121
    const_syntax: string -> Code_Printer.activated_const_syntax option,
haftmann@39381
   122
    program: Code_Thingol.program }
haftmann@28054
   123
  -> serialization;
haftmann@27103
   124
haftmann@39135
   125
datatype description = Fundamental of { serializer: serializer,
haftmann@39136
   126
      literals: literals,
haftmann@37822
   127
      check: { env_var: string, make_destination: Path.T -> Path.T,
haftmann@39092
   128
        make_command: string -> string -> string } }
haftmann@39135
   129
  | Extension of string *
haftmann@39135
   130
      (Code_Thingol.naming -> Code_Thingol.program -> Code_Thingol.program);
haftmann@27103
   131
haftmann@28054
   132
datatype target = Target of {
haftmann@28054
   133
  serial: serial,
haftmann@37821
   134
  description: description,
haftmann@28054
   135
  reserved: string list,
haftmann@28926
   136
  includes: (Pretty.T * string list) Symtab.table,
haftmann@39151
   137
  module_alias: string Symtab.table,
haftmann@39151
   138
  symbol_syntax: symbol_syntax_data
haftmann@28054
   139
};
haftmann@27103
   140
haftmann@39151
   141
fun make_target ((serial, description), ((reserved, includes), (module_alias, symbol_syntax))) =
haftmann@37821
   142
  Target { serial = serial, description = description, reserved = reserved, 
haftmann@39151
   143
    includes = includes, module_alias = module_alias, symbol_syntax = symbol_syntax };
haftmann@39151
   144
fun map_target f ( Target { serial, description, reserved, includes, module_alias, symbol_syntax } ) =
haftmann@39151
   145
  make_target (f ((serial, description), ((reserved, includes), (module_alias, symbol_syntax))));
haftmann@37821
   146
fun merge_target strict target (Target { serial = serial1, description = description,
haftmann@28054
   147
  reserved = reserved1, includes = includes1,
haftmann@39151
   148
  module_alias = module_alias1, symbol_syntax = symbol_syntax1 },
haftmann@37821
   149
    Target { serial = serial2, description = _,
haftmann@28054
   150
      reserved = reserved2, includes = includes2,
haftmann@39151
   151
      module_alias = module_alias2, symbol_syntax = symbol_syntax2 }) =
haftmann@28054
   152
  if serial1 = serial2 orelse not strict then
haftmann@37821
   153
    make_target ((serial1, description),
haftmann@38209
   154
      ((merge (op =) (reserved1, reserved2), Symtab.join (K snd) (includes1, includes2)),
haftmann@39151
   155
        (Symtab.join (K snd) (module_alias1, module_alias2),
haftmann@39151
   156
          merge_symbol_syntax_data (symbol_syntax1, symbol_syntax2))
haftmann@28054
   157
    ))
haftmann@28054
   158
  else
haftmann@37821
   159
    error ("Incompatible targets: " ^ quote target);
haftmann@27436
   160
haftmann@37821
   161
fun the_description (Target { description, ... }) = description;
haftmann@28054
   162
fun the_reserved (Target { reserved, ... }) = reserved;
haftmann@28054
   163
fun the_includes (Target { includes, ... }) = includes;
haftmann@28054
   164
fun the_module_alias (Target { module_alias , ... }) = module_alias;
haftmann@39151
   165
fun the_symbol_syntax (Target { symbol_syntax = Symbol_Syntax_Data x, ... }) = x;
haftmann@27436
   166
haftmann@34243
   167
structure Targets = Theory_Data
haftmann@34071
   168
(
haftmann@34071
   169
  type T = (target Symtab.table * string list) * int;
haftmann@34071
   170
  val empty = ((Symtab.empty, []), 80);
haftmann@34071
   171
  val extend = I;
haftmann@34071
   172
  fun merge (((target1, exc1), width1), ((target2, exc2), width2)) : T =
haftmann@34071
   173
    ((Symtab.join (merge_target true) (target1, target2),
haftmann@34071
   174
      Library.merge (op =) (exc1, exc2)), Int.max (width1, width2));
haftmann@34071
   175
);
haftmann@28054
   176
haftmann@34243
   177
val abort_allowed = snd o fst o Targets.get;
haftmann@34071
   178
haftmann@34243
   179
fun assert_target thy target = if Symtab.defined ((fst o fst) (Targets.get thy)) target
haftmann@33968
   180
  then target
haftmann@33968
   181
  else error ("Unknown code target language: " ^ quote target);
haftmann@28054
   182
haftmann@28054
   183
fun put_target (target, seri) thy =
haftmann@27437
   184
  let
haftmann@34243
   185
    val lookup_target = Symtab.lookup ((fst o fst) (Targets.get thy));
haftmann@28054
   186
    val _ = case seri
haftmann@37821
   187
     of Extension (super, _) => if is_some (lookup_target super) then ()
haftmann@28054
   188
          else error ("Unknown code target language: " ^ quote super)
haftmann@28054
   189
      | _ => ();
haftmann@37821
   190
    val overwriting = case (Option.map the_description o lookup_target) target
haftmann@28663
   191
     of NONE => false
haftmann@37821
   192
      | SOME (Extension _) => true
haftmann@37821
   193
      | SOME (Fundamental _) => (case seri
haftmann@37821
   194
         of Extension _ => error ("Will not overwrite existing target " ^ quote target)
haftmann@28663
   195
          | _ => true);
haftmann@28663
   196
    val _ = if overwriting
haftmann@28054
   197
      then warning ("Overwriting existing target " ^ quote target)
haftmann@28663
   198
      else (); 
haftmann@27103
   199
  in
haftmann@28054
   200
    thy
haftmann@34243
   201
    |> (Targets.map o apfst o apfst o Symtab.update)
haftmann@31599
   202
          (target, make_target ((serial (), seri), (([], Symtab.empty),
haftmann@39151
   203
            (Symtab.empty, make_symbol_syntax_data ((Symtab.empty, Symreltab.empty),
haftmann@39151
   204
              (Symtab.empty, Symtab.empty))))))
haftmann@27103
   205
  end;
haftmann@27000
   206
haftmann@37821
   207
fun add_target (target, seri) = put_target (target, Fundamental seri);
haftmann@28054
   208
fun extend_target (target, (super, modify)) =
haftmann@37821
   209
  put_target (target, Extension (super, modify));
haftmann@27000
   210
haftmann@28054
   211
fun map_target_data target f thy =
haftmann@27304
   212
  let
haftmann@28054
   213
    val _ = assert_target thy target;
haftmann@27000
   214
  in
haftmann@28054
   215
    thy
haftmann@34243
   216
    |> (Targets.map o apfst o apfst o Symtab.map_entry target o map_target) f
haftmann@27000
   217
  end;
haftmann@27000
   218
haftmann@28054
   219
fun map_reserved target =
haftmann@28054
   220
  map_target_data target o apsnd o apfst o apfst;
haftmann@28054
   221
fun map_includes target =
haftmann@28054
   222
  map_target_data target o apsnd o apfst o apsnd;
haftmann@28054
   223
fun map_module_alias target =
haftmann@39151
   224
  map_target_data target o apsnd o apsnd o apfst;
haftmann@39151
   225
fun map_symbol_syntax target =
haftmann@39151
   226
  map_target_data target o apsnd o apsnd o apsnd o map_symbol_syntax_data;
haftmann@27000
   227
haftmann@34243
   228
fun set_default_code_width k = (Targets.map o apsnd) (K k);
haftmann@34071
   229
haftmann@27000
   230
haftmann@34021
   231
(** serializer usage **)
haftmann@34021
   232
haftmann@34021
   233
(* montage *)
haftmann@34021
   234
haftmann@37822
   235
fun the_fundamental thy =
haftmann@34021
   236
  let
haftmann@34243
   237
    val ((targets, _), _) = Targets.get thy;
haftmann@37822
   238
    fun fundamental target = case Symtab.lookup targets target
haftmann@37821
   239
     of SOME data => (case the_description data
haftmann@37822
   240
         of Fundamental data => data
haftmann@37822
   241
          | Extension (super, _) => fundamental super)
haftmann@34021
   242
      | NONE => error ("Unknown code target language: " ^ quote target);
haftmann@37822
   243
  in fundamental end;
haftmann@37822
   244
haftmann@37822
   245
fun the_literals thy = #literals o the_fundamental thy;
haftmann@34021
   246
haftmann@34021
   247
local
haftmann@34021
   248
haftmann@39724
   249
fun activate_target thy target =
haftmann@39153
   250
  let
haftmann@39153
   251
    val ((targets, abortable), default_width) = Targets.get thy;
haftmann@39153
   252
    fun collapse_hierarchy target =
haftmann@39153
   253
      let
haftmann@39153
   254
        val data = case Symtab.lookup targets target
haftmann@39153
   255
         of SOME data => data
haftmann@39153
   256
          | NONE => error ("Unknown code target language: " ^ quote target);
haftmann@39153
   257
      in case the_description data
haftmann@39724
   258
       of Fundamental _ => (K I, data)
haftmann@39153
   259
        | Extension (super, modify) => let
haftmann@39153
   260
            val (modify', data') = collapse_hierarchy super
haftmann@39724
   261
          in (fn naming => modify' naming #> modify naming, merge_target false target (data', data)) end
haftmann@39153
   262
      end;
haftmann@39153
   263
    val (modify, data) = collapse_hierarchy target;
haftmann@39724
   264
  in (default_width, abortable, data, modify) end;
haftmann@39153
   265
haftmann@34021
   266
fun activate_syntax lookup_name src_tab = Symtab.empty
haftmann@34021
   267
  |> fold_map (fn thing_identifier => fn tab => case lookup_name thing_identifier
haftmann@34021
   268
       of SOME name => (SOME name,
haftmann@34021
   269
            Symtab.update_new (name, the (Symtab.lookup src_tab thing_identifier)) tab)
haftmann@34021
   270
        | NONE => (NONE, tab)) (Symtab.keys src_tab)
haftmann@34021
   271
  |>> map_filter I;
haftmann@34021
   272
haftmann@34021
   273
fun activate_const_syntax thy literals src_tab naming = (Symtab.empty, naming)
haftmann@37854
   274
  |> fold_map (fn c => fn (tab, naming) =>
haftmann@37854
   275
      case Code_Thingol.lookup_const naming c
haftmann@34021
   276
       of SOME name => let
haftmann@34021
   277
              val (syn, naming') = Code_Printer.activate_const_syntax thy
haftmann@37854
   278
                literals c (the (Symtab.lookup src_tab c)) naming
haftmann@34021
   279
            in (SOME name, (Symtab.update_new (name, syn) tab, naming')) end
haftmann@34021
   280
        | NONE => (NONE, (tab, naming))) (Symtab.keys src_tab)
haftmann@34021
   281
  |>> map_filter I;
haftmann@34021
   282
haftmann@39153
   283
fun activate_symbol_syntax thy literals naming
haftmann@39153
   284
    class_syntax instance_syntax tyco_syntax const_syntax =
haftmann@34021
   285
  let
haftmann@39153
   286
    val (names_class, class_syntax') =
haftmann@39153
   287
      activate_syntax (Code_Thingol.lookup_class naming) class_syntax;
haftmann@34021
   288
    val names_inst = map_filter (Code_Thingol.lookup_instance naming)
haftmann@39153
   289
      (Symreltab.keys instance_syntax);
haftmann@39153
   290
    val (names_tyco, tyco_syntax') =
haftmann@39153
   291
      activate_syntax (Code_Thingol.lookup_tyco naming) tyco_syntax;
haftmann@39153
   292
    val (names_const, (const_syntax', _)) =
haftmann@39153
   293
      activate_const_syntax thy literals const_syntax naming;
haftmann@39153
   294
  in
haftmann@39153
   295
    (names_class @ names_inst @ names_tyco @ names_const,
haftmann@39153
   296
      (class_syntax', tyco_syntax', const_syntax'))
haftmann@39153
   297
  end;
haftmann@39153
   298
haftmann@39153
   299
fun project_program thy abortable names_hidden names1 program2 =
haftmann@39153
   300
  let
haftmann@34021
   301
    val names2 = subtract (op =) names_hidden names1;
haftmann@34021
   302
    val program3 = Graph.subgraph (not o member (op =) names_hidden) program2;
haftmann@39162
   303
    val names4 = Graph.all_succs program3 names2;
haftmann@34021
   304
    val empty_funs = filter_out (member (op =) abortable)
haftmann@34021
   305
      (Code_Thingol.empty_funs program3);
haftmann@34021
   306
    val _ = if null empty_funs then () else error ("No code equations for "
haftmann@34021
   307
      ^ commas (map (Sign.extern_const thy) empty_funs));
haftmann@39162
   308
    val program4 = Graph.subgraph (member (op =) names4) program3;
haftmann@39162
   309
  in (names4, program4) end;
haftmann@39153
   310
haftmann@39724
   311
fun invoke_serializer thy abortable serializer literals reserved all_includes
haftmann@39153
   312
    module_alias proto_class_syntax proto_instance_syntax proto_tyco_syntax proto_const_syntax
haftmann@39292
   313
    module_name args naming proto_program names =
haftmann@39153
   314
  let
haftmann@39153
   315
    val (names_hidden, (class_syntax, tyco_syntax, const_syntax)) =
haftmann@39153
   316
      activate_symbol_syntax thy literals naming
haftmann@39153
   317
        proto_class_syntax proto_instance_syntax proto_tyco_syntax proto_const_syntax;
haftmann@39153
   318
    val (names_all, program) = project_program thy abortable names_hidden names proto_program;
haftmann@39724
   319
    fun select_include (name, (content, cs)) =
haftmann@39724
   320
      if null cs orelse exists (fn c => case Code_Thingol.lookup_const naming c
haftmann@39724
   321
       of SOME name => member (op =) names_all name
haftmann@39724
   322
        | NONE => false) cs
haftmann@39724
   323
      then SOME (name, content) else NONE;
haftmann@39724
   324
    val includes = map_filter select_include (Symtab.dest all_includes);
haftmann@34021
   325
  in
haftmann@39152
   326
    serializer args {
haftmann@39153
   327
      labelled_name = Code_Thingol.labelled_name thy proto_program,
haftmann@39152
   328
      reserved_syms = reserved,
haftmann@39152
   329
      includes = includes,
haftmann@39159
   330
      module_alias = if module_name = "" then Symtab.lookup module_alias else K (SOME module_name),
haftmann@39153
   331
      class_syntax = Symtab.lookup class_syntax,
haftmann@39153
   332
      tyco_syntax = Symtab.lookup tyco_syntax,
haftmann@39153
   333
      const_syntax = Symtab.lookup const_syntax,
haftmann@39381
   334
      program = program }
haftmann@34021
   335
  end;
haftmann@34021
   336
haftmann@39724
   337
fun mount_serializer thy target some_width module_name args =
haftmann@34021
   338
  let
haftmann@39724
   339
    val (default_width, abortable, data, modify) = activate_target thy target;
haftmann@39147
   340
    val serializer = case the_description data
haftmann@39153
   341
     of Fundamental seri => #serializer seri;
haftmann@34021
   342
    val reserved = the_reserved data;
haftmann@39012
   343
    val module_alias = the_module_alias data 
haftmann@39151
   344
    val { class, instance, tyco, const } = the_symbol_syntax data;
haftmann@34021
   345
    val literals = the_literals thy target;
haftmann@34071
   346
    val width = the_default default_width some_width;
haftmann@39724
   347
  in fn naming => fn program => fn names =>
haftmann@34021
   348
    invoke_serializer thy abortable serializer literals reserved
haftmann@39724
   349
      (the_includes data) module_alias class instance tyco const module_name args
haftmann@39724
   350
        naming (modify naming program) names width
haftmann@34021
   351
  end;
haftmann@34021
   352
haftmann@39159
   353
fun assert_module_name "" = error ("Empty module name not allowed.")
haftmann@39159
   354
  | assert_module_name module_name = module_name;
haftmann@39159
   355
haftmann@34021
   356
in
haftmann@34021
   357
haftmann@39724
   358
fun export_code_for thy some_path target some_width module_name args =
haftmann@39885
   359
  export some_path ooo mount_serializer thy target some_width module_name args;
haftmann@39144
   360
haftmann@39724
   361
fun produce_code_for thy target some_width module_name args =
haftmann@39336
   362
  let
haftmann@39724
   363
    val serializer = mount_serializer thy target some_width (assert_module_name module_name) args;
haftmann@39724
   364
  in fn naming => fn program => fn names =>
haftmann@39885
   365
    produce (serializer naming program names) |> apsnd (fn deresolve => map deresolve names)
haftmann@39724
   366
  end;
haftmann@39155
   367
haftmann@39724
   368
fun present_code_for thy target some_width module_name args =
haftmann@39724
   369
  let
haftmann@39724
   370
    val serializer = mount_serializer thy target some_width (assert_module_name module_name) args;
haftmann@39724
   371
  in fn naming => fn program => fn (names, selects) =>
haftmann@39885
   372
    present selects (serializer naming program names)
haftmann@39724
   373
  end;
haftmann@39144
   374
haftmann@39144
   375
fun check_code_for thy target strict args naming program names_cs =
haftmann@37824
   376
  let
haftmann@39159
   377
    val module_name = "Code";
haftmann@37824
   378
    val { env_var, make_destination, make_command } =
haftmann@37824
   379
      (#check o the_fundamental thy) target;
haftmann@37824
   380
    val env_param = getenv env_var;
haftmann@37824
   381
    fun ext_check env_param p =
haftmann@37824
   382
      let 
haftmann@37824
   383
        val destination = make_destination p;
haftmann@39155
   384
        val _ = export (SOME destination) (mount_serializer thy target (SOME 80)
haftmann@39885
   385
          module_name args naming program names_cs);
haftmann@39092
   386
        val cmd = make_command env_param module_name;
haftmann@37824
   387
      in if bash ("cd " ^ File.shell_path p ^ " && " ^ cmd ^ " 2>&1") <> 0
haftmann@37824
   388
        then error ("Code check failed for " ^ target ^ ": " ^ cmd)
haftmann@37824
   389
        else ()
haftmann@37824
   390
      end;
haftmann@37824
   391
  in if env_param = ""
haftmann@37825
   392
    then if strict
haftmann@37825
   393
      then error (env_var ^ " not set; cannot check code for " ^ target)
haftmann@37825
   394
      else warning (env_var ^ " not set; skipped checking code for " ^ target)
haftmann@37824
   395
    else Cache_IO.with_tmp_dir "Code_Test" (ext_check env_param)
haftmann@37824
   396
  end;
haftmann@37824
   397
haftmann@34021
   398
end; (* local *)
haftmann@34021
   399
haftmann@34021
   400
haftmann@34021
   401
(* code generation *)
haftmann@34021
   402
haftmann@34021
   403
fun transitivly_non_empty_funs thy naming program =
haftmann@34021
   404
  let
haftmann@34021
   405
    val cs = subtract (op =) (abort_allowed thy) (Code_Thingol.empty_funs program);
haftmann@34021
   406
    val names = map_filter (Code_Thingol.lookup_const naming) cs;
haftmann@34021
   407
  in subtract (op =) (Graph.all_preds program names) (Graph.keys program) end;
haftmann@34021
   408
haftmann@34021
   409
fun read_const_exprs thy cs =
haftmann@34021
   410
  let
haftmann@34021
   411
    val (cs1, cs2) = Code_Thingol.read_const_exprs thy cs;
haftmann@36271
   412
    val (names2, (naming, program)) = Code_Thingol.consts_program thy true cs2;
haftmann@36271
   413
    val names3 = transitivly_non_empty_funs thy naming program;
haftmann@36271
   414
    val cs3 = map_filter (fn (c, name) =>
haftmann@36271
   415
      if member (op =) names3 name then SOME c else NONE) (cs2 ~~ names2);
haftmann@36271
   416
  in union (op =) cs3 cs1 end;
haftmann@34021
   417
haftmann@39144
   418
fun prep_destination "" = NONE
haftmann@39144
   419
  | prep_destination "-" = NONE
haftmann@39144
   420
  | prep_destination s = SOME (Path.explode s);
haftmann@39144
   421
haftmann@34021
   422
fun export_code thy cs seris =
haftmann@34021
   423
  let
haftmann@37824
   424
    val (names_cs, (naming, program)) = Code_Thingol.consts_program thy false cs;
haftmann@39144
   425
    val _ = map (fn (((target, module_name), some_path), args) =>
haftmann@39144
   426
      export_code_for thy some_path target NONE module_name args naming program names_cs) seris;
haftmann@34021
   427
  in () end;
haftmann@34021
   428
haftmann@39144
   429
fun export_code_cmd raw_cs seris thy = export_code thy (read_const_exprs thy raw_cs)
haftmann@39144
   430
  ((map o apfst o apsnd) prep_destination seris);
haftmann@39144
   431
haftmann@39155
   432
fun produce_code thy cs target some_width some_module_name args =
haftmann@39144
   433
  let
haftmann@39144
   434
    val (names_cs, (naming, program)) = Code_Thingol.consts_program thy false cs;
haftmann@39155
   435
  in produce_code_for thy target some_width some_module_name args naming program names_cs end;
haftmann@39155
   436
haftmann@39155
   437
fun present_code thy cs names_stmt target some_width some_module_name args =
haftmann@39155
   438
  let
haftmann@39155
   439
    val (names_cs, (naming, program)) = Code_Thingol.consts_program thy false cs;
haftmann@39155
   440
  in present_code_for thy target some_width some_module_name args naming program (names_cs, names_stmt naming) end;
haftmann@34021
   441
haftmann@37824
   442
fun check_code thy cs seris =
haftmann@37824
   443
  let
haftmann@37824
   444
    val (names_cs, (naming, program)) = Code_Thingol.consts_program thy false cs;
haftmann@39144
   445
    val _ = map (fn ((target, strict), args) =>
haftmann@39144
   446
      check_code_for thy target strict args naming program names_cs) seris;
haftmann@37824
   447
  in () end;
haftmann@37824
   448
haftmann@37824
   449
fun check_code_cmd raw_cs seris thy = check_code thy (read_const_exprs thy raw_cs) seris;
haftmann@37824
   450
haftmann@39720
   451
local
haftmann@39720
   452
haftmann@39720
   453
val parse_const_terms = Scan.repeat1 Args.term
haftmann@39720
   454
  >> (fn ts => fn thy => map (Code.check_const thy) ts);
haftmann@39720
   455
haftmann@39720
   456
fun parse_names category parse internalize lookup =
haftmann@39720
   457
  Scan.lift (Args.parens (Args.$$$ category)) |-- Scan.repeat1 parse
haftmann@39720
   458
  >> (fn xs => fn thy => fn naming => map_filter (lookup naming o internalize thy) xs);
haftmann@39720
   459
  
haftmann@39720
   460
val parse_consts = parse_names "consts" Args.term
haftmann@39720
   461
  Code.check_const Code_Thingol.lookup_const ;
haftmann@39720
   462
haftmann@39720
   463
val parse_types = parse_names "types" (Scan.lift Args.name)
haftmann@39720
   464
  Sign.intern_type Code_Thingol.lookup_tyco;
haftmann@39720
   465
haftmann@39720
   466
val parse_classes = parse_names "classes" (Scan.lift Args.name)
haftmann@39720
   467
  Sign.intern_class Code_Thingol.lookup_class;
haftmann@39720
   468
haftmann@39720
   469
val parse_instances = parse_names "instances" (Scan.lift (Args.name --| Args.$$$ "::" -- Args.name))
haftmann@39720
   470
  (fn thy => fn (raw_tyco, raw_class) => (Sign.intern_class thy raw_class, Sign.intern_type thy raw_tyco))
haftmann@39720
   471
    Code_Thingol.lookup_instance;
haftmann@39720
   472
haftmann@39720
   473
in
haftmann@39720
   474
haftmann@39720
   475
val _ = Thy_Output.antiquotation "code_stmts"
haftmann@39720
   476
  (parse_const_terms -- Scan.repeat (parse_consts || parse_types || parse_classes || parse_instances)
haftmann@39720
   477
    -- Scan.lift (Args.parens (Args.name -- Scan.option Parse.int)))
haftmann@39720
   478
  (fn {context = ctxt, ...} => fn ((mk_cs, mk_stmtss), (target, some_width)) =>
haftmann@39720
   479
    let val thy = ProofContext.theory_of ctxt in
haftmann@39720
   480
      present_code thy (mk_cs thy)
haftmann@39720
   481
        (fn naming => maps (fn f => f thy naming) mk_stmtss)
haftmann@39720
   482
        target some_width "Example" []
haftmann@39720
   483
    end);
haftmann@39720
   484
haftmann@39720
   485
end;
haftmann@39720
   486
haftmann@34021
   487
haftmann@28054
   488
(** serializer configuration **)
haftmann@28054
   489
haftmann@27000
   490
(* data access *)
haftmann@24219
   491
haftmann@24992
   492
fun cert_class thy class =
haftmann@24992
   493
  let
haftmann@24992
   494
    val _ = AxClass.get_info thy class;
haftmann@24992
   495
  in class end;
haftmann@24992
   496
haftmann@27103
   497
fun read_class thy = cert_class thy o Sign.intern_class thy;
haftmann@24992
   498
haftmann@24992
   499
fun cert_tyco thy tyco =
haftmann@24992
   500
  let
haftmann@24992
   501
    val _ = if Sign.declared_tyname thy tyco then ()
haftmann@24992
   502
      else error ("No such type constructor: " ^ quote tyco);
haftmann@24992
   503
  in tyco end;
haftmann@24992
   504
haftmann@27103
   505
fun read_tyco thy = cert_tyco thy o Sign.intern_type thy;
haftmann@24219
   506
haftmann@34071
   507
fun cert_inst thy (class, tyco) =
haftmann@34071
   508
  (cert_class thy class, cert_tyco thy tyco);
haftmann@34071
   509
haftmann@34071
   510
fun read_inst thy (raw_tyco, raw_class) =
haftmann@34071
   511
  (read_class thy raw_class, read_tyco thy raw_tyco);
haftmann@34071
   512
haftmann@37844
   513
fun gen_add_syntax (mapp, upd, del) prep_x prep_syn target raw_x some_raw_syn thy =
haftmann@24219
   514
  let
haftmann@37840
   515
    val x = prep_x thy raw_x;
haftmann@37844
   516
    val change = case some_raw_syn
haftmann@37844
   517
     of SOME raw_syn => upd (x, prep_syn thy x raw_syn)
haftmann@37844
   518
      | NONE => del x;
haftmann@39151
   519
  in (map_symbol_syntax target o mapp) change thy end;
haftmann@24219
   520
haftmann@39149
   521
fun gen_add_class_syntax prep_class =
haftmann@37844
   522
  gen_add_syntax (apfst o apfst, Symtab.update, Symtab.delete_safe) prep_class ((K o K) I);
haftmann@24219
   523
haftmann@39149
   524
fun gen_add_instance_syntax prep_inst =
haftmann@37844
   525
  gen_add_syntax (apfst o apsnd, Symreltab.update, Symreltab.delete_safe) prep_inst ((K o K) I);
haftmann@34071
   526
haftmann@39149
   527
fun gen_add_tyco_syntax prep_tyco =
haftmann@37844
   528
  gen_add_syntax (apsnd o apfst, Symtab.update, Symtab.delete_safe) prep_tyco
haftmann@37844
   529
    (fn thy => fn tyco => fn syn => if fst syn <> Sign.arity_number thy tyco
haftmann@24219
   530
      then error ("Number of arguments mismatch in syntax for type constructor " ^ quote tyco)
haftmann@37844
   531
      else syn);
haftmann@24219
   532
haftmann@39149
   533
fun gen_add_const_syntax prep_const =
haftmann@37844
   534
  gen_add_syntax (apsnd o apsnd, Symtab.update, Symtab.delete_safe) prep_const
haftmann@37854
   535
    (fn thy => fn c => fn syn =>
haftmann@37854
   536
      if Code_Printer.requires_args syn > Code.args_number thy c
haftmann@24423
   537
      then error ("Too many arguments in syntax for constant " ^ quote c)
haftmann@37854
   538
      else syn);
haftmann@24219
   539
haftmann@24219
   540
fun add_reserved target =
haftmann@24219
   541
  let
haftmann@24219
   542
    fun add sym syms = if member (op =) syms sym
haftmann@24219
   543
      then error ("Reserved symbol " ^ quote sym ^ " already declared")
haftmann@24219
   544
      else insert (op =) sym syms
haftmann@27103
   545
  in map_reserved target o add end;
haftmann@24992
   546
haftmann@28926
   547
fun gen_add_include read_const target args thy =
haftmann@24992
   548
  let
haftmann@28926
   549
    fun add (name, SOME (content, raw_cs)) incls =
haftmann@24992
   550
          let
haftmann@24992
   551
            val _ = if Symtab.defined incls name
haftmann@24992
   552
              then warning ("Overwriting existing include " ^ name)
haftmann@24992
   553
              else ();
haftmann@28926
   554
            val cs = map (read_const thy) raw_cs;
haftmann@34141
   555
          in Symtab.update (name, (Code_Printer.str content, cs)) incls end
haftmann@28926
   556
      | add (name, NONE) incls = Symtab.delete name incls;
haftmann@28926
   557
  in map_includes target (add args) thy end;
haftmann@28926
   558
haftmann@33968
   559
val add_include = gen_add_include (K I);
haftmann@31156
   560
val add_include_cmd = gen_add_include Code.read_const;
haftmann@24219
   561
haftmann@39159
   562
fun add_module_alias target (thyname, "") =
haftmann@39159
   563
      map_module_alias target (Symtab.delete thyname)
haftmann@39159
   564
  | add_module_alias target (thyname, modlname) =
haftmann@39159
   565
      let
haftmann@39159
   566
        val xs = Long_Name.explode modlname;
haftmann@39159
   567
        val xs' = map (Name.desymbolize true) xs;
haftmann@39159
   568
      in if xs' = xs
haftmann@39159
   569
        then map_module_alias target (Symtab.update (thyname, modlname))
haftmann@39159
   570
        else error ("Invalid module name: " ^ quote modlname ^ "\n"
haftmann@39159
   571
          ^ "perhaps try " ^ quote (Long_Name.implode xs'))
haftmann@39159
   572
      end;
haftmann@24219
   573
haftmann@28663
   574
fun gen_allow_abort prep_const raw_c thy =
haftmann@24841
   575
  let
haftmann@28663
   576
    val c = prep_const thy raw_c;
haftmann@34243
   577
  in thy |> (Targets.map o apfst o apsnd) (insert (op =) c) end;
haftmann@24841
   578
haftmann@27000
   579
haftmann@27103
   580
(* concrete syntax *)
haftmann@27000
   581
haftmann@34021
   582
local
haftmann@34021
   583
haftmann@34141
   584
fun zip_list (x::xs) f g =
haftmann@34141
   585
  f
haftmann@37854
   586
  :|-- (fn y =>
haftmann@34141
   587
    fold_map (fn x => g |-- f >> pair x) xs
haftmann@37854
   588
    :|-- (fn xys => pair ((x, y) :: xys)));
haftmann@34141
   589
haftmann@37854
   590
fun process_multi_syntax parse_thing parse_syntax change =
haftmann@37854
   591
  (Parse.and_list1 parse_thing
haftmann@37854
   592
  :|-- (fn things => Scan.repeat1 (Parse.$$$ "(" |-- Parse.name --
haftmann@37854
   593
        (zip_list things parse_syntax (Parse.$$$ "and")) --| Parse.$$$ ")")))
haftmann@37854
   594
  >> (Toplevel.theory oo fold)
haftmann@37854
   595
    (fn (target, syns) => fold (fn (raw_x, syn) => change target raw_x syn) syns);
haftmann@24219
   596
haftmann@24219
   597
in
haftmann@24219
   598
haftmann@39149
   599
val add_class_syntax = gen_add_class_syntax cert_class;
haftmann@39149
   600
val add_instance_syntax = gen_add_instance_syntax cert_inst;
haftmann@39149
   601
val add_tyco_syntax = gen_add_tyco_syntax cert_tyco;
haftmann@39149
   602
val add_const_syntax = gen_add_const_syntax (K I);
haftmann@27103
   603
val allow_abort = gen_allow_abort (K I);
haftmann@28054
   604
val add_reserved = add_reserved;
haftmann@33968
   605
val add_include = add_include;
haftmann@24219
   606
haftmann@39149
   607
val add_class_syntax_cmd = gen_add_class_syntax read_class;
haftmann@39149
   608
val add_instance_syntax_cmd = gen_add_instance_syntax read_inst;
haftmann@39149
   609
val add_tyco_syntax_cmd = gen_add_tyco_syntax read_tyco;
haftmann@39149
   610
val add_const_syntax_cmd = gen_add_const_syntax Code.read_const;
haftmann@31156
   611
val allow_abort_cmd = gen_allow_abort Code.read_const;
haftmann@24219
   612
haftmann@28054
   613
fun parse_args f args =
wenzelm@36969
   614
  case Scan.read Token.stopper f args
haftmann@28054
   615
   of SOME x => x
haftmann@28054
   616
    | NONE => error "Bad serializer arguments";
haftmann@28054
   617
haftmann@28054
   618
haftmann@27304
   619
(** Isar setup **)
haftmann@27103
   620
haftmann@37824
   621
val (inK, module_nameK, fileK, checkingK) = ("in", "module_name", "file", "checking");
haftmann@37824
   622
haftmann@37824
   623
val code_expr_argsP = Scan.optional (Parse.$$$ "(" |-- Args.parse --| Parse.$$$ ")") [];
haftmann@27103
   624
haftmann@30492
   625
val code_exprP =
haftmann@37824
   626
  Scan.repeat1 Parse.term_group :|-- (fn raw_cs =>
haftmann@37825
   627
    ((Parse.$$$ checkingK |-- Scan.repeat (Parse.name
haftmann@37825
   628
      -- ((Parse.$$$ "?" |-- Scan.succeed false) || Scan.succeed true) -- code_expr_argsP))
haftmann@37824
   629
      >> (fn seris => check_code_cmd raw_cs seris)
haftmann@37824
   630
    || Scan.repeat (Parse.$$$ inK |-- Parse.name
haftmann@39159
   631
       -- Scan.optional (Parse.$$$ module_nameK |-- Parse.name) ""
haftmann@37824
   632
       -- Scan.optional (Parse.$$$ fileK |-- Parse.name) ""
haftmann@37824
   633
       -- code_expr_argsP) >> (fn seris => export_code_cmd raw_cs seris)));
haftmann@27103
   634
haftmann@37824
   635
val _ = List.app Keyword.keyword [inK, module_nameK, fileK, checkingK];
wenzelm@24867
   636
wenzelm@24867
   637
val _ =
wenzelm@36970
   638
  Outer_Syntax.command "code_class" "define code syntax for class" Keyword.thy_decl (
haftmann@37854
   639
    process_multi_syntax Parse.xname (Scan.option Parse.string)
haftmann@39149
   640
    add_class_syntax_cmd);
haftmann@24219
   641
wenzelm@24867
   642
val _ =
wenzelm@36970
   643
  Outer_Syntax.command "code_instance" "define code syntax for instance" Keyword.thy_decl (
haftmann@37854
   644
    process_multi_syntax (Parse.xname --| Parse.$$$ "::" -- Parse.xname)
wenzelm@36970
   645
      (Scan.option (Parse.minus >> K ()))
haftmann@39149
   646
    add_instance_syntax_cmd);
haftmann@24219
   647
wenzelm@24867
   648
val _ =
wenzelm@36970
   649
  Outer_Syntax.command "code_type" "define code syntax for type constructor" Keyword.thy_decl (
haftmann@37854
   650
    process_multi_syntax Parse.xname Code_Printer.parse_tyco_syntax
haftmann@39149
   651
    add_tyco_syntax_cmd);
haftmann@24219
   652
wenzelm@24867
   653
val _ =
wenzelm@36970
   654
  Outer_Syntax.command "code_const" "define code syntax for constant" Keyword.thy_decl (
haftmann@37854
   655
    process_multi_syntax Parse.term_group Code_Printer.parse_const_syntax
haftmann@39149
   656
    add_const_syntax_cmd);
haftmann@24219
   657
wenzelm@24867
   658
val _ =
wenzelm@36970
   659
  Outer_Syntax.command "code_reserved" "declare words as reserved for target language"
wenzelm@36970
   660
    Keyword.thy_decl (
wenzelm@36970
   661
    Parse.name -- Scan.repeat1 Parse.name
haftmann@24219
   662
    >> (fn (target, reserveds) => (Toplevel.theory o fold (add_reserved target)) reserveds)
haftmann@24841
   663
  );
haftmann@24219
   664
wenzelm@24867
   665
val _ =
wenzelm@36970
   666
  Outer_Syntax.command "code_include" "declare piece of code to be included in generated code"
wenzelm@36970
   667
    Keyword.thy_decl (
wenzelm@36970
   668
    Parse.name -- Parse.name -- (Parse.text :|-- (fn "-" => Scan.succeed NONE
wenzelm@36970
   669
      | s => Scan.optional (Parse.$$$ "attach" |-- Scan.repeat1 Parse.term) [] >> pair s >> SOME))
haftmann@28926
   670
    >> (fn ((target, name), content_consts) =>
haftmann@28926
   671
        (Toplevel.theory o add_include_cmd target) (name, content_consts))
haftmann@24992
   672
  );
haftmann@24992
   673
haftmann@24992
   674
val _ =
wenzelm@36970
   675
  Outer_Syntax.command "code_modulename" "alias module to other name" Keyword.thy_decl (
wenzelm@36970
   676
    Parse.name -- Scan.repeat1 (Parse.name -- Parse.name)
haftmann@27103
   677
    >> (fn (target, modlnames) => (Toplevel.theory o fold (add_module_alias target)) modlnames)
haftmann@24841
   678
  );
haftmann@24219
   679
wenzelm@24867
   680
val _ =
wenzelm@36970
   681
  Outer_Syntax.command "code_abort" "permit constant to be implemented as program abort"
wenzelm@36970
   682
    Keyword.thy_decl (
wenzelm@36970
   683
    Scan.repeat1 Parse.term_group >> (Toplevel.theory o fold allow_abort_cmd)
haftmann@24841
   684
  );
haftmann@24219
   685
haftmann@27103
   686
val _ =
wenzelm@36970
   687
  Outer_Syntax.command "export_code" "generate executable code for constants"
wenzelm@36970
   688
    Keyword.diag (Parse.!!! code_exprP >> (fn f => Toplevel.keep (f o Toplevel.theory_of)));
haftmann@30492
   689
haftmann@24219
   690
end; (*local*)
haftmann@24219
   691
haftmann@39870
   692
haftmann@39870
   693
(** external entrance point -- for codegen tool **)
haftmann@39870
   694
haftmann@39983
   695
fun codegen_tool thyname cmd_expr =
haftmann@39870
   696
  let
haftmann@39870
   697
    val thy = Thy_Info.get_theory thyname;
haftmann@39870
   698
    val parse = Scan.read Token.stopper (Parse.!!! code_exprP) o
haftmann@39870
   699
      (filter Token.is_proper o Outer_Syntax.scan Position.none);
haftmann@39870
   700
  in case parse cmd_expr
haftmann@39870
   701
   of SOME f => (writeln "Now generating code..."; f thy)
haftmann@39870
   702
    | NONE => error ("Bad directive " ^ quote cmd_expr)
haftmann@39870
   703
  end;
haftmann@39870
   704
haftmann@24219
   705
end; (*struct*)