1 (* Title: Doc/antiquote_setup.ML
5 Auxiliary antiquotations for the Isabelle manuals.
8 structure AntiquoteSetup: sig end =
11 structure O = ThyOutput;
16 val clean_string = translate_string
25 fun clean_name "\\<dots>" = "dots"
26 | clean_name ".." = "ddot"
27 | clean_name "." = "dot"
28 | clean_name "_" = "underscore"
29 | clean_name "{" = "braceleft"
30 | clean_name "}" = "braceright"
31 | clean_name s = s |> translate_string (fn "_" => "-" | c => c);
36 val verbatim = space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|";
38 val _ = O.add_commands
39 [("verbatim", O.args (Scan.lift Args.name) (fn _ => fn _ =>
40 split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))];
47 fun ml_val (txt1, "") = "fn _ => (" ^ txt1 ^ ");"
48 | ml_val (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ ");";
50 fun ml_type (txt1, "") = "val _ = NONE : (" ^ txt1 ^ ") option;"
51 | ml_type (txt1, txt2) = "val _ = [NONE : (" ^ txt1 ^ ") option, NONE : (" ^ txt2 ^ ") option];";
53 fun ml_exn (txt1, "") = "fn _ => (" ^ txt1 ^ ": exn);"
54 | ml_exn (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ " -> exn);";
56 fun ml_structure (txt, _) = "functor DUMMY_FUNCTOR() = struct structure DUMMY = " ^ txt ^ " end;"
58 fun ml_functor _ = "val _ = ();"; (*no check!*)
60 fun index_ml kind ml src ctxt (txt1, txt2) =
62 val txt = if txt2 = "" then txt1 else
63 if kind = "type" then txt1 ^ " = " ^ txt2
64 else if kind = "exception" then txt1 ^ " of " ^ txt2
65 else txt1 ^ ": " ^ txt2;
66 val txt' = if kind = "" then txt else kind ^ " " ^ txt;
67 val _ = writeln (ml (txt1, txt2));
68 val _ = ML_Context.eval_in (SOME ctxt) false Position.none (ml (txt1, txt2));
70 "\\indexml" ^ kind ^ enclose "{" "}" (clean_string txt1) ^
72 |> (if ! O.quotes then quote else I)
73 |> (if ! O.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
74 else split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))
77 fun output_ml ctxt src =
78 if ! O.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
81 #> map (space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|")
82 #> space_implode "\\isasep\\isanewline%\n";
84 fun ml_args x = O.args (Scan.lift (Args.name -- Scan.optional (Args.colon |-- Args.name) "")) x;
88 val _ = O.add_commands
89 [("index_ML", ml_args (index_ml "" ml_val)),
90 ("index_ML_type", ml_args (index_ml "type" ml_type)),
91 ("index_ML_exn", ml_args (index_ml "exception" ml_exn)),
92 ("index_ML_structure", ml_args (index_ml "structure" ml_structure)),
93 ("index_ML_functor", ml_args (index_ml "functor" ml_functor)),
94 ("ML_functor", O.args (Scan.lift Args.name) output_ml),
95 ("ML_text", O.args (Scan.lift Args.name) output_ml)];
100 (* theorems with names *)
104 fun output_named_thms src ctxt xs =
105 map (apfst (ThyOutput.pretty_thm ctxt)) xs (*always pretty in order to exhibit errors!*)
106 |> (if ! O.quotes then map (apfst Pretty.quote) else I)
107 |> (if ! O.display then
109 Output.output (Pretty.string_of (Pretty.indent (! O.indent) p)) ^
110 "\\rulename{" ^ Output.output (Pretty.str_of (ThyOutput.pretty_text name)) ^ "}")
111 #> space_implode "\\par\\smallskip%\n"
112 #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
115 Output.output (Pretty.str_of p) ^
116 "\\rulename{" ^ Output.output (Pretty.str_of (ThyOutput.pretty_text name)) ^ "}")
117 #> space_implode "\\par\\smallskip%\n"
118 #> enclose "\\isa{" "}");
122 val _ = O.add_commands
123 [("named_thms", O.args (Scan.repeat (Attrib.thm --
124 Scan.lift (Args.parens Args.name))) output_named_thms)];
131 val _ = O.add_commands
132 [("thy_file", O.args (Scan.lift Args.name) (O.output (fn _ => fn name =>
133 (ThyLoad.check_thy Path.current name; Pretty.str name))))];
136 (* Isabelle entities (with index) *)
140 fun no_check _ _ = true;
142 fun thy_check intern defined ctxt =
143 let val thy = ProofContext.theory_of ctxt
144 in defined thy o intern thy end;
146 fun check_tool name =
147 File.exists (Path.append (Path.explode "~~/lib/Tools") (Path.basic name));
149 val arg = enclose "{" "}" o clean_string;
151 fun output_entity check markup index kind ctxt (logic, name) =
153 val hyper_name = "{" ^ NameSpace.append kind (NameSpace.append logic (clean_name name)) ^ "}";
155 enclose ("\\hyperlink" ^ hyper_name ^ "{") "}" #>
156 index = SOME true ? enclose ("\\hypertarget" ^ hyper_name ^ "{") "}";
161 "\\index" ^ (if is_def then "def" else "ref") ^ arg logic ^ arg kind ^ arg name);
163 if check ctxt name then
166 |> (if markup = "" then I else enclose ("\\" ^ markup ^ "{") "}")
167 |> (if ! O.quotes then quote else I)
168 |> (if ! O.display then enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
169 else hyper o enclose "\\mbox{\\isa{" "}}"))
170 else error ("Bad " ^ kind ^ " " ^ quote name)
173 fun entity check markup index kind =
174 O.args (Scan.lift (Scan.optional (Args.parens Args.name) "" -- Args.name))
175 (K (output_entity check markup index kind));
177 fun entity_antiqs check markup kind =
178 [(kind, entity check markup NONE kind),
179 (kind ^ "_def", entity check markup (SOME true) kind),
180 (kind ^ "_ref", entity check markup (SOME false) kind)];
184 val _ = O.add_commands
185 (entity_antiqs no_check "" "syntax" @
186 entity_antiqs (K (is_some o OuterKeyword.command_keyword)) "isacommand" "command" @
187 entity_antiqs (K OuterKeyword.is_keyword) "isakeyword" "keyword" @
188 entity_antiqs (K OuterKeyword.is_keyword) "isakeyword" "element" @
189 entity_antiqs (thy_check Method.intern Method.defined) "" "method" @
190 entity_antiqs (thy_check Attrib.intern Attrib.defined) "" "attribute" @
191 entity_antiqs no_check "" "fact" @
192 entity_antiqs no_check "" "variable" @
193 entity_antiqs no_check "" "case" @
194 entity_antiqs (K ThyOutput.defined_command) "" "antiquotation" @
195 entity_antiqs (fn _ => fn name => is_some (OS.Process.getEnv name)) "isatt" "setting" @
196 entity_antiqs no_check "isatt" "executable" @
197 entity_antiqs (K check_tool) "isatt" "tool" @
198 entity_antiqs (K (File.exists o Path.explode)) "isatt" "file" @
199 entity_antiqs (K ThyInfo.known_thy) "" "theory");