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