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