1 (* Title: Tools/Code/code_target.ML
2 Author: Florian Haftmann, TU Muenchen
4 Generic infrastructure for target language data.
7 signature CODE_TARGET =
9 val cert_tyco: theory -> string -> string
10 val read_tyco: theory -> string -> string
11 val read_const_exprs: theory -> string list -> string list
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) list * 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
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) list * 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
31 val generatedN: string
32 val evaluator: theory -> string -> Code_Thingol.naming -> Code_Thingol.program
33 -> string list -> ((string * class list) list * Code_Thingol.itype) * Code_Thingol.iterm
34 -> (string * string) list * string
37 type literals = Code_Printer.literals
38 val add_target: string * { serializer: serializer, literals: literals,
39 check: { env_var: string, make_destination: Path.T -> Path.T, make_command: string -> string } }
41 val extend_target: string *
42 (string * (Code_Thingol.naming -> Code_Thingol.program -> Code_Thingol.program))
44 val assert_target: theory -> string -> string
45 val the_literals: theory -> string -> literals
47 val parse_args: 'a parser -> Token.T list -> 'a
48 val serialization: (int -> Path.T option -> 'a -> unit)
49 -> (string list -> int -> 'a -> (string * string) list * (string -> string option))
50 -> 'a -> serialization
51 val set_default_code_width: int -> theory -> theory
53 type ('a, 'b, 'c, 'd, 'e, 'f) symbol_attr_decl
55 val set_identifiers: (string, string, string, string, string, string) symbol_attr_decl
57 type const_syntax = Code_Printer.const_syntax
58 type tyco_syntax = Code_Printer.tyco_syntax
59 val set_printings: (const_syntax, tyco_syntax, string, unit, unit, (string * string list)) symbol_attr_decl
61 val add_const_syntax: string -> string -> const_syntax option -> theory -> theory
62 val add_tyco_syntax: string -> string -> tyco_syntax option -> theory -> theory
63 val add_class_syntax: string -> class -> string option -> theory -> theory
64 val add_instance_syntax: string -> class * string -> unit option -> theory -> theory
65 val add_reserved: string -> string -> theory -> theory
66 val add_include: string -> string * (string * string list) option -> theory -> theory
67 val allow_abort: string -> theory -> theory
69 val codegen_tool: string (*theory name*) -> string (*export_code expr*) -> unit
71 val setup: theory -> theory
74 structure Code_Target : CODE_TARGET =
77 open Basic_Code_Thingol;
79 type literals = Code_Printer.literals;
80 type ('a, 'b, 'c, 'd, 'e, 'f) symbol_attr_decl =
81 (string * (string * 'a option) list, string * (string * 'b option) list,
82 class * (string * 'c option) list, (class * class) * (string * 'd option) list,
83 (class * string) * (string * 'e option) list,
84 string * (string * 'f option) list) Code_Symbol.attr;
85 type identifier_data = (string, string, string, string, string, string) Code_Symbol.data;
87 type tyco_syntax = Code_Printer.tyco_syntax;
88 type const_syntax = Code_Printer.const_syntax;
91 (** checking and parsing of symbols **)
93 fun cert_const thy const =
95 val _ = if Sign.declared_const thy const then ()
96 else error ("No such constant: " ^ quote const);
99 fun cert_tyco thy tyco =
101 val _ = if Sign.declared_tyname thy tyco then ()
102 else error ("No such type constructor: " ^ quote tyco);
105 fun read_tyco thy = #1 o dest_Type
106 o Proof_Context.read_type_name_proper (Proof_Context.init_global thy) true;
108 fun cert_class thy class =
110 val _ = Axclass.get_info thy class;
113 fun read_class thy = Proof_Context.read_class (Proof_Context.init_global thy);
115 val parse_classrel_ident = Parse.class --| @{keyword "<"} -- Parse.class;
117 fun cert_inst thy (class, tyco) =
118 (cert_class thy class, cert_tyco thy tyco);
120 fun read_inst thy (raw_tyco, raw_class) =
121 (read_class thy raw_class, read_tyco thy raw_tyco);
123 val parse_inst_ident = Parse.xname --| @{keyword "::"} -- Parse.class;
126 Code_Symbol.map_attr (apfst (cert_const thy)) (apfst (cert_tyco thy))
127 (apfst (cert_class thy)) ((apfst o pairself) (cert_class thy)) (apfst (cert_inst thy)) I;
130 Code_Symbol.map_attr (apfst (Code.read_const thy)) (apfst (read_tyco thy))
131 (apfst (read_class thy)) ((apfst o pairself) (read_class thy)) (apfst (read_inst thy)) I;
133 fun check_name is_module s =
135 val _ = if s = "" then error "Bad empty code name" else ();
136 val xs = Long_Name.explode s;
137 val xs' = if is_module
138 then map (Name.desymbolize true) xs
139 else if length xs < 2
140 then error ("Bad code name without module component: " ^ quote s)
143 val (ys, y) = split_last xs;
144 val ys' = map (Name.desymbolize true) ys;
145 val y' = Name.desymbolize false y;
149 else error ("Invalid code name: " ^ quote s ^ "\n"
150 ^ "better try " ^ quote (Long_Name.implode xs'))
154 (** serializations and serializer **)
156 (* serialization: abstract nonsense to cover different destinies for generated code *)
158 datatype destination = Export of Path.T option | Produce | Present of string list;
159 type serialization = int -> destination -> ((string * string) list * (string -> string option)) option;
161 fun serialization output _ content width (Export some_path) =
162 (output width some_path content; NONE)
163 | serialization _ string content width Produce =
164 string [] width content |> SOME
165 | serialization _ string content width (Present stmt_names) =
166 string stmt_names width content
167 |> (apfst o map o apsnd) (Pretty.output (SOME width) o Pretty.str)
170 fun export some_path f = (f (Export some_path); ());
171 fun produce f = the (f Produce);
172 fun present stmt_names f = space_implode "\n\n" (map snd (fst (the (f (Present stmt_names)))));
175 (* serializers: functions producing serializations *)
177 type serializer = Token.T list
180 symbol_of: string -> Code_Symbol.symbol,
182 reserved_syms: string list,
183 identifiers: identifier_data,
184 includes: (string * Pretty.T) list,
185 class_syntax: string -> string option,
186 tyco_syntax: string -> Code_Printer.tyco_syntax option,
187 const_syntax: string -> Code_Printer.activated_const_syntax option }
188 -> Code_Thingol.program
191 datatype description =
192 Fundamental of { serializer: serializer,
194 check: { env_var: string, make_destination: Path.T -> Path.T,
195 make_command: string -> string } }
196 | Extension of string *
197 (Code_Thingol.naming -> Code_Thingol.program -> Code_Thingol.program);
202 datatype target = Target of {
204 description: description,
205 reserved: string list,
206 identifiers: identifier_data,
207 printings: (Code_Printer.const_syntax, Code_Printer.tyco_syntax, string, unit, unit,
208 (Pretty.T * string list)) Code_Symbol.data
211 fun make_target ((serial, description), (reserved, (identifiers, printings))) =
212 Target { serial = serial, description = description, reserved = reserved,
213 identifiers = identifiers, printings = printings };
214 fun map_target f (Target { serial, description, reserved, identifiers, printings }) =
215 make_target (f ((serial, description), (reserved, (identifiers, printings))));
216 fun merge_target strict target (Target { serial = serial1, description = description,
217 reserved = reserved1, identifiers = identifiers1, printings = printings1 },
218 Target { serial = serial2, description = _,
219 reserved = reserved2, identifiers = identifiers2, printings = printings2 }) =
220 if serial1 = serial2 orelse not strict then
221 make_target ((serial1, description), (merge (op =) (reserved1, reserved2),
222 (Code_Symbol.merge_data (identifiers1, identifiers2),
223 Code_Symbol.merge_data (printings1, printings2))))
225 error ("Incompatible targets: " ^ quote target);
227 fun the_description (Target { description, ... }) = description;
228 fun the_reserved (Target { reserved, ... }) = reserved;
229 fun the_identifiers (Target { identifiers , ... }) = identifiers;
230 fun the_printings (Target { printings, ... }) = printings;
232 structure Targets = Theory_Data
234 type T = (target Symtab.table * string list) * int;
235 val empty = ((Symtab.empty, []), 80);
237 fun merge (((target1, exc1), width1), ((target2, exc2), width2)) : T =
238 ((Symtab.join (merge_target true) (target1, target2),
239 Library.merge (op =) (exc1, exc2)), Int.max (width1, width2));
242 val abort_allowed = snd o fst o Targets.get;
244 fun assert_target thy target = if Symtab.defined ((fst o fst) (Targets.get thy)) target
246 else error ("Unknown code target language: " ^ quote target);
248 fun put_target (target, seri) thy =
250 val lookup_target = Symtab.lookup ((fst o fst) (Targets.get thy));
252 of Extension (super, _) => if is_some (lookup_target super) then ()
253 else error ("Unknown code target language: " ^ quote super)
255 val overwriting = case (Option.map the_description o lookup_target) target
257 | SOME (Extension _) => true
258 | SOME (Fundamental _) => (case seri
259 of Extension _ => error ("Will not overwrite existing target " ^ quote target)
261 val _ = if overwriting
262 then warning ("Overwriting existing target " ^ quote target)
266 |> (Targets.map o apfst o apfst o Symtab.update)
267 (target, make_target ((serial (), seri),
268 ([], (Code_Symbol.empty_data, Code_Symbol.empty_data))))
271 fun add_target (target, seri) = put_target (target, Fundamental seri);
272 fun extend_target (target, (super, modify)) =
273 put_target (target, Extension (super, modify));
275 fun map_target_data target f thy =
277 val _ = assert_target thy target;
280 |> (Targets.map o apfst o apfst o Symtab.map_entry target o map_target o apsnd) f
283 fun map_reserved target =
284 map_target_data target o apfst;
285 fun map_identifiers target =
286 map_target_data target o apsnd o apfst;
287 fun map_printings target =
288 map_target_data target o apsnd o apsnd;
290 fun set_default_code_width k = (Targets.map o apsnd) (K k);
293 (** serializer usage **)
297 fun the_fundamental thy =
299 val ((targets, _), _) = Targets.get thy;
300 fun fundamental target = case Symtab.lookup targets target
301 of SOME data => (case the_description data
302 of Fundamental data => data
303 | Extension (super, _) => fundamental super)
304 | NONE => error ("Unknown code target language: " ^ quote target);
307 fun the_literals thy = #literals o the_fundamental thy;
309 fun collapse_hierarchy thy =
311 val ((targets, _), _) = Targets.get thy;
312 fun collapse target =
314 val data = case Symtab.lookup targets target
316 | NONE => error ("Unknown code target language: " ^ quote target);
317 in case the_description data
318 of Fundamental _ => (K I, data)
319 | Extension (super, modify) => let
320 val (modify', data') = collapse super
321 in (fn naming => modify' naming #> modify naming, merge_target false target (data', data)) end
327 fun activate_target thy target =
329 val ((_, abortable), default_width) = Targets.get thy;
330 val (modify, data) = collapse_hierarchy thy target;
331 in (default_width, abortable, data, modify) end;
333 fun activate_const_syntax thy literals cs_data naming =
334 (Symtab.empty, naming)
335 |> fold_map (fn (c, data) => fn (tab, naming) =>
336 case Code_Thingol.lookup_const naming c
339 Code_Printer.activate_const_syntax thy literals c data naming
340 in (SOME name, (Symtab.update_new (name, syn) tab, naming')) end
341 | NONE => (NONE, (tab, naming))) cs_data
344 fun activate_syntax lookup_name things =
346 |> fold_map (fn (thing_identifier, data) => fn tab => case lookup_name thing_identifier
347 of SOME name => (SOME name, Symtab.update_new (name, data) tab)
348 | NONE => (NONE, tab)) things
351 fun activate_symbol_syntax thy literals naming printings =
353 val (names_const, (const_syntax, _)) =
354 activate_const_syntax thy literals (Code_Symbol.dest_constant_data printings) naming;
355 val (names_tyco, tyco_syntax) =
356 activate_syntax (Code_Thingol.lookup_tyco naming) (Code_Symbol.dest_type_constructor_data printings);
357 val (names_class, class_syntax) =
358 activate_syntax (Code_Thingol.lookup_class naming) (Code_Symbol.dest_type_class_data printings);
359 val names_inst = map_filter (Code_Thingol.lookup_instance naming o fst)
360 (Code_Symbol.dest_class_instance_data printings);
362 (names_const @ names_tyco @ names_class @ names_inst,
363 (const_syntax, tyco_syntax, class_syntax))
366 fun project_program thy abortable names_hidden names1 program2 =
368 val ctxt = Proof_Context.init_global thy;
369 val names2 = subtract (op =) names_hidden names1;
370 val program3 = Graph.restrict (not o member (op =) names_hidden) program2;
371 val names4 = Graph.all_succs program3 names2;
372 val empty_funs = filter_out (member (op =) abortable)
373 (Code_Thingol.empty_funs program3);
375 if null empty_funs then ()
376 else error ("No code equations for " ^
377 commas (map (Proof_Context.extern_const ctxt) empty_funs));
378 val program4 = Graph.restrict (member (op =) names4) program3;
379 in (names4, program4) end;
381 fun prepare_serializer thy abortable (serializer : serializer) literals reserved identifiers
382 printings module_name args naming proto_program names =
384 val (names_hidden, (const_syntax, tyco_syntax, class_syntax)) =
385 activate_symbol_syntax thy literals naming printings;
386 val (names_all, program) = project_program thy abortable names_hidden names proto_program;
387 fun select_include (name, (content, cs)) =
388 if null cs orelse exists (fn c => case Code_Thingol.lookup_const naming c
389 of SOME name => member (op =) names_all name
391 then SOME (name, content) else NONE;
392 val includes = map_filter select_include (Code_Symbol.dest_module_data printings);
394 (serializer args (Proof_Context.init_global thy) {
395 symbol_of = Code_Thingol.symbol_of proto_program,
396 module_name = module_name,
397 reserved_syms = reserved,
398 identifiers = identifiers,
400 const_syntax = Symtab.lookup const_syntax,
401 tyco_syntax = Symtab.lookup tyco_syntax,
402 class_syntax = Symtab.lookup class_syntax },
406 fun mount_serializer thy target some_width module_name args naming program names =
408 val (default_width, abortable, data, modify) = activate_target thy target;
409 val serializer = case the_description data
410 of Fundamental seri => #serializer seri;
411 val (prepared_serializer, prepared_program) =
412 prepare_serializer thy abortable serializer (the_literals thy target)
413 (the_reserved data) (the_identifiers data) (the_printings data)
414 module_name args naming (modify naming program) names
415 val width = the_default default_width some_width;
416 in (fn program => prepared_serializer program width, prepared_program) end;
418 fun invoke_serializer thy target some_width module_name args naming program names =
420 val (mounted_serializer, prepared_program) = mount_serializer thy
421 target some_width module_name args naming program names;
422 in mounted_serializer prepared_program end;
424 fun assert_module_name "" = error "Empty module name not allowed here"
425 | assert_module_name module_name = module_name;
427 fun using_master_directory thy =
428 Option.map (Path.append (File.pwd ()) o Path.append (Thy_Load.master_directory thy));
432 val generatedN = "Generated_Code";
434 fun export_code_for thy some_path target some_width module_name args =
435 export (using_master_directory thy some_path)
436 ooo invoke_serializer thy target some_width module_name args;
438 fun produce_code_for thy target some_width module_name args =
440 val serializer = invoke_serializer thy target some_width (assert_module_name module_name) args;
441 in fn naming => fn program => fn names =>
442 produce (serializer naming program names) |> apsnd (fn deresolve => map deresolve names)
445 fun present_code_for thy target some_width module_name args =
447 val serializer = invoke_serializer thy target some_width (assert_module_name module_name) args;
448 in fn naming => fn program => fn (names, selects) =>
449 present selects (serializer naming program names)
452 fun check_code_for thy target strict args naming program names_cs =
454 val { env_var, make_destination, make_command } =
455 (#check o the_fundamental thy) target;
458 val destination = make_destination p;
459 val _ = export (SOME destination) (invoke_serializer thy target (SOME 80)
460 generatedN args naming program names_cs);
461 val cmd = make_command generatedN;
463 if Isabelle_System.bash ("cd " ^ File.shell_path p ^ " && " ^ cmd ^ " 2>&1") <> 0
464 then error ("Code check failed for " ^ target ^ ": " ^ cmd)
468 if getenv env_var = ""
470 then error (env_var ^ " not set; cannot check code for " ^ target)
471 else warning (env_var ^ " not set; skipped checking code for " ^ target)
472 else Isabelle_System.with_tmp_dir "Code_Test" ext_check
475 fun evaluation mounted_serializer prepared_program consts ((vs, ty), t) =
477 val _ = if Code_Thingol.contains_dict_var t then
478 error "Term to be evaluated contains free dictionaries" else ();
479 val v' = singleton (Name.variant_list (map fst vs)) "a";
480 val vs' = (v', []) :: vs;
481 val ty' = Code_Thingol.fun_tyco `%% [ITyVar v', ty];
482 val value_name = "Value.value.value"
483 val program = prepared_program
484 |> Graph.new_node (value_name,
485 Code_Thingol.Fun (@{const_name dummy_pattern}, (((vs', ty'), [(([IVar NONE], t), (NONE, true))]), NONE)))
486 |> fold (curry (perhaps o try o Graph.add_edge) value_name) consts;
487 val (program_code, deresolve) = produce (mounted_serializer program);
488 val value_name' = the (deresolve value_name);
489 in (program_code, value_name') end;
491 fun evaluator thy target naming program consts =
493 val (mounted_serializer, prepared_program) = mount_serializer thy
494 target NONE generatedN [] naming program consts;
495 in evaluation mounted_serializer prepared_program consts end;
500 (* code generation *)
502 fun transitivly_non_empty_funs thy naming program =
504 val cs = subtract (op =) (abort_allowed thy) (Code_Thingol.empty_funs program);
505 val names = map_filter (Code_Thingol.lookup_const naming) cs;
506 in subtract (op =) (Graph.all_preds program names) (Graph.keys program) end;
508 fun read_const_exprs thy cs =
510 val (cs1, cs2) = Code_Thingol.read_const_exprs thy cs;
511 val (names2, (naming, program)) = Code_Thingol.consts_program thy true cs2;
512 val names3 = transitivly_non_empty_funs thy naming program;
513 val cs3 = map_filter (fn (c, name) =>
514 if member (op =) names3 name then SOME c else NONE) (cs2 ~~ names2);
515 in union (op =) cs3 cs1 end;
517 fun prep_destination "" = NONE
518 | prep_destination "-" = (legacy_feature "drop \"file\" argument entirely instead of \"-\""; NONE)
519 | prep_destination s = SOME (Path.explode s);
521 fun export_code thy cs seris =
523 val (names_cs, (naming, program)) = Code_Thingol.consts_program thy false cs;
524 val _ = map (fn (((target, module_name), some_path), args) =>
525 export_code_for thy some_path target NONE module_name args naming program names_cs) seris;
528 fun export_code_cmd raw_cs seris thy = export_code thy (read_const_exprs thy raw_cs)
529 ((map o apfst o apsnd) prep_destination seris);
531 fun produce_code thy cs target some_width some_module_name args =
533 val (names_cs, (naming, program)) = Code_Thingol.consts_program thy false cs;
534 in produce_code_for thy target some_width some_module_name args naming program names_cs end;
536 fun present_code thy cs names_stmt target some_width some_module_name args =
538 val (names_cs, (naming, program)) = Code_Thingol.consts_program thy false cs;
539 in present_code_for thy target some_width some_module_name args naming program (names_cs, names_stmt naming) end;
541 fun check_code thy cs seris =
543 val (names_cs, (naming, program)) = Code_Thingol.consts_program thy false cs;
544 val _ = map (fn ((target, strict), args) =>
545 check_code_for thy target strict args naming program names_cs) seris;
548 fun check_code_cmd raw_cs seris thy = check_code thy (read_const_exprs thy raw_cs) seris;
552 val parse_const_terms = Scan.repeat1 Args.term
553 >> (fn ts => fn thy => map (Code.check_const thy) ts);
555 fun parse_names category parse internalize lookup =
556 Scan.lift (Args.parens (Args.$$$ category)) |-- Scan.repeat1 parse
557 >> (fn xs => fn thy => fn naming => map_filter (lookup naming o internalize thy) xs);
559 val parse_consts = parse_names "consts" Args.term
560 Code.check_const Code_Thingol.lookup_const;
562 val parse_types = parse_names "types" (Scan.lift Args.name)
563 Sign.intern_type Code_Thingol.lookup_tyco;
565 val parse_classes = parse_names "classes" (Scan.lift Args.name)
566 Sign.intern_class Code_Thingol.lookup_class;
568 val parse_instances = parse_names "instances" (Scan.lift (Args.name --| Args.$$$ "::" -- Args.name))
569 (fn thy => fn (raw_tyco, raw_class) => (Sign.intern_class thy raw_class, Sign.intern_type thy raw_tyco))
570 Code_Thingol.lookup_instance;
575 Thy_Output.antiquotation @{binding code_stmts}
576 (parse_const_terms --
577 Scan.repeat (parse_consts || parse_types || parse_classes || parse_instances)
578 -- Scan.lift (Args.parens (Args.name -- Scan.option Parse.int)))
579 (fn {context = ctxt, ...} => fn ((mk_cs, mk_stmtss), (target, some_width)) =>
580 let val thy = Proof_Context.theory_of ctxt in
581 present_code thy (mk_cs thy)
582 (fn naming => maps (fn f => f thy naming) mk_stmtss)
583 target some_width "Example" []
589 (** serializer configuration **)
591 (* reserved symbol names *)
593 fun add_reserved target sym thy =
595 val (_, data) = collapse_hierarchy thy target;
596 val _ = if member (op =) (the_reserved data) sym
597 then error ("Reserved symbol " ^ quote sym ^ " already declared")
601 |> map_reserved target (insert (op =) sym)
605 (* checking of syntax *)
607 fun check_const_syntax thy c syn =
608 if Code_Printer.requires_args syn > Code.args_number thy c
609 then error ("Too many arguments in syntax for constant " ^ quote c)
612 fun check_tyco_syntax thy tyco syn =
613 if fst syn <> Sign.arity_number thy tyco
614 then error ("Number of arguments mismatch in syntax for type constructor " ^ quote tyco)
618 (* custom symbol names *)
620 fun arrange_name_decls x =
622 fun arrange is_module (sym, target_names) = map (fn (target, some_name) =>
623 (target, (sym, Option.map (check_name is_module) some_name))) target_names;
625 Code_Symbol.maps_attr' (arrange false) (arrange false) (arrange false)
626 (arrange false) (arrange false) (arrange true) x
629 fun cert_name_decls thy = cert_syms thy #> arrange_name_decls;
631 fun read_name_decls thy = read_syms thy #> arrange_name_decls;
633 fun set_identifier (target, sym_name) = map_identifiers target (Code_Symbol.set_data sym_name);
635 fun gen_set_identifiers prep_name_decl raw_name_decls thy =
636 fold set_identifier (prep_name_decl thy raw_name_decls) thy;
638 val set_identifiers = gen_set_identifiers cert_name_decls;
639 val set_identifiers_cmd = gen_set_identifiers read_name_decls;
641 fun add_module_alias_cmd target aliasses =
643 val _ = legacy_feature "prefer \"code_identifier\" over \"code_modulename\"";
645 fold (fn (sym, name) => set_identifier
646 (target, Code_Symbol.Module (sym, if name = "" then NONE else SOME (check_name true name)))) aliasses
650 (* custom printings *)
652 fun arrange_printings prep_const thy =
654 fun arrange check (sym, target_syns) =
655 map (fn (target, some_syn) => (target, (sym, Option.map (check thy sym) some_syn))) target_syns;
657 Code_Symbol.maps_attr'
658 (arrange check_const_syntax) (arrange check_tyco_syntax)
659 (arrange ((K o K) I)) (arrange ((K o K) I)) (arrange ((K o K) I))
660 (arrange (fn thy => fn _ => fn (raw_content, raw_cs) =>
661 (Code_Printer.str raw_content, map (prep_const thy) raw_cs)))
664 fun cert_printings thy = cert_syms thy #> arrange_printings cert_const thy;
666 fun read_printings thy = read_syms thy #> arrange_printings Code.read_const thy;
668 fun set_printing (target, sym_syn) = map_printings target (Code_Symbol.set_data sym_syn);
670 fun gen_set_printings prep_print_decl raw_print_decls thy =
671 fold set_printing (prep_print_decl thy raw_print_decls) thy;
673 val set_printings = gen_set_printings cert_printings;
674 val set_printings_cmd = gen_set_printings read_printings;
676 fun gen_add_syntax Symbol prep_x prep_syn target raw_x some_raw_syn thy =
678 val _ = legacy_feature "prefer \"code_printing\" for custom serialisations"
679 val x = prep_x thy raw_x;
680 in set_printing (target, Symbol (x, Option.map (prep_syn thy x) some_raw_syn)) thy end;
682 fun gen_add_const_syntax prep_const =
683 gen_add_syntax Code_Symbol.Constant prep_const check_const_syntax;
685 fun gen_add_tyco_syntax prep_tyco =
686 gen_add_syntax Code_Symbol.Type_Constructor prep_tyco check_tyco_syntax;
688 fun gen_add_class_syntax prep_class =
689 gen_add_syntax Code_Symbol.Type_Class prep_class ((K o K) I);
691 fun gen_add_instance_syntax prep_inst =
692 gen_add_syntax Code_Symbol.Class_Instance prep_inst ((K o K) I);
694 fun gen_add_include prep_const target (name, some_content) thy =
695 gen_add_syntax Code_Symbol.Module (K I)
696 (fn thy => fn _ => fn (raw_content, raw_cs) => (Code_Printer.str raw_content, map (prep_const thy) raw_cs))
697 target name some_content thy;
700 (* abortable constants *)
702 fun gen_allow_abort prep_const raw_c thy =
704 val c = prep_const thy raw_c;
705 in thy |> (Targets.map o apfst o apsnd) (insert (op =) c) end;
708 (* concrete syntax *)
712 fun zip_list (x :: xs) f g =
715 fold_map (fn x => g |-- f >> pair x) xs
716 :|-- (fn xys => pair ((x, y) :: xys)));
718 fun process_multi_syntax parse_thing parse_syntax change =
719 (Parse.and_list1 parse_thing
720 :|-- (fn things => Scan.repeat1 (@{keyword "("} |-- Parse.name --
721 (zip_list things (Scan.option parse_syntax) @{keyword "and"}) --| @{keyword ")"})))
722 >> (Toplevel.theory oo fold)
723 (fn (target, syns) => fold (fn (raw_x, syn) => change target raw_x syn) syns);
727 val add_reserved = add_reserved;
728 val add_const_syntax = gen_add_const_syntax (K I);
729 val add_tyco_syntax = gen_add_tyco_syntax cert_tyco;
730 val add_class_syntax = gen_add_class_syntax cert_class;
731 val add_instance_syntax = gen_add_instance_syntax cert_inst;
732 val add_include = gen_add_include (K I);
733 val allow_abort = gen_allow_abort (K I);
735 val add_const_syntax_cmd = gen_add_const_syntax Code.read_const;
736 val add_tyco_syntax_cmd = gen_add_tyco_syntax read_tyco;
737 val add_class_syntax_cmd = gen_add_class_syntax read_class;
738 val add_instance_syntax_cmd = gen_add_instance_syntax read_inst;
739 val add_include_cmd = gen_add_include Code.read_const;
740 val allow_abort_cmd = gen_allow_abort Code.read_const;
742 fun parse_args f args =
743 case Scan.read Token.stopper f args
745 | NONE => error "Bad serializer arguments";
750 fun parse_single_symbol_pragma parse_keyword parse_isa parse_target =
751 parse_keyword |-- Parse.!!! (parse_isa --| (@{keyword "\<rightharpoonup>"} || @{keyword "=>"})
752 -- Parse.and_list1 (@{keyword "("} |-- (Parse.name --| @{keyword ")"} -- Scan.option parse_target)));
754 fun parse_symbol_pragma parse_const parse_tyco parse_class parse_classrel parse_inst parse_module =
755 parse_single_symbol_pragma @{keyword "constant"} Parse.term parse_const
756 >> Code_Symbol.Constant
757 || parse_single_symbol_pragma @{keyword "type_constructor"} Parse.type_const parse_tyco
758 >> Code_Symbol.Type_Constructor
759 || parse_single_symbol_pragma @{keyword "type_class"} Parse.class parse_class
760 >> Code_Symbol.Type_Class
761 || parse_single_symbol_pragma @{keyword "class_relation"} parse_classrel_ident parse_classrel
762 >> Code_Symbol.Class_Relation
763 || parse_single_symbol_pragma @{keyword "class_instance"} parse_inst_ident parse_inst
764 >> Code_Symbol.Class_Instance
765 || parse_single_symbol_pragma @{keyword "code_module"} Parse.name parse_module
766 >> Code_Symbol.Module;
768 fun parse_symbol_pragmas parse_const parse_tyco parse_class parse_classrel parse_inst parse_module =
769 Parse.enum1 "|" (Parse.group (fn () => "code symbol pragma")
770 (parse_symbol_pragma parse_const parse_tyco parse_class parse_classrel parse_inst parse_module));
772 val code_expr_argsP = Scan.optional (@{keyword "("} |-- Args.parse --| @{keyword ")"}) [];
774 fun code_expr_inP raw_cs =
775 Scan.repeat (@{keyword "in"} |-- Parse.!!! (Parse.name
776 -- Scan.optional (@{keyword "module_name"} |-- Parse.name) ""
777 -- Scan.optional (@{keyword "file"} |-- Parse.name) ""
779 >> (fn seri_args => export_code_cmd raw_cs seri_args);
781 fun code_expr_checkingP raw_cs =
782 (@{keyword "checking"} |-- Parse.!!!
783 (Scan.repeat (Parse.name -- ((@{keyword "?"} |-- Scan.succeed false) || Scan.succeed true)
784 -- code_expr_argsP)))
785 >> (fn seri_args => check_code_cmd raw_cs seri_args);
787 val code_exprP = Scan.repeat1 Parse.term
788 :|-- (fn raw_cs => (code_expr_checkingP raw_cs || code_expr_inP raw_cs));
791 Outer_Syntax.command @{command_spec "code_reserved"}
792 "declare words as reserved for target language"
793 (Parse.name -- Scan.repeat1 Parse.name
794 >> (fn (target, reserveds) => (Toplevel.theory o fold (add_reserved target)) reserveds));
797 Outer_Syntax.command @{command_spec "code_identifier"} "declare mandatory names for code symbols"
798 (parse_symbol_pragmas Parse.name Parse.name Parse.name Parse.name Parse.name Parse.name
799 >> (Toplevel.theory o fold set_identifiers_cmd));
802 Outer_Syntax.command @{command_spec "code_modulename"} "alias module to other name"
803 (Parse.name -- Scan.repeat1 (Parse.name -- Parse.name)
804 >> (fn (target, modlnames) => (Toplevel.theory o add_module_alias_cmd target) modlnames));
807 Outer_Syntax.command @{command_spec "code_printing"} "declare dedicated printing for code symbols"
808 (parse_symbol_pragmas (Code_Printer.parse_const_syntax) (Code_Printer.parse_tyco_syntax)
809 Parse.string (Parse.minus >> K ()) (Parse.minus >> K ())
810 (Parse.text -- Scan.optional (@{keyword "attach"} |-- Scan.repeat1 Parse.term) [])
811 >> (Toplevel.theory o fold set_printings_cmd));
814 Outer_Syntax.command @{command_spec "code_const"} "define code syntax for constant"
815 (process_multi_syntax Parse.term Code_Printer.parse_const_syntax
816 add_const_syntax_cmd);
819 Outer_Syntax.command @{command_spec "code_type"} "define code syntax for type constructor"
820 (process_multi_syntax Parse.type_const Code_Printer.parse_tyco_syntax
821 add_tyco_syntax_cmd);
824 Outer_Syntax.command @{command_spec "code_class"} "define code syntax for class"
825 (process_multi_syntax Parse.class Parse.string
826 add_class_syntax_cmd);
829 Outer_Syntax.command @{command_spec "code_instance"} "define code syntax for instance"
830 (process_multi_syntax parse_inst_ident (Parse.minus >> K ())
831 add_instance_syntax_cmd);
834 Outer_Syntax.command @{command_spec "code_include"}
835 "declare piece of code to be included in generated code"
836 (Parse.name -- Parse.name -- (Parse.text :|--
837 (fn "-" => Scan.succeed NONE
838 | s => Scan.optional (@{keyword "attach"} |-- Scan.repeat1 Parse.term) [] >> pair s >> SOME))
839 >> (fn ((target, name), content_consts) =>
840 (Toplevel.theory o add_include_cmd target) (name, content_consts)));
843 Outer_Syntax.command @{command_spec "code_abort"}
844 "permit constant to be implemented as program abort"
845 (Scan.repeat1 Parse.term >> (Toplevel.theory o fold allow_abort_cmd));
848 Outer_Syntax.command @{command_spec "export_code"} "generate executable code for constants"
849 (Parse.!!! code_exprP >> (fn f => Toplevel.keep (f o Toplevel.theory_of)));
854 (** external entrance point -- for codegen tool **)
856 fun codegen_tool thyname cmd_expr =
858 val thy = Thy_Info.get_theory thyname;
859 val parse = Scan.read Token.stopper (Parse.!!! code_exprP) o
860 (filter Token.is_proper o Outer_Syntax.scan Position.none);
861 in case parse cmd_expr
862 of SOME f => (writeln "Now generating code..."; f thy)
863 | NONE => error ("Bad directive " ^ quote cmd_expr)
869 val setup = antiq_setup;