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