wenzelm@48985: (*  Title:      Doc/antiquote_setup.ML
wenzelm@21375:     Author:     Makarius
wenzelm@21375: 
wenzelm@26742: Auxiliary antiquotations for the Isabelle manuals.
wenzelm@21375: *)
wenzelm@21375: 
wenzelm@43564: signature ANTIQUOTE_SETUP =
wenzelm@43564: sig
wenzelm@43564:   val setup: theory -> theory
wenzelm@43564: end;
wenzelm@43564: 
wenzelm@43564: structure Antiquote_Setup: ANTIQUOTE_SETUP =
wenzelm@26742: struct
wenzelm@21375: 
wenzelm@26742: (* misc utils *)
wenzelm@26742: 
wenzelm@29736: fun translate f = Symbol.explode #> map f #> implode;
wenzelm@29736: 
wenzelm@29736: val clean_string = translate
wenzelm@26853:   (fn "_" => "\\_"
wenzelm@30120:     | "#" => "\\#"
wenzelm@52408:     | "$" => "\\$"
wenzelm@52408:     | "%" => "\\%"
wenzelm@26897:     | "<" => "$<$"
wenzelm@26768:     | ">" => "$>$"
wenzelm@26768:     | "{" => "\\{"
wenzelm@30120:     | "|" => "$\\mid$"
wenzelm@26768:     | "}" => "\\}"
wenzelm@42666:     | "\<hyphen>" => "-"
wenzelm@26768:     | c => c);
wenzelm@26751: 
wenzelm@31546: fun clean_name "\<dots>" = "dots"
wenzelm@26897:   | clean_name ".." = "ddot"
wenzelm@26897:   | clean_name "." = "dot"
wenzelm@26910:   | clean_name "_" = "underscore"
wenzelm@26897:   | clean_name "{" = "braceleft"
wenzelm@26897:   | clean_name "}" = "braceright"
wenzelm@42666:   | clean_name s = s |> translate (fn "_" => "-" | "\<hyphen>" => "-" | c => c);
wenzelm@26897: 
wenzelm@26742: 
wenzelm@26742: (* verbatim text *)
wenzelm@26742: 
wenzelm@26742: val verbatim = space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|";
wenzelm@26742: 
wenzelm@43564: val verbatim_setup =
wenzelm@43564:   Thy_Output.antiquotation @{binding verbatim} (Scan.lift Args.name)
wenzelm@43564:     (K (split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"));
wenzelm@26742: 
wenzelm@26742: 
wenzelm@26742: (* ML text *)
wenzelm@26742: 
wenzelm@26742: local
wenzelm@26742: 
wenzelm@55831: val ml_toks = ML_Lex.read Position.none;
wenzelm@21375: 
wenzelm@55831: fun ml_val (toks1, []) = ml_toks "fn _ => (" @ toks1 @ ml_toks ");"
wenzelm@55831:   | ml_val (toks1, toks2) = ml_toks "fn _ => (" @ toks1 @ ml_toks " : " @ toks2 @ ml_toks ");";
wenzelm@55831: 
wenzelm@55831: fun ml_op (toks1, []) = ml_toks "fn _ => (op " @ toks1 @ ml_toks ");"
wenzelm@55831:   | ml_op (toks1, toks2) = ml_toks "fn _ => (op " @ toks1 @ ml_toks " : " @ toks2 @ ml_toks ");";
wenzelm@46261: 
wenzelm@55831: fun ml_type (toks1, []) = ml_toks "val _ = NONE : (" @ toks1 @ ml_toks ") option;"
wenzelm@55831:   | ml_type (toks1, toks2) =
wenzelm@55831:       ml_toks "val _ = [NONE : (" @ toks1 @ ml_toks ") option, NONE : (" @
wenzelm@55831:         toks2 @ ml_toks ") option];";
haftmann@22289: 
wenzelm@55837: fun ml_exception (toks1, []) = ml_toks "fn _ => (" @ toks1 @ ml_toks " : exn);"
wenzelm@55837:   | ml_exception (toks1, toks2) =
wenzelm@55831:       ml_toks "fn _ => (" @ toks1 @ ml_toks " : " @ toks2 @ ml_toks " -> exn);";
haftmann@22289: 
wenzelm@55831: fun ml_structure (toks, _) =
wenzelm@55831:   ml_toks "functor XXX() = struct structure XX = " @ toks @ ml_toks " end;";
wenzelm@21375: 
wenzelm@55831: fun ml_functor (Antiquote.Text tok :: _, _) =
wenzelm@55831:       ml_toks "ML_Env.check_functor " @ ml_toks (ML_Syntax.print_string (ML_Lex.content_of tok))
wenzelm@55831:   | ml_functor _ = raise Fail "Bad ML functor specification";
wenzelm@21375: 
wenzelm@39869: val is_name = ML_Lex.kind_of #> (fn kind => kind = ML_Lex.Ident orelse kind = ML_Lex.LongIdent);
wenzelm@39869: 
wenzelm@39869: fun ml_name txt =
wenzelm@39869:   (case filter is_name (ML_Lex.tokenize txt) of
wenzelm@39869:     toks as [_] => ML_Lex.flatten toks
wenzelm@39869:   | _ => error ("Single ML name expected in input: " ^ quote txt));
wenzelm@39869: 
wenzelm@55831: fun prep_ml source =
wenzelm@55831:   (#1 (Symbol_Pos.source_content source), ML_Lex.read_source source);
wenzelm@55831: 
wenzelm@37216: fun index_ml name kind ml = Thy_Output.antiquotation name
wenzelm@55831:   (Scan.lift (Args.name_source_position -- Scan.option (Args.colon |-- Args.name_source_position)))
wenzelm@55831:   (fn {context = ctxt, ...} => fn (source1, opt_source2) =>
wenzelm@30394:     let
wenzelm@55831:       val (txt1, toks1) = prep_ml source1;
wenzelm@55831:       val (txt2, toks2) =
wenzelm@55831:         (case opt_source2 of
wenzelm@55831:           SOME source => prep_ml source
wenzelm@55831:         | NONE => ("", []));
wenzelm@55831: 
wenzelm@30394:       val txt =
wenzelm@30394:         if txt2 = "" then txt1
wenzelm@30394:         else if kind = "type" then txt1 ^ " = " ^ txt2
wenzelm@30394:         else if kind = "exception" then txt1 ^ " of " ^ txt2
wenzelm@50239:         else if Symbol_Pos.is_identifier (Long_Name.base_name (ml_name txt1))
wenzelm@42290:         then txt1 ^ ": " ^ txt2
wenzelm@39858:         else txt1 ^ " : " ^ txt2;
wenzelm@30394:       val txt' = if kind = "" then txt else kind ^ " " ^ txt;
wenzelm@55831: 
wenzelm@55831:       val _ = ML_Context.eval_in (SOME ctxt) false (#pos source1) (ml (toks1, toks2));
wenzelm@30394:       val kind' = if kind = "" then "ML" else "ML " ^ kind;
wenzelm@30394:     in
wenzelm@39869:       "\\indexdef{}{" ^ kind' ^ "}{" ^ clean_string (ml_name txt1) ^ "}" ^
wenzelm@30394:       (txt'
wenzelm@38767:       |> (if Config.get ctxt Thy_Output.quotes then quote else I)
wenzelm@55831:       |> (if Config.get ctxt Thy_Output.display
wenzelm@55831:           then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
wenzelm@30394:           else split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))
wenzelm@30394:     end);
wenzelm@26742: 
wenzelm@26742: in
wenzelm@21375: 
wenzelm@43564: val index_ml_setup =
wenzelm@43564:   index_ml @{binding index_ML} "" ml_val #>
wenzelm@46261:   index_ml @{binding index_ML_op} "infix" ml_op #>
wenzelm@43564:   index_ml @{binding index_ML_type} "type" ml_type #>
wenzelm@55837:   index_ml @{binding index_ML_exception} "exception" ml_exception #>
wenzelm@55837:   index_ml @{binding index_ML_structure} "structure" ml_structure #>
wenzelm@43564:   index_ml @{binding index_ML_functor} "functor" ml_functor;
wenzelm@21375: 
wenzelm@26742: end;
wenzelm@21375: 
berghofe@23846: 
wenzelm@30394: (* named theorems *)
berghofe@23846: 
wenzelm@43564: val named_thms_setup =
wenzelm@43564:   Thy_Output.antiquotation @{binding named_thms}
wenzelm@43564:     (Scan.repeat (Attrib.thm -- Scan.lift (Args.parens Args.name)))
wenzelm@43564:     (fn {context = ctxt, ...} =>
wenzelm@43564:       map (apfst (Thy_Output.pretty_thm ctxt))
wenzelm@43564:       #> (if Config.get ctxt Thy_Output.quotes then map (apfst Pretty.quote) else I)
wenzelm@43564:       #> (if Config.get ctxt Thy_Output.display
wenzelm@43564:           then
wenzelm@43564:             map (fn (p, name) =>
wenzelm@43564:               Output.output (Pretty.string_of (Pretty.indent (Config.get ctxt Thy_Output.indent) p)) ^
wenzelm@43564:               "\\rulename{" ^ Output.output (Pretty.str_of (Thy_Output.pretty_text ctxt name)) ^ "}")
wenzelm@43564:             #> space_implode "\\par\\smallskip%\n"
wenzelm@43564:             #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
wenzelm@43564:           else
wenzelm@43564:             map (fn (p, name) =>
wenzelm@43564:               Output.output (Pretty.str_of p) ^
wenzelm@43564:               "\\rulename{" ^ Output.output (Pretty.str_of (Thy_Output.pretty_text ctxt name)) ^ "}")
wenzelm@43564:             #> space_implode "\\par\\smallskip%\n"
wenzelm@43564:             #> enclose "\\isa{" "}"));
wenzelm@26742: 
wenzelm@26742: 
wenzelm@30394: (* theory file *)
wenzelm@26742: 
wenzelm@43564: val thy_file_setup =
wenzelm@43564:   Thy_Output.antiquotation @{binding thy_file} (Scan.lift Args.name)
wenzelm@43564:     (fn {context = ctxt, ...} =>
wenzelm@48899:       fn name => (Thy_Load.check_thy Path.current name; Thy_Output.output ctxt [Pretty.str name]));
wenzelm@26742: 
wenzelm@26751: 
wenzelm@30394: (* Isabelle/Isar entities (with index) *)
wenzelm@26751: 
wenzelm@26751: local
wenzelm@26751: 
wenzelm@26894: fun no_check _ _ = true;
wenzelm@26894: 
wenzelm@53061: fun command_check (name, pos) =
wenzelm@53061:   is_some (Keyword.command_keyword name) andalso
wenzelm@53061:     let
wenzelm@53061:       val markup =
wenzelm@53061:         Outer_Syntax.scan Position.none name
wenzelm@53061:         |> maps (Outer_Syntax.command_reports (#2 (Outer_Syntax.get_syntax ())))
wenzelm@53061:         |> map (snd o fst);
wenzelm@53061:       val _ = List.app (Position.report pos) markup;
wenzelm@53061:     in true end;
wenzelm@53061: 
wenzelm@53044: fun check_tool (name, pos) =
wenzelm@53044:   let
wenzelm@53044:     fun tool dir =
wenzelm@53044:       let val path = Path.append dir (Path.basic name)
wenzelm@53044:       in if File.exists path then SOME path else NONE end;
wenzelm@53044:   in
wenzelm@53045:     (case get_first tool (Path.split (getenv "ISABELLE_TOOLS")) of
wenzelm@53044:       NONE => false
wenzelm@53044:     | SOME path => (Position.report pos (Markup.path (Path.implode path)); true))
wenzelm@53044:   end;
wenzelm@28237: 
wenzelm@26751: val arg = enclose "{" "}" o clean_string;
wenzelm@26751: 
wenzelm@30394: fun entity check markup kind index =
wenzelm@37216:   Thy_Output.antiquotation
wenzelm@43564:     (Binding.name (translate (fn " " => "_" | c => c) kind ^
wenzelm@43564:       (case index of NONE => "" | SOME true => "_def" | SOME false => "_ref")))
wenzelm@53044:     (Scan.lift (Scan.optional (Args.parens Args.name) "" -- Parse.position Args.name))
wenzelm@53044:     (fn {context = ctxt, ...} => fn (logic, (name, pos)) =>
wenzelm@30394:       let
wenzelm@30394:         val hyper_name =
wenzelm@30394:           "{" ^ Long_Name.append kind (Long_Name.append logic (clean_name name)) ^ "}";
wenzelm@30394:         val hyper =
wenzelm@30394:           enclose ("\\hyperlink" ^ hyper_name ^ "{") "}" #>
wenzelm@30394:           index = SOME true ? enclose ("\\hypertarget" ^ hyper_name ^ "{") "}";
wenzelm@30394:         val idx =
wenzelm@30394:           (case index of
wenzelm@30394:             NONE => ""
wenzelm@30394:           | SOME is_def =>
wenzelm@30394:               "\\index" ^ (if is_def then "def" else "ref") ^ arg logic ^ arg kind ^ arg name);
wenzelm@30394:       in
wenzelm@53044:         if check ctxt (name, pos) then
wenzelm@30394:           idx ^
wenzelm@30394:           (Output.output name
wenzelm@30394:             |> (if markup = "" then I else enclose ("\\" ^ markup ^ "{") "}")
wenzelm@38767:             |> (if Config.get ctxt Thy_Output.quotes then quote else I)
wenzelm@38767:             |> (if Config.get ctxt Thy_Output.display
wenzelm@38767:                 then enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
wenzelm@30394:                 else hyper o enclose "\\mbox{\\isa{" "}}"))
wenzelm@53044:         else error ("Bad " ^ kind ^ " " ^ quote name ^ Position.here pos)
wenzelm@30394:       end);
wenzelm@26897: 
wenzelm@26894: fun entity_antiqs check markup kind =
wenzelm@43564:   entity check markup kind NONE #>
wenzelm@43564:   entity check markup kind (SOME true) #>
wenzelm@43564:   entity check markup kind (SOME false);
wenzelm@26751: 
wenzelm@26751: in
wenzelm@26751: 
wenzelm@43564: val entity_setup =
wenzelm@43564:   entity_antiqs no_check "" "syntax" #>
wenzelm@53061:   entity_antiqs (K command_check) "isacommand" "command" #>
wenzelm@53044:   entity_antiqs (K (Keyword.is_keyword o #1)) "isakeyword" "keyword" #>
wenzelm@53044:   entity_antiqs (K (Keyword.is_keyword o #1)) "isakeyword" "element" #>
wenzelm@55742:   entity_antiqs (can o Method.check_name) "" "method" #>
wenzelm@55743:   entity_antiqs (can o Attrib.check o Proof_Context.theory_of) "" "attribute" #>
wenzelm@43564:   entity_antiqs no_check "" "fact" #>
wenzelm@43564:   entity_antiqs no_check "" "variable" #>
wenzelm@43564:   entity_antiqs no_check "" "case" #>
wenzelm@55743:   entity_antiqs (can o Thy_Output.check_command) "" "antiquotation" #>
wenzelm@55743:   entity_antiqs (can o Thy_Output.check_option) "" "antiquotation option" #>
wenzelm@48554:   entity_antiqs no_check "isatt" "setting" #>
wenzelm@48578:   entity_antiqs no_check "isatt" "system option" #>
wenzelm@43564:   entity_antiqs no_check "" "inference" #>
wenzelm@43564:   entity_antiqs no_check "isatt" "executable" #>
wenzelm@48602:   entity_antiqs (K check_tool) "isatool" "tool" #>
wenzelm@55743:   entity_antiqs (can o ML_Context.check_antiq) "" Markup.ML_antiquotationN;
wenzelm@26751: 
wenzelm@26742: end;
wenzelm@26751: 
wenzelm@43564: 
wenzelm@43564: (* theory setup *)
wenzelm@43564: 
wenzelm@43564: val setup =
wenzelm@43564:   verbatim_setup #>
wenzelm@43564:   index_ml_setup #>
wenzelm@43564:   named_thms_setup #>
wenzelm@43564:   thy_file_setup #>
wenzelm@43564:   entity_setup;
wenzelm@43564: 
wenzelm@26751: end;