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: T
19 val entityN: string val entity: string -> string -> T
20 val get_entity_kind: T -> string option
26 val end_offsetN: string
29 val position_properties': string list
30 val position_properties: string list
31 val positionN: string val position: T
32 val pathN: string val path: string -> T
34 val blockN: string val block: int -> T
36 val breakN: string val break: int -> T
37 val fbreakN: string val fbreak: T
38 val hiddenN: string val hidden: T
42 val fixedN: string val fixed: string -> T
43 val dynamic_factN: string val dynamic_fact: string -> T
44 val tfreeN: string val tfree: T
45 val tvarN: string val tvar: T
46 val freeN: string val free: T
47 val skolemN: string val skolem: T
48 val boundN: string val bound: T
49 val varN: string val var: T
50 val numeralN: string val numeral: T
51 val literalN: string val literal: T
52 val delimiterN: string val delimiter: T
53 val inner_stringN: string val inner_string: T
54 val inner_commentN: string val inner_comment: T
55 val token_rangeN: string val token_range: T
56 val sortN: string val sort: T
57 val typN: string val typ: T
58 val termN: string val term: T
59 val propN: string val prop: T
60 val ML_keywordN: string val ML_keyword: T
61 val ML_delimiterN: string val ML_delimiter: T
62 val ML_identN: string val ML_ident: T
63 val ML_tvarN: string val ML_tvar: T
64 val ML_numeralN: string val ML_numeral: T
65 val ML_charN: string val ML_char: T
66 val ML_stringN: string val ML_string: T
67 val ML_commentN: string val ML_comment: T
68 val ML_malformedN: string val ML_malformed: T
71 val ML_structN: string
72 val ML_typingN: string val ML_typing: T
73 val ML_sourceN: string val ML_source: T
74 val doc_sourceN: string val doc_source: T
75 val antiqN: string val antiq: T
76 val ML_antiquotationN: string
77 val doc_antiquotationN: string
78 val doc_antiquotation_optionN: string
79 val keyword_declN: string val keyword_decl: string -> T
80 val command_declN: string val command_decl: string -> string -> T
81 val keywordN: string val keyword: T
82 val operatorN: string val operator: T
83 val commandN: string val command: T
84 val identN: string val ident: T
85 val stringN: string val string: T
86 val altstringN: string val altstring: T
87 val verbatimN: string val verbatim: T
88 val commentN: string val comment: T
89 val controlN: string val control: T
90 val malformedN: string val malformed: T
91 val tokenN: string val token: Properties.T -> T
92 val command_spanN: string val command_span: string -> T
93 val ignored_spanN: string val ignored_span: T
94 val malformed_spanN: string val malformed_span: T
98 val timingN: string val timing: Timing.timing -> T
100 val proof_stateN: string val proof_state: int -> T
101 val stateN: string val state: T
102 val subgoalN: string val subgoal: T
103 val sendbackN: string val sendback: T
104 val hiliteN: string val hilite: T
106 val forkedN: string val forked: T
107 val joinedN: string val joined: T
108 val failedN: string val failed: T
109 val finishedN: string val finished: T
112 val assignN: string val assign: int -> T
113 val editN: string val edit: int -> int -> T
115 val promptN: string val prompt: T
116 val readyN: string val ready: T
117 val reportN: string val report: T
118 val no_reportN: string val no_report: T
119 val badN: string val bad: T
120 val no_output: Output.output * Output.output
121 val default_output: T -> Output.output * Output.output
122 val add_mode: string -> (T -> Output.output * Output.output) -> unit
123 val output: T -> Output.output * Output.output
124 val enclose: T -> Output.output -> Output.output
125 val markup: T -> string -> string
128 structure Markup: MARKUP =
131 (** markup elements **)
136 (case Int.fromString s of
138 | NONE => raise Fail ("Bad integer: " ^ quote s));
140 val print_int = signed_string_of_int;
145 type T = string * Properties.T;
147 val empty = ("", []);
149 fun is_empty ("", _) = true
150 | is_empty _ = false;
153 fun properties more_props ((elem, props): T) =
154 (elem, fold_rev Properties.put more_props props);
156 fun markup_elem elem = (elem, (elem, []): T);
157 fun markup_string elem prop = (elem, fn s => (elem, [(prop, s)]): T);
158 fun markup_int elem prop = (elem, fn i => (elem, [(prop, print_int i)]): T);
161 (* misc properties *)
164 fun name a = properties [(nameN, a)];
169 (* formal entities *)
171 val (bindingN, binding) = markup_elem "binding";
173 val entityN = "entity";
174 fun entity kind name = (entityN, [(nameN, name), (kindN, kind)]);
176 fun get_entity_kind (name, props) =
177 if name = entityN then AList.lookup (op =) props kindN
187 val columnN = "column";
188 val offsetN = "offset";
189 val end_offsetN = "end_offset";
193 val position_properties' = [fileN, idN];
194 val position_properties = [lineN, columnN, offsetN, end_offsetN] @ position_properties';
196 val (positionN, position) = markup_elem "position";
201 val (pathN, path) = markup_string "path" nameN;
204 (* pretty printing *)
206 val indentN = "indent";
207 val (blockN, block) = markup_int "block" indentN;
209 val widthN = "width";
210 val (breakN, break) = markup_int "break" widthN;
212 val (fbreakN, fbreak) = markup_elem "fbreak";
217 val (hiddenN, hidden) = markup_elem "hidden";
220 (* logical entities *)
222 val classN = "class";
224 val constantN = "constant";
226 val (fixedN, fixed) = markup_string "fixed" nameN;
227 val (dynamic_factN, dynamic_fact) = markup_string "dynamic_fact" nameN;
232 val (tfreeN, tfree) = markup_elem "tfree";
233 val (tvarN, tvar) = markup_elem "tvar";
234 val (freeN, free) = markup_elem "free";
235 val (skolemN, skolem) = markup_elem "skolem";
236 val (boundN, bound) = markup_elem "bound";
237 val (varN, var) = markup_elem "var";
238 val (numeralN, numeral) = markup_elem "numeral";
239 val (literalN, literal) = markup_elem "literal";
240 val (delimiterN, delimiter) = markup_elem "delimiter";
241 val (inner_stringN, inner_string) = markup_elem "inner_string";
242 val (inner_commentN, inner_comment) = markup_elem "inner_comment";
244 val (token_rangeN, token_range) = markup_elem "token_range";
246 val (sortN, sort) = markup_elem "sort";
247 val (typN, typ) = markup_elem "typ";
248 val (termN, term) = markup_elem "term";
249 val (propN, prop) = markup_elem "prop";
254 val (ML_keywordN, ML_keyword) = markup_elem "ML_keyword";
255 val (ML_delimiterN, ML_delimiter) = markup_elem "ML_delimiter";
256 val (ML_identN, ML_ident) = markup_elem "ML_ident";
257 val (ML_tvarN, ML_tvar) = markup_elem "ML_tvar";
258 val (ML_numeralN, ML_numeral) = markup_elem "ML_numeral";
259 val (ML_charN, ML_char) = markup_elem "ML_char";
260 val (ML_stringN, ML_string) = markup_elem "ML_string";
261 val (ML_commentN, ML_comment) = markup_elem "ML_comment";
262 val (ML_malformedN, ML_malformed) = markup_elem "ML_malformed";
264 val ML_defN = "ML_def";
265 val ML_openN = "ML_open";
266 val ML_structN = "ML_struct";
267 val (ML_typingN, ML_typing) = markup_elem "ML_typing";
270 (* embedded source text *)
272 val (ML_sourceN, ML_source) = markup_elem "ML_source";
273 val (doc_sourceN, doc_source) = markup_elem "doc_source";
275 val (antiqN, antiq) = markup_elem "antiq";
276 val ML_antiquotationN = "ML antiquotation";
277 val doc_antiquotationN = "document antiquotation";
278 val doc_antiquotation_optionN = "document antiquotation option";
283 val (keyword_declN, keyword_decl) = markup_string "keyword_decl" nameN;
285 val command_declN = "command_decl";
286 fun command_decl name kind : T = (command_declN, [(nameN, name), (kindN, kind)]);
288 val (keywordN, keyword) = markup_elem "keyword";
289 val (operatorN, operator) = markup_elem "operator";
290 val (commandN, command) = markup_elem "command";
291 val (identN, ident) = markup_elem "ident";
292 val (stringN, string) = markup_elem "string";
293 val (altstringN, altstring) = markup_elem "altstring";
294 val (verbatimN, verbatim) = markup_elem "verbatim";
295 val (commentN, comment) = markup_elem "comment";
296 val (controlN, control) = markup_elem "control";
297 val (malformedN, malformed) = markup_elem "malformed";
299 val tokenN = "token";
300 fun token props = (tokenN, props);
302 val (command_spanN, command_span) = markup_string "command_span" nameN;
303 val (ignored_spanN, ignored_span) = markup_elem "ignored_span";
304 val (malformed_spanN, malformed_span) = markup_elem "malformed_span";
309 val timingN = "timing";
310 val elapsedN = "elapsed";
314 fun timing {elapsed, cpu, gc} =
316 [(elapsedN, Time.toString elapsed),
317 (cpuN, Time.toString cpu),
318 (gcN, Time.toString gc)]);
323 val subgoalsN = "subgoals";
324 val (proof_stateN, proof_state) = markup_int "proof_state" subgoalsN;
326 val (stateN, state) = markup_elem "state";
327 val (subgoalN, subgoal) = markup_elem "subgoal";
328 val (sendbackN, sendback) = markup_elem "sendback";
329 val (hiliteN, hilite) = markup_elem "hilite";
336 val (forkedN, forked) = markup_elem "forked";
337 val (joinedN, joined) = markup_elem "joined";
339 val (failedN, failed) = markup_elem "failed";
340 val (finishedN, finished) = markup_elem "finished";
343 (* interactive documents *)
345 val versionN = "version";
347 val (assignN, assign) = markup_int "assign" versionN;
350 fun edit cmd_id exec_id : T = (editN, [(idN, print_int cmd_id), (execN, print_int exec_id)]);
355 val serialN = "serial";
357 val (promptN, prompt) = markup_elem "prompt";
358 val (readyN, ready) = markup_elem "ready";
360 val (reportN, report) = markup_elem "report";
361 val (no_reportN, no_report) = markup_elem "no_report";
363 val (badN, bad) = markup_elem "bad";
367 (** print mode operations **)
369 val no_output = ("", "");
370 fun default_output (_: T) = no_output;
373 val default = {output = default_output};
374 val modes = Unsynchronized.ref (Symtab.make [("", default)]);
376 fun add_mode name output = CRITICAL (fn () =>
377 Unsynchronized.change modes (Symtab.update_new (name, {output = output})));
379 the_default default (Library.get_first (Symtab.lookup (! modes)) (print_mode_value ()));
382 fun output m = if is_empty m then no_output else #output (get_mode ()) m;
384 val enclose = output #-> Library.enclose;
387 let val (bg, en) = output m
388 in Library.enclose (Output.escape bg) (Output.escape en) end;