1 (* Title: Pure/Thy/thy_output.ML
3 Author: Markus Wenzel, TU Muenchen
5 Theory document output.
14 val add_commands: (string * (Args.src -> Toplevel.node option -> string)) list -> unit
15 val add_options: (string * (string -> (unit -> string) -> unit -> string)) list -> unit
16 val defined_command: string -> bool
17 val defined_option: string -> bool
18 val print_antiquotations: unit -> unit
19 val boolean: string -> bool
20 val integer: string -> int
21 val args: (Context.generic * Args.T list -> 'a * (Context.generic * Args.T list)) ->
22 (Args.src -> Proof.context -> 'a -> string) -> Args.src -> Toplevel.node option -> string
23 datatype markup = Markup | MarkupEnv | Verbatim
24 val modes: string list ref
25 val eval_antiquote: Scan.lexicon -> Toplevel.node option -> string * Position.T -> string
26 val process_thy: Scan.lexicon -> (string -> string list) -> (markup -> string -> bool) ->
27 Toplevel.transition list -> (OuterLex.token, 'a) Source.source -> Buffer.T
28 val output_list: (Proof.context -> 'a -> Pretty.T) -> Args.src ->
29 Proof.context -> 'a list -> string
30 val output: (Proof.context -> 'a -> Pretty.T) -> Args.src -> Proof.context -> 'a -> string
33 structure ThyOutput: THY_OUTPUT =
36 structure T = OuterLex;
37 structure P = OuterParse;
40 (** global options **)
43 val display = ref false;
44 val quotes = ref false;
46 val source = ref false;
47 val break = ref false;
51 (** maintain global commands **)
56 ref (Symtab.empty: (Args.src -> Toplevel.node option -> string) Symtab.table);
59 ref (Symtab.empty: (string -> (unit -> string) -> unit -> string) Symtab.table);
61 fun add_item kind (name, x) tab =
62 (if not (Symtab.defined tab name) then ()
63 else warning ("Redefined text antiquotation " ^ kind ^ ": " ^ quote name);
64 Symtab.update (name, x) tab);
68 fun add_commands xs = CRITICAL (fn () => change global_commands (fold (add_item "command") xs));
69 fun add_options xs = CRITICAL (fn () => change global_options (fold (add_item "option") xs));
71 fun defined_command name = Symtab.defined (! global_commands) name;
72 fun defined_option name = Symtab.defined (! global_options) name;
75 let val ((name, _), pos) = Args.dest_src src in
76 (case Symtab.lookup (! global_commands) name of
77 NONE => error ("Unknown text antiquotation command: " ^ quote name ^ Position.str_of pos)
81 fun option (name, s) f () =
82 (case Symtab.lookup (! global_options) name of
83 NONE => error ("Unknown text antiquotation option: " ^ quote name)
84 | SOME opt => opt s f ());
87 | options (opt :: opts) f = option opt (options opts f);
90 fun print_antiquotations () =
91 [Pretty.big_list "text antiquotation commands:"
92 (map Pretty.str (sort_strings (Symtab.keys (! global_commands)))),
93 Pretty.big_list "text antiquotation options:"
94 (map Pretty.str (sort_strings (Symtab.keys (! global_options))))]
95 |> Pretty.chunks |> Pretty.writeln;
101 (** syntax of antiquotations **)
105 fun boolean "" = true
106 | boolean "true" = true
107 | boolean "false" = false
108 | boolean s = error ("Bad boolean value: " ^ quote s);
113 (case Library.read_int ss of (i, []) => i
114 | _ => error ("Bad integer value: " ^ quote s));
115 in (case Symbol.explode s of "-" :: ss => ~ (int ss) | ss => int ss) end;
120 fun syntax scan = Args.context_syntax "text antiquotation" scan;
122 fun args scan f src node : string =
124 val loc = if ! locale = "" then NONE else SOME (! locale);
125 val (x, ctxt) = syntax scan src (Toplevel.presentation_context node loc);
133 val property = P.xname -- Scan.optional (P.$$$ "=" |-- P.!!! P.xname) "";
134 val properties = Scan.optional (P.$$$ "[" |-- P.!!! (P.enum "," property --| P.$$$ "]")) [];
138 val antiq = P.!!! (P.position P.xname -- properties -- Args.parse --| Scan.ahead P.eof)
139 >> (fn (((x, pos), y), z) => (y, Args.src ((x, z), pos)));
146 val modes = ref ([]: string list);
148 fun eval_antiquote lex node (str, pos) =
150 fun expand (Antiquote.Text s) = s
151 | expand (Antiquote.Antiq x) =
152 let val (opts, src) = Antiquote.read_antiq lex antiq x in
153 options opts (fn () => command src node) (); (*preview errors!*)
154 PrintMode.with_modes (! modes @ Latex.modes)
155 (Output.no_warnings (options opts (fn () => command src node))) ()
157 | expand (Antiquote.Open _) = ""
158 | expand (Antiquote.Close _) = "";
159 val ants = Antiquote.read (str, pos);
161 if is_none node andalso exists Antiquote.is_antiq ants then
162 error ("Unknown context -- cannot expand text antiquotations" ^ Position.str_of pos)
163 else implode (map expand ants)
168 (** present theory source **)
170 (*NB: arranging white space around command spans is a black art.*)
172 (* presentation tokens *)
176 | BasicToken of T.token
177 | MarkupToken of string * (string * Position.T)
178 | MarkupEnvToken of string * (string * Position.T)
179 | VerbatimToken of string * Position.T;
181 fun output_token lex state =
183 val eval = eval_antiquote lex (try Toplevel.node_of state)
186 | BasicToken tok => Latex.output_basic tok
187 | MarkupToken (cmd, txt) => Latex.output_markup cmd (eval txt)
188 | MarkupEnvToken (cmd, txt) => Latex.output_markup_env cmd (eval txt)
189 | VerbatimToken txt => Latex.output_verbatim (eval txt)
192 fun basic_token pred (BasicToken tok) = pred tok
193 | basic_token _ _ = false;
195 val improper_token = basic_token (not o T.is_proper);
196 val comment_token = basic_token T.is_comment;
197 val blank_token = basic_token T.is_blank;
198 val newline_token = basic_token T.is_newline;
203 type command = string * Position.T * string list; (*name, position, tags*)
204 type source = (token * (string * int)) list; (*token, markup flag, meta-comment depth*)
206 datatype span = Span of command * (source * source * source * source) * bool;
208 fun make_span cmd src =
210 fun take_newline (tok :: toks) =
211 if newline_token (fst tok) then ([tok], toks, true)
212 else ([], tok :: toks, false)
213 | take_newline [] = ([], [], false);
214 val (((src_prefix, src_main), src_suffix1), (src_suffix2, src_appendix, newline)) =
216 |> take_prefix (improper_token o fst)
217 ||>> take_suffix (improper_token o fst)
218 ||>> take_prefix (comment_token o fst)
220 in Span (cmd, (src_prefix, src_main, src_suffix1 @ src_suffix2, src_appendix), newline) end;
227 fun err_bad_nesting pos =
228 error ("Bad nesting of commands in presentation" ^ pos);
230 fun edge which f (x: string option, y) =
232 else (case which (x, y) of NONE => I | SOME txt => Buffer.add (f txt));
234 val begin_tag = edge #2 Latex.begin_tag;
235 val end_tag = edge #1 Latex.end_tag;
236 fun open_delim delim e = edge #2 Latex.begin_delim e #> delim #> edge #2 Latex.end_delim e;
237 fun close_delim delim e = edge #1 Latex.begin_delim e #> delim #> edge #1 Latex.end_delim e;
241 fun present_span lex default_tags span state state'
242 (tag_stack, active_tag, newline, buffer, present_cont) =
244 val present = fold (fn (tok, (flag, 0)) =>
245 Buffer.add (output_token lex state' tok)
249 val Span ((cmd_name, cmd_pos, cmd_tags), srcs, span_newline) = span;
251 val (tag, tags) = tag_stack;
252 val tag' = try hd (fold OuterKeyword.update_tags cmd_tags (the_list tag));
255 if is_some tag' then tag'
256 else if cmd_name = "end" andalso not (Toplevel.is_toplevel state') then NONE
257 else try hd (default_tags cmd_name);
258 val edge = (active_tag, active_tag');
261 if is_none active_tag' then span_newline else newline;
263 val nesting = Toplevel.level state' - Toplevel.level state;
265 if nesting = 0 andalso not (Toplevel.is_proof state) then tag_stack
266 else if nesting >= 0 then (tag', replicate nesting tag @ tags)
268 (case Library.drop (~ nesting - 1, tags) of
269 tgs :: tgss => (tgs, tgss)
270 | [] => err_bad_nesting (Position.str_of cmd_pos));
275 |> close_delim (fst present_cont) edge
277 |> open_delim (present (#1 srcs)) edge
279 |> present (#2 srcs);
281 if newline then (present (#3 srcs), present (#4 srcs))
282 else (I, present (#3 srcs) #> present (#4 srcs));
283 in (tag_stack', active_tag', newline', buffer', present_cont') end;
285 fun present_trailer ((_, tags), active_tag, _, buffer, present_cont) =
286 if not (null tags) then err_bad_nesting " at end of theory"
289 |> end_tag (active_tag, NONE)
290 |> close_delim (fst present_cont) (active_tag, NONE)
298 datatype markup = Markup | MarkupEnv | Verbatim;
303 Scan.one T.is_blank -- Scan.many T.is_comment -- Scan.one T.is_proper;
305 val is_improper = not o (T.is_proper orf T.is_begin_ignore orf T.is_end_ignore);
306 val improper = Scan.many is_improper;
307 val improper_end = Scan.repeat (Scan.unless space_proper (Scan.one is_improper));
308 val blank_end = Scan.repeat (Scan.unless space_proper (Scan.one T.is_blank));
310 val opt_newline = Scan.option (Scan.one T.is_newline);
313 Scan.depend (fn d => opt_newline |-- Scan.one T.is_begin_ignore
315 Scan.depend (fn d => Scan.one T.is_end_ignore --|
316 (if d = 0 then Scan.fail_with (K "Bad nesting of meta-comments") else opt_newline)
319 val tag = (improper -- P.$$$ "%" -- improper) |-- P.!!! (P.tag_name --| blank_end);
322 Scan.option ((P.$$$ "(" -- improper -- P.$$$ "in") |--
323 P.!!! (improper |-- P.xname --| (improper -- P.$$$ ")")));
327 fun process_thy lex default_tags is_markup trs src =
331 val ignored = Scan.state --| ignore
332 >> (fn d => (NONE, (NoToken, ("", d))));
334 fun markup mark mk flag = Scan.peek (fn d =>
335 improper |-- P.position (Scan.one (T.is_kind T.Command andf is_markup mark o T.content_of)) --
337 P.!!!! ((improper -- locale -- improper) |-- P.position P.text --| improper_end)
338 >> (fn (((tok, pos), tags), txt) =>
339 let val name = T.content_of tok
340 in (SOME (name, pos, tags), (mk (name, txt), (flag, d))) end));
342 val command = Scan.peek (fn d =>
343 P.position (Scan.one (T.is_kind T.Command)) --
345 >> (fn ((tok, pos), tags) =>
346 let val name = T.content_of tok
347 in (SOME (name, pos, tags), (BasicToken tok, (Latex.markup_false, d))) end));
349 val cmt = Scan.peek (fn d =>
350 P.$$$ "--" |-- P.!!!! (improper |-- P.position P.text)
351 >> (fn txt => (NONE, (MarkupToken ("cmt", txt), ("", d)))));
353 val other = Scan.peek (fn d =>
354 P.not_eof >> (fn tok => (NONE, (BasicToken tok, ("", d)))));
358 markup Markup MarkupToken Latex.markup_true ||
359 markup MarkupEnv MarkupEnvToken Latex.markup_true ||
360 markup Verbatim (VerbatimToken o #2) "" ||
361 command || cmt || other;
366 val is_eof = fn (_, (BasicToken x, _)) => T.is_eof x | _ => false;
367 val stopper = Scan.stopper (K (NONE, (BasicToken T.eof, ("", 0)))) is_eof;
369 val cmd = Scan.one (is_some o fst);
370 val non_cmd = Scan.one (is_none o fst andf not o is_eof) >> #2;
372 val comments = Scan.many (comment_token o fst o snd);
373 val blank = Scan.one (blank_token o fst o snd);
374 val newline = Scan.one (newline_token o fst o snd);
376 Scan.option (newline -- comments) --
377 Scan.option (newline -- comments) --
378 Scan.option (blank -- comments) -- cmd;
381 Scan.repeat non_cmd -- cmd --
382 Scan.repeat (Scan.unless before_cmd non_cmd) --
383 Scan.option (newline >> (single o snd))
384 >> (fn (((toks1, (cmd, tok2)), toks3), tok4) =>
385 make_span (the cmd) (toks1 @ (tok2 :: (toks3 @ the_default [] tok4))));
389 |> Source.filter (not o T.is_semicolon)
390 |> Source.source' 0 T.stopper (Scan.error (Scan.bulk token)) NONE
391 |> Source.source stopper (Scan.error (Scan.bulk span)) NONE
394 if length trs = length spans then
395 ((NONE, []), NONE, true, Buffer.empty, (I, I))
396 |> Toplevel.present_excursion (trs ~~ map (present_span lex default_tags) spans)
398 else error "Messed-up outer syntax for presentation"
405 (** setup default output **)
410 [("show_types", Library.setmp Syntax.show_types o boolean),
411 ("show_sorts", Library.setmp Syntax.show_sorts o boolean),
412 ("show_structs", Library.setmp show_structs o boolean),
413 ("show_question_marks", Library.setmp show_question_marks o boolean),
414 ("long_names", Library.setmp NameSpace.long_names o boolean),
415 ("short_names", Library.setmp NameSpace.short_names o boolean),
416 ("unique_names", Library.setmp NameSpace.unique_names o boolean),
417 ("eta_contract", Library.setmp Syntax.eta_contract o boolean),
418 ("locale", Library.setmp locale),
419 ("display", Library.setmp display o boolean),
420 ("break", Library.setmp break o boolean),
421 ("quotes", Library.setmp quotes o boolean),
422 ("mode", fn s => fn f => PrintMode.with_modes [s] f),
423 ("margin", Pretty.setmp_margin o integer),
424 ("indent", Library.setmp indent o integer),
425 ("source", Library.setmp source o boolean),
426 ("goals_limit", Library.setmp goals_limit o integer)];
429 (* basic pretty printing *)
431 val str_of_source = space_implode " " o map T.unparse o #2 o #1 o Args.dest_src;
434 if ! display then s else Symbol.strip_blanks s;
436 val pretty_text = Pretty.chunks o map Pretty.str o map tweak_line o Library.split_lines;
438 fun pretty_term ctxt t = Syntax.pretty_term (Variable.auto_fixes t ctxt) t;
440 fun pretty_term_abbrev ctxt t = ProofContext.pretty_term_abbrev (Variable.auto_fixes t ctxt) t;
442 fun pretty_term_typ ctxt t =
443 Syntax.pretty_term ctxt (TypeInfer.constrain (Term.fastype_of t) t);
445 fun pretty_term_typeof ctxt = Syntax.pretty_typ ctxt o Term.fastype_of;
447 fun pretty_const ctxt c =
449 val t = Const (c, Consts.type_scheme (ProofContext.consts_of ctxt) c)
450 handle TYPE (msg, _, _) => error msg;
451 val ([t'], _) = Variable.import_terms true [t] ctxt;
452 in pretty_term ctxt t' end;
454 fun pretty_abbrev ctxt s =
456 val t = Syntax.parse_term ctxt s |> singleton (ProofContext.standard_infer_types ctxt);
457 fun err () = error ("Abbreviated constant expected: " ^ Syntax.string_of_term ctxt t);
458 val (head, args) = Term.strip_comb t;
459 val (c, T) = Term.dest_Const head handle TERM _ => err ();
460 val (U, u) = Consts.the_abbreviation (ProofContext.consts_of ctxt) c
461 handle TYPE _ => err ();
462 val t' = Term.betapplys (Envir.expand_atom T (U, u), args);
463 in pretty_term_abbrev ctxt (Logic.mk_equals (t, t')) end;
465 fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of;
467 fun pretty_term_style ctxt (name, t) =
468 pretty_term ctxt (TermStyle.the_style (ProofContext.theory_of ctxt) name ctxt t);
470 fun pretty_thm_style ctxt (name, th) =
471 pretty_term_style ctxt (name, Thm.full_prop_of th);
473 fun pretty_prf full ctxt thms =
474 Pretty.chunks (map (ProofSyntax.pretty_proof_of ctxt full) thms);
476 fun pretty_theory ctxt name =
477 (Theory.requires (ProofContext.theory_of ctxt) name "presentation"; Pretty.str name);
482 fun output_list pretty src ctxt xs =
483 map (pretty ctxt) xs (*always pretty in order to exhibit errors!*)
484 |> (if ! source then K [pretty_text (str_of_source src)] else I)
485 |> (if ! quotes then map Pretty.quote else I)
486 |> (if ! display then
487 map (Output.output o Pretty.string_of o Pretty.indent (! indent))
488 #> space_implode "\\isasep\\isanewline%\n"
489 #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
491 map (Output.output o (if ! break then Pretty.string_of else Pretty.str_of))
492 #> space_implode "\\isasep\\isanewline%\n"
493 #> enclose "\\isa{" "}");
495 fun output pretty src ctxt = output_list pretty src ctxt o single;
497 fun proof_state node =
498 (case Option.map Toplevel.proof_node node of
499 SOME (SOME prf) => ProofNode.current prf
500 | _ => error "No proof state");
502 fun output_goals main_goal src node = args (Scan.succeed ()) (output (fn _ => fn _ =>
503 Pretty.chunks (Proof.pretty_goals main_goal (proof_state node)))) src node;
505 fun ml_val txt = "fn _ => (" ^ txt ^ ");";
506 fun ml_type txt = "val _ = NONE : (" ^ txt ^ ") option;";
507 fun ml_struct txt = "functor DUMMY_FUNCTOR() = struct structure DUMMY = " ^ txt ^ " end;"
509 fun output_ml ml src ctxt (txt, pos) =
510 (ML_Context.eval_in (SOME (Context.Proof ctxt)) false pos (ml txt);
511 (if ! source then str_of_source src else txt)
512 |> (if ! quotes then quote else I)
513 |> (if ! display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
516 #> map (space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|")
517 #> space_implode "\\isasep\\isanewline%\n"));
520 (* embedded lemmas *)
522 fun pretty_lemma ctxt (prop, methods) =
525 |> Proof.theorem_i NONE (K I) [[(prop, [])]]
526 |> Proof.global_terminal_proof methods;
527 in pretty_term ctxt prop end;
530 args (Args.prop -- Scan.lift (Args.$$$ "by" |-- Method.parse -- Scan.option Method.parse))
531 (output pretty_lemma o (fn ((a, arg :: _), p) => (Args.src ((a, [arg]), p))) o Args.dest_src);
536 val _ = OuterKeyword.keyword "by";
539 [("thm", args Attrib.thms (output_list pretty_thm)),
540 ("thm_style", args (Scan.lift Args.liberal_name -- Attrib.thm) (output pretty_thm_style)),
541 ("prop", args Args.prop (output pretty_term)),
542 ("lemma", embedded_lemma),
543 ("term", args Args.term (output pretty_term)),
544 ("term_style", args (Scan.lift Args.liberal_name -- Args.term) (output pretty_term_style)),
545 ("term_type", args Args.term (output pretty_term_typ)),
546 ("typeof", args Args.term (output pretty_term_typeof)),
547 ("const", args Args.const_proper (output pretty_const)),
548 ("abbrev", args (Scan.lift Args.name) (output pretty_abbrev)),
549 ("typ", args Args.typ_abbrev (output Syntax.pretty_typ)),
550 ("text", args (Scan.lift Args.name) (output (K pretty_text))),
551 ("goals", output_goals true),
552 ("subgoals", output_goals false),
553 ("prf", args Attrib.thms (output (pretty_prf false))),
554 ("full_prf", args Attrib.thms (output (pretty_prf true))),
555 ("theory", args (Scan.lift Args.name) (output pretty_theory)),
556 ("ML", args (Scan.lift (P.position Args.name)) (output_ml ml_val)),
557 ("ML_type", args (Scan.lift (P.position Args.name)) (output_ml ml_type)),
558 ("ML_struct", args (Scan.lift (P.position Args.name)) (output_ml ml_struct))];