annotate src/symeval.h @ 2227:8e7b4a0c1a81

[xemacs-hg @ 2004-08-21 17:05:49 by michaels] 2004-08-15 Jan Rychter <jwr@xemacs.org> * window-xemacs.el (really-set-window-configuration): deal gracefully with the case when the buffer previously saved in the configuration (and that we want to switch to) has been killed. Switch to the next buffer on the buffer-list in that case.
author michaels
date Sat, 21 Aug 2004 17:05:51 +0000
parents 543769b89fed
children 6fa9919a9a0b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 /* Definitions of symbol-value forwarding for XEmacs Lisp interpreter.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc.
793
e38acbeb1cae [xemacs-hg @ 2002-03-29 04:46:17 by ben]
ben
parents: 771
diff changeset
3 Copyright (C) 2000, 2001, 2002 Ben Wing.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 This file is part of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 XEmacs is free software; you can redistribute it and/or modify it
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 later version.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 for more details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 along with XEmacs; see the file COPYING. If not, write to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 Boston, MA 02111-1307, USA. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 /* Synched up with: Not in FSF. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 /* Fsymbol_value checks whether XSYMBOL (sym)->value is one of these,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 * and does weird magic stuff if so */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
27 #ifndef INCLUDED_symeval_h_
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
28 #define INCLUDED_symeval_h_
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29
1743
543769b89fed [xemacs-hg @ 2003-10-14 05:02:57 by james]
james
parents: 1650
diff changeset
30 BEGIN_C_DECLS
1650
34abfb24e891 [xemacs-hg @ 2003-08-28 15:44:04 by james]
james
parents: 1632
diff changeset
31
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 enum symbol_value_type
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 /* The following tags use the 'symbol_value_forward' structure
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 and are strictly for variables DEFVARed on the C level. */
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
36 SYMVAL_FIXNUM_FORWARD, /* Forward C "Fixnum", really "EMACS_INT" */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 SYMVAL_CONST_FIXNUM_FORWARD, /* Same, but can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 SYMVAL_BOOLEAN_FORWARD, /* Forward C boolean ("int") */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 SYMVAL_CONST_BOOLEAN_FORWARD, /* Same, but can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 SYMVAL_OBJECT_FORWARD, /* Forward C Lisp_Object */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 SYMVAL_CONST_OBJECT_FORWARD, /* Same, but can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 SYMVAL_CONST_SPECIFIER_FORWARD, /* Same, can't be set, but gives a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 different message when attempting to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 set that says "use set-specifier" */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 SYMVAL_DEFAULT_BUFFER_FORWARD, /* Forward Lisp_Object into Vbuffer_defaults */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 SYMVAL_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into current_buffer */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 SYMVAL_CONST_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 current_buffer, can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 SYMVAL_DEFAULT_CONSOLE_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 Vconsole_defaults */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 SYMVAL_SELECTED_CONSOLE_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 Vselected_console */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 SYMVAL_CONST_SELECTED_CONSOLE_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 Vselected_console,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 SYMVAL_UNBOUND_MARKER, /* Only Qunbound actually has this tag */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 /* The following tags use the 'symbol_value_buffer_local' structure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 SYMVAL_BUFFER_LOCAL, /* make-variable-buffer-local */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 SYMVAL_SOME_BUFFER_LOCAL, /* make-local-variable */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 /* The following tag uses the 'symbol_value_lisp_magic' structure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 SYMVAL_LISP_MAGIC, /* Forward to lisp callbacks */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 /* The following tag uses the 'symbol_value_varalias' structure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 SYMVAL_VARALIAS /* defvaralias */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 #if 0
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69 /* NYI */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 SYMVAL_CONSTANT_SYMBOL, /* Self-evaluating symbol */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 /* NYI */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
75 /* Underlying C type used to implement DEFVAR_INT */
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
76 typedef EMACS_INT Fixnum;
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
77
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 struct symbol_value_magic
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 struct lcrecord_header lcheader;
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
81 void *value;
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 enum symbol_value_type type;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 };
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
84 #define SYMBOL_VALUE_MAGIC_P(x) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
85 (LRECORDP (x) && \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
86 XRECORD_LHEADER (x)->type <= lrecord_type_max_symbol_value_magic)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 #define XSYMBOL_VALUE_MAGIC_TYPE(v) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 (((struct symbol_value_magic *) XPNTR (v))->type)
793
e38acbeb1cae [xemacs-hg @ 2002-03-29 04:46:17 by ben]
ben
parents: 771
diff changeset
89 #define wrap_symbol_value_magic(p) wrap_pointer_1 (p)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 void print_symbol_value_magic (Lisp_Object, Lisp_Object, int);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 /********** The various different symbol-value-magic types ***********/
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 /* 1. symbol-value-forward */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 /* This type of symbol-value-magic is used for variables declared
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97 DEFVAR_LISP, DEFVAR_INT, DEFVAR_BOOL, DEFVAR_BUFFER_LOCAL,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 DEFVAR_BUFFER_DEFAULTS, DEFVAR_SPECIFIER, and for Qunbound.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 Note that some of these types of variables can be made buffer-local.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 Then, the symbol's value field contains a symbol-value-buffer-local,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102 whose CURRENT-VALUE field then contains a symbol-value-forward.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 struct symbol_value_forward
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 struct symbol_value_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109 /* `magicfun' is a function controlling the magic behavior of this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 forward variable.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 SYM is the symbol being operated on (read, set, etc.);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 VAL is either the value to set or the value to be returned.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 IN_OBJECT is the buffer or console that the value is read in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117 or set in. A value of Qnil means that the current buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 and possibly other buffers are being set. (This value will
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119 never be passed for built-in buffer-local or console-local
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120 variables such as `truncate-lines'.) (Currently, a value of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121 Qnil is always passed for DEFVAR_INT, DEFVAR_LISP, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122 DEFVAR_BOOL variables; the code isn't smart enough to figure
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 out what buffers besides the current buffer are being
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 affected. Because the magic function is called
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125 before the value is changed, it's not that easy
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 to determine which buffers are getting changed.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127 #### If this information is important, let me know
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 and I will look into providing it.) (Remember also
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129 that the only console-local variables currently existing
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130 are built-in ones, because others can't be created.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
132 FLAGS gives more information about the operation being performed.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
133
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
134 The return value indicates what the magic function actually did.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136 Currently FLAGS and the return value are not used. This
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137 function is only called when the value of a forward variable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 is about to be changed. Note that this can occur explicitly
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 through a call to `set', `setq', `set-default', or `setq-default',
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 or implicitly by the current buffer being changed. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 int (*magicfun) (Lisp_Object sym, Lisp_Object *val, Lisp_Object in_object,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142 int flags);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 DECLARE_LRECORD (symbol_value_forward, struct symbol_value_forward);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
145 #define XSYMBOL_VALUE_FORWARD(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146 XRECORD (x, symbol_value_forward, struct symbol_value_forward)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
147 #define symbol_value_forward_forward(m) ((void *)((m)->magic.value))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148 #define symbol_value_forward_magicfun(m) ((m)->magicfun)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
150 /* 2. symbol-value-buffer-local */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152 struct symbol_value_buffer_local
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154 struct symbol_value_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 /* Used in a symbol value cell when the symbol's value is per-buffer.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 The type of the symbol-value-magic will be either
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158 SYMVAL_BUFFER_LOCAL (i.e. `make-variable-buffer-local' was called)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159 or SYMVAL_SOME_BUFFER_LOCAL (i.e. `make-local-variable' was called).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 The only difference between the two is that when setting the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161 former kind of variable, an implicit `make-local-variable' is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
162 called.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
163
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
164 A buffer-local variable logically has
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
165
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
166 -- a default value
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
167 -- local values in some buffers
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
168
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
169 The primary place where the local values are stored is in each
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
170 buffer's local_var_alist slot.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
171
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
172 In the simplest implementation, all that this structure needs to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
173 keep track of is the default value; to retrieve the value in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
174 a buffer, look in that buffer's local_var_alist, and use the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
175 default value if there is no local value. To implement
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
176 `make-local-variable' in a buffer, look in the buffer's
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
177 local_var_alist, and if no element exists for this symbol,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
178 add one, copying the value from the default value. When setting
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
179 the value in a buffer, look in the buffer's local_var_alist, and set
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
180 the value in that list if an element exists for this symbol;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
181 otherwise, set the default. (Remember that SYMVAL_BUFFER_LOCAL
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
182 variables implicitly call `make-local-variable' first, so when
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
183 setting a value, there will always be an entry in the buffer's
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
184 local_var_alist to set.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
185
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
186 However, this operation is potentially slow. To speed it up,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
187 we cache the value in one buffer in this structure.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
188
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
189 NOTE: This is *not* a write-through cache. I.e. when setting
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
190 the value in the buffer that is cached, we *only* change the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
191 cache and don't write the value through to either the buffer's
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
192 local_var_alist or the default value. Therefore, when retrieving
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
193 a value in a buffer, you must *always* look in the cache to see if
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
194 it refers to that buffer.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
195
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
196 The cache consists of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
197
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
198 -- a buffer, or nil if the cache has not been set up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
199 -- the value in that buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
200 -- the element (a cons) from the buffer's local_var_alist, or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
201 nil if there is no local value in the buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
202
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
203 These slots are called CURRENT-BUFFER, CURRENT-VALUE, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
204 CURRENT-ALIST-ELEMENT, respectively.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
205
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
206 If we want to examine or set the value in BUFFER and CURRENT-BUFFER
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
207 equals BUFFER, we just examine or set CURRENT-VALUE. Otherwise,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
208 we store CURRENT-VALUE value into CURRENT-ALIST-ELEMENT (or maybe
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
209 into DEFAULT-VALUE), then find the appropriate alist element for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
210 BUFFER and set up CURRENT-ALIST-ELEMENT. Then we set CURRENT-VALUE
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
211 out of that element (or maybe out of DEFAULT-VALUE), and store
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
212 BUFFER into CURRENT-BUFFER.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
213
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
214 If we are setting the variable and the current buffer does not have
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
215 an alist entry for this variable, an alist entry is created.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
216
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
217 Note that CURRENT-BUFFER's local_var_alist value for this variable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
218 might be out-of-date (the correct value is stored in CURRENT-VALUE).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
219 Similarly, if CURRENT-BUFFER sees the default value, then
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
220 DEFAULT-VALUE might be out-of-date.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
221
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
222 Note that CURRENT-VALUE (but not DEFAULT-VALUE) can be a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
223 forwarding pointer. Each time it is examined or set,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
224 forwarding must be done.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
225 */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
226 Lisp_Object default_value;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
227 Lisp_Object current_value;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
228 Lisp_Object current_buffer;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
229 Lisp_Object current_alist_element;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
230 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
231 DECLARE_LRECORD (symbol_value_buffer_local, struct symbol_value_buffer_local);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
232 #define XSYMBOL_VALUE_BUFFER_LOCAL(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
233 XRECORD (x, symbol_value_buffer_local, struct symbol_value_buffer_local)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
234 #define SYMBOL_VALUE_BUFFER_LOCAL_P(x) RECORDP (x, symbol_value_buffer_local)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
235
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
236 /* 3. symbol-value-lisp-magic */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
237
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
238 enum lisp_magic_handler
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
239 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
240 MAGIC_HANDLER_GET_VALUE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
241 MAGIC_HANDLER_SET_VALUE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
242 MAGIC_HANDLER_BOUND_PREDICATE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
243 MAGIC_HANDLER_MAKE_UNBOUND,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
244 MAGIC_HANDLER_LOCAL_PREDICATE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
245 MAGIC_HANDLER_MAKE_LOCAL,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
246 MAGIC_HANDLER_MAX
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
247 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
248
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
249 struct symbol_value_lisp_magic
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
250 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
251 struct symbol_value_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
252 Lisp_Object handler[MAGIC_HANDLER_MAX];
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
253 Lisp_Object harg[MAGIC_HANDLER_MAX];
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
254 Lisp_Object shadowed;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
255 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
256 DECLARE_LRECORD (symbol_value_lisp_magic, struct symbol_value_lisp_magic);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
257 #define XSYMBOL_VALUE_LISP_MAGIC(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
258 XRECORD (x, symbol_value_lisp_magic, struct symbol_value_lisp_magic)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
259 #define SYMBOL_VALUE_LISP_MAGIC_P(x) RECORDP (x, symbol_value_lisp_magic)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
260
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
261 /* 4. symbol-value-varalias */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
262
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
263 struct symbol_value_varalias
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
264 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
265 struct symbol_value_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
266 Lisp_Object aliasee;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
267 Lisp_Object shadowed;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
268 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
269 DECLARE_LRECORD (symbol_value_varalias, struct symbol_value_varalias);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
270 #define XSYMBOL_VALUE_VARALIAS(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
271 XRECORD (x, symbol_value_varalias, struct symbol_value_varalias)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
272 #define SYMBOL_VALUE_VARALIAS_P(x) RECORDP (x, symbol_value_varalias)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
273 #define symbol_value_varalias_aliasee(m) ((m)->aliasee)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
274 #define symbol_value_varalias_shadowed(m) ((m)->shadowed)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
275
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
276 /* To define a Lisp primitive function using a C function `Fname', do this:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
277 DEFUN ("name, Fname, ...); // at top level in foo.c
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
278 DEFSUBR (Fname); // in syms_of_foo();
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
279 */
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
280 MODULE_API void defsubr (Lisp_Subr *);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
281 #define DEFSUBR(Fname) defsubr (&S##Fname)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
282
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
283 /* To define a Lisp primitive macro using a C function `Fname', do this:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
284 DEFUN ("name, Fname, ...); // at top level in foo.c
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
285 DEFSUBR_MACRO (Fname); // in syms_of_foo();
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
286 */
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
287 MODULE_API void defsubr_macro (Lisp_Subr *);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
288 #define DEFSUBR_MACRO(Fname) defsubr_macro (&S##Fname)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
289
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
290 MODULE_API void defsymbol_massage_name (Lisp_Object *location,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
291 const char *name);
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
292 MODULE_API void defsymbol_massage_name_nodump (Lisp_Object *location,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
293 const char *name);
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
294 MODULE_API void defsymbol_massage_multiword_predicate (Lisp_Object *location,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
295 const char *name);
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
296 MODULE_API void
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
297 defsymbol_massage_multiword_predicate_nodump (Lisp_Object *location,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
298 const char *name);
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
299 MODULE_API void defsymbol (Lisp_Object *location, const char *name);
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
300 MODULE_API void defsymbol_nodump (Lisp_Object *location, const char *name);
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
301
563
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
302 /* Defining symbols:
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
303
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
304 (1) A standard symbol is defined with DEFSYMBOL. That means that
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
305 the symbol's print name can be derived from the symbol's variable
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
306 name by removing the initial Q and replacing underscores with hyphens.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
307 (2) A keyword symbol is defined with DEFKEYWORD. That means that
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
308 the symbol's print name can be derived from the symbol's variable
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
309 name by removing the initial Q and replacing underscores with hyphens,
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
310 except that the initial underscore, which comes directly after the Q,
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
311 is replaced by a colon.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
312 (3) DEFSYMBOL_MULTIWORD_PREDICATE is used for the predicates that are
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
313 associated with a particular type of Lisp Object. Because of the
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
314 limitations of C macros, they're always given a predicate symbol
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
315 whose C name simply appends `p' to the type name, modulo hyphen/
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
316 underscore conversion. Properly, however, the Lisp name should have
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
317 `-p' if there is more than one word in the type name.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
318 DEFSYMBOL_MULTIWORD_PREDICATE is for these weird symbols -- the
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
319 C name as supplied to the macro should end with a `p' with no
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
320 underscore before it, and the macro will insert a hyphen there in
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
321 the Lisp name.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
322 (4) In case you have some weird symbol where the equivalence between
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
323 the C and Lisp names is more complicated (e.g. the Lisp symbol has
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
324 non-alphabetic, non-numeric characters in it), you can just call
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
325 defsymbol() (the lowercase version) directly.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
326 */
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
327
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
328 #define DEFSYMBOL(name) defsymbol_massage_name (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
329 #define DEFSYMBOL_NO_DUMP(name) defsymbol_massage_name_nodump (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
330 #define DEFSYMBOL_MULTIWORD_PREDICATE(name) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
331 defsymbol_massage_multiword_predicate (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
332 #define DEFSYMBOL_MULTIWORD_PREDICATE_NO_DUMP(name) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
333 defsymbol_massage_multiword_predicate_nodump (&name, #name)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
334
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
335 MODULE_API void defkeyword (Lisp_Object *location, const char *name);
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
336 MODULE_API void defkeyword_massage_name (Lisp_Object *location,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
337 const char *name);
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
338 #define DEFKEYWORD(name) defkeyword_massage_name (&name, #name)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
339
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
340 MODULE_API void deferror (Lisp_Object *symbol, const char *name,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
341 const char *message, Lisp_Object inherits_from);
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
342 MODULE_API void deferror_massage_name (Lisp_Object *symbol, const char *name,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
343 const char *message,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
344 Lisp_Object inherits_from);
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
345 MODULE_API void deferror_massage_name_and_message (Lisp_Object *symbol,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
346 const char *name,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
347 Lisp_Object inherits_from);
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
348 #define DEFERROR(name, message, inherits_from) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
349 deferror_massage_name (&name, #name, message, inherits_from)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
350 /* In this case, the error message is the same as the name, modulo some
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
351 prettifying */
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
352 #define DEFERROR_STANDARD(name, inherits_from) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
353 deferror_massage_name_and_message (&name, #name, inherits_from)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
354
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
355 /* Macros we use to define forwarded Lisp variables.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
356 These are used in the syms_of_FILENAME functions. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
357
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
358 MODULE_API void defvar_magic (const char *symbol_name,
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
359 const struct symbol_value_forward *magic);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
360
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
361 #define DEFVAR_SYMVAL_FWD(lname, c_location, forward_type, magicfun) \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
362 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
363 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
364 static const struct symbol_value_forward I_hate_C = \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
365 { /* struct symbol_value_forward */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
366 { /* struct symbol_value_magic */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
367 { /* struct lcrecord_header */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
368 { /* struct lrecord_header */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
369 lrecord_type_symbol_value_forward, /* lrecord_type_index */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
370 1, /* mark bit */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
371 1, /* c_readonly bit */ \
1111
184461bc8de4 [xemacs-hg @ 2002-11-18 06:52:23 by ben]
ben
parents: 793
diff changeset
372 1, /* lisp_readonly bit */ \
184461bc8de4 [xemacs-hg @ 2002-11-18 06:52:23 by ben]
ben
parents: 793
diff changeset
373 0 /* unused */ \
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
374 }, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
375 0, /* next */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
376 0, /* uid */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
377 0 /* free */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
378 }, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
379 c_location, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
380 forward_type \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
381 }, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
382 magicfun \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
383 }; \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
384 defvar_magic ((lname), &I_hate_C); \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
385 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
386
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
387 #define DEFVAR_SYMVAL_FWD_INT(lname, c_location, forward_type, magicfun) \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
388 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
389 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
390 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
391 dump_add_opaque_int (c_location); \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
392 } while (0)
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
393
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
394 #define DEFVAR_SYMVAL_FWD_FIXNUM(lname, c_location, forward_type, magicfun) \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
395 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
396 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
397 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
398 dump_add_opaque_fixnum (c_location); \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
399 } while (0)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
400
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
401 #define DEFVAR_SYMVAL_FWD_OBJECT(lname, c_location, forward_type, magicfun) \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
402 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
403 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
404 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
405 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
406 Lisp_Object *DSF_location = c_location; /* Type check */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
407 staticpro (DSF_location); \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
408 if (EQ (*DSF_location, Qnull_pointer)) *DSF_location = Qnil; \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
409 } \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
410 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
411
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
412 #define DEFVAR_LISP(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
413 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
414 #define DEFVAR_CONST_LISP(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
415 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_OBJECT_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
416 #define DEFVAR_SPECIFIER(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
417 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_SPECIFIER_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
418 #define DEFVAR_INT(lname, c_location) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
419 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
420 #define DEFVAR_CONST_INT(lname, c_location) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
421 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_CONST_FIXNUM_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
422 #define DEFVAR_BOOL(lname, c_location) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
423 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
424 #define DEFVAR_CONST_BOOL(lname, c_location) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
425 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_CONST_BOOLEAN_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
426 #define DEFVAR_LISP_MAGIC(lname, c_location, magicfun) \
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
427 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
428 #define DEFVAR_INT_MAGIC(lname, c_location, magicfun) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
429 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
430 #define DEFVAR_BOOL_MAGIC(lname, c_location, magicfun) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
431 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
432
446
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 442
diff changeset
433 void flush_all_buffer_local_cache (void);
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 442
diff changeset
434
1743
543769b89fed [xemacs-hg @ 2003-10-14 05:02:57 by james]
james
parents: 1650
diff changeset
435 END_C_DECLS
1650
34abfb24e891 [xemacs-hg @ 2003-08-28 15:44:04 by james]
james
parents: 1632
diff changeset
436
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
437 #endif /* INCLUDED_symeval_h_ */