src/Pure/Thy/thy_output.ML
author Christian Urban <urbanc@in.tum.de>
Thu Jan 15 12:55:38 2009 +0000 (2009-01-15)
changeset 29491 4f864f851f4d
parent 28644 e2ae4a6cf166
child 29606 fedb8be05f24
permissions -rw-r--r--
exported break reference
wenzelm@22124
     1
(*  Title:      Pure/Thy/thy_output.ML
wenzelm@22124
     2
    ID:         $Id$
wenzelm@22124
     3
    Author:     Markus Wenzel, TU Muenchen
wenzelm@22124
     4
wenzelm@22124
     5
Theory document output.
wenzelm@22124
     6
*)
wenzelm@22124
     7
wenzelm@22124
     8
signature THY_OUTPUT =
wenzelm@22124
     9
sig
wenzelm@22124
    10
  val display: bool ref
wenzelm@22124
    11
  val quotes: bool ref
wenzelm@22124
    12
  val indent: int ref
wenzelm@22124
    13
  val source: bool ref
urbanc@29491
    14
  val break: bool ref
wenzelm@22124
    15
  val add_commands: (string * (Args.src -> Toplevel.node option -> string)) list -> unit
wenzelm@22124
    16
  val add_options: (string * (string -> (unit -> string) -> unit -> string)) list -> unit
wenzelm@26893
    17
  val defined_command: string -> bool
wenzelm@26893
    18
  val defined_option: string -> bool
wenzelm@22124
    19
  val print_antiquotations: unit -> unit
wenzelm@22124
    20
  val boolean: string -> bool
wenzelm@22124
    21
  val integer: string -> int
wenzelm@22124
    22
  val args: (Context.generic * Args.T list -> 'a * (Context.generic * Args.T list)) ->
wenzelm@22124
    23
    (Args.src -> Proof.context -> 'a -> string) -> Args.src -> Toplevel.node option -> string
wenzelm@22124
    24
  datatype markup = Markup | MarkupEnv | Verbatim
wenzelm@22124
    25
  val modes: string list ref
wenzelm@27874
    26
  val eval_antiquote: Scan.lexicon -> Toplevel.node option -> SymbolPos.text * Position.T -> string
wenzelm@28427
    27
  val present_thy: Scan.lexicon -> (string -> string list) -> (markup -> string -> bool) ->
wenzelm@28427
    28
    (Toplevel.transition * Toplevel.state) list -> (OuterLex.token, 'a) Source.source -> Buffer.T
wenzelm@28644
    29
  val str_of_source: Args.src -> string
wenzelm@28644
    30
  val pretty_text: string -> Pretty.T
wenzelm@28644
    31
  val pretty_term: Proof.context -> term -> Pretty.T
wenzelm@28644
    32
  val pretty_thm: Proof.context -> thm -> Pretty.T
wenzelm@22124
    33
  val output_list: (Proof.context -> 'a -> Pretty.T) -> Args.src ->
wenzelm@22124
    34
    Proof.context -> 'a list -> string
wenzelm@22124
    35
  val output: (Proof.context -> 'a -> Pretty.T) -> Args.src -> Proof.context -> 'a -> string
wenzelm@22124
    36
end;
wenzelm@22124
    37
wenzelm@22124
    38
structure ThyOutput: THY_OUTPUT =
wenzelm@22124
    39
struct
wenzelm@22124
    40
wenzelm@22124
    41
structure T = OuterLex;
wenzelm@22124
    42
structure P = OuterParse;
wenzelm@22124
    43
wenzelm@22124
    44
wenzelm@22124
    45
(** global options **)
wenzelm@22124
    46
wenzelm@22124
    47
val locale = ref "";
wenzelm@22124
    48
val display = ref false;
wenzelm@22124
    49
val quotes = ref false;
wenzelm@22124
    50
val indent = ref 0;
wenzelm@22124
    51
val source = ref false;
wenzelm@22124
    52
val break = ref false;
wenzelm@22124
    53
wenzelm@22124
    54
wenzelm@22124
    55
wenzelm@22124
    56
(** maintain global commands **)
wenzelm@22124
    57
wenzelm@22124
    58
local
wenzelm@22124
    59
wenzelm@22124
    60
val global_commands =
wenzelm@22124
    61
  ref (Symtab.empty: (Args.src -> Toplevel.node option -> string) Symtab.table);
wenzelm@22124
    62
wenzelm@22124
    63
val global_options =
wenzelm@22124
    64
  ref (Symtab.empty: (string -> (unit -> string) -> unit -> string) Symtab.table);
wenzelm@22124
    65
wenzelm@22124
    66
fun add_item kind (name, x) tab =
wenzelm@22124
    67
 (if not (Symtab.defined tab name) then ()
wenzelm@27897
    68
  else warning ("Redefined document antiquotation " ^ kind ^ ": " ^ quote name);
wenzelm@22124
    69
  Symtab.update (name, x) tab);
wenzelm@22124
    70
wenzelm@22124
    71
in
wenzelm@22124
    72
wenzelm@23942
    73
fun add_commands xs = CRITICAL (fn () => change global_commands (fold (add_item "command") xs));
wenzelm@23942
    74
fun add_options xs = CRITICAL (fn () => change global_options (fold (add_item "option") xs));
wenzelm@22124
    75
wenzelm@26893
    76
fun defined_command name = Symtab.defined (! global_commands) name;
wenzelm@26893
    77
fun defined_option name = Symtab.defined (! global_options) name;
wenzelm@26893
    78
wenzelm@22124
    79
fun command src =
wenzelm@22124
    80
  let val ((name, _), pos) = Args.dest_src src in
wenzelm@22124
    81
    (case Symtab.lookup (! global_commands) name of
wenzelm@27897
    82
      NONE => error ("Unknown document antiquotation command: " ^ quote name ^ Position.str_of pos)
wenzelm@27897
    83
    | SOME f => (Position.report (Markup.doc_antiq name) pos; f src))
wenzelm@22124
    84
  end;
wenzelm@22124
    85
wenzelm@22124
    86
fun option (name, s) f () =
wenzelm@22124
    87
  (case Symtab.lookup (! global_options) name of
wenzelm@27897
    88
    NONE => error ("Unknown document antiquotation option: " ^ quote name)
wenzelm@22124
    89
  | SOME opt => opt s f ());
wenzelm@22124
    90
wenzelm@22124
    91
fun options [] f = f
wenzelm@22124
    92
  | options (opt :: opts) f = option opt (options opts f);
wenzelm@22124
    93
wenzelm@22124
    94
wenzelm@22124
    95
fun print_antiquotations () =
wenzelm@27897
    96
 [Pretty.big_list "document antiquotation commands:"
wenzelm@23272
    97
    (map Pretty.str (sort_strings (Symtab.keys (! global_commands)))),
wenzelm@27897
    98
  Pretty.big_list "document antiquotation options:"
wenzelm@23272
    99
    (map Pretty.str (sort_strings (Symtab.keys (! global_options))))]
wenzelm@22124
   100
 |> Pretty.chunks |> Pretty.writeln;
wenzelm@22124
   101
wenzelm@22124
   102
end;
wenzelm@22124
   103
wenzelm@22124
   104
wenzelm@22124
   105
wenzelm@22124
   106
(** syntax of antiquotations **)
wenzelm@22124
   107
wenzelm@22124
   108
(* option values *)
wenzelm@22124
   109
wenzelm@22124
   110
fun boolean "" = true
wenzelm@22124
   111
  | boolean "true" = true
wenzelm@22124
   112
  | boolean "false" = false
wenzelm@22124
   113
  | boolean s = error ("Bad boolean value: " ^ quote s);
wenzelm@22124
   114
wenzelm@22124
   115
fun integer s =
wenzelm@22124
   116
  let
wenzelm@22124
   117
    fun int ss =
wenzelm@22124
   118
      (case Library.read_int ss of (i, []) => i
wenzelm@22124
   119
      | _ => error ("Bad integer value: " ^ quote s));
wenzelm@22124
   120
  in (case Symbol.explode s of "-" :: ss => ~ (int ss) | ss => int ss) end;
wenzelm@22124
   121
wenzelm@22124
   122
wenzelm@22124
   123
(* args syntax *)
wenzelm@22124
   124
wenzelm@27897
   125
fun syntax scan = Args.context_syntax "document antiquotation" scan;
wenzelm@22124
   126
wenzelm@22124
   127
fun args scan f src node : string =
wenzelm@22124
   128
  let
wenzelm@22124
   129
    val loc = if ! locale = "" then NONE else SOME (! locale);
wenzelm@22124
   130
    val (x, ctxt) = syntax scan src (Toplevel.presentation_context node loc);
wenzelm@22124
   131
  in f src ctxt x end;
wenzelm@22124
   132
wenzelm@22124
   133
wenzelm@22124
   134
(* outer syntax *)
wenzelm@22124
   135
wenzelm@22124
   136
local
wenzelm@22124
   137
wenzelm@22124
   138
val property = P.xname -- Scan.optional (P.$$$ "=" |-- P.!!! P.xname) "";
wenzelm@22124
   139
val properties = Scan.optional (P.$$$ "[" |-- P.!!! (P.enum "," property --| P.$$$ "]")) [];
wenzelm@22124
   140
wenzelm@22124
   141
in
wenzelm@22124
   142
wenzelm@27809
   143
val antiq = P.!!! (P.position P.xname -- properties -- Args.parse --| Scan.ahead P.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@22124
   151
val modes = ref ([]: string list);
wenzelm@22124
   152
wenzelm@27874
   153
fun eval_antiquote lex node (txt, pos) =
wenzelm@22124
   154
  let
wenzelm@22124
   155
    fun expand (Antiquote.Text s) = s
wenzelm@27781
   156
      | expand (Antiquote.Antiq x) =
wenzelm@27781
   157
          let val (opts, src) = Antiquote.read_antiq lex antiq x in
wenzelm@22124
   158
            options opts (fn () => command src node) ();  (*preview errors!*)
wenzelm@23935
   159
            PrintMode.with_modes (! modes @ Latex.modes)
wenzelm@22124
   160
              (Output.no_warnings (options opts (fn () => command src node))) ()
wenzelm@27344
   161
          end
wenzelm@27344
   162
      | expand (Antiquote.Open _) = ""
wenzelm@27344
   163
      | expand (Antiquote.Close _) = "";
wenzelm@27874
   164
    val ants = Antiquote.read (SymbolPos.explode (txt, pos), pos);
wenzelm@22124
   165
  in
wenzelm@22124
   166
    if is_none node andalso exists Antiquote.is_antiq 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@22124
   187
  let
wenzelm@22124
   188
    val eval = eval_antiquote lex (try Toplevel.node_of state)
wenzelm@22124
   189
  in
wenzelm@22124
   190
    fn NoToken => ""
wenzelm@22124
   191
     | BasicToken tok => Latex.output_basic tok
wenzelm@22124
   192
     | MarkupToken (cmd, txt) => Latex.output_markup cmd (eval txt)
wenzelm@22124
   193
     | MarkupEnvToken (cmd, txt) => Latex.output_markup_env cmd (eval txt)
wenzelm@22124
   194
     | VerbatimToken txt => Latex.output_verbatim (eval txt)
wenzelm@22124
   195
  end;
wenzelm@22124
   196
wenzelm@22124
   197
fun basic_token pred (BasicToken tok) = pred tok
wenzelm@22124
   198
  | basic_token _ _ = false;
wenzelm@22124
   199
wenzelm@22124
   200
val improper_token = basic_token (not o T.is_proper);
wenzelm@22124
   201
val comment_token = basic_token T.is_comment;
wenzelm@22124
   202
val blank_token = basic_token T.is_blank;
wenzelm@22124
   203
val newline_token = basic_token T.is_newline;
wenzelm@22124
   204
wenzelm@22124
   205
wenzelm@22124
   206
(* command spans *)
wenzelm@22124
   207
wenzelm@22124
   208
type command = string * Position.T * string list;   (*name, position, tags*)
wenzelm@22124
   209
type source = (token * (string * int)) list;        (*token, markup flag, meta-comment depth*)
wenzelm@22124
   210
wenzelm@22124
   211
datatype span = Span of command * (source * source * source * source) * bool;
wenzelm@22124
   212
wenzelm@22124
   213
fun make_span cmd src =
wenzelm@22124
   214
  let
wenzelm@22124
   215
    fun take_newline (tok :: toks) =
wenzelm@22124
   216
          if newline_token (fst tok) then ([tok], toks, true)
wenzelm@22124
   217
          else ([], tok :: toks, false)
wenzelm@22124
   218
      | take_newline [] = ([], [], false);
wenzelm@22124
   219
    val (((src_prefix, src_main), src_suffix1), (src_suffix2, src_appendix, newline)) =
wenzelm@22124
   220
      src
wenzelm@22124
   221
      |> take_prefix (improper_token o fst)
wenzelm@22124
   222
      ||>> take_suffix (improper_token o fst)
wenzelm@22124
   223
      ||>> take_prefix (comment_token o fst)
wenzelm@22124
   224
      ||> take_newline;
wenzelm@22124
   225
  in Span (cmd, (src_prefix, src_main, src_suffix1 @ src_suffix2, src_appendix), newline) end;
wenzelm@22124
   226
wenzelm@22124
   227
wenzelm@22124
   228
(* present spans *)
wenzelm@22124
   229
wenzelm@22124
   230
local
wenzelm@22124
   231
wenzelm@22124
   232
fun err_bad_nesting pos =
wenzelm@22124
   233
  error ("Bad nesting of commands in presentation" ^ pos);
wenzelm@22124
   234
wenzelm@22124
   235
fun edge which f (x: string option, y) =
wenzelm@22124
   236
  if x = y then I
wenzelm@22124
   237
  else (case which (x, y) of NONE => I | SOME txt => Buffer.add (f txt));
wenzelm@22124
   238
wenzelm@22124
   239
val begin_tag = edge #2 Latex.begin_tag;
wenzelm@22124
   240
val end_tag = edge #1 Latex.end_tag;
wenzelm@22124
   241
fun open_delim delim e = edge #2 Latex.begin_delim e #> delim #> edge #2 Latex.end_delim e;
wenzelm@22124
   242
fun close_delim delim e = edge #1 Latex.begin_delim e #> delim #> edge #1 Latex.end_delim e;
wenzelm@22124
   243
wenzelm@22124
   244
in
wenzelm@22124
   245
wenzelm@22124
   246
fun present_span lex default_tags span state state'
wenzelm@22124
   247
    (tag_stack, active_tag, newline, buffer, present_cont) =
wenzelm@22124
   248
  let
wenzelm@22124
   249
    val present = fold (fn (tok, (flag, 0)) =>
wenzelm@22124
   250
        Buffer.add (output_token lex state' tok)
wenzelm@22124
   251
        #> Buffer.add flag
wenzelm@22124
   252
      | _ => I);
wenzelm@22124
   253
wenzelm@22124
   254
    val Span ((cmd_name, cmd_pos, cmd_tags), srcs, span_newline) = span;
wenzelm@22124
   255
wenzelm@22124
   256
    val (tag, tags) = tag_stack;
wenzelm@22124
   257
    val tag' = try hd (fold OuterKeyword.update_tags cmd_tags (the_list tag));
wenzelm@22124
   258
wenzelm@22124
   259
    val active_tag' =
wenzelm@22124
   260
      if is_some tag' then tag'
wenzelm@22124
   261
      else if cmd_name = "end" andalso not (Toplevel.is_toplevel state') then NONE
wenzelm@22124
   262
      else try hd (default_tags cmd_name);
wenzelm@22124
   263
    val edge = (active_tag, active_tag');
wenzelm@22124
   264
wenzelm@22124
   265
    val newline' =
wenzelm@22124
   266
      if is_none active_tag' then span_newline else newline;
wenzelm@22124
   267
wenzelm@22124
   268
    val nesting = Toplevel.level state' - Toplevel.level state;
wenzelm@22124
   269
    val tag_stack' =
wenzelm@22124
   270
      if nesting = 0 andalso not (Toplevel.is_proof state) then tag_stack
wenzelm@22124
   271
      else if nesting >= 0 then (tag', replicate nesting tag @ tags)
wenzelm@22124
   272
      else
wenzelm@22124
   273
        (case Library.drop (~ nesting - 1, tags) of
wenzelm@22124
   274
          tgs :: tgss => (tgs, tgss)
wenzelm@22124
   275
        | [] => err_bad_nesting (Position.str_of cmd_pos));
wenzelm@22124
   276
wenzelm@22124
   277
    val buffer' =
wenzelm@22124
   278
      buffer
wenzelm@22124
   279
      |> end_tag edge
wenzelm@22124
   280
      |> close_delim (fst present_cont) edge
wenzelm@22124
   281
      |> snd present_cont
wenzelm@22124
   282
      |> open_delim (present (#1 srcs)) edge
wenzelm@22124
   283
      |> begin_tag edge
wenzelm@22124
   284
      |> present (#2 srcs);
wenzelm@22124
   285
    val present_cont' =
wenzelm@22124
   286
      if newline then (present (#3 srcs), present (#4 srcs))
wenzelm@22124
   287
      else (I, present (#3 srcs) #> present (#4 srcs));
wenzelm@22124
   288
  in (tag_stack', active_tag', newline', buffer', present_cont') end;
wenzelm@22124
   289
wenzelm@22124
   290
fun present_trailer ((_, tags), active_tag, _, buffer, present_cont) =
wenzelm@22124
   291
  if not (null tags) then err_bad_nesting " at end of theory"
wenzelm@22124
   292
  else
wenzelm@22124
   293
    buffer
wenzelm@22124
   294
    |> end_tag (active_tag, NONE)
wenzelm@22124
   295
    |> close_delim (fst present_cont) (active_tag, NONE)
wenzelm@22124
   296
    |> snd present_cont;
wenzelm@22124
   297
wenzelm@22124
   298
end;
wenzelm@22124
   299
wenzelm@22124
   300
wenzelm@28427
   301
(* present_thy *)
wenzelm@22124
   302
wenzelm@22124
   303
datatype markup = Markup | MarkupEnv | Verbatim;
wenzelm@22124
   304
wenzelm@22124
   305
local
wenzelm@22124
   306
wenzelm@22124
   307
val space_proper =
wenzelm@22124
   308
  Scan.one T.is_blank -- Scan.many T.is_comment -- Scan.one T.is_proper;
wenzelm@22124
   309
wenzelm@22124
   310
val is_improper = not o (T.is_proper orf T.is_begin_ignore orf T.is_end_ignore);
wenzelm@22124
   311
val improper = Scan.many is_improper;
wenzelm@22124
   312
val improper_end = Scan.repeat (Scan.unless space_proper (Scan.one is_improper));
wenzelm@22124
   313
val blank_end = Scan.repeat (Scan.unless space_proper (Scan.one T.is_blank));
wenzelm@22124
   314
wenzelm@22124
   315
val opt_newline = Scan.option (Scan.one T.is_newline);
wenzelm@22124
   316
wenzelm@22124
   317
val ignore =
wenzelm@22124
   318
  Scan.depend (fn d => opt_newline |-- Scan.one T.is_begin_ignore
wenzelm@22124
   319
    >> pair (d + 1)) ||
wenzelm@22124
   320
  Scan.depend (fn d => Scan.one T.is_end_ignore --|
wenzelm@22124
   321
    (if d = 0 then Scan.fail_with (K "Bad nesting of meta-comments") else opt_newline)
wenzelm@22124
   322
    >> pair (d - 1));
wenzelm@22124
   323
wenzelm@22124
   324
val tag = (improper -- P.$$$ "%" -- improper) |-- P.!!! (P.tag_name --| blank_end);
wenzelm@22124
   325
wenzelm@22124
   326
val locale =
wenzelm@22124
   327
  Scan.option ((P.$$$ "(" -- improper -- P.$$$ "in") |--
wenzelm@22124
   328
    P.!!! (improper |-- P.xname --| (improper -- P.$$$ ")")));
wenzelm@22124
   329
wenzelm@22124
   330
in
wenzelm@22124
   331
wenzelm@28427
   332
fun present_thy lex default_tags is_markup command_results src =
wenzelm@22124
   333
  let
wenzelm@22124
   334
    (* tokens *)
wenzelm@22124
   335
wenzelm@22124
   336
    val ignored = Scan.state --| ignore
wenzelm@22124
   337
      >> (fn d => (NONE, (NoToken, ("", d))));
wenzelm@22124
   338
wenzelm@22124
   339
    fun markup mark mk flag = Scan.peek (fn d =>
wenzelm@27809
   340
      improper |-- P.position (Scan.one (T.is_kind T.Command andf is_markup mark o T.content_of)) --
wenzelm@22124
   341
      Scan.repeat tag --
wenzelm@27874
   342
      P.!!!! ((improper -- locale -- improper) |-- P.doc_source --| improper_end)
wenzelm@22124
   343
      >> (fn (((tok, pos), tags), txt) =>
wenzelm@27809
   344
        let val name = T.content_of tok
wenzelm@22124
   345
        in (SOME (name, pos, tags), (mk (name, txt), (flag, d))) end));
wenzelm@22124
   346
wenzelm@22124
   347
    val command = Scan.peek (fn d =>
wenzelm@22124
   348
      P.position (Scan.one (T.is_kind T.Command)) --
wenzelm@22124
   349
      Scan.repeat tag
wenzelm@22124
   350
      >> (fn ((tok, pos), tags) =>
wenzelm@27809
   351
        let val name = T.content_of tok
wenzelm@22124
   352
        in (SOME (name, pos, tags), (BasicToken tok, (Latex.markup_false, d))) end));
wenzelm@22124
   353
wenzelm@22124
   354
    val cmt = Scan.peek (fn d =>
wenzelm@27874
   355
      P.$$$ "--" |-- P.!!!! (improper |-- P.doc_source)
wenzelm@22124
   356
      >> (fn txt => (NONE, (MarkupToken ("cmt", txt), ("", d)))));
wenzelm@22124
   357
wenzelm@22124
   358
    val other = Scan.peek (fn d =>
wenzelm@23725
   359
       P.not_eof >> (fn tok => (NONE, (BasicToken tok, ("", d)))));
wenzelm@22124
   360
wenzelm@22124
   361
    val token =
wenzelm@22124
   362
      ignored ||
wenzelm@22124
   363
      markup Markup MarkupToken Latex.markup_true ||
wenzelm@22124
   364
      markup MarkupEnv MarkupEnvToken Latex.markup_true ||
wenzelm@22124
   365
      markup Verbatim (VerbatimToken o #2) "" ||
wenzelm@22124
   366
      command || cmt || other;
wenzelm@22124
   367
wenzelm@22124
   368
wenzelm@22124
   369
    (* spans *)
wenzelm@22124
   370
wenzelm@27732
   371
    val is_eof = fn (_, (BasicToken x, _)) => T.is_eof x | _ => false;
wenzelm@27732
   372
    val stopper = Scan.stopper (K (NONE, (BasicToken T.eof, ("", 0)))) is_eof;
wenzelm@22124
   373
wenzelm@22124
   374
    val cmd = Scan.one (is_some o fst);
wenzelm@27732
   375
    val non_cmd = Scan.one (is_none o fst andf not o is_eof) >> #2;
wenzelm@22124
   376
wenzelm@22124
   377
    val comments = Scan.many (comment_token o fst o snd);
wenzelm@22124
   378
    val blank = Scan.one (blank_token o fst o snd);
wenzelm@22124
   379
    val newline = Scan.one (newline_token o fst o snd);
wenzelm@22124
   380
    val before_cmd =
wenzelm@22124
   381
      Scan.option (newline -- comments) --
wenzelm@22124
   382
      Scan.option (newline -- comments) --
wenzelm@22124
   383
      Scan.option (blank -- comments) -- cmd;
wenzelm@22124
   384
wenzelm@22124
   385
    val span =
wenzelm@22124
   386
      Scan.repeat non_cmd -- cmd --
wenzelm@22124
   387
        Scan.repeat (Scan.unless before_cmd non_cmd) --
wenzelm@22124
   388
        Scan.option (newline >> (single o snd))
wenzelm@22124
   389
      >> (fn (((toks1, (cmd, tok2)), toks3), tok4) =>
wenzelm@22124
   390
          make_span (the cmd) (toks1 @ (tok2 :: (toks3 @ the_default [] tok4))));
wenzelm@22124
   391
wenzelm@22124
   392
    val spans =
wenzelm@22124
   393
      src
wenzelm@22124
   394
      |> Source.filter (not o T.is_semicolon)
wenzelm@22124
   395
      |> Source.source' 0 T.stopper (Scan.error (Scan.bulk token)) NONE
wenzelm@22124
   396
      |> Source.source stopper (Scan.error (Scan.bulk span)) NONE
wenzelm@22124
   397
      |> Source.exhaust;
wenzelm@28427
   398
wenzelm@28427
   399
wenzelm@28427
   400
    (* present commands *)
wenzelm@28427
   401
wenzelm@28427
   402
    fun present_command tr span st st' =
wenzelm@28427
   403
      Toplevel.setmp_thread_position tr (present_span lex default_tags span st st');
wenzelm@28427
   404
wenzelm@28427
   405
    fun present _ [] = I
wenzelm@28427
   406
      | present st (((tr, st'), span) :: rest) = present_command tr span st st' #> present st' rest;
wenzelm@22124
   407
  in
wenzelm@28427
   408
    if length command_results = length spans then
wenzelm@22124
   409
      ((NONE, []), NONE, true, Buffer.empty, (I, I))
wenzelm@28427
   410
      |> present Toplevel.toplevel (command_results ~~ spans)
wenzelm@22124
   411
      |> present_trailer
wenzelm@22124
   412
    else error "Messed-up outer syntax for presentation"
wenzelm@22124
   413
  end;
wenzelm@22124
   414
wenzelm@22124
   415
end;
wenzelm@22124
   416
wenzelm@22124
   417
wenzelm@22124
   418
wenzelm@22124
   419
(** setup default output **)
wenzelm@22124
   420
wenzelm@22124
   421
(* options *)
wenzelm@22124
   422
wenzelm@22124
   423
val _ = add_options
wenzelm@22124
   424
 [("show_types", Library.setmp Syntax.show_types o boolean),
wenzelm@22124
   425
  ("show_sorts", Library.setmp Syntax.show_sorts o boolean),
wenzelm@22124
   426
  ("show_structs", Library.setmp show_structs o boolean),
wenzelm@22124
   427
  ("show_question_marks", Library.setmp show_question_marks o boolean),
wenzelm@22124
   428
  ("long_names", Library.setmp NameSpace.long_names o boolean),
wenzelm@22124
   429
  ("short_names", Library.setmp NameSpace.short_names o boolean),
wenzelm@22124
   430
  ("unique_names", Library.setmp NameSpace.unique_names o boolean),
wenzelm@22124
   431
  ("eta_contract", Library.setmp Syntax.eta_contract o boolean),
wenzelm@22124
   432
  ("locale", Library.setmp locale),
wenzelm@22124
   433
  ("display", Library.setmp display o boolean),
wenzelm@22124
   434
  ("break", Library.setmp break o boolean),
wenzelm@22124
   435
  ("quotes", Library.setmp quotes o boolean),
wenzelm@23935
   436
  ("mode", fn s => fn f => PrintMode.with_modes [s] f),
wenzelm@22124
   437
  ("margin", Pretty.setmp_margin o integer),
wenzelm@22124
   438
  ("indent", Library.setmp indent o integer),
wenzelm@22124
   439
  ("source", Library.setmp source o boolean),
wenzelm@22124
   440
  ("goals_limit", Library.setmp goals_limit o integer)];
wenzelm@22124
   441
wenzelm@22124
   442
wenzelm@22124
   443
(* basic pretty printing *)
wenzelm@22124
   444
wenzelm@27809
   445
val str_of_source = space_implode " " o map T.unparse o #2 o #1 o Args.dest_src;
wenzelm@22124
   446
wenzelm@22124
   447
fun tweak_line s =
wenzelm@22124
   448
  if ! display then s else Symbol.strip_blanks s;
wenzelm@22124
   449
wenzelm@22124
   450
val pretty_text = Pretty.chunks o map Pretty.str o map tweak_line o Library.split_lines;
wenzelm@22124
   451
wenzelm@26710
   452
fun pretty_term ctxt t = Syntax.pretty_term (Variable.auto_fixes t ctxt) t;
wenzelm@24920
   453
wenzelm@26710
   454
fun pretty_term_abbrev ctxt t = ProofContext.pretty_term_abbrev (Variable.auto_fixes t ctxt) t;
wenzelm@22124
   455
wenzelm@22124
   456
fun pretty_term_typ ctxt t =
wenzelm@24920
   457
  Syntax.pretty_term ctxt (TypeInfer.constrain (Term.fastype_of t) t);
wenzelm@22124
   458
wenzelm@24920
   459
fun pretty_term_typeof ctxt = Syntax.pretty_typ ctxt o Term.fastype_of;
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);
wenzelm@22124
   477
  in pretty_term_abbrev ctxt (Logic.mk_equals (t, t')) end;
wenzelm@22124
   478
wenzelm@22124
   479
fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of;
wenzelm@22124
   480
wenzelm@22124
   481
fun pretty_term_style ctxt (name, t) =
wenzelm@22124
   482
  pretty_term ctxt (TermStyle.the_style (ProofContext.theory_of ctxt) name ctxt t);
wenzelm@22124
   483
wenzelm@22124
   484
fun pretty_thm_style ctxt (name, th) =
wenzelm@22124
   485
  pretty_term_style ctxt (name, Thm.full_prop_of th);
wenzelm@22124
   486
wenzelm@22124
   487
fun pretty_prf full ctxt thms =
wenzelm@27258
   488
  Pretty.chunks (map (ProofSyntax.pretty_proof_of ctxt full) thms);
wenzelm@22124
   489
wenzelm@22124
   490
fun pretty_theory ctxt name =
wenzelm@22124
   491
  (Theory.requires (ProofContext.theory_of ctxt) name "presentation"; Pretty.str name);
wenzelm@22124
   492
wenzelm@22124
   493
wenzelm@22124
   494
(* Isar output *)
wenzelm@22124
   495
wenzelm@22124
   496
fun output_list pretty src ctxt xs =
wenzelm@22124
   497
  map (pretty ctxt) xs        (*always pretty in order to exhibit errors!*)
wenzelm@22124
   498
  |> (if ! source then K [pretty_text (str_of_source src)] else I)
wenzelm@22124
   499
  |> (if ! quotes then map Pretty.quote else I)
wenzelm@22124
   500
  |> (if ! display then
wenzelm@22124
   501
    map (Output.output o Pretty.string_of o Pretty.indent (! indent))
wenzelm@22124
   502
    #> space_implode "\\isasep\\isanewline%\n"
wenzelm@22124
   503
    #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
wenzelm@22124
   504
  else
wenzelm@22124
   505
    map (Output.output o (if ! break then Pretty.string_of else Pretty.str_of))
wenzelm@22124
   506
    #> space_implode "\\isasep\\isanewline%\n"
wenzelm@22124
   507
    #> enclose "\\isa{" "}");
wenzelm@22124
   508
wenzelm@22124
   509
fun output pretty src ctxt = output_list pretty src ctxt o single;
wenzelm@22124
   510
wenzelm@22124
   511
fun proof_state node =
wenzelm@22124
   512
  (case Option.map Toplevel.proof_node node of
wenzelm@27566
   513
    SOME (SOME prf) => ProofNode.current prf
wenzelm@22124
   514
  | _ => error "No proof state");
wenzelm@22124
   515
wenzelm@22124
   516
fun output_goals main_goal src node = args (Scan.succeed ()) (output (fn _ => fn _ =>
wenzelm@22124
   517
  Pretty.chunks (Proof.pretty_goals main_goal (proof_state node)))) src node;
wenzelm@22124
   518
wenzelm@22124
   519
fun ml_val txt = "fn _ => (" ^ txt ^ ");";
wenzelm@22124
   520
fun ml_type txt = "val _ = NONE : (" ^ txt ^ ") option;";
wenzelm@22124
   521
fun ml_struct txt = "functor DUMMY_FUNCTOR() = struct structure DUMMY = " ^ txt ^ " end;"
wenzelm@22124
   522
wenzelm@26385
   523
fun output_ml ml src ctxt (txt, pos) =
wenzelm@28273
   524
 (ML_Context.eval_in (SOME ctxt) false pos (ml txt);
wenzelm@27882
   525
  (if ! source then str_of_source src else SymbolPos.content (SymbolPos.explode (txt, pos)))
wenzelm@22124
   526
  |> (if ! quotes then quote else I)
wenzelm@22124
   527
  |> (if ! display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
wenzelm@22124
   528
  else
wenzelm@22124
   529
    split_lines
wenzelm@22124
   530
    #> map (space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|")
wenzelm@22124
   531
    #> space_implode "\\isasep\\isanewline%\n"));
wenzelm@22124
   532
wenzelm@22124
   533
wenzelm@27522
   534
(* embedded lemmas *)
wenzelm@27522
   535
wenzelm@27522
   536
fun pretty_lemma ctxt (prop, methods) =
wenzelm@27522
   537
  let
wenzelm@27522
   538
    val _ = ctxt
wenzelm@27522
   539
      |> Proof.theorem_i NONE (K I) [[(prop, [])]]
wenzelm@27522
   540
      |> Proof.global_terminal_proof methods;
wenzelm@27522
   541
  in pretty_term ctxt prop end;
wenzelm@22124
   542
wenzelm@27381
   543
val embedded_lemma =
wenzelm@27809
   544
  args (Args.prop -- Scan.lift (Args.$$$ "by" |-- Method.parse -- Scan.option Method.parse))
wenzelm@27381
   545
    (output pretty_lemma o (fn ((a, arg :: _), p) => (Args.src ((a, [arg]), p))) o Args.dest_src);
wenzelm@27381
   546
wenzelm@27522
   547
wenzelm@27522
   548
(* commands *)
wenzelm@27522
   549
wenzelm@27381
   550
val _ = OuterKeyword.keyword "by";
wenzelm@27381
   551
wenzelm@22124
   552
val _ = add_commands
wenzelm@22124
   553
 [("thm", args Attrib.thms (output_list pretty_thm)),
wenzelm@22124
   554
  ("thm_style", args (Scan.lift Args.liberal_name -- Attrib.thm) (output pretty_thm_style)),
wenzelm@22124
   555
  ("prop", args Args.prop (output pretty_term)),
wenzelm@27381
   556
  ("lemma", embedded_lemma),
wenzelm@22124
   557
  ("term", args Args.term (output pretty_term)),
wenzelm@22124
   558
  ("term_style", args (Scan.lift Args.liberal_name -- Args.term) (output pretty_term_style)),
wenzelm@22124
   559
  ("term_type", args Args.term (output pretty_term_typ)),
wenzelm@22124
   560
  ("typeof", args Args.term (output pretty_term_typeof)),
wenzelm@25373
   561
  ("const", args Args.const_proper (output pretty_const)),
wenzelm@27882
   562
  ("abbrev", args (Scan.lift Args.name_source) (output pretty_abbrev)),
wenzelm@24920
   563
  ("typ", args Args.typ_abbrev (output Syntax.pretty_typ)),
wenzelm@22124
   564
  ("text", args (Scan.lift Args.name) (output (K pretty_text))),
wenzelm@22124
   565
  ("goals", output_goals true),
wenzelm@22124
   566
  ("subgoals", output_goals false),
wenzelm@22124
   567
  ("prf", args Attrib.thms (output (pretty_prf false))),
wenzelm@22124
   568
  ("full_prf", args Attrib.thms (output (pretty_prf true))),
wenzelm@22124
   569
  ("theory", args (Scan.lift Args.name) (output pretty_theory)),
wenzelm@27882
   570
  ("ML", args (Scan.lift Args.name_source_position) (output_ml ml_val)),
wenzelm@27882
   571
  ("ML_type", args (Scan.lift Args.name_source_position) (output_ml ml_type)),
wenzelm@27882
   572
  ("ML_struct", args (Scan.lift Args.name_source_position) (output_ml ml_struct))];
wenzelm@22124
   573
wenzelm@22124
   574
end;