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