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