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