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