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