1 (* Title: Pure/General/markup.ML
4 Common markup elements.
9 val parse_int: string -> int
10 val print_int: int -> string
11 type T = string * Properties.T
13 val is_empty: T -> bool
14 val properties: Properties.T -> T -> T
16 val name: string -> T -> T
18 val bindingN: string val binding: string -> T
19 val entityN: string val entity: string -> string -> T
25 val end_offsetN: string
28 val position_properties': string list
29 val position_properties: string list
30 val positionN: string val position: T
32 val blockN: string val block: int -> T
34 val breakN: string val break: int -> T
35 val fbreakN: string val fbreak: T
36 val hiddenN: string val hidden: T
37 val tclassN: string val tclass: string -> T
38 val tyconN: string val tycon: string -> T
39 val fixedN: string val fixed: string -> T
40 val constN: string val const: string -> T
41 val dynamic_factN: string val dynamic_fact: string -> T
42 val tfreeN: string val tfree: T
43 val tvarN: string val tvar: T
44 val freeN: string val free: T
45 val skolemN: string val skolem: T
46 val boundN: string val bound: T
47 val varN: string val var: T
48 val numeralN: string val numeral: T
49 val literalN: string val literal: T
50 val inner_stringN: string val inner_string: T
51 val inner_commentN: string val inner_comment: T
52 val token_rangeN: string val token_range: T
53 val sortN: string val sort: T
54 val typN: string val typ: T
55 val termN: string val term: T
56 val propN: string val prop: T
57 val ML_keywordN: string val ML_keyword: T
58 val ML_delimiterN: string val ML_delimiter: T
59 val ML_identN: string val ML_ident: T
60 val ML_tvarN: string val ML_tvar: T
61 val ML_numeralN: string val ML_numeral: T
62 val ML_charN: string val ML_char: T
63 val ML_stringN: string val ML_string: T
64 val ML_commentN: string val ML_comment: T
65 val ML_malformedN: string val ML_malformed: T
68 val ML_structN: string
69 val ML_typingN: string val ML_typing: T
70 val ML_sourceN: string val ML_source: T
71 val doc_sourceN: string val doc_source: T
72 val antiqN: string val antiq: T
73 val ML_antiqN: string val ML_antiq: string -> T
74 val doc_antiqN: string val doc_antiq: string -> T
75 val keyword_declN: string val keyword_decl: string -> T
76 val command_declN: string val command_decl: string -> string -> T
77 val keywordN: string val keyword: T
78 val operatorN: string val operator: T
79 val commandN: string val command: T
80 val identN: string val ident: T
81 val stringN: string val string: T
82 val altstringN: string val altstring: T
83 val verbatimN: string val verbatim: T
84 val commentN: string val comment: T
85 val controlN: string val control: T
86 val malformedN: string val malformed: T
87 val tokenN: string val token: Properties.T -> T
88 val command_spanN: string val command_span: string -> T
89 val ignored_spanN: string val ignored_span: T
90 val malformed_spanN: string val malformed_span: T
94 val timingN: string val timing: Timing.timing -> T
96 val proof_stateN: string val proof_state: int -> T
97 val stateN: string val state: T
98 val subgoalN: string val subgoal: T
99 val sendbackN: string val sendback: T
100 val hiliteN: string val hilite: T
102 val forkedN: string val forked: T
103 val joinedN: string val joined: T
104 val failedN: string val failed: T
105 val finishedN: string val finished: T
108 val assignN: string val assign: int -> T
109 val editN: string val edit: int -> int -> T
111 val promptN: string val prompt: T
112 val readyN: string val ready: T
113 val reportN: string val report: T
114 val no_reportN: string val no_report: T
115 val badN: string val bad: T
116 val no_output: Output.output * Output.output
117 val default_output: T -> Output.output * Output.output
118 val add_mode: string -> (T -> Output.output * Output.output) -> unit
119 val output: T -> Output.output * Output.output
120 val enclose: T -> Output.output -> Output.output
121 val markup: T -> string -> string
124 structure Markup: MARKUP =
127 (** markup elements **)
132 (case Int.fromString s of
134 | NONE => raise Fail ("Bad integer: " ^ quote s));
136 val print_int = signed_string_of_int;
141 type T = string * Properties.T;
143 val empty = ("", []);
145 fun is_empty ("", _) = true
146 | is_empty _ = false;
149 fun properties more_props ((elem, props): T) =
150 (elem, fold_rev Properties.put more_props props);
152 fun markup_elem elem = (elem, (elem, []): T);
153 fun markup_string elem prop = (elem, fn s => (elem, [(prop, s)]): T);
154 fun markup_int elem prop = (elem, fn i => (elem, [(prop, print_int i)]): T);
157 (* misc properties *)
160 fun name a = properties [(nameN, a)];
165 (* formal entities *)
167 val (bindingN, binding) = markup_string "binding" nameN;
169 val entityN = "entity";
170 fun entity kind name = (entityN, [(nameN, name), (kindN, kind)]);
179 val columnN = "column";
180 val offsetN = "offset";
181 val end_offsetN = "end_offset";
185 val position_properties' = [fileN, idN];
186 val position_properties = [lineN, columnN, offsetN, end_offsetN] @ position_properties';
188 val (positionN, position) = markup_elem "position";
191 (* pretty printing *)
193 val indentN = "indent";
194 val (blockN, block) = markup_int "block" indentN;
196 val widthN = "width";
197 val (breakN, break) = markup_int "break" widthN;
199 val (fbreakN, fbreak) = markup_elem "fbreak";
204 val (hiddenN, hidden) = markup_elem "hidden";
207 (* logical entities *)
209 val (tclassN, tclass) = markup_string "tclass" nameN;
210 val (tyconN, tycon) = markup_string "tycon" nameN;
211 val (fixedN, fixed) = markup_string "fixed" nameN;
212 val (constN, const) = markup_string "constant" nameN;
213 val (dynamic_factN, dynamic_fact) = markup_string "dynamic_fact" nameN;
218 val (tfreeN, tfree) = markup_elem "tfree";
219 val (tvarN, tvar) = markup_elem "tvar";
220 val (freeN, free) = markup_elem "free";
221 val (skolemN, skolem) = markup_elem "skolem";
222 val (boundN, bound) = markup_elem "bound";
223 val (varN, var) = markup_elem "var";
224 val (numeralN, numeral) = markup_elem "numeral";
225 val (literalN, literal) = markup_elem "literal";
226 val (inner_stringN, inner_string) = markup_elem "inner_string";
227 val (inner_commentN, inner_comment) = markup_elem "inner_comment";
229 val (token_rangeN, token_range) = markup_elem "token_range";
231 val (sortN, sort) = markup_elem "sort";
232 val (typN, typ) = markup_elem "typ";
233 val (termN, term) = markup_elem "term";
234 val (propN, prop) = markup_elem "prop";
239 val (ML_keywordN, ML_keyword) = markup_elem "ML_keyword";
240 val (ML_delimiterN, ML_delimiter) = markup_elem "ML_delimiter";
241 val (ML_identN, ML_ident) = markup_elem "ML_ident";
242 val (ML_tvarN, ML_tvar) = markup_elem "ML_tvar";
243 val (ML_numeralN, ML_numeral) = markup_elem "ML_numeral";
244 val (ML_charN, ML_char) = markup_elem "ML_char";
245 val (ML_stringN, ML_string) = markup_elem "ML_string";
246 val (ML_commentN, ML_comment) = markup_elem "ML_comment";
247 val (ML_malformedN, ML_malformed) = markup_elem "ML_malformed";
249 val ML_defN = "ML_def";
250 val ML_openN = "ML_open";
251 val ML_structN = "ML_struct";
252 val (ML_typingN, ML_typing) = markup_elem "ML_typing";
255 (* embedded source text *)
257 val (ML_sourceN, ML_source) = markup_elem "ML_source";
258 val (doc_sourceN, doc_source) = markup_elem "doc_source";
260 val (antiqN, antiq) = markup_elem "antiq";
261 val (ML_antiqN, ML_antiq) = markup_string "ML_antiq" nameN;
262 val (doc_antiqN, doc_antiq) = markup_string "doc_antiq" nameN;
267 val (keyword_declN, keyword_decl) = markup_string "keyword_decl" nameN;
269 val command_declN = "command_decl";
270 fun command_decl name kind : T = (command_declN, [(nameN, name), (kindN, kind)]);
272 val (keywordN, keyword) = markup_elem "keyword";
273 val (operatorN, operator) = markup_elem "operator";
274 val (commandN, command) = markup_elem "command";
275 val (identN, ident) = markup_elem "ident";
276 val (stringN, string) = markup_elem "string";
277 val (altstringN, altstring) = markup_elem "altstring";
278 val (verbatimN, verbatim) = markup_elem "verbatim";
279 val (commentN, comment) = markup_elem "comment";
280 val (controlN, control) = markup_elem "control";
281 val (malformedN, malformed) = markup_elem "malformed";
283 val tokenN = "token";
284 fun token props = (tokenN, props);
286 val (command_spanN, command_span) = markup_string "command_span" nameN;
287 val (ignored_spanN, ignored_span) = markup_elem "ignored_span";
288 val (malformed_spanN, malformed_span) = markup_elem "malformed_span";
293 val timingN = "timing";
294 val elapsedN = "elapsed";
298 fun timing {elapsed, cpu, gc} =
300 [(elapsedN, Time.toString elapsed),
301 (cpuN, Time.toString cpu),
302 (gcN, Time.toString gc)]);
307 val subgoalsN = "subgoals";
308 val (proof_stateN, proof_state) = markup_int "proof_state" subgoalsN;
310 val (stateN, state) = markup_elem "state";
311 val (subgoalN, subgoal) = markup_elem "subgoal";
312 val (sendbackN, sendback) = markup_elem "sendback";
313 val (hiliteN, hilite) = markup_elem "hilite";
320 val (forkedN, forked) = markup_elem "forked";
321 val (joinedN, joined) = markup_elem "joined";
323 val (failedN, failed) = markup_elem "failed";
324 val (finishedN, finished) = markup_elem "finished";
327 (* interactive documents *)
329 val versionN = "version";
331 val (assignN, assign) = markup_int "assign" versionN;
334 fun edit cmd_id exec_id : T = (editN, [(idN, print_int cmd_id), (execN, print_int exec_id)]);
339 val serialN = "serial";
341 val (promptN, prompt) = markup_elem "prompt";
342 val (readyN, ready) = markup_elem "ready";
344 val (reportN, report) = markup_elem "report";
345 val (no_reportN, no_report) = markup_elem "no_report";
347 val (badN, bad) = markup_elem "bad";
351 (** print mode operations **)
353 val no_output = ("", "");
354 fun default_output (_: T) = no_output;
357 val default = {output = default_output};
358 val modes = Unsynchronized.ref (Symtab.make [("", default)]);
360 fun add_mode name output = CRITICAL (fn () =>
361 Unsynchronized.change modes (Symtab.update_new (name, {output = output})));
363 the_default default (Library.get_first (Symtab.lookup (! modes)) (print_mode_value ()));
366 fun output m = if is_empty m then no_output else #output (get_mode ()) m;
368 val enclose = output #-> Library.enclose;
371 let val (bg, en) = output m
372 in Library.enclose (Output.escape bg) (Output.escape en) end;