src/Pure/Isar/outer_lex.ML
author wenzelm
Tue Mar 21 12:18:15 2006 +0100 (2006-03-21 ago)
changeset 19305 5c16895d548b
parent 18547 d1978038b945
child 20112 a25c5d283239
permissions -rw-r--r--
avoid polymorphic equality;
wenzelm@5825
     1
(*  Title:      Pure/Isar/outer_lex.ML
wenzelm@5825
     2
    ID:         $Id$
wenzelm@5825
     3
    Author:     Markus Wenzel, TU Muenchen
wenzelm@5825
     4
wenzelm@5825
     5
Outer lexical syntax for Isabelle/Isar.
wenzelm@5825
     6
*)
wenzelm@5825
     7
wenzelm@5825
     8
signature OUTER_LEX =
wenzelm@5825
     9
sig
wenzelm@5825
    10
  datatype token_kind =
wenzelm@7477
    11
    Command | Keyword | Ident | LongIdent | SymIdent | Var | TypeIdent | TypeVar |
wenzelm@17164
    12
    Nat | String | AltString | Verbatim | Space | Comment | Sync | Malformed | EOF
aspinall@15143
    13
  eqtype token
wenzelm@5825
    14
  val str_of_kind: token_kind -> string
wenzelm@5825
    15
  val stopper: token * (token -> bool)
wenzelm@6859
    16
  val not_sync: token -> bool
wenzelm@5825
    17
  val not_eof: token -> bool
wenzelm@5825
    18
  val position_of: token -> Position.T
wenzelm@5825
    19
  val pos_of: token -> string
wenzelm@5825
    20
  val is_kind: token_kind -> token -> bool
wenzelm@7026
    21
  val keyword_with: (string -> bool) -> token -> bool
wenzelm@16029
    22
  val ident_with: (string -> bool) -> token -> bool
wenzelm@5825
    23
  val name_of: token -> string
wenzelm@5825
    24
  val is_proper: token -> bool
wenzelm@9130
    25
  val is_semicolon: token -> bool
wenzelm@17069
    26
  val is_comment: token -> bool
wenzelm@8580
    27
  val is_begin_ignore: token -> bool
wenzelm@8580
    28
  val is_end_ignore: token -> bool
wenzelm@17069
    29
  val is_blank: token -> bool
wenzelm@8651
    30
  val is_newline: token -> bool
wenzelm@14991
    31
  val unparse: token -> string
wenzelm@5825
    32
  val val_of: token -> string
wenzelm@5876
    33
  val is_sid: string -> bool
wenzelm@9130
    34
  val !!! : string -> (Position.T * 'a -> 'b) -> Position.T * 'a -> 'b
wenzelm@9130
    35
  val incr_line: ('a -> 'b * 'c) -> Position.T * 'a -> 'b * (Position.T * 'c)
wenzelm@9130
    36
  val keep_line: ('a -> 'b * 'c) -> Position.T * 'a -> 'b * (Position.T * 'c)
wenzelm@9130
    37
  val scan_blank: Position.T * Symbol.symbol list
wenzelm@9130
    38
    -> Symbol.symbol * (Position.T * Symbol.symbol list)
wenzelm@9130
    39
  val scan_string: Position.T * Symbol.symbol list -> string * (Position.T * Symbol.symbol list)
wenzelm@7026
    40
  val scan: (Scan.lexicon * Scan.lexicon) ->
wenzelm@5825
    41
    Position.T * Symbol.symbol list -> token * (Position.T * Symbol.symbol list)
wenzelm@7026
    42
  val source: bool -> (unit -> (Scan.lexicon * Scan.lexicon)) ->
wenzelm@7026
    43
    Position.T -> (Symbol.symbol, 'a) Source.source ->
wenzelm@7682
    44
    (token, Position.T * (Symbol.symbol, 'a) Source.source) Source.source
wenzelm@17164
    45
  val source_proper: (token, 'a) Source.source ->
wenzelm@17164
    46
    (token, (token, 'a) Source.source) Source.source
wenzelm@9130
    47
  val make_lexicon: string list -> Scan.lexicon
wenzelm@5825
    48
end;
wenzelm@5825
    49
wenzelm@5825
    50
structure OuterLex: OUTER_LEX =
wenzelm@5825
    51
struct
wenzelm@5825
    52
wenzelm@5825
    53
wenzelm@5825
    54
(** tokens **)
wenzelm@5825
    55
wenzelm@5825
    56
(* datatype token *)
wenzelm@5825
    57
wenzelm@5825
    58
datatype token_kind =
wenzelm@7477
    59
  Command | Keyword | Ident | LongIdent | SymIdent | Var | TypeIdent | TypeVar |
wenzelm@17164
    60
  Nat | String | AltString | Verbatim | Space | Comment | Sync | Malformed | EOF;
wenzelm@5825
    61
wenzelm@5825
    62
datatype token = Token of Position.T * (token_kind * string);
wenzelm@5825
    63
wenzelm@5825
    64
val str_of_kind =
wenzelm@7026
    65
 fn Command => "command"
wenzelm@7026
    66
  | Keyword => "keyword"
wenzelm@5825
    67
  | Ident => "identifier"
wenzelm@5825
    68
  | LongIdent => "long identifier"
wenzelm@5825
    69
  | SymIdent => "symbolic identifier"
wenzelm@5825
    70
  | Var => "schematic variable"
wenzelm@5825
    71
  | TypeIdent => "type variable"
wenzelm@5825
    72
  | TypeVar => "schematic type variable"
wenzelm@5825
    73
  | Nat => "number"
wenzelm@5825
    74
  | String => "string"
wenzelm@17164
    75
  | AltString => "back-quoted string"
wenzelm@5825
    76
  | Verbatim => "verbatim text"
wenzelm@7682
    77
  | Space => "white space"
wenzelm@7682
    78
  | Comment => "comment text"
wenzelm@6859
    79
  | Sync => "sync marker"
wenzelm@10748
    80
  | Malformed => "bad input"
wenzelm@5825
    81
  | EOF => "end-of-file";
wenzelm@5825
    82
wenzelm@5825
    83
wenzelm@10748
    84
(* control tokens *)
wenzelm@6859
    85
wenzelm@6859
    86
fun not_sync (Token (_, (Sync, _))) = false
wenzelm@6859
    87
  | not_sync _ = true;
wenzelm@6859
    88
wenzelm@10748
    89
val malformed = Token (Position.none, (Malformed, ""));
aspinall@15224
    90
fun malformed_of xs = Token (Position.none, (Malformed, implode xs));
wenzelm@10748
    91
wenzelm@6859
    92
wenzelm@5825
    93
(* eof token *)
wenzelm@5825
    94
wenzelm@5825
    95
val eof = Token (Position.none, (EOF, ""));
wenzelm@5825
    96
wenzelm@5825
    97
fun is_eof (Token (_, (EOF, _))) = true
wenzelm@5825
    98
  | is_eof _ = false;
wenzelm@5825
    99
wenzelm@5825
   100
val stopper = (eof, is_eof);
wenzelm@5825
   101
val not_eof = not o is_eof;
wenzelm@5825
   102
wenzelm@5825
   103
wenzelm@5825
   104
(* get position *)
wenzelm@5825
   105
wenzelm@5825
   106
fun position_of (Token (pos, _)) = pos;
wenzelm@5825
   107
val pos_of = Position.str_of o position_of;
wenzelm@5825
   108
wenzelm@5825
   109
wenzelm@5825
   110
(* kind of token *)
wenzelm@5825
   111
wenzelm@5825
   112
fun is_kind k (Token (_, (k', _))) = k = k';
wenzelm@5825
   113
wenzelm@7026
   114
fun keyword_with pred (Token (_, (Keyword, x))) = pred x
wenzelm@7026
   115
  | keyword_with _ _ = false;
wenzelm@5825
   116
wenzelm@16029
   117
fun ident_with pred (Token (_, (Ident, x))) = pred x
wenzelm@16029
   118
  | ident_with _ _ = false;
wenzelm@16029
   119
wenzelm@7682
   120
fun is_proper (Token (_, (Space, _))) = false
wenzelm@7682
   121
  | is_proper (Token (_, (Comment, _))) = false
wenzelm@5825
   122
  | is_proper _ = true;
wenzelm@5825
   123
wenzelm@9195
   124
fun is_semicolon (Token (_, (Keyword, ";"))) = true
wenzelm@9130
   125
  | is_semicolon _ = false;
wenzelm@9130
   126
wenzelm@17069
   127
fun is_comment (Token (_, (Comment, _))) = true
wenzelm@17069
   128
  | is_comment _ = false;
wenzelm@17069
   129
wenzelm@8580
   130
fun is_begin_ignore (Token (_, (Comment, "<"))) = true
wenzelm@8580
   131
  | is_begin_ignore _ = false;
wenzelm@8580
   132
wenzelm@8580
   133
fun is_end_ignore (Token (_, (Comment, ">"))) = true
wenzelm@8580
   134
  | is_end_ignore _ = false;
wenzelm@8580
   135
wenzelm@8651
   136
wenzelm@17069
   137
(* blanks and newlines -- space tokens obey lines *)
wenzelm@8651
   138
wenzelm@17069
   139
fun is_blank (Token (_, (Space, s))) = not (String.isSuffix "\n" s)
wenzelm@17069
   140
  | is_blank _ = false;
wenzelm@17069
   141
wenzelm@17069
   142
fun is_newline (Token (_, (Space, s))) = String.isSuffix "\n" s
wenzelm@8651
   143
  | is_newline _ = false;
wenzelm@8651
   144
wenzelm@5825
   145
wenzelm@14991
   146
(* token content *)
wenzelm@9155
   147
wenzelm@9155
   148
fun name_of (tok as Token (_, (k, x))) =
wenzelm@10748
   149
  if is_semicolon tok then "terminator"
wenzelm@10748
   150
  else if x = "" then str_of_kind k
wenzelm@10748
   151
  else str_of_kind k ^ " " ^ quote x;
wenzelm@5825
   152
wenzelm@18547
   153
fun escape q =
wenzelm@18547
   154
  implode o map (fn s => if s = q orelse s = "\\" then "\\" ^ s else s) o Symbol.explode;
wenzelm@18547
   155
wenzelm@14991
   156
fun unparse (Token (_, (kind, x))) =
wenzelm@14991
   157
  (case kind of
wenzelm@18547
   158
    String => x |> quote o escape "\""
wenzelm@18547
   159
  | AltString => x |> enclose "`" "`" o escape "`"
wenzelm@14991
   160
  | Verbatim => x |> enclose "{*" "*}"
wenzelm@14991
   161
  | Comment => x |> enclose "(*" "*)"
wenzelm@14991
   162
  | _ => x);
wenzelm@14991
   163
wenzelm@5825
   164
fun val_of (Token (_, (_, x))) = x;
wenzelm@5825
   165
wenzelm@5825
   166
fun token_leq (Token (_, (_, x)), Token (_, (_, x'))) = x <= x';
wenzelm@5825
   167
wenzelm@5825
   168
wenzelm@5825
   169
wenzelm@5825
   170
(** scanners **)
wenzelm@5825
   171
wenzelm@5825
   172
fun change_prompt scan = Scan.prompt "# " scan;
wenzelm@5825
   173
wenzelm@5825
   174
wenzelm@5825
   175
(* diagnostics *)
wenzelm@5825
   176
wenzelm@5825
   177
fun lex_err msg ((pos, cs), _) = "Outer lexical error" ^ Position.str_of pos ^ ": " ^ msg cs;
wenzelm@9130
   178
fun !!! msg scan = Scan.!! (lex_err (K msg)) scan;
wenzelm@5825
   179
wenzelm@5825
   180
wenzelm@5825
   181
(* line numbering *)
wenzelm@5825
   182
wenzelm@5825
   183
fun incr_line scan = Scan.depend (fn pos => scan >> pair (Position.inc pos));
wenzelm@5825
   184
val keep_line = Scan.lift;
wenzelm@5825
   185
wenzelm@5825
   186
val scan_blank =
wenzelm@5825
   187
  incr_line ($$ "\n") ||
wenzelm@5825
   188
  keep_line (Scan.one Symbol.is_blank);
wenzelm@5825
   189
wenzelm@5825
   190
wenzelm@5825
   191
(* scan symbolic idents *)
wenzelm@5825
   192
wenzelm@17164
   193
val sym_chars = explode "!#$%&*+-/:<=>?@^_|~";
wenzelm@5825
   194
fun is_sym_char s = s mem sym_chars;
wenzelm@5825
   195
wenzelm@8231
   196
val scan_symid =
wenzelm@8231
   197
  Scan.any1 is_sym_char >> implode ||
wenzelm@8231
   198
  Scan.one Symbol.is_symbolic;
wenzelm@5825
   199
wenzelm@8231
   200
fun is_symid str =
wenzelm@8231
   201
  (case try Symbol.explode str of
skalberg@15531
   202
    SOME [s] => Symbol.is_symbolic s orelse is_sym_char s
skalberg@15531
   203
  | SOME ss => forall is_sym_char ss
wenzelm@8231
   204
  | _ => false);
wenzelm@8231
   205
wenzelm@5876
   206
val is_sid = is_symid orf Syntax.is_identifier;
wenzelm@5825
   207
wenzelm@5825
   208
wenzelm@5825
   209
(* scan strings *)
wenzelm@5825
   210
wenzelm@17164
   211
local
wenzelm@17164
   212
wenzelm@17164
   213
fun scan_str q =
wenzelm@7682
   214
  scan_blank ||
wenzelm@9130
   215
  keep_line ($$ "\\") |-- !!! "bad escape character in string"
wenzelm@17164
   216
      (scan_blank || keep_line ($$ q || $$ "\\")) ||
wenzelm@19305
   217
  keep_line (Scan.one (fn s => s <> q andalso s <> "\\" andalso
wenzelm@19305
   218
    Symbol.not_sync s andalso Symbol.not_eof s));
wenzelm@5825
   219
wenzelm@17164
   220
fun scan_strs q =
wenzelm@17164
   221
  keep_line ($$ q) |--
wenzelm@9130
   222
    !!! "missing quote at end of string"
wenzelm@17164
   223
      (change_prompt ((Scan.repeat (scan_str q) >> implode) --| keep_line ($$ q)));
wenzelm@17164
   224
wenzelm@17164
   225
in
wenzelm@17164
   226
wenzelm@17164
   227
val scan_string = scan_strs "\"";
wenzelm@17164
   228
val scan_alt_string = scan_strs "`";
wenzelm@17164
   229
wenzelm@17164
   230
end;
wenzelm@5825
   231
wenzelm@5825
   232
wenzelm@5825
   233
(* scan verbatim text *)
wenzelm@5825
   234
wenzelm@5825
   235
val scan_verb =
wenzelm@5825
   236
  scan_blank ||
wenzelm@19305
   237
  keep_line ($$ "*" --| Scan.ahead (~$$ "}")) ||
wenzelm@19305
   238
  keep_line (Scan.one (fn s => s <> "*" andalso Symbol.not_sync s andalso Symbol.not_eof s));
wenzelm@5825
   239
wenzelm@5825
   240
val scan_verbatim =
wenzelm@6743
   241
  keep_line ($$ "{" -- $$ "*") |--
wenzelm@9130
   242
    !!! "missing end of verbatim text"
wenzelm@6743
   243
      (change_prompt ((Scan.repeat scan_verb >> implode) --| keep_line ($$ "*" -- $$ "}")));
wenzelm@5825
   244
wenzelm@5825
   245
wenzelm@5825
   246
(* scan space *)
wenzelm@5825
   247
wenzelm@19305
   248
fun is_space s = Symbol.is_blank s andalso s <> "\n";
wenzelm@5825
   249
wenzelm@5825
   250
val scan_space =
wenzelm@7682
   251
  (keep_line (Scan.any1 is_space) -- Scan.optional (incr_line ($$ "\n")) "" ||
wenzelm@7682
   252
    keep_line (Scan.any is_space) -- incr_line ($$ "\n")) >> (fn (cs, c) => implode cs ^ c);
wenzelm@5825
   253
wenzelm@5825
   254
wenzelm@5825
   255
(* scan nested comments *)
wenzelm@5825
   256
wenzelm@5825
   257
val scan_cmt =
wenzelm@5825
   258
  Scan.lift scan_blank ||
wenzelm@5825
   259
  Scan.depend (fn d => keep_line ($$ "(" ^^ $$ "*") >> pair (d + 1)) ||
wenzelm@5825
   260
  Scan.depend (fn 0 => Scan.fail | d => keep_line ($$ "*" ^^ $$ ")") >> pair (d - 1)) ||
wenzelm@19305
   261
  Scan.lift (keep_line ($$ "*" --| Scan.ahead (~$$ ")"))) ||
wenzelm@19305
   262
  Scan.lift (keep_line (Scan.one (fn s =>
wenzelm@19305
   263
    s <> "*" andalso Symbol.not_sync s andalso Symbol.not_eof s)));
wenzelm@5825
   264
wenzelm@5825
   265
val scan_comment =
wenzelm@5825
   266
  keep_line ($$ "(" -- $$ "*") |--
wenzelm@9130
   267
    !!! "missing end of comment"
wenzelm@5825
   268
      (change_prompt
wenzelm@7682
   269
        (Scan.pass 0 (Scan.repeat scan_cmt >> implode) --| keep_line ($$ "*" -- $$ ")")));
wenzelm@5825
   270
wenzelm@5825
   271
wenzelm@5825
   272
(* scan token *)
wenzelm@5825
   273
wenzelm@9130
   274
fun scan (lex1, lex2) =
wenzelm@5825
   275
  let
wenzelm@9130
   276
    val scanner = Scan.state :-- (fn pos =>
wenzelm@9130
   277
      let
wenzelm@9130
   278
        fun token k x = Token (pos, (k, x));
wenzelm@9130
   279
        fun sync _ = token Sync Symbol.sync;
wenzelm@9130
   280
      in
wenzelm@9130
   281
        scan_string >> token String ||
wenzelm@17164
   282
        scan_alt_string >> token AltString ||
wenzelm@9130
   283
        scan_verbatim >> token Verbatim ||
wenzelm@9130
   284
        scan_space >> token Space ||
wenzelm@9130
   285
        scan_comment >> token Comment ||
wenzelm@9130
   286
        keep_line (Scan.one Symbol.is_sync >> sync) ||
wenzelm@9130
   287
        keep_line (Scan.max token_leq
wenzelm@9130
   288
          (Scan.max token_leq
wenzelm@9130
   289
            (Scan.literal lex1 >> (token Keyword o implode))
wenzelm@9130
   290
            (Scan.literal lex2 >> (token Command o implode)))
wenzelm@9130
   291
          (Syntax.scan_longid >> token LongIdent ||
wenzelm@9130
   292
            Syntax.scan_id >> token Ident ||
wenzelm@9130
   293
            Syntax.scan_var >> token Var ||
wenzelm@9130
   294
            Syntax.scan_tid >> token TypeIdent ||
wenzelm@9130
   295
            Syntax.scan_tvar >> token TypeVar ||
wenzelm@9130
   296
            Syntax.scan_nat >> token Nat ||
wenzelm@9130
   297
            scan_symid >> token SymIdent))
wenzelm@9130
   298
      end) >> #2;
wenzelm@14729
   299
  in !! (lex_err (fn cs => "bad input " ^ quote (Symbol.beginning 10 cs))) scanner end;
wenzelm@5825
   300
wenzelm@5825
   301
wenzelm@9130
   302
(* token sources *)
wenzelm@5825
   303
wenzelm@6859
   304
val is_junk = (not o Symbol.is_blank) andf Symbol.not_sync andf Symbol.not_eof;
aspinall@15224
   305
fun recover xs = (keep_line (Scan.any is_junk) >> (fn ts => [malformed_of ts])) xs;
wenzelm@5825
   306
wenzelm@5825
   307
fun source do_recover get_lex pos src =
wenzelm@5825
   308
  Source.source' pos Symbol.stopper (Scan.bulk (fn xs => scan (get_lex ()) xs))
skalberg@15531
   309
    (if do_recover then SOME recover else NONE) src;
wenzelm@5825
   310
wenzelm@9130
   311
fun source_proper src = src |> Source.filter is_proper;
wenzelm@9130
   312
wenzelm@9130
   313
wenzelm@9130
   314
(* lexicons *)
wenzelm@9130
   315
wenzelm@9130
   316
val make_lexicon = Scan.make_lexicon o map Symbol.explode;
wenzelm@5825
   317
wenzelm@5825
   318
end;