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