src/Pure/General/name_space.ML
author wenzelm
Sun Jun 05 11:31:25 2005 +0200 (2005-06-05)
changeset 16262 bd1b38f57fc7
parent 16137 00e9ca1e7261
child 16341 e573e5167eda
permissions -rw-r--r--
no warning for non-identifiers;
wenzelm@6118
     1
(*  Title:      Pure/General/name_space.ML
wenzelm@5012
     2
    ID:         $Id$
wenzelm@5012
     3
    Author:     Markus Wenzel, TU Muenchen
wenzelm@5012
     4
wenzelm@16137
     5
Generic name spaces with declared and hidden entries.  Unknown names
wenzelm@16137
     6
are considered as global; no support for absolute addressing.
wenzelm@16137
     7
*)
wenzelm@16137
     8
wenzelm@16137
     9
type bstring = string;    (*names to be bound / internalized*)
wenzelm@16137
    10
type xstring = string;    (*externalized names / to be printed*)
wenzelm@5012
    11
wenzelm@16137
    12
signature BASIC_NAME_SPACE =
wenzelm@16137
    13
sig
wenzelm@16137
    14
  val long_names: bool ref
wenzelm@16137
    15
  val short_names: bool ref
wenzelm@16137
    16
  val unique_names: bool ref
wenzelm@16137
    17
end;
wenzelm@5012
    18
wenzelm@5012
    19
signature NAME_SPACE =
wenzelm@5012
    20
sig
wenzelm@16137
    21
  include BASIC_NAME_SPACE
wenzelm@9120
    22
  val hidden: string -> string
wenzelm@16137
    23
  val separator: string                 (*single char*)
wenzelm@16137
    24
  val is_qualified: string -> bool
wenzelm@16137
    25
  val pack: string list -> string
wenzelm@5012
    26
  val unpack: string -> string list
wenzelm@16137
    27
  val append: string -> string -> string
wenzelm@16137
    28
  val qualified: string -> string -> string
wenzelm@5012
    29
  val base: string -> string
wenzelm@16137
    30
  val drop_base: string -> string
wenzelm@11829
    31
  val map_base: (string -> string) -> string -> string
wenzelm@16137
    32
  val suffixes_prefixes: 'a list -> 'a list list
wenzelm@5012
    33
  val accesses: string -> string list
wenzelm@13332
    34
  val accesses': string -> string list
wenzelm@5012
    35
  type T
wenzelm@5012
    36
  val empty: T
wenzelm@16137
    37
  val valid_accesses: T -> string -> xstring list
wenzelm@16137
    38
  val intern: T -> xstring -> string
wenzelm@16137
    39
  val extern: T -> string -> xstring
wenzelm@16137
    40
  val extern_table: T -> 'a Symtab.table -> (xstring * 'a) list
wenzelm@16137
    41
  val hide: bool -> string -> T -> T
wenzelm@5012
    42
  val merge: T * T -> T
wenzelm@16137
    43
  val dest: T -> (string * xstring list) list
wenzelm@16137
    44
  type naming
wenzelm@16137
    45
  val path_of: naming -> string
wenzelm@16137
    46
  val full: naming -> bstring -> string
wenzelm@16137
    47
  val declare: naming -> string -> T -> T
wenzelm@16137
    48
  val default_naming: naming
wenzelm@16137
    49
  val add_path: string -> naming -> naming
wenzelm@16137
    50
  val qualified_names: naming -> naming
wenzelm@16137
    51
  val no_base_names: naming -> naming
wenzelm@16137
    52
  val custom_accesses: (string list -> string list list) -> naming -> naming
wenzelm@16137
    53
  val set_policy: (string -> bstring -> string) * (string list -> string list list) ->
wenzelm@16137
    54
    naming -> naming
wenzelm@5012
    55
end;
wenzelm@5012
    56
wenzelm@5012
    57
structure NameSpace: NAME_SPACE =
wenzelm@5012
    58
struct
wenzelm@5012
    59
wenzelm@5012
    60
(** long identifiers **)
wenzelm@5012
    61
wenzelm@16137
    62
fun hidden name = "??." ^ name;
wenzelm@16137
    63
val is_hidden = String.isPrefix "??."
wenzelm@16137
    64
wenzelm@5012
    65
val separator = ".";
wenzelm@16137
    66
val is_qualified = exists_string (equal separator);
wenzelm@5012
    67
wenzelm@16137
    68
val pack = space_implode separator;
wenzelm@5012
    69
val unpack = space_explode separator;
wenzelm@5012
    70
wenzelm@16137
    71
fun append name1 "" = name1
wenzelm@16137
    72
  | append "" name2 = name2
wenzelm@16137
    73
  | append name1 name2 = name1 ^ separator ^ name2;
wenzelm@16137
    74
wenzelm@16137
    75
fun qualified path name =
wenzelm@16137
    76
  if path = "" orelse name = "" then name
wenzelm@16137
    77
  else path ^ separator ^ name;
wenzelm@11829
    78
wenzelm@16137
    79
fun base "" = ""
wenzelm@16137
    80
  | base name = List.last (unpack name);
wenzelm@11829
    81
wenzelm@16137
    82
fun drop_base "" = ""
wenzelm@16137
    83
  | drop_base name = pack (#1 (split_last (unpack name)));
wenzelm@5012
    84
wenzelm@16137
    85
fun map_base _ "" = ""
wenzelm@16137
    86
  | map_base f name =
wenzelm@16137
    87
      let val names = unpack name
wenzelm@16137
    88
      in pack (map_nth_elem (length names - 1) f names) end;
wenzelm@16137
    89
wenzelm@16137
    90
fun suffixes_prefixes xs =
wenzelm@5012
    91
  let
wenzelm@16137
    92
    val (qs, b) = split_last xs;
wenzelm@16137
    93
    val sfxs = Library.suffixes1 xs;
wenzelm@16137
    94
    val pfxs = map (fn x => x @ [b]) (Library.prefixes1 qs);
wenzelm@16137
    95
  in sfxs @ pfxs end;
wenzelm@5012
    96
wenzelm@16137
    97
val accesses = map pack o suffixes_prefixes o unpack;
wenzelm@13332
    98
val accesses' = map pack o Library.suffixes1 o unpack;
wenzelm@13332
    99
wenzelm@5012
   100
wenzelm@5012
   101
wenzelm@5012
   102
(** name spaces **)
wenzelm@5012
   103
wenzelm@5012
   104
(* datatype T *)
wenzelm@5012
   105
wenzelm@5012
   106
datatype T =
wenzelm@8728
   107
  NameSpace of (string list * string list) Symtab.table;
wenzelm@5012
   108
wenzelm@5012
   109
val empty = NameSpace Symtab.empty;
wenzelm@5012
   110
wenzelm@16137
   111
fun lookup (NameSpace tab) xname =
wenzelm@16137
   112
  (case Symtab.lookup (tab, xname) of
wenzelm@16137
   113
    NONE => (xname, true)
wenzelm@16137
   114
  | SOME ([], []) => (xname, true)
wenzelm@16137
   115
  | SOME ([name], _) => (name, true)
wenzelm@16137
   116
  | SOME (name :: _, _) => (name, false)
wenzelm@16137
   117
  | SOME ([], name' :: _) => (hidden name', true));
wenzelm@8728
   118
wenzelm@16137
   119
fun valid_accesses (NameSpace tab) name =
wenzelm@16137
   120
  ([], tab) |> Symtab.foldl (fn (accs, (xname, (names, _))) =>
wenzelm@16137
   121
    if null names orelse hd names <> name then accs else xname :: accs);
wenzelm@8728
   122
wenzelm@8728
   123
wenzelm@16137
   124
(* intern and extern *)
wenzelm@16137
   125
wenzelm@16137
   126
fun intern space xname = #1 (lookup space xname);
wenzelm@16137
   127
wenzelm@16137
   128
val long_names = ref false;
wenzelm@16137
   129
val short_names = ref false;
wenzelm@16137
   130
val unique_names = ref true;
wenzelm@16137
   131
wenzelm@16137
   132
fun extern space name =
wenzelm@16137
   133
  let
wenzelm@16137
   134
    fun valid unique xname =
wenzelm@16137
   135
      let val (name', uniq) = lookup space xname
wenzelm@16137
   136
      in name = name' andalso (uniq orelse (not unique)) end;
wenzelm@8728
   137
wenzelm@16137
   138
    fun ex [] = if valid false name then name else hidden name
wenzelm@16137
   139
      | ex (nm :: nms) = if valid (! unique_names) nm then nm else ex nms;
wenzelm@16137
   140
  in
wenzelm@16137
   141
    if ! long_names then name
wenzelm@16137
   142
    else if ! short_names then base name
wenzelm@16137
   143
    else ex (accesses' name)
wenzelm@16137
   144
  end;
wenzelm@16137
   145
wenzelm@16137
   146
fun extern_table space tab =
wenzelm@16137
   147
  Library.sort_wrt #1 (map (apfst (extern space)) (Symtab.dest tab));
wenzelm@16137
   148
wenzelm@5012
   149
wenzelm@16137
   150
(* basic operations *)
wenzelm@16137
   151
wenzelm@16137
   152
fun map_space f xname (NameSpace tab) =
wenzelm@16137
   153
  NameSpace (Symtab.update ((xname, f (if_none (Symtab.lookup (tab, xname)) ([], []))), tab));
wenzelm@16137
   154
wenzelm@16137
   155
fun del (name: string) = remove (op =) name;
wenzelm@16137
   156
fun add name names = name :: del name names;
wenzelm@16137
   157
wenzelm@16137
   158
val del_name = map_space o apfst o del;
wenzelm@16137
   159
val add_name = map_space o apfst o add;
wenzelm@16137
   160
val add_name' = map_space o apsnd o add;
wenzelm@8728
   161
wenzelm@8728
   162
wenzelm@8728
   163
(* hide *)
wenzelm@5012
   164
wenzelm@16137
   165
fun hide fully name space =
wenzelm@8728
   166
  if not (is_qualified name) then
wenzelm@8728
   167
    error ("Attempt to hide global name " ^ quote name)
wenzelm@8728
   168
  else if is_hidden name then
wenzelm@8728
   169
    error ("Attempt to hide hidden name " ^ quote name)
wenzelm@16137
   170
  else
wenzelm@16137
   171
    let val names = valid_accesses space name in
wenzelm@16137
   172
      space
wenzelm@16137
   173
      |> add_name' name name
wenzelm@16137
   174
      |> fold (del_name name) (if fully then names else names inter_string [base name])
wenzelm@16137
   175
    end;
wenzelm@5012
   176
wenzelm@5012
   177
wenzelm@16137
   178
(* merge *)
wenzelm@5012
   179
wenzelm@16137
   180
fun merge (NameSpace tab1, space2) = (space2, tab1) |> Symtab.foldl
wenzelm@16137
   181
  (fn (space, (xname, (names1, names1'))) =>
wenzelm@16137
   182
    map_space (fn (names2, names2') =>
wenzelm@16137
   183
      (merge_lists' names2 names1, merge_lists' names2' names1')) xname space);
wenzelm@6845
   184
wenzelm@5012
   185
wenzelm@5012
   186
(* dest *)
wenzelm@5012
   187
skalberg@15531
   188
fun dest_entry (xname, ([], _)) = NONE
skalberg@15531
   189
  | dest_entry (xname, (name :: _, _)) = SOME (name, xname);
wenzelm@8728
   190
wenzelm@5012
   191
fun dest (NameSpace tab) =
wenzelm@5012
   192
  map (apsnd (sort (int_ord o pairself size)))
skalberg@15570
   193
    (Symtab.dest (Symtab.make_multi (List.mapPartial dest_entry (Symtab.dest tab))));
wenzelm@5012
   194
wenzelm@5012
   195
wenzelm@16137
   196
wenzelm@16137
   197
(** naming contexts **)
wenzelm@16137
   198
wenzelm@16137
   199
(* datatype naming *)
wenzelm@16137
   200
wenzelm@16137
   201
datatype naming = Naming of
wenzelm@16137
   202
  string * ((string -> string -> string) * (string list -> string list list));
wenzelm@16137
   203
wenzelm@16137
   204
fun path_of (Naming (path, _)) = path;
wenzelm@16137
   205
wenzelm@16137
   206
wenzelm@16137
   207
(* declarations *)
wenzelm@16137
   208
wenzelm@16137
   209
fun full (Naming (path, (qualify, _))) = qualify path;
wenzelm@16137
   210
wenzelm@16137
   211
fun declare (Naming (_, (_, accs))) name space =
wenzelm@16137
   212
  if is_hidden name then
wenzelm@16137
   213
    error ("Attempt to declare hidden name " ^ quote name)
wenzelm@16137
   214
  else
wenzelm@16137
   215
    let val names = unpack name in
wenzelm@16137
   216
      conditional (null names orelse exists (equal "") names) (fn () =>
wenzelm@16137
   217
        error ("Bad name declaration " ^ quote name));
wenzelm@16137
   218
      fold (add_name name) (map pack (accs names)) space
wenzelm@16137
   219
    end;
wenzelm@16137
   220
wenzelm@16137
   221
wenzelm@16137
   222
(* manipulate namings *)
wenzelm@16137
   223
wenzelm@16137
   224
fun reject_qualified name =
wenzelm@16137
   225
  if is_qualified name then
wenzelm@16137
   226
    error ("Attempt to declare qualified name " ^ quote name)
wenzelm@16137
   227
  else name;
wenzelm@16137
   228
wenzelm@16137
   229
val default_naming =
wenzelm@16137
   230
  Naming ("", (fn path => qualified path o reject_qualified, suffixes_prefixes));
wenzelm@16137
   231
wenzelm@16137
   232
fun add_path elems (Naming (path, policy)) =
wenzelm@16137
   233
  if elems = "//" then Naming ("", (qualified, #2 policy))
wenzelm@16137
   234
  else if elems = "/" then Naming ("", policy)
wenzelm@16137
   235
  else if elems = ".." then Naming (drop_base path, policy)
wenzelm@16137
   236
  else Naming (append path elems, policy);
wenzelm@16137
   237
wenzelm@16137
   238
fun qualified_names (Naming (path, (_, accs))) = Naming (path, (qualified, accs));
wenzelm@16137
   239
wenzelm@16137
   240
fun no_base_names (Naming (path, (qualify, accs))) =
wenzelm@16137
   241
  Naming (path, (qualify, filter_out (fn [_] => true | _ => false) o accs));
wenzelm@16137
   242
wenzelm@16137
   243
fun custom_accesses accs (Naming (path, (qualify, _))) = Naming (path, (qualify, accs));
wenzelm@16137
   244
fun set_policy policy (Naming (path, _)) = Naming (path, policy);
wenzelm@16137
   245
wenzelm@16137
   246
wenzelm@5012
   247
end;
wenzelm@5175
   248
wenzelm@16137
   249
structure BasicNameSpace: BASIC_NAME_SPACE = NameSpace;
wenzelm@16137
   250
open BasicNameSpace;