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