src/Pure/Thy/thy_output.ML
author wenzelm
Sat May 15 23:16:32 2010 +0200 (2010-05-15)
changeset 36950 75b8f26f2f07
parent 36745 403585a89772
child 36959 f5417836dbea
permissions -rw-r--r--
refer directly to structure Keyword and Parse;
eliminated old-style structure aliases K and P;
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@32738
     9
  val display: bool Unsynchronized.ref
wenzelm@32738
    10
  val quotes: bool Unsynchronized.ref
wenzelm@32738
    11
  val indent: int Unsynchronized.ref
wenzelm@32738
    12
  val source: bool Unsynchronized.ref
wenzelm@32738
    13
  val break: bool Unsynchronized.ref
wenzelm@30367
    14
  val add_commands: (string * (Args.src -> Toplevel.state -> string)) list -> unit
wenzelm@22124
    15
  val add_options: (string * (string -> (unit -> string) -> unit -> string)) list -> unit
wenzelm@26893
    16
  val defined_command: string -> bool
wenzelm@26893
    17
  val defined_option: string -> bool
wenzelm@22124
    18
  val print_antiquotations: unit -> unit
wenzelm@22124
    19
  val boolean: string -> bool
wenzelm@22124
    20
  val integer: string -> int
wenzelm@30513
    21
  val antiquotation: string -> 'a context_parser ->
wenzelm@30381
    22
    ({state: Toplevel.state, source: Args.src, context: Proof.context} -> 'a -> string) -> unit
wenzelm@22124
    23
  datatype markup = Markup | MarkupEnv | Verbatim
wenzelm@32738
    24
  val modes: string list Unsynchronized.ref
wenzelm@30573
    25
  val eval_antiquote: Scan.lexicon -> Toplevel.state -> Symbol_Pos.text * Position.T -> string
wenzelm@28427
    26
  val present_thy: Scan.lexicon -> (string -> string list) -> (markup -> string -> bool) ->
wenzelm@28427
    27
    (Toplevel.transition * Toplevel.state) list -> (OuterLex.token, 'a) Source.source -> Buffer.T
wenzelm@28644
    28
  val pretty_text: string -> Pretty.T
wenzelm@28644
    29
  val pretty_term: Proof.context -> term -> Pretty.T
wenzelm@28644
    30
  val pretty_thm: Proof.context -> thm -> Pretty.T
wenzelm@30390
    31
  val str_of_source: Args.src -> string
wenzelm@30390
    32
  val maybe_pretty_source: ('a -> Pretty.T) -> Args.src -> 'a list -> Pretty.T list
wenzelm@30390
    33
  val output: Pretty.T list -> string
wenzelm@22124
    34
end;
wenzelm@22124
    35
wenzelm@22124
    36
structure ThyOutput: THY_OUTPUT =
wenzelm@22124
    37
struct
wenzelm@22124
    38
wenzelm@22124
    39
structure T = OuterLex;
wenzelm@22124
    40
wenzelm@22124
    41
wenzelm@22124
    42
(** global options **)
wenzelm@22124
    43
wenzelm@32738
    44
val display = Unsynchronized.ref false;
wenzelm@32738
    45
val quotes = Unsynchronized.ref false;
wenzelm@32738
    46
val indent = Unsynchronized.ref 0;
wenzelm@32738
    47
val source = Unsynchronized.ref false;
wenzelm@32738
    48
val break = Unsynchronized.ref false;
wenzelm@22124
    49
wenzelm@22124
    50
wenzelm@22124
    51
wenzelm@30390
    52
(** maintain global antiquotations **)
wenzelm@22124
    53
wenzelm@22124
    54
local
wenzelm@22124
    55
wenzelm@22124
    56
val global_commands =
wenzelm@32738
    57
  Unsynchronized.ref (Symtab.empty: (Args.src -> Toplevel.state -> string) Symtab.table);
wenzelm@22124
    58
wenzelm@22124
    59
val global_options =
wenzelm@32738
    60
  Unsynchronized.ref (Symtab.empty: (string -> (unit -> string) -> unit -> string) Symtab.table);
wenzelm@22124
    61
wenzelm@22124
    62
fun add_item kind (name, x) tab =
wenzelm@22124
    63
 (if not (Symtab.defined tab name) then ()
wenzelm@27897
    64
  else warning ("Redefined document antiquotation " ^ kind ^ ": " ^ quote name);
wenzelm@22124
    65
  Symtab.update (name, x) tab);
wenzelm@22124
    66
wenzelm@22124
    67
in
wenzelm@22124
    68
wenzelm@32738
    69
fun add_commands xs =
wenzelm@32738
    70
  CRITICAL (fn () => Unsynchronized.change global_commands (fold (add_item "command") xs));
wenzelm@32738
    71
fun add_options xs =
wenzelm@32738
    72
  CRITICAL (fn () => Unsynchronized.change global_options (fold (add_item "option") xs));
wenzelm@22124
    73
wenzelm@26893
    74
fun defined_command name = Symtab.defined (! global_commands) name;
wenzelm@26893
    75
fun defined_option name = Symtab.defined (! global_options) name;
wenzelm@26893
    76
wenzelm@22124
    77
fun command src =
wenzelm@22124
    78
  let val ((name, _), pos) = Args.dest_src src in
wenzelm@22124
    79
    (case Symtab.lookup (! global_commands) name of
wenzelm@30317
    80
      NONE => error ("Unknown document antiquotation: " ^ quote name ^ Position.str_of pos)
wenzelm@30317
    81
    | SOME f =>
wenzelm@30317
    82
       (Position.report (Markup.doc_antiq name) pos;
wenzelm@30367
    83
        (fn state => f src state handle ERROR msg =>
wenzelm@30317
    84
          cat_error msg ("The error(s) above occurred in document antiquotation: " ^
wenzelm@30317
    85
            quote name ^ Position.str_of pos))))
wenzelm@22124
    86
  end;
wenzelm@22124
    87
wenzelm@22124
    88
fun option (name, s) f () =
wenzelm@22124
    89
  (case Symtab.lookup (! global_options) name of
wenzelm@27897
    90
    NONE => error ("Unknown document antiquotation option: " ^ quote name)
wenzelm@22124
    91
  | SOME opt => opt s f ());
wenzelm@22124
    92
wenzelm@22124
    93
fun options [] f = f
wenzelm@22124
    94
  | options (opt :: opts) f = option opt (options opts f);
wenzelm@22124
    95
wenzelm@22124
    96
wenzelm@22124
    97
fun print_antiquotations () =
wenzelm@27897
    98
 [Pretty.big_list "document antiquotation commands:"
wenzelm@23272
    99
    (map Pretty.str (sort_strings (Symtab.keys (! global_commands)))),
wenzelm@27897
   100
  Pretty.big_list "document antiquotation options:"
wenzelm@23272
   101
    (map Pretty.str (sort_strings (Symtab.keys (! global_options))))]
wenzelm@22124
   102
 |> Pretty.chunks |> Pretty.writeln;
wenzelm@22124
   103
wenzelm@22124
   104
end;
wenzelm@22124
   105
wenzelm@30390
   106
fun antiquotation name scan out = add_commands [(name, fn src => fn state =>
wenzelm@30390
   107
  let val (x, ctxt) = Args.context_syntax "document antiquotation"
wenzelm@30398
   108
    scan src (Toplevel.presentation_context_of state)
wenzelm@30390
   109
  in out {source = src, state = state, context = ctxt} x end)];
wenzelm@30390
   110
wenzelm@22124
   111
wenzelm@22124
   112
wenzelm@22124
   113
(** syntax of antiquotations **)
wenzelm@22124
   114
wenzelm@22124
   115
(* option values *)
wenzelm@22124
   116
wenzelm@22124
   117
fun boolean "" = true
wenzelm@22124
   118
  | boolean "true" = true
wenzelm@22124
   119
  | boolean "false" = false
wenzelm@22124
   120
  | boolean s = error ("Bad boolean value: " ^ quote s);
wenzelm@22124
   121
wenzelm@22124
   122
fun integer s =
wenzelm@22124
   123
  let
wenzelm@22124
   124
    fun int ss =
wenzelm@22124
   125
      (case Library.read_int ss of (i, []) => i
wenzelm@22124
   126
      | _ => error ("Bad integer value: " ^ quote s));
wenzelm@22124
   127
  in (case Symbol.explode s of "-" :: ss => ~ (int ss) | ss => int ss) end;
wenzelm@22124
   128
wenzelm@22124
   129
wenzelm@22124
   130
(* outer syntax *)
wenzelm@22124
   131
wenzelm@22124
   132
local
wenzelm@22124
   133
wenzelm@36950
   134
val property =
wenzelm@36950
   135
  Parse.xname -- Scan.optional (Parse.$$$ "=" |-- Parse.!!! Parse.xname) "";
wenzelm@36950
   136
wenzelm@36950
   137
val properties =
wenzelm@36950
   138
  Scan.optional (Parse.$$$ "[" |-- Parse.!!! (Parse.enum "," property --| Parse.$$$ "]")) [];
wenzelm@22124
   139
wenzelm@22124
   140
in
wenzelm@22124
   141
wenzelm@36950
   142
val antiq =
wenzelm@36950
   143
  Parse.!!! (Parse.position Parse.xname -- properties -- Args.parse --| Scan.ahead Parse.eof)
wenzelm@22124
   144
  >> (fn (((x, pos), y), z) => (y, Args.src ((x, z), pos)));
wenzelm@22124
   145
wenzelm@22124
   146
end;
wenzelm@22124
   147
wenzelm@22124
   148
wenzelm@22124
   149
(* eval_antiquote *)
wenzelm@22124
   150
wenzelm@32738
   151
val modes = Unsynchronized.ref ([]: string list);
wenzelm@22124
   152
wenzelm@30367
   153
fun eval_antiquote lex state (txt, pos) =
wenzelm@22124
   154
  let
wenzelm@30589
   155
    fun expand (Antiquote.Text ss) = Symbol_Pos.content ss
wenzelm@30683
   156
      | expand (Antiquote.Antiq (ss, (pos, _))) =
wenzelm@30683
   157
          let val (opts, src) = T.read_antiq lex antiq (ss, pos) in
wenzelm@30367
   158
            options opts (fn () => command src state) ();  (*preview errors!*)
wenzelm@23935
   159
            PrintMode.with_modes (! modes @ Latex.modes)
wenzelm@32966
   160
              (Output.no_warnings_CRITICAL (options opts (fn () => command src state))) ()
wenzelm@27344
   161
          end
wenzelm@27344
   162
      | expand (Antiquote.Open _) = ""
wenzelm@27344
   163
      | expand (Antiquote.Close _) = "";
wenzelm@30642
   164
    val ants = Antiquote.read (Symbol_Pos.explode (txt, pos), pos);
wenzelm@22124
   165
  in
wenzelm@30635
   166
    if Toplevel.is_toplevel state andalso not (forall Antiquote.is_text ants) then
wenzelm@27897
   167
      error ("Unknown context -- cannot expand document antiquotations" ^ Position.str_of pos)
wenzelm@22124
   168
    else implode (map expand ants)
wenzelm@22124
   169
  end;
wenzelm@22124
   170
wenzelm@22124
   171
wenzelm@22124
   172
wenzelm@22124
   173
(** present theory source **)
wenzelm@22124
   174
wenzelm@22124
   175
(*NB: arranging white space around command spans is a black art.*)
wenzelm@22124
   176
wenzelm@22124
   177
(* presentation tokens *)
wenzelm@22124
   178
wenzelm@22124
   179
datatype token =
wenzelm@22124
   180
    NoToken
wenzelm@22124
   181
  | BasicToken of T.token
wenzelm@22124
   182
  | MarkupToken of string * (string * Position.T)
wenzelm@22124
   183
  | MarkupEnvToken of string * (string * Position.T)
wenzelm@22124
   184
  | VerbatimToken of string * Position.T;
wenzelm@22124
   185
wenzelm@22124
   186
fun output_token lex state =
wenzelm@30367
   187
  let val eval = eval_antiquote lex state in
wenzelm@22124
   188
    fn NoToken => ""
wenzelm@22124
   189
     | BasicToken tok => Latex.output_basic tok
wenzelm@22124
   190
     | MarkupToken (cmd, txt) => Latex.output_markup cmd (eval txt)
wenzelm@22124
   191
     | MarkupEnvToken (cmd, txt) => Latex.output_markup_env cmd (eval txt)
wenzelm@22124
   192
     | VerbatimToken txt => Latex.output_verbatim (eval txt)
wenzelm@22124
   193
  end;
wenzelm@22124
   194
wenzelm@22124
   195
fun basic_token pred (BasicToken tok) = pred tok
wenzelm@22124
   196
  | basic_token _ _ = false;
wenzelm@22124
   197
wenzelm@22124
   198
val improper_token = basic_token (not o T.is_proper);
wenzelm@22124
   199
val comment_token = basic_token T.is_comment;
wenzelm@22124
   200
val blank_token = basic_token T.is_blank;
wenzelm@22124
   201
val newline_token = basic_token T.is_newline;
wenzelm@22124
   202
wenzelm@22124
   203
wenzelm@22124
   204
(* command spans *)
wenzelm@22124
   205
wenzelm@22124
   206
type command = string * Position.T * string list;   (*name, position, tags*)
wenzelm@22124
   207
type source = (token * (string * int)) list;        (*token, markup flag, meta-comment depth*)
wenzelm@22124
   208
wenzelm@22124
   209
datatype span = Span of command * (source * source * source * source) * bool;
wenzelm@22124
   210
wenzelm@22124
   211
fun make_span cmd src =
wenzelm@22124
   212
  let
wenzelm@22124
   213
    fun take_newline (tok :: toks) =
wenzelm@22124
   214
          if newline_token (fst tok) then ([tok], toks, true)
wenzelm@22124
   215
          else ([], tok :: toks, false)
wenzelm@22124
   216
      | take_newline [] = ([], [], false);
wenzelm@22124
   217
    val (((src_prefix, src_main), src_suffix1), (src_suffix2, src_appendix, newline)) =
wenzelm@22124
   218
      src
wenzelm@22124
   219
      |> take_prefix (improper_token o fst)
wenzelm@22124
   220
      ||>> take_suffix (improper_token o fst)
wenzelm@22124
   221
      ||>> take_prefix (comment_token o fst)
wenzelm@22124
   222
      ||> take_newline;
wenzelm@22124
   223
  in Span (cmd, (src_prefix, src_main, src_suffix1 @ src_suffix2, src_appendix), newline) end;
wenzelm@22124
   224
wenzelm@22124
   225
wenzelm@22124
   226
(* present spans *)
wenzelm@22124
   227
wenzelm@22124
   228
local
wenzelm@22124
   229
wenzelm@22124
   230
fun err_bad_nesting pos =
wenzelm@22124
   231
  error ("Bad nesting of commands in presentation" ^ pos);
wenzelm@22124
   232
wenzelm@22124
   233
fun edge which f (x: string option, y) =
wenzelm@22124
   234
  if x = y then I
wenzelm@22124
   235
  else (case which (x, y) of NONE => I | SOME txt => Buffer.add (f txt));
wenzelm@22124
   236
wenzelm@22124
   237
val begin_tag = edge #2 Latex.begin_tag;
wenzelm@22124
   238
val end_tag = edge #1 Latex.end_tag;
wenzelm@22124
   239
fun open_delim delim e = edge #2 Latex.begin_delim e #> delim #> edge #2 Latex.end_delim e;
wenzelm@22124
   240
fun close_delim delim e = edge #1 Latex.begin_delim e #> delim #> edge #1 Latex.end_delim e;
wenzelm@22124
   241
wenzelm@22124
   242
in
wenzelm@22124
   243
wenzelm@22124
   244
fun present_span lex default_tags span state state'
wenzelm@22124
   245
    (tag_stack, active_tag, newline, buffer, present_cont) =
wenzelm@22124
   246
  let
wenzelm@22124
   247
    val present = fold (fn (tok, (flag, 0)) =>
wenzelm@22124
   248
        Buffer.add (output_token lex state' tok)
wenzelm@22124
   249
        #> Buffer.add flag
wenzelm@22124
   250
      | _ => I);
wenzelm@22124
   251
wenzelm@22124
   252
    val Span ((cmd_name, cmd_pos, cmd_tags), srcs, span_newline) = span;
wenzelm@22124
   253
wenzelm@22124
   254
    val (tag, tags) = tag_stack;
wenzelm@36950
   255
    val tag' = try hd (fold Keyword.update_tags cmd_tags (the_list tag));
wenzelm@22124
   256
wenzelm@22124
   257
    val active_tag' =
wenzelm@22124
   258
      if is_some tag' then tag'
wenzelm@22124
   259
      else if cmd_name = "end" andalso not (Toplevel.is_toplevel state') then NONE
wenzelm@22124
   260
      else try hd (default_tags cmd_name);
wenzelm@22124
   261
    val edge = (active_tag, active_tag');
wenzelm@22124
   262
wenzelm@22124
   263
    val newline' =
wenzelm@22124
   264
      if is_none active_tag' then span_newline else newline;
wenzelm@22124
   265
wenzelm@22124
   266
    val nesting = Toplevel.level state' - Toplevel.level state;
wenzelm@22124
   267
    val tag_stack' =
wenzelm@22124
   268
      if nesting = 0 andalso not (Toplevel.is_proof state) then tag_stack
wenzelm@22124
   269
      else if nesting >= 0 then (tag', replicate nesting tag @ tags)
wenzelm@22124
   270
      else
haftmann@33957
   271
        (case drop (~ nesting - 1) tags of
wenzelm@22124
   272
          tgs :: tgss => (tgs, tgss)
wenzelm@22124
   273
        | [] => err_bad_nesting (Position.str_of cmd_pos));
wenzelm@22124
   274
wenzelm@22124
   275
    val buffer' =
wenzelm@22124
   276
      buffer
wenzelm@22124
   277
      |> end_tag edge
wenzelm@22124
   278
      |> close_delim (fst present_cont) edge
wenzelm@22124
   279
      |> snd present_cont
wenzelm@22124
   280
      |> open_delim (present (#1 srcs)) edge
wenzelm@22124
   281
      |> begin_tag edge
wenzelm@22124
   282
      |> present (#2 srcs);
wenzelm@22124
   283
    val present_cont' =
wenzelm@22124
   284
      if newline then (present (#3 srcs), present (#4 srcs))
wenzelm@22124
   285
      else (I, present (#3 srcs) #> present (#4 srcs));
wenzelm@22124
   286
  in (tag_stack', active_tag', newline', buffer', present_cont') end;
wenzelm@22124
   287
wenzelm@22124
   288
fun present_trailer ((_, tags), active_tag, _, buffer, present_cont) =
wenzelm@22124
   289
  if not (null tags) then err_bad_nesting " at end of theory"
wenzelm@22124
   290
  else
wenzelm@22124
   291
    buffer
wenzelm@22124
   292
    |> end_tag (active_tag, NONE)
wenzelm@22124
   293
    |> close_delim (fst present_cont) (active_tag, NONE)
wenzelm@22124
   294
    |> snd present_cont;
wenzelm@22124
   295
wenzelm@22124
   296
end;
wenzelm@22124
   297
wenzelm@22124
   298
wenzelm@28427
   299
(* present_thy *)
wenzelm@22124
   300
wenzelm@22124
   301
datatype markup = Markup | MarkupEnv | Verbatim;
wenzelm@22124
   302
wenzelm@22124
   303
local
wenzelm@22124
   304
wenzelm@22124
   305
val space_proper =
wenzelm@22124
   306
  Scan.one T.is_blank -- Scan.many T.is_comment -- Scan.one T.is_proper;
wenzelm@22124
   307
wenzelm@22124
   308
val is_improper = not o (T.is_proper orf T.is_begin_ignore orf T.is_end_ignore);
wenzelm@22124
   309
val improper = Scan.many is_improper;
wenzelm@22124
   310
val improper_end = Scan.repeat (Scan.unless space_proper (Scan.one is_improper));
wenzelm@22124
   311
val blank_end = Scan.repeat (Scan.unless space_proper (Scan.one T.is_blank));
wenzelm@22124
   312
wenzelm@22124
   313
val opt_newline = Scan.option (Scan.one T.is_newline);
wenzelm@22124
   314
wenzelm@22124
   315
val ignore =
wenzelm@22124
   316
  Scan.depend (fn d => opt_newline |-- Scan.one T.is_begin_ignore
wenzelm@22124
   317
    >> pair (d + 1)) ||
wenzelm@22124
   318
  Scan.depend (fn d => Scan.one T.is_end_ignore --|
wenzelm@22124
   319
    (if d = 0 then Scan.fail_with (K "Bad nesting of meta-comments") else opt_newline)
wenzelm@22124
   320
    >> pair (d - 1));
wenzelm@22124
   321
wenzelm@36950
   322
val tag = (improper -- Parse.$$$ "%" -- improper) |-- Parse.!!! (Parse.tag_name --| blank_end);
wenzelm@22124
   323
wenzelm@22124
   324
val locale =
wenzelm@36950
   325
  Scan.option ((Parse.$$$ "(" -- improper -- Parse.$$$ "in") |--
wenzelm@36950
   326
    Parse.!!! (improper |-- Parse.xname --| (improper -- Parse.$$$ ")")));
wenzelm@22124
   327
wenzelm@22124
   328
in
wenzelm@22124
   329
wenzelm@28427
   330
fun present_thy lex default_tags is_markup command_results src =
wenzelm@22124
   331
  let
wenzelm@22124
   332
    (* tokens *)
wenzelm@22124
   333
wenzelm@22124
   334
    val ignored = Scan.state --| ignore
wenzelm@22124
   335
      >> (fn d => (NONE, (NoToken, ("", d))));
wenzelm@22124
   336
wenzelm@22124
   337
    fun markup mark mk flag = Scan.peek (fn d =>
wenzelm@36950
   338
      improper |--
wenzelm@36950
   339
        Parse.position (Scan.one (T.is_kind T.Command andf is_markup mark o T.content_of)) --
wenzelm@22124
   340
      Scan.repeat tag --
wenzelm@36950
   341
      Parse.!!!! ((improper -- locale -- improper) |-- Parse.doc_source --| improper_end)
wenzelm@22124
   342
      >> (fn (((tok, pos), tags), txt) =>
wenzelm@27809
   343
        let val name = T.content_of tok
wenzelm@22124
   344
        in (SOME (name, pos, tags), (mk (name, txt), (flag, d))) end));
wenzelm@22124
   345
wenzelm@22124
   346
    val command = Scan.peek (fn d =>
wenzelm@36950
   347
      Parse.position (Scan.one (T.is_kind T.Command)) --
wenzelm@22124
   348
      Scan.repeat tag
wenzelm@22124
   349
      >> (fn ((tok, pos), tags) =>
wenzelm@27809
   350
        let val name = T.content_of tok
wenzelm@22124
   351
        in (SOME (name, pos, tags), (BasicToken tok, (Latex.markup_false, d))) end));
wenzelm@22124
   352
wenzelm@22124
   353
    val cmt = Scan.peek (fn d =>
wenzelm@36950
   354
      Parse.$$$ "--" |-- Parse.!!!! (improper |-- Parse.doc_source)
wenzelm@22124
   355
      >> (fn txt => (NONE, (MarkupToken ("cmt", txt), ("", d)))));
wenzelm@22124
   356
wenzelm@22124
   357
    val other = Scan.peek (fn d =>
wenzelm@36950
   358
       Parse.not_eof >> (fn tok => (NONE, (BasicToken tok, ("", d)))));
wenzelm@22124
   359
wenzelm@22124
   360
    val token =
wenzelm@22124
   361
      ignored ||
wenzelm@22124
   362
      markup Markup MarkupToken Latex.markup_true ||
wenzelm@22124
   363
      markup MarkupEnv MarkupEnvToken Latex.markup_true ||
wenzelm@22124
   364
      markup Verbatim (VerbatimToken o #2) "" ||
wenzelm@22124
   365
      command || cmt || other;
wenzelm@22124
   366
wenzelm@22124
   367
wenzelm@22124
   368
    (* spans *)
wenzelm@22124
   369
wenzelm@27732
   370
    val is_eof = fn (_, (BasicToken x, _)) => T.is_eof x | _ => false;
wenzelm@27732
   371
    val stopper = Scan.stopper (K (NONE, (BasicToken T.eof, ("", 0)))) is_eof;
wenzelm@22124
   372
wenzelm@22124
   373
    val cmd = Scan.one (is_some o fst);
wenzelm@27732
   374
    val non_cmd = Scan.one (is_none o fst andf not o is_eof) >> #2;
wenzelm@22124
   375
wenzelm@22124
   376
    val comments = Scan.many (comment_token o fst o snd);
wenzelm@22124
   377
    val blank = Scan.one (blank_token o fst o snd);
wenzelm@22124
   378
    val newline = Scan.one (newline_token o fst o snd);
wenzelm@22124
   379
    val before_cmd =
wenzelm@22124
   380
      Scan.option (newline -- comments) --
wenzelm@22124
   381
      Scan.option (newline -- comments) --
wenzelm@22124
   382
      Scan.option (blank -- comments) -- cmd;
wenzelm@22124
   383
wenzelm@22124
   384
    val span =
wenzelm@22124
   385
      Scan.repeat non_cmd -- cmd --
wenzelm@22124
   386
        Scan.repeat (Scan.unless before_cmd non_cmd) --
wenzelm@22124
   387
        Scan.option (newline >> (single o snd))
wenzelm@22124
   388
      >> (fn (((toks1, (cmd, tok2)), toks3), tok4) =>
wenzelm@22124
   389
          make_span (the cmd) (toks1 @ (tok2 :: (toks3 @ the_default [] tok4))));
wenzelm@22124
   390
wenzelm@22124
   391
    val spans =
wenzelm@22124
   392
      src
wenzelm@22124
   393
      |> Source.filter (not o T.is_semicolon)
wenzelm@22124
   394
      |> Source.source' 0 T.stopper (Scan.error (Scan.bulk token)) NONE
wenzelm@22124
   395
      |> Source.source stopper (Scan.error (Scan.bulk span)) NONE
wenzelm@22124
   396
      |> Source.exhaust;
wenzelm@28427
   397
wenzelm@28427
   398
wenzelm@28427
   399
    (* present commands *)
wenzelm@28427
   400
wenzelm@28427
   401
    fun present_command tr span st st' =
wenzelm@28427
   402
      Toplevel.setmp_thread_position tr (present_span lex default_tags span st st');
wenzelm@28427
   403
wenzelm@28427
   404
    fun present _ [] = I
wenzelm@28427
   405
      | present st (((tr, st'), span) :: rest) = present_command tr span st st' #> present st' rest;
wenzelm@22124
   406
  in
wenzelm@28427
   407
    if length command_results = length spans then
wenzelm@22124
   408
      ((NONE, []), NONE, true, Buffer.empty, (I, I))
wenzelm@28427
   409
      |> present Toplevel.toplevel (command_results ~~ spans)
wenzelm@22124
   410
      |> present_trailer
wenzelm@22124
   411
    else error "Messed-up outer syntax for presentation"
wenzelm@22124
   412
  end;
wenzelm@22124
   413
wenzelm@22124
   414
end;
wenzelm@22124
   415
wenzelm@22124
   416
wenzelm@22124
   417
wenzelm@22124
   418
(** setup default output **)
wenzelm@22124
   419
wenzelm@22124
   420
(* options *)
wenzelm@22124
   421
wenzelm@22124
   422
val _ = add_options
wenzelm@32966
   423
 [("show_types", setmp_CRITICAL Syntax.show_types o boolean),
wenzelm@32966
   424
  ("show_sorts", setmp_CRITICAL Syntax.show_sorts o boolean),
wenzelm@32966
   425
  ("show_structs", setmp_CRITICAL show_structs o boolean),
wenzelm@32966
   426
  ("show_question_marks", setmp_CRITICAL show_question_marks o boolean),
wenzelm@33095
   427
  ("long_names", setmp_CRITICAL Name_Space.long_names o boolean),
wenzelm@33095
   428
  ("short_names", setmp_CRITICAL Name_Space.short_names o boolean),
wenzelm@33095
   429
  ("unique_names", setmp_CRITICAL Name_Space.unique_names o boolean),
wenzelm@32966
   430
  ("eta_contract", setmp_CRITICAL Syntax.eta_contract o boolean),
wenzelm@32966
   431
  ("display", setmp_CRITICAL display o boolean),
wenzelm@32966
   432
  ("break", setmp_CRITICAL break o boolean),
wenzelm@32966
   433
  ("quotes", setmp_CRITICAL quotes o boolean),
wenzelm@23935
   434
  ("mode", fn s => fn f => PrintMode.with_modes [s] f),
wenzelm@36745
   435
  ("margin", setmp_CRITICAL Pretty.margin_default o integer),
wenzelm@32966
   436
  ("indent", setmp_CRITICAL indent o integer),
wenzelm@32966
   437
  ("source", setmp_CRITICAL source o boolean),
wenzelm@32966
   438
  ("goals_limit", setmp_CRITICAL goals_limit o integer)];
wenzelm@22124
   439
wenzelm@22124
   440
wenzelm@22124
   441
(* basic pretty printing *)
wenzelm@22124
   442
wenzelm@22124
   443
fun tweak_line s =
wenzelm@22124
   444
  if ! display then s else Symbol.strip_blanks s;
wenzelm@22124
   445
wenzelm@22124
   446
val pretty_text = Pretty.chunks o map Pretty.str o map tweak_line o Library.split_lines;
wenzelm@22124
   447
wenzelm@26710
   448
fun pretty_term ctxt t = Syntax.pretty_term (Variable.auto_fixes t ctxt) t;
wenzelm@24920
   449
haftmann@32898
   450
fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of;
haftmann@32898
   451
haftmann@32898
   452
fun pretty_term_style ctxt (style, t) =
haftmann@32898
   453
  pretty_term ctxt (style t);
wenzelm@22124
   454
haftmann@32898
   455
fun pretty_thm_style ctxt (style, th) =
haftmann@32898
   456
  pretty_term ctxt (style (Thm.full_prop_of th));
wenzelm@22124
   457
haftmann@32898
   458
fun pretty_term_typ ctxt (style, t) =
haftmann@32898
   459
  let val t' = style t
haftmann@36446
   460
  in pretty_term ctxt (TypeInfer.constrain (Term.fastype_of t') t') end;
haftmann@32898
   461
haftmann@32898
   462
fun pretty_term_typeof ctxt (style, t) =
haftmann@32898
   463
  Syntax.pretty_typ ctxt (Term.fastype_of (style t));
wenzelm@22124
   464
wenzelm@25373
   465
fun pretty_const ctxt c =
wenzelm@25373
   466
  let
wenzelm@25373
   467
    val t = Const (c, Consts.type_scheme (ProofContext.consts_of ctxt) c)
wenzelm@25373
   468
      handle TYPE (msg, _, _) => error msg;
wenzelm@25373
   469
    val ([t'], _) = Variable.import_terms true [t] ctxt;
wenzelm@25373
   470
  in pretty_term ctxt t' end;
wenzelm@22124
   471
wenzelm@25407
   472
fun pretty_abbrev ctxt s =
wenzelm@22124
   473
  let
wenzelm@25407
   474
    val t = Syntax.parse_term ctxt s |> singleton (ProofContext.standard_infer_types ctxt);
wenzelm@24920
   475
    fun err () = error ("Abbreviated constant expected: " ^ Syntax.string_of_term ctxt t);
wenzelm@22124
   476
    val (head, args) = Term.strip_comb t;
wenzelm@22124
   477
    val (c, T) = Term.dest_Const head handle TERM _ => err ();
wenzelm@25054
   478
    val (U, u) = Consts.the_abbreviation (ProofContext.consts_of ctxt) c
wenzelm@22124
   479
      handle TYPE _ => err ();
wenzelm@22124
   480
    val t' = Term.betapplys (Envir.expand_atom T (U, u), args);
haftmann@32898
   481
    val eq = Logic.mk_equals (t, t');
haftmann@32898
   482
    val ctxt' = Variable.auto_fixes eq ctxt;
haftmann@32898
   483
  in ProofContext.pretty_term_abbrev ctxt' eq end;
wenzelm@22124
   484
wenzelm@33388
   485
fun pretty_prf full ctxt = Proof_Syntax.pretty_proof_of ctxt full;
wenzelm@22124
   486
wenzelm@22124
   487
fun pretty_theory ctxt name =
wenzelm@22124
   488
  (Theory.requires (ProofContext.theory_of ctxt) name "presentation"; Pretty.str name);
wenzelm@22124
   489
wenzelm@22124
   490
wenzelm@30390
   491
(* default output *)
wenzelm@30390
   492
wenzelm@30390
   493
val str_of_source = space_implode " " o map T.unparse o #2 o #1 o Args.dest_src;
wenzelm@22124
   494
wenzelm@30390
   495
fun maybe_pretty_source pretty src xs =
wenzelm@30390
   496
  map pretty xs  (*always pretty in order to exhibit errors!*)
wenzelm@30390
   497
  |> (if ! source then K [pretty_text (str_of_source src)] else I);
wenzelm@30390
   498
wenzelm@30390
   499
fun output prts =
wenzelm@30390
   500
  prts
wenzelm@22124
   501
  |> (if ! quotes then map Pretty.quote else I)
wenzelm@22124
   502
  |> (if ! display then
wenzelm@22124
   503
    map (Output.output o Pretty.string_of o Pretty.indent (! indent))
wenzelm@22124
   504
    #> space_implode "\\isasep\\isanewline%\n"
wenzelm@22124
   505
    #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
wenzelm@22124
   506
  else
wenzelm@22124
   507
    map (Output.output o (if ! break then Pretty.string_of else Pretty.str_of))
wenzelm@22124
   508
    #> space_implode "\\isasep\\isanewline%\n"
wenzelm@22124
   509
    #> enclose "\\isa{" "}");
wenzelm@22124
   510
wenzelm@30390
   511
wenzelm@30390
   512
wenzelm@30390
   513
(** concrete antiquotations **)
wenzelm@30390
   514
wenzelm@30390
   515
(* basic entities *)
wenzelm@30390
   516
wenzelm@30390
   517
local
wenzelm@30390
   518
wenzelm@30390
   519
fun basic_entities name scan pretty = antiquotation name scan
wenzelm@30390
   520
  (fn {source, context, ...} => output o maybe_pretty_source (pretty context) source);
wenzelm@30390
   521
haftmann@32890
   522
fun basic_entities_style name scan pretty = antiquotation name scan
haftmann@32890
   523
  (fn {source, context, ...} => fn (style, xs) =>
haftmann@32890
   524
    output (maybe_pretty_source (fn x => pretty context (style, x)) source xs));
haftmann@32890
   525
wenzelm@30390
   526
fun basic_entity name scan = basic_entities name (scan >> single);
wenzelm@30390
   527
wenzelm@30390
   528
in
wenzelm@30390
   529
haftmann@32890
   530
val _ = basic_entities_style "thm" (Term_Style.parse -- Attrib.thms) pretty_thm_style;
haftmann@32890
   531
val _ = basic_entity "prop" (Term_Style.parse -- Args.prop) pretty_term_style;
haftmann@32890
   532
val _ = basic_entity "term" (Term_Style.parse -- Args.term) pretty_term_style;
haftmann@32898
   533
val _ = basic_entity "term_type" (Term_Style.parse -- Args.term) pretty_term_typ;
haftmann@32898
   534
val _ = basic_entity "typeof" (Term_Style.parse -- Args.term) pretty_term_typeof;
wenzelm@35399
   535
val _ = basic_entity "const" (Args.const_proper false) pretty_const;
wenzelm@30390
   536
val _ = basic_entity "abbrev" (Scan.lift Args.name_source) pretty_abbrev;
wenzelm@30390
   537
val _ = basic_entity "typ" Args.typ_abbrev Syntax.pretty_typ;
wenzelm@30390
   538
val _ = basic_entity "text" (Scan.lift Args.name) (K pretty_text);
wenzelm@30390
   539
val _ = basic_entities "prf" Attrib.thms (pretty_prf false);
wenzelm@30390
   540
val _ = basic_entities "full_prf" Attrib.thms (pretty_prf true);
wenzelm@30390
   541
val _ = basic_entity "theory" (Scan.lift Args.name) pretty_theory;
wenzelm@30390
   542
haftmann@32898
   543
val _ = basic_entities_style "thm_style" (Term_Style.parse_bare -- Attrib.thms) pretty_thm_style;
haftmann@32898
   544
val _ = basic_entity "term_style" (Term_Style.parse_bare -- Args.term) pretty_term_style;
haftmann@32898
   545
wenzelm@30390
   546
end;
wenzelm@30390
   547
wenzelm@30390
   548
wenzelm@30390
   549
(* goal state *)
wenzelm@30390
   550
wenzelm@30390
   551
local
wenzelm@22124
   552
wenzelm@30367
   553
fun proof_state state =
wenzelm@30367
   554
  (case try Toplevel.proof_of state of
wenzelm@30367
   555
    SOME prf => prf
wenzelm@22124
   556
  | _ => error "No proof state");
wenzelm@22124
   557
wenzelm@30390
   558
fun goal_state name main_goal = antiquotation name (Scan.succeed ())
wenzelm@30390
   559
  (fn {state, ...} => fn () => output
wenzelm@30390
   560
    [Pretty.chunks (Proof.pretty_goals main_goal (proof_state state))]);
wenzelm@22124
   561
wenzelm@30390
   562
in
wenzelm@30390
   563
wenzelm@30390
   564
val _ = goal_state "goals" true;
wenzelm@30390
   565
val _ = goal_state "subgoals" false;
wenzelm@30390
   566
wenzelm@30390
   567
end;
wenzelm@22124
   568
wenzelm@22124
   569
wenzelm@30390
   570
(* embedded lemma *)
wenzelm@27522
   571
wenzelm@36950
   572
val _ = Keyword.keyword "by";
wenzelm@27381
   573
wenzelm@30390
   574
val _ = antiquotation "lemma"
wenzelm@30390
   575
  (Args.prop -- Scan.lift (Args.$$$ "by" |-- Method.parse -- Scan.option Method.parse))
wenzelm@30390
   576
  (fn {source, context, ...} => fn (prop, methods) =>
wenzelm@30390
   577
    let
wenzelm@30390
   578
      val prop_src =
wenzelm@30390
   579
        (case Args.dest_src source of ((a, arg :: _), pos) => Args.src ((a, [arg]), pos));
wenzelm@30390
   580
      val _ = context
wenzelm@36323
   581
        |> Proof.theorem NONE (K I) [[(prop, [])]]
wenzelm@30390
   582
        |> Proof.global_terminal_proof methods;
wenzelm@30390
   583
    in output (maybe_pretty_source (pretty_term context) prop_src [prop]) end);
wenzelm@30390
   584
wenzelm@30390
   585
wenzelm@30390
   586
(* ML text *)
wenzelm@30390
   587
wenzelm@30390
   588
local
wenzelm@30390
   589
wenzelm@30390
   590
fun ml_text name ml = antiquotation name (Scan.lift Args.name_source_position)
wenzelm@30390
   591
  (fn {context, ...} => fn (txt, pos) =>
wenzelm@30390
   592
   (ML_Context.eval_in (SOME context) false pos (ml txt);
wenzelm@30573
   593
    Symbol_Pos.content (Symbol_Pos.explode (txt, pos))
wenzelm@30390
   594
    |> (if ! quotes then quote else I)
wenzelm@30390
   595
    |> (if ! display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
wenzelm@30390
   596
    else
wenzelm@30390
   597
      split_lines
wenzelm@30390
   598
      #> map (space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|")
wenzelm@30390
   599
      #> space_implode "\\isasep\\isanewline%\n")));
wenzelm@30390
   600
wenzelm@30390
   601
in
wenzelm@30390
   602
wenzelm@30390
   603
val _ = ml_text "ML" (fn txt => "fn _ => (" ^ txt ^ ");");
wenzelm@30390
   604
val _ = ml_text "ML_type" (fn txt => "val _ = NONE : (" ^ txt ^ ") option;");
wenzelm@30394
   605
val _ = ml_text "ML_struct" (fn txt => "functor XXX() = struct structure XX = " ^ txt ^ " end;");
wenzelm@36163
   606
val _ = ml_text "ML_functor" (fn txt => "ML_Env.check_functor " ^ ML_Syntax.print_string txt);
wenzelm@30394
   607
val _ = ml_text "ML_text" (K "");
wenzelm@22124
   608
wenzelm@22124
   609
end;
wenzelm@30390
   610
wenzelm@30390
   611
end;