1 (* Title: Tools/code/code_target.ML
2 Author: Florian Haftmann, TU Muenchen
4 Serializer from intermediate language ("Thin-gol") to target languages.
7 signature CODE_TARGET =
12 val add_target: string * (serializer * literals) -> theory -> theory
13 val extend_target: string *
14 (string * (Code_Thingol.naming -> Code_Thingol.program -> Code_Thingol.program))
16 val assert_target: theory -> string -> string
20 val parse_args: (OuterLex.token list -> 'a * OuterLex.token list)
21 -> OuterLex.token list -> 'a
22 val stmt_names_of_destination: destination -> string list
23 val code_of_pretty: Pretty.T -> string
24 val code_writeln: Pretty.T -> unit
25 val mk_serialization: string -> ('a -> unit) option
26 -> (Path.T option -> 'a -> unit)
27 -> ('a -> string * string option list)
28 -> 'a -> serialization
29 val serialize: theory -> string -> string option -> OuterLex.token list
30 -> Code_Thingol.naming -> Code_Thingol.program -> string list -> serialization
31 val serialize_custom: theory -> string * (serializer * literals)
32 -> Code_Thingol.naming -> Code_Thingol.program -> string list -> string * string option list
33 val the_literals: theory -> string -> literals
34 val compile: serialization -> unit
35 val export: serialization -> unit
36 val file: Path.T -> serialization -> unit
37 val string: string list -> serialization -> string
38 val code_of: theory -> string -> string
39 -> string list -> (Code_Thingol.naming -> string list) -> string
40 val shell_command: string (*theory name*) -> string (*export_code expr*) -> unit
41 val code_width: int ref
43 val allow_abort: string -> theory -> theory
44 val add_syntax_class: string -> class -> string option -> theory -> theory
45 val add_syntax_inst: string -> string * class -> bool -> theory -> theory
46 val add_syntax_tyco: string -> string -> tyco_syntax option -> theory -> theory
47 val add_syntax_const: string -> string -> const_syntax option -> theory -> theory
48 val add_reserved: string -> string -> theory -> theory
51 structure Code_Target : CODE_TARGET =
54 open Basic_Code_Thingol;
59 datatype destination = Compile | Export | File of Path.T | String of string list;
60 type serialization = destination -> (string * string option list) option;
62 val code_width = ref 80; (*FIXME after Pretty module no longer depends on print mode*)
63 fun code_setmp f = PrintMode.setmp [] (Pretty.setmp_margin (!code_width) f);
64 fun code_of_pretty p = code_setmp Pretty.string_of p ^ "\n";
65 fun code_writeln p = Pretty.setmp_margin (!code_width) Pretty.writeln p;
67 (*FIXME why another code_setmp?*)
68 fun compile f = (code_setmp f Compile; ());
69 fun export f = (code_setmp f Export; ());
70 fun file p f = (code_setmp f (File p); ());
71 fun string stmts f = fst (the (code_setmp f (String stmts)));
73 fun stmt_names_of_destination (String stmts) = stmts
74 | stmt_names_of_destination _ = [];
76 fun mk_serialization target (SOME comp) _ _ code Compile = (comp code; NONE)
77 | mk_serialization target NONE _ _ _ Compile = error (target ^ ": no internal compilation")
78 | mk_serialization target _ output _ code Export = (output NONE code ; NONE)
79 | mk_serialization target _ output _ code (File file) = (output (SOME file) code; NONE)
80 | mk_serialization target _ _ string code (String _) = SOME (string code);
85 datatype name_syntax_table = NameSyntaxTable of {
86 class: string Symtab.table,
87 instance: unit Symreltab.table,
88 tyco: tyco_syntax Symtab.table,
89 const: const_syntax Symtab.table
92 fun mk_name_syntax_table ((class, instance), (tyco, const)) =
93 NameSyntaxTable { class = class, instance = instance, tyco = tyco, const = const };
94 fun map_name_syntax_table f (NameSyntaxTable { class, instance, tyco, const }) =
95 mk_name_syntax_table (f ((class, instance), (tyco, const)));
96 fun merge_name_syntax_table (NameSyntaxTable { class = class1, instance = instance1, tyco = tyco1, const = const1 },
97 NameSyntaxTable { class = class2, instance = instance2, tyco = tyco2, const = const2 }) =
98 mk_name_syntax_table (
99 (Symtab.join (K snd) (class1, class2),
100 Symreltab.join (K snd) (instance1, instance2)),
101 (Symtab.join (K snd) (tyco1, tyco2),
102 Symtab.join (K snd) (const1, const2))
106 string option (*module name*)
107 -> OuterLex.token list (*arguments*)
108 -> (string -> string) (*labelled_name*)
109 -> string list (*reserved symbols*)
110 -> (string * Pretty.T) list (*includes*)
111 -> (string -> string option) (*module aliasses*)
112 -> (string -> string option) (*class syntax*)
113 -> (string -> tyco_syntax option)
114 -> (string -> const_syntax option)
115 -> Code_Thingol.naming
116 -> Code_Thingol.program
117 -> string list (*selected statements*)
120 datatype serializer_entry = Serializer of serializer * literals
121 | Extends of string * (Code_Thingol.naming -> Code_Thingol.program -> Code_Thingol.program);
123 datatype target = Target of {
125 serializer: serializer_entry,
126 reserved: string list,
127 includes: (Pretty.T * string list) Symtab.table,
128 name_syntax_table: name_syntax_table,
129 module_alias: string Symtab.table
132 fun mk_target ((serial, serializer), ((reserved, includes), (name_syntax_table, module_alias))) =
133 Target { serial = serial, serializer = serializer, reserved = reserved,
134 includes = includes, name_syntax_table = name_syntax_table, module_alias = module_alias };
135 fun map_target f ( Target { serial, serializer, reserved, includes, name_syntax_table, module_alias } ) =
136 mk_target (f ((serial, serializer), ((reserved, includes), (name_syntax_table, module_alias))));
137 fun merge_target strict target (Target { serial = serial1, serializer = serializer,
138 reserved = reserved1, includes = includes1,
139 name_syntax_table = name_syntax_table1, module_alias = module_alias1 },
140 Target { serial = serial2, serializer = _,
141 reserved = reserved2, includes = includes2,
142 name_syntax_table = name_syntax_table2, module_alias = module_alias2 }) =
143 if serial1 = serial2 orelse not strict then
144 mk_target ((serial1, serializer),
145 ((merge (op =) (reserved1, reserved2), Symtab.merge (op =) (includes1, includes2)),
146 (merge_name_syntax_table (name_syntax_table1, name_syntax_table2),
147 Symtab.join (K snd) (module_alias1, module_alias2))
150 error ("Incompatible serializers: " ^ quote target);
152 structure CodeTargetData = TheoryDataFun
154 type T = target Symtab.table * string list;
155 val empty = (Symtab.empty, []);
158 fun merge _ ((target1, exc1) : T, (target2, exc2)) =
159 (Symtab.join (merge_target true) (target1, target2), Library.merge (op =) (exc1, exc2));
162 fun the_serializer (Target { serializer, ... }) = serializer;
163 fun the_reserved (Target { reserved, ... }) = reserved;
164 fun the_includes (Target { includes, ... }) = includes;
165 fun the_name_syntax (Target { name_syntax_table = NameSyntaxTable x, ... }) = x;
166 fun the_module_alias (Target { module_alias , ... }) = module_alias;
168 val abort_allowed = snd o CodeTargetData.get;
170 fun assert_target thy target =
171 case Symtab.lookup (fst (CodeTargetData.get thy)) target
172 of SOME data => target
173 | NONE => error ("Unknown code target language: " ^ quote target);
175 fun put_target (target, seri) thy =
177 val lookup_target = Symtab.lookup (fst (CodeTargetData.get thy));
179 of Extends (super, _) => if is_some (lookup_target super) then ()
180 else error ("Unknown code target language: " ^ quote super)
182 val overwriting = case (Option.map the_serializer o lookup_target) target
184 | SOME (Extends _) => true
185 | SOME (Serializer _) => (case seri
186 of Extends _ => error ("Will not overwrite existing target " ^ quote target)
188 val _ = if overwriting
189 then warning ("Overwriting existing target " ^ quote target)
193 |> (CodeTargetData.map o apfst oo Symtab.map_default)
194 (target, mk_target ((serial (), seri), (([], Symtab.empty),
195 (mk_name_syntax_table ((Symtab.empty, Symreltab.empty), (Symtab.empty, Symtab.empty)),
197 ((map_target o apfst o apsnd o K) seri)
200 fun add_target (target, seri) = put_target (target, Serializer seri);
201 fun extend_target (target, (super, modify)) =
202 put_target (target, Extends (super, modify));
204 fun map_target_data target f thy =
206 val _ = assert_target thy target;
209 |> (CodeTargetData.map o apfst o Symtab.map_entry target o map_target) f
212 fun map_reserved target =
213 map_target_data target o apsnd o apfst o apfst;
214 fun map_includes target =
215 map_target_data target o apsnd o apfst o apsnd;
216 fun map_name_syntax target =
217 map_target_data target o apsnd o apsnd o apfst o map_name_syntax_table;
218 fun map_module_alias target =
219 map_target_data target o apsnd o apsnd o apsnd;
222 (** serializer configuration **)
228 fun cert_class thy class =
230 val _ = AxClass.get_info thy class;
233 fun read_class thy = cert_class thy o Sign.intern_class thy;
235 fun cert_tyco thy tyco =
237 val _ = if Sign.declared_tyname thy tyco then ()
238 else error ("No such type constructor: " ^ quote tyco);
241 fun read_tyco thy = cert_tyco thy o Sign.intern_type thy;
243 fun gen_add_syntax_class prep_class prep_const target raw_class raw_syn thy =
245 val class = prep_class thy raw_class;
249 |> (map_name_syntax target o apfst o apfst)
250 (Symtab.update (class, syntax))
253 |> (map_name_syntax target o apfst o apfst)
254 (Symtab.delete_safe class)
257 fun gen_add_syntax_inst prep_class prep_tyco target (raw_tyco, raw_class) add_del thy =
259 val inst = (prep_class thy raw_class, prep_tyco thy raw_tyco);
262 |> (map_name_syntax target o apfst o apsnd)
263 (Symreltab.update (inst, ()))
266 |> (map_name_syntax target o apfst o apsnd)
267 (Symreltab.delete_safe inst)
270 fun gen_add_syntax_tyco prep_tyco target raw_tyco raw_syn thy =
272 val tyco = prep_tyco thy raw_tyco;
273 fun check_args (syntax as (n, _)) = if n <> Sign.arity_number thy tyco
274 then error ("Number of arguments mismatch in syntax for type constructor " ^ quote tyco)
279 |> (map_name_syntax target o apsnd o apfst)
280 (Symtab.update (tyco, check_args syntax))
283 |> (map_name_syntax target o apsnd o apfst)
284 (Symtab.delete_safe tyco)
287 fun gen_add_syntax_const prep_const target raw_c raw_syn thy =
289 val c = prep_const thy raw_c;
290 fun check_args (syntax as (n, _)) = if n > Code_Unit.no_args thy c
291 then error ("Too many arguments in syntax for constant " ^ quote c)
296 |> (map_name_syntax target o apsnd o apsnd)
297 (Symtab.update (c, check_args syntax))
300 |> (map_name_syntax target o apsnd o apsnd)
301 (Symtab.delete_safe c)
304 fun add_reserved target =
306 fun add sym syms = if member (op =) syms sym
307 then error ("Reserved symbol " ^ quote sym ^ " already declared")
308 else insert (op =) sym syms
309 in map_reserved target o add end;
311 fun gen_add_include read_const target args thy =
313 fun add (name, SOME (content, raw_cs)) incls =
315 val _ = if Symtab.defined incls name
316 then warning ("Overwriting existing include " ^ name)
318 val cs = map (read_const thy) raw_cs;
319 in Symtab.update (name, (str content, cs)) incls end
320 | add (name, NONE) incls = Symtab.delete name incls;
321 in map_includes target (add args) thy end;
323 val add_include = gen_add_include Code_Unit.check_const;
324 val add_include_cmd = gen_add_include Code_Unit.read_const;
326 fun add_module_alias target (thyname, modlname) =
328 val xs = Long_Name.explode modlname;
329 val xs' = map (Code_Name.purify_name true) xs;
331 then map_module_alias target (Symtab.update (thyname, modlname))
332 else error ("Invalid module name: " ^ quote modlname ^ "\n"
333 ^ "perhaps try " ^ quote (Long_Name.implode xs'))
336 fun gen_allow_abort prep_const raw_c thy =
338 val c = prep_const thy raw_c;
339 in thy |> (CodeTargetData.map o apsnd) (insert (op =) c) end;
341 fun zip_list (x::xs) f g =
344 fold_map (fn x => g |-- f >> pair x) xs
345 #-> (fn xys => pair ((x, y) :: xys)));
348 (* concrete syntax *)
350 structure P = OuterParse
353 fun parse_multi_syntax parse_thing parse_syntax =
354 P.and_list1 parse_thing
355 #-> (fn things => Scan.repeat1 (P.$$$ "(" |-- P.name --
356 (zip_list things parse_syntax (P.$$$ "and")) --| P.$$$ ")"));
360 val add_syntax_class = gen_add_syntax_class cert_class (K I);
361 val add_syntax_inst = gen_add_syntax_inst cert_class cert_tyco;
362 val add_syntax_tyco = gen_add_syntax_tyco cert_tyco;
363 val add_syntax_const = gen_add_syntax_const (K I);
364 val allow_abort = gen_allow_abort (K I);
365 val add_reserved = add_reserved;
367 val add_syntax_class_cmd = gen_add_syntax_class read_class Code_Unit.read_const;
368 val add_syntax_inst_cmd = gen_add_syntax_inst read_class read_tyco;
369 val add_syntax_tyco_cmd = gen_add_syntax_tyco read_tyco;
370 val add_syntax_const_cmd = gen_add_syntax_const Code_Unit.read_const;
371 val allow_abort_cmd = gen_allow_abort Code_Unit.read_const;
373 fun the_literals thy =
375 val (targets, _) = CodeTargetData.get thy;
376 fun literals target = case Symtab.lookup targets target
377 of SOME data => (case the_serializer data
378 of Serializer (_, literals) => literals
379 | Extends (super, _) => literals super)
380 | NONE => error ("Unknown code target language: " ^ quote target);
384 (** serializer usage **)
390 fun labelled_name thy program name = case Graph.get_node program name
391 of Code_Thingol.Fun (c, _) => quote (Code_Unit.string_of_const thy c)
392 | Code_Thingol.Datatype (tyco, _) => "type " ^ quote (Sign.extern_type thy tyco)
393 | Code_Thingol.Datatypecons (c, _) => quote (Code_Unit.string_of_const thy c)
394 | Code_Thingol.Class (class, _) => "class " ^ quote (Sign.extern_class thy class)
395 | Code_Thingol.Classrel (sub, super) => let
396 val Code_Thingol.Class (sub, _) = Graph.get_node program sub
397 val Code_Thingol.Class (super, _) = Graph.get_node program super
398 in quote (Sign.extern_class thy sub ^ " < " ^ Sign.extern_class thy super) end
399 | Code_Thingol.Classparam (c, _) => quote (Code_Unit.string_of_const thy c)
400 | Code_Thingol.Classinst ((class, (tyco, _)), _) => let
401 val Code_Thingol.Class (class, _) = Graph.get_node program class
402 val Code_Thingol.Datatype (tyco, _) = Graph.get_node program tyco
403 in quote (Sign.extern_type thy tyco ^ " :: " ^ Sign.extern_class thy class) end
405 fun invoke_serializer thy abortable serializer reserved abs_includes
406 module_alias class instance tyco const module args naming program2 names1 =
408 fun distill_names lookup_name src_tab = Symtab.empty
409 |> fold_map (fn thing_identifier => fn tab => case lookup_name naming thing_identifier
410 of SOME name => (SOME name, Symtab.update_new (name, the (Symtab.lookup src_tab thing_identifier)) tab)
411 | NONE => (NONE, tab)) (Symtab.keys src_tab)
413 val (names_class, class') = distill_names Code_Thingol.lookup_class class;
414 val names_inst = map_filter (Code_Thingol.lookup_instance naming)
415 (Symreltab.keys instance);
416 val (names_tyco, tyco') = distill_names Code_Thingol.lookup_tyco tyco;
417 val (names_const, const') = distill_names Code_Thingol.lookup_const const;
418 val names_hidden = names_class @ names_inst @ names_tyco @ names_const;
419 val names2 = subtract (op =) names_hidden names1;
420 val program3 = Graph.subgraph (not o member (op =) names_hidden) program2;
421 val names_all = Graph.all_succs program3 names2;
422 val includes = abs_includes names_all;
423 val program4 = Graph.subgraph (member (op =) names_all) program3;
424 val empty_funs = filter_out (member (op =) abortable)
425 (Code_Thingol.empty_funs program3);
426 val _ = if null empty_funs then () else error ("No code equations for "
427 ^ commas (map (Sign.extern_const thy) empty_funs));
429 serializer module args (labelled_name thy program2) reserved includes
430 (Symtab.lookup module_alias) (Symtab.lookup class')
431 (Symtab.lookup tyco') (Symtab.lookup const')
432 naming program4 names2
435 fun mount_serializer thy alt_serializer target module args naming program names =
437 val (targets, abortable) = CodeTargetData.get thy;
438 fun collapse_hierarchy target =
440 val data = case Symtab.lookup targets target
442 | NONE => error ("Unknown code target language: " ^ quote target);
443 in case the_serializer data
444 of Serializer _ => (I, data)
445 | Extends (super, modify) => let
446 val (modify', data') = collapse_hierarchy super
447 in (modify' #> modify naming, merge_target false target (data', data)) end
449 val (modify, data) = collapse_hierarchy target;
450 val (serializer, _) = the_default (case the_serializer data
451 of Serializer seri => seri) alt_serializer;
452 val reserved = the_reserved data;
453 fun select_include names_all (name, (content, cs)) =
454 if null cs then SOME (name, content)
455 else if exists (fn c => case Code_Thingol.lookup_const naming c
456 of SOME name => member (op =) names_all name
458 then SOME (name, content) else NONE;
459 fun includes names_all = map_filter (select_include names_all)
460 ((Symtab.dest o the_includes) data);
461 val module_alias = the_module_alias data;
462 val { class, instance, tyco, const } = the_name_syntax data;
464 invoke_serializer thy abortable serializer reserved
465 includes module_alias class instance tyco const module args naming (modify program) names
470 fun serialize thy = mount_serializer thy NONE;
472 fun serialize_custom thy (target_name, seri) naming program names =
473 mount_serializer thy (SOME seri) target_name NONE [] naming program names (String [])
478 fun parse_args f args =
479 case Scan.read OuterLex.stopper f args
481 | NONE => error "Bad serializer arguments";
484 (* code presentation *)
486 fun code_of thy target module_name cs names_stmt =
488 val (names_cs, (naming, program)) = Code_Thingol.consts_program thy cs;
490 string (names_stmt naming) (serialize thy target (SOME module_name) []
491 naming program names_cs)
495 (* code generation *)
497 fun transitivly_non_empty_funs thy naming program =
499 val cs = subtract (op =) (abort_allowed thy) (Code_Thingol.empty_funs program);
500 val names = map_filter (Code_Thingol.lookup_const naming) cs;
501 in subtract (op =) (Graph.all_preds program names) (Graph.keys program) end;
503 fun read_const_exprs thy cs =
505 val (cs1, cs2) = Code_Name.read_const_exprs thy cs;
506 val (names3, (naming, program)) = Code_Thingol.consts_program thy cs2;
507 val names4 = transitivly_non_empty_funs thy naming program;
509 (fn (c, name) => if member (op =) names4 name then SOME c else NONE) (cs2 ~~ names3);
510 in fold (insert (op =)) cs5 cs1 end;
512 fun cached_program thy =
514 val (naming, program) = Code_Thingol.cached_program thy;
515 in (transitivly_non_empty_funs thy naming program, (naming, program)) end
517 fun export_code thy cs seris =
519 val (cs', (naming, program)) = if null cs then cached_program thy
520 else Code_Thingol.consts_program thy cs;
521 fun mk_seri_dest dest = case dest
524 | SOME f => file (Path.explode f)
525 val _ = map (fn (((target, module), dest), args) =>
526 (mk_seri_dest dest (serialize thy target module args naming program cs'))) seris;
529 fun export_code_cmd raw_cs seris thy = export_code thy (read_const_exprs thy raw_cs) seris;
534 val (inK, module_nameK, fileK) = ("in", "module_name", "file");
537 (Scan.repeat P.term_group
538 -- Scan.repeat (P.$$$ inK |-- P.name
539 -- Scan.option (P.$$$ module_nameK |-- P.name)
540 -- Scan.option (P.$$$ fileK |-- P.name)
541 -- Scan.optional (P.$$$ "(" |-- Args.parse --| P.$$$ ")") []
542 ) >> (fn (raw_cs, seris) => export_code_cmd raw_cs seris));
544 val _ = List.app OuterKeyword.keyword [inK, module_nameK, fileK];
547 OuterSyntax.command "code_class" "define code syntax for class" K.thy_decl (
548 parse_multi_syntax P.xname (Scan.option P.string)
549 >> (Toplevel.theory oo fold) (fn (target, syns) =>
550 fold (fn (raw_class, syn) => add_syntax_class_cmd target raw_class syn) syns)
554 OuterSyntax.command "code_instance" "define code syntax for instance" K.thy_decl (
555 parse_multi_syntax (P.xname --| P.$$$ "::" -- P.xname)
556 ((P.minus >> K true) || Scan.succeed false)
557 >> (Toplevel.theory oo fold) (fn (target, syns) =>
558 fold (fn (raw_inst, add_del) => add_syntax_inst_cmd target raw_inst add_del) syns)
562 OuterSyntax.command "code_type" "define code syntax for type constructor" K.thy_decl (
563 parse_multi_syntax P.xname (parse_syntax I)
564 >> (Toplevel.theory oo fold) (fn (target, syns) =>
565 fold (fn (raw_tyco, syn) => add_syntax_tyco_cmd target raw_tyco syn) syns)
569 OuterSyntax.command "code_const" "define code syntax for constant" K.thy_decl (
570 parse_multi_syntax P.term_group (parse_syntax fst)
571 >> (Toplevel.theory oo fold) (fn (target, syns) =>
572 fold (fn (raw_const, syn) => add_syntax_const_cmd target raw_const
573 (Code_Printer.simple_const_syntax syn)) syns)
577 OuterSyntax.command "code_reserved" "declare words as reserved for target language" K.thy_decl (
578 P.name -- Scan.repeat1 P.name
579 >> (fn (target, reserveds) => (Toplevel.theory o fold (add_reserved target)) reserveds)
583 OuterSyntax.command "code_include" "declare piece of code to be included in generated code" K.thy_decl (
584 P.name -- P.name -- (P.text :|-- (fn "-" => Scan.succeed NONE
585 | s => Scan.optional (P.$$$ "attach" |-- Scan.repeat1 P.term) [] >> pair s >> SOME))
586 >> (fn ((target, name), content_consts) =>
587 (Toplevel.theory o add_include_cmd target) (name, content_consts))
591 OuterSyntax.command "code_modulename" "alias module to other name" K.thy_decl (
592 P.name -- Scan.repeat1 (P.name -- P.name)
593 >> (fn (target, modlnames) => (Toplevel.theory o fold (add_module_alias target)) modlnames)
597 OuterSyntax.command "code_abort" "permit constant to be implemented as program abort" K.thy_decl (
598 Scan.repeat1 P.term_group >> (Toplevel.theory o fold allow_abort_cmd)
602 OuterSyntax.command "export_code" "generate executable code for constants"
603 K.diag (P.!!! code_exprP >> (fn f => Toplevel.keep (f o Toplevel.theory_of)));
605 fun shell_command thyname cmd = Toplevel.program (fn _ =>
606 (use_thy thyname; case Scan.read OuterLex.stopper (P.!!! code_exprP)
607 ((filter OuterLex.is_proper o OuterSyntax.scan Position.none) cmd)
608 of SOME f => (writeln "Now generating code..."; f (theory thyname))
609 | NONE => error ("Bad directive " ^ quote cmd)))
610 handle TOPLEVEL_ERROR => OS.Process.exit OS.Process.failure;