annotate src/symeval.h @ 5880:44ba043ceada

Fix a small typo
author Vin Shelton <acs@xemacs.org>
date Sat, 28 Mar 2015 16:03:33 -0400
parents 308d34e9f07d
children
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.
5142
f965e31a35f0 reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents: 5127
diff changeset
3 Copyright (C) 2000, 2001, 2002, 2010 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
5402
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 5280
diff changeset
7 XEmacs is free software: you can redistribute it and/or modify it
428
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
5402
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 5280
diff changeset
9 Free Software Foundation, either version 3 of the License, or (at your
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 5280
diff changeset
10 option) any later version.
428
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
5402
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 5280
diff changeset
18 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 /* Synched up with: Not in FSF. */
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 /* Fsymbol_value checks whether XSYMBOL (sym)->value is one of these,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 * and does weird magic stuff if so */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
25 #ifndef INCLUDED_symeval_h_
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
26 #define INCLUDED_symeval_h_
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27
1743
543769b89fed [xemacs-hg @ 2003-10-14 05:02:57 by james]
james
parents: 1650
diff changeset
28 BEGIN_C_DECLS
1650
34abfb24e891 [xemacs-hg @ 2003-08-28 15:44:04 by james]
james
parents: 1632
diff changeset
29
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 enum symbol_value_type
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 /* The following tags use the 'symbol_value_forward' structure
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 and are strictly for variables DEFVARed on the C level. */
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
34 SYMVAL_FIXNUM_FORWARD, /* Forward C "Fixnum", really "EMACS_INT" */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 SYMVAL_CONST_FIXNUM_FORWARD, /* Same, but can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 SYMVAL_BOOLEAN_FORWARD, /* Forward C boolean ("int") */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 SYMVAL_CONST_BOOLEAN_FORWARD, /* Same, but can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 SYMVAL_OBJECT_FORWARD, /* Forward C Lisp_Object */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 SYMVAL_CONST_OBJECT_FORWARD, /* Same, but can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 SYMVAL_CONST_SPECIFIER_FORWARD, /* Same, can't be set, but gives a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 different message when attempting to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 set that says "use set-specifier" */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 SYMVAL_DEFAULT_BUFFER_FORWARD, /* Forward Lisp_Object into Vbuffer_defaults */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 SYMVAL_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into current_buffer */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 SYMVAL_CONST_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 current_buffer, can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 SYMVAL_DEFAULT_CONSOLE_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 Vconsole_defaults */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 SYMVAL_SELECTED_CONSOLE_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 Vselected_console */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 SYMVAL_CONST_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 can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 SYMVAL_UNBOUND_MARKER, /* Only Qunbound actually has this tag */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 /* The following tags use the 'symbol_value_buffer_local' structure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 SYMVAL_BUFFER_LOCAL, /* make-variable-buffer-local */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 SYMVAL_SOME_BUFFER_LOCAL, /* make-local-variable */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 /* The following tag uses the 'symbol_value_lisp_magic' structure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 SYMVAL_LISP_MAGIC, /* Forward to lisp callbacks */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 /* The following tag uses the 'symbol_value_varalias' structure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 SYMVAL_VARALIAS /* defvaralias */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 #if 0
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 /* NYI */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 SYMVAL_CONSTANT_SYMBOL, /* Self-evaluating symbol */
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 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
73 /* Underlying C type used to implement DEFVAR_INT */
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
74 typedef EMACS_INT Fixnum;
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
75
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 struct symbol_value_magic
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 {
5127
a9c41067dd88 more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents: 5125
diff changeset
78 NORMAL_LISP_OBJECT_HEADER header;
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
79 void *value;
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 enum symbol_value_type type;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 };
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
82 #define SYMBOL_VALUE_MAGIC_P(x) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
83 (LRECORDP (x) && \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
84 XRECORD_LHEADER (x)->type <= lrecord_type_max_symbol_value_magic)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 #define XSYMBOL_VALUE_MAGIC_TYPE(v) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 (((struct symbol_value_magic *) XPNTR (v))->type)
793
e38acbeb1cae [xemacs-hg @ 2002-03-29 04:46:17 by ben]
ben
parents: 771
diff changeset
87 #define wrap_symbol_value_magic(p) wrap_pointer_1 (p)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 void print_symbol_value_magic (Lisp_Object, Lisp_Object, int);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 /********** The various different symbol-value-magic types ***********/
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 /* 1. symbol-value-forward */
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 /* This type of symbol-value-magic is used for variables declared
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 DEFVAR_LISP, DEFVAR_INT, DEFVAR_BOOL, DEFVAR_BUFFER_LOCAL,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 DEFVAR_BUFFER_DEFAULTS, DEFVAR_SPECIFIER, and for Qunbound.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 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
99 Then, the symbol's value field contains a symbol-value-buffer-local,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 whose CURRENT-VALUE field then contains a symbol-value-forward.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 struct symbol_value_forward
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_magic magic;
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 /* `magicfun' is a function controlling the magic behavior of this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108 forward variable.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 SYM is the symbol being operated on (read, set, etc.);
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 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
113
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 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
115 or set in. A value of Qnil means that the current buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 and possibly other buffers are being set. (This value will
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117 never be passed for built-in buffer-local or console-local
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 variables such as `truncate-lines'.) (Currently, a value of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119 Qnil is always passed for DEFVAR_INT, DEFVAR_LISP, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120 DEFVAR_BOOL variables; the code isn't smart enough to figure
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121 out what buffers besides the current buffer are being
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122 affected. Because the magic function is called
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 before the value is changed, it's not that easy
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 to determine which buffers are getting changed.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125 #### If this information is important, let me know
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 and I will look into providing it.) (Remember also
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127 that the only console-local variables currently existing
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 are built-in ones, because others can't be created.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130 FLAGS gives more information about the operation being performed.
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 The return value indicates what the magic function actually did.
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 Currently FLAGS and the return value are not used. This
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135 function is only called when the value of a forward variable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136 is about to be changed. Note that this can occur explicitly
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137 through a call to `set', `setq', `set-default', or `setq-default',
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 or implicitly by the current buffer being changed. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 int (*magicfun) (Lisp_Object sym, Lisp_Object *val, Lisp_Object in_object,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 int flags);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 };
5118
e0db3c197671 merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
142 DECLARE_LISP_OBJECT (symbol_value_forward, struct symbol_value_forward);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 #define XSYMBOL_VALUE_FORWARD(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 XRECORD (x, symbol_value_forward, struct symbol_value_forward)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
145 #define symbol_value_forward_forward(m) ((void *)((m)->magic.value))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146 #define symbol_value_forward_magicfun(m) ((m)->magicfun)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148 /* 2. symbol-value-buffer-local */
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 struct 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_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 /* 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
154
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 The type of the symbol-value-magic will be either
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156 SYMVAL_BUFFER_LOCAL (i.e. `make-variable-buffer-local' was called)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 or SYMVAL_SOME_BUFFER_LOCAL (i.e. `make-local-variable' was called).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158 The only difference between the two is that when setting the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159 former kind of variable, an implicit `make-local-variable' is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 called.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
162 A buffer-local variable logically has
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 default value
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
165 -- local values in some buffers
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
166
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
167 The primary place where the local values are stored is in each
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
168 buffer's local_var_alist slot.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
169
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
170 In the simplest implementation, all that this structure needs to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
171 keep track of is the default value; to retrieve the value in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
172 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
173 default value if there is no local value. To implement
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
174 `make-local-variable' in a buffer, look in the buffer's
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
175 local_var_alist, and if no element exists for this symbol,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
176 add one, copying the value from the default value. When setting
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
177 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
178 the value in that list if an element exists for this symbol;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
179 otherwise, set the default. (Remember that SYMVAL_BUFFER_LOCAL
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
180 variables implicitly call `make-local-variable' first, so when
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
181 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
182 local_var_alist to set.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
183
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
184 However, this operation is potentially slow. To speed it up,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
185 we cache the value in one buffer in this structure.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
186
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
187 NOTE: This is *not* a write-through cache. I.e. when setting
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
188 the value in the buffer that is cached, we *only* change the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
189 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
190 local_var_alist or the default value. Therefore, when retrieving
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
191 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
192 it refers to that buffer.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
193
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
194 The cache consists of
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 -- a buffer, or nil if the cache has not been set up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
197 -- the value in that buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
198 -- the element (a cons) from the buffer's local_var_alist, or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
199 nil if there is no local value in the buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
200
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
201 These slots are called CURRENT-BUFFER, CURRENT-VALUE, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
202 CURRENT-ALIST-ELEMENT, respectively.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
203
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
204 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
205 equals BUFFER, we just examine or set CURRENT-VALUE. Otherwise,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
206 we store CURRENT-VALUE value into CURRENT-ALIST-ELEMENT (or maybe
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
207 into DEFAULT-VALUE), then find the appropriate alist element for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
208 BUFFER and set up CURRENT-ALIST-ELEMENT. Then we set CURRENT-VALUE
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
209 out of that element (or maybe out of DEFAULT-VALUE), and store
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
210 BUFFER into CURRENT-BUFFER.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
211
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
212 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
213 an alist entry for this variable, an alist entry is created.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
214
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
215 Note that CURRENT-BUFFER's local_var_alist value for this variable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
216 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
217 Similarly, if CURRENT-BUFFER sees the default value, then
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
218 DEFAULT-VALUE might be out-of-date.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
219
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
220 Note that CURRENT-VALUE (but not DEFAULT-VALUE) can be a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
221 forwarding pointer. Each time it is examined or set,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
222 forwarding must be done.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
223 */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
224 Lisp_Object default_value;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
225 Lisp_Object current_value;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
226 Lisp_Object current_buffer;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
227 Lisp_Object current_alist_element;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
228 };
5118
e0db3c197671 merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
229 DECLARE_LISP_OBJECT (symbol_value_buffer_local, struct symbol_value_buffer_local);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
230 #define XSYMBOL_VALUE_BUFFER_LOCAL(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
231 XRECORD (x, symbol_value_buffer_local, struct symbol_value_buffer_local)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
232 #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
233
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
234 /* 3. symbol-value-lisp-magic */
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 enum lisp_magic_handler
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 MAGIC_HANDLER_GET_VALUE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
239 MAGIC_HANDLER_SET_VALUE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
240 MAGIC_HANDLER_BOUND_PREDICATE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
241 MAGIC_HANDLER_MAKE_UNBOUND,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
242 MAGIC_HANDLER_LOCAL_PREDICATE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
243 MAGIC_HANDLER_MAKE_LOCAL,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
244 MAGIC_HANDLER_MAX
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
245 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
246
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
247 struct symbol_value_lisp_magic
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_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
250 Lisp_Object handler[MAGIC_HANDLER_MAX];
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
251 Lisp_Object harg[MAGIC_HANDLER_MAX];
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
252 Lisp_Object shadowed;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
253 };
5118
e0db3c197671 merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
254 DECLARE_LISP_OBJECT (symbol_value_lisp_magic, struct symbol_value_lisp_magic);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
255 #define XSYMBOL_VALUE_LISP_MAGIC(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
256 XRECORD (x, symbol_value_lisp_magic, struct symbol_value_lisp_magic)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
257 #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
258
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
259 /* 4. symbol-value-varalias */
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 struct 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_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
264 Lisp_Object aliasee;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
265 Lisp_Object shadowed;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
266 };
5118
e0db3c197671 merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
267 DECLARE_LISP_OBJECT (symbol_value_varalias, struct symbol_value_varalias);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
268 #define XSYMBOL_VALUE_VARALIAS(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
269 XRECORD (x, symbol_value_varalias, struct symbol_value_varalias)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
270 #define SYMBOL_VALUE_VARALIAS_P(x) RECORDP (x, symbol_value_varalias)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
271 #define symbol_value_varalias_aliasee(m) ((m)->aliasee)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
272 #define symbol_value_varalias_shadowed(m) ((m)->shadowed)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
273
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
274 /* 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
275 DEFUN ("name, Fname, ...); // at top level in foo.c
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
276 DEFSUBR (Fname); // in syms_of_foo();
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
277 */
3263
d674024a8674 [xemacs-hg @ 2006-02-27 16:29:00 by crestani]
crestani
parents: 3024
diff changeset
278 #ifdef NEW_GC
2720
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
279 MODULE_API void defsubr (Lisp_Subr *);
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
280 #define DEFSUBR_MC_ALLOC(Fname) \
2814
520c08f04735 [xemacs-hg @ 2005-06-16 19:59:33 by crestani]
crestani
parents: 2720
diff changeset
281 S##Fname= (struct Lisp_Subr *) mc_alloc (sizeof (struct Lisp_Subr)); \
2720
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
282 set_lheader_implementation (&S##Fname->lheader, &lrecord_subr); \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
283 \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
284 S##Fname->min_args = MC_ALLOC_S##Fname.min_args; \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
285 S##Fname->max_args = MC_ALLOC_S##Fname.max_args; \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
286 S##Fname->prompt = MC_ALLOC_S##Fname.prompt; \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
287 S##Fname->doc = MC_ALLOC_S##Fname.doc; \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
288 S##Fname->name = MC_ALLOC_S##Fname.name; \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
289 S##Fname->subr_fn = MC_ALLOC_S##Fname.subr_fn; \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
290 MARK_LRECORD_AS_LISP_READONLY (S##Fname);
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
291
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
292
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
293 #define DEFSUBR(Fname) \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
294 do { \
5280
59a6419f7504 Use GET_DEFUN_LISP_OBJECT() in PARSE_KEYWORDS(), fix former under NEW_GC.
Aidan Kehoe <kehoea@parhasard.net>
parents: 5142
diff changeset
295 /* #### As far as I can see, this has no upside compared to the non-NEW_GC \
59a6419f7504 Use GET_DEFUN_LISP_OBJECT() in PARSE_KEYWORDS(), fix former under NEW_GC.
Aidan Kehoe <kehoea@parhasard.net>
parents: 5142
diff changeset
296 code. The MC_ALLOC_S##Fname structure is also in the dumped \
59a6419f7504 Use GET_DEFUN_LISP_OBJECT() in PARSE_KEYWORDS(), fix former under NEW_GC.
Aidan Kehoe <kehoea@parhasard.net>
parents: 5142
diff changeset
297 XEmacs. Aidan Kehoe, Mon Sep 20 23:14:01 IST 2010 */ \
2720
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
298 DEFSUBR_MC_ALLOC (Fname); \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
299 defsubr (S##Fname); \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
300 } while (0)
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
301
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
302 /* To define a Lisp primitive macro using a C function `Fname', do this:
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
303 DEFUN ("name, Fname, ...); // at top level in foo.c
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
304 DEFSUBR_MACRO (Fname); // in syms_of_foo();
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
305 */
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
306 MODULE_API void defsubr_macro (Lisp_Subr *);
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
307 #define DEFSUBR_MACRO(Fname) \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
308 do { \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
309 DEFSUBR_MC_ALLOC (Fname); \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
310 defsubr_macro (S##Fname); \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
311 } while (0)
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
312
3263
d674024a8674 [xemacs-hg @ 2006-02-27 16:29:00 by crestani]
crestani
parents: 3024
diff changeset
313 #else /* not NEW_GC */
2720
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
314 /* To define a Lisp primitive function using a C function `Fname', do this:
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
315 DEFUN ("name, Fname, ...); // at top level in foo.c
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
316 DEFSUBR (Fname); // in syms_of_foo();
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
317 */
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
318 MODULE_API void defsubr (Lisp_Subr *);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
319 #define DEFSUBR(Fname) defsubr (&S##Fname)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
320
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
321 /* 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
322 DEFUN ("name, Fname, ...); // at top level in foo.c
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
323 DEFSUBR_MACRO (Fname); // in syms_of_foo();
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
324 */
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
325 MODULE_API void defsubr_macro (Lisp_Subr *);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
326 #define DEFSUBR_MACRO(Fname) defsubr_macro (&S##Fname)
3263
d674024a8674 [xemacs-hg @ 2006-02-27 16:29:00 by crestani]
crestani
parents: 3024
diff changeset
327 #endif /* not NEW_GC */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
328
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
329 MODULE_API void defsymbol_massage_name (Lisp_Object *location,
4952
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
330 const Ascbyte *name);
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
331 MODULE_API void defsymbol_massage_name_nodump (Lisp_Object *location,
4952
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
332 const Ascbyte *name);
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
333 MODULE_API void defsymbol_massage_multiword_predicate (Lisp_Object *location,
4952
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
334 const Ascbyte *name);
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
335 MODULE_API void
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
336 defsymbol_massage_multiword_predicate_nodump (Lisp_Object *location,
4952
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
337 const Ascbyte *name);
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
338 MODULE_API void defsymbol (Lisp_Object *location, const Ascbyte *name);
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
339 MODULE_API void defsymbol_nodump (Lisp_Object *location, const Ascbyte *name);
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
340
563
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
341 /* Defining symbols:
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
342
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
343 (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
344 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
345 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
346 (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
347 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
348 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
349 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
350 is replaced by a colon.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
351 (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
352 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
353 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
354 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
355 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
356 `-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
357 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
358 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
359 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
360 the Lisp name.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
361 (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
362 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
363 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
364 defsymbol() (the lowercase version) directly.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
365 */
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
366
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
367 #define DEFSYMBOL(name) defsymbol_massage_name (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
368 #define DEFSYMBOL_NO_DUMP(name) defsymbol_massage_name_nodump (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
369 #define DEFSYMBOL_MULTIWORD_PREDICATE(name) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
370 defsymbol_massage_multiword_predicate (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
371 #define DEFSYMBOL_MULTIWORD_PREDICATE_NO_DUMP(name) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
372 defsymbol_massage_multiword_predicate_nodump (&name, #name)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
373
4952
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
374 MODULE_API void defkeyword (Lisp_Object *location, const Ascbyte *name);
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
375 MODULE_API void defkeyword_massage_name (Lisp_Object *location,
4952
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
376 const Ascbyte *name);
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
377 #define DEFKEYWORD(name) defkeyword_massage_name (&name, #name)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
378
4952
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
379 MODULE_API void deferror (Lisp_Object *symbol, const Ascbyte *name,
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
380 const Ascbyte *message, Lisp_Object inherits_from);
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
381 MODULE_API void deferror_massage_name (Lisp_Object *symbol, const Ascbyte *name,
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
382 const Ascbyte *message,
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
383 Lisp_Object inherits_from);
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
384 MODULE_API void deferror_massage_name_and_message (Lisp_Object *symbol,
4952
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
385 const Ascbyte *name,
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
386 Lisp_Object inherits_from);
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
387 #define DEFERROR(name, message, inherits_from) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
388 deferror_massage_name (&name, #name, message, inherits_from)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
389 /* 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
390 prettifying */
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
391 #define DEFERROR_STANDARD(name, inherits_from) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
392 deferror_massage_name_and_message (&name, #name, inherits_from)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
393
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
394 /* Macros we use to define forwarded Lisp variables.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
395 These are used in the syms_of_FILENAME functions. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
396
4952
19a72041c5ed Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
397 MODULE_API void defvar_magic (const Ascbyte *symbol_name,
1632
64eaceca611d [xemacs-hg @ 2003-08-19 02:07:03 by james]
james
parents: 1111
diff changeset
398 const struct symbol_value_forward *magic);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
399
3263
d674024a8674 [xemacs-hg @ 2006-02-27 16:29:00 by crestani]
crestani
parents: 3024
diff changeset
400 #ifdef NEW_GC
2720
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
401 #define DEFVAR_SYMVAL_FWD(lname, c_location, forward_type, magic_fun) \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
402 do \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
403 { \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
404 struct symbol_value_forward *I_hate_C = \
5127
a9c41067dd88 more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents: 5125
diff changeset
405 XSYMBOL_VALUE_FORWARD (ALLOC_NORMAL_LISP_OBJECT (symbol_value_forward)); \
2720
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
406 /* mcpro ((Lisp_Object) I_hate_C);*/ \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
407 \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
408 MARK_LRECORD_AS_LISP_READONLY (I_hate_C); \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
409 \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
410 I_hate_C->magic.value = c_location; \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
411 I_hate_C->magic.type = forward_type; \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
412 I_hate_C->magicfun = magic_fun; \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
413 \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
414 defvar_magic ((lname), I_hate_C); \
6fa9919a9a0b [xemacs-hg @ 2005-04-08 23:10:01 by crestani]
crestani
parents: 1743
diff changeset
415 } while (0)
3263
d674024a8674 [xemacs-hg @ 2006-02-27 16:29:00 by crestani]
crestani
parents: 3024
diff changeset
416 #else /* not NEW_GC */
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
417 #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
418 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
419 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
420 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
421 { /* struct symbol_value_forward */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
422 { /* struct symbol_value_magic */ \
3024
b7f26b2f78bd [xemacs-hg @ 2005-10-25 08:32:40 by ben]
ben
parents: 3017
diff changeset
423 { /* struct old_lcrecord_header */ \
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
424 { /* struct lrecord_header */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
425 lrecord_type_symbol_value_forward, /* lrecord_type_index */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
426 1, /* mark bit */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
427 1, /* c_readonly bit */ \
1111
184461bc8de4 [xemacs-hg @ 2002-11-18 06:52:23 by ben]
ben
parents: 793
diff changeset
428 1, /* lisp_readonly bit */ \
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
429 }, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
430 0, /* next */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
431 }, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
432 c_location, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
433 forward_type \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
434 }, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
435 magicfun \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
436 }; \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
437 defvar_magic ((lname), &I_hate_C); \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
438 } while (0)
3263
d674024a8674 [xemacs-hg @ 2006-02-27 16:29:00 by crestani]
crestani
parents: 3024
diff changeset
439 #endif /* not NEW_GC */
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
440 #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
441 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
442 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
443 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
444 dump_add_opaque_int (c_location); \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
445 } while (0)
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
446
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
447 #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
448 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
449 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
450 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
451 dump_add_opaque_fixnum (c_location); \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
452 } while (0)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
453
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
454 #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
455 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
456 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
457 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
458 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
459 Lisp_Object *DSF_location = c_location; /* Type check */ \
4971
bcdf496e49d0 put back patch to get more informative staticpro debugging
Ben Wing <ben@xemacs.org>
parents: 4969
diff changeset
460 staticpro_1 (DSF_location, lname); \
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
461 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
462 } \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
463 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
464
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
465 #define DEFVAR_LISP(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
466 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
467 #define DEFVAR_CONST_LISP(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
468 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_OBJECT_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
469 #define DEFVAR_SPECIFIER(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
470 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_SPECIFIER_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
471 #define DEFVAR_INT(lname, c_location) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
472 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
473 #define DEFVAR_CONST_INT(lname, c_location) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
474 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
475 #define DEFVAR_BOOL(lname, c_location) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
476 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
477 #define DEFVAR_CONST_BOOL(lname, c_location) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
478 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
479 #define DEFVAR_LISP_MAGIC(lname, c_location, magicfun) \
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
480 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
481 #define DEFVAR_INT_MAGIC(lname, c_location, magicfun) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
482 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
483 #define DEFVAR_BOOL_MAGIC(lname, c_location, magicfun) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
484 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
485
446
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 442
diff changeset
486 void flush_all_buffer_local_cache (void);
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 442
diff changeset
487
4677
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
488 struct multiple_value {
5127
a9c41067dd88 more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents: 5125
diff changeset
489 NORMAL_LISP_OBJECT_HEADER header;
4677
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
490 Elemcount count;
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
491 Elemcount allocated_count;
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
492 Elemcount first_desired;
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
493 Lisp_Object contents[1];
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
494 };
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
495 typedef struct multiple_value multiple_value;
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
496
5118
e0db3c197671 merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents: 4677
diff changeset
497 DECLARE_LISP_OBJECT (multiple_value, multiple_value);
4677
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
498 #define MULTIPLE_VALUEP(x) RECORDP (x, multiple_value)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
499
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
500 #define XMULTIPLE_VALUE(x) XRECORD (x, multiple_value, multiple_value)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
501 #define wrap_multiple_value(p) wrap_record (p, multiple_value)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
502
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
503 #define CHECK_MULTIPLE_VALUE(x) CHECK_RECORD (x, multiple_value)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
504 #define CONCHECK_MULTIPLE_VALUE(x) CONCHECK_RECORD (x, multiple_value)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
505
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
506 #define multiple_value_count(x) ((x)->count)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
507 #define multiple_value_allocated_count(x) ((x)->allocated_count)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
508 #define multiple_value_first_desired(x) ((x)->first_desired)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
509 #define multiple_value_contents(x) ((x)->contents)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
510
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
511 #define XMULTIPLE_VALUE_COUNT(x) multiple_value_count (XMULTIPLE_VALUE (x))
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
512 #define XMULTIPLE_VALUE_ALLOCATED_COUNT(x) \
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
513 multiple_value_allocated_count (XMULTIPLE_VALUE (x))
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
514 #define XMULTIPLE_VALUE_FIRST_DESIRED(x) \
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
515 multiple_value_first_desired (XMULTIPLE_VALUE(x))
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
516 #define XMULTIPLE_VALUE_CONTENTS(x) multiple_value_contents (XMULTIPLE_VALUE(x))
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
517
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
518 Lisp_Object multiple_value_call (int nargs, Lisp_Object *args);
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
519 Lisp_Object multiple_value_list_internal (int nargs, Lisp_Object *args);
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
520
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
521 /* It's slightly ugly to expose this here, but it does cut down the amount
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
522 of work the bytecode interpreter has to do substantially. */
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
523 extern int multiple_value_current_limit;
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
524
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
525 /* Bind the multiple value limits that #'values and #'values-list pay
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
526 attention to. Used by bytecode and interpreted code. */
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
527 int bind_multiple_value_limits (int first, int upper);
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
528
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
529 Lisp_Object multiple_value_aref (Lisp_Object, Elemcount);
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
530 void multiple_value_aset (Lisp_Object, Elemcount, Lisp_Object);
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
531
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
532 Lisp_Object values2 (Lisp_Object first, Lisp_Object second);
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
533
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
534 DECLARE_INLINE_HEADER (
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
535 Lisp_Object
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
536 ignore_multiple_values (Lisp_Object obj)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
537 )
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
538 {
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
539 return MULTIPLE_VALUEP (obj) ? multiple_value_aref (obj, 0) : obj;
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
540 }
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
541
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
542 #ifdef ERROR_CHECK_MULTIPLE_VALUES
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
543
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
544 DECLARE_INLINE_HEADER (
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
545 Lisp_Object
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
546 ignore_multiple_values_1 (Lisp_Object obj)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
547 )
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
548 {
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
549 if (1 == multiple_value_current_limit)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
550 {
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
551 assert (!MULTIPLE_VALUEP (obj));
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
552 return obj;
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
553 }
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
554
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
555 return ignore_multiple_values (obj);
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
556 }
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
557
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
558 #define IGNORE_MULTIPLE_VALUES(X) ignore_multiple_values_1 (X)
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
559
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
560 #else
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
561 #define IGNORE_MULTIPLE_VALUES(X) (multiple_value_current_limit == 1 ? (X) \
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
562 : ignore_multiple_values (X))
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
563 #endif
8f1ee2d15784 Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents: 3263
diff changeset
564
1743
543769b89fed [xemacs-hg @ 2003-10-14 05:02:57 by james]
james
parents: 1650
diff changeset
565 END_C_DECLS
1650
34abfb24e891 [xemacs-hg @ 2003-08-28 15:44:04 by james]
james
parents: 1632
diff changeset
566
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
567 #endif /* INCLUDED_symeval_h_ */