1 (* Title: Pure/General/markup.ML
5 Common markup elements.
10 type property = string * string
11 type T = string * property list
12 val get_string: T -> string -> string option
13 val get_int: T -> string -> int option
15 val properties: (string * string) list -> T -> T
18 val theory_nameN: string
22 val property_internal: property
26 val end_columnN: string
28 val position_properties: string list
29 val positionN: string val position: T
30 val locationN: string val location: 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 classN: string val class: string -> T
37 val tyconN: string val tycon: string -> T
38 val fixedN: string val fixed: string -> T
39 val constN: string val const: string -> T
40 val factN: string val fact: 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 numN: string val num: T
49 val xnumN: string val xnum: T
50 val xstrN: string val xstr: T
51 val sortN: string val sort: T
52 val typN: string val typ: T
53 val termN: string val term: T
54 val propN: string val prop: T
55 val keywordN: string val keyword: string -> T
56 val commandN: string val command: string -> T
57 val keyword_declN: string val keyword_decl: string -> T
58 val command_declN: string val command_decl: string -> string -> T
59 val stringN: string val string: T
60 val altstringN: string val altstring: T
61 val verbatimN: string val verbatim: T
62 val commentN: string val comment: T
63 val controlN: string val control: T
64 val malformedN: string val malformed: T
65 val antiqN: string val antiq: T
66 val command_spanN: string val command_span: string -> T
67 val ignored_spanN: string val ignored_span: T
68 val unknown_spanN: string val unknown_span: T
69 val promptN: string val prompt: T
70 val stateN: string val state: T
71 val subgoalN: string val subgoal: T
72 val sendbackN: string val sendback: T
73 val hiliteN: string val hilite: T
74 val unprocessedN: string val unprocessed: T
75 val runningN: string val running: T
76 val failedN: string val failed: T
77 val finishedN: string val finished: T
78 val disposedN: string val disposed: T
79 val default_output: T -> output * output
80 val add_mode: string -> (T -> output * output) -> unit
81 val output: T -> output * output
82 val enclose: T -> output -> output
83 val markup: T -> string -> string
86 structure Markup: MARKUP =
91 type property = string * string;
92 type T = string * property list;
97 fun properties more_props ((elem, props): T) =
98 (elem, fold_rev (AList.update (op =)) more_props props);
100 fun get_string ((_, props): T) prop = AList.lookup (op =) props prop;
101 fun get_int m prop = (case get_string m prop of NONE => NONE | SOME s => Int.fromString s);
103 fun markup_elem elem = (elem, (elem, []): T);
104 fun markup_string elem prop = (elem, fn s => (elem, [(prop, s)]): T);
105 fun markup_int elem prop = (elem, fn i => (elem, [(prop, Int.toString i)]): T);
111 val groupN = "group";
112 val theory_nameN = "theory_name";
119 val internalK = "internal";
120 val property_internal = (kindN, internalK);
126 val columnN = "column";
127 val end_lineN = "end_line";
128 val end_columnN = "end_column";
132 val position_properties = [lineN, columnN, end_lineN, end_columnN, fileN, idN];
133 val (positionN, position) = markup_elem "position";
135 val (locationN, location) = markup_elem "location";
138 (* pretty printing *)
140 val indentN = "indent";
141 val (blockN, block) = markup_int "block" indentN;
143 val widthN = "width";
144 val (breakN, break) = markup_int "break" widthN;
146 val (fbreakN, fbreak) = markup_elem "fbreak";
149 (* logical entities *)
151 val (classN, class) = markup_string "class" nameN;
152 val (tyconN, tycon) = markup_string "tycon" nameN;
153 val (fixedN, fixed) = markup_string "fixed" nameN;
154 val (constN, const) = markup_string "const" nameN;
155 val (factN, fact) = markup_string "fact" nameN;
156 val (dynamic_factN, dynamic_fact) = markup_string "dynamic_fact" nameN;
161 val (tfreeN, tfree) = markup_elem "tfree";
162 val (tvarN, tvar) = markup_elem "tvar";
163 val (freeN, free) = markup_elem "free";
164 val (skolemN, skolem) = markup_elem "skolem";
165 val (boundN, bound) = markup_elem "bound";
166 val (varN, var) = markup_elem "var";
167 val (numN, num) = markup_elem "num";
168 val (xnumN, xnum) = markup_elem "xnum";
169 val (xstrN, xstr) = markup_elem "xstr";
171 val (sortN, sort) = markup_elem "sort";
172 val (typN, typ) = markup_elem "typ";
173 val (termN, term) = markup_elem "term";
174 val (propN, prop) = markup_elem "prop";
179 val (keywordN, keyword) = markup_string "keyword" nameN;
180 val (commandN, command) = markup_string "command" nameN;
182 val (keyword_declN, keyword_decl) = markup_string "keyword_decl" nameN;
184 val command_declN = "command_decl";
185 fun command_decl name kind : T = (command_declN, [(nameN, name), (kindN, kind)]);
187 val (stringN, string) = markup_elem "string";
188 val (altstringN, altstring) = markup_elem "altstring";
189 val (verbatimN, verbatim) = markup_elem "verbatim";
190 val (commentN, comment) = markup_elem "comment";
191 val (controlN, control) = markup_elem "control";
192 val (malformedN, malformed) = markup_elem "malformed";
194 val (antiqN, antiq) = markup_elem "antiq";
196 val (command_spanN, command_span) = markup_string "command_span" nameN;
197 val (ignored_spanN, ignored_span) = markup_elem "ignored_span";
198 val (unknown_spanN, unknown_span) = markup_elem "unknown_span";
203 val (promptN, prompt) = markup_elem "prompt";
204 val (stateN, state) = markup_elem "state";
205 val (subgoalN, subgoal) = markup_elem "subgoal";
206 val (sendbackN, sendback) = markup_elem "sendback";
207 val (hiliteN, hilite) = markup_elem "hilite";
212 val (unprocessedN, unprocessed) = markup_elem "unprocessed";
213 val (runningN, running) = markup_elem "running";
214 val (failedN, failed) = markup_elem "failed";
215 val (finishedN, finished) = markup_elem "finished";
216 val (disposedN, disposed) = markup_elem "disposed";
219 (* print mode operations *)
221 fun default_output (_: T) = ("", "");
224 val default = {output = default_output};
225 val modes = ref (Symtab.make [("", default)]);
227 fun add_mode name output = CRITICAL (fn () =>
228 change modes (Symtab.update_new (name, {output = output})));
230 the_default default (Library.get_first (Symtab.lookup (! modes)) (print_mode_value ()));
233 fun output ("", _) = ("", "")
234 | output m = #output (get_mode ()) m;
236 val enclose = output #-> Library.enclose;
239 let val (bg, en) = output m
240 in Library.enclose (Output.escape bg) (Output.escape en) end;