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