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