haftmann@24584
|
1 |
(* Title: Doc/antiquote_setup.ML
|
wenzelm@21375
|
2 |
Author: Makarius
|
wenzelm@21375
|
3 |
|
wenzelm@26742
|
4 |
Auxiliary antiquotations for the Isabelle manuals.
|
wenzelm@21375
|
5 |
*)
|
wenzelm@21375
|
6 |
|
wenzelm@26742
|
7 |
structure AntiquoteSetup: sig end =
|
wenzelm@26742
|
8 |
struct
|
wenzelm@21375
|
9 |
|
wenzelm@22094
|
10 |
structure O = ThyOutput;
|
wenzelm@21375
|
11 |
|
wenzelm@26742
|
12 |
|
wenzelm@26742
|
13 |
(* misc utils *)
|
wenzelm@26742
|
14 |
|
wenzelm@30062
|
15 |
fun translate f = Symbol.explode #> map f #> implode;
|
wenzelm@30062
|
16 |
|
wenzelm@30062
|
17 |
val clean_string = translate
|
wenzelm@26853
|
18 |
(fn "_" => "\\_"
|
wenzelm@30120
|
19 |
| "#" => "\\#"
|
wenzelm@26897
|
20 |
| "<" => "$<$"
|
wenzelm@26768
|
21 |
| ">" => "$>$"
|
wenzelm@26768
|
22 |
| "{" => "\\{"
|
wenzelm@30120
|
23 |
| "|" => "$\\mid$"
|
wenzelm@26768
|
24 |
| "}" => "\\}"
|
wenzelm@30062
|
25 |
| "\\<dash>" => "-"
|
wenzelm@26768
|
26 |
| c => c);
|
wenzelm@26751
|
27 |
|
wenzelm@26897
|
28 |
fun clean_name "\\<dots>" = "dots"
|
wenzelm@26897
|
29 |
| clean_name ".." = "ddot"
|
wenzelm@26897
|
30 |
| clean_name "." = "dot"
|
wenzelm@26910
|
31 |
| clean_name "_" = "underscore"
|
wenzelm@26897
|
32 |
| clean_name "{" = "braceleft"
|
wenzelm@26897
|
33 |
| clean_name "}" = "braceright"
|
wenzelm@30062
|
34 |
| clean_name s = s |> translate (fn "_" => "-" | "\\<dash>" => "-" | c => c);
|
wenzelm@26897
|
35 |
|
wenzelm@26742
|
36 |
|
wenzelm@26742
|
37 |
(* verbatim text *)
|
wenzelm@26742
|
38 |
|
wenzelm@26742
|
39 |
val verbatim = space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|";
|
wenzelm@26742
|
40 |
|
wenzelm@26742
|
41 |
val _ = O.add_commands
|
wenzelm@26742
|
42 |
[("verbatim", O.args (Scan.lift Args.name) (fn _ => fn _ =>
|
wenzelm@26742
|
43 |
split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))];
|
wenzelm@26742
|
44 |
|
wenzelm@26742
|
45 |
|
wenzelm@26742
|
46 |
(* ML text *)
|
wenzelm@26742
|
47 |
|
wenzelm@26742
|
48 |
local
|
wenzelm@26742
|
49 |
|
wenzelm@21375
|
50 |
fun ml_val (txt1, "") = "fn _ => (" ^ txt1 ^ ");"
|
wenzelm@21375
|
51 |
| ml_val (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ ");";
|
wenzelm@21375
|
52 |
|
wenzelm@21375
|
53 |
fun ml_type (txt1, "") = "val _ = NONE : (" ^ txt1 ^ ") option;"
|
wenzelm@21375
|
54 |
| ml_type (txt1, txt2) = "val _ = [NONE : (" ^ txt1 ^ ") option, NONE : (" ^ txt2 ^ ") option];";
|
haftmann@22289
|
55 |
|
wenzelm@23651
|
56 |
fun ml_exn (txt1, "") = "fn _ => (" ^ txt1 ^ ": exn);"
|
wenzelm@23651
|
57 |
| ml_exn (txt1, txt2) = "fn _ => (" ^ txt1 ^ ": " ^ txt2 ^ " -> exn);";
|
haftmann@22289
|
58 |
|
wenzelm@21375
|
59 |
fun ml_structure (txt, _) = "functor DUMMY_FUNCTOR() = struct structure DUMMY = " ^ txt ^ " end;"
|
wenzelm@21375
|
60 |
|
wenzelm@21375
|
61 |
fun ml_functor _ = "val _ = ();"; (*no check!*)
|
wenzelm@21375
|
62 |
|
wenzelm@21375
|
63 |
fun index_ml kind ml src ctxt (txt1, txt2) =
|
wenzelm@21375
|
64 |
let
|
wenzelm@21375
|
65 |
val txt = if txt2 = "" then txt1 else
|
wenzelm@26742
|
66 |
if kind = "type" then txt1 ^ " = " ^ txt2
|
wenzelm@26742
|
67 |
else if kind = "exception" then txt1 ^ " of " ^ txt2
|
haftmann@22289
|
68 |
else txt1 ^ ": " ^ txt2;
|
wenzelm@21375
|
69 |
val txt' = if kind = "" then txt else kind ^ " " ^ txt;
|
wenzelm@28273
|
70 |
val _ = ML_Context.eval_in (SOME ctxt) false Position.none (ml (txt1, txt2));
|
wenzelm@30120
|
71 |
val kind' = if kind = "" then "ML" else "ML " ^ kind;
|
wenzelm@21375
|
72 |
in
|
wenzelm@30120
|
73 |
"\\indexdef{}{" ^ kind' ^ "}{" ^ clean_string txt1 ^ "}" ^
|
wenzelm@28759
|
74 |
(txt'
|
wenzelm@21375
|
75 |
|> (if ! O.quotes then quote else I)
|
wenzelm@21375
|
76 |
|> (if ! O.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
|
wenzelm@26751
|
77 |
else split_lines #> map verbatim #> space_implode "\\isasep\\isanewline%\n"))
|
wenzelm@21375
|
78 |
end;
|
wenzelm@21375
|
79 |
|
haftmann@26461
|
80 |
fun output_ml ctxt src =
|
haftmann@26461
|
81 |
if ! O.display then enclose "\\begin{verbatim}\n" "\n\\end{verbatim}"
|
wenzelm@26742
|
82 |
else
|
haftmann@26461
|
83 |
split_lines
|
haftmann@26461
|
84 |
#> map (space_implode "\\verb,|," o map (enclose "\\verb|" "|") o space_explode "|")
|
haftmann@26461
|
85 |
#> space_implode "\\isasep\\isanewline%\n";
|
haftmann@26461
|
86 |
|
wenzelm@26742
|
87 |
fun ml_args x = O.args (Scan.lift (Args.name -- Scan.optional (Args.colon |-- Args.name) "")) x;
|
wenzelm@21375
|
88 |
|
wenzelm@26742
|
89 |
in
|
wenzelm@21375
|
90 |
|
wenzelm@26742
|
91 |
val _ = O.add_commands
|
wenzelm@26742
|
92 |
[("index_ML", ml_args (index_ml "" ml_val)),
|
wenzelm@26742
|
93 |
("index_ML_type", ml_args (index_ml "type" ml_type)),
|
wenzelm@26742
|
94 |
("index_ML_exn", ml_args (index_ml "exception" ml_exn)),
|
wenzelm@26742
|
95 |
("index_ML_structure", ml_args (index_ml "structure" ml_structure)),
|
wenzelm@26742
|
96 |
("index_ML_functor", ml_args (index_ml "functor" ml_functor)),
|
wenzelm@26742
|
97 |
("ML_functor", O.args (Scan.lift Args.name) output_ml),
|
wenzelm@26742
|
98 |
("ML_text", O.args (Scan.lift Args.name) output_ml)];
|
wenzelm@26742
|
99 |
|
wenzelm@26742
|
100 |
end;
|
wenzelm@21375
|
101 |
|
berghofe@23846
|
102 |
|
berghofe@23846
|
103 |
(* theorems with names *)
|
berghofe@23846
|
104 |
|
wenzelm@26742
|
105 |
local
|
berghofe@23846
|
106 |
|
wenzelm@26742
|
107 |
fun output_named_thms src ctxt xs =
|
wenzelm@28644
|
108 |
map (apfst (ThyOutput.pretty_thm ctxt)) xs (*always pretty in order to exhibit errors!*)
|
berghofe@23846
|
109 |
|> (if ! O.quotes then map (apfst Pretty.quote) else I)
|
berghofe@23846
|
110 |
|> (if ! O.display then
|
berghofe@23846
|
111 |
map (fn (p, name) =>
|
berghofe@23846
|
112 |
Output.output (Pretty.string_of (Pretty.indent (! O.indent) p)) ^
|
wenzelm@28644
|
113 |
"\\rulename{" ^ Output.output (Pretty.str_of (ThyOutput.pretty_text name)) ^ "}")
|
berghofe@23846
|
114 |
#> space_implode "\\par\\smallskip%\n"
|
berghofe@23846
|
115 |
#> enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
|
berghofe@23846
|
116 |
else
|
berghofe@23846
|
117 |
map (fn (p, name) =>
|
berghofe@23846
|
118 |
Output.output (Pretty.str_of p) ^
|
wenzelm@28644
|
119 |
"\\rulename{" ^ Output.output (Pretty.str_of (ThyOutput.pretty_text name)) ^ "}")
|
berghofe@23846
|
120 |
#> space_implode "\\par\\smallskip%\n"
|
berghofe@23846
|
121 |
#> enclose "\\isa{" "}");
|
berghofe@23846
|
122 |
|
wenzelm@21375
|
123 |
in
|
wenzelm@21375
|
124 |
|
wenzelm@21375
|
125 |
val _ = O.add_commands
|
wenzelm@26742
|
126 |
[("named_thms", O.args (Scan.repeat (Attrib.thm --
|
wenzelm@26751
|
127 |
Scan.lift (Args.parens Args.name))) output_named_thms)];
|
wenzelm@21375
|
128 |
|
wenzelm@21375
|
129 |
end;
|
wenzelm@26742
|
130 |
|
wenzelm@26742
|
131 |
|
wenzelm@26742
|
132 |
(* theory files *)
|
wenzelm@26742
|
133 |
|
wenzelm@26742
|
134 |
val _ = O.add_commands
|
wenzelm@26742
|
135 |
[("thy_file", O.args (Scan.lift Args.name) (O.output (fn _ => fn name =>
|
wenzelm@26742
|
136 |
(ThyLoad.check_thy Path.current name; Pretty.str name))))];
|
wenzelm@26742
|
137 |
|
wenzelm@26751
|
138 |
|
wenzelm@28218
|
139 |
(* Isabelle entities (with index) *)
|
wenzelm@26751
|
140 |
|
wenzelm@26751
|
141 |
local
|
wenzelm@26751
|
142 |
|
wenzelm@26894
|
143 |
fun no_check _ _ = true;
|
wenzelm@26894
|
144 |
|
wenzelm@26894
|
145 |
fun thy_check intern defined ctxt =
|
wenzelm@26894
|
146 |
let val thy = ProofContext.theory_of ctxt
|
wenzelm@26894
|
147 |
in defined thy o intern thy end;
|
wenzelm@26894
|
148 |
|
wenzelm@28237
|
149 |
fun check_tool name =
|
wenzelm@28237
|
150 |
File.exists (Path.append (Path.explode "~~/lib/Tools") (Path.basic name));
|
wenzelm@28237
|
151 |
|
wenzelm@26751
|
152 |
val arg = enclose "{" "}" o clean_string;
|
wenzelm@26751
|
153 |
|
wenzelm@26894
|
154 |
fun output_entity check markup index kind ctxt (logic, name) =
|
wenzelm@26897
|
155 |
let
|
wenzelm@26897
|
156 |
val hyper_name = "{" ^ NameSpace.append kind (NameSpace.append logic (clean_name name)) ^ "}";
|
wenzelm@26897
|
157 |
val hyper =
|
wenzelm@26897
|
158 |
enclose ("\\hyperlink" ^ hyper_name ^ "{") "}" #>
|
wenzelm@26897
|
159 |
index = SOME true ? enclose ("\\hypertarget" ^ hyper_name ^ "{") "}";
|
wenzelm@26897
|
160 |
val idx =
|
wenzelm@26897
|
161 |
(case index of
|
wenzelm@26897
|
162 |
NONE => ""
|
wenzelm@26897
|
163 |
| SOME is_def =>
|
wenzelm@26897
|
164 |
"\\index" ^ (if is_def then "def" else "ref") ^ arg logic ^ arg kind ^ arg name);
|
wenzelm@26897
|
165 |
in
|
wenzelm@26897
|
166 |
if check ctxt name then
|
wenzelm@26897
|
167 |
idx ^
|
wenzelm@26897
|
168 |
(Output.output name
|
wenzelm@26897
|
169 |
|> (if markup = "" then I else enclose ("\\" ^ markup ^ "{") "}")
|
wenzelm@26897
|
170 |
|> (if ! O.quotes then quote else I)
|
wenzelm@26897
|
171 |
|> (if ! O.display then enclose "\\begin{isabelle}%\n" "%\n\\end{isabelle}"
|
wenzelm@26897
|
172 |
else hyper o enclose "\\mbox{\\isa{" "}}"))
|
wenzelm@28237
|
173 |
else error ("Bad " ^ kind ^ " " ^ quote name)
|
wenzelm@26897
|
174 |
end;
|
wenzelm@26751
|
175 |
|
wenzelm@26894
|
176 |
fun entity check markup index kind =
|
wenzelm@26751
|
177 |
O.args (Scan.lift (Scan.optional (Args.parens Args.name) "" -- Args.name))
|
wenzelm@26894
|
178 |
(K (output_entity check markup index kind));
|
wenzelm@26897
|
179 |
|
wenzelm@26894
|
180 |
fun entity_antiqs check markup kind =
|
wenzelm@26894
|
181 |
[(kind, entity check markup NONE kind),
|
wenzelm@26897
|
182 |
(kind ^ "_def", entity check markup (SOME true) kind),
|
wenzelm@26894
|
183 |
(kind ^ "_ref", entity check markup (SOME false) kind)];
|
wenzelm@26751
|
184 |
|
wenzelm@26751
|
185 |
in
|
wenzelm@26751
|
186 |
|
wenzelm@26751
|
187 |
val _ = O.add_commands
|
wenzelm@26894
|
188 |
(entity_antiqs no_check "" "syntax" @
|
wenzelm@27353
|
189 |
entity_antiqs (K (is_some o OuterKeyword.command_keyword)) "isacommand" "command" @
|
wenzelm@27353
|
190 |
entity_antiqs (K OuterKeyword.is_keyword) "isakeyword" "keyword" @
|
wenzelm@27353
|
191 |
entity_antiqs (K OuterKeyword.is_keyword) "isakeyword" "element" @
|
wenzelm@26894
|
192 |
entity_antiqs (thy_check Method.intern Method.defined) "" "method" @
|
wenzelm@26894
|
193 |
entity_antiqs (thy_check Attrib.intern Attrib.defined) "" "attribute" @
|
wenzelm@26894
|
194 |
entity_antiqs no_check "" "fact" @
|
wenzelm@26894
|
195 |
entity_antiqs no_check "" "variable" @
|
wenzelm@26894
|
196 |
entity_antiqs no_check "" "case" @
|
wenzelm@28217
|
197 |
entity_antiqs (K ThyOutput.defined_command) "" "antiquotation" @
|
wenzelm@28237
|
198 |
entity_antiqs (fn _ => fn name => is_some (OS.Process.getEnv name)) "isatt" "setting" @
|
wenzelm@30052
|
199 |
entity_antiqs no_check "" "inference" @
|
wenzelm@28217
|
200 |
entity_antiqs no_check "isatt" "executable" @
|
wenzelm@28237
|
201 |
entity_antiqs (K check_tool) "isatt" "tool" @
|
haftmann@28399
|
202 |
entity_antiqs (K (File.exists o Path.explode)) "isatt" "file" @
|
haftmann@28399
|
203 |
entity_antiqs (K ThyInfo.known_thy) "" "theory");
|
wenzelm@26751
|
204 |
|
wenzelm@26742
|
205 |
end;
|
wenzelm@26751
|
206 |
|
wenzelm@26751
|
207 |
end;
|