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