src/Pure/name.ML
author wenzelm
Thu Mar 06 10:12:47 2014 +0100 (2014-03-06)
changeset 55948 bb21b380f65d
parent 43683 b5d1873449fb
child 55949 4766342e8376
permissions -rw-r--r--
tuned signature;
wenzelm@20089
     1
(*  Title:      Pure/name.ML
wenzelm@20089
     2
    Author:     Makarius
wenzelm@20089
     3
haftmann@28965
     4
Names of basic logical entities (variables etc.).
wenzelm@20089
     5
*)
wenzelm@20089
     6
wenzelm@20089
     7
signature NAME =
wenzelm@20089
     8
sig
wenzelm@24849
     9
  val uu: string
wenzelm@43683
    10
  val uu_: string
wenzelm@24849
    11
  val aT: string
wenzelm@20089
    12
  val bound: int -> string
wenzelm@20089
    13
  val is_bound: string -> bool
wenzelm@20089
    14
  val internal: string -> string
wenzelm@20089
    15
  val dest_internal: string -> string
wenzelm@55948
    16
  val is_internal: string -> bool
wenzelm@20089
    17
  val skolem: string -> string
wenzelm@20089
    18
  val dest_skolem: string -> string
wenzelm@55948
    19
  val is_skolem: string -> bool
wenzelm@20089
    20
  val clean_index: string * int -> string * int
wenzelm@20089
    21
  val clean: string -> string
wenzelm@20089
    22
  type context
wenzelm@20089
    23
  val context: context
wenzelm@20158
    24
  val make_context: string list -> context
wenzelm@20089
    25
  val declare: string -> context -> context
wenzelm@20158
    26
  val is_declared: context -> string -> bool
wenzelm@43329
    27
  val invent: context -> string -> int -> string list
wenzelm@43329
    28
  val invent_names: context -> string -> 'a list -> (string * 'a) list
wenzelm@20089
    29
  val invent_list: string list -> string -> int -> string list
wenzelm@43326
    30
  val variant: string -> context -> string * context
wenzelm@20089
    31
  val variant_list: string list -> string list -> string list
haftmann@31035
    32
  val desymbolize: bool -> string -> string
wenzelm@20089
    33
end;
wenzelm@20089
    34
wenzelm@20089
    35
structure Name: NAME =
wenzelm@20089
    36
struct
wenzelm@20089
    37
wenzelm@24849
    38
(** common defaults **)
wenzelm@24849
    39
wenzelm@24849
    40
val uu = "uu";
wenzelm@43683
    41
val uu_ = "uu_";
wenzelm@24849
    42
val aT = "'a";
wenzelm@24849
    43
wenzelm@24849
    44
wenzelm@20089
    45
wenzelm@20089
    46
(** special variable names **)
wenzelm@20089
    47
wenzelm@20089
    48
(* encoded bounds *)
wenzelm@20089
    49
wenzelm@20089
    50
(*names for numbered variables --
wenzelm@20089
    51
  preserves order wrt. int_ord vs. string_ord, avoids allocating new strings*)
wenzelm@20089
    52
wenzelm@20089
    53
val small_int = Vector.tabulate (1000, fn i =>
wenzelm@20089
    54
  let val leading = if i < 10 then "00" else if i < 100 then "0" else ""
wenzelm@20089
    55
  in ":" ^ leading ^ string_of_int i end);
wenzelm@20089
    56
wenzelm@20089
    57
fun bound n =
wenzelm@20089
    58
  if n < 1000 then Vector.sub (small_int, n)
wenzelm@20089
    59
  else ":" ^ bound (n div 1000) ^ Vector.sub (small_int, n mod 1000);
wenzelm@20089
    60
wenzelm@20089
    61
val is_bound = String.isPrefix ":";
wenzelm@20089
    62
wenzelm@20089
    63
wenzelm@20089
    64
(* internal names *)
wenzelm@20089
    65
wenzelm@20089
    66
val internal = suffix "_";
wenzelm@20089
    67
val dest_internal = unsuffix "_";
wenzelm@55948
    68
val is_internal = String.isSuffix "_";
wenzelm@20089
    69
wenzelm@20089
    70
val skolem = suffix "__";
wenzelm@20089
    71
val dest_skolem = unsuffix "__";
wenzelm@55948
    72
val is_skolem = String.isSuffix "__";
wenzelm@20089
    73
wenzelm@20099
    74
fun clean_index (x, i) =
wenzelm@20099
    75
  (case try dest_internal x of
wenzelm@20099
    76
    NONE => (x, i)
wenzelm@20099
    77
  | SOME x' => clean_index (x', i + 1));
wenzelm@20089
    78
wenzelm@20089
    79
fun clean x = #1 (clean_index (x, 0));
wenzelm@20089
    80
wenzelm@20089
    81
wenzelm@20089
    82
wenzelm@20089
    83
(** generating fresh names **)
wenzelm@20089
    84
wenzelm@20089
    85
(* context *)
wenzelm@20089
    86
wenzelm@20089
    87
datatype context =
wenzelm@20089
    88
  Context of string option Symtab.table;    (*declared names with latest renaming*)
wenzelm@20089
    89
wenzelm@20099
    90
fun declare x (Context tab) =
wenzelm@20099
    91
  Context (Symtab.default (clean x, NONE) tab);
wenzelm@20099
    92
wenzelm@20099
    93
fun declare_renaming (x, x') (Context tab) =
wenzelm@20099
    94
  Context (Symtab.update (clean x, SOME (clean x')) tab);
wenzelm@20089
    95
wenzelm@20158
    96
fun is_declared (Context tab) = Symtab.defined tab;
wenzelm@20089
    97
fun declared (Context tab) = Symtab.lookup tab;
wenzelm@20089
    98
wenzelm@20121
    99
val context = Context Symtab.empty |> fold declare ["", "'"];
wenzelm@20089
   100
fun make_context used = fold declare used context;
wenzelm@20089
   101
wenzelm@20089
   102
wenzelm@43329
   103
(* invent names *)
wenzelm@20089
   104
wenzelm@43329
   105
fun invent ctxt =
wenzelm@20089
   106
  let
wenzelm@20089
   107
    fun invs _ 0 = []
wenzelm@20089
   108
      | invs x n =
wenzelm@43329
   109
          let val x' = Symbol.bump_string x
wenzelm@43329
   110
          in if is_declared ctxt x then invs x' n else x :: invs x' (n - 1) end;
wenzelm@20099
   111
  in invs o clean end;
wenzelm@20089
   112
wenzelm@43329
   113
fun invent_names ctxt x xs = invent ctxt x (length xs) ~~ xs;
wenzelm@20198
   114
wenzelm@43329
   115
val invent_list = invent o make_context;
wenzelm@20089
   116
wenzelm@20089
   117
wenzelm@20089
   118
(* variants *)
wenzelm@20089
   119
wenzelm@20089
   120
(*makes a variant of a name distinct from already used names in a
wenzelm@20089
   121
  context; preserves a suffix of underscores "_"*)
wenzelm@43326
   122
fun variant name ctxt =
wenzelm@20089
   123
  let
wenzelm@20089
   124
    fun vary x =
wenzelm@20089
   125
      (case declared ctxt x of
wenzelm@20089
   126
        NONE => x
wenzelm@20089
   127
      | SOME x' => vary (Symbol.bump_string (the_default x x')));
wenzelm@20089
   128
wenzelm@20121
   129
    val (x, n) = clean_index (name, 0);
wenzelm@20089
   130
    val (x', ctxt') =
wenzelm@20158
   131
      if not (is_declared ctxt x) then (x, declare x ctxt)
wenzelm@20089
   132
      else
wenzelm@20089
   133
        let
wenzelm@20089
   134
          val x0 = Symbol.bump_init x;
wenzelm@20089
   135
          val x' = vary x0;
wenzelm@20089
   136
          val ctxt' = ctxt
wenzelm@21565
   137
            |> x0 <> x' ? declare_renaming (x0, x')
wenzelm@20089
   138
            |> declare x';
wenzelm@20089
   139
        in (x', ctxt') end;
wenzelm@43326
   140
  in (x' ^ replicate_string n "_", ctxt') end;
wenzelm@20089
   141
wenzelm@43326
   142
fun variant_list used names = #1 (make_context used |> fold_map variant names);
wenzelm@20089
   143
haftmann@31013
   144
haftmann@31035
   145
(* names conforming to typical requirements of identifiers in the world outside *)
haftmann@31013
   146
haftmann@31035
   147
fun desymbolize upper "" = if upper then "X" else "x"
haftmann@31035
   148
  | desymbolize upper s =
haftmann@31013
   149
      let
haftmann@31035
   150
        val xs as (x :: _) = Symbol.explode s;
wenzelm@33547
   151
        val ys =
wenzelm@33547
   152
          if Symbol.is_ascii_letter x orelse Symbol.is_symbolic x then xs
haftmann@31013
   153
          else "x" :: xs;
haftmann@31013
   154
        fun is_valid x =
haftmann@34307
   155
          Symbol.is_ascii_letter x orelse Symbol.is_ascii_digit x;
haftmann@31013
   156
        fun sep [] = []
haftmann@31013
   157
          | sep (xs as "_" :: _) = xs
haftmann@31013
   158
          | sep xs = "_" :: xs;
haftmann@31035
   159
        fun desep ("_" :: xs) = xs
haftmann@31035
   160
          | desep xs = xs;
wenzelm@33547
   161
        fun desymb x xs =
wenzelm@33547
   162
          if is_valid x then x :: xs
haftmann@31013
   163
          else
wenzelm@33547
   164
            (case Symbol.decode x of
wenzelm@40627
   165
              Symbol.Sym name => "_" :: raw_explode name @ sep xs
wenzelm@33547
   166
            | _ => sep xs);
wenzelm@33547
   167
        fun upper_lower cs =
wenzelm@33547
   168
          if upper then nth_map 0 Symbol.to_ascii_upper cs
wenzelm@33547
   169
          else
wenzelm@33547
   170
            (if forall Symbol.is_ascii_upper cs then map else nth_map 0)
wenzelm@33547
   171
              Symbol.to_ascii_lower cs;
haftmann@31035
   172
      in fold_rev desymb ys [] |> desep |> upper_lower |> implode end;
haftmann@31013
   173
wenzelm@20089
   174
end;