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);
33 val str_of_source = space_implode " " o map OuterLex.unparse o #2 o #1 o Args.dest_src;
36 if ! O.display then s else Symbol.strip_blanks s;
38 val pretty_text = Pretty.chunks o map Pretty.str o map tweak_line o Library.split_lines;
40 fun pretty_term ctxt t = Syntax.pretty_term (Variable.auto_fixes t ctxt) t;
41 fun pretty_thm ctxt = pretty_term ctxt o Thm.full_prop_of;
46 val verbatim = space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|";
48 val _ = O.add_commands
49 [("verbatim", O.args (Scan.lift Args.name) (fn _ => fn _ =>
50 split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))];
57 fun ml_val (txt1, "") = "fn _ => (" ^ txt1 ^ ");"
58 | ml_val (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ ");";
60 fun ml_type (txt1, "") = "val _ = NONE : (" ^ txt1 ^ ") option;"
61 | ml_type (txt1, txt2) = "val _ = [NONE : (" ^ txt1 ^ ") option, NONE : (" ^ txt2 ^ ") option];";
63 fun ml_exn (txt1, "") = "fn _ => (" ^ txt1 ^ ": exn);"
64 | ml_exn (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ " -> exn);";
66 fun ml_structure (txt, _) = "functor DUMMY_FUNCTOR() = struct structure DUMMY = " ^ txt ^ " end;"
68 fun ml_functor _ = "val _ = ();"; (*no check!*)
70 fun index_ml kind ml src ctxt (txt1, txt2) =
72 val txt = if txt2 = "" then txt1 else
73 if kind = "type" then txt1 ^ " = " ^ txt2
74 else if kind = "exception" then txt1 ^ " of " ^ txt2
75 else txt1 ^ ": " ^ txt2;
76 val txt' = if kind = "" then txt else kind ^ " " ^ txt;
77 val _ = writeln (ml (txt1, txt2));
78 val _ = ML_Context.eval_in (SOME (Context.Proof ctxt)) false Position.none (ml (txt1, txt2));
80 "\\indexml" ^ kind ^ enclose "{" "}" (clean_string txt1) ^
81 ((if ! O.source then str_of_source src else txt')
82 |> (if ! O.quotes then quote else I)
83 |> (if ! O.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
84 else split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))
87 fun output_ml ctxt src =
88 if ! O.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
91 #> map (space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|")
92 #> space_implode "\\isasep\\isanewline%\n";
94 fun ml_args x = O.args (Scan.lift (Args.name -- Scan.optional (Args.colon |-- Args.name) "")) x;
98 val _ = O.add_commands
99 [("index_ML", ml_args (index_ml "" ml_val)),
100 ("index_ML_type", ml_args (index_ml "type" ml_type)),
101 ("index_ML_exn", ml_args (index_ml "exception" ml_exn)),
102 ("index_ML_structure", ml_args (index_ml "structure" ml_structure)),
103 ("index_ML_functor", ml_args (index_ml "functor" ml_functor)),
104 ("ML_functor", O.args (Scan.lift Args.name) output_ml),
105 ("ML_text", O.args (Scan.lift Args.name) output_ml)];
110 (* theorems with names *)
114 fun output_named_thms src ctxt xs =
115 map (apfst (pretty_thm ctxt)) xs (*always pretty in order to exhibit errors!*)
116 |> (if ! O.quotes then map (apfst Pretty.quote) else I)
117 |> (if ! O.display then
119 Output.output (Pretty.string_of (Pretty.indent (! O.indent) p)) ^
120 "\\rulename{" ^ Output.output (Pretty.str_of (pretty_text name)) ^ "}")
121 #> space_implode "\\par\\smallskip%\n"
122 #> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
125 Output.output (Pretty.str_of p) ^
126 "\\rulename{" ^ Output.output (Pretty.str_of (pretty_text name)) ^ "}")
127 #> space_implode "\\par\\smallskip%\n"
128 #> enclose "\\isa{" "}");
132 val _ = O.add_commands
133 [("named_thms", O.args (Scan.repeat (Attrib.thm --
134 Scan.lift (Args.parens Args.name))) output_named_thms)];
141 val _ = O.add_commands
142 [("thy_file", O.args (Scan.lift Args.name) (O.output (fn _ => fn name =>
143 (ThyLoad.check_thy Path.current name; Pretty.str name))))];
146 (* Isabelle entities (with index) *)
150 fun no_check _ _ = true;
152 fun thy_check intern defined ctxt =
153 let val thy = ProofContext.theory_of ctxt
154 in defined thy o intern thy end;
156 fun check_tool name =
157 File.exists (Path.append (Path.explode "~~/lib/Tools") (Path.basic name));
159 val arg = enclose "{" "}" o clean_string;
161 fun output_entity check markup index kind ctxt (logic, name) =
163 val hyper_name = "{" ^ NameSpace.append kind (NameSpace.append logic (clean_name name)) ^ "}";
165 enclose ("\\hyperlink" ^ hyper_name ^ "{") "}" #>
166 index = SOME true ? enclose ("\\hypertarget" ^ hyper_name ^ "{") "}";
171 "\\index" ^ (if is_def then "def" else "ref") ^ arg logic ^ arg kind ^ arg name);
173 if check ctxt name then
176 |> (if markup = "" then I else enclose ("\\" ^ markup ^ "{") "}")
177 |> (if ! O.quotes then quote else I)
178 |> (if ! O.display then enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
179 else hyper o enclose "\\mbox{\\isa{" "}}"))
180 else error ("Bad " ^ kind ^ " " ^ quote name)
183 fun entity check markup index kind =
184 O.args (Scan.lift (Scan.optional (Args.parens Args.name) "" -- Args.name))
185 (K (output_entity check markup index kind));
187 fun entity_antiqs check markup kind =
188 [(kind, entity check markup NONE kind),
189 (kind ^ "_def", entity check markup (SOME true) kind),
190 (kind ^ "_ref", entity check markup (SOME false) kind)];
194 val _ = O.add_commands
195 (entity_antiqs no_check "" "syntax" @
196 entity_antiqs (K (is_some o OuterKeyword.command_keyword)) "isacommand" "command" @
197 entity_antiqs (K OuterKeyword.is_keyword) "isakeyword" "keyword" @
198 entity_antiqs (K OuterKeyword.is_keyword) "isakeyword" "element" @
199 entity_antiqs (thy_check Method.intern Method.defined) "" "method" @
200 entity_antiqs (thy_check Attrib.intern Attrib.defined) "" "attribute" @
201 entity_antiqs no_check "" "fact" @
202 entity_antiqs no_check "" "variable" @
203 entity_antiqs no_check "" "case" @
204 entity_antiqs (K ThyOutput.defined_command) "" "antiquotation" @
205 entity_antiqs (fn _ => fn name => is_some (OS.Process.getEnv name)) "isatt" "setting" @
206 entity_antiqs no_check "isatt" "executable" @
207 entity_antiqs (K check_tool) "isatt" "tool" @
208 entity_antiqs (K (File.exists o Path.explode)) "isatt" "file");