src/Pure/General/symbol.ML
author wenzelm
Thu Jul 19 23:18:48 2007 +0200 (2007-07-19)
changeset 23863 8f3099589cfa
parent 23784 75e6b9dd5336
child 24580 916259859344
permissions -rw-r--r--
tuned signature;
wenzelm@6118
     1
(*  Title:      Pure/General/symbol.ML
wenzelm@6116
     2
    ID:         $Id$
wenzelm@6116
     3
    Author:     Markus Wenzel, TU Muenchen
wenzelm@6116
     4
paulson@21897
     5
Generalized characters with infinitely many named symbols.
wenzelm@6116
     6
*)
wenzelm@6116
     7
wenzelm@6116
     8
signature SYMBOL =
wenzelm@6116
     9
sig
wenzelm@6116
    10
  type symbol
wenzelm@6116
    11
  val space: symbol
wenzelm@23618
    12
  val spaces: int -> string
wenzelm@14678
    13
  val is_char: symbol -> bool
wenzelm@14678
    14
  val is_symbolic: symbol -> bool
wenzelm@14678
    15
  val is_printable: symbol -> bool
wenzelm@6116
    16
  val eof: symbol
wenzelm@6116
    17
  val is_eof: symbol -> bool
wenzelm@6116
    18
  val stopper: symbol * (symbol -> bool)
wenzelm@14678
    19
  val sync: symbol
wenzelm@14678
    20
  val is_sync: symbol -> bool
wenzelm@14678
    21
  val malformed: symbol
wenzelm@23676
    22
  val end_malformed: symbol
wenzelm@23784
    23
  val is_regular: symbol -> bool
wenzelm@6116
    24
  val is_ascii: symbol -> bool
wenzelm@14678
    25
  val is_ascii_letter: symbol -> bool
kleing@20067
    26
  val is_hex_letter: symbol -> bool
wenzelm@14678
    27
  val is_ascii_digit: symbol -> bool
wenzelm@14678
    28
  val is_ascii_quasi: symbol -> bool
wenzelm@14678
    29
  val is_ascii_blank: symbol -> bool
wenzelm@20200
    30
  val is_ascii_lower: symbol -> bool
wenzelm@20200
    31
  val is_ascii_upper: symbol -> bool
wenzelm@20200
    32
  val to_ascii_lower: symbol -> symbol
wenzelm@20200
    33
  val to_ascii_upper: symbol -> symbol
wenzelm@14834
    34
  val is_raw: symbol -> bool
wenzelm@14834
    35
  val decode_raw: symbol -> string
wenzelm@14977
    36
  val encode_raw: string -> string
wenzelm@14873
    37
  datatype sym = Char of string | Sym of string | Ctrl of string | Raw of string
wenzelm@14873
    38
  val decode: symbol -> sym
wenzelm@14678
    39
  datatype kind = Letter | Digit | Quasi | Blank | Other
wenzelm@14678
    40
  val kind: symbol -> kind
wenzelm@6116
    41
  val is_letter: symbol -> bool
wenzelm@6116
    42
  val is_digit: symbol -> bool
wenzelm@12904
    43
  val is_quasi: symbol -> bool
wenzelm@14678
    44
  val is_blank: symbol -> bool
wenzelm@6116
    45
  val is_quasi_letter: symbol -> bool
wenzelm@6116
    46
  val is_letdig: symbol -> bool
wenzelm@16138
    47
  val is_ident: symbol list -> bool
wenzelm@14728
    48
  val beginning: int -> symbol list -> string
wenzelm@14678
    49
  val scanner: string -> (string list -> 'a * string list) -> symbol list -> 'a
berghofe@13730
    50
  val scan_id: string list -> string * string list
wenzelm@6116
    51
  val source: bool -> (string, 'a) Source.source ->
wenzelm@6116
    52
    (symbol, (string, 'a) Source.source) Source.source
wenzelm@6272
    53
  val explode: string -> symbol list
wenzelm@14977
    54
  val escape: string -> string
wenzelm@14678
    55
  val strip_blanks: string -> string
wenzelm@14678
    56
  val bump_init: string -> string
wenzelm@12904
    57
  val bump_string: string -> string
wenzelm@14678
    58
  val length: symbol list -> int
wenzelm@6692
    59
  val xsymbolsN: string
wenzelm@6116
    60
end;
wenzelm@6116
    61
wenzelm@6116
    62
structure Symbol: SYMBOL =
wenzelm@6116
    63
struct
wenzelm@6116
    64
wenzelm@14678
    65
(** type symbol **)
wenzelm@6272
    66
wenzelm@14678
    67
(*Symbols, which are considered the smallest entities of any Isabelle
wenzelm@6272
    68
  string, may be of the following form:
wenzelm@14678
    69
wenzelm@14834
    70
    (1) ASCII symbols: a
wenzelm@17823
    71
    (2) regular symbols: \<ident>
wenzelm@14834
    72
    (3) control symbols: \<^ident>
wenzelm@14834
    73
    (4) raw control symbols: \<^raw:...>, where "..." may be any printable
wenzelm@20205
    74
        character (excluding ".", ">"), or \<^raw000>
wenzelm@6272
    75
wenzelm@14678
    76
  Output is subject to the print_mode variable (default: verbatim),
wenzelm@14678
    77
  actual interpretation in display is up to front-end tools.
wenzelm@6272
    78
*)
wenzelm@6272
    79
wenzelm@6272
    80
type symbol = string;
wenzelm@6272
    81
wenzelm@6272
    82
val space = " ";
wenzelm@17063
    83
wenzelm@17063
    84
local
wenzelm@17063
    85
  val small_spaces = Vector.tabulate (65, fn i => Library.replicate_string i space);
wenzelm@17063
    86
in
wenzelm@17063
    87
  fun spaces k =
wenzelm@17063
    88
    if k < 64 then Vector.sub (small_spaces, k)
wenzelm@17063
    89
    else Library.replicate_string (k div 64) (Vector.sub (small_spaces, 64)) ^
wenzelm@17063
    90
      Vector.sub (small_spaces, k mod 64);
wenzelm@17063
    91
end;
wenzelm@14678
    92
wenzelm@14678
    93
fun is_char s = size s = 1;
wenzelm@14678
    94
wenzelm@14678
    95
fun is_symbolic s =
wenzelm@14678
    96
  String.isPrefix "\\<" s andalso not (String.isPrefix "\\<^" s);
wenzelm@14678
    97
wenzelm@14678
    98
fun is_printable s =
wenzelm@14678
    99
  if is_char s then ord space <= ord s andalso ord s <= ord "~"
wenzelm@14678
   100
  else not (String.isPrefix "\\<^" s);
wenzelm@6272
   101
wenzelm@6272
   102
wenzelm@14678
   103
(* input source control *)
wenzelm@6272
   104
wenzelm@14678
   105
val eof = "";
wenzelm@6272
   106
fun is_eof s = s = eof;
wenzelm@6272
   107
fun not_eof s = s <> eof;
wenzelm@6272
   108
val stopper = (eof, is_eof);
wenzelm@6272
   109
wenzelm@14678
   110
val sync = "\\<^sync>";
wenzelm@14678
   111
fun is_sync s = s = sync;
wenzelm@14678
   112
wenzelm@23676
   113
val malformed = "[[";
wenzelm@23676
   114
val end_malformed = "]]";
wenzelm@23784
   115
fun malformed_msg s = "Malformed symbolic character: " ^ quote (Output.escape_malformed s);
wenzelm@23676
   116
wenzelm@23784
   117
fun is_regular s =
wenzelm@23784
   118
  not_eof s andalso s <> sync andalso s <> malformed andalso s <> end_malformed;
wenzelm@14678
   119
wenzelm@14678
   120
wenzelm@14678
   121
(* ascii symbols *)
wenzelm@14678
   122
wenzelm@14678
   123
fun is_ascii s = is_char s andalso ord s < 128;
wenzelm@14678
   124
wenzelm@14678
   125
fun is_ascii_letter s =
wenzelm@14678
   126
  is_char s andalso
wenzelm@14678
   127
   (ord "A" <= ord s andalso ord s <= ord "Z" orelse
wenzelm@14678
   128
    ord "a" <= ord s andalso ord s <= ord "z");
wenzelm@14678
   129
kleing@20067
   130
fun is_hex_letter s =
kleing@20067
   131
  is_char s andalso
kleing@20067
   132
   (ord "A" <= ord s andalso ord s <= ord "F" orelse
kleing@20067
   133
    ord "a" <= ord s andalso ord s <= ord "f");
kleing@20067
   134
wenzelm@14678
   135
fun is_ascii_digit s =
wenzelm@14678
   136
  is_char s andalso ord "0" <= ord s andalso ord s <= ord "9";
wenzelm@14678
   137
wenzelm@14678
   138
fun is_ascii_quasi "_" = true
wenzelm@14678
   139
  | is_ascii_quasi "'" = true
wenzelm@14678
   140
  | is_ascii_quasi _ = false;
wenzelm@14678
   141
wenzelm@14678
   142
val is_ascii_blank =
wenzelm@17756
   143
  fn " " => true | "\t" => true | "\n" => true | "\^L" => true | "\^M" => true
wenzelm@14678
   144
    | _ => false;
wenzelm@14678
   145
wenzelm@20200
   146
fun is_ascii_lower s = is_char s andalso (ord "a" <= ord s andalso ord s <= ord "z");
wenzelm@20200
   147
fun is_ascii_upper s = is_char s andalso (ord "A" <= ord s andalso ord s <= ord "Z");
wenzelm@20200
   148
wenzelm@20200
   149
fun to_ascii_lower s = if is_ascii_upper s then chr (ord s + ord "a" - ord "A") else s;
wenzelm@20200
   150
fun to_ascii_upper s = if is_ascii_lower s then chr (ord s + ord "A" - ord "a") else s;
wenzelm@20200
   151
wenzelm@14678
   152
wenzelm@14956
   153
(* encode_raw *)
wenzelm@14956
   154
wenzelm@20205
   155
fun raw_chr c =
wenzelm@20205
   156
  ord space <= ord c andalso ord c <= ord "~" andalso c <> "." andalso c <> ">"
wenzelm@17823
   157
  orelse ord c >= 128;
wenzelm@14956
   158
wenzelm@14956
   159
fun encode_raw str =
wenzelm@14956
   160
  let
wenzelm@23676
   161
    val raw0 = enclose "\\<^raw:" ">";
wenzelm@23676
   162
    val raw1 = raw0 o implode;
wenzelm@14956
   163
    val raw2 = enclose "\\<^raw" ">" o string_of_int o ord;
wenzelm@14956
   164
wenzelm@14956
   165
    fun encode cs = enc (Library.take_prefix raw_chr cs)
wenzelm@14956
   166
    and enc ([], []) = []
wenzelm@14956
   167
      | enc (cs, []) = [raw1 cs]
wenzelm@14956
   168
      | enc ([], d :: ds) = raw2 d :: encode ds
wenzelm@14956
   169
      | enc (cs, d :: ds) = raw1 cs :: raw2 d :: encode ds;
wenzelm@14956
   170
  in
wenzelm@14977
   171
    if exists_string (not o raw_chr) str then implode (encode (explode str))
wenzelm@23676
   172
    else raw0 str
wenzelm@14956
   173
  end;
wenzelm@14956
   174
wenzelm@14956
   175
wenzelm@14956
   176
(* diagnostics *)
wenzelm@14956
   177
wenzelm@14956
   178
fun beginning n cs =
wenzelm@14956
   179
  let
wenzelm@14956
   180
    val drop_blanks = #1 o Library.take_suffix is_ascii_blank;
wenzelm@14956
   181
    val all_cs = drop_blanks cs;
wenzelm@14956
   182
    val dots = if length all_cs > n then " ..." else "";
wenzelm@14956
   183
  in
wenzelm@14956
   184
    (drop_blanks (Library.take (n, all_cs))
wenzelm@14956
   185
      |> map (fn c => if is_ascii_blank c then space else c)
wenzelm@14956
   186
      |> implode) ^ dots
wenzelm@14956
   187
  end;
wenzelm@14956
   188
wenzelm@14956
   189
wenzelm@14956
   190
(* decode_raw *)
wenzelm@14834
   191
wenzelm@14834
   192
fun is_raw s =
wenzelm@17063
   193
  String.isPrefix "\\<^raw" s andalso String.isSuffix ">" s;
wenzelm@14834
   194
wenzelm@14834
   195
fun decode_raw s =
wenzelm@23676
   196
  if not (is_raw s) then error (malformed_msg s)
wenzelm@14834
   197
  else if String.isPrefix "\\<^raw:" s then String.substring (s, 7, size s - 8)
wenzelm@14834
   198
  else chr (#1 (Library.read_int (explode (String.substring (s, 6, size s - 7)))));
wenzelm@14834
   199
wenzelm@14834
   200
wenzelm@14873
   201
(* symbol variants *)
wenzelm@14873
   202
wenzelm@14873
   203
datatype sym = Char of string | Sym of string | Ctrl of string | Raw of string;
wenzelm@14873
   204
wenzelm@14873
   205
fun decode s =
wenzelm@14873
   206
  if is_char s then Char s
wenzelm@14873
   207
  else if is_raw s then Raw (decode_raw s)
wenzelm@14873
   208
  else if String.isPrefix "\\<^" s then Ctrl (String.substring (s, 3, size s - 4))
wenzelm@14873
   209
  else if String.isPrefix "\\<" s then Sym (String.substring (s, 2, size s - 3))
wenzelm@23676
   210
  else error (malformed_msg s);
wenzelm@14873
   211
wenzelm@14873
   212
wenzelm@14678
   213
(* standard symbol kinds *)
wenzelm@14678
   214
wenzelm@14678
   215
datatype kind = Letter | Digit | Quasi | Blank | Other;
wenzelm@6272
   216
skalberg@14171
   217
local
wenzelm@14678
   218
  val symbol_kinds = Symtab.make
wenzelm@14678
   219
   [("\\<A>", Letter),
wenzelm@14678
   220
    ("\\<B>", Letter),
wenzelm@14678
   221
    ("\\<C>", Letter),
wenzelm@14678
   222
    ("\\<D>", Letter),
wenzelm@14678
   223
    ("\\<E>", Letter),
wenzelm@14678
   224
    ("\\<F>", Letter),
wenzelm@14678
   225
    ("\\<G>", Letter),
wenzelm@14678
   226
    ("\\<H>", Letter),
wenzelm@14678
   227
    ("\\<I>", Letter),
wenzelm@14678
   228
    ("\\<J>", Letter),
wenzelm@14678
   229
    ("\\<K>", Letter),
wenzelm@14678
   230
    ("\\<L>", Letter),
wenzelm@14678
   231
    ("\\<M>", Letter),
wenzelm@14678
   232
    ("\\<N>", Letter),
wenzelm@14678
   233
    ("\\<O>", Letter),
wenzelm@14678
   234
    ("\\<P>", Letter),
wenzelm@14678
   235
    ("\\<Q>", Letter),
wenzelm@14678
   236
    ("\\<R>", Letter),
wenzelm@14678
   237
    ("\\<S>", Letter),
wenzelm@14678
   238
    ("\\<T>", Letter),
wenzelm@14678
   239
    ("\\<U>", Letter),
wenzelm@14678
   240
    ("\\<V>", Letter),
wenzelm@14678
   241
    ("\\<W>", Letter),
wenzelm@14678
   242
    ("\\<X>", Letter),
wenzelm@14678
   243
    ("\\<Y>", Letter),
wenzelm@14678
   244
    ("\\<Z>", Letter),
wenzelm@14678
   245
    ("\\<a>", Letter),
wenzelm@14678
   246
    ("\\<b>", Letter),
wenzelm@14678
   247
    ("\\<c>", Letter),
wenzelm@14678
   248
    ("\\<d>", Letter),
wenzelm@14678
   249
    ("\\<e>", Letter),
wenzelm@14678
   250
    ("\\<f>", Letter),
wenzelm@14678
   251
    ("\\<g>", Letter),
wenzelm@14678
   252
    ("\\<h>", Letter),
wenzelm@14678
   253
    ("\\<i>", Letter),
wenzelm@14678
   254
    ("\\<j>", Letter),
wenzelm@14678
   255
    ("\\<k>", Letter),
wenzelm@14678
   256
    ("\\<l>", Letter),
wenzelm@14678
   257
    ("\\<m>", Letter),
wenzelm@14678
   258
    ("\\<n>", Letter),
wenzelm@14678
   259
    ("\\<o>", Letter),
wenzelm@14678
   260
    ("\\<p>", Letter),
wenzelm@14678
   261
    ("\\<q>", Letter),
wenzelm@14678
   262
    ("\\<r>", Letter),
wenzelm@14678
   263
    ("\\<s>", Letter),
wenzelm@14678
   264
    ("\\<t>", Letter),
wenzelm@14678
   265
    ("\\<u>", Letter),
wenzelm@14678
   266
    ("\\<v>", Letter),
wenzelm@14678
   267
    ("\\<w>", Letter),
wenzelm@14678
   268
    ("\\<x>", Letter),
wenzelm@14678
   269
    ("\\<y>", Letter),
wenzelm@14678
   270
    ("\\<z>", Letter),
wenzelm@14678
   271
    ("\\<AA>", Letter),
wenzelm@14678
   272
    ("\\<BB>", Letter),
wenzelm@14678
   273
    ("\\<CC>", Letter),
wenzelm@14678
   274
    ("\\<DD>", Letter),
wenzelm@14678
   275
    ("\\<EE>", Letter),
wenzelm@14678
   276
    ("\\<FF>", Letter),
wenzelm@14678
   277
    ("\\<GG>", Letter),
wenzelm@14678
   278
    ("\\<HH>", Letter),
wenzelm@14678
   279
    ("\\<II>", Letter),
wenzelm@14678
   280
    ("\\<JJ>", Letter),
wenzelm@14678
   281
    ("\\<KK>", Letter),
wenzelm@14678
   282
    ("\\<LL>", Letter),
wenzelm@14678
   283
    ("\\<MM>", Letter),
wenzelm@14678
   284
    ("\\<NN>", Letter),
wenzelm@14678
   285
    ("\\<OO>", Letter),
wenzelm@14678
   286
    ("\\<PP>", Letter),
wenzelm@14678
   287
    ("\\<QQ>", Letter),
wenzelm@14678
   288
    ("\\<RR>", Letter),
wenzelm@14678
   289
    ("\\<SS>", Letter),
wenzelm@14678
   290
    ("\\<TT>", Letter),
wenzelm@14678
   291
    ("\\<UU>", Letter),
wenzelm@14678
   292
    ("\\<VV>", Letter),
wenzelm@14678
   293
    ("\\<WW>", Letter),
wenzelm@14678
   294
    ("\\<XX>", Letter),
wenzelm@14678
   295
    ("\\<YY>", Letter),
wenzelm@14678
   296
    ("\\<ZZ>", Letter),
wenzelm@14678
   297
    ("\\<aa>", Letter),
wenzelm@14678
   298
    ("\\<bb>", Letter),
wenzelm@14678
   299
    ("\\<cc>", Letter),
wenzelm@14678
   300
    ("\\<dd>", Letter),
wenzelm@14678
   301
    ("\\<ee>", Letter),
wenzelm@14678
   302
    ("\\<ff>", Letter),
wenzelm@14678
   303
    ("\\<gg>", Letter),
wenzelm@14678
   304
    ("\\<hh>", Letter),
wenzelm@14678
   305
    ("\\<ii>", Letter),
wenzelm@14678
   306
    ("\\<jj>", Letter),
wenzelm@14678
   307
    ("\\<kk>", Letter),
wenzelm@14678
   308
    ("\\<ll>", Letter),
wenzelm@14678
   309
    ("\\<mm>", Letter),
wenzelm@14678
   310
    ("\\<nn>", Letter),
wenzelm@14678
   311
    ("\\<oo>", Letter),
wenzelm@14678
   312
    ("\\<pp>", Letter),
wenzelm@14678
   313
    ("\\<qq>", Letter),
wenzelm@14678
   314
    ("\\<rr>", Letter),
wenzelm@14678
   315
    ("\\<ss>", Letter),
wenzelm@14678
   316
    ("\\<tt>", Letter),
wenzelm@14678
   317
    ("\\<uu>", Letter),
wenzelm@14678
   318
    ("\\<vv>", Letter),
wenzelm@14678
   319
    ("\\<ww>", Letter),
wenzelm@14678
   320
    ("\\<xx>", Letter),
wenzelm@14678
   321
    ("\\<yy>", Letter),
wenzelm@14678
   322
    ("\\<zz>", Letter),
wenzelm@14678
   323
    ("\\<alpha>", Letter),
wenzelm@14678
   324
    ("\\<beta>", Letter),
wenzelm@14678
   325
    ("\\<gamma>", Letter),
wenzelm@14678
   326
    ("\\<delta>", Letter),
wenzelm@14678
   327
    ("\\<epsilon>", Letter),
wenzelm@14678
   328
    ("\\<zeta>", Letter),
wenzelm@14678
   329
    ("\\<eta>", Letter),
wenzelm@14678
   330
    ("\\<theta>", Letter),
wenzelm@14678
   331
    ("\\<iota>", Letter),
wenzelm@14678
   332
    ("\\<kappa>", Letter),
wenzelm@14678
   333
    ("\\<lambda>", Other),      (*sic!*)
wenzelm@14678
   334
    ("\\<mu>", Letter),
wenzelm@14678
   335
    ("\\<nu>", Letter),
wenzelm@14678
   336
    ("\\<xi>", Letter),
wenzelm@14678
   337
    ("\\<pi>", Letter),
wenzelm@14678
   338
    ("\\<rho>", Letter),
wenzelm@14678
   339
    ("\\<sigma>", Letter),
wenzelm@14678
   340
    ("\\<tau>", Letter),
wenzelm@14678
   341
    ("\\<upsilon>", Letter),
wenzelm@14678
   342
    ("\\<phi>", Letter),
wenzelm@14678
   343
    ("\\<psi>", Letter),
wenzelm@14678
   344
    ("\\<omega>", Letter),
wenzelm@14678
   345
    ("\\<Gamma>", Letter),
wenzelm@14678
   346
    ("\\<Delta>", Letter),
wenzelm@14678
   347
    ("\\<Theta>", Letter),
wenzelm@14678
   348
    ("\\<Lambda>", Letter),
wenzelm@14678
   349
    ("\\<Xi>", Letter),
wenzelm@14678
   350
    ("\\<Pi>", Letter),
wenzelm@14678
   351
    ("\\<Sigma>", Letter),
wenzelm@14678
   352
    ("\\<Upsilon>", Letter),
wenzelm@14678
   353
    ("\\<Phi>", Letter),
wenzelm@14678
   354
    ("\\<Psi>", Letter),
wenzelm@14678
   355
    ("\\<Omega>", Letter),
wenzelm@14961
   356
    ("\\<^isub>", Letter),
wenzelm@14961
   357
    ("\\<^isup>", Letter),
wenzelm@14678
   358
    ("\\<spacespace>", Blank)];
skalberg@14171
   359
in
wenzelm@14678
   360
  fun kind s =
wenzelm@14678
   361
    if is_ascii_letter s then Letter
wenzelm@14678
   362
    else if is_ascii_digit s then Digit
wenzelm@14678
   363
    else if is_ascii_quasi s then Quasi
wenzelm@14678
   364
    else if is_ascii_blank s then Blank
wenzelm@14678
   365
    else if is_char s then Other
wenzelm@18939
   366
    else the_default Other (Symtab.lookup symbol_kinds s);
wenzelm@14678
   367
end;
skalberg@14173
   368
wenzelm@14678
   369
fun is_letter s = kind s = Letter;
wenzelm@14678
   370
fun is_digit s = kind s = Digit;
wenzelm@14678
   371
fun is_quasi s = kind s = Quasi;
wenzelm@14678
   372
fun is_blank s = kind s = Blank;
wenzelm@6272
   373
wenzelm@14678
   374
fun is_quasi_letter s = let val k = kind s in k = Letter orelse k = Quasi end;
wenzelm@14678
   375
fun is_letdig s = let val k = kind s in k = Letter orelse k = Digit orelse k = Quasi end;
wenzelm@11010
   376
wenzelm@16138
   377
fun is_ident [] = false
wenzelm@16138
   378
  | is_ident (c :: cs) = is_letter c andalso forall is_letdig cs;
wenzelm@16138
   379
wenzelm@6272
   380
wenzelm@6272
   381
wenzelm@14678
   382
(** symbol input **)
wenzelm@14678
   383
wenzelm@14678
   384
(* scanning through symbols *)
wenzelm@6272
   385
wenzelm@6640
   386
fun scanner msg scan chs =
wenzelm@6640
   387
  let
skalberg@15531
   388
    fun message (cs, NONE) = msg ^ ": " ^ quote (beginning 10 cs)
skalberg@15531
   389
      | message (cs, SOME msg') = msg ^ ", " ^ msg' ^ ": " ^ quote (beginning 10 cs);
wenzelm@14961
   390
    val fin_scan = Scan.error (Scan.finite stopper (!! message scan));
wenzelm@6640
   391
  in
wenzelm@6640
   392
    (case fin_scan chs of
wenzelm@6640
   393
      (result, []) => result
skalberg@15531
   394
    | (_, rest) => error (message (rest, NONE)))
wenzelm@6640
   395
  end;
wenzelm@6640
   396
wenzelm@21858
   397
val scan_id = Scan.one is_letter ^^ (Scan.many is_letdig >> implode);
wenzelm@14678
   398
wenzelm@23676
   399
wenzelm@23676
   400
(* source *)
wenzelm@23676
   401
wenzelm@14678
   402
local
schirmer@14561
   403
wenzelm@23676
   404
fun is_plain s = s <> "\^M" andalso s <> "\\" andalso not_eof s;
wenzelm@23676
   405
wenzelm@14678
   406
val scan_encoded_newline =
wenzelm@17756
   407
  $$ "\^M" -- $$ "\n" >> K "\n" ||
wenzelm@17756
   408
  $$ "\^M" >> K "\n" ||
wenzelm@14956
   409
  $$ "\\" -- Scan.optional ($$ "\\") "" -- Scan.this_string "<^newline>" >> K "\n";
wenzelm@14956
   410
wenzelm@14956
   411
val scan_raw =
wenzelm@21858
   412
  Scan.this_string "raw:" ^^ (Scan.many raw_chr >> implode) ||
wenzelm@21858
   413
  Scan.this_string "raw" ^^ (Scan.many1 is_ascii_digit >> implode);
wenzelm@14678
   414
wenzelm@23676
   415
val scan =
wenzelm@23676
   416
  Scan.one is_plain ||
wenzelm@23676
   417
  scan_encoded_newline ||
wenzelm@23676
   418
  (($$ "\\" --| Scan.optional ($$ "\\") "") ^^ $$ "<" ^^
wenzelm@23676
   419
    !! (fn (cs, _) => malformed_msg (beginning 10 ("\\" :: "<" :: cs)))
wenzelm@23676
   420
      (($$ "^" ^^ (scan_raw || scan_id) || scan_id) ^^ $$ ">")) ||
wenzelm@23676
   421
  Scan.one not_eof;
wenzelm@23676
   422
wenzelm@23676
   423
val recover =
wenzelm@23676
   424
  Scan.many (fn s => not (is_blank s) andalso s <> "\"" andalso not_eof s)
wenzelm@23676
   425
    >> (fn ss => malformed :: ss @ [end_malformed]);
wenzelm@23676
   426
wenzelm@14678
   427
in
wenzelm@6116
   428
wenzelm@23676
   429
fun source do_recover src =
wenzelm@23682
   430
  Source.source stopper (Scan.bulk scan)
wenzelm@23682
   431
    (if do_recover then SOME (false, K recover) else NONE) src;
wenzelm@6116
   432
wenzelm@14678
   433
end;
wenzelm@14678
   434
wenzelm@14562
   435
wenzelm@23676
   436
(* explode *)
wenzelm@6116
   437
wenzelm@23676
   438
local
wenzelm@6116
   439
wenzelm@14562
   440
fun no_explode [] = true
wenzelm@14562
   441
  | no_explode ("\\" :: "<" :: _) = false
wenzelm@17756
   442
  | no_explode ("\^M" :: _) = false
wenzelm@14562
   443
  | no_explode (_ :: cs) = no_explode cs;
wenzelm@6116
   444
wenzelm@23676
   445
in
wenzelm@23676
   446
wenzelm@6116
   447
fun sym_explode str =
wenzelm@6116
   448
  let val chs = explode str in
wenzelm@14562
   449
    if no_explode chs then chs
wenzelm@23676
   450
    else Source.exhaust (source false (Source.of_list chs))
wenzelm@6116
   451
  end;
wenzelm@6116
   452
wenzelm@23676
   453
end;
wenzelm@14994
   454
wenzelm@6116
   455
wenzelm@14977
   456
(* escape *)
wenzelm@14977
   457
wenzelm@14977
   458
val escape = implode o map (fn s => if is_char s then s else "\\" ^ s) o sym_explode;
wenzelm@14977
   459
wenzelm@14977
   460
wenzelm@14678
   461
(* blanks *)
wenzelm@14678
   462
wenzelm@14678
   463
fun strip_blanks s =
wenzelm@14678
   464
  sym_explode s
wenzelm@14678
   465
  |> Library.take_prefix is_blank |> #2
wenzelm@14678
   466
  |> Library.take_suffix is_blank |> #1
wenzelm@14678
   467
  |> implode;
wenzelm@14678
   468
wenzelm@14678
   469
wenzelm@14678
   470
(* bump string -- treat as base 26 or base 1 numbers *)
wenzelm@14678
   471
wenzelm@15979
   472
fun symbolic_end (_ :: "\\<^isub>" :: _) = true
wenzelm@15979
   473
  | symbolic_end (_ :: "\\<^isup>" :: _) = true
wenzelm@14908
   474
  | symbolic_end (s :: _) = is_symbolic s
wenzelm@14908
   475
  | symbolic_end [] = false;
wenzelm@14678
   476
wenzelm@14678
   477
fun bump_init str =
wenzelm@14908
   478
  if symbolic_end (rev (sym_explode str)) then str ^ "'"
wenzelm@14678
   479
  else str ^ "a";
wenzelm@12904
   480
wenzelm@12904
   481
fun bump_string str =
wenzelm@12904
   482
  let
wenzelm@12904
   483
    fun bump [] = ["a"]
wenzelm@12904
   484
      | bump ("z" :: ss) = "a" :: bump ss
wenzelm@12904
   485
      | bump (s :: ss) =
wenzelm@14678
   486
          if is_char s andalso ord "a" <= ord s andalso ord s < ord "z"
wenzelm@12904
   487
          then chr (ord s + 1) :: ss
wenzelm@12904
   488
          else "a" :: s :: ss;
wenzelm@14678
   489
wenzelm@14678
   490
    val (ss, qs) = apfst rev (Library.take_suffix is_quasi (sym_explode str));
wenzelm@14908
   491
    val ss' = if symbolic_end ss then "'" :: ss else bump ss;
wenzelm@14678
   492
  in implode (rev ss' @ qs) end;
wenzelm@14678
   493
wenzelm@12904
   494
wenzelm@6272
   495
wenzelm@23618
   496
(** xsymbols **)
wenzelm@14977
   497
wenzelm@14977
   498
val xsymbolsN = "xsymbols";
wenzelm@6272
   499
wenzelm@14678
   500
fun sym_len s =
wenzelm@14678
   501
  if not (is_printable s) then 0
wenzelm@14678
   502
  else if String.isPrefix "\\<long" s then 2
wenzelm@14678
   503
  else if String.isPrefix "\\<Long" s then 2
wenzelm@14678
   504
  else if s = "\\<spacespace>" then 2
wenzelm@14678
   505
  else 1;
wenzelm@14678
   506
wenzelm@19473
   507
fun sym_length ss = fold (fn s => fn n => sym_len s + n) ss 0;
wenzelm@14678
   508
wenzelm@6116
   509
(*final declarations of this structure!*)
wenzelm@6272
   510
val length = sym_length;
wenzelm@6116
   511
val explode = sym_explode;
wenzelm@6116
   512
wenzelm@6116
   513
end;