src/Tools/Code/code_target.ML
author wenzelm
Sun Mar 09 16:37:56 2014 +0100 (2014-03-09)
changeset 56002 2028467b4df4
parent 55951 c07d184aebe9
child 56201 dd2df97b379b
permissions -rw-r--r--
tuned signature;
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))
haftmann@55757
   120
    (apfst (cert_class ctxt)) ((apfst o pairself) (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))
haftmann@55757
   124
    (apfst (Proof_Context.read_class ctxt)) ((apfst o pairself) (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@52377
   131
        then map (Name.desymbolize true) 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@52377
   137
          val ys' = map (Name.desymbolize true) ys;
haftmann@52377
   138
          val y' = Name.desymbolize false 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@52137
   184
datatype description =
haftmann@52137
   185
    Fundamental of { serializer: serializer,
haftmann@38910
   186
      literals: literals,
haftmann@37822
   187
      check: { env_var: string, make_destination: Path.T -> Path.T,
wenzelm@41940
   188
        make_command: string -> string } }
haftmann@38909
   189
  | Extension of string *
haftmann@55147
   190
      (Code_Thingol.program -> Code_Thingol.program);
haftmann@28054
   191
haftmann@52137
   192
haftmann@52137
   193
(** theory data **)
haftmann@52137
   194
haftmann@28054
   195
datatype target = Target of {
haftmann@28054
   196
  serial: serial,
haftmann@37821
   197
  description: description,
haftmann@28054
   198
  reserved: string list,
haftmann@52138
   199
  identifiers: identifier_data,
haftmann@55153
   200
  printings: (Code_Printer.const_syntax, Code_Printer.tyco_syntax, string, unit, unit,
haftmann@52137
   201
    (Pretty.T * string list)) Code_Symbol.data
haftmann@28054
   202
};
haftmann@27103
   203
haftmann@52138
   204
fun make_target ((serial, description), (reserved, (identifiers, printings))) =
wenzelm@43564
   205
  Target { serial = serial, description = description, reserved = reserved,
haftmann@52138
   206
    identifiers = identifiers, printings = printings };
haftmann@52138
   207
fun map_target f (Target { serial, description, reserved, identifiers, printings }) =
haftmann@52138
   208
  make_target (f ((serial, description), (reserved, (identifiers, printings))));
haftmann@37821
   209
fun merge_target strict target (Target { serial = serial1, description = description,
haftmann@52138
   210
  reserved = reserved1, identifiers = identifiers1, printings = printings1 },
haftmann@37821
   211
    Target { serial = serial2, description = _,
haftmann@52138
   212
      reserved = reserved2, identifiers = identifiers2, printings = printings2 }) =
haftmann@28054
   213
  if serial1 = serial2 orelse not strict then
haftmann@52138
   214
    make_target ((serial1, description), (merge (op =) (reserved1, reserved2),
haftmann@52138
   215
      (Code_Symbol.merge_data (identifiers1, identifiers2),
haftmann@52138
   216
        Code_Symbol.merge_data (printings1, printings2))))
haftmann@28054
   217
  else
haftmann@37821
   218
    error ("Incompatible targets: " ^ quote target);
haftmann@27103
   219
haftmann@37821
   220
fun the_description (Target { description, ... }) = description;
haftmann@28054
   221
fun the_reserved (Target { reserved, ... }) = reserved;
haftmann@52138
   222
fun the_identifiers (Target { identifiers , ... }) = identifiers;
haftmann@52137
   223
fun the_printings (Target { printings, ... }) = printings;
haftmann@27437
   224
haftmann@34248
   225
structure Targets = Theory_Data
haftmann@34071
   226
(
haftmann@54890
   227
  type T = target Symtab.table * int;
haftmann@54890
   228
  val empty = (Symtab.empty, 80);
haftmann@34071
   229
  val extend = I;
haftmann@54890
   230
  fun merge ((target1, width1), (target2, width2)) : T =
haftmann@54890
   231
    (Symtab.join (merge_target true) (target1, target2), Int.max (width1, width2));
haftmann@34071
   232
);
haftmann@27436
   233
haftmann@55757
   234
fun assert_target ctxt target =
haftmann@55757
   235
  if Symtab.defined (fst (Targets.get (Proof_Context.theory_of ctxt))) target
haftmann@33969
   236
  then target
haftmann@33969
   237
  else error ("Unknown code target language: " ^ quote target);
haftmann@28054
   238
haftmann@28054
   239
fun put_target (target, seri) thy =
haftmann@27304
   240
  let
haftmann@54890
   241
    val lookup_target = Symtab.lookup (fst (Targets.get thy));
haftmann@28054
   242
    val _ = case seri
haftmann@37821
   243
     of Extension (super, _) => if is_some (lookup_target super) then ()
haftmann@28054
   244
          else error ("Unknown code target language: " ^ quote super)
haftmann@28054
   245
      | _ => ();
haftmann@37821
   246
    val overwriting = case (Option.map the_description o lookup_target) target
haftmann@28663
   247
     of NONE => false
haftmann@37821
   248
      | SOME (Extension _) => true
haftmann@37821
   249
      | SOME (Fundamental _) => (case seri
haftmann@37821
   250
         of Extension _ => error ("Will not overwrite existing target " ^ quote target)
haftmann@28663
   251
          | _ => true);
haftmann@28663
   252
    val _ = if overwriting
haftmann@28054
   253
      then warning ("Overwriting existing target " ^ quote target)
wenzelm@43564
   254
      else ();
haftmann@28054
   255
  in
haftmann@28054
   256
    thy
haftmann@54890
   257
    |> (Targets.map o apfst o Symtab.update)
haftmann@52138
   258
        (target, make_target ((serial (), seri),
haftmann@52138
   259
          ([], (Code_Symbol.empty_data, Code_Symbol.empty_data))))
haftmann@28054
   260
  end;
haftmann@27436
   261
haftmann@37821
   262
fun add_target (target, seri) = put_target (target, Fundamental seri);
haftmann@28054
   263
fun extend_target (target, (super, modify)) =
haftmann@37821
   264
  put_target (target, Extension (super, modify));
haftmann@27436
   265
haftmann@28054
   266
fun map_target_data target f thy =
haftmann@27436
   267
  let
haftmann@55757
   268
    val _ = assert_target (Proof_Context.init_global thy) target;
haftmann@28054
   269
  in
haftmann@28054
   270
    thy
haftmann@54890
   271
    |> (Targets.map o apfst o Symtab.map_entry target o map_target o apsnd) f
haftmann@28054
   272
  end;
haftmann@27304
   273
haftmann@28054
   274
fun map_reserved target =
haftmann@52138
   275
  map_target_data target o apfst;
haftmann@52138
   276
fun map_identifiers target =
haftmann@52138
   277
  map_target_data target o apsnd o apfst;
haftmann@52137
   278
fun map_printings target =
haftmann@52137
   279
  map_target_data target o apsnd o apsnd;
haftmann@27000
   280
haftmann@34248
   281
fun set_default_code_width k = (Targets.map o apsnd) (K k);
haftmann@34071
   282
haftmann@27000
   283
haftmann@34021
   284
(** serializer usage **)
haftmann@34021
   285
haftmann@34021
   286
(* montage *)
haftmann@34021
   287
haftmann@55757
   288
fun the_fundamental ctxt =
haftmann@34021
   289
  let
haftmann@55757
   290
    val (targets, _) = Targets.get (Proof_Context.theory_of ctxt);
haftmann@37822
   291
    fun fundamental target = case Symtab.lookup targets target
haftmann@37821
   292
     of SOME data => (case the_description data
haftmann@37822
   293
         of Fundamental data => data
haftmann@37822
   294
          | Extension (super, _) => fundamental super)
haftmann@34021
   295
      | NONE => error ("Unknown code target language: " ^ quote target);
haftmann@37822
   296
  in fundamental end;
haftmann@37822
   297
haftmann@55757
   298
fun the_literals ctxt = #literals o the_fundamental ctxt;
haftmann@34021
   299
haftmann@55757
   300
fun collapse_hierarchy ctxt =
haftmann@38927
   301
  let
haftmann@55757
   302
    val (targets, _) = Targets.get (Proof_Context.theory_of ctxt);
wenzelm@43564
   303
    fun collapse target =
haftmann@38927
   304
      let
haftmann@38927
   305
        val data = case Symtab.lookup targets target
haftmann@38927
   306
         of SOME data => data
haftmann@38927
   307
          | NONE => error ("Unknown code target language: " ^ quote target);
haftmann@38927
   308
      in case the_description data
haftmann@55147
   309
       of Fundamental _ => (I, data)
haftmann@38927
   310
        | Extension (super, modify) => let
haftmann@39817
   311
            val (modify', data') = collapse super
haftmann@55147
   312
          in (modify' #> modify, merge_target false target (data', data)) end
haftmann@38927
   313
      end;
haftmann@39817
   314
  in collapse end;
haftmann@39817
   315
haftmann@39817
   316
local
haftmann@39817
   317
haftmann@55757
   318
fun activate_target ctxt target =
haftmann@39817
   319
  let
haftmann@55757
   320
    val thy = Proof_Context.theory_of ctxt;
haftmann@54890
   321
    val (_, default_width) = Targets.get thy;
haftmann@55757
   322
    val (modify, data) = collapse_hierarchy ctxt target;
haftmann@54890
   323
  in (default_width, data, modify) end;
haftmann@38927
   324
haftmann@55757
   325
fun project_program ctxt syms_hidden syms1 program2 =
haftmann@38927
   326
  let
haftmann@55147
   327
    val syms2 = subtract (op =) syms_hidden syms1;
haftmann@55147
   328
    val program3 = Code_Symbol.Graph.restrict (not o member (op =) syms_hidden) program2;
haftmann@55147
   329
    val syms4 = Code_Symbol.Graph.all_succs program3 syms2;
haftmann@54890
   330
    val unimplemented = Code_Thingol.unimplemented program3;
wenzelm@42359
   331
    val _ =
haftmann@54889
   332
      if null unimplemented then ()
wenzelm@42359
   333
      else error ("No code equations for " ^
wenzelm@55304
   334
        commas (map (Proof_Context.markup_const ctxt) unimplemented));
haftmann@55147
   335
    val program4 = Code_Symbol.Graph.restrict (member (op =) syms4) program3;
haftmann@55147
   336
  in (syms4, program4) end;
haftmann@38927
   337
haftmann@55757
   338
fun prepare_serializer ctxt (serializer : serializer) reserved identifiers
haftmann@55147
   339
    printings module_name args proto_program syms =
haftmann@38927
   340
  let
haftmann@55149
   341
    val syms_hidden = Code_Symbol.symbols_of printings;
haftmann@55757
   342
    val (syms_all, program) = project_program ctxt syms_hidden syms proto_program;
haftmann@39484
   343
    fun select_include (name, (content, cs)) =
haftmann@55150
   344
      if null cs orelse exists (fn c => member (op =) syms_all (Constant c)) cs
haftmann@39484
   345
      then SOME (name, content) else NONE;
haftmann@52137
   346
    val includes = map_filter select_include (Code_Symbol.dest_module_data printings);
haftmann@34021
   347
  in
haftmann@55757
   348
    (serializer args ctxt {
haftmann@52138
   349
      module_name = module_name,
haftmann@38926
   350
      reserved_syms = reserved,
haftmann@52138
   351
      identifiers = identifiers,
haftmann@38926
   352
      includes = includes,
haftmann@55149
   353
      const_syntax = Code_Symbol.lookup_constant_data printings,
haftmann@55149
   354
      tyco_syntax = Code_Symbol.lookup_type_constructor_data printings,
haftmann@55149
   355
      class_syntax = Code_Symbol.lookup_type_class_data printings },
haftmann@55776
   356
      (subtract (op =) syms_hidden syms, program))
haftmann@34021
   357
  end;
haftmann@34021
   358
haftmann@55757
   359
fun mount_serializer ctxt target some_width module_name args program syms =
haftmann@34021
   360
  let
haftmann@55757
   361
    val (default_width, data, modify) = activate_target ctxt target;
haftmann@38921
   362
    val serializer = case the_description data
haftmann@38927
   363
     of Fundamental seri => #serializer seri;
haftmann@55683
   364
    val (prepared_serializer, (prepared_syms, prepared_program)) =
haftmann@55757
   365
      prepare_serializer ctxt serializer
haftmann@52138
   366
        (the_reserved data) (the_identifiers data) (the_printings data)
haftmann@55147
   367
        module_name args (modify program) syms
haftmann@34071
   368
    val width = the_default default_width some_width;
haftmann@55683
   369
  in (fn program => fn syms => prepared_serializer syms program width, (prepared_syms, prepared_program)) end;
haftmann@41344
   370
haftmann@55757
   371
fun invoke_serializer ctxt target some_width raw_module_name args program all_public syms =
haftmann@41344
   372
  let
haftmann@55291
   373
    val module_name = if raw_module_name = "" then ""
haftmann@55291
   374
      else (check_name true raw_module_name; raw_module_name)
haftmann@55757
   375
    val (mounted_serializer, (prepared_syms, prepared_program)) =
haftmann@55757
   376
      mount_serializer ctxt target some_width module_name args program syms;
haftmann@55776
   377
  in mounted_serializer prepared_program (if all_public then [] else prepared_syms) end;
haftmann@34021
   378
haftmann@52138
   379
fun assert_module_name "" = error "Empty module name not allowed here"
haftmann@38933
   380
  | assert_module_name module_name = module_name;
haftmann@38933
   381
haftmann@55757
   382
fun using_master_directory ctxt =
haftmann@55757
   383
  Option.map (Path.append (File.pwd ()) o Path.append (Thy_Load.master_directory (Proof_Context.theory_of ctxt)));
haftmann@48371
   384
haftmann@34021
   385
in
haftmann@34021
   386
haftmann@48568
   387
val generatedN = "Generated_Code";
haftmann@48568
   388
haftmann@55757
   389
fun export_code_for ctxt some_path target some_width module_name args =
haftmann@55757
   390
  export (using_master_directory ctxt some_path)
haftmann@55757
   391
  ooo invoke_serializer ctxt target some_width module_name args;
haftmann@38918
   392
haftmann@55757
   393
fun produce_code_for ctxt target some_width module_name args =
haftmann@39102
   394
  let
haftmann@55757
   395
    val serializer = invoke_serializer ctxt target some_width (assert_module_name module_name) args;
haftmann@55683
   396
  in fn program => fn all_public => fn syms =>
haftmann@55683
   397
    produce (serializer program all_public syms) |> apsnd (fn deresolve => map deresolve syms)
haftmann@39484
   398
  end;
haftmann@38929
   399
haftmann@55757
   400
fun present_code_for ctxt target some_width module_name args =
haftmann@39484
   401
  let
haftmann@55757
   402
    val serializer = invoke_serializer ctxt target some_width (assert_module_name module_name) args;
haftmann@55147
   403
  in fn program => fn (syms, selects) =>
haftmann@55683
   404
    present selects (serializer program false syms)
haftmann@39484
   405
  end;
haftmann@38918
   406
haftmann@55757
   407
fun check_code_for ctxt target strict args program all_public syms =
haftmann@37824
   408
  let
haftmann@37824
   409
    val { env_var, make_destination, make_command } =
haftmann@55757
   410
      (#check o the_fundamental ctxt) target;
wenzelm@41939
   411
    fun ext_check p =
wenzelm@43564
   412
      let
haftmann@37824
   413
        val destination = make_destination p;
haftmann@55757
   414
        val _ = export (SOME destination) (invoke_serializer ctxt target (SOME 80)
haftmann@55683
   415
          generatedN args program all_public syms);
haftmann@48568
   416
        val cmd = make_command generatedN;
wenzelm@43850
   417
      in
wenzelm@43850
   418
        if Isabelle_System.bash ("cd " ^ File.shell_path p ^ " && " ^ cmd ^ " 2>&1") <> 0
haftmann@37824
   419
        then error ("Code check failed for " ^ target ^ ": " ^ cmd)
haftmann@37824
   420
        else ()
haftmann@37824
   421
      end;
wenzelm@43850
   422
  in
wenzelm@43850
   423
    if getenv env_var = ""
haftmann@37825
   424
    then if strict
haftmann@37825
   425
      then error (env_var ^ " not set; cannot check code for " ^ target)
haftmann@37825
   426
      else warning (env_var ^ " not set; skipped checking code for " ^ target)
wenzelm@41939
   427
    else Isabelle_System.with_tmp_dir "Code_Test" ext_check
haftmann@37824
   428
  end;
haftmann@37824
   429
haftmann@55684
   430
fun evaluation mounted_serializer prepared_program syms all_public ((vs, ty), t) =
haftmann@41344
   431
  let
haftmann@41344
   432
    val _ = if Code_Thingol.contains_dict_var t then
haftmann@41344
   433
      error "Term to be evaluated contains free dictionaries" else ();
wenzelm@43324
   434
    val v' = singleton (Name.variant_list (map fst vs)) "a";
haftmann@41344
   435
    val vs' = (v', []) :: vs;
haftmann@55147
   436
    val ty' = ITyVar v' `-> ty;
haftmann@41344
   437
    val program = prepared_program
haftmann@55147
   438
      |> Code_Symbol.Graph.new_node (Code_Symbol.value,
haftmann@55147
   439
          Code_Thingol.Fun (((vs', ty'), [(([IVar NONE], t), (NONE, true))]), NONE))
haftmann@55147
   440
      |> fold (curry (perhaps o try o
haftmann@55147
   441
          Code_Symbol.Graph.add_edge) Code_Symbol.value) syms;
haftmann@55683
   442
    val (program_code, deresolve) =
haftmann@55684
   443
      produce (mounted_serializer program (if all_public then [] else [Code_Symbol.value]));
haftmann@55147
   444
    val value_name = the (deresolve Code_Symbol.value);
haftmann@55147
   445
  in (program_code, value_name) end;
haftmann@41344
   446
haftmann@55757
   447
fun evaluator ctxt target program syms =
haftmann@41344
   448
  let
haftmann@55683
   449
    val (mounted_serializer, (_, prepared_program)) =
haftmann@55757
   450
      mount_serializer ctxt target NONE generatedN [] program syms;
haftmann@55147
   451
  in evaluation mounted_serializer prepared_program syms end;
haftmann@41344
   452
haftmann@34021
   453
end; (* local *)
haftmann@34021
   454
haftmann@34021
   455
haftmann@34021
   456
(* code generation *)
haftmann@34021
   457
haftmann@38918
   458
fun prep_destination "" = NONE
haftmann@38918
   459
  | prep_destination s = SOME (Path.explode s);
haftmann@38918
   460
haftmann@55757
   461
fun export_code ctxt all_public cs seris =
haftmann@34021
   462
  let
haftmann@55757
   463
    val thy = Proof_Context.theory_of ctxt;
haftmann@55188
   464
    val program = Code_Thingol.consts_program thy cs;
haftmann@38918
   465
    val _ = map (fn (((target, module_name), some_path), args) =>
haftmann@55757
   466
      export_code_for ctxt some_path target NONE module_name args program all_public (map Constant cs)) seris;
haftmann@34021
   467
  in () end;
haftmann@34021
   468
haftmann@55757
   469
fun export_code_cmd all_public raw_cs seris ctxt =
haftmann@55757
   470
  export_code ctxt all_public
haftmann@55757
   471
    (Code_Thingol.read_const_exprs ctxt raw_cs)
haftmann@55683
   472
    ((map o apfst o apsnd) prep_destination seris);
haftmann@38918
   473
haftmann@55757
   474
fun produce_code ctxt all_public cs target some_width some_module_name args =
haftmann@38918
   475
  let
haftmann@55757
   476
    val thy = Proof_Context.theory_of ctxt;
haftmann@55188
   477
    val program = Code_Thingol.consts_program thy cs;
haftmann@55757
   478
  in produce_code_for ctxt target some_width some_module_name args program all_public (map Constant cs) end;
haftmann@38929
   479
haftmann@55757
   480
fun present_code ctxt cs syms target some_width some_module_name args =
haftmann@38929
   481
  let
haftmann@55757
   482
    val thy = Proof_Context.theory_of ctxt;
haftmann@55188
   483
    val program = Code_Thingol.consts_program thy cs;
haftmann@55757
   484
  in present_code_for ctxt target some_width some_module_name args program (map Constant cs, syms) end;
haftmann@34021
   485
haftmann@55757
   486
fun check_code ctxt all_public cs seris =
haftmann@37824
   487
  let
haftmann@55757
   488
    val thy = Proof_Context.theory_of ctxt;
haftmann@55188
   489
    val program = Code_Thingol.consts_program thy cs;
haftmann@38918
   490
    val _ = map (fn ((target, strict), args) =>
haftmann@55757
   491
      check_code_for ctxt target strict args program all_public (map Constant cs)) seris;
haftmann@37824
   492
  in () end;
haftmann@37824
   493
haftmann@55757
   494
fun check_code_cmd all_public raw_cs seris ctxt =
haftmann@55757
   495
  check_code ctxt all_public
haftmann@55757
   496
    (Code_Thingol.read_const_exprs ctxt raw_cs) seris;
haftmann@37824
   497
haftmann@39480
   498
local
haftmann@39480
   499
haftmann@39480
   500
val parse_const_terms = Scan.repeat1 Args.term
haftmann@55757
   501
  >> (fn ts => fn ctxt => map (Code.check_const (Proof_Context.theory_of ctxt)) ts);
haftmann@39480
   502
haftmann@55147
   503
fun parse_names category parse internalize mark_symbol =
haftmann@39480
   504
  Scan.lift (Args.parens (Args.$$$ category)) |-- Scan.repeat1 parse
haftmann@55757
   505
  >> (fn xs => fn ctxt => map (mark_symbol o internalize ctxt) xs);
wenzelm@43564
   506
haftmann@39480
   507
val parse_consts = parse_names "consts" Args.term
haftmann@55757
   508
  (Code.check_const o Proof_Context.theory_of) Constant;
haftmann@39480
   509
haftmann@39480
   510
val parse_types = parse_names "types" (Scan.lift Args.name)
haftmann@55757
   511
  (Sign.intern_type o Proof_Context.theory_of) Type_Constructor;
haftmann@39480
   512
haftmann@39480
   513
val parse_classes = parse_names "classes" (Scan.lift Args.name)
haftmann@55757
   514
  (Sign.intern_class o Proof_Context.theory_of) Type_Class;
haftmann@39480
   515
haftmann@39480
   516
val parse_instances = parse_names "instances" (Scan.lift (Args.name --| Args.$$$ "::" -- Args.name))
haftmann@55757
   517
  (fn ctxt => fn (raw_tyco, raw_class) =>
haftmann@55757
   518
    let
haftmann@55757
   519
      val thy = Proof_Context.theory_of ctxt;
haftmann@55757
   520
    in (Sign.intern_class thy raw_tyco, Sign.intern_type thy raw_class) end) Class_Instance;
haftmann@39480
   521
haftmann@39480
   522
in
haftmann@39480
   523
wenzelm@43564
   524
val antiq_setup =
wenzelm@43564
   525
  Thy_Output.antiquotation @{binding code_stmts}
wenzelm@43564
   526
    (parse_const_terms --
wenzelm@43564
   527
      Scan.repeat (parse_consts || parse_types || parse_classes || parse_instances)
wenzelm@43564
   528
      -- Scan.lift (Args.parens (Args.name -- Scan.option Parse.int)))
wenzelm@43564
   529
    (fn {context = ctxt, ...} => fn ((mk_cs, mk_stmtss), (target, some_width)) =>
haftmann@55757
   530
        present_code ctxt (mk_cs ctxt)
haftmann@55757
   531
          (maps (fn f => f ctxt) mk_stmtss)
haftmann@55757
   532
          target some_width "Example" []);
haftmann@39480
   533
haftmann@39480
   534
end;
haftmann@39480
   535
haftmann@34021
   536
haftmann@28054
   537
(** serializer configuration **)
haftmann@27000
   538
haftmann@52138
   539
(* reserved symbol names *)
haftmann@52138
   540
haftmann@52138
   541
fun add_reserved target sym thy =
haftmann@52138
   542
  let
haftmann@55757
   543
    val (_, data) = collapse_hierarchy (Proof_Context.init_global thy) target;
haftmann@52138
   544
    val _ = if member (op =) (the_reserved data) sym
haftmann@52138
   545
      then error ("Reserved symbol " ^ quote sym ^ " already declared")
haftmann@52138
   546
      else ();
haftmann@52138
   547
  in
haftmann@52138
   548
    thy
haftmann@52138
   549
    |> map_reserved target (insert (op =) sym)
haftmann@52138
   550
  end;
haftmann@52138
   551
haftmann@52138
   552
haftmann@52377
   553
(* checking of syntax *)
haftmann@52138
   554
haftmann@55757
   555
fun check_const_syntax ctxt target c syn =
haftmann@55757
   556
  if Code_Printer.requires_args syn > Code.args_number (Proof_Context.theory_of ctxt) c
haftmann@52137
   557
  then error ("Too many arguments in syntax for constant " ^ quote c)
haftmann@55757
   558
  else Code_Printer.prep_const_syntax (Proof_Context.theory_of ctxt) (the_literals ctxt target) c syn;
haftmann@52137
   559
haftmann@55757
   560
fun check_tyco_syntax ctxt target tyco syn =
haftmann@55757
   561
  if fst syn <> Sign.arity_number (Proof_Context.theory_of ctxt) tyco
haftmann@52137
   562
  then error ("Number of arguments mismatch in syntax for type constructor " ^ quote tyco)
haftmann@52137
   563
  else syn;
haftmann@34071
   564
haftmann@52138
   565
haftmann@52138
   566
(* custom symbol names *)
haftmann@52138
   567
wenzelm@52218
   568
fun arrange_name_decls x =
haftmann@52138
   569
  let
haftmann@52138
   570
    fun arrange is_module (sym, target_names) = map (fn (target, some_name) =>
haftmann@52138
   571
      (target, (sym, Option.map (check_name is_module) some_name))) target_names;
haftmann@52138
   572
  in
haftmann@52138
   573
    Code_Symbol.maps_attr' (arrange false) (arrange false) (arrange false)
wenzelm@52218
   574
      (arrange false) (arrange false) (arrange true) x
haftmann@52138
   575
  end;
haftmann@52138
   576
haftmann@55757
   577
fun cert_name_decls ctxt = cert_syms ctxt #> arrange_name_decls;
haftmann@52138
   578
haftmann@55757
   579
fun read_name_decls ctxt = read_syms ctxt #> arrange_name_decls;
haftmann@52138
   580
haftmann@52138
   581
fun set_identifier (target, sym_name) = map_identifiers target (Code_Symbol.set_data sym_name);
haftmann@52138
   582
haftmann@52138
   583
fun gen_set_identifiers prep_name_decl raw_name_decls thy =
haftmann@55757
   584
  fold set_identifier (prep_name_decl (Proof_Context.init_global thy) raw_name_decls) thy;
haftmann@52138
   585
haftmann@52138
   586
val set_identifiers = gen_set_identifiers cert_name_decls;
haftmann@52138
   587
val set_identifiers_cmd = gen_set_identifiers read_name_decls;
haftmann@52138
   588
haftmann@52138
   589
haftmann@52138
   590
(* custom printings *)
haftmann@52138
   591
haftmann@55757
   592
fun arrange_printings prep_const ctxt =
haftmann@52137
   593
  let
haftmann@52137
   594
    fun arrange check (sym, target_syns) =
haftmann@55757
   595
      map (fn (target, some_syn) => (target, (sym, Option.map (check ctxt target sym) some_syn))) target_syns;
haftmann@52137
   596
  in
haftmann@52137
   597
    Code_Symbol.maps_attr'
haftmann@52137
   598
      (arrange check_const_syntax) (arrange check_tyco_syntax)
haftmann@55149
   599
        (arrange ((K o K o K) I)) (arrange ((K o K o K) I)) (arrange ((K o K o K) I))
haftmann@55757
   600
        (arrange (fn ctxt => fn _ => fn _ => fn (raw_content, raw_cs) =>
haftmann@55757
   601
          (Code_Printer.str raw_content, map (prep_const ctxt) raw_cs)))
haftmann@52137
   602
  end;
haftmann@52137
   603
haftmann@55757
   604
fun cert_printings ctxt = cert_syms ctxt #> arrange_printings cert_const ctxt;
haftmann@24219
   605
haftmann@55757
   606
fun read_printings ctxt = read_syms ctxt #> arrange_printings read_const ctxt;
haftmann@52137
   607
haftmann@52137
   608
fun set_printing (target, sym_syn) = map_printings target (Code_Symbol.set_data sym_syn);
haftmann@52137
   609
haftmann@52137
   610
fun gen_set_printings prep_print_decl raw_print_decls thy =
haftmann@55757
   611
  fold set_printing (prep_print_decl (Proof_Context.init_global thy) raw_print_decls) thy;
haftmann@52137
   612
haftmann@52137
   613
val set_printings = gen_set_printings cert_printings;
haftmann@52137
   614
val set_printings_cmd = gen_set_printings read_printings;
haftmann@52137
   615
haftmann@52137
   616
haftmann@27103
   617
(* concrete syntax *)
haftmann@27000
   618
haftmann@28054
   619
fun parse_args f args =
wenzelm@36959
   620
  case Scan.read Token.stopper f args
haftmann@28054
   621
   of SOME x => x
haftmann@28054
   622
    | NONE => error "Bad serializer arguments";
haftmann@28054
   623
haftmann@28054
   624
haftmann@27304
   625
(** Isar setup **)
haftmann@27103
   626
haftmann@52137
   627
fun parse_single_symbol_pragma parse_keyword parse_isa parse_target =
haftmann@52434
   628
  parse_keyword |-- Parse.!!! (parse_isa --| (@{keyword "\<rightharpoonup>"} || @{keyword "=>"})
haftmann@52434
   629
    -- Parse.and_list1 (@{keyword "("} |-- (Parse.name --| @{keyword ")"} -- Scan.option parse_target)));
haftmann@52137
   630
haftmann@52137
   631
fun parse_symbol_pragma parse_const parse_tyco parse_class parse_classrel parse_inst parse_module =
wenzelm@52801
   632
  parse_single_symbol_pragma @{keyword "constant"} Parse.term parse_const
haftmann@55150
   633
    >> Constant
haftmann@52377
   634
  || parse_single_symbol_pragma @{keyword "type_constructor"} Parse.type_const parse_tyco
haftmann@55150
   635
    >> Type_Constructor
haftmann@52377
   636
  || parse_single_symbol_pragma @{keyword "type_class"} Parse.class parse_class
haftmann@55150
   637
    >> Type_Class
haftmann@52137
   638
  || parse_single_symbol_pragma @{keyword "class_relation"} parse_classrel_ident parse_classrel
haftmann@55150
   639
    >> Class_Relation
haftmann@52137
   640
  || parse_single_symbol_pragma @{keyword "class_instance"} parse_inst_ident parse_inst
haftmann@55150
   641
    >> Class_Instance
haftmann@52137
   642
  || parse_single_symbol_pragma @{keyword "code_module"} Parse.name parse_module
haftmann@52137
   643
    >> Code_Symbol.Module;
haftmann@52137
   644
haftmann@52137
   645
fun parse_symbol_pragmas parse_const parse_tyco parse_class parse_classrel parse_inst parse_module =
haftmann@52137
   646
  Parse.enum1 "|" (Parse.group (fn () => "code symbol pragma")
haftmann@52137
   647
    (parse_symbol_pragma parse_const parse_tyco parse_class parse_classrel parse_inst parse_module));
haftmann@52137
   648
haftmann@52138
   649
val code_expr_argsP = Scan.optional (@{keyword "("} |-- Args.parse --| @{keyword ")"}) [];
haftmann@52138
   650
haftmann@55683
   651
fun code_expr_inP all_public raw_cs =
haftmann@52434
   652
  Scan.repeat (@{keyword "in"} |-- Parse.!!! (Parse.name
haftmann@52434
   653
    -- Scan.optional (@{keyword "module_name"} |-- Parse.name) ""
haftmann@52434
   654
    -- Scan.optional (@{keyword "file"} |-- Parse.name) ""
haftmann@52434
   655
    -- code_expr_argsP))
haftmann@55683
   656
      >> (fn seri_args => export_code_cmd all_public raw_cs seri_args);
haftmann@52434
   657
haftmann@55683
   658
fun code_expr_checkingP all_public raw_cs =
haftmann@52434
   659
  (@{keyword "checking"} |-- Parse.!!!
haftmann@52434
   660
    (Scan.repeat (Parse.name -- ((@{keyword "?"} |-- Scan.succeed false) || Scan.succeed true)
haftmann@52434
   661
    -- code_expr_argsP)))
haftmann@55683
   662
      >> (fn seri_args => check_code_cmd all_public raw_cs seri_args);
haftmann@52434
   663
haftmann@55683
   664
val code_exprP = (Scan.optional (@{keyword "open"} |-- Scan.succeed true) false
haftmann@55683
   665
  -- Scan.repeat1 Parse.term)
haftmann@55683
   666
  :|-- (fn (all_public, raw_cs) => (code_expr_checkingP all_public raw_cs || code_expr_inP all_public raw_cs));
haftmann@52138
   667
haftmann@52138
   668
val _ =
haftmann@52138
   669
  Outer_Syntax.command @{command_spec "code_reserved"}
haftmann@52138
   670
    "declare words as reserved for target language"
haftmann@52138
   671
    (Parse.name -- Scan.repeat1 Parse.name
haftmann@52138
   672
      >> (fn (target, reserveds) => (Toplevel.theory o fold (add_reserved target)) reserveds));
haftmann@52138
   673
haftmann@52138
   674
val _ =
haftmann@52138
   675
  Outer_Syntax.command @{command_spec "code_identifier"} "declare mandatory names for code symbols"
haftmann@52138
   676
    (parse_symbol_pragmas Parse.name Parse.name Parse.name Parse.name Parse.name Parse.name
haftmann@52138
   677
      >> (Toplevel.theory o fold set_identifiers_cmd));
haftmann@52138
   678
haftmann@52138
   679
val _ =
haftmann@52137
   680
  Outer_Syntax.command @{command_spec "code_printing"} "declare dedicated printing for code symbols"
haftmann@52137
   681
    (parse_symbol_pragmas (Code_Printer.parse_const_syntax) (Code_Printer.parse_tyco_syntax)
haftmann@52137
   682
      Parse.string (Parse.minus >> K ()) (Parse.minus >> K ())
haftmann@52137
   683
      (Parse.text -- Scan.optional (@{keyword "attach"} |-- Scan.repeat1 Parse.term) [])
haftmann@52137
   684
      >> (Toplevel.theory o fold set_printings_cmd));
haftmann@52137
   685
haftmann@52137
   686
val _ =
wenzelm@46961
   687
  Outer_Syntax.command @{command_spec "export_code"} "generate executable code for constants"
haftmann@55757
   688
    (Parse.!!! code_exprP >> (fn f => Toplevel.keep (f o Toplevel.context_of)));
haftmann@30494
   689
haftmann@39646
   690
haftmann@39646
   691
(** external entrance point -- for codegen tool **)
haftmann@39646
   692
haftmann@39750
   693
fun codegen_tool thyname cmd_expr =
haftmann@39646
   694
  let
haftmann@55757
   695
    val ctxt = Proof_Context.init_global (Thy_Info.get_theory thyname);
haftmann@39646
   696
    val parse = Scan.read Token.stopper (Parse.!!! code_exprP) o
haftmann@39646
   697
      (filter Token.is_proper o Outer_Syntax.scan Position.none);
haftmann@39646
   698
  in case parse cmd_expr
haftmann@55757
   699
   of SOME f => (writeln "Now generating code..."; f ctxt)
haftmann@39646
   700
    | NONE => error ("Bad directive " ^ quote cmd_expr)
haftmann@39646
   701
  end;
haftmann@39646
   702
wenzelm@43564
   703
wenzelm@43564
   704
(** theory setup **)
wenzelm@43564
   705
wenzelm@43564
   706
val setup = antiq_setup;
wenzelm@43564
   707
haftmann@24219
   708
end; (*struct*)