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