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