Mercurial > hg > xemacs-beta
annotate src/symbols.c @ 5468:a9094f28f9a9
Merge with trunk.
author | Mats Lidell <matsl@xemacs.org> |
---|---|
date | Wed, 19 Jan 2011 22:35:23 +0100 |
parents | 308d34e9f07d 8608eadee6ba |
children | 0af042a0c116 |
rev | line source |
---|---|
428 | 1 /* "intern" and friends -- moved here from lread.c and data.c |
2 Copyright (C) 1985-1989, 1992-1994 Free Software Foundation, Inc. | |
4940
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
3 Copyright (C) 1995, 2000, 2001, 2002, 2010 Ben Wing. |
428 | 4 |
5 This file is part of XEmacs. | |
6 | |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5277
diff
changeset
|
7 XEmacs is free software: you can redistribute it and/or modify it |
428 | 8 under the terms of the GNU General Public License as published by the |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5277
diff
changeset
|
9 Free Software Foundation, either version 3 of the License, or (at your |
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5277
diff
changeset
|
10 option) any later version. |
428 | 11 |
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5277
diff
changeset
|
18 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */ |
428 | 19 |
20 /* Synched up with: FSF 19.30. */ | |
21 | |
22 /* This file has been Mule-ized. */ | |
23 | |
24 /* NOTE: | |
25 | |
26 The value cell of a symbol can contain a simple value or one of | |
27 various symbol-value-magic objects. Some of these objects can | |
28 chain into other kinds of objects. Here is a table of possibilities: | |
29 | |
30 1a) simple value | |
31 1b) Qunbound | |
32 1c) symbol-value-forward, excluding Qunbound | |
33 2) symbol-value-buffer-local -> 1a or 1b or 1c | |
34 3) symbol-value-lisp-magic -> 1a or 1b or 1c | |
35 4) symbol-value-lisp-magic -> symbol-value-buffer-local -> 1a or 1b or 1c | |
36 5) symbol-value-varalias | |
37 6) symbol-value-lisp-magic -> symbol-value-varalias | |
38 | |
39 The "chain" of a symbol-value-buffer-local is its current_value slot. | |
40 | |
41 The "chain" of a symbol-value-lisp-magic is its shadowed slot, which | |
42 applies for handler types without associated handlers. | |
43 | |
44 All other fields in all the structures (including the "shadowed" slot | |
45 in a symbol-value-varalias) can *only* contain a simple value or Qunbound. | |
46 | |
47 */ | |
48 | |
49 /* #### Ugh, though, this file does awful things with symbol-value-magic | |
50 objects. This ought to be cleaned up. */ | |
51 | |
52 #include <config.h> | |
53 #include "lisp.h" | |
54 | |
4921
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
4905
diff
changeset
|
55 #include "bytecode.h" /* for COMPILED_FUNCTION_ANNOTATION_HACK, |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
4905
diff
changeset
|
56 defined in bytecode.h and used here. */ |
428 | 57 #include "buffer.h" /* for Vbuffer_defaults */ |
872 | 58 #include "console-impl.h" |
428 | 59 #include "elhash.h" |
60 | |
61 Lisp_Object Qad_advice_info, Qad_activate; | |
62 | |
63 Lisp_Object Qget_value, Qset_value, Qbound_predicate, Qmake_unbound; | |
64 Lisp_Object Qlocal_predicate, Qmake_local; | |
65 | |
66 Lisp_Object Qboundp, Qglobally_boundp, Qmakunbound; | |
67 Lisp_Object Qsymbol_value, Qset, Qdefault_boundp, Qdefault_value; | |
68 Lisp_Object Qset_default, Qsetq_default; | |
69 Lisp_Object Qmake_variable_buffer_local, Qmake_local_variable; | |
70 Lisp_Object Qkill_local_variable, Qkill_console_local_variable; | |
71 Lisp_Object Qsymbol_value_in_buffer, Qsymbol_value_in_console; | |
72 Lisp_Object Qlocal_variable_p; | |
73 | |
74 Lisp_Object Qconst_integer, Qconst_boolean, Qconst_object; | |
75 Lisp_Object Qconst_specifier; | |
76 Lisp_Object Qdefault_buffer, Qcurrent_buffer, Qconst_current_buffer; | |
77 Lisp_Object Qdefault_console, Qselected_console, Qconst_selected_console; | |
78 | |
79 static Lisp_Object maybe_call_magic_handler (Lisp_Object sym, | |
80 Lisp_Object funsym, | |
81 int nargs, ...); | |
82 static Lisp_Object fetch_value_maybe_past_magic (Lisp_Object sym, | |
83 Lisp_Object follow_past_lisp_magic); | |
84 static Lisp_Object *value_slot_past_magic (Lisp_Object sym); | |
85 static Lisp_Object follow_varalias_pointers (Lisp_Object symbol, | |
86 Lisp_Object follow_past_lisp_magic); | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
87 static Lisp_Object map_varalias_chain (Lisp_Object symbol, |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
88 Lisp_Object follow_past_lisp_magic, |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
89 Lisp_Object (*fn) (Lisp_Object arg)); |
428 | 90 |
91 | |
92 static Lisp_Object | |
93 mark_symbol (Lisp_Object obj) | |
94 { | |
440 | 95 Lisp_Symbol *sym = XSYMBOL (obj); |
428 | 96 |
97 mark_object (sym->value); | |
98 mark_object (sym->function); | |
793 | 99 mark_object (sym->name); |
428 | 100 if (!symbol_next (sym)) |
101 return sym->plist; | |
102 else | |
103 { | |
104 mark_object (sym->plist); | |
105 /* Mark the rest of the symbols in the obarray hash-chain */ | |
106 sym = symbol_next (sym); | |
793 | 107 return wrap_symbol (sym); |
428 | 108 } |
109 } | |
110 | |
1204 | 111 static const struct memory_description symbol_description[] = { |
440 | 112 { XD_LISP_OBJECT, offsetof (Lisp_Symbol, next) }, |
113 { XD_LISP_OBJECT, offsetof (Lisp_Symbol, name) }, | |
114 { XD_LISP_OBJECT, offsetof (Lisp_Symbol, value) }, | |
115 { XD_LISP_OBJECT, offsetof (Lisp_Symbol, function) }, | |
116 { XD_LISP_OBJECT, offsetof (Lisp_Symbol, plist) }, | |
428 | 117 { XD_END } |
118 }; | |
119 | |
442 | 120 /* Symbol plists are directly accessible, so we need to protect against |
121 invalid property list structure */ | |
122 | |
123 static Lisp_Object | |
124 symbol_getprop (Lisp_Object symbol, Lisp_Object property) | |
125 { | |
126 return external_plist_get (&XSYMBOL (symbol)->plist, property, 0, ERROR_ME); | |
127 } | |
128 | |
129 static int | |
130 symbol_putprop (Lisp_Object symbol, Lisp_Object property, Lisp_Object value) | |
131 { | |
132 external_plist_put (&XSYMBOL (symbol)->plist, property, value, 0, ERROR_ME); | |
133 return 1; | |
134 } | |
135 | |
136 static int | |
137 symbol_remprop (Lisp_Object symbol, Lisp_Object property) | |
138 { | |
139 return external_remprop (&XSYMBOL (symbol)->plist, property, 0, ERROR_ME); | |
140 } | |
141 | |
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
142 DEFINE_DUMPABLE_FROB_BLOCK_LISP_OBJECT ("symbol", symbol, |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
143 mark_symbol, print_symbol, |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
144 0, 0, 0, symbol_description, |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
145 Lisp_Symbol); |
428 | 146 |
147 /**********************************************************************/ | |
148 /* Intern */ | |
149 /**********************************************************************/ | |
150 | |
151 /* #### using a vector here is way bogus. Use a hash table instead. */ | |
152 | |
153 Lisp_Object Vobarray; | |
154 | |
155 static Lisp_Object initial_obarray; | |
156 | |
157 /* oblookup stores the bucket number here, for the sake of Funintern. */ | |
158 | |
159 static int oblookup_last_bucket_number; | |
160 | |
161 static Lisp_Object | |
162 check_obarray (Lisp_Object obarray) | |
163 { | |
164 while (!VECTORP (obarray) || XVECTOR_LENGTH (obarray) == 0) | |
165 { | |
166 /* If Vobarray is now invalid, force it to be valid. */ | |
167 if (EQ (Vobarray, obarray)) Vobarray = initial_obarray; | |
168 | |
169 obarray = wrong_type_argument (Qvectorp, obarray); | |
170 } | |
171 return obarray; | |
172 } | |
173 | |
174 Lisp_Object | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
175 intern_istring (const Ibyte *str) |
428 | 176 { |
771 | 177 Bytecount len = qxestrlen (str); |
428 | 178 Lisp_Object obarray = Vobarray; |
179 | |
180 if (!VECTORP (obarray) || XVECTOR_LENGTH (obarray) == 0) | |
181 obarray = check_obarray (obarray); | |
182 | |
183 { | |
771 | 184 Lisp_Object tem = oblookup (obarray, str, len); |
428 | 185 if (SYMBOLP (tem)) |
186 return tem; | |
187 } | |
188 | |
771 | 189 return Fintern (make_string (str, len), obarray); |
190 } | |
191 | |
192 Lisp_Object | |
867 | 193 intern (const CIbyte *str) |
771 | 194 { |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
195 return intern_istring ((Ibyte *) str); |
428 | 196 } |
197 | |
814 | 198 Lisp_Object |
5277
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
199 intern_massaging_name (const CIbyte *str) |
814 | 200 { |
201 Bytecount len = strlen (str); | |
867 | 202 CIbyte *tmp = alloca_extbytes (len + 1); |
814 | 203 Bytecount i; |
204 strcpy (tmp, str); | |
205 for (i = 0; i < len; i++) | |
5277
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
206 { |
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
207 if (tmp[i] == '_') |
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
208 { |
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
209 tmp[i] = '-'; |
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
210 } |
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
211 else if (tmp[i] == 'X') |
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
212 { |
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
213 tmp[i] = '*'; |
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
214 } |
d804e621add0
Simplify the API of PARSE_KEYWORDS for callers.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5255
diff
changeset
|
215 } |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
216 return intern_istring ((Ibyte *) tmp); |
814 | 217 } |
218 | |
428 | 219 DEFUN ("intern", Fintern, 1, 2, 0, /* |
220 Return the canonical symbol whose name is STRING. | |
221 If there is none, one is created by this function and returned. | |
444 | 222 Optional second argument OBARRAY specifies the obarray to use; |
223 it defaults to the value of the variable `obarray'. | |
428 | 224 */ |
225 (string, obarray)) | |
226 { | |
227 Lisp_Object object, *ptr; | |
793 | 228 Lisp_Object symbol; |
428 | 229 Bytecount len; |
230 | |
231 if (NILP (obarray)) obarray = Vobarray; | |
232 obarray = check_obarray (obarray); | |
233 | |
234 CHECK_STRING (string); | |
235 | |
236 len = XSTRING_LENGTH (string); | |
237 object = oblookup (obarray, XSTRING_DATA (string), len); | |
238 if (!INTP (object)) | |
239 /* Found it */ | |
240 return object; | |
241 | |
242 ptr = &XVECTOR_DATA (obarray)[XINT (object)]; | |
243 | |
244 object = Fmake_symbol (string); | |
793 | 245 symbol = object; |
428 | 246 |
247 if (SYMBOLP (*ptr)) | |
793 | 248 XSYMBOL_NEXT (symbol) = XSYMBOL (*ptr); |
428 | 249 else |
793 | 250 XSYMBOL_NEXT (symbol) = 0; |
428 | 251 *ptr = object; |
252 | |
826 | 253 if (string_byte (XSYMBOL_NAME (symbol), 0) == ':' && EQ (obarray, Vobarray)) |
428 | 254 { |
255 /* The LISP way is to put keywords in their own package, but we | |
256 don't have packages, so we do something simpler. Someday, | |
257 maybe we'll have packages and then this will be reworked. | |
258 --Stig. */ | |
793 | 259 XSYMBOL_VALUE (symbol) = object; |
428 | 260 } |
261 | |
262 return object; | |
263 } | |
264 | |
4355
a2af1ff1761f
Provide a DEFAULT argument in #'intern-soft.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4337
diff
changeset
|
265 DEFUN ("intern-soft", Fintern_soft, 1, 3, 0, /* |
428 | 266 Return the canonical symbol named NAME, or nil if none exists. |
267 NAME may be a string or a symbol. If it is a symbol, that exact | |
268 symbol is searched for. | |
444 | 269 Optional second argument OBARRAY specifies the obarray to use; |
270 it defaults to the value of the variable `obarray'. | |
4355
a2af1ff1761f
Provide a DEFAULT argument in #'intern-soft.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4337
diff
changeset
|
271 Optional third argument DEFAULT says what Lisp object to return if there is |
a2af1ff1761f
Provide a DEFAULT argument in #'intern-soft.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4337
diff
changeset
|
272 no canonical symbol named NAME, and defaults to nil. |
428 | 273 */ |
4355
a2af1ff1761f
Provide a DEFAULT argument in #'intern-soft.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4337
diff
changeset
|
274 (name, obarray, default_)) |
428 | 275 { |
276 Lisp_Object tem; | |
793 | 277 Lisp_Object string; |
428 | 278 |
279 if (NILP (obarray)) obarray = Vobarray; | |
280 obarray = check_obarray (obarray); | |
281 | |
282 if (!SYMBOLP (name)) | |
283 { | |
284 CHECK_STRING (name); | |
793 | 285 string = name; |
428 | 286 } |
287 else | |
288 string = symbol_name (XSYMBOL (name)); | |
289 | |
793 | 290 tem = oblookup (obarray, XSTRING_DATA (string), XSTRING_LENGTH (string)); |
428 | 291 if (INTP (tem) || (SYMBOLP (name) && !EQ (name, tem))) |
4355
a2af1ff1761f
Provide a DEFAULT argument in #'intern-soft.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4337
diff
changeset
|
292 return default_; |
428 | 293 else |
294 return tem; | |
295 } | |
296 | |
297 DEFUN ("unintern", Funintern, 1, 2, 0, /* | |
298 Delete the symbol named NAME, if any, from OBARRAY. | |
299 The value is t if a symbol was found and deleted, nil otherwise. | |
300 NAME may be a string or a symbol. If it is a symbol, that symbol | |
301 is deleted, if it belongs to OBARRAY--no other symbol is deleted. | |
444 | 302 OBARRAY defaults to the value of the variable `obarray'. |
428 | 303 */ |
304 (name, obarray)) | |
305 { | |
306 Lisp_Object tem; | |
793 | 307 Lisp_Object string; |
428 | 308 int hash; |
309 | |
310 if (NILP (obarray)) obarray = Vobarray; | |
311 obarray = check_obarray (obarray); | |
312 | |
313 if (SYMBOLP (name)) | |
314 string = symbol_name (XSYMBOL (name)); | |
315 else | |
316 { | |
317 CHECK_STRING (name); | |
793 | 318 string = name; |
428 | 319 } |
320 | |
793 | 321 tem = oblookup (obarray, XSTRING_DATA (string), XSTRING_LENGTH (string)); |
428 | 322 if (INTP (tem)) |
323 return Qnil; | |
324 /* If arg was a symbol, don't delete anything but that symbol itself. */ | |
325 if (SYMBOLP (name) && !EQ (name, tem)) | |
326 return Qnil; | |
327 | |
328 hash = oblookup_last_bucket_number; | |
329 | |
330 if (EQ (XVECTOR_DATA (obarray)[hash], tem)) | |
331 { | |
332 if (XSYMBOL (tem)->next) | |
793 | 333 XVECTOR_DATA (obarray)[hash] = wrap_symbol (XSYMBOL (tem)->next); |
428 | 334 else |
335 XVECTOR_DATA (obarray)[hash] = Qzero; | |
336 } | |
337 else | |
338 { | |
339 Lisp_Object tail, following; | |
340 | |
341 for (tail = XVECTOR_DATA (obarray)[hash]; | |
342 XSYMBOL (tail)->next; | |
343 tail = following) | |
344 { | |
793 | 345 following = wrap_symbol (XSYMBOL (tail)->next); |
428 | 346 if (EQ (following, tem)) |
347 { | |
348 XSYMBOL (tail)->next = XSYMBOL (following)->next; | |
349 break; | |
350 } | |
351 } | |
352 } | |
353 return Qt; | |
354 } | |
355 | |
356 /* Return the symbol in OBARRAY whose names matches the string | |
357 of SIZE characters at PTR. If there is no such symbol in OBARRAY, | |
358 return the index into OBARRAY that the string hashes to. | |
359 | |
360 Also store the bucket number in oblookup_last_bucket_number. */ | |
361 | |
362 Lisp_Object | |
867 | 363 oblookup (Lisp_Object obarray, const Ibyte *ptr, Bytecount size) |
428 | 364 { |
490 | 365 unsigned int hash, obsize; |
440 | 366 Lisp_Symbol *tail; |
428 | 367 Lisp_Object bucket; |
368 | |
369 if (!VECTORP (obarray) || | |
370 (obsize = XVECTOR_LENGTH (obarray)) == 0) | |
371 { | |
372 obarray = check_obarray (obarray); | |
373 obsize = XVECTOR_LENGTH (obarray); | |
374 } | |
375 hash = hash_string (ptr, size) % obsize; | |
376 oblookup_last_bucket_number = hash; | |
377 bucket = XVECTOR_DATA (obarray)[hash]; | |
378 if (ZEROP (bucket)) | |
379 ; | |
380 else if (!SYMBOLP (bucket)) | |
563 | 381 signal_error (Qinvalid_state, "Bad data in guts of obarray", Qunbound); /* Like CADR error message */ |
428 | 382 else |
383 for (tail = XSYMBOL (bucket); ;) | |
384 { | |
793 | 385 if (XSTRING_LENGTH (tail->name) == size && |
386 !memcmp (XSTRING_DATA (tail->name), ptr, size)) | |
428 | 387 { |
793 | 388 return wrap_symbol (tail); |
428 | 389 } |
390 tail = symbol_next (tail); | |
391 if (!tail) | |
392 break; | |
393 } | |
394 return make_int (hash); | |
395 } | |
396 | |
490 | 397 /* An excellent string hashing function. |
398 Adapted from glib's g_str_hash(). | |
399 Investigation by Karl Nelson <kenelson@ece.ucdavis.edu>. | |
400 Do a web search for "g_str_hash X31_HASH" if you want to know more. */ | |
401 unsigned int | |
867 | 402 hash_string (const Ibyte *ptr, Bytecount len) |
428 | 403 { |
490 | 404 unsigned int hash; |
405 | |
406 for (hash = 0; len; len--, ptr++) | |
407 /* (31 * hash) will probably be optimized to ((hash << 5) - hash). */ | |
408 hash = 31 * hash + *ptr; | |
409 | |
410 return hash; | |
428 | 411 } |
412 | |
413 /* Map FN over OBARRAY. The mapping is stopped when FN returns a | |
414 non-zero value. */ | |
415 void | |
416 map_obarray (Lisp_Object obarray, | |
417 int (*fn) (Lisp_Object, void *), void *arg) | |
418 { | |
419 REGISTER int i; | |
420 | |
421 CHECK_VECTOR (obarray); | |
422 for (i = XVECTOR_LENGTH (obarray) - 1; i >= 0; i--) | |
423 { | |
424 Lisp_Object tail = XVECTOR_DATA (obarray)[i]; | |
425 if (SYMBOLP (tail)) | |
426 while (1) | |
427 { | |
440 | 428 Lisp_Symbol *next; |
428 | 429 if ((*fn) (tail, arg)) |
430 return; | |
431 next = symbol_next (XSYMBOL (tail)); | |
432 if (!next) | |
433 break; | |
793 | 434 tail = wrap_symbol (next); |
428 | 435 } |
436 } | |
437 } | |
438 | |
439 static int | |
440 mapatoms_1 (Lisp_Object sym, void *arg) | |
441 { | |
442 call1 (*(Lisp_Object *)arg, sym); | |
443 return 0; | |
444 } | |
445 | |
446 DEFUN ("mapatoms", Fmapatoms, 1, 2, 0, /* | |
447 Call FUNCTION on every symbol in OBARRAY. | |
448 OBARRAY defaults to the value of `obarray'. | |
449 */ | |
450 (function, obarray)) | |
451 { | |
442 | 452 struct gcpro gcpro1; |
453 | |
428 | 454 if (NILP (obarray)) |
455 obarray = Vobarray; | |
456 obarray = check_obarray (obarray); | |
457 | |
442 | 458 GCPRO1 (obarray); |
428 | 459 map_obarray (obarray, mapatoms_1, &function); |
442 | 460 UNGCPRO; |
428 | 461 return Qnil; |
462 } | |
463 | |
464 | |
465 /**********************************************************************/ | |
466 /* Apropos */ | |
467 /**********************************************************************/ | |
468 | |
469 struct appropos_mapper_closure | |
470 { | |
471 Lisp_Object regexp; | |
472 Lisp_Object predicate; | |
473 Lisp_Object accumulation; | |
474 }; | |
475 | |
476 static int | |
477 apropos_mapper (Lisp_Object symbol, void *arg) | |
478 { | |
479 struct appropos_mapper_closure *closure = | |
480 (struct appropos_mapper_closure *) arg; | |
481 Bytecount match = fast_lisp_string_match (closure->regexp, | |
482 Fsymbol_name (symbol)); | |
483 | |
484 if (match >= 0 && | |
485 (NILP (closure->predicate) || | |
486 !NILP (call1 (closure->predicate, symbol)))) | |
487 closure->accumulation = Fcons (symbol, closure->accumulation); | |
488 | |
489 return 0; | |
490 } | |
491 | |
492 DEFUN ("apropos-internal", Fapropos_internal, 1, 2, 0, /* | |
444 | 493 Return a list of all symbols whose names contain match for REGEXP. |
494 If optional 2nd arg PREDICATE is non-nil, only symbols for which | |
495 \(funcall PREDICATE SYMBOL) returns non-nil are returned. | |
428 | 496 */ |
497 (regexp, predicate)) | |
498 { | |
499 struct appropos_mapper_closure closure; | |
442 | 500 struct gcpro gcpro1; |
428 | 501 |
502 CHECK_STRING (regexp); | |
503 | |
504 closure.regexp = regexp; | |
505 closure.predicate = predicate; | |
506 closure.accumulation = Qnil; | |
442 | 507 GCPRO1 (closure.accumulation); |
428 | 508 map_obarray (Vobarray, apropos_mapper, &closure); |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5157
diff
changeset
|
509 closure.accumulation = list_sort (closure.accumulation, NULL, Qstring_lessp, |
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5157
diff
changeset
|
510 Qidentity); |
442 | 511 UNGCPRO; |
428 | 512 return closure.accumulation; |
513 } | |
514 | |
515 | |
516 /* Extract and set components of symbols */ | |
517 | |
518 static void set_up_buffer_local_cache (Lisp_Object sym, | |
519 struct symbol_value_buffer_local *bfwd, | |
520 struct buffer *buf, | |
521 Lisp_Object new_alist_el, | |
522 int set_it_p); | |
523 | |
524 DEFUN ("boundp", Fboundp, 1, 1, 0, /* | |
525 Return t if SYMBOL's value is not void. | |
526 */ | |
527 (symbol)) | |
528 { | |
529 CHECK_SYMBOL (symbol); | |
530 return UNBOUNDP (find_symbol_value (symbol)) ? Qnil : Qt; | |
531 } | |
532 | |
533 DEFUN ("globally-boundp", Fglobally_boundp, 1, 1, 0, /* | |
534 Return t if SYMBOL has a global (non-bound) value. | |
535 This is for the byte-compiler; you really shouldn't be using this. | |
536 */ | |
537 (symbol)) | |
538 { | |
539 CHECK_SYMBOL (symbol); | |
540 return UNBOUNDP (top_level_value (symbol)) ? Qnil : Qt; | |
541 } | |
542 | |
543 DEFUN ("fboundp", Ffboundp, 1, 1, 0, /* | |
544 Return t if SYMBOL's function definition is not void. | |
545 */ | |
546 (symbol)) | |
547 { | |
548 CHECK_SYMBOL (symbol); | |
549 return UNBOUNDP (XSYMBOL (symbol)->function) ? Qnil : Qt; | |
550 } | |
551 | |
552 /* Return non-zero if SYM's value or function (the current contents of | |
553 which should be passed in as VAL) is constant, i.e. unsettable. */ | |
554 | |
555 static int | |
556 symbol_is_constant (Lisp_Object sym, Lisp_Object val) | |
557 { | |
558 /* #### - I wonder if it would be better to just have a new magic value | |
559 type and make nil, t, and all keywords have that same magic | |
560 constant_symbol value. This test is awfully specific about what is | |
561 constant and what isn't. --Stig */ | |
562 if (EQ (sym, Qnil) || | |
563 EQ (sym, Qt)) | |
564 return 1; | |
565 | |
566 if (SYMBOL_VALUE_MAGIC_P (val)) | |
567 switch (XSYMBOL_VALUE_MAGIC_TYPE (val)) | |
568 { | |
569 case SYMVAL_CONST_OBJECT_FORWARD: | |
570 case SYMVAL_CONST_SPECIFIER_FORWARD: | |
571 case SYMVAL_CONST_FIXNUM_FORWARD: | |
572 case SYMVAL_CONST_BOOLEAN_FORWARD: | |
573 case SYMVAL_CONST_CURRENT_BUFFER_FORWARD: | |
574 case SYMVAL_CONST_SELECTED_CONSOLE_FORWARD: | |
575 return 1; | |
576 default: break; /* Warning suppression */ | |
577 } | |
578 | |
579 /* We don't return true for keywords here because they are handled | |
580 specially by reject_constant_symbols(). */ | |
581 return 0; | |
582 } | |
583 | |
584 /* We are setting SYM's value slot (or function slot, if FUNCTION_P is | |
585 non-zero) to NEWVAL. Make sure this is allowed. | |
586 FOLLOW_PAST_LISP_MAGIC specifies whether we delve past | |
587 symbol-value-lisp-magic objects. */ | |
588 | |
589 void | |
590 reject_constant_symbols (Lisp_Object sym, Lisp_Object newval, int function_p, | |
591 Lisp_Object follow_past_lisp_magic) | |
592 { | |
593 Lisp_Object val = | |
594 (function_p ? XSYMBOL (sym)->function | |
595 : fetch_value_maybe_past_magic (sym, follow_past_lisp_magic)); | |
596 | |
597 if (SYMBOL_VALUE_MAGIC_P (val) && | |
598 XSYMBOL_VALUE_MAGIC_TYPE (val) == SYMVAL_CONST_SPECIFIER_FORWARD) | |
563 | 599 invalid_change ("Use `set-specifier' to change a specifier's value", |
600 sym); | |
428 | 601 |
996 | 602 if ( |
603 #ifdef HAVE_SHLIB | |
604 !(unloading_module && UNBOUNDP(newval)) && | |
605 #endif | |
606 (symbol_is_constant (sym, val) | |
5222
18c0b5909d16
Use keywords in structure syntax; new #define, NEED_TO_HANDLE_21_4_CODE 1
Aidan Kehoe <kehoea@parhasard.net>
parents:
5182
diff
changeset
|
607 #ifdef NEED_TO_HANDLE_21_4_CODE |
4793
8b50bee3c88c
Remove attempted support for 1996-era emacs without self-quoting keywords.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
608 || (SYMBOL_IS_KEYWORD (sym) && !EQ (newval, sym)) |
8b50bee3c88c
Remove attempted support for 1996-era emacs without self-quoting keywords.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
609 #endif |
8b50bee3c88c
Remove attempted support for 1996-era emacs without self-quoting keywords.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
610 )) |
563 | 611 signal_error_1 (Qsetting_constant, |
612 UNBOUNDP (newval) ? list1 (sym) : list2 (sym, newval)); | |
428 | 613 } |
614 | |
615 /* Verify that it's ok to make SYM buffer-local. This rejects | |
616 constants and default-buffer-local variables. FOLLOW_PAST_LISP_MAGIC | |
617 specifies whether we delve into symbol-value-lisp-magic objects. | |
618 (Should be a symbol indicating what action is being taken; that way, | |
619 we don't delve if there's a handler for that action, but do otherwise.) */ | |
620 | |
621 static void | |
622 verify_ok_for_buffer_local (Lisp_Object sym, | |
623 Lisp_Object follow_past_lisp_magic) | |
624 { | |
625 Lisp_Object val = fetch_value_maybe_past_magic (sym, follow_past_lisp_magic); | |
626 | |
627 if (symbol_is_constant (sym, val)) | |
628 goto not_ok; | |
629 if (SYMBOL_VALUE_MAGIC_P (val)) | |
630 switch (XSYMBOL_VALUE_MAGIC_TYPE (val)) | |
631 { | |
632 case SYMVAL_DEFAULT_BUFFER_FORWARD: | |
633 case SYMVAL_DEFAULT_CONSOLE_FORWARD: | |
634 /* #### It's theoretically possible for it to be reasonable | |
635 to have both console-local and buffer-local variables, | |
636 but I don't want to consider that right now. */ | |
637 case SYMVAL_SELECTED_CONSOLE_FORWARD: | |
638 goto not_ok; | |
639 default: break; /* Warning suppression */ | |
640 } | |
641 | |
642 return; | |
643 | |
644 not_ok: | |
563 | 645 invalid_change ("Symbol may not be buffer-local", sym); |
428 | 646 } |
647 | |
648 DEFUN ("makunbound", Fmakunbound, 1, 1, 0, /* | |
649 Make SYMBOL's value be void. | |
650 */ | |
651 (symbol)) | |
652 { | |
653 Fset (symbol, Qunbound); | |
654 return symbol; | |
655 } | |
656 | |
657 DEFUN ("fmakunbound", Ffmakunbound, 1, 1, 0, /* | |
658 Make SYMBOL's function definition be void. | |
659 */ | |
660 (symbol)) | |
661 { | |
662 CHECK_SYMBOL (symbol); | |
663 reject_constant_symbols (symbol, Qunbound, 1, Qt); | |
664 XSYMBOL (symbol)->function = Qunbound; | |
665 return symbol; | |
666 } | |
667 | |
668 DEFUN ("symbol-function", Fsymbol_function, 1, 1, 0, /* | |
669 Return SYMBOL's function definition. Error if that is void. | |
670 */ | |
671 (symbol)) | |
672 { | |
673 CHECK_SYMBOL (symbol); | |
674 if (UNBOUNDP (XSYMBOL (symbol)->function)) | |
675 signal_void_function_error (symbol); | |
676 return XSYMBOL (symbol)->function; | |
677 } | |
678 | |
679 DEFUN ("symbol-plist", Fsymbol_plist, 1, 1, 0, /* | |
680 Return SYMBOL's property list. | |
681 */ | |
682 (symbol)) | |
683 { | |
684 CHECK_SYMBOL (symbol); | |
685 return XSYMBOL (symbol)->plist; | |
686 } | |
687 | |
688 DEFUN ("symbol-name", Fsymbol_name, 1, 1, 0, /* | |
689 Return SYMBOL's name, a string. | |
690 */ | |
691 (symbol)) | |
692 { | |
693 CHECK_SYMBOL (symbol); | |
793 | 694 return XSYMBOL (symbol)->name; |
428 | 695 } |
696 | |
697 DEFUN ("fset", Ffset, 2, 2, 0, /* | |
698 Set SYMBOL's function definition to NEWDEF, and return NEWDEF. | |
699 */ | |
700 (symbol, newdef)) | |
701 { | |
702 /* This function can GC */ | |
703 CHECK_SYMBOL (symbol); | |
704 reject_constant_symbols (symbol, newdef, 1, Qt); | |
705 if (!NILP (Vautoload_queue) && !UNBOUNDP (XSYMBOL (symbol)->function)) | |
706 Vautoload_queue = Fcons (Fcons (symbol, XSYMBOL (symbol)->function), | |
707 Vautoload_queue); | |
708 XSYMBOL (symbol)->function = newdef; | |
709 /* Handle automatic advice activation */ | |
710 if (CONSP (XSYMBOL (symbol)->plist) && | |
711 !NILP (Fget (symbol, Qad_advice_info, Qnil))) | |
712 { | |
713 call2 (Qad_activate, symbol, Qnil); | |
714 newdef = XSYMBOL (symbol)->function; | |
715 } | |
716 return newdef; | |
717 } | |
718 | |
719 /* FSFmacs */ | |
720 DEFUN ("define-function", Fdefine_function, 2, 2, 0, /* | |
721 Set SYMBOL's function definition to NEWDEF, and return NEWDEF. | |
722 Associates the function with the current load file, if any. | |
4921
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
4905
diff
changeset
|
723 If NEWDEF is a compiled-function object, stores the function name in |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
4905
diff
changeset
|
724 the `annotated' slot of the compiled-function (retrievable using |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
4905
diff
changeset
|
725 `compiled-function-annotation'). |
428 | 726 */ |
727 (symbol, newdef)) | |
728 { | |
729 /* This function can GC */ | |
730 Ffset (symbol, newdef); | |
4535
69a1eda3da06
Distinguish vars and functions in #'symbol-file, #'describe-{function,variable}
Aidan Kehoe <kehoea@parhasard.net>
parents:
4503
diff
changeset
|
731 LOADHIST_ATTACH (Fcons (Qdefun, symbol)); |
4921
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
4905
diff
changeset
|
732 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
4905
diff
changeset
|
733 if (COMPILED_FUNCTIONP (newdef)) |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
4905
diff
changeset
|
734 XCOMPILED_FUNCTION (newdef)->annotated = symbol; |
17362f371cc2
add more byte-code assertions and better failure output
Ben Wing <ben@xemacs.org>
parents:
4905
diff
changeset
|
735 #endif /* COMPILED_FUNCTION_ANNOTATION_HACK */ |
428 | 736 return newdef; |
737 } | |
738 | |
3368 | 739 DEFUN ("subr-name", Fsubr_name, 1, 1, 0, /* |
740 Return name of function SUBR. | |
741 SUBR must be a built-in function. | |
742 */ | |
743 (subr)) | |
744 { | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
745 const Ascbyte *name; |
3497 | 746 CHECK_SUBR (subr); |
747 | |
3368 | 748 name = XSUBR (subr)->name; |
3379 | 749 return make_string ((const Ibyte *)name, strlen (name)); |
3368 | 750 } |
428 | 751 |
4905
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4793
diff
changeset
|
752 DEFUN ("special-operator-p", Fspecial_operator_p, 1, 1, 0, /* |
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4793
diff
changeset
|
753 Return whether SUBR is a special operator. |
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4793
diff
changeset
|
754 |
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4793
diff
changeset
|
755 A special operator is a built-in function (a subr, that is a function |
4337
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
756 implemented in C, not Lisp) which does not necessarily evaluate all its |
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
757 arguments. Much of the basic XEmacs Lisp syntax is implemented by means of |
4905
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4793
diff
changeset
|
758 special operators; examples are `let', `condition-case', `setq', and so |
4337
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
759 on. |
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
760 |
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
761 If you intend to write a Lisp function that does not necessarily evaluate |
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
762 all its arguments, the portable (across emacs variants, and across Lisp |
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
763 implementations) way to go about it is to write a macro instead. See |
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
764 `defmacro' and `backquote'. |
4336
cdc2f70d4319
Provide #'special-form-p, for the use of advice.el, perhaps other files.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3497
diff
changeset
|
765 */ |
cdc2f70d4319
Provide #'special-form-p, for the use of advice.el, perhaps other files.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3497
diff
changeset
|
766 (subr)) |
cdc2f70d4319
Provide #'special-form-p, for the use of advice.el, perhaps other files.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3497
diff
changeset
|
767 { |
4337
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
768 subr = indirect_function (subr, 0); |
c32e4dca0296
#'special-form-p; don't error (thank you Jerry James); flesh out docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4336
diff
changeset
|
769 return (SUBRP (subr) && XSUBR (subr)->max_args == UNEVALLED) ? Qt : Qnil; |
4336
cdc2f70d4319
Provide #'special-form-p, for the use of advice.el, perhaps other files.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3497
diff
changeset
|
770 } |
cdc2f70d4319
Provide #'special-form-p, for the use of advice.el, perhaps other files.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3497
diff
changeset
|
771 |
428 | 772 DEFUN ("setplist", Fsetplist, 2, 2, 0, /* |
773 Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. | |
774 */ | |
775 (symbol, newplist)) | |
776 { | |
777 CHECK_SYMBOL (symbol); | |
778 | |
779 XSYMBOL (symbol)->plist = newplist; | |
780 return newplist; | |
781 } | |
782 | |
783 | |
784 /**********************************************************************/ | |
785 /* symbol-value */ | |
786 /**********************************************************************/ | |
787 | |
4940
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
788 /* |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
789 NOTE NOTE NOTE: |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
790 --------------- |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
791 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
792 There are various different uses of "magic" with regard to symbols, |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
793 and they need to be distinguished: |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
794 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
795 1. `symbol-value-magic' class of objects (struct symbol_value_magic): |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
796 A set of Lisp object types used as the value of a variable with any |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
797 behavior other than just a plain repository of a value. This |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
798 includes buffer-local variables, console-local variables, read-only |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
799 variables, variable aliases, variables that are linked to a C |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
800 variable, etc. The more specific types are: |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
801 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
802 -- `symbol-value-forward': Variables that forward to a C variable. |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
803 NOTE:This includes built-in buffer-local and console-local |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
804 variables, since they forward to an element in a buffer or |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
805 console structure. |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
806 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
807 -- `symbol-value-buffer-local': Variables on which |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
808 `make-local-variable' or `make-variable-buffer-local' have |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
809 been called. |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
810 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
811 -- `symbol-value-lisp-magic': See below. |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
812 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
813 -- `symbol-value-varalias': Variable aliases. |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
814 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
815 2. `symbol-value-lisp-magic': Variables on which |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
816 `dontusethis-set-symbol-value-handler' have been called. These |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
817 variables are extra-magic in that operations that would normally |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
818 change their value instead get forwarded out to Lisp handlers, |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
819 which can do anything they want. (NOTE: Handlers for getting a |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
820 variable's value aren't implemented yet.) |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
821 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
822 3. "magicfun" handlers on C-forwarding variables, declared with any |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
823 of the following: |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
824 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
825 -- DEFVAR_LISP_MAGIC |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
826 -- DEFVAR_INT_MAGIC |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
827 -- DEFVAR_BOOL_MAGIC, |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
828 -- DEFVAR_BUFFER_LOCAL_MAGIC |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
829 -- DEFVAR_BUFFER_DEFAULTS_MAGIC |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
830 -- DEFVAR_CONSOLE_LOCAL_MAGIC |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
831 -- DEFVAR_CONSOLE_DEFAULTS_MAGIC |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
832 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
833 Here, the "magic function" is a handler that is notified whenever the |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
834 value of a variable is changed, so that some other updating can take |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
835 place (e.g. setting redisplay-related dirty bits, updating a cache, |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
836 etc.). |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
837 |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
838 Note that DEFVAR_LISP_MAGIC does *NOT* have anything to do with |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
839 `symbol-value-lisp-magic'. The former refers to variables that can |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
840 hold an arbitrary Lisp object and forward to a C variable declared |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
841 `Lisp_Object foo', and have a "magicfun" as just described; the |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
842 latter are variables that have Lisp-level handlers that function |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
843 in *PLACE* of normal variable-setting mechanisms, and are established |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
844 with `dontusethis-set-symbol-value-handler', as described above. |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
845 */ |
9113c5044de8
(for main branch) add long comment about types of magic symbols
Ben Wing <ben@xemacs.org>
parents:
4793
diff
changeset
|
846 |
428 | 847 /* If the contents of the value cell of a symbol is one of the following |
848 three types of objects, then the symbol is "magic" in that setting | |
849 and retrieving its value doesn't just set or retrieve the raw | |
850 contents of the value cell. None of these objects can escape to | |
851 the user level, so there is no loss of generality. | |
852 | |
853 If a symbol is "unbound", then the contents of its value cell is | |
854 Qunbound. Despite appearances, this is *not* a symbol, but is a | |
855 symbol-value-forward object. This is so that printing it results | |
856 in "INTERNAL OBJECT (XEmacs bug?)", in case it leaks to Lisp, somehow. | |
857 | |
858 Logically all of the following objects are "symbol-value-magic" | |
859 objects, and there are some games played w.r.t. this (#### this | |
860 should be cleaned up). SYMBOL_VALUE_MAGIC_P is true for all of | |
861 the object types. XSYMBOL_VALUE_MAGIC_TYPE returns the type of | |
862 symbol-value-magic object. There are more than three types | |
863 returned by this macro: in particular, symbol-value-forward | |
864 has eight subtypes, and symbol-value-buffer-local has two. See | |
865 symeval.h. | |
866 | |
867 1. symbol-value-forward | |
868 | |
869 symbol-value-forward is used for variables whose actual contents | |
870 are stored in a C variable of some sort, and for Qunbound. The | |
871 lcheader.next field (which is only used to chain together free | |
872 lcrecords) holds a pointer to the actual C variable. Included | |
873 in this type are "buffer-local" variables that are actually | |
874 stored in the buffer object itself; in this case, the "pointer" | |
875 is an offset into the struct buffer structure. | |
876 | |
877 The subtypes are as follows: | |
878 | |
879 SYMVAL_OBJECT_FORWARD: | |
880 (declare with DEFVAR_LISP) | |
881 The value of this variable is stored in a C variable of type | |
882 "Lisp_Object". Setting this variable sets the C variable. | |
883 Accessing this variable retrieves a value from the C variable. | |
884 These variables can be buffer-local -- in this case, the | |
885 raw symbol-value field gets converted into a | |
886 symbol-value-buffer-local, whose "current_value" slot contains | |
887 the symbol-value-forward. (See below.) | |
888 | |
889 SYMVAL_FIXNUM_FORWARD: | |
458 | 890 (declare with DEFVAR_INT) |
891 Similar to SYMVAL_OBJECT_FORWARD except that the C variable | |
892 is of type "Fixnum", a typedef for "EMACS_INT", and the corresponding | |
893 lisp variable is always the corresponding integer. | |
894 | |
428 | 895 SYMVAL_BOOLEAN_FORWARD: |
458 | 896 (declare with DEFVAR_BOOL) |
428 | 897 Similar to SYMVAL_OBJECT_FORWARD except that the C variable |
458 | 898 is of type "int" and is a boolean. |
428 | 899 |
900 SYMVAL_CONST_OBJECT_FORWARD: | |
901 SYMVAL_CONST_FIXNUM_FORWARD: | |
902 SYMVAL_CONST_BOOLEAN_FORWARD: | |
903 (declare with DEFVAR_CONST_LISP, DEFVAR_CONST_INT, or | |
904 DEFVAR_CONST_BOOL) | |
905 Similar to SYMVAL_OBJECT_FORWARD, SYMVAL_FIXNUM_FORWARD, or | |
906 SYMVAL_BOOLEAN_FORWARD, respectively, except that the value cannot | |
907 be changed. | |
908 | |
909 SYMVAL_CONST_SPECIFIER_FORWARD: | |
910 (declare with DEFVAR_SPECIFIER) | |
440 | 911 Exactly like SYMVAL_CONST_OBJECT_FORWARD except that the error |
912 message you get when attempting to set the value says to use | |
428 | 913 `set-specifier' instead. |
914 | |
915 SYMVAL_CURRENT_BUFFER_FORWARD: | |
916 (declare with DEFVAR_BUFFER_LOCAL) | |
917 This is used for built-in buffer-local variables -- i.e. | |
918 Lisp variables whose value is stored in the "struct buffer". | |
919 Variables of this sort always forward into C "Lisp_Object" | |
920 fields (although there's no reason in principle that other | |
921 types for ints and booleans couldn't be added). Note that | |
922 some of these variables are automatically local in each | |
923 buffer, while some are only local when they become set | |
924 (similar to `make-variable-buffer-local'). In these latter | |
925 cases, of course, the default value shows through in all | |
926 buffers in which the variable doesn't have a local value. | |
927 This is implemented by making sure the "struct buffer" field | |
928 always contains the correct value (whether it's local or | |
929 a default) and maintaining a mask in the "struct buffer" | |
930 indicating which fields are local. When `set-default' is | |
931 called on a variable that's not always local to all buffers, | |
932 it loops through each buffer and sets the corresponding | |
933 field in each buffer without a local value for the field, | |
934 according to the mask. | |
935 | |
936 Calling `make-local-variable' on a variable of this sort | |
937 only has the effect of maybe changing the current buffer's mask. | |
938 Calling `make-variable-buffer-local' on a variable of this | |
939 sort has no effect at all. | |
940 | |
941 SYMVAL_CONST_CURRENT_BUFFER_FORWARD: | |
942 (declare with DEFVAR_CONST_BUFFER_LOCAL) | |
943 Same as SYMVAL_CURRENT_BUFFER_FORWARD except that the | |
944 value cannot be set. | |
945 | |
946 SYMVAL_DEFAULT_BUFFER_FORWARD: | |
947 (declare with DEFVAR_BUFFER_DEFAULTS) | |
948 This is used for the Lisp variables that contain the | |
949 default values of built-in buffer-local variables. Setting | |
950 or referencing one of these variables forwards into a slot | |
951 in the special struct buffer Vbuffer_defaults. | |
952 | |
953 SYMVAL_UNBOUND_MARKER: | |
954 This is used for only one object, Qunbound. | |
955 | |
956 SYMVAL_SELECTED_CONSOLE_FORWARD: | |
957 (declare with DEFVAR_CONSOLE_LOCAL) | |
958 This is used for built-in console-local variables -- i.e. | |
959 Lisp variables whose value is stored in the "struct console". | |
960 These work just like built-in buffer-local variables. | |
961 However, calling `make-local-variable' or | |
962 `make-variable-buffer-local' on one of these variables | |
963 is currently disallowed because that would entail having | |
964 both console-local and buffer-local variables, which is | |
965 trickier to implement. | |
966 | |
967 SYMVAL_CONST_SELECTED_CONSOLE_FORWARD: | |
968 (declare with DEFVAR_CONST_CONSOLE_LOCAL) | |
969 Same as SYMVAL_SELECTED_CONSOLE_FORWARD except that the | |
970 value cannot be set. | |
971 | |
972 SYMVAL_DEFAULT_CONSOLE_FORWARD: | |
973 (declare with DEFVAR_CONSOLE_DEFAULTS) | |
974 This is used for the Lisp variables that contain the | |
975 default values of built-in console-local variables. Setting | |
976 or referencing one of these variables forwards into a slot | |
977 in the special struct console Vconsole_defaults. | |
978 | |
979 | |
980 2. symbol-value-buffer-local | |
981 | |
982 symbol-value-buffer-local is used for variables that have had | |
983 `make-local-variable' or `make-variable-buffer-local' applied | |
984 to them. This object contains an alist mapping buffers to | |
985 values. In addition, the object contains a "current value", | |
986 which is the value in some buffer. Whenever you access the | |
987 variable with `symbol-value' or set it with `set' or `setq', | |
988 things are switched around so that the "current value" | |
989 refers to the current buffer, if it wasn't already. This | |
990 way, repeated references to a variable in the same buffer | |
991 are almost as efficient as if the variable weren't buffer | |
992 local. Note that the alist may not be up-to-date w.r.t. | |
993 the buffer whose value is current, as the "current value" | |
994 cache is normally only flushed into the alist when the | |
995 buffer it refers to changes. | |
996 | |
997 Note also that it is possible for `make-local-variable' | |
998 or `make-variable-buffer-local' to be called on a variable | |
999 that forwards into a C variable (i.e. a variable whose | |
1000 value cell is a symbol-value-forward). In this case, | |
1001 the value cell becomes a symbol-value-buffer-local (as | |
1002 always), and the symbol-value-forward moves into | |
1003 the "current value" cell in this object. Also, in | |
1004 this case the "current value" *always* refers to the | |
1005 current buffer, so that the values of the C variable | |
1006 always is the correct value for the current buffer. | |
1007 set_buffer_internal() automatically updates the current-value | |
1008 cells of all buffer-local variables that forward into C | |
1009 variables. (There is a list of all buffer-local variables | |
1010 that is maintained for this and other purposes.) | |
1011 | |
1012 Note that only certain types of `symbol-value-forward' objects | |
1013 can find their way into the "current value" cell of a | |
1014 `symbol-value-buffer-local' object: SYMVAL_OBJECT_FORWARD, | |
1015 SYMVAL_FIXNUM_FORWARD, SYMVAL_BOOLEAN_FORWARD, and | |
1016 SYMVAL_UNBOUND_MARKER. The SYMVAL_CONST_*_FORWARD cannot | |
1017 be buffer-local because they are unsettable; | |
1018 SYMVAL_DEFAULT_*_FORWARD cannot be buffer-local because that | |
1019 makes no sense; making SYMVAL_CURRENT_BUFFER_FORWARD buffer-local | |
1020 does not have much of an effect (it's already buffer-local); and | |
1021 SYMVAL_SELECTED_CONSOLE_FORWARD cannot be buffer-local because | |
1022 that's not currently implemented. | |
1023 | |
1024 | |
1025 3. symbol-value-varalias | |
1026 | |
1027 A symbol-value-varalias object is used for variables that | |
1028 are aliases for other variables. This object contains | |
1029 the symbol that this variable is aliased to. | |
1030 symbol-value-varalias objects cannot occur anywhere within | |
1031 a symbol-value-buffer-local object, and most of the | |
1032 low-level functions below do not accept them; you need | |
1033 to call follow_varalias_pointers to get the actual | |
1034 symbol to operate on. */ | |
1035 | |
1204 | 1036 static const struct memory_description symbol_value_buffer_local_description[] = { |
1037 { XD_LISP_OBJECT, offsetof (struct symbol_value_buffer_local, default_value) }, | |
1038 { XD_LISP_OBJECT, offsetof (struct symbol_value_buffer_local, current_value) }, | |
1039 { XD_LISP_OBJECT, offsetof (struct symbol_value_buffer_local, current_buffer) }, | |
1040 { XD_LISP_OBJECT, offsetof (struct symbol_value_buffer_local, current_alist_element) }, | |
1041 { XD_END } | |
1042 }; | |
1043 | |
428 | 1044 static Lisp_Object |
1045 mark_symbol_value_buffer_local (Lisp_Object obj) | |
1046 { | |
1047 struct symbol_value_buffer_local *bfwd; | |
1048 | |
800 | 1049 #ifdef ERROR_CHECK_TYPES |
428 | 1050 assert (XSYMBOL_VALUE_MAGIC_TYPE (obj) == SYMVAL_BUFFER_LOCAL || |
1051 XSYMBOL_VALUE_MAGIC_TYPE (obj) == SYMVAL_SOME_BUFFER_LOCAL); | |
1052 #endif | |
1053 | |
1054 bfwd = XSYMBOL_VALUE_BUFFER_LOCAL (obj); | |
1055 mark_object (bfwd->default_value); | |
1056 mark_object (bfwd->current_value); | |
1057 mark_object (bfwd->current_buffer); | |
1058 return bfwd->current_alist_element; | |
1059 } | |
1060 | |
1204 | 1061 |
1062 static const struct memory_description symbol_value_lisp_magic_description[] = { | |
1063 { XD_LISP_OBJECT_ARRAY, offsetof (struct symbol_value_lisp_magic, handler), MAGIC_HANDLER_MAX }, | |
1064 { XD_LISP_OBJECT_ARRAY, offsetof (struct symbol_value_lisp_magic, harg), MAGIC_HANDLER_MAX }, | |
1065 { XD_LISP_OBJECT, offsetof (struct symbol_value_lisp_magic, shadowed) }, | |
1066 { XD_END } | |
1067 }; | |
1068 | |
428 | 1069 static Lisp_Object |
1070 mark_symbol_value_lisp_magic (Lisp_Object obj) | |
1071 { | |
1072 struct symbol_value_lisp_magic *bfwd; | |
1073 int i; | |
1074 | |
1075 assert (XSYMBOL_VALUE_MAGIC_TYPE (obj) == SYMVAL_LISP_MAGIC); | |
1076 | |
1077 bfwd = XSYMBOL_VALUE_LISP_MAGIC (obj); | |
1078 for (i = 0; i < MAGIC_HANDLER_MAX; i++) | |
1079 { | |
1080 mark_object (bfwd->handler[i]); | |
1081 mark_object (bfwd->harg[i]); | |
1082 } | |
1083 return bfwd->shadowed; | |
1084 } | |
1085 | |
1204 | 1086 static const struct memory_description symbol_value_varalias_description[] = { |
1087 { XD_LISP_OBJECT, offsetof (struct symbol_value_varalias, aliasee) }, | |
1088 { XD_LISP_OBJECT, offsetof (struct symbol_value_varalias, shadowed) }, | |
1089 { XD_END } | |
1090 }; | |
1091 | |
428 | 1092 static Lisp_Object |
1093 mark_symbol_value_varalias (Lisp_Object obj) | |
1094 { | |
1095 struct symbol_value_varalias *bfwd; | |
1096 | |
1097 assert (XSYMBOL_VALUE_MAGIC_TYPE (obj) == SYMVAL_VARALIAS); | |
1098 | |
1099 bfwd = XSYMBOL_VALUE_VARALIAS (obj); | |
1100 mark_object (bfwd->shadowed); | |
1101 return bfwd->aliasee; | |
1102 } | |
1103 | |
1104 /* Should never, ever be called. (except by an external debugger) */ | |
1105 void | |
2286 | 1106 print_symbol_value_magic (Lisp_Object obj, Lisp_Object printcharfun, |
1107 int UNUSED (escapeflag)) | |
428 | 1108 { |
800 | 1109 write_fmt_string (printcharfun, |
5146
88bd4f3ef8e4
make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c
Ben Wing <ben@xemacs.org>
parents:
5142
diff
changeset
|
1110 "#<INTERNAL OBJECT (XEmacs bug?) (%s type %d) 0x%x>", |
800 | 1111 XRECORD_LHEADER_IMPLEMENTATION (obj)->name, |
1112 XSYMBOL_VALUE_MAGIC_TYPE (obj), | |
5146
88bd4f3ef8e4
make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c
Ben Wing <ben@xemacs.org>
parents:
5142
diff
changeset
|
1113 LISP_OBJECT_UID (obj)); |
428 | 1114 } |
1115 | |
1204 | 1116 static const struct memory_description symbol_value_forward_description[] = { |
428 | 1117 { XD_END } |
1118 }; | |
1119 | |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1120 DEFINE_DUMPABLE_LISP_OBJECT ("symbol-value-forward", |
5124
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1121 symbol_value_forward, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1122 0, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1123 print_symbol_value_magic, 0, 0, 0, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1124 symbol_value_forward_description, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1125 struct symbol_value_forward); |
934 | 1126 |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1127 DEFINE_DUMPABLE_LISP_OBJECT ("symbol-value-buffer-local", |
5124
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1128 symbol_value_buffer_local, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1129 mark_symbol_value_buffer_local, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1130 print_symbol_value_magic, 0, 0, 0, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1131 symbol_value_buffer_local_description, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1132 struct symbol_value_buffer_local); |
934 | 1133 |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1134 DEFINE_DUMPABLE_LISP_OBJECT ("symbol-value-lisp-magic", |
5124
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1135 symbol_value_lisp_magic, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1136 mark_symbol_value_lisp_magic, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1137 print_symbol_value_magic, 0, 0, 0, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1138 symbol_value_lisp_magic_description, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1139 struct symbol_value_lisp_magic); |
934 | 1140 |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
1141 DEFINE_DUMPABLE_LISP_OBJECT ("symbol-value-varalias", |
5124
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1142 symbol_value_varalias, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1143 mark_symbol_value_varalias, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1144 print_symbol_value_magic, 0, 0, 0, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1145 symbol_value_varalias_description, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5118
diff
changeset
|
1146 struct symbol_value_varalias); |
934 | 1147 |
428 | 1148 |
1149 /* Getting and setting values of symbols */ | |
1150 | |
1151 /* Given the raw contents of a symbol value cell, return the Lisp value of | |
1152 the symbol. However, VALCONTENTS cannot be a symbol-value-buffer-local, | |
1153 symbol-value-lisp-magic, or symbol-value-varalias. | |
1154 | |
1155 BUFFER specifies a buffer, and is used for built-in buffer-local | |
1156 variables, which are of type SYMVAL_CURRENT_BUFFER_FORWARD. | |
1157 Note that such variables are never encapsulated in a | |
1158 symbol-value-buffer-local structure. | |
1159 | |
1160 CONSOLE specifies a console, and is used for built-in console-local | |
1161 variables, which are of type SYMVAL_SELECTED_CONSOLE_FORWARD. | |
1162 Note that such variables are (currently) never encapsulated in a | |
1163 symbol-value-buffer-local structure. | |
1164 */ | |
1165 | |
1166 static Lisp_Object | |
1167 do_symval_forwarding (Lisp_Object valcontents, struct buffer *buffer, | |
1168 struct console *console) | |
1169 { | |
442 | 1170 const struct symbol_value_forward *fwd; |
428 | 1171 |
1172 if (!SYMBOL_VALUE_MAGIC_P (valcontents)) | |
1173 return valcontents; | |
1174 | |
1175 fwd = XSYMBOL_VALUE_FORWARD (valcontents); | |
1176 switch (fwd->magic.type) | |
1177 { | |
1178 case SYMVAL_FIXNUM_FORWARD: | |
1179 case SYMVAL_CONST_FIXNUM_FORWARD: | |
458 | 1180 return make_int (*((Fixnum *)symbol_value_forward_forward (fwd))); |
428 | 1181 |
1182 case SYMVAL_BOOLEAN_FORWARD: | |
1183 case SYMVAL_CONST_BOOLEAN_FORWARD: | |
1184 return *((int *)symbol_value_forward_forward (fwd)) ? Qt : Qnil; | |
1185 | |
1186 case SYMVAL_OBJECT_FORWARD: | |
1187 case SYMVAL_CONST_OBJECT_FORWARD: | |
1188 case SYMVAL_CONST_SPECIFIER_FORWARD: | |
1189 return *((Lisp_Object *)symbol_value_forward_forward (fwd)); | |
1190 | |
1191 case SYMVAL_DEFAULT_BUFFER_FORWARD: | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1192 return (*((Lisp_Object *)((Rawbyte *) XBUFFER (Vbuffer_defaults) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1193 + ((Rawbyte *)symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1194 - (Rawbyte *)&buffer_local_flags)))); |
428 | 1195 |
1196 | |
1197 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
1198 case SYMVAL_CONST_CURRENT_BUFFER_FORWARD: | |
1199 assert (buffer); | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1200 return (*((Lisp_Object *)((Rawbyte *)buffer |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1201 + ((Rawbyte *)symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1202 - (Rawbyte *)&buffer_local_flags)))); |
428 | 1203 |
1204 case SYMVAL_DEFAULT_CONSOLE_FORWARD: | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1205 return (*((Lisp_Object *)((Rawbyte *) XCONSOLE (Vconsole_defaults) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1206 + ((Rawbyte *)symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1207 - (Rawbyte *)&console_local_flags)))); |
428 | 1208 |
1209 case SYMVAL_SELECTED_CONSOLE_FORWARD: | |
1210 case SYMVAL_CONST_SELECTED_CONSOLE_FORWARD: | |
1211 assert (console); | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1212 return (*((Lisp_Object *)((Rawbyte *)console |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1213 + ((Rawbyte *)symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1214 - (Rawbyte *)&console_local_flags)))); |
428 | 1215 |
1216 case SYMVAL_UNBOUND_MARKER: | |
1217 return valcontents; | |
1218 | |
1219 default: | |
2500 | 1220 ABORT (); |
428 | 1221 } |
1222 return Qnil; /* suppress compiler warning */ | |
1223 } | |
1224 | |
1225 /* Set the value of default-buffer-local variable SYM to VALUE. */ | |
1226 | |
1227 static void | |
1228 set_default_buffer_slot_variable (Lisp_Object sym, | |
1229 Lisp_Object value) | |
1230 { | |
1231 /* Handle variables like case-fold-search that have special slots in | |
1232 the buffer. Make them work apparently like buffer_local variables. | |
1233 */ | |
1234 /* At this point, the value cell may not contain a symbol-value-varalias | |
1235 or symbol-value-buffer-local, and if there's a handler, we should | |
1236 have already called it. */ | |
1237 Lisp_Object valcontents = fetch_value_maybe_past_magic (sym, Qt); | |
442 | 1238 const struct symbol_value_forward *fwd |
428 | 1239 = XSYMBOL_VALUE_FORWARD (valcontents); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1240 int offset = ((Rawbyte *) symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1241 - (Rawbyte *) &buffer_local_flags); |
428 | 1242 int mask = XINT (*((Lisp_Object *) symbol_value_forward_forward (fwd))); |
1243 int (*magicfun) (Lisp_Object simm, Lisp_Object *val, Lisp_Object in_object, | |
1244 int flags) = symbol_value_forward_magicfun (fwd); | |
1245 | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1246 *((Lisp_Object *) (offset + (Rawbyte *) XBUFFER (Vbuffer_defaults))) |
428 | 1247 = value; |
1248 | |
1249 if (mask > 0) /* Not always per-buffer */ | |
1250 { | |
1251 /* Set value in each buffer which hasn't shadowed the default */ | |
1252 LIST_LOOP_2 (elt, Vbuffer_alist) | |
1253 { | |
1254 struct buffer *b = XBUFFER (XCDR (elt)); | |
1255 if (!(b->local_var_flags & mask)) | |
1256 { | |
1257 if (magicfun) | |
771 | 1258 magicfun (sym, &value, wrap_buffer (b), 0); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1259 *((Lisp_Object *) (offset + (Rawbyte *) b)) = value; |
428 | 1260 } |
1261 } | |
1262 } | |
1263 } | |
1264 | |
1265 /* Set the value of default-console-local variable SYM to VALUE. */ | |
1266 | |
1267 static void | |
1268 set_default_console_slot_variable (Lisp_Object sym, | |
1269 Lisp_Object value) | |
1270 { | |
1271 /* Handle variables like case-fold-search that have special slots in | |
1272 the console. Make them work apparently like console_local variables. | |
1273 */ | |
1274 /* At this point, the value cell may not contain a symbol-value-varalias | |
1275 or symbol-value-buffer-local, and if there's a handler, we should | |
1276 have already called it. */ | |
1277 Lisp_Object valcontents = fetch_value_maybe_past_magic (sym, Qt); | |
442 | 1278 const struct symbol_value_forward *fwd |
428 | 1279 = XSYMBOL_VALUE_FORWARD (valcontents); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1280 int offset = ((Rawbyte *) symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1281 - (Rawbyte *) &console_local_flags); |
428 | 1282 int mask = XINT (*((Lisp_Object *) symbol_value_forward_forward (fwd))); |
1283 int (*magicfun) (Lisp_Object simm, Lisp_Object *val, Lisp_Object in_object, | |
1284 int flags) = symbol_value_forward_magicfun (fwd); | |
1285 | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1286 *((Lisp_Object *) (offset + (Rawbyte *) XCONSOLE (Vconsole_defaults))) |
428 | 1287 = value; |
1288 | |
1289 if (mask > 0) /* Not always per-console */ | |
1290 { | |
1291 /* Set value in each console which hasn't shadowed the default */ | |
1292 LIST_LOOP_2 (console, Vconsole_list) | |
1293 { | |
1294 struct console *d = XCONSOLE (console); | |
1295 if (!(d->local_var_flags & mask)) | |
1296 { | |
1297 if (magicfun) | |
1298 magicfun (sym, &value, console, 0); | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1299 *((Lisp_Object *) (offset + (Rawbyte *) d)) = value; |
428 | 1300 } |
1301 } | |
1302 } | |
1303 } | |
1304 | |
1305 /* Store NEWVAL into SYM. | |
1306 | |
1307 SYM's value slot may *not* be types (5) or (6) above, | |
1308 i.e. no symbol-value-varalias objects. (You should have | |
1309 forwarded past all of these.) | |
1310 | |
1311 SYM should not be an unsettable symbol or a symbol with | |
1312 a magic `set-value' handler (unless you want to explicitly | |
1313 ignore this handler). | |
1314 | |
1315 OVALUE is the current value of SYM, but forwarded past any | |
1316 symbol-value-buffer-local and symbol-value-lisp-magic objects. | |
1317 (i.e. if SYM is a symbol-value-buffer-local, OVALUE should be | |
1318 the contents of its current-value cell.) NEWVAL may only be | |
1319 a simple value or Qunbound. If SYM is a symbol-value-buffer-local, | |
1320 this function will only modify its current-value cell, which should | |
1321 already be set up to point to the current buffer. | |
1322 */ | |
1323 | |
1324 static void | |
1325 store_symval_forwarding (Lisp_Object sym, Lisp_Object ovalue, | |
1326 Lisp_Object newval) | |
1327 { | |
1328 if (!SYMBOL_VALUE_MAGIC_P (ovalue) || UNBOUNDP (ovalue)) | |
1329 { | |
1330 Lisp_Object *store_pointer = value_slot_past_magic (sym); | |
1331 | |
1332 if (SYMBOL_VALUE_BUFFER_LOCAL_P (*store_pointer)) | |
1333 store_pointer = | |
1334 &XSYMBOL_VALUE_BUFFER_LOCAL (*store_pointer)->current_value; | |
1335 | |
1336 assert (UNBOUNDP (*store_pointer) | |
1337 || !SYMBOL_VALUE_MAGIC_P (*store_pointer)); | |
1338 *store_pointer = newval; | |
1339 } | |
1340 else | |
1341 { | |
442 | 1342 const struct symbol_value_forward *fwd = XSYMBOL_VALUE_FORWARD (ovalue); |
428 | 1343 int (*magicfun) (Lisp_Object simm, Lisp_Object *val, |
1344 Lisp_Object in_object, int flags) | |
1345 = symbol_value_forward_magicfun (fwd); | |
1346 | |
1347 switch (XSYMBOL_VALUE_MAGIC_TYPE (ovalue)) | |
1348 { | |
1349 case SYMVAL_FIXNUM_FORWARD: | |
1350 CHECK_INT (newval); | |
1351 if (magicfun) | |
1352 magicfun (sym, &newval, Qnil, 0); | |
458 | 1353 *((Fixnum *) symbol_value_forward_forward (fwd)) = XINT (newval); |
428 | 1354 return; |
1355 | |
1356 case SYMVAL_BOOLEAN_FORWARD: | |
1357 if (magicfun) | |
1358 magicfun (sym, &newval, Qnil, 0); | |
1359 *((int *) symbol_value_forward_forward (fwd)) | |
1360 = !NILP (newval); | |
1361 return; | |
1362 | |
1363 case SYMVAL_OBJECT_FORWARD: | |
1364 if (magicfun) | |
1365 magicfun (sym, &newval, Qnil, 0); | |
1366 *((Lisp_Object *) symbol_value_forward_forward (fwd)) = newval; | |
1367 return; | |
1368 | |
1369 case SYMVAL_DEFAULT_BUFFER_FORWARD: | |
1370 set_default_buffer_slot_variable (sym, newval); | |
1371 return; | |
1372 | |
1373 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
1374 if (magicfun) | |
771 | 1375 magicfun (sym, &newval, wrap_buffer (current_buffer), 0); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1376 *((Lisp_Object *) ((Rawbyte *) current_buffer |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1377 + ((Rawbyte *) symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1378 - (Rawbyte *) &buffer_local_flags))) |
428 | 1379 = newval; |
1380 return; | |
1381 | |
1382 case SYMVAL_DEFAULT_CONSOLE_FORWARD: | |
1383 set_default_console_slot_variable (sym, newval); | |
1384 return; | |
1385 | |
1386 case SYMVAL_SELECTED_CONSOLE_FORWARD: | |
1387 if (magicfun) | |
1388 magicfun (sym, &newval, Vselected_console, 0); | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1389 *((Lisp_Object *) ((Rawbyte *) XCONSOLE (Vselected_console) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1390 + ((Rawbyte *) symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
1391 - (Rawbyte *) &console_local_flags))) |
428 | 1392 = newval; |
1393 return; | |
1394 | |
1395 default: | |
2500 | 1396 ABORT (); |
428 | 1397 } |
1398 } | |
1399 } | |
1400 | |
1401 /* Given a per-buffer variable SYMBOL and its raw value-cell contents | |
1402 BFWD, locate and return a pointer to the element in BUFFER's | |
1403 local_var_alist for SYMBOL. The return value will be Qnil if | |
1404 BUFFER does not have its own value for SYMBOL (i.e. the default | |
1405 value is seen in that buffer). | |
1406 */ | |
1407 | |
1408 static Lisp_Object | |
1409 buffer_local_alist_element (struct buffer *buffer, Lisp_Object symbol, | |
1410 struct symbol_value_buffer_local *bfwd) | |
1411 { | |
1412 if (!NILP (bfwd->current_buffer) && | |
1413 XBUFFER (bfwd->current_buffer) == buffer) | |
1414 /* This is just an optimization of the below. */ | |
1415 return bfwd->current_alist_element; | |
1416 else | |
1417 return assq_no_quit (symbol, buffer->local_var_alist); | |
1418 } | |
1419 | |
1420 /* [Remember that the slot that mirrors CURRENT-VALUE in the | |
1421 symbol-value-buffer-local of a per-buffer variable -- i.e. the | |
1422 slot in CURRENT-BUFFER's local_var_alist, or the DEFAULT-VALUE | |
1423 slot -- may be out of date.] | |
1424 | |
1425 Write out any cached value in buffer-local variable SYMBOL's | |
1426 buffer-local structure, which is passed in as BFWD. | |
1427 */ | |
1428 | |
1429 static void | |
2286 | 1430 write_out_buffer_local_cache (Lisp_Object UNUSED (symbol), |
428 | 1431 struct symbol_value_buffer_local *bfwd) |
1432 { | |
1433 if (!NILP (bfwd->current_buffer)) | |
1434 { | |
1435 /* We pass 0 for BUFFER because only SYMVAL_CURRENT_BUFFER_FORWARD | |
1436 uses it, and that type cannot be inside a symbol-value-buffer-local */ | |
1437 Lisp_Object cval = do_symval_forwarding (bfwd->current_value, 0, 0); | |
1438 if (NILP (bfwd->current_alist_element)) | |
1439 /* current_value may be updated more recently than default_value */ | |
1440 bfwd->default_value = cval; | |
1441 else | |
1442 Fsetcdr (bfwd->current_alist_element, cval); | |
1443 } | |
1444 } | |
1445 | |
1446 /* SYM is a buffer-local variable, and BFWD is its buffer-local structure. | |
1447 Set up BFWD's cache for validity in buffer BUF. This assumes that | |
1448 the cache is currently in a consistent state (this can include | |
1449 not having any value cached, if BFWD->CURRENT_BUFFER is nil). | |
1450 | |
1451 If the cache is already set up for BUF, this function does nothing | |
1452 at all. | |
1453 | |
1454 Otherwise, if SYM forwards out to a C variable, this also forwards | |
1455 SYM's value in BUF out to the variable. Therefore, you generally | |
1456 only want to call this when BUF is, or is about to become, the | |
1457 current buffer. | |
1458 | |
1459 (Otherwise, you can just retrieve the value without changing the | |
1460 cache, at the expense of slower retrieval.) | |
1461 */ | |
1462 | |
1463 static void | |
1464 set_up_buffer_local_cache (Lisp_Object sym, | |
1465 struct symbol_value_buffer_local *bfwd, | |
1466 struct buffer *buf, | |
1467 Lisp_Object new_alist_el, | |
1468 int set_it_p) | |
1469 { | |
1470 Lisp_Object new_val; | |
1471 | |
1472 if (!NILP (bfwd->current_buffer) | |
1473 && buf == XBUFFER (bfwd->current_buffer)) | |
1474 /* Cache is already set up. */ | |
1475 return; | |
1476 | |
1477 /* Flush out the old cache. */ | |
1478 write_out_buffer_local_cache (sym, bfwd); | |
1479 | |
1480 /* Retrieve the new alist element and new value. */ | |
1481 if (NILP (new_alist_el) | |
1482 && set_it_p) | |
1483 new_alist_el = buffer_local_alist_element (buf, sym, bfwd); | |
1484 | |
1485 if (NILP (new_alist_el)) | |
1486 new_val = bfwd->default_value; | |
1487 else | |
1488 new_val = Fcdr (new_alist_el); | |
1489 | |
1490 bfwd->current_alist_element = new_alist_el; | |
793 | 1491 bfwd->current_buffer = wrap_buffer (buf); |
428 | 1492 |
1493 /* Now store the value into the current-value slot. | |
1494 We don't simply write it there, because the current-value | |
1495 slot might be a forwarding pointer, in which case we need | |
1496 to instead write the value into the C variable. | |
1497 | |
1498 We might also want to call a magic function. | |
1499 | |
1500 So instead, we call this function. */ | |
1501 store_symval_forwarding (sym, bfwd->current_value, new_val); | |
1502 } | |
1503 | |
446 | 1504 |
1505 /* SYM is a buffer-local variable, and BFWD is its buffer-local structure. | |
1506 Flush the cache. BFWD->CURRENT_BUFFER will be nil after this operation. | |
1507 */ | |
1508 | |
1509 static void | |
1510 flush_buffer_local_cache (Lisp_Object sym, | |
1511 struct symbol_value_buffer_local *bfwd) | |
1512 { | |
1513 if (NILP (bfwd->current_buffer)) | |
1514 /* Cache is already flushed. */ | |
1515 return; | |
1516 | |
1517 /* Flush out the old cache. */ | |
1518 write_out_buffer_local_cache (sym, bfwd); | |
1519 | |
1520 bfwd->current_alist_element = Qnil; | |
1521 bfwd->current_buffer = Qnil; | |
1522 | |
1523 /* Now store default the value into the current-value slot. | |
1524 We don't simply write it there, because the current-value | |
1525 slot might be a forwarding pointer, in which case we need | |
1526 to instead write the value into the C variable. | |
1527 | |
1528 We might also want to call a magic function. | |
1529 | |
1530 So instead, we call this function. */ | |
1531 store_symval_forwarding (sym, bfwd->current_value, bfwd->default_value); | |
1532 } | |
1533 | |
1534 /* Flush all the buffer-local variable caches. Whoever has a | |
1535 non-interned buffer-local variable will be spanked. Whoever has a | |
1536 magic variable that interns or uninterns symbols... I don't even | |
1537 want to think about it. | |
1538 */ | |
1539 | |
1540 void | |
1541 flush_all_buffer_local_cache (void) | |
1542 { | |
1543 Lisp_Object *syms = XVECTOR_DATA (Vobarray); | |
1544 long count = XVECTOR_LENGTH (Vobarray); | |
1545 long i; | |
1546 | |
1547 for (i=0; i<count; i++) | |
1548 { | |
1549 Lisp_Object sym = syms[i]; | |
1550 Lisp_Object value; | |
1551 | |
1552 if (!ZEROP (sym)) | |
1553 for(;;) | |
1554 { | |
1555 Lisp_Symbol *next; | |
1556 assert (SYMBOLP (sym)); | |
1557 value = fetch_value_maybe_past_magic (sym, Qt); | |
1558 if (SYMBOL_VALUE_BUFFER_LOCAL_P (value)) | |
1559 flush_buffer_local_cache (sym, XSYMBOL_VALUE_BUFFER_LOCAL (value)); | |
1560 | |
1561 next = symbol_next (XSYMBOL (sym)); | |
1562 if (!next) | |
1563 break; | |
793 | 1564 sym = wrap_symbol (next); |
446 | 1565 } |
1566 } | |
1567 } | |
1568 | |
428 | 1569 |
1570 void | |
1571 kill_buffer_local_variables (struct buffer *buf) | |
1572 { | |
1573 Lisp_Object prev = Qnil; | |
1574 Lisp_Object alist; | |
1575 | |
1576 /* Any which are supposed to be permanent, | |
1577 make local again, with the same values they had. */ | |
1578 | |
1579 for (alist = buf->local_var_alist; !NILP (alist); alist = XCDR (alist)) | |
1580 { | |
1581 Lisp_Object sym = XCAR (XCAR (alist)); | |
1582 struct symbol_value_buffer_local *bfwd; | |
1583 /* Variables with a symbol-value-varalias should not be here | |
1584 (we should have forwarded past them) and there must be a | |
1585 symbol-value-buffer-local. If there's a symbol-value-lisp-magic, | |
1586 just forward past it; if the variable has a handler, it was | |
1587 already called. */ | |
1588 Lisp_Object value = fetch_value_maybe_past_magic (sym, Qt); | |
1589 | |
1590 assert (SYMBOL_VALUE_BUFFER_LOCAL_P (value)); | |
1591 bfwd = XSYMBOL_VALUE_BUFFER_LOCAL (value); | |
1592 | |
1593 if (!NILP (Fget (sym, Qpermanent_local, Qnil))) | |
1594 /* prev points to the last alist element that is still | |
1595 staying around, so *only* update it now. This didn't | |
1596 used to be the case; this bug has been around since | |
1597 mly's rewrite two years ago! */ | |
1598 prev = alist; | |
1599 else | |
1600 { | |
1601 /* Really truly kill it. */ | |
1602 if (!NILP (prev)) | |
1603 XCDR (prev) = XCDR (alist); | |
1604 else | |
1605 buf->local_var_alist = XCDR (alist); | |
1606 | |
1607 /* We just effectively changed the value for this variable | |
1608 in BUF. So: */ | |
1609 | |
1610 /* (1) If the cache is caching BUF, invalidate the cache. */ | |
1611 if (!NILP (bfwd->current_buffer) && | |
1612 buf == XBUFFER (bfwd->current_buffer)) | |
1613 bfwd->current_buffer = Qnil; | |
1614 | |
1615 /* (2) If we changed the value in current_buffer and this | |
1616 variable forwards to a C variable, we need to change the | |
1617 value of the C variable. set_up_buffer_local_cache() | |
1618 will do this. It doesn't hurt to do it whenever | |
1619 BUF == current_buffer, so just go ahead and do that. */ | |
1620 if (buf == current_buffer) | |
1621 set_up_buffer_local_cache (sym, bfwd, buf, Qnil, 0); | |
1622 } | |
1623 } | |
1624 } | |
1625 | |
1626 static Lisp_Object | |
1627 find_symbol_value_1 (Lisp_Object sym, struct buffer *buf, | |
1628 struct console *con, int swap_it_in, | |
1629 Lisp_Object symcons, int set_it_p) | |
1630 { | |
1631 Lisp_Object valcontents; | |
1632 | |
1633 retry: | |
1634 valcontents = XSYMBOL (sym)->value; | |
1635 | |
1636 retry_2: | |
1637 if (!SYMBOL_VALUE_MAGIC_P (valcontents)) | |
1638 return valcontents; | |
1639 | |
1640 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
1641 { | |
1642 case SYMVAL_LISP_MAGIC: | |
1643 /* #### kludge */ | |
1644 valcontents = XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed; | |
1645 /* semi-change-o */ | |
1646 goto retry_2; | |
1647 | |
1648 case SYMVAL_VARALIAS: | |
1649 sym = follow_varalias_pointers (sym, Qt /* #### kludge */); | |
1650 symcons = Qnil; | |
1651 /* presto change-o! */ | |
1652 goto retry; | |
1653 | |
1654 case SYMVAL_BUFFER_LOCAL: | |
1655 case SYMVAL_SOME_BUFFER_LOCAL: | |
1656 { | |
1657 struct symbol_value_buffer_local *bfwd | |
1658 = XSYMBOL_VALUE_BUFFER_LOCAL (valcontents); | |
1659 | |
1660 if (swap_it_in) | |
1661 { | |
1662 set_up_buffer_local_cache (sym, bfwd, buf, symcons, set_it_p); | |
1663 valcontents = bfwd->current_value; | |
1664 } | |
1665 else | |
1666 { | |
1667 if (!NILP (bfwd->current_buffer) && | |
1668 buf == XBUFFER (bfwd->current_buffer)) | |
1669 valcontents = bfwd->current_value; | |
1670 else if (NILP (symcons)) | |
1671 { | |
1672 if (set_it_p) | |
1673 valcontents = assq_no_quit (sym, buf->local_var_alist); | |
1674 if (NILP (valcontents)) | |
1675 valcontents = bfwd->default_value; | |
1676 else | |
1677 valcontents = XCDR (valcontents); | |
1678 } | |
1679 else | |
1680 valcontents = XCDR (symcons); | |
1681 } | |
1682 break; | |
1683 } | |
1684 | |
1685 default: | |
1686 break; | |
1687 } | |
1688 return do_symval_forwarding (valcontents, buf, con); | |
1689 } | |
1690 | |
1691 | |
1692 /* Find the value of a symbol in BUFFER, returning Qunbound if it's not | |
1693 bound. Note that it must not be possible to QUIT within this | |
1694 function. */ | |
1695 | |
1696 Lisp_Object | |
1697 symbol_value_in_buffer (Lisp_Object sym, Lisp_Object buffer) | |
1698 { | |
1699 struct buffer *buf; | |
1700 | |
1701 CHECK_SYMBOL (sym); | |
1702 | |
1703 if (NILP (buffer)) | |
1704 buf = current_buffer; | |
1705 else | |
1706 { | |
1707 CHECK_BUFFER (buffer); | |
1708 buf = XBUFFER (buffer); | |
1709 } | |
1710 | |
1711 return find_symbol_value_1 (sym, buf, | |
1712 /* If it bombs out at startup due to a | |
1713 Lisp error, this may be nil. */ | |
1714 CONSOLEP (Vselected_console) | |
1715 ? XCONSOLE (Vselected_console) : 0, 0, Qnil, 1); | |
1716 } | |
1717 | |
1718 static Lisp_Object | |
1719 symbol_value_in_console (Lisp_Object sym, Lisp_Object console) | |
1720 { | |
1721 CHECK_SYMBOL (sym); | |
1722 | |
1723 if (NILP (console)) | |
1724 console = Vselected_console; | |
1725 else | |
1726 CHECK_CONSOLE (console); | |
1727 | |
1728 return find_symbol_value_1 (sym, current_buffer, XCONSOLE (console), 0, | |
1729 Qnil, 1); | |
1730 } | |
1731 | |
1732 /* Return the current value of SYM. The difference between this function | |
1733 and calling symbol_value_in_buffer with a BUFFER of Qnil is that | |
1734 this updates the CURRENT_VALUE slot of buffer-local variables to | |
1735 point to the current buffer, while symbol_value_in_buffer doesn't. */ | |
1736 | |
1737 Lisp_Object | |
1738 find_symbol_value (Lisp_Object sym) | |
1739 { | |
1740 /* WARNING: This function can be called when current_buffer is 0 | |
1741 and Vselected_console is Qnil, early in initialization. */ | |
1742 struct console *con; | |
1743 Lisp_Object valcontents; | |
1744 | |
1745 CHECK_SYMBOL (sym); | |
1746 | |
1747 valcontents = XSYMBOL (sym)->value; | |
1748 if (!SYMBOL_VALUE_MAGIC_P (valcontents)) | |
1749 return valcontents; | |
1750 | |
1751 if (CONSOLEP (Vselected_console)) | |
1752 con = XCONSOLE (Vselected_console); | |
1753 else | |
1754 { | |
1755 /* This can also get called while we're preparing to shutdown. | |
1756 #### What should really happen in that case? Should we | |
1757 actually fix things so we can't get here in that case? */ | |
1758 #ifndef PDUMP | |
1759 assert (!initialized || preparing_for_armageddon); | |
1760 #endif | |
1761 con = 0; | |
1762 } | |
1763 | |
1764 return find_symbol_value_1 (sym, current_buffer, con, 1, Qnil, 1); | |
1765 } | |
1766 | |
1767 /* This is an optimized function for quick lookup of buffer local symbols | |
1768 by avoiding O(n) search. This will work when either: | |
1769 a) We have already found the symbol e.g. by traversing local_var_alist. | |
1770 or | |
1771 b) We know that the symbol will not be found in the current buffer's | |
1772 list of local variables. | |
1773 In the former case, find_it_p is 1 and symbol_cons is the element from | |
1774 local_var_alist. In the latter case, find_it_p is 0 and symbol_cons | |
1775 is the symbol. | |
1776 | |
1777 This function is called from set_buffer_internal which does both of these | |
1778 things. */ | |
1779 | |
1780 Lisp_Object | |
1781 find_symbol_value_quickly (Lisp_Object symbol_cons, int find_it_p) | |
1782 { | |
1783 /* WARNING: This function can be called when current_buffer is 0 | |
1784 and Vselected_console is Qnil, early in initialization. */ | |
1785 struct console *con; | |
1786 Lisp_Object sym = find_it_p ? XCAR (symbol_cons) : symbol_cons; | |
1787 | |
1788 CHECK_SYMBOL (sym); | |
1789 if (CONSOLEP (Vselected_console)) | |
1790 con = XCONSOLE (Vselected_console); | |
1791 else | |
1792 { | |
1793 /* This can also get called while we're preparing to shutdown. | |
1794 #### What should really happen in that case? Should we | |
1795 actually fix things so we can't get here in that case? */ | |
1796 #ifndef PDUMP | |
1797 assert (!initialized || preparing_for_armageddon); | |
1798 #endif | |
1799 con = 0; | |
1800 } | |
1801 | |
1802 return find_symbol_value_1 (sym, current_buffer, con, 1, | |
1803 find_it_p ? symbol_cons : Qnil, | |
1804 find_it_p); | |
1805 } | |
1806 | |
1807 DEFUN ("symbol-value", Fsymbol_value, 1, 1, 0, /* | |
1808 Return SYMBOL's value. Error if that is void. | |
1809 */ | |
1810 (symbol)) | |
1811 { | |
1812 Lisp_Object val = find_symbol_value (symbol); | |
1813 | |
1814 if (UNBOUNDP (val)) | |
1815 return Fsignal (Qvoid_variable, list1 (symbol)); | |
1816 else | |
1817 return val; | |
1818 } | |
1819 | |
1820 DEFUN ("set", Fset, 2, 2, 0, /* | |
1821 Set SYMBOL's value to NEWVAL, and return NEWVAL. | |
1822 */ | |
1823 (symbol, newval)) | |
1824 { | |
1825 REGISTER Lisp_Object valcontents; | |
440 | 1826 Lisp_Symbol *sym; |
428 | 1827 /* remember, we're called by Fmakunbound() as well */ |
1828 | |
1829 CHECK_SYMBOL (symbol); | |
1830 | |
1831 retry: | |
1832 sym = XSYMBOL (symbol); | |
1833 valcontents = sym->value; | |
1834 | |
1835 if (EQ (symbol, Qnil) || | |
1836 EQ (symbol, Qt) || | |
1837 SYMBOL_IS_KEYWORD (symbol)) | |
1838 reject_constant_symbols (symbol, newval, 0, | |
1839 UNBOUNDP (newval) ? Qmakunbound : Qset); | |
1840 | |
1841 if (!SYMBOL_VALUE_MAGIC_P (valcontents) || UNBOUNDP (valcontents)) | |
1842 { | |
1843 sym->value = newval; | |
1844 return newval; | |
1845 } | |
1846 | |
1847 reject_constant_symbols (symbol, newval, 0, | |
1848 UNBOUNDP (newval) ? Qmakunbound : Qset); | |
1849 | |
1850 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
1851 { | |
1852 case SYMVAL_LISP_MAGIC: | |
1853 { | |
1854 if (UNBOUNDP (newval)) | |
440 | 1855 { |
1856 maybe_call_magic_handler (symbol, Qmakunbound, 0); | |
1857 return XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed = Qunbound; | |
1858 } | |
428 | 1859 else |
440 | 1860 { |
1861 maybe_call_magic_handler (symbol, Qset, 1, newval); | |
1862 return XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed = newval; | |
1863 } | |
428 | 1864 } |
1865 | |
1866 case SYMVAL_VARALIAS: | |
1867 symbol = follow_varalias_pointers (symbol, | |
1868 UNBOUNDP (newval) | |
1869 ? Qmakunbound : Qset); | |
1870 /* presto change-o! */ | |
1871 goto retry; | |
1872 | |
1873 case SYMVAL_FIXNUM_FORWARD: | |
996 | 1874 case SYMVAL_CONST_FIXNUM_FORWARD: |
428 | 1875 case SYMVAL_BOOLEAN_FORWARD: |
996 | 1876 case SYMVAL_CONST_BOOLEAN_FORWARD: |
428 | 1877 case SYMVAL_DEFAULT_BUFFER_FORWARD: |
1878 case SYMVAL_DEFAULT_CONSOLE_FORWARD: | |
1879 if (UNBOUNDP (newval)) | |
996 | 1880 { |
1881 #ifdef HAVE_SHLIB | |
1882 if (unloading_module) | |
1883 { | |
1884 sym->value = newval; | |
1885 return newval; | |
1886 } | |
1887 else | |
1888 #endif | |
1889 invalid_change ("Cannot makunbound", symbol); | |
1890 } | |
1891 break; | |
1892 | |
1893 case SYMVAL_OBJECT_FORWARD: | |
1894 case SYMVAL_CONST_OBJECT_FORWARD: | |
1895 if (UNBOUNDP (newval)) | |
1896 { | |
1897 #ifdef HAVE_SHLIB | |
1898 if (unloading_module) | |
1899 { | |
1111 | 1900 unstaticpro_nodump ((Lisp_Object *) |
1901 symbol_value_forward_forward | |
996 | 1902 (XSYMBOL_VALUE_FORWARD (valcontents))); |
1903 sym->value = newval; | |
1904 return newval; | |
1905 } | |
1906 else | |
1907 #endif | |
1908 invalid_change ("Cannot makunbound", symbol); | |
1909 } | |
428 | 1910 break; |
1911 | |
1912 /* case SYMVAL_UNBOUND_MARKER: break; */ | |
1913 | |
1914 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
1915 { | |
442 | 1916 const struct symbol_value_forward *fwd |
428 | 1917 = XSYMBOL_VALUE_FORWARD (valcontents); |
1918 int mask = XINT (*((Lisp_Object *) | |
1919 symbol_value_forward_forward (fwd))); | |
1920 if (mask > 0) | |
1921 /* Setting this variable makes it buffer-local */ | |
1922 current_buffer->local_var_flags |= mask; | |
1923 break; | |
1924 } | |
1925 | |
1926 case SYMVAL_SELECTED_CONSOLE_FORWARD: | |
1927 { | |
442 | 1928 const struct symbol_value_forward *fwd |
428 | 1929 = XSYMBOL_VALUE_FORWARD (valcontents); |
1930 int mask = XINT (*((Lisp_Object *) | |
1931 symbol_value_forward_forward (fwd))); | |
1932 if (mask > 0) | |
1933 /* Setting this variable makes it console-local */ | |
1934 XCONSOLE (Vselected_console)->local_var_flags |= mask; | |
1935 break; | |
1936 } | |
1937 | |
1938 case SYMVAL_BUFFER_LOCAL: | |
1939 case SYMVAL_SOME_BUFFER_LOCAL: | |
1940 { | |
1941 /* If we want to examine or set the value and | |
1942 CURRENT-BUFFER is current, we just examine or set | |
1943 CURRENT-VALUE. If CURRENT-BUFFER is not current, we | |
1944 store the current CURRENT-VALUE value into | |
1945 CURRENT-ALIST- ELEMENT, then find the appropriate alist | |
1946 element for the buffer now current and set up | |
1947 CURRENT-ALIST-ELEMENT. Then we set CURRENT-VALUE out | |
1948 of that element, and store into CURRENT-BUFFER. | |
1949 | |
1950 If we are setting the variable and the current buffer does | |
1951 not have an alist entry for this variable, an alist entry is | |
1952 created. | |
1953 | |
1954 Note that CURRENT-VALUE can be a forwarding pointer. | |
1955 Each time it is examined or set, forwarding must be | |
1956 done. */ | |
1957 struct symbol_value_buffer_local *bfwd | |
1958 = XSYMBOL_VALUE_BUFFER_LOCAL (valcontents); | |
1959 int some_buffer_local_p = | |
1960 (bfwd->magic.type == SYMVAL_SOME_BUFFER_LOCAL); | |
1961 /* What value are we caching right now? */ | |
1962 Lisp_Object aelt = bfwd->current_alist_element; | |
1963 | |
1964 if (!NILP (bfwd->current_buffer) && | |
1965 current_buffer == XBUFFER (bfwd->current_buffer) | |
1966 && ((some_buffer_local_p) | |
1967 ? 1 /* doesn't automatically become local */ | |
1968 : !NILP (aelt) /* already local */ | |
1969 )) | |
1970 { | |
1971 /* Cache is valid */ | |
1972 valcontents = bfwd->current_value; | |
1973 } | |
1974 else | |
1975 { | |
1976 /* If the current buffer is not the buffer whose binding is | |
1977 currently cached, or if it's a SYMVAL_BUFFER_LOCAL and | |
1978 we're looking at the default value, the cache is invalid; we | |
1979 need to write it out, and find the new CURRENT-ALIST-ELEMENT | |
1980 */ | |
1981 | |
1982 /* Write out the cached value for the old buffer; copy it | |
1983 back to its alist element. This works if the current | |
1984 buffer only sees the default value, too. */ | |
1985 write_out_buffer_local_cache (symbol, bfwd); | |
1986 | |
1987 /* Find the new value for CURRENT-ALIST-ELEMENT. */ | |
1988 aelt = buffer_local_alist_element (current_buffer, symbol, bfwd); | |
1989 if (NILP (aelt)) | |
1990 { | |
1991 /* This buffer is still seeing the default value. */ | |
1992 if (!some_buffer_local_p) | |
1993 { | |
1994 /* If it's a SYMVAL_BUFFER_LOCAL, give this buffer a | |
1995 new assoc for a local value and set | |
1996 CURRENT-ALIST-ELEMENT to point to that. */ | |
1997 aelt = | |
1998 do_symval_forwarding (bfwd->current_value, | |
1999 current_buffer, | |
2000 XCONSOLE (Vselected_console)); | |
2001 aelt = Fcons (symbol, aelt); | |
2002 current_buffer->local_var_alist | |
2003 = Fcons (aelt, current_buffer->local_var_alist); | |
2004 } | |
2005 else | |
2006 { | |
2007 /* If the variable is a SYMVAL_SOME_BUFFER_LOCAL, | |
2008 we're currently seeing the default value. */ | |
2009 ; | |
2010 } | |
2011 } | |
2012 /* Cache the new buffer's assoc in CURRENT-ALIST-ELEMENT. */ | |
2013 bfwd->current_alist_element = aelt; | |
2014 /* Set BUFFER, now that CURRENT-ALIST-ELEMENT is accurate. */ | |
793 | 2015 bfwd->current_buffer = wrap_buffer (current_buffer); |
428 | 2016 valcontents = bfwd->current_value; |
2017 } | |
2018 break; | |
2019 } | |
2020 default: | |
2500 | 2021 ABORT (); |
428 | 2022 } |
2023 store_symval_forwarding (symbol, valcontents, newval); | |
2024 | |
2025 return newval; | |
2026 } | |
2027 | |
2028 | |
2029 /* Access or set a buffer-local symbol's default value. */ | |
2030 | |
2031 /* Return the default value of SYM, but don't check for voidness. | |
2032 Return Qunbound if it is void. */ | |
2033 | |
2034 static Lisp_Object | |
2035 default_value (Lisp_Object sym) | |
2036 { | |
2037 Lisp_Object valcontents; | |
2038 | |
2039 CHECK_SYMBOL (sym); | |
2040 | |
2041 retry: | |
2042 valcontents = XSYMBOL (sym)->value; | |
2043 | |
2044 retry_2: | |
2045 if (!SYMBOL_VALUE_MAGIC_P (valcontents)) | |
2046 return valcontents; | |
2047 | |
2048 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
2049 { | |
2050 case SYMVAL_LISP_MAGIC: | |
2051 /* #### kludge */ | |
2052 valcontents = XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed; | |
2053 /* semi-change-o */ | |
2054 goto retry_2; | |
2055 | |
2056 case SYMVAL_VARALIAS: | |
2057 sym = follow_varalias_pointers (sym, Qt /* #### kludge */); | |
2058 /* presto change-o! */ | |
2059 goto retry; | |
2060 | |
2061 case SYMVAL_UNBOUND_MARKER: | |
2062 return valcontents; | |
2063 | |
2064 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
2065 { | |
442 | 2066 const struct symbol_value_forward *fwd |
428 | 2067 = XSYMBOL_VALUE_FORWARD (valcontents); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2068 return (*((Lisp_Object *)((Rawbyte *) XBUFFER (Vbuffer_defaults) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2069 + ((Rawbyte *)symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2070 - (Rawbyte *)&buffer_local_flags)))); |
428 | 2071 } |
2072 | |
2073 case SYMVAL_SELECTED_CONSOLE_FORWARD: | |
2074 { | |
442 | 2075 const struct symbol_value_forward *fwd |
428 | 2076 = XSYMBOL_VALUE_FORWARD (valcontents); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2077 return (*((Lisp_Object *)((Rawbyte *) XCONSOLE (Vconsole_defaults) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2078 + ((Rawbyte *)symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2079 - (Rawbyte *)&console_local_flags)))); |
428 | 2080 } |
2081 | |
2082 case SYMVAL_BUFFER_LOCAL: | |
2083 case SYMVAL_SOME_BUFFER_LOCAL: | |
2084 { | |
2085 struct symbol_value_buffer_local *bfwd = | |
2086 XSYMBOL_VALUE_BUFFER_LOCAL (valcontents); | |
2087 | |
2088 /* Handle user-created local variables. */ | |
2089 /* If var is set up for a buffer that lacks a local value for it, | |
2090 the current value is nominally the default value. | |
2091 But the current value slot may be more up to date, since | |
2092 ordinary setq stores just that slot. So use that. */ | |
2093 if (NILP (bfwd->current_alist_element)) | |
2094 return do_symval_forwarding (bfwd->current_value, current_buffer, | |
2095 XCONSOLE (Vselected_console)); | |
2096 else | |
2097 return bfwd->default_value; | |
2098 } | |
2099 default: | |
2100 /* For other variables, get the current value. */ | |
2101 return do_symval_forwarding (valcontents, current_buffer, | |
2102 XCONSOLE (Vselected_console)); | |
2103 } | |
2104 | |
1204 | 2105 RETURN_NOT_REACHED (Qnil); /* suppress compiler warning */ |
428 | 2106 } |
2107 | |
2108 DEFUN ("default-boundp", Fdefault_boundp, 1, 1, 0, /* | |
2109 Return t if SYMBOL has a non-void default value. | |
2110 This is the value that is seen in buffers that do not have their own values | |
2111 for this variable. | |
2112 */ | |
2113 (symbol)) | |
2114 { | |
2115 return UNBOUNDP (default_value (symbol)) ? Qnil : Qt; | |
2116 } | |
2117 | |
2118 DEFUN ("default-value", Fdefault_value, 1, 1, 0, /* | |
2119 Return SYMBOL's default value. | |
2120 This is the value that is seen in buffers that do not have their own values | |
2121 for this variable. The default value is meaningful for variables with | |
2122 local bindings in certain buffers. | |
2123 */ | |
2124 (symbol)) | |
2125 { | |
2126 Lisp_Object value = default_value (symbol); | |
2127 | |
2128 return UNBOUNDP (value) ? Fsignal (Qvoid_variable, list1 (symbol)) : value; | |
2129 } | |
2130 | |
2131 DEFUN ("set-default", Fset_default, 2, 2, 0, /* | |
444 | 2132 Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated. |
428 | 2133 The default value is seen in buffers that do not have their own values |
2134 for this variable. | |
2135 */ | |
2136 (symbol, value)) | |
2137 { | |
2138 Lisp_Object valcontents; | |
2139 | |
2140 CHECK_SYMBOL (symbol); | |
2141 | |
2142 retry: | |
2143 valcontents = XSYMBOL (symbol)->value; | |
2144 | |
2145 retry_2: | |
2146 if (!SYMBOL_VALUE_MAGIC_P (valcontents)) | |
2147 return Fset (symbol, value); | |
2148 | |
2149 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
2150 { | |
2151 case SYMVAL_LISP_MAGIC: | |
2152 RETURN_IF_NOT_UNBOUND (maybe_call_magic_handler (symbol, Qset_default, 1, | |
2153 value)); | |
2154 valcontents = XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed; | |
2155 /* semi-change-o */ | |
2156 goto retry_2; | |
2157 | |
2158 case SYMVAL_VARALIAS: | |
2159 symbol = follow_varalias_pointers (symbol, Qset_default); | |
2160 /* presto change-o! */ | |
2161 goto retry; | |
2162 | |
2163 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
2164 set_default_buffer_slot_variable (symbol, value); | |
2165 return value; | |
2166 | |
2167 case SYMVAL_SELECTED_CONSOLE_FORWARD: | |
2168 set_default_console_slot_variable (symbol, value); | |
2169 return value; | |
2170 | |
2171 case SYMVAL_BUFFER_LOCAL: | |
2172 case SYMVAL_SOME_BUFFER_LOCAL: | |
2173 { | |
2174 /* Store new value into the DEFAULT-VALUE slot */ | |
2175 struct symbol_value_buffer_local *bfwd | |
2176 = XSYMBOL_VALUE_BUFFER_LOCAL (valcontents); | |
2177 | |
2178 bfwd->default_value = value; | |
2179 /* If current-buffer doesn't shadow default_value, | |
2180 * we must set the CURRENT-VALUE slot too */ | |
2181 if (NILP (bfwd->current_alist_element)) | |
2182 store_symval_forwarding (symbol, bfwd->current_value, value); | |
2183 return value; | |
2184 } | |
2185 | |
2186 default: | |
2187 return Fset (symbol, value); | |
2188 } | |
2189 } | |
2190 | |
2191 DEFUN ("setq-default", Fsetq_default, 0, UNEVALLED, 0, /* | |
2192 Set the default value of variable SYMBOL to VALUE. | |
2193 SYMBOL, the variable name, is literal (not evaluated); | |
2194 VALUE is an expression and it is evaluated. | |
2195 The default value of a variable is seen in buffers | |
2196 that do not have their own values for the variable. | |
2197 | |
2198 More generally, you can use multiple variables and values, as in | |
2199 (setq-default SYMBOL VALUE SYMBOL VALUE...) | |
2200 This sets each SYMBOL's default value to the corresponding VALUE. | |
2201 The VALUE for the Nth SYMBOL can refer to the new default values | |
2202 of previous SYMBOLs. | |
2203 */ | |
2204 (args)) | |
2205 { | |
2206 /* This function can GC */ | |
2207 int nargs; | |
2421 | 2208 Lisp_Object retval = Qnil; |
428 | 2209 |
2210 GET_LIST_LENGTH (args, nargs); | |
2211 | |
2212 if (nargs & 1) /* Odd number of arguments? */ | |
2213 Fsignal (Qwrong_number_of_arguments, | |
2214 list2 (Qsetq_default, make_int (nargs))); | |
2215 | |
2421 | 2216 GC_PROPERTY_LIST_LOOP_3 (symbol, val, args) |
428 | 2217 { |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4642
diff
changeset
|
2218 val = IGNORE_MULTIPLE_VALUES (Feval (val)); |
428 | 2219 Fset_default (symbol, val); |
2421 | 2220 retval = val; |
428 | 2221 } |
2222 | |
2421 | 2223 END_GC_PROPERTY_LIST_LOOP (symbol); |
2224 return retval; | |
428 | 2225 } |
2226 | |
2227 /* Lisp functions for creating and removing buffer-local variables. */ | |
2228 | |
2229 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local, 1, 1, | |
2230 "vMake Variable Buffer Local: ", /* | |
2231 Make VARIABLE have a separate value for each buffer. | |
2232 At any time, the value for the current buffer is in effect. | |
2233 There is also a default value which is seen in any buffer which has not yet | |
2234 set its own value. | |
2235 Using `set' or `setq' to set the variable causes it to have a separate value | |
2236 for the current buffer if it was previously using the default value. | |
2237 The function `default-value' gets the default value and `set-default' | |
2238 sets it. | |
2239 */ | |
2240 (variable)) | |
2241 { | |
2242 Lisp_Object valcontents; | |
2243 | |
2244 CHECK_SYMBOL (variable); | |
2245 | |
2246 retry: | |
2247 verify_ok_for_buffer_local (variable, Qmake_variable_buffer_local); | |
2248 | |
2249 valcontents = XSYMBOL (variable)->value; | |
2250 | |
2251 retry_2: | |
2252 if (SYMBOL_VALUE_MAGIC_P (valcontents)) | |
2253 { | |
2254 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
2255 { | |
2256 case SYMVAL_LISP_MAGIC: | |
2257 if (!UNBOUNDP (maybe_call_magic_handler | |
2258 (variable, Qmake_variable_buffer_local, 0))) | |
2259 return variable; | |
2260 valcontents = XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed; | |
2261 /* semi-change-o */ | |
2262 goto retry_2; | |
2263 | |
2264 case SYMVAL_VARALIAS: | |
2265 variable = follow_varalias_pointers (variable, | |
2266 Qmake_variable_buffer_local); | |
2267 /* presto change-o! */ | |
2268 goto retry; | |
2269 | |
2270 case SYMVAL_FIXNUM_FORWARD: | |
2271 case SYMVAL_BOOLEAN_FORWARD: | |
2272 case SYMVAL_OBJECT_FORWARD: | |
2273 case SYMVAL_UNBOUND_MARKER: | |
2274 break; | |
2275 | |
2276 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
2277 case SYMVAL_BUFFER_LOCAL: | |
2278 /* Already per-each-buffer */ | |
2279 return variable; | |
2280 | |
2281 case SYMVAL_SOME_BUFFER_LOCAL: | |
2282 /* Transmogrify */ | |
2283 XSYMBOL_VALUE_BUFFER_LOCAL (valcontents)->magic.type = | |
2284 SYMVAL_BUFFER_LOCAL; | |
2285 return variable; | |
2286 | |
2287 default: | |
2500 | 2288 ABORT (); |
428 | 2289 } |
2290 } | |
2291 | |
2292 { | |
2293 struct symbol_value_buffer_local *bfwd | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
2294 = XSYMBOL_VALUE_BUFFER_LOCAL |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
2295 (ALLOC_NORMAL_LISP_OBJECT (symbol_value_buffer_local)); |
428 | 2296 Lisp_Object foo; |
2297 bfwd->magic.type = SYMVAL_BUFFER_LOCAL; | |
2298 | |
2299 bfwd->default_value = find_symbol_value (variable); | |
2300 bfwd->current_value = valcontents; | |
2301 bfwd->current_alist_element = Qnil; | |
2302 bfwd->current_buffer = Fcurrent_buffer (); | |
793 | 2303 foo = wrap_symbol_value_magic (bfwd); |
428 | 2304 *value_slot_past_magic (variable) = foo; |
2305 #if 1 /* #### Yuck! FSFmacs bug-compatibility*/ | |
2306 /* This sets the default-value of any make-variable-buffer-local to nil. | |
2307 That just sucks. User can just use setq-default to effect that, | |
2308 but there's no way to do makunbound-default to undo this lossage. */ | |
2309 if (UNBOUNDP (valcontents)) | |
2310 bfwd->default_value = Qnil; | |
2311 #endif | |
2312 #if 0 /* #### Yuck! */ | |
2313 /* This sets the value to nil in this buffer. | |
2314 User could use (setq variable nil) to do this. | |
2315 It isn't as egregious to do this automatically | |
2316 as it is to do so to the default-value, but it's | |
2317 still really dubious. */ | |
2318 if (UNBOUNDP (valcontents)) | |
2319 Fset (variable, Qnil); | |
2320 #endif | |
2321 return variable; | |
2322 } | |
2323 } | |
2324 | |
2325 DEFUN ("make-local-variable", Fmake_local_variable, 1, 1, | |
2326 "vMake Local Variable: ", /* | |
2327 Make VARIABLE have a separate value in the current buffer. | |
2328 Other buffers will continue to share a common default value. | |
2329 \(The buffer-local value of VARIABLE starts out as the same value | |
2330 VARIABLE previously had. If VARIABLE was void, it remains void.) | |
2331 See also `make-variable-buffer-local'. | |
2332 | |
2333 If the variable is already arranged to become local when set, | |
2334 this function causes a local value to exist for this buffer, | |
2335 just as setting the variable would do. | |
2336 | |
2337 Do not use `make-local-variable' to make a hook variable buffer-local. | |
2338 Use `make-local-hook' instead. | |
2339 */ | |
2340 (variable)) | |
2341 { | |
2342 Lisp_Object valcontents; | |
2343 struct symbol_value_buffer_local *bfwd; | |
2344 | |
2345 CHECK_SYMBOL (variable); | |
2346 | |
2347 retry: | |
2348 verify_ok_for_buffer_local (variable, Qmake_local_variable); | |
2349 | |
2350 valcontents = XSYMBOL (variable)->value; | |
2351 | |
2352 retry_2: | |
2353 if (SYMBOL_VALUE_MAGIC_P (valcontents)) | |
2354 { | |
2355 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
2356 { | |
2357 case SYMVAL_LISP_MAGIC: | |
2358 if (!UNBOUNDP (maybe_call_magic_handler | |
2359 (variable, Qmake_local_variable, 0))) | |
2360 return variable; | |
2361 valcontents = XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed; | |
2362 /* semi-change-o */ | |
2363 goto retry_2; | |
2364 | |
2365 case SYMVAL_VARALIAS: | |
2366 variable = follow_varalias_pointers (variable, Qmake_local_variable); | |
2367 /* presto change-o! */ | |
2368 goto retry; | |
2369 | |
2370 case SYMVAL_FIXNUM_FORWARD: | |
2371 case SYMVAL_BOOLEAN_FORWARD: | |
2372 case SYMVAL_OBJECT_FORWARD: | |
2373 case SYMVAL_UNBOUND_MARKER: | |
2374 break; | |
2375 | |
2376 case SYMVAL_BUFFER_LOCAL: | |
2377 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
2378 { | |
2379 /* Make sure the symbol has a local value in this particular | |
2380 buffer, by setting it to the same value it already has. */ | |
2381 Fset (variable, find_symbol_value (variable)); | |
2382 return variable; | |
2383 } | |
2384 | |
2385 case SYMVAL_SOME_BUFFER_LOCAL: | |
2386 { | |
2387 if (!NILP (buffer_local_alist_element (current_buffer, | |
2388 variable, | |
2389 (XSYMBOL_VALUE_BUFFER_LOCAL | |
2390 (valcontents))))) | |
2391 goto already_local_to_current_buffer; | |
2392 else | |
2393 goto already_local_to_some_other_buffer; | |
2394 } | |
2395 | |
2396 default: | |
2500 | 2397 ABORT (); |
428 | 2398 } |
2399 } | |
2400 | |
2401 /* Make sure variable is set up to hold per-buffer values */ | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
2402 bfwd = XSYMBOL_VALUE_BUFFER_LOCAL |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
2403 (ALLOC_NORMAL_LISP_OBJECT (symbol_value_buffer_local)); |
428 | 2404 bfwd->magic.type = SYMVAL_SOME_BUFFER_LOCAL; |
2405 | |
2406 bfwd->current_buffer = Qnil; | |
2407 bfwd->current_alist_element = Qnil; | |
2408 bfwd->current_value = valcontents; | |
2409 /* passing 0 is OK because this should never be a | |
2410 SYMVAL_CURRENT_BUFFER_FORWARD or SYMVAL_SELECTED_CONSOLE_FORWARD | |
2411 variable. */ | |
2412 bfwd->default_value = do_symval_forwarding (valcontents, 0, 0); | |
2413 | |
2414 #if 0 | |
2415 if (UNBOUNDP (bfwd->default_value)) | |
2416 bfwd->default_value = Qnil; /* Yuck! */ | |
2417 #endif | |
2418 | |
793 | 2419 valcontents = wrap_symbol_value_magic (bfwd); |
428 | 2420 *value_slot_past_magic (variable) = valcontents; |
2421 | |
2422 already_local_to_some_other_buffer: | |
2423 | |
2424 /* Make sure this buffer has its own value of variable */ | |
2425 bfwd = XSYMBOL_VALUE_BUFFER_LOCAL (valcontents); | |
2426 | |
2427 if (UNBOUNDP (bfwd->default_value)) | |
2428 { | |
2429 /* If default value is unbound, set local value to nil. */ | |
793 | 2430 bfwd->current_buffer = wrap_buffer (current_buffer); |
428 | 2431 bfwd->current_alist_element = Fcons (variable, Qnil); |
2432 current_buffer->local_var_alist = | |
2433 Fcons (bfwd->current_alist_element, current_buffer->local_var_alist); | |
2434 store_symval_forwarding (variable, bfwd->current_value, Qnil); | |
2435 return variable; | |
2436 } | |
2437 | |
2438 current_buffer->local_var_alist | |
2439 = Fcons (Fcons (variable, bfwd->default_value), | |
2440 current_buffer->local_var_alist); | |
2441 | |
2442 /* Make sure symbol does not think it is set up for this buffer; | |
2443 force it to look once again for this buffer's value */ | |
2444 if (!NILP (bfwd->current_buffer) && | |
2445 current_buffer == XBUFFER (bfwd->current_buffer)) | |
2446 bfwd->current_buffer = Qnil; | |
2447 | |
2448 already_local_to_current_buffer: | |
2449 | |
2450 /* If the symbol forwards into a C variable, then swap in the | |
2451 variable for this buffer immediately. If C code modifies the | |
2452 variable before we swap in, then that new value will clobber the | |
2453 default value the next time we swap. */ | |
2454 bfwd = XSYMBOL_VALUE_BUFFER_LOCAL (valcontents); | |
2455 if (SYMBOL_VALUE_MAGIC_P (bfwd->current_value)) | |
2456 { | |
2457 switch (XSYMBOL_VALUE_MAGIC_TYPE (bfwd->current_value)) | |
2458 { | |
2459 case SYMVAL_FIXNUM_FORWARD: | |
2460 case SYMVAL_BOOLEAN_FORWARD: | |
2461 case SYMVAL_OBJECT_FORWARD: | |
2462 case SYMVAL_DEFAULT_BUFFER_FORWARD: | |
2463 set_up_buffer_local_cache (variable, bfwd, current_buffer, Qnil, 1); | |
2464 break; | |
2465 | |
2466 case SYMVAL_UNBOUND_MARKER: | |
2467 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
2468 break; | |
2469 | |
2470 default: | |
2500 | 2471 ABORT (); |
428 | 2472 } |
2473 } | |
2474 | |
2475 return variable; | |
2476 } | |
2477 | |
2478 DEFUN ("kill-local-variable", Fkill_local_variable, 1, 1, | |
2479 "vKill Local Variable: ", /* | |
2480 Make VARIABLE no longer have a separate value in the current buffer. | |
2481 From now on the default value will apply in this buffer. | |
2482 */ | |
2483 (variable)) | |
2484 { | |
2485 Lisp_Object valcontents; | |
2486 | |
2487 CHECK_SYMBOL (variable); | |
2488 | |
2489 retry: | |
2490 valcontents = XSYMBOL (variable)->value; | |
2491 | |
2492 retry_2: | |
2493 if (!SYMBOL_VALUE_MAGIC_P (valcontents)) | |
2494 return variable; | |
2495 | |
2496 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
2497 { | |
2498 case SYMVAL_LISP_MAGIC: | |
2499 if (!UNBOUNDP (maybe_call_magic_handler | |
2500 (variable, Qkill_local_variable, 0))) | |
2501 return variable; | |
2502 valcontents = XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed; | |
2503 /* semi-change-o */ | |
2504 goto retry_2; | |
2505 | |
2506 case SYMVAL_VARALIAS: | |
2507 variable = follow_varalias_pointers (variable, Qkill_local_variable); | |
2508 /* presto change-o! */ | |
2509 goto retry; | |
2510 | |
2511 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
2512 { | |
442 | 2513 const struct symbol_value_forward *fwd |
428 | 2514 = XSYMBOL_VALUE_FORWARD (valcontents); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2515 int offset = ((Rawbyte *) symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2516 - (Rawbyte *) &buffer_local_flags); |
428 | 2517 int mask = |
2518 XINT (*((Lisp_Object *) symbol_value_forward_forward (fwd))); | |
2519 | |
2520 if (mask > 0) | |
2521 { | |
2522 int (*magicfun) (Lisp_Object sym, Lisp_Object *val, | |
2523 Lisp_Object in_object, int flags) = | |
2524 symbol_value_forward_magicfun (fwd); | |
2525 Lisp_Object oldval = * (Lisp_Object *) | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2526 (offset + (Rawbyte *) XBUFFER (Vbuffer_defaults)); |
428 | 2527 if (magicfun) |
771 | 2528 (magicfun) (variable, &oldval, wrap_buffer (current_buffer), 0); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2529 *(Lisp_Object *) (offset + (Rawbyte *) current_buffer) |
428 | 2530 = oldval; |
2531 current_buffer->local_var_flags &= ~mask; | |
2532 } | |
2533 return variable; | |
2534 } | |
2535 | |
2536 case SYMVAL_BUFFER_LOCAL: | |
2537 case SYMVAL_SOME_BUFFER_LOCAL: | |
2538 { | |
2539 /* Get rid of this buffer's alist element, if any */ | |
2540 struct symbol_value_buffer_local *bfwd | |
2541 = XSYMBOL_VALUE_BUFFER_LOCAL (valcontents); | |
2542 Lisp_Object alist = current_buffer->local_var_alist; | |
2543 Lisp_Object alist_element | |
2544 = buffer_local_alist_element (current_buffer, variable, bfwd); | |
2545 | |
2546 if (!NILP (alist_element)) | |
5338
8608eadee6ba
Move #'delq, #'delete to Lisp, adding support for sequences.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5277
diff
changeset
|
2547 current_buffer->local_var_alist = delq_no_quit (alist_element, |
8608eadee6ba
Move #'delq, #'delete to Lisp, adding support for sequences.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5277
diff
changeset
|
2548 alist); |
428 | 2549 |
2550 /* Make sure symbol does not think it is set up for this buffer; | |
2551 force it to look once again for this buffer's value */ | |
2552 if (!NILP (bfwd->current_buffer) && | |
2553 current_buffer == XBUFFER (bfwd->current_buffer)) | |
2554 bfwd->current_buffer = Qnil; | |
2555 | |
2556 /* We just changed the value in the current_buffer. If this | |
2557 variable forwards to a C variable, we need to change the | |
2558 value of the C variable. set_up_buffer_local_cache() | |
2559 will do this. It doesn't hurt to do it always, | |
2560 so just go ahead and do that. */ | |
2561 set_up_buffer_local_cache (variable, bfwd, current_buffer, Qnil, 1); | |
2562 } | |
2563 return variable; | |
2564 | |
2565 default: | |
2566 return variable; | |
2567 } | |
1204 | 2568 RETURN_NOT_REACHED(Qnil); /* suppress compiler warning */ |
428 | 2569 } |
2570 | |
2571 | |
2572 DEFUN ("kill-console-local-variable", Fkill_console_local_variable, 1, 1, | |
2573 "vKill Console Local Variable: ", /* | |
2574 Make VARIABLE no longer have a separate value in the selected console. | |
2575 From now on the default value will apply in this console. | |
2576 */ | |
2577 (variable)) | |
2578 { | |
2579 Lisp_Object valcontents; | |
2580 | |
2581 CHECK_SYMBOL (variable); | |
2582 | |
2583 retry: | |
2584 valcontents = XSYMBOL (variable)->value; | |
2585 | |
2586 retry_2: | |
2587 if (!SYMBOL_VALUE_MAGIC_P (valcontents)) | |
2588 return variable; | |
2589 | |
2590 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
2591 { | |
2592 case SYMVAL_LISP_MAGIC: | |
2593 if (!UNBOUNDP (maybe_call_magic_handler | |
2594 (variable, Qkill_console_local_variable, 0))) | |
2595 return variable; | |
2596 valcontents = XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed; | |
2597 /* semi-change-o */ | |
2598 goto retry_2; | |
2599 | |
2600 case SYMVAL_VARALIAS: | |
2601 variable = follow_varalias_pointers (variable, | |
2602 Qkill_console_local_variable); | |
2603 /* presto change-o! */ | |
2604 goto retry; | |
2605 | |
2606 case SYMVAL_SELECTED_CONSOLE_FORWARD: | |
2607 { | |
442 | 2608 const struct symbol_value_forward *fwd |
428 | 2609 = XSYMBOL_VALUE_FORWARD (valcontents); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2610 int offset = ((Rawbyte *) symbol_value_forward_forward (fwd) |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2611 - (Rawbyte *) &console_local_flags); |
428 | 2612 int mask = |
2613 XINT (*((Lisp_Object *) symbol_value_forward_forward (fwd))); | |
2614 | |
2615 if (mask > 0) | |
2616 { | |
2617 int (*magicfun) (Lisp_Object sym, Lisp_Object *val, | |
2618 Lisp_Object in_object, int flags) = | |
2619 symbol_value_forward_magicfun (fwd); | |
2620 Lisp_Object oldval = * (Lisp_Object *) | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2621 (offset + (Rawbyte *) XCONSOLE (Vconsole_defaults)); |
428 | 2622 if (magicfun) |
2623 magicfun (variable, &oldval, Vselected_console, 0); | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
2624 *(Lisp_Object *) (offset + (Rawbyte *) XCONSOLE (Vselected_console)) |
428 | 2625 = oldval; |
2626 XCONSOLE (Vselected_console)->local_var_flags &= ~mask; | |
2627 } | |
2628 return variable; | |
2629 } | |
2630 | |
2631 default: | |
2632 return variable; | |
2633 } | |
2634 } | |
2635 | |
2636 /* Used by specbind to determine what effects it might have. Returns: | |
2637 * 0 if symbol isn't buffer-local, and wouldn't be after it is set | |
2638 * <0 if symbol isn't presently buffer-local, but set would make it so | |
2639 * >0 if symbol is presently buffer-local | |
2640 */ | |
2641 int | |
2642 symbol_value_buffer_local_info (Lisp_Object symbol, struct buffer *buffer) | |
2643 { | |
2644 Lisp_Object valcontents; | |
2645 | |
2646 retry: | |
2647 valcontents = XSYMBOL (symbol)->value; | |
2648 | |
2649 retry_2: | |
2650 if (SYMBOL_VALUE_MAGIC_P (valcontents)) | |
2651 { | |
2652 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
2653 { | |
2654 case SYMVAL_LISP_MAGIC: | |
2655 /* #### kludge */ | |
2656 valcontents = XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed; | |
2657 /* semi-change-o */ | |
2658 goto retry_2; | |
2659 | |
2660 case SYMVAL_VARALIAS: | |
2661 symbol = follow_varalias_pointers (symbol, Qt /* #### kludge */); | |
2662 /* presto change-o! */ | |
2663 goto retry; | |
2664 | |
2665 case SYMVAL_CURRENT_BUFFER_FORWARD: | |
2666 { | |
442 | 2667 const struct symbol_value_forward *fwd |
428 | 2668 = XSYMBOL_VALUE_FORWARD (valcontents); |
2669 int mask = XINT (*((Lisp_Object *) | |
2670 symbol_value_forward_forward (fwd))); | |
2671 if ((mask <= 0) || (buffer && (buffer->local_var_flags & mask))) | |
2672 /* Already buffer-local */ | |
2673 return 1; | |
2674 else | |
2675 /* Would be buffer-local after set */ | |
2676 return -1; | |
2677 } | |
2678 case SYMVAL_BUFFER_LOCAL: | |
2679 case SYMVAL_SOME_BUFFER_LOCAL: | |
2680 { | |
2681 struct symbol_value_buffer_local *bfwd | |
2682 = XSYMBOL_VALUE_BUFFER_LOCAL (valcontents); | |
2683 if (buffer | |
2684 && !NILP (buffer_local_alist_element (buffer, symbol, bfwd))) | |
2685 return 1; | |
2686 else | |
2687 /* Automatically becomes local when set */ | |
2688 return bfwd->magic.type == SYMVAL_BUFFER_LOCAL ? -1 : 0; | |
2689 } | |
2690 default: | |
2691 return 0; | |
2692 } | |
2693 } | |
2694 return 0; | |
2695 } | |
2696 | |
2697 | |
2698 DEFUN ("symbol-value-in-buffer", Fsymbol_value_in_buffer, 2, 3, 0, /* | |
2699 Return the value of SYMBOL in BUFFER, or UNBOUND-VALUE if it is unbound. | |
2700 */ | |
2701 (symbol, buffer, unbound_value)) | |
2702 { | |
2703 Lisp_Object value; | |
2704 CHECK_SYMBOL (symbol); | |
2705 CHECK_BUFFER (buffer); | |
2706 value = symbol_value_in_buffer (symbol, buffer); | |
2707 return UNBOUNDP (value) ? unbound_value : value; | |
2708 } | |
2709 | |
2710 DEFUN ("symbol-value-in-console", Fsymbol_value_in_console, 2, 3, 0, /* | |
2711 Return the value of SYMBOL in CONSOLE, or UNBOUND-VALUE if it is unbound. | |
2712 */ | |
2713 (symbol, console, unbound_value)) | |
2714 { | |
2715 Lisp_Object value; | |
2716 CHECK_SYMBOL (symbol); | |
2717 CHECK_CONSOLE (console); | |
2718 value = symbol_value_in_console (symbol, console); | |
2719 return UNBOUNDP (value) ? unbound_value : value; | |
2720 } | |
2721 | |
2722 DEFUN ("built-in-variable-type", Fbuilt_in_variable_type, 1, 1, 0, /* | |
2723 If SYMBOL is a built-in variable, return info about this; else return nil. | |
2724 The returned info will be a symbol, one of | |
2725 | |
2726 `object' A simple built-in variable. | |
2727 `const-object' Same, but cannot be set. | |
2728 `integer' A built-in integer variable. | |
2729 `const-integer' Same, but cannot be set. | |
2730 `boolean' A built-in boolean variable. | |
2731 `const-boolean' Same, but cannot be set. | |
2732 `const-specifier' Always contains a specifier; e.g. `has-modeline-p'. | |
2733 `current-buffer' A built-in buffer-local variable. | |
2734 `const-current-buffer' Same, but cannot be set. | |
2735 `default-buffer' Forwards to the default value of a built-in | |
2736 buffer-local variable. | |
2737 `selected-console' A built-in console-local variable. | |
2738 `const-selected-console' Same, but cannot be set. | |
2739 `default-console' Forwards to the default value of a built-in | |
2740 console-local variable. | |
2741 */ | |
2742 (symbol)) | |
2743 { | |
2744 REGISTER Lisp_Object valcontents; | |
2745 | |
2746 CHECK_SYMBOL (symbol); | |
2747 | |
2748 retry: | |
2749 valcontents = XSYMBOL (symbol)->value; | |
2750 | |
2751 retry_2: | |
2752 if (!SYMBOL_VALUE_MAGIC_P (valcontents)) | |
2753 return Qnil; | |
2754 | |
2755 switch (XSYMBOL_VALUE_MAGIC_TYPE (valcontents)) | |
2756 { | |
2757 case SYMVAL_LISP_MAGIC: | |
2758 valcontents = XSYMBOL_VALUE_LISP_MAGIC (valcontents)->shadowed; | |
2759 /* semi-change-o */ | |
2760 goto retry_2; | |
2761 | |
2762 case SYMVAL_VARALIAS: | |
2763 symbol = follow_varalias_pointers (symbol, Qt); | |
2764 /* presto change-o! */ | |
2765 goto retry; | |
2766 | |
2767 case SYMVAL_BUFFER_LOCAL: | |
2768 case SYMVAL_SOME_BUFFER_LOCAL: | |
2769 valcontents = | |
2770 XSYMBOL_VALUE_BUFFER_LOCAL (valcontents)->current_value; | |
2771 /* semi-change-o */ | |
2772 goto retry_2; | |
2773 | |
2774 case SYMVAL_FIXNUM_FORWARD: return Qinteger; | |
2775 case SYMVAL_CONST_FIXNUM_FORWARD: return Qconst_integer; | |
2776 case SYMVAL_BOOLEAN_FORWARD: return Qboolean; | |
2777 case SYMVAL_CONST_BOOLEAN_FORWARD: return Qconst_boolean; | |
2778 case SYMVAL_OBJECT_FORWARD: return Qobject; | |
2779 case SYMVAL_CONST_OBJECT_FORWARD: return Qconst_object; | |
2780 case SYMVAL_CONST_SPECIFIER_FORWARD: return Qconst_specifier; | |
2781 case SYMVAL_DEFAULT_BUFFER_FORWARD: return Qdefault_buffer; | |
2782 case SYMVAL_CURRENT_BUFFER_FORWARD: return Qcurrent_buffer; | |
2783 case SYMVAL_CONST_CURRENT_BUFFER_FORWARD: return Qconst_current_buffer; | |
2784 case SYMVAL_DEFAULT_CONSOLE_FORWARD: return Qdefault_console; | |
2785 case SYMVAL_SELECTED_CONSOLE_FORWARD: return Qselected_console; | |
2786 case SYMVAL_CONST_SELECTED_CONSOLE_FORWARD: return Qconst_selected_console; | |
2787 case SYMVAL_UNBOUND_MARKER: return Qnil; | |
2788 | |
2789 default: | |
2500 | 2790 ABORT (); return Qnil; |
428 | 2791 } |
2792 } | |
2793 | |
2794 | |
2795 DEFUN ("local-variable-p", Flocal_variable_p, 2, 3, 0, /* | |
2796 Return t if SYMBOL's value is local to BUFFER. | |
444 | 2797 If optional third arg AFTER-SET is non-nil, return t if SYMBOL would be |
428 | 2798 buffer-local after it is set, regardless of whether it is so presently. |
2799 A nil value for BUFFER is *not* the same as (current-buffer), but means | |
2800 "no buffer". Specifically: | |
2801 | |
2802 -- If BUFFER is nil and AFTER-SET is nil, a return value of t indicates that | |
2803 the variable is one of the special built-in variables that is always | |
2804 buffer-local. (This includes `buffer-file-name', `buffer-read-only', | |
2805 `buffer-undo-list', and others.) | |
2806 | |
2807 -- If BUFFER is nil and AFTER-SET is t, a return value of t indicates that | |
2808 the variable has had `make-variable-buffer-local' applied to it. | |
2809 */ | |
2810 (symbol, buffer, after_set)) | |
2811 { | |
2812 int local_info; | |
2813 | |
2814 CHECK_SYMBOL (symbol); | |
2815 if (!NILP (buffer)) | |
2816 { | |
2817 buffer = get_buffer (buffer, 1); | |
2818 local_info = symbol_value_buffer_local_info (symbol, XBUFFER (buffer)); | |
2819 } | |
2820 else | |
2821 { | |
2822 local_info = symbol_value_buffer_local_info (symbol, 0); | |
2823 } | |
2824 | |
2825 if (NILP (after_set)) | |
2826 return local_info > 0 ? Qt : Qnil; | |
2827 else | |
2828 return local_info != 0 ? Qt : Qnil; | |
2829 } | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2830 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2831 DEFUN ("custom-variable-p", Fcustom_variable_p, 1, 1, 0, /* |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2832 Return non-nil if SYMBOL names a custom variable. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2833 Does not follow the variable alias chain. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2834 */ |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2835 (symbol)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2836 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2837 return (!(NILP (Fget(symbol, intern ("standard-value"), Qnil))) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2838 || !(NILP (Fget(symbol, intern ("custom-autoload"), Qnil)))) ? |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2839 Qt: Qnil; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2840 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2841 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2842 static Lisp_Object |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2843 user_variable_alias_check_fun (Lisp_Object symbol) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2844 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2845 Lisp_Object documentation = Fget (symbol, Qvariable_documentation, Qnil); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2846 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2847 if ((INTP (documentation) && XINT (documentation) < 0) || |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2848 (STRINGP (documentation) && |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2849 (string_byte (documentation, 0) == '*')) || |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2850 /* If (STRING . INTEGER), a negative integer means a user variable. */ |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2851 (CONSP (documentation) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2852 && STRINGP (XCAR (documentation)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2853 && INTP (XCDR (documentation)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2854 && XINT (XCDR (documentation)) < 0) || |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2855 !NILP (Fcustom_variable_p (symbol))) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2856 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2857 return make_int(1); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2858 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2859 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2860 return Qzero; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2861 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2862 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2863 DEFUN ("user-variable-p", Fuser_variable_p, 1, 1, 0, /* |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2864 Return t if SYMBOL names a variable intended to be set and modified by users. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2865 \(The alternative is a variable used internally in a Lisp program.) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2866 A symbol names a user variable if |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2867 \(1) the first character of its documentation is `*', or |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2868 \(2) it is customizable (`custom-variable-p' gives t), or |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2869 \(3) it names a variable alias that eventually resolves to another user variable. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2870 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2871 The GNU Emacs implementation of `user-variable-p' returns nil if there is a |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2872 loop in the chain of symbols. Since this is indistinguishable from the case |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2873 where a symbol names a non-user variable, XEmacs signals a |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2874 `cyclic-variable-indirection' error instead; use `condition-case' to catch |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2875 this error if you really want to avoid this. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2876 */ |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2877 (symbol)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2878 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2879 Lisp_Object mapped; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2880 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2881 if (!SYMBOLP (symbol)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2882 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2883 return Qnil; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2884 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2885 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2886 /* Called for its side-effects, we want it to signal if there's a loop. */ |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2887 follow_varalias_pointers (symbol, Qt); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2888 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2889 /* Look through the various aliases. */ |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2890 mapped = map_varalias_chain (symbol, Qt, user_variable_alias_check_fun); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2891 if (EQ (Qzero, mapped)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2892 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2893 return Qnil; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2894 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2895 |
4503
af95657e0bfd
Use EQ() and !EQ() in symbols.c, thank you Robert Delius Royar.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4502
diff
changeset
|
2896 assert (EQ (make_int (1), mapped)); |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2897 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2898 return Qt; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2899 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2900 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
2901 |
428 | 2902 |
2903 | |
2904 /* | |
2905 I've gone ahead and partially implemented this because it's | |
2906 super-useful for dealing with the compatibility problems in supporting | |
2907 the old pointer-shape variables, and preventing people from `setq'ing | |
2908 the new variables. Any other way of handling this problem is way | |
2909 ugly, likely to be slow, and generally not something I want to waste | |
2910 my time worrying about. | |
2911 | |
2912 The interface and/or function name is sure to change before this | |
2913 gets into its final form. I currently like the way everything is | |
2914 set up and it has all the features I want it to have, except for | |
2915 one: I really want to be able to have multiple nested handlers, | |
2916 to implement an `advice'-like capability. This would allow, | |
2917 for example, a clean way of implementing `debug-if-set' or | |
2918 `debug-if-referenced' and such. | |
2919 | |
2920 NOTE NOTE NOTE NOTE NOTE NOTE NOTE: | |
2921 ************************************************************ | |
2922 **Only** the `set-value', `make-unbound', and `make-local' | |
2923 handler types are currently implemented. Implementing the | |
2924 get-value and bound-predicate handlers is somewhat tricky | |
2925 because there are lots of subfunctions (e.g. find_symbol_value()). | |
2926 find_symbol_value(), in fact, is called from outside of | |
2927 this module. You'd have to have it do this: | |
2928 | |
2929 -- check for a `bound-predicate' handler, call that if so; | |
2930 if it returns nil, return Qunbound | |
2931 -- check for a `get-value' handler and call it and return | |
2932 that value | |
2933 | |
2934 It gets even trickier when you have to deal with | |
2935 sub-subfunctions like find_symbol_value_1(), and esp. | |
2936 when you have to properly handle variable aliases, which | |
2937 can lead to lots of tricky situations. So I've just | |
2938 punted on this, since the interface isn't officially | |
2939 exported and we can get by with just a `set-value' | |
2940 handler. | |
2941 | |
2942 Actions in unimplemented handler types will correctly | |
2943 ignore any handlers, and will not fuck anything up or | |
2944 go awry. | |
2945 | |
2946 WARNING WARNING: If you do go and implement another | |
2947 type of handler, make *sure* to change | |
2948 would_be_magic_handled() so it knows about this, | |
2949 or dire things could result. | |
2950 ************************************************************ | |
2951 NOTE NOTE NOTE NOTE NOTE NOTE NOTE | |
2952 | |
2953 Real documentation is as follows. | |
2954 | |
2955 Set a magic handler for VARIABLE. | |
2956 This allows you to specify arbitrary behavior that results from | |
2957 accessing or setting a variable. For example, retrieving the | |
2958 variable's value might actually retrieve the first element off of | |
2959 a list stored in another variable, and setting the variable's value | |
2960 might add an element to the front of that list. (This is how the | |
2961 obsolete variable `unread-command-event' is implemented.) | |
2962 | |
2963 In general it is NOT good programming practice to use magic variables | |
2964 in a new package that you are designing. If you feel the need to | |
2965 do this, it's almost certainly a sign that you should be using a | |
2966 function instead of a variable. This facility is provided to allow | |
2967 a package to support obsolete variables and provide compatibility | |
2968 with similar packages with different variable names and semantics. | |
2969 By using magic handlers, you can cleanly provide obsoleteness and | |
2970 compatibility support and separate this support from the core | |
2971 routines in a package. | |
2972 | |
2973 VARIABLE should be a symbol naming the variable for which the | |
2974 magic behavior is provided. HANDLER-TYPE is a symbol specifying | |
2975 which behavior is being controlled, and HANDLER is the function | |
2976 that will be called to control this behavior. HARG is a | |
2977 value that will be passed to HANDLER but is otherwise | |
2978 uninterpreted. KEEP-EXISTING specifies what to do with existing | |
2979 handlers of the same type; nil means "erase them all", t means | |
2980 "keep them but insert at the beginning", the list (t) means | |
2981 "keep them but insert at the end", a function means "keep | |
2982 them but insert before the specified function", a list containing | |
2983 a function means "keep them but insert after the specified | |
2984 function". | |
2985 | |
2986 You can specify magic behavior for any type of variable at all, | |
2987 and for any handler types that are unspecified, the standard | |
2988 behavior applies. This allows you, for example, to use | |
2989 `defvaralias' in conjunction with this function. (For that | |
2990 matter, `defvaralias' could be implemented using this function.) | |
2991 | |
2992 The behaviors that can be specified in HANDLER-TYPE are | |
2993 | |
2994 get-value (SYM ARGS FUN HARG HANDLERS) | |
2995 This means that one of the functions `symbol-value', | |
2996 `default-value', `symbol-value-in-buffer', or | |
2997 `symbol-value-in-console' was called on SYM. | |
2998 | |
2999 set-value (SYM ARGS FUN HARG HANDLERS) | |
3000 This means that one of the functions `set' or `set-default' | |
3001 was called on SYM. | |
3002 | |
3003 bound-predicate (SYM ARGS FUN HARG HANDLERS) | |
3004 This means that one of the functions `boundp', `globally-boundp', | |
3005 or `default-boundp' was called on SYM. | |
3006 | |
3007 make-unbound (SYM ARGS FUN HARG HANDLERS) | |
3008 This means that the function `makunbound' was called on SYM. | |
3009 | |
3010 local-predicate (SYM ARGS FUN HARG HANDLERS) | |
3011 This means that the function `local-variable-p' was called | |
3012 on SYM. | |
3013 | |
3014 make-local (SYM ARGS FUN HARG HANDLERS) | |
3015 This means that one of the functions `make-local-variable', | |
3016 `make-variable-buffer-local', `kill-local-variable', | |
3017 or `kill-console-local-variable' was called on SYM. | |
3018 | |
3019 The meanings of the arguments are as follows: | |
3020 | |
3021 SYM is the symbol on which the function was called, and is always | |
3022 the first argument to the function. | |
3023 | |
3024 ARGS are the remaining arguments in the original call (i.e. all | |
3025 but the first). In the case of `set-value' in particular, | |
3026 the first element of ARGS is the value to which the variable | |
3027 is being set. In some cases, ARGS is sanitized from what was | |
3028 actually given. For example, whenever `nil' is passed to an | |
3029 argument and it means `current-buffer', the current buffer is | |
3030 substituted instead. | |
3031 | |
3032 FUN is a symbol indicating which function is being called. | |
3033 For many of the functions, you can determine the corresponding | |
3034 function of a different class using | |
3035 `symbol-function-corresponding-function'. | |
3036 | |
3037 HARG is the argument that was given in the call | |
3038 to `set-symbol-value-handler' for SYM and HANDLER-TYPE. | |
3039 | |
3040 HANDLERS is a structure containing the remaining handlers | |
3041 for the variable; to call one of them, use | |
3042 `chain-to-symbol-value-handler'. | |
3043 | |
3044 NOTE: You may *not* modify the list in ARGS, and if you want to | |
3045 keep it around after the handler function exits, you must make | |
3046 a copy using `copy-sequence'. (Same caveats for HANDLERS also.) | |
3047 */ | |
3048 | |
3049 static enum lisp_magic_handler | |
3050 decode_magic_handler_type (Lisp_Object symbol) | |
3051 { | |
3052 if (EQ (symbol, Qget_value)) return MAGIC_HANDLER_GET_VALUE; | |
3053 if (EQ (symbol, Qset_value)) return MAGIC_HANDLER_SET_VALUE; | |
3054 if (EQ (symbol, Qbound_predicate)) return MAGIC_HANDLER_BOUND_PREDICATE; | |
3055 if (EQ (symbol, Qmake_unbound)) return MAGIC_HANDLER_MAKE_UNBOUND; | |
3056 if (EQ (symbol, Qlocal_predicate)) return MAGIC_HANDLER_LOCAL_PREDICATE; | |
3057 if (EQ (symbol, Qmake_local)) return MAGIC_HANDLER_MAKE_LOCAL; | |
3058 | |
563 | 3059 invalid_constant ("Unrecognized symbol value handler type", symbol); |
1204 | 3060 RETURN_NOT_REACHED (MAGIC_HANDLER_MAX); |
428 | 3061 } |
3062 | |
3063 static enum lisp_magic_handler | |
3064 handler_type_from_function_symbol (Lisp_Object funsym, int abort_if_not_found) | |
3065 { | |
3066 if (EQ (funsym, Qsymbol_value) | |
3067 || EQ (funsym, Qdefault_value) | |
3068 || EQ (funsym, Qsymbol_value_in_buffer) | |
3069 || EQ (funsym, Qsymbol_value_in_console)) | |
3070 return MAGIC_HANDLER_GET_VALUE; | |
3071 | |
3072 if (EQ (funsym, Qset) | |
3073 || EQ (funsym, Qset_default)) | |
3074 return MAGIC_HANDLER_SET_VALUE; | |
3075 | |
3076 if (EQ (funsym, Qboundp) | |
3077 || EQ (funsym, Qglobally_boundp) | |
3078 || EQ (funsym, Qdefault_boundp)) | |
3079 return MAGIC_HANDLER_BOUND_PREDICATE; | |
3080 | |
3081 if (EQ (funsym, Qmakunbound)) | |
3082 return MAGIC_HANDLER_MAKE_UNBOUND; | |
3083 | |
3084 if (EQ (funsym, Qlocal_variable_p)) | |
3085 return MAGIC_HANDLER_LOCAL_PREDICATE; | |
3086 | |
3087 if (EQ (funsym, Qmake_variable_buffer_local) | |
3088 || EQ (funsym, Qmake_local_variable)) | |
3089 return MAGIC_HANDLER_MAKE_LOCAL; | |
3090 | |
3091 if (abort_if_not_found) | |
2500 | 3092 ABORT (); |
563 | 3093 invalid_argument ("Unrecognized symbol-value function", funsym); |
1204 | 3094 RETURN_NOT_REACHED (MAGIC_HANDLER_MAX); |
428 | 3095 } |
3096 | |
3097 static int | |
3098 would_be_magic_handled (Lisp_Object sym, Lisp_Object funsym) | |
3099 { | |
3100 /* does not take into account variable aliasing. */ | |
3101 Lisp_Object valcontents = XSYMBOL (sym)->value; | |
3102 enum lisp_magic_handler slot; | |
3103 | |
3104 if (!SYMBOL_VALUE_LISP_MAGIC_P (valcontents)) | |
3105 return 0; | |
3106 slot = handler_type_from_function_symbol (funsym, 1); | |
3107 if (slot != MAGIC_HANDLER_SET_VALUE && slot != MAGIC_HANDLER_MAKE_UNBOUND | |
3108 && slot != MAGIC_HANDLER_MAKE_LOCAL) | |
3109 /* #### temporary kludge because we haven't implemented | |
3110 lisp-magic variables completely */ | |
3111 return 0; | |
3112 return !NILP (XSYMBOL_VALUE_LISP_MAGIC (valcontents)->handler[slot]); | |
3113 } | |
3114 | |
3115 static Lisp_Object | |
3116 fetch_value_maybe_past_magic (Lisp_Object sym, | |
3117 Lisp_Object follow_past_lisp_magic) | |
3118 { | |
3119 Lisp_Object value = XSYMBOL (sym)->value; | |
3120 if (SYMBOL_VALUE_LISP_MAGIC_P (value) | |
3121 && (EQ (follow_past_lisp_magic, Qt) | |
3122 || (!NILP (follow_past_lisp_magic) | |
3123 && !would_be_magic_handled (sym, follow_past_lisp_magic)))) | |
3124 value = XSYMBOL_VALUE_LISP_MAGIC (value)->shadowed; | |
3125 return value; | |
3126 } | |
3127 | |
3128 static Lisp_Object * | |
3129 value_slot_past_magic (Lisp_Object sym) | |
3130 { | |
3131 Lisp_Object *store_pointer = &XSYMBOL (sym)->value; | |
3132 | |
3133 if (SYMBOL_VALUE_LISP_MAGIC_P (*store_pointer)) | |
3134 store_pointer = &XSYMBOL_VALUE_LISP_MAGIC (sym)->shadowed; | |
3135 return store_pointer; | |
3136 } | |
3137 | |
3138 static Lisp_Object | |
3139 maybe_call_magic_handler (Lisp_Object sym, Lisp_Object funsym, int nargs, ...) | |
3140 { | |
3141 va_list vargs; | |
3142 Lisp_Object args[20]; /* should be enough ... */ | |
3143 int i; | |
3144 enum lisp_magic_handler htype; | |
3145 Lisp_Object legerdemain; | |
3146 struct symbol_value_lisp_magic *bfwd; | |
3147 | |
440 | 3148 assert (nargs >= 0 && nargs < countof (args)); |
428 | 3149 legerdemain = XSYMBOL (sym)->value; |
3150 assert (SYMBOL_VALUE_LISP_MAGIC_P (legerdemain)); | |
3151 bfwd = XSYMBOL_VALUE_LISP_MAGIC (legerdemain); | |
3152 | |
3153 va_start (vargs, nargs); | |
3154 for (i = 0; i < nargs; i++) | |
3155 args[i] = va_arg (vargs, Lisp_Object); | |
3156 va_end (vargs); | |
3157 | |
3158 htype = handler_type_from_function_symbol (funsym, 1); | |
3159 if (NILP (bfwd->handler[htype])) | |
3160 return Qunbound; | |
3161 /* #### should be reusing the arglist, not always consing anew. | |
3162 Repeated handler invocations should not cause repeated consing. | |
3163 Doesn't matter for now, because this is just a quick implementation | |
3164 for obsolescence support. */ | |
3165 return call5 (bfwd->handler[htype], sym, Flist (nargs, args), funsym, | |
3166 bfwd->harg[htype], Qnil); | |
3167 } | |
3168 | |
3169 DEFUN ("dontusethis-set-symbol-value-handler", Fdontusethis_set_symbol_value_handler, | |
3170 3, 5, 0, /* | |
3171 Don't you dare use this. | |
3172 If you do, suffer the wrath of Ben, who is likely to rename | |
3173 this function (or change the semantics of its arguments) without | |
3174 pity, thereby invalidating your code. | |
3175 */ | |
2286 | 3176 (variable, handler_type, handler, harg, |
4642
48b45a606961
Support #'function-arglist with built-in special forms.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
3177 UNUSED (keep_existing ))) |
428 | 3178 { |
3179 Lisp_Object valcontents; | |
3180 struct symbol_value_lisp_magic *bfwd; | |
3181 enum lisp_magic_handler htype; | |
3182 int i; | |
3183 | |
3184 /* #### WARNING, only some handler types are implemented. See above. | |
3185 Actions of other types will ignore a handler if it's there. | |
3186 | |
3187 #### Also, `chain-to-symbol-value-handler' and | |
3188 `symbol-function-corresponding-function' are not implemented. */ | |
3189 CHECK_SYMBOL (variable); | |
3190 CHECK_SYMBOL (handler_type); | |
3191 htype = decode_magic_handler_type (handler_type); | |
3192 valcontents = XSYMBOL (variable)->value; | |
3193 if (!SYMBOL_VALUE_LISP_MAGIC_P (valcontents)) | |
3194 { | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
3195 bfwd = |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
3196 XSYMBOL_VALUE_LISP_MAGIC |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
3197 (ALLOC_NORMAL_LISP_OBJECT (symbol_value_lisp_magic)); |
428 | 3198 bfwd->magic.type = SYMVAL_LISP_MAGIC; |
3199 for (i = 0; i < MAGIC_HANDLER_MAX; i++) | |
3200 { | |
3201 bfwd->handler[i] = Qnil; | |
3202 bfwd->harg[i] = Qnil; | |
3203 } | |
3204 bfwd->shadowed = valcontents; | |
793 | 3205 XSYMBOL (variable)->value = wrap_symbol_value_magic (bfwd); |
428 | 3206 } |
3207 else | |
3208 bfwd = XSYMBOL_VALUE_LISP_MAGIC (valcontents); | |
3209 bfwd->handler[htype] = handler; | |
3210 bfwd->harg[htype] = harg; | |
3211 | |
3212 for (i = 0; i < MAGIC_HANDLER_MAX; i++) | |
3213 if (!NILP (bfwd->handler[i])) | |
3214 break; | |
3215 | |
3216 if (i == MAGIC_HANDLER_MAX) | |
3217 /* there are no remaining handlers, so remove the structure. */ | |
3218 XSYMBOL (variable)->value = bfwd->shadowed; | |
3219 | |
3220 return Qnil; | |
3221 } | |
3222 | |
3223 | |
3224 /* functions for working with variable aliases. */ | |
3225 | |
3226 /* Follow the chain of variable aliases for SYMBOL. Return the | |
3227 resulting symbol, whose value cell is guaranteed not to be a | |
3228 symbol-value-varalias. | |
3229 | |
3230 Also maybe follow past symbol-value-lisp-magic -> symbol-value-varalias. | |
3231 If FUNSYM is t, always follow in such a case. If FUNSYM is nil, | |
3232 never follow; stop right there. Otherwise FUNSYM should be a | |
3233 recognized symbol-value function symbol; this means, follow | |
3234 unless there is a special handler for the named function. | |
3235 | |
3236 OK, there is at least one reason why it's necessary for | |
3237 FOLLOW-PAST-LISP-MAGIC to be specified correctly: So that we | |
3238 can always be sure to catch cyclic variable aliasing. If we never | |
3239 follow past Lisp magic, then if the following is done: | |
3240 | |
3241 (defvaralias 'a 'b) | |
3242 add some magic behavior to a, but not a "get-value" handler | |
3243 (defvaralias 'b 'a) | |
3244 | |
3245 then an attempt to retrieve a's or b's value would cause infinite | |
3246 looping in `symbol-value'. | |
3247 | |
3248 We (of course) can't always follow past Lisp magic, because then | |
3249 we make any variable that is lisp-magic -> varalias behave as if | |
3250 the lisp-magic is not present at all. | |
3251 */ | |
3252 | |
3253 static Lisp_Object | |
3254 follow_varalias_pointers (Lisp_Object symbol, | |
3255 Lisp_Object follow_past_lisp_magic) | |
3256 { | |
3257 #define VARALIAS_INDIRECTION_SUSPICION_LENGTH 16 | |
3258 Lisp_Object tortoise, hare, val; | |
3259 int count; | |
3260 | |
3261 /* quick out just in case */ | |
3262 if (!SYMBOL_VALUE_MAGIC_P (XSYMBOL (symbol)->value)) | |
3263 return symbol; | |
3264 | |
3265 /* Compare implementation of indirect_function(). */ | |
3266 for (hare = tortoise = symbol, count = 0; | |
3267 val = fetch_value_maybe_past_magic (hare, follow_past_lisp_magic), | |
3268 SYMBOL_VALUE_VARALIAS_P (val); | |
3269 hare = symbol_value_varalias_aliasee (XSYMBOL_VALUE_VARALIAS (val)), | |
3270 count++) | |
3271 { | |
3272 if (count < VARALIAS_INDIRECTION_SUSPICION_LENGTH) continue; | |
3273 | |
3274 if (count & 1) | |
3275 tortoise = symbol_value_varalias_aliasee | |
3276 (XSYMBOL_VALUE_VARALIAS (fetch_value_maybe_past_magic | |
3277 (tortoise, follow_past_lisp_magic))); | |
3278 if (EQ (hare, tortoise)) | |
3279 return Fsignal (Qcyclic_variable_indirection, list1 (symbol)); | |
3280 } | |
3281 | |
3282 return hare; | |
3283 } | |
3284 | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3285 /* Map FN over the chain of variable aliases for SYMBOL. If FN returns |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3286 something other than Qzero for some link in the chain, return that |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3287 immediately. Otherwise return Qzero (which is not a symbol). |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3288 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3289 FN may be called twice on the same symbol if the varalias chain is |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3290 cyclic. Prevent this by calling follow_varalias_pointers first for its |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3291 side-effects. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3292 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3293 Signals a cyclic-variable-indirection error if a cyclic structure is |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3294 detected. */ |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3295 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3296 static Lisp_Object |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3297 map_varalias_chain (Lisp_Object symbol, |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3298 Lisp_Object follow_past_lisp_magic, |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3299 Lisp_Object (*fn) (Lisp_Object arg)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3300 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3301 #define VARALIAS_INDIRECTION_SUSPICION_LENGTH 16 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3302 Lisp_Object tortoise, hare, val, res; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3303 int count; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3304 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3305 assert (fn); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3306 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3307 /* quick out just in case */ |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3308 if (!SYMBOL_VALUE_MAGIC_P (XSYMBOL (symbol)->value)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3309 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3310 return (fn)(symbol); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3311 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3312 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3313 /* Compare implementation of indirect_function(). */ |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3314 for (hare = tortoise = symbol, count = 0; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3315 val = fetch_value_maybe_past_magic (hare, follow_past_lisp_magic), |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3316 SYMBOL_VALUE_VARALIAS_P (val); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3317 hare = symbol_value_varalias_aliasee (XSYMBOL_VALUE_VARALIAS (val)), |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3318 count++) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3319 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3320 res = (fn) (hare); |
4503
af95657e0bfd
Use EQ() and !EQ() in symbols.c, thank you Robert Delius Royar.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4502
diff
changeset
|
3321 if (!EQ (Qzero, res)) |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3322 { |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3323 return res; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3324 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3325 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3326 if (count < VARALIAS_INDIRECTION_SUSPICION_LENGTH) continue; |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3327 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3328 if (count & 1) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3329 tortoise = symbol_value_varalias_aliasee |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3330 (XSYMBOL_VALUE_VARALIAS (fetch_value_maybe_past_magic |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3331 (tortoise, follow_past_lisp_magic))); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3332 if (EQ (hare, tortoise)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3333 return Fsignal (Qcyclic_variable_indirection, list1 (symbol)); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3334 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3335 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3336 return (fn) (hare); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3337 } |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3338 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3339 /* |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3340 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3341 OED entry, 2nd edition, IPA transliterated using Kirshenbaum: |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3342 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3343 alias ('eIlI@s, '&lI@s), adv. and n. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3344 [...] |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3345 B. n. (with pl. aliases.) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3346 1. Another name, an assumed name. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3347 1605 Camden Rem. (1614) 147 An Alias or double name cannot preiudice the honest. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3348 1831 Edin. Rev. LIII. 364 He has been assuming various aliases. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3349 1861 Macaulay Hist. Eng. V. 92 The monk who was sometimes called Harrison |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3350 and sometimes went by the alias of Johnson. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3351 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3352 The alias is the fake name. Let's try to follow that usage in our |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3353 documentation. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3354 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3355 */ |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3356 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3357 DEFUN ("defvaralias", Fdefvaralias, 2, 3, 0, /* |
428 | 3358 Define a variable as an alias for another variable. |
3359 Thenceforth, any operations performed on VARIABLE will actually be | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3360 performed on ALIASED. Both VARIABLE and ALIASED should be symbols. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3361 If ALIASED is nil and VARIABLE is an existing alias, remove that alias. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3362 ALIASED can itself be an alias, and the chain of variable aliases |
428 | 3363 will be followed appropriately. |
3364 If VARIABLE already has a value, this value will be shadowed | |
3365 until the alias is removed, at which point it will be restored. | |
3366 Currently VARIABLE cannot be a built-in variable, a variable that | |
3367 has a buffer-local value in any buffer, or the symbols nil or t. | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3368 \(ALIASED, however, can be any type of variable.) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3369 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3370 Optional argument DOCSTRING is documentation for VARIABLE in its use as an |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3371 alias for ALIASED. The XEmacs help code ignores this documentation, using |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3372 the documentation of ALIASED instead, and the docstring, if specified, is |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3373 not shadowed in the same way that the value is. Only use it if you know |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3374 what you're doing. |
428 | 3375 */ |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3376 (variable, aliased, docstring)) |
428 | 3377 { |
3378 struct symbol_value_varalias *bfwd; | |
3379 Lisp_Object valcontents; | |
3380 | |
3381 CHECK_SYMBOL (variable); | |
3382 reject_constant_symbols (variable, Qunbound, 0, Qt); | |
3383 | |
3384 valcontents = XSYMBOL (variable)->value; | |
3385 | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3386 if (NILP (aliased)) |
428 | 3387 { |
3388 if (SYMBOL_VALUE_VARALIAS_P (valcontents)) | |
3389 { | |
3390 XSYMBOL (variable)->value = | |
3391 symbol_value_varalias_shadowed | |
3392 (XSYMBOL_VALUE_VARALIAS (valcontents)); | |
3393 } | |
3394 return Qnil; | |
3395 } | |
3396 | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3397 CHECK_SYMBOL (aliased); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3398 |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3399 if (!NILP (docstring)) |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3400 Fput (variable, Qvariable_documentation, docstring); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3401 |
428 | 3402 if (SYMBOL_VALUE_VARALIAS_P (valcontents)) |
3403 { | |
3404 /* transmogrify */ | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3405 XSYMBOL_VALUE_VARALIAS (valcontents)->aliasee = aliased; |
428 | 3406 return Qnil; |
3407 } | |
3408 | |
3409 if (SYMBOL_VALUE_MAGIC_P (valcontents) | |
3410 && !UNBOUNDP (valcontents)) | |
563 | 3411 invalid_change ("Variable is magic and cannot be aliased", variable); |
428 | 3412 reject_constant_symbols (variable, Qunbound, 0, Qt); |
3413 | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
3414 bfwd = |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
3415 XSYMBOL_VALUE_VARALIAS (ALLOC_NORMAL_LISP_OBJECT (symbol_value_varalias)); |
428 | 3416 bfwd->magic.type = SYMVAL_VARALIAS; |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3417 bfwd->aliasee = aliased; |
428 | 3418 bfwd->shadowed = valcontents; |
3419 | |
793 | 3420 valcontents = wrap_symbol_value_magic (bfwd); |
428 | 3421 XSYMBOL (variable)->value = valcontents; |
3422 return Qnil; | |
3423 } | |
3424 | |
3425 DEFUN ("variable-alias", Fvariable_alias, 1, 2, 0, /* | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3426 If VARIABLE is an alias of another variable, return that variable. |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3427 VARIABLE should be a symbol. If VARIABLE is not an alias, return nil. |
428 | 3428 Variable aliases are created with `defvaralias'. See also |
3429 `indirect-variable'. | |
3430 */ | |
3431 (variable, follow_past_lisp_magic)) | |
3432 { | |
3433 Lisp_Object valcontents; | |
3434 | |
3435 CHECK_SYMBOL (variable); | |
3436 if (!NILP (follow_past_lisp_magic) && !EQ (follow_past_lisp_magic, Qt)) | |
3437 { | |
3438 CHECK_SYMBOL (follow_past_lisp_magic); | |
3439 handler_type_from_function_symbol (follow_past_lisp_magic, 0); | |
3440 } | |
3441 | |
3442 valcontents = fetch_value_maybe_past_magic (variable, | |
3443 follow_past_lisp_magic); | |
3444 | |
3445 if (SYMBOL_VALUE_VARALIAS_P (valcontents)) | |
3446 return symbol_value_varalias_aliasee | |
3447 (XSYMBOL_VALUE_VARALIAS (valcontents)); | |
3448 else | |
3449 return Qnil; | |
3450 } | |
3451 | |
3452 DEFUN ("indirect-variable", Findirect_variable, 1, 2, 0, /* | |
3453 Return the variable at the end of OBJECT's variable-alias chain. | |
3454 If OBJECT is a symbol, follow all variable aliases and return | |
3455 the final (non-aliased) symbol. Variable aliases are created with | |
3456 the function `defvaralias'. | |
3457 If OBJECT is not a symbol, just return it. | |
3458 Signal a cyclic-variable-indirection error if there is a loop in the | |
3459 variable chain of symbols. | |
3460 */ | |
3461 (object, follow_past_lisp_magic)) | |
3462 { | |
3463 if (!SYMBOLP (object)) | |
3464 return object; | |
3465 if (!NILP (follow_past_lisp_magic) && !EQ (follow_past_lisp_magic, Qt)) | |
3466 { | |
3467 CHECK_SYMBOL (follow_past_lisp_magic); | |
3468 handler_type_from_function_symbol (follow_past_lisp_magic, 0); | |
3469 } | |
3470 return follow_varalias_pointers (object, follow_past_lisp_magic); | |
3471 } | |
3472 | |
1674 | 3473 DEFUN ("variable-binding-locus", Fvariable_binding_locus, 1, 1, 0, /* |
3474 Return a value indicating where VARIABLE's current binding comes from. | |
3475 If the current binding is buffer-local, the value is the current buffer. | |
3476 If the current binding is global (the default), the value is nil. | |
3477 */ | |
3478 (variable)) | |
3479 { | |
3480 Lisp_Object valcontents; | |
3481 | |
3482 CHECK_SYMBOL (variable); | |
3483 variable = Findirect_variable (variable, Qnil); | |
3484 | |
3485 /* Make sure the current binding is actually swapped in. */ | |
3486 find_symbol_value (variable); | |
3487 | |
3488 valcontents = XSYMBOL (variable)->value; | |
3489 | |
3490 if (SYMBOL_VALUE_MAGIC_P (valcontents) | |
3491 && ((XSYMBOL_VALUE_MAGIC_TYPE (valcontents) == SYMVAL_BUFFER_LOCAL) | |
3492 || (XSYMBOL_VALUE_MAGIC_TYPE (valcontents) == SYMVAL_SOME_BUFFER_LOCAL)) | |
3493 && (!NILP (Flocal_variable_p (variable, Fcurrent_buffer (), Qnil)))) | |
3494 return Fcurrent_buffer (); | |
3495 else | |
3496 return Qnil; | |
3497 } | |
428 | 3498 |
3499 /************************************************************************/ | |
3500 /* initialization */ | |
3501 /************************************************************************/ | |
3502 | |
3503 /* A dumped XEmacs image has a lot more than 1511 symbols. Last | |
3504 estimate was that there were actually around 6300. So let's try | |
3505 making this bigger and see if we get better hashing behavior. */ | |
3506 #define OBARRAY_SIZE 16411 | |
3507 | |
3508 #ifndef Qzero | |
3509 Lisp_Object Qzero; | |
3510 #endif | |
3511 #ifndef Qnull_pointer | |
3512 Lisp_Object Qnull_pointer; | |
3513 #endif | |
3514 | |
3263 | 3515 #ifndef NEW_GC |
428 | 3516 /* some losing systems can't have static vars at function scope... */ |
442 | 3517 static const struct symbol_value_magic guts_of_unbound_marker = |
3518 { /* struct symbol_value_magic */ | |
3024 | 3519 { /* struct old_lcrecord_header */ |
442 | 3520 { /* struct lrecord_header */ |
3521 lrecord_type_symbol_value_forward, /* lrecord_type_index */ | |
3522 1, /* mark bit */ | |
3523 1, /* c_readonly bit */ | |
3524 1, /* lisp_readonly bit */ | |
3525 }, | |
3526 0, /* next */ | |
3527 }, | |
3528 0, /* value */ | |
3529 SYMVAL_UNBOUND_MARKER | |
3530 }; | |
3263 | 3531 #endif /* not NEW_GC */ |
428 | 3532 |
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3533 static void |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3534 reinit_symbol_objects_early (void) |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3535 { |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3536 OBJECT_HAS_METHOD (symbol, getprop); |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3537 OBJECT_HAS_METHOD (symbol, putprop); |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3538 OBJECT_HAS_METHOD (symbol, remprop); |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3539 OBJECT_HAS_NAMED_METHOD (symbol, plist, Fsymbol_plist); |
5255
b5611afbcc76
Support process plists, for greater GNU compatibility.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5222
diff
changeset
|
3540 OBJECT_HAS_NAMED_METHOD (symbol, setplist, Fsetplist); |
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3541 } |
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3542 |
428 | 3543 void |
3544 init_symbols_once_early (void) | |
3545 { | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
3546 INIT_LISP_OBJECT (symbol); |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
3547 INIT_LISP_OBJECT (symbol_value_forward); |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
3548 INIT_LISP_OBJECT (symbol_value_buffer_local); |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
3549 INIT_LISP_OBJECT (symbol_value_lisp_magic); |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3024
diff
changeset
|
3550 INIT_LISP_OBJECT (symbol_value_varalias); |
442 | 3551 |
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3552 reinit_symbol_objects_early (); |
428 | 3553 |
3554 /* Bootstrapping problem: Qnil isn't set when make_string_nocopy is | |
3555 called the first time. */ | |
867 | 3556 Qnil = Fmake_symbol (make_string_nocopy ((const Ibyte *) "nil", 3)); |
793 | 3557 XSTRING_PLIST (XSYMBOL (Qnil)->name) = Qnil; |
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3558 XSYMBOL (Qnil)->value = Qnil; /* Nihil ex nihilo */ |
428 | 3559 XSYMBOL (Qnil)->plist = Qnil; |
3560 | |
3561 Vobarray = make_vector (OBARRAY_SIZE, Qzero); | |
3562 initial_obarray = Vobarray; | |
3563 staticpro (&initial_obarray); | |
3564 /* Intern nil in the obarray */ | |
3565 { | |
793 | 3566 unsigned int hash = hash_string (XSTRING_DATA (XSYMBOL (Qnil)->name), 3); |
428 | 3567 XVECTOR_DATA (Vobarray)[hash % OBARRAY_SIZE] = Qnil; |
3568 } | |
3569 | |
3570 { | |
3571 /* Required to get around a GCC syntax error on certain | |
3572 architectures */ | |
3263 | 3573 #ifdef NEW_GC |
2720 | 3574 struct symbol_value_magic *tem = (struct symbol_value_magic *) |
3575 mc_alloc (sizeof (struct symbol_value_magic)); | |
3576 MARK_LRECORD_AS_LISP_READONLY (tem); | |
3577 MARK_LRECORD_AS_NOT_FREE (tem); | |
3578 tem->header.type = lrecord_type_symbol_value_forward; | |
3579 mcpro (wrap_pointer_1 (tem)); | |
3580 tem->value = 0; | |
3581 tem->type = SYMVAL_UNBOUND_MARKER; | |
2994 | 3582 #ifdef ALLOC_TYPE_STATS |
2775 | 3583 inc_lrecord_stats (sizeof (struct symbol_value_magic), |
3584 (const struct lrecord_header *) tem); | |
2994 | 3585 #endif /* ALLOC_TYPE_STATS */ |
3263 | 3586 #else /* not NEW_GC */ |
442 | 3587 const struct symbol_value_magic *tem = &guts_of_unbound_marker; |
3263 | 3588 #endif /* not NEW_GC */ |
428 | 3589 |
793 | 3590 Qunbound = wrap_symbol_value_magic (tem); |
428 | 3591 } |
3592 | |
3593 XSYMBOL (Qnil)->function = Qunbound; | |
3594 | |
563 | 3595 DEFSYMBOL (Qt); |
444 | 3596 XSYMBOL (Qt)->value = Qt; /* Veritas aeterna */ |
428 | 3597 Vquit_flag = Qnil; |
3598 | |
1204 | 3599 dump_add_root_lisp_object (&Qnil); |
3600 dump_add_root_lisp_object (&Qunbound); | |
3601 dump_add_root_lisp_object (&Vquit_flag); | |
428 | 3602 } |
3603 | |
3604 void | |
1204 | 3605 reinit_symbols_early (void) |
440 | 3606 { |
5157
1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
Ben Wing <ben@xemacs.org>
parents:
5146
diff
changeset
|
3607 reinit_symbol_objects_early (); |
440 | 3608 } |
3609 | |
442 | 3610 static void |
4979
4234fd5a7b17
fix bug #668 (compile error, not --with-debug)
Ben Wing <ben@xemacs.org>
parents:
4971
diff
changeset
|
3611 defsymbol_massage_name_1 (Lisp_Object *location, const Ascbyte *name, |
4234fd5a7b17
fix bug #668 (compile error, not --with-debug)
Ben Wing <ben@xemacs.org>
parents:
4971
diff
changeset
|
3612 int dump_p, int multiword_predicate_p) |
442 | 3613 { |
3614 char temp[500]; | |
3615 int len = strlen (name) - 1; | |
3616 int i; | |
3617 | |
3618 if (multiword_predicate_p) | |
647 | 3619 assert (len + 1 < (int) sizeof (temp)); |
442 | 3620 else |
647 | 3621 assert (len < (int) sizeof (temp)); |
442 | 3622 strcpy (temp, name + 1); /* Remove initial Q */ |
3623 if (multiword_predicate_p) | |
3624 { | |
3625 strcpy (temp + len - 1, "_p"); | |
3626 len++; | |
3627 } | |
3628 for (i = 0; i < len; i++) | |
3629 if (temp[i] == '_') | |
3630 temp[i] = '-'; | |
867 | 3631 *location = Fintern (make_string ((const Ibyte *) temp, len), Qnil); |
442 | 3632 if (dump_p) |
4971
bcdf496e49d0
put back patch to get more informative staticpro debugging
Ben Wing <ben@xemacs.org>
parents:
4969
diff
changeset
|
3633 staticpro_1 (location, name); |
442 | 3634 else |
4971
bcdf496e49d0
put back patch to get more informative staticpro debugging
Ben Wing <ben@xemacs.org>
parents:
4969
diff
changeset
|
3635 staticpro_nodump_1 (location, name); |
442 | 3636 } |
3637 | |
440 | 3638 void |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3639 defsymbol_massage_name_nodump (Lisp_Object *location, const Ascbyte *name) |
442 | 3640 { |
3641 defsymbol_massage_name_1 (location, name, 0, 0); | |
3642 } | |
3643 | |
3644 void | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3645 defsymbol_massage_name (Lisp_Object *location, const Ascbyte *name) |
428 | 3646 { |
442 | 3647 defsymbol_massage_name_1 (location, name, 1, 0); |
3648 } | |
3649 | |
3650 void | |
3651 defsymbol_massage_multiword_predicate_nodump (Lisp_Object *location, | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3652 const Ascbyte *name) |
442 | 3653 { |
3654 defsymbol_massage_name_1 (location, name, 0, 1); | |
3655 } | |
3656 | |
3657 void | |
4979
4234fd5a7b17
fix bug #668 (compile error, not --with-debug)
Ben Wing <ben@xemacs.org>
parents:
4971
diff
changeset
|
3658 defsymbol_massage_multiword_predicate (Lisp_Object *location, |
4234fd5a7b17
fix bug #668 (compile error, not --with-debug)
Ben Wing <ben@xemacs.org>
parents:
4971
diff
changeset
|
3659 const Ascbyte *name) |
442 | 3660 { |
3661 defsymbol_massage_name_1 (location, name, 1, 1); | |
3662 } | |
3663 | |
3664 void | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3665 defsymbol_nodump (Lisp_Object *location, const Ascbyte *name) |
442 | 3666 { |
867 | 3667 *location = Fintern (make_string_nocopy ((const Ibyte *) name, |
428 | 3668 strlen (name)), |
3669 Qnil); | |
4971
bcdf496e49d0
put back patch to get more informative staticpro debugging
Ben Wing <ben@xemacs.org>
parents:
4969
diff
changeset
|
3670 staticpro_nodump_1 (location, name); |
428 | 3671 } |
3672 | |
3673 void | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3674 defsymbol (Lisp_Object *location, const Ascbyte *name) |
428 | 3675 { |
867 | 3676 *location = Fintern (make_string_nocopy ((const Ibyte *) name, |
428 | 3677 strlen (name)), |
3678 Qnil); | |
4971
bcdf496e49d0
put back patch to get more informative staticpro debugging
Ben Wing <ben@xemacs.org>
parents:
4969
diff
changeset
|
3679 staticpro_1 (location, name); |
428 | 3680 } |
3681 | |
3682 void | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3683 defkeyword (Lisp_Object *location, const Ascbyte *name) |
428 | 3684 { |
3685 defsymbol (location, name); | |
3686 Fset (*location, *location); | |
3687 } | |
3688 | |
442 | 3689 void |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3690 defkeyword_massage_name (Lisp_Object *location, const Ascbyte *name) |
442 | 3691 { |
3692 char temp[500]; | |
3693 int len = strlen (name); | |
3694 | |
647 | 3695 assert (len < (int) sizeof (temp)); |
442 | 3696 strcpy (temp, name); |
3697 temp[1] = ':'; /* it's an underscore in the C variable */ | |
3698 | |
3699 defsymbol_massage_name (location, temp); | |
3700 Fset (*location, *location); | |
3701 } | |
3702 | |
428 | 3703 #ifdef DEBUG_XEMACS |
930 | 3704 /* Check that nobody spazzed writing a builtin (non-module) DEFUN. */ |
428 | 3705 static void |
3706 check_sane_subr (Lisp_Subr *subr, Lisp_Object sym) | |
3707 { | |
930 | 3708 if (!initialized) { |
3709 assert (subr->min_args >= 0); | |
3710 assert (subr->min_args <= SUBR_MAX_ARGS); | |
3711 | |
3712 if (subr->max_args != MANY && | |
3713 subr->max_args != UNEVALLED) | |
3714 { | |
3715 /* Need to fix lisp.h and eval.c if SUBR_MAX_ARGS too small */ | |
3716 assert (subr->max_args <= SUBR_MAX_ARGS); | |
3717 assert (subr->min_args <= subr->max_args); | |
3718 } | |
3719 assert (UNBOUNDP (XSYMBOL (sym)->function)); | |
3720 } | |
428 | 3721 } |
3722 #else | |
3723 #define check_sane_subr(subr, sym) /* nothing */ | |
3724 #endif | |
3725 | |
3726 #ifdef HAVE_SHLIB | |
3263 | 3727 #ifndef NEW_GC |
428 | 3728 /* |
3729 * If we are not in a pure undumped Emacs, we need to make a duplicate of | |
3730 * the subr. This is because the only time this function will be called | |
3731 * in a running Emacs is when a dynamically loaded module is adding a | |
3732 * subr, and we need to make sure that the subr is in allocated, Lisp- | |
3733 * accessible memory. The address assigned to the static subr struct | |
3734 * in the shared object will be a trampoline address, so we need to create | |
3735 * a copy here to ensure that a real address is used. | |
3736 * | |
3737 * Once we have copied everything across, we re-use the original static | |
3738 * structure to store a pointer to the newly allocated one. This will be | |
3739 * used in emodules.c by emodules_doc_subr() to find a pointer to the | |
442 | 3740 * allocated object so that we can set its doc string properly. |
428 | 3741 * |
442 | 3742 * NOTE: We don't actually use the DOC pointer here any more, but we did |
428 | 3743 * in an earlier implementation of module support. There is no harm in |
3744 * setting it here in case we ever need it in future implementations. | |
3745 * subr->doc will point to the new subr structure that was allocated. | |
442 | 3746 * Code can then get this value from the static subr structure and use |
428 | 3747 * it if required. |
3748 * | |
442 | 3749 * FIXME: Should newsubr be staticpro()'ed? I don't think so but I need |
428 | 3750 * a guru to check. |
3751 */ | |
930 | 3752 #define check_module_subr(subr) \ |
3753 do { \ | |
3754 if (initialized) { \ | |
3755 Lisp_Subr *newsubr; \ | |
3756 Lisp_Object f; \ | |
3757 \ | |
3758 if (subr->min_args < 0) \ | |
3759 signal_ferror (Qdll_error, "%s min_args (%hd) too small", \ | |
3760 subr_name (subr), subr->min_args); \ | |
3761 if (subr->min_args > SUBR_MAX_ARGS) \ | |
3762 signal_ferror (Qdll_error, "%s min_args (%hd) too big (max = %d)", \ | |
3763 subr_name (subr), subr->min_args, SUBR_MAX_ARGS); \ | |
3764 \ | |
3765 if (subr->max_args != MANY && \ | |
3766 subr->max_args != UNEVALLED) \ | |
3767 { \ | |
3768 /* Need to fix lisp.h and eval.c if SUBR_MAX_ARGS too small */ \ | |
3769 if (subr->max_args > SUBR_MAX_ARGS) \ | |
3770 signal_ferror (Qdll_error, "%s max_args (%hd) too big (max = %d)", \ | |
3771 subr_name (subr), subr->max_args, SUBR_MAX_ARGS); \ | |
3772 if (subr->min_args > subr->max_args) \ | |
3773 signal_ferror (Qdll_error, "%s min_args (%hd) > max_args (%hd)", \ | |
3774 subr_name (subr), subr->min_args, subr->max_args); \ | |
3775 } \ | |
3776 \ | |
3777 f = XSYMBOL (sym)->function; \ | |
3778 if (!UNBOUNDP (f) && (!CONSP (f) || !EQ (XCAR (f), Qautoload))) \ | |
3779 signal_ferror (Qdll_error, "Attempt to redefine %s", subr_name (subr)); \ | |
3780 \ | |
2367 | 3781 newsubr = xnew (Lisp_Subr); \ |
930 | 3782 memcpy (newsubr, subr, sizeof (Lisp_Subr)); \ |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3783 subr->doc = (const CIbyte *)newsubr; \ |
930 | 3784 subr = newsubr; \ |
3785 } \ | |
428 | 3786 } while (0) |
3263 | 3787 #else /* NEW_GC */ |
2963 | 3788 /* |
3789 * If we have the new allocator enabled, we do not need to make a | |
3790 * duplicate of the subr. The new allocator already does allocate all | |
3791 * subrs in Lisp-accessible memory rather than have it in the static | |
3792 * subr struct. | |
3793 * | |
3794 * NOTE: The DOC pointer is not set here as described above. | |
3795 */ | |
3796 #define check_module_subr(subr) \ | |
3797 do { \ | |
3798 if (initialized) { \ | |
3799 Lisp_Object f; \ | |
3800 \ | |
3801 if (subr->min_args < 0) \ | |
3802 signal_ferror (Qdll_error, "%s min_args (%hd) too small", \ | |
3803 subr_name (subr), subr->min_args); \ | |
3804 if (subr->min_args > SUBR_MAX_ARGS) \ | |
3805 signal_ferror (Qdll_error, "%s min_args (%hd) too big (max = %d)", \ | |
3806 subr_name (subr), subr->min_args, SUBR_MAX_ARGS); \ | |
3807 \ | |
3808 if (subr->max_args != MANY && \ | |
3809 subr->max_args != UNEVALLED) \ | |
3810 { \ | |
3811 /* Need to fix lisp.h and eval.c if SUBR_MAX_ARGS too small */ \ | |
3812 if (subr->max_args > SUBR_MAX_ARGS) \ | |
3813 signal_ferror (Qdll_error, "%s max_args (%hd) too big (max = %d)", \ | |
3814 subr_name (subr), subr->max_args, SUBR_MAX_ARGS); \ | |
3815 if (subr->min_args > subr->max_args) \ | |
3816 signal_ferror (Qdll_error, "%s min_args (%hd) > max_args (%hd)", \ | |
3817 subr_name (subr), subr->min_args, subr->max_args); \ | |
3818 } \ | |
3819 \ | |
3820 f = XSYMBOL (sym)->function; \ | |
3821 if (!UNBOUNDP (f) && (!CONSP (f) || !EQ (XCAR (f), Qautoload))) \ | |
3822 signal_ferror (Qdll_error, "Attempt to redefine %s", subr_name (subr)); \ | |
3823 } \ | |
3824 } while (0) | |
3263 | 3825 #endif /* NEW_GC */ |
428 | 3826 #else /* ! HAVE_SHLIB */ |
930 | 3827 #define check_module_subr(subr) |
428 | 3828 #endif |
3829 | |
3830 void | |
3831 defsubr (Lisp_Subr *subr) | |
3832 { | |
3833 Lisp_Object sym = intern (subr_name (subr)); | |
3834 Lisp_Object fun; | |
3835 | |
3836 check_sane_subr (subr, sym); | |
930 | 3837 check_module_subr (subr); |
428 | 3838 |
793 | 3839 fun = wrap_subr (subr); |
428 | 3840 XSYMBOL (sym)->function = fun; |
996 | 3841 |
3842 #ifdef HAVE_SHLIB | |
3843 /* If it is declared in a module, update the load history */ | |
3844 if (initialized) | |
3845 LOADHIST_ATTACH (sym); | |
3846 #endif | |
428 | 3847 } |
3848 | |
3849 /* Define a lisp macro using a Lisp_Subr. */ | |
3850 void | |
3851 defsubr_macro (Lisp_Subr *subr) | |
3852 { | |
3853 Lisp_Object sym = intern (subr_name (subr)); | |
3854 Lisp_Object fun; | |
3855 | |
3856 check_sane_subr (subr, sym); | |
930 | 3857 check_module_subr (subr); |
428 | 3858 |
793 | 3859 fun = wrap_subr (subr); |
428 | 3860 XSYMBOL (sym)->function = Fcons (Qmacro, fun); |
996 | 3861 |
3862 #ifdef HAVE_SHLIB | |
3863 /* If it is declared in a module, update the load history */ | |
3864 if (initialized) | |
3865 LOADHIST_ATTACH (sym); | |
3866 #endif | |
428 | 3867 } |
3868 | |
442 | 3869 static void |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3870 deferror_1 (Lisp_Object *symbol, const Ascbyte *name, const Ascbyte *messuhhj, |
442 | 3871 Lisp_Object inherits_from, int massage_p) |
428 | 3872 { |
3873 Lisp_Object conds; | |
442 | 3874 if (massage_p) |
3875 defsymbol_massage_name (symbol, name); | |
3876 else | |
3877 defsymbol (symbol, name); | |
428 | 3878 |
3879 assert (SYMBOLP (inherits_from)); | |
3880 conds = Fget (inherits_from, Qerror_conditions, Qnil); | |
3881 Fput (*symbol, Qerror_conditions, Fcons (*symbol, conds)); | |
771 | 3882 /* NOT build_msg_string (). This function is called at load time |
428 | 3883 and the string needs to get translated at run time. (This happens |
3884 in the function (display-error) in cmdloop.el.) */ | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3885 Fput (*symbol, Qerror_message, build_defer_string (messuhhj)); |
428 | 3886 } |
3887 | |
3888 void | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3889 deferror (Lisp_Object *symbol, const Ascbyte *name, const Ascbyte *messuhhj, |
442 | 3890 Lisp_Object inherits_from) |
3891 { | |
3892 deferror_1 (symbol, name, messuhhj, inherits_from, 0); | |
3893 } | |
3894 | |
3895 void | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3896 deferror_massage_name (Lisp_Object *symbol, const Ascbyte *name, |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3897 const Ascbyte *messuhhj, Lisp_Object inherits_from) |
442 | 3898 { |
3899 deferror_1 (symbol, name, messuhhj, inherits_from, 1); | |
3900 } | |
3901 | |
3902 void | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
3903 deferror_massage_name_and_message (Lisp_Object *symbol, const Ascbyte *name, |
442 | 3904 Lisp_Object inherits_from) |
3905 { | |
3906 char temp[500]; | |
3907 int i; | |
3908 int len = strlen (name) - 1; | |
3909 | |
647 | 3910 assert (len < (int) sizeof (temp)); |
442 | 3911 strcpy (temp, name + 1); /* Remove initial Q */ |
3912 temp[0] = toupper (temp[0]); | |
3913 for (i = 0; i < len; i++) | |
3914 if (temp[i] == '_') | |
3915 temp[i] = ' '; | |
3916 | |
3917 deferror_1 (symbol, name, temp, inherits_from, 1); | |
3918 } | |
3919 | |
3920 void | |
428 | 3921 syms_of_symbols (void) |
3922 { | |
442 | 3923 DEFSYMBOL (Qvariable_documentation); |
3924 DEFSYMBOL (Qvariable_domain); /* I18N3 */ | |
3925 DEFSYMBOL (Qad_advice_info); | |
3926 DEFSYMBOL (Qad_activate); | |
3927 | |
3928 DEFSYMBOL (Qget_value); | |
3929 DEFSYMBOL (Qset_value); | |
3930 DEFSYMBOL (Qbound_predicate); | |
3931 DEFSYMBOL (Qmake_unbound); | |
3932 DEFSYMBOL (Qlocal_predicate); | |
3933 DEFSYMBOL (Qmake_local); | |
3934 | |
3935 DEFSYMBOL (Qboundp); | |
3936 DEFSYMBOL (Qglobally_boundp); | |
3937 DEFSYMBOL (Qmakunbound); | |
3938 DEFSYMBOL (Qsymbol_value); | |
3939 DEFSYMBOL (Qset); | |
3940 DEFSYMBOL (Qsetq_default); | |
3941 DEFSYMBOL (Qdefault_boundp); | |
3942 DEFSYMBOL (Qdefault_value); | |
3943 DEFSYMBOL (Qset_default); | |
3944 DEFSYMBOL (Qmake_variable_buffer_local); | |
3945 DEFSYMBOL (Qmake_local_variable); | |
3946 DEFSYMBOL (Qkill_local_variable); | |
3947 DEFSYMBOL (Qkill_console_local_variable); | |
3948 DEFSYMBOL (Qsymbol_value_in_buffer); | |
3949 DEFSYMBOL (Qsymbol_value_in_console); | |
3950 DEFSYMBOL (Qlocal_variable_p); | |
3951 DEFSYMBOL (Qconst_integer); | |
3952 DEFSYMBOL (Qconst_boolean); | |
3953 DEFSYMBOL (Qconst_object); | |
3954 DEFSYMBOL (Qconst_specifier); | |
3955 DEFSYMBOL (Qdefault_buffer); | |
3956 DEFSYMBOL (Qcurrent_buffer); | |
3957 DEFSYMBOL (Qconst_current_buffer); | |
3958 DEFSYMBOL (Qdefault_console); | |
3959 DEFSYMBOL (Qselected_console); | |
3960 DEFSYMBOL (Qconst_selected_console); | |
428 | 3961 |
3962 DEFSUBR (Fintern); | |
3963 DEFSUBR (Fintern_soft); | |
3964 DEFSUBR (Funintern); | |
3965 DEFSUBR (Fmapatoms); | |
3966 DEFSUBR (Fapropos_internal); | |
3967 | |
3968 DEFSUBR (Fsymbol_function); | |
3969 DEFSUBR (Fsymbol_plist); | |
3970 DEFSUBR (Fsymbol_name); | |
3971 DEFSUBR (Fmakunbound); | |
3972 DEFSUBR (Ffmakunbound); | |
3973 DEFSUBR (Fboundp); | |
3974 DEFSUBR (Fglobally_boundp); | |
3975 DEFSUBR (Ffboundp); | |
3976 DEFSUBR (Ffset); | |
3977 DEFSUBR (Fdefine_function); | |
3978 Ffset (intern ("defalias"), intern ("define-function")); | |
3368 | 3979 DEFSUBR (Fsubr_name); |
4905
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4793
diff
changeset
|
3980 DEFSUBR (Fspecial_operator_p); |
428 | 3981 DEFSUBR (Fsetplist); |
3982 DEFSUBR (Fsymbol_value_in_buffer); | |
3983 DEFSUBR (Fsymbol_value_in_console); | |
3984 DEFSUBR (Fbuilt_in_variable_type); | |
3985 DEFSUBR (Fsymbol_value); | |
3986 DEFSUBR (Fset); | |
3987 DEFSUBR (Fdefault_boundp); | |
3988 DEFSUBR (Fdefault_value); | |
3989 DEFSUBR (Fset_default); | |
3990 DEFSUBR (Fsetq_default); | |
3991 DEFSUBR (Fmake_variable_buffer_local); | |
3992 DEFSUBR (Fmake_local_variable); | |
3993 DEFSUBR (Fkill_local_variable); | |
3994 DEFSUBR (Fkill_console_local_variable); | |
3995 DEFSUBR (Flocal_variable_p); | |
4502
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3996 DEFSUBR (Fcustom_variable_p); |
8748a3f7ceb4
Handle varalias chains, custom variables in #'user-variable-p.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3997 DEFSUBR (Fuser_variable_p); |
428 | 3998 DEFSUBR (Fdefvaralias); |
3999 DEFSUBR (Fvariable_alias); | |
4000 DEFSUBR (Findirect_variable); | |
1674 | 4001 DEFSUBR (Fvariable_binding_locus); |
428 | 4002 DEFSUBR (Fdontusethis_set_symbol_value_handler); |
4003 } | |
4004 | |
4005 /* Create and initialize a Lisp variable whose value is forwarded to C data */ | |
4006 void | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
4007 defvar_magic (const Ascbyte *symbol_name, |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
4008 const struct symbol_value_forward *magic) |
428 | 4009 { |
442 | 4010 Lisp_Object sym; |
428 | 4011 |
996 | 4012 #ifdef HAVE_SHLIB |
428 | 4013 /* |
4014 * As with defsubr(), this will only be called in a dumped Emacs when | |
4015 * we are adding variables from a dynamically loaded module. That means | |
4016 * we can't use purespace. Take that into account. | |
4017 */ | |
4018 if (initialized) | |
996 | 4019 { |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4940
diff
changeset
|
4020 sym = Fintern (build_ascstring (symbol_name), Qnil); |
996 | 4021 LOADHIST_ATTACH (sym); |
4022 } | |
428 | 4023 else |
4024 #endif | |
867 | 4025 sym = Fintern (make_string_nocopy ((const Ibyte *) symbol_name, |
428 | 4026 strlen (symbol_name)), Qnil); |
4027 | |
793 | 4028 XSYMBOL (sym)->value = wrap_pointer_1 (magic); |
428 | 4029 } |
4030 | |
4031 void | |
4032 vars_of_symbols (void) | |
4033 { | |
4034 DEFVAR_LISP ("obarray", &Vobarray /* | |
4035 Symbol table for use by `intern' and `read'. | |
4036 It is a vector whose length ought to be prime for best results. | |
4037 The vector's contents don't make sense if examined from Lisp programs; | |
4038 to find all the symbols in an obarray, use `mapatoms'. | |
4039 */ ); | |
4040 /* obarray has been initialized long before */ | |
4041 } |