(* Title: Pure/Thy/thy_output.ML Author: Markus Wenzel, TU Muenchen Theory document output with antiquotations. *) signature THY_OUTPUT = sig val display: bool Config.T val quotes: bool Config.T val margin: int Config.T val indent: int Config.T val source: bool Config.T val break: bool Config.T val modes: string Config.T val add_wrapper: ((unit -> string) -> unit -> string) -> Proof.context -> Proof.context val add_option: binding -> (string -> Proof.context -> Proof.context) -> theory -> theory val check_command: Proof.context -> xstring * Position.T -> string val check_option: Proof.context -> xstring * Position.T -> string val print_antiquotations: bool -> Proof.context -> unit val antiquotation: binding -> 'a context_parser -> ({source: Token.src, state: Toplevel.state, context: Proof.context} -> 'a -> string) -> theory -> theory val boolean: string -> bool val integer: string -> int val eval_antiquote: Toplevel.state -> Antiquote.text_antiquote -> string val output_text: Toplevel.state -> {markdown: bool} -> Input.source -> string val present_thy: theory -> (Toplevel.transition * Toplevel.state) list -> Token.T list -> Buffer.T val set_meta_args_parser : (theory -> string parser) -> unit val pretty_text: Proof.context -> string -> Pretty.T val pretty_term: Proof.context -> term -> Pretty.T val pretty_thm: Proof.context -> thm -> Pretty.T val str_of_source: Token.src -> string val maybe_pretty_source: (Proof.context -> 'a -> Pretty.T) -> Proof.context -> Token.src -> 'a list -> Pretty.T list val string_of_margin: Proof.context -> Pretty.T -> string val output: Proof.context -> Pretty.T list -> string val verbatim_text: Proof.context -> string -> string val document_command: {markdown: bool} -> (xstring * Position.T) option * Input.source -> Toplevel.transition -> Toplevel.transition end; structure Thy_Output: THY_OUTPUT = struct (** options **) val display = Attrib.setup_option_bool ("thy_output_display", \<^here>); val break = Attrib.setup_option_bool ("thy_output_break", \<^here>); val quotes = Attrib.setup_option_bool ("thy_output_quotes", \<^here>); val margin = Attrib.setup_option_int ("thy_output_margin", \<^here>); val indent = Attrib.setup_option_int ("thy_output_indent", \<^here>); val source = Attrib.setup_option_bool ("thy_output_source", \<^here>); val modes = Attrib.setup_option_string ("thy_output_modes", \<^here>); structure Wrappers = Proof_Data ( type T = ((unit -> string) -> unit -> string) list; fun init _ = []; ); fun add_wrapper wrapper = Wrappers.map (cons wrapper); val wrap = Wrappers.get #> fold (fn wrapper => fn f => wrapper f); (** maintain global antiquotations **) structure Antiquotations = Theory_Data ( type T = (Token.src -> Toplevel.state -> Proof.context -> string) Name_Space.table * (string -> Proof.context -> Proof.context) Name_Space.table; val empty : T = (Name_Space.empty_table Markup.document_antiquotationN, Name_Space.empty_table Markup.document_antiquotation_optionN); val extend = I; fun merge ((commands1, options1), (commands2, options2)) : T = (Name_Space.merge_tables (commands1, commands2), Name_Space.merge_tables (options1, options2)); ); val get_antiquotations = Antiquotations.get o Proof_Context.theory_of; fun add_command name cmd thy = thy |> Antiquotations.map (apfst (Name_Space.define (Context.Theory thy) true (name, cmd) #> snd)); fun add_option name opt thy = thy |> Antiquotations.map (apsnd (Name_Space.define (Context.Theory thy) true (name, opt) #> snd)); fun check_command ctxt = #1 o Name_Space.check (Context.Proof ctxt) (#1 (get_antiquotations ctxt)); fun check_option ctxt = #1 o Name_Space.check (Context.Proof ctxt) (#2 (get_antiquotations ctxt)); fun command src state ctxt = let val (src', f) = Token.check_src ctxt (#1 o get_antiquotations) src in f src' state ctxt end; fun option ((xname, pos), s) ctxt = let val (_, opt) = Name_Space.check (Context.Proof ctxt) (#2 (get_antiquotations ctxt)) (xname, pos); in opt s ctxt end; fun print_antiquotations verbose ctxt = let val (commands, options) = get_antiquotations ctxt; val command_names = map #1 (Name_Space.markup_table verbose ctxt commands); val option_names = map #1 (Name_Space.markup_table verbose ctxt options); in [Pretty.big_list "document antiquotations:" (map Pretty.mark_str command_names), Pretty.big_list "document antiquotation options:" (map Pretty.mark_str option_names)] end |> Pretty.writeln_chunks; fun antiquotation name scan body = add_command name (fn src => fn state => fn ctxt => let val (x, ctxt') = Token.syntax scan src ctxt in body {source = src, state = state, context = ctxt'} x end); (** syntax of antiquotations **) (* option values *) fun boolean "" = true | boolean "true" = true | boolean "false" = false | boolean s = error ("Bad boolean value: " ^ quote s); fun integer s = let fun int ss = (case Library.read_int ss of (i, []) => i | _ => error ("Bad integer value: " ^ quote s)); in (case Symbol.explode s of "-" :: ss => ~ (int ss) | ss => int ss) end; (* outer syntax *) local val property = Parse.position Parse.name -- Scan.optional (Parse.$$$ "=" |-- Parse.!!! Parse.name) ""; val properties = Scan.optional (Parse.$$$ "[" |-- Parse.!!! (Parse.enum "," property --| Parse.$$$ "]")) []; in val antiq = Parse.!!! (Parse.token Parse.liberal_name -- properties -- Parse.args --| Scan.ahead Parse.eof) >> (fn ((name, props), args) => (props, name :: args)); end; (* eval antiquote *) local fun eval_antiq state (opts, src) = let val preview_ctxt = fold option opts (Toplevel.presentation_context_of state); val print_ctxt = Context_Position.set_visible false preview_ctxt; fun cmd ctxt = wrap ctxt (fn () => command src state ctxt) (); val _ = cmd preview_ctxt; val print_modes = space_explode "," (Config.get print_ctxt modes) @ [Latex.latexN]; in Print_Mode.with_modes print_modes (fn () => cmd print_ctxt) () end; in fun eval_antiquote _ (Antiquote.Text ss) = Symbol_Pos.content ss | eval_antiquote state (Antiquote.Control {name, body, ...}) = eval_antiq state ([], Token.make_src name (if null body then [] else [Token.read_cartouche body])) | eval_antiquote state (Antiquote.Antiq {range = (pos, _), body, ...}) = let val keywords = (case try Toplevel.presentation_context_of state of SOME ctxt => Thy_Header.get_keywords' ctxt | NONE => error ("Unknown context -- cannot expand document antiquotations" ^ Position.here pos)); in eval_antiq state (Token.read_antiq keywords antiq (body, pos)) end; end; (* output text *) fun output_text state {markdown} source = let val is_reported = (case try Toplevel.context_of state of SOME ctxt => Context_Position.is_visible ctxt | NONE => true); val pos = Input.pos_of source; val syms = Input.source_explode source; val _ = if is_reported then Position.report pos (Markup.language_document (Input.is_delimited source)) else (); val output_antiquotes = map (eval_antiquote state) #> implode; fun output_line line = (if Markdown.line_is_item line then "\\item " else "") ^ output_antiquotes (Markdown.line_content line); fun output_blocks blocks = space_implode "\n\n" (map output_block blocks) and output_block (Markdown.Par lines) = cat_lines (map output_line lines) | output_block (Markdown.List {kind, body, ...}) = Latex.environment (Markdown.print_kind kind) (output_blocks body); in if Toplevel.is_skipped_proof state then "" else if markdown andalso exists (Markdown.is_control o Symbol_Pos.symbol) syms then let val ants = Antiquote.parse pos syms; val reports = Antiquote.antiq_reports ants; val blocks = Markdown.read_antiquotes ants; val _ = if is_reported then Position.reports (reports @ Markdown.reports blocks) else (); in output_blocks blocks end else let val ants = Antiquote.parse pos (Symbol_Pos.trim_blanks syms); val reports = Antiquote.antiq_reports ants; val _ = if is_reported then Position.reports (reports @ Markdown.text_reports ants) else (); in output_antiquotes ants end end; (** present theory source **) (*NB: arranging white space around command spans is a black art*) (* presentation tokens *) datatype token = No_Token | Basic_Token of Token.T | Markup_Token of string * string * Input.source | Markup_Env_Token of string * string * Input.source | Raw_Token of Input.source; fun basic_token pred (Basic_Token tok) = pred tok | basic_token _ _ = false; val improper_token = basic_token Token.is_improper; val comment_token = basic_token Token.is_comment; val blank_token = basic_token Token.is_blank; val newline_token = basic_token Token.is_newline; (* output token *) fun output_token state tok = (case tok of No_Token => "" | Basic_Token tok => Latex.output_token tok | Markup_Token (cmd, meta_args, source) => "%\n\\isamarkup" ^ cmd ^ meta_args ^ "{" ^ output_text state {markdown = false} source ^ "%\n}\n" | Markup_Env_Token (cmd, meta_args, source) => Latex.environment ("isamarkup" ^ cmd) (meta_args ^ output_text state {markdown = true} source) | Raw_Token source => "%\n" ^ output_text state {markdown = true} source ^ "\n"); (* command spans *) type command = string * Position.T * string list; (*name, position, tags*) type source = (token * (string * int)) list; (*token, markup flag, meta-comment depth*) datatype span = Span of command * (source * source * source * source) * bool; fun make_span cmd src = let fun take_newline (tok :: toks) = if newline_token (fst tok) then ([tok], toks, true) else ([], tok :: toks, false) | take_newline [] = ([], [], false); val (((src_prefix, src_main), src_suffix1), (src_suffix2, src_appendix, newline)) = src |> take_prefix (improper_token o fst) ||>> take_suffix (improper_token o fst) ||>> take_prefix (comment_token o fst) ||> take_newline; in Span (cmd, (src_prefix, src_main, src_suffix1 @ src_suffix2, src_appendix), newline) end; (* present spans *) local fun err_bad_nesting pos = error ("Bad nesting of commands in presentation" ^ pos); fun edge which f (x: string option, y) = if x = y then I else (case which (x, y) of NONE => I | SOME txt => Buffer.add (f txt)); val begin_tag = edge #2 Latex.begin_tag; val end_tag = edge #1 Latex.end_tag; fun open_delim delim e = edge #2 Latex.begin_delim e #> delim #> edge #2 Latex.end_delim e; fun close_delim delim e = edge #1 Latex.begin_delim e #> delim #> edge #1 Latex.end_delim e; in fun present_span keywords span state state' (tag_stack, active_tag, newline, buffer, present_cont) = let val present = fold (fn (tok, (flag, 0)) => Buffer.add (output_token state' tok) #> Buffer.add flag | _ => I); val Span ((cmd_name, cmd_pos, cmd_tags), srcs, span_newline) = span; val (tag, tags) = tag_stack; val tag' = try hd (fold (update (op =)) cmd_tags (the_list tag)); val nesting = Toplevel.level state' - Toplevel.level state; val active_tag' = if is_some tag' then tag' else if cmd_name = "end" andalso not (Toplevel.is_toplevel state') then NONE else (case Keyword.command_tags keywords cmd_name of default_tag :: _ => SOME default_tag | [] => if Keyword.is_vacuous keywords cmd_name andalso Toplevel.is_proof state then active_tag else NONE); val edge = (active_tag, active_tag'); val newline' = if is_none active_tag' then span_newline else newline; val tag_stack' = if nesting = 0 andalso not (Toplevel.is_proof state) then tag_stack else if nesting >= 0 then (tag', replicate nesting tag @ tags) else (case drop (~ nesting - 1) tags of tg :: tgs => (tg, tgs) | [] => err_bad_nesting (Position.here cmd_pos)); val buffer' = buffer |> end_tag edge |> close_delim (fst present_cont) edge |> snd present_cont |> open_delim (present (#1 srcs)) edge |> begin_tag edge |> present (#2 srcs); val present_cont' = if newline then (present (#3 srcs), present (#4 srcs)) else (I, present (#3 srcs) #> present (#4 srcs)); in (tag_stack', active_tag', newline', buffer', present_cont') end; fun present_trailer ((_, tags), active_tag, _, buffer, present_cont) = if not (null tags) then err_bad_nesting " at end of theory" else buffer |> end_tag (active_tag, NONE) |> close_delim (fst present_cont) (active_tag, NONE) |> snd present_cont; end; (* present_thy *) local val markup_true = "\\isamarkuptrue%\n"; val markup_false = "\\isamarkupfalse%\n"; val space_proper = Scan.one Token.is_blank -- Scan.many Token.is_comment -- Scan.one Token.is_proper; val is_improper = not o (Token.is_proper orf Token.is_begin_ignore orf Token.is_end_ignore); val improper = Scan.many is_improper; val improper_end = Scan.repeat (Scan.unless space_proper (Scan.one is_improper)); val blank_end = Scan.repeat (Scan.unless space_proper (Scan.one Token.is_blank)); val opt_newline = Scan.option (Scan.one Token.is_newline); val ignore = Scan.depend (fn d => opt_newline |-- Scan.one Token.is_begin_ignore >> pair (d + 1)) || Scan.depend (fn d => Scan.one Token.is_end_ignore --| (if d = 0 then Scan.fail_with (K (fn () => "Bad nesting of meta-comments")) else opt_newline) >> pair (d - 1)); val tag = (improper -- Parse.$$$ "%" -- improper) |-- Parse.!!! (Parse.tag_name --| blank_end); val locale = Scan.option ((Parse.$$$ "(" -- improper -- Parse.$$$ "in") |-- Parse.!!! (improper |-- Parse.name --| (improper -- Parse.$$$ ")"))); val meta_args_parser_hook = Unsynchronized.ref((fn thy => fn s => ("",s)): theory -> string parser) in fun present_thy thy command_results toks = let val keywords = Thy_Header.get_keywords thy; (* tokens *) val ignored = Scan.state --| ignore >> (fn d => (NONE, (No_Token, ("", d)))); fun markup pred mk flag = Scan.peek (fn d => improper |-- Parse.position (Scan.one (fn tok => Token.is_command tok andalso pred keywords (Token.content_of tok))) -- Scan.repeat tag -- (improper |-- (Parse.!!!! ( (!meta_args_parser_hook thy) -- ( (improper -- locale -- improper) |-- (Parse.document_source)) --| improper_end))) >> (fn (((tok, pos'), tags), (meta_args,source)) => let val name = Token.content_of tok in (SOME (name, pos', tags), (mk (name, meta_args, source), (flag, d))) end)); val command = Scan.peek (fn d => Scan.optional (Scan.one Token.is_command_modifier ::: improper) [] -- Scan.one Token.is_command -- Scan.repeat tag >> (fn ((cmd_mod, cmd), tags) => map (fn tok => (NONE, (Basic_Token tok, ("", d)))) cmd_mod @ [(SOME (Token.content_of cmd, Token.pos_of cmd, tags), (Basic_Token cmd, (markup_false, d)))])); val cmt = Scan.peek (fn d => (Parse.$$$ "--" || Parse.$$$ Symbol.comment) |-- Parse.!!!! (improper |-- Parse.document_source) >> (fn source => (NONE, (Markup_Token ("cmt", "", source), ("", d))))); val other = Scan.peek (fn d => Parse.not_eof >> (fn tok => (NONE, (Basic_Token tok, ("", d))))); val tokens = (ignored || markup Keyword.is_document_heading Markup_Token markup_true || markup Keyword.is_document_body Markup_Env_Token markup_true || markup Keyword.is_document_raw (Raw_Token o #3) "") >> single || command || (cmt || other) >> single; (* spans *) val is_eof = fn (_, (Basic_Token x, _)) => Token.is_eof x | _ => false; val stopper = Scan.stopper (K (NONE, (Basic_Token Token.eof, ("", 0)))) is_eof; val cmd = Scan.one (is_some o fst); val non_cmd = Scan.one (is_none o fst andf not o is_eof) >> #2; val comments = Scan.many (comment_token o fst o snd); val blank = Scan.one (blank_token o fst o snd); val newline = Scan.one (newline_token o fst o snd); val before_cmd = Scan.option (newline -- comments) -- Scan.option (newline -- comments) -- Scan.option (blank -- comments) -- cmd; val span = Scan.repeat non_cmd -- cmd -- Scan.repeat (Scan.unless before_cmd non_cmd) -- Scan.option (newline >> (single o snd)) >> (fn (((toks1, (cmd, tok2)), toks3), tok4) => make_span (the cmd) (toks1 @ (tok2 :: (toks3 @ the_default [] tok4)))); val spans = toks |> take_suffix Token.is_space |> #1 |> Source.of_list |> Source.source' 0 Token.stopper (Scan.error (Scan.bulk tokens >> flat)) |> Source.source stopper (Scan.error (Scan.bulk span)) |> Source.exhaust; (* present commands *) fun present_command tr span st st' = Toplevel.setmp_thread_position tr (present_span keywords span st st'); fun present _ [] = I | present st (((tr, st'), span) :: rest) = present_command tr span st st' #> present st' rest; in if length command_results = length spans then ((NONE, []), NONE, true, Buffer.empty, (I, I)) |> present Toplevel.toplevel (command_results ~~ spans) |> present_trailer else error "Messed-up outer syntax for presentation" end; fun set_meta_args_parser f = (meta_args_parser_hook:= f) end; (** setup default output **) (* options *) val _ = Theory.setup (add_option @{binding show_types} (Config.put show_types o boolean) #> add_option @{binding show_sorts} (Config.put show_sorts o boolean) #> add_option @{binding show_structs} (Config.put show_structs o boolean) #> add_option @{binding show_question_marks} (Config.put show_question_marks o boolean) #> add_option @{binding show_abbrevs} (Config.put show_abbrevs o boolean) #> add_option @{binding names_long} (Config.put Name_Space.names_long o boolean) #> add_option @{binding names_short} (Config.put Name_Space.names_short o boolean) #> add_option @{binding names_unique} (Config.put Name_Space.names_unique o boolean) #> add_option @{binding eta_contract} (Config.put Syntax_Trans.eta_contract o boolean) #> add_option @{binding display} (Config.put display o boolean) #> add_option @{binding break} (Config.put break o boolean) #> add_option @{binding quotes} (Config.put quotes o boolean) #> add_option @{binding mode} (add_wrapper o Print_Mode.with_modes o single) #> add_option @{binding margin} (Config.put margin o integer) #> add_option @{binding indent} (Config.put indent o integer) #> add_option @{binding source} (Config.put source o boolean) #> add_option @{binding goals_limit} (Config.put Goal_Display.goals_limit o integer)); (* basic pretty printing *) fun perhaps_trim ctxt = not (Config.get ctxt display) ? Symbol.trim_blanks; fun pretty_text ctxt = Pretty.chunks o map Pretty.str o map (perhaps_trim ctxt) o split_lines; fun pretty_term ctxt t = Syntax.pretty_term (Variable.auto_fixes t ctxt) t; fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of; fun pretty_term_style ctxt (style, t) = pretty_term ctxt (style t); fun pretty_thm_style ctxt (style, th) = pretty_term ctxt (style (Thm.full_prop_of th)); fun pretty_term_typ ctxt (style, t) = let val t' = style t in pretty_term ctxt (Type.constraint (Term.fastype_of t') t') end; fun pretty_term_typeof ctxt (style, t) = Syntax.pretty_typ ctxt (Term.fastype_of (style t)); fun pretty_const ctxt c = let val t = Const (c, Consts.type_scheme (Proof_Context.consts_of ctxt) c) handle TYPE (msg, _, _) => error msg; val ([t'], _) = Variable.import_terms true [t] ctxt; in pretty_term ctxt t' end; fun pretty_abbrev ctxt s = let val t = Syntax.read_term (Proof_Context.set_mode Proof_Context.mode_abbrev ctxt) s; fun err () = error ("Abbreviated constant expected: " ^ Syntax.string_of_term ctxt t); val (head, args) = Term.strip_comb t; val (c, T) = Term.dest_Const head handle TERM _ => err (); val (U, u) = Consts.the_abbreviation (Proof_Context.consts_of ctxt) c handle TYPE _ => err (); val t' = Term.betapplys (Envir.expand_atom T (U, u), args); val eq = Logic.mk_equals (t, t'); val ctxt' = Variable.auto_fixes eq ctxt; in Proof_Context.pretty_term_abbrev ctxt' eq end; fun pretty_locale ctxt (name, pos) = let val thy = Proof_Context.theory_of ctxt in (Pretty.str o Locale.extern thy o Locale.check thy) (name, pos) end; fun pretty_class ctxt = Pretty.str o Proof_Context.extern_class ctxt o Proof_Context.read_class ctxt; fun pretty_type ctxt s = let val Type (name, _) = Proof_Context.read_type_name {proper = true, strict = false} ctxt s in Pretty.str (Proof_Context.extern_type ctxt name) end; fun pretty_prf full ctxt = Proof_Syntax.pretty_clean_proof_of ctxt full; fun pretty_theory ctxt (name, pos) = (Theory.check ctxt (name, pos); Pretty.str name); (* default output *) val str_of_source = space_implode " " o map Token.unparse o Token.args_of_src; fun maybe_pretty_source pretty ctxt src xs = map (pretty ctxt) xs (*always pretty in order to exhibit errors!*) |> (if Config.get ctxt source then K [pretty_text ctxt (str_of_source src)] else I); fun string_of_margin ctxt = Pretty.string_of_margin (Config.get ctxt margin); fun output ctxt prts = prts |> Config.get ctxt quotes ? map Pretty.quote |> (if Config.get ctxt display then map (Pretty.indent (Config.get ctxt indent) #> string_of_margin ctxt #> Output.output) #> space_implode "\\isasep\\isanewline%\n" #> Latex.environment "isabelle" else map ((if Config.get ctxt break then string_of_margin ctxt else Pretty.unformatted_string_of) #> Output.output) #> space_implode "\\isasep\\isanewline%\n" #> enclose "\\isa{" "}"); (* verbatim text *) fun verbatim_text ctxt = if Config.get ctxt display then split_lines #> map (prefix (Symbol.spaces (Config.get ctxt indent))) #> cat_lines #> Latex.output_ascii #> Latex.environment "isabellett" else split_lines #> map (Latex.output_ascii #> enclose "\\isatt{" "}") #> space_implode "\\isasep\\isanewline%\n"; (* antiquotations for basic entities *) local fun basic_entities name scan pretty = antiquotation name scan (fn {source, context = ctxt, ...} => output ctxt o maybe_pretty_source pretty ctxt source); fun basic_entities_style name scan pretty = antiquotation name scan (fn {source, context = ctxt, ...} => fn (style, xs) => output ctxt (maybe_pretty_source (fn ctxt => fn x => pretty ctxt (style, x)) ctxt source xs)); fun basic_entity name scan = basic_entities name (scan >> single); in val _ = Theory.setup (basic_entities_style @{binding thm} (Term_Style.parse -- Attrib.thms) pretty_thm_style #> basic_entity @{binding prop} (Term_Style.parse -- Args.prop) pretty_term_style #> basic_entity @{binding term} (Term_Style.parse -- Args.term) pretty_term_style #> basic_entity @{binding term_type} (Term_Style.parse -- Args.term) pretty_term_typ #> basic_entity @{binding typeof} (Term_Style.parse -- Args.term) pretty_term_typeof #> basic_entity @{binding const} (Args.const {proper = true, strict = false}) pretty_const #> basic_entity @{binding abbrev} (Scan.lift Args.embedded_inner_syntax) pretty_abbrev #> basic_entity @{binding typ} Args.typ_abbrev Syntax.pretty_typ #> basic_entity @{binding locale} (Scan.lift (Parse.position Args.name)) pretty_locale #> basic_entity @{binding class} (Scan.lift Args.embedded_inner_syntax) pretty_class #> basic_entity @{binding type} (Scan.lift Args.embedded) pretty_type #> basic_entities @{binding prf} Attrib.thms (pretty_prf false) #> basic_entities @{binding full_prf} Attrib.thms (pretty_prf true) #> basic_entity @{binding theory} (Scan.lift (Parse.position Args.name)) pretty_theory); end; (** document command **) fun document_command markdown (loc, txt) = Toplevel.keep (fn state => (case loc of NONE => ignore (output_text state markdown txt) | SOME (_, pos) => error ("Illegal target specification -- not a theory context" ^ Position.here pos))) o Toplevel.present_local_theory loc (fn state => ignore (output_text state markdown txt)); end;