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