|
0
|
1 /* Definitions of symbol-value forwarding for XEmacs Lisp interpreter.
|
|
|
2 Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc.
|
|
|
3
|
|
|
4 This file is part of XEmacs.
|
|
|
5
|
|
|
6 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
7 under the terms of the GNU General Public License as published by the
|
|
|
8 Free Software Foundation; either version 2, or (at your option) any
|
|
|
9 later version.
|
|
|
10
|
|
|
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
14 for more details.
|
|
|
15
|
|
|
16 You should have received a copy of the GNU General Public License
|
|
|
17 along with XEmacs; see the file COPYING. If not, write to
|
|
|
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
19 Boston, MA 02111-1307, USA. */
|
|
|
20
|
|
|
21 /* Synched up with: Not in FSF. */
|
|
|
22
|
|
|
23 /* Fsymbol_value checks whether XSYMBOL (sym)->value is one of these,
|
|
|
24 * and does weird magic stuff if so */
|
|
|
25
|
|
398
|
26 #ifndef INCLUDED_symeval_h_
|
|
|
27 #define INCLUDED_symeval_h_
|
|
0
|
28
|
|
185
|
29 enum symbol_value_type
|
|
|
30 {
|
|
|
31 /* The following tags use the 'symbol_value_forward' structure
|
|
|
32 and are strictly for variables DEFVARed on the C level. */
|
|
|
33 SYMVAL_FIXNUM_FORWARD, /* Forward C "int" */
|
|
|
34 SYMVAL_CONST_FIXNUM_FORWARD, /* Same, but can't be set */
|
|
|
35 SYMVAL_BOOLEAN_FORWARD, /* Forward C boolean ("int") */
|
|
|
36 SYMVAL_CONST_BOOLEAN_FORWARD, /* Same, but can't be set */
|
|
|
37 SYMVAL_OBJECT_FORWARD, /* Forward C Lisp_Object */
|
|
|
38 SYMVAL_CONST_OBJECT_FORWARD, /* Same, but can't be set */
|
|
|
39 SYMVAL_CONST_SPECIFIER_FORWARD, /* Same, can't be set, but gives a
|
|
|
40 different message when attempting to
|
|
|
41 set that says "use set-specifier" */
|
|
|
42 SYMVAL_DEFAULT_BUFFER_FORWARD, /* Forward Lisp_Object into Vbuffer_defaults */
|
|
|
43 SYMVAL_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into current_buffer */
|
|
|
44 SYMVAL_CONST_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into
|
|
|
45 current_buffer, can't be set */
|
|
|
46 SYMVAL_DEFAULT_CONSOLE_FORWARD, /* Forward Lisp_Object into
|
|
|
47 Vconsole_defaults */
|
|
|
48 SYMVAL_SELECTED_CONSOLE_FORWARD, /* Forward Lisp_Object into
|
|
|
49 Vselected_console */
|
|
|
50 SYMVAL_CONST_SELECTED_CONSOLE_FORWARD, /* Forward Lisp_Object into
|
|
|
51 Vselected_console,
|
|
|
52 can't be set */
|
|
|
53 SYMVAL_UNBOUND_MARKER, /* Only Qunbound actually has this tag */
|
|
|
54
|
|
|
55 /* The following tags use the 'symbol_value_buffer_local' structure */
|
|
|
56 SYMVAL_BUFFER_LOCAL, /* make-variable-buffer-local */
|
|
|
57 SYMVAL_SOME_BUFFER_LOCAL, /* make-local-variable */
|
|
|
58
|
|
|
59 /* The following tag uses the 'symbol_value_lisp_magic' structure */
|
|
|
60 SYMVAL_LISP_MAGIC, /* Forward to lisp callbacks */
|
|
|
61
|
|
|
62 /* The following tag uses the 'symbol_value_varalias' structure */
|
|
|
63 SYMVAL_VARALIAS /* defvaralias */
|
|
|
64
|
|
|
65 #if 0
|
|
|
66 /* NYI */
|
|
|
67 SYMVAL_CONSTANT_SYMBOL, /* Self-evaluating symbol */
|
|
|
68 /* NYI */
|
|
|
69 #endif
|
|
|
70 };
|
|
|
71
|
|
0
|
72 struct symbol_value_magic
|
|
|
73 {
|
|
|
74 struct lcrecord_header lcheader;
|
|
398
|
75 void *value;
|
|
185
|
76 enum symbol_value_type type;
|
|
0
|
77 };
|
|
|
78 #define SYMBOL_VALUE_MAGIC_P(x) \
|
|
|
79 (LRECORDP (x) \
|
|
211
|
80 && (XRECORD_LHEADER_IMPLEMENTATION (x)->printer \
|
|
0
|
81 == print_symbol_value_magic))
|
|
|
82 #define XSYMBOL_VALUE_MAGIC_TYPE(v) \
|
|
|
83 (((struct symbol_value_magic *) XPNTR (v))->type)
|
|
185
|
84 #define XSETSYMBOL_VALUE_MAGIC(s, p) XSETOBJ (s, Lisp_Type_Record, p)
|
|
272
|
85 void print_symbol_value_magic (Lisp_Object, Lisp_Object, int);
|
|
0
|
86
|
|
|
87 /********** The various different symbol-value-magic types ***********/
|
|
|
88
|
|
|
89 /* 1. symbol-value-forward */
|
|
|
90
|
|
|
91 /* This type of symbol-value-magic is used for variables declared
|
|
|
92 DEFVAR_LISP, DEFVAR_INT, DEFVAR_BOOL, DEFVAR_BUFFER_LOCAL,
|
|
|
93 DEFVAR_BUFFER_DEFAULTS, DEFVAR_SPECIFIER, and for Qunbound.
|
|
|
94
|
|
|
95 Note that some of these types of variables can be made buffer-local.
|
|
|
96 Then, the symbol's value field contains a symbol-value-buffer-local,
|
|
|
97 whose CURRENT-VALUE field then contains a symbol-value-forward.
|
|
|
98 */
|
|
185
|
99
|
|
0
|
100 struct symbol_value_forward
|
|
|
101 {
|
|
|
102 struct symbol_value_magic magic;
|
|
380
|
103
|
|
|
104 /* `magicfun' is a function controlling the magic behavior of this
|
|
|
105 forward variable.
|
|
0
|
106
|
|
|
107 SYM is the symbol being operated on (read, set, etc.);
|
|
|
108
|
|
|
109 VAL is either the value to set or the value to be returned.
|
|
|
110
|
|
|
111 IN_OBJECT is the buffer or console that the value is read in
|
|
|
112 or set in. A value of Qnil means that the current buffer
|
|
|
113 and possibly other buffers are being set. (This value will
|
|
|
114 never be passed for built-in buffer-local or console-local
|
|
|
115 variables such as `truncate-lines'.) (Currently, a value of
|
|
|
116 Qnil is always passed for DEFVAR_INT, DEFVAR_LISP, and
|
|
|
117 DEFVAR_BOOL variables; the code isn't smart enough to figure
|
|
|
118 out what buffers besides the current buffer are being
|
|
|
119 affected. Because the magic function is called
|
|
|
120 before the value is changed, it's not that easy
|
|
|
121 to determine which buffers are getting changed.
|
|
|
122 #### If this information is important, let me know
|
|
|
123 and I will look into providing it.) (Remember also
|
|
|
124 that the only console-local variables currently existing
|
|
|
125 are built-in ones, because others can't be created.)
|
|
|
126
|
|
380
|
127 FLAGS gives more information about the operation being performed.
|
|
0
|
128
|
|
380
|
129 The return value indicates what the magic function actually did.
|
|
0
|
130
|
|
|
131 Currently FLAGS and the return value are not used. This
|
|
|
132 function is only called when the value of a forward variable
|
|
|
133 is about to be changed. Note that this can occur explicitly
|
|
|
134 through a call to `set', `setq', `set-default', or `setq-default',
|
|
380
|
135 or implicitly by the current buffer being changed. */
|
|
0
|
136 int (*magicfun) (Lisp_Object sym, Lisp_Object *val, Lisp_Object in_object,
|
|
|
137 int flags);
|
|
|
138 };
|
|
272
|
139 DECLARE_LRECORD (symbol_value_forward, struct symbol_value_forward);
|
|
|
140 #define XSYMBOL_VALUE_FORWARD(x) \
|
|
|
141 XRECORD (x, symbol_value_forward, struct symbol_value_forward)
|
|
398
|
142 #define symbol_value_forward_forward(m) ((void *)((m)->magic.value))
|
|
0
|
143 #define symbol_value_forward_magicfun(m) ((m)->magicfun)
|
|
|
144
|
|
|
145 /* 2. symbol-value-buffer-local */
|
|
|
146
|
|
|
147 struct symbol_value_buffer_local
|
|
|
148 {
|
|
|
149 struct symbol_value_magic magic;
|
|
|
150 /* Used in a symbol value cell when the symbol's value is per-buffer.
|
|
|
151
|
|
|
152 The type of the symbol-value-magic will be either
|
|
|
153 SYMVAL_BUFFER_LOCAL (i.e. `make-variable-buffer-local' was called)
|
|
|
154 or SYMVAL_SOME_BUFFER_LOCAL (i.e. `make-local-variable' was called).
|
|
|
155 The only difference between the two is that when setting the
|
|
|
156 former kind of variable, an implicit `make-local-variable' is
|
|
|
157 called.
|
|
|
158
|
|
|
159 A buffer-local variable logically has
|
|
|
160
|
|
|
161 -- a default value
|
|
|
162 -- local values in some buffers
|
|
|
163
|
|
|
164 The primary place where the local values are stored is in each
|
|
|
165 buffer's local_var_alist slot.
|
|
|
166
|
|
|
167 In the simplest implementation, all that this structure needs to
|
|
|
168 keep track of is the default value; to retrieve the value in
|
|
|
169 a buffer, look in that buffer's local_var_alist, and use the
|
|
|
170 default value if there is no local value. To implement
|
|
|
171 `make-local-variable' in a buffer, look in the buffer's
|
|
|
172 local_var_alist, and if no element exists for this symbol,
|
|
|
173 add one, copying the value from the default value. When setting
|
|
|
174 the value in a buffer, look in the buffer's local_var_alist, and set
|
|
|
175 the value in that list if an element exists for this symbol;
|
|
|
176 otherwise, set the default. (Remember that SYMVAL_BUFFER_LOCAL
|
|
|
177 variables implicitly call `make-local-variable' first, so when
|
|
|
178 setting a value, there will always be an entry in the buffer's
|
|
|
179 local_var_alist to set.)
|
|
|
180
|
|
272
|
181 However, this operation is potentially slow. To speed it up,
|
|
0
|
182 we cache the value in one buffer in this structure.
|
|
|
183
|
|
|
184 NOTE: This is *not* a write-through cache. I.e. when setting
|
|
|
185 the value in the buffer that is cached, we *only* change the
|
|
|
186 cache and don't write the value through to either the buffer's
|
|
|
187 local_var_alist or the default value. Therefore, when retrieving
|
|
|
188 a value in a buffer, you must *always* look in the cache to see if
|
|
|
189 it refers to that buffer.
|
|
|
190
|
|
|
191 The cache consists of
|
|
|
192
|
|
|
193 -- a buffer, or nil if the cache has not been set up
|
|
|
194 -- the value in that buffer
|
|
|
195 -- the element (a cons) from the buffer's local_var_alist, or
|
|
|
196 nil if there is no local value in the buffer
|
|
|
197
|
|
|
198 These slots are called CURRENT-BUFFER, CURRENT-VALUE, and
|
|
|
199 CURRENT-ALIST-ELEMENT, respectively.
|
|
185
|
200
|
|
0
|
201 If we want to examine or set the value in BUFFER and CURRENT-BUFFER
|
|
|
202 equals BUFFER, we just examine or set CURRENT-VALUE. Otherwise,
|
|
|
203 we store CURRENT-VALUE value into CURRENT-ALIST-ELEMENT (or maybe
|
|
|
204 into DEFAULT-VALUE), then find the appropriate alist element for
|
|
|
205 BUFFER and set up CURRENT-ALIST-ELEMENT. Then we set CURRENT-VALUE
|
|
|
206 out of that element (or maybe out of DEFAULT-VALUE), and store
|
|
|
207 BUFFER into CURRENT-BUFFER.
|
|
185
|
208
|
|
0
|
209 If we are setting the variable and the current buffer does not have
|
|
|
210 an alist entry for this variable, an alist entry is created.
|
|
185
|
211
|
|
0
|
212 Note that CURRENT-BUFFER's local_var_alist value for this variable
|
|
|
213 might be out-of-date (the correct value is stored in CURRENT-VALUE).
|
|
|
214 Similarly, if CURRENT-BUFFER sees the default value, then
|
|
|
215 DEFAULT-VALUE might be out-of-date.
|
|
185
|
216
|
|
0
|
217 Note that CURRENT-VALUE (but not DEFAULT-VALUE) can be a
|
|
185
|
218 forwarding pointer. Each time it is examined or set,
|
|
0
|
219 forwarding must be done.
|
|
|
220 */
|
|
|
221 Lisp_Object default_value;
|
|
|
222 Lisp_Object current_value;
|
|
|
223 Lisp_Object current_buffer;
|
|
|
224 Lisp_Object current_alist_element;
|
|
|
225 };
|
|
272
|
226 DECLARE_LRECORD (symbol_value_buffer_local, struct symbol_value_buffer_local);
|
|
|
227 #define XSYMBOL_VALUE_BUFFER_LOCAL(x) \
|
|
|
228 XRECORD (x, symbol_value_buffer_local, struct symbol_value_buffer_local)
|
|
|
229 #define SYMBOL_VALUE_BUFFER_LOCAL_P(x) RECORDP (x, symbol_value_buffer_local)
|
|
0
|
230
|
|
|
231 /* 3. symbol-value-lisp-magic */
|
|
|
232
|
|
|
233 enum lisp_magic_handler
|
|
|
234 {
|
|
|
235 MAGIC_HANDLER_GET_VALUE,
|
|
|
236 MAGIC_HANDLER_SET_VALUE,
|
|
|
237 MAGIC_HANDLER_BOUND_PREDICATE,
|
|
|
238 MAGIC_HANDLER_MAKE_UNBOUND,
|
|
|
239 MAGIC_HANDLER_LOCAL_PREDICATE,
|
|
|
240 MAGIC_HANDLER_MAKE_LOCAL,
|
|
|
241 MAGIC_HANDLER_MAX
|
|
|
242 };
|
|
|
243
|
|
|
244 struct symbol_value_lisp_magic
|
|
|
245 {
|
|
|
246 struct symbol_value_magic magic;
|
|
|
247 Lisp_Object handler[MAGIC_HANDLER_MAX];
|
|
|
248 Lisp_Object harg[MAGIC_HANDLER_MAX];
|
|
|
249 Lisp_Object shadowed;
|
|
|
250 };
|
|
272
|
251 DECLARE_LRECORD (symbol_value_lisp_magic, struct symbol_value_lisp_magic);
|
|
|
252 #define XSYMBOL_VALUE_LISP_MAGIC(x) \
|
|
|
253 XRECORD (x, symbol_value_lisp_magic, struct symbol_value_lisp_magic)
|
|
|
254 #define SYMBOL_VALUE_LISP_MAGIC_P(x) RECORDP (x, symbol_value_lisp_magic)
|
|
0
|
255
|
|
|
256 /* 4. symbol-value-varalias */
|
|
|
257
|
|
|
258 struct symbol_value_varalias
|
|
|
259 {
|
|
|
260 struct symbol_value_magic magic;
|
|
|
261 Lisp_Object aliasee;
|
|
|
262 Lisp_Object shadowed;
|
|
|
263 };
|
|
272
|
264 DECLARE_LRECORD (symbol_value_varalias, struct symbol_value_varalias);
|
|
|
265 #define XSYMBOL_VALUE_VARALIAS(x) \
|
|
|
266 XRECORD (x, symbol_value_varalias, struct symbol_value_varalias)
|
|
|
267 #define SYMBOL_VALUE_VARALIAS_P(x) RECORDP (x, symbol_value_varalias)
|
|
0
|
268 #define symbol_value_varalias_aliasee(m) ((m)->aliasee)
|
|
|
269 #define symbol_value_varalias_shadowed(m) ((m)->shadowed)
|
|
|
270
|
|
380
|
271 /* To define a Lisp primitive function using a C function `Fname', do this:
|
|
|
272 DEFUN ("name, Fname, ...); // at top level in foo.c
|
|
|
273 DEFSUBR (Fname); // in syms_of_foo();
|
|
|
274 */
|
|
|
275 void defsubr (Lisp_Subr *);
|
|
16
|
276 #define DEFSUBR(Fname) defsubr (&S##Fname)
|
|
380
|
277
|
|
|
278 /* To define a Lisp primitive macro using a C function `Fname', do this:
|
|
|
279 DEFUN ("name, Fname, ...); // at top level in foo.c
|
|
|
280 DEFSUBR_MACRO (Fname); // in syms_of_foo();
|
|
|
281 */
|
|
|
282 void defsubr_macro (Lisp_Subr *);
|
|
|
283 #define DEFSUBR_MACRO(Fname) defsubr_macro (&S##Fname)
|
|
0
|
284
|
|
398
|
285 void defsymbol (Lisp_Object *location, const char *name);
|
|
|
286 void defsymbol_nodump (Lisp_Object *location, const char *name);
|
|
0
|
287
|
|
398
|
288 void defkeyword (Lisp_Object *location, const char *name);
|
|
0
|
289
|
|
398
|
290 void deferror (Lisp_Object *symbol, const char *name,
|
|
|
291 const char *message, Lisp_Object inherits_from);
|
|
0
|
292
|
|
|
293 /* Macros we use to define forwarded Lisp variables.
|
|
|
294 These are used in the syms_of_FILENAME functions. */
|
|
|
295
|
|
398
|
296 void defvar_magic (const char *symbol_name, const struct symbol_value_forward *magic);
|
|
211
|
297
|
|
380
|
298 #define DEFVAR_SYMVAL_FWD(lname, c_location, forward_type, magicfun) do { \
|
|
398
|
299 static CONST_IF_NOT_DEBUG struct symbol_value_forward I_hate_C = \
|
|
|
300 { /* struct symbol_value_forward */ \
|
|
|
301 { /* struct symbol_value_magic */ \
|
|
|
302 { /* struct lcrecord_header */ \
|
|
|
303 { /* struct lrecord_header */ \
|
|
|
304 1, /* type - index into lrecord_implementations_table */ \
|
|
|
305 0, /* mark bit */ \
|
|
|
306 0, /* c_readonly bit */ \
|
|
|
307 0 /* lisp_readonly bit */ \
|
|
|
308 }, \
|
|
|
309 0, /* next */ \
|
|
|
310 0, /* uid */ \
|
|
|
311 0 /* free */ \
|
|
|
312 }, \
|
|
|
313 c_location, \
|
|
|
314 forward_type \
|
|
|
315 }, \
|
|
|
316 magicfun \
|
|
|
317 }; \
|
|
380
|
318 defvar_magic ((lname), &I_hate_C); \
|
|
185
|
319 } while (0)
|
|
0
|
320
|
|
398
|
321 #define DEFVAR_SYMVAL_FWD_INT(lname, c_location, forward_type, magicfun) do{ \
|
|
|
322 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
|
|
|
323 dumpopaque (c_location, sizeof(int)); \
|
|
|
324 } while (0)
|
|
|
325
|
|
380
|
326 #define DEFVAR_SYMVAL_FWD_OBJECT(lname, c_location, forward_type, magicfun) do{ \
|
|
|
327 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
|
|
|
328 staticpro (c_location); \
|
|
|
329 if (EQ (*c_location, Qnull_pointer)) *c_location = Qnil; \
|
|
185
|
330 } while (0)
|
|
0
|
331
|
|
380
|
332 #define DEFVAR_LISP(lname, c_location) \
|
|
|
333 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, 0)
|
|
185
|
334 #define DEFVAR_CONST_LISP(lname, c_location) \
|
|
380
|
335 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_OBJECT_FORWARD, 0)
|
|
185
|
336 #define DEFVAR_SPECIFIER(lname, c_location) \
|
|
380
|
337 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_SPECIFIER_FORWARD, 0)
|
|
185
|
338 #define DEFVAR_INT(lname, c_location) \
|
|
398
|
339 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_FIXNUM_FORWARD, 0)
|
|
185
|
340 #define DEFVAR_CONST_INT(lname, c_location) \
|
|
398
|
341 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_CONST_FIXNUM_FORWARD, 0)
|
|
185
|
342 #define DEFVAR_BOOL(lname, c_location) \
|
|
398
|
343 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, 0)
|
|
185
|
344 #define DEFVAR_CONST_BOOL(lname, c_location) \
|
|
398
|
345 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_CONST_BOOLEAN_FORWARD, 0)
|
|
380
|
346 #define DEFVAR_LISP_MAGIC(lname, c_location, magicfun) \
|
|
398
|
347 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, magicfun)
|
|
185
|
348 #define DEFVAR_INT_MAGIC(lname, c_location, magicfun) \
|
|
398
|
349 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_FIXNUM_FORWARD, magicfun)
|
|
185
|
350 #define DEFVAR_BOOL_MAGIC(lname, c_location, magicfun) \
|
|
398
|
351 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, magicfun)
|
|
0
|
352
|
|
398
|
353 #endif /* INCLUDED_symeval_h_ */
|
