src/Pure/Isar/outer_parse.ML
author wenzelm
Thu Nov 22 17:14:17 2001 +0100 (2001-11-22)
changeset 12268 28e60c998eee
parent 12263 6f2acf10e2a2
child 12272 9bc50336dab6
permissions -rw-r--r--
added uname;
syntax for locale expressions (presently unused);
     1 (*  Title:      Pure/Isar/outer_parse.ML
     2     ID:         $Id$
     3     Author:     Markus Wenzel, TU Muenchen
     4     License:    GPL (GNU GENERAL PUBLIC LICENSE)
     5 
     6 Generic parsers for Isabelle/Isar outer syntax.
     7 *)
     8 
     9 signature OUTER_PARSE =
    10 sig
    11   type token
    12   val group: string -> (token list -> 'a) -> token list -> 'a
    13   val !!! : (token list -> 'a) -> token list -> 'a
    14   val !!!! : (token list -> 'a) -> token list -> 'a
    15   val triple1: ('a * 'b) * 'c -> 'a * 'b * 'c
    16   val triple2: 'a * ('b * 'c) -> 'a * 'b * 'c
    17   val triple_swap: ('a * 'b) * 'c -> ('a * 'c) * 'b
    18   val $$$ : string -> token list -> string * token list
    19   val semicolon: token list -> string * token list
    20   val underscore: token list -> string * token list
    21   val position: (token list -> 'a * 'b) -> token list -> ('a * Position.T) * 'b
    22   val command: token list -> string * token list
    23   val keyword: token list -> string * token list
    24   val short_ident: token list -> string * token list
    25   val long_ident: token list -> string * token list
    26   val sym_ident: token list -> string * token list
    27   val term_var: token list -> string * token list
    28   val type_ident: token list -> string * token list
    29   val type_var: token list -> string * token list
    30   val number: token list -> string * token list
    31   val string: token list -> string * token list
    32   val verbatim: token list -> string * token list
    33   val sync: token list -> string * token list
    34   val eof: token list -> string * token list
    35   val not_eof: token list -> token * token list
    36   val opt_unit: token list -> unit * token list
    37   val nat: token list -> int * token list
    38   val enum: string -> (token list -> 'a * token list) -> token list -> 'a list * token list
    39   val enum1: string -> (token list -> 'a * token list) -> token list -> 'a list * token list
    40   val list: (token list -> 'a * token list) -> token list -> 'a list * token list
    41   val list1: (token list -> 'a * token list) -> token list -> 'a list * token list
    42   val and_list: (token list -> 'a * token list) -> token list -> 'a list * token list
    43   val and_list1: (token list -> 'a * token list) -> token list -> 'a list * token list
    44   val name: token list -> bstring * token list
    45   val xname: token list -> xstring * token list
    46   val text: token list -> string * token list
    47   val uname: token list -> string option * token list
    48   val comment: token list -> Comment.text * token list
    49   val marg_comment: token list -> Comment.text * token list
    50   val interest: token list -> Comment.interest * token list
    51   val sort: token list -> string * token list
    52   val arity: token list -> (string list * string) * token list
    53   val simple_arity: token list -> (string list * xclass) * token list
    54   val type_args: token list -> string list * token list
    55   val typ: token list -> string * token list
    56   val opt_infix: token list -> Syntax.mixfix * token list
    57   val opt_mixfix: token list -> Syntax.mixfix * token list
    58   val opt_infix': token list -> Syntax.mixfix * token list
    59   val opt_mixfix': token list -> Syntax.mixfix * token list
    60   val const: token list -> (bstring * string * Syntax.mixfix) * token list
    61   val term: token list -> string * token list
    62   val prop: token list -> string * token list
    63   val propp: token list -> (string * (string list * string list)) * token list
    64   val termp: token list -> (string * string list) * token list
    65   val arguments: token list -> Args.T list * token list
    66   val attribs: token list -> Args.src list * token list
    67   val opt_attribs: token list -> Args.src list * token list
    68   val thm_name: string -> token list -> (bstring * Args.src list) * token list
    69   val opt_thm_name: string -> token list -> (bstring * Args.src list) * token list
    70   val spec_name: token list -> ((bstring * string) * Args.src list) * token list
    71   val spec_opt_name: token list -> ((bstring * string) * Args.src list) * token list
    72   val xthm: token list -> (xstring * Args.src list) * token list
    73   val xthms1: token list -> (xstring * Args.src list) list * token list
    74   val locale_element: token list -> Args.src Locale.element * token list
    75   val method: token list -> Method.text * token list
    76 end;
    77 
    78 structure OuterParse: OUTER_PARSE =
    79 struct
    80 
    81 structure T = OuterLex;
    82 type token = T.token;
    83 
    84 
    85 (** error handling **)
    86 
    87 (* group atomic parsers (no cuts!) *)
    88 
    89 fun fail_with s = Scan.fail_with
    90   (fn [] => s ^ " expected (past end-of-file!)"
    91     | (tok :: _) => s ^ " expected,\nbut " ^ T.name_of tok ^ T.pos_of tok ^ " was found");
    92 
    93 fun group s scan = scan || fail_with s;
    94 
    95 
    96 (* cut *)
    97 
    98 fun cut kind scan =
    99   let
   100     fun get_pos [] = " (past end-of-file!)"
   101       | get_pos (tok :: _) = T.pos_of tok;
   102 
   103     fun err (toks, None) = kind ^ get_pos toks
   104       | err (toks, Some msg) = kind ^ get_pos toks ^ ": " ^ msg;
   105   in Scan.!! err scan end;
   106 
   107 fun !!! scan = cut "Outer syntax error" scan;
   108 fun !!!! scan = cut "Corrupted outer syntax in presentation" scan;
   109 
   110 
   111 
   112 (** basic parsers **)
   113 
   114 (* utils *)
   115 
   116 fun triple1 ((x, y), z) = (x, y, z);
   117 fun triple2 (x, (y, z)) = (x, y, z);
   118 fun triple_swap ((x, y), z) = ((x, z), y);
   119 
   120 
   121 (* tokens *)
   122 
   123 fun position scan =
   124   (Scan.ahead (Scan.one T.not_eof) >> T.position_of) -- scan >> Library.swap;
   125 
   126 fun kind k =
   127   group (T.str_of_kind k) (Scan.one (T.is_kind k) >> T.val_of);
   128 
   129 val command = kind T.Command;
   130 val keyword = kind T.Keyword;
   131 val short_ident = kind T.Ident;
   132 val long_ident = kind T.LongIdent;
   133 val sym_ident = kind T.SymIdent;
   134 val term_var = kind T.Var;
   135 val type_ident = kind T.TypeIdent;
   136 val type_var = kind T.TypeVar;
   137 val number = kind T.Nat;
   138 val string = kind T.String;
   139 val verbatim = kind T.Verbatim;
   140 val sync = kind T.Sync;
   141 val eof = kind T.EOF;
   142 
   143 fun $$$ x =
   144   group (T.str_of_kind T.Keyword ^ " " ^ quote x)
   145     (Scan.one (T.keyword_with (equal x)) >> T.val_of);
   146 
   147 val semicolon = $$$ ";";
   148 
   149 val underscore = sym_ident :-- (fn "_" => Scan.succeed () | _ => Scan.fail) >> #1;
   150 
   151 val nat = number >> (fst o Term.read_int o Symbol.explode);
   152 
   153 val not_eof = Scan.one T.not_eof;
   154 
   155 val opt_unit = Scan.optional ($$$ "(" -- $$$ ")" >> (K ())) ();
   156 
   157 
   158 (* enumerations *)
   159 
   160 fun enum1 sep scan = scan -- Scan.repeat ($$$ sep |-- !!! scan) >> op ::;
   161 fun enum sep scan = enum1 sep scan || Scan.succeed [];
   162 
   163 fun list1 scan = enum1 "," scan;
   164 fun list scan = enum "," scan;
   165 
   166 fun and_list1 scan = enum1 "and" scan;
   167 fun and_list scan = enum "and" scan;
   168 
   169 
   170 (* names and text *)
   171 
   172 val name = group "name declaration" (short_ident || sym_ident || string || number);
   173 val xname = group "name reference" (short_ident || long_ident || sym_ident || string || number);
   174 val text = group "text" (short_ident || long_ident || sym_ident || string || number || verbatim);
   175 
   176 val uname = underscore >> K None || name >> Some;
   177 
   178 
   179 (* formal comments *)
   180 
   181 val comment = text >> (Comment.plain o Library.single);
   182 val marg_comment = Scan.repeat ($$$ "--" |-- text) >> Comment.plain;
   183 
   184 val interest = Scan.optional ($$$ "%%" >> K Comment.no_interest ||
   185   $$$ "%" |-- Scan.optional nat 1 >> Comment.interest) Comment.default_interest;
   186 
   187 
   188 (* sorts and arities *)
   189 
   190 val sort = group "sort" xname;
   191 
   192 fun gen_arity cod =
   193   Scan.optional ($$$ "(" |-- !!! (list1 sort --| $$$ ")")) [] -- cod;
   194 
   195 val arity = gen_arity sort;
   196 val simple_arity = gen_arity xname;
   197 
   198 
   199 (* types *)
   200 
   201 val typ = group "type"
   202   (short_ident || long_ident || sym_ident || type_ident || type_var || string || number);
   203 
   204 val type_args =
   205   type_ident >> single ||
   206   $$$ "(" |-- !!! (list1 type_ident --| $$$ ")") ||
   207   Scan.succeed [];
   208 
   209 
   210 (* mixfix annotations *)
   211 
   212 val infx = $$$ "infix" |-- !!! (nat >> Syntax.Infix || string -- nat >> Syntax.InfixName);
   213 val infxl = $$$ "infixl" |-- !!! (nat >> Syntax.Infixl || string -- nat >> Syntax.InfixlName);
   214 val infxr = $$$ "infixr" |-- !!! (nat >> Syntax.Infixr || string -- nat >> Syntax.InfixrName);
   215 
   216 val binder =
   217   $$$ "binder" |--
   218     !!! (string -- ($$$ "[" |-- nat --| $$$ "]" -- nat || nat >> (fn n => (n, n))))
   219   >> (Syntax.Binder o triple2);
   220 
   221 
   222 val opt_pris = Scan.optional ($$$ "[" |-- !!! (list nat --| $$$ "]")) [];
   223 
   224 val mixfix =
   225   (string -- !!! (opt_pris -- Scan.optional nat Syntax.max_pri))
   226   >> (Syntax.Mixfix o triple2);
   227 
   228 fun opt_fix guard fix =
   229   Scan.optional ($$$ "(" |-- guard (fix --| $$$ ")")) Syntax.NoSyn;
   230 
   231 val opt_infix = opt_fix !!! (infxl || infxr || infx);
   232 val opt_mixfix = opt_fix !!! (mixfix || binder || infxl || infxr || infx);
   233 
   234 val opt_infix' = opt_fix I (infxl || infxr || infx);
   235 val opt_mixfix' = opt_fix I (mixfix || binder || infxl || infxr || infx);
   236 
   237 
   238 (* consts *)
   239 
   240 val const =
   241   name -- ($$$ "::" |-- !!! (typ -- opt_mixfix)) >> triple2;
   242 
   243 
   244 (* terms *)
   245 
   246 val trm = short_ident || long_ident || sym_ident || term_var || number || string;
   247 
   248 val term = group "term" trm;
   249 val prop = group "proposition" trm;
   250 
   251 
   252 (* patterns *)
   253 
   254 val is_terms = Scan.repeat1 ($$$ "is" |-- term);
   255 val is_props = Scan.repeat1 ($$$ "is" |-- prop);
   256 val concl_props = $$$ "concl" |-- !!! is_props;
   257 val any_props = concl_props >> pair [] || is_props -- Scan.optional concl_props [];
   258 
   259 val propp = prop -- Scan.optional ($$$ "(" |-- !!! (any_props --| $$$ ")")) ([], []);
   260 val propp' = prop -- Scan.optional ($$$ "(" |-- !!! (is_props --| $$$ ")")) [];
   261 val termp = term -- Scan.optional ($$$ "(" |-- !!! (is_terms --| $$$ ")")) [];
   262 
   263 
   264 (* arguments *)
   265 
   266 fun keyword_symid is_symid = Scan.one (T.keyword_with is_symid) >> T.val_of;
   267 val keyword_sid = keyword_symid T.is_sid;
   268 
   269 fun atom_arg is_symid blk =
   270   group "argument"
   271     (position (short_ident || long_ident || sym_ident || term_var ||
   272         type_ident || type_var || number) >> Args.ident ||
   273       position (keyword_symid is_symid) >> Args.keyword ||
   274       position (string || verbatim) >> Args.string ||
   275       position (if blk then $$$ "," else Scan.fail) >> Args.keyword);
   276 
   277 fun paren_args l r scan = position ($$$ l) -- !!! (scan true -- position ($$$ r))
   278   >> (fn (x, (ys, z)) => Args.keyword x :: ys @ [Args.keyword z]);
   279 
   280 fun args is_symid blk x = Scan.optional (args1 is_symid blk) [] x
   281 and args1 is_symid blk x =
   282   ((Scan.repeat1
   283     (Scan.repeat1 (atom_arg is_symid blk) ||
   284       paren_args "(" ")" (args is_symid) ||
   285       paren_args "[" "]" (args is_symid))) >> flat) x;
   286 
   287 val arguments = args T.is_sid false;
   288 
   289 
   290 (* theorem specifications *)
   291 
   292 val attrib = position ((keyword_sid || xname) -- !!! arguments) >> Args.src;
   293 val attribs = $$$ "[" |-- !!! (list attrib --| $$$ "]");
   294 val opt_attribs = Scan.optional attribs [];
   295 
   296 fun thm_name s = name -- opt_attribs --| $$$ s;
   297 fun opt_thm_name s =
   298   Scan.optional ((name -- opt_attribs || (attribs >> pair "")) --| $$$ s) ("", []);;
   299 
   300 val spec_name = thm_name ":" -- prop >> (fn ((x, y), z) => ((x, z), y));
   301 val spec_opt_name = opt_thm_name ":" -- prop >> (fn ((x, y), z) => ((x, z), y));
   302 
   303 val xthm = xname -- opt_attribs;
   304 val xthms1 = Scan.repeat1 xthm;
   305 
   306 
   307 (* locale elements *)
   308 
   309 (* FIXME
   310 fun expr2 x = (xname >> Locale.Locale || $$$ "(" |-- !!! (expr0 --| $$$ ")")) x
   311 and expr1 x = (expr2 -- Scan.repeat1 uname >> Locale.Rename || expr2) x
   312 and expr0 x = (enum1 "+" expr1 >> (fn [e] => e | es => Locale.Merge es)) x;
   313 *)
   314 val expr0 = xname;
   315 
   316 val loc_mixfix = $$$ "(" -- $$$ "structure" -- !!! ($$$ ")") >> K None || opt_mixfix >> Some;
   317 
   318 val locale_element = group "locale element"
   319   ($$$ "fixes" |-- !!! (and_list1 (name -- Scan.option ($$$ "::" |-- typ) -- loc_mixfix
   320     >> triple1)) >> Locale.Fixes ||
   321   $$$ "assumes" |-- !!! (and_list1 (opt_thm_name ":" -- Scan.repeat1 propp))
   322     >> Locale.Assumes ||
   323   $$$ "defines" |-- !!! (and_list1 (opt_thm_name ":" -- propp'))
   324     >> Locale.Defines ||
   325   $$$ "notes" |-- !!! (and_list1 (opt_thm_name "=" -- xthms1)) >> Locale.Notes ||
   326   $$$ "uses" |-- !!! expr0 >> (Locale.Uses o Locale.Locale));
   327 
   328 
   329 (* proof methods *)
   330 
   331 fun is_symid_meth s =
   332   s <> "|" andalso s <> "?" andalso s <> "+" andalso T.is_sid s;
   333 
   334 fun meth4 x =
   335  (position (xname >> rpair []) >> (Method.Source o Args.src) ||
   336   $$$ "(" |-- !!! (meth0 --| $$$ ")")) x
   337 and meth3 x =
   338  (meth4 --| $$$ "?" >> Method.Try ||
   339   meth4 --| $$$ "+" >> Method.Repeat1 ||
   340   meth4) x
   341 and meth2 x =
   342  (position (xname -- args1 is_symid_meth false) >> (Method.Source o Args.src) ||
   343   meth3) x
   344 and meth1 x = (enum1 "," meth2 >> (fn [m] => m | ms => Method.Then ms)) x
   345 and meth0 x = (enum1 "|" meth1 >> (fn [m] => m | ms => Method.Orelse ms)) x;
   346 
   347 val method = meth3;
   348 
   349 
   350 end;