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