src/Tools/Code/code_target.ML
author haftmann
Thu Dec 04 16:51:54 2014 +0100 (2014-12-04)
changeset 59101 6dc48c98303c
parent 59100 ad09649f6f50
child 59102 2c0005cc623f
permissions -rw-r--r--
tuned target inheritance bookkeeping: ancestry is always fully maintained at current entry using canonical merge;
n. b. merging of bidirectional dependencies results in effective join of involved nodes: no termination problem since ancestry is always kept explicitly normalized
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@55757
     9
  val cert_tyco: Proof.context -> string -> string
haftmann@55757
    10
  val read_tyco: Proof.context -> string -> string
haftmann@36471
    11
haftmann@55757
    12
  val export_code_for: Proof.context -> Path.T option -> string -> int option -> string -> Token.T list
haftmann@55683
    13
    -> Code_Thingol.program -> bool -> Code_Symbol.T list -> unit
haftmann@55757
    14
  val produce_code_for: Proof.context -> string -> int option -> string -> Token.T list
haftmann@55683
    15
    -> Code_Thingol.program -> bool -> Code_Symbol.T list -> (string * string) list * string option list
haftmann@55757
    16
  val present_code_for: Proof.context -> string -> int option -> string -> Token.T list
haftmann@55150
    17
    -> Code_Thingol.program -> Code_Symbol.T list * Code_Symbol.T list -> string
haftmann@55757
    18
  val check_code_for: Proof.context -> string -> bool -> Token.T list
haftmann@55683
    19
    -> Code_Thingol.program -> bool -> Code_Symbol.T list -> unit
haftmann@38918
    20
haftmann@55757
    21
  val export_code: Proof.context -> bool -> string list
haftmann@38933
    22
    -> (((string * string) * Path.T option) * Token.T list) list -> unit
haftmann@55757
    23
  val produce_code: Proof.context -> bool -> string list
haftmann@48568
    24
    -> string -> int option -> string -> Token.T list -> (string * string) list * string option list
haftmann@55757
    25
  val present_code: Proof.context -> string list -> Code_Symbol.T list
haftmann@38933
    26
    -> string -> int option -> string -> Token.T list -> string
haftmann@55757
    27
  val check_code: Proof.context -> bool -> string list
haftmann@38918
    28
    -> ((string * bool) * Token.T list) list -> unit
haftmann@38918
    29
haftmann@48568
    30
  val generatedN: string
haftmann@55757
    31
  val evaluator: Proof.context -> string -> Code_Thingol.program
haftmann@55684
    32
    -> Code_Symbol.T list -> bool -> ((string * class list) list * Code_Thingol.itype) * Code_Thingol.iterm
haftmann@48568
    33
    -> (string * string) list * string
haftmann@41344
    34
haftmann@28054
    35
  type serializer
haftmann@34152
    36
  type literals = Code_Printer.literals
haftmann@37822
    37
  val add_target: string * { serializer: serializer, literals: literals,
wenzelm@41940
    38
    check: { env_var: string, make_destination: Path.T -> Path.T, make_command: string -> string } }
wenzelm@41940
    39
    -> theory -> theory
haftmann@28663
    40
  val extend_target: string *
haftmann@55147
    41
      (string * (Code_Thingol.program -> Code_Thingol.program))
haftmann@28054
    42
    -> theory -> theory
haftmann@55757
    43
  val assert_target: Proof.context -> string -> string
haftmann@55757
    44
  val the_literals: Proof.context -> string -> literals
haftmann@28054
    45
  type serialization
wenzelm@36959
    46
  val parse_args: 'a parser -> Token.T list -> 'a
haftmann@38916
    47
  val serialization: (int -> Path.T option -> 'a -> unit)
haftmann@55150
    48
    -> (Code_Symbol.T list -> int -> 'a -> (string * string) list * (Code_Symbol.T -> string option))
haftmann@38925
    49
    -> 'a -> serialization
haftmann@38918
    50
  val set_default_code_width: int -> theory -> theory
haftmann@38917
    51
haftmann@52137
    52
  type ('a, 'b, 'c, 'd, 'e, 'f) symbol_attr_decl
haftmann@52138
    53
  type identifier_data
haftmann@52138
    54
  val set_identifiers: (string, string, string, string, string, string) symbol_attr_decl
haftmann@52138
    55
    -> theory -> theory
haftmann@55372
    56
  val set_printings: (Code_Printer.raw_const_syntax, Code_Printer.tyco_syntax, string, unit, unit, (string * string list)) symbol_attr_decl
haftmann@52137
    57
    -> theory -> theory
haftmann@28054
    58
  val add_reserved: string -> string -> theory -> theory
haftmann@39646
    59
haftmann@39750
    60
  val codegen_tool: string (*theory name*) -> string (*export_code expr*) -> unit
wenzelm@43564
    61
wenzelm@43564
    62
  val setup: theory -> theory
haftmann@24219
    63
end;
haftmann@24219
    64
haftmann@28054
    65
structure Code_Target : CODE_TARGET =
haftmann@24219
    66
struct
haftmann@24219
    67
haftmann@55150
    68
open Basic_Code_Symbol;
haftmann@28054
    69
open Basic_Code_Thingol;
haftmann@34152
    70
haftmann@34152
    71
type literals = Code_Printer.literals;
haftmann@52137
    72
type ('a, 'b, 'c, 'd, 'e, 'f) symbol_attr_decl =
haftmann@52137
    73
  (string * (string * 'a option) list, string * (string * 'b option) list,
haftmann@52137
    74
    class * (string * 'c option) list, (class * class) * (string * 'd option) list,
haftmann@52137
    75
    (class * string) * (string * 'e option) list,
haftmann@52137
    76
    string * (string * 'f option) list) Code_Symbol.attr;
haftmann@55291
    77
type identifier_data = (string list * string, string list * string, string list * string, string list * string,
haftmann@55291
    78
  string list * string, string list * string) Code_Symbol.data;
haftmann@52137
    79
haftmann@34152
    80
type tyco_syntax = Code_Printer.tyco_syntax;
haftmann@55153
    81
type raw_const_syntax = Code_Printer.raw_const_syntax;
haftmann@34152
    82
haftmann@24219
    83
haftmann@52377
    84
(** checking and parsing of symbols **)
haftmann@52377
    85
haftmann@55757
    86
fun cert_const ctxt const =
haftmann@52377
    87
  let
haftmann@55757
    88
    val _ = if Sign.declared_const (Proof_Context.theory_of ctxt) const then ()
haftmann@52377
    89
      else error ("No such constant: " ^ quote const);
haftmann@52377
    90
  in const end;
haftmann@52377
    91
haftmann@55757
    92
fun read_const ctxt = Code.read_const (Proof_Context.theory_of ctxt);
haftmann@55757
    93
haftmann@55757
    94
fun cert_tyco ctxt tyco =
haftmann@52377
    95
  let
haftmann@55757
    96
    val _ = if Sign.declared_tyname (Proof_Context.theory_of ctxt) tyco then ()
haftmann@52377
    97
      else error ("No such type constructor: " ^ quote tyco);
haftmann@52377
    98
  in tyco end;
haftmann@52377
    99
wenzelm@55951
   100
fun read_tyco ctxt =
wenzelm@56002
   101
  #1 o dest_Type o Proof_Context.read_type_name {proper = true, strict = true} ctxt;
haftmann@52377
   102
haftmann@55757
   103
fun cert_class ctxt class =
haftmann@52377
   104
  let
haftmann@55757
   105
    val _ = Axclass.get_info (Proof_Context.theory_of ctxt) class;
haftmann@52377
   106
  in class end;
haftmann@52377
   107
haftmann@52377
   108
val parse_classrel_ident = Parse.class --| @{keyword "<"} -- Parse.class;
haftmann@52377
   109
haftmann@55757
   110
fun cert_inst ctxt (class, tyco) =
haftmann@55757
   111
  (cert_class ctxt class, cert_tyco ctxt tyco);
haftmann@52377
   112
haftmann@55757
   113
fun read_inst ctxt (raw_tyco, raw_class) =
haftmann@55757
   114
  (read_tyco ctxt raw_tyco, Proof_Context.read_class ctxt raw_class);
haftmann@52377
   115
haftmann@52377
   116
val parse_inst_ident = Parse.xname --| @{keyword "::"} -- Parse.class;
haftmann@52377
   117
haftmann@55757
   118
fun cert_syms ctxt =
haftmann@55757
   119
  Code_Symbol.map_attr (apfst (cert_const ctxt)) (apfst (cert_tyco ctxt))
wenzelm@59058
   120
    (apfst (cert_class ctxt)) ((apfst o apply2) (cert_class ctxt)) (apfst (cert_inst ctxt)) I;
haftmann@52377
   121
haftmann@55757
   122
fun read_syms ctxt =
haftmann@55757
   123
  Code_Symbol.map_attr (apfst (read_const ctxt)) (apfst (read_tyco ctxt))
wenzelm@59058
   124
    (apfst (Proof_Context.read_class ctxt)) ((apfst o apply2) (Proof_Context.read_class ctxt)) (apfst (read_inst ctxt)) I;
haftmann@52377
   125
haftmann@52377
   126
fun check_name is_module s =
haftmann@52377
   127
  let
haftmann@52377
   128
    val _ = if s = "" then error "Bad empty code name" else ();
haftmann@52377
   129
    val xs = Long_Name.explode s;
haftmann@52377
   130
    val xs' = if is_module
haftmann@56826
   131
        then map (Name.desymbolize NONE) xs
haftmann@52377
   132
      else if length xs < 2
haftmann@52377
   133
        then error ("Bad code name without module component: " ^ quote s)
haftmann@52377
   134
      else
haftmann@52377
   135
        let
haftmann@52377
   136
          val (ys, y) = split_last xs;
haftmann@56826
   137
          val ys' = map (Name.desymbolize NONE) ys;
haftmann@56826
   138
          val y' = Name.desymbolize NONE y;
haftmann@52377
   139
        in ys' @ [y'] end;
haftmann@52377
   140
  in if xs' = xs
haftmann@55291
   141
    then if is_module then (xs, "") else split_last xs
haftmann@52377
   142
    else error ("Invalid code name: " ^ quote s ^ "\n"
haftmann@52377
   143
      ^ "better try " ^ quote (Long_Name.implode xs'))
haftmann@52377
   144
  end;
haftmann@52377
   145
haftmann@52377
   146
haftmann@52137
   147
(** serializations and serializer **)
haftmann@52137
   148
haftmann@52137
   149
(* serialization: abstract nonsense to cover different destinies for generated code *)
haftmann@24219
   150
haftmann@55150
   151
datatype destination = Export of Path.T option | Produce | Present of Code_Symbol.T list;
haftmann@55150
   152
type serialization = int -> destination -> ((string * string) list * (Code_Symbol.T -> string option)) option;
haftmann@27014
   153
haftmann@39659
   154
fun serialization output _ content width (Export some_path) =
haftmann@39661
   155
      (output width some_path content; NONE)
haftmann@39661
   156
  | serialization _ string content width Produce =
haftmann@39661
   157
      string [] width content |> SOME
haftmann@55147
   158
  | serialization _ string content width (Present syms) =
haftmann@55147
   159
     string syms width content
haftmann@48568
   160
     |> (apfst o map o apsnd) (Pretty.output (SOME width) o Pretty.str)
haftmann@39661
   161
     |> SOME;
haftmann@39659
   162
haftmann@39661
   163
fun export some_path f = (f (Export some_path); ());
haftmann@39661
   164
fun produce f = the (f Produce);
haftmann@55147
   165
fun present syms f = space_implode "\n\n" (map snd (fst (the (f (Present syms)))));
haftmann@38917
   166
haftmann@24219
   167
haftmann@52137
   168
(* serializers: functions producing serializations *)
haftmann@28054
   169
haftmann@39142
   170
type serializer = Token.T list
haftmann@52138
   171
  -> Proof.context
haftmann@39142
   172
  -> {
haftmann@52138
   173
    module_name: string,
haftmann@38926
   174
    reserved_syms: string list,
haftmann@52138
   175
    identifiers: identifier_data,
haftmann@38926
   176
    includes: (string * Pretty.T) list,
haftmann@38926
   177
    class_syntax: string -> string option,
haftmann@38926
   178
    tyco_syntax: string -> Code_Printer.tyco_syntax option,
haftmann@55153
   179
    const_syntax: string -> Code_Printer.const_syntax option }
haftmann@55683
   180
  -> Code_Symbol.T list
haftmann@41342
   181
  -> Code_Thingol.program
haftmann@28054
   182
  -> serialization;
haftmann@27000
   183
haftmann@59099
   184
type fundamental = { serializer: serializer, literals: literals,
haftmann@59099
   185
  check: { env_var: string, make_destination: Path.T -> Path.T, make_command: string -> string } }; 
haftmann@59099
   186
haftmann@52137
   187
haftmann@52137
   188
(** theory data **)
haftmann@52137
   189
haftmann@28054
   190
datatype target = Target of {
haftmann@59101
   191
  fundamental: serial * fundamental,
haftmann@59101
   192
  ancestry: (string * (Code_Thingol.program -> Code_Thingol.program)) list,
haftmann@28054
   193
  reserved: string list,
haftmann@52138
   194
  identifiers: identifier_data,
haftmann@55153
   195
  printings: (Code_Printer.const_syntax, Code_Printer.tyco_syntax, string, unit, unit,
haftmann@52137
   196
    (Pretty.T * string list)) Code_Symbol.data
haftmann@28054
   197
};
haftmann@27103
   198
haftmann@59101
   199
fun make_target ((fundamental, ancestry), (reserved, (identifiers, printings))) =
haftmann@59101
   200
  Target { fundamental = fundamental, ancestry = ancestry,
haftmann@59101
   201
    reserved = reserved, identifiers = identifiers, printings = printings };
haftmann@59101
   202
fun map_target f (Target { fundamental, ancestry, reserved, identifiers, printings }) =
haftmann@59101
   203
  make_target (f ((fundamental, ancestry), (reserved, (identifiers, printings))));
haftmann@59101
   204
fun merge_target strict target_name (Target { fundamental = (serial1, fundamental1),
haftmann@59101
   205
  ancestry = ancestry1, reserved = reserved1, identifiers = identifiers1, printings = printings1 },
haftmann@59101
   206
    Target { fundamental = (serial2, _), ancestry = ancestry2,
haftmann@52138
   207
      reserved = reserved2, identifiers = identifiers2, printings = printings2 }) =
haftmann@28054
   208
  if serial1 = serial2 orelse not strict then
haftmann@59101
   209
    make_target (((serial1, fundamental1), AList.join (op =) (K snd) (ancestry1, ancestry2)),
haftmann@59101
   210
      (merge (op =) (reserved1, reserved2),
haftmann@52138
   211
      (Code_Symbol.merge_data (identifiers1, identifiers2),
haftmann@52138
   212
        Code_Symbol.merge_data (printings1, printings2))))
haftmann@28054
   213
  else
haftmann@59099
   214
    error ("Incompatible targets: " ^ quote target_name);
haftmann@27103
   215
haftmann@59101
   216
fun the_marked_fundamental (Target { fundamental, ... }) = fundamental;
haftmann@59101
   217
fun the_ancestry (Target { ancestry, ... }) = ancestry;
haftmann@28054
   218
fun the_reserved (Target { reserved, ... }) = reserved;
haftmann@52138
   219
fun the_identifiers (Target { identifiers , ... }) = identifiers;
haftmann@52137
   220
fun the_printings (Target { printings, ... }) = printings;
haftmann@27437
   221
haftmann@34248
   222
structure Targets = Theory_Data
haftmann@34071
   223
(
haftmann@54890
   224
  type T = target Symtab.table * int;
haftmann@54890
   225
  val empty = (Symtab.empty, 80);
haftmann@34071
   226
  val extend = I;
haftmann@54890
   227
  fun merge ((target1, width1), (target2, width2)) : T =
haftmann@54890
   228
    (Symtab.join (merge_target true) (target1, target2), Int.max (width1, width2));
haftmann@34071
   229
);
haftmann@27436
   230
haftmann@59101
   231
fun exists_target thy = Symtab.defined (fst (Targets.get thy));
haftmann@59100
   232
fun lookup_target thy = Symtab.lookup (fst (Targets.get thy));
haftmann@59100
   233
haftmann@59101
   234
fun join_ancestry thy target_name =
haftmann@59101
   235
  let
haftmann@59101
   236
    val the_target = the o lookup_target thy;
haftmann@59101
   237
    val target = the_target target_name;
haftmann@59101
   238
    val ancestry = the_ancestry target
haftmann@59101
   239
    val targets = rev (map (fn (target_name', modify') =>
haftmann@59101
   240
      (target_name', (modify', the_target target_name'))) ancestry)
haftmann@59101
   241
      @ [(target_name, (I, target))];
haftmann@59101
   242
  in
haftmann@59101
   243
    fold (fn (target_name', (modify', target')) => fn (modify, target) =>
haftmann@59101
   244
      (modify' o modify, merge_target false target_name' (target, target')))
haftmann@59101
   245
      (tl targets) (snd (hd targets))
haftmann@59101
   246
  end;
haftmann@59101
   247
haftmann@59099
   248
fun assert_target ctxt target_name =
haftmann@59101
   249
  if exists_target (Proof_Context.theory_of ctxt) target_name
haftmann@59099
   250
  then target_name
haftmann@59099
   251
  else error ("Unknown code target language: " ^ quote target_name);
haftmann@28054
   252
haftmann@59101
   253
fun allocate_target target_name target thy =
haftmann@27304
   254
  let
haftmann@59101
   255
    val _ = if exists_target thy target_name
haftmann@59101
   256
      then error ("Attempt to overwrite existing target " ^ quote target_name)
wenzelm@43564
   257
      else ();
haftmann@28054
   258
  in
haftmann@28054
   259
    thy
haftmann@59101
   260
    |> (Targets.map o apfst o Symtab.update) (target_name, target) 
haftmann@28054
   261
  end;
haftmann@27436
   262
haftmann@59100
   263
fun add_target (target_name, fundamental) =
haftmann@59101
   264
  allocate_target target_name (make_target (((serial (), fundamental), []),
haftmann@59101
   265
    ([], (Code_Symbol.empty_data, Code_Symbol.empty_data))));
haftmann@27436
   266
haftmann@59101
   267
fun extend_target (target_name, (super, modify)) thy =
haftmann@59101
   268
  let
haftmann@59101
   269
    val super_target = case lookup_target thy super of
haftmann@59101
   270
      NONE => error ("Unknown code target language: " ^ quote super)
haftmann@59101
   271
    | SOME super_target => super_target;
haftmann@59101
   272
    val fundamental = the_marked_fundamental super_target;
haftmann@59101
   273
  in
haftmann@59101
   274
    allocate_target target_name (make_target ((fundamental,
haftmann@59101
   275
      (super, modify) :: the_ancestry super_target),
haftmann@59101
   276
        ([], (Code_Symbol.empty_data, Code_Symbol.empty_data)))) thy
haftmann@59101
   277
  end;
haftmann@59101
   278
  
haftmann@59099
   279
fun map_target_data target_name f thy =
haftmann@27436
   280
  let
haftmann@59099
   281
    val _ = assert_target (Proof_Context.init_global thy) target_name;
haftmann@28054
   282
  in
haftmann@28054
   283
    thy
haftmann@59099
   284
    |> (Targets.map o apfst o Symtab.map_entry target_name o map_target o apsnd) f
haftmann@28054
   285
  end;
haftmann@27304
   286
haftmann@59099
   287
fun map_reserved target_name =
haftmann@59099
   288
  map_target_data target_name o apfst;
haftmann@59099
   289
fun map_identifiers target_name =
haftmann@59099
   290
  map_target_data target_name o apsnd o apfst;
haftmann@59099
   291
fun map_printings target_name =
haftmann@59099
   292
  map_target_data target_name o apsnd o apsnd;
haftmann@27000
   293
haftmann@34248
   294
fun set_default_code_width k = (Targets.map o apsnd) (K k);
haftmann@34071
   295
haftmann@27000
   296
haftmann@34021
   297
(** serializer usage **)
haftmann@34021
   298
haftmann@34021
   299
(* montage *)
haftmann@34021
   300
haftmann@55757
   301
fun the_fundamental ctxt =
haftmann@59101
   302
  snd o the_marked_fundamental o the o lookup_target (Proof_Context.theory_of ctxt)
haftmann@37822
   303
haftmann@55757
   304
fun the_literals ctxt = #literals o the_fundamental ctxt;
haftmann@34021
   305
haftmann@39817
   306
local
haftmann@39817
   307
haftmann@59099
   308
fun activate_target ctxt target_name =
haftmann@39817
   309
  let
haftmann@59101
   310
    val thy = Proof_Context.theory_of ctxt
haftmann@59101
   311
    val (_, default_width) = Targets.get thy;
haftmann@59101
   312
    val (modify, target) = join_ancestry thy target_name;
haftmann@59099
   313
  in (default_width, target, modify) end;
haftmann@38927
   314
haftmann@55757
   315
fun project_program ctxt syms_hidden syms1 program2 =
haftmann@38927
   316
  let
haftmann@55147
   317
    val syms2 = subtract (op =) syms_hidden syms1;
haftmann@55147
   318
    val program3 = Code_Symbol.Graph.restrict (not o member (op =) syms_hidden) program2;
haftmann@55147
   319
    val syms4 = Code_Symbol.Graph.all_succs program3 syms2;
haftmann@54890
   320
    val unimplemented = Code_Thingol.unimplemented program3;
wenzelm@42359
   321
    val _ =
haftmann@54889
   322
      if null unimplemented then ()
wenzelm@42359
   323
      else error ("No code equations for " ^
wenzelm@55304
   324
        commas (map (Proof_Context.markup_const ctxt) unimplemented));
haftmann@55147
   325
    val program4 = Code_Symbol.Graph.restrict (member (op =) syms4) program3;
haftmann@55147
   326
  in (syms4, program4) end;
haftmann@38927
   327
haftmann@55757
   328
fun prepare_serializer ctxt (serializer : serializer) reserved identifiers
haftmann@55147
   329
    printings module_name args proto_program syms =
haftmann@38927
   330
  let
haftmann@55149
   331
    val syms_hidden = Code_Symbol.symbols_of printings;
haftmann@55757
   332
    val (syms_all, program) = project_program ctxt syms_hidden syms proto_program;
haftmann@39484
   333
    fun select_include (name, (content, cs)) =
haftmann@55150
   334
      if null cs orelse exists (fn c => member (op =) syms_all (Constant c)) cs
haftmann@39484
   335
      then SOME (name, content) else NONE;
haftmann@52137
   336
    val includes = map_filter select_include (Code_Symbol.dest_module_data printings);
haftmann@34021
   337
  in
haftmann@55757
   338
    (serializer args ctxt {
haftmann@52138
   339
      module_name = module_name,
haftmann@38926
   340
      reserved_syms = reserved,
haftmann@52138
   341
      identifiers = identifiers,
haftmann@38926
   342
      includes = includes,
haftmann@55149
   343
      const_syntax = Code_Symbol.lookup_constant_data printings,
haftmann@55149
   344
      tyco_syntax = Code_Symbol.lookup_type_constructor_data printings,
haftmann@55149
   345
      class_syntax = Code_Symbol.lookup_type_class_data printings },
haftmann@55776
   346
      (subtract (op =) syms_hidden syms, program))
haftmann@34021
   347
  end;
haftmann@34021
   348
haftmann@59099
   349
fun mount_serializer ctxt target_name some_width module_name args program syms =
haftmann@34021
   350
  let
haftmann@59099
   351
    val (default_width, target, modify) = activate_target ctxt target_name;
haftmann@59101
   352
    val serializer = (#serializer o snd o the_marked_fundamental) target;
haftmann@55683
   353
    val (prepared_serializer, (prepared_syms, prepared_program)) =
haftmann@55757
   354
      prepare_serializer ctxt serializer
haftmann@59099
   355
        (the_reserved target) (the_identifiers target) (the_printings target)
haftmann@55147
   356
        module_name args (modify program) syms
haftmann@34071
   357
    val width = the_default default_width some_width;
haftmann@55683
   358
  in (fn program => fn syms => prepared_serializer syms program width, (prepared_syms, prepared_program)) end;
haftmann@41344
   359
haftmann@59099
   360
fun invoke_serializer ctxt target_name some_width raw_module_name args program all_public syms =
haftmann@41344
   361
  let
haftmann@55291
   362
    val module_name = if raw_module_name = "" then ""
haftmann@55291
   363
      else (check_name true raw_module_name; raw_module_name)
haftmann@55757
   364
    val (mounted_serializer, (prepared_syms, prepared_program)) =
haftmann@59099
   365
      mount_serializer ctxt target_name some_width module_name args program syms;
haftmann@55776
   366
  in mounted_serializer prepared_program (if all_public then [] else prepared_syms) end;
haftmann@34021
   367
haftmann@52138
   368
fun assert_module_name "" = error "Empty module name not allowed here"
haftmann@38933
   369
  | assert_module_name module_name = module_name;
haftmann@38933
   370
haftmann@55757
   371
fun using_master_directory ctxt =
wenzelm@56208
   372
  Option.map (Path.append (File.pwd ()) o
wenzelm@56208
   373
    Path.append (Resources.master_directory (Proof_Context.theory_of ctxt)));
haftmann@48371
   374
haftmann@34021
   375
in
haftmann@34021
   376
haftmann@48568
   377
val generatedN = "Generated_Code";
haftmann@48568
   378
haftmann@59099
   379
fun export_code_for ctxt some_path target_name some_width module_name args =
haftmann@55757
   380
  export (using_master_directory ctxt some_path)
haftmann@59099
   381
  ooo invoke_serializer ctxt target_name some_width module_name args;
haftmann@38918
   382
haftmann@59099
   383
fun produce_code_for ctxt target_name some_width module_name args =
haftmann@39102
   384
  let
haftmann@59099
   385
    val serializer = invoke_serializer ctxt target_name some_width (assert_module_name module_name) args;
haftmann@55683
   386
  in fn program => fn all_public => fn syms =>
haftmann@55683
   387
    produce (serializer program all_public syms) |> apsnd (fn deresolve => map deresolve syms)
haftmann@39484
   388
  end;
haftmann@38929
   389
haftmann@59099
   390
fun present_code_for ctxt target_name some_width module_name args =
haftmann@39484
   391
  let
haftmann@59099
   392
    val serializer = invoke_serializer ctxt target_name some_width (assert_module_name module_name) args;
haftmann@55147
   393
  in fn program => fn (syms, selects) =>
haftmann@55683
   394
    present selects (serializer program false syms)
haftmann@39484
   395
  end;
haftmann@38918
   396
haftmann@59099
   397
fun check_code_for ctxt target_name strict args program all_public syms =
haftmann@37824
   398
  let
haftmann@37824
   399
    val { env_var, make_destination, make_command } =
haftmann@59099
   400
      (#check o the_fundamental ctxt) target_name;
wenzelm@41939
   401
    fun ext_check p =
wenzelm@43564
   402
      let
haftmann@37824
   403
        val destination = make_destination p;
haftmann@59099
   404
        val _ = export (SOME destination) (invoke_serializer ctxt target_name (SOME 80)
haftmann@55683
   405
          generatedN args program all_public syms);
haftmann@48568
   406
        val cmd = make_command generatedN;
wenzelm@43850
   407
      in
wenzelm@43850
   408
        if Isabelle_System.bash ("cd " ^ File.shell_path p ^ " && " ^ cmd ^ " 2>&1") <> 0
haftmann@59099
   409
        then error ("Code check failed for " ^ target_name ^ ": " ^ cmd)
haftmann@37824
   410
        else ()
haftmann@37824
   411
      end;
wenzelm@43850
   412
  in
wenzelm@43850
   413
    if getenv env_var = ""
haftmann@37825
   414
    then if strict
haftmann@59099
   415
      then error (env_var ^ " not set; cannot check code for " ^ target_name)
haftmann@59099
   416
      else warning (env_var ^ " not set; skipped checking code for " ^ target_name)
wenzelm@41939
   417
    else Isabelle_System.with_tmp_dir "Code_Test" ext_check
haftmann@37824
   418
  end;
haftmann@37824
   419
haftmann@56920
   420
fun subevaluator mounted_serializer prepared_program syms all_public ((vs, ty), t) =
haftmann@41344
   421
  let
haftmann@41344
   422
    val _ = if Code_Thingol.contains_dict_var t then
haftmann@41344
   423
      error "Term to be evaluated contains free dictionaries" else ();
wenzelm@43324
   424
    val v' = singleton (Name.variant_list (map fst vs)) "a";
haftmann@41344
   425
    val vs' = (v', []) :: vs;
haftmann@55147
   426
    val ty' = ITyVar v' `-> ty;
haftmann@41344
   427
    val program = prepared_program
haftmann@55147
   428
      |> Code_Symbol.Graph.new_node (Code_Symbol.value,
haftmann@57249
   429
          Code_Thingol.Fun (((vs', ty'), [(([IVar (SOME "dummy")], t), (NONE, true))]), NONE))
haftmann@55147
   430
      |> fold (curry (perhaps o try o
haftmann@55147
   431
          Code_Symbol.Graph.add_edge) Code_Symbol.value) syms;
haftmann@55683
   432
    val (program_code, deresolve) =
haftmann@55684
   433
      produce (mounted_serializer program (if all_public then [] else [Code_Symbol.value]));
haftmann@55147
   434
    val value_name = the (deresolve Code_Symbol.value);
haftmann@55147
   435
  in (program_code, value_name) end;
haftmann@41344
   436
haftmann@59099
   437
fun evaluator ctxt target_name program syms =
haftmann@41344
   438
  let
haftmann@55683
   439
    val (mounted_serializer, (_, prepared_program)) =
haftmann@59099
   440
      mount_serializer ctxt target_name NONE generatedN [] program syms;
haftmann@56920
   441
  in subevaluator mounted_serializer prepared_program syms end;
haftmann@41344
   442
haftmann@34021
   443
end; (* local *)
haftmann@34021
   444
haftmann@34021
   445
haftmann@34021
   446
(* code generation *)
haftmann@34021
   447
haftmann@38918
   448
fun prep_destination "" = NONE
haftmann@38918
   449
  | prep_destination s = SOME (Path.explode s);
haftmann@38918
   450
haftmann@55757
   451
fun export_code ctxt all_public cs seris =
haftmann@34021
   452
  let
haftmann@55757
   453
    val thy = Proof_Context.theory_of ctxt;
haftmann@55188
   454
    val program = Code_Thingol.consts_program thy cs;
haftmann@59099
   455
    val _ = map (fn (((target_name, module_name), some_path), args) =>
haftmann@59099
   456
      export_code_for ctxt some_path target_name NONE module_name args program all_public (map Constant cs)) seris;
haftmann@34021
   457
  in () end;
haftmann@34021
   458
haftmann@55757
   459
fun export_code_cmd all_public raw_cs seris ctxt =
haftmann@55757
   460
  export_code ctxt all_public
haftmann@55757
   461
    (Code_Thingol.read_const_exprs ctxt raw_cs)
haftmann@55683
   462
    ((map o apfst o apsnd) prep_destination seris);
haftmann@38918
   463
haftmann@59099
   464
fun produce_code ctxt all_public cs target_name some_width some_module_name args =
haftmann@38918
   465
  let
haftmann@55757
   466
    val thy = Proof_Context.theory_of ctxt;
haftmann@55188
   467
    val program = Code_Thingol.consts_program thy cs;
haftmann@59099
   468
  in produce_code_for ctxt target_name some_width some_module_name args program all_public (map Constant cs) end;
haftmann@38929
   469
haftmann@59099
   470
fun present_code ctxt cs syms target_name some_width some_module_name args =
haftmann@38929
   471
  let
haftmann@55757
   472
    val thy = Proof_Context.theory_of ctxt;
haftmann@55188
   473
    val program = Code_Thingol.consts_program thy cs;
haftmann@59099
   474
  in present_code_for ctxt target_name some_width some_module_name args program (map Constant cs, syms) end;
haftmann@34021
   475
haftmann@55757
   476
fun check_code ctxt all_public cs seris =
haftmann@37824
   477
  let
haftmann@55757
   478
    val thy = Proof_Context.theory_of ctxt;
haftmann@55188
   479
    val program = Code_Thingol.consts_program thy cs;
haftmann@59099
   480
    val _ = map (fn ((target_name, strict), args) =>
haftmann@59099
   481
      check_code_for ctxt target_name strict args program all_public (map Constant cs)) seris;
haftmann@37824
   482
  in () end;
haftmann@37824
   483
haftmann@55757
   484
fun check_code_cmd all_public raw_cs seris ctxt =
haftmann@55757
   485
  check_code ctxt all_public
haftmann@55757
   486
    (Code_Thingol.read_const_exprs ctxt raw_cs) seris;
haftmann@37824
   487
haftmann@39480
   488
local
haftmann@39480
   489
haftmann@39480
   490
val parse_const_terms = Scan.repeat1 Args.term
haftmann@55757
   491
  >> (fn ts => fn ctxt => map (Code.check_const (Proof_Context.theory_of ctxt)) ts);
haftmann@39480
   492
haftmann@55147
   493
fun parse_names category parse internalize mark_symbol =
haftmann@39480
   494
  Scan.lift (Args.parens (Args.$$$ category)) |-- Scan.repeat1 parse
haftmann@55757
   495
  >> (fn xs => fn ctxt => map (mark_symbol o internalize ctxt) xs);
wenzelm@43564
   496
haftmann@39480
   497
val parse_consts = parse_names "consts" Args.term
haftmann@55757
   498
  (Code.check_const o Proof_Context.theory_of) Constant;
haftmann@39480
   499
haftmann@39480
   500
val parse_types = parse_names "types" (Scan.lift Args.name)
haftmann@55757
   501
  (Sign.intern_type o Proof_Context.theory_of) Type_Constructor;
haftmann@39480
   502
haftmann@39480
   503
val parse_classes = parse_names "classes" (Scan.lift Args.name)
haftmann@55757
   504
  (Sign.intern_class o Proof_Context.theory_of) Type_Class;
haftmann@39480
   505
haftmann@39480
   506
val parse_instances = parse_names "instances" (Scan.lift (Args.name --| Args.$$$ "::" -- Args.name))
haftmann@55757
   507
  (fn ctxt => fn (raw_tyco, raw_class) =>
haftmann@55757
   508
    let
haftmann@55757
   509
      val thy = Proof_Context.theory_of ctxt;
haftmann@55757
   510
    in (Sign.intern_class thy raw_tyco, Sign.intern_type thy raw_class) end) Class_Instance;
haftmann@39480
   511
haftmann@39480
   512
in
haftmann@39480
   513
wenzelm@43564
   514
val antiq_setup =
wenzelm@43564
   515
  Thy_Output.antiquotation @{binding code_stmts}
wenzelm@43564
   516
    (parse_const_terms --
wenzelm@43564
   517
      Scan.repeat (parse_consts || parse_types || parse_classes || parse_instances)
wenzelm@43564
   518
      -- Scan.lift (Args.parens (Args.name -- Scan.option Parse.int)))
haftmann@59099
   519
    (fn {context = ctxt, ...} => fn ((mk_cs, mk_stmtss), (target_name, some_width)) =>
haftmann@55757
   520
        present_code ctxt (mk_cs ctxt)
haftmann@55757
   521
          (maps (fn f => f ctxt) mk_stmtss)
haftmann@59099
   522
          target_name some_width "Example" []);
haftmann@39480
   523
haftmann@39480
   524
end;
haftmann@39480
   525
haftmann@34021
   526
haftmann@28054
   527
(** serializer configuration **)
haftmann@27000
   528
haftmann@52138
   529
(* reserved symbol names *)
haftmann@52138
   530
haftmann@59099
   531
fun add_reserved target_name sym thy =
haftmann@52138
   532
  let
haftmann@59101
   533
    val (_, target) = join_ancestry thy target_name;
haftmann@59099
   534
    val _ = if member (op =) (the_reserved target) sym
haftmann@52138
   535
      then error ("Reserved symbol " ^ quote sym ^ " already declared")
haftmann@52138
   536
      else ();
haftmann@52138
   537
  in
haftmann@52138
   538
    thy
haftmann@59099
   539
    |> map_reserved target_name (insert (op =) sym)
haftmann@52138
   540
  end;
haftmann@52138
   541
haftmann@52138
   542
haftmann@52377
   543
(* checking of syntax *)
haftmann@52138
   544
haftmann@59099
   545
fun check_const_syntax ctxt target_name c syn =
haftmann@55757
   546
  if Code_Printer.requires_args syn > Code.args_number (Proof_Context.theory_of ctxt) c
haftmann@52137
   547
  then error ("Too many arguments in syntax for constant " ^ quote c)
haftmann@59099
   548
  else Code_Printer.prep_const_syntax (Proof_Context.theory_of ctxt) (the_literals ctxt target_name) c syn;
haftmann@52137
   549
haftmann@59099
   550
fun check_tyco_syntax ctxt target_name tyco syn =
haftmann@55757
   551
  if fst syn <> Sign.arity_number (Proof_Context.theory_of ctxt) tyco
haftmann@52137
   552
  then error ("Number of arguments mismatch in syntax for type constructor " ^ quote tyco)
haftmann@52137
   553
  else syn;
haftmann@34071
   554
haftmann@52138
   555
haftmann@52138
   556
(* custom symbol names *)
haftmann@52138
   557
wenzelm@52218
   558
fun arrange_name_decls x =
haftmann@52138
   559
  let
haftmann@52138
   560
    fun arrange is_module (sym, target_names) = map (fn (target, some_name) =>
haftmann@52138
   561
      (target, (sym, Option.map (check_name is_module) some_name))) target_names;
haftmann@52138
   562
  in
haftmann@52138
   563
    Code_Symbol.maps_attr' (arrange false) (arrange false) (arrange false)
wenzelm@52218
   564
      (arrange false) (arrange false) (arrange true) x
haftmann@52138
   565
  end;
haftmann@52138
   566
haftmann@55757
   567
fun cert_name_decls ctxt = cert_syms ctxt #> arrange_name_decls;
haftmann@52138
   568
haftmann@55757
   569
fun read_name_decls ctxt = read_syms ctxt #> arrange_name_decls;
haftmann@52138
   570
haftmann@59099
   571
fun set_identifier (target_name, sym_name) = map_identifiers target_name (Code_Symbol.set_data sym_name);
haftmann@52138
   572
haftmann@52138
   573
fun gen_set_identifiers prep_name_decl raw_name_decls thy =
haftmann@55757
   574
  fold set_identifier (prep_name_decl (Proof_Context.init_global thy) raw_name_decls) thy;
haftmann@52138
   575
haftmann@52138
   576
val set_identifiers = gen_set_identifiers cert_name_decls;
haftmann@52138
   577
val set_identifiers_cmd = gen_set_identifiers read_name_decls;
haftmann@52138
   578
haftmann@52138
   579
haftmann@52138
   580
(* custom printings *)
haftmann@52138
   581
haftmann@55757
   582
fun arrange_printings prep_const ctxt =
haftmann@52137
   583
  let
haftmann@52137
   584
    fun arrange check (sym, target_syns) =
haftmann@59099
   585
      map (fn (target_name, some_syn) =>
haftmann@59099
   586
        (target_name, (sym, Option.map (check ctxt target_name sym) some_syn))) target_syns;
haftmann@52137
   587
  in
haftmann@52137
   588
    Code_Symbol.maps_attr'
haftmann@52137
   589
      (arrange check_const_syntax) (arrange check_tyco_syntax)
haftmann@55149
   590
        (arrange ((K o K o K) I)) (arrange ((K o K o K) I)) (arrange ((K o K o K) I))
haftmann@55757
   591
        (arrange (fn ctxt => fn _ => fn _ => fn (raw_content, raw_cs) =>
haftmann@55757
   592
          (Code_Printer.str raw_content, map (prep_const ctxt) raw_cs)))
haftmann@52137
   593
  end;
haftmann@52137
   594
haftmann@55757
   595
fun cert_printings ctxt = cert_syms ctxt #> arrange_printings cert_const ctxt;
haftmann@24219
   596
haftmann@55757
   597
fun read_printings ctxt = read_syms ctxt #> arrange_printings read_const ctxt;
haftmann@52137
   598
haftmann@59099
   599
fun set_printing (target_name, sym_syn) = map_printings target_name (Code_Symbol.set_data sym_syn);
haftmann@52137
   600
haftmann@52137
   601
fun gen_set_printings prep_print_decl raw_print_decls thy =
haftmann@55757
   602
  fold set_printing (prep_print_decl (Proof_Context.init_global thy) raw_print_decls) thy;
haftmann@52137
   603
haftmann@52137
   604
val set_printings = gen_set_printings cert_printings;
haftmann@52137
   605
val set_printings_cmd = gen_set_printings read_printings;
haftmann@52137
   606
haftmann@52137
   607
haftmann@27103
   608
(* concrete syntax *)
haftmann@27000
   609
haftmann@28054
   610
fun parse_args f args =
wenzelm@36959
   611
  case Scan.read Token.stopper f args
haftmann@28054
   612
   of SOME x => x
haftmann@28054
   613
    | NONE => error "Bad serializer arguments";
haftmann@28054
   614
haftmann@28054
   615
haftmann@27304
   616
(** Isar setup **)
haftmann@27103
   617
haftmann@52137
   618
fun parse_single_symbol_pragma parse_keyword parse_isa parse_target =
haftmann@52434
   619
  parse_keyword |-- Parse.!!! (parse_isa --| (@{keyword "\<rightharpoonup>"} || @{keyword "=>"})
haftmann@52434
   620
    -- Parse.and_list1 (@{keyword "("} |-- (Parse.name --| @{keyword ")"} -- Scan.option parse_target)));
haftmann@52137
   621
haftmann@52137
   622
fun parse_symbol_pragma parse_const parse_tyco parse_class parse_classrel parse_inst parse_module =
wenzelm@52801
   623
  parse_single_symbol_pragma @{keyword "constant"} Parse.term parse_const
haftmann@55150
   624
    >> Constant
haftmann@52377
   625
  || parse_single_symbol_pragma @{keyword "type_constructor"} Parse.type_const parse_tyco
haftmann@55150
   626
    >> Type_Constructor
haftmann@52377
   627
  || parse_single_symbol_pragma @{keyword "type_class"} Parse.class parse_class
haftmann@55150
   628
    >> Type_Class
haftmann@52137
   629
  || parse_single_symbol_pragma @{keyword "class_relation"} parse_classrel_ident parse_classrel
haftmann@55150
   630
    >> Class_Relation
haftmann@52137
   631
  || parse_single_symbol_pragma @{keyword "class_instance"} parse_inst_ident parse_inst
haftmann@55150
   632
    >> Class_Instance
haftmann@52137
   633
  || parse_single_symbol_pragma @{keyword "code_module"} Parse.name parse_module
haftmann@52137
   634
    >> Code_Symbol.Module;
haftmann@52137
   635
haftmann@52137
   636
fun parse_symbol_pragmas parse_const parse_tyco parse_class parse_classrel parse_inst parse_module =
haftmann@52137
   637
  Parse.enum1 "|" (Parse.group (fn () => "code symbol pragma")
haftmann@52137
   638
    (parse_symbol_pragma parse_const parse_tyco parse_class parse_classrel parse_inst parse_module));
haftmann@52137
   639
wenzelm@56201
   640
val code_expr_argsP = Scan.optional (@{keyword "("} |-- Parse.args --| @{keyword ")"}) [];
haftmann@52138
   641
haftmann@55683
   642
fun code_expr_inP all_public raw_cs =
haftmann@52434
   643
  Scan.repeat (@{keyword "in"} |-- Parse.!!! (Parse.name
haftmann@52434
   644
    -- Scan.optional (@{keyword "module_name"} |-- Parse.name) ""
haftmann@52434
   645
    -- Scan.optional (@{keyword "file"} |-- Parse.name) ""
haftmann@52434
   646
    -- code_expr_argsP))
haftmann@55683
   647
      >> (fn seri_args => export_code_cmd all_public raw_cs seri_args);
haftmann@52434
   648
haftmann@55683
   649
fun code_expr_checkingP all_public raw_cs =
haftmann@52434
   650
  (@{keyword "checking"} |-- Parse.!!!
haftmann@52434
   651
    (Scan.repeat (Parse.name -- ((@{keyword "?"} |-- Scan.succeed false) || Scan.succeed true)
haftmann@52434
   652
    -- code_expr_argsP)))
haftmann@55683
   653
      >> (fn seri_args => check_code_cmd all_public raw_cs seri_args);
haftmann@52434
   654
haftmann@55683
   655
val code_exprP = (Scan.optional (@{keyword "open"} |-- Scan.succeed true) false
haftmann@55683
   656
  -- Scan.repeat1 Parse.term)
haftmann@55683
   657
  :|-- (fn (all_public, raw_cs) => (code_expr_checkingP all_public raw_cs || code_expr_inP all_public raw_cs));
haftmann@52138
   658
haftmann@52138
   659
val _ =
haftmann@52138
   660
  Outer_Syntax.command @{command_spec "code_reserved"}
haftmann@52138
   661
    "declare words as reserved for target language"
haftmann@52138
   662
    (Parse.name -- Scan.repeat1 Parse.name
haftmann@52138
   663
      >> (fn (target, reserveds) => (Toplevel.theory o fold (add_reserved target)) reserveds));
haftmann@52138
   664
haftmann@52138
   665
val _ =
haftmann@52138
   666
  Outer_Syntax.command @{command_spec "code_identifier"} "declare mandatory names for code symbols"
haftmann@52138
   667
    (parse_symbol_pragmas Parse.name Parse.name Parse.name Parse.name Parse.name Parse.name
haftmann@52138
   668
      >> (Toplevel.theory o fold set_identifiers_cmd));
haftmann@52138
   669
haftmann@52138
   670
val _ =
haftmann@52137
   671
  Outer_Syntax.command @{command_spec "code_printing"} "declare dedicated printing for code symbols"
haftmann@52137
   672
    (parse_symbol_pragmas (Code_Printer.parse_const_syntax) (Code_Printer.parse_tyco_syntax)
haftmann@52137
   673
      Parse.string (Parse.minus >> K ()) (Parse.minus >> K ())
haftmann@52137
   674
      (Parse.text -- Scan.optional (@{keyword "attach"} |-- Scan.repeat1 Parse.term) [])
haftmann@52137
   675
      >> (Toplevel.theory o fold set_printings_cmd));
haftmann@52137
   676
haftmann@52137
   677
val _ =
wenzelm@46961
   678
  Outer_Syntax.command @{command_spec "export_code"} "generate executable code for constants"
haftmann@55757
   679
    (Parse.!!! code_exprP >> (fn f => Toplevel.keep (f o Toplevel.context_of)));
haftmann@30494
   680
haftmann@39646
   681
haftmann@39646
   682
(** external entrance point -- for codegen tool **)
haftmann@39646
   683
haftmann@39750
   684
fun codegen_tool thyname cmd_expr =
haftmann@39646
   685
  let
wenzelm@58928
   686
    val thy = Thy_Info.get_theory thyname;
wenzelm@58928
   687
    val ctxt = Proof_Context.init_global thy;
haftmann@39646
   688
    val parse = Scan.read Token.stopper (Parse.!!! code_exprP) o
wenzelm@59083
   689
      (filter Token.is_proper o Token.explode (Thy_Header.get_keywords thy) Position.none);
haftmann@39646
   690
  in case parse cmd_expr
haftmann@55757
   691
   of SOME f => (writeln "Now generating code..."; f ctxt)
haftmann@39646
   692
    | NONE => error ("Bad directive " ^ quote cmd_expr)
haftmann@39646
   693
  end;
haftmann@39646
   694
wenzelm@43564
   695
wenzelm@43564
   696
(** theory setup **)
wenzelm@43564
   697
wenzelm@43564
   698
val setup = antiq_setup;
wenzelm@43564
   699
haftmann@24219
   700
end; (*struct*)