src/Pure/Thy/thy_output.ML
author wenzelm
Tue Feb 11 17:44:29 2014 +0100 (2014-02-11)
changeset 55431 e0f20a44ff9d
parent 55111 5792f5106c40
child 55526 39708e59f4b0
permissions -rw-r--r--
common Command.Chunk for command source and auxiliary files (static Symbol.Index without actual String content);
more informative type Blob, to allow markup reports;
     1 (*  Title:      Pure/Thy/thy_output.ML
     2     Author:     Markus Wenzel, TU Muenchen
     3 
     4 Theory document output with antiquotations.
     5 *)
     6 
     7 signature THY_OUTPUT =
     8 sig
     9   val display: bool Config.T
    10   val quotes: bool Config.T
    11   val indent: int Config.T
    12   val source: bool Config.T
    13   val break: bool Config.T
    14   val modes: string Config.T
    15   val add_wrapper: ((unit -> string) -> unit -> string) -> Proof.context -> Proof.context
    16   val add_option: binding -> (string -> Proof.context -> Proof.context) -> theory -> theory
    17   val check_command: theory -> xstring * Position.T -> string
    18   val check_option: theory -> xstring * Position.T -> string
    19   val print_antiquotations: Proof.context -> unit
    20   val antiquotation: binding -> 'a context_parser ->
    21     ({source: Args.src, state: Toplevel.state, context: Proof.context} -> 'a -> string) ->
    22       theory -> theory
    23   val boolean: string -> bool
    24   val integer: string -> int
    25   datatype markup = Markup | MarkupEnv | Verbatim
    26   val eval_antiq: Scan.lexicon -> Toplevel.state -> Symbol_Pos.T list * Position.range -> string
    27   val eval_antiquote: Scan.lexicon -> Toplevel.state -> Symbol_Pos.text * Position.T -> string
    28   val check_text: Symbol_Pos.text * Position.T -> Toplevel.state -> unit
    29   val present_thy: Scan.lexicon -> (string -> string list) -> (markup -> string -> bool) ->
    30     (Toplevel.transition * Toplevel.state) list -> Token.T list -> Buffer.T
    31   val pretty_text: Proof.context -> string -> Pretty.T
    32   val pretty_term: Proof.context -> term -> Pretty.T
    33   val pretty_thm: Proof.context -> thm -> Pretty.T
    34   val str_of_source: Args.src -> string
    35   val maybe_pretty_source: (Proof.context -> 'a -> Pretty.T) -> Proof.context ->
    36     Args.src -> 'a list -> Pretty.T list
    37   val output: Proof.context -> Pretty.T list -> string
    38   val verb_text: string -> string
    39 end;
    40 
    41 structure Thy_Output: THY_OUTPUT =
    42 struct
    43 
    44 (** options **)
    45 
    46 val display = Attrib.setup_option_bool "thy_output_display";
    47 val break = Attrib.setup_option_bool "thy_output_break";
    48 val quotes = Attrib.setup_option_bool "thy_output_quotes";
    49 val indent = Attrib.setup_option_int "thy_output_indent";
    50 val source = Attrib.setup_option_bool "thy_output_source";
    51 val modes = Attrib.setup_option_string "thy_output_modes";
    52 
    53 
    54 structure Wrappers = Proof_Data
    55 (
    56   type T = ((unit -> string) -> unit -> string) list;
    57   fun init _ = [];
    58 );
    59 
    60 fun add_wrapper wrapper = Wrappers.map (cons wrapper);
    61 
    62 val wrap = Wrappers.get #> fold (fn wrapper => fn f => wrapper f);
    63 
    64 
    65 
    66 (** maintain global antiquotations **)
    67 
    68 structure Antiquotations = Theory_Data
    69 (
    70   type T =
    71     (Args.src -> Toplevel.state -> Proof.context -> string) Name_Space.table *
    72       (string -> Proof.context -> Proof.context) Name_Space.table;
    73   val empty : T =
    74     (Name_Space.empty_table Markup.document_antiquotationN,
    75       Name_Space.empty_table Markup.document_antiquotation_optionN);
    76   val extend = I;
    77   fun merge ((commands1, options1), (commands2, options2)) : T =
    78     (Name_Space.merge_tables (commands1, commands2),
    79       Name_Space.merge_tables (options1, options2));
    80 );
    81 
    82 fun add_command name cmd thy = thy
    83   |> Antiquotations.map (apfst (Name_Space.define (Context.Theory thy) true (name, cmd) #> snd));
    84 
    85 fun add_option name opt thy = thy
    86   |> Antiquotations.map (apsnd (Name_Space.define (Context.Theory thy) true (name, opt) #> snd));
    87 
    88 fun check_command thy = #1 o Name_Space.check (Context.Theory thy) (#1 (Antiquotations.get thy));
    89 
    90 fun check_option thy = #1 o Name_Space.check (Context.Theory thy) (#2 (Antiquotations.get thy));
    91 
    92 fun command src state ctxt =
    93   let
    94     val thy = Proof_Context.theory_of ctxt;
    95     val ((xname, _), pos) = Args.dest_src src;
    96     val (name, f) = Name_Space.check (Context.Proof ctxt) (#1 (Antiquotations.get thy)) (xname, pos);
    97   in
    98     f src state ctxt handle ERROR msg =>
    99       cat_error msg ("The error(s) above occurred in document antiquotation: " ^
   100         quote name ^ Position.here pos)
   101   end;
   102 
   103 fun option ((xname, pos), s) ctxt =
   104   let
   105     val thy = Proof_Context.theory_of ctxt;
   106     val (_, opt) = Name_Space.check (Context.Proof ctxt) (#2 (Antiquotations.get thy)) (xname, pos);
   107   in opt s ctxt end;
   108 
   109 fun print_antiquotations ctxt =
   110   let
   111     val thy = Proof_Context.theory_of ctxt;
   112     val (commands, options) = Antiquotations.get thy;
   113     val command_names = map #1 (Name_Space.extern_table ctxt commands);
   114     val option_names = map #1 (Name_Space.extern_table ctxt options);
   115   in
   116     [Pretty.big_list "document antiquotations:" (map Pretty.mark_str command_names),
   117       Pretty.big_list "document antiquotation options:" (map Pretty.mark_str option_names)]
   118     |> Pretty.chunks |> Pretty.writeln
   119   end;
   120 
   121 fun antiquotation name scan out =
   122   add_command name
   123     (fn src => fn state => fn ctxt =>
   124       let val (x, ctxt') = Args.context_syntax "document antiquotation" scan src ctxt
   125       in out {source = src, state = state, context = ctxt'} x end);
   126 
   127 
   128 
   129 (** syntax of antiquotations **)
   130 
   131 (* option values *)
   132 
   133 fun boolean "" = true
   134   | boolean "true" = true
   135   | boolean "false" = false
   136   | boolean s = error ("Bad boolean value: " ^ quote s);
   137 
   138 fun integer s =
   139   let
   140     fun int ss =
   141       (case Library.read_int ss of (i, []) => i
   142       | _ => error ("Bad integer value: " ^ quote s));
   143   in (case Symbol.explode s of "-" :: ss => ~ (int ss) | ss => int ss) end;
   144 
   145 
   146 (* outer syntax *)
   147 
   148 local
   149 
   150 val property =
   151   Parse.position Parse.xname -- Scan.optional (Parse.$$$ "=" |-- Parse.!!! Parse.xname) "";
   152 
   153 val properties =
   154   Scan.optional (Parse.$$$ "[" |-- Parse.!!! (Parse.enum "," property --| Parse.$$$ "]")) [];
   155 
   156 in
   157 
   158 val antiq =
   159   Parse.!!!
   160     (Parse.position Parse.liberal_name -- properties -- Args.parse --| Scan.ahead Parse.eof)
   161   >> (fn (((x, pos), y), z) => (y, Args.src ((x, z), pos)));
   162 
   163 end;
   164 
   165 
   166 (* eval_antiquote *)
   167 
   168 fun eval_antiq lex state (ss, (pos, _)) =
   169   let
   170     val (opts, src) = Token.read_antiq lex antiq (ss, pos);
   171     fun cmd ctxt = wrap ctxt (fn () => command src state ctxt) ();
   172     val preview_ctxt = fold option opts (Toplevel.presentation_context_of state);
   173     val print_ctxt = Context_Position.set_visible false preview_ctxt;
   174     val _ = cmd preview_ctxt;
   175     val print_modes = space_explode "," (Config.get print_ctxt modes) @ Latex.modes;
   176   in Print_Mode.with_modes print_modes (fn () => cmd print_ctxt) () end;
   177 
   178 fun eval_antiquote lex state (txt, pos) =
   179   let
   180     fun expand (Antiquote.Text ss) = Symbol_Pos.content ss
   181       | expand (Antiquote.Antiq antiq) = eval_antiq lex state antiq;
   182     val ants = Antiquote.read (Symbol_Pos.explode (txt, pos), pos);
   183   in
   184     if Toplevel.is_toplevel state andalso not (forall Antiquote.is_text ants) then
   185       error ("Unknown context -- cannot expand document antiquotations" ^ Position.here pos)
   186     else implode (map expand ants)
   187   end;
   188 
   189 
   190 fun check_text (txt, pos) state =
   191  (Position.report pos Markup.document_source;
   192   if Toplevel.is_skipped_proof state then ()
   193   else ignore (eval_antiquote (#1 (Keyword.get_lexicons ())) state (txt, pos)));
   194 
   195 
   196 
   197 (** present theory source **)
   198 
   199 (*NB: arranging white space around command spans is a black art.*)
   200 
   201 (* presentation tokens *)
   202 
   203 datatype token =
   204     NoToken
   205   | BasicToken of Token.T
   206   | MarkupToken of string * (string * Position.T)
   207   | MarkupEnvToken of string * (string * Position.T)
   208   | VerbatimToken of string * Position.T;
   209 
   210 fun output_token lex state =
   211   let val eval = eval_antiquote lex state in
   212     fn NoToken => ""
   213      | BasicToken tok => Latex.output_basic tok
   214      | MarkupToken (cmd, txt) => Latex.output_markup cmd (eval txt)
   215      | MarkupEnvToken (cmd, txt) => Latex.output_markup_env cmd (eval txt)
   216      | VerbatimToken txt => Latex.output_verbatim (eval txt)
   217   end;
   218 
   219 fun basic_token pred (BasicToken tok) = pred tok
   220   | basic_token _ _ = false;
   221 
   222 val improper_token = basic_token Token.is_improper;
   223 val comment_token = basic_token Token.is_comment;
   224 val blank_token = basic_token Token.is_blank;
   225 val newline_token = basic_token Token.is_newline;
   226 
   227 
   228 (* command spans *)
   229 
   230 type command = string * Position.T * string list;   (*name, position, tags*)
   231 type source = (token * (string * int)) list;        (*token, markup flag, meta-comment depth*)
   232 
   233 datatype span = Span of command * (source * source * source * source) * bool;
   234 
   235 fun make_span cmd src =
   236   let
   237     fun take_newline (tok :: toks) =
   238           if newline_token (fst tok) then ([tok], toks, true)
   239           else ([], tok :: toks, false)
   240       | take_newline [] = ([], [], false);
   241     val (((src_prefix, src_main), src_suffix1), (src_suffix2, src_appendix, newline)) =
   242       src
   243       |> take_prefix (improper_token o fst)
   244       ||>> take_suffix (improper_token o fst)
   245       ||>> take_prefix (comment_token o fst)
   246       ||> take_newline;
   247   in Span (cmd, (src_prefix, src_main, src_suffix1 @ src_suffix2, src_appendix), newline) end;
   248 
   249 
   250 (* present spans *)
   251 
   252 local
   253 
   254 fun err_bad_nesting pos =
   255   error ("Bad nesting of commands in presentation" ^ pos);
   256 
   257 fun edge which f (x: string option, y) =
   258   if x = y then I
   259   else (case which (x, y) of NONE => I | SOME txt => Buffer.add (f txt));
   260 
   261 val begin_tag = edge #2 Latex.begin_tag;
   262 val end_tag = edge #1 Latex.end_tag;
   263 fun open_delim delim e = edge #2 Latex.begin_delim e #> delim #> edge #2 Latex.end_delim e;
   264 fun close_delim delim e = edge #1 Latex.begin_delim e #> delim #> edge #1 Latex.end_delim e;
   265 
   266 in
   267 
   268 fun present_span lex default_tags span state state'
   269     (tag_stack, active_tag, newline, buffer, present_cont) =
   270   let
   271     val present = fold (fn (tok, (flag, 0)) =>
   272         Buffer.add (output_token lex state' tok)
   273         #> Buffer.add flag
   274       | _ => I);
   275 
   276     val Span ((cmd_name, cmd_pos, cmd_tags), srcs, span_newline) = span;
   277 
   278     val (tag, tags) = tag_stack;
   279     val tag' = try hd (fold (update (op =)) cmd_tags (the_list tag));
   280 
   281     val active_tag' =
   282       if is_some tag' then tag'
   283       else if cmd_name = "end" andalso not (Toplevel.is_toplevel state') then NONE
   284       else try hd (default_tags cmd_name);
   285     val edge = (active_tag, active_tag');
   286 
   287     val newline' =
   288       if is_none active_tag' then span_newline else newline;
   289 
   290     val nesting = Toplevel.level state' - Toplevel.level state;
   291     val tag_stack' =
   292       if nesting = 0 andalso not (Toplevel.is_proof state) then tag_stack
   293       else if nesting >= 0 then (tag', replicate nesting tag @ tags)
   294       else
   295         (case drop (~ nesting - 1) tags of
   296           tgs :: tgss => (tgs, tgss)
   297         | [] => err_bad_nesting (Position.here cmd_pos));
   298 
   299     val buffer' =
   300       buffer
   301       |> end_tag edge
   302       |> close_delim (fst present_cont) edge
   303       |> snd present_cont
   304       |> open_delim (present (#1 srcs)) edge
   305       |> begin_tag edge
   306       |> present (#2 srcs);
   307     val present_cont' =
   308       if newline then (present (#3 srcs), present (#4 srcs))
   309       else (I, present (#3 srcs) #> present (#4 srcs));
   310   in (tag_stack', active_tag', newline', buffer', present_cont') end;
   311 
   312 fun present_trailer ((_, tags), active_tag, _, buffer, present_cont) =
   313   if not (null tags) then err_bad_nesting " at end of theory"
   314   else
   315     buffer
   316     |> end_tag (active_tag, NONE)
   317     |> close_delim (fst present_cont) (active_tag, NONE)
   318     |> snd present_cont;
   319 
   320 end;
   321 
   322 
   323 (* present_thy *)
   324 
   325 datatype markup = Markup | MarkupEnv | Verbatim;
   326 
   327 local
   328 
   329 val space_proper =
   330   Scan.one Token.is_blank -- Scan.many Token.is_comment -- Scan.one Token.is_proper;
   331 
   332 val is_improper = not o (Token.is_proper orf Token.is_begin_ignore orf Token.is_end_ignore);
   333 val improper = Scan.many is_improper;
   334 val improper_end = Scan.repeat (Scan.unless space_proper (Scan.one is_improper));
   335 val blank_end = Scan.repeat (Scan.unless space_proper (Scan.one Token.is_blank));
   336 
   337 val opt_newline = Scan.option (Scan.one Token.is_newline);
   338 
   339 val ignore =
   340   Scan.depend (fn d => opt_newline |-- Scan.one Token.is_begin_ignore
   341     >> pair (d + 1)) ||
   342   Scan.depend (fn d => Scan.one Token.is_end_ignore --|
   343     (if d = 0 then Scan.fail_with (K (fn () => "Bad nesting of meta-comments")) else opt_newline)
   344     >> pair (d - 1));
   345 
   346 val tag = (improper -- Parse.$$$ "%" -- improper) |-- Parse.!!! (Parse.tag_name --| blank_end);
   347 
   348 val locale =
   349   Scan.option ((Parse.$$$ "(" -- improper -- Parse.$$$ "in") |--
   350     Parse.!!! (improper |-- Parse.xname --| (improper -- Parse.$$$ ")")));
   351 
   352 in
   353 
   354 fun present_thy lex default_tags is_markup command_results toks =
   355   let
   356     (* tokens *)
   357 
   358     val ignored = Scan.state --| ignore
   359       >> (fn d => (NONE, (NoToken, ("", d))));
   360 
   361     fun markup mark mk flag = Scan.peek (fn d =>
   362       improper |--
   363         Parse.position (Scan.one (Token.is_command andf is_markup mark o Token.content_of)) --
   364       Scan.repeat tag --
   365       Parse.!!!! ((improper -- locale -- improper) |-- Parse.document_source --| improper_end)
   366       >> (fn (((tok, pos), tags), txt) =>
   367         let val name = Token.content_of tok
   368         in (SOME (name, pos, tags), (mk (name, txt), (flag, d))) end));
   369 
   370     val command = Scan.peek (fn d =>
   371       Parse.position (Scan.one (Token.is_command)) --
   372       Scan.repeat tag
   373       >> (fn ((tok, pos), tags) =>
   374         let val name = Token.content_of tok
   375         in (SOME (name, pos, tags), (BasicToken tok, (Latex.markup_false, d))) end));
   376 
   377     val cmt = Scan.peek (fn d =>
   378       Parse.$$$ "--" |-- Parse.!!!! (improper |-- Parse.document_source)
   379       >> (fn txt => (NONE, (MarkupToken ("cmt", txt), ("", d)))));
   380 
   381     val other = Scan.peek (fn d =>
   382        Parse.not_eof >> (fn tok => (NONE, (BasicToken tok, ("", d)))));
   383 
   384     val token =
   385       ignored ||
   386       markup Markup MarkupToken Latex.markup_true ||
   387       markup MarkupEnv MarkupEnvToken Latex.markup_true ||
   388       markup Verbatim (VerbatimToken o #2) "" ||
   389       command || cmt || other;
   390 
   391 
   392     (* spans *)
   393 
   394     val is_eof = fn (_, (BasicToken x, _)) => Token.is_eof x | _ => false;
   395     val stopper = Scan.stopper (K (NONE, (BasicToken Token.eof, ("", 0)))) is_eof;
   396 
   397     val cmd = Scan.one (is_some o fst);
   398     val non_cmd = Scan.one (is_none o fst andf not o is_eof) >> #2;
   399 
   400     val comments = Scan.many (comment_token o fst o snd);
   401     val blank = Scan.one (blank_token o fst o snd);
   402     val newline = Scan.one (newline_token o fst o snd);
   403     val before_cmd =
   404       Scan.option (newline -- comments) --
   405       Scan.option (newline -- comments) --
   406       Scan.option (blank -- comments) -- cmd;
   407 
   408     val span =
   409       Scan.repeat non_cmd -- cmd --
   410         Scan.repeat (Scan.unless before_cmd non_cmd) --
   411         Scan.option (newline >> (single o snd))
   412       >> (fn (((toks1, (cmd, tok2)), toks3), tok4) =>
   413           make_span (the cmd) (toks1 @ (tok2 :: (toks3 @ the_default [] tok4))));
   414 
   415     val spans =
   416       Source.of_list (filter_out Token.is_semicolon toks)
   417       |> Source.source' 0 Token.stopper (Scan.error (Scan.bulk token)) NONE
   418       |> Source.source stopper (Scan.error (Scan.bulk span)) NONE
   419       |> Source.exhaust;
   420 
   421 
   422     (* present commands *)
   423 
   424     fun present_command tr span st st' =
   425       Toplevel.setmp_thread_position tr (present_span lex default_tags span st st');
   426 
   427     fun present _ [] = I
   428       | present st (((tr, st'), span) :: rest) = present_command tr span st st' #> present st' rest;
   429   in
   430     if length command_results = length spans then
   431       ((NONE, []), NONE, true, Buffer.empty, (I, I))
   432       |> present Toplevel.toplevel (command_results ~~ spans)
   433       |> present_trailer
   434     else error "Messed-up outer syntax for presentation"
   435   end;
   436 
   437 end;
   438 
   439 
   440 
   441 (** setup default output **)
   442 
   443 (* options *)
   444 
   445 val _ = Theory.setup
   446  (add_option (Binding.name "show_types") (Config.put show_types o boolean) #>
   447   add_option (Binding.name "show_sorts") (Config.put show_sorts o boolean) #>
   448   add_option (Binding.name "show_structs") (Config.put show_structs o boolean) #>
   449   add_option (Binding.name "show_question_marks") (Config.put show_question_marks o boolean) #>
   450   add_option (Binding.name "show_abbrevs") (Config.put show_abbrevs o boolean) #>
   451   add_option (Binding.name "names_long") (Config.put Name_Space.names_long o boolean) #>
   452   add_option (Binding.name "names_short") (Config.put Name_Space.names_short o boolean) #>
   453   add_option (Binding.name "names_unique") (Config.put Name_Space.names_unique o boolean) #>
   454   add_option (Binding.name "eta_contract") (Config.put Syntax_Trans.eta_contract o boolean) #>
   455   add_option (Binding.name "display") (Config.put display o boolean) #>
   456   add_option (Binding.name "break") (Config.put break o boolean) #>
   457   add_option (Binding.name "quotes") (Config.put quotes o boolean) #>
   458   add_option (Binding.name "mode") (add_wrapper o Print_Mode.with_modes o single) #>
   459   add_option (Binding.name "margin") (add_wrapper o setmp_CRITICAL Pretty.margin_default o integer) #>
   460   add_option (Binding.name "indent") (Config.put indent o integer) #>
   461   add_option (Binding.name "source") (Config.put source o boolean) #>
   462   add_option (Binding.name "goals_limit") (Config.put Goal_Display.goals_limit o integer));
   463 
   464 
   465 (* basic pretty printing *)
   466 
   467 fun tweak_line ctxt s =
   468   if Config.get ctxt display then s else Symbol.strip_blanks s;
   469 
   470 fun pretty_text ctxt =
   471   Pretty.chunks o map Pretty.str o map (tweak_line ctxt) o split_lines;
   472 
   473 fun pretty_term ctxt t = Syntax.pretty_term (Variable.auto_fixes t ctxt) t;
   474 
   475 fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of;
   476 
   477 fun pretty_term_style ctxt (style, t) =
   478   pretty_term ctxt (style t);
   479 
   480 fun pretty_thm_style ctxt (style, th) =
   481   pretty_term ctxt (style (Thm.full_prop_of th));
   482 
   483 fun pretty_term_typ ctxt (style, t) =
   484   let val t' = style t
   485   in pretty_term ctxt (Type.constraint (Term.fastype_of t') t') end;
   486 
   487 fun pretty_term_typeof ctxt (style, t) =
   488   Syntax.pretty_typ ctxt (Term.fastype_of (style t));
   489 
   490 fun pretty_const ctxt c =
   491   let
   492     val t = Const (c, Consts.type_scheme (Proof_Context.consts_of ctxt) c)
   493       handle TYPE (msg, _, _) => error msg;
   494     val ([t'], _) = Variable.import_terms true [t] ctxt;
   495   in pretty_term ctxt t' end;
   496 
   497 fun pretty_abbrev ctxt s =
   498   let
   499     val t = Syntax.read_term (Proof_Context.set_mode Proof_Context.mode_abbrev ctxt) s;
   500     fun err () = error ("Abbreviated constant expected: " ^ Syntax.string_of_term ctxt t);
   501     val (head, args) = Term.strip_comb t;
   502     val (c, T) = Term.dest_Const head handle TERM _ => err ();
   503     val (U, u) = Consts.the_abbreviation (Proof_Context.consts_of ctxt) c
   504       handle TYPE _ => err ();
   505     val t' = Term.betapplys (Envir.expand_atom T (U, u), args);
   506     val eq = Logic.mk_equals (t, t');
   507     val ctxt' = Variable.auto_fixes eq ctxt;
   508   in Proof_Context.pretty_term_abbrev ctxt' eq end;
   509 
   510 fun pretty_class ctxt =
   511   Pretty.str o Proof_Context.extern_class ctxt o Proof_Context.read_class ctxt;
   512 
   513 fun pretty_type ctxt s =
   514   let val Type (name, _) = Proof_Context.read_type_name_proper ctxt false s
   515   in Pretty.str (Proof_Context.extern_type ctxt name) end;
   516 
   517 fun pretty_prf full ctxt = Proof_Syntax.pretty_proof_of ctxt full;
   518 
   519 fun pretty_theory ctxt (name, pos) =
   520   (case find_first (fn thy => Context.theory_name thy = name)
   521       (Theory.nodes_of (Proof_Context.theory_of ctxt)) of
   522     NONE => error ("No ancestor theory " ^ quote name ^ Position.here pos)
   523   | SOME thy => (Position.report pos (Theory.get_markup thy); Pretty.str name));
   524 
   525 
   526 (* default output *)
   527 
   528 val str_of_source = space_implode " " o map Token.unparse o #2 o #1 o Args.dest_src;
   529 
   530 fun maybe_pretty_source pretty ctxt src xs =
   531   map (pretty ctxt) xs  (*always pretty in order to exhibit errors!*)
   532   |> (if Config.get ctxt source then K [pretty_text ctxt (str_of_source src)] else I);
   533 
   534 fun output ctxt prts =
   535   prts
   536   |> (if Config.get ctxt quotes then map Pretty.quote else I)
   537   |> (if Config.get ctxt display then
   538     map (Output.output o Pretty.string_of o Pretty.indent (Config.get ctxt indent))
   539     #> space_implode "\\isasep\\isanewline%\n"
   540     #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
   541   else
   542     map (Output.output o (if Config.get ctxt break then Pretty.string_of else Pretty.str_of))
   543     #> space_implode "\\isasep\\isanewline%\n"
   544     #> enclose "\\isa{" "}");
   545 
   546 
   547 
   548 (** concrete antiquotations **)
   549 
   550 (* basic entities *)
   551 
   552 local
   553 
   554 fun basic_entities name scan pretty = antiquotation name scan
   555   (fn {source, context, ...} => output context o maybe_pretty_source pretty context source);
   556 
   557 fun basic_entities_style name scan pretty = antiquotation name scan
   558   (fn {source, context, ...} => fn (style, xs) =>
   559     output context
   560       (maybe_pretty_source (fn ctxt => fn x => pretty ctxt (style, x)) context source xs));
   561 
   562 fun basic_entity name scan = basic_entities name (scan >> single);
   563 
   564 in
   565 
   566 val _ = Theory.setup
   567  (basic_entities_style (Binding.name "thm") (Term_Style.parse -- Attrib.thms) pretty_thm_style #>
   568   basic_entity (Binding.name "prop") (Term_Style.parse -- Args.prop) pretty_term_style #>
   569   basic_entity (Binding.name "term") (Term_Style.parse -- Args.term) pretty_term_style #>
   570   basic_entity (Binding.name "term_type") (Term_Style.parse -- Args.term) pretty_term_typ #>
   571   basic_entity (Binding.name "typeof") (Term_Style.parse -- Args.term) pretty_term_typeof #>
   572   basic_entity (Binding.name "const") (Args.const_proper false) pretty_const #>
   573   basic_entity (Binding.name "abbrev") (Scan.lift Args.name_inner_syntax) pretty_abbrev #>
   574   basic_entity (Binding.name "typ") Args.typ_abbrev Syntax.pretty_typ #>
   575   basic_entity (Binding.name "class") (Scan.lift Args.name_inner_syntax) pretty_class #>
   576   basic_entity (Binding.name "type") (Scan.lift Args.name) pretty_type #>
   577   basic_entity (Binding.name "text") (Scan.lift Args.name) pretty_text #>
   578   basic_entities (Binding.name "prf") Attrib.thms (pretty_prf false) #>
   579   basic_entities (Binding.name "full_prf") Attrib.thms (pretty_prf true) #>
   580   basic_entity (Binding.name "theory") (Scan.lift (Parse.position Args.name)) pretty_theory);
   581 
   582 end;
   583 
   584 
   585 (* goal state *)
   586 
   587 local
   588 
   589 fun proof_state state =
   590   (case try (Proof.goal o Toplevel.proof_of) state of
   591     SOME {goal, ...} => goal
   592   | _ => error "No proof state");
   593 
   594 fun goal_state name main = antiquotation name (Scan.succeed ())
   595   (fn {state, context = ctxt, ...} => fn () => output ctxt
   596     [Goal_Display.pretty_goal
   597       (Config.put Goal_Display.show_main_goal main ctxt) (proof_state state)]);
   598 
   599 in
   600 
   601 val _ = Theory.setup
   602  (goal_state (Binding.name "goals") true #>
   603   goal_state (Binding.name "subgoals") false);
   604 
   605 end;
   606 
   607 
   608 (* embedded lemma *)
   609 
   610 val _ = Keyword.define ("by", NONE);  (*overlap with command category*)
   611 
   612 val _ = Theory.setup
   613   (antiquotation (Binding.name "lemma")
   614     (Args.prop -- Scan.lift (Args.$$$ "by" |-- Method.parse -- Scan.option Method.parse))
   615     (fn {source, context, ...} => fn (prop, methods) =>
   616       let
   617         val prop_src =
   618           (case Args.dest_src source of ((a, arg :: _), pos) => Args.src ((a, [arg]), pos));
   619         (* FIXME check proof!? *)
   620         val _ = context
   621           |> Proof.theorem NONE (K I) [[(prop, [])]]
   622           |> Proof.global_terminal_proof methods;
   623       in output context (maybe_pretty_source pretty_term context prop_src [prop]) end));
   624 
   625 
   626 (* ML text *)
   627 
   628 val verb_text =
   629   split_lines
   630   #> map (space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|")
   631   #> space_implode "\\isasep\\isanewline%\n";
   632 
   633 local
   634 
   635 fun ml_text name ml = antiquotation name (Scan.lift Args.name_source_position)
   636   (fn {context, ...} => fn (txt, pos) =>
   637    (ML_Context.eval_in (SOME context) false pos (ml pos txt);
   638     Symbol_Pos.content (Symbol_Pos.explode (txt, pos))
   639     |> (if Config.get context quotes then quote else I)
   640     |> (if Config.get context display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
   641         else verb_text)));
   642 
   643 fun ml_enclose bg en pos txt =
   644   ML_Lex.read Position.none bg @ ML_Lex.read pos txt @ ML_Lex.read Position.none en;
   645 
   646 in
   647 
   648 val _ = Theory.setup
   649  (ml_text (Binding.name "ML") (ml_enclose "fn _ => (" ");") #>
   650   ml_text (Binding.name "ML_op") (ml_enclose "fn _ => (op " ");") #>
   651   ml_text (Binding.name "ML_type") (ml_enclose "val _ = NONE : (" ") option;") #>
   652   ml_text (Binding.name "ML_struct")
   653     (ml_enclose "functor XXX() = struct structure XX = " " end;") #>
   654 
   655   ml_text (Binding.name "ML_functor")   (* FIXME formal treatment of functor name (!?) *)
   656     (fn pos => fn txt =>
   657       ML_Lex.read Position.none ("ML_Env.check_functor " ^
   658         ML_Syntax.print_string (Symbol_Pos.content (Symbol_Pos.explode (txt, pos))))) #>
   659 
   660   ml_text (Binding.name "ML_text") (K (K [])));
   661 
   662 end;
   663 
   664 
   665 (* URLs *)
   666 
   667 val _ = Theory.setup
   668   (antiquotation (Binding.name "url") (Scan.lift (Parse.position Parse.name))
   669     (fn {context = ctxt, ...} => fn (name, pos) =>
   670       (Position.report pos (Markup.url name); enclose "\\url{" "}" name)));
   671 
   672 end;