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