Commit | Line | Data |
---|---|---|
3cfe6dfd | 1 | /* Fundamental definitions for GNU Emacs Lisp interpreter. |
e2017fe2 GM |
2 | |
3 | Copyright (C) 1985-1987, 1993-1995, 1997-2012 Free Software Foundation, Inc. | |
3cfe6dfd JB |
4 | |
5 | This file is part of GNU Emacs. | |
6 | ||
b9b1cc14 | 7 | GNU Emacs is free software: you can redistribute it and/or modify |
3cfe6dfd | 8 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
9 | the Free Software Foundation, either version 3 of the License, or |
10 | (at your option) any later version. | |
3cfe6dfd JB |
11 | |
12 | GNU Emacs is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
b9b1cc14 | 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
3cfe6dfd | 19 | |
6b61353c KH |
20 | #ifndef EMACS_LISP_H |
21 | #define EMACS_LISP_H | |
22 | ||
6a8033e1 | 23 | #include <stdarg.h> |
89887d67 | 24 | #include <stddef.h> |
8ac068ac | 25 | #include <inttypes.h> |
dd3482fe | 26 | #include <limits.h> |
6a8033e1 | 27 | |
be44ca6c PE |
28 | #include <intprops.h> |
29 | ||
7b3a82d7 DN |
30 | /* Use the configure flag --enable-checking[=LIST] to enable various |
31 | types of run time checks for Lisp objects. */ | |
35f464a7 | 32 | |
cdf61d83 | 33 | #ifdef GC_CHECK_CONS_LIST |
e5aab7e7 PE |
34 | extern void check_cons_list (void); |
35 | #define CHECK_CONS_LIST() check_cons_list () | |
cdf61d83 | 36 | #else |
e5aab7e7 | 37 | #define CHECK_CONS_LIST() ((void) 0) |
cdf61d83 | 38 | #endif |
3cfe6dfd | 39 | |
122b0c86 PE |
40 | /* Temporarily disable wider-than-pointer integers until they're tested more. |
41 | Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */ | |
42 | /* #undef WIDE_EMACS_INT */ | |
43 | ||
34374650 PE |
44 | /* EMACS_INT - signed integer wide enough to hold an Emacs value |
45 | EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if | |
46 | pI - printf length modifier for EMACS_INT | |
47 | EMACS_UINT - unsigned variant of EMACS_INT */ | |
71f88e00 | 48 | #ifndef EMACS_INT_MAX |
34374650 | 49 | # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT |
71f88e00 PE |
50 | typedef long long int EMACS_INT; |
51 | typedef unsigned long long int EMACS_UINT; | |
34374650 | 52 | # define EMACS_INT_MAX LLONG_MAX |
47be4ab5 | 53 | # define pI "ll" |
34374650 | 54 | # elif INT_MAX < LONG_MAX |
71f88e00 PE |
55 | typedef long int EMACS_INT; |
56 | typedef unsigned long int EMACS_UINT; | |
34374650 | 57 | # define EMACS_INT_MAX LONG_MAX |
47be4ab5 PE |
58 | # define pI "l" |
59 | # else | |
71f88e00 PE |
60 | typedef int EMACS_INT; |
61 | typedef unsigned int EMACS_UINT; | |
34374650 | 62 | # define EMACS_INT_MAX INT_MAX |
47be4ab5 PE |
63 | # define pI "" |
64 | # endif | |
68c45bf0 | 65 | #endif |
34374650 PE |
66 | |
67 | /* Number of bits in some machine integer types. */ | |
68 | enum | |
69 | { | |
70 | BITS_PER_CHAR = CHAR_BIT, | |
71 | BITS_PER_SHORT = CHAR_BIT * sizeof (short), | |
72 | BITS_PER_INT = CHAR_BIT * sizeof (int), | |
73 | BITS_PER_LONG = CHAR_BIT * sizeof (long int), | |
74 | BITS_PER_EMACS_INT = CHAR_BIT * sizeof (EMACS_INT) | |
75 | }; | |
ce99fd65 | 76 | |
a81d11a3 PE |
77 | /* printmax_t and uprintmax_t are types for printing large integers. |
78 | These are the widest integers that are supported for printing. | |
79 | pMd etc. are conversions for printing them. | |
80 | On C99 hosts, there's no problem, as even the widest integers work. | |
81 | Fall back on EMACS_INT on pre-C99 hosts. */ | |
82 | #ifdef PRIdMAX | |
83 | typedef intmax_t printmax_t; | |
84 | typedef uintmax_t uprintmax_t; | |
85 | # define pMd PRIdMAX | |
86 | # define pMu PRIuMAX | |
87 | #else | |
88 | typedef EMACS_INT printmax_t; | |
89 | typedef EMACS_UINT uprintmax_t; | |
90 | # define pMd pI"d" | |
91 | # define pMu pI"u" | |
92 | #endif | |
93 | ||
9c4c5f81 PE |
94 | /* Use pD to format ptrdiff_t values, which suffice for indexes into |
95 | buffers and strings. Emacs never allocates objects larger than | |
96 | PTRDIFF_MAX bytes, as they cause problems with pointer subtraction. | |
97 | In C99, pD can always be "t"; configure it here for the sake of | |
98 | pre-C99 libraries such as glibc 2.0 and Solaris 8. */ | |
99 | #if PTRDIFF_MAX == INT_MAX | |
100 | # define pD "" | |
101 | #elif PTRDIFF_MAX == LONG_MAX | |
102 | # define pD "l" | |
103 | #elif PTRDIFF_MAX == LLONG_MAX | |
104 | # define pD "ll" | |
105 | #else | |
106 | # define pD "t" | |
107 | #endif | |
108 | ||
e0b8c689 | 109 | /* Extra internal type checking? */ |
c6129d7e | 110 | |
310fbfa8 PE |
111 | /* Define an Emacs version of 'assert (COND)', since some |
112 | system-defined 'assert's are flaky. COND should be free of side | |
113 | effects; it may or may not be evaluated. */ | |
114 | #ifndef ENABLE_CHECKING | |
115 | # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */ | |
116 | #else /* ENABLE_CHECKING */ | |
c6129d7e | 117 | |
845ca893 | 118 | extern _Noreturn void die (const char *, const char *, int); |
244ed907 | 119 | |
383b707e KR |
120 | /* The suppress_checking variable is initialized to 0 in alloc.c. Set |
121 | it to 1 using a debugger to temporarily disable aborting on | |
122 | detected internal inconsistencies or error conditions. | |
123 | ||
383b707e | 124 | In some cases, a good compiler may be able to optimize away the |
310fbfa8 | 125 | eassert macro altogether, e.g., if XSTRING (x) uses eassert to test |
383b707e KR |
126 | STRINGP (x), but a particular use of XSTRING is invoked only after |
127 | testing that STRINGP (x) is true, making the test redundant. */ | |
244ed907 PE |
128 | extern int suppress_checking EXTERNALLY_VISIBLE; |
129 | ||
310fbfa8 PE |
130 | # define eassert(cond) \ |
131 | ((cond) || suppress_checking \ | |
132 | ? (void) 0 \ | |
133 | : die ("assertion failed: " # cond, __FILE__, __LINE__)) | |
3694b4ab | 134 | #endif /* ENABLE_CHECKING */ |
b9466edb | 135 | \f |
646b5f55 AS |
136 | /* Use the configure flag --enable-check-lisp-object-type to make |
137 | Lisp_Object use a struct type instead of the default int. The flag | |
138 | causes CHECK_LISP_OBJECT_TYPE to be defined. */ | |
b86cfd28 | 139 | |
b9466edb | 140 | /***** Select the tagging scheme. *****/ |
646b5f55 | 141 | /* The following option controls the tagging scheme: |
b9466edb SM |
142 | - USE_LSB_TAG means that we can assume the least 3 bits of pointers are |
143 | always 0, and we can thus use them to hold tag bits, without | |
144 | restricting our addressing space. | |
145 | ||
bfe3e0a2 PE |
146 | If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus |
147 | restricting our possible address range. | |
b9466edb SM |
148 | |
149 | USE_LSB_TAG not only requires the least 3 bits of pointers returned by | |
150 | malloc to be 0 but also needs to be able to impose a mult-of-8 alignment | |
151 | on the few static Lisp_Objects used: all the defsubr as well | |
152 | as the two special buffers buffer_defaults and buffer_local_symbols. */ | |
153 | ||
154 | /* First, try and define DECL_ALIGN(type,var) which declares a static | |
155 | variable VAR of type TYPE with the added requirement that it be | |
9aba6043 | 156 | TYPEBITS-aligned. */ |
8c9afb46 | 157 | |
4706125e PE |
158 | enum Lisp_Bits |
159 | { | |
160 | /* Number of bits in a Lisp_Object tag. This can be used in #if, | |
161 | and for GDB's sake also as a regular symbol. */ | |
162 | GCTYPEBITS = | |
8c9afb46 | 163 | #define GCTYPEBITS 3 |
4706125e PE |
164 | GCTYPEBITS, |
165 | ||
166 | /* Number of bits in a Lisp_Object value, not counting the tag. */ | |
167 | VALBITS = BITS_PER_EMACS_INT - GCTYPEBITS, | |
1781b9e9 | 168 | |
4706125e PE |
169 | /* Number of bits in a Lisp fixnum tag. */ |
170 | INTTYPEBITS = GCTYPEBITS - 1, | |
171 | ||
172 | /* Number of bits in a Lisp fixnum value, not counting the tag. */ | |
173 | FIXNUM_BITS = VALBITS + 1 | |
174 | }; | |
34374650 PE |
175 | |
176 | /* The maximum value that can be stored in a EMACS_INT, assuming all | |
177 | bits other than the type bits contribute to a nonnegative signed value. | |
178 | This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */ | |
179 | #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1)) | |
310f5bd4 | 180 | |
b9466edb SM |
181 | #ifndef NO_DECL_ALIGN |
182 | # ifndef DECL_ALIGN | |
7cae64b4 | 183 | # if HAVE_ATTRIBUTE_ALIGNED |
b9466edb SM |
184 | # define DECL_ALIGN(type, var) \ |
185 | type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var | |
a6fc3b5c | 186 | # elif defined(_MSC_VER) |
8c9afb46 EZ |
187 | # define ALIGN_GCTYPEBITS 8 |
188 | # if (1 << GCTYPEBITS) != ALIGN_GCTYPEBITS | |
189 | # error ALIGN_GCTYPEBITS is wrong! | |
190 | # endif | |
a6fc3b5c | 191 | # define DECL_ALIGN(type, var) \ |
8c9afb46 | 192 | type __declspec(align(ALIGN_GCTYPEBITS)) var |
7cae64b4 PE |
193 | # else |
194 | /* What directives do other compilers use? */ | |
b9466edb SM |
195 | # endif |
196 | # endif | |
197 | #endif | |
198 | ||
bfe3e0a2 PE |
199 | /* Unless otherwise specified, use USE_LSB_TAG on systems where: */ |
200 | #ifndef USE_LSB_TAG | |
201 | /* 1. We know malloc returns a multiple of 8. */ | |
202 | # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \ | |
203 | || defined DARWIN_OS || defined __sun) | |
204 | /* 2. We can specify multiple-of-8 alignment on static variables. */ | |
205 | # ifdef DECL_ALIGN | |
206 | /* 3. Pointers-as-ints exceed VAL_MAX. | |
207 | On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is: | |
27f3c637 PE |
208 | a. unnecessary, because the top bits of an EMACS_INT are unused, and |
209 | b. slower, because it typically requires extra masking. | |
bfe3e0a2 PE |
210 | So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */ |
211 | # if VAL_MAX < UINTPTR_MAX | |
212 | # define USE_LSB_TAG 1 | |
213 | # endif | |
310f5bd4 | 214 | # endif |
b9466edb SM |
215 | # endif |
216 | #endif | |
5eceb8fb PE |
217 | #ifdef USE_LSB_TAG |
218 | # undef USE_LSB_TAG | |
4706125e | 219 | enum enum_USE_LSB_TAG { USE_LSB_TAG = 1 }; |
5eceb8fb PE |
220 | # define USE_LSB_TAG 1 |
221 | #else | |
4706125e | 222 | enum enum_USE_LSB_TAG { USE_LSB_TAG = 0 }; |
bfe3e0a2 PE |
223 | # define USE_LSB_TAG 0 |
224 | #endif | |
b9466edb SM |
225 | |
226 | /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */ | |
227 | #ifndef DECL_ALIGN | |
bfe3e0a2 | 228 | # if USE_LSB_TAG |
b9466edb SM |
229 | # error "USE_LSB_TAG used without defining DECL_ALIGN" |
230 | # endif | |
231 | # define DECL_ALIGN(type, var) type var | |
232 | #endif | |
233 | ||
e0b8c689 | 234 | |
99a3d506 | 235 | /* Define the fundamental Lisp data structures. */ |
3cfe6dfd | 236 | |
99a3d506 | 237 | /* This is the set of Lisp data types. */ |
3cfe6dfd | 238 | |
2b570124 PE |
239 | /* Lisp integers use 2 tags, to give them one extra bit, thus |
240 | extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */ | |
2b570124 PE |
241 | #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1)) |
242 | #define LISP_INT_TAG Lisp_Int0 | |
243 | #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1 | |
244 | #define LISP_INT1_TAG (USE_LSB_TAG ? 1 << INTTYPEBITS : 1) | |
245 | #define LISP_STRING_TAG (5 - LISP_INT1_TAG) | |
246 | #define LISP_INT_TAG_P(x) (((x) & ~LISP_INT1_TAG) == 0) | |
2de9f71c | 247 | |
a6fc3b5c EZ |
248 | /* Stolen from GDB. The only known compiler that doesn't support |
249 | enums in bitfields is MSVC. */ | |
250 | #ifdef _MSC_VER | |
251 | #define ENUM_BF(TYPE) unsigned int | |
252 | #else | |
253 | #define ENUM_BF(TYPE) enum TYPE | |
254 | #endif | |
255 | ||
256 | ||
3cfe6dfd JB |
257 | enum Lisp_Type |
258 | { | |
99a3d506 | 259 | /* Integer. XINT (obj) is the integer value. */ |
2de9f71c SM |
260 | Lisp_Int0 = 0, |
261 | Lisp_Int1 = LISP_INT1_TAG, | |
3cfe6dfd | 262 | |
99a3d506 | 263 | /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */ |
2de9f71c | 264 | Lisp_Symbol = 2, |
3cfe6dfd | 265 | |
84d1833e KH |
266 | /* Miscellaneous. XMISC (object) points to a union Lisp_Misc, |
267 | whose first member indicates the subtype. */ | |
2de9f71c | 268 | Lisp_Misc = 3, |
3cfe6dfd JB |
269 | |
270 | /* String. XSTRING (object) points to a struct Lisp_String. | |
99a3d506 | 271 | The length of the string, and its contents, are stored therein. */ |
2de9f71c | 272 | Lisp_String = LISP_STRING_TAG, |
3cfe6dfd | 273 | |
b5088f80 | 274 | /* Vector of Lisp objects, or something resembling it. |
7c06ac2b | 275 | XVECTOR (object) points to a struct Lisp_Vector, which contains |
b5088f80 KH |
276 | the size and contents. The size field also contains the type |
277 | information, if it's not a real vector object. */ | |
2de9f71c | 278 | Lisp_Vectorlike = 5, |
3cfe6dfd | 279 | |
99a3d506 | 280 | /* Cons. XCONS (object) points to a struct Lisp_Cons. */ |
2de9f71c | 281 | Lisp_Cons = 6, |
4d1207f6 | 282 | |
2de9f71c | 283 | Lisp_Float = 7, |
3cfe6dfd JB |
284 | }; |
285 | ||
a32fa736 | 286 | /* This is the set of data types that share a common structure. |
c98adc1b KH |
287 | The first member of the structure is a type code from this set. |
288 | The enum values are arbitrary, but we'll use large numbers to make it | |
289 | more likely that we'll spot the error if a random word in memory is | |
290 | mistakenly interpreted as a Lisp_Misc. */ | |
1c4ca5a3 KH |
291 | enum Lisp_Misc_Type |
292 | { | |
c98adc1b | 293 | Lisp_Misc_Free = 0x5eab, |
84d1833e | 294 | Lisp_Misc_Marker, |
99a3d506 | 295 | Lisp_Misc_Overlay, |
222151aa | 296 | Lisp_Misc_Save_Value, |
99a3d506 RS |
297 | /* Currently floats are not a misc type, |
298 | but let's define this in case we want to change that. */ | |
299 | Lisp_Misc_Float, | |
300 | /* This is not a type code. It is for range checking. */ | |
301 | Lisp_Misc_Limit | |
1c4ca5a3 KH |
302 | }; |
303 | ||
ce5b453a SM |
304 | /* These are the types of forwarding objects used in the value slot |
305 | of symbols for special built-in variables whose value is stored in | |
306 | C variables. */ | |
307 | enum Lisp_Fwd_Type | |
308 | { | |
309 | Lisp_Fwd_Int, /* Fwd to a C `int' variable. */ | |
310 | Lisp_Fwd_Bool, /* Fwd to a C boolean var. */ | |
311 | Lisp_Fwd_Obj, /* Fwd to a C Lisp_Object variable. */ | |
312 | Lisp_Fwd_Buffer_Obj, /* Fwd to a Lisp_Object field of buffers. */ | |
313 | Lisp_Fwd_Kboard_Obj, /* Fwd to a Lisp_Object field of kboards. */ | |
314 | }; | |
315 | ||
646b5f55 | 316 | #ifdef CHECK_LISP_OBJECT_TYPE |
3cfe6dfd | 317 | |
646b5f55 AS |
318 | typedef struct { EMACS_INT i; } Lisp_Object; |
319 | ||
320 | #define XLI(o) (o).i | |
321 | static inline Lisp_Object | |
322 | XIL (EMACS_INT i) | |
323 | { | |
324 | Lisp_Object o = { i }; | |
325 | return o; | |
326 | } | |
3cfe6dfd | 327 | |
55d4c1b2 | 328 | static inline Lisp_Object |
f3fbd155 KR |
329 | LISP_MAKE_RVALUE (Lisp_Object o) |
330 | { | |
331 | return o; | |
332 | } | |
bfe3e0a2 PE |
333 | |
334 | #define LISP_INITIALLY_ZERO {0} | |
f3fbd155 | 335 | |
4706125e PE |
336 | #undef CHECK_LISP_OBJECT_TYPE |
337 | enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = 1 }; | |
646b5f55 | 338 | #else /* CHECK_LISP_OBJECT_TYPE */ |
3cfe6dfd | 339 | |
646b5f55 | 340 | /* If a struct type is not wanted, define Lisp_Object as just a number. */ |
3cfe6dfd | 341 | |
c003141f | 342 | typedef EMACS_INT Lisp_Object; |
646b5f55 AS |
343 | #define XLI(o) (o) |
344 | #define XIL(i) (i) | |
f3fbd155 | 345 | #define LISP_MAKE_RVALUE(o) (0+(o)) |
bfe3e0a2 | 346 | #define LISP_INITIALLY_ZERO 0 |
4706125e | 347 | enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = 0 }; |
646b5f55 | 348 | #endif /* CHECK_LISP_OBJECT_TYPE */ |
3cfe6dfd | 349 | |
d311d28c | 350 | /* In the size word of a vector, this bit means the vector has been marked. */ |
846d69ac | 351 | |
d311d28c | 352 | #define ARRAY_MARK_FLAG PTRDIFF_MIN |
846d69ac | 353 | |
b5088f80 KH |
354 | /* In the size word of a struct Lisp_Vector, this bit means it's really |
355 | some other vector-like object. */ | |
d311d28c | 356 | #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2) |
b5088f80 | 357 | |
303a5c93 | 358 | /* In a pseudovector, the size field actually contains a word with one |
b5088f80 | 359 | PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to |
49e49fb5 | 360 | indicate the actual type. |
539b8c1c SM |
361 | We use a bitset, even tho only one of the bits can be set at any |
362 | particular time just so as to be able to use micro-optimizations such as | |
363 | testing membership of a particular subset of pseudovectors in Fequal. | |
364 | It is not crucial, but there are plenty of bits here, so why not do it? */ | |
99a3d506 RS |
365 | enum pvec_type |
366 | { | |
ee28be33 SM |
367 | PVEC_NORMAL_VECTOR = 0, /* Unused! */ |
368 | PVEC_FREE, | |
369 | PVEC_PROCESS, | |
370 | PVEC_FRAME, | |
371 | PVEC_WINDOW, | |
372 | PVEC_BOOL_VECTOR, | |
373 | PVEC_BUFFER, | |
374 | PVEC_HASH_TABLE, | |
375 | PVEC_TERMINAL, | |
376 | PVEC_WINDOW_CONFIGURATION, | |
377 | PVEC_SUBR, | |
6195f384 | 378 | PVEC_EXCURSION, |
ee28be33 SM |
379 | PVEC_OTHER, |
380 | /* These last 4 are special because we OR them in fns.c:internal_equal, | |
381 | so they have to use a disjoint bit pattern: | |
382 | if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE | |
383 | | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */ | |
384 | PVEC_COMPILED = 0x10, | |
385 | PVEC_CHAR_TABLE = 0x20, | |
386 | PVEC_SUB_CHAR_TABLE = 0x30, | |
387 | PVEC_FONT = 0x40 | |
99a3d506 | 388 | }; |
b5088f80 | 389 | |
4706125e PE |
390 | /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers |
391 | which were stored in a Lisp_Object. */ | |
392 | #ifndef DATA_SEG_BITS | |
393 | # define DATA_SEG_BITS 0 | |
394 | #endif | |
395 | enum { gdb_DATA_SEG_BITS = DATA_SEG_BITS }; | |
396 | #undef DATA_SEG_BITS | |
397 | ||
398 | enum More_Lisp_Bits | |
1781b9e9 | 399 | { |
4706125e PE |
400 | DATA_SEG_BITS = gdb_DATA_SEG_BITS, |
401 | ||
402 | /* For convenience, we also store the number of elements in these bits. | |
403 | Note that this size is not necessarily the memory-footprint size, but | |
404 | only the number of Lisp_Object fields (that need to be traced by GC). | |
405 | The distinction is used, e.g., by Lisp_Process, which places extra | |
406 | non-Lisp_Object fields at the end of the structure. */ | |
1781b9e9 PE |
407 | PSEUDOVECTOR_SIZE_BITS = 16, |
408 | PSEUDOVECTOR_SIZE_MASK = (1 << PSEUDOVECTOR_SIZE_BITS) - 1, | |
4706125e | 409 | PVEC_TYPE_MASK = 0x0fff << PSEUDOVECTOR_SIZE_BITS, |
1781b9e9 | 410 | |
4706125e PE |
411 | /* Number of bits to put in each character in the internal representation |
412 | of bool vectors. This should not vary across implementations. */ | |
413 | BOOL_VECTOR_BITS_PER_CHAR = 8 | |
414 | }; | |
3cfe6dfd JB |
415 | \f |
416 | /* These macros extract various sorts of values from a Lisp_Object. | |
417 | For example, if tem is a Lisp_Object whose type is Lisp_Cons, | |
99a3d506 | 418 | XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */ |
3cfe6dfd | 419 | |
b9466edb | 420 | /* Return a perfect hash of the Lisp_Object representation. */ |
2b570124 | 421 | #define XHASH(a) XLI (a) |
b9466edb | 422 | |
bfe3e0a2 | 423 | #if USE_LSB_TAG |
6b61353c | 424 | |
1781b9e9 | 425 | #define VALMASK (-1 << GCTYPEBITS) |
2b570124 PE |
426 | #define TYPEMASK ((1 << GCTYPEBITS) - 1) |
427 | #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK)) | |
428 | #define XINT(a) (XLI (a) >> INTTYPEBITS) | |
429 | #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS) | |
430 | #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS) | |
646b5f55 | 431 | #define XSET(var, type, ptr) \ |
2b570124 PE |
432 | (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \ |
433 | (var) = XIL ((type) | (intptr_t) (ptr))) | |
6b61353c | 434 | |
2b570124 PE |
435 | #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK)) |
436 | #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type))) | |
6b61353c KH |
437 | |
438 | #else /* not USE_LSB_TAG */ | |
439 | ||
34374650 | 440 | #define VALMASK VAL_MAX |
6b61353c | 441 | |
2b570124 | 442 | #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS)) |
3cfe6dfd | 443 | |
221f4ef3 KH |
444 | /* For integers known to be positive, XFASTINT provides fast retrieval |
445 | and XSETFASTINT provides fast storage. This takes advantage of the | |
2b570124 PE |
446 | fact that Lisp integers have zero-bits in their tags. */ |
447 | #define XFASTINT(a) (XLI (a) + 0) | |
448 | #define XSETFASTINT(a, b) ((a) = XIL (b)) | |
3cfe6dfd | 449 | |
2de9f71c | 450 | /* Extract the value of a Lisp_Object as a (un)signed integer. */ |
3cfe6dfd | 451 | |
2b570124 PE |
452 | #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS) |
453 | #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK)) | |
454 | #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK) | |
3cfe6dfd | 455 | |
2b570124 PE |
456 | #define XSET(var, type, ptr) \ |
457 | ((var) = XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \ | |
646b5f55 | 458 | + ((intptr_t) (ptr) & VALMASK))) |
b7acde90 | 459 | |
1781b9e9 | 460 | #if DATA_SEG_BITS |
19634648 CY |
461 | /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers |
462 | which were stored in a Lisp_Object */ | |
2b570124 | 463 | #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS)) |
19634648 | 464 | #else |
2b570124 | 465 | #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK)) |
19634648 | 466 | #endif |
b7acde90 | 467 | |
6b61353c | 468 | #endif /* not USE_LSB_TAG */ |
3cfe6dfd | 469 | |
b349d111 SM |
470 | /* For integers known to be positive, XFASTINT sometimes provides |
471 | faster retrieval and XSETFASTINT provides faster storage. | |
472 | If not, fallback on the non-accelerated path. */ | |
473 | #ifndef XFASTINT | |
474 | # define XFASTINT(a) (XINT (a)) | |
475 | # define XSETFASTINT(a, b) (XSETINT (a, b)) | |
476 | #endif | |
477 | ||
b263a6b0 PE |
478 | /* Extract the pointer value of the Lisp object A, under the |
479 | assumption that A's type is TYPE. This is a fallback | |
480 | implementation if nothing faster is available. */ | |
481 | #ifndef XUNTAG | |
482 | # define XUNTAG(a, type) XPNTR (a) | |
483 | #endif | |
484 | ||
b9466edb SM |
485 | #define EQ(x, y) (XHASH (x) == XHASH (y)) |
486 | ||
0de4bb68 PE |
487 | /* Largest and smallest representable fixnum values. These are the C |
488 | values. */ | |
2b570124 | 489 | #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS) |
0de4bb68 PE |
490 | #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM) |
491 | ||
987c9327 AS |
492 | /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is |
493 | written this way so that it also works if I is of unsigned | |
2e6578fb | 494 | type or if I is a NaN. */ |
dc8e8b07 GM |
495 | |
496 | #define FIXNUM_OVERFLOW_P(i) \ | |
2e6578fb | 497 | (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM)) |
dc8e8b07 | 498 | |
d311d28c PE |
499 | static inline ptrdiff_t |
500 | clip_to_bounds (ptrdiff_t lower, EMACS_INT num, ptrdiff_t upper) | |
501 | { | |
502 | return num < lower ? lower : num <= upper ? num : upper; | |
503 | } | |
504 | ||
99a3d506 | 505 | /* Extract a value or address from a Lisp_Object. */ |
3cfe6dfd | 506 | |
b263a6b0 PE |
507 | #define XCONS(a) (eassert (CONSP (a)), \ |
508 | (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons)) | |
509 | #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \ | |
510 | (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike)) | |
511 | #define XSTRING(a) (eassert (STRINGP (a)), \ | |
512 | (struct Lisp_String *) XUNTAG (a, Lisp_String)) | |
513 | #define XSYMBOL(a) (eassert (SYMBOLP (a)), \ | |
514 | (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol)) | |
515 | #define XFLOAT(a) (eassert (FLOATP (a)), \ | |
516 | (struct Lisp_Float *) XUNTAG (a, Lisp_Float)) | |
7c06ac2b RS |
517 | |
518 | /* Misc types. */ | |
c9f6631c | 519 | |
b263a6b0 | 520 | #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc)) |
5e617bc2 | 521 | #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any)) |
67ee9f6e | 522 | #define XMISCTYPE(a) (XMISCANY (a)->type) |
5e617bc2 JB |
523 | #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker)) |
524 | #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay)) | |
525 | #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value)) | |
ce5b453a SM |
526 | |
527 | /* Forwarding object types. */ | |
528 | ||
529 | #define XFWDTYPE(a) (a->u_intfwd.type) | |
530 | #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd)) | |
531 | #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd)) | |
532 | #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd)) | |
19fa82b9 | 533 | #define XBUFFER_OBJFWD(a) \ |
ce5b453a | 534 | (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd)) |
19fa82b9 | 535 | #define XKBOARD_OBJFWD(a) \ |
ce5b453a | 536 | (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd)) |
3cfe6dfd | 537 | |
7c06ac2b | 538 | /* Pseudovector types. */ |
c9f6631c | 539 | |
b263a6b0 PE |
540 | #define XPROCESS(a) (eassert (PROCESSP (a)), \ |
541 | (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike)) | |
542 | #define XWINDOW(a) (eassert (WINDOWP (a)), \ | |
543 | (struct window *) XUNTAG (a, Lisp_Vectorlike)) | |
544 | #define XTERMINAL(a) (eassert (TERMINALP (a)), \ | |
545 | (struct terminal *) XUNTAG (a, Lisp_Vectorlike)) | |
546 | #define XSUBR(a) (eassert (SUBRP (a)), \ | |
547 | (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike)) | |
6195f384 DA |
548 | #define XEXCURSION(a) (eassert (EXCURSIONP (a)), \ |
549 | (struct Lisp_Excursion *) XUNTAG (a, Lisp_Vectorlike)) | |
b263a6b0 PE |
550 | #define XBUFFER(a) (eassert (BUFFERP (a)), \ |
551 | (struct buffer *) XUNTAG (a, Lisp_Vectorlike)) | |
552 | #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \ | |
553 | (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike)) | |
554 | #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \ | |
555 | ((struct Lisp_Sub_Char_Table *) \ | |
556 | XUNTAG (a, Lisp_Vectorlike))) | |
557 | #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \ | |
558 | ((struct Lisp_Bool_Vector *) \ | |
559 | XUNTAG (a, Lisp_Vectorlike))) | |
99a3d506 | 560 | |
99a3d506 | 561 | /* Construct a Lisp_Object from a value or address. */ |
7c06ac2b | 562 | |
a84f89d5 | 563 | #define XSETINT(a, b) (a) = make_number (b) |
a94ef819 | 564 | #define XSETCONS(a, b) XSET (a, Lisp_Cons, b) |
b5088f80 | 565 | #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b) |
a94ef819 KH |
566 | #define XSETSTRING(a, b) XSET (a, Lisp_String, b) |
567 | #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b) | |
a94ef819 | 568 | #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b) |
7c06ac2b RS |
569 | |
570 | /* Misc types. */ | |
c9f6631c | 571 | |
7c06ac2b | 572 | #define XSETMISC(a, b) XSET (a, Lisp_Misc, b) |
a7aa28f6 | 573 | #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker) |
7c06ac2b RS |
574 | |
575 | /* Pseudovector types. */ | |
c9f6631c | 576 | |
5e617bc2 | 577 | #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code) |
eab3844f | 578 | #define XSETTYPED_PVECTYPE(v, size_member, code) \ |
ee28be33 | 579 | ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)) |
eab3844f | 580 | #define XSETPVECTYPESIZE(v, code, sizeval) \ |
ee28be33 SM |
581 | ((v)->header.size = (PSEUDOVECTOR_FLAG \ |
582 | | ((code) << PSEUDOVECTOR_SIZE_BITS) \ | |
583 | | (sizeval))) | |
aa0b0087 PE |
584 | |
585 | /* The cast to struct vectorlike_header * avoids aliasing issues. */ | |
7c06ac2b | 586 | #define XSETPSEUDOVECTOR(a, b, code) \ |
7555c33f SM |
587 | XSETTYPED_PSEUDOVECTOR (a, b, \ |
588 | (((struct vectorlike_header *) \ | |
589 | XUNTAG (a, Lisp_Vectorlike)) \ | |
590 | ->size), \ | |
591 | code) | |
eab3844f | 592 | #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \ |
beb9f745 | 593 | (XSETVECTOR (a, b), \ |
eab3844f | 594 | eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \ |
ee28be33 | 595 | == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS)))) |
aa0b0087 | 596 | |
7c06ac2b RS |
597 | #define XSETWINDOW_CONFIGURATION(a, b) \ |
598 | (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION)) | |
599 | #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS)) | |
600 | #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW)) | |
49e49fb5 | 601 | #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL)) |
6195f384 DA |
602 | /* These are special because both Lisp_Subr and Lisp_Excursion lacks |
603 | struct vectorlike_header. */ | |
1a2f43d0 PE |
604 | #define XSETSUBR(a, b) \ |
605 | XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR) | |
6195f384 DA |
606 | #define XSETEXCURSION(a, b) \ |
607 | XSETTYPED_PSEUDOVECTOR (a, b, XEXCURSION (a)->size, PVEC_EXCURSION) | |
7c06ac2b | 608 | #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED)) |
99a3d506 | 609 | #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER)) |
608ff985 RS |
610 | #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE)) |
611 | #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR)) | |
1842abb2 | 612 | #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE)) |
c9f6631c GM |
613 | |
614 | /* Convenience macros for dealing with Lisp arrays. */ | |
615 | ||
915b2a6a | 616 | #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX] |
77b37c05 | 617 | #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size |
915b2a6a | 618 | /* The IDX==IDX tries to detect when the macro argument is side-effecting. */ |
4b75ffab SM |
619 | #define ASET(ARRAY, IDX, VAL) \ |
620 | (eassert ((IDX) == (IDX)), \ | |
621 | eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \ | |
915b2a6a | 622 | AREF ((ARRAY), (IDX)) = (VAL)) |
c9f6631c | 623 | |
d90a14e0 GM |
624 | /* Convenience macros for dealing with Lisp strings. */ |
625 | ||
674537ea | 626 | #define SDATA(string) (XSTRING (string)->data + 0) |
b9466edb SM |
627 | #define SREF(string, index) (SDATA (string)[index] + 0) |
628 | #define SSET(string, index, new) (SDATA (string)[index] = (new)) | |
7412b6fd KR |
629 | #define SCHARS(string) (XSTRING (string)->size + 0) |
630 | #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0) | |
631 | ||
51b59d79 PE |
632 | /* Avoid "differ in sign" warnings. */ |
633 | #define SSDATA(x) ((char *) SDATA (x)) | |
634 | ||
7412b6fd KR |
635 | #define STRING_SET_CHARS(string, newsize) \ |
636 | (XSTRING (string)->size = (newsize)) | |
d90a14e0 | 637 | |
101d50c8 | 638 | #define STRING_COPYIN(string, index, new, count) \ |
72af86bd | 639 | memcpy (SDATA (string) + index, new, count) |
101d50c8 | 640 | |
c8a39089 KS |
641 | /* Type checking. */ |
642 | ||
643 | #define CHECK_TYPE(ok, Qxxxp, x) \ | |
644 | do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0) | |
645 | ||
646 | ||
3cfe6dfd | 647 | \f |
5f6bf5fe | 648 | /* See the macros in intervals.h. */ |
e221eae3 JA |
649 | |
650 | typedef struct interval *INTERVAL; | |
651 | ||
652 | /* Complain if object is not string or buffer type */ | |
874cc80e | 653 | #define CHECK_STRING_OR_BUFFER(x) \ |
c8a39089 KS |
654 | CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x) |
655 | ||
e221eae3 | 656 | \f |
3cfe6dfd JB |
657 | /* In a cons, the markbit of the car is the gc mark bit */ |
658 | ||
659 | struct Lisp_Cons | |
660 | { | |
8f34f70a KR |
661 | /* Please do not use the names of these elements in code other |
662 | than the core lisp implementation. Use XCAR and XCDR below. */ | |
663 | #ifdef HIDE_LISP_IMPLEMENTATION | |
3a623fee AS |
664 | Lisp_Object car_; |
665 | union | |
666 | { | |
667 | Lisp_Object cdr_; | |
668 | struct Lisp_Cons *chain; | |
669 | } u; | |
8f34f70a | 670 | #else |
3a623fee AS |
671 | Lisp_Object car; |
672 | union | |
673 | { | |
674 | Lisp_Object cdr; | |
675 | struct Lisp_Cons *chain; | |
676 | } u; | |
8f34f70a | 677 | #endif |
3cfe6dfd JB |
678 | }; |
679 | ||
b7acde90 | 680 | /* Take the car or cdr of something known to be a cons cell. */ |
f3fbd155 KR |
681 | /* The _AS_LVALUE macros shouldn't be used outside of the minimal set |
682 | of code that has to know what a cons cell looks like. Other code not | |
683 | part of the basic lisp implementation should assume that the car and cdr | |
684 | fields are not accessible as lvalues. (What if we want to switch to | |
685 | a copying collector someday? Cached cons cell field addresses may be | |
686 | invalidated at arbitrary points.) */ | |
8f34f70a | 687 | #ifdef HIDE_LISP_IMPLEMENTATION |
f3fbd155 | 688 | #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_) |
3a623fee | 689 | #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_) |
8f34f70a | 690 | #else |
f3fbd155 | 691 | #define XCAR_AS_LVALUE(c) (XCONS ((c))->car) |
3a623fee | 692 | #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr) |
8f34f70a | 693 | #endif |
b7acde90 | 694 | |
f3fbd155 | 695 | /* Use these from normal code. */ |
5e617bc2 JB |
696 | #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c)) |
697 | #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c)) | |
f3fbd155 KR |
698 | |
699 | /* Use these to set the fields of a cons cell. | |
700 | ||
701 | Note that both arguments may refer to the same object, so 'n' | |
702 | should not be read after 'c' is first modified. Also, neither | |
703 | argument should be evaluated more than once; side effects are | |
704 | especially common in the second argument. */ | |
5e617bc2 JB |
705 | #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n)) |
706 | #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n)) | |
f3fbd155 | 707 | |
b7acde90 KH |
708 | /* Take the car or cdr of something whose type is not known. */ |
709 | #define CAR(c) \ | |
710 | (CONSP ((c)) ? XCAR ((c)) \ | |
711 | : NILP ((c)) ? Qnil \ | |
915b2a6a | 712 | : wrong_type_argument (Qlistp, (c))) |
b7acde90 KH |
713 | |
714 | #define CDR(c) \ | |
715 | (CONSP ((c)) ? XCDR ((c)) \ | |
716 | : NILP ((c)) ? Qnil \ | |
915b2a6a | 717 | : wrong_type_argument (Qlistp, (c))) |
b7acde90 | 718 | |
c8a39089 KS |
719 | /* Take the car or cdr of something whose type is not known. */ |
720 | #define CAR_SAFE(c) \ | |
721 | (CONSP ((c)) ? XCAR ((c)) : Qnil) | |
722 | ||
723 | #define CDR_SAFE(c) \ | |
724 | (CONSP ((c)) ? XCDR ((c)) : Qnil) | |
725 | ||
d8fc7ce4 KH |
726 | /* Nonzero if STR is a multibyte string. */ |
727 | #define STRING_MULTIBYTE(STR) \ | |
728 | (XSTRING (STR)->size_byte >= 0) | |
729 | ||
730 | /* Return the length in bytes of STR. */ | |
35f464a7 GM |
731 | |
732 | #ifdef GC_CHECK_STRING_BYTES | |
733 | ||
734 | struct Lisp_String; | |
d311d28c | 735 | extern ptrdiff_t string_bytes (struct Lisp_String *); |
35f464a7 GM |
736 | #define STRING_BYTES(S) string_bytes ((S)) |
737 | ||
738 | #else /* not GC_CHECK_STRING_BYTES */ | |
739 | ||
d8fc7ce4 KH |
740 | #define STRING_BYTES(STR) \ |
741 | ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte) | |
742 | ||
35f464a7 GM |
743 | #endif /* not GC_CHECK_STRING_BYTES */ |
744 | ||
c9d624c6 PE |
745 | /* An upper bound on the number of bytes in a Lisp string, not |
746 | counting the terminating null. This a tight enough bound to | |
747 | prevent integer overflow errors that would otherwise occur during | |
748 | string size calculations. A string cannot contain more bytes than | |
749 | a fixnum can represent, nor can it be so long that C pointer | |
750 | arithmetic stops working on the string plus its terminating null. | |
751 | Although the actual size limit (see STRING_BYTES_MAX in alloc.c) | |
752 | may be a bit smaller than STRING_BYTES_BOUND, calculating it here | |
753 | would expose alloc.c internal details that we'd rather keep | |
754 | private. The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is | |
755 | signed. */ | |
756 | #define STRING_BYTES_BOUND \ | |
757 | min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1) | |
d1f3d2af | 758 | |
491c2516 | 759 | /* Mark STR as a unibyte string. */ |
2c668b9a JB |
760 | #define STRING_SET_UNIBYTE(STR) \ |
761 | do { if (EQ (STR, empty_multibyte_string)) \ | |
762 | (STR) = empty_unibyte_string; \ | |
763 | else XSTRING (STR)->size_byte = -1; } while (0) | |
491c2516 | 764 | |
94ef4d69 KH |
765 | /* Mark STR as a multibyte string. Assure that STR contains only |
766 | ASCII characters in advance. */ | |
767 | #define STRING_SET_MULTIBYTE(STR) \ | |
768 | do { if (EQ (STR, empty_unibyte_string)) \ | |
769 | (STR) = empty_multibyte_string; \ | |
770 | else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0) | |
771 | ||
491c2516 | 772 | /* Get text properties. */ |
90b81429 KR |
773 | #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0) |
774 | ||
775 | /* Set text properties. */ | |
776 | #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT)) | |
d8fc7ce4 | 777 | |
ee28be33 | 778 | /* In a string or vector, the sign bit of the `size' is the gc mark bit. */ |
3cfe6dfd JB |
779 | |
780 | struct Lisp_String | |
781 | { | |
d311d28c PE |
782 | ptrdiff_t size; |
783 | ptrdiff_t size_byte; | |
ee28be33 | 784 | INTERVAL intervals; /* Text properties in this string. */ |
f05d7ea2 | 785 | unsigned char *data; |
3cfe6dfd JB |
786 | }; |
787 | ||
aa0b0087 PE |
788 | /* Header of vector-like objects. This documents the layout constraints on |
789 | vectors and pseudovectors other than struct Lisp_Subr. It also prevents | |
790 | compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR | |
791 | and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *, | |
792 | because when two such pointers potentially alias, a compiler won't | |
793 | incorrectly reorder loads and stores to their size fields. See | |
794 | <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */ | |
b102ceb1 | 795 | struct vectorlike_header |
3cfe6dfd | 796 | { |
ee28be33 SM |
797 | /* This field contains various pieces of information: |
798 | - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit. | |
799 | - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain | |
800 | vector (0) or a pseudovector (1). | |
801 | - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number | |
802 | of slots) of the vector. | |
803 | - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into | |
804 | a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest | |
805 | PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of | |
806 | Lisp_Object slots at the beginning of the object that need to be | |
807 | traced by the GC, tho some types use it slightly differently. | |
808 | - E.g. if the pvec type is PVEC_FREE it means this is an unallocated | |
809 | vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size | |
810 | in bytes. */ | |
d311d28c | 811 | ptrdiff_t size; |
aa0b0087 | 812 | |
f3372c87 DA |
813 | /* When the vector is allocated from a vector block, NBYTES is used |
814 | if the vector is not on a free list, and VECTOR is used otherwise. | |
815 | For large vector-like objects, BUFFER or VECTOR is used as a pointer | |
2b570124 | 816 | to the next vector-like object. It is generally a buffer or a |
aa0b0087 PE |
817 | Lisp_Vector alias, so for convenience it is a union instead of a |
818 | pointer: this way, one can write P->next.vector instead of ((struct | |
819 | Lisp_Vector *) P->next). */ | |
eab3844f | 820 | union { |
ee28be33 SM |
821 | /* This is only needed for small vectors that are not free because the |
822 | `size' field only gives us the number of Lisp_Object slots, whereas we | |
823 | need to know the total size, including non-Lisp_Object data. | |
824 | FIXME: figure out a way to store this info elsewhere so we can | |
825 | finally get rid of this extra word of overhead. */ | |
f3372c87 | 826 | ptrdiff_t nbytes; |
eab3844f | 827 | struct buffer *buffer; |
ee28be33 SM |
828 | /* FIXME: This can be removed: For large vectors, this field could be |
829 | placed *before* the vector itself. And for small vectors on a free | |
830 | list, this field could be stored in the vector's bytes, since the | |
831 | empty vector is handled specially anyway. */ | |
eab3844f PE |
832 | struct Lisp_Vector *vector; |
833 | } next; | |
834 | }; | |
835 | ||
836 | struct Lisp_Vector | |
837 | { | |
b102ceb1 | 838 | struct vectorlike_header header; |
3cfe6dfd JB |
839 | Lisp_Object contents[1]; |
840 | }; | |
841 | ||
94225242 | 842 | /* If a struct is made to look like a vector, this macro returns the length |
4115d3f7 | 843 | of the shortest vector that would hold that struct. */ |
4bb7141c | 844 | #define VECSIZE(type) ((sizeof (type) \ |
89887d67 | 845 | - offsetof (struct Lisp_Vector, contents[0]) \ |
ee28be33 | 846 | + sizeof (Lisp_Object) - 1) /* Round up. */ \ |
94225242 KH |
847 | / sizeof (Lisp_Object)) |
848 | ||
d0ebe33a SM |
849 | /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields |
850 | at the end and we need to compute the number of Lisp_Object fields (the | |
851 | ones that the GC needs to trace). */ | |
852 | #define PSEUDOVECSIZE(type, nonlispfield) \ | |
5e617bc2 | 853 | ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \ |
d0ebe33a SM |
854 | / sizeof (Lisp_Object)) |
855 | ||
1842abb2 | 856 | /* A char-table is a kind of vectorlike, with contents are like a |
ea724a01 | 857 | vector but with a few other slots. For some purposes, it makes |
1842abb2 | 858 | sense to handle a char-table with type struct Lisp_Vector. An |
ea724a01 KH |
859 | element of a char table can be any Lisp objects, but if it is a sub |
860 | char-table, we treat it a table that contains information of a | |
1842abb2 KH |
861 | specific range of characters. A sub char-table has the same |
862 | structure as a vector. A sub char table appears only in an element | |
863 | of a char-table, and there's no way to access it directly from | |
864 | Emacs Lisp program. */ | |
608ff985 | 865 | |
ea724a01 KH |
866 | /* This is the number of slots that every char table must have. This |
867 | counts the ordinary slots and the top, defalt, parent, and purpose | |
868 | slots. */ | |
1842abb2 | 869 | #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1) |
608ff985 RS |
870 | |
871 | /* Return the number of "extra" slots in the char table CT. */ | |
872 | ||
873 | #define CHAR_TABLE_EXTRA_SLOTS(CT) \ | |
eab3844f | 874 | (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS) |
608ff985 | 875 | |
d9da2f45 KH |
876 | #ifdef __GNUC__ |
877 | ||
878 | #define CHAR_TABLE_REF_ASCII(CT, IDX) \ | |
879 | ({struct Lisp_Char_Table *_tbl = NULL; \ | |
880 | Lisp_Object _val; \ | |
881 | do { \ | |
882 | _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \ | |
883 | _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \ | |
884 | : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \ | |
885 | if (NILP (_val)) \ | |
886 | _val = _tbl->defalt; \ | |
887 | } while (NILP (_val) && ! NILP (_tbl->parent)); \ | |
888 | _val; }) | |
c5c21b70 | 889 | |
d9da2f45 KH |
890 | #else /* not __GNUC__ */ |
891 | ||
892 | #define CHAR_TABLE_REF_ASCII(CT, IDX) \ | |
893 | (! NILP (XCHAR_TABLE (CT)->ascii) \ | |
894 | ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \ | |
895 | ? XCHAR_TABLE (CT)->ascii \ | |
896 | : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \ | |
897 | ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \ | |
898 | : char_table_ref ((CT), (IDX))) \ | |
899 | : char_table_ref ((CT), (IDX))) | |
900 | ||
901 | #endif /* not __GNUC__ */ | |
902 | ||
ea204efb PE |
903 | /* Compute A OP B, using the unsigned comparison operator OP. A and B |
904 | should be integer expressions. This is not the same as | |
53964682 | 905 | mathematical comparison; for example, UNSIGNED_CMP (0, <, -1) |
ea204efb PE |
906 | returns 1. For efficiency, prefer plain unsigned comparison if A |
907 | and B's sizes both fit (after integer promotion). */ | |
908 | #define UNSIGNED_CMP(a, op, b) \ | |
909 | (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \ | |
910 | ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \ | |
911 | : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0)) | |
912 | ||
15206ed9 | 913 | /* Nonzero iff C is an ASCII character. */ |
ea204efb | 914 | #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80) |
15206ed9 | 915 | |
b96656ce | 916 | /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII |
1842abb2 | 917 | characters. Do not check validity of CT. */ |
d9da2f45 KH |
918 | #define CHAR_TABLE_REF(CT, IDX) \ |
919 | (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \ | |
1842abb2 | 920 | : char_table_ref ((CT), (IDX))) |
b96656ce | 921 | |
dcafe1c7 KH |
922 | /* Almost equivalent to Faref (CT, IDX). However, if the result is |
923 | not a character, return IDX. | |
29b7163f RS |
924 | |
925 | For these characters, do not check validity of CT | |
926 | and do not follow parent. */ | |
1842abb2 KH |
927 | #define CHAR_TABLE_TRANSLATE(CT, IDX) \ |
928 | char_table_translate (CT, IDX) | |
29b7163f | 929 | |
b96656ce | 930 | /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and |
c497dce4 | 931 | 8-bit European characters. Do not check validity of CT. */ |
1842abb2 | 932 | #define CHAR_TABLE_SET(CT, IDX, VAL) \ |
193e32d9 | 933 | (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \ |
1842abb2 KH |
934 | ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \ |
935 | : char_table_set (CT, IDX, VAL)) | |
936 | ||
1842abb2 KH |
937 | #define CHARTAB_SIZE_BITS_0 6 |
938 | #define CHARTAB_SIZE_BITS_1 4 | |
939 | #define CHARTAB_SIZE_BITS_2 5 | |
940 | #define CHARTAB_SIZE_BITS_3 7 | |
941 | ||
942 | extern const int chartab_size[4]; | |
943 | ||
944 | struct Lisp_Sub_Char_Table; | |
b96656ce | 945 | |
608ff985 RS |
946 | struct Lisp_Char_Table |
947 | { | |
eab3844f | 948 | /* HEADER.SIZE is the vector's size field, which also holds the |
608ff985 | 949 | pseudovector type information. It holds the size, too. |
c73bd236 MB |
950 | The size counts the defalt, parent, purpose, ascii, |
951 | contents, and extras slots. */ | |
b102ceb1 | 952 | struct vectorlike_header header; |
1842abb2 | 953 | |
608ff985 RS |
954 | /* This holds a default value, |
955 | which is used whenever the value for a specific character is nil. */ | |
956 | Lisp_Object defalt; | |
ea724a01 | 957 | |
8f924df7 KH |
958 | /* This points to another char table, which we inherit from when the |
959 | value for a specific character is nil. The `defalt' slot takes | |
960 | precedence over this. */ | |
608ff985 | 961 | Lisp_Object parent; |
1842abb2 | 962 | |
8f924df7 KH |
963 | /* This is a symbol which says what kind of use this char-table is |
964 | meant for. */ | |
7f73dc9d | 965 | Lisp_Object purpose; |
1842abb2 | 966 | |
8f924df7 KH |
967 | /* The bottom sub char-table for characters of the range 0..127. It |
968 | is nil if none of ASCII character has a specific value. */ | |
969 | Lisp_Object ascii; | |
1842abb2 | 970 | |
8f924df7 | 971 | Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)]; |
1842abb2 | 972 | |
8f924df7 | 973 | /* These hold additional data. It is a vector. */ |
608ff985 RS |
974 | Lisp_Object extras[1]; |
975 | }; | |
976 | ||
1842abb2 | 977 | struct Lisp_Sub_Char_Table |
8f924df7 | 978 | { |
eab3844f | 979 | /* HEADER.SIZE is the vector's size field, which also holds the |
8f924df7 | 980 | pseudovector type information. It holds the size, too. */ |
b102ceb1 | 981 | struct vectorlike_header header; |
1842abb2 | 982 | |
8f924df7 | 983 | /* Depth of this sub char-table. It should be 1, 2, or 3. A sub |
78edd3b7 | 984 | char-table of depth 1 contains 16 elements, and each element |
8f924df7 KH |
985 | covers 4096 (128*32) characters. A sub char-table of depth 2 |
986 | contains 32 elements, and each element covers 128 characters. A | |
987 | sub char-table of depth 3 contains 128 elements, and each element | |
988 | is for one character. */ | |
989 | Lisp_Object depth; | |
1842abb2 | 990 | |
8f924df7 KH |
991 | /* Minimum character covered by the sub char-table. */ |
992 | Lisp_Object min_char; | |
1842abb2 | 993 | |
8f924df7 KH |
994 | Lisp_Object contents[1]; |
995 | }; | |
608ff985 RS |
996 | |
997 | /* A boolvector is a kind of vectorlike, with contents are like a string. */ | |
998 | struct Lisp_Bool_Vector | |
999 | { | |
eab3844f | 1000 | /* HEADER.SIZE is the vector's size field. It doesn't have the real size, |
608ff985 | 1001 | just the subtype information. */ |
b102ceb1 | 1002 | struct vectorlike_header header; |
608ff985 | 1003 | /* This is the size in bits. */ |
b61cc01c | 1004 | EMACS_INT size; |
608ff985 RS |
1005 | /* This contains the actual bits, packed into bytes. */ |
1006 | unsigned char data[1]; | |
1007 | }; | |
1008 | ||
7c06ac2b RS |
1009 | /* This structure describes a built-in function. |
1010 | It is generated by the DEFUN macro only. | |
1011 | defsubr makes it into a Lisp object. | |
1012 | ||
1013 | This type is treated in most respects as a pseudovector, | |
1014 | but since we never dynamically allocate or free them, | |
b102ceb1 | 1015 | we don't need a struct vectorlike_header and its 'next' field. */ |
e98227af | 1016 | |
3cfe6dfd JB |
1017 | struct Lisp_Subr |
1018 | { | |
d311d28c | 1019 | ptrdiff_t size; |
c0f2f16b DN |
1020 | union { |
1021 | Lisp_Object (*a0) (void); | |
1022 | Lisp_Object (*a1) (Lisp_Object); | |
1023 | Lisp_Object (*a2) (Lisp_Object, Lisp_Object); | |
1024 | Lisp_Object (*a3) (Lisp_Object, Lisp_Object, Lisp_Object); | |
1025 | Lisp_Object (*a4) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1026 | Lisp_Object (*a5) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1027 | Lisp_Object (*a6) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1028 | Lisp_Object (*a7) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1029 | Lisp_Object (*a8) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
d5273788 | 1030 | Lisp_Object (*aUNEVALLED) (Lisp_Object args); |
f66c7cf8 | 1031 | Lisp_Object (*aMANY) (ptrdiff_t, Lisp_Object *); |
c0f2f16b | 1032 | } function; |
3cfe6dfd | 1033 | short min_args, max_args; |
5e2327cf | 1034 | const char *symbol_name; |
89dc303e DN |
1035 | const char *intspec; |
1036 | const char *doc; | |
3cfe6dfd | 1037 | }; |
5010d3b8 GM |
1038 | |
1039 | \f | |
a32fa736 GM |
1040 | /*********************************************************************** |
1041 | Symbols | |
1042 | ***********************************************************************/ | |
1043 | ||
1044 | /* Interned state of a symbol. */ | |
1045 | ||
1046 | enum symbol_interned | |
1047 | { | |
1048 | SYMBOL_UNINTERNED = 0, | |
1049 | SYMBOL_INTERNED = 1, | |
1050 | SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2 | |
1051 | }; | |
1052 | ||
ce5b453a SM |
1053 | enum symbol_redirect |
1054 | { | |
1055 | SYMBOL_PLAINVAL = 4, | |
1056 | SYMBOL_VARALIAS = 1, | |
1057 | SYMBOL_LOCALIZED = 2, | |
9aba6043 | 1058 | SYMBOL_FORWARDED = 3 |
ce5b453a SM |
1059 | }; |
1060 | ||
a32fa736 GM |
1061 | struct Lisp_Symbol |
1062 | { | |
a84f89d5 SM |
1063 | unsigned gcmarkbit : 1; |
1064 | ||
ce5b453a SM |
1065 | /* Indicates where the value can be found: |
1066 | 0 : it's a plain var, the value is in the `value' field. | |
1067 | 1 : it's a varalias, the value is really in the `alias' symbol. | |
1068 | 2 : it's a localized var, the value is in the `blv' object. | |
9aba6043 | 1069 | 3 : it's a forwarding variable, the value is in `forward'. */ |
a6fc3b5c | 1070 | ENUM_BF (symbol_redirect) redirect : 3; |
a32fa736 GM |
1071 | |
1072 | /* Non-zero means symbol is constant, i.e. changing its value | |
ce5b453a SM |
1073 | should signal an error. If the value is 3, then the var |
1074 | can be changed, but only by `defconst'. */ | |
1075 | unsigned constant : 2; | |
a32fa736 GM |
1076 | |
1077 | /* Interned state of the symbol. This is an enumerator from | |
1078 | enum symbol_interned. */ | |
1079 | unsigned interned : 2; | |
1e973bc7 | 1080 | |
b9598260 SM |
1081 | /* Non-zero means that this variable has been explicitly declared |
1082 | special (with `defvar' etc), and shouldn't be lexically bound. */ | |
1083 | unsigned declared_special : 1; | |
a32fa736 | 1084 | |
74d70085 | 1085 | /* The symbol's name, as a Lisp string. |
74d70085 KR |
1086 | The name "xname" is used to intentionally break code referring to |
1087 | the old field "name" of type pointer to struct Lisp_String. */ | |
1088 | Lisp_Object xname; | |
a32fa736 | 1089 | |
9aba6043 SM |
1090 | /* Value of the symbol or Qunbound if unbound. Which alternative of the |
1091 | union is used depends on the `redirect' field above. */ | |
ce5b453a SM |
1092 | union { |
1093 | Lisp_Object value; | |
1094 | struct Lisp_Symbol *alias; | |
1095 | struct Lisp_Buffer_Local_Value *blv; | |
1096 | union Lisp_Fwd *fwd; | |
1097 | } val; | |
a32fa736 | 1098 | |
d28981c9 | 1099 | /* Function value of the symbol or Qunbound if not fboundp. */ |
a32fa736 GM |
1100 | Lisp_Object function; |
1101 | ||
1102 | /* The symbol's property list. */ | |
1103 | Lisp_Object plist; | |
e2c0561e | 1104 | |
a32fa736 GM |
1105 | /* Next symbol in obarray bucket, if the symbol is interned. */ |
1106 | struct Lisp_Symbol *next; | |
1107 | }; | |
1108 | ||
74d70085 KR |
1109 | /* Value is name of symbol. */ |
1110 | ||
ce5b453a SM |
1111 | #define SYMBOL_VAL(sym) \ |
1112 | (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value) | |
1113 | #define SYMBOL_ALIAS(sym) \ | |
1114 | (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias) | |
1115 | #define SYMBOL_BLV(sym) \ | |
1116 | (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv) | |
1117 | #define SYMBOL_FWD(sym) \ | |
1118 | (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd) | |
1119 | #define SET_SYMBOL_VAL(sym, v) \ | |
1120 | (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v)) | |
1121 | #define SET_SYMBOL_ALIAS(sym, v) \ | |
1122 | (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v)) | |
1123 | #define SET_SYMBOL_BLV(sym, v) \ | |
1124 | (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v)) | |
1125 | #define SET_SYMBOL_FWD(sym, v) \ | |
1126 | (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v)) | |
1127 | ||
74d70085 KR |
1128 | #define SYMBOL_NAME(sym) \ |
1129 | LISP_MAKE_RVALUE (XSYMBOL (sym)->xname) | |
1130 | ||
a32fa736 GM |
1131 | /* Value is non-zero if SYM is an interned symbol. */ |
1132 | ||
1133 | #define SYMBOL_INTERNED_P(sym) \ | |
1134 | (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED) | |
1135 | ||
1136 | /* Value is non-zero if SYM is interned in initial_obarray. */ | |
1137 | ||
1138 | #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \ | |
1139 | (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY) | |
1140 | ||
1141 | /* Value is non-zero if symbol is considered a constant, i.e. its | |
1142 | value cannot be changed (there is an exception for keyword symbols, | |
1143 | whose value can be set to the keyword symbol itself). */ | |
1144 | ||
1145 | #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant | |
1146 | ||
cd3520a4 JB |
1147 | #define DEFSYM(sym, name) \ |
1148 | do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0) | |
1149 | ||
a32fa736 | 1150 | \f |
5010d3b8 GM |
1151 | /*********************************************************************** |
1152 | Hash Tables | |
1153 | ***********************************************************************/ | |
1154 | ||
1155 | /* The structure of a Lisp hash table. */ | |
1156 | ||
1157 | struct Lisp_Hash_Table | |
1158 | { | |
eab3844f | 1159 | /* This is for Lisp; the hash table code does not refer to it. */ |
b102ceb1 | 1160 | struct vectorlike_header header; |
e2c0561e | 1161 | |
5010d3b8 GM |
1162 | /* Function used to compare keys. */ |
1163 | Lisp_Object test; | |
1164 | ||
1165 | /* Nil if table is non-weak. Otherwise a symbol describing the | |
1166 | weakness of the table. */ | |
1167 | Lisp_Object weak; | |
e2c0561e | 1168 | |
5010d3b8 GM |
1169 | /* When the table is resized, and this is an integer, compute the |
1170 | new size by adding this to the old size. If a float, compute the | |
1171 | new size by multiplying the old size with this factor. */ | |
1172 | Lisp_Object rehash_size; | |
1173 | ||
1174 | /* Resize hash table when number of entries/ table size is >= this | |
1175 | ratio, a float. */ | |
1176 | Lisp_Object rehash_threshold; | |
1177 | ||
5010d3b8 GM |
1178 | /* Vector of hash codes.. If hash[I] is nil, this means that that |
1179 | entry I is unused. */ | |
1180 | Lisp_Object hash; | |
1181 | ||
1182 | /* Vector used to chain entries. If entry I is free, next[I] is the | |
1183 | entry number of the next free item. If entry I is non-free, | |
1184 | next[I] is the index of the next entry in the collision chain. */ | |
1185 | Lisp_Object next; | |
1186 | ||
1187 | /* Index of first free entry in free list. */ | |
1188 | Lisp_Object next_free; | |
1189 | ||
1190 | /* Bucket vector. A non-nil entry is the index of the first item in | |
1191 | a collision chain. This vector's size can be larger than the | |
1192 | hash table size to reduce collisions. */ | |
1193 | Lisp_Object index; | |
1194 | ||
5010d3b8 GM |
1195 | /* User-supplied hash function, or nil. */ |
1196 | Lisp_Object user_hash_function; | |
1197 | ||
1198 | /* User-supplied key comparison function, or nil. */ | |
1199 | Lisp_Object user_cmp_function; | |
1200 | ||
878f97ff | 1201 | /* Only the fields above are traced normally by the GC. The ones below |
78edd3b7 | 1202 | `count' are special and are either ignored by the GC or traced in |
878f97ff SM |
1203 | a special way (e.g. because of weakness). */ |
1204 | ||
1205 | /* Number of key/value entries in the table. */ | |
d311d28c | 1206 | ptrdiff_t count; |
878f97ff SM |
1207 | |
1208 | /* Vector of keys and values. The key of item I is found at index | |
1209 | 2 * I, the value is found at index 2 * I + 1. | |
1210 | This is gc_marked specially if the table is weak. */ | |
1211 | Lisp_Object key_and_value; | |
1212 | ||
6c661ec9 SM |
1213 | /* Next weak hash table if this is a weak hash table. The head |
1214 | of the list is in weak_hash_tables. */ | |
1215 | struct Lisp_Hash_Table *next_weak; | |
1216 | ||
5010d3b8 | 1217 | /* C function to compare two keys. */ |
0de4bb68 PE |
1218 | int (*cmpfn) (struct Lisp_Hash_Table *, |
1219 | Lisp_Object, EMACS_UINT, | |
1220 | Lisp_Object, EMACS_UINT); | |
5010d3b8 GM |
1221 | |
1222 | /* C function to compute hash code. */ | |
0de4bb68 | 1223 | EMACS_UINT (*hashfn) (struct Lisp_Hash_Table *, Lisp_Object); |
5010d3b8 GM |
1224 | }; |
1225 | ||
1226 | ||
1227 | #define XHASH_TABLE(OBJ) \ | |
b263a6b0 | 1228 | ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike)) |
5010d3b8 GM |
1229 | |
1230 | #define XSET_HASH_TABLE(VAR, PTR) \ | |
1231 | (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE)) | |
1232 | ||
1233 | #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE) | |
5010d3b8 | 1234 | |
c8a39089 KS |
1235 | #define CHECK_HASH_TABLE(x) \ |
1236 | CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x) | |
5010d3b8 | 1237 | |
141788b5 SM |
1238 | /* Value is the key part of entry IDX in hash table H. */ |
1239 | ||
915b2a6a | 1240 | #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX)) |
141788b5 SM |
1241 | |
1242 | /* Value is the value part of entry IDX in hash table H. */ | |
1243 | ||
915b2a6a | 1244 | #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1) |
141788b5 SM |
1245 | |
1246 | /* Value is the index of the next entry following the one at IDX | |
1247 | in hash table H. */ | |
1248 | ||
915b2a6a | 1249 | #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX)) |
141788b5 SM |
1250 | |
1251 | /* Value is the hash code computed for entry IDX in hash table H. */ | |
1252 | ||
915b2a6a | 1253 | #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX)) |
141788b5 SM |
1254 | |
1255 | /* Value is the index of the element in hash table H that is the | |
1256 | start of the collision list at index IDX in the index vector of H. */ | |
1257 | ||
915b2a6a | 1258 | #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX)) |
141788b5 SM |
1259 | |
1260 | /* Value is the size of hash table H. */ | |
1261 | ||
77b37c05 | 1262 | #define HASH_TABLE_SIZE(H) ASIZE ((H)->next) |
141788b5 | 1263 | |
5010d3b8 GM |
1264 | /* Default size for hash tables if not specified. */ |
1265 | ||
1266 | #define DEFAULT_HASH_SIZE 65 | |
1267 | ||
1268 | /* Default threshold specifying when to resize a hash table. The | |
1269 | value gives the ratio of current entries in the hash table and the | |
1270 | size of the hash table. */ | |
1271 | ||
1272 | #define DEFAULT_REHASH_THRESHOLD 0.8 | |
1273 | ||
1274 | /* Default factor by which to increase the size of a hash table. */ | |
1275 | ||
1276 | #define DEFAULT_REHASH_SIZE 1.5 | |
1277 | ||
ee4c9ce4 | 1278 | \f |
7c06ac2b RS |
1279 | /* These structures are used for various misc types. */ |
1280 | ||
67ee9f6e SM |
1281 | struct Lisp_Misc_Any /* Supertype of all Misc types. */ |
1282 | { | |
a6fc3b5c | 1283 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_??? */ |
67ee9f6e SM |
1284 | unsigned gcmarkbit : 1; |
1285 | int spacer : 15; | |
1286 | }; | |
1287 | ||
3cfe6dfd | 1288 | struct Lisp_Marker |
308e97d0 | 1289 | { |
a6fc3b5c | 1290 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Marker */ |
a84f89d5 | 1291 | unsigned gcmarkbit : 1; |
9bb13d08 KH |
1292 | int spacer : 13; |
1293 | /* This flag is temporarily used in the functions | |
1294 | decode/encode_coding_object to record that the marker position | |
1295 | must be adjusted after the conversion. */ | |
1296 | unsigned int need_adjustment : 1; | |
308e97d0 RS |
1297 | /* 1 means normal insertion at the marker's position |
1298 | leaves the marker after the inserted text. */ | |
1299 | unsigned int insertion_type : 1; | |
b9466edb SM |
1300 | /* This is the buffer that the marker points into, or 0 if it points nowhere. |
1301 | Note: a chain of markers can contain markers pointing into different | |
1302 | buffers (the chain is per buffer_text rather than per buffer, so it's | |
1303 | shared between indirect buffers). */ | |
1304 | /* This is used for (other than NULL-checking): | |
1305 | - Fmarker_buffer | |
1306 | - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain. | |
1307 | - unchain_marker: to find the list from which to unchain. | |
ce5b453a | 1308 | - Fkill_buffer: to only unchain the markers of current indirect buffer. |
b9466edb | 1309 | */ |
308e97d0 | 1310 | struct buffer *buffer; |
4ed24bf3 RS |
1311 | |
1312 | /* The remaining fields are meaningless in a marker that | |
1313 | does not point anywhere. */ | |
1314 | ||
1315 | /* For markers that point somewhere, | |
1316 | this is used to chain of all the markers in a given buffer. */ | |
d6aa1876 SM |
1317 | /* We could remove it and use an array in buffer_text instead. |
1318 | That would also allow to preserve it ordered. */ | |
c0ac2f4a | 1319 | struct Lisp_Marker *next; |
4ed24bf3 | 1320 | /* This is the char position where the marker points. */ |
d311d28c | 1321 | ptrdiff_t charpos; |
ce5b453a SM |
1322 | /* This is the byte position. |
1323 | It's mostly used as a charpos<->bytepos cache (i.e. it's not directly | |
1324 | used to implement the functionality of markers, but rather to (ab)use | |
1325 | markers as a cache for char<->byte mappings). */ | |
d311d28c | 1326 | ptrdiff_t bytepos; |
308e97d0 | 1327 | }; |
3cfe6dfd | 1328 | |
7555c33f SM |
1329 | /* START and END are markers in the overlay's buffer, and |
1330 | PLIST is the overlay's property list. */ | |
1331 | struct Lisp_Overlay | |
fa691a83 DA |
1332 | /* An overlay's real data content is: |
1333 | - plist | |
1334 | - buffer (really there are two buffer pointers, one per marker, | |
1335 | and both points to the same buffer) | |
1336 | - insertion type of both ends (per-marker fields) | |
1337 | - start & start byte (of start marker) | |
1338 | - end & end byte (of end marker) | |
1339 | - next (singly linked list of overlays) | |
1340 | - next fields of start and end markers (singly linked list of markers). | |
1341 | I.e. 9words plus 2 bits, 3words of which are for external linked lists. | |
1342 | */ | |
7555c33f SM |
1343 | { |
1344 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Overlay */ | |
1345 | unsigned gcmarkbit : 1; | |
1346 | int spacer : 15; | |
1347 | struct Lisp_Overlay *next; | |
1348 | Lisp_Object start, end, plist; | |
1349 | }; | |
1350 | ||
1351 | /* Hold a C pointer for later use. | |
1352 | This type of object is used in the arg to record_unwind_protect. */ | |
1353 | struct Lisp_Save_Value | |
1354 | { | |
1355 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Save_Value */ | |
1356 | unsigned gcmarkbit : 1; | |
1357 | int spacer : 14; | |
1358 | /* If DOGC is set, POINTER is the address of a memory | |
1359 | area containing INTEGER potential Lisp_Objects. */ | |
1360 | unsigned int dogc : 1; | |
1361 | void *pointer; | |
1362 | ptrdiff_t integer; | |
1363 | }; | |
1364 | ||
1365 | ||
1366 | /* A miscellaneous object, when it's on the free list. */ | |
1367 | struct Lisp_Free | |
1368 | { | |
1369 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Free */ | |
1370 | unsigned gcmarkbit : 1; | |
1371 | int spacer : 15; | |
1372 | union Lisp_Misc *chain; | |
1373 | }; | |
1374 | ||
1375 | /* To get the type field of a union Lisp_Misc, use XMISCTYPE. | |
1376 | It uses one of these struct subtypes to get the type field. */ | |
1377 | ||
1378 | union Lisp_Misc | |
1379 | { | |
1380 | struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */ | |
1381 | struct Lisp_Free u_free; | |
1382 | struct Lisp_Marker u_marker; | |
1383 | struct Lisp_Overlay u_overlay; | |
1384 | struct Lisp_Save_Value u_save_value; | |
1385 | }; | |
1386 | ||
ee4c9ce4 KH |
1387 | /* Forwarding pointer to an int variable. |
1388 | This is allowed only in the value cell of a symbol, | |
1389 | and it means that the symbol's value really lives in the | |
1390 | specified int variable. */ | |
1391 | struct Lisp_Intfwd | |
84d1833e | 1392 | { |
ce5b453a | 1393 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Int */ |
31ade731 | 1394 | EMACS_INT *intvar; |
ee4c9ce4 KH |
1395 | }; |
1396 | ||
1397 | /* Boolean forwarding pointer to an int variable. | |
1398 | This is like Lisp_Intfwd except that the ostensible | |
1399 | "value" of the symbol is t if the int variable is nonzero, | |
1400 | nil if it is zero. */ | |
1401 | struct Lisp_Boolfwd | |
1402 | { | |
ce5b453a | 1403 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Bool */ |
ee4c9ce4 KH |
1404 | int *boolvar; |
1405 | }; | |
1406 | ||
1407 | /* Forwarding pointer to a Lisp_Object variable. | |
1408 | This is allowed only in the value cell of a symbol, | |
1409 | and it means that the symbol's value really lives in the | |
1410 | specified variable. */ | |
1411 | struct Lisp_Objfwd | |
1412 | { | |
ce5b453a | 1413 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Obj */ |
ee4c9ce4 KH |
1414 | Lisp_Object *objvar; |
1415 | }; | |
1416 | ||
1417 | /* Like Lisp_Objfwd except that value lives in a slot in the | |
1418 | current buffer. Value is byte index of slot within buffer. */ | |
1419 | struct Lisp_Buffer_Objfwd | |
1420 | { | |
ce5b453a | 1421 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Buffer_Obj */ |
ee4c9ce4 | 1422 | int offset; |
ce5b453a | 1423 | Lisp_Object slottype; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */ |
84d1833e KH |
1424 | }; |
1425 | ||
65d0110b RS |
1426 | /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when |
1427 | the symbol has buffer-local or frame-local bindings. (Exception: | |
1428 | some buffer-local variables are built-in, with their values stored | |
1429 | in the buffer structure itself. They are handled differently, | |
1430 | using struct Lisp_Buffer_Objfwd.) | |
1431 | ||
1432 | The `realvalue' slot holds the variable's current value, or a | |
1433 | forwarding pointer to where that value is kept. This value is the | |
1434 | one that corresponds to the loaded binding. To read or set the | |
1435 | variable, you must first make sure the right binding is loaded; | |
1436 | then you can access the value in (or through) `realvalue'. | |
e2c0561e | 1437 | |
65d0110b RS |
1438 | `buffer' and `frame' are the buffer and frame for which the loaded |
1439 | binding was found. If those have changed, to make sure the right | |
1440 | binding is loaded it is necessary to find which binding goes with | |
1441 | the current buffer and selected frame, then load it. To load it, | |
1442 | first unload the previous binding, then copy the value of the new | |
1443 | binding into `realvalue' (or through it). Also update | |
1444 | LOADED-BINDING to point to the newly loaded binding. | |
7d65f1c2 | 1445 | |
78edd3b7 JB |
1446 | `local_if_set' indicates that merely setting the variable creates a |
1447 | local binding for the current buffer. Otherwise the latter, setting | |
1448 | the variable does not do that; only make-local-variable does that. */ | |
65d0110b | 1449 | |
7d65f1c2 KH |
1450 | struct Lisp_Buffer_Local_Value |
1451 | { | |
67ee9f6e | 1452 | /* 1 means that merely setting the variable creates a local |
7555c33f | 1453 | binding for the current buffer. */ |
67ee9f6e | 1454 | unsigned int local_if_set : 1; |
ce5b453a SM |
1455 | /* 1 means this variable can have frame-local bindings, otherwise, it is |
1456 | can have buffer-local bindings. The two cannot be combined. */ | |
1457 | unsigned int frame_local : 1; | |
1458 | /* 1 means that the binding now loaded was found. | |
7555c33f | 1459 | Presumably equivalent to (defcell!=valcell). */ |
ce5b453a SM |
1460 | unsigned int found : 1; |
1461 | /* If non-NULL, a forwarding to the C var where it should also be set. */ | |
1462 | union Lisp_Fwd *fwd; /* Should never be (Buffer|Kboard)_Objfwd. */ | |
1463 | /* The buffer or frame for which the loaded binding was found. */ | |
1464 | Lisp_Object where; | |
1465 | /* A cons cell that holds the default value. It has the form | |
1466 | (SYMBOL . DEFAULT-VALUE). */ | |
1467 | Lisp_Object defcell; | |
1468 | /* The cons cell from `where's parameter alist. | |
1469 | It always has the form (SYMBOL . VALUE) | |
1470 | Note that if `forward' is non-nil, VALUE may be out of date. | |
1471 | Also if the currently loaded binding is the default binding, then | |
1472 | this is `eq'ual to defcell. */ | |
1473 | Lisp_Object valcell; | |
7d65f1c2 KH |
1474 | }; |
1475 | ||
ce5b453a SM |
1476 | #define BLV_FOUND(blv) \ |
1477 | (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found) | |
1478 | #define SET_BLV_FOUND(blv, v) \ | |
1479 | (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v)) | |
1480 | ||
1481 | #define BLV_VALUE(blv) (XCDR ((blv)->valcell)) | |
1482 | #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v)) | |
1483 | ||
f334de0e | 1484 | /* Like Lisp_Objfwd except that value lives in a slot in the |
32462604 KH |
1485 | current kboard. */ |
1486 | struct Lisp_Kboard_Objfwd | |
f334de0e | 1487 | { |
ce5b453a | 1488 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Kboard_Obj */ |
f334de0e KH |
1489 | int offset; |
1490 | }; | |
1491 | ||
ce5b453a SM |
1492 | union Lisp_Fwd |
1493 | { | |
d55c12ed AS |
1494 | struct Lisp_Intfwd u_intfwd; |
1495 | struct Lisp_Boolfwd u_boolfwd; | |
1496 | struct Lisp_Objfwd u_objfwd; | |
1497 | struct Lisp_Buffer_Objfwd u_buffer_objfwd; | |
1498 | struct Lisp_Kboard_Objfwd u_kboard_objfwd; | |
84d1833e | 1499 | }; |
7c06ac2b | 1500 | \f |
7555c33f | 1501 | /* Lisp floating point type. */ |
3cfe6dfd JB |
1502 | struct Lisp_Float |
1503 | { | |
3a623fee AS |
1504 | union |
1505 | { | |
8f34f70a | 1506 | #ifdef HIDE_LISP_IMPLEMENTATION |
3a623fee | 1507 | double data_; |
8f34f70a | 1508 | #else |
3a623fee | 1509 | double data; |
8f34f70a | 1510 | #endif |
3a623fee AS |
1511 | struct Lisp_Float *chain; |
1512 | } u; | |
3cfe6dfd | 1513 | }; |
8f34f70a KR |
1514 | |
1515 | #ifdef HIDE_LISP_IMPLEMENTATION | |
52766425 | 1516 | #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_) |
8f34f70a | 1517 | #else |
52766425 | 1518 | #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data) |
f601cdf3 KR |
1519 | /* This should be used only in alloc.c, which always disables |
1520 | HIDE_LISP_IMPLEMENTATION. */ | |
1521 | #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n)) | |
8f34f70a | 1522 | #endif |
3cfe6dfd | 1523 | |
6195f384 DA |
1524 | /* This structure is used to record buffer state for Fsave_excursion. |
1525 | It's mostly treated as Lisp_Vector but allocated and freed explicitly | |
1526 | with xmalloc and xfree, so there is no vectorlike_header here. */ | |
1527 | ||
1528 | struct Lisp_Excursion | |
1529 | { | |
1530 | ptrdiff_t size; | |
1531 | ||
1532 | /* Saved value of XWINDOW (selected_window). */ | |
1533 | struct window *window; | |
1534 | ||
1535 | /* Buffer where this excursion is in effect. */ | |
1536 | struct buffer *buffer; | |
1537 | ||
1538 | /* Non-zero if the window above has displayed the buffer. */ | |
1539 | unsigned visible : 1; | |
1540 | ||
1541 | /* Non-zero if this buffer has the mark active. */ | |
1542 | unsigned active : 1; | |
1543 | ||
1544 | /* Saved point. */ | |
1545 | struct Lisp_Marker point; | |
1546 | ||
1547 | /* Saved mark. May point to nowhere. */ | |
1548 | struct Lisp_Marker mark; | |
1549 | }; | |
1550 | ||
3cfe6dfd | 1551 | /* A character, declared with the following typedef, is a member |
99a3d506 | 1552 | of some character set associated with the current buffer. */ |
b2ba7b00 RS |
1553 | #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */ |
1554 | #define _UCHAR_T | |
3cfe6dfd | 1555 | typedef unsigned char UCHAR; |
b2ba7b00 | 1556 | #endif |
3cfe6dfd JB |
1557 | |
1558 | /* Meanings of slots in a Lisp_Compiled: */ | |
1559 | ||
1560 | #define COMPILED_ARGLIST 0 | |
1561 | #define COMPILED_BYTECODE 1 | |
1562 | #define COMPILED_CONSTANTS 2 | |
1563 | #define COMPILED_STACK_DEPTH 3 | |
1564 | #define COMPILED_DOC_STRING 4 | |
1565 | #define COMPILED_INTERACTIVE 5 | |
88dbfee5 | 1566 | |
d03f79ef JB |
1567 | /* Flag bits in a character. These also get used in termhooks.h. |
1568 | Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE | |
7c06ac2b RS |
1569 | (MUlti-Lingual Emacs) might need 22 bits for the character value |
1570 | itself, so we probably shouldn't use any bits lower than 0x0400000. */ | |
1571 | #define CHAR_ALT (0x0400000) | |
1572 | #define CHAR_SUPER (0x0800000) | |
1573 | #define CHAR_HYPER (0x1000000) | |
1574 | #define CHAR_SHIFT (0x2000000) | |
1575 | #define CHAR_CTL (0x4000000) | |
1576 | #define CHAR_META (0x8000000) | |
703f2808 | 1577 | |
048151c1 KH |
1578 | #define CHAR_MODIFIER_MASK \ |
1579 | (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META) | |
1580 | ||
1581 | ||
1842abb2 | 1582 | /* Actually, the current Emacs uses 22 bits for the character value |
6b768554 | 1583 | itself. */ |
13ac3ac9 | 1584 | #define CHARACTERBITS 22 |
6b768554 | 1585 | |
703f2808 | 1586 | \f |
ec9ed378 KS |
1587 | /* The glyph datatype, used to represent characters on the display. |
1588 | It consists of a char code and a face id. */ | |
1589 | ||
1590 | typedef struct { | |
1591 | int ch; | |
1592 | int face_id; | |
1593 | } GLYPH; | |
703f2808 JB |
1594 | |
1595 | /* Return a glyph's character code. */ | |
ec9ed378 | 1596 | #define GLYPH_CHAR(glyph) ((glyph).ch) |
703f2808 JB |
1597 | |
1598 | /* Return a glyph's face ID. */ | |
ec9ed378 | 1599 | #define GLYPH_FACE(glyph) ((glyph).face_id) |
49b0dd75 | 1600 | |
ec9ed378 KS |
1601 | #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char)) |
1602 | #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face)) | |
1603 | #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face)) | |
703f2808 | 1604 | |
e0f24100 | 1605 | /* Return 1 if GLYPH contains valid character code. */ |
2638320e | 1606 | #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph)) |
ec9ed378 KS |
1607 | |
1608 | ||
1609 | /* Glyph Code from a display vector may either be an integer which | |
1610 | encodes a char code in the lower CHARACTERBITS bits and a (very small) | |
1611 | face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */ | |
1612 | ||
d311d28c PE |
1613 | #define GLYPH_CODE_P(gc) \ |
1614 | (CONSP (gc) \ | |
1615 | ? (CHARACTERP (XCAR (gc)) \ | |
1616 | && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \ | |
1617 | : (RANGED_INTEGERP \ | |
1618 | (0, gc, \ | |
1619 | (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \ | |
1620 | ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \ | |
1621 | : TYPE_MAXIMUM (EMACS_INT))))) | |
ec9ed378 | 1622 | |
d311d28c | 1623 | /* The following are valid only if GLYPH_CODE_P (gc). */ |
ec9ed378 | 1624 | |
d311d28c PE |
1625 | #define GLYPH_CODE_CHAR(gc) \ |
1626 | (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1)) | |
ec9ed378 | 1627 | |
d311d28c PE |
1628 | #define GLYPH_CODE_FACE(gc) \ |
1629 | (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS) | |
ec9ed378 | 1630 | |
ec9ed378 KS |
1631 | #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \ |
1632 | do \ | |
1633 | { \ | |
1634 | if (CONSP (gc)) \ | |
1635 | SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \ | |
1636 | else \ | |
1637 | SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \ | |
1638 | (XINT (gc) >> CHARACTERBITS)); \ | |
1639 | } \ | |
1640 | while (0) | |
b96656ce | 1641 | |
4606cc9d RS |
1642 | /* The ID of the mode line highlighting face. */ |
1643 | #define GLYPH_MODE_LINE_FACE 1 | |
3cfe6dfd | 1644 | \f |
7ea692f6 EZ |
1645 | /* Structure to hold mouse highlight data. This is here because other |
1646 | header files need it for defining struct x_output etc. */ | |
1647 | typedef struct { | |
1648 | /* These variables describe the range of text currently shown in its | |
1649 | mouse-face, together with the window they apply to. As long as | |
1650 | the mouse stays within this range, we need not redraw anything on | |
1651 | its account. Rows and columns are glyph matrix positions in | |
1652 | MOUSE_FACE_WINDOW. */ | |
1653 | int mouse_face_beg_row, mouse_face_beg_col; | |
1654 | int mouse_face_beg_x, mouse_face_beg_y; | |
1655 | int mouse_face_end_row, mouse_face_end_col; | |
1656 | int mouse_face_end_x, mouse_face_end_y; | |
1657 | int mouse_face_past_end; | |
1658 | Lisp_Object mouse_face_window; | |
1659 | int mouse_face_face_id; | |
1660 | Lisp_Object mouse_face_overlay; | |
1661 | ||
1662 | /* 1 if a mouse motion event came and we didn't handle it right away because | |
1663 | gc was in progress. */ | |
1664 | int mouse_face_deferred_gc; | |
1665 | ||
1666 | /* FRAME and X, Y position of mouse when last checked for | |
1667 | highlighting. X and Y can be negative or out of range for the frame. */ | |
1668 | struct frame *mouse_face_mouse_frame; | |
1669 | int mouse_face_mouse_x, mouse_face_mouse_y; | |
1670 | ||
1671 | /* Nonzero means defer mouse-motion highlighting. */ | |
1672 | int mouse_face_defer; | |
1673 | ||
1674 | /* Nonzero means that the mouse highlight should not be shown. */ | |
1675 | int mouse_face_hidden; | |
1676 | ||
1677 | int mouse_face_image_state; | |
1678 | } Mouse_HLInfo; | |
1679 | \f | |
3cfe6dfd JB |
1680 | /* Data type checking */ |
1681 | ||
3c7a4fa3 | 1682 | #define NILP(x) EQ (x, Qnil) |
3cfe6dfd | 1683 | |
c5af3bb9 | 1684 | #define NUMBERP(x) (INTEGERP (x) || FLOATP (x)) |
a4a9f09f | 1685 | #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0) |
4746118a | 1686 | |
ca9ce8f2 PE |
1687 | #define RANGED_INTEGERP(lo, x, hi) \ |
1688 | (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi)) | |
1689 | #define TYPE_RANGED_INTEGERP(type, x) \ | |
d311d28c PE |
1690 | (TYPE_SIGNED (type) \ |
1691 | ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \ | |
1692 | : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type))) | |
ca9ce8f2 | 1693 | |
2de9f71c | 1694 | #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x)))) |
edfa9106 | 1695 | #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol) |
84d1833e | 1696 | #define MISCP(x) (XTYPE ((x)) == Lisp_Misc) |
b5088f80 | 1697 | #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike) |
edfa9106 | 1698 | #define STRINGP(x) (XTYPE ((x)) == Lisp_String) |
3cfe6dfd | 1699 | #define CONSP(x) (XTYPE ((x)) == Lisp_Cons) |
7c06ac2b | 1700 | |
edfa9106 | 1701 | #define FLOATP(x) (XTYPE ((x)) == Lisp_Float) |
77b37c05 | 1702 | #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG)) |
a7aa28f6 | 1703 | #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay) |
a7aa28f6 | 1704 | #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker) |
19fa82b9 | 1705 | #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value) |
edfa9106 | 1706 | |
ce5b453a SM |
1707 | #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int) |
1708 | #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool) | |
1709 | #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj) | |
1710 | #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj) | |
1711 | #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj) | |
7c06ac2b | 1712 | |
aa0b0087 PE |
1713 | /* True if object X is a pseudovector whose code is CODE. The cast to struct |
1714 | vectorlike_header * avoids aliasing issues. */ | |
7c06ac2b | 1715 | #define PSEUDOVECTORP(x, code) \ |
ee28be33 SM |
1716 | TYPED_PSEUDOVECTORP (x, vectorlike_header, code) |
1717 | ||
1718 | #define PSEUDOVECTOR_TYPEP(v, code) \ | |
1719 | (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \ | |
1720 | == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))) | |
eab3844f PE |
1721 | |
1722 | /* True if object X, with internal type struct T *, is a pseudovector whose | |
1723 | code is CODE. */ | |
1724 | #define TYPED_PSEUDOVECTORP(x, t, code) \ | |
7c06ac2b | 1725 | (VECTORLIKEP (x) \ |
ee28be33 | 1726 | && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code)) |
7c06ac2b | 1727 | |
7c06ac2b RS |
1728 | /* Test for specific pseudovector types. */ |
1729 | #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION) | |
7c06ac2b | 1730 | #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS) |
7c06ac2b | 1731 | #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW) |
49e49fb5 | 1732 | #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL) |
6195f384 DA |
1733 | /* These are special because both Lisp_Subr and Lisp_Excursion lacks |
1734 | struct vectorlike_header. */ | |
eab3844f | 1735 | #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR) |
6195f384 | 1736 | #define EXCURSIONP(x) TYPED_PSEUDOVECTORP (x, Lisp_Excursion, PVEC_EXCURSION) |
7c06ac2b | 1737 | #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED) |
99a3d506 | 1738 | #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER) |
608ff985 | 1739 | #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE) |
1842abb2 | 1740 | #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE) |
608ff985 | 1741 | #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR) |
7c06ac2b | 1742 | #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME) |
ea724a01 | 1743 | |
6b61353c KH |
1744 | /* Test for image (image . spec) */ |
1745 | #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage)) | |
1746 | ||
c8a39089 KS |
1747 | /* Array types. */ |
1748 | ||
1749 | #define ARRAYP(x) \ | |
1750 | (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x)) | |
7c06ac2b | 1751 | \f |
874cc80e | 1752 | #define CHECK_LIST(x) \ |
c8a39089 KS |
1753 | CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x) |
1754 | ||
1755 | #define CHECK_LIST_CONS(x, y) \ | |
1756 | CHECK_TYPE (CONSP (x), Qlistp, y) | |
1757 | ||
1758 | #define CHECK_LIST_END(x, y) \ | |
1759 | CHECK_TYPE (NILP (x), Qlistp, y) | |
3cfe6dfd | 1760 | |
874cc80e | 1761 | #define CHECK_STRING(x) \ |
c8a39089 | 1762 | CHECK_TYPE (STRINGP (x), Qstringp, x) |
3cfe6dfd | 1763 | |
57ddb5d0 | 1764 | #define CHECK_STRING_CAR(x) \ |
c8a39089 | 1765 | CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x)) |
57ddb5d0 | 1766 | |
874cc80e | 1767 | #define CHECK_CONS(x) \ |
c8a39089 | 1768 | CHECK_TYPE (CONSP (x), Qconsp, x) |
3cfe6dfd | 1769 | |
874cc80e | 1770 | #define CHECK_SYMBOL(x) \ |
c8a39089 | 1771 | CHECK_TYPE (SYMBOLP (x), Qsymbolp, x) |
3cfe6dfd | 1772 | |
874cc80e | 1773 | #define CHECK_CHAR_TABLE(x) \ |
c8a39089 | 1774 | CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x) |
608ff985 | 1775 | |
874cc80e | 1776 | #define CHECK_VECTOR(x) \ |
c8a39089 | 1777 | CHECK_TYPE (VECTORP (x), Qvectorp, x) |
3cfe6dfd | 1778 | |
c8a39089 KS |
1779 | #define CHECK_VECTOR_OR_STRING(x) \ |
1780 | CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x) | |
1781 | ||
78edd3b7 | 1782 | #define CHECK_ARRAY(x, Qxxxp) \ |
c8a39089 KS |
1783 | CHECK_TYPE (ARRAYP (x), Qxxxp, x) |
1784 | ||
1785 | #define CHECK_VECTOR_OR_CHAR_TABLE(x) \ | |
1786 | CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x) | |
7f73dc9d | 1787 | |
874cc80e | 1788 | #define CHECK_BUFFER(x) \ |
c8a39089 | 1789 | CHECK_TYPE (BUFFERP (x), Qbufferp, x) |
3cfe6dfd | 1790 | |
874cc80e | 1791 | #define CHECK_WINDOW(x) \ |
c8a39089 KS |
1792 | CHECK_TYPE (WINDOWP (x), Qwindowp, x) |
1793 | ||
1794 | #define CHECK_WINDOW_CONFIGURATION(x) \ | |
1795 | CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x) | |
3cfe6dfd | 1796 | |
03273ec5 | 1797 | /* This macro rejects windows on the interior of the window tree as |
e98227af | 1798 | "dead", which is what we want; this is an argument-checking macro, and |
03273ec5 JB |
1799 | the user should never get access to interior windows. |
1800 | ||
e0f24100 | 1801 | A window of any sort, leaf or interior, is dead if the buffer, |
03273ec5 JB |
1802 | vchild, and hchild members are all nil. */ |
1803 | ||
c8a39089 KS |
1804 | #define CHECK_LIVE_WINDOW(x) \ |
1805 | CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x) | |
03273ec5 | 1806 | |
874cc80e | 1807 | #define CHECK_PROCESS(x) \ |
c8a39089 KS |
1808 | CHECK_TYPE (PROCESSP (x), Qprocessp, x) |
1809 | ||
1810 | #define CHECK_SUBR(x) \ | |
1811 | CHECK_TYPE (SUBRP (x), Qsubrp, x) | |
3cfe6dfd | 1812 | |
874cc80e | 1813 | #define CHECK_NUMBER(x) \ |
c8a39089 | 1814 | CHECK_TYPE (INTEGERP (x), Qintegerp, x) |
3cfe6dfd | 1815 | |
874cc80e | 1816 | #define CHECK_NATNUM(x) \ |
c8a39089 | 1817 | CHECK_TYPE (NATNUMP (x), Qwholenump, x) |
3cfe6dfd | 1818 | |
af5a5a98 | 1819 | #define CHECK_RANGED_INTEGER(x, lo, hi) \ |
d311d28c PE |
1820 | do { \ |
1821 | CHECK_NUMBER (x); \ | |
1822 | if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \ | |
1823 | args_out_of_range_3 \ | |
1824 | (x, \ | |
1825 | make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \ | |
1826 | ? MOST_NEGATIVE_FIXNUM \ | |
1827 | : (lo)), \ | |
1828 | make_number (min (hi, MOST_POSITIVE_FIXNUM))); \ | |
1829 | } while (0) | |
1830 | #define CHECK_TYPE_RANGED_INTEGER(type, x) \ | |
1831 | do { \ | |
1832 | if (TYPE_SIGNED (type)) \ | |
af5a5a98 | 1833 | CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \ |
d311d28c | 1834 | else \ |
af5a5a98 | 1835 | CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \ |
d311d28c PE |
1836 | } while (0) |
1837 | ||
874cc80e | 1838 | #define CHECK_MARKER(x) \ |
c8a39089 | 1839 | CHECK_TYPE (MARKERP (x), Qmarkerp, x) |
3cfe6dfd | 1840 | |
874cc80e | 1841 | #define CHECK_NUMBER_COERCE_MARKER(x) \ |
221f4ef3 | 1842 | do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \ |
c8a39089 | 1843 | else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0) |
3cfe6dfd | 1844 | |
3cfe6dfd JB |
1845 | #define XFLOATINT(n) extract_float((n)) |
1846 | ||
78edd3b7 | 1847 | #define CHECK_FLOAT(x) \ |
c8a39089 | 1848 | CHECK_TYPE (FLOATP (x), Qfloatp, x) |
3cfe6dfd | 1849 | |
78edd3b7 | 1850 | #define CHECK_NUMBER_OR_FLOAT(x) \ |
c8a39089 | 1851 | CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x) |
3cfe6dfd | 1852 | |
874cc80e | 1853 | #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \ |
78edd3b7 | 1854 | do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \ |
c8a39089 | 1855 | else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0) |
3cfe6dfd | 1856 | |
874cc80e | 1857 | #define CHECK_OVERLAY(x) \ |
c8a39089 | 1858 | CHECK_TYPE (OVERLAYP (x), Qoverlayp, x) |
20280af7 | 1859 | |
f3fbd155 KR |
1860 | /* Since we can't assign directly to the CAR or CDR fields of a cons |
1861 | cell, use these when checking that those fields contain numbers. */ | |
874cc80e | 1862 | #define CHECK_NUMBER_CAR(x) \ |
f3fbd155 KR |
1863 | do { \ |
1864 | Lisp_Object tmp = XCAR (x); \ | |
874cc80e | 1865 | CHECK_NUMBER (tmp); \ |
f3fbd155 KR |
1866 | XSETCAR ((x), tmp); \ |
1867 | } while (0) | |
1868 | ||
874cc80e | 1869 | #define CHECK_NUMBER_CDR(x) \ |
f3fbd155 KR |
1870 | do { \ |
1871 | Lisp_Object tmp = XCDR (x); \ | |
874cc80e | 1872 | CHECK_NUMBER (tmp); \ |
f3fbd155 KR |
1873 | XSETCDR ((x), tmp); \ |
1874 | } while (0) | |
1875 | ||
8f924df7 KH |
1876 | #define CHECK_NATNUM_CAR(x) \ |
1877 | do { \ | |
1878 | Lisp_Object tmp = XCAR (x); \ | |
1879 | CHECK_NATNUM (tmp); \ | |
1880 | XSETCAR ((x), tmp); \ | |
1881 | } while (0) | |
1882 | ||
1883 | #define CHECK_NATNUM_CDR(x) \ | |
1884 | do { \ | |
1885 | Lisp_Object tmp = XCDR (x); \ | |
1886 | CHECK_NATNUM (tmp); \ | |
1887 | XSETCDR ((x), tmp); \ | |
1888 | } while (0) | |
3cfe6dfd JB |
1889 | \f |
1890 | /* Define a built-in function for calling from Lisp. | |
1891 | `lname' should be the name to give the function in Lisp, | |
1892 | as a null-terminated C string. | |
1893 | `fnname' should be the name of the function in C. | |
1894 | By convention, it starts with F. | |
1895 | `sname' should be the name for the C constant structure | |
1896 | that records information on this function for internal use. | |
1897 | By convention, it should be the same as `fnname' but with S instead of F. | |
1898 | It's too bad that C macros can't compute this from `fnname'. | |
1899 | `minargs' should be a number, the minimum number of arguments allowed. | |
1900 | `maxargs' should be a number, the maximum number of arguments allowed, | |
1901 | or else MANY or UNEVALLED. | |
1902 | MANY means pass a vector of evaluated arguments, | |
1903 | in the form of an integer number-of-arguments | |
1904 | followed by the address of a vector of Lisp_Objects | |
1905 | which contains the argument values. | |
1906 | UNEVALLED means pass the list of unevaluated arguments | |
4bca9161 MC |
1907 | `intspec' says how interactive arguments are to be fetched. |
1908 | If the string starts with a `(', `intspec' is evaluated and the resulting | |
1909 | list is the list of arguments. | |
1910 | If it's a string that doesn't start with `(', the value should follow | |
1911 | the one of the doc string for `interactive'. | |
3cfe6dfd | 1912 | A null string means call interactively with no arguments. |
eab9d423 | 1913 | `doc' is documentation for the user. */ |
3cfe6dfd | 1914 | |
c451d7b1 | 1915 | /* This version of DEFUN declares a function prototype with the right |
99a3d506 | 1916 | arguments, so we can catch errors with maxargs at compile-time. */ |
a6fc3b5c EZ |
1917 | #ifdef _MSC_VER |
1918 | #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \ | |
1919 | Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \ | |
1920 | static DECL_ALIGN (struct Lisp_Subr, sname) = \ | |
ee28be33 SM |
1921 | { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \ |
1922 | | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \ | |
a6fc3b5c EZ |
1923 | { (Lisp_Object (__cdecl *)(void))fnname }, \ |
1924 | minargs, maxargs, lname, intspec, 0}; \ | |
1925 | Lisp_Object fnname | |
1926 | #else /* not _MSC_VER */ | |
1927 | #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \ | |
1928 | Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \ | |
1929 | static DECL_ALIGN (struct Lisp_Subr, sname) = \ | |
ee28be33 | 1930 | { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \ |
a6fc3b5c EZ |
1931 | { .a ## maxargs = fnname }, \ |
1932 | minargs, maxargs, lname, intspec, 0}; \ | |
1933 | Lisp_Object fnname | |
1934 | #endif | |
c451d7b1 RS |
1935 | |
1936 | /* Note that the weird token-substitution semantics of ANSI C makes | |
99a3d506 | 1937 | this work for MANY and UNEVALLED. */ |
f66c7cf8 | 1938 | #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *) |
c451d7b1 RS |
1939 | #define DEFUN_ARGS_UNEVALLED (Lisp_Object) |
1940 | #define DEFUN_ARGS_0 (void) | |
1941 | #define DEFUN_ARGS_1 (Lisp_Object) | |
1942 | #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object) | |
1943 | #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object) | |
1944 | #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object) | |
1945 | #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ | |
1946 | Lisp_Object) | |
1947 | #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ | |
1948 | Lisp_Object, Lisp_Object) | |
1949 | #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ | |
1950 | Lisp_Object, Lisp_Object, Lisp_Object) | |
5593f7e3 KH |
1951 | #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ |
1952 | Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object) | |
276680c4 | 1953 | |
78edd3b7 | 1954 | /* Non-zero if OBJ is a Lisp function. */ |
276680c4 GM |
1955 | #define FUNCTIONP(OBJ) \ |
1956 | ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \ | |
1957 | || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \ | |
1958 | || COMPILEDP (OBJ) \ | |
1959 | || SUBRP (OBJ)) | |
e2c0561e | 1960 | |
3cfe6dfd | 1961 | /* defsubr (Sname); |
d19b9aa8 | 1962 | is how we define the symbol for function `name' at start-up time. */ |
383e0970 | 1963 | extern void defsubr (struct Lisp_Subr *); |
3cfe6dfd JB |
1964 | |
1965 | #define MANY -2 | |
1966 | #define UNEVALLED -1 | |
1967 | ||
ce5b453a SM |
1968 | extern void defvar_lisp (struct Lisp_Objfwd *, const char *, Lisp_Object *); |
1969 | extern void defvar_lisp_nopro (struct Lisp_Objfwd *, const char *, Lisp_Object *); | |
1970 | extern void defvar_bool (struct Lisp_Boolfwd *, const char *, int *); | |
1971 | extern void defvar_int (struct Lisp_Intfwd *, const char *, EMACS_INT *); | |
1972 | extern void defvar_kboard (struct Lisp_Kboard_Objfwd *, const char *, int); | |
3cfe6dfd JB |
1973 | |
1974 | /* Macros we use to define forwarded Lisp variables. | |
29208e82 | 1975 | These are used in the syms_of_FILENAME functions. |
51b59d79 | 1976 | |
29208e82 TT |
1977 | An ordinary (not in buffer_defaults, per-buffer, or per-keyboard) |
1978 | lisp variable is actually a field in `struct emacs_globals'. The | |
1979 | field's name begins with "f_", which is a convention enforced by | |
1980 | these macros. Each such global has a corresponding #define in | |
1981 | globals.h; the plain name should be used in the code. | |
1982 | ||
1983 | E.g., the global "cons_cells_consed" is declared as "int | |
1984 | f_cons_cells_consed" in globals.h, but there is a define: | |
1985 | ||
1986 | #define cons_cells_consed globals.f_cons_cells_consed | |
1987 | ||
1988 | All C code uses the `cons_cells_consed' name. This is all done | |
1989 | this way to support indirection for multi-threaded Emacs. */ | |
3cfe6dfd | 1990 | |
ce5b453a SM |
1991 | #define DEFVAR_LISP(lname, vname, doc) \ |
1992 | do { \ | |
1993 | static struct Lisp_Objfwd o_fwd; \ | |
29208e82 | 1994 | defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \ |
ce5b453a SM |
1995 | } while (0) |
1996 | #define DEFVAR_LISP_NOPRO(lname, vname, doc) \ | |
1997 | do { \ | |
1998 | static struct Lisp_Objfwd o_fwd; \ | |
29208e82 | 1999 | defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \ |
ce5b453a SM |
2000 | } while (0) |
2001 | #define DEFVAR_BOOL(lname, vname, doc) \ | |
2002 | do { \ | |
2003 | static struct Lisp_Boolfwd b_fwd; \ | |
29208e82 | 2004 | defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \ |
ce5b453a SM |
2005 | } while (0) |
2006 | #define DEFVAR_INT(lname, vname, doc) \ | |
2007 | do { \ | |
2008 | static struct Lisp_Intfwd i_fwd; \ | |
29208e82 | 2009 | defvar_int (&i_fwd, lname, &globals.f_ ## vname); \ |
ce5b453a | 2010 | } while (0) |
92d2947b | 2011 | |
422745d0 TT |
2012 | #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \ |
2013 | do { \ | |
2014 | static struct Lisp_Objfwd o_fwd; \ | |
eb4916d7 | 2015 | defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \ |
422745d0 TT |
2016 | } while (0) |
2017 | ||
ce5b453a SM |
2018 | #define DEFVAR_KBOARD(lname, vname, doc) \ |
2019 | do { \ | |
2020 | static struct Lisp_Kboard_Objfwd ko_fwd; \ | |
437b2cb4 | 2021 | defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \ |
ce5b453a | 2022 | } while (0) |
df7cd53b | 2023 | |
df7cd53b | 2024 | |
3cfe6dfd | 2025 | \f |
78ca380c JB |
2026 | /* Structure for recording Lisp call stack for backtrace purposes. */ |
2027 | ||
2028 | /* The special binding stack holds the outer values of variables while | |
2029 | they are bound by a function application or a let form, stores the | |
2030 | code to be executed for Lisp unwind-protect forms, and stores the C | |
2031 | functions to be called for record_unwind_protect. | |
2032 | ||
2033 | If func is non-zero, undoing this binding applies func to old_value; | |
2034 | This implements record_unwind_protect. | |
5fd6e274 RS |
2035 | |
2036 | Otherwise, the element is a variable binding. | |
e2c0561e | 2037 | |
5fd6e274 | 2038 | If the symbol field is a symbol, it is an ordinary variable binding. |
e2c0561e | 2039 | |
78edd3b7 JB |
2040 | Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER), |
2041 | which means having bound a local value while CURRENT-BUFFER was active. | |
2042 | If WHERE is nil this means we saw the default value when binding SYMBOL. | |
2043 | WHERE being a buffer or frame means we saw a buffer-local or frame-local | |
2044 | value. Other values of WHERE mean an internal error. */ | |
5fd6e274 | 2045 | |
383e0970 | 2046 | typedef Lisp_Object (*specbinding_func) (Lisp_Object); |
07c9ebd6 | 2047 | |
3cfe6dfd JB |
2048 | struct specbinding |
2049 | { | |
a7af5886 SM |
2050 | Lisp_Object symbol, old_value; |
2051 | specbinding_func func; | |
3cfe6dfd JB |
2052 | Lisp_Object unused; /* Dividing by 16 is faster than by 12 */ |
2053 | }; | |
2054 | ||
2055 | extern struct specbinding *specpdl; | |
a7af5886 | 2056 | extern struct specbinding *specpdl_ptr; |
d311d28c | 2057 | extern ptrdiff_t specpdl_size; |
3cfe6dfd | 2058 | |
d311d28c | 2059 | #define SPECPDL_INDEX() (specpdl_ptr - specpdl) |
acb8dc44 | 2060 | |
78ca380c | 2061 | /* Everything needed to describe an active condition case. */ |
3cfe6dfd JB |
2062 | struct handler |
2063 | { | |
78ca380c | 2064 | /* The handler clauses and variable from the condition-case form. */ |
992dd91a RS |
2065 | /* For a handler set up in Lisp code, this is always a list. |
2066 | For an internal handler set up by internal_condition_case*, | |
2067 | this can instead be the symbol t or `error'. | |
2068 | t: handle all conditions. | |
2069 | error: handle all conditions, and errors can run the debugger | |
2070 | or display a backtrace. */ | |
3cfe6dfd JB |
2071 | Lisp_Object handler; |
2072 | Lisp_Object var; | |
22bbbd42 RS |
2073 | /* Fsignal stores here the condition-case clause that applies, |
2074 | and Fcondition_case thus knows which clause to run. */ | |
2075 | Lisp_Object chosen_clause; | |
78ca380c JB |
2076 | |
2077 | /* Used to effect the longjump out to the handler. */ | |
3cfe6dfd | 2078 | struct catchtag *tag; |
78ca380c JB |
2079 | |
2080 | /* The next enclosing handler. */ | |
3cfe6dfd JB |
2081 | struct handler *next; |
2082 | }; | |
2083 | ||
d7306fe6 DN |
2084 | /* This structure helps implement the `catch' and `throw' control |
2085 | structure. A struct catchtag contains all the information needed | |
2086 | to restore the state of the interpreter after a non-local jump. | |
2087 | ||
2088 | Handlers for error conditions (represented by `struct handler' | |
2089 | structures) just point to a catch tag to do the cleanup required | |
2090 | for their jumps. | |
2091 | ||
2092 | catchtag structures are chained together in the C calling stack; | |
2093 | the `next' member points to the next outer catchtag. | |
2094 | ||
2095 | A call like (throw TAG VAL) searches for a catchtag whose `tag' | |
2096 | member is TAG, and then unbinds to it. The `val' member is used to | |
2097 | hold VAL while the stack is unwound; `val' is returned as the value | |
2098 | of the catch form. | |
2099 | ||
2100 | All the other members are concerned with restoring the interpreter | |
2101 | state. */ | |
2102 | ||
2103 | struct catchtag | |
2104 | { | |
2105 | Lisp_Object tag; | |
2106 | Lisp_Object val; | |
2107 | struct catchtag *next; | |
2108 | struct gcpro *gcpro; | |
2109 | jmp_buf jmp; | |
2110 | struct backtrace *backlist; | |
2111 | struct handler *handlerlist; | |
d311d28c PE |
2112 | EMACS_INT lisp_eval_depth; |
2113 | ptrdiff_t pdlcount; | |
d7306fe6 DN |
2114 | int poll_suppress_count; |
2115 | int interrupt_input_blocked; | |
2116 | struct byte_stack *byte_stack; | |
2117 | }; | |
2118 | ||
22bbbd42 RS |
2119 | extern Lisp_Object memory_signal_data; |
2120 | ||
3cfe6dfd JB |
2121 | /* An address near the bottom of the stack. |
2122 | Tells GC how to save a copy of the stack. */ | |
2123 | extern char *stack_bottom; | |
2124 | ||
4742f524 RS |
2125 | /* Check quit-flag and quit if it is non-nil. |
2126 | Typing C-g does not directly cause a quit; it only sets Vquit_flag. | |
2127 | So the program needs to do QUIT at times when it is safe to quit. | |
2128 | Every loop that might run for a long time or might not exit | |
2129 | ought to do QUIT at least once, at a safe place. | |
2130 | Unless that is impossible, of course. | |
2131 | But it is very desirable to avoid creating loops where QUIT is impossible. | |
2132 | ||
2133 | Exception: if you set immediate_quit to nonzero, | |
2134 | then the handler that responds to the C-g does the quit itself. | |
2135 | This is a good thing to do around a loop that has no side effects | |
6c07aac2 AS |
2136 | and (in particular) cannot call arbitrary Lisp code. |
2137 | ||
2138 | If quit-flag is set to `kill-emacs' the SIGINT handler has received | |
2139 | a request to exit Emacs when it is safe to do. */ | |
3cfe6dfd | 2140 | |
6b61353c | 2141 | #ifdef SYNC_INPUT |
383e0970 | 2142 | extern void process_pending_signals (void); |
26f1ab24 | 2143 | extern int pending_signals; |
c0335e02 SM |
2144 | #define ELSE_PENDING_SIGNALS \ |
2145 | else if (pending_signals) \ | |
2146 | process_pending_signals (); | |
6b61353c | 2147 | #else /* not SYNC_INPUT */ |
c0335e02 SM |
2148 | #define ELSE_PENDING_SIGNALS |
2149 | #endif /* not SYNC_INPUT */ | |
6b61353c | 2150 | |
7dbda6df | 2151 | extern void process_quit_flag (void); |
a69a6e61 GM |
2152 | #define QUIT \ |
2153 | do { \ | |
2154 | if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \ | |
6d5eb5b0 | 2155 | process_quit_flag (); \ |
c0335e02 | 2156 | ELSE_PENDING_SIGNALS \ |
a69a6e61 | 2157 | } while (0) |
3cfe6dfd | 2158 | |
6b61353c | 2159 | |
3cfe6dfd JB |
2160 | /* Nonzero if ought to quit now. */ |
2161 | ||
efb859b4 | 2162 | #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) |
3cfe6dfd | 2163 | \f |
31cd66f3 PE |
2164 | extern Lisp_Object Vascii_downcase_table; |
2165 | extern Lisp_Object Vascii_canon_table; | |
3cfe6dfd | 2166 | \f |
99a3d506 | 2167 | /* Structure for recording stack slots that need marking. */ |
3cfe6dfd | 2168 | |
78edd3b7 JB |
2169 | /* This is a chain of structures, each of which points at a Lisp_Object |
2170 | variable whose value should be marked in garbage collection. | |
2171 | Normally every link of the chain is an automatic variable of a function, | |
2172 | and its `val' points to some argument or local variable of the function. | |
2173 | On exit to the function, the chain is set back to the value it had on entry. | |
2174 | This way, no link remains in the chain when the stack frame containing the | |
2175 | link disappears. | |
3cfe6dfd | 2176 | |
78edd3b7 JB |
2177 | Every function that can call Feval must protect in this fashion all |
2178 | Lisp_Object variables whose contents will be used again. */ | |
3cfe6dfd JB |
2179 | |
2180 | extern struct gcpro *gcprolist; | |
2181 | ||
2182 | struct gcpro | |
834168ef GM |
2183 | { |
2184 | struct gcpro *next; | |
e2c0561e | 2185 | |
834168ef GM |
2186 | /* Address of first protected variable. */ |
2187 | volatile Lisp_Object *var; | |
e2c0561e | 2188 | |
834168ef | 2189 | /* Number of consecutive protected variables. */ |
f66c7cf8 | 2190 | ptrdiff_t nvars; |
e2c0561e | 2191 | |
4742f524 | 2192 | #ifdef DEBUG_GCPRO |
834168ef | 2193 | int level; |
4742f524 | 2194 | #endif |
834168ef | 2195 | }; |
3cfe6dfd | 2196 | |
1216f5e4 GM |
2197 | /* Values of GC_MARK_STACK during compilation: |
2198 | ||
2199 | 0 Use GCPRO as before | |
2200 | 1 Do the real thing, make GCPROs and UNGCPRO no-ops. | |
2201 | 2 Mark the stack, and check that everything GCPRO'd is | |
2202 | marked. | |
2203 | 3 Mark using GCPRO's, mark stack last, and count how many | |
2204 | dead objects are kept alive. */ | |
2205 | ||
2206 | ||
2207 | #define GC_USE_GCPROS_AS_BEFORE 0 | |
2208 | #define GC_MAKE_GCPROS_NOOPS 1 | |
2209 | #define GC_MARK_STACK_CHECK_GCPROS 2 | |
2210 | #define GC_USE_GCPROS_CHECK_ZOMBIES 3 | |
2211 | ||
2212 | #ifndef GC_MARK_STACK | |
b948ce8b | 2213 | #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS |
1216f5e4 GM |
2214 | #endif |
2215 | ||
b286858c SM |
2216 | /* Whether we do the stack marking manually. */ |
2217 | #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \ | |
2218 | || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS) | |
2219 | ||
2220 | ||
1216f5e4 GM |
2221 | #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS |
2222 | ||
9f0443f9 | 2223 | /* Do something silly with gcproN vars just so gcc shuts up. */ |
656c33dc | 2224 | /* You get warnings from MIPSPro... */ |
9f0443f9 | 2225 | |
dbf31225 PE |
2226 | #define GCPRO1(varname) ((void) gcpro1) |
2227 | #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1) | |
2228 | #define GCPRO3(varname1, varname2, varname3) \ | |
2229 | ((void) gcpro3, (void) gcpro2, (void) gcpro1) | |
2230 | #define GCPRO4(varname1, varname2, varname3, varname4) \ | |
2231 | ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1) | |
2232 | #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \ | |
2233 | ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1) | |
2234 | #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \ | |
2235 | ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \ | |
2236 | (void) gcpro1) | |
2237 | #define UNGCPRO ((void) 0) | |
1216f5e4 GM |
2238 | |
2239 | #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */ | |
2240 | ||
4742f524 RS |
2241 | #ifndef DEBUG_GCPRO |
2242 | ||
dbf31225 PE |
2243 | #define GCPRO1(varname) \ |
2244 | {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \ | |
2245 | gcprolist = &gcpro1; } | |
2246 | ||
2247 | #define GCPRO2(varname1, varname2) \ | |
2248 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2249 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2250 | gcprolist = &gcpro2; } | |
2251 | ||
2252 | #define GCPRO3(varname1, varname2, varname3) \ | |
2253 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2254 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2255 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
2256 | gcprolist = &gcpro3; } | |
2257 | ||
2258 | #define GCPRO4(varname1, varname2, varname3, varname4) \ | |
2259 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2260 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2261 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
2262 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
2263 | gcprolist = &gcpro4; } | |
2264 | ||
2265 | #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \ | |
2266 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2267 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2268 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
2269 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
2270 | gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \ | |
2271 | gcprolist = &gcpro5; } | |
2272 | ||
2273 | #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \ | |
2274 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2275 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2276 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
2277 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
2278 | gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \ | |
2279 | gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \ | |
2280 | gcprolist = &gcpro6; } | |
2281 | ||
2282 | #define UNGCPRO (gcprolist = gcpro1.next) | |
3cfe6dfd | 2283 | |
4742f524 | 2284 | #else |
e98227af | 2285 | |
4742f524 RS |
2286 | extern int gcpro_level; |
2287 | ||
dbf31225 PE |
2288 | #define GCPRO1(varname) \ |
2289 | {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \ | |
2290 | gcpro1.level = gcpro_level++; \ | |
2291 | gcprolist = &gcpro1; } | |
2292 | ||
2293 | #define GCPRO2(varname1, varname2) \ | |
2294 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2295 | gcpro1.level = gcpro_level; \ | |
2296 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2297 | gcpro2.level = gcpro_level++; \ | |
2298 | gcprolist = &gcpro2; } | |
2299 | ||
2300 | #define GCPRO3(varname1, varname2, varname3) \ | |
2301 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2302 | gcpro1.level = gcpro_level; \ | |
2303 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2304 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
2305 | gcpro3.level = gcpro_level++; \ | |
2306 | gcprolist = &gcpro3; } | |
2307 | ||
2308 | #define GCPRO4(varname1, varname2, varname3, varname4) \ | |
2309 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2310 | gcpro1.level = gcpro_level; \ | |
2311 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2312 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
2313 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
2314 | gcpro4.level = gcpro_level++; \ | |
2315 | gcprolist = &gcpro4; } | |
2316 | ||
2317 | #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \ | |
2318 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2319 | gcpro1.level = gcpro_level; \ | |
2320 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2321 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
2322 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
2323 | gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \ | |
2324 | gcpro5.level = gcpro_level++; \ | |
2325 | gcprolist = &gcpro5; } | |
2326 | ||
2327 | #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \ | |
2328 | {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \ | |
2329 | gcpro1.level = gcpro_level; \ | |
2330 | gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \ | |
2331 | gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \ | |
2332 | gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \ | |
2333 | gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \ | |
2334 | gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \ | |
2335 | gcpro6.level = gcpro_level++; \ | |
2336 | gcprolist = &gcpro6; } | |
2337 | ||
2338 | #define UNGCPRO \ | |
2339 | ((--gcpro_level != gcpro1.level) \ | |
2340 | ? (abort (), 0) \ | |
2341 | : ((gcprolist = gcpro1.next), 0)) | |
4742f524 RS |
2342 | |
2343 | #endif /* DEBUG_GCPRO */ | |
1216f5e4 GM |
2344 | #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */ |
2345 | ||
3cfe6dfd | 2346 | |
5db82c9d | 2347 | /* Evaluate expr, UNGCPRO, and then return the value of expr. */ |
c47b8d02 | 2348 | #define RETURN_UNGCPRO(expr) \ |
0868e74e | 2349 | do \ |
c47b8d02 RS |
2350 | { \ |
2351 | Lisp_Object ret_ungc_val; \ | |
2352 | ret_ungc_val = (expr); \ | |
2353 | UNGCPRO; \ | |
2354 | return ret_ungc_val; \ | |
2355 | } \ | |
0868e74e | 2356 | while (0) |
4742f524 RS |
2357 | |
2358 | /* Call staticpro (&var) to protect static variable `var'. */ | |
2359 | ||
383e0970 | 2360 | void staticpro (Lisp_Object *); |
3cfe6dfd | 2361 | \f |
2f69f2ec RS |
2362 | /* Declare a Lisp-callable function. The MAXARGS parameter has the same |
2363 | meaning as in the DEFUN macro, and is used to construct a prototype. */ | |
2f69f2ec RS |
2364 | /* We can use the same trick as in the DEFUN macro to generate the |
2365 | appropriate prototype. */ | |
2366 | #define EXFUN(fnname, maxargs) \ | |
2367 | extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs | |
2f69f2ec | 2368 | |
526a2be7 AS |
2369 | /* Forward declarations for prototypes. */ |
2370 | struct window; | |
2371 | struct frame; | |
2f69f2ec | 2372 | |
f6d62986 | 2373 | /* Defined in data.c. */ |
955cbe7b | 2374 | extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qunbound; |
3cfe6dfd | 2375 | extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level; |
955cbe7b | 2376 | extern Lisp_Object Qerror, Qquit, Qargs_out_of_range; |
3cfe6dfd | 2377 | extern Lisp_Object Qvoid_variable, Qvoid_function; |
955cbe7b | 2378 | extern Lisp_Object Qinvalid_read_syntax; |
3cfe6dfd | 2379 | extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch; |
71873e2b | 2380 | extern Lisp_Object Quser_error, Qend_of_file, Qarith_error, Qmark_inactive; |
3cfe6dfd | 2381 | extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only; |
6b61353c | 2382 | extern Lisp_Object Qtext_read_only; |
e6cba650 | 2383 | extern Lisp_Object Qinteractive_form; |
99f3388e | 2384 | extern Lisp_Object Qcircular_list; |
955cbe7b | 2385 | extern Lisp_Object Qintegerp, Qwholenump, Qsymbolp, Qlistp, Qconsp; |
3cfe6dfd | 2386 | extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp; |
6b61353c | 2387 | extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp; |
cde20f41 | 2388 | extern Lisp_Object Qbuffer_or_string_p; |
955cbe7b | 2389 | extern Lisp_Object Qfboundp; |
6b61353c KH |
2390 | extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p; |
2391 | ||
3cfe6dfd JB |
2392 | extern Lisp_Object Qcdr; |
2393 | ||
6b61353c KH |
2394 | extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error; |
2395 | extern Lisp_Object Qoverflow_error, Qunderflow_error; | |
3cfe6dfd | 2396 | |
6b61353c KH |
2397 | extern Lisp_Object Qfloatp; |
2398 | extern Lisp_Object Qnumberp, Qnumber_or_marker_p; | |
2399 | ||
3ab6e069 DA |
2400 | extern Lisp_Object Qinteger, Qinterval, Qsymbol, Qstring; |
2401 | extern Lisp_Object Qmisc, Qvector, Qfloat, Qcons, Qbuffer; | |
3cfe6dfd | 2402 | |
a35ebb81 CY |
2403 | extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object; |
2404 | ||
5994c183 PE |
2405 | EXFUN (Fbyteorder, 0) ATTRIBUTE_CONST; |
2406 | ||
6b61353c KH |
2407 | /* Defined in frame.c */ |
2408 | extern Lisp_Object Qframep; | |
7436b0a9 | 2409 | |
2f7c71a1 | 2410 | /* Defined in data.c */ |
383e0970 | 2411 | extern Lisp_Object indirect_function (Lisp_Object); |
383e0970 | 2412 | extern Lisp_Object find_symbol_value (Lisp_Object); |
2f69f2ec | 2413 | |
be44ca6c PE |
2414 | /* Convert the integer I to an Emacs representation, either the integer |
2415 | itself, or a cons of two or three integers, or if all else fails a float. | |
2416 | I should not have side effects. */ | |
2417 | #define INTEGER_TO_CONS(i) \ | |
2418 | (! FIXNUM_OVERFLOW_P (i) \ | |
2419 | ? make_number (i) \ | |
2420 | : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \ | |
2421 | || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \ | |
2422 | && FIXNUM_OVERFLOW_P ((i) >> 16)) \ | |
2423 | ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \ | |
2424 | : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \ | |
2425 | || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \ | |
2426 | && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \ | |
2427 | ? Fcons (make_number ((i) >> 16 >> 24), \ | |
2428 | Fcons (make_number ((i) >> 16 & 0xffffff), \ | |
2429 | make_number ((i) & 0xffff))) \ | |
2430 | : make_float (i)) | |
2431 | ||
2432 | /* Convert the Emacs representation CONS back to an integer of type | |
2433 | TYPE, storing the result the variable VAR. Signal an error if CONS | |
2434 | is not a valid representation or is out of range for TYPE. */ | |
2435 | #define CONS_TO_INTEGER(cons, type, var) \ | |
2436 | (TYPE_SIGNED (type) \ | |
2437 | ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \ | |
2438 | : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type)))) | |
2439 | extern intmax_t cons_to_signed (Lisp_Object, intmax_t, intmax_t); | |
2440 | extern uintmax_t cons_to_unsigned (Lisp_Object, uintmax_t); | |
2441 | ||
ad97b375 | 2442 | extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *); |
845ca893 PE |
2443 | extern _Noreturn void args_out_of_range (Lisp_Object, Lisp_Object); |
2444 | extern _Noreturn void args_out_of_range_3 (Lisp_Object, Lisp_Object, | |
2445 | Lisp_Object); | |
2446 | extern _Noreturn Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object); | |
ce5b453a | 2447 | extern Lisp_Object do_symval_forwarding (union Lisp_Fwd *); |
94b612ad | 2448 | extern void set_internal (Lisp_Object, Lisp_Object, Lisp_Object, int); |
383e0970 J |
2449 | extern void syms_of_data (void); |
2450 | extern void init_data (void); | |
2451 | extern void swap_in_global_binding (struct Lisp_Symbol *); | |
3cfe6dfd | 2452 | |
a37e10f9 | 2453 | /* Defined in cmds.c */ |
383e0970 J |
2454 | extern void syms_of_cmds (void); |
2455 | extern void keys_of_cmds (void); | |
a37e10f9 | 2456 | |
6b768554 | 2457 | /* Defined in coding.c */ |
2f7c71a1 | 2458 | extern Lisp_Object Qcharset; |
d311d28c PE |
2459 | extern Lisp_Object detect_coding_system (const unsigned char *, ptrdiff_t, |
2460 | ptrdiff_t, int, int, Lisp_Object); | |
383e0970 J |
2461 | extern void init_coding (void); |
2462 | extern void init_coding_once (void); | |
2463 | extern void syms_of_coding (void); | |
1842abb2 KH |
2464 | |
2465 | /* Defined in character.c */ | |
5994c183 | 2466 | EXFUN (Fmax_char, 0) ATTRIBUTE_CONST; |
d311d28c PE |
2467 | extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t); |
2468 | extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t); | |
5994c183 PE |
2469 | extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST; |
2470 | extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST; | |
2f7c71a1 AS |
2471 | extern void syms_of_character (void); |
2472 | ||
2473 | /* Defined in charset.c */ | |
383e0970 J |
2474 | extern void init_charset (void); |
2475 | extern void init_charset_once (void); | |
2476 | extern void syms_of_charset (void); | |
8f924df7 KH |
2477 | /* Structure forward declarations. */ |
2478 | struct charset; | |
5e741a41 | 2479 | |
1842abb2 | 2480 | /* Defined in composite.c */ |
383e0970 | 2481 | extern void syms_of_composite (void); |
5e741a41 | 2482 | |
a37e10f9 | 2483 | /* Defined in syntax.c */ |
383e0970 J |
2484 | extern void init_syntax_once (void); |
2485 | extern void syms_of_syntax (void); | |
a37e10f9 | 2486 | |
3cfe6dfd | 2487 | /* Defined in fns.c */ |
99f3388e | 2488 | extern Lisp_Object QCrehash_size, QCrehash_threshold; |
ca9ce8f2 | 2489 | enum { NEXT_ALMOST_PRIME_LIMIT = 11 }; |
5994c183 PE |
2490 | EXFUN (Fidentity, 1) ATTRIBUTE_CONST; |
2491 | extern EMACS_INT next_almost_prime (EMACS_INT) ATTRIBUTE_CONST; | |
d311d28c | 2492 | extern Lisp_Object larger_vector (Lisp_Object, ptrdiff_t, ptrdiff_t); |
383e0970 | 2493 | extern void sweep_weak_hash_tables (void); |
e6cba650 | 2494 | extern Lisp_Object Qcursor_in_echo_area; |
3cfe6dfd | 2495 | extern Lisp_Object Qstring_lessp; |
99f3388e | 2496 | extern Lisp_Object QCsize, QCtest, QCweakness, Qequal, Qeq, Qeql; |
3cc5a532 | 2497 | EMACS_UINT hash_string (char const *, ptrdiff_t); |
0de4bb68 | 2498 | EMACS_UINT sxhash (Lisp_Object, int); |
383e0970 J |
2499 | Lisp_Object make_hash_table (Lisp_Object, Lisp_Object, Lisp_Object, |
2500 | Lisp_Object, Lisp_Object, Lisp_Object, | |
2501 | Lisp_Object); | |
d3411f89 PE |
2502 | ptrdiff_t hash_lookup (struct Lisp_Hash_Table *, Lisp_Object, EMACS_UINT *); |
2503 | ptrdiff_t hash_put (struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object, | |
0de4bb68 | 2504 | EMACS_UINT); |
404dbd37 | 2505 | |
d311d28c PE |
2506 | extern Lisp_Object substring_both (Lisp_Object, ptrdiff_t, ptrdiff_t, |
2507 | ptrdiff_t, ptrdiff_t); | |
383e0970 | 2508 | extern Lisp_Object do_yes_or_no_p (Lisp_Object); |
383e0970 J |
2509 | extern Lisp_Object concat2 (Lisp_Object, Lisp_Object); |
2510 | extern Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object); | |
2511 | extern Lisp_Object nconc2 (Lisp_Object, Lisp_Object); | |
2512 | extern Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object); | |
2513 | extern Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object); | |
2514 | extern void clear_string_char_byte_cache (void); | |
d311d28c PE |
2515 | extern ptrdiff_t string_char_to_byte (Lisp_Object, ptrdiff_t); |
2516 | extern ptrdiff_t string_byte_to_char (Lisp_Object, ptrdiff_t); | |
383e0970 J |
2517 | extern Lisp_Object string_to_multibyte (Lisp_Object); |
2518 | extern Lisp_Object string_make_unibyte (Lisp_Object); | |
383e0970 | 2519 | extern void syms_of_fns (void); |
2f69f2ec RS |
2520 | |
2521 | /* Defined in floatfns.c */ | |
383e0970 | 2522 | extern double extract_float (Lisp_Object); |
383e0970 J |
2523 | extern void init_floatfns (void); |
2524 | extern void syms_of_floatfns (void); | |
3d608a86 | 2525 | extern Lisp_Object fmod_float (Lisp_Object x, Lisp_Object y); |
3cfe6dfd | 2526 | |
6b61353c | 2527 | /* Defined in fringe.c */ |
383e0970 J |
2528 | extern void syms_of_fringe (void); |
2529 | extern void init_fringe (void); | |
524c7aa6 PE |
2530 | #ifdef HAVE_WINDOW_SYSTEM |
2531 | extern void mark_fringe_data (void); | |
383e0970 | 2532 | extern void init_fringe_once (void); |
524c7aa6 | 2533 | #endif /* HAVE_WINDOW_SYSTEM */ |
6b61353c KH |
2534 | |
2535 | /* Defined in image.c */ | |
955cbe7b PE |
2536 | extern Lisp_Object QCascent, QCmargin, QCrelief; |
2537 | extern Lisp_Object QCconversion; | |
0766b489 | 2538 | extern int x_bitmap_mask (struct frame *, ptrdiff_t); |
383e0970 | 2539 | extern void syms_of_image (void); |
6b61353c | 2540 | |
c98adc1b | 2541 | /* Defined in insdel.c */ |
b8b31967 | 2542 | extern Lisp_Object Qinhibit_modification_hooks; |
d311d28c PE |
2543 | extern void move_gap (ptrdiff_t); |
2544 | extern void move_gap_both (ptrdiff_t, ptrdiff_t); | |
845ca893 | 2545 | extern _Noreturn void buffer_overflow (void); |
d311d28c PE |
2546 | extern void make_gap (ptrdiff_t); |
2547 | extern ptrdiff_t copy_text (const unsigned char *, unsigned char *, | |
2548 | ptrdiff_t, int, int); | |
ae19ba7c | 2549 | extern int count_combining_before (const unsigned char *, |
d311d28c | 2550 | ptrdiff_t, ptrdiff_t, ptrdiff_t); |
ae19ba7c | 2551 | extern int count_combining_after (const unsigned char *, |
d311d28c PE |
2552 | ptrdiff_t, ptrdiff_t, ptrdiff_t); |
2553 | extern void insert (const char *, ptrdiff_t); | |
2554 | extern void insert_and_inherit (const char *, ptrdiff_t); | |
2555 | extern void insert_1 (const char *, ptrdiff_t, int, int, int); | |
2556 | extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t, | |
ae19ba7c | 2557 | int, int, int); |
d311d28c PE |
2558 | extern void insert_from_gap (ptrdiff_t, ptrdiff_t); |
2559 | extern void insert_from_string (Lisp_Object, ptrdiff_t, ptrdiff_t, | |
2560 | ptrdiff_t, ptrdiff_t, int); | |
2561 | extern void insert_from_buffer (struct buffer *, ptrdiff_t, ptrdiff_t, int); | |
ae19ba7c SM |
2562 | extern void insert_char (int); |
2563 | extern void insert_string (const char *); | |
d311d28c PE |
2564 | extern void insert_before_markers (const char *, ptrdiff_t); |
2565 | extern void insert_before_markers_and_inherit (const char *, ptrdiff_t); | |
2566 | extern void insert_from_string_before_markers (Lisp_Object, ptrdiff_t, | |
2567 | ptrdiff_t, ptrdiff_t, | |
2568 | ptrdiff_t, int); | |
2569 | extern void del_range (ptrdiff_t, ptrdiff_t); | |
2570 | extern Lisp_Object del_range_1 (ptrdiff_t, ptrdiff_t, int, int); | |
2571 | extern void del_range_byte (ptrdiff_t, ptrdiff_t, int); | |
2572 | extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int); | |
2573 | extern Lisp_Object del_range_2 (ptrdiff_t, ptrdiff_t, | |
2574 | ptrdiff_t, ptrdiff_t, int); | |
2575 | extern void modify_region (struct buffer *, ptrdiff_t, ptrdiff_t, int); | |
2576 | extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *); | |
2577 | extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t); | |
2578 | extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t, | |
2579 | ptrdiff_t, ptrdiff_t); | |
2580 | extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t, | |
2581 | ptrdiff_t, ptrdiff_t); | |
2582 | extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object, int, int, int); | |
2583 | extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, | |
2584 | const char *, ptrdiff_t, ptrdiff_t, int); | |
ae19ba7c | 2585 | extern void syms_of_insdel (void); |
c98adc1b | 2586 | |
1747fb16 | 2587 | /* Defined in dispnew.c */ |
9e4bf381 PE |
2588 | #if (defined PROFILING \ |
2589 | && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__)) | |
845ca893 | 2590 | _Noreturn void __executable_start (void); |
9e4bf381 | 2591 | #endif |
37b793e6 | 2592 | extern Lisp_Object selected_frame; |
7684e57b | 2593 | extern Lisp_Object Vwindow_system; |
d311d28c | 2594 | void duration_to_sec_usec (double, int *, int *); |
383e0970 J |
2595 | extern Lisp_Object sit_for (Lisp_Object, int, int); |
2596 | extern void init_display (void); | |
2597 | extern void syms_of_display (void); | |
1747fb16 | 2598 | |
c98adc1b | 2599 | /* Defined in xdisp.c */ |
c6ae41f3 | 2600 | extern Lisp_Object Qinhibit_point_motion_hooks; |
016c7a15 | 2601 | extern Lisp_Object Qinhibit_redisplay, Qdisplay; |
99f3388e | 2602 | extern Lisp_Object Qmenu_bar_update_hook; |
29208e82 | 2603 | extern Lisp_Object Qwindow_scroll_functions; |
99f3388e | 2604 | extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map; |
8a52f00a | 2605 | extern Lisp_Object Qimage, Qtext, Qboth, Qboth_horiz, Qtext_image_horiz; |
89dc303e | 2606 | extern Lisp_Object Qspace, Qcenter, QCalign_to; |
99f3388e DN |
2607 | extern Lisp_Object Qbar, Qhbar, Qbox, Qhollow; |
2608 | extern Lisp_Object Qleft_margin, Qright_margin; | |
b932f8b1 | 2609 | extern Lisp_Object Qglyphless_char; |
89dc303e | 2610 | extern Lisp_Object QCdata, QCfile; |
99f3388e | 2611 | extern Lisp_Object QCmap; |
e6cba650 | 2612 | extern Lisp_Object Qrisky_local_variable; |
b932f8b1 | 2613 | extern struct frame *last_glyphless_glyph_frame; |
d311d28c | 2614 | extern int last_glyphless_glyph_face_id; |
b932f8b1 | 2615 | extern int last_glyphless_glyph_merged_face_id; |
99f3388e | 2616 | extern int noninteractive_need_newline; |
986113df | 2617 | extern Lisp_Object echo_area_buffer[2]; |
89dc303e | 2618 | extern void add_to_log (const char *, Lisp_Object, Lisp_Object); |
383e0970 J |
2619 | extern void check_message_stack (void); |
2620 | extern void setup_echo_area_for_printing (int); | |
2621 | extern int push_message (void); | |
2622 | extern Lisp_Object pop_message_unwind (Lisp_Object); | |
2623 | extern Lisp_Object restore_message_unwind (Lisp_Object); | |
383e0970 J |
2624 | extern void restore_message (void); |
2625 | extern Lisp_Object current_message (void); | |
383e0970 | 2626 | extern void clear_message (int, int); |
1e973bc7 | 2627 | extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2); |
a8fe7202 AS |
2628 | extern void message1 (const char *); |
2629 | extern void message1_nolog (const char *); | |
d311d28c PE |
2630 | extern void message2 (const char *, ptrdiff_t, int); |
2631 | extern void message2_nolog (const char *, ptrdiff_t, int); | |
2632 | extern void message3 (Lisp_Object, ptrdiff_t, int); | |
2633 | extern void message3_nolog (Lisp_Object, ptrdiff_t, int); | |
2634 | extern void message_dolog (const char *, ptrdiff_t, int, int); | |
a8fe7202 | 2635 | extern void message_with_string (const char *, Lisp_Object, int); |
383e0970 J |
2636 | extern void message_log_maybe_newline (void); |
2637 | extern void update_echo_area (void); | |
d311d28c | 2638 | extern void truncate_echo_area (ptrdiff_t); |
383e0970 | 2639 | extern void redisplay (void); |
383e0970 J |
2640 | extern void redisplay_preserve_echo_area (int); |
2641 | extern void prepare_menu_bars (void); | |
c4bf5bc3 | 2642 | |
383e0970 J |
2643 | void set_frame_cursor_types (struct frame *, Lisp_Object); |
2644 | extern void syms_of_xdisp (void); | |
2645 | extern void init_xdisp (void); | |
2646 | extern Lisp_Object safe_eval (Lisp_Object); | |
d311d28c | 2647 | extern int pos_visible_p (struct window *, ptrdiff_t, int *, |
383e0970 | 2648 | int *, int *, int *, int *, int *); |
c98adc1b | 2649 | |
637fa988 | 2650 | /* Defined in xsettings.c */ |
383e0970 | 2651 | extern void syms_of_xsettings (void); |
637fa988 | 2652 | |
15b0ced5 | 2653 | /* Defined in vm-limit.c. */ |
261cb4bb | 2654 | extern void memory_warnings (void *, void (*warnfun) (const char *)); |
9043c90a | 2655 | |
3cfe6dfd | 2656 | /* Defined in alloc.c */ |
383e0970 | 2657 | extern void check_pure_size (void); |
413d18e7 | 2658 | extern void allocate_string_data (struct Lisp_String *, EMACS_INT, EMACS_INT); |
383e0970 J |
2659 | extern void reset_malloc_hooks (void); |
2660 | extern void uninterrupt_malloc (void); | |
a8fe7202 | 2661 | extern void malloc_warning (const char *); |
845ca893 PE |
2662 | extern _Noreturn void memory_full (size_t); |
2663 | extern _Noreturn void buffer_memory_full (ptrdiff_t); | |
383e0970 J |
2664 | extern int survives_gc_p (Lisp_Object); |
2665 | extern void mark_object (Lisp_Object); | |
69003fd8 | 2666 | #if defined REL_ALLOC && !defined SYSTEM_MALLOC |
84dfc8a7 | 2667 | extern void refill_memory_reserve (void); |
69003fd8 | 2668 | #endif |
50c77428 | 2669 | extern const char *pending_malloc_warning; |
9730daca | 2670 | extern Lisp_Object zero_vector; |
89dc303e | 2671 | extern Lisp_Object *stack_base; |
dac616ff DA |
2672 | extern EMACS_INT consing_since_gc; |
2673 | extern EMACS_INT gc_relative_threshold; | |
2674 | extern EMACS_INT memory_full_cons_threshold; | |
2f7c71a1 AS |
2675 | extern Lisp_Object list1 (Lisp_Object); |
2676 | extern Lisp_Object list2 (Lisp_Object, Lisp_Object); | |
2677 | extern Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object); | |
2678 | extern Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
2679 | extern Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, | |
2680 | Lisp_Object); | |
694b6c97 DA |
2681 | enum constype {HEAP, PURE}; |
2682 | extern Lisp_Object listn (enum constype, ptrdiff_t, Lisp_Object, ...); | |
845ca893 | 2683 | extern _Noreturn void string_overflow (void); |
d311d28c | 2684 | extern Lisp_Object make_string (const char *, ptrdiff_t); |
26bccfae PE |
2685 | extern Lisp_Object make_formatted_string (char *, const char *, ...) |
2686 | ATTRIBUTE_FORMAT_PRINTF (2, 3); | |
d311d28c | 2687 | extern Lisp_Object make_unibyte_string (const char *, ptrdiff_t); |
d7ea76b4 DA |
2688 | |
2689 | /* Make unibyte string from C string when the length isn't known. */ | |
2690 | ||
2691 | static inline Lisp_Object | |
2692 | build_unibyte_string (const char *str) | |
2693 | { | |
2694 | return make_unibyte_string (str, strlen (str)); | |
2695 | } | |
2696 | ||
d311d28c | 2697 | extern Lisp_Object make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t); |
383e0970 | 2698 | extern Lisp_Object make_event_array (int, Lisp_Object *); |
413d18e7 EZ |
2699 | extern Lisp_Object make_uninit_string (EMACS_INT); |
2700 | extern Lisp_Object make_uninit_multibyte_string (EMACS_INT, EMACS_INT); | |
d311d28c | 2701 | extern Lisp_Object make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t); |
14162469 | 2702 | extern Lisp_Object make_specified_string (const char *, |
d311d28c | 2703 | ptrdiff_t, ptrdiff_t, int); |
d311d28c | 2704 | extern Lisp_Object make_pure_string (const char *, ptrdiff_t, ptrdiff_t, int); |
2a0213a6 DA |
2705 | extern Lisp_Object make_pure_c_string (const char *, ptrdiff_t); |
2706 | ||
2707 | /* Make a string allocated in pure space, use STR as string data. */ | |
2708 | ||
2709 | static inline Lisp_Object | |
2710 | build_pure_c_string (const char *str) | |
2711 | { | |
2712 | return make_pure_c_string (str, strlen (str)); | |
2713 | } | |
1130ecfc DA |
2714 | |
2715 | /* Make a string from the data at STR, treating it as multibyte if the | |
2716 | data warrants. */ | |
2717 | ||
2718 | static inline Lisp_Object | |
2719 | build_string (const char *str) | |
2720 | { | |
2721 | return make_string (str, strlen (str)); | |
2722 | } | |
2723 | ||
383e0970 | 2724 | extern Lisp_Object pure_cons (Lisp_Object, Lisp_Object); |
3017f87f | 2725 | extern void make_byte_code (struct Lisp_Vector *); |
7f73dc9d | 2726 | extern Lisp_Object Qchar_table_extra_slots; |
383e0970 | 2727 | extern struct Lisp_Vector *allocate_vector (EMACS_INT); |
d311d28c | 2728 | extern struct Lisp_Vector *allocate_pseudovector (int memlen, int lisplen, int tag); |
30f95089 SM |
2729 | #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \ |
2730 | ((typ*) \ | |
2731 | allocate_pseudovector \ | |
2732 | (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag)) | |
383e0970 J |
2733 | extern struct Lisp_Hash_Table *allocate_hash_table (void); |
2734 | extern struct window *allocate_window (void); | |
2735 | extern struct frame *allocate_frame (void); | |
2736 | extern struct Lisp_Process *allocate_process (void); | |
2737 | extern struct terminal *allocate_terminal (void); | |
4d57802e | 2738 | extern int gc_in_progress; |
95684592 | 2739 | extern int abort_on_gc; |
383e0970 J |
2740 | extern Lisp_Object make_float (double); |
2741 | extern void display_malloc_warning (void); | |
d311d28c | 2742 | extern ptrdiff_t inhibit_garbage_collection (void); |
9c4c5f81 | 2743 | extern Lisp_Object make_save_value (void *, ptrdiff_t); |
d7a7fda3 | 2744 | extern Lisp_Object build_overlay (Lisp_Object, Lisp_Object, Lisp_Object); |
383e0970 J |
2745 | extern void free_marker (Lisp_Object); |
2746 | extern void free_cons (struct Lisp_Cons *); | |
2747 | extern void init_alloc_once (void); | |
2748 | extern void init_alloc (void); | |
2749 | extern void syms_of_alloc (void); | |
2750 | extern struct buffer * allocate_buffer (void); | |
2751 | extern int valid_lisp_object_p (Lisp_Object); | |
3cfe6dfd | 2752 | |
a041960a PE |
2753 | #ifdef REL_ALLOC |
2754 | /* Defined in ralloc.c */ | |
2755 | extern void *r_alloc (void **, size_t); | |
2756 | extern void r_alloc_free (void **); | |
2757 | extern void *r_re_alloc (void **, size_t); | |
2758 | extern void r_alloc_reset_variable (void **, void **); | |
57b81a9f | 2759 | extern void r_alloc_inhibit_buffer_relocation (int); |
a041960a PE |
2760 | #endif |
2761 | ||
1842abb2 | 2762 | /* Defined in chartab.c */ |
383e0970 | 2763 | extern Lisp_Object copy_char_table (Lisp_Object); |
383e0970 J |
2764 | extern Lisp_Object char_table_ref (Lisp_Object, int); |
2765 | extern Lisp_Object char_table_ref_and_range (Lisp_Object, int, | |
2766 | int *, int *); | |
2767 | extern Lisp_Object char_table_set (Lisp_Object, int, Lisp_Object); | |
2768 | extern Lisp_Object char_table_set_range (Lisp_Object, int, int, | |
2769 | Lisp_Object); | |
2770 | extern int char_table_translate (Lisp_Object, int); | |
2771 | extern void map_char_table (void (*) (Lisp_Object, Lisp_Object, | |
2772 | Lisp_Object), | |
2773 | Lisp_Object, Lisp_Object, Lisp_Object); | |
e6cba650 DN |
2774 | extern void map_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object), |
2775 | Lisp_Object, Lisp_Object, | |
2776 | Lisp_Object, struct charset *, | |
2777 | unsigned, unsigned); | |
5cc7f7af | 2778 | extern Lisp_Object uniprop_table (Lisp_Object); |
383e0970 | 2779 | extern void syms_of_chartab (void); |
1842abb2 | 2780 | |
3cfe6dfd JB |
2781 | /* Defined in print.c */ |
2782 | extern Lisp_Object Vprin1_to_string_buffer; | |
42c8bc9b | 2783 | extern void debug_print (Lisp_Object) EXTERNALLY_VISIBLE; |
29208e82 | 2784 | extern Lisp_Object Qstandard_output; |
9453ea7b | 2785 | extern Lisp_Object Qexternal_debugging_output; |
383e0970 | 2786 | extern void temp_output_buffer_setup (const char *); |
29208e82 | 2787 | extern int print_level; |
3cfe6dfd | 2788 | extern Lisp_Object Qprint_escape_newlines; |
a8fe7202 | 2789 | extern void write_string (const char *, int); |
a8fe7202 AS |
2790 | extern void print_error_message (Lisp_Object, Lisp_Object, const char *, |
2791 | Lisp_Object); | |
526a2be7 | 2792 | extern Lisp_Object internal_with_output_to_temp_buffer |
383e0970 | 2793 | (const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object); |
6e8e6bf2 | 2794 | #define FLOAT_TO_STRING_BUFSIZE 350 |
99027bdd | 2795 | extern int float_to_string (char *, double); |
383e0970 | 2796 | extern void syms_of_print (void); |
526a2be7 | 2797 | |
e6c3da20 | 2798 | /* Defined in doprnt.c */ |
c2d1e36d PE |
2799 | extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *, |
2800 | va_list); | |
62f19c19 PE |
2801 | extern ptrdiff_t esprintf (char *, char const *, ...) |
2802 | ATTRIBUTE_FORMAT_PRINTF (2, 3); | |
62f19c19 PE |
2803 | extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t, |
2804 | char const *, ...) | |
2805 | ATTRIBUTE_FORMAT_PRINTF (5, 6); | |
2806 | extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t, | |
2807 | char const *, va_list) | |
2808 | ATTRIBUTE_FORMAT_PRINTF (5, 0); | |
e6c3da20 | 2809 | |
ea6c7ae6 | 2810 | /* Defined in lread.c. */ |
3cfe6dfd | 2811 | extern Lisp_Object Qvariable_documentation, Qstandard_input; |
99f3388e | 2812 | extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction; |
383e0970 | 2813 | extern Lisp_Object check_obarray (Lisp_Object); |
e8df9267 DA |
2814 | extern Lisp_Object intern_1 (const char *, ptrdiff_t); |
2815 | extern Lisp_Object intern_c_string_1 (const char *, ptrdiff_t); | |
d311d28c | 2816 | extern Lisp_Object oblookup (Lisp_Object, const char *, ptrdiff_t, ptrdiff_t); |
c5e3de70 | 2817 | #define LOADHIST_ATTACH(x) \ |
d6d23852 SM |
2818 | do { \ |
2819 | if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \ | |
2820 | } while (0) | |
383e0970 J |
2821 | extern int openp (Lisp_Object, Lisp_Object, Lisp_Object, |
2822 | Lisp_Object *, Lisp_Object); | |
452f4150 | 2823 | Lisp_Object string_to_number (char const *, int, int); |
383e0970 J |
2824 | extern void map_obarray (Lisp_Object, void (*) (Lisp_Object, Lisp_Object), |
2825 | Lisp_Object); | |
a8fe7202 | 2826 | extern void dir_warning (const char *, Lisp_Object); |
383e0970 J |
2827 | extern void close_load_descs (void); |
2828 | extern void init_obarray (void); | |
2829 | extern void init_lread (void); | |
2830 | extern void syms_of_lread (void); | |
3cfe6dfd | 2831 | |
e8df9267 DA |
2832 | static inline Lisp_Object |
2833 | intern (const char *str) | |
2834 | { | |
2835 | return intern_1 (str, strlen (str)); | |
2836 | } | |
2837 | ||
2838 | static inline Lisp_Object | |
2839 | intern_c_string (const char *str) | |
2840 | { | |
2841 | return intern_c_string_1 (str, strlen (str)); | |
2842 | } | |
2843 | ||
f6d62986 | 2844 | /* Defined in eval.c. */ |
61b108cc | 2845 | extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qmacro; |
ed008a6d | 2846 | extern Lisp_Object Qinhibit_quit, Qclosure; |
955cbe7b | 2847 | extern Lisp_Object Qand_rest; |
3cfe6dfd | 2848 | extern Lisp_Object Vautoload_queue; |
fab88cb7 | 2849 | extern Lisp_Object Vsignaling_function; |
d1f55f16 | 2850 | extern Lisp_Object inhibit_lisp_code; |
21c5a64e | 2851 | extern int handling_signal; |
244ed907 PE |
2852 | #if BYTE_MARK_STACK |
2853 | extern struct catchtag *catchlist; | |
2854 | extern struct handler *handlerlist; | |
2855 | #endif | |
f1b6e5fc SM |
2856 | /* To run a normal hook, use the appropriate function from the list below. |
2857 | The calling convention: | |
2858 | ||
846d69ac | 2859 | if (!NILP (Vrun_hooks)) |
f1b6e5fc SM |
2860 | call1 (Vrun_hooks, Qmy_funny_hook); |
2861 | ||
2862 | should no longer be used. */ | |
3cfe6dfd | 2863 | extern Lisp_Object Vrun_hooks; |
383e0970 | 2864 | extern void run_hook_with_args_2 (Lisp_Object, Lisp_Object, Lisp_Object); |
f66c7cf8 | 2865 | extern Lisp_Object run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args, |
f6d62986 | 2866 | Lisp_Object (*funcall) |
f66c7cf8 | 2867 | (ptrdiff_t nargs, Lisp_Object *args)); |
845ca893 PE |
2868 | extern _Noreturn void xsignal (Lisp_Object, Lisp_Object); |
2869 | extern _Noreturn void xsignal0 (Lisp_Object); | |
2870 | extern _Noreturn void xsignal1 (Lisp_Object, Lisp_Object); | |
2871 | extern _Noreturn void xsignal2 (Lisp_Object, Lisp_Object, Lisp_Object); | |
2872 | extern _Noreturn void xsignal3 (Lisp_Object, Lisp_Object, Lisp_Object, | |
2873 | Lisp_Object); | |
2874 | extern _Noreturn void signal_error (const char *, Lisp_Object); | |
defb1411 | 2875 | extern Lisp_Object eval_sub (Lisp_Object form); |
383e0970 J |
2876 | extern Lisp_Object apply1 (Lisp_Object, Lisp_Object); |
2877 | extern Lisp_Object call0 (Lisp_Object); | |
2878 | extern Lisp_Object call1 (Lisp_Object, Lisp_Object); | |
2879 | extern Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object); | |
2880 | extern Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
2881 | extern Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
2882 | extern Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
2883 | extern Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
2884 | extern Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
383e0970 J |
2885 | extern Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object); |
2886 | extern Lisp_Object internal_lisp_condition_case (Lisp_Object, Lisp_Object, Lisp_Object); | |
2887 | extern Lisp_Object internal_condition_case (Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object)); | |
2888 | extern Lisp_Object internal_condition_case_1 (Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)); | |
2889 | extern Lisp_Object internal_condition_case_2 (Lisp_Object (*) (Lisp_Object, Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)); | |
f66c7cf8 | 2890 | extern Lisp_Object internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object *), ptrdiff_t, Lisp_Object *, Lisp_Object, Lisp_Object (*) (Lisp_Object)); |
383e0970 J |
2891 | extern void specbind (Lisp_Object, Lisp_Object); |
2892 | extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object), Lisp_Object); | |
d311d28c | 2893 | extern Lisp_Object unbind_to (ptrdiff_t, Lisp_Object); |
845ca893 PE |
2894 | extern _Noreturn void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2); |
2895 | extern _Noreturn void verror (const char *, va_list) | |
2896 | ATTRIBUTE_FORMAT_PRINTF (1, 0); | |
383e0970 | 2897 | extern Lisp_Object un_autoload (Lisp_Object); |
383e0970 | 2898 | extern void init_eval_once (void); |
f66c7cf8 | 2899 | extern Lisp_Object safe_call (ptrdiff_t, Lisp_Object *); |
383e0970 | 2900 | extern Lisp_Object safe_call1 (Lisp_Object, Lisp_Object); |
58555d81 | 2901 | extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object); |
383e0970 | 2902 | extern void init_eval (void); |
244ed907 | 2903 | #if BYTE_MARK_STACK |
8b2c52e9 | 2904 | extern void mark_backtrace (void); |
244ed907 | 2905 | #endif |
383e0970 | 2906 | extern void syms_of_eval (void); |
3cfe6dfd | 2907 | |
7abaf5cc | 2908 | /* Defined in editfns.c. */ |
e6cba650 | 2909 | extern Lisp_Object Qfield; |
383e0970 | 2910 | extern void insert1 (Lisp_Object); |
a8fe7202 | 2911 | extern Lisp_Object format2 (const char *, Lisp_Object, Lisp_Object); |
383e0970 J |
2912 | extern Lisp_Object save_excursion_save (void); |
2913 | extern Lisp_Object save_restriction_save (void); | |
2914 | extern Lisp_Object save_excursion_restore (Lisp_Object); | |
2915 | extern Lisp_Object save_restriction_restore (Lisp_Object); | |
845ca893 | 2916 | extern _Noreturn void time_overflow (void); |
d311d28c PE |
2917 | extern Lisp_Object make_buffer_string (ptrdiff_t, ptrdiff_t, int); |
2918 | extern Lisp_Object make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, | |
2919 | ptrdiff_t, int); | |
383e0970 | 2920 | extern void init_editfns (void); |
a2928364 | 2921 | const char *get_system_name (void); |
383e0970 | 2922 | extern void syms_of_editfns (void); |
a8fe7202 | 2923 | extern void set_time_zone_rule (const char *); |
3cfe6dfd | 2924 | |
7abaf5cc | 2925 | /* Defined in buffer.c. */ |
383e0970 | 2926 | extern int mouse_face_overlay_overlaps (Lisp_Object); |
845ca893 | 2927 | extern _Noreturn void nsberror (Lisp_Object); |
d311d28c PE |
2928 | extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t); |
2929 | extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t); | |
2930 | extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t); | |
383e0970 J |
2931 | extern void report_overlay_modification (Lisp_Object, Lisp_Object, int, |
2932 | Lisp_Object, Lisp_Object, Lisp_Object); | |
d311d28c | 2933 | extern int overlay_touches_p (ptrdiff_t); |
29208e82 | 2934 | extern Lisp_Object Vbuffer_alist; |
2f7c71a1 | 2935 | extern Lisp_Object set_buffer_if_live (Lisp_Object); |
9397e56f | 2936 | extern Lisp_Object other_buffer_safely (Lisp_Object); |
955cbe7b | 2937 | extern Lisp_Object Qpriority, Qwindow, Qbefore_string, Qafter_string; |
383e0970 | 2938 | extern Lisp_Object get_truename_buffer (Lisp_Object); |
383e0970 J |
2939 | extern void init_buffer_once (void); |
2940 | extern void init_buffer (void); | |
2941 | extern void syms_of_buffer (void); | |
2942 | extern void keys_of_buffer (void); | |
3cfe6dfd | 2943 | |
7abaf5cc | 2944 | /* Defined in marker.c. */ |
3cfe6dfd | 2945 | |
d311d28c PE |
2946 | extern ptrdiff_t marker_position (Lisp_Object); |
2947 | extern ptrdiff_t marker_byte_position (Lisp_Object); | |
383e0970 | 2948 | extern void clear_charpos_cache (struct buffer *); |
d311d28c PE |
2949 | extern ptrdiff_t charpos_to_bytepos (ptrdiff_t); |
2950 | extern ptrdiff_t buf_charpos_to_bytepos (struct buffer *, ptrdiff_t); | |
2951 | extern ptrdiff_t buf_bytepos_to_charpos (struct buffer *, ptrdiff_t); | |
6195f384 | 2952 | extern void unchain_marker (struct Lisp_Marker *); |
383e0970 | 2953 | extern Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object); |
d311d28c | 2954 | extern Lisp_Object set_marker_both (Lisp_Object, Lisp_Object, ptrdiff_t, ptrdiff_t); |
383e0970 | 2955 | extern Lisp_Object set_marker_restricted_both (Lisp_Object, Lisp_Object, |
6195f384 DA |
2956 | ptrdiff_t, ptrdiff_t); |
2957 | extern void init_marker (struct Lisp_Marker *, struct buffer *, | |
2958 | ptrdiff_t, ptrdiff_t, int); | |
2959 | extern void attach_marker (struct Lisp_Marker *, struct buffer *, | |
2960 | ptrdiff_t, ptrdiff_t); | |
657924ff | 2961 | extern Lisp_Object build_marker (struct buffer *, ptrdiff_t, ptrdiff_t); |
383e0970 | 2962 | extern void syms_of_marker (void); |
3cfe6dfd JB |
2963 | |
2964 | /* Defined in fileio.c */ | |
2965 | ||
2966 | extern Lisp_Object Qfile_error; | |
99f3388e | 2967 | extern Lisp_Object Qfile_exists_p; |
e6cba650 DN |
2968 | extern Lisp_Object Qfile_directory_p; |
2969 | extern Lisp_Object Qinsert_file_contents; | |
7684e57b | 2970 | extern Lisp_Object Qfile_name_history; |
383e0970 | 2971 | extern Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object); |
e2017fe2 | 2972 | EXFUN (Fread_file_name, 6); /* not a normal DEFUN */ |
383e0970 J |
2973 | extern Lisp_Object close_file_unwind (Lisp_Object); |
2974 | extern Lisp_Object restore_point_unwind (Lisp_Object); | |
845ca893 | 2975 | extern _Noreturn void report_file_error (const char *, Lisp_Object); |
383e0970 J |
2976 | extern int internal_delete_file (Lisp_Object); |
2977 | extern void syms_of_fileio (void); | |
2978 | extern Lisp_Object make_temp_name (Lisp_Object, int); | |
b86cfd28 | 2979 | extern Lisp_Object Qdelete_file; |
3cfe6dfd | 2980 | |
78edd3b7 | 2981 | /* Defined in search.c */ |
383e0970 | 2982 | extern void shrink_regexp_cache (void); |
383e0970 | 2983 | extern void restore_search_regs (void); |
383e0970 | 2984 | extern void record_unwind_save_match_data (void); |
dbd37a95 PE |
2985 | struct re_registers; |
2986 | extern struct re_pattern_buffer *compile_pattern (Lisp_Object, | |
2987 | struct re_registers *, | |
2988 | Lisp_Object, int, int); | |
d311d28c | 2989 | extern ptrdiff_t fast_string_match (Lisp_Object, Lisp_Object); |
d923b542 DA |
2990 | extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object, const char *, |
2991 | ptrdiff_t); | |
d311d28c PE |
2992 | extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object, Lisp_Object); |
2993 | extern ptrdiff_t fast_looking_at (Lisp_Object, ptrdiff_t, ptrdiff_t, | |
2994 | ptrdiff_t, ptrdiff_t, Lisp_Object); | |
2995 | extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t, | |
2996 | ptrdiff_t *, int); | |
2997 | extern EMACS_INT scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, | |
c098fdb8 | 2998 | EMACS_INT, int); |
d311d28c PE |
2999 | extern ptrdiff_t find_next_newline (ptrdiff_t, int); |
3000 | extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t); | |
3001 | extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t); | |
383e0970 J |
3002 | extern void syms_of_search (void); |
3003 | extern void clear_regexp_cache (void); | |
3cfe6dfd | 3004 | |
464d5a5e | 3005 | /* Defined in minibuf.c. */ |
3cfe6dfd | 3006 | |
e6cba650 | 3007 | extern Lisp_Object Qcompletion_ignore_case; |
99f3388e | 3008 | extern Lisp_Object Vminibuffer_list; |
3cfe6dfd | 3009 | extern Lisp_Object last_minibuf_string; |
62f19c19 | 3010 | extern Lisp_Object get_minibuffer (EMACS_INT); |
383e0970 J |
3011 | extern void init_minibuf_once (void); |
3012 | extern void syms_of_minibuf (void); | |
3cfe6dfd | 3013 | |
464d5a5e | 3014 | /* Defined in callint.c. */ |
3cfe6dfd | 3015 | |
29208e82 | 3016 | extern Lisp_Object Qminus, Qplus; |
99f3388e | 3017 | extern Lisp_Object Qwhen; |
7fd61057 | 3018 | extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook; |
383e0970 | 3019 | extern void syms_of_callint (void); |
3cfe6dfd | 3020 | |
464d5a5e | 3021 | /* Defined in casefiddle.c. */ |
3cfe6dfd | 3022 | |
99f3388e | 3023 | extern Lisp_Object Qidentity; |
383e0970 J |
3024 | extern void syms_of_casefiddle (void); |
3025 | extern void keys_of_casefiddle (void); | |
3cfe6dfd | 3026 | |
464d5a5e | 3027 | /* Defined in casetab.c. */ |
1747fb16 | 3028 | |
383e0970 J |
3029 | extern void init_casetab_once (void); |
3030 | extern void syms_of_casetab (void); | |
1747fb16 | 3031 | |
464d5a5e | 3032 | /* Defined in keyboard.c. */ |
3cfe6dfd | 3033 | |
54cd1651 | 3034 | extern Lisp_Object echo_message_buffer; |
417750de | 3035 | extern struct kboard *echo_kboard; |
383e0970 | 3036 | extern void cancel_echoing (void); |
1425dcb6 | 3037 | extern Lisp_Object Qdisabled, QCfilter; |
955cbe7b PE |
3038 | extern Lisp_Object Qup, Qdown, Qbottom; |
3039 | extern Lisp_Object Qtop; | |
464d5a5e | 3040 | extern Lisp_Object last_undo_boundary; |
8e7bd231 | 3041 | extern int input_pending; |
383e0970 J |
3042 | extern Lisp_Object menu_bar_items (Lisp_Object); |
3043 | extern Lisp_Object tool_bar_items (Lisp_Object, int *); | |
383e0970 | 3044 | extern void discard_mouse_events (void); |
58555d81 | 3045 | extern Lisp_Object pending_funcalls; |
383e0970 J |
3046 | extern int detect_input_pending (void); |
3047 | extern int detect_input_pending_ignore_squeezables (void); | |
3048 | extern int detect_input_pending_run_timers (int); | |
3049 | extern void safe_run_hooks (Lisp_Object); | |
a8fe7202 | 3050 | extern void cmd_error_internal (Lisp_Object, const char *); |
383e0970 J |
3051 | extern Lisp_Object command_loop_1 (void); |
3052 | extern Lisp_Object recursive_edit_1 (void); | |
3053 | extern void record_auto_save (void); | |
8a1414fa | 3054 | #ifdef SIGDANGER |
4752793e | 3055 | extern void force_auto_save_soon (void); |
8a1414fa | 3056 | #endif |
383e0970 J |
3057 | extern void init_keyboard (void); |
3058 | extern void syms_of_keyboard (void); | |
3059 | extern void keys_of_keyboard (void); | |
3cfe6dfd | 3060 | |
464d5a5e | 3061 | /* Defined in indent.c. */ |
d311d28c | 3062 | extern ptrdiff_t current_column (void); |
383e0970 | 3063 | extern void invalidate_current_column (void); |
d311d28c | 3064 | extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT); |
383e0970 | 3065 | extern void syms_of_indent (void); |
3cfe6dfd | 3066 | |
464d5a5e | 3067 | /* Defined in frame.c. */ |
e6cba650 | 3068 | extern Lisp_Object Qonly; |
362fb47a | 3069 | extern Lisp_Object Qvisible; |
383e0970 J |
3070 | extern void store_frame_param (struct frame *, Lisp_Object, Lisp_Object); |
3071 | extern void store_in_alist (Lisp_Object *, Lisp_Object, Lisp_Object); | |
3072 | extern Lisp_Object do_switch_frame (Lisp_Object, int, int, Lisp_Object); | |
81626931 | 3073 | #if HAVE_NS |
383e0970 | 3074 | extern Lisp_Object get_frame_param (struct frame *, Lisp_Object); |
81626931 | 3075 | #endif |
383e0970 | 3076 | extern Lisp_Object frame_buffer_predicate (Lisp_Object); |
383e0970 | 3077 | extern void frames_discard_buffer (Lisp_Object); |
383e0970 | 3078 | extern void syms_of_frame (void); |
3cfe6dfd | 3079 | |
464d5a5e | 3080 | /* Defined in emacs.c. */ |
99f3388e DN |
3081 | extern char **initial_argv; |
3082 | extern int initial_argc; | |
5e617bc2 | 3083 | #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS) |
89dc303e DN |
3084 | extern int display_arg; |
3085 | #endif | |
a8fe7202 | 3086 | extern Lisp_Object decode_env_path (const char *, const char *); |
2c668b9a | 3087 | extern Lisp_Object empty_unibyte_string, empty_multibyte_string; |
e6cba650 | 3088 | extern Lisp_Object Qfile_name_handler_alist; |
35f08c38 | 3089 | #ifdef FLOAT_CATCH_SIGILL |
9af30bdf | 3090 | extern void fatal_error_signal (int); |
35f08c38 | 3091 | #endif |
6c07aac2 | 3092 | extern Lisp_Object Qkill_emacs; |
68c45bf0 | 3093 | #if HAVE_SETLOCALE |
383e0970 J |
3094 | void fixup_locale (void); |
3095 | void synchronize_system_messages_locale (void); | |
3096 | void synchronize_system_time_locale (void); | |
68c45bf0 PE |
3097 | #else |
3098 | #define setlocale(category, locale) | |
3099 | #define fixup_locale() | |
ca9c0567 PE |
3100 | #define synchronize_system_messages_locale() |
3101 | #define synchronize_system_time_locale() | |
68c45bf0 | 3102 | #endif |
383e0970 | 3103 | void shut_down_emacs (int, int, Lisp_Object); |
78edd3b7 | 3104 | /* Nonzero means don't do interactive redisplay and don't change tty modes. */ |
3cfe6dfd | 3105 | extern int noninteractive; |
ff808935 | 3106 | |
66b7b0fe GM |
3107 | /* Nonzero means remove site-lisp directories from load-path. */ |
3108 | extern int no_site_lisp; | |
3109 | ||
ff808935 DN |
3110 | /* Pipe used to send exit notification to the daemon parent at |
3111 | startup. */ | |
3112 | extern int daemon_pipe[2]; | |
3113 | #define IS_DAEMON (daemon_pipe[1] != 0) | |
3114 | ||
78edd3b7 | 3115 | /* Nonzero means don't do use window-system-specific display code. */ |
3cfe6dfd | 3116 | extern int inhibit_window_system; |
99a3d506 | 3117 | /* Nonzero means that a filter or a sentinel is running. */ |
7074fde6 | 3118 | extern int running_asynch_code; |
3cfe6dfd | 3119 | |
6c60eb9f | 3120 | /* Defined in process.c. */ |
89dc303e | 3121 | extern Lisp_Object QCtype, Qlocal; |
6efad63b | 3122 | extern Lisp_Object Qprocessp; |
383e0970 | 3123 | extern void kill_buffer_processes (Lisp_Object); |
d35af63c | 3124 | extern int wait_reading_process_output (intmax_t, int, int, int, |
383e0970 J |
3125 | Lisp_Object, |
3126 | struct Lisp_Process *, | |
3127 | int); | |
f1dd8073 PE |
3128 | /* Max value for the first argument of wait_reading_process_output. */ |
3129 | #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5) | |
3130 | /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3. | |
3131 | The bug merely causes a bogus warning, but the warning is annoying. */ | |
3132 | # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX) | |
3133 | #else | |
3134 | # define WAIT_READING_MAX INTMAX_MAX | |
3135 | #endif | |
383e0970 J |
3136 | extern void add_keyboard_wait_descriptor (int); |
3137 | extern void delete_keyboard_wait_descriptor (int); | |
4475bec4 | 3138 | #ifdef HAVE_GPM |
383e0970 J |
3139 | extern void add_gpm_wait_descriptor (int); |
3140 | extern void delete_gpm_wait_descriptor (int); | |
4475bec4 | 3141 | #endif |
383e0970 | 3142 | extern void close_process_descs (void); |
b82da769 | 3143 | extern void init_process_emacs (void); |
383e0970 J |
3144 | extern void syms_of_process (void); |
3145 | extern void setup_process_coding_systems (Lisp_Object); | |
3cfe6dfd | 3146 | |
6bd8c144 | 3147 | #ifndef DOS_NT |
845ca893 | 3148 | _Noreturn |
6bd8c144 | 3149 | #endif |
845ca893 | 3150 | extern int child_setup (int, int, int, char **, int, Lisp_Object); |
383e0970 J |
3151 | extern void init_callproc_1 (void); |
3152 | extern void init_callproc (void); | |
3153 | extern void set_initial_environment (void); | |
3154 | extern void syms_of_callproc (void); | |
3cfe6dfd | 3155 | |
78edd3b7 | 3156 | /* Defined in doc.c */ |
99f3388e | 3157 | extern Lisp_Object Qfunction_documentation; |
383e0970 J |
3158 | extern Lisp_Object read_doc_string (Lisp_Object); |
3159 | extern Lisp_Object get_doc_string (Lisp_Object, int, int); | |
3160 | extern void syms_of_doc (void); | |
3161 | extern int read_bytecode_char (int); | |
3cfe6dfd | 3162 | |
78edd3b7 | 3163 | /* Defined in bytecode.c */ |
3cfe6dfd | 3164 | extern Lisp_Object Qbytecode; |
383e0970 | 3165 | extern void syms_of_bytecode (void); |
35c7a974 | 3166 | extern struct byte_stack *byte_stack_list; |
244ed907 | 3167 | #if BYTE_MARK_STACK |
383e0970 | 3168 | extern void mark_byte_stack (void); |
b286858c | 3169 | #endif |
383e0970 | 3170 | extern void unmark_byte_stack (void); |
0ee81a0c | 3171 | extern Lisp_Object exec_byte_code (Lisp_Object, Lisp_Object, Lisp_Object, |
f66c7cf8 | 3172 | Lisp_Object, ptrdiff_t, Lisp_Object *); |
3cfe6dfd | 3173 | |
78edd3b7 | 3174 | /* Defined in macros.c */ |
3cfe6dfd | 3175 | extern Lisp_Object Qexecute_kbd_macro; |
383e0970 J |
3176 | extern void init_macros (void); |
3177 | extern void syms_of_macros (void); | |
3cfe6dfd | 3178 | |
78edd3b7 | 3179 | /* Defined in undo.c */ |
89dc303e | 3180 | extern Lisp_Object Qapply; |
a387611b | 3181 | extern Lisp_Object Qinhibit_read_only; |
383e0970 | 3182 | extern void truncate_undo_list (struct buffer *); |
d311d28c PE |
3183 | extern void record_marker_adjustment (Lisp_Object, ptrdiff_t); |
3184 | extern void record_insert (ptrdiff_t, ptrdiff_t); | |
3185 | extern void record_delete (ptrdiff_t, Lisp_Object); | |
383e0970 | 3186 | extern void record_first_change (void); |
d311d28c PE |
3187 | extern void record_change (ptrdiff_t, ptrdiff_t); |
3188 | extern void record_property_change (ptrdiff_t, ptrdiff_t, | |
c8a66ab8 | 3189 | Lisp_Object, Lisp_Object, |
383e0970 J |
3190 | Lisp_Object); |
3191 | extern void syms_of_undo (void); | |
78edd3b7 | 3192 | /* Defined in textprop.c */ |
5f6bf5fe | 3193 | extern Lisp_Object Qfont, Qmouse_face; |
c2d8811c | 3194 | extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks; |
e6cba650 DN |
3195 | extern Lisp_Object Qfront_sticky, Qrear_nonsticky; |
3196 | extern Lisp_Object Qminibuffer_prompt; | |
3197 | ||
383e0970 | 3198 | extern void report_interval_modification (Lisp_Object, Lisp_Object); |
8537f1cb | 3199 | |
78edd3b7 | 3200 | /* Defined in menu.c */ |
383e0970 | 3201 | extern void syms_of_menu (void); |
febcacdd | 3202 | |
78edd3b7 | 3203 | /* Defined in xmenu.c */ |
383e0970 | 3204 | extern void syms_of_xmenu (void); |
526a2be7 | 3205 | |
78edd3b7 | 3206 | /* Defined in termchar.h */ |
28d7d09f KL |
3207 | struct tty_display_info; |
3208 | ||
78edd3b7 | 3209 | /* Defined in termhooks.h */ |
6ed8eeff | 3210 | struct terminal; |
28d440ab | 3211 | |
78edd3b7 | 3212 | /* Defined in sysdep.c */ |
2412f586 | 3213 | #ifndef HAVE_GET_CURRENT_DIR_NAME |
383e0970 | 3214 | extern char *get_current_dir_name (void); |
2b94e598 | 3215 | #endif |
383e0970 J |
3216 | extern void stuff_char (char c); |
3217 | extern void init_sigio (int); | |
3218 | extern void sys_subshell (void); | |
3219 | extern void sys_suspend (void); | |
3220 | extern void discard_tty_input (void); | |
3221 | extern void init_sys_modes (struct tty_display_info *); | |
3222 | extern void reset_sys_modes (struct tty_display_info *); | |
3223 | extern void init_all_sys_modes (void); | |
3224 | extern void reset_all_sys_modes (void); | |
d311d28c PE |
3225 | extern void wait_for_termination (pid_t); |
3226 | extern void interruptible_wait_for_termination (pid_t); | |
5994c183 | 3227 | extern void flush_pending_output (int) ATTRIBUTE_CONST; |
383e0970 J |
3228 | extern void child_setup_tty (int); |
3229 | extern void setup_pty (int); | |
3230 | extern int set_window_size (int, int, int); | |
ede49d71 | 3231 | extern EMACS_INT get_random (void); |
a884fdcc | 3232 | extern void seed_random (long); |
383e0970 J |
3233 | extern int emacs_open (const char *, int, int); |
3234 | extern int emacs_close (int); | |
d311d28c PE |
3235 | extern ptrdiff_t emacs_read (int, char *, ptrdiff_t); |
3236 | extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t); | |
d1fdcab7 PE |
3237 | enum { READLINK_BUFSIZE = 1024 }; |
3238 | extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE]); | |
526a2be7 | 3239 | |
383e0970 J |
3240 | extern void unlock_all_files (void); |
3241 | extern void lock_file (Lisp_Object); | |
3242 | extern void unlock_file (Lisp_Object); | |
3243 | extern void unlock_buffer (struct buffer *); | |
3244 | extern void syms_of_filelock (void); | |
15b0ced5 GM |
3245 | |
3246 | /* Defined in sound.c */ | |
383e0970 | 3247 | extern void syms_of_sound (void); |
46abf440 AS |
3248 | |
3249 | /* Defined in category.c */ | |
383e0970 J |
3250 | extern void init_category_once (void); |
3251 | extern Lisp_Object char_category_set (int); | |
3252 | extern void syms_of_category (void); | |
46abf440 AS |
3253 | |
3254 | /* Defined in ccl.c */ | |
383e0970 | 3255 | extern void syms_of_ccl (void); |
46abf440 AS |
3256 | |
3257 | /* Defined in dired.c */ | |
383e0970 J |
3258 | extern void syms_of_dired (void); |
3259 | extern Lisp_Object directory_files_internal (Lisp_Object, Lisp_Object, | |
3260 | Lisp_Object, Lisp_Object, | |
3261 | int, Lisp_Object); | |
46abf440 | 3262 | |
46abf440 | 3263 | /* Defined in term.c */ |
e6cba650 | 3264 | extern int *char_ins_del_vector; |
e6ca6543 | 3265 | extern void mark_ttys (void); |
383e0970 | 3266 | extern void syms_of_term (void); |
845ca893 PE |
3267 | extern _Noreturn void fatal (const char *msgid, ...) |
3268 | ATTRIBUTE_FORMAT_PRINTF (1, 2); | |
46abf440 | 3269 | |
ed8dad6b | 3270 | /* Defined in terminal.c */ |
383e0970 | 3271 | extern void syms_of_terminal (void); |
ed8dad6b | 3272 | |
b86cfd28 | 3273 | /* Defined in font.c */ |
383e0970 J |
3274 | extern void syms_of_font (void); |
3275 | extern void init_font (void); | |
b86cfd28 | 3276 | |
4f48f1ab | 3277 | #ifdef HAVE_WINDOW_SYSTEM |
46abf440 | 3278 | /* Defined in fontset.c */ |
383e0970 | 3279 | extern void syms_of_fontset (void); |
4f48f1ab YM |
3280 | |
3281 | /* Defined in xfns.c, w32fns.c, or macfns.c */ | |
99f3388e | 3282 | extern Lisp_Object Qfont_param; |
46abf440 AS |
3283 | #endif |
3284 | ||
3285 | /* Defined in xfaces.c */ | |
955cbe7b PE |
3286 | extern Lisp_Object Qdefault, Qtool_bar, Qfringe; |
3287 | extern Lisp_Object Qheader_line, Qscroll_bar, Qcursor; | |
3288 | extern Lisp_Object Qmode_line_inactive; | |
e6cba650 | 3289 | extern Lisp_Object Qface; |
89dc303e | 3290 | extern Lisp_Object Qnormal; |
0e9c8657 JB |
3291 | extern Lisp_Object QCfamily, QCweight, QCslant; |
3292 | extern Lisp_Object QCheight, QCname, QCwidth, QCforeground, QCbackground; | |
99f3388e | 3293 | extern Lisp_Object Vface_alternative_font_family_alist; |
99f3388e | 3294 | extern Lisp_Object Vface_alternative_font_registry_alist; |
383e0970 | 3295 | extern void syms_of_xfaces (void); |
46abf440 AS |
3296 | |
3297 | #ifdef HAVE_X_WINDOWS | |
3298 | /* Defined in xfns.c */ | |
383e0970 | 3299 | extern void syms_of_xfns (void); |
46abf440 | 3300 | |
e02207d4 | 3301 | /* Defined in xsmfns.c */ |
383e0970 | 3302 | extern void syms_of_xsmfns (void); |
e02207d4 | 3303 | |
46abf440 | 3304 | /* Defined in xselect.c */ |
383e0970 | 3305 | extern void syms_of_xselect (void); |
46abf440 AS |
3306 | |
3307 | /* Defined in xterm.c */ | |
383e0970 | 3308 | extern void syms_of_xterm (void); |
4f48f1ab | 3309 | #endif /* HAVE_X_WINDOWS */ |
4baa6f88 | 3310 | |
7af07b96 AS |
3311 | #ifdef HAVE_WINDOW_SYSTEM |
3312 | /* Defined in xterm.c, nsterm.m, w32term.c */ | |
3313 | extern char *x_get_keysym_name (int); | |
3314 | #endif /* HAVE_WINDOW_SYSTEM */ | |
3315 | ||
381408e2 LMI |
3316 | #ifdef HAVE_LIBXML2 |
3317 | /* Defined in xml.c */ | |
3318 | extern void syms_of_xml (void); | |
9078ead6 | 3319 | extern void xml_cleanup_parser (void); |
381408e2 LMI |
3320 | #endif |
3321 | ||
4d0ac3d7 | 3322 | #ifdef HAVE_MENUS |
07b87a10 | 3323 | /* Defined in (x|w32)fns.c, nsfns.m... */ |
383e0970 | 3324 | extern int have_menus_p (void); |
4d0ac3d7 | 3325 | #endif |
b86cfd28 EZ |
3326 | |
3327 | #ifdef HAVE_DBUS | |
3328 | /* Defined in dbusbind.c */ | |
383e0970 | 3329 | void syms_of_dbusbind (void); |
b86cfd28 | 3330 | #endif |
36e053eb DN |
3331 | |
3332 | #ifdef DOS_NT | |
3333 | /* Defined in msdos.c, w32.c */ | |
3334 | extern char *emacs_root_dir (void); | |
3335 | #endif /* DOS_NT */ | |
83925baa | 3336 | \f |
3cfe6dfd JB |
3337 | /* Nonzero means Emacs has already been initialized. |
3338 | Used during startup to detect startup of dumped Emacs. */ | |
3339 | extern int initialized; | |
3340 | ||
3341 | extern int immediate_quit; /* Nonzero means ^G can quit instantly */ | |
3342 | ||
261cb4bb | 3343 | extern void *xmalloc (size_t); |
23f86fce | 3344 | extern void *xzalloc (size_t); |
261cb4bb PE |
3345 | extern void *xrealloc (void *, size_t); |
3346 | extern void xfree (void *); | |
0065d054 PE |
3347 | extern void *xnmalloc (ptrdiff_t, ptrdiff_t); |
3348 | extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t); | |
3349 | extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t); | |
074b6efe | 3350 | |
383e0970 | 3351 | extern char *xstrdup (const char *); |
3cfe6dfd | 3352 | |
a8fe7202 | 3353 | extern char *egetenv (const char *); |
e98227af | 3354 | |
5d6be39f | 3355 | /* Set up the name of the machine we're running on. */ |
383e0970 | 3356 | extern void init_system_name (void); |
881a5a80 RS |
3357 | |
3358 | /* Some systems (e.g., NT) use a different path separator than Unix, | |
087fc47a | 3359 | in addition to a device separator. Set the path separator |
881a5a80 RS |
3360 | to '/', and don't test for a device separator in IS_ANY_SEP. */ |
3361 | ||
881a5a80 | 3362 | #define DIRECTORY_SEP '/' |
881a5a80 RS |
3363 | #ifndef IS_DIRECTORY_SEP |
3364 | #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP) | |
3365 | #endif | |
3366 | #ifndef IS_DEVICE_SEP | |
3367 | #ifndef DEVICE_SEP | |
3368 | #define IS_DEVICE_SEP(_c_) 0 | |
3369 | #else | |
3370 | #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP) | |
3371 | #endif | |
3372 | #endif | |
3373 | #ifndef IS_ANY_SEP | |
3374 | #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_)) | |
3375 | #endif | |
51bd4610 | 3376 | |
51bd4610 | 3377 | #define SWITCH_ENUM_CAST(x) (x) |
a32fa736 | 3378 | |
9aba6043 | 3379 | /* Use this to suppress gcc's warnings. */ |
dba65498 | 3380 | #ifdef lint |
f2ed8a70 PE |
3381 | |
3382 | /* Use CODE only if lint checking is in effect. */ | |
dba65498 | 3383 | # define IF_LINT(Code) Code |
f2ed8a70 PE |
3384 | |
3385 | /* Assume that the expression COND is true. This differs in intent | |
3386 | from 'assert', as it is a message from the programmer to the compiler. */ | |
3387 | # define lint_assume(cond) ((cond) ? (void) 0 : abort ()) | |
3388 | ||
dba65498 PE |
3389 | #else |
3390 | # define IF_LINT(Code) /* empty */ | |
f2ed8a70 | 3391 | # define lint_assume(cond) ((void) (0 && (cond))) |
dba65498 PE |
3392 | #endif |
3393 | ||
8a226de7 GM |
3394 | /* The ubiquitous min and max macros. */ |
3395 | ||
152180e3 AI |
3396 | #ifdef max |
3397 | #undef max | |
3398 | #undef min | |
3399 | #endif | |
8a226de7 GM |
3400 | #define min(a, b) ((a) < (b) ? (a) : (b)) |
3401 | #define max(a, b) ((a) > (b) ? (a) : (b)) | |
53ede3f4 | 3402 | |
555b10b0 EZ |
3403 | /* We used to use `abs', but that clashes with system headers on some |
3404 | platforms, and using a name reserved by Standard C is a bad idea | |
3405 | anyway. */ | |
5e617bc2 | 3406 | #if !defined (eabs) |
555b10b0 | 3407 | #define eabs(x) ((x) < 0 ? -(x) : (x)) |
096e8667 GM |
3408 | #endif |
3409 | ||
53ede3f4 GM |
3410 | /* Return a fixnum or float, depending on whether VAL fits in a Lisp |
3411 | fixnum. */ | |
3412 | ||
3413 | #define make_fixnum_or_float(val) \ | |
cbeff735 | 3414 | (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val)) |
6b61353c | 3415 | |
e32d9872 MB |
3416 | |
3417 | /* Checks the `cycle check' variable CHECK to see if it indicates that | |
3418 | EL is part of a cycle; CHECK must be either Qnil or a value returned | |
3419 | by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of | |
3420 | elements after which a cycle might be suspected; after that many | |
3421 | elements, this macro begins consing in order to keep more precise | |
3422 | track of elements. | |
3423 | ||
3424 | Returns nil if a cycle was detected, otherwise a new value for CHECK | |
3425 | that includes EL. | |
3426 | ||
3427 | CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so | |
3428 | the caller should make sure that's ok. */ | |
3429 | ||
3430 | #define CYCLE_CHECK(check, el, suspicious) \ | |
3431 | (NILP (check) \ | |
3432 | ? make_number (0) \ | |
3433 | : (INTEGERP (check) \ | |
3434 | ? (XFASTINT (check) < (suspicious) \ | |
3435 | ? make_number (XFASTINT (check) + 1) \ | |
3436 | : Fcons (el, Qnil)) \ | |
3437 | : (!NILP (Fmemq ((el), (check))) \ | |
3438 | ? Qnil \ | |
3439 | : Fcons ((el), (check))))) | |
3440 | ||
3441 | ||
79518a8d KS |
3442 | /* SAFE_ALLOCA normally allocates memory on the stack, but if size is |
3443 | larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */ | |
3444 | ||
3445 | #define MAX_ALLOCA 16*1024 | |
3446 | ||
3447 | extern Lisp_Object safe_alloca_unwind (Lisp_Object); | |
3448 | ||
3449 | #define USE_SAFE_ALLOCA \ | |
d311d28c | 3450 | ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0 |
79518a8d | 3451 | |
a9e6bacc KS |
3452 | /* SAFE_ALLOCA allocates a simple buffer. */ |
3453 | ||
79518a8d KS |
3454 | #define SAFE_ALLOCA(buf, type, size) \ |
3455 | do { \ | |
3456 | if ((size) < MAX_ALLOCA) \ | |
3457 | buf = (type) alloca (size); \ | |
3458 | else \ | |
3459 | { \ | |
23f86fce | 3460 | buf = xmalloc (size); \ |
a2d26660 | 3461 | sa_must_free = 1; \ |
79518a8d KS |
3462 | record_unwind_protect (safe_alloca_unwind, \ |
3463 | make_save_value (buf, 0)); \ | |
3464 | } \ | |
3465 | } while (0) | |
3466 | ||
0065d054 PE |
3467 | /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER * |
3468 | NITEMS items, each of the same type as *BUF. MULTIPLIER must | |
3469 | positive. The code is tuned for MULTIPLIER being a constant. */ | |
3470 | ||
3471 | #define SAFE_NALLOCA(buf, multiplier, nitems) \ | |
3472 | do { \ | |
3473 | if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \ | |
3474 | (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \ | |
3475 | else \ | |
3476 | { \ | |
3477 | (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \ | |
3478 | sa_must_free = 1; \ | |
3479 | record_unwind_protect (safe_alloca_unwind, \ | |
3480 | make_save_value (buf, 0)); \ | |
3481 | } \ | |
3482 | } while (0) | |
3483 | ||
a9e6bacc KS |
3484 | /* SAFE_FREE frees xmalloced memory and enables GC as needed. */ |
3485 | ||
c33188d9 | 3486 | #define SAFE_FREE() \ |
79518a8d | 3487 | do { \ |
c33188d9 KS |
3488 | if (sa_must_free) { \ |
3489 | sa_must_free = 0; \ | |
79518a8d | 3490 | unbind_to (sa_count, Qnil); \ |
c33188d9 | 3491 | } \ |
79518a8d KS |
3492 | } while (0) |
3493 | ||
3494 | ||
5f5d6c62 KS |
3495 | /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */ |
3496 | ||
3497 | #define SAFE_ALLOCA_LISP(buf, nelt) \ | |
3498 | do { \ | |
9c4c5f81 PE |
3499 | if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \ |
3500 | buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \ | |
3501 | else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \ | |
5f5d6c62 KS |
3502 | { \ |
3503 | Lisp_Object arg_; \ | |
23f86fce | 3504 | buf = xmalloc ((nelt) * sizeof (Lisp_Object)); \ |
5f5d6c62 KS |
3505 | arg_ = make_save_value (buf, nelt); \ |
3506 | XSAVE_VALUE (arg_)->dogc = 1; \ | |
a2d26660 | 3507 | sa_must_free = 1; \ |
5f5d6c62 KS |
3508 | record_unwind_protect (safe_alloca_unwind, arg_); \ |
3509 | } \ | |
9c4c5f81 PE |
3510 | else \ |
3511 | memory_full (SIZE_MAX); \ | |
5f5d6c62 KS |
3512 | } while (0) |
3513 | ||
79518a8d | 3514 | |
29208e82 TT |
3515 | #include "globals.h" |
3516 | ||
dac616ff DA |
3517 | /* Check whether it's time for GC, and run it if so. */ |
3518 | ||
3519 | static inline void | |
3520 | maybe_gc (void) | |
3521 | { | |
3522 | if ((consing_since_gc > gc_cons_threshold | |
3523 | && consing_since_gc > gc_relative_threshold) | |
3524 | || (!NILP (Vmemory_full) | |
3525 | && consing_since_gc > memory_full_cons_threshold)) | |
3526 | Fgarbage_collect (); | |
3527 | } | |
3528 | ||
6b61353c | 3529 | #endif /* EMACS_LISP_H */ |