defer evaluation of Scan.message, for improved performance in the frequent situation where failure is handled later (e.g. via ||);
1 (* Title: Pure/Isar/parse.ML
2 Author: Markus Wenzel, TU Muenchen
4 Generic parsers for Isabelle/Isar outer syntax.
9 type 'a parser = Token.T list -> 'a * Token.T list
10 type 'a context_parser = Context.generic * Token.T list -> 'a * (Context.generic * Token.T list)
11 val group: string -> (Token.T list -> 'a) -> Token.T list -> 'a
12 val !!! : (Token.T list -> 'a) -> Token.T list -> 'a
13 val !!!! : (Token.T list -> 'a) -> Token.T list -> 'a
14 val triple1: ('a * 'b) * 'c -> 'a * 'b * 'c
15 val triple2: 'a * ('b * 'c) -> 'a * 'b * 'c
16 val triple_swap: ('a * 'b) * 'c -> ('a * 'c) * 'b
17 val not_eof: Token.T parser
18 val position: 'a parser -> ('a * Position.T) parser
19 val source_position: 'a parser -> (Symbol_Pos.text * Position.T) parser
20 val inner_syntax: 'a parser -> string parser
21 val command: string parser
22 val keyword: string parser
23 val short_ident: string parser
24 val long_ident: string parser
25 val sym_ident: string parser
26 val minus: string parser
27 val term_var: string parser
28 val type_ident: string parser
29 val type_var: string parser
30 val number: string parser
31 val float_number: string parser
32 val string: string parser
33 val alt_string: string parser
34 val verbatim: string parser
35 val sync: string parser
36 val eof: string parser
37 val keyword_with: (string -> bool) -> string parser
38 val keyword_ident_or_symbolic: string parser
39 val $$$ : string -> string parser
40 val reserved: string -> string parser
41 val semicolon: string parser
42 val underscore: string parser
43 val maybe: 'a parser -> 'a option parser
44 val tag_name: string parser
45 val tags: string list parser
46 val opt_unit: unit parser
47 val opt_keyword: string -> bool parser
48 val begin: string parser
49 val opt_begin: bool parser
53 val enum: string -> 'a parser -> 'a list parser
54 val enum1: string -> 'a parser -> 'a list parser
55 val and_list: 'a parser -> 'a list parser
56 val and_list1: 'a parser -> 'a list parser
57 val enum': string -> 'a context_parser -> 'a list context_parser
58 val enum1': string -> 'a context_parser -> 'a list context_parser
59 val and_list': 'a context_parser -> 'a list context_parser
60 val and_list1': 'a context_parser -> 'a list context_parser
61 val list: 'a parser -> 'a list parser
62 val list1: 'a parser -> 'a list parser
63 val properties: Properties.T parser
64 val name: bstring parser
65 val binding: binding parser
66 val xname: xstring parser
67 val text: string parser
68 val path: Path.T parser
69 val liberal_name: xstring parser
70 val parname: string parser
71 val parbinding: binding parser
72 val sort: string parser
73 val arity: (string * string list * string) parser
74 val multi_arity: (string list * string list * string) parser
75 val type_args: string list parser
76 val type_args_constrained: (string * string option) list parser
77 val typ_group: string parser
78 val typ: string parser
79 val mixfix: mixfix parser
80 val mixfix': mixfix parser
81 val opt_mixfix: mixfix parser
82 val opt_mixfix': mixfix parser
83 val where_: string parser
84 val const_decl: (string * string * mixfix) parser
85 val const_binding: (binding * string * mixfix) parser
86 val params: (binding * string option) list parser
87 val simple_fixes: (binding * string option) list parser
88 val fixes: (binding * string option * mixfix) list parser
89 val for_fixes: (binding * string option * mixfix) list parser
90 val for_simple_fixes: (binding * string option) list parser
91 val ML_source: (Symbol_Pos.text * Position.T) parser
92 val doc_source: (Symbol_Pos.text * Position.T) parser
93 val term_group: string parser
94 val prop_group: string parser
95 val term: string parser
96 val prop: string parser
97 val type_const: string parser
98 val const: string parser
99 val literal_fact: string parser
100 val propp: (string * string list) parser
101 val termp: (string * string list) parser
102 val target: xstring parser
103 val opt_target: xstring option parser
106 structure Parse: PARSE =
109 type 'a parser = Token.T list -> 'a * Token.T list;
110 type 'a context_parser = Context.generic * Token.T list -> 'a * (Context.generic * Token.T list);
113 (** error handling **)
115 (* group atomic parsers (no cuts!) *)
117 fun fail_with s = Scan.fail_with
118 (fn [] => (fn () => s ^ " expected (past end-of-file!)")
121 (case Token.text_of tok of
123 s ^ " expected,\nbut " ^ txt ^ Token.pos_of tok ^ " was found"
125 s ^ " expected,\nbut " ^ txt1 ^ Token.pos_of tok ^ " was found:\n" ^ txt2)));
127 fun group s scan = scan || fail_with s;
134 fun get_pos [] = " (past end-of-file!)"
135 | get_pos (tok :: _) = Token.pos_of tok;
137 fun err (toks, NONE) = (fn () => kind ^ get_pos toks)
138 | err (toks, SOME msg) =
140 let val s = msg () in
141 if String.isPrefix kind s then s
142 else kind ^ get_pos toks ^ ": " ^ s
144 in Scan.!! err scan end;
146 fun !!! scan = cut "Outer syntax error" scan;
147 fun !!!! scan = cut "Corrupted outer syntax in presentation" scan;
151 (** basic parsers **)
155 fun triple1 ((x, y), z) = (x, y, z);
156 fun triple2 (x, (y, z)) = (x, y, z);
157 fun triple_swap ((x, y), z) = ((x, z), y);
162 fun RESET_VALUE atom = (*required for all primitive parsers*)
163 Scan.ahead (Scan.one (K true)) -- atom >> (fn (arg, x) => (Token.assign NONE arg; x));
166 val not_eof = RESET_VALUE (Scan.one Token.not_eof);
168 fun position scan = (Scan.ahead not_eof >> Token.position_of) -- scan >> Library.swap;
169 fun source_position atom = Scan.ahead atom |-- not_eof >> Token.source_position_of;
170 fun inner_syntax atom = Scan.ahead atom |-- not_eof >> Token.source_of;
173 group (Token.str_of_kind k) (RESET_VALUE (Scan.one (Token.is_kind k) >> Token.content_of));
175 val command = kind Token.Command;
176 val keyword = kind Token.Keyword;
177 val short_ident = kind Token.Ident;
178 val long_ident = kind Token.LongIdent;
179 val sym_ident = kind Token.SymIdent;
180 val term_var = kind Token.Var;
181 val type_ident = kind Token.TypeIdent;
182 val type_var = kind Token.TypeVar;
183 val number = kind Token.Nat;
184 val float_number = kind Token.Float;
185 val string = kind Token.String;
186 val alt_string = kind Token.AltString;
187 val verbatim = kind Token.Verbatim;
188 val sync = kind Token.Sync;
189 val eof = kind Token.EOF;
191 fun keyword_with pred = RESET_VALUE (Scan.one (Token.keyword_with pred) >> Token.content_of);
192 val keyword_ident_or_symbolic = keyword_with Token.ident_or_symbolic;
195 group (Token.str_of_kind Token.Keyword ^ " " ^ quote x) (keyword_with (fn y => x = y));
198 group ("reserved identifier " ^ quote x)
199 (RESET_VALUE (Scan.one (Token.ident_with (fn y => x = y)) >> Token.content_of));
201 val semicolon = $$$ ";";
203 val minus = sym_ident :-- (fn "-" => Scan.succeed () | _ => Scan.fail) >> #1;
204 val underscore = sym_ident :-- (fn "_" => Scan.succeed () | _ => Scan.fail) >> #1;
205 fun maybe scan = underscore >> K NONE || scan >> SOME;
207 val nat = number >> (#1 o Library.read_int o Symbol.explode);
208 val int = Scan.optional (minus >> K ~1) 1 -- nat >> op *;
209 val real = float_number >> (the o Real.fromString) || int >> Real.fromInt;
211 val tag_name = group "tag name" (short_ident || string);
212 val tags = Scan.repeat ($$$ "%" |-- !!! tag_name);
214 val opt_unit = Scan.optional ($$$ "(" -- $$$ ")" >> (K ())) ();
215 fun opt_keyword s = Scan.optional ($$$ "(" |-- !!! (($$$ s >> K true) --| $$$ ")")) false;
217 val begin = $$$ "begin";
218 val opt_begin = Scan.optional (begin >> K true) false;
223 fun enum1 sep scan = scan ::: Scan.repeat ($$$ sep |-- !!! scan);
224 fun enum sep scan = enum1 sep scan || Scan.succeed [];
226 fun enum1' sep scan = scan ::: Scan.repeat (Scan.lift ($$$ sep) |-- scan);
227 fun enum' sep scan = enum1' sep scan || Scan.succeed [];
229 fun and_list1 scan = enum1 "and" scan;
230 fun and_list scan = enum "and" scan;
232 fun and_list1' scan = enum1' "and" scan;
233 fun and_list' scan = enum' "and" scan;
235 fun list1 scan = enum1 "," scan;
236 fun list scan = enum "," scan;
238 val properties = $$$ "(" |-- !!! (list (string -- ($$$ "=" |-- string)) --| $$$ ")");
243 val name = group "name declaration" (short_ident || sym_ident || string || number);
244 val binding = position name >> Binding.make;
245 val xname = group "name reference" (short_ident || long_ident || sym_ident || string || number);
246 val text = group "text" (short_ident || long_ident || sym_ident || string || number || verbatim);
247 val path = group "file name/path specification" name >> Path.explode;
249 val liberal_name = keyword_ident_or_symbolic || xname;
251 val parname = Scan.optional ($$$ "(" |-- name --| $$$ ")") "";
252 val parbinding = Scan.optional ($$$ "(" |-- binding --| $$$ ")") Binding.empty;
255 (* sorts and arities *)
257 val sort = group "sort" (inner_syntax xname);
259 val arity = xname -- ($$$ "::" |-- !!!
260 (Scan.optional ($$$ "(" |-- !!! (list1 sort --| $$$ ")")) [] -- sort)) >> triple2;
262 val multi_arity = and_list1 xname -- ($$$ "::" |-- !!!
263 (Scan.optional ($$$ "(" |-- !!! (list1 sort --| $$$ ")")) [] -- sort)) >> triple2;
268 val typ_group = group "type"
269 (short_ident || long_ident || sym_ident || type_ident || type_var || string || number);
271 val typ = inner_syntax typ_group;
273 fun type_arguments arg =
275 $$$ "(" |-- !!! (list1 arg --| $$$ ")") ||
278 val type_args = type_arguments type_ident;
279 val type_args_constrained = type_arguments (type_ident -- Scan.option ($$$ "::" |-- !!! sort));
282 (* mixfix annotations *)
285 !!! (Scan.optional ($$$ "[" |-- !!! (list nat --| $$$ "]")) [] --
286 Scan.optional nat 1000) >> (Mixfix o triple2);
288 val infx = $$$ "infix" |-- !!! (string -- nat >> Infix);
289 val infxl = $$$ "infixl" |-- !!! (string -- nat >> Infixl);
290 val infxr = $$$ "infixr" |-- !!! (string -- nat >> Infixr);
292 val binder = $$$ "binder" |--
293 !!! (string -- ($$$ "[" |-- nat --| $$$ "]" -- nat || nat >> (fn n => (n, n))))
294 >> (Binder o triple2);
296 fun annotation guard fix = $$$ "(" |-- guard (fix --| $$$ ")");
297 fun opt_annotation guard fix = Scan.optional (annotation guard fix) NoSyn;
299 val mixfix = annotation !!! (mfix || binder || infxl || infxr || infx);
300 val mixfix' = annotation I (mfix || binder || infxl || infxr || infx);
301 val opt_mixfix = opt_annotation !!! (mfix || binder || infxl || infxr || infx);
302 val opt_mixfix' = opt_annotation I (mfix || binder || infxl || infxr || infx);
307 val where_ = $$$ "where";
309 val const_decl = name -- ($$$ "::" |-- !!! typ) -- opt_mixfix >> triple1;
310 val const_binding = binding -- ($$$ "::" |-- !!! typ) -- opt_mixfix >> triple1;
312 val params = Scan.repeat1 binding -- Scan.option ($$$ "::" |-- !!! typ)
313 >> (fn (xs, T) => map (rpair T) xs);
315 val simple_fixes = and_list1 params >> flat;
318 and_list1 (binding -- Scan.option ($$$ "::" |-- typ) -- mixfix >> (single o triple1) ||
319 params >> map (fn (x, y) => (x, y, NoSyn))) >> flat;
321 val for_fixes = Scan.optional ($$$ "for" |-- !!! fixes) [];
322 val for_simple_fixes = Scan.optional ($$$ "for" |-- !!! simple_fixes) [];
325 (* embedded source text *)
327 val ML_source = source_position (group "ML source" text);
328 val doc_source = source_position (group "document source" text);
333 val tm = short_ident || long_ident || sym_ident || term_var || number || string;
335 val term_group = group "term" tm;
336 val prop_group = group "proposition" tm;
338 val term = inner_syntax term_group;
339 val prop = inner_syntax prop_group;
341 val type_const = inner_syntax (group "type constructor" xname);
342 val const = inner_syntax (group "constant" xname);
344 val literal_fact = inner_syntax (group "literal fact" alt_string);
349 val is_terms = Scan.repeat1 ($$$ "is" |-- term);
350 val is_props = Scan.repeat1 ($$$ "is" |-- prop);
352 val propp = prop -- Scan.optional ($$$ "(" |-- !!! (is_props --| $$$ ")")) [];
353 val termp = term -- Scan.optional ($$$ "(" |-- !!! (is_terms --| $$$ ")")) [];
358 val target = ($$$ "(" -- $$$ "in") |-- !!! (xname --| $$$ ")");
359 val opt_target = Scan.option target;
363 type 'a parser = 'a Parse.parser;
364 type 'a context_parser = 'a Parse.context_parser;