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