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