(*  Title:      Pure/Thy/thy_output.ML

     Author:     Markus Wenzel, TU Muenchen

 Theory document output with antiquotations.

 *)

 signature THY_OUTPUT =

 sig

   val display: bool Unsynchronized.ref

   val quotes: bool Unsynchronized.ref

   val indent: int Unsynchronized.ref

   val source: bool Unsynchronized.ref

   val break: bool Unsynchronized.ref

   val add_commands: (string * (Args.src -> Toplevel.state -> string)) list -> unit

   val add_options: (string * (string -> (unit -> string) -> unit -> string)) list -> unit

   val defined_command: string -> bool

   val defined_option: string -> bool

   val print_antiquotations: unit -> unit

   val boolean: string -> bool

   val integer: string -> int

   val antiquotation: string -> 'a context_parser ->

     ({state: Toplevel.state, source: Args.src, context: Proof.context} -> 'a -> string) -> unit

   datatype markup = Markup | MarkupEnv | Verbatim

   val modes: string list Unsynchronized.ref

   val eval_antiquote: Scan.lexicon -> Toplevel.state -> Symbol_Pos.text * Position.T -> string

   val present_thy: Scan.lexicon -> (string -> string list) -> (markup -> string -> bool) ->

     (Toplevel.transition * Toplevel.state) list -> (Token.T, 'a) Source.source -> Buffer.T

   val pretty_text: string -> Pretty.T

   val pretty_term: Proof.context -> term -> Pretty.T

   val pretty_thm: Proof.context -> thm -> Pretty.T

   val str_of_source: Args.src -> string

   val maybe_pretty_source: ('a -> Pretty.T) -> Args.src -> 'a list -> Pretty.T list

   val output: Pretty.T list -> string

 end;

 structure Thy_Output: THY_OUTPUT =

 struct

 (** global options **)

 val display = Unsynchronized.ref false;

 val quotes = Unsynchronized.ref false;

 val indent = Unsynchronized.ref 0;

 val source = Unsynchronized.ref false;

 val break = Unsynchronized.ref false;

 (** maintain global antiquotations **)

 local

 val global_commands =

   Unsynchronized.ref (Symtab.empty: (Args.src -> Toplevel.state -> string) Symtab.table);

 val global_options =

   Unsynchronized.ref (Symtab.empty: (string -> (unit -> string) -> unit -> string) Symtab.table);

 fun add_item kind (name, x) tab =

  (if not (Symtab.defined tab name) then ()

   else warning ("Redefined document antiquotation " ^ kind ^ ": " ^ quote name);

   Symtab.update (name, x) tab);

 in

 fun add_commands xs =

   CRITICAL (fn () => Unsynchronized.change global_commands (fold (add_item "command") xs));

 fun add_options xs =

   CRITICAL (fn () => Unsynchronized.change global_options (fold (add_item "option") xs));

 fun defined_command name = Symtab.defined (! global_commands) name;

 fun defined_option name = Symtab.defined (! global_options) name;

 fun command src =

   let val ((name, _), pos) = Args.dest_src src in

     (case Symtab.lookup (! global_commands) name of

       NONE => error ("Unknown document antiquotation: " ^ quote name ^ Position.str_of pos)

     | SOME f =>

        (Position.report (Markup.doc_antiq name) pos;

         (fn state => f src state handle ERROR msg =>

           cat_error msg ("The error(s) above occurred in document antiquotation: " ^

             quote name ^ Position.str_of pos))))

   end;

 fun option (name, s) f () =

   (case Symtab.lookup (! global_options) name of

     NONE => error ("Unknown document antiquotation option: " ^ quote name)

   | SOME opt => opt s f ());

 fun options [] f = f

   | options (opt :: opts) f = option opt (options opts f);

 fun print_antiquotations () =

  [Pretty.big_list "document antiquotation commands:"

     (map Pretty.str (sort_strings (Symtab.keys (! global_commands)))),

   Pretty.big_list "document antiquotation options:"

     (map Pretty.str (sort_strings (Symtab.keys (! global_options))))]

  |> Pretty.chunks |> Pretty.writeln;

 end;

 fun antiquotation name scan out = add_commands [(name, fn src => fn state =>

   let val (x, ctxt) = Args.context_syntax "document antiquotation"

     scan src (Toplevel.presentation_context_of state)

   in out {source = src, state = state, context = ctxt} x end)];

 (** syntax of antiquotations **)

 (* option values *)

 fun boolean "" = true

   | boolean "true" = true

   | boolean "false" = false

   | boolean s = error ("Bad boolean value: " ^ quote s);

 fun integer s =

   let

     fun int ss =

       (case Library.read_int ss of (i, []) => i

       | _ => error ("Bad integer value: " ^ quote s));

   in (case Symbol.explode s of "-" :: ss => ~ (int ss) | ss => int ss) end;

 (* outer syntax *)

 local

 val property =

   Parse.xname -- Scan.optional (Parse.$$$ "=" |-- Parse.!!! Parse.xname) "";

 val properties =

   Scan.optional (Parse.$$$ "[" |-- Parse.!!! (Parse.enum "," property --| Parse.$$$ "]")) [];

 in

 val antiq =

   Parse.!!! (Parse.position Parse.xname -- properties -- Args.parse --| Scan.ahead Parse.eof)

   >> (fn (((x, pos), y), z) => (y, Args.src ((x, z), pos)));

 end;

 (* eval_antiquote *)

 val modes = Unsynchronized.ref ([]: string list);

 fun eval_antiquote lex state (txt, pos) =

   let

     fun expand (Antiquote.Text ss) = Symbol_Pos.content ss

       | expand (Antiquote.Antiq (ss, (pos, _))) =

           let val (opts, src) = Token.read_antiq lex antiq (ss, pos) in

             options opts (fn () => command src state) ();  (*preview errors!*)

             Print_Mode.with_modes (! modes @ Latex.modes)

               (Output.no_warnings_CRITICAL (options opts (fn () => command src state))) ()

           end

       | expand (Antiquote.Open _) = ""

       | expand (Antiquote.Close _) = "";

     val ants = Antiquote.read (Symbol_Pos.explode (txt, pos), pos);

   in

     if Toplevel.is_toplevel state andalso not (forall Antiquote.is_text ants) then

       error ("Unknown context -- cannot expand document antiquotations" ^ Position.str_of pos)

     else implode (map expand ants)

   end;

 (** present theory source **)

 (*NB: arranging white space around command spans is a black art.*)

 (* presentation tokens *)

 datatype token =

     NoToken

   | BasicToken of Token.T

   | MarkupToken of string * (string * Position.T)

   | MarkupEnvToken of string * (string * Position.T)

   | VerbatimToken of string * Position.T;

 fun output_token lex state =

   let val eval = eval_antiquote lex state in

     fn NoToken => ""

      | BasicToken tok => Latex.output_basic tok

      | MarkupToken (cmd, txt) => Latex.output_markup cmd (eval txt)

      | MarkupEnvToken (cmd, txt) => Latex.output_markup_env cmd (eval txt)

      | VerbatimToken txt => Latex.output_verbatim (eval txt)

   end;

 fun basic_token pred (BasicToken tok) = pred tok

   | basic_token _ _ = false;

 val improper_token = basic_token (not o Token.is_proper);

 val comment_token = basic_token Token.is_comment;

 val blank_token = basic_token Token.is_blank;

 val newline_token = basic_token Token.is_newline;

 (* command spans *)

 type command = string * Position.T * string list;   (*name, position, tags*)

 type source = (token * (string * int)) list;        (*token, markup flag, meta-comment depth*)

 datatype span = Span of command * (source * source * source * source) * bool;

 fun make_span cmd src =

   let

     fun take_newline (tok :: toks) =

           if newline_token (fst tok) then ([tok], toks, true)

           else ([], tok :: toks, false)

       | take_newline [] = ([], [], false);

     val (((src_prefix, src_main), src_suffix1), (src_suffix2, src_appendix, newline)) =

       src

       |> take_prefix (improper_token o fst)

       ||>> take_suffix (improper_token o fst)

       ||>> take_prefix (comment_token o fst)

       ||> take_newline;

   in Span (cmd, (src_prefix, src_main, src_suffix1 @ src_suffix2, src_appendix), newline) end;

 (* present spans *)

 local

 fun err_bad_nesting pos =

   error ("Bad nesting of commands in presentation" ^ pos);

 fun edge which f (x: string option, y) =

   if x = y then I

   else (case which (x, y) of NONE => I | SOME txt => Buffer.add (f txt));

 val begin_tag = edge #2 Latex.begin_tag;

 val end_tag = edge #1 Latex.end_tag;

 fun open_delim delim e = edge #2 Latex.begin_delim e #> delim #> edge #2 Latex.end_delim e;

 fun close_delim delim e = edge #1 Latex.begin_delim e #> delim #> edge #1 Latex.end_delim e;

 in

 fun present_span lex default_tags span state state'

     (tag_stack, active_tag, newline, buffer, present_cont) =

   let

     val present = fold (fn (tok, (flag, 0)) =>

         Buffer.add (output_token lex state' tok)

         #> Buffer.add flag

       | _ => I);

     val Span ((cmd_name, cmd_pos, cmd_tags), srcs, span_newline) = span;

     val (tag, tags) = tag_stack;

     val tag' = try hd (fold Keyword.update_tags cmd_tags (the_list tag));

     val active_tag' =

       if is_some tag' then tag'

       else if cmd_name = "end" andalso not (Toplevel.is_toplevel state') then NONE

       else try hd (default_tags cmd_name);

     val edge = (active_tag, active_tag');

     val newline' =

       if is_none active_tag' then span_newline else newline;

     val nesting = Toplevel.level state' - Toplevel.level state;

     val tag_stack' =

       if nesting = 0 andalso not (Toplevel.is_proof state) then tag_stack

       else if nesting >= 0 then (tag', replicate nesting tag @ tags)

       else

         (case drop (~ nesting - 1) tags of

           tgs :: tgss => (tgs, tgss)

         | [] => err_bad_nesting (Position.str_of cmd_pos));

     val buffer' =

       buffer

       |> end_tag edge

       |> close_delim (fst present_cont) edge

       |> snd present_cont

       |> open_delim (present (#1 srcs)) edge

       |> begin_tag edge

       |> present (#2 srcs);

     val present_cont' =

       if newline then (present (#3 srcs), present (#4 srcs))

       else (I, present (#3 srcs) #> present (#4 srcs));

   in (tag_stack', active_tag', newline', buffer', present_cont') end;

 fun present_trailer ((_, tags), active_tag, _, buffer, present_cont) =

   if not (null tags) then err_bad_nesting " at end of theory"

   else

     buffer

     |> end_tag (active_tag, NONE)

     |> close_delim (fst present_cont) (active_tag, NONE)

     |> snd present_cont;

 end;

 (* present_thy *)

 datatype markup = Markup | MarkupEnv | Verbatim;

 local

 val space_proper =

   Scan.one Token.is_blank -- Scan.many Token.is_comment -- Scan.one Token.is_proper;

 val is_improper = not o (Token.is_proper orf Token.is_begin_ignore orf Token.is_end_ignore);

 val improper = Scan.many is_improper;

 val improper_end = Scan.repeat (Scan.unless space_proper (Scan.one is_improper));

 val blank_end = Scan.repeat (Scan.unless space_proper (Scan.one Token.is_blank));

 val opt_newline = Scan.option (Scan.one Token.is_newline);

 val ignore =

   Scan.depend (fn d => opt_newline |-- Scan.one Token.is_begin_ignore

     >> pair (d + 1)) ||

   Scan.depend (fn d => Scan.one Token.is_end_ignore --|

     (if d = 0 then Scan.fail_with (K "Bad nesting of meta-comments") else opt_newline)

     >> pair (d - 1));

 val tag = (improper -- Parse.$$$ "%" -- improper) |-- Parse.!!! (Parse.tag_name --| blank_end);

 val locale =

   Scan.option ((Parse.$$$ "(" -- improper -- Parse.$$$ "in") |--

     Parse.!!! (improper |-- Parse.xname --| (improper -- Parse.$$$ ")")));

 in

 fun present_thy lex default_tags is_markup command_results src =

   let

     (* tokens *)

     val ignored = Scan.state --| ignore

       >> (fn d => (NONE, (NoToken, ("", d))));

     fun markup mark mk flag = Scan.peek (fn d =>

       improper |--

         Parse.position

           (Scan.one (Token.is_kind Token.Command andf is_markup mark o Token.content_of)) --

       Scan.repeat tag --

       Parse.!!!! ((improper -- locale -- improper) |-- Parse.doc_source --| improper_end)

       >> (fn (((tok, pos), tags), txt) =>

         let val name = Token.content_of tok

         in (SOME (name, pos, tags), (mk (name, txt), (flag, d))) end));

     val command = Scan.peek (fn d =>

       Parse.position (Scan.one (Token.is_kind Token.Command)) --

       Scan.repeat tag

       >> (fn ((tok, pos), tags) =>

         let val name = Token.content_of tok

         in (SOME (name, pos, tags), (BasicToken tok, (Latex.markup_false, d))) end));

     val cmt = Scan.peek (fn d =>

       Parse.$$$ "--" |-- Parse.!!!! (improper |-- Parse.doc_source)

       >> (fn txt => (NONE, (MarkupToken ("cmt", txt), ("", d)))));

     val other = Scan.peek (fn d =>

        Parse.not_eof >> (fn tok => (NONE, (BasicToken tok, ("", d)))));

     val token =

       ignored ||

       markup Markup MarkupToken Latex.markup_true ||

       markup MarkupEnv MarkupEnvToken Latex.markup_true ||

       markup Verbatim (VerbatimToken o #2) "" ||

       command || cmt || other;

     (* spans *)

     val is_eof = fn (_, (BasicToken x, _)) => Token.is_eof x | _ => false;

     val stopper = Scan.stopper (K (NONE, (BasicToken Token.eof, ("", 0)))) is_eof;

     val cmd = Scan.one (is_some o fst);

     val non_cmd = Scan.one (is_none o fst andf not o is_eof) >> #2;

     val comments = Scan.many (comment_token o fst o snd);

     val blank = Scan.one (blank_token o fst o snd);

     val newline = Scan.one (newline_token o fst o snd);

     val before_cmd =

       Scan.option (newline -- comments) --

       Scan.option (newline -- comments) --

       Scan.option (blank -- comments) -- cmd;

     val span =

       Scan.repeat non_cmd -- cmd --

         Scan.repeat (Scan.unless before_cmd non_cmd) --

         Scan.option (newline >> (single o snd))

       >> (fn (((toks1, (cmd, tok2)), toks3), tok4) =>

           make_span (the cmd) (toks1 @ (tok2 :: (toks3 @ the_default [] tok4))));

     val spans =

       src

       |> Source.filter (not o Token.is_semicolon)

       |> Source.source' 0 Token.stopper (Scan.error (Scan.bulk token)) NONE

       |> Source.source stopper (Scan.error (Scan.bulk span)) NONE

       |> Source.exhaust;

     (* present commands *)

     fun present_command tr span st st' =

       Toplevel.setmp_thread_position tr (present_span lex default_tags span st st');

     fun present _ [] = I

       | present st (((tr, st'), span) :: rest) = present_command tr span st st' #> present st' rest;

   in

     if length command_results = length spans then

       ((NONE, []), NONE, true, Buffer.empty, (I, I))

       |> present Toplevel.toplevel (command_results ~~ spans)

       |> present_trailer

     else error "Messed-up outer syntax for presentation"

   end;

 end;

 (** setup default output **)

 (* options *)

 val _ = add_options

  [("show_types", setmp_CRITICAL Syntax.show_types o boolean),

   ("show_sorts", setmp_CRITICAL Syntax.show_sorts o boolean),

   ("show_structs", setmp_CRITICAL show_structs o boolean),

   ("show_question_marks", setmp_CRITICAL show_question_marks o boolean),

   ("long_names", setmp_CRITICAL Name_Space.long_names o boolean),

   ("short_names", setmp_CRITICAL Name_Space.short_names o boolean),

   ("unique_names", setmp_CRITICAL Name_Space.unique_names o boolean),

   ("eta_contract", setmp_CRITICAL Syntax.eta_contract o boolean),

   ("display", setmp_CRITICAL display o boolean),

   ("break", setmp_CRITICAL break o boolean),

   ("quotes", setmp_CRITICAL quotes o boolean),

   ("mode", fn s => fn f => Print_Mode.with_modes [s] f),

   ("margin", setmp_CRITICAL Pretty.margin_default o integer),

   ("indent", setmp_CRITICAL indent o integer),

   ("source", setmp_CRITICAL source o boolean),

   ("goals_limit", setmp_CRITICAL goals_limit o integer)];

 (* basic pretty printing *)

 fun tweak_line s =

   if ! display then s else Symbol.strip_blanks s;

 val pretty_text = Pretty.chunks o map Pretty.str o map tweak_line o Library.split_lines;

 fun pretty_term ctxt t = Syntax.pretty_term (Variable.auto_fixes t ctxt) t;

 fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of;

 fun pretty_term_style ctxt (style, t) =

   pretty_term ctxt (style t);

 fun pretty_thm_style ctxt (style, th) =

   pretty_term ctxt (style (Thm.full_prop_of th));

 fun pretty_term_typ ctxt (style, t) =

   let val t' = style t

   in pretty_term ctxt (Type_Infer.constrain (Term.fastype_of t') t') end;

 fun pretty_term_typeof ctxt (style, t) =

   Syntax.pretty_typ ctxt (Term.fastype_of (style t));

 fun pretty_const ctxt c =

   let

     val t = Const (c, Consts.type_scheme (ProofContext.consts_of ctxt) c)

       handle TYPE (msg, _, _) => error msg;

     val ([t'], _) = Variable.import_terms true [t] ctxt;

   in pretty_term ctxt t' end;

 fun pretty_abbrev ctxt s =

   let

     val t = Syntax.parse_term ctxt s |> singleton (ProofContext.standard_infer_types ctxt);

     fun err () = error ("Abbreviated constant expected: " ^ Syntax.string_of_term ctxt t);

     val (head, args) = Term.strip_comb t;

     val (c, T) = Term.dest_Const head handle TERM _ => err ();

     val (U, u) = Consts.the_abbreviation (ProofContext.consts_of ctxt) c

       handle TYPE _ => err ();

     val t' = Term.betapplys (Envir.expand_atom T (U, u), args);

     val eq = Logic.mk_equals (t, t');

     val ctxt' = Variable.auto_fixes eq ctxt;

   in ProofContext.pretty_term_abbrev ctxt' eq end;

 fun pretty_prf full ctxt = Proof_Syntax.pretty_proof_of ctxt full;

 fun pretty_theory ctxt name =

   (Theory.requires (ProofContext.theory_of ctxt) name "presentation"; Pretty.str name);

 (* default output *)

 val str_of_source = space_implode " " o map Token.unparse o #2 o #1 o Args.dest_src;

 fun maybe_pretty_source pretty src xs =

   map pretty xs  (*always pretty in order to exhibit errors!*)

   |> (if ! source then K [pretty_text (str_of_source src)] else I);

 fun output prts =

   prts

   |> (if ! quotes then map Pretty.quote else I)

   |> (if ! display then

     map (Output.output o Pretty.string_of o Pretty.indent (! indent))

     #> space_implode "\\isasep\\isanewline%\n"

     #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"

   else

     map (Output.output o (if ! break then Pretty.string_of else Pretty.str_of))

     #> space_implode "\\isasep\\isanewline%\n"

     #> enclose "\\isa{" "}");

 (** concrete antiquotations **)

 (* basic entities *)

 local

 fun basic_entities name scan pretty = antiquotation name scan

   (fn {source, context, ...} => output o maybe_pretty_source (pretty context) source);

 fun basic_entities_style name scan pretty = antiquotation name scan

   (fn {source, context, ...} => fn (style, xs) =>

     output (maybe_pretty_source (fn x => pretty context (style, x)) source xs));

 fun basic_entity name scan = basic_entities name (scan >> single);

 in

 val _ = basic_entities_style "thm" (Term_Style.parse -- Attrib.thms) pretty_thm_style;

 val _ = basic_entity "prop" (Term_Style.parse -- Args.prop) pretty_term_style;

 val _ = basic_entity "term" (Term_Style.parse -- Args.term) pretty_term_style;

 val _ = basic_entity "term_type" (Term_Style.parse -- Args.term) pretty_term_typ;

 val _ = basic_entity "typeof" (Term_Style.parse -- Args.term) pretty_term_typeof;

 val _ = basic_entity "const" (Args.const_proper false) pretty_const;

 val _ = basic_entity "abbrev" (Scan.lift Args.name_source) pretty_abbrev;

 val _ = basic_entity "typ" Args.typ_abbrev Syntax.pretty_typ;

 val _ = basic_entity "text" (Scan.lift Args.name) (K pretty_text);

 val _ = basic_entities "prf" Attrib.thms (pretty_prf false);

 val _ = basic_entities "full_prf" Attrib.thms (pretty_prf true);

 val _ = basic_entity "theory" (Scan.lift Args.name) pretty_theory;

 val _ = basic_entities_style "thm_style" (Term_Style.parse_bare -- Attrib.thms) pretty_thm_style;

 val _ = basic_entity "term_style" (Term_Style.parse_bare -- Args.term) pretty_term_style;

 end;

 (* goal state *)

 local

 fun proof_state state =

   (case try Toplevel.proof_of state of

     SOME prf => prf

   | _ => error "No proof state");

 fun goal_state name main_goal = antiquotation name (Scan.succeed ())

   (fn {state, ...} => fn () => output

     [Pretty.chunks (Proof.pretty_goals main_goal (proof_state state))]);

 in

 val _ = goal_state "goals" true;

 val _ = goal_state "subgoals" false;

 end;

 (* embedded lemma *)

 val _ = Keyword.keyword "by";

 val _ = antiquotation "lemma"

   (Args.prop -- Scan.lift (Args.$$$ "by" |-- Method.parse -- Scan.option Method.parse))

   (fn {source, context, ...} => fn (prop, methods) =>

     let

       val prop_src =

         (case Args.dest_src source of ((a, arg :: _), pos) => Args.src ((a, [arg]), pos));

       val _ = context

         |> Proof.theorem NONE (K I) [[(prop, [])]]

         |> Proof.global_terminal_proof methods;

     in output (maybe_pretty_source (pretty_term context) prop_src [prop]) end);

 (* ML text *)

 local

 fun ml_text name ml = antiquotation name (Scan.lift Args.name_source_position)

   (fn {context, ...} => fn (txt, pos) =>

    (ML_Context.eval_in (SOME context) false pos (ml pos txt);

     Symbol_Pos.content (Symbol_Pos.explode (txt, pos))

     |> (if ! quotes then quote else I)

     |> (if ! display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"

     else

       split_lines

       #> map (space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|")

       #> space_implode "\\isasep\\isanewline%\n")));

 fun ml_enclose bg en pos txt =

   ML_Lex.read Position.none bg @ ML_Lex.read pos txt @ ML_Lex.read Position.none en;

 in

 val _ = ml_text "ML" (ml_enclose "fn _ => (" ");");

 val _ = ml_text "ML_type" (ml_enclose "val _ = NONE : (" ") option;");

 val _ = ml_text "ML_struct" (ml_enclose "functor XXX() = struct structure XX = " " end;");

 val _ = ml_text "ML_functor"   (* FIXME formal treatment of functor name (!?) *)

   (fn pos => fn txt =>

     ML_Lex.read Position.none ("ML_Env.check_functor " ^

       ML_Syntax.print_string (Symbol_Pos.content (Symbol_Pos.explode (txt, pos)))));

 val _ = ml_text "ML_text" (K (K []));

 end;

 end;