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