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