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