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