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