Commit | Line | Data |
---|---|---|
3cfe6dfd | 1 | /* Fundamental definitions for GNU Emacs Lisp interpreter. |
e2017fe2 | 2 | |
ba318903 PE |
3 | Copyright (C) 1985-1987, 1993-1995, 1997-2014 Free Software Foundation, |
4 | Inc. | |
3cfe6dfd JB |
5 | |
6 | This file is part of GNU Emacs. | |
7 | ||
b9b1cc14 | 8 | GNU Emacs is free software: you can redistribute it and/or modify |
3cfe6dfd | 9 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
10 | the Free Software Foundation, either version 3 of the License, or |
11 | (at your option) any later version. | |
3cfe6dfd JB |
12 | |
13 | GNU Emacs is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
b9b1cc14 | 19 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
3cfe6dfd | 20 | |
6b61353c KH |
21 | #ifndef EMACS_LISP_H |
22 | #define EMACS_LISP_H | |
23 | ||
0328b6de | 24 | #include <setjmp.h> |
e32a5799 | 25 | #include <stdalign.h> |
6a8033e1 | 26 | #include <stdarg.h> |
89887d67 | 27 | #include <stddef.h> |
4d7e6e51 | 28 | #include <float.h> |
8ac068ac | 29 | #include <inttypes.h> |
dd3482fe | 30 | #include <limits.h> |
6a8033e1 | 31 | |
be44ca6c | 32 | #include <intprops.h> |
b9ff995e | 33 | #include <verify.h> |
be44ca6c | 34 | |
f162bcc3 | 35 | INLINE_HEADER_BEGIN |
f162bcc3 | 36 | |
bb9937df PE |
37 | /* Define a TYPE constant ID as an externally visible name. Use like this: |
38 | ||
bba89481 PE |
39 | #define ID_val (some integer preprocessor expression) |
40 | #if ENUMABLE (ID_val) | |
41 | DEFINE_GDB_SYMBOL_ENUM (ID) | |
42 | #else | |
bb9937df | 43 | DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID) |
bba89481 | 44 | # define ID ID_val |
bb9937df | 45 | DEFINE_GDB_SYMBOL_END (ID) |
bba89481 | 46 | #endif |
bb9937df PE |
47 | |
48 | This hack is for the benefit of compilers that do not make macro | |
49 | definitions visible to the debugger. It's used for symbols that | |
50 | .gdbinit needs, symbols whose values may not fit in 'int' (where an | |
bba89481 PE |
51 | enum would suffice). |
52 | ||
53 | Some GCC versions before GCC 4.2 omit enums in debugging output; | |
54 | see GCC bug 23336. So don't use enums with older GCC. */ | |
55 | ||
56 | #if !defined __GNUC__ || 4 < __GNUC__ + (2 <= __GNUC_MINOR__) | |
57 | # define ENUMABLE(val) (INT_MIN <= (val) && (val) <= INT_MAX) | |
58 | #else | |
59 | # define ENUMABLE(val) 0 | |
60 | #endif | |
61 | ||
62 | /* On AIX 7.1 ENUMABLE should return true when possible, otherwise the | |
63 | linker can optimize the symbols away, making it harder to debug. | |
64 | This was discovered only late in the release process, so to play it | |
65 | safe for now, non-AIX platforms do not use enums for debugging symbols. | |
66 | FIXME: remove this comment and the following four lines of code. */ | |
67 | #ifndef _AIX | |
68 | # undef ENUMABLE | |
69 | # define ENUMABLE(val) 0 | |
70 | #endif | |
71 | ||
72 | #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val }; | |
0f679e86 | 73 | #if defined MAIN_PROGRAM |
bb9937df PE |
74 | # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE |
75 | # define DEFINE_GDB_SYMBOL_END(id) = id; | |
76 | #else | |
77 | # define DEFINE_GDB_SYMBOL_BEGIN(type, id) | |
78 | # define DEFINE_GDB_SYMBOL_END(val) | |
79 | #endif | |
80 | ||
03a660a6 PE |
81 | /* The ubiquitous max and min macros. */ |
82 | #undef min | |
83 | #undef max | |
84 | #define max(a, b) ((a) > (b) ? (a) : (b)) | |
85 | #define min(a, b) ((a) < (b) ? (a) : (b)) | |
86 | ||
34374650 PE |
87 | /* EMACS_INT - signed integer wide enough to hold an Emacs value |
88 | EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if | |
89 | pI - printf length modifier for EMACS_INT | |
90 | EMACS_UINT - unsigned variant of EMACS_INT */ | |
71f88e00 | 91 | #ifndef EMACS_INT_MAX |
b00cdd96 PE |
92 | # if INTPTR_MAX <= 0 |
93 | # error "INTPTR_MAX misconfigured" | |
94 | # elif INTPTR_MAX <= INT_MAX && !defined WIDE_EMACS_INT | |
95 | typedef int EMACS_INT; | |
96 | typedef unsigned int EMACS_UINT; | |
97 | # define EMACS_INT_MAX INT_MAX | |
98 | # define pI "" | |
99 | # elif INTPTR_MAX <= LONG_MAX && !defined WIDE_EMACS_INT | |
71f88e00 | 100 | typedef long int EMACS_INT; |
2d9783e0 | 101 | typedef unsigned long EMACS_UINT; |
34374650 | 102 | # define EMACS_INT_MAX LONG_MAX |
47be4ab5 | 103 | # define pI "l" |
b00cdd96 PE |
104 | # elif INTPTR_MAX <= LLONG_MAX |
105 | typedef long long int EMACS_INT; | |
106 | typedef unsigned long long int EMACS_UINT; | |
107 | # define EMACS_INT_MAX LLONG_MAX | |
108 | # define pI "ll" | |
47be4ab5 | 109 | # else |
b00cdd96 | 110 | # error "INTPTR_MAX too large" |
47be4ab5 | 111 | # endif |
68c45bf0 | 112 | #endif |
34374650 | 113 | |
df5b4930 PE |
114 | /* Number of bits to put in each character in the internal representation |
115 | of bool vectors. This should not vary across implementations. */ | |
116 | enum { BOOL_VECTOR_BITS_PER_CHAR = | |
117 | #define BOOL_VECTOR_BITS_PER_CHAR 8 | |
118 | BOOL_VECTOR_BITS_PER_CHAR | |
119 | }; | |
120 | ||
87c4314d | 121 | /* An unsigned integer type representing a fixed-length bit sequence, |
df5b4930 PE |
122 | suitable for words in a Lisp bool vector. Normally it is size_t |
123 | for speed, but it is unsigned char on weird platforms. */ | |
2cf00efc | 124 | #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT |
87c4314d | 125 | typedef size_t bits_word; |
2cf00efc | 126 | # define BITS_WORD_MAX SIZE_MAX |
df5b4930 PE |
127 | enum { BITS_PER_BITS_WORD = CHAR_BIT * sizeof (bits_word) }; |
128 | #else | |
129 | typedef unsigned char bits_word; | |
2cf00efc | 130 | # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1) |
df5b4930 PE |
131 | enum { BITS_PER_BITS_WORD = BOOL_VECTOR_BITS_PER_CHAR }; |
132 | #endif | |
2cf00efc | 133 | verify (BITS_WORD_MAX >> (BITS_PER_BITS_WORD - 1) == 1); |
87c4314d | 134 | |
34374650 PE |
135 | /* Number of bits in some machine integer types. */ |
136 | enum | |
137 | { | |
138 | BITS_PER_CHAR = CHAR_BIT, | |
139 | BITS_PER_SHORT = CHAR_BIT * sizeof (short), | |
140 | BITS_PER_INT = CHAR_BIT * sizeof (int), | |
141 | BITS_PER_LONG = CHAR_BIT * sizeof (long int), | |
142 | BITS_PER_EMACS_INT = CHAR_BIT * sizeof (EMACS_INT) | |
143 | }; | |
ce99fd65 | 144 | |
a81d11a3 PE |
145 | /* printmax_t and uprintmax_t are types for printing large integers. |
146 | These are the widest integers that are supported for printing. | |
147 | pMd etc. are conversions for printing them. | |
148 | On C99 hosts, there's no problem, as even the widest integers work. | |
149 | Fall back on EMACS_INT on pre-C99 hosts. */ | |
150 | #ifdef PRIdMAX | |
151 | typedef intmax_t printmax_t; | |
152 | typedef uintmax_t uprintmax_t; | |
153 | # define pMd PRIdMAX | |
154 | # define pMu PRIuMAX | |
155 | #else | |
156 | typedef EMACS_INT printmax_t; | |
157 | typedef EMACS_UINT uprintmax_t; | |
158 | # define pMd pI"d" | |
159 | # define pMu pI"u" | |
160 | #endif | |
161 | ||
9c4c5f81 PE |
162 | /* Use pD to format ptrdiff_t values, which suffice for indexes into |
163 | buffers and strings. Emacs never allocates objects larger than | |
164 | PTRDIFF_MAX bytes, as they cause problems with pointer subtraction. | |
165 | In C99, pD can always be "t"; configure it here for the sake of | |
166 | pre-C99 libraries such as glibc 2.0 and Solaris 8. */ | |
167 | #if PTRDIFF_MAX == INT_MAX | |
168 | # define pD "" | |
169 | #elif PTRDIFF_MAX == LONG_MAX | |
170 | # define pD "l" | |
171 | #elif PTRDIFF_MAX == LLONG_MAX | |
172 | # define pD "ll" | |
173 | #else | |
174 | # define pD "t" | |
175 | #endif | |
176 | ||
e0b8c689 | 177 | /* Extra internal type checking? */ |
c6129d7e | 178 | |
b9ff995e PE |
179 | /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s |
180 | 'assume (COND)'. COND should be free of side effects, as it may or | |
181 | may not be evaluated. | |
182 | ||
183 | 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is | |
184 | defined and suppress_checking is false, and does nothing otherwise. | |
185 | Emacs dies if COND is checked and is false. The suppress_checking | |
186 | variable is initialized to 0 in alloc.c. Set it to 1 using a | |
187 | debugger to temporarily disable aborting on detected internal | |
188 | inconsistencies or error conditions. | |
189 | ||
190 | In some cases, a good compiler may be able to optimize away the | |
191 | eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x) | |
192 | uses eassert to test STRINGP (x), but a particular use of XSTRING | |
193 | is invoked only after testing that STRINGP (x) is true, making the | |
194 | test redundant. | |
195 | ||
196 | eassume is like eassert except that it also causes the compiler to | |
197 | assume that COND is true afterwards, regardless of whether runtime | |
198 | checking is enabled. This can improve performance in some cases, | |
199 | though it can degrade performance in others. It's often suboptimal | |
200 | for COND to call external functions or access volatile storage. */ | |
201 | ||
310fbfa8 | 202 | #ifndef ENABLE_CHECKING |
96c06863 | 203 | # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */ |
b9ff995e | 204 | # define eassume(cond) assume (cond) |
310fbfa8 | 205 | #else /* ENABLE_CHECKING */ |
c6129d7e | 206 | |
845ca893 | 207 | extern _Noreturn void die (const char *, const char *, int); |
244ed907 | 208 | |
fce31d69 | 209 | extern bool suppress_checking EXTERNALLY_VISIBLE; |
244ed907 | 210 | |
310fbfa8 | 211 | # define eassert(cond) \ |
5013fc08 | 212 | (suppress_checking || (cond) \ |
0d5d3029 | 213 | ? (void) 0 \ |
5013fc08 | 214 | : die (# cond, __FILE__, __LINE__)) |
b9ff995e PE |
215 | # define eassume(cond) \ |
216 | (suppress_checking \ | |
217 | ? assume (cond) \ | |
218 | : (cond) \ | |
219 | ? (void) 0 \ | |
220 | : die (# cond, __FILE__, __LINE__)) | |
3694b4ab | 221 | #endif /* ENABLE_CHECKING */ |
3e0b94e7 | 222 | |
b9466edb | 223 | \f |
646b5f55 AS |
224 | /* Use the configure flag --enable-check-lisp-object-type to make |
225 | Lisp_Object use a struct type instead of the default int. The flag | |
226 | causes CHECK_LISP_OBJECT_TYPE to be defined. */ | |
b86cfd28 | 227 | |
b9466edb | 228 | /***** Select the tagging scheme. *****/ |
646b5f55 | 229 | /* The following option controls the tagging scheme: |
b9466edb SM |
230 | - USE_LSB_TAG means that we can assume the least 3 bits of pointers are |
231 | always 0, and we can thus use them to hold tag bits, without | |
232 | restricting our addressing space. | |
233 | ||
bfe3e0a2 PE |
234 | If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus |
235 | restricting our possible address range. | |
b9466edb SM |
236 | |
237 | USE_LSB_TAG not only requires the least 3 bits of pointers returned by | |
238 | malloc to be 0 but also needs to be able to impose a mult-of-8 alignment | |
239 | on the few static Lisp_Objects used: all the defsubr as well | |
240 | as the two special buffers buffer_defaults and buffer_local_symbols. */ | |
241 | ||
4706125e PE |
242 | enum Lisp_Bits |
243 | { | |
244 | /* Number of bits in a Lisp_Object tag. This can be used in #if, | |
245 | and for GDB's sake also as a regular symbol. */ | |
246 | GCTYPEBITS = | |
8c9afb46 | 247 | #define GCTYPEBITS 3 |
4706125e PE |
248 | GCTYPEBITS, |
249 | ||
b6b3b294 PE |
250 | /* 2**GCTYPEBITS. This must be a macro that expands to a literal |
251 | integer constant, for MSVC. */ | |
e32a5799 | 252 | #define GCALIGNMENT 8 |
e32a5799 | 253 | |
4706125e PE |
254 | /* Number of bits in a Lisp_Object value, not counting the tag. */ |
255 | VALBITS = BITS_PER_EMACS_INT - GCTYPEBITS, | |
1781b9e9 | 256 | |
4706125e PE |
257 | /* Number of bits in a Lisp fixnum tag. */ |
258 | INTTYPEBITS = GCTYPEBITS - 1, | |
259 | ||
260 | /* Number of bits in a Lisp fixnum value, not counting the tag. */ | |
261 | FIXNUM_BITS = VALBITS + 1 | |
262 | }; | |
34374650 | 263 | |
e32a5799 PE |
264 | #if GCALIGNMENT != 1 << GCTYPEBITS |
265 | # error "GCALIGNMENT and GCTYPEBITS are inconsistent" | |
266 | #endif | |
267 | ||
34374650 PE |
268 | /* The maximum value that can be stored in a EMACS_INT, assuming all |
269 | bits other than the type bits contribute to a nonnegative signed value. | |
270 | This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */ | |
271 | #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1)) | |
310f5bd4 | 272 | |
bfe3e0a2 PE |
273 | /* Unless otherwise specified, use USE_LSB_TAG on systems where: */ |
274 | #ifndef USE_LSB_TAG | |
275 | /* 1. We know malloc returns a multiple of 8. */ | |
276 | # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \ | |
277 | || defined DARWIN_OS || defined __sun) | |
278 | /* 2. We can specify multiple-of-8 alignment on static variables. */ | |
e32a5799 | 279 | # ifdef alignas |
bfe3e0a2 PE |
280 | /* 3. Pointers-as-ints exceed VAL_MAX. |
281 | On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is: | |
27f3c637 PE |
282 | a. unnecessary, because the top bits of an EMACS_INT are unused, and |
283 | b. slower, because it typically requires extra masking. | |
96c06863 | 284 | So, default USE_LSB_TAG to true only on hosts where it might be useful. */ |
bfe3e0a2 | 285 | # if VAL_MAX < UINTPTR_MAX |
96c06863 | 286 | # define USE_LSB_TAG true |
bfe3e0a2 | 287 | # endif |
310f5bd4 | 288 | # endif |
b9466edb SM |
289 | # endif |
290 | #endif | |
5eceb8fb PE |
291 | #ifdef USE_LSB_TAG |
292 | # undef USE_LSB_TAG | |
96c06863 PE |
293 | enum enum_USE_LSB_TAG { USE_LSB_TAG = true }; |
294 | # define USE_LSB_TAG true | |
5eceb8fb | 295 | #else |
96c06863 PE |
296 | enum enum_USE_LSB_TAG { USE_LSB_TAG = false }; |
297 | # define USE_LSB_TAG false | |
bfe3e0a2 | 298 | #endif |
b9466edb | 299 | |
e32a5799 PE |
300 | #ifndef alignas |
301 | # define alignas(alignment) /* empty */ | |
bfe3e0a2 | 302 | # if USE_LSB_TAG |
e32a5799 | 303 | # error "USE_LSB_TAG requires alignas" |
b9466edb | 304 | # endif |
b9466edb SM |
305 | #endif |
306 | ||
e0b8c689 | 307 | |
84575e67 PE |
308 | /* Some operations are so commonly executed that they are implemented |
309 | as macros, not functions, because otherwise runtime performance would | |
310 | suffer too much when compiling with GCC without optimization. | |
311 | There's no need to inline everything, just the operations that | |
312 | would otherwise cause a serious performance problem. | |
313 | ||
314 | For each such operation OP, define a macro lisp_h_OP that contains | |
5ebb1ee6 | 315 | the operation's implementation. That way, OP can be implemented |
84575e67 PE |
316 | via a macro definition like this: |
317 | ||
318 | #define OP(x) lisp_h_OP (x) | |
319 | ||
320 | and/or via a function definition like this: | |
321 | ||
322 | LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x)) | |
323 | ||
324 | which macro-expands to this: | |
325 | ||
326 | Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); } | |
327 | ||
328 | without worrying about the implementations diverging, since | |
329 | lisp_h_OP defines the actual implementation. The lisp_h_OP macros | |
330 | are intended to be private to this include file, and should not be | |
331 | used elsewhere. | |
332 | ||
333 | FIXME: Remove the lisp_h_OP macros, and define just the inline OP | |
334 | functions, once most developers have access to GCC 4.8 or later and | |
335 | can use "gcc -Og" to debug. Maybe in the year 2016. See | |
336 | Bug#11935. | |
337 | ||
338 | Commentary for these macros can be found near their corresponding | |
339 | functions, below. */ | |
340 | ||
341 | #if CHECK_LISP_OBJECT_TYPE | |
342 | # define lisp_h_XLI(o) ((o).i) | |
343 | # define lisp_h_XIL(i) ((Lisp_Object) { i }) | |
344 | #else | |
345 | # define lisp_h_XLI(o) (o) | |
346 | # define lisp_h_XIL(i) (i) | |
347 | #endif | |
348 | #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y) | |
349 | #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x) | |
350 | #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x) | |
351 | #define lisp_h_CHECK_TYPE(ok, Qxxxp, x) \ | |
352 | ((ok) ? (void) 0 : (void) wrong_type_argument (Qxxxp, x)) | |
353 | #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons) | |
354 | #define lisp_h_EQ(x, y) (XLI (x) == XLI (y)) | |
355 | #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float) | |
356 | #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0) | |
357 | #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker) | |
358 | #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc) | |
359 | #define lisp_h_NILP(x) EQ (x, Qnil) | |
360 | #define lisp_h_SET_SYMBOL_VAL(sym, v) \ | |
361 | (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v)) | |
362 | #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant) | |
363 | #define lisp_h_SYMBOL_VAL(sym) \ | |
364 | (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value) | |
365 | #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol) | |
366 | #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike) | |
367 | #define lisp_h_XCAR(c) XCONS (c)->car | |
368 | #define lisp_h_XCDR(c) XCONS (c)->u.cdr | |
369 | #define lisp_h_XCONS(a) \ | |
370 | (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons)) | |
371 | #define lisp_h_XHASH(a) XUINT (a) | |
372 | #define lisp_h_XPNTR(a) \ | |
13a5993b | 373 | ((void *) (intptr_t) ((XLI (a) & VALMASK) | (DATA_SEG_BITS & ~VALMASK))) |
84575e67 PE |
374 | #define lisp_h_XSYMBOL(a) \ |
375 | (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol)) | |
376 | #ifndef GC_CHECK_CONS_LIST | |
377 | # define lisp_h_check_cons_list() ((void) 0) | |
378 | #endif | |
379 | #if USE_LSB_TAG | |
380 | # define lisp_h_make_number(n) XIL ((EMACS_INT) (n) << INTTYPEBITS) | |
381 | # define lisp_h_XFASTINT(a) XINT (a) | |
382 | # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS) | |
383 | # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK)) | |
384 | # define lisp_h_XUNTAG(a, type) ((void *) (XLI (a) - (type))) | |
385 | #endif | |
386 | ||
387 | /* When compiling via gcc -O0, define the key operations as macros, as | |
388 | Emacs is too slow otherwise. To disable this optimization, compile | |
96c06863 | 389 | with -DINLINING=false. */ |
84575e67 PE |
390 | #if (defined __NO_INLINE__ \ |
391 | && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \ | |
392 | && ! (defined INLINING && ! INLINING)) | |
393 | # define XLI(o) lisp_h_XLI (o) | |
394 | # define XIL(i) lisp_h_XIL (i) | |
395 | # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y) | |
396 | # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x) | |
397 | # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x) | |
398 | # define CHECK_TYPE(ok, Qxxxp, x) lisp_h_CHECK_TYPE (ok, Qxxxp, x) | |
399 | # define CONSP(x) lisp_h_CONSP (x) | |
400 | # define EQ(x, y) lisp_h_EQ (x, y) | |
401 | # define FLOATP(x) lisp_h_FLOATP (x) | |
402 | # define INTEGERP(x) lisp_h_INTEGERP (x) | |
403 | # define MARKERP(x) lisp_h_MARKERP (x) | |
404 | # define MISCP(x) lisp_h_MISCP (x) | |
405 | # define NILP(x) lisp_h_NILP (x) | |
406 | # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v) | |
407 | # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym) | |
408 | # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym) | |
409 | # define SYMBOLP(x) lisp_h_SYMBOLP (x) | |
410 | # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x) | |
411 | # define XCAR(c) lisp_h_XCAR (c) | |
412 | # define XCDR(c) lisp_h_XCDR (c) | |
413 | # define XCONS(a) lisp_h_XCONS (a) | |
414 | # define XHASH(a) lisp_h_XHASH (a) | |
415 | # define XPNTR(a) lisp_h_XPNTR (a) | |
416 | # define XSYMBOL(a) lisp_h_XSYMBOL (a) | |
417 | # ifndef GC_CHECK_CONS_LIST | |
418 | # define check_cons_list() lisp_h_check_cons_list () | |
419 | # endif | |
420 | # if USE_LSB_TAG | |
421 | # define make_number(n) lisp_h_make_number (n) | |
422 | # define XFASTINT(a) lisp_h_XFASTINT (a) | |
423 | # define XINT(a) lisp_h_XINT (a) | |
424 | # define XTYPE(a) lisp_h_XTYPE (a) | |
425 | # define XUNTAG(a, type) lisp_h_XUNTAG (a, type) | |
426 | # endif | |
427 | #endif | |
428 | ||
429 | /* Define NAME as a lisp.h inline function that returns TYPE and has | |
430 | arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and | |
431 | ARGS should be parenthesized. Implement the function by calling | |
432 | lisp_h_NAME ARGS. */ | |
433 | #define LISP_MACRO_DEFUN(name, type, argdecls, args) \ | |
00382e8b | 434 | INLINE type (name) argdecls { return lisp_h_##name args; } |
84575e67 PE |
435 | |
436 | /* like LISP_MACRO_DEFUN, except NAME returns void. */ | |
437 | #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \ | |
00382e8b | 438 | INLINE void (name) argdecls { lisp_h_##name args; } |
84575e67 PE |
439 | |
440 | ||
99a3d506 | 441 | /* Define the fundamental Lisp data structures. */ |
3cfe6dfd | 442 | |
c95a4266 EZ |
443 | /* This is the set of Lisp data types. If you want to define a new |
444 | data type, read the comments after Lisp_Fwd_Type definition | |
445 | below. */ | |
3cfe6dfd | 446 | |
2b570124 PE |
447 | /* Lisp integers use 2 tags, to give them one extra bit, thus |
448 | extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */ | |
eff1c190 | 449 | #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1)) |
2b570124 | 450 | #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1 |
2de9f71c | 451 | |
29abe551 | 452 | /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields, |
91f2d272 PE |
453 | MSVC doesn't support them, and xlc and Oracle Studio c99 complain |
454 | vociferously about them. */ | |
455 | #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \ | |
456 | || (defined __SUNPRO_C && __STDC__)) | |
a6fc3b5c EZ |
457 | #define ENUM_BF(TYPE) unsigned int |
458 | #else | |
459 | #define ENUM_BF(TYPE) enum TYPE | |
460 | #endif | |
461 | ||
462 | ||
3cfe6dfd JB |
463 | enum Lisp_Type |
464 | { | |
99a3d506 | 465 | /* Integer. XINT (obj) is the integer value. */ |
2de9f71c | 466 | Lisp_Int0 = 0, |
d5040d2d | 467 | Lisp_Int1 = USE_LSB_TAG ? 1 << INTTYPEBITS : 1, |
3cfe6dfd | 468 | |
99a3d506 | 469 | /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */ |
2de9f71c | 470 | Lisp_Symbol = 2, |
3cfe6dfd | 471 | |
84d1833e KH |
472 | /* Miscellaneous. XMISC (object) points to a union Lisp_Misc, |
473 | whose first member indicates the subtype. */ | |
2de9f71c | 474 | Lisp_Misc = 3, |
3cfe6dfd JB |
475 | |
476 | /* String. XSTRING (object) points to a struct Lisp_String. | |
99a3d506 | 477 | The length of the string, and its contents, are stored therein. */ |
d5040d2d | 478 | Lisp_String = USE_LSB_TAG ? 1 : 1 << INTTYPEBITS, |
3cfe6dfd | 479 | |
b5088f80 | 480 | /* Vector of Lisp objects, or something resembling it. |
7c06ac2b | 481 | XVECTOR (object) points to a struct Lisp_Vector, which contains |
b5088f80 KH |
482 | the size and contents. The size field also contains the type |
483 | information, if it's not a real vector object. */ | |
2de9f71c | 484 | Lisp_Vectorlike = 5, |
3cfe6dfd | 485 | |
99a3d506 | 486 | /* Cons. XCONS (object) points to a struct Lisp_Cons. */ |
2de9f71c | 487 | Lisp_Cons = 6, |
4d1207f6 | 488 | |
29abe551 | 489 | Lisp_Float = 7 |
3cfe6dfd JB |
490 | }; |
491 | ||
a32fa736 | 492 | /* This is the set of data types that share a common structure. |
c98adc1b KH |
493 | The first member of the structure is a type code from this set. |
494 | The enum values are arbitrary, but we'll use large numbers to make it | |
495 | more likely that we'll spot the error if a random word in memory is | |
496 | mistakenly interpreted as a Lisp_Misc. */ | |
1c4ca5a3 KH |
497 | enum Lisp_Misc_Type |
498 | { | |
c98adc1b | 499 | Lisp_Misc_Free = 0x5eab, |
84d1833e | 500 | Lisp_Misc_Marker, |
99a3d506 | 501 | Lisp_Misc_Overlay, |
222151aa | 502 | Lisp_Misc_Save_Value, |
99a3d506 RS |
503 | /* Currently floats are not a misc type, |
504 | but let's define this in case we want to change that. */ | |
505 | Lisp_Misc_Float, | |
506 | /* This is not a type code. It is for range checking. */ | |
507 | Lisp_Misc_Limit | |
1c4ca5a3 KH |
508 | }; |
509 | ||
ce5b453a SM |
510 | /* These are the types of forwarding objects used in the value slot |
511 | of symbols for special built-in variables whose value is stored in | |
512 | C variables. */ | |
513 | enum Lisp_Fwd_Type | |
514 | { | |
515 | Lisp_Fwd_Int, /* Fwd to a C `int' variable. */ | |
516 | Lisp_Fwd_Bool, /* Fwd to a C boolean var. */ | |
517 | Lisp_Fwd_Obj, /* Fwd to a C Lisp_Object variable. */ | |
518 | Lisp_Fwd_Buffer_Obj, /* Fwd to a Lisp_Object field of buffers. */ | |
29abe551 | 519 | Lisp_Fwd_Kboard_Obj /* Fwd to a Lisp_Object field of kboards. */ |
ce5b453a SM |
520 | }; |
521 | ||
c95a4266 EZ |
522 | /* If you want to define a new Lisp data type, here are some |
523 | instructions. See the thread at | |
524 | http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html | |
525 | for more info. | |
526 | ||
527 | First, there are already a couple of Lisp types that can be used if | |
528 | your new type does not need to be exposed to Lisp programs nor | |
529 | displayed to users. These are Lisp_Save_Value, a Lisp_Misc | |
791ef5f8 | 530 | subtype; and PVEC_OTHER, a kind of vectorlike object. The former |
c95a4266 | 531 | is suitable for temporarily stashing away pointers and integers in |
1396ac86 | 532 | a Lisp object. The latter is useful for vector-like Lisp objects |
c95a4266 EZ |
533 | that need to be used as part of other objects, but which are never |
534 | shown to users or Lisp code (search for PVEC_OTHER in xterm.c for | |
535 | an example). | |
536 | ||
537 | These two types don't look pretty when printed, so they are | |
538 | unsuitable for Lisp objects that can be exposed to users. | |
539 | ||
540 | To define a new data type, add one more Lisp_Misc subtype or one | |
541 | more pseudovector subtype. Pseudovectors are more suitable for | |
542 | objects with several slots that need to support fast random access, | |
791ef5f8 | 543 | while Lisp_Misc types are for everything else. A pseudovector object |
c95a4266 EZ |
544 | provides one or more slots for Lisp objects, followed by struct |
545 | members that are accessible only from C. A Lisp_Misc object is a | |
546 | wrapper for a C struct that can contain anything you like. | |
547 | ||
8847a0de DA |
548 | Explicit freeing is discouraged for Lisp objects in general. But if |
549 | you really need to exploit this, use Lisp_Misc (check free_misc in | |
550 | alloc.c to see why). There is no way to free a vectorlike object. | |
551 | ||
c95a4266 EZ |
552 | To add a new pseudovector type, extend the pvec_type enumeration; |
553 | to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration. | |
554 | ||
555 | For a Lisp_Misc, you will also need to add your entry to union | |
556 | Lisp_Misc (but make sure the first word has the same structure as | |
557 | the others, starting with a 16-bit member of the Lisp_Misc_Type | |
558 | enumeration and a 1-bit GC markbit) and make sure the overall size | |
559 | of the union is not increased by your addition. | |
560 | ||
8847a0de DA |
561 | For a new pseudovector, it's highly desirable to limit the size |
562 | of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c). | |
563 | Otherwise you will need to change sweep_vectors (also in alloc.c). | |
564 | ||
c95a4266 EZ |
565 | Then you will need to add switch branches in print.c (in |
566 | print_object, to print your object, and possibly also in | |
567 | print_preprocess) and to alloc.c, to mark your object (in | |
568 | mark_object) and to free it (in gc_sweep). The latter is also the | |
569 | right place to call any code specific to your data type that needs | |
570 | to run when the object is recycled -- e.g., free any additional | |
571 | resources allocated for it that are not Lisp objects. You can even | |
572 | make a pointer to the function that frees the resources a slot in | |
573 | your object -- this way, the same object could be used to represent | |
574 | several disparate C structures. */ | |
575 | ||
646b5f55 | 576 | #ifdef CHECK_LISP_OBJECT_TYPE |
3cfe6dfd | 577 | |
646b5f55 AS |
578 | typedef struct { EMACS_INT i; } Lisp_Object; |
579 | ||
bfe3e0a2 | 580 | #define LISP_INITIALLY_ZERO {0} |
f3fbd155 | 581 | |
4706125e | 582 | #undef CHECK_LISP_OBJECT_TYPE |
96c06863 | 583 | enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = true }; |
646b5f55 | 584 | #else /* CHECK_LISP_OBJECT_TYPE */ |
3cfe6dfd | 585 | |
646b5f55 | 586 | /* If a struct type is not wanted, define Lisp_Object as just a number. */ |
3cfe6dfd | 587 | |
c003141f | 588 | typedef EMACS_INT Lisp_Object; |
bfe3e0a2 | 589 | #define LISP_INITIALLY_ZERO 0 |
96c06863 | 590 | enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = false }; |
646b5f55 | 591 | #endif /* CHECK_LISP_OBJECT_TYPE */ |
3cfe6dfd | 592 | |
84575e67 PE |
593 | /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa. |
594 | At the machine level, these operations are no-ops. */ | |
595 | LISP_MACRO_DEFUN (XLI, EMACS_INT, (Lisp_Object o), (o)) | |
596 | LISP_MACRO_DEFUN (XIL, Lisp_Object, (EMACS_INT i), (i)) | |
597 | ||
d311d28c | 598 | /* In the size word of a vector, this bit means the vector has been marked. */ |
846d69ac | 599 | |
bba89481 PE |
600 | #define ARRAY_MARK_FLAG_val PTRDIFF_MIN |
601 | #if ENUMABLE (ARRAY_MARK_FLAG_val) | |
602 | DEFINE_GDB_SYMBOL_ENUM (ARRAY_MARK_FLAG) | |
603 | #else | |
bb9937df | 604 | DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG) |
bba89481 | 605 | # define ARRAY_MARK_FLAG ARRAY_MARK_FLAG_val |
bb9937df | 606 | DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG) |
bba89481 | 607 | #endif |
846d69ac | 608 | |
b5088f80 KH |
609 | /* In the size word of a struct Lisp_Vector, this bit means it's really |
610 | some other vector-like object. */ | |
bba89481 PE |
611 | #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2) |
612 | #if ENUMABLE (PSEUDOVECTOR_FLAG_val) | |
613 | DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG) | |
614 | #else | |
bb9937df | 615 | DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG) |
bba89481 | 616 | # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val |
bb9937df | 617 | DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG) |
bba89481 | 618 | #endif |
b5088f80 | 619 | |
303a5c93 | 620 | /* In a pseudovector, the size field actually contains a word with one |
6aea7528 DA |
621 | PSEUDOVECTOR_FLAG bit set, and one of the following values extracted |
622 | with PVEC_TYPE_MASK to indicate the actual type. */ | |
99a3d506 RS |
623 | enum pvec_type |
624 | { | |
6aea7528 | 625 | PVEC_NORMAL_VECTOR, |
ee28be33 SM |
626 | PVEC_FREE, |
627 | PVEC_PROCESS, | |
628 | PVEC_FRAME, | |
629 | PVEC_WINDOW, | |
630 | PVEC_BOOL_VECTOR, | |
631 | PVEC_BUFFER, | |
632 | PVEC_HASH_TABLE, | |
633 | PVEC_TERMINAL, | |
634 | PVEC_WINDOW_CONFIGURATION, | |
635 | PVEC_SUBR, | |
636 | PVEC_OTHER, | |
914adc42 DA |
637 | /* These should be last, check internal_equal to see why. */ |
638 | PVEC_COMPILED, | |
639 | PVEC_CHAR_TABLE, | |
640 | PVEC_SUB_CHAR_TABLE, | |
641 | PVEC_FONT /* Should be last because it's used for range checking. */ | |
99a3d506 | 642 | }; |
b5088f80 | 643 | |
4706125e PE |
644 | /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers |
645 | which were stored in a Lisp_Object. */ | |
646 | #ifndef DATA_SEG_BITS | |
647 | # define DATA_SEG_BITS 0 | |
648 | #endif | |
649 | enum { gdb_DATA_SEG_BITS = DATA_SEG_BITS }; | |
650 | #undef DATA_SEG_BITS | |
651 | ||
652 | enum More_Lisp_Bits | |
1781b9e9 | 653 | { |
4706125e PE |
654 | DATA_SEG_BITS = gdb_DATA_SEG_BITS, |
655 | ||
656 | /* For convenience, we also store the number of elements in these bits. | |
657 | Note that this size is not necessarily the memory-footprint size, but | |
658 | only the number of Lisp_Object fields (that need to be traced by GC). | |
659 | The distinction is used, e.g., by Lisp_Process, which places extra | |
660 | non-Lisp_Object fields at the end of the structure. */ | |
914adc42 | 661 | PSEUDOVECTOR_SIZE_BITS = 12, |
1781b9e9 | 662 | PSEUDOVECTOR_SIZE_MASK = (1 << PSEUDOVECTOR_SIZE_BITS) - 1, |
914adc42 DA |
663 | |
664 | /* To calculate the memory footprint of the pseudovector, it's useful | |
665 | to store the size of non-Lisp area in word_size units here. */ | |
666 | PSEUDOVECTOR_REST_BITS = 12, | |
04a2d0d3 | 667 | PSEUDOVECTOR_REST_MASK = (((1 << PSEUDOVECTOR_REST_BITS) - 1) |
914adc42 DA |
668 | << PSEUDOVECTOR_SIZE_BITS), |
669 | ||
670 | /* Used to extract pseudovector subtype information. */ | |
671 | PSEUDOVECTOR_AREA_BITS = PSEUDOVECTOR_SIZE_BITS + PSEUDOVECTOR_REST_BITS, | |
56a0e352 | 672 | PVEC_TYPE_MASK = 0x3f << PSEUDOVECTOR_AREA_BITS |
4706125e | 673 | }; |
3cfe6dfd | 674 | \f |
84575e67 | 675 | /* These functions extract various sorts of values from a Lisp_Object. |
bb9937df PE |
676 | For example, if tem is a Lisp_Object whose type is Lisp_Cons, |
677 | XCONS (tem) is the struct Lisp_Cons * pointing to the memory for | |
678 | that cons. */ | |
3cfe6dfd | 679 | |
bba89481 PE |
680 | /* Mask for the value (as opposed to the type bits) of a Lisp object. */ |
681 | #define VALMASK_val (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX) | |
682 | #if ENUMABLE (VALMASK_val) | |
683 | DEFINE_GDB_SYMBOL_ENUM (VALMASK) | |
684 | #else | |
bb9937df | 685 | DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT, VALMASK) |
bba89481 | 686 | # define VALMASK VALMASK_val |
bb9937df | 687 | DEFINE_GDB_SYMBOL_END (VALMASK) |
bba89481 | 688 | #endif |
6b61353c | 689 | |
84575e67 PE |
690 | /* Largest and smallest representable fixnum values. These are the C |
691 | values. They are macros for use in static initializers. */ | |
692 | #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS) | |
693 | #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM) | |
6b61353c | 694 | |
84575e67 PE |
695 | /* Extract the pointer hidden within A. */ |
696 | LISP_MACRO_DEFUN (XPNTR, void *, (Lisp_Object a), (a)) | |
6b61353c | 697 | |
84575e67 | 698 | #if USE_LSB_TAG |
6b61353c | 699 | |
84575e67 PE |
700 | LISP_MACRO_DEFUN (make_number, Lisp_Object, (EMACS_INT n), (n)) |
701 | LISP_MACRO_DEFUN (XINT, EMACS_INT, (Lisp_Object a), (a)) | |
702 | LISP_MACRO_DEFUN (XFASTINT, EMACS_INT, (Lisp_Object a), (a)) | |
703 | LISP_MACRO_DEFUN (XTYPE, enum Lisp_Type, (Lisp_Object a), (a)) | |
704 | LISP_MACRO_DEFUN (XUNTAG, void *, (Lisp_Object a, int type), (a, type)) | |
6b61353c | 705 | |
84575e67 | 706 | #else /* ! USE_LSB_TAG */ |
3cfe6dfd | 707 | |
84575e67 PE |
708 | /* Although compiled only if ! USE_LSB_TAG, the following functions |
709 | also work when USE_LSB_TAG; this is to aid future maintenance when | |
710 | the lisp_h_* macros are eventually removed. */ | |
3cfe6dfd | 711 | |
84575e67 PE |
712 | /* Make a Lisp integer representing the value of the low order |
713 | bits of N. */ | |
00382e8b | 714 | INLINE Lisp_Object |
84575e67 PE |
715 | make_number (EMACS_INT n) |
716 | { | |
717 | return XIL (USE_LSB_TAG ? n << INTTYPEBITS : n & INTMASK); | |
718 | } | |
3cfe6dfd | 719 | |
84575e67 | 720 | /* Extract A's value as a signed integer. */ |
00382e8b | 721 | INLINE EMACS_INT |
84575e67 PE |
722 | XINT (Lisp_Object a) |
723 | { | |
724 | EMACS_INT i = XLI (a); | |
725 | return (USE_LSB_TAG ? i : i << INTTYPEBITS) >> INTTYPEBITS; | |
726 | } | |
3cfe6dfd | 727 | |
84575e67 PE |
728 | /* Like XINT (A), but may be faster. A must be nonnegative. |
729 | If ! USE_LSB_TAG, this takes advantage of the fact that Lisp | |
730 | integers have zero-bits in their tags. */ | |
00382e8b | 731 | INLINE EMACS_INT |
84575e67 PE |
732 | XFASTINT (Lisp_Object a) |
733 | { | |
734 | EMACS_INT n = USE_LSB_TAG ? XINT (a) : XLI (a); | |
735 | eassert (0 <= n); | |
736 | return n; | |
737 | } | |
b7acde90 | 738 | |
84575e67 | 739 | /* Extract A's type. */ |
00382e8b | 740 | INLINE enum Lisp_Type |
84575e67 PE |
741 | XTYPE (Lisp_Object a) |
742 | { | |
743 | EMACS_UINT i = XLI (a); | |
744 | return USE_LSB_TAG ? i & ~VALMASK : i >> VALBITS; | |
745 | } | |
b7acde90 | 746 | |
84575e67 | 747 | /* Extract A's pointer value, assuming A's type is TYPE. */ |
00382e8b | 748 | INLINE void * |
84575e67 PE |
749 | XUNTAG (Lisp_Object a, int type) |
750 | { | |
751 | if (USE_LSB_TAG) | |
752 | { | |
753 | intptr_t i = XLI (a) - type; | |
754 | return (void *) i; | |
755 | } | |
756 | return XPNTR (a); | |
757 | } | |
3cfe6dfd | 758 | |
84575e67 | 759 | #endif /* ! USE_LSB_TAG */ |
61ddb1b9 | 760 | |
84575e67 | 761 | /* Extract A's value as an unsigned integer. */ |
00382e8b | 762 | INLINE EMACS_UINT |
84575e67 PE |
763 | XUINT (Lisp_Object a) |
764 | { | |
765 | EMACS_UINT i = XLI (a); | |
766 | return USE_LSB_TAG ? i >> INTTYPEBITS : i & INTMASK; | |
767 | } | |
b349d111 | 768 | |
84575e67 PE |
769 | /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT |
770 | right now, but XUINT should only be applied to objects we know are | |
771 | integers. */ | |
772 | LISP_MACRO_DEFUN (XHASH, EMACS_INT, (Lisp_Object a), (a)) | |
b263a6b0 | 773 | |
84575e67 | 774 | /* Like make_number (N), but may be faster. N must be in nonnegative range. */ |
00382e8b | 775 | INLINE Lisp_Object |
84575e67 PE |
776 | make_natnum (EMACS_INT n) |
777 | { | |
778 | eassert (0 <= n && n <= MOST_POSITIVE_FIXNUM); | |
779 | return USE_LSB_TAG ? make_number (n) : XIL (n); | |
780 | } | |
b9466edb | 781 | |
84575e67 PE |
782 | /* Return true if X and Y are the same object. */ |
783 | LISP_MACRO_DEFUN (EQ, bool, (Lisp_Object x, Lisp_Object y), (x, y)) | |
0de4bb68 | 784 | |
96c06863 | 785 | /* Value is true if I doesn't fit into a Lisp fixnum. It is |
987c9327 | 786 | written this way so that it also works if I is of unsigned |
2e6578fb | 787 | type or if I is a NaN. */ |
dc8e8b07 GM |
788 | |
789 | #define FIXNUM_OVERFLOW_P(i) \ | |
7216e43b | 790 | (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM)) |
dc8e8b07 | 791 | |
00382e8b | 792 | INLINE ptrdiff_t |
d311d28c PE |
793 | clip_to_bounds (ptrdiff_t lower, EMACS_INT num, ptrdiff_t upper) |
794 | { | |
795 | return num < lower ? lower : num <= upper ? num : upper; | |
796 | } | |
84575e67 PE |
797 | \f |
798 | /* Forward declarations. */ | |
799 | ||
800 | /* Defined in this file. */ | |
801 | union Lisp_Fwd; | |
00382e8b PE |
802 | INLINE bool BOOL_VECTOR_P (Lisp_Object); |
803 | INLINE bool BUFFER_OBJFWDP (union Lisp_Fwd *); | |
804 | INLINE bool BUFFERP (Lisp_Object); | |
805 | INLINE bool CHAR_TABLE_P (Lisp_Object); | |
806 | INLINE Lisp_Object CHAR_TABLE_REF_ASCII (Lisp_Object, ptrdiff_t); | |
807 | INLINE bool (CONSP) (Lisp_Object); | |
808 | INLINE bool (FLOATP) (Lisp_Object); | |
809 | INLINE bool functionp (Lisp_Object); | |
810 | INLINE bool (INTEGERP) (Lisp_Object); | |
811 | INLINE bool (MARKERP) (Lisp_Object); | |
812 | INLINE bool (MISCP) (Lisp_Object); | |
813 | INLINE bool (NILP) (Lisp_Object); | |
814 | INLINE bool OVERLAYP (Lisp_Object); | |
815 | INLINE bool PROCESSP (Lisp_Object); | |
816 | INLINE bool PSEUDOVECTORP (Lisp_Object, int); | |
817 | INLINE bool SAVE_VALUEP (Lisp_Object); | |
818 | INLINE void set_sub_char_table_contents (Lisp_Object, ptrdiff_t, | |
84575e67 | 819 | Lisp_Object); |
00382e8b PE |
820 | INLINE bool STRINGP (Lisp_Object); |
821 | INLINE bool SUB_CHAR_TABLE_P (Lisp_Object); | |
822 | INLINE bool SUBRP (Lisp_Object); | |
823 | INLINE bool (SYMBOLP) (Lisp_Object); | |
824 | INLINE bool (VECTORLIKEP) (Lisp_Object); | |
825 | INLINE bool WINDOWP (Lisp_Object); | |
826 | INLINE struct Lisp_Save_Value *XSAVE_VALUE (Lisp_Object); | |
d311d28c | 827 | |
84575e67 PE |
828 | /* Defined in chartab.c. */ |
829 | extern Lisp_Object char_table_ref (Lisp_Object, int); | |
830 | extern void char_table_set (Lisp_Object, int, Lisp_Object); | |
831 | extern int char_table_translate (Lisp_Object, int); | |
832 | ||
833 | /* Defined in data.c. */ | |
834 | extern Lisp_Object Qarrayp, Qbufferp, Qbuffer_or_string_p, Qchar_table_p; | |
835 | extern Lisp_Object Qconsp, Qfloatp, Qintegerp, Qlambda, Qlistp, Qmarkerp, Qnil; | |
df5b4930 | 836 | extern Lisp_Object Qnumberp, Qstringp, Qsymbolp, Qt, Qvectorp; |
3e0b94e7 | 837 | extern Lisp_Object Qbool_vector_p; |
84575e67 | 838 | extern Lisp_Object Qvector_or_char_table_p, Qwholenump; |
8f3a2c26 | 839 | extern Lisp_Object Qwindow; |
84575e67 PE |
840 | extern Lisp_Object Ffboundp (Lisp_Object); |
841 | extern _Noreturn Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object); | |
842 | ||
843 | /* Defined in emacs.c. */ | |
844 | extern bool initialized; | |
845 | ||
846 | /* Defined in eval.c. */ | |
847 | extern Lisp_Object Qautoload; | |
848 | ||
849 | /* Defined in floatfns.c. */ | |
850 | extern double extract_float (Lisp_Object); | |
851 | ||
852 | /* Defined in process.c. */ | |
853 | extern Lisp_Object Qprocessp; | |
854 | ||
855 | /* Defined in window.c. */ | |
856 | extern Lisp_Object Qwindowp; | |
857 | ||
858 | /* Defined in xdisp.c. */ | |
859 | extern Lisp_Object Qimage; | |
7b1123d8 | 860 | \f |
84575e67 | 861 | |
99a3d506 | 862 | /* Extract a value or address from a Lisp_Object. */ |
3cfe6dfd | 863 | |
84575e67 | 864 | LISP_MACRO_DEFUN (XCONS, struct Lisp_Cons *, (Lisp_Object a), (a)) |
7c06ac2b | 865 | |
00382e8b | 866 | INLINE struct Lisp_Vector * |
84575e67 PE |
867 | XVECTOR (Lisp_Object a) |
868 | { | |
869 | eassert (VECTORLIKEP (a)); | |
870 | return XUNTAG (a, Lisp_Vectorlike); | |
871 | } | |
c9f6631c | 872 | |
00382e8b | 873 | INLINE struct Lisp_String * |
84575e67 PE |
874 | XSTRING (Lisp_Object a) |
875 | { | |
876 | eassert (STRINGP (a)); | |
877 | return XUNTAG (a, Lisp_String); | |
878 | } | |
ce5b453a | 879 | |
84575e67 | 880 | LISP_MACRO_DEFUN (XSYMBOL, struct Lisp_Symbol *, (Lisp_Object a), (a)) |
ce5b453a | 881 | |
00382e8b | 882 | INLINE struct Lisp_Float * |
84575e67 PE |
883 | XFLOAT (Lisp_Object a) |
884 | { | |
885 | eassert (FLOATP (a)); | |
886 | return XUNTAG (a, Lisp_Float); | |
887 | } | |
3cfe6dfd | 888 | |
7c06ac2b | 889 | /* Pseudovector types. */ |
84575e67 | 890 | |
00382e8b | 891 | INLINE struct Lisp_Process * |
84575e67 PE |
892 | XPROCESS (Lisp_Object a) |
893 | { | |
894 | eassert (PROCESSP (a)); | |
895 | return XUNTAG (a, Lisp_Vectorlike); | |
896 | } | |
897 | ||
00382e8b | 898 | INLINE struct window * |
84575e67 PE |
899 | XWINDOW (Lisp_Object a) |
900 | { | |
901 | eassert (WINDOWP (a)); | |
902 | return XUNTAG (a, Lisp_Vectorlike); | |
903 | } | |
904 | ||
00382e8b | 905 | INLINE struct terminal * |
84575e67 PE |
906 | XTERMINAL (Lisp_Object a) |
907 | { | |
908 | return XUNTAG (a, Lisp_Vectorlike); | |
909 | } | |
910 | ||
00382e8b | 911 | INLINE struct Lisp_Subr * |
84575e67 PE |
912 | XSUBR (Lisp_Object a) |
913 | { | |
914 | eassert (SUBRP (a)); | |
915 | return XUNTAG (a, Lisp_Vectorlike); | |
916 | } | |
917 | ||
00382e8b | 918 | INLINE struct buffer * |
84575e67 PE |
919 | XBUFFER (Lisp_Object a) |
920 | { | |
921 | eassert (BUFFERP (a)); | |
922 | return XUNTAG (a, Lisp_Vectorlike); | |
923 | } | |
924 | ||
00382e8b | 925 | INLINE struct Lisp_Char_Table * |
84575e67 PE |
926 | XCHAR_TABLE (Lisp_Object a) |
927 | { | |
928 | eassert (CHAR_TABLE_P (a)); | |
929 | return XUNTAG (a, Lisp_Vectorlike); | |
930 | } | |
931 | ||
00382e8b | 932 | INLINE struct Lisp_Sub_Char_Table * |
84575e67 PE |
933 | XSUB_CHAR_TABLE (Lisp_Object a) |
934 | { | |
935 | eassert (SUB_CHAR_TABLE_P (a)); | |
936 | return XUNTAG (a, Lisp_Vectorlike); | |
937 | } | |
938 | ||
00382e8b | 939 | INLINE struct Lisp_Bool_Vector * |
84575e67 PE |
940 | XBOOL_VECTOR (Lisp_Object a) |
941 | { | |
942 | eassert (BOOL_VECTOR_P (a)); | |
943 | return XUNTAG (a, Lisp_Vectorlike); | |
944 | } | |
99a3d506 | 945 | |
99a3d506 | 946 | /* Construct a Lisp_Object from a value or address. */ |
7c06ac2b | 947 | |
00382e8b | 948 | INLINE Lisp_Object |
84575e67 PE |
949 | make_lisp_ptr (void *ptr, enum Lisp_Type type) |
950 | { | |
951 | EMACS_UINT utype = type; | |
952 | EMACS_UINT typebits = USE_LSB_TAG ? type : utype << VALBITS; | |
953 | Lisp_Object a = XIL (typebits | (uintptr_t) ptr); | |
954 | eassert (XTYPE (a) == type && XUNTAG (a, type) == ptr); | |
955 | return a; | |
956 | } | |
957 | ||
00382e8b | 958 | INLINE Lisp_Object |
84575e67 PE |
959 | make_lisp_proc (struct Lisp_Process *p) |
960 | { | |
961 | return make_lisp_ptr (p, Lisp_Vectorlike); | |
962 | } | |
963 | ||
ff55dfe8 | 964 | #define XSETINT(a, b) ((a) = make_number (b)) |
84575e67 | 965 | #define XSETFASTINT(a, b) ((a) = make_natnum (b)) |
ff55dfe8 PE |
966 | #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons)) |
967 | #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike)) | |
968 | #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String)) | |
969 | #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol)) | |
970 | #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float)) | |
ff55dfe8 | 971 | #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc)) |
7c06ac2b RS |
972 | |
973 | /* Pseudovector types. */ | |
c9f6631c | 974 | |
914adc42 DA |
975 | #define XSETPVECTYPE(v, code) \ |
976 | ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS)) | |
977 | #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \ | |
ee28be33 | 978 | ((v)->header.size = (PSEUDOVECTOR_FLAG \ |
914adc42 DA |
979 | | ((code) << PSEUDOVECTOR_AREA_BITS) \ |
980 | | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \ | |
981 | | (lispsize))) | |
aa0b0087 PE |
982 | |
983 | /* The cast to struct vectorlike_header * avoids aliasing issues. */ | |
7c06ac2b | 984 | #define XSETPSEUDOVECTOR(a, b, code) \ |
7555c33f SM |
985 | XSETTYPED_PSEUDOVECTOR (a, b, \ |
986 | (((struct vectorlike_header *) \ | |
987 | XUNTAG (a, Lisp_Vectorlike)) \ | |
988 | ->size), \ | |
989 | code) | |
eab3844f | 990 | #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \ |
beb9f745 | 991 | (XSETVECTOR (a, b), \ |
eab3844f | 992 | eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \ |
914adc42 | 993 | == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS)))) |
aa0b0087 | 994 | |
7c06ac2b RS |
995 | #define XSETWINDOW_CONFIGURATION(a, b) \ |
996 | (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION)) | |
997 | #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS)) | |
998 | #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW)) | |
49e49fb5 | 999 | #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL)) |
914adc42 | 1000 | #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR)) |
7c06ac2b | 1001 | #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED)) |
99a3d506 | 1002 | #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER)) |
608ff985 RS |
1003 | #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE)) |
1004 | #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR)) | |
1842abb2 | 1005 | #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE)) |
c9f6631c | 1006 | |
c8a39089 KS |
1007 | /* Type checking. */ |
1008 | ||
84575e67 PE |
1009 | LISP_MACRO_DEFUN_VOID (CHECK_TYPE, (int ok, Lisp_Object Qxxxp, Lisp_Object x), |
1010 | (ok, Qxxxp, x)) | |
c8a39089 | 1011 | |
c644523b | 1012 | /* Deprecated and will be removed soon. */ |
e34f7f79 DA |
1013 | |
1014 | #define INTERNAL_FIELD(field) field ## _ | |
c8a39089 | 1015 | |
5f6bf5fe | 1016 | /* See the macros in intervals.h. */ |
e221eae3 JA |
1017 | |
1018 | typedef struct interval *INTERVAL; | |
1019 | ||
3cfe6dfd JB |
1020 | struct Lisp_Cons |
1021 | { | |
d8a05828 | 1022 | /* Car of this cons cell. */ |
c644523b | 1023 | Lisp_Object car; |
d8a05828 | 1024 | |
3a623fee AS |
1025 | union |
1026 | { | |
d8a05828 | 1027 | /* Cdr of this cons cell. */ |
c644523b | 1028 | Lisp_Object cdr; |
d8a05828 DA |
1029 | |
1030 | /* Used to chain conses on a free list. */ | |
3a623fee AS |
1031 | struct Lisp_Cons *chain; |
1032 | } u; | |
3cfe6dfd JB |
1033 | }; |
1034 | ||
b7acde90 | 1035 | /* Take the car or cdr of something known to be a cons cell. */ |
84575e67 | 1036 | /* The _addr functions shouldn't be used outside of the minimal set |
f3fbd155 KR |
1037 | of code that has to know what a cons cell looks like. Other code not |
1038 | part of the basic lisp implementation should assume that the car and cdr | |
84575e67 | 1039 | fields are not accessible. (What if we want to switch to |
f3fbd155 KR |
1040 | a copying collector someday? Cached cons cell field addresses may be |
1041 | invalidated at arbitrary points.) */ | |
00382e8b | 1042 | INLINE Lisp_Object * |
84575e67 PE |
1043 | xcar_addr (Lisp_Object c) |
1044 | { | |
1045 | return &XCONS (c)->car; | |
1046 | } | |
00382e8b | 1047 | INLINE Lisp_Object * |
84575e67 PE |
1048 | xcdr_addr (Lisp_Object c) |
1049 | { | |
1050 | return &XCONS (c)->u.cdr; | |
1051 | } | |
b7acde90 | 1052 | |
f3fbd155 | 1053 | /* Use these from normal code. */ |
84575e67 PE |
1054 | LISP_MACRO_DEFUN (XCAR, Lisp_Object, (Lisp_Object c), (c)) |
1055 | LISP_MACRO_DEFUN (XCDR, Lisp_Object, (Lisp_Object c), (c)) | |
f3fbd155 KR |
1056 | |
1057 | /* Use these to set the fields of a cons cell. | |
1058 | ||
1059 | Note that both arguments may refer to the same object, so 'n' | |
84575e67 | 1060 | should not be read after 'c' is first modified. */ |
00382e8b | 1061 | INLINE void |
84575e67 PE |
1062 | XSETCAR (Lisp_Object c, Lisp_Object n) |
1063 | { | |
1064 | *xcar_addr (c) = n; | |
1065 | } | |
00382e8b | 1066 | INLINE void |
84575e67 PE |
1067 | XSETCDR (Lisp_Object c, Lisp_Object n) |
1068 | { | |
1069 | *xcdr_addr (c) = n; | |
1070 | } | |
f3fbd155 | 1071 | |
b7acde90 | 1072 | /* Take the car or cdr of something whose type is not known. */ |
00382e8b | 1073 | INLINE Lisp_Object |
84575e67 PE |
1074 | CAR (Lisp_Object c) |
1075 | { | |
1076 | return (CONSP (c) ? XCAR (c) | |
1077 | : NILP (c) ? Qnil | |
1078 | : wrong_type_argument (Qlistp, c)); | |
1079 | } | |
00382e8b | 1080 | INLINE Lisp_Object |
84575e67 PE |
1081 | CDR (Lisp_Object c) |
1082 | { | |
1083 | return (CONSP (c) ? XCDR (c) | |
1084 | : NILP (c) ? Qnil | |
1085 | : wrong_type_argument (Qlistp, c)); | |
1086 | } | |
b7acde90 | 1087 | |
c8a39089 | 1088 | /* Take the car or cdr of something whose type is not known. */ |
00382e8b | 1089 | INLINE Lisp_Object |
84575e67 PE |
1090 | CAR_SAFE (Lisp_Object c) |
1091 | { | |
1092 | return CONSP (c) ? XCAR (c) : Qnil; | |
1093 | } | |
00382e8b | 1094 | INLINE Lisp_Object |
84575e67 PE |
1095 | CDR_SAFE (Lisp_Object c) |
1096 | { | |
1097 | return CONSP (c) ? XCDR (c) : Qnil; | |
1098 | } | |
35f464a7 | 1099 | |
84575e67 | 1100 | /* In a string or vector, the sign bit of the `size' is the gc mark bit. */ |
35f464a7 | 1101 | |
84575e67 PE |
1102 | struct Lisp_String |
1103 | { | |
1104 | ptrdiff_t size; | |
1105 | ptrdiff_t size_byte; | |
1106 | INTERVAL intervals; /* Text properties in this string. */ | |
1107 | unsigned char *data; | |
1108 | }; | |
d8fc7ce4 | 1109 | |
84575e67 | 1110 | /* True if STR is a multibyte string. */ |
00382e8b | 1111 | INLINE bool |
84575e67 PE |
1112 | STRING_MULTIBYTE (Lisp_Object str) |
1113 | { | |
1114 | return 0 <= XSTRING (str)->size_byte; | |
1115 | } | |
35f464a7 | 1116 | |
c9d624c6 PE |
1117 | /* An upper bound on the number of bytes in a Lisp string, not |
1118 | counting the terminating null. This a tight enough bound to | |
1119 | prevent integer overflow errors that would otherwise occur during | |
1120 | string size calculations. A string cannot contain more bytes than | |
1121 | a fixnum can represent, nor can it be so long that C pointer | |
1122 | arithmetic stops working on the string plus its terminating null. | |
1123 | Although the actual size limit (see STRING_BYTES_MAX in alloc.c) | |
1124 | may be a bit smaller than STRING_BYTES_BOUND, calculating it here | |
1125 | would expose alloc.c internal details that we'd rather keep | |
03a660a6 PE |
1126 | private. |
1127 | ||
7b1123d8 PE |
1128 | This is a macro for use in static initializers. The cast to |
1129 | ptrdiff_t ensures that the macro is signed. */ | |
c9d624c6 | 1130 | #define STRING_BYTES_BOUND \ |
88fb40b4 | 1131 | ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1)) |
d1f3d2af | 1132 | |
491c2516 | 1133 | /* Mark STR as a unibyte string. */ |
96c06863 PE |
1134 | #define STRING_SET_UNIBYTE(STR) \ |
1135 | do { \ | |
1136 | if (EQ (STR, empty_multibyte_string)) \ | |
1137 | (STR) = empty_unibyte_string; \ | |
1138 | else \ | |
1139 | XSTRING (STR)->size_byte = -1; \ | |
1140 | } while (false) | |
491c2516 | 1141 | |
94ef4d69 KH |
1142 | /* Mark STR as a multibyte string. Assure that STR contains only |
1143 | ASCII characters in advance. */ | |
96c06863 PE |
1144 | #define STRING_SET_MULTIBYTE(STR) \ |
1145 | do { \ | |
1146 | if (EQ (STR, empty_unibyte_string)) \ | |
1147 | (STR) = empty_multibyte_string; \ | |
1148 | else \ | |
1149 | XSTRING (STR)->size_byte = XSTRING (STR)->size; \ | |
1150 | } while (false) | |
94ef4d69 | 1151 | |
84575e67 | 1152 | /* Convenience functions for dealing with Lisp strings. */ |
3cfe6dfd | 1153 | |
00382e8b | 1154 | INLINE unsigned char * |
84575e67 PE |
1155 | SDATA (Lisp_Object string) |
1156 | { | |
1157 | return XSTRING (string)->data; | |
1158 | } | |
00382e8b | 1159 | INLINE char * |
84575e67 PE |
1160 | SSDATA (Lisp_Object string) |
1161 | { | |
1162 | /* Avoid "differ in sign" warnings. */ | |
1163 | return (char *) SDATA (string); | |
1164 | } | |
00382e8b | 1165 | INLINE unsigned char |
84575e67 PE |
1166 | SREF (Lisp_Object string, ptrdiff_t index) |
1167 | { | |
1168 | return SDATA (string)[index]; | |
1169 | } | |
00382e8b | 1170 | INLINE void |
84575e67 PE |
1171 | SSET (Lisp_Object string, ptrdiff_t index, unsigned char new) |
1172 | { | |
1173 | SDATA (string)[index] = new; | |
1174 | } | |
00382e8b | 1175 | INLINE ptrdiff_t |
84575e67 PE |
1176 | SCHARS (Lisp_Object string) |
1177 | { | |
1178 | return XSTRING (string)->size; | |
1179 | } | |
fbe9e0b9 PE |
1180 | |
1181 | #ifdef GC_CHECK_STRING_BYTES | |
1182 | extern ptrdiff_t string_bytes (struct Lisp_String *); | |
1183 | #endif | |
00382e8b | 1184 | INLINE ptrdiff_t |
84575e67 PE |
1185 | STRING_BYTES (struct Lisp_String *s) |
1186 | { | |
1187 | #ifdef GC_CHECK_STRING_BYTES | |
84575e67 PE |
1188 | return string_bytes (s); |
1189 | #else | |
1190 | return s->size_byte < 0 ? s->size : s->size_byte; | |
1191 | #endif | |
1192 | } | |
fbe9e0b9 | 1193 | |
00382e8b | 1194 | INLINE ptrdiff_t |
84575e67 PE |
1195 | SBYTES (Lisp_Object string) |
1196 | { | |
1197 | return STRING_BYTES (XSTRING (string)); | |
1198 | } | |
00382e8b | 1199 | INLINE void |
84575e67 PE |
1200 | STRING_SET_CHARS (Lisp_Object string, ptrdiff_t newsize) |
1201 | { | |
1202 | XSTRING (string)->size = newsize; | |
1203 | } | |
00382e8b | 1204 | INLINE void |
84575e67 PE |
1205 | STRING_COPYIN (Lisp_Object string, ptrdiff_t index, char const *new, |
1206 | ptrdiff_t count) | |
1207 | { | |
1208 | memcpy (SDATA (string) + index, new, count); | |
1209 | } | |
3cfe6dfd | 1210 | |
aa0b0087 | 1211 | /* Header of vector-like objects. This documents the layout constraints on |
914adc42 | 1212 | vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents |
84575e67 PE |
1213 | compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR |
1214 | and PSEUDOVECTORP cast their pointers to struct vectorlike_header *, | |
aa0b0087 PE |
1215 | because when two such pointers potentially alias, a compiler won't |
1216 | incorrectly reorder loads and stores to their size fields. See | |
df5b4930 | 1217 | Bug#8546. */ |
b102ceb1 | 1218 | struct vectorlike_header |
3cfe6dfd | 1219 | { |
914adc42 | 1220 | /* The only field contains various pieces of information: |
ee28be33 SM |
1221 | - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit. |
1222 | - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain | |
1223 | vector (0) or a pseudovector (1). | |
1224 | - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number | |
1225 | of slots) of the vector. | |
914adc42 DA |
1226 | - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields: |
1227 | - a) pseudovector subtype held in PVEC_TYPE_MASK field; | |
1228 | - b) number of Lisp_Objects slots at the beginning of the object | |
1229 | held in PSEUDOVECTOR_SIZE_MASK field. These objects are always | |
1230 | traced by the GC; | |
1231 | - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and | |
1232 | measured in word_size units. Rest fields may also include | |
1233 | Lisp_Objects, but these objects usually needs some special treatment | |
1234 | during GC. | |
1235 | There are some exceptions. For PVEC_FREE, b) is always zero. For | |
1236 | PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero. | |
1237 | Current layout limits the pseudovectors to 63 PVEC_xxx subtypes, | |
1238 | 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */ | |
d311d28c | 1239 | ptrdiff_t size; |
eab3844f PE |
1240 | }; |
1241 | ||
91f2d272 | 1242 | /* A regular vector is just a header plus an array of Lisp_Objects. */ |
663e2b3f | 1243 | |
eab3844f PE |
1244 | struct Lisp_Vector |
1245 | { | |
b102ceb1 | 1246 | struct vectorlike_header header; |
91f2d272 PE |
1247 | Lisp_Object contents[FLEXIBLE_ARRAY_MEMBER]; |
1248 | }; | |
0a858ebf | 1249 | |
91f2d272 PE |
1250 | /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */ |
1251 | enum | |
1252 | { | |
1253 | ALIGNOF_STRUCT_LISP_VECTOR | |
1254 | = alignof (union { struct vectorlike_header a; Lisp_Object b; }) | |
3cfe6dfd JB |
1255 | }; |
1256 | ||
91f2d272 | 1257 | /* A boolvector is a kind of vectorlike, with contents like a string. */ |
663e2b3f DA |
1258 | |
1259 | struct Lisp_Bool_Vector | |
1260 | { | |
1261 | /* HEADER.SIZE is the vector's size field. It doesn't have the real size, | |
1262 | just the subtype information. */ | |
1263 | struct vectorlike_header header; | |
1264 | /* This is the size in bits. */ | |
1265 | EMACS_INT size; | |
2cf00efc | 1266 | /* The actual bits, packed into bytes. |
75360f19 | 1267 | Zeros fill out the last word if needed. |
2cf00efc PE |
1268 | The bits are in little-endian order in the bytes, and |
1269 | the bytes are in little-endian order in the words. */ | |
df5b4930 | 1270 | bits_word data[FLEXIBLE_ARRAY_MEMBER]; |
663e2b3f DA |
1271 | }; |
1272 | ||
1c0a7493 PE |
1273 | INLINE EMACS_INT |
1274 | bool_vector_size (Lisp_Object a) | |
1275 | { | |
1276 | EMACS_INT size = XBOOL_VECTOR (a)->size; | |
1277 | eassume (0 <= size); | |
1278 | return size; | |
1279 | } | |
1280 | ||
df5b4930 PE |
1281 | INLINE bits_word * |
1282 | bool_vector_data (Lisp_Object a) | |
1283 | { | |
1284 | return XBOOL_VECTOR (a)->data; | |
1285 | } | |
1286 | ||
1287 | INLINE unsigned char * | |
1288 | bool_vector_uchar_data (Lisp_Object a) | |
1289 | { | |
1290 | return (unsigned char *) bool_vector_data (a); | |
1291 | } | |
1292 | ||
2cf00efc | 1293 | /* The number of data words and bytes in a bool vector with SIZE bits. */ |
df5b4930 PE |
1294 | |
1295 | INLINE EMACS_INT | |
1296 | bool_vector_words (EMACS_INT size) | |
1297 | { | |
1298 | eassume (0 <= size && size <= EMACS_INT_MAX - (BITS_PER_BITS_WORD - 1)); | |
1299 | return (size + BITS_PER_BITS_WORD - 1) / BITS_PER_BITS_WORD; | |
1300 | } | |
1301 | ||
2cf00efc PE |
1302 | INLINE EMACS_INT |
1303 | bool_vector_bytes (EMACS_INT size) | |
1304 | { | |
1305 | eassume (0 <= size && size <= EMACS_INT_MAX - (BITS_PER_BITS_WORD - 1)); | |
1306 | return (size + BOOL_VECTOR_BITS_PER_CHAR - 1) / BOOL_VECTOR_BITS_PER_CHAR; | |
1307 | } | |
1308 | ||
df5b4930 PE |
1309 | /* True if A's Ith bit is set. */ |
1310 | ||
1311 | INLINE bool | |
1312 | bool_vector_bitref (Lisp_Object a, EMACS_INT i) | |
1313 | { | |
1314 | eassume (0 <= i && i < bool_vector_size (a)); | |
1315 | return !! (bool_vector_uchar_data (a)[i / BOOL_VECTOR_BITS_PER_CHAR] | |
1316 | & (1 << (i % BOOL_VECTOR_BITS_PER_CHAR))); | |
1317 | } | |
1318 | ||
1319 | INLINE Lisp_Object | |
1320 | bool_vector_ref (Lisp_Object a, EMACS_INT i) | |
1321 | { | |
1322 | return bool_vector_bitref (a, i) ? Qt : Qnil; | |
1323 | } | |
1324 | ||
1325 | /* Set A's Ith bit to B. */ | |
1326 | ||
1327 | INLINE void | |
1328 | bool_vector_set (Lisp_Object a, EMACS_INT i, bool b) | |
1329 | { | |
1330 | unsigned char *addr; | |
1331 | ||
1332 | eassume (0 <= i && i < bool_vector_size (a)); | |
1333 | addr = &bool_vector_uchar_data (a)[i / BOOL_VECTOR_BITS_PER_CHAR]; | |
1334 | ||
1335 | if (b) | |
1336 | *addr |= 1 << (i % BOOL_VECTOR_BITS_PER_CHAR); | |
1337 | else | |
1338 | *addr &= ~ (1 << (i % BOOL_VECTOR_BITS_PER_CHAR)); | |
1339 | } | |
1340 | ||
663e2b3f DA |
1341 | /* Some handy constants for calculating sizes |
1342 | and offsets, mostly of vectorlike objects. */ | |
1343 | ||
1344 | enum | |
1345 | { | |
91f2d272 | 1346 | header_size = offsetof (struct Lisp_Vector, contents), |
663e2b3f DA |
1347 | bool_header_size = offsetof (struct Lisp_Bool_Vector, data), |
1348 | word_size = sizeof (Lisp_Object) | |
1349 | }; | |
1350 | ||
84575e67 PE |
1351 | /* Conveniences for dealing with Lisp arrays. */ |
1352 | ||
00382e8b | 1353 | INLINE Lisp_Object |
84575e67 PE |
1354 | AREF (Lisp_Object array, ptrdiff_t idx) |
1355 | { | |
91f2d272 | 1356 | return XVECTOR (array)->contents[idx]; |
84575e67 PE |
1357 | } |
1358 | ||
00382e8b | 1359 | INLINE Lisp_Object * |
84575e67 PE |
1360 | aref_addr (Lisp_Object array, ptrdiff_t idx) |
1361 | { | |
91f2d272 | 1362 | return & XVECTOR (array)->contents[idx]; |
84575e67 PE |
1363 | } |
1364 | ||
00382e8b | 1365 | INLINE ptrdiff_t |
84575e67 PE |
1366 | ASIZE (Lisp_Object array) |
1367 | { | |
1368 | return XVECTOR (array)->header.size; | |
1369 | } | |
1370 | ||
00382e8b | 1371 | INLINE void |
84575e67 PE |
1372 | ASET (Lisp_Object array, ptrdiff_t idx, Lisp_Object val) |
1373 | { | |
1374 | eassert (0 <= idx && idx < ASIZE (array)); | |
91f2d272 | 1375 | XVECTOR (array)->contents[idx] = val; |
84575e67 PE |
1376 | } |
1377 | ||
00382e8b | 1378 | INLINE void |
84575e67 PE |
1379 | gc_aset (Lisp_Object array, ptrdiff_t idx, Lisp_Object val) |
1380 | { | |
1381 | /* Like ASET, but also can be used in the garbage collector: | |
1382 | sweep_weak_table calls set_hash_key etc. while the table is marked. */ | |
1383 | eassert (0 <= idx && idx < (ASIZE (array) & ~ARRAY_MARK_FLAG)); | |
91f2d272 | 1384 | XVECTOR (array)->contents[idx] = val; |
84575e67 PE |
1385 | } |
1386 | ||
94225242 | 1387 | /* If a struct is made to look like a vector, this macro returns the length |
4115d3f7 | 1388 | of the shortest vector that would hold that struct. */ |
663e2b3f DA |
1389 | |
1390 | #define VECSIZE(type) \ | |
1391 | ((sizeof (type) - header_size + word_size - 1) / word_size) | |
94225242 | 1392 | |
d0ebe33a SM |
1393 | /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields |
1394 | at the end and we need to compute the number of Lisp_Object fields (the | |
1395 | ones that the GC needs to trace). */ | |
663e2b3f DA |
1396 | |
1397 | #define PSEUDOVECSIZE(type, nonlispfield) \ | |
1398 | ((offsetof (type, nonlispfield) - header_size) / word_size) | |
d0ebe33a | 1399 | |
ea204efb PE |
1400 | /* Compute A OP B, using the unsigned comparison operator OP. A and B |
1401 | should be integer expressions. This is not the same as | |
53964682 | 1402 | mathematical comparison; for example, UNSIGNED_CMP (0, <, -1) |
96c06863 | 1403 | returns true. For efficiency, prefer plain unsigned comparison if A |
ea204efb PE |
1404 | and B's sizes both fit (after integer promotion). */ |
1405 | #define UNSIGNED_CMP(a, op, b) \ | |
1406 | (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \ | |
1407 | ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \ | |
1408 | : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0)) | |
1409 | ||
96c06863 | 1410 | /* True iff C is an ASCII character. */ |
ea204efb | 1411 | #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80) |
15206ed9 | 1412 | |
84575e67 PE |
1413 | /* A char-table is a kind of vectorlike, with contents are like a |
1414 | vector but with a few other slots. For some purposes, it makes | |
1415 | sense to handle a char-table with type struct Lisp_Vector. An | |
1416 | element of a char table can be any Lisp objects, but if it is a sub | |
1417 | char-table, we treat it a table that contains information of a | |
1418 | specific range of characters. A sub char-table has the same | |
1419 | structure as a vector. A sub char table appears only in an element | |
1420 | of a char-table, and there's no way to access it directly from | |
1421 | Emacs Lisp program. */ | |
1842abb2 | 1422 | |
03a660a6 PE |
1423 | enum CHARTAB_SIZE_BITS |
1424 | { | |
1425 | CHARTAB_SIZE_BITS_0 = 6, | |
1426 | CHARTAB_SIZE_BITS_1 = 4, | |
1427 | CHARTAB_SIZE_BITS_2 = 5, | |
1428 | CHARTAB_SIZE_BITS_3 = 7 | |
1429 | }; | |
1842abb2 KH |
1430 | |
1431 | extern const int chartab_size[4]; | |
1432 | ||
608ff985 RS |
1433 | struct Lisp_Char_Table |
1434 | { | |
eab3844f | 1435 | /* HEADER.SIZE is the vector's size field, which also holds the |
608ff985 | 1436 | pseudovector type information. It holds the size, too. |
c73bd236 MB |
1437 | The size counts the defalt, parent, purpose, ascii, |
1438 | contents, and extras slots. */ | |
b102ceb1 | 1439 | struct vectorlike_header header; |
1842abb2 | 1440 | |
608ff985 RS |
1441 | /* This holds a default value, |
1442 | which is used whenever the value for a specific character is nil. */ | |
1443 | Lisp_Object defalt; | |
ea724a01 | 1444 | |
8f924df7 KH |
1445 | /* This points to another char table, which we inherit from when the |
1446 | value for a specific character is nil. The `defalt' slot takes | |
1447 | precedence over this. */ | |
608ff985 | 1448 | Lisp_Object parent; |
1842abb2 | 1449 | |
8f924df7 KH |
1450 | /* This is a symbol which says what kind of use this char-table is |
1451 | meant for. */ | |
7f73dc9d | 1452 | Lisp_Object purpose; |
1842abb2 | 1453 | |
8f924df7 KH |
1454 | /* The bottom sub char-table for characters of the range 0..127. It |
1455 | is nil if none of ASCII character has a specific value. */ | |
1456 | Lisp_Object ascii; | |
1842abb2 | 1457 | |
8f924df7 | 1458 | Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)]; |
1842abb2 | 1459 | |
8f924df7 | 1460 | /* These hold additional data. It is a vector. */ |
fbe9e0b9 | 1461 | Lisp_Object extras[FLEXIBLE_ARRAY_MEMBER]; |
608ff985 RS |
1462 | }; |
1463 | ||
1842abb2 | 1464 | struct Lisp_Sub_Char_Table |
8f924df7 | 1465 | { |
eab3844f | 1466 | /* HEADER.SIZE is the vector's size field, which also holds the |
8f924df7 | 1467 | pseudovector type information. It holds the size, too. */ |
b102ceb1 | 1468 | struct vectorlike_header header; |
1842abb2 | 1469 | |
8f924df7 | 1470 | /* Depth of this sub char-table. It should be 1, 2, or 3. A sub |
78edd3b7 | 1471 | char-table of depth 1 contains 16 elements, and each element |
8f924df7 KH |
1472 | covers 4096 (128*32) characters. A sub char-table of depth 2 |
1473 | contains 32 elements, and each element covers 128 characters. A | |
1474 | sub char-table of depth 3 contains 128 elements, and each element | |
1475 | is for one character. */ | |
1476 | Lisp_Object depth; | |
1842abb2 | 1477 | |
8f924df7 KH |
1478 | /* Minimum character covered by the sub char-table. */ |
1479 | Lisp_Object min_char; | |
1842abb2 | 1480 | |
34dabdb7 | 1481 | /* Use set_sub_char_table_contents to set this. */ |
fbe9e0b9 | 1482 | Lisp_Object contents[FLEXIBLE_ARRAY_MEMBER]; |
8f924df7 | 1483 | }; |
608ff985 | 1484 | |
00382e8b | 1485 | INLINE Lisp_Object |
84575e67 PE |
1486 | CHAR_TABLE_REF_ASCII (Lisp_Object ct, ptrdiff_t idx) |
1487 | { | |
1488 | struct Lisp_Char_Table *tbl = NULL; | |
1489 | Lisp_Object val; | |
1490 | do | |
1491 | { | |
1492 | tbl = tbl ? XCHAR_TABLE (tbl->parent) : XCHAR_TABLE (ct); | |
1493 | val = (! SUB_CHAR_TABLE_P (tbl->ascii) ? tbl->ascii | |
1494 | : XSUB_CHAR_TABLE (tbl->ascii)->contents[idx]); | |
1495 | if (NILP (val)) | |
1496 | val = tbl->defalt; | |
1497 | } | |
1498 | while (NILP (val) && ! NILP (tbl->parent)); | |
1499 | ||
1500 | return val; | |
1501 | } | |
1502 | ||
1503 | /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII | |
1504 | characters. Do not check validity of CT. */ | |
00382e8b | 1505 | INLINE Lisp_Object |
84575e67 PE |
1506 | CHAR_TABLE_REF (Lisp_Object ct, int idx) |
1507 | { | |
1508 | return (ASCII_CHAR_P (idx) | |
1509 | ? CHAR_TABLE_REF_ASCII (ct, idx) | |
1510 | : char_table_ref (ct, idx)); | |
1511 | } | |
1512 | ||
1513 | /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and | |
1514 | 8-bit European characters. Do not check validity of CT. */ | |
00382e8b | 1515 | INLINE void |
84575e67 PE |
1516 | CHAR_TABLE_SET (Lisp_Object ct, int idx, Lisp_Object val) |
1517 | { | |
1518 | if (ASCII_CHAR_P (idx) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct)->ascii)) | |
1519 | set_sub_char_table_contents (XCHAR_TABLE (ct)->ascii, idx, val); | |
1520 | else | |
1521 | char_table_set (ct, idx, val); | |
1522 | } | |
1523 | ||
7c06ac2b RS |
1524 | /* This structure describes a built-in function. |
1525 | It is generated by the DEFUN macro only. | |
914adc42 | 1526 | defsubr makes it into a Lisp object. */ |
e98227af | 1527 | |
3cfe6dfd JB |
1528 | struct Lisp_Subr |
1529 | { | |
914adc42 | 1530 | struct vectorlike_header header; |
c0f2f16b DN |
1531 | union { |
1532 | Lisp_Object (*a0) (void); | |
1533 | Lisp_Object (*a1) (Lisp_Object); | |
1534 | Lisp_Object (*a2) (Lisp_Object, Lisp_Object); | |
1535 | Lisp_Object (*a3) (Lisp_Object, Lisp_Object, Lisp_Object); | |
1536 | Lisp_Object (*a4) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1537 | Lisp_Object (*a5) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1538 | Lisp_Object (*a6) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1539 | Lisp_Object (*a7) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1540 | Lisp_Object (*a8) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
d5273788 | 1541 | Lisp_Object (*aUNEVALLED) (Lisp_Object args); |
f66c7cf8 | 1542 | Lisp_Object (*aMANY) (ptrdiff_t, Lisp_Object *); |
c0f2f16b | 1543 | } function; |
3cfe6dfd | 1544 | short min_args, max_args; |
5e2327cf | 1545 | const char *symbol_name; |
89dc303e DN |
1546 | const char *intspec; |
1547 | const char *doc; | |
3cfe6dfd | 1548 | }; |
5010d3b8 | 1549 | |
03a660a6 PE |
1550 | /* This is the number of slots that every char table must have. This |
1551 | counts the ordinary slots and the top, defalt, parent, and purpose | |
1552 | slots. */ | |
1553 | enum CHAR_TABLE_STANDARD_SLOTS | |
1554 | { | |
fbe9e0b9 | 1555 | CHAR_TABLE_STANDARD_SLOTS = PSEUDOVECSIZE (struct Lisp_Char_Table, extras) |
03a660a6 PE |
1556 | }; |
1557 | ||
1558 | /* Return the number of "extra" slots in the char table CT. */ | |
1559 | ||
00382e8b | 1560 | INLINE int |
84575e67 PE |
1561 | CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table *ct) |
1562 | { | |
1563 | return ((ct->header.size & PSEUDOVECTOR_SIZE_MASK) | |
1564 | - CHAR_TABLE_STANDARD_SLOTS); | |
1565 | } | |
03a660a6 | 1566 | |
5010d3b8 | 1567 | \f |
a32fa736 GM |
1568 | /*********************************************************************** |
1569 | Symbols | |
1570 | ***********************************************************************/ | |
1571 | ||
1572 | /* Interned state of a symbol. */ | |
1573 | ||
1574 | enum symbol_interned | |
1575 | { | |
1576 | SYMBOL_UNINTERNED = 0, | |
1577 | SYMBOL_INTERNED = 1, | |
1578 | SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2 | |
1579 | }; | |
1580 | ||
ce5b453a SM |
1581 | enum symbol_redirect |
1582 | { | |
1583 | SYMBOL_PLAINVAL = 4, | |
1584 | SYMBOL_VARALIAS = 1, | |
1585 | SYMBOL_LOCALIZED = 2, | |
9aba6043 | 1586 | SYMBOL_FORWARDED = 3 |
ce5b453a SM |
1587 | }; |
1588 | ||
a32fa736 GM |
1589 | struct Lisp_Symbol |
1590 | { | |
96c06863 | 1591 | bool_bf gcmarkbit : 1; |
a84f89d5 | 1592 | |
ce5b453a SM |
1593 | /* Indicates where the value can be found: |
1594 | 0 : it's a plain var, the value is in the `value' field. | |
1595 | 1 : it's a varalias, the value is really in the `alias' symbol. | |
1596 | 2 : it's a localized var, the value is in the `blv' object. | |
9aba6043 | 1597 | 3 : it's a forwarding variable, the value is in `forward'. */ |
a6fc3b5c | 1598 | ENUM_BF (symbol_redirect) redirect : 3; |
a32fa736 GM |
1599 | |
1600 | /* Non-zero means symbol is constant, i.e. changing its value | |
ce5b453a SM |
1601 | should signal an error. If the value is 3, then the var |
1602 | can be changed, but only by `defconst'. */ | |
1603 | unsigned constant : 2; | |
a32fa736 GM |
1604 | |
1605 | /* Interned state of the symbol. This is an enumerator from | |
1606 | enum symbol_interned. */ | |
1607 | unsigned interned : 2; | |
1e973bc7 | 1608 | |
96c06863 | 1609 | /* True means that this variable has been explicitly declared |
b9598260 | 1610 | special (with `defvar' etc), and shouldn't be lexically bound. */ |
96c06863 | 1611 | bool_bf declared_special : 1; |
a32fa736 | 1612 | |
e3b83880 SM |
1613 | /* True if pointed to from purespace and hence can't be GC'd. */ |
1614 | bool_bf pinned : 1; | |
1615 | ||
c644523b DA |
1616 | /* The symbol's name, as a Lisp string. */ |
1617 | Lisp_Object name; | |
a32fa736 | 1618 | |
9aba6043 SM |
1619 | /* Value of the symbol or Qunbound if unbound. Which alternative of the |
1620 | union is used depends on the `redirect' field above. */ | |
ce5b453a | 1621 | union { |
c644523b | 1622 | Lisp_Object value; |
ce5b453a SM |
1623 | struct Lisp_Symbol *alias; |
1624 | struct Lisp_Buffer_Local_Value *blv; | |
1625 | union Lisp_Fwd *fwd; | |
1626 | } val; | |
a32fa736 | 1627 | |
eadf1faa | 1628 | /* Function value of the symbol or Qnil if not fboundp. */ |
c644523b | 1629 | Lisp_Object function; |
a32fa736 GM |
1630 | |
1631 | /* The symbol's property list. */ | |
c644523b | 1632 | Lisp_Object plist; |
e2c0561e | 1633 | |
a32fa736 GM |
1634 | /* Next symbol in obarray bucket, if the symbol is interned. */ |
1635 | struct Lisp_Symbol *next; | |
1636 | }; | |
1637 | ||
74d70085 KR |
1638 | /* Value is name of symbol. */ |
1639 | ||
84575e67 | 1640 | LISP_MACRO_DEFUN (SYMBOL_VAL, Lisp_Object, (struct Lisp_Symbol *sym), (sym)) |
ce5b453a | 1641 | |
00382e8b | 1642 | INLINE struct Lisp_Symbol * |
84575e67 PE |
1643 | SYMBOL_ALIAS (struct Lisp_Symbol *sym) |
1644 | { | |
1645 | eassert (sym->redirect == SYMBOL_VARALIAS); | |
1646 | return sym->val.alias; | |
1647 | } | |
00382e8b | 1648 | INLINE struct Lisp_Buffer_Local_Value * |
84575e67 PE |
1649 | SYMBOL_BLV (struct Lisp_Symbol *sym) |
1650 | { | |
1651 | eassert (sym->redirect == SYMBOL_LOCALIZED); | |
1652 | return sym->val.blv; | |
1653 | } | |
00382e8b | 1654 | INLINE union Lisp_Fwd * |
84575e67 PE |
1655 | SYMBOL_FWD (struct Lisp_Symbol *sym) |
1656 | { | |
1657 | eassert (sym->redirect == SYMBOL_FORWARDED); | |
1658 | return sym->val.fwd; | |
1659 | } | |
74d70085 | 1660 | |
84575e67 PE |
1661 | LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL, |
1662 | (struct Lisp_Symbol *sym, Lisp_Object v), (sym, v)) | |
a32fa736 | 1663 | |
00382e8b | 1664 | INLINE void |
84575e67 PE |
1665 | SET_SYMBOL_ALIAS (struct Lisp_Symbol *sym, struct Lisp_Symbol *v) |
1666 | { | |
1667 | eassert (sym->redirect == SYMBOL_VARALIAS); | |
1668 | sym->val.alias = v; | |
1669 | } | |
00382e8b | 1670 | INLINE void |
84575e67 PE |
1671 | SET_SYMBOL_BLV (struct Lisp_Symbol *sym, struct Lisp_Buffer_Local_Value *v) |
1672 | { | |
1673 | eassert (sym->redirect == SYMBOL_LOCALIZED); | |
1674 | sym->val.blv = v; | |
1675 | } | |
00382e8b | 1676 | INLINE void |
84575e67 PE |
1677 | SET_SYMBOL_FWD (struct Lisp_Symbol *sym, union Lisp_Fwd *v) |
1678 | { | |
1679 | eassert (sym->redirect == SYMBOL_FORWARDED); | |
1680 | sym->val.fwd = v; | |
1681 | } | |
1682 | ||
00382e8b | 1683 | INLINE Lisp_Object |
84575e67 PE |
1684 | SYMBOL_NAME (Lisp_Object sym) |
1685 | { | |
1686 | return XSYMBOL (sym)->name; | |
1687 | } | |
1688 | ||
1689 | /* Value is true if SYM is an interned symbol. */ | |
1690 | ||
00382e8b | 1691 | INLINE bool |
84575e67 PE |
1692 | SYMBOL_INTERNED_P (Lisp_Object sym) |
1693 | { | |
1694 | return XSYMBOL (sym)->interned != SYMBOL_UNINTERNED; | |
1695 | } | |
a32fa736 | 1696 | |
84575e67 | 1697 | /* Value is true if SYM is interned in initial_obarray. */ |
a32fa736 | 1698 | |
00382e8b | 1699 | INLINE bool |
84575e67 PE |
1700 | SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym) |
1701 | { | |
1702 | return XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY; | |
1703 | } | |
a32fa736 GM |
1704 | |
1705 | /* Value is non-zero if symbol is considered a constant, i.e. its | |
1706 | value cannot be changed (there is an exception for keyword symbols, | |
1707 | whose value can be set to the keyword symbol itself). */ | |
1708 | ||
84575e67 | 1709 | LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P, int, (Lisp_Object sym), (sym)) |
a32fa736 | 1710 | |
c644523b | 1711 | #define DEFSYM(sym, name) \ |
96c06863 | 1712 | do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false) |
cd3520a4 | 1713 | |
a32fa736 | 1714 | \f |
5010d3b8 GM |
1715 | /*********************************************************************** |
1716 | Hash Tables | |
1717 | ***********************************************************************/ | |
1718 | ||
1719 | /* The structure of a Lisp hash table. */ | |
1720 | ||
b7432bb2 SM |
1721 | struct hash_table_test |
1722 | { | |
1723 | /* Name of the function used to compare keys. */ | |
1724 | Lisp_Object name; | |
1725 | ||
1726 | /* User-supplied hash function, or nil. */ | |
1727 | Lisp_Object user_hash_function; | |
1728 | ||
1729 | /* User-supplied key comparison function, or nil. */ | |
1730 | Lisp_Object user_cmp_function; | |
1731 | ||
1732 | /* C function to compare two keys. */ | |
1733 | bool (*cmpfn) (struct hash_table_test *t, Lisp_Object, Lisp_Object); | |
1734 | ||
1735 | /* C function to compute hash code. */ | |
1736 | EMACS_UINT (*hashfn) (struct hash_table_test *t, Lisp_Object); | |
1737 | }; | |
1738 | ||
5010d3b8 GM |
1739 | struct Lisp_Hash_Table |
1740 | { | |
eab3844f | 1741 | /* This is for Lisp; the hash table code does not refer to it. */ |
b102ceb1 | 1742 | struct vectorlike_header header; |
e2c0561e | 1743 | |
5010d3b8 GM |
1744 | /* Nil if table is non-weak. Otherwise a symbol describing the |
1745 | weakness of the table. */ | |
1746 | Lisp_Object weak; | |
e2c0561e | 1747 | |
5010d3b8 GM |
1748 | /* When the table is resized, and this is an integer, compute the |
1749 | new size by adding this to the old size. If a float, compute the | |
1750 | new size by multiplying the old size with this factor. */ | |
1751 | Lisp_Object rehash_size; | |
1752 | ||
1753 | /* Resize hash table when number of entries/ table size is >= this | |
1754 | ratio, a float. */ | |
1755 | Lisp_Object rehash_threshold; | |
1756 | ||
5833dd93 EZ |
1757 | /* Vector of hash codes. If hash[I] is nil, this means that the |
1758 | I-th entry is unused. */ | |
5010d3b8 GM |
1759 | Lisp_Object hash; |
1760 | ||
1761 | /* Vector used to chain entries. If entry I is free, next[I] is the | |
1762 | entry number of the next free item. If entry I is non-free, | |
1763 | next[I] is the index of the next entry in the collision chain. */ | |
1764 | Lisp_Object next; | |
1765 | ||
1766 | /* Index of first free entry in free list. */ | |
1767 | Lisp_Object next_free; | |
1768 | ||
1769 | /* Bucket vector. A non-nil entry is the index of the first item in | |
1770 | a collision chain. This vector's size can be larger than the | |
1771 | hash table size to reduce collisions. */ | |
1772 | Lisp_Object index; | |
1773 | ||
878f97ff | 1774 | /* Only the fields above are traced normally by the GC. The ones below |
78edd3b7 | 1775 | `count' are special and are either ignored by the GC or traced in |
878f97ff SM |
1776 | a special way (e.g. because of weakness). */ |
1777 | ||
1778 | /* Number of key/value entries in the table. */ | |
d311d28c | 1779 | ptrdiff_t count; |
878f97ff SM |
1780 | |
1781 | /* Vector of keys and values. The key of item I is found at index | |
1782 | 2 * I, the value is found at index 2 * I + 1. | |
1783 | This is gc_marked specially if the table is weak. */ | |
1784 | Lisp_Object key_and_value; | |
1785 | ||
b7432bb2 SM |
1786 | /* The comparison and hash functions. */ |
1787 | struct hash_table_test test; | |
1788 | ||
6c661ec9 SM |
1789 | /* Next weak hash table if this is a weak hash table. The head |
1790 | of the list is in weak_hash_tables. */ | |
1791 | struct Lisp_Hash_Table *next_weak; | |
5010d3b8 GM |
1792 | }; |
1793 | ||
1794 | ||
00382e8b | 1795 | INLINE struct Lisp_Hash_Table * |
84575e67 PE |
1796 | XHASH_TABLE (Lisp_Object a) |
1797 | { | |
1798 | return XUNTAG (a, Lisp_Vectorlike); | |
1799 | } | |
5010d3b8 GM |
1800 | |
1801 | #define XSET_HASH_TABLE(VAR, PTR) \ | |
1802 | (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE)) | |
1803 | ||
00382e8b | 1804 | INLINE bool |
84575e67 PE |
1805 | HASH_TABLE_P (Lisp_Object a) |
1806 | { | |
1807 | return PSEUDOVECTORP (a, PVEC_HASH_TABLE); | |
1808 | } | |
5010d3b8 | 1809 | |
141788b5 | 1810 | /* Value is the key part of entry IDX in hash table H. */ |
00382e8b | 1811 | INLINE Lisp_Object |
84575e67 PE |
1812 | HASH_KEY (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1813 | { | |
1814 | return AREF (h->key_and_value, 2 * idx); | |
1815 | } | |
141788b5 SM |
1816 | |
1817 | /* Value is the value part of entry IDX in hash table H. */ | |
00382e8b | 1818 | INLINE Lisp_Object |
84575e67 PE |
1819 | HASH_VALUE (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1820 | { | |
1821 | return AREF (h->key_and_value, 2 * idx + 1); | |
1822 | } | |
141788b5 SM |
1823 | |
1824 | /* Value is the index of the next entry following the one at IDX | |
1825 | in hash table H. */ | |
00382e8b | 1826 | INLINE Lisp_Object |
84575e67 PE |
1827 | HASH_NEXT (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1828 | { | |
1829 | return AREF (h->next, idx); | |
1830 | } | |
141788b5 SM |
1831 | |
1832 | /* Value is the hash code computed for entry IDX in hash table H. */ | |
00382e8b | 1833 | INLINE Lisp_Object |
84575e67 PE |
1834 | HASH_HASH (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1835 | { | |
1836 | return AREF (h->hash, idx); | |
1837 | } | |
141788b5 SM |
1838 | |
1839 | /* Value is the index of the element in hash table H that is the | |
1840 | start of the collision list at index IDX in the index vector of H. */ | |
00382e8b | 1841 | INLINE Lisp_Object |
84575e67 PE |
1842 | HASH_INDEX (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1843 | { | |
1844 | return AREF (h->index, idx); | |
1845 | } | |
141788b5 SM |
1846 | |
1847 | /* Value is the size of hash table H. */ | |
00382e8b | 1848 | INLINE ptrdiff_t |
84575e67 PE |
1849 | HASH_TABLE_SIZE (struct Lisp_Hash_Table *h) |
1850 | { | |
1851 | return ASIZE (h->next); | |
1852 | } | |
141788b5 | 1853 | |
5010d3b8 GM |
1854 | /* Default size for hash tables if not specified. */ |
1855 | ||
03a660a6 | 1856 | enum DEFAULT_HASH_SIZE { DEFAULT_HASH_SIZE = 65 }; |
5010d3b8 GM |
1857 | |
1858 | /* Default threshold specifying when to resize a hash table. The | |
1859 | value gives the ratio of current entries in the hash table and the | |
1860 | size of the hash table. */ | |
1861 | ||
185ee146 | 1862 | static double const DEFAULT_REHASH_THRESHOLD = 0.8; |
5010d3b8 GM |
1863 | |
1864 | /* Default factor by which to increase the size of a hash table. */ | |
1865 | ||
185ee146 | 1866 | static double const DEFAULT_REHASH_SIZE = 1.5; |
5010d3b8 | 1867 | |
04a2d0d3 PE |
1868 | /* Combine two integers X and Y for hashing. The result might not fit |
1869 | into a Lisp integer. */ | |
1870 | ||
00382e8b | 1871 | INLINE EMACS_UINT |
04a2d0d3 PE |
1872 | sxhash_combine (EMACS_UINT x, EMACS_UINT y) |
1873 | { | |
1874 | return (x << 4) + (x >> (BITS_PER_EMACS_INT - 4)) + y; | |
1875 | } | |
1876 | ||
eff1c190 PE |
1877 | /* Hash X, returning a value that fits into a fixnum. */ |
1878 | ||
00382e8b | 1879 | INLINE EMACS_UINT |
eff1c190 PE |
1880 | SXHASH_REDUCE (EMACS_UINT x) |
1881 | { | |
1882 | return (x ^ x >> (BITS_PER_EMACS_INT - FIXNUM_BITS)) & INTMASK; | |
1883 | } | |
1884 | ||
7c06ac2b RS |
1885 | /* These structures are used for various misc types. */ |
1886 | ||
67ee9f6e SM |
1887 | struct Lisp_Misc_Any /* Supertype of all Misc types. */ |
1888 | { | |
a6fc3b5c | 1889 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_??? */ |
96c06863 | 1890 | bool_bf gcmarkbit : 1; |
91f2d272 | 1891 | unsigned spacer : 15; |
67ee9f6e SM |
1892 | }; |
1893 | ||
3cfe6dfd | 1894 | struct Lisp_Marker |
308e97d0 | 1895 | { |
a6fc3b5c | 1896 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Marker */ |
96c06863 | 1897 | bool_bf gcmarkbit : 1; |
91f2d272 | 1898 | unsigned spacer : 13; |
9bb13d08 KH |
1899 | /* This flag is temporarily used in the functions |
1900 | decode/encode_coding_object to record that the marker position | |
1901 | must be adjusted after the conversion. */ | |
96c06863 PE |
1902 | bool_bf need_adjustment : 1; |
1903 | /* True means normal insertion at the marker's position | |
308e97d0 | 1904 | leaves the marker after the inserted text. */ |
96c06863 | 1905 | bool_bf insertion_type : 1; |
b9466edb SM |
1906 | /* This is the buffer that the marker points into, or 0 if it points nowhere. |
1907 | Note: a chain of markers can contain markers pointing into different | |
1908 | buffers (the chain is per buffer_text rather than per buffer, so it's | |
1909 | shared between indirect buffers). */ | |
1910 | /* This is used for (other than NULL-checking): | |
1911 | - Fmarker_buffer | |
1912 | - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain. | |
1913 | - unchain_marker: to find the list from which to unchain. | |
ce5b453a | 1914 | - Fkill_buffer: to only unchain the markers of current indirect buffer. |
b9466edb | 1915 | */ |
308e97d0 | 1916 | struct buffer *buffer; |
4ed24bf3 RS |
1917 | |
1918 | /* The remaining fields are meaningless in a marker that | |
1919 | does not point anywhere. */ | |
1920 | ||
1921 | /* For markers that point somewhere, | |
1922 | this is used to chain of all the markers in a given buffer. */ | |
d6aa1876 SM |
1923 | /* We could remove it and use an array in buffer_text instead. |
1924 | That would also allow to preserve it ordered. */ | |
c0ac2f4a | 1925 | struct Lisp_Marker *next; |
4ed24bf3 | 1926 | /* This is the char position where the marker points. */ |
d311d28c | 1927 | ptrdiff_t charpos; |
ce5b453a SM |
1928 | /* This is the byte position. |
1929 | It's mostly used as a charpos<->bytepos cache (i.e. it's not directly | |
1930 | used to implement the functionality of markers, but rather to (ab)use | |
1931 | markers as a cache for char<->byte mappings). */ | |
d311d28c | 1932 | ptrdiff_t bytepos; |
308e97d0 | 1933 | }; |
3cfe6dfd | 1934 | |
7555c33f SM |
1935 | /* START and END are markers in the overlay's buffer, and |
1936 | PLIST is the overlay's property list. */ | |
1937 | struct Lisp_Overlay | |
fa691a83 DA |
1938 | /* An overlay's real data content is: |
1939 | - plist | |
1940 | - buffer (really there are two buffer pointers, one per marker, | |
1941 | and both points to the same buffer) | |
1942 | - insertion type of both ends (per-marker fields) | |
1943 | - start & start byte (of start marker) | |
1944 | - end & end byte (of end marker) | |
1945 | - next (singly linked list of overlays) | |
1946 | - next fields of start and end markers (singly linked list of markers). | |
1947 | I.e. 9words plus 2 bits, 3words of which are for external linked lists. | |
1948 | */ | |
7555c33f SM |
1949 | { |
1950 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Overlay */ | |
96c06863 | 1951 | bool_bf gcmarkbit : 1; |
91f2d272 | 1952 | unsigned spacer : 15; |
7555c33f | 1953 | struct Lisp_Overlay *next; |
c644523b DA |
1954 | Lisp_Object start; |
1955 | Lisp_Object end; | |
1956 | Lisp_Object plist; | |
7555c33f SM |
1957 | }; |
1958 | ||
73ebd38f DA |
1959 | /* Types of data which may be saved in a Lisp_Save_Value. */ |
1960 | ||
1961 | enum | |
1962 | { | |
1963 | SAVE_UNUSED, | |
1964 | SAVE_INTEGER, | |
52a9bcae | 1965 | SAVE_FUNCPOINTER, |
73ebd38f DA |
1966 | SAVE_POINTER, |
1967 | SAVE_OBJECT | |
1968 | }; | |
1969 | ||
7b1123d8 | 1970 | /* Number of bits needed to store one of the above values. */ |
52a9bcae | 1971 | enum { SAVE_SLOT_BITS = 3 }; |
7b1123d8 PE |
1972 | |
1973 | /* Number of slots in a save value where save_type is nonzero. */ | |
1974 | enum { SAVE_VALUE_SLOTS = 4 }; | |
1975 | ||
1976 | /* Bit-width and values for struct Lisp_Save_Value's save_type member. */ | |
1977 | ||
1978 | enum { SAVE_TYPE_BITS = SAVE_VALUE_SLOTS * SAVE_SLOT_BITS + 1 }; | |
1979 | ||
1980 | enum Lisp_Save_Type | |
1981 | { | |
1982 | SAVE_TYPE_INT_INT = SAVE_INTEGER + (SAVE_INTEGER << SAVE_SLOT_BITS), | |
1983 | SAVE_TYPE_INT_INT_INT | |
1984 | = (SAVE_INTEGER + (SAVE_TYPE_INT_INT << SAVE_SLOT_BITS)), | |
1985 | SAVE_TYPE_OBJ_OBJ = SAVE_OBJECT + (SAVE_OBJECT << SAVE_SLOT_BITS), | |
1986 | SAVE_TYPE_OBJ_OBJ_OBJ = SAVE_OBJECT + (SAVE_TYPE_OBJ_OBJ << SAVE_SLOT_BITS), | |
1987 | SAVE_TYPE_OBJ_OBJ_OBJ_OBJ | |
1988 | = SAVE_OBJECT + (SAVE_TYPE_OBJ_OBJ_OBJ << SAVE_SLOT_BITS), | |
1989 | SAVE_TYPE_PTR_INT = SAVE_POINTER + (SAVE_INTEGER << SAVE_SLOT_BITS), | |
1990 | SAVE_TYPE_PTR_OBJ = SAVE_POINTER + (SAVE_OBJECT << SAVE_SLOT_BITS), | |
1991 | SAVE_TYPE_PTR_PTR = SAVE_POINTER + (SAVE_POINTER << SAVE_SLOT_BITS), | |
52a9bcae PE |
1992 | SAVE_TYPE_FUNCPTR_PTR_OBJ |
1993 | = SAVE_FUNCPOINTER + (SAVE_TYPE_PTR_OBJ << SAVE_SLOT_BITS), | |
7b1123d8 PE |
1994 | |
1995 | /* This has an extra bit indicating it's raw memory. */ | |
1996 | SAVE_TYPE_MEMORY = SAVE_TYPE_PTR_INT + (1 << (SAVE_TYPE_BITS - 1)) | |
1997 | }; | |
1998 | ||
468afbac DA |
1999 | /* Special object used to hold a different values for later use. |
2000 | ||
2001 | This is mostly used to package C integers and pointers to call | |
27e498e6 | 2002 | record_unwind_protect when two or more values need to be saved. |
1396ac86 | 2003 | For example: |
468afbac DA |
2004 | |
2005 | ... | |
2006 | struct my_data *md = get_my_data (); | |
1396ac86 PE |
2007 | ptrdiff_t mi = get_my_integer (); |
2008 | record_unwind_protect (my_unwind, make_save_ptr_int (md, mi)); | |
468afbac DA |
2009 | ... |
2010 | ||
2011 | Lisp_Object my_unwind (Lisp_Object arg) | |
2012 | { | |
2013 | struct my_data *md = XSAVE_POINTER (arg, 0); | |
1396ac86 | 2014 | ptrdiff_t mi = XSAVE_INTEGER (arg, 1); |
468afbac DA |
2015 | ... |
2016 | } | |
2017 | ||
2018 | If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the | |
2019 | saved objects and raise eassert if type of the saved object doesn't match | |
2020 | the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2) | |
1396ac86 PE |
2021 | and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and |
2022 | slot 0 is a pointer. */ | |
73ebd38f | 2023 | |
52a9bcae PE |
2024 | typedef void (*voidfuncptr) (void); |
2025 | ||
7555c33f SM |
2026 | struct Lisp_Save_Value |
2027 | { | |
2028 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Save_Value */ | |
96c06863 | 2029 | bool_bf gcmarkbit : 1; |
91f2d272 | 2030 | unsigned spacer : 32 - (16 + 1 + SAVE_TYPE_BITS); |
7b1123d8 | 2031 | |
1396ac86 PE |
2032 | /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of |
2033 | V's data entries are determined by V->save_type. E.g., if | |
2034 | V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer, | |
2035 | V->data[1] is an integer, and V's other data entries are unused. | |
7b1123d8 | 2036 | |
1396ac86 PE |
2037 | If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of |
2038 | a memory area containing V->data[1].integer potential Lisp_Objects. */ | |
7b1123d8 | 2039 | ENUM_BF (Lisp_Save_Type) save_type : SAVE_TYPE_BITS; |
73ebd38f DA |
2040 | union { |
2041 | void *pointer; | |
52a9bcae | 2042 | voidfuncptr funcpointer; |
73ebd38f DA |
2043 | ptrdiff_t integer; |
2044 | Lisp_Object object; | |
7b1123d8 | 2045 | } data[SAVE_VALUE_SLOTS]; |
7555c33f SM |
2046 | }; |
2047 | ||
84575e67 | 2048 | /* Return the type of V's Nth saved value. */ |
00382e8b | 2049 | INLINE int |
84575e67 PE |
2050 | save_type (struct Lisp_Save_Value *v, int n) |
2051 | { | |
2052 | eassert (0 <= n && n < SAVE_VALUE_SLOTS); | |
2053 | return (v->save_type >> (SAVE_SLOT_BITS * n) & ((1 << SAVE_SLOT_BITS) - 1)); | |
2054 | } | |
2055 | ||
2056 | /* Get and set the Nth saved pointer. */ | |
2057 | ||
00382e8b | 2058 | INLINE void * |
84575e67 PE |
2059 | XSAVE_POINTER (Lisp_Object obj, int n) |
2060 | { | |
2061 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_POINTER); | |
52a9bcae | 2062 | return XSAVE_VALUE (obj)->data[n].pointer; |
84575e67 | 2063 | } |
00382e8b | 2064 | INLINE void |
84575e67 PE |
2065 | set_save_pointer (Lisp_Object obj, int n, void *val) |
2066 | { | |
2067 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_POINTER); | |
2068 | XSAVE_VALUE (obj)->data[n].pointer = val; | |
2069 | } | |
00382e8b | 2070 | INLINE voidfuncptr |
52a9bcae PE |
2071 | XSAVE_FUNCPOINTER (Lisp_Object obj, int n) |
2072 | { | |
2073 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_FUNCPOINTER); | |
2074 | return XSAVE_VALUE (obj)->data[n].funcpointer; | |
2075 | } | |
84575e67 PE |
2076 | |
2077 | /* Likewise for the saved integer. */ | |
2078 | ||
00382e8b | 2079 | INLINE ptrdiff_t |
84575e67 PE |
2080 | XSAVE_INTEGER (Lisp_Object obj, int n) |
2081 | { | |
2082 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_INTEGER); | |
2083 | return XSAVE_VALUE (obj)->data[n].integer; | |
2084 | } | |
00382e8b | 2085 | INLINE void |
84575e67 PE |
2086 | set_save_integer (Lisp_Object obj, int n, ptrdiff_t val) |
2087 | { | |
2088 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_INTEGER); | |
2089 | XSAVE_VALUE (obj)->data[n].integer = val; | |
2090 | } | |
2091 | ||
2092 | /* Extract Nth saved object. */ | |
2093 | ||
00382e8b | 2094 | INLINE Lisp_Object |
84575e67 PE |
2095 | XSAVE_OBJECT (Lisp_Object obj, int n) |
2096 | { | |
2097 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_OBJECT); | |
2098 | return XSAVE_VALUE (obj)->data[n].object; | |
2099 | } | |
2100 | ||
7555c33f SM |
2101 | /* A miscellaneous object, when it's on the free list. */ |
2102 | struct Lisp_Free | |
2103 | { | |
2104 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Free */ | |
96c06863 | 2105 | bool_bf gcmarkbit : 1; |
91f2d272 | 2106 | unsigned spacer : 15; |
7555c33f SM |
2107 | union Lisp_Misc *chain; |
2108 | }; | |
2109 | ||
2110 | /* To get the type field of a union Lisp_Misc, use XMISCTYPE. | |
2111 | It uses one of these struct subtypes to get the type field. */ | |
2112 | ||
2113 | union Lisp_Misc | |
2114 | { | |
2115 | struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */ | |
2116 | struct Lisp_Free u_free; | |
2117 | struct Lisp_Marker u_marker; | |
2118 | struct Lisp_Overlay u_overlay; | |
2119 | struct Lisp_Save_Value u_save_value; | |
2120 | }; | |
2121 | ||
00382e8b | 2122 | INLINE union Lisp_Misc * |
84575e67 PE |
2123 | XMISC (Lisp_Object a) |
2124 | { | |
2125 | return XUNTAG (a, Lisp_Misc); | |
2126 | } | |
2127 | ||
00382e8b | 2128 | INLINE struct Lisp_Misc_Any * |
84575e67 PE |
2129 | XMISCANY (Lisp_Object a) |
2130 | { | |
2131 | eassert (MISCP (a)); | |
2132 | return & XMISC (a)->u_any; | |
2133 | } | |
2134 | ||
00382e8b | 2135 | INLINE enum Lisp_Misc_Type |
84575e67 PE |
2136 | XMISCTYPE (Lisp_Object a) |
2137 | { | |
2138 | return XMISCANY (a)->type; | |
2139 | } | |
2140 | ||
00382e8b | 2141 | INLINE struct Lisp_Marker * |
84575e67 PE |
2142 | XMARKER (Lisp_Object a) |
2143 | { | |
2144 | eassert (MARKERP (a)); | |
2145 | return & XMISC (a)->u_marker; | |
2146 | } | |
2147 | ||
00382e8b | 2148 | INLINE struct Lisp_Overlay * |
84575e67 PE |
2149 | XOVERLAY (Lisp_Object a) |
2150 | { | |
2151 | eassert (OVERLAYP (a)); | |
2152 | return & XMISC (a)->u_overlay; | |
2153 | } | |
2154 | ||
00382e8b | 2155 | INLINE struct Lisp_Save_Value * |
84575e67 PE |
2156 | XSAVE_VALUE (Lisp_Object a) |
2157 | { | |
2158 | eassert (SAVE_VALUEP (a)); | |
2159 | return & XMISC (a)->u_save_value; | |
2160 | } | |
2161 | \f | |
ee4c9ce4 KH |
2162 | /* Forwarding pointer to an int variable. |
2163 | This is allowed only in the value cell of a symbol, | |
2164 | and it means that the symbol's value really lives in the | |
2165 | specified int variable. */ | |
2166 | struct Lisp_Intfwd | |
84d1833e | 2167 | { |
ce5b453a | 2168 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Int */ |
31ade731 | 2169 | EMACS_INT *intvar; |
ee4c9ce4 KH |
2170 | }; |
2171 | ||
2172 | /* Boolean forwarding pointer to an int variable. | |
2173 | This is like Lisp_Intfwd except that the ostensible | |
96c06863 PE |
2174 | "value" of the symbol is t if the bool variable is true, |
2175 | nil if it is false. */ | |
ee4c9ce4 KH |
2176 | struct Lisp_Boolfwd |
2177 | { | |
ce5b453a | 2178 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Bool */ |
f5d9e83a | 2179 | bool *boolvar; |
ee4c9ce4 KH |
2180 | }; |
2181 | ||
2182 | /* Forwarding pointer to a Lisp_Object variable. | |
2183 | This is allowed only in the value cell of a symbol, | |
2184 | and it means that the symbol's value really lives in the | |
2185 | specified variable. */ | |
2186 | struct Lisp_Objfwd | |
2187 | { | |
ce5b453a | 2188 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Obj */ |
ee4c9ce4 KH |
2189 | Lisp_Object *objvar; |
2190 | }; | |
2191 | ||
2192 | /* Like Lisp_Objfwd except that value lives in a slot in the | |
2193 | current buffer. Value is byte index of slot within buffer. */ | |
2194 | struct Lisp_Buffer_Objfwd | |
2195 | { | |
ce5b453a | 2196 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Buffer_Obj */ |
ee4c9ce4 | 2197 | int offset; |
58cc0a01 DA |
2198 | /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */ |
2199 | Lisp_Object predicate; | |
84d1833e KH |
2200 | }; |
2201 | ||
65d0110b RS |
2202 | /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when |
2203 | the symbol has buffer-local or frame-local bindings. (Exception: | |
2204 | some buffer-local variables are built-in, with their values stored | |
2205 | in the buffer structure itself. They are handled differently, | |
2206 | using struct Lisp_Buffer_Objfwd.) | |
2207 | ||
2208 | The `realvalue' slot holds the variable's current value, or a | |
2209 | forwarding pointer to where that value is kept. This value is the | |
2210 | one that corresponds to the loaded binding. To read or set the | |
2211 | variable, you must first make sure the right binding is loaded; | |
2212 | then you can access the value in (or through) `realvalue'. | |
e2c0561e | 2213 | |
65d0110b RS |
2214 | `buffer' and `frame' are the buffer and frame for which the loaded |
2215 | binding was found. If those have changed, to make sure the right | |
2216 | binding is loaded it is necessary to find which binding goes with | |
2217 | the current buffer and selected frame, then load it. To load it, | |
2218 | first unload the previous binding, then copy the value of the new | |
2219 | binding into `realvalue' (or through it). Also update | |
2220 | LOADED-BINDING to point to the newly loaded binding. | |
7d65f1c2 | 2221 | |
78edd3b7 JB |
2222 | `local_if_set' indicates that merely setting the variable creates a |
2223 | local binding for the current buffer. Otherwise the latter, setting | |
2224 | the variable does not do that; only make-local-variable does that. */ | |
65d0110b | 2225 | |
7d65f1c2 KH |
2226 | struct Lisp_Buffer_Local_Value |
2227 | { | |
96c06863 | 2228 | /* True means that merely setting the variable creates a local |
7555c33f | 2229 | binding for the current buffer. */ |
96c06863 PE |
2230 | bool_bf local_if_set : 1; |
2231 | /* True means this variable can have frame-local bindings, otherwise, it is | |
ce5b453a | 2232 | can have buffer-local bindings. The two cannot be combined. */ |
96c06863 PE |
2233 | bool_bf frame_local : 1; |
2234 | /* True means that the binding now loaded was found. | |
7555c33f | 2235 | Presumably equivalent to (defcell!=valcell). */ |
96c06863 | 2236 | bool_bf found : 1; |
ce5b453a SM |
2237 | /* If non-NULL, a forwarding to the C var where it should also be set. */ |
2238 | union Lisp_Fwd *fwd; /* Should never be (Buffer|Kboard)_Objfwd. */ | |
2239 | /* The buffer or frame for which the loaded binding was found. */ | |
2240 | Lisp_Object where; | |
2241 | /* A cons cell that holds the default value. It has the form | |
2242 | (SYMBOL . DEFAULT-VALUE). */ | |
2243 | Lisp_Object defcell; | |
2244 | /* The cons cell from `where's parameter alist. | |
2245 | It always has the form (SYMBOL . VALUE) | |
2246 | Note that if `forward' is non-nil, VALUE may be out of date. | |
2247 | Also if the currently loaded binding is the default binding, then | |
2248 | this is `eq'ual to defcell. */ | |
2249 | Lisp_Object valcell; | |
7d65f1c2 KH |
2250 | }; |
2251 | ||
f334de0e | 2252 | /* Like Lisp_Objfwd except that value lives in a slot in the |
32462604 KH |
2253 | current kboard. */ |
2254 | struct Lisp_Kboard_Objfwd | |
f334de0e | 2255 | { |
ce5b453a | 2256 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Kboard_Obj */ |
f334de0e KH |
2257 | int offset; |
2258 | }; | |
2259 | ||
ce5b453a SM |
2260 | union Lisp_Fwd |
2261 | { | |
d55c12ed AS |
2262 | struct Lisp_Intfwd u_intfwd; |
2263 | struct Lisp_Boolfwd u_boolfwd; | |
2264 | struct Lisp_Objfwd u_objfwd; | |
2265 | struct Lisp_Buffer_Objfwd u_buffer_objfwd; | |
2266 | struct Lisp_Kboard_Objfwd u_kboard_objfwd; | |
84d1833e | 2267 | }; |
84575e67 | 2268 | |
00382e8b | 2269 | INLINE enum Lisp_Fwd_Type |
84575e67 PE |
2270 | XFWDTYPE (union Lisp_Fwd *a) |
2271 | { | |
2272 | return a->u_intfwd.type; | |
2273 | } | |
2274 | ||
00382e8b | 2275 | INLINE struct Lisp_Buffer_Objfwd * |
84575e67 PE |
2276 | XBUFFER_OBJFWD (union Lisp_Fwd *a) |
2277 | { | |
2278 | eassert (BUFFER_OBJFWDP (a)); | |
2279 | return &a->u_buffer_objfwd; | |
2280 | } | |
7c06ac2b | 2281 | \f |
7555c33f | 2282 | /* Lisp floating point type. */ |
3cfe6dfd JB |
2283 | struct Lisp_Float |
2284 | { | |
3a623fee AS |
2285 | union |
2286 | { | |
3a623fee | 2287 | double data; |
3a623fee AS |
2288 | struct Lisp_Float *chain; |
2289 | } u; | |
3cfe6dfd | 2290 | }; |
8f34f70a | 2291 | |
00382e8b | 2292 | INLINE double |
84575e67 PE |
2293 | XFLOAT_DATA (Lisp_Object f) |
2294 | { | |
2295 | return XFLOAT (f)->u.data; | |
2296 | } | |
3cfe6dfd | 2297 | |
4d7e6e51 PE |
2298 | /* Most hosts nowadays use IEEE floating point, so they use IEC 60559 |
2299 | representations, have infinities and NaNs, and do not trap on | |
2300 | exceptions. Define IEEE_FLOATING_POINT if this host is one of the | |
2301 | typical ones. The C11 macro __STDC_IEC_559__ is close to what is | |
2302 | wanted here, but is not quite right because Emacs does not require | |
2303 | all the features of C11 Annex F (and does not require C11 at all, | |
2304 | for that matter). */ | |
84575e67 PE |
2305 | enum |
2306 | { | |
2307 | IEEE_FLOATING_POINT | |
2308 | = (FLT_RADIX == 2 && FLT_MANT_DIG == 24 | |
2309 | && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128) | |
2310 | }; | |
4d7e6e51 | 2311 | |
3cfe6dfd | 2312 | /* A character, declared with the following typedef, is a member |
99a3d506 | 2313 | of some character set associated with the current buffer. */ |
b2ba7b00 RS |
2314 | #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */ |
2315 | #define _UCHAR_T | |
3cfe6dfd | 2316 | typedef unsigned char UCHAR; |
b2ba7b00 | 2317 | #endif |
3cfe6dfd JB |
2318 | |
2319 | /* Meanings of slots in a Lisp_Compiled: */ | |
2320 | ||
03a660a6 PE |
2321 | enum Lisp_Compiled |
2322 | { | |
2323 | COMPILED_ARGLIST = 0, | |
2324 | COMPILED_BYTECODE = 1, | |
2325 | COMPILED_CONSTANTS = 2, | |
2326 | COMPILED_STACK_DEPTH = 3, | |
2327 | COMPILED_DOC_STRING = 4, | |
2328 | COMPILED_INTERACTIVE = 5 | |
2329 | }; | |
88dbfee5 | 2330 | |
d03f79ef JB |
2331 | /* Flag bits in a character. These also get used in termhooks.h. |
2332 | Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE | |
7c06ac2b RS |
2333 | (MUlti-Lingual Emacs) might need 22 bits for the character value |
2334 | itself, so we probably shouldn't use any bits lower than 0x0400000. */ | |
03a660a6 PE |
2335 | enum char_bits |
2336 | { | |
2337 | CHAR_ALT = 0x0400000, | |
2338 | CHAR_SUPER = 0x0800000, | |
2339 | CHAR_HYPER = 0x1000000, | |
2340 | CHAR_SHIFT = 0x2000000, | |
2341 | CHAR_CTL = 0x4000000, | |
2342 | CHAR_META = 0x8000000, | |
2343 | ||
2344 | CHAR_MODIFIER_MASK = | |
88fb40b4 | 2345 | CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META, |
03a660a6 PE |
2346 | |
2347 | /* Actually, the current Emacs uses 22 bits for the character value | |
2348 | itself. */ | |
2349 | CHARACTERBITS = 22 | |
2350 | }; | |
3cfe6dfd | 2351 | \f |
e7032e7c | 2352 | /* Data type checking. */ |
3cfe6dfd | 2353 | |
84575e67 | 2354 | LISP_MACRO_DEFUN (NILP, bool, (Lisp_Object x), (x)) |
3cfe6dfd | 2355 | |
00382e8b | 2356 | INLINE bool |
84575e67 PE |
2357 | NUMBERP (Lisp_Object x) |
2358 | { | |
2359 | return INTEGERP (x) || FLOATP (x); | |
2360 | } | |
00382e8b | 2361 | INLINE bool |
84575e67 PE |
2362 | NATNUMP (Lisp_Object x) |
2363 | { | |
2364 | return INTEGERP (x) && 0 <= XINT (x); | |
2365 | } | |
2366 | ||
00382e8b | 2367 | INLINE bool |
84575e67 PE |
2368 | RANGED_INTEGERP (intmax_t lo, Lisp_Object x, intmax_t hi) |
2369 | { | |
2370 | return INTEGERP (x) && lo <= XINT (x) && XINT (x) <= hi; | |
2371 | } | |
4746118a | 2372 | |
ca9ce8f2 | 2373 | #define TYPE_RANGED_INTEGERP(type, x) \ |
84575e67 PE |
2374 | (INTEGERP (x) \ |
2375 | && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \ | |
2376 | && XINT (x) <= TYPE_MAXIMUM (type)) | |
2377 | ||
2378 | LISP_MACRO_DEFUN (CONSP, bool, (Lisp_Object x), (x)) | |
2379 | LISP_MACRO_DEFUN (FLOATP, bool, (Lisp_Object x), (x)) | |
2380 | LISP_MACRO_DEFUN (MISCP, bool, (Lisp_Object x), (x)) | |
2381 | LISP_MACRO_DEFUN (SYMBOLP, bool, (Lisp_Object x), (x)) | |
2382 | LISP_MACRO_DEFUN (INTEGERP, bool, (Lisp_Object x), (x)) | |
2383 | LISP_MACRO_DEFUN (VECTORLIKEP, bool, (Lisp_Object x), (x)) | |
2384 | LISP_MACRO_DEFUN (MARKERP, bool, (Lisp_Object x), (x)) | |
2385 | ||
00382e8b | 2386 | INLINE bool |
84575e67 PE |
2387 | STRINGP (Lisp_Object x) |
2388 | { | |
2389 | return XTYPE (x) == Lisp_String; | |
2390 | } | |
00382e8b | 2391 | INLINE bool |
84575e67 PE |
2392 | VECTORP (Lisp_Object x) |
2393 | { | |
2394 | return VECTORLIKEP (x) && ! (ASIZE (x) & PSEUDOVECTOR_FLAG); | |
2395 | } | |
00382e8b | 2396 | INLINE bool |
84575e67 PE |
2397 | OVERLAYP (Lisp_Object x) |
2398 | { | |
2399 | return MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay; | |
2400 | } | |
00382e8b | 2401 | INLINE bool |
84575e67 PE |
2402 | SAVE_VALUEP (Lisp_Object x) |
2403 | { | |
2404 | return MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value; | |
2405 | } | |
2406 | ||
00382e8b | 2407 | INLINE bool |
84575e67 PE |
2408 | AUTOLOADP (Lisp_Object x) |
2409 | { | |
2410 | return CONSP (x) && EQ (Qautoload, XCAR (x)); | |
2411 | } | |
7b1123d8 | 2412 | |
00382e8b | 2413 | INLINE bool |
84575e67 | 2414 | BUFFER_OBJFWDP (union Lisp_Fwd *a) |
7b1123d8 | 2415 | { |
84575e67 | 2416 | return XFWDTYPE (a) == Lisp_Fwd_Buffer_Obj; |
7b1123d8 | 2417 | } |
edfa9106 | 2418 | |
00382e8b | 2419 | INLINE bool |
84575e67 | 2420 | PSEUDOVECTOR_TYPEP (struct vectorlike_header *a, int code) |
717b8bcd | 2421 | { |
84575e67 PE |
2422 | return ((a->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) |
2423 | == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))); | |
717b8bcd SM |
2424 | } |
2425 | ||
84575e67 | 2426 | /* True if A is a pseudovector whose code is CODE. */ |
00382e8b | 2427 | INLINE bool |
84575e67 | 2428 | PSEUDOVECTORP (Lisp_Object a, int code) |
717b8bcd | 2429 | { |
84575e67 | 2430 | if (! VECTORLIKEP (a)) |
96c06863 | 2431 | return false; |
84575e67 PE |
2432 | else |
2433 | { | |
2434 | /* Converting to struct vectorlike_header * avoids aliasing issues. */ | |
2435 | struct vectorlike_header *h = XUNTAG (a, Lisp_Vectorlike); | |
2436 | return PSEUDOVECTOR_TYPEP (h, code); | |
2437 | } | |
717b8bcd SM |
2438 | } |
2439 | ||
717b8bcd | 2440 | |
84575e67 PE |
2441 | /* Test for specific pseudovector types. */ |
2442 | ||
00382e8b | 2443 | INLINE bool |
84575e67 | 2444 | WINDOW_CONFIGURATIONP (Lisp_Object a) |
717b8bcd | 2445 | { |
84575e67 | 2446 | return PSEUDOVECTORP (a, PVEC_WINDOW_CONFIGURATION); |
717b8bcd | 2447 | } |
84575e67 | 2448 | |
00382e8b | 2449 | INLINE bool |
84575e67 | 2450 | PROCESSP (Lisp_Object a) |
717b8bcd | 2451 | { |
84575e67 | 2452 | return PSEUDOVECTORP (a, PVEC_PROCESS); |
717b8bcd SM |
2453 | } |
2454 | ||
00382e8b | 2455 | INLINE bool |
84575e67 | 2456 | WINDOWP (Lisp_Object a) |
717b8bcd | 2457 | { |
84575e67 | 2458 | return PSEUDOVECTORP (a, PVEC_WINDOW); |
717b8bcd | 2459 | } |
84575e67 | 2460 | |
00382e8b | 2461 | INLINE bool |
84575e67 | 2462 | TERMINALP (Lisp_Object a) |
717b8bcd | 2463 | { |
84575e67 | 2464 | return PSEUDOVECTORP (a, PVEC_TERMINAL); |
717b8bcd SM |
2465 | } |
2466 | ||
00382e8b | 2467 | INLINE bool |
84575e67 | 2468 | SUBRP (Lisp_Object a) |
717b8bcd | 2469 | { |
84575e67 | 2470 | return PSEUDOVECTORP (a, PVEC_SUBR); |
717b8bcd SM |
2471 | } |
2472 | ||
00382e8b | 2473 | INLINE bool |
84575e67 PE |
2474 | COMPILEDP (Lisp_Object a) |
2475 | { | |
2476 | return PSEUDOVECTORP (a, PVEC_COMPILED); | |
2477 | } | |
32e5c58c | 2478 | |
00382e8b | 2479 | INLINE bool |
84575e67 PE |
2480 | BUFFERP (Lisp_Object a) |
2481 | { | |
2482 | return PSEUDOVECTORP (a, PVEC_BUFFER); | |
2483 | } | |
7c06ac2b | 2484 | |
00382e8b | 2485 | INLINE bool |
84575e67 PE |
2486 | CHAR_TABLE_P (Lisp_Object a) |
2487 | { | |
2488 | return PSEUDOVECTORP (a, PVEC_CHAR_TABLE); | |
2489 | } | |
ee28be33 | 2490 | |
00382e8b | 2491 | INLINE bool |
84575e67 PE |
2492 | SUB_CHAR_TABLE_P (Lisp_Object a) |
2493 | { | |
2494 | return PSEUDOVECTORP (a, PVEC_SUB_CHAR_TABLE); | |
2495 | } | |
eab3844f | 2496 | |
00382e8b | 2497 | INLINE bool |
84575e67 PE |
2498 | BOOL_VECTOR_P (Lisp_Object a) |
2499 | { | |
2500 | return PSEUDOVECTORP (a, PVEC_BOOL_VECTOR); | |
2501 | } | |
7c06ac2b | 2502 | |
00382e8b | 2503 | INLINE bool |
84575e67 PE |
2504 | FRAMEP (Lisp_Object a) |
2505 | { | |
2506 | return PSEUDOVECTORP (a, PVEC_FRAME); | |
2507 | } | |
ea724a01 | 2508 | |
6b61353c | 2509 | /* Test for image (image . spec) */ |
00382e8b | 2510 | INLINE bool |
84575e67 PE |
2511 | IMAGEP (Lisp_Object x) |
2512 | { | |
2513 | return CONSP (x) && EQ (XCAR (x), Qimage); | |
2514 | } | |
6b61353c | 2515 | |
c8a39089 | 2516 | /* Array types. */ |
00382e8b | 2517 | INLINE bool |
84575e67 PE |
2518 | ARRAYP (Lisp_Object x) |
2519 | { | |
2520 | return VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x); | |
2521 | } | |
7c06ac2b | 2522 | \f |
00382e8b | 2523 | INLINE void |
84575e67 PE |
2524 | CHECK_LIST (Lisp_Object x) |
2525 | { | |
2526 | CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x); | |
2527 | } | |
3cfe6dfd | 2528 | |
84575e67 PE |
2529 | LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS, (Lisp_Object x, Lisp_Object y), (x, y)) |
2530 | LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL, (Lisp_Object x), (x)) | |
2531 | LISP_MACRO_DEFUN_VOID (CHECK_NUMBER, (Lisp_Object x), (x)) | |
3cfe6dfd | 2532 | |
00382e8b | 2533 | INLINE void |
84575e67 PE |
2534 | CHECK_STRING (Lisp_Object x) |
2535 | { | |
2536 | CHECK_TYPE (STRINGP (x), Qstringp, x); | |
2537 | } | |
00382e8b | 2538 | INLINE void |
84575e67 PE |
2539 | CHECK_STRING_CAR (Lisp_Object x) |
2540 | { | |
2541 | CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x)); | |
2542 | } | |
00382e8b | 2543 | INLINE void |
84575e67 PE |
2544 | CHECK_CONS (Lisp_Object x) |
2545 | { | |
2546 | CHECK_TYPE (CONSP (x), Qconsp, x); | |
2547 | } | |
00382e8b | 2548 | INLINE void |
84575e67 PE |
2549 | CHECK_VECTOR (Lisp_Object x) |
2550 | { | |
2551 | CHECK_TYPE (VECTORP (x), Qvectorp, x); | |
2552 | } | |
00382e8b | 2553 | INLINE void |
3e0b94e7 DC |
2554 | CHECK_BOOL_VECTOR (Lisp_Object x) |
2555 | { | |
2556 | CHECK_TYPE (BOOL_VECTOR_P (x), Qbool_vector_p, x); | |
2557 | } | |
2558 | INLINE void | |
84575e67 PE |
2559 | CHECK_VECTOR_OR_STRING (Lisp_Object x) |
2560 | { | |
2561 | CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x); | |
2562 | } | |
00382e8b | 2563 | INLINE void |
84575e67 PE |
2564 | CHECK_ARRAY (Lisp_Object x, Lisp_Object Qxxxp) |
2565 | { | |
2566 | CHECK_TYPE (ARRAYP (x), Qxxxp, x); | |
2567 | } | |
00382e8b | 2568 | INLINE void |
84575e67 PE |
2569 | CHECK_BUFFER (Lisp_Object x) |
2570 | { | |
2571 | CHECK_TYPE (BUFFERP (x), Qbufferp, x); | |
2572 | } | |
00382e8b | 2573 | INLINE void |
84575e67 PE |
2574 | CHECK_WINDOW (Lisp_Object x) |
2575 | { | |
2576 | CHECK_TYPE (WINDOWP (x), Qwindowp, x); | |
2577 | } | |
bf6b4923 | 2578 | #ifdef subprocesses |
00382e8b | 2579 | INLINE void |
84575e67 PE |
2580 | CHECK_PROCESS (Lisp_Object x) |
2581 | { | |
2582 | CHECK_TYPE (PROCESSP (x), Qprocessp, x); | |
2583 | } | |
bf6b4923 | 2584 | #endif |
00382e8b | 2585 | INLINE void |
84575e67 PE |
2586 | CHECK_NATNUM (Lisp_Object x) |
2587 | { | |
2588 | CHECK_TYPE (NATNUMP (x), Qwholenump, x); | |
2589 | } | |
3cfe6dfd | 2590 | |
af5a5a98 | 2591 | #define CHECK_RANGED_INTEGER(x, lo, hi) \ |
d311d28c PE |
2592 | do { \ |
2593 | CHECK_NUMBER (x); \ | |
2594 | if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \ | |
2595 | args_out_of_range_3 \ | |
2596 | (x, \ | |
2597 | make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \ | |
2598 | ? MOST_NEGATIVE_FIXNUM \ | |
2599 | : (lo)), \ | |
2600 | make_number (min (hi, MOST_POSITIVE_FIXNUM))); \ | |
96c06863 | 2601 | } while (false) |
d311d28c PE |
2602 | #define CHECK_TYPE_RANGED_INTEGER(type, x) \ |
2603 | do { \ | |
2604 | if (TYPE_SIGNED (type)) \ | |
af5a5a98 | 2605 | CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \ |
d311d28c | 2606 | else \ |
af5a5a98 | 2607 | CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \ |
96c06863 | 2608 | } while (false) |
d311d28c | 2609 | |
96c06863 PE |
2610 | #define CHECK_NUMBER_COERCE_MARKER(x) \ |
2611 | do { \ | |
2612 | if (MARKERP ((x))) \ | |
2613 | XSETFASTINT (x, marker_position (x)); \ | |
2614 | else \ | |
2615 | CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \ | |
2616 | } while (false) | |
3cfe6dfd | 2617 | |
00382e8b | 2618 | INLINE double |
84575e67 PE |
2619 | XFLOATINT (Lisp_Object n) |
2620 | { | |
2621 | return extract_float (n); | |
2622 | } | |
3cfe6dfd | 2623 | |
00382e8b | 2624 | INLINE void |
84575e67 PE |
2625 | CHECK_NUMBER_OR_FLOAT (Lisp_Object x) |
2626 | { | |
2627 | CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x); | |
2628 | } | |
3cfe6dfd | 2629 | |
96c06863 PE |
2630 | #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \ |
2631 | do { \ | |
2632 | if (MARKERP (x)) \ | |
2633 | XSETFASTINT (x, marker_position (x)); \ | |
2634 | else \ | |
2635 | CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \ | |
2636 | } while (false) | |
3cfe6dfd | 2637 | |
f3fbd155 KR |
2638 | /* Since we can't assign directly to the CAR or CDR fields of a cons |
2639 | cell, use these when checking that those fields contain numbers. */ | |
00382e8b | 2640 | INLINE void |
84575e67 PE |
2641 | CHECK_NUMBER_CAR (Lisp_Object x) |
2642 | { | |
2643 | Lisp_Object tmp = XCAR (x); | |
2644 | CHECK_NUMBER (tmp); | |
2645 | XSETCAR (x, tmp); | |
2646 | } | |
8f924df7 | 2647 | |
00382e8b | 2648 | INLINE void |
84575e67 PE |
2649 | CHECK_NUMBER_CDR (Lisp_Object x) |
2650 | { | |
2651 | Lisp_Object tmp = XCDR (x); | |
2652 | CHECK_NUMBER (tmp); | |
2653 | XSETCDR (x, tmp); | |
2654 | } | |
3cfe6dfd JB |
2655 | \f |
2656 | /* Define a built-in function for calling from Lisp. | |
2657 | `lname' should be the name to give the function in Lisp, | |
2658 | as a null-terminated C string. | |
2659 | `fnname' should be the name of the function in C. | |
2660 | By convention, it starts with F. | |
2661 | `sname' should be the name for the C constant structure | |
2662 | that records information on this function for internal use. | |
2663 | By convention, it should be the same as `fnname' but with S instead of F. | |
2664 | It's too bad that C macros can't compute this from `fnname'. | |
2665 | `minargs' should be a number, the minimum number of arguments allowed. | |
2666 | `maxargs' should be a number, the maximum number of arguments allowed, | |
2667 | or else MANY or UNEVALLED. | |
2668 | MANY means pass a vector of evaluated arguments, | |
2669 | in the form of an integer number-of-arguments | |
2670 | followed by the address of a vector of Lisp_Objects | |
2671 | which contains the argument values. | |
2672 | UNEVALLED means pass the list of unevaluated arguments | |
4bca9161 MC |
2673 | `intspec' says how interactive arguments are to be fetched. |
2674 | If the string starts with a `(', `intspec' is evaluated and the resulting | |
2675 | list is the list of arguments. | |
2676 | If it's a string that doesn't start with `(', the value should follow | |
2677 | the one of the doc string for `interactive'. | |
3cfe6dfd | 2678 | A null string means call interactively with no arguments. |
eab9d423 | 2679 | `doc' is documentation for the user. */ |
3cfe6dfd | 2680 | |
c451d7b1 | 2681 | /* This version of DEFUN declares a function prototype with the right |
99a3d506 | 2682 | arguments, so we can catch errors with maxargs at compile-time. */ |
a6fc3b5c EZ |
2683 | #ifdef _MSC_VER |
2684 | #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \ | |
2685 | Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \ | |
e32a5799 | 2686 | static struct Lisp_Subr alignas (GCALIGNMENT) sname = \ |
914adc42 DA |
2687 | { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \ |
2688 | | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \ | |
a6fc3b5c EZ |
2689 | { (Lisp_Object (__cdecl *)(void))fnname }, \ |
2690 | minargs, maxargs, lname, intspec, 0}; \ | |
2691 | Lisp_Object fnname | |
2692 | #else /* not _MSC_VER */ | |
29abe551 PE |
2693 | # if __STDC_VERSION__ < 199901 |
2694 | # define DEFUN_FUNCTION_INIT(fnname, maxargs) (Lisp_Object (*) (void)) fnname | |
2695 | # else | |
2696 | # define DEFUN_FUNCTION_INIT(fnname, maxargs) .a ## maxargs = fnname | |
2697 | # endif | |
a6fc3b5c EZ |
2698 | #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \ |
2699 | Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \ | |
e32a5799 | 2700 | static struct Lisp_Subr alignas (GCALIGNMENT) sname = \ |
914adc42 | 2701 | { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \ |
29abe551 | 2702 | { DEFUN_FUNCTION_INIT (fnname, maxargs) }, \ |
a6fc3b5c EZ |
2703 | minargs, maxargs, lname, intspec, 0}; \ |
2704 | Lisp_Object fnname | |
2705 | #endif | |
c451d7b1 RS |
2706 | |
2707 | /* Note that the weird token-substitution semantics of ANSI C makes | |
99a3d506 | 2708 | this work for MANY and UNEVALLED. */ |
f66c7cf8 | 2709 | #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *) |
c451d7b1 RS |
2710 | #define DEFUN_ARGS_UNEVALLED (Lisp_Object) |
2711 | #define DEFUN_ARGS_0 (void) | |
2712 | #define DEFUN_ARGS_1 (Lisp_Object) | |
2713 | #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object) | |
2714 | #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object) | |
2715 | #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object) | |
2716 | #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ | |
2717 | Lisp_Object) | |
2718 | #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ | |
2719 | Lisp_Object, Lisp_Object) | |
2720 | #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ | |
2721 | Lisp_Object, Lisp_Object, Lisp_Object) | |
5593f7e3 KH |
2722 | #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ |
2723 | Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object) | |
276680c4 | 2724 | |
84575e67 | 2725 | /* True if OBJ is a Lisp function. */ |
00382e8b | 2726 | INLINE bool |
84575e67 PE |
2727 | FUNCTIONP (Lisp_Object obj) |
2728 | { | |
2729 | return functionp (obj); | |
2730 | } | |
e2c0561e | 2731 | |
3cfe6dfd | 2732 | /* defsubr (Sname); |
d19b9aa8 | 2733 | is how we define the symbol for function `name' at start-up time. */ |
383e0970 | 2734 | extern void defsubr (struct Lisp_Subr *); |
3cfe6dfd | 2735 | |
03a660a6 PE |
2736 | enum maxargs |
2737 | { | |
2738 | MANY = -2, | |
2739 | UNEVALLED = -1 | |
2740 | }; | |
3cfe6dfd | 2741 | |
ce5b453a SM |
2742 | extern void defvar_lisp (struct Lisp_Objfwd *, const char *, Lisp_Object *); |
2743 | extern void defvar_lisp_nopro (struct Lisp_Objfwd *, const char *, Lisp_Object *); | |
f5d9e83a | 2744 | extern void defvar_bool (struct Lisp_Boolfwd *, const char *, bool *); |
ce5b453a SM |
2745 | extern void defvar_int (struct Lisp_Intfwd *, const char *, EMACS_INT *); |
2746 | extern void defvar_kboard (struct Lisp_Kboard_Objfwd *, const char *, int); | |
3cfe6dfd JB |
2747 | |
2748 | /* Macros we use to define forwarded Lisp variables. | |
29208e82 | 2749 | These are used in the syms_of_FILENAME functions. |
51b59d79 | 2750 | |
29208e82 TT |
2751 | An ordinary (not in buffer_defaults, per-buffer, or per-keyboard) |
2752 | lisp variable is actually a field in `struct emacs_globals'. The | |
2753 | field's name begins with "f_", which is a convention enforced by | |
2754 | these macros. Each such global has a corresponding #define in | |
2755 | globals.h; the plain name should be used in the code. | |
2756 | ||
2757 | E.g., the global "cons_cells_consed" is declared as "int | |
2758 | f_cons_cells_consed" in globals.h, but there is a define: | |
2759 | ||
2760 | #define cons_cells_consed globals.f_cons_cells_consed | |
2761 | ||
2762 | All C code uses the `cons_cells_consed' name. This is all done | |
2763 | this way to support indirection for multi-threaded Emacs. */ | |
3cfe6dfd | 2764 | |
ce5b453a SM |
2765 | #define DEFVAR_LISP(lname, vname, doc) \ |
2766 | do { \ | |
2767 | static struct Lisp_Objfwd o_fwd; \ | |
29208e82 | 2768 | defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \ |
96c06863 | 2769 | } while (false) |
ce5b453a SM |
2770 | #define DEFVAR_LISP_NOPRO(lname, vname, doc) \ |
2771 | do { \ | |
2772 | static struct Lisp_Objfwd o_fwd; \ | |
29208e82 | 2773 | defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \ |
96c06863 | 2774 | } while (false) |
ce5b453a SM |
2775 | #define DEFVAR_BOOL(lname, vname, doc) \ |
2776 | do { \ | |
2777 | static struct Lisp_Boolfwd b_fwd; \ | |
29208e82 | 2778 | defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \ |
96c06863 | 2779 | } while (false) |
ce5b453a SM |
2780 | #define DEFVAR_INT(lname, vname, doc) \ |
2781 | do { \ | |
2782 | static struct Lisp_Intfwd i_fwd; \ | |
29208e82 | 2783 | defvar_int (&i_fwd, lname, &globals.f_ ## vname); \ |
96c06863 | 2784 | } while (false) |
92d2947b | 2785 | |
422745d0 TT |
2786 | #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \ |
2787 | do { \ | |
2788 | static struct Lisp_Objfwd o_fwd; \ | |
eb4916d7 | 2789 | defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \ |
96c06863 | 2790 | } while (false) |
422745d0 | 2791 | |
ce5b453a SM |
2792 | #define DEFVAR_KBOARD(lname, vname, doc) \ |
2793 | do { \ | |
2794 | static struct Lisp_Kboard_Objfwd ko_fwd; \ | |
437b2cb4 | 2795 | defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \ |
96c06863 | 2796 | } while (false) |
0328b6de PE |
2797 | \f |
2798 | /* Save and restore the instruction and environment pointers, | |
2799 | without affecting the signal mask. */ | |
2800 | ||
2801 | #ifdef HAVE__SETJMP | |
2802 | typedef jmp_buf sys_jmp_buf; | |
2803 | # define sys_setjmp(j) _setjmp (j) | |
2804 | # define sys_longjmp(j, v) _longjmp (j, v) | |
2805 | #elif defined HAVE_SIGSETJMP | |
2806 | typedef sigjmp_buf sys_jmp_buf; | |
2807 | # define sys_setjmp(j) sigsetjmp (j, 0) | |
2808 | # define sys_longjmp(j, v) siglongjmp (j, v) | |
2809 | #else | |
7105c8cb EZ |
2810 | /* A platform that uses neither _longjmp nor siglongjmp; assume |
2811 | longjmp does not affect the sigmask. */ | |
0328b6de PE |
2812 | typedef jmp_buf sys_jmp_buf; |
2813 | # define sys_setjmp(j) setjmp (j) | |
2814 | # define sys_longjmp(j, v) longjmp (j, v) | |
2815 | #endif | |
df7cd53b | 2816 | |
3cfe6dfd | 2817 | \f |
2f592f95 SM |
2818 | /* Elisp uses several stacks: |
2819 | - the C stack. | |
2820 | - the bytecode stack: used internally by the bytecode interpreter. | |
2821 | Allocated from the C stack. | |
2822 | - The specpdl stack: keeps track of active unwind-protect and | |
2823 | dynamic-let-bindings. Allocated from the `specpdl' array, a manually | |
2824 | managed stack. | |
adf2aa61 SM |
2825 | - The handler stack: keeps track of active catch tags and condition-case |
2826 | handlers. Allocated in a manually managed stack implemented by a | |
2827 | doubly-linked list allocated via xmalloc and never freed. */ | |
2f592f95 | 2828 | |
78ca380c JB |
2829 | /* Structure for recording Lisp call stack for backtrace purposes. */ |
2830 | ||
2831 | /* The special binding stack holds the outer values of variables while | |
2832 | they are bound by a function application or a let form, stores the | |
2f592f95 | 2833 | code to be executed for unwind-protect forms. |
78ca380c | 2834 | |
9349e5f7 | 2835 | NOTE: The specbinding union is defined here, because SPECPDL_INDEX is |
2f592f95 | 2836 | used all over the place, needs to be fast, and needs to know the size of |
9349e5f7 | 2837 | union specbinding. But only eval.c should access it. */ |
5fd6e274 | 2838 | |
2f592f95 | 2839 | enum specbind_tag { |
27e498e6 PE |
2840 | SPECPDL_UNWIND, /* An unwind_protect function on Lisp_Object. */ |
2841 | SPECPDL_UNWIND_PTR, /* Likewise, on void *. */ | |
2842 | SPECPDL_UNWIND_INT, /* Likewise, on int. */ | |
2843 | SPECPDL_UNWIND_VOID, /* Likewise, with no arg. */ | |
2f592f95 SM |
2844 | SPECPDL_BACKTRACE, /* An element of the backtrace. */ |
2845 | SPECPDL_LET, /* A plain and simple dynamic let-binding. */ | |
2846 | /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */ | |
2847 | SPECPDL_LET_LOCAL, /* A buffer-local let-binding. */ | |
2848 | SPECPDL_LET_DEFAULT /* A global binding for a localized var. */ | |
2849 | }; | |
2850 | ||
9349e5f7 | 2851 | union specbinding |
3cfe6dfd | 2852 | { |
9349e5f7 PE |
2853 | ENUM_BF (specbind_tag) kind : CHAR_BIT; |
2854 | struct { | |
2855 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
27e498e6 | 2856 | void (*func) (Lisp_Object); |
9349e5f7 | 2857 | Lisp_Object arg; |
9349e5f7 | 2858 | } unwind; |
27e498e6 PE |
2859 | struct { |
2860 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
2861 | void (*func) (void *); | |
2862 | void *arg; | |
2863 | } unwind_ptr; | |
2864 | struct { | |
2865 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
2866 | void (*func) (int); | |
2867 | int arg; | |
2868 | } unwind_int; | |
2869 | struct { | |
2870 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
2871 | void (*func) (void); | |
2872 | } unwind_void; | |
9349e5f7 PE |
2873 | struct { |
2874 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
2875 | /* `where' is not used in the case of SPECPDL_LET. */ | |
2876 | Lisp_Object symbol, old_value, where; | |
2877 | } let; | |
2878 | struct { | |
2879 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
96c06863 | 2880 | bool_bf debug_on_exit : 1; |
9349e5f7 PE |
2881 | Lisp_Object function; |
2882 | Lisp_Object *args; | |
2883 | ptrdiff_t nargs; | |
2884 | } bt; | |
3cfe6dfd JB |
2885 | }; |
2886 | ||
9349e5f7 PE |
2887 | extern union specbinding *specpdl; |
2888 | extern union specbinding *specpdl_ptr; | |
d311d28c | 2889 | extern ptrdiff_t specpdl_size; |
3cfe6dfd | 2890 | |
00382e8b | 2891 | INLINE ptrdiff_t |
84575e67 PE |
2892 | SPECPDL_INDEX (void) |
2893 | { | |
2894 | return specpdl_ptr - specpdl; | |
2895 | } | |
acb8dc44 | 2896 | |
adf2aa61 SM |
2897 | /* This structure helps implement the `catch/throw' and `condition-case/signal' |
2898 | control structures. A struct handler contains all the information needed to | |
2899 | restore the state of the interpreter after a non-local jump. | |
50f2e553 | 2900 | |
adf2aa61 SM |
2901 | handler structures are chained together in a doubly linked list; the `next' |
2902 | member points to the next outer catchtag and the `nextfree' member points in | |
2903 | the other direction to the next inner element (which is typically the next | |
2904 | free element since we mostly use it on the deepest handler). | |
3cfe6dfd | 2905 | |
adf2aa61 | 2906 | A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch' |
d7306fe6 DN |
2907 | member is TAG, and then unbinds to it. The `val' member is used to |
2908 | hold VAL while the stack is unwound; `val' is returned as the value | |
2909 | of the catch form. | |
2910 | ||
2911 | All the other members are concerned with restoring the interpreter | |
50f2e553 | 2912 | state. |
d7306fe6 | 2913 | |
50f2e553 | 2914 | Members are volatile if their values need to survive _longjmp when |
adf2aa61 SM |
2915 | a 'struct handler' is a local variable. */ |
2916 | ||
2917 | enum handlertype { CATCHER, CONDITION_CASE }; | |
2918 | ||
2919 | struct handler | |
d7306fe6 | 2920 | { |
adf2aa61 SM |
2921 | enum handlertype type; |
2922 | Lisp_Object tag_or_ch; | |
2923 | Lisp_Object val; | |
2924 | struct handler *next; | |
2925 | struct handler *nextfree; | |
2926 | ||
2927 | /* The bytecode interpreter can have several handlers active at the same | |
2928 | time, so when we longjmp to one of them, it needs to know which handler | |
2929 | this was and what was the corresponding internal state. This is stored | |
2930 | here, and when we longjmp we make sure that handlerlist points to the | |
2931 | proper handler. */ | |
2932 | Lisp_Object *bytecode_top; | |
2933 | int bytecode_dest; | |
2934 | ||
2935 | /* Most global vars are reset to their value via the specpdl mechanism, | |
2936 | but a few others are handled by storing their value here. */ | |
96c06863 | 2937 | #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */ |
d7306fe6 | 2938 | struct gcpro *gcpro; |
2f592f95 | 2939 | #endif |
0328b6de | 2940 | sys_jmp_buf jmp; |
d311d28c | 2941 | EMACS_INT lisp_eval_depth; |
adf2aa61 | 2942 | ptrdiff_t pdlcount; |
d7306fe6 DN |
2943 | int poll_suppress_count; |
2944 | int interrupt_input_blocked; | |
2945 | struct byte_stack *byte_stack; | |
2946 | }; | |
2947 | ||
adf2aa61 SM |
2948 | /* Fill in the components of c, and put it on the list. */ |
2949 | #define PUSH_HANDLER(c, tag_ch_val, handlertype) \ | |
70de5e86 | 2950 | if (handlerlist->nextfree) \ |
adf2aa61 SM |
2951 | (c) = handlerlist->nextfree; \ |
2952 | else \ | |
2953 | { \ | |
2954 | (c) = xmalloc (sizeof (struct handler)); \ | |
2955 | (c)->nextfree = NULL; \ | |
70de5e86 | 2956 | handlerlist->nextfree = (c); \ |
adf2aa61 SM |
2957 | } \ |
2958 | (c)->type = (handlertype); \ | |
2959 | (c)->tag_or_ch = (tag_ch_val); \ | |
2960 | (c)->val = Qnil; \ | |
2961 | (c)->next = handlerlist; \ | |
2962 | (c)->lisp_eval_depth = lisp_eval_depth; \ | |
2963 | (c)->pdlcount = SPECPDL_INDEX (); \ | |
2964 | (c)->poll_suppress_count = poll_suppress_count; \ | |
2965 | (c)->interrupt_input_blocked = interrupt_input_blocked;\ | |
2966 | (c)->gcpro = gcprolist; \ | |
2967 | (c)->byte_stack = byte_stack_list; \ | |
2968 | handlerlist = (c); | |
2969 | ||
2970 | ||
22bbbd42 RS |
2971 | extern Lisp_Object memory_signal_data; |
2972 | ||
3cfe6dfd JB |
2973 | /* An address near the bottom of the stack. |
2974 | Tells GC how to save a copy of the stack. */ | |
2975 | extern char *stack_bottom; | |
2976 | ||
4742f524 RS |
2977 | /* Check quit-flag and quit if it is non-nil. |
2978 | Typing C-g does not directly cause a quit; it only sets Vquit_flag. | |
2979 | So the program needs to do QUIT at times when it is safe to quit. | |
2980 | Every loop that might run for a long time or might not exit | |
2981 | ought to do QUIT at least once, at a safe place. | |
2982 | Unless that is impossible, of course. | |
2983 | But it is very desirable to avoid creating loops where QUIT is impossible. | |
2984 | ||
96c06863 | 2985 | Exception: if you set immediate_quit to true, |
4742f524 RS |
2986 | then the handler that responds to the C-g does the quit itself. |
2987 | This is a good thing to do around a loop that has no side effects | |
6c07aac2 AS |
2988 | and (in particular) cannot call arbitrary Lisp code. |
2989 | ||
2990 | If quit-flag is set to `kill-emacs' the SIGINT handler has received | |
2991 | a request to exit Emacs when it is safe to do. */ | |
3cfe6dfd | 2992 | |
383e0970 | 2993 | extern void process_pending_signals (void); |
88d69b7d | 2994 | extern bool volatile pending_signals; |
6b61353c | 2995 | |
7dbda6df | 2996 | extern void process_quit_flag (void); |
a69a6e61 GM |
2997 | #define QUIT \ |
2998 | do { \ | |
2999 | if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \ | |
6d5eb5b0 | 3000 | process_quit_flag (); \ |
0caaedb1 PE |
3001 | else if (pending_signals) \ |
3002 | process_pending_signals (); \ | |
96c06863 | 3003 | } while (false) |
3cfe6dfd | 3004 | |
6b61353c | 3005 | |
96c06863 | 3006 | /* True if ought to quit now. */ |
3cfe6dfd | 3007 | |
efb859b4 | 3008 | #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) |
3cfe6dfd | 3009 | \f |
31cd66f3 PE |
3010 | extern Lisp_Object Vascii_downcase_table; |
3011 | extern Lisp_Object Vascii_canon_table; | |
3cfe6dfd | 3012 | \f |
99a3d506 | 3013 | /* Structure for recording stack slots that need marking. */ |
3cfe6dfd | 3014 | |
78edd3b7 JB |
3015 | /* This is a chain of structures, each of which points at a Lisp_Object |
3016 | variable whose value should be marked in garbage collection. | |
3017 | Normally every link of the chain is an automatic variable of a function, | |
3018 | and its `val' points to some argument or local variable of the function. | |
3019 | On exit to the function, the chain is set back to the value it had on entry. | |
3020 | This way, no link remains in the chain when the stack frame containing the | |
3021 | link disappears. | |
3cfe6dfd | 3022 | |
78edd3b7 JB |
3023 | Every function that can call Feval must protect in this fashion all |
3024 | Lisp_Object variables whose contents will be used again. */ | |
3cfe6dfd JB |
3025 | |
3026 | extern struct gcpro *gcprolist; | |
3027 | ||
3028 | struct gcpro | |
834168ef GM |
3029 | { |
3030 | struct gcpro *next; | |
e2c0561e | 3031 | |
834168ef GM |
3032 | /* Address of first protected variable. */ |
3033 | volatile Lisp_Object *var; | |
e2c0561e | 3034 | |
834168ef | 3035 | /* Number of consecutive protected variables. */ |
f66c7cf8 | 3036 | ptrdiff_t nvars; |
e2c0561e | 3037 | |
4742f524 | 3038 | #ifdef DEBUG_GCPRO |
834168ef | 3039 | int level; |
4742f524 | 3040 | #endif |
834168ef | 3041 | }; |
3cfe6dfd | 3042 | |
1216f5e4 GM |
3043 | /* Values of GC_MARK_STACK during compilation: |
3044 | ||
3045 | 0 Use GCPRO as before | |
3046 | 1 Do the real thing, make GCPROs and UNGCPRO no-ops. | |
3047 | 2 Mark the stack, and check that everything GCPRO'd is | |
3048 | marked. | |
3049 | 3 Mark using GCPRO's, mark stack last, and count how many | |
444b01bb | 3050 | dead objects are kept alive. |
1216f5e4 | 3051 | |
444b01bb PE |
3052 | Formerly, method 0 was used. Currently, method 1 is used unless |
3053 | otherwise specified by hand when building, e.g., | |
3054 | "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'". | |
3055 | Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */ | |
1216f5e4 GM |
3056 | |
3057 | #define GC_USE_GCPROS_AS_BEFORE 0 | |
3058 | #define GC_MAKE_GCPROS_NOOPS 1 | |
3059 | #define GC_MARK_STACK_CHECK_GCPROS 2 | |
3060 | #define GC_USE_GCPROS_CHECK_ZOMBIES 3 | |
3061 | ||
3062 | #ifndef GC_MARK_STACK | |
b948ce8b | 3063 | #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS |
1216f5e4 GM |
3064 | #endif |
3065 | ||
b286858c SM |
3066 | /* Whether we do the stack marking manually. */ |
3067 | #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \ | |
3068 | || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS) | |
3069 | ||
3070 | ||
1216f5e4 GM |
3071 | #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS |
3072 | ||
9f0443f9 | 3073 | /* Do something silly with gcproN vars just so gcc shuts up. */ |
656c33dc | 3074 | /* You get warnings from MIPSPro... */ |
9f0443f9 | 3075 | |
dbf31225 PE |
3076 | #define GCPRO1(varname) ((void) gcpro1) |
3077 | #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1) | |
3078 | #define GCPRO3(varname1, varname2, varname3) \ | |
3079 | ((void) gcpro3, (void) gcpro2, (void) gcpro1) | |
3080 | #define GCPRO4(varname1, varname2, varname3, varname4) \ | |
3081 | ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1) | |
3082 | #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \ | |
3083 | ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1) | |
3084 | #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \ | |
3085 | ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \ | |
3086 | (void) gcpro1) | |
518c40a2 | 3087 | #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7) |
dbf31225 | 3088 | #define UNGCPRO ((void) 0) |
1216f5e4 GM |
3089 | |
3090 | #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */ | |
3091 | ||
4742f524 RS |
3092 | #ifndef DEBUG_GCPRO |
3093 | ||
dbf31225 PE |
3094 | #define GCPRO1(varname) \ |
3095 | {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \ | |
3096 | gcprolist = &gcpro1; } | |
3097 | ||
3098 | #define GCPRO2(varname1, varname2) \ | |
3099 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3100 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3101 | gcprolist = &gcpro2; } | |
3102 | ||
3103 | #define GCPRO3(varname1, varname2, varname3) \ | |
3104 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3105 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3106 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
3107 | gcprolist = &gcpro3; } | |
3108 | ||
3109 | #define GCPRO4(varname1, varname2, varname3, varname4) \ | |
3110 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3111 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3112 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
3113 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
3114 | gcprolist = &gcpro4; } | |
3115 | ||
3116 | #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \ | |
3117 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3118 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3119 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
3120 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
3121 | gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \ | |
3122 | gcprolist = &gcpro5; } | |
3123 | ||
3124 | #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \ | |
3125 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3126 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3127 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
3128 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
3129 | gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \ | |
3130 | gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \ | |
3131 | gcprolist = &gcpro6; } | |
3132 | ||
518c40a2 PE |
3133 | #define GCPRO7(a, b, c, d, e, f, g) \ |
3134 | {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \ | |
3135 | gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \ | |
3136 | gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \ | |
3137 | gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \ | |
3138 | gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \ | |
3139 | gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \ | |
3140 | gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \ | |
3141 | gcprolist = &gcpro7; } | |
3142 | ||
dbf31225 | 3143 | #define UNGCPRO (gcprolist = gcpro1.next) |
3cfe6dfd | 3144 | |
4742f524 | 3145 | #else |
e98227af | 3146 | |
4742f524 RS |
3147 | extern int gcpro_level; |
3148 | ||
dbf31225 PE |
3149 | #define GCPRO1(varname) \ |
3150 | {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \ | |
3151 | gcpro1.level = gcpro_level++; \ | |
3152 | gcprolist = &gcpro1; } | |
3153 | ||
3154 | #define GCPRO2(varname1, varname2) \ | |
3155 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3156 | gcpro1.level = gcpro_level; \ | |
3157 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3158 | gcpro2.level = gcpro_level++; \ | |
3159 | gcprolist = &gcpro2; } | |
3160 | ||
3161 | #define GCPRO3(varname1, varname2, varname3) \ | |
3162 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3163 | gcpro1.level = gcpro_level; \ | |
3164 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3165 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
3166 | gcpro3.level = gcpro_level++; \ | |
3167 | gcprolist = &gcpro3; } | |
3168 | ||
3169 | #define GCPRO4(varname1, varname2, varname3, varname4) \ | |
3170 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3171 | gcpro1.level = gcpro_level; \ | |
3172 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3173 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
3174 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
3175 | gcpro4.level = gcpro_level++; \ | |
3176 | gcprolist = &gcpro4; } | |
3177 | ||
3178 | #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \ | |
3179 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3180 | gcpro1.level = gcpro_level; \ | |
3181 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3182 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
3183 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
3184 | gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \ | |
3185 | gcpro5.level = gcpro_level++; \ | |
3186 | gcprolist = &gcpro5; } | |
3187 | ||
3188 | #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \ | |
3189 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
3190 | gcpro1.level = gcpro_level; \ | |
3191 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
3192 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
3193 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
3194 | gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \ | |
3195 | gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \ | |
3196 | gcpro6.level = gcpro_level++; \ | |
3197 | gcprolist = &gcpro6; } | |
3198 | ||
518c40a2 PE |
3199 | #define GCPRO7(a, b, c, d, e, f, g) \ |
3200 | {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \ | |
3201 | gcpro1.level = gcpro_level; \ | |
3202 | gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \ | |
3203 | gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \ | |
3204 | gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \ | |
3205 | gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \ | |
3206 | gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \ | |
3207 | gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \ | |
3208 | gcpro7.level = gcpro_level++; \ | |
3209 | gcprolist = &gcpro7; } | |
3210 | ||
dbf31225 | 3211 | #define UNGCPRO \ |
96c06863 PE |
3212 | (--gcpro_level != gcpro1.level \ |
3213 | ? emacs_abort () \ | |
3214 | : (void) (gcprolist = gcpro1.next)) | |
4742f524 RS |
3215 | |
3216 | #endif /* DEBUG_GCPRO */ | |
1216f5e4 GM |
3217 | #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */ |
3218 | ||
3cfe6dfd | 3219 | |
5db82c9d | 3220 | /* Evaluate expr, UNGCPRO, and then return the value of expr. */ |
c47b8d02 | 3221 | #define RETURN_UNGCPRO(expr) \ |
96c06863 | 3222 | do \ |
c47b8d02 RS |
3223 | { \ |
3224 | Lisp_Object ret_ungc_val; \ | |
3225 | ret_ungc_val = (expr); \ | |
3226 | UNGCPRO; \ | |
3227 | return ret_ungc_val; \ | |
3228 | } \ | |
96c06863 | 3229 | while (false) |
4742f524 RS |
3230 | |
3231 | /* Call staticpro (&var) to protect static variable `var'. */ | |
3232 | ||
383e0970 | 3233 | void staticpro (Lisp_Object *); |
3cfe6dfd | 3234 | \f |
2f69f2ec RS |
3235 | /* Declare a Lisp-callable function. The MAXARGS parameter has the same |
3236 | meaning as in the DEFUN macro, and is used to construct a prototype. */ | |
2f69f2ec RS |
3237 | /* We can use the same trick as in the DEFUN macro to generate the |
3238 | appropriate prototype. */ | |
3239 | #define EXFUN(fnname, maxargs) \ | |
3240 | extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs | |
2f69f2ec | 3241 | |
84575e67 PE |
3242 | #include "globals.h" |
3243 | ||
526a2be7 AS |
3244 | /* Forward declarations for prototypes. */ |
3245 | struct window; | |
3246 | struct frame; | |
2f69f2ec | 3247 | |
086ca913 DA |
3248 | /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */ |
3249 | ||
00382e8b | 3250 | INLINE void |
086ca913 DA |
3251 | vcopy (Lisp_Object v, ptrdiff_t offset, Lisp_Object *args, ptrdiff_t count) |
3252 | { | |
7216e43b | 3253 | eassert (0 <= offset && 0 <= count && offset + count <= ASIZE (v)); |
91f2d272 | 3254 | memcpy (XVECTOR (v)->contents + offset, args, count * sizeof *args); |
086ca913 DA |
3255 | } |
3256 | ||
3257 | /* Functions to modify hash tables. */ | |
3258 | ||
00382e8b | 3259 | INLINE void |
e83064be | 3260 | set_hash_key_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val) |
4939150c | 3261 | { |
8834c57a | 3262 | gc_aset (h->key_and_value, 2 * idx, val); |
4939150c PE |
3263 | } |
3264 | ||
00382e8b | 3265 | INLINE void |
e83064be | 3266 | set_hash_value_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val) |
4939150c | 3267 | { |
8834c57a | 3268 | gc_aset (h->key_and_value, 2 * idx + 1, val); |
4939150c PE |
3269 | } |
3270 | ||
c644523b DA |
3271 | /* Use these functions to set Lisp_Object |
3272 | or pointer slots of struct Lisp_Symbol. */ | |
3273 | ||
00382e8b | 3274 | INLINE void |
c644523b DA |
3275 | set_symbol_function (Lisp_Object sym, Lisp_Object function) |
3276 | { | |
3277 | XSYMBOL (sym)->function = function; | |
3278 | } | |
3279 | ||
00382e8b | 3280 | INLINE void |
c644523b DA |
3281 | set_symbol_plist (Lisp_Object sym, Lisp_Object plist) |
3282 | { | |
3283 | XSYMBOL (sym)->plist = plist; | |
3284 | } | |
3285 | ||
00382e8b | 3286 | INLINE void |
c644523b DA |
3287 | set_symbol_next (Lisp_Object sym, struct Lisp_Symbol *next) |
3288 | { | |
3289 | XSYMBOL (sym)->next = next; | |
3290 | } | |
3291 | ||
a04e2c62 DA |
3292 | /* Buffer-local (also frame-local) variable access functions. */ |
3293 | ||
00382e8b | 3294 | INLINE int |
a04e2c62 DA |
3295 | blv_found (struct Lisp_Buffer_Local_Value *blv) |
3296 | { | |
3297 | eassert (blv->found == !EQ (blv->defcell, blv->valcell)); | |
3298 | return blv->found; | |
3299 | } | |
3300 | ||
c644523b DA |
3301 | /* Set overlay's property list. */ |
3302 | ||
00382e8b | 3303 | INLINE void |
c644523b DA |
3304 | set_overlay_plist (Lisp_Object overlay, Lisp_Object plist) |
3305 | { | |
3306 | XOVERLAY (overlay)->plist = plist; | |
3307 | } | |
3308 | ||
ad8c997f DA |
3309 | /* Get text properties of S. */ |
3310 | ||
00382e8b | 3311 | INLINE INTERVAL |
0c94c8d6 | 3312 | string_intervals (Lisp_Object s) |
ad8c997f DA |
3313 | { |
3314 | return XSTRING (s)->intervals; | |
3315 | } | |
3316 | ||
3317 | /* Set text properties of S to I. */ | |
3318 | ||
00382e8b | 3319 | INLINE void |
0c94c8d6 | 3320 | set_string_intervals (Lisp_Object s, INTERVAL i) |
ad8c997f DA |
3321 | { |
3322 | XSTRING (s)->intervals = i; | |
3323 | } | |
3324 | ||
742af32f PE |
3325 | /* Set a Lisp slot in TABLE to VAL. Most code should use this instead |
3326 | of setting slots directly. */ | |
3327 | ||
00382e8b | 3328 | INLINE void |
742af32f PE |
3329 | set_char_table_defalt (Lisp_Object table, Lisp_Object val) |
3330 | { | |
3331 | XCHAR_TABLE (table)->defalt = val; | |
3332 | } | |
00382e8b | 3333 | INLINE void |
742af32f PE |
3334 | set_char_table_purpose (Lisp_Object table, Lisp_Object val) |
3335 | { | |
3336 | XCHAR_TABLE (table)->purpose = val; | |
3337 | } | |
3338 | ||
a098c930 DA |
3339 | /* Set different slots in (sub)character tables. */ |
3340 | ||
00382e8b | 3341 | INLINE void |
34dabdb7 | 3342 | set_char_table_extras (Lisp_Object table, ptrdiff_t idx, Lisp_Object val) |
a098c930 DA |
3343 | { |
3344 | eassert (0 <= idx && idx < CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table))); | |
3345 | XCHAR_TABLE (table)->extras[idx] = val; | |
3346 | } | |
3347 | ||
00382e8b | 3348 | INLINE void |
34dabdb7 | 3349 | set_char_table_contents (Lisp_Object table, ptrdiff_t idx, Lisp_Object val) |
a098c930 DA |
3350 | { |
3351 | eassert (0 <= idx && idx < (1 << CHARTAB_SIZE_BITS_0)); | |
3352 | XCHAR_TABLE (table)->contents[idx] = val; | |
3353 | } | |
3354 | ||
00382e8b | 3355 | INLINE void |
34dabdb7 | 3356 | set_sub_char_table_contents (Lisp_Object table, ptrdiff_t idx, Lisp_Object val) |
a098c930 DA |
3357 | { |
3358 | XSUB_CHAR_TABLE (table)->contents[idx] = val; | |
3359 | } | |
3360 | ||
f6d62986 | 3361 | /* Defined in data.c. */ |
955cbe7b | 3362 | extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qunbound; |
3cfe6dfd | 3363 | extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level; |
955cbe7b | 3364 | extern Lisp_Object Qerror, Qquit, Qargs_out_of_range; |
3cfe6dfd | 3365 | extern Lisp_Object Qvoid_variable, Qvoid_function; |
955cbe7b | 3366 | extern Lisp_Object Qinvalid_read_syntax; |
3cfe6dfd | 3367 | extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch; |
71873e2b | 3368 | extern Lisp_Object Quser_error, Qend_of_file, Qarith_error, Qmark_inactive; |
3cfe6dfd | 3369 | extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only; |
6b61353c | 3370 | extern Lisp_Object Qtext_read_only; |
e6cba650 | 3371 | extern Lisp_Object Qinteractive_form; |
99f3388e | 3372 | extern Lisp_Object Qcircular_list; |
955cbe7b | 3373 | extern Lisp_Object Qintegerp, Qwholenump, Qsymbolp, Qlistp, Qconsp; |
3cfe6dfd | 3374 | extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp; |
6b61353c | 3375 | extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp; |
cde20f41 | 3376 | extern Lisp_Object Qbuffer_or_string_p; |
955cbe7b | 3377 | extern Lisp_Object Qfboundp; |
6b61353c KH |
3378 | extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p; |
3379 | ||
3cfe6dfd JB |
3380 | extern Lisp_Object Qcdr; |
3381 | ||
c990426a | 3382 | extern Lisp_Object Qrange_error, Qoverflow_error; |
3cfe6dfd | 3383 | |
6b61353c KH |
3384 | extern Lisp_Object Qfloatp; |
3385 | extern Lisp_Object Qnumberp, Qnumber_or_marker_p; | |
3386 | ||
b52d6985 | 3387 | extern Lisp_Object Qbuffer, Qinteger, Qsymbol; |
3cfe6dfd | 3388 | |
a35ebb81 CY |
3389 | extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object; |
3390 | ||
5994c183 PE |
3391 | EXFUN (Fbyteorder, 0) ATTRIBUTE_CONST; |
3392 | ||
e7032e7c | 3393 | /* Defined in data.c. */ |
383e0970 | 3394 | extern Lisp_Object indirect_function (Lisp_Object); |
383e0970 | 3395 | extern Lisp_Object find_symbol_value (Lisp_Object); |
ebb99847 BR |
3396 | enum Arith_Comparison { |
3397 | ARITH_EQUAL, | |
3398 | ARITH_NOTEQUAL, | |
3399 | ARITH_LESS, | |
3400 | ARITH_GRTR, | |
3401 | ARITH_LESS_OR_EQUAL, | |
3402 | ARITH_GRTR_OR_EQUAL | |
3403 | }; | |
3404 | extern Lisp_Object arithcompare (Lisp_Object num1, Lisp_Object num2, | |
3405 | enum Arith_Comparison comparison); | |
2f69f2ec | 3406 | |
be44ca6c PE |
3407 | /* Convert the integer I to an Emacs representation, either the integer |
3408 | itself, or a cons of two or three integers, or if all else fails a float. | |
3409 | I should not have side effects. */ | |
3410 | #define INTEGER_TO_CONS(i) \ | |
3411 | (! FIXNUM_OVERFLOW_P (i) \ | |
3412 | ? make_number (i) \ | |
3413 | : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \ | |
3414 | || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \ | |
3415 | && FIXNUM_OVERFLOW_P ((i) >> 16)) \ | |
3416 | ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \ | |
3417 | : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \ | |
3418 | || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \ | |
3419 | && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \ | |
3420 | ? Fcons (make_number ((i) >> 16 >> 24), \ | |
3421 | Fcons (make_number ((i) >> 16 & 0xffffff), \ | |
3422 | make_number ((i) & 0xffff))) \ | |
3423 | : make_float (i)) | |
3424 | ||
3425 | /* Convert the Emacs representation CONS back to an integer of type | |
3426 | TYPE, storing the result the variable VAR. Signal an error if CONS | |
3427 | is not a valid representation or is out of range for TYPE. */ | |
3428 | #define CONS_TO_INTEGER(cons, type, var) \ | |
3429 | (TYPE_SIGNED (type) \ | |
3430 | ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \ | |
3431 | : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type)))) | |
3432 | extern intmax_t cons_to_signed (Lisp_Object, intmax_t, intmax_t); | |
3433 | extern uintmax_t cons_to_unsigned (Lisp_Object, uintmax_t); | |
3434 | ||
ad97b375 | 3435 | extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *); |
845ca893 PE |
3436 | extern _Noreturn void args_out_of_range (Lisp_Object, Lisp_Object); |
3437 | extern _Noreturn void args_out_of_range_3 (Lisp_Object, Lisp_Object, | |
3438 | Lisp_Object); | |
3439 | extern _Noreturn Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object); | |
ce5b453a | 3440 | extern Lisp_Object do_symval_forwarding (union Lisp_Fwd *); |
de1339b0 | 3441 | extern void set_internal (Lisp_Object, Lisp_Object, Lisp_Object, bool); |
383e0970 | 3442 | extern void syms_of_data (void); |
383e0970 | 3443 | extern void swap_in_global_binding (struct Lisp_Symbol *); |
3cfe6dfd | 3444 | |
a37e10f9 | 3445 | /* Defined in cmds.c */ |
383e0970 J |
3446 | extern void syms_of_cmds (void); |
3447 | extern void keys_of_cmds (void); | |
a37e10f9 | 3448 | |
e7032e7c | 3449 | /* Defined in coding.c. */ |
2f7c71a1 | 3450 | extern Lisp_Object Qcharset; |
d311d28c | 3451 | extern Lisp_Object detect_coding_system (const unsigned char *, ptrdiff_t, |
f10fe38f | 3452 | ptrdiff_t, bool, bool, Lisp_Object); |
383e0970 J |
3453 | extern void init_coding (void); |
3454 | extern void init_coding_once (void); | |
3455 | extern void syms_of_coding (void); | |
1842abb2 | 3456 | |
e7032e7c | 3457 | /* Defined in character.c. */ |
5994c183 | 3458 | EXFUN (Fmax_char, 0) ATTRIBUTE_CONST; |
d311d28c PE |
3459 | extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t); |
3460 | extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t); | |
5994c183 PE |
3461 | extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST; |
3462 | extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST; | |
2f7c71a1 AS |
3463 | extern void syms_of_character (void); |
3464 | ||
e7032e7c | 3465 | /* Defined in charset.c. */ |
383e0970 J |
3466 | extern void init_charset (void); |
3467 | extern void init_charset_once (void); | |
3468 | extern void syms_of_charset (void); | |
8f924df7 KH |
3469 | /* Structure forward declarations. */ |
3470 | struct charset; | |
5e741a41 | 3471 | |
e7032e7c | 3472 | /* Defined in composite.c. */ |
383e0970 | 3473 | extern void syms_of_composite (void); |
5e741a41 | 3474 | |
e7032e7c | 3475 | /* Defined in syntax.c. */ |
383e0970 J |
3476 | extern void init_syntax_once (void); |
3477 | extern void syms_of_syntax (void); | |
a37e10f9 | 3478 | |
e7032e7c | 3479 | /* Defined in fns.c. */ |
99f3388e | 3480 | extern Lisp_Object QCrehash_size, QCrehash_threshold; |
ca9ce8f2 | 3481 | enum { NEXT_ALMOST_PRIME_LIMIT = 11 }; |
5994c183 PE |
3482 | EXFUN (Fidentity, 1) ATTRIBUTE_CONST; |
3483 | extern EMACS_INT next_almost_prime (EMACS_INT) ATTRIBUTE_CONST; | |
d311d28c | 3484 | extern Lisp_Object larger_vector (Lisp_Object, ptrdiff_t, ptrdiff_t); |
383e0970 | 3485 | extern void sweep_weak_hash_tables (void); |
e6cba650 | 3486 | extern Lisp_Object Qcursor_in_echo_area; |
3cfe6dfd | 3487 | extern Lisp_Object Qstring_lessp; |
53371430 | 3488 | extern Lisp_Object QCsize, QCtest, QCweakness, Qequal, Qeq; |
3cc5a532 | 3489 | EMACS_UINT hash_string (char const *, ptrdiff_t); |
0de4bb68 | 3490 | EMACS_UINT sxhash (Lisp_Object, int); |
b7432bb2 SM |
3491 | Lisp_Object make_hash_table (struct hash_table_test, Lisp_Object, Lisp_Object, |
3492 | Lisp_Object, Lisp_Object); | |
d3411f89 PE |
3493 | ptrdiff_t hash_lookup (struct Lisp_Hash_Table *, Lisp_Object, EMACS_UINT *); |
3494 | ptrdiff_t hash_put (struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object, | |
0de4bb68 | 3495 | EMACS_UINT); |
53371430 | 3496 | extern struct hash_table_test hashtest_eql, hashtest_equal; |
404dbd37 | 3497 | |
d311d28c PE |
3498 | extern Lisp_Object substring_both (Lisp_Object, ptrdiff_t, ptrdiff_t, |
3499 | ptrdiff_t, ptrdiff_t); | |
6318cde0 | 3500 | extern Lisp_Object merge (Lisp_Object, Lisp_Object, Lisp_Object); |
383e0970 | 3501 | extern Lisp_Object do_yes_or_no_p (Lisp_Object); |
383e0970 J |
3502 | extern Lisp_Object concat2 (Lisp_Object, Lisp_Object); |
3503 | extern Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object); | |
3504 | extern Lisp_Object nconc2 (Lisp_Object, Lisp_Object); | |
3505 | extern Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object); | |
3506 | extern Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object); | |
3507 | extern void clear_string_char_byte_cache (void); | |
d311d28c PE |
3508 | extern ptrdiff_t string_char_to_byte (Lisp_Object, ptrdiff_t); |
3509 | extern ptrdiff_t string_byte_to_char (Lisp_Object, ptrdiff_t); | |
383e0970 J |
3510 | extern Lisp_Object string_to_multibyte (Lisp_Object); |
3511 | extern Lisp_Object string_make_unibyte (Lisp_Object); | |
383e0970 | 3512 | extern void syms_of_fns (void); |
2f69f2ec | 3513 | |
e7032e7c | 3514 | /* Defined in floatfns.c. */ |
383e0970 | 3515 | extern double extract_float (Lisp_Object); |
383e0970 | 3516 | extern void syms_of_floatfns (void); |
3d608a86 | 3517 | extern Lisp_Object fmod_float (Lisp_Object x, Lisp_Object y); |
3cfe6dfd | 3518 | |
e7032e7c | 3519 | /* Defined in fringe.c. */ |
383e0970 J |
3520 | extern void syms_of_fringe (void); |
3521 | extern void init_fringe (void); | |
524c7aa6 PE |
3522 | #ifdef HAVE_WINDOW_SYSTEM |
3523 | extern void mark_fringe_data (void); | |
383e0970 | 3524 | extern void init_fringe_once (void); |
524c7aa6 | 3525 | #endif /* HAVE_WINDOW_SYSTEM */ |
6b61353c | 3526 | |
e7032e7c | 3527 | /* Defined in image.c. */ |
955cbe7b PE |
3528 | extern Lisp_Object QCascent, QCmargin, QCrelief; |
3529 | extern Lisp_Object QCconversion; | |
0766b489 | 3530 | extern int x_bitmap_mask (struct frame *, ptrdiff_t); |
aa15c6bb | 3531 | extern void reset_image_types (void); |
383e0970 | 3532 | extern void syms_of_image (void); |
6b61353c | 3533 | |
e7032e7c | 3534 | /* Defined in insdel.c. */ |
b8b31967 | 3535 | extern Lisp_Object Qinhibit_modification_hooks; |
d311d28c | 3536 | extern void move_gap_both (ptrdiff_t, ptrdiff_t); |
845ca893 | 3537 | extern _Noreturn void buffer_overflow (void); |
d311d28c | 3538 | extern void make_gap (ptrdiff_t); |
eefd7278 | 3539 | extern void make_gap_1 (struct buffer *, ptrdiff_t); |
d311d28c | 3540 | extern ptrdiff_t copy_text (const unsigned char *, unsigned char *, |
a08d4ba7 | 3541 | ptrdiff_t, bool, bool); |
ae19ba7c | 3542 | extern int count_combining_before (const unsigned char *, |
d311d28c | 3543 | ptrdiff_t, ptrdiff_t, ptrdiff_t); |
ae19ba7c | 3544 | extern int count_combining_after (const unsigned char *, |
d311d28c PE |
3545 | ptrdiff_t, ptrdiff_t, ptrdiff_t); |
3546 | extern void insert (const char *, ptrdiff_t); | |
3547 | extern void insert_and_inherit (const char *, ptrdiff_t); | |
d311d28c | 3548 | extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t, |
a08d4ba7 | 3549 | bool, bool, bool); |
8a44e6d1 | 3550 | extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail); |
d311d28c | 3551 | extern void insert_from_string (Lisp_Object, ptrdiff_t, ptrdiff_t, |
a08d4ba7 PE |
3552 | ptrdiff_t, ptrdiff_t, bool); |
3553 | extern void insert_from_buffer (struct buffer *, ptrdiff_t, ptrdiff_t, bool); | |
ae19ba7c SM |
3554 | extern void insert_char (int); |
3555 | extern void insert_string (const char *); | |
d311d28c PE |
3556 | extern void insert_before_markers (const char *, ptrdiff_t); |
3557 | extern void insert_before_markers_and_inherit (const char *, ptrdiff_t); | |
3558 | extern void insert_from_string_before_markers (Lisp_Object, ptrdiff_t, | |
3559 | ptrdiff_t, ptrdiff_t, | |
a08d4ba7 | 3560 | ptrdiff_t, bool); |
d311d28c | 3561 | extern void del_range (ptrdiff_t, ptrdiff_t); |
a08d4ba7 PE |
3562 | extern Lisp_Object del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool); |
3563 | extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool); | |
3564 | extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool); | |
d311d28c | 3565 | extern Lisp_Object del_range_2 (ptrdiff_t, ptrdiff_t, |
a08d4ba7 | 3566 | ptrdiff_t, ptrdiff_t, bool); |
00012b86 | 3567 | extern void modify_text (ptrdiff_t, ptrdiff_t); |
d311d28c | 3568 | extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *); |
00012b86 | 3569 | extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *); |
37c790b3 | 3570 | extern void invalidate_buffer_caches (struct buffer *, ptrdiff_t, ptrdiff_t); |
d311d28c PE |
3571 | extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t); |
3572 | extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t, | |
3573 | ptrdiff_t, ptrdiff_t); | |
3574 | extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t, | |
3575 | ptrdiff_t, ptrdiff_t); | |
a08d4ba7 | 3576 | extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object, bool, bool, bool); |
d311d28c | 3577 | extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, |
a08d4ba7 | 3578 | const char *, ptrdiff_t, ptrdiff_t, bool); |
ae19ba7c | 3579 | extern void syms_of_insdel (void); |
c98adc1b | 3580 | |
e7032e7c | 3581 | /* Defined in dispnew.c. */ |
9e4bf381 PE |
3582 | #if (defined PROFILING \ |
3583 | && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__)) | |
845ca893 | 3584 | _Noreturn void __executable_start (void); |
9e4bf381 | 3585 | #endif |
7684e57b | 3586 | extern Lisp_Object Vwindow_system; |
59ea14cd | 3587 | extern Lisp_Object sit_for (Lisp_Object, bool, int); |
383e0970 J |
3588 | extern void init_display (void); |
3589 | extern void syms_of_display (void); | |
1747fb16 | 3590 | |
e7032e7c | 3591 | /* Defined in xdisp.c. */ |
c6ae41f3 | 3592 | extern Lisp_Object Qinhibit_point_motion_hooks; |
016c7a15 | 3593 | extern Lisp_Object Qinhibit_redisplay, Qdisplay; |
99f3388e | 3594 | extern Lisp_Object Qmenu_bar_update_hook; |
29208e82 | 3595 | extern Lisp_Object Qwindow_scroll_functions; |
99f3388e | 3596 | extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map; |
8a52f00a | 3597 | extern Lisp_Object Qimage, Qtext, Qboth, Qboth_horiz, Qtext_image_horiz; |
89dc303e | 3598 | extern Lisp_Object Qspace, Qcenter, QCalign_to; |
99f3388e DN |
3599 | extern Lisp_Object Qbar, Qhbar, Qbox, Qhollow; |
3600 | extern Lisp_Object Qleft_margin, Qright_margin; | |
89dc303e | 3601 | extern Lisp_Object QCdata, QCfile; |
99f3388e | 3602 | extern Lisp_Object QCmap; |
e6cba650 | 3603 | extern Lisp_Object Qrisky_local_variable; |
e08813d0 | 3604 | extern bool noninteractive_need_newline; |
986113df | 3605 | extern Lisp_Object echo_area_buffer[2]; |
89dc303e | 3606 | extern void add_to_log (const char *, Lisp_Object, Lisp_Object); |
383e0970 J |
3607 | extern void check_message_stack (void); |
3608 | extern void setup_echo_area_for_printing (int); | |
fce31d69 | 3609 | extern bool push_message (void); |
27e498e6 | 3610 | extern void pop_message_unwind (void); |
383e0970 | 3611 | extern Lisp_Object restore_message_unwind (Lisp_Object); |
383e0970 J |
3612 | extern void restore_message (void); |
3613 | extern Lisp_Object current_message (void); | |
44ad1cf7 | 3614 | extern void clear_message (bool, bool); |
1e973bc7 | 3615 | extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2); |
a8fe7202 AS |
3616 | extern void message1 (const char *); |
3617 | extern void message1_nolog (const char *); | |
b09cca6a SM |
3618 | extern void message3 (Lisp_Object); |
3619 | extern void message3_nolog (Lisp_Object); | |
0063fdb1 | 3620 | extern void message_dolog (const char *, ptrdiff_t, bool, bool); |
a8fe7202 | 3621 | extern void message_with_string (const char *, Lisp_Object, int); |
383e0970 J |
3622 | extern void message_log_maybe_newline (void); |
3623 | extern void update_echo_area (void); | |
d311d28c | 3624 | extern void truncate_echo_area (ptrdiff_t); |
383e0970 | 3625 | extern void redisplay (void); |
383e0970 | 3626 | extern void redisplay_preserve_echo_area (int); |
c4bf5bc3 | 3627 | |
383e0970 J |
3628 | void set_frame_cursor_types (struct frame *, Lisp_Object); |
3629 | extern void syms_of_xdisp (void); | |
3630 | extern void init_xdisp (void); | |
3631 | extern Lisp_Object safe_eval (Lisp_Object); | |
d311d28c | 3632 | extern int pos_visible_p (struct window *, ptrdiff_t, int *, |
383e0970 | 3633 | int *, int *, int *, int *, int *); |
c98adc1b | 3634 | |
e7032e7c | 3635 | /* Defined in xsettings.c. */ |
383e0970 | 3636 | extern void syms_of_xsettings (void); |
637fa988 | 3637 | |
15b0ced5 | 3638 | /* Defined in vm-limit.c. */ |
261cb4bb | 3639 | extern void memory_warnings (void *, void (*warnfun) (const char *)); |
9043c90a | 3640 | |
e7032e7c | 3641 | /* Defined in alloc.c. */ |
383e0970 | 3642 | extern void check_pure_size (void); |
73ebd38f | 3643 | extern void free_misc (Lisp_Object); |
413d18e7 | 3644 | extern void allocate_string_data (struct Lisp_String *, EMACS_INT, EMACS_INT); |
a8fe7202 | 3645 | extern void malloc_warning (const char *); |
845ca893 PE |
3646 | extern _Noreturn void memory_full (size_t); |
3647 | extern _Noreturn void buffer_memory_full (ptrdiff_t); | |
fce31d69 | 3648 | extern bool survives_gc_p (Lisp_Object); |
383e0970 | 3649 | extern void mark_object (Lisp_Object); |
69003fd8 | 3650 | #if defined REL_ALLOC && !defined SYSTEM_MALLOC |
84dfc8a7 | 3651 | extern void refill_memory_reserve (void); |
69003fd8 | 3652 | #endif |
50c77428 | 3653 | extern const char *pending_malloc_warning; |
9730daca | 3654 | extern Lisp_Object zero_vector; |
89dc303e | 3655 | extern Lisp_Object *stack_base; |
dac616ff DA |
3656 | extern EMACS_INT consing_since_gc; |
3657 | extern EMACS_INT gc_relative_threshold; | |
3658 | extern EMACS_INT memory_full_cons_threshold; | |
2f7c71a1 AS |
3659 | extern Lisp_Object list1 (Lisp_Object); |
3660 | extern Lisp_Object list2 (Lisp_Object, Lisp_Object); | |
3661 | extern Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object); | |
3662 | extern Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3663 | extern Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, | |
3664 | Lisp_Object); | |
3438fe21 | 3665 | enum constype {CONSTYPE_HEAP, CONSTYPE_PURE}; |
694b6c97 | 3666 | extern Lisp_Object listn (enum constype, ptrdiff_t, Lisp_Object, ...); |
3de717bd DA |
3667 | |
3668 | /* Build a frequently used 2/3/4-integer lists. */ | |
3669 | ||
00382e8b | 3670 | INLINE Lisp_Object |
3de717bd DA |
3671 | list2i (EMACS_INT x, EMACS_INT y) |
3672 | { | |
3673 | return list2 (make_number (x), make_number (y)); | |
3674 | } | |
3675 | ||
00382e8b | 3676 | INLINE Lisp_Object |
3de717bd DA |
3677 | list3i (EMACS_INT x, EMACS_INT y, EMACS_INT w) |
3678 | { | |
3679 | return list3 (make_number (x), make_number (y), make_number (w)); | |
3680 | } | |
3681 | ||
00382e8b | 3682 | INLINE Lisp_Object |
3de717bd DA |
3683 | list4i (EMACS_INT x, EMACS_INT y, EMACS_INT w, EMACS_INT h) |
3684 | { | |
3685 | return list4 (make_number (x), make_number (y), | |
3686 | make_number (w), make_number (h)); | |
3687 | } | |
3688 | ||
2cf00efc PE |
3689 | extern Lisp_Object make_uninit_bool_vector (EMACS_INT); |
3690 | extern Lisp_Object bool_vector_fill (Lisp_Object, Lisp_Object); | |
845ca893 | 3691 | extern _Noreturn void string_overflow (void); |
d311d28c | 3692 | extern Lisp_Object make_string (const char *, ptrdiff_t); |
26bccfae PE |
3693 | extern Lisp_Object make_formatted_string (char *, const char *, ...) |
3694 | ATTRIBUTE_FORMAT_PRINTF (2, 3); | |
d311d28c | 3695 | extern Lisp_Object make_unibyte_string (const char *, ptrdiff_t); |
d7ea76b4 DA |
3696 | |
3697 | /* Make unibyte string from C string when the length isn't known. */ | |
3698 | ||
00382e8b | 3699 | INLINE Lisp_Object |
d7ea76b4 DA |
3700 | build_unibyte_string (const char *str) |
3701 | { | |
3702 | return make_unibyte_string (str, strlen (str)); | |
3703 | } | |
3704 | ||
d311d28c | 3705 | extern Lisp_Object make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t); |
0c90b9ee | 3706 | extern Lisp_Object make_event_array (ptrdiff_t, Lisp_Object *); |
413d18e7 EZ |
3707 | extern Lisp_Object make_uninit_string (EMACS_INT); |
3708 | extern Lisp_Object make_uninit_multibyte_string (EMACS_INT, EMACS_INT); | |
d311d28c | 3709 | extern Lisp_Object make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t); |
14162469 | 3710 | extern Lisp_Object make_specified_string (const char *, |
fce31d69 PE |
3711 | ptrdiff_t, ptrdiff_t, bool); |
3712 | extern Lisp_Object make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool); | |
2a0213a6 DA |
3713 | extern Lisp_Object make_pure_c_string (const char *, ptrdiff_t); |
3714 | ||
3715 | /* Make a string allocated in pure space, use STR as string data. */ | |
3716 | ||
00382e8b | 3717 | INLINE Lisp_Object |
2a0213a6 DA |
3718 | build_pure_c_string (const char *str) |
3719 | { | |
3720 | return make_pure_c_string (str, strlen (str)); | |
3721 | } | |
1130ecfc DA |
3722 | |
3723 | /* Make a string from the data at STR, treating it as multibyte if the | |
3724 | data warrants. */ | |
3725 | ||
00382e8b | 3726 | INLINE Lisp_Object |
1130ecfc DA |
3727 | build_string (const char *str) |
3728 | { | |
3729 | return make_string (str, strlen (str)); | |
3730 | } | |
3731 | ||
383e0970 | 3732 | extern Lisp_Object pure_cons (Lisp_Object, Lisp_Object); |
3017f87f | 3733 | extern void make_byte_code (struct Lisp_Vector *); |
3d80c99f | 3734 | extern Lisp_Object Qautomatic_gc; |
7f73dc9d | 3735 | extern Lisp_Object Qchar_table_extra_slots; |
383e0970 | 3736 | extern struct Lisp_Vector *allocate_vector (EMACS_INT); |
25721f5b | 3737 | |
8b17a8b9 | 3738 | /* Make an uninitialized vector for SIZE objects. NOTE: you must |
25721f5b DA |
3739 | be sure that GC cannot happen until the vector is completely |
3740 | initialized. E.g. the following code is likely to crash: | |
3741 | ||
3742 | v = make_uninit_vector (3); | |
3743 | ASET (v, 0, obj0); | |
3744 | ASET (v, 1, Ffunction_can_gc ()); | |
3745 | ASET (v, 2, obj1); */ | |
3746 | ||
00382e8b | 3747 | INLINE Lisp_Object |
25721f5b DA |
3748 | make_uninit_vector (ptrdiff_t size) |
3749 | { | |
3750 | Lisp_Object v; | |
3751 | struct Lisp_Vector *p; | |
3752 | ||
3753 | p = allocate_vector (size); | |
3754 | XSETVECTOR (v, p); | |
3755 | return v; | |
3756 | } | |
3757 | ||
914adc42 | 3758 | extern struct Lisp_Vector *allocate_pseudovector (int, int, enum pvec_type); |
30f95089 SM |
3759 | #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \ |
3760 | ((typ*) \ | |
3761 | allocate_pseudovector \ | |
3762 | (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag)) | |
383e0970 J |
3763 | extern struct Lisp_Hash_Table *allocate_hash_table (void); |
3764 | extern struct window *allocate_window (void); | |
3765 | extern struct frame *allocate_frame (void); | |
3766 | extern struct Lisp_Process *allocate_process (void); | |
3767 | extern struct terminal *allocate_terminal (void); | |
fce31d69 PE |
3768 | extern bool gc_in_progress; |
3769 | extern bool abort_on_gc; | |
383e0970 J |
3770 | extern Lisp_Object make_float (double); |
3771 | extern void display_malloc_warning (void); | |
d311d28c | 3772 | extern ptrdiff_t inhibit_garbage_collection (void); |
1396ac86 PE |
3773 | extern Lisp_Object make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t); |
3774 | extern Lisp_Object make_save_obj_obj_obj_obj (Lisp_Object, Lisp_Object, | |
3775 | Lisp_Object, Lisp_Object); | |
3776 | extern Lisp_Object make_save_ptr (void *); | |
3777 | extern Lisp_Object make_save_ptr_int (void *, ptrdiff_t); | |
3778 | extern Lisp_Object make_save_ptr_ptr (void *, void *); | |
3779 | extern Lisp_Object make_save_funcptr_ptr_obj (void (*) (void), void *, | |
3780 | Lisp_Object); | |
3781 | extern Lisp_Object make_save_memory (Lisp_Object *, ptrdiff_t); | |
27e498e6 | 3782 | extern void free_save_value (Lisp_Object); |
d7a7fda3 | 3783 | extern Lisp_Object build_overlay (Lisp_Object, Lisp_Object, Lisp_Object); |
383e0970 J |
3784 | extern void free_marker (Lisp_Object); |
3785 | extern void free_cons (struct Lisp_Cons *); | |
3786 | extern void init_alloc_once (void); | |
3787 | extern void init_alloc (void); | |
3788 | extern void syms_of_alloc (void); | |
3789 | extern struct buffer * allocate_buffer (void); | |
3790 | extern int valid_lisp_object_p (Lisp_Object); | |
7e63e0c3 DA |
3791 | #ifdef GC_CHECK_CONS_LIST |
3792 | extern void check_cons_list (void); | |
3793 | #else | |
00382e8b | 3794 | INLINE void (check_cons_list) (void) { lisp_h_check_cons_list (); } |
7e63e0c3 | 3795 | #endif |
3cfe6dfd | 3796 | |
a041960a | 3797 | #ifdef REL_ALLOC |
e7032e7c | 3798 | /* Defined in ralloc.c. */ |
a041960a PE |
3799 | extern void *r_alloc (void **, size_t); |
3800 | extern void r_alloc_free (void **); | |
3801 | extern void *r_re_alloc (void **, size_t); | |
3802 | extern void r_alloc_reset_variable (void **, void **); | |
57b81a9f | 3803 | extern void r_alloc_inhibit_buffer_relocation (int); |
a041960a PE |
3804 | #endif |
3805 | ||
e7032e7c | 3806 | /* Defined in chartab.c. */ |
383e0970 | 3807 | extern Lisp_Object copy_char_table (Lisp_Object); |
383e0970 J |
3808 | extern Lisp_Object char_table_ref (Lisp_Object, int); |
3809 | extern Lisp_Object char_table_ref_and_range (Lisp_Object, int, | |
3810 | int *, int *); | |
e757f1c6 PE |
3811 | extern void char_table_set (Lisp_Object, int, Lisp_Object); |
3812 | extern void char_table_set_range (Lisp_Object, int, int, Lisp_Object); | |
383e0970 J |
3813 | extern int char_table_translate (Lisp_Object, int); |
3814 | extern void map_char_table (void (*) (Lisp_Object, Lisp_Object, | |
3815 | Lisp_Object), | |
3816 | Lisp_Object, Lisp_Object, Lisp_Object); | |
e6cba650 DN |
3817 | extern void map_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object), |
3818 | Lisp_Object, Lisp_Object, | |
3819 | Lisp_Object, struct charset *, | |
3820 | unsigned, unsigned); | |
5cc7f7af | 3821 | extern Lisp_Object uniprop_table (Lisp_Object); |
383e0970 | 3822 | extern void syms_of_chartab (void); |
1842abb2 | 3823 | |
e7032e7c | 3824 | /* Defined in print.c. */ |
3cfe6dfd | 3825 | extern Lisp_Object Vprin1_to_string_buffer; |
42c8bc9b | 3826 | extern void debug_print (Lisp_Object) EXTERNALLY_VISIBLE; |
29208e82 | 3827 | extern Lisp_Object Qstandard_output; |
9453ea7b | 3828 | extern Lisp_Object Qexternal_debugging_output; |
383e0970 | 3829 | extern void temp_output_buffer_setup (const char *); |
29208e82 | 3830 | extern int print_level; |
3cfe6dfd | 3831 | extern Lisp_Object Qprint_escape_newlines; |
a8fe7202 | 3832 | extern void write_string (const char *, int); |
a8fe7202 AS |
3833 | extern void print_error_message (Lisp_Object, Lisp_Object, const char *, |
3834 | Lisp_Object); | |
526a2be7 | 3835 | extern Lisp_Object internal_with_output_to_temp_buffer |
383e0970 | 3836 | (const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object); |
1915d8d6 | 3837 | #define FLOAT_TO_STRING_BUFSIZE 350 |
99027bdd | 3838 | extern int float_to_string (char *, double); |
cf4bb06d | 3839 | extern void init_print_once (void); |
383e0970 | 3840 | extern void syms_of_print (void); |
526a2be7 | 3841 | |
e7032e7c | 3842 | /* Defined in doprnt.c. */ |
c2d1e36d PE |
3843 | extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *, |
3844 | va_list); | |
62f19c19 PE |
3845 | extern ptrdiff_t esprintf (char *, char const *, ...) |
3846 | ATTRIBUTE_FORMAT_PRINTF (2, 3); | |
62f19c19 PE |
3847 | extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t, |
3848 | char const *, ...) | |
3849 | ATTRIBUTE_FORMAT_PRINTF (5, 6); | |
3850 | extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t, | |
3851 | char const *, va_list) | |
3852 | ATTRIBUTE_FORMAT_PRINTF (5, 0); | |
e6c3da20 | 3853 | |
ea6c7ae6 | 3854 | /* Defined in lread.c. */ |
3cfe6dfd | 3855 | extern Lisp_Object Qvariable_documentation, Qstandard_input; |
99f3388e | 3856 | extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction; |
a411ac43 | 3857 | extern Lisp_Object Qlexical_binding; |
383e0970 | 3858 | extern Lisp_Object check_obarray (Lisp_Object); |
e8df9267 DA |
3859 | extern Lisp_Object intern_1 (const char *, ptrdiff_t); |
3860 | extern Lisp_Object intern_c_string_1 (const char *, ptrdiff_t); | |
d311d28c | 3861 | extern Lisp_Object oblookup (Lisp_Object, const char *, ptrdiff_t, ptrdiff_t); |
00382e8b | 3862 | INLINE void |
84575e67 PE |
3863 | LOADHIST_ATTACH (Lisp_Object x) |
3864 | { | |
3865 | if (initialized) | |
3866 | Vcurrent_load_list = Fcons (x, Vcurrent_load_list); | |
3867 | } | |
383e0970 | 3868 | extern int openp (Lisp_Object, Lisp_Object, Lisp_Object, |
518c40a2 | 3869 | Lisp_Object *, Lisp_Object, bool); |
7cded46f | 3870 | extern Lisp_Object string_to_number (char const *, int, bool); |
383e0970 J |
3871 | extern void map_obarray (Lisp_Object, void (*) (Lisp_Object, Lisp_Object), |
3872 | Lisp_Object); | |
a8fe7202 | 3873 | extern void dir_warning (const char *, Lisp_Object); |
383e0970 J |
3874 | extern void init_obarray (void); |
3875 | extern void init_lread (void); | |
3876 | extern void syms_of_lread (void); | |
3cfe6dfd | 3877 | |
00382e8b | 3878 | INLINE Lisp_Object |
e8df9267 DA |
3879 | intern (const char *str) |
3880 | { | |
3881 | return intern_1 (str, strlen (str)); | |
3882 | } | |
3883 | ||
00382e8b | 3884 | INLINE Lisp_Object |
e8df9267 DA |
3885 | intern_c_string (const char *str) |
3886 | { | |
3887 | return intern_c_string_1 (str, strlen (str)); | |
3888 | } | |
3889 | ||
f6d62986 | 3890 | /* Defined in eval.c. */ |
61b108cc | 3891 | extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qmacro; |
a411ac43 | 3892 | extern Lisp_Object Qinhibit_quit, Qinternal_interpreter_environment, Qclosure; |
955cbe7b | 3893 | extern Lisp_Object Qand_rest; |
3cfe6dfd | 3894 | extern Lisp_Object Vautoload_queue; |
fab88cb7 | 3895 | extern Lisp_Object Vsignaling_function; |
d1f55f16 | 3896 | extern Lisp_Object inhibit_lisp_code; |
244ed907 | 3897 | extern struct handler *handlerlist; |
adf2aa61 | 3898 | |
f1b6e5fc SM |
3899 | /* To run a normal hook, use the appropriate function from the list below. |
3900 | The calling convention: | |
3901 | ||
846d69ac | 3902 | if (!NILP (Vrun_hooks)) |
f1b6e5fc SM |
3903 | call1 (Vrun_hooks, Qmy_funny_hook); |
3904 | ||
3905 | should no longer be used. */ | |
3cfe6dfd | 3906 | extern Lisp_Object Vrun_hooks; |
383e0970 | 3907 | extern void run_hook_with_args_2 (Lisp_Object, Lisp_Object, Lisp_Object); |
f66c7cf8 | 3908 | extern Lisp_Object run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args, |
f6d62986 | 3909 | Lisp_Object (*funcall) |
f66c7cf8 | 3910 | (ptrdiff_t nargs, Lisp_Object *args)); |
845ca893 PE |
3911 | extern _Noreturn void xsignal (Lisp_Object, Lisp_Object); |
3912 | extern _Noreturn void xsignal0 (Lisp_Object); | |
3913 | extern _Noreturn void xsignal1 (Lisp_Object, Lisp_Object); | |
3914 | extern _Noreturn void xsignal2 (Lisp_Object, Lisp_Object, Lisp_Object); | |
3915 | extern _Noreturn void xsignal3 (Lisp_Object, Lisp_Object, Lisp_Object, | |
3916 | Lisp_Object); | |
3917 | extern _Noreturn void signal_error (const char *, Lisp_Object); | |
defb1411 | 3918 | extern Lisp_Object eval_sub (Lisp_Object form); |
383e0970 J |
3919 | extern Lisp_Object apply1 (Lisp_Object, Lisp_Object); |
3920 | extern Lisp_Object call0 (Lisp_Object); | |
3921 | extern Lisp_Object call1 (Lisp_Object, Lisp_Object); | |
3922 | extern Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object); | |
3923 | extern Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3924 | extern Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3925 | extern Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3926 | extern Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3927 | extern Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
383e0970 J |
3928 | extern Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object); |
3929 | extern Lisp_Object internal_lisp_condition_case (Lisp_Object, Lisp_Object, Lisp_Object); | |
3930 | extern Lisp_Object internal_condition_case (Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object)); | |
3931 | extern Lisp_Object internal_condition_case_1 (Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)); | |
3932 | extern Lisp_Object internal_condition_case_2 (Lisp_Object (*) (Lisp_Object, Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)); | |
cc92c454 SM |
3933 | extern Lisp_Object internal_condition_case_n |
3934 | (Lisp_Object (*) (ptrdiff_t, Lisp_Object *), ptrdiff_t, Lisp_Object *, | |
3935 | Lisp_Object, Lisp_Object (*) (Lisp_Object, ptrdiff_t, Lisp_Object *)); | |
383e0970 | 3936 | extern void specbind (Lisp_Object, Lisp_Object); |
27e498e6 | 3937 | extern void record_unwind_protect (void (*) (Lisp_Object), Lisp_Object); |
27e498e6 | 3938 | extern void record_unwind_protect_ptr (void (*) (void *), void *); |
94fcd171 | 3939 | extern void record_unwind_protect_int (void (*) (int), int); |
27e498e6 | 3940 | extern void record_unwind_protect_void (void (*) (void)); |
f4b1eb36 | 3941 | extern void record_unwind_protect_nothing (void); |
a0931322 | 3942 | extern void clear_unwind_protect (ptrdiff_t); |
94fcd171 | 3943 | extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object), Lisp_Object); |
a0931322 | 3944 | extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *); |
d311d28c | 3945 | extern Lisp_Object unbind_to (ptrdiff_t, Lisp_Object); |
845ca893 PE |
3946 | extern _Noreturn void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2); |
3947 | extern _Noreturn void verror (const char *, va_list) | |
3948 | ATTRIBUTE_FORMAT_PRINTF (1, 0); | |
27e498e6 | 3949 | extern void un_autoload (Lisp_Object); |
7f7e0167 | 3950 | extern Lisp_Object call_debugger (Lisp_Object arg); |
383e0970 | 3951 | extern void init_eval_once (void); |
6cd7a139 | 3952 | extern Lisp_Object safe_call (ptrdiff_t, Lisp_Object, ...); |
383e0970 | 3953 | extern Lisp_Object safe_call1 (Lisp_Object, Lisp_Object); |
58555d81 | 3954 | extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object); |
383e0970 J |
3955 | extern void init_eval (void); |
3956 | extern void syms_of_eval (void); | |
27e498e6 | 3957 | extern void unwind_body (Lisp_Object); |
2f592f95 SM |
3958 | extern void record_in_backtrace (Lisp_Object function, |
3959 | Lisp_Object *args, ptrdiff_t nargs); | |
3960 | extern void mark_specpdl (void); | |
3961 | extern void get_backtrace (Lisp_Object array); | |
3962 | Lisp_Object backtrace_top_function (void); | |
3963 | extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol); | |
3964 | extern bool let_shadows_global_binding_p (Lisp_Object symbol); | |
3965 | ||
3cfe6dfd | 3966 | |
7abaf5cc | 3967 | /* Defined in editfns.c. */ |
e6cba650 | 3968 | extern Lisp_Object Qfield; |
383e0970 | 3969 | extern void insert1 (Lisp_Object); |
a8fe7202 | 3970 | extern Lisp_Object format2 (const char *, Lisp_Object, Lisp_Object); |
383e0970 J |
3971 | extern Lisp_Object save_excursion_save (void); |
3972 | extern Lisp_Object save_restriction_save (void); | |
27e498e6 PE |
3973 | extern void save_excursion_restore (Lisp_Object); |
3974 | extern void save_restriction_restore (Lisp_Object); | |
845ca893 | 3975 | extern _Noreturn void time_overflow (void); |
a08d4ba7 | 3976 | extern Lisp_Object make_buffer_string (ptrdiff_t, ptrdiff_t, bool); |
d311d28c | 3977 | extern Lisp_Object make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, |
a08d4ba7 | 3978 | ptrdiff_t, bool); |
383e0970 J |
3979 | extern void init_editfns (void); |
3980 | extern void syms_of_editfns (void); | |
a8fe7202 | 3981 | extern void set_time_zone_rule (const char *); |
3cfe6dfd | 3982 | |
7abaf5cc | 3983 | /* Defined in buffer.c. */ |
37ef52bb | 3984 | extern bool mouse_face_overlay_overlaps (Lisp_Object); |
845ca893 | 3985 | extern _Noreturn void nsberror (Lisp_Object); |
d311d28c PE |
3986 | extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t); |
3987 | extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t); | |
3988 | extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t); | |
37ef52bb | 3989 | extern void report_overlay_modification (Lisp_Object, Lisp_Object, bool, |
383e0970 | 3990 | Lisp_Object, Lisp_Object, Lisp_Object); |
37ef52bb | 3991 | extern bool overlay_touches_p (ptrdiff_t); |
9397e56f | 3992 | extern Lisp_Object other_buffer_safely (Lisp_Object); |
383e0970 | 3993 | extern Lisp_Object get_truename_buffer (Lisp_Object); |
383e0970 J |
3994 | extern void init_buffer_once (void); |
3995 | extern void init_buffer (void); | |
3996 | extern void syms_of_buffer (void); | |
3997 | extern void keys_of_buffer (void); | |
3cfe6dfd | 3998 | |
7abaf5cc | 3999 | /* Defined in marker.c. */ |
3cfe6dfd | 4000 | |
d311d28c PE |
4001 | extern ptrdiff_t marker_position (Lisp_Object); |
4002 | extern ptrdiff_t marker_byte_position (Lisp_Object); | |
383e0970 | 4003 | extern void clear_charpos_cache (struct buffer *); |
d311d28c PE |
4004 | extern ptrdiff_t buf_charpos_to_bytepos (struct buffer *, ptrdiff_t); |
4005 | extern ptrdiff_t buf_bytepos_to_charpos (struct buffer *, ptrdiff_t); | |
eeaea515 | 4006 | extern void unchain_marker (struct Lisp_Marker *marker); |
383e0970 | 4007 | extern Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object); |
d311d28c | 4008 | extern Lisp_Object set_marker_both (Lisp_Object, Lisp_Object, ptrdiff_t, ptrdiff_t); |
383e0970 | 4009 | extern Lisp_Object set_marker_restricted_both (Lisp_Object, Lisp_Object, |
eeaea515 | 4010 | ptrdiff_t, ptrdiff_t); |
657924ff | 4011 | extern Lisp_Object build_marker (struct buffer *, ptrdiff_t, ptrdiff_t); |
383e0970 | 4012 | extern void syms_of_marker (void); |
3cfe6dfd | 4013 | |
e7032e7c | 4014 | /* Defined in fileio.c. */ |
3cfe6dfd JB |
4015 | |
4016 | extern Lisp_Object Qfile_error; | |
86dfb7a8 | 4017 | extern Lisp_Object Qfile_notify_error; |
99f3388e | 4018 | extern Lisp_Object Qfile_exists_p; |
e6cba650 DN |
4019 | extern Lisp_Object Qfile_directory_p; |
4020 | extern Lisp_Object Qinsert_file_contents; | |
7684e57b | 4021 | extern Lisp_Object Qfile_name_history; |
383e0970 | 4022 | extern Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object); |
94fcd171 PE |
4023 | extern Lisp_Object write_region (Lisp_Object, Lisp_Object, Lisp_Object, |
4024 | Lisp_Object, Lisp_Object, Lisp_Object, | |
4025 | Lisp_Object, int); | |
e7032e7c | 4026 | EXFUN (Fread_file_name, 6); /* Not a normal DEFUN. */ |
27e498e6 | 4027 | extern void close_file_unwind (int); |
f4b1eb36 | 4028 | extern void fclose_unwind (void *); |
27e498e6 | 4029 | extern void restore_point_unwind (Lisp_Object); |
a773ed9a | 4030 | extern _Noreturn void report_file_errno (const char *, Lisp_Object, int); |
845ca893 | 4031 | extern _Noreturn void report_file_error (const char *, Lisp_Object); |
7d80ea23 | 4032 | extern bool internal_delete_file (Lisp_Object); |
8654f9d7 | 4033 | extern Lisp_Object emacs_readlinkat (int, const char *); |
73dcdb9f PE |
4034 | extern bool file_directory_p (const char *); |
4035 | extern bool file_accessible_directory_p (const char *); | |
9fe43ff6 | 4036 | extern void init_fileio (void); |
383e0970 | 4037 | extern void syms_of_fileio (void); |
f75d7a91 | 4038 | extern Lisp_Object make_temp_name (Lisp_Object, bool); |
b86cfd28 | 4039 | extern Lisp_Object Qdelete_file; |
3cfe6dfd | 4040 | |
e7032e7c | 4041 | /* Defined in search.c. */ |
383e0970 | 4042 | extern void shrink_regexp_cache (void); |
383e0970 | 4043 | extern void restore_search_regs (void); |
383e0970 | 4044 | extern void record_unwind_save_match_data (void); |
dbd37a95 PE |
4045 | struct re_registers; |
4046 | extern struct re_pattern_buffer *compile_pattern (Lisp_Object, | |
4047 | struct re_registers *, | |
457882c2 | 4048 | Lisp_Object, bool, bool); |
d311d28c | 4049 | extern ptrdiff_t fast_string_match (Lisp_Object, Lisp_Object); |
d923b542 DA |
4050 | extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object, const char *, |
4051 | ptrdiff_t); | |
d311d28c PE |
4052 | extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object, Lisp_Object); |
4053 | extern ptrdiff_t fast_looking_at (Lisp_Object, ptrdiff_t, ptrdiff_t, | |
4054 | ptrdiff_t, ptrdiff_t, Lisp_Object); | |
b5426561 DA |
4055 | extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, |
4056 | ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool); | |
d2b36813 DA |
4057 | extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, |
4058 | ptrdiff_t, bool); | |
b5426561 DA |
4059 | extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t, |
4060 | ptrdiff_t, ptrdiff_t *); | |
2a14a4f1 DA |
4061 | extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, |
4062 | ptrdiff_t, ptrdiff_t *); | |
383e0970 J |
4063 | extern void syms_of_search (void); |
4064 | extern void clear_regexp_cache (void); | |
3cfe6dfd | 4065 | |
464d5a5e | 4066 | /* Defined in minibuf.c. */ |
3cfe6dfd | 4067 | |
e6cba650 | 4068 | extern Lisp_Object Qcompletion_ignore_case; |
99f3388e | 4069 | extern Lisp_Object Vminibuffer_list; |
3cfe6dfd | 4070 | extern Lisp_Object last_minibuf_string; |
62f19c19 | 4071 | extern Lisp_Object get_minibuffer (EMACS_INT); |
383e0970 J |
4072 | extern void init_minibuf_once (void); |
4073 | extern void syms_of_minibuf (void); | |
3cfe6dfd | 4074 | |
464d5a5e | 4075 | /* Defined in callint.c. */ |
3cfe6dfd | 4076 | |
29208e82 | 4077 | extern Lisp_Object Qminus, Qplus; |
99f3388e | 4078 | extern Lisp_Object Qwhen; |
6e65b9cc | 4079 | extern Lisp_Object Qmouse_leave_buffer_hook; |
383e0970 | 4080 | extern void syms_of_callint (void); |
3cfe6dfd | 4081 | |
464d5a5e | 4082 | /* Defined in casefiddle.c. */ |
3cfe6dfd | 4083 | |
99f3388e | 4084 | extern Lisp_Object Qidentity; |
383e0970 J |
4085 | extern void syms_of_casefiddle (void); |
4086 | extern void keys_of_casefiddle (void); | |
3cfe6dfd | 4087 | |
464d5a5e | 4088 | /* Defined in casetab.c. */ |
1747fb16 | 4089 | |
383e0970 J |
4090 | extern void init_casetab_once (void); |
4091 | extern void syms_of_casetab (void); | |
1747fb16 | 4092 | |
464d5a5e | 4093 | /* Defined in keyboard.c. */ |
3cfe6dfd | 4094 | |
54cd1651 | 4095 | extern Lisp_Object echo_message_buffer; |
417750de | 4096 | extern struct kboard *echo_kboard; |
383e0970 | 4097 | extern void cancel_echoing (void); |
1425dcb6 | 4098 | extern Lisp_Object Qdisabled, QCfilter; |
955cbe7b PE |
4099 | extern Lisp_Object Qup, Qdown, Qbottom; |
4100 | extern Lisp_Object Qtop; | |
464d5a5e | 4101 | extern Lisp_Object last_undo_boundary; |
9fa1de30 | 4102 | extern bool input_pending; |
383e0970 J |
4103 | extern Lisp_Object menu_bar_items (Lisp_Object); |
4104 | extern Lisp_Object tool_bar_items (Lisp_Object, int *); | |
383e0970 | 4105 | extern void discard_mouse_events (void); |
4d7e6e51 PE |
4106 | #ifdef USABLE_SIGIO |
4107 | void handle_input_available_signal (int); | |
4108 | #endif | |
58555d81 | 4109 | extern Lisp_Object pending_funcalls; |
9fa1de30 PE |
4110 | extern bool detect_input_pending (void); |
4111 | extern bool detect_input_pending_ignore_squeezables (void); | |
4112 | extern bool detect_input_pending_run_timers (bool); | |
383e0970 | 4113 | extern void safe_run_hooks (Lisp_Object); |
a8fe7202 | 4114 | extern void cmd_error_internal (Lisp_Object, const char *); |
383e0970 | 4115 | extern Lisp_Object command_loop_1 (void); |
3b158d11 | 4116 | extern Lisp_Object read_menu_command (void); |
383e0970 J |
4117 | extern Lisp_Object recursive_edit_1 (void); |
4118 | extern void record_auto_save (void); | |
4752793e | 4119 | extern void force_auto_save_soon (void); |
383e0970 J |
4120 | extern void init_keyboard (void); |
4121 | extern void syms_of_keyboard (void); | |
4122 | extern void keys_of_keyboard (void); | |
3cfe6dfd | 4123 | |
464d5a5e | 4124 | /* Defined in indent.c. */ |
d311d28c | 4125 | extern ptrdiff_t current_column (void); |
383e0970 | 4126 | extern void invalidate_current_column (void); |
578098f3 | 4127 | extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT); |
383e0970 | 4128 | extern void syms_of_indent (void); |
3cfe6dfd | 4129 | |
464d5a5e | 4130 | /* Defined in frame.c. */ |
9fb0c957 | 4131 | extern Lisp_Object Qonly, Qnone; |
362fb47a | 4132 | extern Lisp_Object Qvisible; |
880e6158 | 4133 | extern void set_frame_param (struct frame *, Lisp_Object, Lisp_Object); |
383e0970 J |
4134 | extern void store_frame_param (struct frame *, Lisp_Object, Lisp_Object); |
4135 | extern void store_in_alist (Lisp_Object *, Lisp_Object, Lisp_Object); | |
4136 | extern Lisp_Object do_switch_frame (Lisp_Object, int, int, Lisp_Object); | |
336fe071 | 4137 | #if HAVE_NS || HAVE_NTGUI |
383e0970 | 4138 | extern Lisp_Object get_frame_param (struct frame *, Lisp_Object); |
81626931 | 4139 | #endif |
383e0970 | 4140 | extern void frames_discard_buffer (Lisp_Object); |
383e0970 | 4141 | extern void syms_of_frame (void); |
3cfe6dfd | 4142 | |
464d5a5e | 4143 | /* Defined in emacs.c. */ |
99f3388e DN |
4144 | extern char **initial_argv; |
4145 | extern int initial_argc; | |
5e617bc2 | 4146 | #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS) |
1882aa38 | 4147 | extern bool display_arg; |
89dc303e | 4148 | #endif |
17e0445b | 4149 | extern Lisp_Object decode_env_path (const char *, const char *, bool); |
2c668b9a | 4150 | extern Lisp_Object empty_unibyte_string, empty_multibyte_string; |
e6cba650 | 4151 | extern Lisp_Object Qfile_name_handler_alist; |
4d7e6e51 | 4152 | extern _Noreturn void terminate_due_to_signal (int, int); |
6c07aac2 | 4153 | extern Lisp_Object Qkill_emacs; |
aa15c6bb JB |
4154 | #ifdef WINDOWSNT |
4155 | extern Lisp_Object Vlibrary_cache; | |
4156 | #endif | |
68c45bf0 | 4157 | #if HAVE_SETLOCALE |
383e0970 J |
4158 | void fixup_locale (void); |
4159 | void synchronize_system_messages_locale (void); | |
4160 | void synchronize_system_time_locale (void); | |
68c45bf0 | 4161 | #else |
00382e8b PE |
4162 | INLINE void fixup_locale (void) {} |
4163 | INLINE void synchronize_system_messages_locale (void) {} | |
4164 | INLINE void synchronize_system_time_locale (void) {} | |
68c45bf0 | 4165 | #endif |
1882aa38 | 4166 | extern void shut_down_emacs (int, Lisp_Object); |
ff808935 | 4167 | |
1882aa38 PE |
4168 | /* True means don't do interactive redisplay and don't change tty modes. */ |
4169 | extern bool noninteractive; | |
4170 | ||
4171 | /* True means remove site-lisp directories from load-path. */ | |
4172 | extern bool no_site_lisp; | |
66b7b0fe | 4173 | |
ff808935 DN |
4174 | /* Pipe used to send exit notification to the daemon parent at |
4175 | startup. */ | |
4176 | extern int daemon_pipe[2]; | |
4177 | #define IS_DAEMON (daemon_pipe[1] != 0) | |
4178 | ||
1882aa38 PE |
4179 | /* True if handling a fatal error already. */ |
4180 | extern bool fatal_error_in_progress; | |
4181 | ||
4182 | /* True means don't do use window-system-specific display code. */ | |
4183 | extern bool inhibit_window_system; | |
4184 | /* True means that a filter or a sentinel is running. */ | |
4185 | extern bool running_asynch_code; | |
3cfe6dfd | 4186 | |
6c60eb9f | 4187 | /* Defined in process.c. */ |
89dc303e | 4188 | extern Lisp_Object QCtype, Qlocal; |
383e0970 | 4189 | extern void kill_buffer_processes (Lisp_Object); |
0bce5d9e PE |
4190 | extern bool wait_reading_process_output (intmax_t, int, int, bool, |
4191 | Lisp_Object, | |
4192 | struct Lisp_Process *, | |
4193 | int); | |
f1dd8073 PE |
4194 | /* Max value for the first argument of wait_reading_process_output. */ |
4195 | #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5) | |
4196 | /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3. | |
4197 | The bug merely causes a bogus warning, but the warning is annoying. */ | |
4198 | # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX) | |
4199 | #else | |
4200 | # define WAIT_READING_MAX INTMAX_MAX | |
4201 | #endif | |
383e0970 J |
4202 | extern void add_keyboard_wait_descriptor (int); |
4203 | extern void delete_keyboard_wait_descriptor (int); | |
4475bec4 | 4204 | #ifdef HAVE_GPM |
383e0970 J |
4205 | extern void add_gpm_wait_descriptor (int); |
4206 | extern void delete_gpm_wait_descriptor (int); | |
4475bec4 | 4207 | #endif |
b82da769 | 4208 | extern void init_process_emacs (void); |
383e0970 J |
4209 | extern void syms_of_process (void); |
4210 | extern void setup_process_coding_systems (Lisp_Object); | |
3cfe6dfd | 4211 | |
4ebbdd67 | 4212 | /* Defined in callproc.c. */ |
6bd8c144 | 4213 | #ifndef DOS_NT |
845ca893 | 4214 | _Noreturn |
6bd8c144 | 4215 | #endif |
2f221583 | 4216 | extern int child_setup (int, int, int, char **, bool, Lisp_Object); |
383e0970 J |
4217 | extern void init_callproc_1 (void); |
4218 | extern void init_callproc (void); | |
4219 | extern void set_initial_environment (void); | |
4220 | extern void syms_of_callproc (void); | |
3cfe6dfd | 4221 | |
e7032e7c | 4222 | /* Defined in doc.c. */ |
99f3388e | 4223 | extern Lisp_Object Qfunction_documentation; |
383e0970 | 4224 | extern Lisp_Object read_doc_string (Lisp_Object); |
a08d4ba7 | 4225 | extern Lisp_Object get_doc_string (Lisp_Object, bool, bool); |
383e0970 | 4226 | extern void syms_of_doc (void); |
a08d4ba7 | 4227 | extern int read_bytecode_char (bool); |
3cfe6dfd | 4228 | |
e7032e7c | 4229 | /* Defined in bytecode.c. */ |
383e0970 | 4230 | extern void syms_of_bytecode (void); |
35c7a974 | 4231 | extern struct byte_stack *byte_stack_list; |
244ed907 | 4232 | #if BYTE_MARK_STACK |
383e0970 | 4233 | extern void mark_byte_stack (void); |
b286858c | 4234 | #endif |
383e0970 | 4235 | extern void unmark_byte_stack (void); |
0ee81a0c | 4236 | extern Lisp_Object exec_byte_code (Lisp_Object, Lisp_Object, Lisp_Object, |
f66c7cf8 | 4237 | Lisp_Object, ptrdiff_t, Lisp_Object *); |
3cfe6dfd | 4238 | |
e7032e7c | 4239 | /* Defined in macros.c. */ |
383e0970 J |
4240 | extern void init_macros (void); |
4241 | extern void syms_of_macros (void); | |
3cfe6dfd | 4242 | |
e7032e7c | 4243 | /* Defined in undo.c. */ |
89dc303e | 4244 | extern Lisp_Object Qapply; |
a387611b | 4245 | extern Lisp_Object Qinhibit_read_only; |
383e0970 | 4246 | extern void truncate_undo_list (struct buffer *); |
d311d28c | 4247 | extern void record_insert (ptrdiff_t, ptrdiff_t); |
37ea8275 | 4248 | extern void record_delete (ptrdiff_t, Lisp_Object, bool); |
383e0970 | 4249 | extern void record_first_change (void); |
d311d28c PE |
4250 | extern void record_change (ptrdiff_t, ptrdiff_t); |
4251 | extern void record_property_change (ptrdiff_t, ptrdiff_t, | |
c8a66ab8 | 4252 | Lisp_Object, Lisp_Object, |
383e0970 J |
4253 | Lisp_Object); |
4254 | extern void syms_of_undo (void); | |
e7032e7c | 4255 | /* Defined in textprop.c. */ |
5f6bf5fe | 4256 | extern Lisp_Object Qfont, Qmouse_face; |
c2d8811c | 4257 | extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks; |
e6cba650 DN |
4258 | extern Lisp_Object Qfront_sticky, Qrear_nonsticky; |
4259 | extern Lisp_Object Qminibuffer_prompt; | |
4260 | ||
383e0970 | 4261 | extern void report_interval_modification (Lisp_Object, Lisp_Object); |
8537f1cb | 4262 | |
e7032e7c | 4263 | /* Defined in menu.c. */ |
383e0970 | 4264 | extern void syms_of_menu (void); |
febcacdd | 4265 | |
e7032e7c | 4266 | /* Defined in xmenu.c. */ |
383e0970 | 4267 | extern void syms_of_xmenu (void); |
526a2be7 | 4268 | |
e7032e7c | 4269 | /* Defined in termchar.h. */ |
28d7d09f KL |
4270 | struct tty_display_info; |
4271 | ||
e7032e7c | 4272 | /* Defined in termhooks.h. */ |
6ed8eeff | 4273 | struct terminal; |
28d440ab | 4274 | |
e7032e7c | 4275 | /* Defined in sysdep.c. */ |
2412f586 | 4276 | #ifndef HAVE_GET_CURRENT_DIR_NAME |
383e0970 | 4277 | extern char *get_current_dir_name (void); |
2b94e598 | 4278 | #endif |
383e0970 | 4279 | extern void stuff_char (char c); |
322aea6d | 4280 | extern void init_foreground_group (void); |
383e0970 J |
4281 | extern void init_sigio (int); |
4282 | extern void sys_subshell (void); | |
4283 | extern void sys_suspend (void); | |
4284 | extern void discard_tty_input (void); | |
b8956427 PE |
4285 | extern void block_tty_out_signal (void); |
4286 | extern void unblock_tty_out_signal (void); | |
383e0970 J |
4287 | extern void init_sys_modes (struct tty_display_info *); |
4288 | extern void reset_sys_modes (struct tty_display_info *); | |
4289 | extern void init_all_sys_modes (void); | |
4290 | extern void reset_all_sys_modes (void); | |
383e0970 J |
4291 | extern void child_setup_tty (int); |
4292 | extern void setup_pty (int); | |
4293 | extern int set_window_size (int, int, int); | |
ede49d71 | 4294 | extern EMACS_INT get_random (void); |
0e23ef9d PE |
4295 | extern void seed_random (void *, ptrdiff_t); |
4296 | extern void init_random (void); | |
cf29dd84 | 4297 | extern void emacs_backtrace (int); |
1088b922 | 4298 | extern _Noreturn void emacs_abort (void) NO_INLINE; |
383e0970 | 4299 | extern int emacs_open (const char *, int, int); |
c7ddc792 | 4300 | extern int emacs_pipe (int[2]); |
383e0970 | 4301 | extern int emacs_close (int); |
223752d7 PE |
4302 | extern ptrdiff_t emacs_read (int, void *, ptrdiff_t); |
4303 | extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t); | |
4304 | extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t); | |
4ebbdd67 | 4305 | extern void emacs_perror (char const *); |
526a2be7 | 4306 | |
383e0970 J |
4307 | extern void unlock_all_files (void); |
4308 | extern void lock_file (Lisp_Object); | |
4309 | extern void unlock_file (Lisp_Object); | |
4310 | extern void unlock_buffer (struct buffer *); | |
4311 | extern void syms_of_filelock (void); | |
15b0ced5 | 4312 | |
e7032e7c | 4313 | /* Defined in sound.c. */ |
383e0970 | 4314 | extern void syms_of_sound (void); |
46abf440 | 4315 | |
e7032e7c | 4316 | /* Defined in category.c. */ |
383e0970 J |
4317 | extern void init_category_once (void); |
4318 | extern Lisp_Object char_category_set (int); | |
4319 | extern void syms_of_category (void); | |
46abf440 | 4320 | |
e7032e7c | 4321 | /* Defined in ccl.c. */ |
383e0970 | 4322 | extern void syms_of_ccl (void); |
46abf440 | 4323 | |
e7032e7c | 4324 | /* Defined in dired.c. */ |
383e0970 J |
4325 | extern void syms_of_dired (void); |
4326 | extern Lisp_Object directory_files_internal (Lisp_Object, Lisp_Object, | |
4327 | Lisp_Object, Lisp_Object, | |
86ec63ba | 4328 | bool, Lisp_Object); |
46abf440 | 4329 | |
e7032e7c | 4330 | /* Defined in term.c. */ |
e6cba650 | 4331 | extern int *char_ins_del_vector; |
383e0970 | 4332 | extern void syms_of_term (void); |
845ca893 PE |
4333 | extern _Noreturn void fatal (const char *msgid, ...) |
4334 | ATTRIBUTE_FORMAT_PRINTF (1, 2); | |
46abf440 | 4335 | |
e7032e7c | 4336 | /* Defined in terminal.c. */ |
383e0970 | 4337 | extern void syms_of_terminal (void); |
ed8dad6b | 4338 | |
e7032e7c | 4339 | /* Defined in font.c. */ |
383e0970 J |
4340 | extern void syms_of_font (void); |
4341 | extern void init_font (void); | |
b86cfd28 | 4342 | |
4f48f1ab | 4343 | #ifdef HAVE_WINDOW_SYSTEM |
e7032e7c | 4344 | /* Defined in fontset.c. */ |
383e0970 | 4345 | extern void syms_of_fontset (void); |
4f48f1ab | 4346 | |
e7032e7c | 4347 | /* Defined in xfns.c, w32fns.c, or macfns.c. */ |
99f3388e | 4348 | extern Lisp_Object Qfont_param; |
46abf440 AS |
4349 | #endif |
4350 | ||
c9628c79 MA |
4351 | /* Defined in gfilenotify.c */ |
4352 | #ifdef HAVE_GFILENOTIFY | |
90db8702 | 4353 | extern void globals_of_gfilenotify (void); |
c9628c79 | 4354 | extern void syms_of_gfilenotify (void); |
477f1e50 EZ |
4355 | #endif |
4356 | ||
81606b10 RS |
4357 | /* Defined in inotify.c */ |
4358 | #ifdef HAVE_INOTIFY | |
4359 | extern void syms_of_inotify (void); | |
4360 | #endif | |
4361 | ||
c9628c79 MA |
4362 | #ifdef HAVE_W32NOTIFY |
4363 | /* Defined on w32notify.c. */ | |
4364 | extern void syms_of_w32notify (void); | |
4365 | #endif | |
4366 | ||
e7032e7c | 4367 | /* Defined in xfaces.c. */ |
955cbe7b PE |
4368 | extern Lisp_Object Qdefault, Qtool_bar, Qfringe; |
4369 | extern Lisp_Object Qheader_line, Qscroll_bar, Qcursor; | |
4370 | extern Lisp_Object Qmode_line_inactive; | |
e6cba650 | 4371 | extern Lisp_Object Qface; |
89dc303e | 4372 | extern Lisp_Object Qnormal; |
0e9c8657 JB |
4373 | extern Lisp_Object QCfamily, QCweight, QCslant; |
4374 | extern Lisp_Object QCheight, QCname, QCwidth, QCforeground, QCbackground; | |
a411ac43 PE |
4375 | extern Lisp_Object Qextra_light, Qlight, Qsemi_light, Qsemi_bold; |
4376 | extern Lisp_Object Qbold, Qextra_bold, Qultra_bold; | |
4377 | extern Lisp_Object Qoblique, Qitalic; | |
99f3388e | 4378 | extern Lisp_Object Vface_alternative_font_family_alist; |
99f3388e | 4379 | extern Lisp_Object Vface_alternative_font_registry_alist; |
383e0970 | 4380 | extern void syms_of_xfaces (void); |
46abf440 AS |
4381 | |
4382 | #ifdef HAVE_X_WINDOWS | |
e7032e7c | 4383 | /* Defined in xfns.c. */ |
383e0970 | 4384 | extern void syms_of_xfns (void); |
46abf440 | 4385 | |
e7032e7c | 4386 | /* Defined in xsmfns.c. */ |
383e0970 | 4387 | extern void syms_of_xsmfns (void); |
e02207d4 | 4388 | |
e7032e7c | 4389 | /* Defined in xselect.c. */ |
383e0970 | 4390 | extern void syms_of_xselect (void); |
46abf440 | 4391 | |
e7032e7c | 4392 | /* Defined in xterm.c. */ |
383e0970 | 4393 | extern void syms_of_xterm (void); |
4f48f1ab | 4394 | #endif /* HAVE_X_WINDOWS */ |
4baa6f88 | 4395 | |
7af07b96 | 4396 | #ifdef HAVE_WINDOW_SYSTEM |
e7032e7c | 4397 | /* Defined in xterm.c, nsterm.m, w32term.c. */ |
7af07b96 AS |
4398 | extern char *x_get_keysym_name (int); |
4399 | #endif /* HAVE_WINDOW_SYSTEM */ | |
4400 | ||
381408e2 | 4401 | #ifdef HAVE_LIBXML2 |
e7032e7c | 4402 | /* Defined in xml.c. */ |
381408e2 | 4403 | extern void syms_of_xml (void); |
9078ead6 | 4404 | extern void xml_cleanup_parser (void); |
381408e2 LMI |
4405 | #endif |
4406 | ||
313546eb LMI |
4407 | #ifdef HAVE_ZLIB |
4408 | /* Defined in decompress.c. */ | |
4409 | extern void syms_of_decompress (void); | |
4410 | #endif | |
4411 | ||
b86cfd28 | 4412 | #ifdef HAVE_DBUS |
e7032e7c | 4413 | /* Defined in dbusbind.c. */ |
383e0970 | 4414 | void syms_of_dbusbind (void); |
b86cfd28 | 4415 | #endif |
36e053eb | 4416 | |
ad942b63 SM |
4417 | |
4418 | /* Defined in profiler.c. */ | |
6521894d | 4419 | extern bool profiler_memory_running; |
c2d7786e | 4420 | extern void malloc_probe (size_t); |
c2d7786e TM |
4421 | extern void syms_of_profiler (void); |
4422 | ||
ad942b63 | 4423 | |
36e053eb | 4424 | #ifdef DOS_NT |
e7032e7c | 4425 | /* Defined in msdos.c, w32.c. */ |
36e053eb DN |
4426 | extern char *emacs_root_dir (void); |
4427 | #endif /* DOS_NT */ | |
83925baa | 4428 | \f |
1882aa38 | 4429 | /* True means Emacs has already been initialized. |
3cfe6dfd | 4430 | Used during startup to detect startup of dumped Emacs. */ |
1882aa38 | 4431 | extern bool initialized; |
3cfe6dfd | 4432 | |
9fa1de30 PE |
4433 | /* True means ^G can quit instantly. */ |
4434 | extern bool immediate_quit; | |
3cfe6dfd | 4435 | |
261cb4bb | 4436 | extern void *xmalloc (size_t); |
23f86fce | 4437 | extern void *xzalloc (size_t); |
261cb4bb PE |
4438 | extern void *xrealloc (void *, size_t); |
4439 | extern void xfree (void *); | |
0065d054 PE |
4440 | extern void *xnmalloc (ptrdiff_t, ptrdiff_t); |
4441 | extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t); | |
4442 | extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t); | |
074b6efe | 4443 | |
383e0970 | 4444 | extern char *xstrdup (const char *); |
5b71542d | 4445 | extern char *xlispstrdup (Lisp_Object); |
8268febf | 4446 | extern void dupstring (char **, char const *); |
5745a7df | 4447 | extern void xputenv (const char *); |
3cfe6dfd | 4448 | |
a8fe7202 | 4449 | extern char *egetenv (const char *); |
e98227af | 4450 | |
5b71542d DA |
4451 | /* Copy Lisp string to temporary (allocated on stack) C string. */ |
4452 | ||
4453 | #define xlispstrdupa(string) \ | |
4454 | memcpy (alloca (SBYTES (string) + 1), \ | |
4455 | SSDATA (string), SBYTES (string) + 1) | |
4456 | ||
5d6be39f | 4457 | /* Set up the name of the machine we're running on. */ |
383e0970 | 4458 | extern void init_system_name (void); |
881a5a80 | 4459 | |
d7a0a7c9 PE |
4460 | /* Return the absolute value of X. X should be a signed integer |
4461 | expression without side effects, and X's absolute value should not | |
4462 | exceed the maximum for its promoted type. This is called 'eabs' | |
4463 | because 'abs' is reserved by the C standard. */ | |
555b10b0 | 4464 | #define eabs(x) ((x) < 0 ? -(x) : (x)) |
096e8667 | 4465 | |
53ede3f4 GM |
4466 | /* Return a fixnum or float, depending on whether VAL fits in a Lisp |
4467 | fixnum. */ | |
4468 | ||
4469 | #define make_fixnum_or_float(val) \ | |
cbeff735 | 4470 | (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val)) |
6b61353c | 4471 | |
79518a8d KS |
4472 | /* SAFE_ALLOCA normally allocates memory on the stack, but if size is |
4473 | larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */ | |
4474 | ||
e7032e7c | 4475 | enum MAX_ALLOCA { MAX_ALLOCA = 16 * 1024 }; |
79518a8d | 4476 | |
98c6f1e3 | 4477 | extern void *record_xmalloc (size_t); |
79518a8d KS |
4478 | |
4479 | #define USE_SAFE_ALLOCA \ | |
96c06863 | 4480 | ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false |
79518a8d | 4481 | |
a9e6bacc KS |
4482 | /* SAFE_ALLOCA allocates a simple buffer. */ |
4483 | ||
98c6f1e3 PE |
4484 | #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \ |
4485 | ? alloca (size) \ | |
96c06863 | 4486 | : (sa_must_free = true, record_xmalloc (size))) |
79518a8d | 4487 | |
0065d054 PE |
4488 | /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER * |
4489 | NITEMS items, each of the same type as *BUF. MULTIPLIER must | |
4490 | positive. The code is tuned for MULTIPLIER being a constant. */ | |
4491 | ||
468afbac DA |
4492 | #define SAFE_NALLOCA(buf, multiplier, nitems) \ |
4493 | do { \ | |
4494 | if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \ | |
4495 | (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \ | |
4496 | else \ | |
0065d054 PE |
4497 | { \ |
4498 | (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \ | |
96c06863 | 4499 | sa_must_free = true; \ |
27e498e6 | 4500 | record_unwind_protect_ptr (xfree, buf); \ |
0065d054 | 4501 | } \ |
96c06863 | 4502 | } while (false) |
0065d054 | 4503 | |
a9e6bacc KS |
4504 | /* SAFE_FREE frees xmalloced memory and enables GC as needed. */ |
4505 | ||
c33188d9 | 4506 | #define SAFE_FREE() \ |
79518a8d | 4507 | do { \ |
c33188d9 | 4508 | if (sa_must_free) { \ |
96c06863 | 4509 | sa_must_free = false; \ |
79518a8d | 4510 | unbind_to (sa_count, Qnil); \ |
c33188d9 | 4511 | } \ |
96c06863 | 4512 | } while (false) |
79518a8d KS |
4513 | |
4514 | ||
5f5d6c62 KS |
4515 | /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */ |
4516 | ||
663e2b3f DA |
4517 | #define SAFE_ALLOCA_LISP(buf, nelt) \ |
4518 | do { \ | |
4519 | if ((nelt) < MAX_ALLOCA / word_size) \ | |
96c06863 | 4520 | (buf) = alloca ((nelt) * word_size); \ |
663e2b3f DA |
4521 | else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \ |
4522 | { \ | |
4523 | Lisp_Object arg_; \ | |
96c06863 | 4524 | (buf) = xmalloc ((nelt) * word_size); \ |
1396ac86 | 4525 | arg_ = make_save_memory (buf, nelt); \ |
96c06863 | 4526 | sa_must_free = true; \ |
27e498e6 | 4527 | record_unwind_protect (free_save_value, arg_); \ |
663e2b3f DA |
4528 | } \ |
4529 | else \ | |
4530 | memory_full (SIZE_MAX); \ | |
96c06863 | 4531 | } while (false) |
5f5d6c62 | 4532 | |
105324ce SM |
4533 | /* Loop over all tails of a list, checking for cycles. |
4534 | FIXME: Make tortoise and n internal declarations. | |
4535 | FIXME: Unroll the loop body so we don't need `n'. */ | |
4536 | #define FOR_EACH_TAIL(hare, list, tortoise, n) \ | |
96c06863 | 4537 | for ((tortoise) = (hare) = (list), (n) = true; \ |
105324ce | 4538 | CONSP (hare); \ |
96c06863 PE |
4539 | (hare = XCDR (hare), (n) = !(n), \ |
4540 | ((n) \ | |
4541 | ? (EQ (hare, tortoise) \ | |
4542 | ? xsignal1 (Qcircular_list, list) \ | |
4543 | : (void) 0) \ | |
105324ce SM |
4544 | /* Move tortoise before the next iteration, in case */ \ |
4545 | /* the next iteration does an Fsetcdr. */ \ | |
96c06863 | 4546 | : (void) ((tortoise) = XCDR (tortoise))))) |
105324ce | 4547 | |
d5a1acfa DA |
4548 | /* Do a `for' loop over alist values. */ |
4549 | ||
4550 | #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \ | |
96c06863 PE |
4551 | for ((list_var) = (head_var); \ |
4552 | (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \ | |
4553 | (list_var) = XCDR (list_var)) | |
79518a8d | 4554 | |
dac616ff DA |
4555 | /* Check whether it's time for GC, and run it if so. */ |
4556 | ||
00382e8b | 4557 | INLINE void |
dac616ff DA |
4558 | maybe_gc (void) |
4559 | { | |
4560 | if ((consing_since_gc > gc_cons_threshold | |
4561 | && consing_since_gc > gc_relative_threshold) | |
4562 | || (!NILP (Vmemory_full) | |
4563 | && consing_since_gc > memory_full_cons_threshold)) | |
4564 | Fgarbage_collect (); | |
4565 | } | |
4566 | ||
00382e8b | 4567 | INLINE bool |
e1f29348 BR |
4568 | functionp (Lisp_Object object) |
4569 | { | |
4570 | if (SYMBOLP (object) && !NILP (Ffboundp (object))) | |
4571 | { | |
4572 | object = Findirect_function (object, Qt); | |
4573 | ||
4574 | if (CONSP (object) && EQ (XCAR (object), Qautoload)) | |
4575 | { | |
4576 | /* Autoloaded symbols are functions, except if they load | |
4577 | macros or keymaps. */ | |
4578 | int i; | |
4579 | for (i = 0; i < 4 && CONSP (object); i++) | |
4580 | object = XCDR (object); | |
4581 | ||
4582 | return ! (CONSP (object) && !NILP (XCAR (object))); | |
4583 | } | |
4584 | } | |
4585 | ||
4586 | if (SUBRP (object)) | |
4587 | return XSUBR (object)->max_args != UNEVALLED; | |
4588 | else if (COMPILEDP (object)) | |
96c06863 | 4589 | return true; |
e1f29348 BR |
4590 | else if (CONSP (object)) |
4591 | { | |
4592 | Lisp_Object car = XCAR (object); | |
4593 | return EQ (car, Qlambda) || EQ (car, Qclosure); | |
4594 | } | |
4595 | else | |
96c06863 | 4596 | return false; |
e1f29348 BR |
4597 | } |
4598 | ||
f162bcc3 PE |
4599 | INLINE_HEADER_END |
4600 | ||
6b61353c | 4601 | #endif /* EMACS_LISP_H */ |