Commit | Line | Data |
---|---|---|
7426a638 | 1 | /* Copyright (C) 1995,1996,1997,1998,2000,2001, 2003, 2004 Free Software Foundation, Inc. |
0f2d19dd | 2 | * |
73be1d9e MV |
3 | * This library is free software; you can redistribute it and/or |
4 | * modify it under the terms of the GNU Lesser General Public | |
5 | * License as published by the Free Software Foundation; either | |
6 | * version 2.1 of the License, or (at your option) any later version. | |
0f2d19dd | 7 | * |
73be1d9e MV |
8 | * This library is distributed in the hope that it will be useful, |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
11 | * Lesser General Public License for more details. | |
0f2d19dd | 12 | * |
73be1d9e MV |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the Free Software | |
15 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
16 | */ | |
1bbd0b84 | 17 | |
1bbd0b84 | 18 | |
0f2d19dd | 19 | \f |
cf007485 RB |
20 | #if HAVE_CONFIG_H |
21 | # include <config.h> | |
22 | #endif | |
0f2d19dd | 23 | |
a0599745 MD |
24 | #include "libguile/_scm.h" |
25 | #include "libguile/chars.h" | |
26 | #include "libguile/eval.h" | |
ba393257 | 27 | #include "libguile/hash.h" |
fb43bf74 | 28 | #include "libguile/smob.h" |
a0599745 MD |
29 | #include "libguile/variable.h" |
30 | #include "libguile/alist.h" | |
7e73eaee | 31 | #include "libguile/fluids.h" |
a0599745 MD |
32 | #include "libguile/strings.h" |
33 | #include "libguile/vectors.h" | |
00ffa0e7 | 34 | #include "libguile/hashtab.h" |
a0599745 | 35 | #include "libguile/weaks.h" |
eb8db440 | 36 | #include "libguile/modules.h" |
1206efbe MV |
37 | #include "libguile/read.h" |
38 | #include "libguile/srfi-13.h" | |
a0599745 MD |
39 | |
40 | #include "libguile/validate.h" | |
41 | #include "libguile/symbols.h" | |
0f2d19dd | 42 | |
95b88819 GH |
43 | #ifdef HAVE_STRING_H |
44 | #include <string.h> | |
45 | #endif | |
46 | ||
0f2d19dd JB |
47 | \f |
48 | ||
0f979f3f DH |
49 | static SCM symbols; |
50 | ||
a4c91488 MD |
51 | #ifdef GUILE_DEBUG |
52 | SCM_DEFINE (scm_sys_symbols, "%symbols", 0, 0, 0, | |
53 | (), | |
54 | "Return the system symbol obarray.") | |
55 | #define FUNC_NAME s_scm_sys_symbols | |
56 | { | |
57 | return symbols; | |
58 | } | |
59 | #undef FUNC_NAME | |
60 | #endif | |
61 | ||
0f979f3f DH |
62 | \f |
63 | ||
0f2d19dd JB |
64 | /* {Symbols} |
65 | */ | |
66 | ||
c35738c1 MD |
67 | /* In order to optimize reading speed, this function breaks part of |
68 | * the hashtable abstraction. The optimizations are: | |
69 | * | |
70 | * 1. The argument string can be compared directly to symbol objects | |
71 | * without first creating an SCM string object. (This would have | |
72 | * been necessary if we had used the hashtable API in hashtab.h.) | |
73 | * | |
3ee86942 | 74 | * 2. We can use the raw hash value stored in scm_i_symbol_hash (sym) |
c35738c1 MD |
75 | * to speed up lookup. |
76 | * | |
77 | * Both optimizations might be possible without breaking the | |
78 | * abstraction if the API in hashtab.c is improved. | |
79 | */ | |
80 | ||
81 | unsigned long | |
82 | scm_i_hash_symbol (SCM obj, unsigned long n, void *closure) | |
83 | { | |
3ee86942 | 84 | return scm_i_symbol_hash (obj) % n; |
c35738c1 | 85 | } |
1cc91f1b | 86 | |
3ee86942 MV |
87 | static SCM |
88 | scm_i_mem2symbol (SCM str) | |
b52e071b | 89 | { |
3ee86942 MV |
90 | const char *name = scm_i_string_chars (str); |
91 | size_t len = scm_i_string_length (str); | |
92 | ||
c35738c1 MD |
93 | size_t raw_hash = scm_string_hash ((const unsigned char *) name, len) / 2; |
94 | size_t hash = raw_hash % SCM_HASHTABLE_N_BUCKETS (symbols); | |
b52e071b DH |
95 | |
96 | { | |
0f979f3f | 97 | /* Try to find the symbol in the symbols table */ |
b52e071b DH |
98 | |
99 | SCM l; | |
100 | ||
c35738c1 MD |
101 | for (l = SCM_HASHTABLE_BUCKETS (symbols) [hash]; |
102 | !SCM_NULLP (l); | |
103 | l = SCM_CDR (l)) | |
b52e071b | 104 | { |
a7a59ea9 | 105 | SCM sym = SCM_CAAR (l); |
3ee86942 MV |
106 | if (scm_i_symbol_hash (sym) == raw_hash |
107 | && scm_i_symbol_length (sym) == len) | |
b52e071b | 108 | { |
3ee86942 | 109 | const char *chrs = scm_i_symbol_chars (sym); |
1be6b49c | 110 | size_t i = len; |
b52e071b DH |
111 | |
112 | while (i != 0) | |
113 | { | |
114 | --i; | |
115 | if (name[i] != chrs[i]) | |
116 | goto next_symbol; | |
117 | } | |
118 | ||
119 | return sym; | |
120 | } | |
121 | next_symbol: | |
8d5a2737 | 122 | ; |
b52e071b DH |
123 | } |
124 | } | |
125 | ||
126 | { | |
127 | /* The symbol was not found - create it. */ | |
3ee86942 MV |
128 | SCM symbol = scm_i_make_symbol (str, raw_hash, |
129 | scm_cons (SCM_BOOL_F, SCM_EOL)); | |
b52e071b | 130 | |
c35738c1 | 131 | SCM slot = SCM_HASHTABLE_BUCKETS (symbols) [hash]; |
c8a1bdc4 | 132 | SCM cell = scm_cons (symbol, SCM_UNDEFINED); |
c35738c1 MD |
133 | SCM_SET_HASHTABLE_BUCKET (symbols, hash, scm_cons (cell, slot)); |
134 | SCM_HASHTABLE_INCREMENT (symbols); | |
135 | if (SCM_HASHTABLE_N_ITEMS (symbols) > SCM_HASHTABLE_UPPER (symbols)) | |
136 | scm_i_rehash (symbols, scm_i_hash_symbol, 0, "scm_mem2symbol"); | |
b52e071b DH |
137 | |
138 | return symbol; | |
139 | } | |
140 | } | |
141 | ||
3ee86942 MV |
142 | static SCM |
143 | scm_i_mem2uninterned_symbol (SCM str) | |
ac48757b | 144 | { |
3ee86942 MV |
145 | const char *name = scm_i_string_chars (str); |
146 | size_t len = scm_i_string_length (str); | |
147 | ||
ac48757b MV |
148 | size_t raw_hash = (scm_string_hash ((const unsigned char *) name, len)/2 |
149 | + SCM_T_BITS_MAX/2 + 1); | |
150 | ||
3ee86942 MV |
151 | return scm_i_make_symbol (str, raw_hash, |
152 | scm_cons (SCM_BOOL_F, SCM_EOL)); | |
b52e071b DH |
153 | } |
154 | ||
3b3b36dd | 155 | SCM_DEFINE (scm_symbol_p, "symbol?", 1, 0, 0, |
8e93e199 | 156 | (SCM obj), |
1e6808ea MG |
157 | "Return @code{#t} if @var{obj} is a symbol, otherwise return\n" |
158 | "@code{#f}.") | |
1bbd0b84 | 159 | #define FUNC_NAME s_scm_symbol_p |
0f2d19dd | 160 | { |
3ee86942 | 161 | return scm_from_bool (scm_is_symbol (obj)); |
0f2d19dd | 162 | } |
1bbd0b84 | 163 | #undef FUNC_NAME |
0f2d19dd | 164 | |
ac48757b MV |
165 | SCM_DEFINE (scm_symbol_interned_p, "symbol-interned?", 1, 0, 0, |
166 | (SCM symbol), | |
167 | "Return @code{#t} if @var{symbol} is interned, otherwise return\n" | |
168 | "@code{#f}.") | |
169 | #define FUNC_NAME s_scm_symbol_interned_p | |
170 | { | |
171 | SCM_VALIDATE_SYMBOL (1, symbol); | |
3ee86942 | 172 | return scm_from_bool (scm_i_symbol_is_interned (symbol)); |
ac48757b MV |
173 | } |
174 | #undef FUNC_NAME | |
175 | ||
176 | SCM_DEFINE (scm_make_symbol, "make-symbol", 1, 0, 0, | |
177 | (SCM name), | |
178 | "Return a new uninterned symbol with the name @var{name}. " | |
179 | "The returned symbol is guaranteed to be unique and future " | |
d58d5bfc | 180 | "calls to @code{string->symbol} will not return it.") |
ac48757b MV |
181 | #define FUNC_NAME s_scm_make_symbol |
182 | { | |
ac48757b | 183 | SCM_VALIDATE_STRING (1, name); |
3ee86942 | 184 | return scm_i_mem2uninterned_symbol (name); |
ac48757b MV |
185 | } |
186 | #undef FUNC_NAME | |
187 | ||
3b3b36dd | 188 | SCM_DEFINE (scm_symbol_to_string, "symbol->string", 1, 0, 0, |
1bbd0b84 | 189 | (SCM s), |
1e6808ea MG |
190 | "Return the name of @var{symbol} as a string. If the symbol was\n" |
191 | "part of an object returned as the value of a literal expression\n" | |
7a095584 | 192 | "(section @pxref{Literal expressions,,,r5rs, The Revised^5\n" |
1e6808ea MG |
193 | "Report on Scheme}) or by a call to the @code{read} procedure,\n" |
194 | "and its name contains alphabetic characters, then the string\n" | |
195 | "returned will contain characters in the implementation's\n" | |
196 | "preferred standard case---some implementations will prefer\n" | |
197 | "upper case, others lower case. If the symbol was returned by\n" | |
198 | "@code{string->symbol}, the case of characters in the string\n" | |
199 | "returned will be the same as the case in the string that was\n" | |
200 | "passed to @code{string->symbol}. It is an error to apply\n" | |
201 | "mutation procedures like @code{string-set!} to strings returned\n" | |
202 | "by this procedure.\n" | |
203 | "\n" | |
942e5b91 | 204 | "The following examples assume that the implementation's\n" |
1e6808ea MG |
205 | "standard case is lower case:\n" |
206 | "\n" | |
942e5b91 | 207 | "@lisp\n" |
1e6808ea MG |
208 | "(symbol->string 'flying-fish) @result{} \"flying-fish\"\n" |
209 | "(symbol->string 'Martin) @result{} \"martin\"\n" | |
5ffe9968 | 210 | "(symbol->string\n" |
942e5b91 MG |
211 | " (string->symbol \"Malvina\")) @result{} \"Malvina\"\n" |
212 | "@end lisp") | |
1bbd0b84 | 213 | #define FUNC_NAME s_scm_symbol_to_string |
0f2d19dd | 214 | { |
28b06554 | 215 | SCM_VALIDATE_SYMBOL (1, s); |
3ee86942 | 216 | return scm_i_symbol_substring (s, 0, scm_i_symbol_length (s)); |
0f2d19dd | 217 | } |
1bbd0b84 | 218 | #undef FUNC_NAME |
0f2d19dd JB |
219 | |
220 | ||
3b3b36dd | 221 | SCM_DEFINE (scm_string_to_symbol, "string->symbol", 1, 0, 0, |
1e6808ea MG |
222 | (SCM string), |
223 | "Return the symbol whose name is @var{string}. This procedure\n" | |
942e5b91 MG |
224 | "can create symbols with names containing special characters or\n" |
225 | "letters in the non-standard case, but it is usually a bad idea\n" | |
1e6808ea MG |
226 | "to create such symbols because in some implementations of\n" |
227 | "Scheme they cannot be read as themselves. See\n" | |
228 | "@code{symbol->string}.\n" | |
229 | "\n" | |
942e5b91 | 230 | "The following examples assume that the implementation's\n" |
1e6808ea MG |
231 | "standard case is lower case:\n" |
232 | "\n" | |
942e5b91 MG |
233 | "@lisp\n" |
234 | "(eq? 'mISSISSIppi 'mississippi) @result{} #t\n" | |
235 | "(string->symbol \"mISSISSIppi\") @result{} @r{the symbol with name \"mISSISSIppi\"}\n" | |
236 | "(eq? 'bitBlt (string->symbol \"bitBlt\")) @result{} #f\n" | |
237 | "(eq? 'JollyWog\n" | |
238 | " (string->symbol (symbol->string 'JollyWog))) @result{} #t\n" | |
239 | "(string=? \"K. Harper, M.D.\"\n" | |
240 | " (symbol->string\n" | |
241 | " (string->symbol \"K. Harper, M.D.\"))) @result{}#t\n" | |
242 | "@end lisp") | |
1bbd0b84 | 243 | #define FUNC_NAME s_scm_string_to_symbol |
0f2d19dd | 244 | { |
1e6808ea | 245 | SCM_VALIDATE_STRING (1, string); |
3ee86942 | 246 | return scm_i_mem2symbol (string); |
0f2d19dd | 247 | } |
1bbd0b84 | 248 | #undef FUNC_NAME |
0f2d19dd | 249 | |
1206efbe MV |
250 | SCM_DEFINE (scm_string_ci_to_symbol, "string-ci->symbol", 1, 0, 0, |
251 | (SCM str), | |
252 | "Return the symbol whose name is @var{str}. @var{str} is\n" | |
253 | "converted to lowercase before the conversion is done, if Guile\n" | |
254 | "is currently reading symbols case-insensitively.") | |
255 | #define FUNC_NAME s_scm_string_ci_to_symbol | |
256 | { | |
257 | return scm_string_to_symbol (SCM_CASE_INSENSITIVE_P | |
258 | ? scm_string_downcase(str) | |
259 | : str); | |
260 | } | |
261 | #undef FUNC_NAME | |
262 | ||
86d31dfe | 263 | #define MAX_PREFIX_LENGTH 30 |
0f2d19dd | 264 | |
86d31dfe MV |
265 | SCM_DEFINE (scm_gensym, "gensym", 0, 1, 0, |
266 | (SCM prefix), | |
267 | "Create a new symbol with a name constructed from a prefix and\n" | |
268 | "a counter value. The string @var{prefix} can be specified as\n" | |
68dc153d | 269 | "an optional argument. Default prefix is @code{ g}. The counter\n" |
86d31dfe MV |
270 | "is increased by 1 at each call. There is no provision for\n" |
271 | "resetting the counter.") | |
272 | #define FUNC_NAME s_scm_gensym | |
0f2d19dd | 273 | { |
7426a638 | 274 | static int gensym_counter = 0; |
3ee86942 MV |
275 | |
276 | SCM suffix, name; | |
277 | int n, n_digits; | |
278 | char buf[SCM_INTBUFLEN]; | |
7426a638 | 279 | |
86d31dfe | 280 | if (SCM_UNBNDP (prefix)) |
3ee86942 MV |
281 | prefix = scm_from_locale_string (" g"); |
282 | ||
283 | /* mutex in case another thread looks and incs at the exact same moment */ | |
284 | scm_mutex_lock (&scm_i_misc_mutex); | |
285 | n = gensym_counter++; | |
286 | scm_mutex_unlock (&scm_i_misc_mutex); | |
287 | ||
288 | n_digits = scm_iint2str (n, 10, buf); | |
289 | suffix = scm_from_locale_stringn (buf, n_digits); | |
290 | name = scm_string_append (scm_list_2 (prefix, suffix)); | |
291 | return scm_string_to_symbol (name); | |
0f2d19dd | 292 | } |
1bbd0b84 | 293 | #undef FUNC_NAME |
0f2d19dd | 294 | |
86d31dfe MV |
295 | SCM_DEFINE (scm_symbol_hash, "symbol-hash", 1, 0, 0, |
296 | (SCM symbol), | |
297 | "Return a hash value for @var{symbol}.") | |
298 | #define FUNC_NAME s_scm_symbol_hash | |
0f2d19dd | 299 | { |
86d31dfe | 300 | SCM_VALIDATE_SYMBOL (1, symbol); |
3ee86942 | 301 | return scm_from_ulong (scm_i_symbol_hash (symbol)); |
0f2d19dd | 302 | } |
1bbd0b84 | 303 | #undef FUNC_NAME |
0f2d19dd | 304 | |
3b3b36dd | 305 | SCM_DEFINE (scm_symbol_fref, "symbol-fref", 1, 0, 0, |
1bbd0b84 | 306 | (SCM s), |
b380b885 | 307 | "Return the contents of @var{symbol}'s @dfn{function slot}.") |
1bbd0b84 | 308 | #define FUNC_NAME s_scm_symbol_fref |
0f2d19dd | 309 | { |
34d19ef6 | 310 | SCM_VALIDATE_SYMBOL (1, s); |
3ee86942 | 311 | return SCM_CAR (SCM_CELL_OBJECT_3 (s)); |
0f2d19dd | 312 | } |
1bbd0b84 | 313 | #undef FUNC_NAME |
0f2d19dd JB |
314 | |
315 | ||
3b3b36dd | 316 | SCM_DEFINE (scm_symbol_pref, "symbol-pref", 1, 0, 0, |
1bbd0b84 | 317 | (SCM s), |
b380b885 | 318 | "Return the @dfn{property list} currently associated with @var{symbol}.") |
1bbd0b84 | 319 | #define FUNC_NAME s_scm_symbol_pref |
0f2d19dd | 320 | { |
34d19ef6 | 321 | SCM_VALIDATE_SYMBOL (1, s); |
3ee86942 | 322 | return SCM_CDR (SCM_CELL_OBJECT_3 (s)); |
0f2d19dd | 323 | } |
1bbd0b84 | 324 | #undef FUNC_NAME |
0f2d19dd JB |
325 | |
326 | ||
3b3b36dd | 327 | SCM_DEFINE (scm_symbol_fset_x, "symbol-fset!", 2, 0, 0, |
1bbd0b84 | 328 | (SCM s, SCM val), |
b380b885 | 329 | "Change the binding of @var{symbol}'s function slot.") |
1bbd0b84 | 330 | #define FUNC_NAME s_scm_symbol_fset_x |
0f2d19dd | 331 | { |
34d19ef6 | 332 | SCM_VALIDATE_SYMBOL (1, s); |
3ee86942 | 333 | SCM_SETCAR (SCM_CELL_OBJECT_3 (s), val); |
0f2d19dd JB |
334 | return SCM_UNSPECIFIED; |
335 | } | |
1bbd0b84 | 336 | #undef FUNC_NAME |
0f2d19dd JB |
337 | |
338 | ||
3b3b36dd | 339 | SCM_DEFINE (scm_symbol_pset_x, "symbol-pset!", 2, 0, 0, |
1bbd0b84 | 340 | (SCM s, SCM val), |
b380b885 | 341 | "Change the binding of @var{symbol}'s property slot.") |
1bbd0b84 | 342 | #define FUNC_NAME s_scm_symbol_pset_x |
0f2d19dd | 343 | { |
34d19ef6 | 344 | SCM_VALIDATE_SYMBOL (1, s); |
3ee86942 | 345 | SCM_SETCDR (SCM_CELL_OBJECT_3 (s), val); |
0f2d19dd JB |
346 | return SCM_UNSPECIFIED; |
347 | } | |
1bbd0b84 | 348 | #undef FUNC_NAME |
0f2d19dd | 349 | |
3ee86942 MV |
350 | SCM |
351 | scm_from_locale_symbol (const char *sym) | |
af68e5e5 | 352 | { |
3ee86942 | 353 | return scm_string_to_symbol (scm_from_locale_string (sym)); |
af68e5e5 | 354 | } |
af68e5e5 | 355 | |
3ee86942 MV |
356 | SCM |
357 | scm_from_locale_symboln (const char *sym, size_t len) | |
358 | { | |
359 | return scm_string_to_symbol (scm_from_locale_stringn (sym, len)); | |
360 | } | |
af68e5e5 | 361 | |
0f979f3f DH |
362 | void |
363 | scm_symbols_prehistory () | |
364 | { | |
e11e83f3 | 365 | symbols = scm_make_weak_key_hash_table (scm_from_int (2139)); |
0f979f3f DH |
366 | scm_permanent_object (symbols); |
367 | } | |
368 | ||
369 | ||
0f2d19dd JB |
370 | void |
371 | scm_init_symbols () | |
0f2d19dd | 372 | { |
a0599745 | 373 | #include "libguile/symbols.x" |
0f2d19dd | 374 | } |
89e00824 ML |
375 | |
376 | /* | |
377 | Local Variables: | |
378 | c-file-style: "gnu" | |
379 | End: | |
380 | */ |