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