1 (* Title: Pure/General/markup.ML
4 Common markup elements.
9 type T = string * Properties.T
11 val is_none: T -> bool
12 val properties: (string * string) list -> T -> T
14 val name: string -> T -> T
15 val bindingN: string val binding: string -> T
16 val theory_nameN: string
19 val entityN: string val entity: string -> T
26 val end_columnN: string
27 val end_offsetN: string
30 val position_properties': string list
31 val position_properties: string list
32 val positionN: string val position: T
33 val locationN: string val location: T
35 val blockN: string val block: int -> T
37 val breakN: string val break: int -> T
38 val fbreakN: string val fbreak: T
39 val tclassN: string val tclass: string -> T
40 val tyconN: string val tycon: string -> T
41 val fixed_declN: string val fixed_decl: string -> T
42 val fixedN: string val fixed: string -> T
43 val const_declN: string val const_decl: string -> T
44 val constN: string val const: string -> T
45 val fact_declN: string val fact_decl: string -> T
46 val factN: string val fact: string -> T
47 val dynamic_factN: string val dynamic_fact: string -> T
48 val local_fact_declN: string val local_fact_decl: string -> T
49 val local_factN: string val local_fact: string -> T
50 val tfreeN: string val tfree: T
51 val tvarN: string val tvar: T
52 val freeN: string val free: T
53 val skolemN: string val skolem: T
54 val boundN: string val bound: T
55 val varN: string val var: T
56 val numeralN: string val numeral: T
57 val literalN: string val literal: T
58 val inner_stringN: string val inner_string: T
59 val inner_commentN: string val inner_comment: T
60 val sortN: string val sort: T
61 val typN: string val typ: T
62 val termN: string val term: T
63 val propN: string val prop: T
64 val attributeN: string val attribute: string -> T
65 val methodN: string val method: string -> T
66 val ML_keywordN: string val ML_keyword: T
67 val ML_identN: string val ML_ident: T
68 val ML_tvarN: string val ML_tvar: T
69 val ML_numeralN: string val ML_numeral: T
70 val ML_charN: string val ML_char: T
71 val ML_stringN: string val ML_string: T
72 val ML_commentN: string val ML_comment: T
73 val ML_malformedN: string val ML_malformed: T
74 val ML_defN: string val ML_def: T
75 val ML_openN: string val ML_open: T
76 val ML_structN: string val ML_struct: T
77 val ML_refN: string val ML_ref: T
78 val ML_typingN: string val ML_typing: T
79 val ML_sourceN: string val ML_source: T
80 val doc_sourceN: string val doc_source: T
81 val antiqN: string val antiq: T
82 val ML_antiqN: string val ML_antiq: string -> T
83 val doc_antiqN: string val doc_antiq: string -> T
84 val keyword_declN: string val keyword_decl: string -> T
85 val command_declN: string val command_decl: string -> string -> T
86 val keywordN: string val keyword: string -> T
87 val commandN: string val command: string -> T
88 val identN: string val ident: T
89 val stringN: string val string: T
90 val altstringN: string val altstring: T
91 val verbatimN: string val verbatim: T
92 val commentN: string val comment: T
93 val controlN: string val control: T
94 val malformedN: string val malformed: T
95 val tokenN: string val token: T
96 val command_spanN: string val command_span: string -> T
97 val ignored_spanN: string val ignored_span: T
98 val malformed_spanN: string val malformed_span: T
99 val stateN: string val state: T
100 val subgoalN: string val subgoal: T
101 val sendbackN: string val sendback: T
102 val hiliteN: string val hilite: T
104 val unprocessedN: string val unprocessed: T
105 val runningN: string val running: string -> T
106 val failedN: string val failed: T
107 val finishedN: string val finished: T
108 val disposedN: string val disposed: T
109 val editsN: string val edits: string -> T
110 val editN: string val edit: string -> string -> T
113 val promptN: string val prompt: T
114 val readyN: string val ready: T
115 val no_output: output * output
116 val default_output: T -> output * output
117 val add_mode: string -> (T -> output * output) -> unit
118 val output: T -> output * output
119 val enclose: T -> output -> output
120 val markup: T -> string -> string
123 structure Markup: MARKUP =
126 (** markup elements **)
130 type T = string * Properties.T;
134 fun is_none ("", _) = true
138 fun properties more_props ((elem, props): T) =
139 (elem, fold_rev Properties.put more_props props);
141 fun markup_elem elem = (elem, (elem, []): T);
142 fun markup_string elem prop = (elem, fn s => (elem, [(prop, s)]): T);
143 fun markup_int elem prop = (elem, fn i => (elem, [(prop, Int.toString i)]): T);
149 fun name a = properties [(nameN, a)];
151 val (bindingN, binding) = markup_string "binding" nameN;
153 val theory_nameN = "theory_name";
160 val internalK = "internal";
163 (* formal entities *)
165 val (entityN, entity) = markup_string "entity" nameN;
174 val columnN = "column";
175 val offsetN = "offset";
176 val end_lineN = "end_line";
177 val end_columnN = "end_column";
178 val end_offsetN = "end_offset";
182 val position_properties' = [end_lineN, end_columnN, end_offsetN, fileN, idN];
183 val position_properties = [lineN, columnN, offsetN] @ position_properties';
185 val (positionN, position) = markup_elem "position";
186 val (locationN, location) = markup_elem "location";
189 (* pretty printing *)
191 val indentN = "indent";
192 val (blockN, block) = markup_int "block" indentN;
194 val widthN = "width";
195 val (breakN, break) = markup_int "break" widthN;
197 val (fbreakN, fbreak) = markup_elem "fbreak";
200 (* logical entities *)
202 val (tclassN, tclass) = markup_string "tclass" nameN;
203 val (tyconN, tycon) = markup_string "tycon" nameN;
204 val (fixed_declN, fixed_decl) = markup_string "fixed_decl" nameN;
205 val (fixedN, fixed) = markup_string "fixed" nameN;
206 val (const_declN, const_decl) = markup_string "const_decl" nameN;
207 val (constN, const) = markup_string "const" nameN;
208 val (fact_declN, fact_decl) = markup_string "fact_decl" nameN;
209 val (factN, fact) = markup_string "fact" nameN;
210 val (dynamic_factN, dynamic_fact) = markup_string "dynamic_fact" nameN;
211 val (local_fact_declN, local_fact_decl) = markup_string "local_fact_decl" nameN;
212 val (local_factN, local_fact) = markup_string "local_fact" nameN;
217 val (tfreeN, tfree) = markup_elem "tfree";
218 val (tvarN, tvar) = markup_elem "tvar";
219 val (freeN, free) = markup_elem "free";
220 val (skolemN, skolem) = markup_elem "skolem";
221 val (boundN, bound) = markup_elem "bound";
222 val (varN, var) = markup_elem "var";
223 val (numeralN, numeral) = markup_elem "numeral";
224 val (literalN, literal) = markup_elem "literal";
225 val (inner_stringN, inner_string) = markup_elem "inner_string";
226 val (inner_commentN, inner_comment) = markup_elem "inner_comment";
228 val (sortN, sort) = markup_elem "sort";
229 val (typN, typ) = markup_elem "typ";
230 val (termN, term) = markup_elem "term";
231 val (propN, prop) = markup_elem "prop";
233 val (attributeN, attribute) = markup_string "attribute" nameN;
234 val (methodN, method) = markup_string "method" nameN;
239 val (ML_keywordN, ML_keyword) = markup_elem "ML_keyword";
240 val (ML_identN, ML_ident) = markup_elem "ML_ident";
241 val (ML_tvarN, ML_tvar) = markup_elem "ML_tvar";
242 val (ML_numeralN, ML_numeral) = markup_elem "ML_numeral";
243 val (ML_charN, ML_char) = markup_elem "ML_char";
244 val (ML_stringN, ML_string) = markup_elem "ML_string";
245 val (ML_commentN, ML_comment) = markup_elem "ML_comment";
246 val (ML_malformedN, ML_malformed) = markup_elem "ML_malformed";
248 val (ML_defN, ML_def) = markup_elem "ML_def";
249 val (ML_openN, ML_open) = markup_elem "ML_open";
250 val (ML_structN, ML_struct) = markup_elem "ML_struct";
251 val (ML_refN, ML_ref) = markup_elem "ML_ref";
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_string "keyword" nameN;
273 val (commandN, command) = markup_string "command" nameN;
274 val (identN, ident) = markup_elem "ident";
275 val (stringN, string) = markup_elem "string";
276 val (altstringN, altstring) = markup_elem "altstring";
277 val (verbatimN, verbatim) = markup_elem "verbatim";
278 val (commentN, comment) = markup_elem "comment";
279 val (controlN, control) = markup_elem "control";
280 val (malformedN, malformed) = markup_elem "malformed";
282 val (tokenN, token) = markup_elem "token";
284 val (command_spanN, command_span) = markup_string "command_span" nameN;
285 val (ignored_spanN, ignored_span) = markup_elem "ignored_span";
286 val (malformed_spanN, malformed_span) = markup_elem "malformed_span";
291 val (stateN, state) = markup_elem "state";
292 val (subgoalN, subgoal) = markup_elem "subgoal";
293 val (sendbackN, sendback) = markup_elem "sendback";
294 val (hiliteN, hilite) = markup_elem "hilite";
301 val (unprocessedN, unprocessed) = markup_elem "unprocessed";
302 val (runningN, running) = markup_string "running" taskN;
303 val (failedN, failed) = markup_elem "failed";
304 val (finishedN, finished) = markup_elem "finished";
305 val (disposedN, disposed) = markup_elem "disposed";
308 (* interactive documents *)
310 val (editsN, edits) = markup_string "edits" idN;
313 fun edit id state_id : T = (editN, [(idN, id), (stateN, state_id)]);
319 val sessionN = "session";
321 val (promptN, prompt) = markup_elem "prompt";
322 val (readyN, ready) = markup_elem "ready";
326 (** print mode operations **)
328 val no_output = ("", "");
329 fun default_output (_: T) = no_output;
332 val default = {output = default_output};
333 val modes = Unsynchronized.ref (Symtab.make [("", default)]);
335 fun add_mode name output = CRITICAL (fn () =>
336 Unsynchronized.change modes (Symtab.update_new (name, {output = output})));
338 the_default default (Library.get_first (Symtab.lookup (! modes)) (print_mode_value ()));
341 fun output m = if is_none m then no_output else #output (get_mode ()) m;
343 val enclose = output #-> Library.enclose;
346 let val (bg, en) = output m
347 in Library.enclose (Output.escape bg) (Output.escape en) end;