1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2015 Free Software Foundation,
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/>. */
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
39 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
40 # define ID (some integer preprocessor expression of type TYPE)
41 DEFINE_GDB_SYMBOL_END (ID)
43 This hack is for the benefit of compilers that do not make macro
44 definitions or enums visible to the debugger. It's used for symbols
45 that .gdbinit needs. */
47 #define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
49 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
50 # define DEFINE_GDB_SYMBOL_END(id) = id;
52 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
53 # define DEFINE_GDB_SYMBOL_END(val) ;
56 /* The ubiquitous max and min macros. */
59 #define max(a, b) ((a) > (b) ? (a) : (b))
60 #define min(a, b) ((a) < (b) ? (a) : (b))
62 /* Number of elements in an array. */
63 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
65 /* Number of bits in a Lisp_Object tag. */
66 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
68 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
70 /* The number of bits needed in an EMACS_INT over and above the number
71 of bits in a pointer. This is 0 on systems where:
72 1. We can specify multiple-of-8 alignment on static variables.
73 2. We know malloc returns a multiple of 8. */
74 #if (defined alignas \
75 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
76 || defined DARWIN_OS || defined __sun || defined __MINGW32__ \
78 # define NONPOINTER_BITS 0
80 # define NONPOINTER_BITS GCTYPEBITS
83 /* EMACS_INT - signed integer wide enough to hold an Emacs value
84 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
85 pI - printf length modifier for EMACS_INT
86 EMACS_UINT - unsigned variant of EMACS_INT */
89 # error "INTPTR_MAX misconfigured"
90 # elif INTPTR_MAX <= INT_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
91 typedef int EMACS_INT
;
92 typedef unsigned int EMACS_UINT
;
93 # define EMACS_INT_MAX INT_MAX
95 # elif INTPTR_MAX <= LONG_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
96 typedef long int EMACS_INT
;
97 typedef unsigned long EMACS_UINT
;
98 # define EMACS_INT_MAX LONG_MAX
100 /* Check versus LLONG_MAX, not LLONG_MAX >> NONPOINTER_BITS.
101 In theory this is not safe, but in practice it seems to be OK. */
102 # elif INTPTR_MAX <= LLONG_MAX
103 typedef long long int EMACS_INT
;
104 typedef unsigned long long int EMACS_UINT
;
105 # define EMACS_INT_MAX LLONG_MAX
108 # error "INTPTR_MAX too large"
112 /* Number of bits to put in each character in the internal representation
113 of bool vectors. This should not vary across implementations. */
114 enum { BOOL_VECTOR_BITS_PER_CHAR
=
115 #define BOOL_VECTOR_BITS_PER_CHAR 8
116 BOOL_VECTOR_BITS_PER_CHAR
119 /* An unsigned integer type representing a fixed-length bit sequence,
120 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
121 for speed, but it is unsigned char on weird platforms. */
122 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
123 typedef size_t bits_word
;
124 # define BITS_WORD_MAX SIZE_MAX
125 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
127 typedef unsigned char bits_word
;
128 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
129 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
131 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
133 /* Number of bits in some machine integer types. */
136 BITS_PER_CHAR
= CHAR_BIT
,
137 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
138 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
139 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
142 /* printmax_t and uprintmax_t are types for printing large integers.
143 These are the widest integers that are supported for printing.
144 pMd etc. are conversions for printing them.
145 On C99 hosts, there's no problem, as even the widest integers work.
146 Fall back on EMACS_INT on pre-C99 hosts. */
148 typedef intmax_t printmax_t
;
149 typedef uintmax_t uprintmax_t
;
153 typedef EMACS_INT printmax_t
;
154 typedef EMACS_UINT uprintmax_t
;
159 /* Use pD to format ptrdiff_t values, which suffice for indexes into
160 buffers and strings. Emacs never allocates objects larger than
161 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
162 In C99, pD can always be "t"; configure it here for the sake of
163 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
164 #if PTRDIFF_MAX == INT_MAX
166 #elif PTRDIFF_MAX == LONG_MAX
168 #elif PTRDIFF_MAX == LLONG_MAX
174 /* Extra internal type checking? */
176 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
177 'assume (COND)'. COND should be free of side effects, as it may or
178 may not be evaluated.
180 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
181 defined and suppress_checking is false, and does nothing otherwise.
182 Emacs dies if COND is checked and is false. The suppress_checking
183 variable is initialized to 0 in alloc.c. Set it to 1 using a
184 debugger to temporarily disable aborting on detected internal
185 inconsistencies or error conditions.
187 In some cases, a good compiler may be able to optimize away the
188 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
189 uses eassert to test STRINGP (x), but a particular use of XSTRING
190 is invoked only after testing that STRINGP (x) is true, making the
193 eassume is like eassert except that it also causes the compiler to
194 assume that COND is true afterwards, regardless of whether runtime
195 checking is enabled. This can improve performance in some cases,
196 though it can degrade performance in others. It's often suboptimal
197 for COND to call external functions or access volatile storage. */
199 #ifndef ENABLE_CHECKING
200 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
201 # define eassume(cond) assume (cond)
202 #else /* ENABLE_CHECKING */
204 extern _Noreturn
void die (const char *, const char *, int);
206 extern bool suppress_checking EXTERNALLY_VISIBLE
;
208 # define eassert(cond) \
209 (suppress_checking || (cond) \
211 : die (# cond, __FILE__, __LINE__))
212 # define eassume(cond) \
217 : die (# cond, __FILE__, __LINE__))
218 #endif /* ENABLE_CHECKING */
221 /* Use the configure flag --enable-check-lisp-object-type to make
222 Lisp_Object use a struct type instead of the default int. The flag
223 causes CHECK_LISP_OBJECT_TYPE to be defined. */
225 /***** Select the tagging scheme. *****/
226 /* The following option controls the tagging scheme:
227 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
228 always 0, and we can thus use them to hold tag bits, without
229 restricting our addressing space.
231 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
232 restricting our possible address range.
234 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
235 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
236 on the few static Lisp_Objects used: lispsym, all the defsubr, and
237 the two special buffers buffer_defaults and buffer_local_symbols. */
241 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
242 integer constant, for MSVC. */
243 #define GCALIGNMENT 8
245 /* Number of bits in a Lisp_Object value, not counting the tag. */
246 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
248 /* Number of bits in a Lisp fixnum tag. */
249 INTTYPEBITS
= GCTYPEBITS
- 1,
251 /* Number of bits in a Lisp fixnum value, not counting the tag. */
252 FIXNUM_BITS
= VALBITS
+ 1
255 #if GCALIGNMENT != 1 << GCTYPEBITS
256 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
259 /* The maximum value that can be stored in a EMACS_INT, assuming all
260 bits other than the type bits contribute to a nonnegative signed value.
261 This can be used in #if, e.g., '#if USB_TAG' below expands to an
262 expression involving VAL_MAX. */
263 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
265 /* Whether the least-significant bits of an EMACS_INT contain the tag.
266 On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
267 a. unnecessary, because the top bits of an EMACS_INT are unused, and
268 b. slower, because it typically requires extra masking.
269 So, USE_LSB_TAG is true only on hosts where it might be useful. */
270 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
271 #define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
272 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
274 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
275 # error "USE_LSB_TAG not supported on this platform; please report this." \
276 "Try 'configure --with-wide-int' to work around the problem."
281 # define alignas(alignment) /* empty */
283 # error "USE_LSB_TAG requires alignas"
287 #ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
288 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
290 # define GCALIGNED /* empty */
293 /* Some operations are so commonly executed that they are implemented
294 as macros, not functions, because otherwise runtime performance would
295 suffer too much when compiling with GCC without optimization.
296 There's no need to inline everything, just the operations that
297 would otherwise cause a serious performance problem.
299 For each such operation OP, define a macro lisp_h_OP that contains
300 the operation's implementation. That way, OP can be implemented
301 via a macro definition like this:
303 #define OP(x) lisp_h_OP (x)
305 and/or via a function definition like this:
307 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
309 which macro-expands to this:
311 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
313 without worrying about the implementations diverging, since
314 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
315 are intended to be private to this include file, and should not be
318 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
319 functions, once most developers have access to GCC 4.8 or later and
320 can use "gcc -Og" to debug. Maybe in the year 2016. See
323 Commentary for these macros can be found near their corresponding
326 #if CHECK_LISP_OBJECT_TYPE
327 # define lisp_h_XLI(o) ((o).i)
328 # define lisp_h_XIL(i) ((Lisp_Object) { i })
330 # define lisp_h_XLI(o) (o)
331 # define lisp_h_XIL(i) (i)
333 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
334 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
335 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
336 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
337 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
338 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
339 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
340 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
341 #define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
342 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
343 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
344 #define lisp_h_NILP(x) EQ (x, Qnil)
345 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
346 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
347 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
348 #define lisp_h_SYMBOL_VAL(sym) \
349 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
350 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
351 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
352 #define lisp_h_XCAR(c) XCONS (c)->car
353 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
354 #define lisp_h_XCONS(a) \
355 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
356 #define lisp_h_XHASH(a) XUINT (a)
357 #define lisp_h_XPNTR(a) \
358 (SYMBOLP (a) ? XSYMBOL (a) : (void *) ((intptr_t) (XLI (a) & VALMASK)))
359 #ifndef GC_CHECK_CONS_LIST
360 # define lisp_h_check_cons_list() ((void) 0)
363 # define lisp_h_make_number(n) \
364 XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
365 # define lisp_h_XFASTINT(a) XINT (a)
366 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
367 # define lisp_h_XSYMBOL(a) \
368 (eassert (SYMBOLP (a)), \
369 (struct Lisp_Symbol *) ((uintptr_t) XLI (a) - Lisp_Symbol \
371 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
372 # define lisp_h_XUNTAG(a, type) ((void *) (intptr_t) (XLI (a) - (type)))
375 /* When compiling via gcc -O0, define the key operations as macros, as
376 Emacs is too slow otherwise. To disable this optimization, compile
377 with -DINLINING=false. */
378 #if (defined __NO_INLINE__ \
379 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
380 && ! (defined INLINING && ! INLINING))
381 # define XLI(o) lisp_h_XLI (o)
382 # define XIL(i) lisp_h_XIL (i)
383 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
384 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
385 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
386 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
387 # define CONSP(x) lisp_h_CONSP (x)
388 # define EQ(x, y) lisp_h_EQ (x, y)
389 # define FLOATP(x) lisp_h_FLOATP (x)
390 # define INTEGERP(x) lisp_h_INTEGERP (x)
391 # define MARKERP(x) lisp_h_MARKERP (x)
392 # define MISCP(x) lisp_h_MISCP (x)
393 # define NILP(x) lisp_h_NILP (x)
394 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
395 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
396 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
397 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
398 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
399 # define XCAR(c) lisp_h_XCAR (c)
400 # define XCDR(c) lisp_h_XCDR (c)
401 # define XCONS(a) lisp_h_XCONS (a)
402 # define XHASH(a) lisp_h_XHASH (a)
403 # define XPNTR(a) lisp_h_XPNTR (a)
404 # ifndef GC_CHECK_CONS_LIST
405 # define check_cons_list() lisp_h_check_cons_list ()
408 # define make_number(n) lisp_h_make_number (n)
409 # define XFASTINT(a) lisp_h_XFASTINT (a)
410 # define XINT(a) lisp_h_XINT (a)
411 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
412 # define XTYPE(a) lisp_h_XTYPE (a)
413 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
417 /* Define NAME as a lisp.h inline function that returns TYPE and has
418 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
419 ARGS should be parenthesized. Implement the function by calling
421 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
422 INLINE type (name) argdecls { return lisp_h_##name args; }
424 /* like LISP_MACRO_DEFUN, except NAME returns void. */
425 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
426 INLINE void (name) argdecls { lisp_h_##name args; }
429 /* Define the fundamental Lisp data structures. */
431 /* This is the set of Lisp data types. If you want to define a new
432 data type, read the comments after Lisp_Fwd_Type definition
435 /* Lisp integers use 2 tags, to give them one extra bit, thus
436 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
437 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
438 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
440 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
441 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
442 vociferously about them. */
443 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
444 || (defined __SUNPRO_C && __STDC__))
445 #define ENUM_BF(TYPE) unsigned int
447 #define ENUM_BF(TYPE) enum TYPE
453 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
456 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
457 whose first member indicates the subtype. */
460 /* Integer. XINT (obj) is the integer value. */
462 Lisp_Int1
= USE_LSB_TAG
? 6 : 3,
464 /* String. XSTRING (object) points to a struct Lisp_String.
465 The length of the string, and its contents, are stored therein. */
468 /* Vector of Lisp objects, or something resembling it.
469 XVECTOR (object) points to a struct Lisp_Vector, which contains
470 the size and contents. The size field also contains the type
471 information, if it's not a real vector object. */
474 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
475 Lisp_Cons
= USE_LSB_TAG
? 3 : 6,
480 /* This is the set of data types that share a common structure.
481 The first member of the structure is a type code from this set.
482 The enum values are arbitrary, but we'll use large numbers to make it
483 more likely that we'll spot the error if a random word in memory is
484 mistakenly interpreted as a Lisp_Misc. */
487 Lisp_Misc_Free
= 0x5eab,
490 Lisp_Misc_Save_Value
,
491 /* Currently floats are not a misc type,
492 but let's define this in case we want to change that. */
494 /* This is not a type code. It is for range checking. */
498 /* These are the types of forwarding objects used in the value slot
499 of symbols for special built-in variables whose value is stored in
503 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
504 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
505 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
506 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
507 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
510 /* If you want to define a new Lisp data type, here are some
511 instructions. See the thread at
512 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
515 First, there are already a couple of Lisp types that can be used if
516 your new type does not need to be exposed to Lisp programs nor
517 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
518 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
519 is suitable for temporarily stashing away pointers and integers in
520 a Lisp object. The latter is useful for vector-like Lisp objects
521 that need to be used as part of other objects, but which are never
522 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
525 These two types don't look pretty when printed, so they are
526 unsuitable for Lisp objects that can be exposed to users.
528 To define a new data type, add one more Lisp_Misc subtype or one
529 more pseudovector subtype. Pseudovectors are more suitable for
530 objects with several slots that need to support fast random access,
531 while Lisp_Misc types are for everything else. A pseudovector object
532 provides one or more slots for Lisp objects, followed by struct
533 members that are accessible only from C. A Lisp_Misc object is a
534 wrapper for a C struct that can contain anything you like.
536 Explicit freeing is discouraged for Lisp objects in general. But if
537 you really need to exploit this, use Lisp_Misc (check free_misc in
538 alloc.c to see why). There is no way to free a vectorlike object.
540 To add a new pseudovector type, extend the pvec_type enumeration;
541 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
543 For a Lisp_Misc, you will also need to add your entry to union
544 Lisp_Misc (but make sure the first word has the same structure as
545 the others, starting with a 16-bit member of the Lisp_Misc_Type
546 enumeration and a 1-bit GC markbit) and make sure the overall size
547 of the union is not increased by your addition.
549 For a new pseudovector, it's highly desirable to limit the size
550 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
551 Otherwise you will need to change sweep_vectors (also in alloc.c).
553 Then you will need to add switch branches in print.c (in
554 print_object, to print your object, and possibly also in
555 print_preprocess) and to alloc.c, to mark your object (in
556 mark_object) and to free it (in gc_sweep). The latter is also the
557 right place to call any code specific to your data type that needs
558 to run when the object is recycled -- e.g., free any additional
559 resources allocated for it that are not Lisp objects. You can even
560 make a pointer to the function that frees the resources a slot in
561 your object -- this way, the same object could be used to represent
562 several disparate C structures. */
564 #ifdef CHECK_LISP_OBJECT_TYPE
566 typedef struct { EMACS_INT i
; } Lisp_Object
;
568 #define LISP_INITIALLY(i) {i}
570 #undef CHECK_LISP_OBJECT_TYPE
571 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
572 #else /* CHECK_LISP_OBJECT_TYPE */
574 /* If a struct type is not wanted, define Lisp_Object as just a number. */
576 typedef EMACS_INT Lisp_Object
;
577 #define LISP_INITIALLY(i) (i)
578 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
579 #endif /* CHECK_LISP_OBJECT_TYPE */
581 #define LISP_INITIALLY_ZERO LISP_INITIALLY (0)
583 /* Forward declarations. */
585 /* Defined in this file. */
587 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
588 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
589 INLINE
bool BUFFERP (Lisp_Object
);
590 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
591 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
592 INLINE
bool (CONSP
) (Lisp_Object
);
593 INLINE
bool (FLOATP
) (Lisp_Object
);
594 INLINE
bool functionp (Lisp_Object
);
595 INLINE
bool (INTEGERP
) (Lisp_Object
);
596 INLINE
bool (MARKERP
) (Lisp_Object
);
597 INLINE
bool (MISCP
) (Lisp_Object
);
598 INLINE
bool (NILP
) (Lisp_Object
);
599 INLINE
bool OVERLAYP (Lisp_Object
);
600 INLINE
bool PROCESSP (Lisp_Object
);
601 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
602 INLINE
bool SAVE_VALUEP (Lisp_Object
);
603 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
605 INLINE
bool STRINGP (Lisp_Object
);
606 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
607 INLINE
bool SUBRP (Lisp_Object
);
608 INLINE
bool (SYMBOLP
) (Lisp_Object
);
609 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
610 INLINE
bool WINDOWP (Lisp_Object
);
611 INLINE
bool TERMINALP (Lisp_Object
);
612 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
613 INLINE
struct Lisp_Symbol
*(XSYMBOL
) (Lisp_Object
);
614 INLINE
void *(XUNTAG
) (Lisp_Object
, int);
616 /* Defined in chartab.c. */
617 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
618 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
620 /* Defined in data.c. */
621 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
622 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
624 /* Defined in emacs.c. */
625 extern bool might_dump
;
626 /* True means Emacs has already been initialized.
627 Used during startup to detect startup of dumped Emacs. */
628 extern bool initialized
;
630 /* Defined in floatfns.c. */
631 extern double extract_float (Lisp_Object
);
634 /* Interned state of a symbol. */
638 SYMBOL_UNINTERNED
= 0,
640 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
647 SYMBOL_LOCALIZED
= 2,
653 bool_bf gcmarkbit
: 1;
655 /* Indicates where the value can be found:
656 0 : it's a plain var, the value is in the `value' field.
657 1 : it's a varalias, the value is really in the `alias' symbol.
658 2 : it's a localized var, the value is in the `blv' object.
659 3 : it's a forwarding variable, the value is in `forward'. */
660 ENUM_BF (symbol_redirect
) redirect
: 3;
662 /* Non-zero means symbol is constant, i.e. changing its value
663 should signal an error. If the value is 3, then the var
664 can be changed, but only by `defconst'. */
665 unsigned constant
: 2;
667 /* Interned state of the symbol. This is an enumerator from
668 enum symbol_interned. */
669 unsigned interned
: 2;
671 /* True means that this variable has been explicitly declared
672 special (with `defvar' etc), and shouldn't be lexically bound. */
673 bool_bf declared_special
: 1;
675 /* True if pointed to from purespace and hence can't be GC'd. */
678 /* The symbol's name, as a Lisp string. */
681 /* Value of the symbol or Qunbound if unbound. Which alternative of the
682 union is used depends on the `redirect' field above. */
685 struct Lisp_Symbol
*alias
;
686 struct Lisp_Buffer_Local_Value
*blv
;
690 /* Function value of the symbol or Qnil if not fboundp. */
691 Lisp_Object function
;
693 /* The symbol's property list. */
696 /* Next symbol in obarray bucket, if the symbol is interned. */
697 struct Lisp_Symbol
*next
;
700 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
701 meaning as in the DEFUN macro, and is used to construct a prototype. */
702 /* We can use the same trick as in the DEFUN macro to generate the
703 appropriate prototype. */
704 #define EXFUN(fnname, maxargs) \
705 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
707 /* Note that the weird token-substitution semantics of ANSI C makes
708 this work for MANY and UNEVALLED. */
709 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
710 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
711 #define DEFUN_ARGS_0 (void)
712 #define DEFUN_ARGS_1 (Lisp_Object)
713 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
714 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
715 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
716 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
718 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
719 Lisp_Object, Lisp_Object)
720 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
721 Lisp_Object, Lisp_Object, Lisp_Object)
722 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
723 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
725 /* Yield an integer that contains TAG along with PTR. */
726 #define TAG_PTR(tag, ptr) \
727 ((USE_LSB_TAG ? (tag) : (EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr))
729 /* Yield an integer that contains a symbol tag along with OFFSET.
730 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
731 #define TAG_SYMOFFSET(offset) \
732 TAG_PTR (Lisp_Symbol, \
733 ((uintptr_t) (offset) >> (USE_LSB_TAG ? 0 : GCTYPEBITS)))
735 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
736 XLI (builtin_lisp_symbol (Qwhatever)),
737 except the former expands to an integer constant expression. */
738 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
740 /* Declare extern constants for Lisp symbols. These can be helpful
741 when using a debugger like GDB, on older platforms where the debug
742 format does not represent C macros. */
743 #define DEFINE_LISP_SYMBOL(name) \
744 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
745 DEFINE_GDB_SYMBOL_END (LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name)))
747 /* By default, define macros for Qt, etc., as this leads to a bit
748 better performance in the core Emacs interpreter. A plugin can
749 define DEFINE_NONNIL_Q_SYMBOL_MACROS to be false, to be portable to
750 other Emacs instances that assign different values to Qt, etc. */
751 #ifndef DEFINE_NONNIL_Q_SYMBOL_MACROS
752 # define DEFINE_NONNIL_Q_SYMBOL_MACROS true
757 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
758 At the machine level, these operations are no-ops. */
759 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
760 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
762 /* In the size word of a vector, this bit means the vector has been marked. */
764 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
765 # define ARRAY_MARK_FLAG PTRDIFF_MIN
766 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
768 /* In the size word of a struct Lisp_Vector, this bit means it's really
769 some other vector-like object. */
770 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
771 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
772 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
774 /* In a pseudovector, the size field actually contains a word with one
775 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
776 with PVEC_TYPE_MASK to indicate the actual type. */
788 PVEC_WINDOW_CONFIGURATION
,
791 /* These should be last, check internal_equal to see why. */
795 PVEC_FONT
/* Should be last because it's used for range checking. */
800 /* For convenience, we also store the number of elements in these bits.
801 Note that this size is not necessarily the memory-footprint size, but
802 only the number of Lisp_Object fields (that need to be traced by GC).
803 The distinction is used, e.g., by Lisp_Process, which places extra
804 non-Lisp_Object fields at the end of the structure. */
805 PSEUDOVECTOR_SIZE_BITS
= 12,
806 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
808 /* To calculate the memory footprint of the pseudovector, it's useful
809 to store the size of non-Lisp area in word_size units here. */
810 PSEUDOVECTOR_REST_BITS
= 12,
811 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
812 << PSEUDOVECTOR_SIZE_BITS
),
814 /* Used to extract pseudovector subtype information. */
815 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
816 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
819 /* These functions extract various sorts of values from a Lisp_Object.
820 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
821 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
824 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
825 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
826 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
827 DEFINE_GDB_SYMBOL_END (VALMASK
)
829 /* Largest and smallest representable fixnum values. These are the C
830 values. They are macros for use in static initializers. */
831 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
832 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
836 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
837 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
838 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
839 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
840 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
841 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
843 #else /* ! USE_LSB_TAG */
845 /* Although compiled only if ! USE_LSB_TAG, the following functions
846 also work when USE_LSB_TAG; this is to aid future maintenance when
847 the lisp_h_* macros are eventually removed. */
849 /* Make a Lisp integer representing the value of the low order
852 make_number (EMACS_INT n
)
854 EMACS_INT int0
= Lisp_Int0
;
858 n
= u
<< INTTYPEBITS
;
864 n
+= (int0
<< VALBITS
);
869 /* Extract A's value as a signed integer. */
873 EMACS_INT i
= XLI (a
);
877 i
= u
<< INTTYPEBITS
;
879 return i
>> INTTYPEBITS
;
882 /* Like XINT (A), but may be faster. A must be nonnegative.
883 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
884 integers have zero-bits in their tags. */
886 XFASTINT (Lisp_Object a
)
888 EMACS_INT int0
= Lisp_Int0
;
889 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
) - (int0
<< VALBITS
);
894 /* Extract A's value as a symbol. */
895 INLINE
struct Lisp_Symbol
*
896 XSYMBOL (Lisp_Object a
)
898 uintptr_t i
= (uintptr_t) XUNTAG (a
, Lisp_Symbol
);
901 void *p
= (char *) lispsym
+ i
;
905 /* Extract A's type. */
906 INLINE
enum Lisp_Type
907 XTYPE (Lisp_Object a
)
909 EMACS_UINT i
= XLI (a
);
910 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
913 /* Extract A's pointer value, assuming A's type is TYPE. */
915 XUNTAG (Lisp_Object a
, int type
)
917 intptr_t i
= USE_LSB_TAG
? XLI (a
) - type
: XLI (a
) & VALMASK
;
921 #endif /* ! USE_LSB_TAG */
923 /* Extract the pointer hidden within A. */
924 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
926 /* Extract A's value as an unsigned integer. */
928 XUINT (Lisp_Object a
)
930 EMACS_UINT i
= XLI (a
);
931 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
934 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
935 right now, but XUINT should only be applied to objects we know are
937 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
939 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
941 make_natnum (EMACS_INT n
)
943 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
944 EMACS_INT int0
= Lisp_Int0
;
945 return USE_LSB_TAG
? make_number (n
) : XIL (n
+ (int0
<< VALBITS
));
948 /* Return true if X and Y are the same object. */
949 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
951 /* Value is true if I doesn't fit into a Lisp fixnum. It is
952 written this way so that it also works if I is of unsigned
953 type or if I is a NaN. */
955 #define FIXNUM_OVERFLOW_P(i) \
956 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
959 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
961 return num
< lower
? lower
: num
<= upper
? num
: upper
;
965 /* Extract a value or address from a Lisp_Object. */
967 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
969 INLINE
struct Lisp_Vector
*
970 XVECTOR (Lisp_Object a
)
972 eassert (VECTORLIKEP (a
));
973 return XUNTAG (a
, Lisp_Vectorlike
);
976 INLINE
struct Lisp_String
*
977 XSTRING (Lisp_Object a
)
979 eassert (STRINGP (a
));
980 return XUNTAG (a
, Lisp_String
);
983 /* The index of the C-defined Lisp symbol SYM.
984 This can be used in a static initializer. */
985 #define SYMBOL_INDEX(sym) i##sym
987 INLINE
struct Lisp_Float
*
988 XFLOAT (Lisp_Object a
)
990 eassert (FLOATP (a
));
991 return XUNTAG (a
, Lisp_Float
);
994 /* Pseudovector types. */
996 INLINE
struct Lisp_Process
*
997 XPROCESS (Lisp_Object a
)
999 eassert (PROCESSP (a
));
1000 return XUNTAG (a
, Lisp_Vectorlike
);
1003 INLINE
struct window
*
1004 XWINDOW (Lisp_Object a
)
1006 eassert (WINDOWP (a
));
1007 return XUNTAG (a
, Lisp_Vectorlike
);
1010 INLINE
struct terminal
*
1011 XTERMINAL (Lisp_Object a
)
1013 eassert (TERMINALP (a
));
1014 return XUNTAG (a
, Lisp_Vectorlike
);
1017 INLINE
struct Lisp_Subr
*
1018 XSUBR (Lisp_Object a
)
1020 eassert (SUBRP (a
));
1021 return XUNTAG (a
, Lisp_Vectorlike
);
1024 INLINE
struct buffer
*
1025 XBUFFER (Lisp_Object a
)
1027 eassert (BUFFERP (a
));
1028 return XUNTAG (a
, Lisp_Vectorlike
);
1031 INLINE
struct Lisp_Char_Table
*
1032 XCHAR_TABLE (Lisp_Object a
)
1034 eassert (CHAR_TABLE_P (a
));
1035 return XUNTAG (a
, Lisp_Vectorlike
);
1038 INLINE
struct Lisp_Sub_Char_Table
*
1039 XSUB_CHAR_TABLE (Lisp_Object a
)
1041 eassert (SUB_CHAR_TABLE_P (a
));
1042 return XUNTAG (a
, Lisp_Vectorlike
);
1045 INLINE
struct Lisp_Bool_Vector
*
1046 XBOOL_VECTOR (Lisp_Object a
)
1048 eassert (BOOL_VECTOR_P (a
));
1049 return XUNTAG (a
, Lisp_Vectorlike
);
1052 /* Construct a Lisp_Object from a value or address. */
1055 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
1057 Lisp_Object a
= XIL (TAG_PTR (type
, ptr
));
1058 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
1063 make_lisp_symbol (struct Lisp_Symbol
*sym
)
1065 Lisp_Object a
= XIL (TAG_SYMOFFSET ((char *) sym
- (char *) lispsym
));
1066 eassert (XSYMBOL (a
) == sym
);
1071 builtin_lisp_symbol (int index
)
1073 return make_lisp_symbol (lispsym
+ index
);
1076 #define XSETINT(a, b) ((a) = make_number (b))
1077 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1078 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1079 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1080 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1081 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1082 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1083 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1085 /* Pseudovector types. */
1087 #define XSETPVECTYPE(v, code) \
1088 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1089 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1090 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1091 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1092 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1095 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1096 #define XSETPSEUDOVECTOR(a, b, code) \
1097 XSETTYPED_PSEUDOVECTOR (a, b, \
1098 (((struct vectorlike_header *) \
1099 XUNTAG (a, Lisp_Vectorlike)) \
1102 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1103 (XSETVECTOR (a, b), \
1104 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1105 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1107 #define XSETWINDOW_CONFIGURATION(a, b) \
1108 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1109 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1110 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1111 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1112 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1113 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1114 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1115 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1116 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1117 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1119 /* Efficiently convert a pointer to a Lisp object and back. The
1120 pointer is represented as a Lisp integer, so the garbage collector
1121 does not know about it. The pointer should not have both Lisp_Int1
1122 bits set, which makes this conversion inherently unportable. */
1125 XINTPTR (Lisp_Object a
)
1127 return XUNTAG (a
, Lisp_Int0
);
1131 make_pointer_integer (void *p
)
1133 Lisp_Object a
= XIL (TAG_PTR (Lisp_Int0
, p
));
1134 eassert (INTEGERP (a
) && XINTPTR (a
) == p
);
1138 /* Type checking. */
1140 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
1141 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
1144 /* Deprecated and will be removed soon. */
1146 #define INTERNAL_FIELD(field) field ## _
1148 /* See the macros in intervals.h. */
1150 typedef struct interval
*INTERVAL
;
1152 struct GCALIGNED Lisp_Cons
1154 /* Car of this cons cell. */
1159 /* Cdr of this cons cell. */
1162 /* Used to chain conses on a free list. */
1163 struct Lisp_Cons
*chain
;
1167 /* Take the car or cdr of something known to be a cons cell. */
1168 /* The _addr functions shouldn't be used outside of the minimal set
1169 of code that has to know what a cons cell looks like. Other code not
1170 part of the basic lisp implementation should assume that the car and cdr
1171 fields are not accessible. (What if we want to switch to
1172 a copying collector someday? Cached cons cell field addresses may be
1173 invalidated at arbitrary points.) */
1174 INLINE Lisp_Object
*
1175 xcar_addr (Lisp_Object c
)
1177 return &XCONS (c
)->car
;
1179 INLINE Lisp_Object
*
1180 xcdr_addr (Lisp_Object c
)
1182 return &XCONS (c
)->u
.cdr
;
1185 /* Use these from normal code. */
1186 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
1187 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
1189 /* Use these to set the fields of a cons cell.
1191 Note that both arguments may refer to the same object, so 'n'
1192 should not be read after 'c' is first modified. */
1194 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1199 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1204 /* Take the car or cdr of something whose type is not known. */
1208 return (CONSP (c
) ? XCAR (c
)
1210 : wrong_type_argument (Qlistp
, c
));
1215 return (CONSP (c
) ? XCDR (c
)
1217 : wrong_type_argument (Qlistp
, c
));
1220 /* Take the car or cdr of something whose type is not known. */
1222 CAR_SAFE (Lisp_Object c
)
1224 return CONSP (c
) ? XCAR (c
) : Qnil
;
1227 CDR_SAFE (Lisp_Object c
)
1229 return CONSP (c
) ? XCDR (c
) : Qnil
;
1232 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1234 struct GCALIGNED Lisp_String
1237 ptrdiff_t size_byte
;
1238 INTERVAL intervals
; /* Text properties in this string. */
1239 unsigned char *data
;
1242 /* True if STR is a multibyte string. */
1244 STRING_MULTIBYTE (Lisp_Object str
)
1246 return 0 <= XSTRING (str
)->size_byte
;
1249 /* An upper bound on the number of bytes in a Lisp string, not
1250 counting the terminating null. This a tight enough bound to
1251 prevent integer overflow errors that would otherwise occur during
1252 string size calculations. A string cannot contain more bytes than
1253 a fixnum can represent, nor can it be so long that C pointer
1254 arithmetic stops working on the string plus its terminating null.
1255 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1256 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1257 would expose alloc.c internal details that we'd rather keep
1260 This is a macro for use in static initializers. The cast to
1261 ptrdiff_t ensures that the macro is signed. */
1262 #define STRING_BYTES_BOUND \
1263 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1265 /* Mark STR as a unibyte string. */
1266 #define STRING_SET_UNIBYTE(STR) \
1268 if (EQ (STR, empty_multibyte_string)) \
1269 (STR) = empty_unibyte_string; \
1271 XSTRING (STR)->size_byte = -1; \
1274 /* Mark STR as a multibyte string. Assure that STR contains only
1275 ASCII characters in advance. */
1276 #define STRING_SET_MULTIBYTE(STR) \
1278 if (EQ (STR, empty_unibyte_string)) \
1279 (STR) = empty_multibyte_string; \
1281 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1284 /* Convenience functions for dealing with Lisp strings. */
1286 INLINE
unsigned char *
1287 SDATA (Lisp_Object string
)
1289 return XSTRING (string
)->data
;
1292 SSDATA (Lisp_Object string
)
1294 /* Avoid "differ in sign" warnings. */
1295 return (char *) SDATA (string
);
1297 INLINE
unsigned char
1298 SREF (Lisp_Object string
, ptrdiff_t index
)
1300 return SDATA (string
)[index
];
1303 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1305 SDATA (string
)[index
] = new;
1308 SCHARS (Lisp_Object string
)
1310 return XSTRING (string
)->size
;
1313 #ifdef GC_CHECK_STRING_BYTES
1314 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1317 STRING_BYTES (struct Lisp_String
*s
)
1319 #ifdef GC_CHECK_STRING_BYTES
1320 return string_bytes (s
);
1322 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1327 SBYTES (Lisp_Object string
)
1329 return STRING_BYTES (XSTRING (string
));
1332 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1334 XSTRING (string
)->size
= newsize
;
1337 /* Header of vector-like objects. This documents the layout constraints on
1338 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1339 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1340 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1341 because when two such pointers potentially alias, a compiler won't
1342 incorrectly reorder loads and stores to their size fields. See
1344 struct vectorlike_header
1346 /* The only field contains various pieces of information:
1347 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1348 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1349 vector (0) or a pseudovector (1).
1350 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1351 of slots) of the vector.
1352 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1353 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1354 - b) number of Lisp_Objects slots at the beginning of the object
1355 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1357 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1358 measured in word_size units. Rest fields may also include
1359 Lisp_Objects, but these objects usually needs some special treatment
1361 There are some exceptions. For PVEC_FREE, b) is always zero. For
1362 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1363 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1364 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1368 /* A regular vector is just a header plus an array of Lisp_Objects. */
1372 struct vectorlike_header header
;
1373 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1376 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1379 ALIGNOF_STRUCT_LISP_VECTOR
1380 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1383 /* A boolvector is a kind of vectorlike, with contents like a string. */
1385 struct Lisp_Bool_Vector
1387 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1388 just the subtype information. */
1389 struct vectorlike_header header
;
1390 /* This is the size in bits. */
1392 /* The actual bits, packed into bytes.
1393 Zeros fill out the last word if needed.
1394 The bits are in little-endian order in the bytes, and
1395 the bytes are in little-endian order in the words. */
1396 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1400 bool_vector_size (Lisp_Object a
)
1402 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1403 eassume (0 <= size
);
1408 bool_vector_data (Lisp_Object a
)
1410 return XBOOL_VECTOR (a
)->data
;
1413 INLINE
unsigned char *
1414 bool_vector_uchar_data (Lisp_Object a
)
1416 return (unsigned char *) bool_vector_data (a
);
1419 /* The number of data words and bytes in a bool vector with SIZE bits. */
1422 bool_vector_words (EMACS_INT size
)
1424 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1425 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1429 bool_vector_bytes (EMACS_INT size
)
1431 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1432 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1435 /* True if A's Ith bit is set. */
1438 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1440 eassume (0 <= i
&& i
< bool_vector_size (a
));
1441 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1442 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1446 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1448 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1451 /* Set A's Ith bit to B. */
1454 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1456 unsigned char *addr
;
1458 eassume (0 <= i
&& i
< bool_vector_size (a
));
1459 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1462 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1464 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1467 /* Some handy constants for calculating sizes
1468 and offsets, mostly of vectorlike objects. */
1472 header_size
= offsetof (struct Lisp_Vector
, contents
),
1473 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1474 word_size
= sizeof (Lisp_Object
)
1477 /* Conveniences for dealing with Lisp arrays. */
1480 AREF (Lisp_Object array
, ptrdiff_t idx
)
1482 return XVECTOR (array
)->contents
[idx
];
1485 INLINE Lisp_Object
*
1486 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1488 return & XVECTOR (array
)->contents
[idx
];
1492 ASIZE (Lisp_Object array
)
1494 return XVECTOR (array
)->header
.size
;
1498 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1500 eassert (0 <= idx
&& idx
< ASIZE (array
));
1501 XVECTOR (array
)->contents
[idx
] = val
;
1505 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1507 /* Like ASET, but also can be used in the garbage collector:
1508 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1509 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
1510 XVECTOR (array
)->contents
[idx
] = val
;
1513 /* True, since Qnil's representation is zero. Every place in the code
1514 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1515 to find such assumptions later if we change Qnil to be nonzero. */
1516 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1518 /* Clear the object addressed by P, with size NBYTES, so that all its
1519 bytes are zero and all its Lisp values are nil. */
1521 memclear (void *p
, ptrdiff_t nbytes
)
1523 eassert (0 <= nbytes
);
1524 verify (NIL_IS_ZERO
);
1525 /* Since Qnil is zero, memset suffices. */
1526 memset (p
, 0, nbytes
);
1529 /* If a struct is made to look like a vector, this macro returns the length
1530 of the shortest vector that would hold that struct. */
1532 #define VECSIZE(type) \
1533 ((sizeof (type) - header_size + word_size - 1) / word_size)
1535 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1536 at the end and we need to compute the number of Lisp_Object fields (the
1537 ones that the GC needs to trace). */
1539 #define PSEUDOVECSIZE(type, nonlispfield) \
1540 ((offsetof (type, nonlispfield) - header_size) / word_size)
1542 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1543 should be integer expressions. This is not the same as
1544 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1545 returns true. For efficiency, prefer plain unsigned comparison if A
1546 and B's sizes both fit (after integer promotion). */
1547 #define UNSIGNED_CMP(a, op, b) \
1548 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1549 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1550 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1552 /* True iff C is an ASCII character. */
1553 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1555 /* A char-table is a kind of vectorlike, with contents are like a
1556 vector but with a few other slots. For some purposes, it makes
1557 sense to handle a char-table with type struct Lisp_Vector. An
1558 element of a char table can be any Lisp objects, but if it is a sub
1559 char-table, we treat it a table that contains information of a
1560 specific range of characters. A sub char-table is like a vector but
1561 with two integer fields between the header and Lisp data, which means
1562 that it has to be marked with some precautions (see mark_char_table
1563 in alloc.c). A sub char-table appears only in an element of a char-table,
1564 and there's no way to access it directly from Emacs Lisp program. */
1566 enum CHARTAB_SIZE_BITS
1568 CHARTAB_SIZE_BITS_0
= 6,
1569 CHARTAB_SIZE_BITS_1
= 4,
1570 CHARTAB_SIZE_BITS_2
= 5,
1571 CHARTAB_SIZE_BITS_3
= 7
1574 extern const int chartab_size
[4];
1576 struct Lisp_Char_Table
1578 /* HEADER.SIZE is the vector's size field, which also holds the
1579 pseudovector type information. It holds the size, too.
1580 The size counts the defalt, parent, purpose, ascii,
1581 contents, and extras slots. */
1582 struct vectorlike_header header
;
1584 /* This holds a default value,
1585 which is used whenever the value for a specific character is nil. */
1588 /* This points to another char table, which we inherit from when the
1589 value for a specific character is nil. The `defalt' slot takes
1590 precedence over this. */
1593 /* This is a symbol which says what kind of use this char-table is
1595 Lisp_Object purpose
;
1597 /* The bottom sub char-table for characters of the range 0..127. It
1598 is nil if none of ASCII character has a specific value. */
1601 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1603 /* These hold additional data. It is a vector. */
1604 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1607 struct Lisp_Sub_Char_Table
1609 /* HEADER.SIZE is the vector's size field, which also holds the
1610 pseudovector type information. It holds the size, too. */
1611 struct vectorlike_header header
;
1613 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1614 char-table of depth 1 contains 16 elements, and each element
1615 covers 4096 (128*32) characters. A sub char-table of depth 2
1616 contains 32 elements, and each element covers 128 characters. A
1617 sub char-table of depth 3 contains 128 elements, and each element
1618 is for one character. */
1621 /* Minimum character covered by the sub char-table. */
1624 /* Use set_sub_char_table_contents to set this. */
1625 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1629 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1631 struct Lisp_Char_Table
*tbl
= NULL
;
1635 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1636 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1637 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1641 while (NILP (val
) && ! NILP (tbl
->parent
));
1646 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1647 characters. Do not check validity of CT. */
1649 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1651 return (ASCII_CHAR_P (idx
)
1652 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1653 : char_table_ref (ct
, idx
));
1656 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1657 8-bit European characters. Do not check validity of CT. */
1659 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1661 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1662 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1664 char_table_set (ct
, idx
, val
);
1667 /* This structure describes a built-in function.
1668 It is generated by the DEFUN macro only.
1669 defsubr makes it into a Lisp object. */
1673 struct vectorlike_header header
;
1675 Lisp_Object (*a0
) (void);
1676 Lisp_Object (*a1
) (Lisp_Object
);
1677 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1678 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1679 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1680 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1681 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1682 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1683 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1684 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1685 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1687 short min_args
, max_args
;
1688 const char *symbol_name
;
1689 const char *intspec
;
1693 enum char_table_specials
1695 /* This is the number of slots that every char table must have. This
1696 counts the ordinary slots and the top, defalt, parent, and purpose
1698 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1700 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1701 when the latter is treated as an ordinary Lisp_Vector. */
1702 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1705 /* Return the number of "extra" slots in the char table CT. */
1708 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1710 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1711 - CHAR_TABLE_STANDARD_SLOTS
);
1714 /* Make sure that sub char-table contents slot is where we think it is. */
1715 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1716 == offsetof (struct Lisp_Vector
, contents
[SUB_CHAR_TABLE_OFFSET
]));
1718 /***********************************************************************
1720 ***********************************************************************/
1722 /* Value is name of symbol. */
1724 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1726 INLINE
struct Lisp_Symbol
*
1727 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1729 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1730 return sym
->val
.alias
;
1732 INLINE
struct Lisp_Buffer_Local_Value
*
1733 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1735 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1736 return sym
->val
.blv
;
1738 INLINE
union Lisp_Fwd
*
1739 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1741 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1742 return sym
->val
.fwd
;
1745 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1746 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1749 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1751 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1755 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1757 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1761 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1763 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1768 SYMBOL_NAME (Lisp_Object sym
)
1770 return XSYMBOL (sym
)->name
;
1773 /* Value is true if SYM is an interned symbol. */
1776 SYMBOL_INTERNED_P (Lisp_Object sym
)
1778 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1781 /* Value is true if SYM is interned in initial_obarray. */
1784 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1786 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1789 /* Value is non-zero if symbol is considered a constant, i.e. its
1790 value cannot be changed (there is an exception for keyword symbols,
1791 whose value can be set to the keyword symbol itself). */
1793 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1795 /* Placeholder for make-docfile to process. The actual symbol
1796 definition is done by lread.c's defsym. */
1797 #define DEFSYM(sym, name) /* empty */
1800 /***********************************************************************
1802 ***********************************************************************/
1804 /* The structure of a Lisp hash table. */
1806 struct hash_table_test
1808 /* Name of the function used to compare keys. */
1811 /* User-supplied hash function, or nil. */
1812 Lisp_Object user_hash_function
;
1814 /* User-supplied key comparison function, or nil. */
1815 Lisp_Object user_cmp_function
;
1817 /* C function to compare two keys. */
1818 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1820 /* C function to compute hash code. */
1821 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1824 struct Lisp_Hash_Table
1826 /* This is for Lisp; the hash table code does not refer to it. */
1827 struct vectorlike_header header
;
1829 /* Nil if table is non-weak. Otherwise a symbol describing the
1830 weakness of the table. */
1833 /* When the table is resized, and this is an integer, compute the
1834 new size by adding this to the old size. If a float, compute the
1835 new size by multiplying the old size with this factor. */
1836 Lisp_Object rehash_size
;
1838 /* Resize hash table when number of entries/ table size is >= this
1840 Lisp_Object rehash_threshold
;
1842 /* Vector of hash codes. If hash[I] is nil, this means that the
1843 I-th entry is unused. */
1846 /* Vector used to chain entries. If entry I is free, next[I] is the
1847 entry number of the next free item. If entry I is non-free,
1848 next[I] is the index of the next entry in the collision chain. */
1851 /* Index of first free entry in free list. */
1852 Lisp_Object next_free
;
1854 /* Bucket vector. A non-nil entry is the index of the first item in
1855 a collision chain. This vector's size can be larger than the
1856 hash table size to reduce collisions. */
1859 /* Only the fields above are traced normally by the GC. The ones below
1860 `count' are special and are either ignored by the GC or traced in
1861 a special way (e.g. because of weakness). */
1863 /* Number of key/value entries in the table. */
1866 /* Vector of keys and values. The key of item I is found at index
1867 2 * I, the value is found at index 2 * I + 1.
1868 This is gc_marked specially if the table is weak. */
1869 Lisp_Object key_and_value
;
1871 /* The comparison and hash functions. */
1872 struct hash_table_test test
;
1874 /* Next weak hash table if this is a weak hash table. The head
1875 of the list is in weak_hash_tables. */
1876 struct Lisp_Hash_Table
*next_weak
;
1880 INLINE
struct Lisp_Hash_Table
*
1881 XHASH_TABLE (Lisp_Object a
)
1883 return XUNTAG (a
, Lisp_Vectorlike
);
1886 #define XSET_HASH_TABLE(VAR, PTR) \
1887 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1890 HASH_TABLE_P (Lisp_Object a
)
1892 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1895 /* Value is the key part of entry IDX in hash table H. */
1897 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1899 return AREF (h
->key_and_value
, 2 * idx
);
1902 /* Value is the value part of entry IDX in hash table H. */
1904 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1906 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1909 /* Value is the index of the next entry following the one at IDX
1912 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1914 return AREF (h
->next
, idx
);
1917 /* Value is the hash code computed for entry IDX in hash table H. */
1919 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1921 return AREF (h
->hash
, idx
);
1924 /* Value is the index of the element in hash table H that is the
1925 start of the collision list at index IDX in the index vector of H. */
1927 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1929 return AREF (h
->index
, idx
);
1932 /* Value is the size of hash table H. */
1934 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1936 return ASIZE (h
->next
);
1939 /* Default size for hash tables if not specified. */
1941 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1943 /* Default threshold specifying when to resize a hash table. The
1944 value gives the ratio of current entries in the hash table and the
1945 size of the hash table. */
1947 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1949 /* Default factor by which to increase the size of a hash table. */
1951 static double const DEFAULT_REHASH_SIZE
= 1.5;
1953 /* Combine two integers X and Y for hashing. The result might not fit
1954 into a Lisp integer. */
1957 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1959 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1962 /* Hash X, returning a value that fits into a fixnum. */
1965 SXHASH_REDUCE (EMACS_UINT x
)
1967 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1970 /* These structures are used for various misc types. */
1972 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1974 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1975 bool_bf gcmarkbit
: 1;
1976 unsigned spacer
: 15;
1981 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1982 bool_bf gcmarkbit
: 1;
1983 unsigned spacer
: 13;
1984 /* This flag is temporarily used in the functions
1985 decode/encode_coding_object to record that the marker position
1986 must be adjusted after the conversion. */
1987 bool_bf need_adjustment
: 1;
1988 /* True means normal insertion at the marker's position
1989 leaves the marker after the inserted text. */
1990 bool_bf insertion_type
: 1;
1991 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1992 Note: a chain of markers can contain markers pointing into different
1993 buffers (the chain is per buffer_text rather than per buffer, so it's
1994 shared between indirect buffers). */
1995 /* This is used for (other than NULL-checking):
1997 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1998 - unchain_marker: to find the list from which to unchain.
1999 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2001 struct buffer
*buffer
;
2003 /* The remaining fields are meaningless in a marker that
2004 does not point anywhere. */
2006 /* For markers that point somewhere,
2007 this is used to chain of all the markers in a given buffer. */
2008 /* We could remove it and use an array in buffer_text instead.
2009 That would also allow to preserve it ordered. */
2010 struct Lisp_Marker
*next
;
2011 /* This is the char position where the marker points. */
2013 /* This is the byte position.
2014 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2015 used to implement the functionality of markers, but rather to (ab)use
2016 markers as a cache for char<->byte mappings). */
2020 /* START and END are markers in the overlay's buffer, and
2021 PLIST is the overlay's property list. */
2023 /* An overlay's real data content is:
2025 - buffer (really there are two buffer pointers, one per marker,
2026 and both points to the same buffer)
2027 - insertion type of both ends (per-marker fields)
2028 - start & start byte (of start marker)
2029 - end & end byte (of end marker)
2030 - next (singly linked list of overlays)
2031 - next fields of start and end markers (singly linked list of markers).
2032 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2035 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2036 bool_bf gcmarkbit
: 1;
2037 unsigned spacer
: 15;
2038 struct Lisp_Overlay
*next
;
2044 /* Types of data which may be saved in a Lisp_Save_Value. */
2055 /* Number of bits needed to store one of the above values. */
2056 enum { SAVE_SLOT_BITS
= 3 };
2058 /* Number of slots in a save value where save_type is nonzero. */
2059 enum { SAVE_VALUE_SLOTS
= 4 };
2061 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2063 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2067 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2068 SAVE_TYPE_INT_INT_INT
2069 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2070 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2071 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2072 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2073 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2074 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2075 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2076 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2077 SAVE_TYPE_FUNCPTR_PTR_OBJ
2078 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2080 /* This has an extra bit indicating it's raw memory. */
2081 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2084 /* Special object used to hold a different values for later use.
2086 This is mostly used to package C integers and pointers to call
2087 record_unwind_protect when two or more values need to be saved.
2091 struct my_data *md = get_my_data ();
2092 ptrdiff_t mi = get_my_integer ();
2093 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2096 Lisp_Object my_unwind (Lisp_Object arg)
2098 struct my_data *md = XSAVE_POINTER (arg, 0);
2099 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2103 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2104 saved objects and raise eassert if type of the saved object doesn't match
2105 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2106 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2107 slot 0 is a pointer. */
2109 typedef void (*voidfuncptr
) (void);
2111 struct Lisp_Save_Value
2113 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2114 bool_bf gcmarkbit
: 1;
2115 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2117 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2118 V's data entries are determined by V->save_type. E.g., if
2119 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2120 V->data[1] is an integer, and V's other data entries are unused.
2122 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2123 a memory area containing V->data[1].integer potential Lisp_Objects. */
2124 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2127 voidfuncptr funcpointer
;
2130 } data
[SAVE_VALUE_SLOTS
];
2133 /* Return the type of V's Nth saved value. */
2135 save_type (struct Lisp_Save_Value
*v
, int n
)
2137 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2138 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2141 /* Get and set the Nth saved pointer. */
2144 XSAVE_POINTER (Lisp_Object obj
, int n
)
2146 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2147 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2150 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2152 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2153 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2156 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2158 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2159 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2162 /* Likewise for the saved integer. */
2165 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2167 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2168 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2171 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2173 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2174 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2177 /* Extract Nth saved object. */
2180 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2182 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2183 return XSAVE_VALUE (obj
)->data
[n
].object
;
2186 /* A miscellaneous object, when it's on the free list. */
2189 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2190 bool_bf gcmarkbit
: 1;
2191 unsigned spacer
: 15;
2192 union Lisp_Misc
*chain
;
2195 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2196 It uses one of these struct subtypes to get the type field. */
2200 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2201 struct Lisp_Free u_free
;
2202 struct Lisp_Marker u_marker
;
2203 struct Lisp_Overlay u_overlay
;
2204 struct Lisp_Save_Value u_save_value
;
2207 INLINE
union Lisp_Misc
*
2208 XMISC (Lisp_Object a
)
2210 return XUNTAG (a
, Lisp_Misc
);
2213 INLINE
struct Lisp_Misc_Any
*
2214 XMISCANY (Lisp_Object a
)
2216 eassert (MISCP (a
));
2217 return & XMISC (a
)->u_any
;
2220 INLINE
enum Lisp_Misc_Type
2221 XMISCTYPE (Lisp_Object a
)
2223 return XMISCANY (a
)->type
;
2226 INLINE
struct Lisp_Marker
*
2227 XMARKER (Lisp_Object a
)
2229 eassert (MARKERP (a
));
2230 return & XMISC (a
)->u_marker
;
2233 INLINE
struct Lisp_Overlay
*
2234 XOVERLAY (Lisp_Object a
)
2236 eassert (OVERLAYP (a
));
2237 return & XMISC (a
)->u_overlay
;
2240 INLINE
struct Lisp_Save_Value
*
2241 XSAVE_VALUE (Lisp_Object a
)
2243 eassert (SAVE_VALUEP (a
));
2244 return & XMISC (a
)->u_save_value
;
2247 /* Forwarding pointer to an int variable.
2248 This is allowed only in the value cell of a symbol,
2249 and it means that the symbol's value really lives in the
2250 specified int variable. */
2253 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2257 /* Boolean forwarding pointer to an int variable.
2258 This is like Lisp_Intfwd except that the ostensible
2259 "value" of the symbol is t if the bool variable is true,
2260 nil if it is false. */
2263 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2267 /* Forwarding pointer to a Lisp_Object variable.
2268 This is allowed only in the value cell of a symbol,
2269 and it means that the symbol's value really lives in the
2270 specified variable. */
2273 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2274 Lisp_Object
*objvar
;
2277 /* Like Lisp_Objfwd except that value lives in a slot in the
2278 current buffer. Value is byte index of slot within buffer. */
2279 struct Lisp_Buffer_Objfwd
2281 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2283 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2284 Lisp_Object predicate
;
2287 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2288 the symbol has buffer-local or frame-local bindings. (Exception:
2289 some buffer-local variables are built-in, with their values stored
2290 in the buffer structure itself. They are handled differently,
2291 using struct Lisp_Buffer_Objfwd.)
2293 The `realvalue' slot holds the variable's current value, or a
2294 forwarding pointer to where that value is kept. This value is the
2295 one that corresponds to the loaded binding. To read or set the
2296 variable, you must first make sure the right binding is loaded;
2297 then you can access the value in (or through) `realvalue'.
2299 `buffer' and `frame' are the buffer and frame for which the loaded
2300 binding was found. If those have changed, to make sure the right
2301 binding is loaded it is necessary to find which binding goes with
2302 the current buffer and selected frame, then load it. To load it,
2303 first unload the previous binding, then copy the value of the new
2304 binding into `realvalue' (or through it). Also update
2305 LOADED-BINDING to point to the newly loaded binding.
2307 `local_if_set' indicates that merely setting the variable creates a
2308 local binding for the current buffer. Otherwise the latter, setting
2309 the variable does not do that; only make-local-variable does that. */
2311 struct Lisp_Buffer_Local_Value
2313 /* True means that merely setting the variable creates a local
2314 binding for the current buffer. */
2315 bool_bf local_if_set
: 1;
2316 /* True means this variable can have frame-local bindings, otherwise, it is
2317 can have buffer-local bindings. The two cannot be combined. */
2318 bool_bf frame_local
: 1;
2319 /* True means that the binding now loaded was found.
2320 Presumably equivalent to (defcell!=valcell). */
2322 /* If non-NULL, a forwarding to the C var where it should also be set. */
2323 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2324 /* The buffer or frame for which the loaded binding was found. */
2326 /* A cons cell that holds the default value. It has the form
2327 (SYMBOL . DEFAULT-VALUE). */
2328 Lisp_Object defcell
;
2329 /* The cons cell from `where's parameter alist.
2330 It always has the form (SYMBOL . VALUE)
2331 Note that if `forward' is non-nil, VALUE may be out of date.
2332 Also if the currently loaded binding is the default binding, then
2333 this is `eq'ual to defcell. */
2334 Lisp_Object valcell
;
2337 /* Like Lisp_Objfwd except that value lives in a slot in the
2339 struct Lisp_Kboard_Objfwd
2341 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2347 struct Lisp_Intfwd u_intfwd
;
2348 struct Lisp_Boolfwd u_boolfwd
;
2349 struct Lisp_Objfwd u_objfwd
;
2350 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2351 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2354 INLINE
enum Lisp_Fwd_Type
2355 XFWDTYPE (union Lisp_Fwd
*a
)
2357 return a
->u_intfwd
.type
;
2360 INLINE
struct Lisp_Buffer_Objfwd
*
2361 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2363 eassert (BUFFER_OBJFWDP (a
));
2364 return &a
->u_buffer_objfwd
;
2367 /* Lisp floating point type. */
2373 struct Lisp_Float
*chain
;
2378 XFLOAT_DATA (Lisp_Object f
)
2380 return XFLOAT (f
)->u
.data
;
2383 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2384 representations, have infinities and NaNs, and do not trap on
2385 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2386 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2387 wanted here, but is not quite right because Emacs does not require
2388 all the features of C11 Annex F (and does not require C11 at all,
2389 for that matter). */
2393 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2394 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2397 /* A character, declared with the following typedef, is a member
2398 of some character set associated with the current buffer. */
2399 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2401 typedef unsigned char UCHAR
;
2404 /* Meanings of slots in a Lisp_Compiled: */
2408 COMPILED_ARGLIST
= 0,
2409 COMPILED_BYTECODE
= 1,
2410 COMPILED_CONSTANTS
= 2,
2411 COMPILED_STACK_DEPTH
= 3,
2412 COMPILED_DOC_STRING
= 4,
2413 COMPILED_INTERACTIVE
= 5
2416 /* Flag bits in a character. These also get used in termhooks.h.
2417 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2418 (MUlti-Lingual Emacs) might need 22 bits for the character value
2419 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2422 CHAR_ALT
= 0x0400000,
2423 CHAR_SUPER
= 0x0800000,
2424 CHAR_HYPER
= 0x1000000,
2425 CHAR_SHIFT
= 0x2000000,
2426 CHAR_CTL
= 0x4000000,
2427 CHAR_META
= 0x8000000,
2429 CHAR_MODIFIER_MASK
=
2430 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2432 /* Actually, the current Emacs uses 22 bits for the character value
2437 /* Data type checking. */
2439 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2442 NUMBERP (Lisp_Object x
)
2444 return INTEGERP (x
) || FLOATP (x
);
2447 NATNUMP (Lisp_Object x
)
2449 return INTEGERP (x
) && 0 <= XINT (x
);
2453 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2455 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2458 #define TYPE_RANGED_INTEGERP(type, x) \
2460 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2461 && XINT (x) <= TYPE_MAXIMUM (type))
2463 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2464 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2465 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2466 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2467 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2468 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2469 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2472 STRINGP (Lisp_Object x
)
2474 return XTYPE (x
) == Lisp_String
;
2477 VECTORP (Lisp_Object x
)
2479 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2482 OVERLAYP (Lisp_Object x
)
2484 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2487 SAVE_VALUEP (Lisp_Object x
)
2489 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2493 AUTOLOADP (Lisp_Object x
)
2495 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2499 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2501 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2505 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2507 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2508 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2511 /* True if A is a pseudovector whose code is CODE. */
2513 PSEUDOVECTORP (Lisp_Object a
, int code
)
2515 if (! VECTORLIKEP (a
))
2519 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2520 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2521 return PSEUDOVECTOR_TYPEP (h
, code
);
2526 /* Test for specific pseudovector types. */
2529 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2531 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2535 PROCESSP (Lisp_Object a
)
2537 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2541 WINDOWP (Lisp_Object a
)
2543 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2547 TERMINALP (Lisp_Object a
)
2549 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2553 SUBRP (Lisp_Object a
)
2555 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2559 COMPILEDP (Lisp_Object a
)
2561 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2565 BUFFERP (Lisp_Object a
)
2567 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2571 CHAR_TABLE_P (Lisp_Object a
)
2573 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2577 SUB_CHAR_TABLE_P (Lisp_Object a
)
2579 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2583 BOOL_VECTOR_P (Lisp_Object a
)
2585 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2589 FRAMEP (Lisp_Object a
)
2591 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2594 /* Test for image (image . spec) */
2596 IMAGEP (Lisp_Object x
)
2598 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2603 ARRAYP (Lisp_Object x
)
2605 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2609 CHECK_LIST (Lisp_Object x
)
2611 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2614 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2615 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2616 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2619 CHECK_STRING (Lisp_Object x
)
2621 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2624 CHECK_STRING_CAR (Lisp_Object x
)
2626 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2629 CHECK_CONS (Lisp_Object x
)
2631 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2634 CHECK_VECTOR (Lisp_Object x
)
2636 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2639 CHECK_BOOL_VECTOR (Lisp_Object x
)
2641 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2643 /* This is a bit special because we always need size afterwards. */
2645 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2651 wrong_type_argument (Qarrayp
, x
);
2654 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2656 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2659 CHECK_BUFFER (Lisp_Object x
)
2661 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2664 CHECK_WINDOW (Lisp_Object x
)
2666 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2670 CHECK_PROCESS (Lisp_Object x
)
2672 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2676 CHECK_NATNUM (Lisp_Object x
)
2678 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2681 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2684 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2685 args_out_of_range_3 \
2687 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2688 ? MOST_NEGATIVE_FIXNUM \
2690 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2692 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2694 if (TYPE_SIGNED (type)) \
2695 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2697 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2700 #define CHECK_NUMBER_COERCE_MARKER(x) \
2702 if (MARKERP ((x))) \
2703 XSETFASTINT (x, marker_position (x)); \
2705 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2709 XFLOATINT (Lisp_Object n
)
2711 return extract_float (n
);
2715 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2717 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2720 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2723 XSETFASTINT (x, marker_position (x)); \
2725 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2728 /* Since we can't assign directly to the CAR or CDR fields of a cons
2729 cell, use these when checking that those fields contain numbers. */
2731 CHECK_NUMBER_CAR (Lisp_Object x
)
2733 Lisp_Object tmp
= XCAR (x
);
2739 CHECK_NUMBER_CDR (Lisp_Object x
)
2741 Lisp_Object tmp
= XCDR (x
);
2746 /* Define a built-in function for calling from Lisp.
2747 `lname' should be the name to give the function in Lisp,
2748 as a null-terminated C string.
2749 `fnname' should be the name of the function in C.
2750 By convention, it starts with F.
2751 `sname' should be the name for the C constant structure
2752 that records information on this function for internal use.
2753 By convention, it should be the same as `fnname' but with S instead of F.
2754 It's too bad that C macros can't compute this from `fnname'.
2755 `minargs' should be a number, the minimum number of arguments allowed.
2756 `maxargs' should be a number, the maximum number of arguments allowed,
2757 or else MANY or UNEVALLED.
2758 MANY means pass a vector of evaluated arguments,
2759 in the form of an integer number-of-arguments
2760 followed by the address of a vector of Lisp_Objects
2761 which contains the argument values.
2762 UNEVALLED means pass the list of unevaluated arguments
2763 `intspec' says how interactive arguments are to be fetched.
2764 If the string starts with a `(', `intspec' is evaluated and the resulting
2765 list is the list of arguments.
2766 If it's a string that doesn't start with `(', the value should follow
2767 the one of the doc string for `interactive'.
2768 A null string means call interactively with no arguments.
2769 `doc' is documentation for the user. */
2771 /* This version of DEFUN declares a function prototype with the right
2772 arguments, so we can catch errors with maxargs at compile-time. */
2774 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2775 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2776 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2777 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2778 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2779 { (Lisp_Object (__cdecl *)(void))fnname }, \
2780 minargs, maxargs, lname, intspec, 0}; \
2782 #else /* not _MSC_VER */
2783 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2784 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2785 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2786 { .a ## maxargs = fnname }, \
2787 minargs, maxargs, lname, intspec, 0}; \
2791 /* True if OBJ is a Lisp function. */
2793 FUNCTIONP (Lisp_Object obj
)
2795 return functionp (obj
);
2799 is how we define the symbol for function `name' at start-up time. */
2800 extern void defsubr (struct Lisp_Subr
*);
2808 /* Call a function F that accepts many args, passing it ARRAY's elements. */
2809 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
2811 /* Call a function F that accepts many args, passing it the remaining args,
2812 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
2813 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
2814 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
2815 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
2817 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2818 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2819 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2820 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2821 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2823 /* Macros we use to define forwarded Lisp variables.
2824 These are used in the syms_of_FILENAME functions.
2826 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2827 lisp variable is actually a field in `struct emacs_globals'. The
2828 field's name begins with "f_", which is a convention enforced by
2829 these macros. Each such global has a corresponding #define in
2830 globals.h; the plain name should be used in the code.
2832 E.g., the global "cons_cells_consed" is declared as "int
2833 f_cons_cells_consed" in globals.h, but there is a define:
2835 #define cons_cells_consed globals.f_cons_cells_consed
2837 All C code uses the `cons_cells_consed' name. This is all done
2838 this way to support indirection for multi-threaded Emacs. */
2840 #define DEFVAR_LISP(lname, vname, doc) \
2842 static struct Lisp_Objfwd o_fwd; \
2843 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2845 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2847 static struct Lisp_Objfwd o_fwd; \
2848 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2850 #define DEFVAR_BOOL(lname, vname, doc) \
2852 static struct Lisp_Boolfwd b_fwd; \
2853 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2855 #define DEFVAR_INT(lname, vname, doc) \
2857 static struct Lisp_Intfwd i_fwd; \
2858 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2861 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2863 static struct Lisp_Objfwd o_fwd; \
2864 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2867 #define DEFVAR_KBOARD(lname, vname, doc) \
2869 static struct Lisp_Kboard_Objfwd ko_fwd; \
2870 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2873 /* Save and restore the instruction and environment pointers,
2874 without affecting the signal mask. */
2877 typedef jmp_buf sys_jmp_buf
;
2878 # define sys_setjmp(j) _setjmp (j)
2879 # define sys_longjmp(j, v) _longjmp (j, v)
2880 #elif defined HAVE_SIGSETJMP
2881 typedef sigjmp_buf sys_jmp_buf
;
2882 # define sys_setjmp(j) sigsetjmp (j, 0)
2883 # define sys_longjmp(j, v) siglongjmp (j, v)
2885 /* A platform that uses neither _longjmp nor siglongjmp; assume
2886 longjmp does not affect the sigmask. */
2887 typedef jmp_buf sys_jmp_buf
;
2888 # define sys_setjmp(j) setjmp (j)
2889 # define sys_longjmp(j, v) longjmp (j, v)
2893 /* Elisp uses several stacks:
2895 - the bytecode stack: used internally by the bytecode interpreter.
2896 Allocated from the C stack.
2897 - The specpdl stack: keeps track of active unwind-protect and
2898 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2900 - The handler stack: keeps track of active catch tags and condition-case
2901 handlers. Allocated in a manually managed stack implemented by a
2902 doubly-linked list allocated via xmalloc and never freed. */
2904 /* Structure for recording Lisp call stack for backtrace purposes. */
2906 /* The special binding stack holds the outer values of variables while
2907 they are bound by a function application or a let form, stores the
2908 code to be executed for unwind-protect forms.
2910 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2911 used all over the place, needs to be fast, and needs to know the size of
2912 union specbinding. But only eval.c should access it. */
2915 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2916 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2917 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2918 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2919 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2920 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2921 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2922 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2923 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2928 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2930 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2931 void (*func
) (Lisp_Object
);
2935 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2936 void (*func
) (void *);
2940 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2945 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2946 void (*func
) (void);
2949 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2950 /* `where' is not used in the case of SPECPDL_LET. */
2951 Lisp_Object symbol
, old_value
, where
;
2954 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2955 bool_bf debug_on_exit
: 1;
2956 Lisp_Object function
;
2962 extern union specbinding
*specpdl
;
2963 extern union specbinding
*specpdl_ptr
;
2964 extern ptrdiff_t specpdl_size
;
2967 SPECPDL_INDEX (void)
2969 return specpdl_ptr
- specpdl
;
2972 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2973 control structures. A struct handler contains all the information needed to
2974 restore the state of the interpreter after a non-local jump.
2976 handler structures are chained together in a doubly linked list; the `next'
2977 member points to the next outer catchtag and the `nextfree' member points in
2978 the other direction to the next inner element (which is typically the next
2979 free element since we mostly use it on the deepest handler).
2981 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2982 member is TAG, and then unbinds to it. The `val' member is used to
2983 hold VAL while the stack is unwound; `val' is returned as the value
2986 All the other members are concerned with restoring the interpreter
2989 Members are volatile if their values need to survive _longjmp when
2990 a 'struct handler' is a local variable. */
2992 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2996 enum handlertype type
;
2997 Lisp_Object tag_or_ch
;
2999 struct handler
*next
;
3000 struct handler
*nextfree
;
3002 /* The bytecode interpreter can have several handlers active at the same
3003 time, so when we longjmp to one of them, it needs to know which handler
3004 this was and what was the corresponding internal state. This is stored
3005 here, and when we longjmp we make sure that handlerlist points to the
3007 Lisp_Object
*bytecode_top
;
3010 /* Most global vars are reset to their value via the specpdl mechanism,
3011 but a few others are handled by storing their value here. */
3012 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
3013 struct gcpro
*gcpro
;
3016 EMACS_INT lisp_eval_depth
;
3018 int poll_suppress_count
;
3019 int interrupt_input_blocked
;
3020 struct byte_stack
*byte_stack
;
3023 /* Fill in the components of c, and put it on the list. */
3024 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
3025 if (handlerlist->nextfree) \
3026 (c) = handlerlist->nextfree; \
3029 (c) = xmalloc (sizeof (struct handler)); \
3030 (c)->nextfree = NULL; \
3031 handlerlist->nextfree = (c); \
3033 (c)->type = (handlertype); \
3034 (c)->tag_or_ch = (tag_ch_val); \
3036 (c)->next = handlerlist; \
3037 (c)->lisp_eval_depth = lisp_eval_depth; \
3038 (c)->pdlcount = SPECPDL_INDEX (); \
3039 (c)->poll_suppress_count = poll_suppress_count; \
3040 (c)->interrupt_input_blocked = interrupt_input_blocked;\
3041 (c)->gcpro = gcprolist; \
3042 (c)->byte_stack = byte_stack_list; \
3046 extern Lisp_Object memory_signal_data
;
3048 /* An address near the bottom of the stack.
3049 Tells GC how to save a copy of the stack. */
3050 extern char *stack_bottom
;
3052 /* Check quit-flag and quit if it is non-nil.
3053 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
3054 So the program needs to do QUIT at times when it is safe to quit.
3055 Every loop that might run for a long time or might not exit
3056 ought to do QUIT at least once, at a safe place.
3057 Unless that is impossible, of course.
3058 But it is very desirable to avoid creating loops where QUIT is impossible.
3060 Exception: if you set immediate_quit to true,
3061 then the handler that responds to the C-g does the quit itself.
3062 This is a good thing to do around a loop that has no side effects
3063 and (in particular) cannot call arbitrary Lisp code.
3065 If quit-flag is set to `kill-emacs' the SIGINT handler has received
3066 a request to exit Emacs when it is safe to do. */
3068 extern void process_pending_signals (void);
3069 extern bool volatile pending_signals
;
3071 extern void process_quit_flag (void);
3074 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3075 process_quit_flag (); \
3076 else if (pending_signals) \
3077 process_pending_signals (); \
3081 /* True if ought to quit now. */
3083 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3085 extern Lisp_Object Vascii_downcase_table
;
3086 extern Lisp_Object Vascii_canon_table
;
3088 /* Structure for recording stack slots that need marking. */
3090 /* This is a chain of structures, each of which points at a Lisp_Object
3091 variable whose value should be marked in garbage collection.
3092 Normally every link of the chain is an automatic variable of a function,
3093 and its `val' points to some argument or local variable of the function.
3094 On exit to the function, the chain is set back to the value it had on entry.
3095 This way, no link remains in the chain when the stack frame containing the
3098 Every function that can call Feval must protect in this fashion all
3099 Lisp_Object variables whose contents will be used again. */
3101 extern struct gcpro
*gcprolist
;
3107 /* Address of first protected variable. */
3108 volatile Lisp_Object
*var
;
3110 /* Number of consecutive protected variables. */
3114 /* File name where this record is used. */
3117 /* Line number in this file. */
3120 /* Index in the local chain of records. */
3123 /* Nesting level. */
3128 /* Values of GC_MARK_STACK during compilation:
3130 0 Use GCPRO as before
3131 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
3132 2 Mark the stack, and check that everything GCPRO'd is
3134 3 Mark using GCPRO's, mark stack last, and count how many
3135 dead objects are kept alive.
3137 Formerly, method 0 was used. Currently, method 1 is used unless
3138 otherwise specified by hand when building, e.g.,
3139 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
3140 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
3142 #define GC_USE_GCPROS_AS_BEFORE 0
3143 #define GC_MAKE_GCPROS_NOOPS 1
3144 #define GC_MARK_STACK_CHECK_GCPROS 2
3145 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
3147 #ifndef GC_MARK_STACK
3148 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
3151 /* Whether we do the stack marking manually. */
3152 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
3153 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
3156 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
3158 /* Do something silly with gcproN vars just so gcc shuts up. */
3159 /* You get warnings from MIPSPro... */
3161 #define GCPRO1(varname) ((void) gcpro1)
3162 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
3163 #define GCPRO3(varname1, varname2, varname3) \
3164 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
3165 #define GCPRO4(varname1, varname2, varname3, varname4) \
3166 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3167 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3168 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3169 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3170 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
3172 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
3173 #define UNGCPRO ((void) 0)
3175 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3180 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3181 gcprolist = &gcpro1; }
3183 #define GCPRO2(a, b) \
3184 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3185 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3186 gcprolist = &gcpro2; }
3188 #define GCPRO3(a, b, c) \
3189 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3190 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3191 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3192 gcprolist = &gcpro3; }
3194 #define GCPRO4(a, b, c, d) \
3195 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3196 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3197 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3198 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3199 gcprolist = &gcpro4; }
3201 #define GCPRO5(a, b, c, d, e) \
3202 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3203 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3204 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3205 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3206 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3207 gcprolist = &gcpro5; }
3209 #define GCPRO6(a, b, c, d, e, f) \
3210 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3211 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3212 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3213 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3214 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3215 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3216 gcprolist = &gcpro6; }
3218 #define GCPRO7(a, b, c, d, e, f, g) \
3219 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3220 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3221 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3222 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3223 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3224 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3225 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3226 gcprolist = &gcpro7; }
3228 #define UNGCPRO (gcprolist = gcpro1.next)
3230 #else /* !DEBUG_GCPRO */
3232 extern int gcpro_level
;
3235 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3236 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3237 gcpro1.level = gcpro_level++; \
3238 gcprolist = &gcpro1; }
3240 #define GCPRO2(a, b) \
3241 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3242 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3243 gcpro1.level = gcpro_level; \
3244 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3245 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3246 gcpro2.level = gcpro_level++; \
3247 gcprolist = &gcpro2; }
3249 #define GCPRO3(a, b, c) \
3250 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3251 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3252 gcpro1.level = gcpro_level; \
3253 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3254 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3255 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3256 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3257 gcpro3.level = gcpro_level++; \
3258 gcprolist = &gcpro3; }
3260 #define GCPRO4(a, b, c, d) \
3261 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3262 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3263 gcpro1.level = gcpro_level; \
3264 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3265 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3266 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3267 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3268 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3269 gcpro4.name = __FILE__; gcpro4.lineno = __LINE__; gcpro4.idx = 4; \
3270 gcpro4.level = gcpro_level++; \
3271 gcprolist = &gcpro4; }
3273 #define GCPRO5(a, b, c, d, e) \
3274 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3275 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3276 gcpro1.level = gcpro_level; \
3277 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3278 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3279 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3280 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3281 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3282 gcpro4.name = __FILE__; gcpro4.lineno = __LINE__; gcpro4.idx = 4; \
3283 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3284 gcpro5.name = __FILE__; gcpro5.lineno = __LINE__; gcpro5.idx = 5; \
3285 gcpro5.level = gcpro_level++; \
3286 gcprolist = &gcpro5; }
3288 #define GCPRO6(a, b, c, d, e, f) \
3289 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3290 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3291 gcpro1.level = gcpro_level; \
3292 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3293 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3294 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3295 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3296 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3297 gcpro4.name = __FILE__; gcpro4.lineno = __LINE__; gcpro4.idx = 4; \
3298 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3299 gcpro5.name = __FILE__; gcpro5.lineno = __LINE__; gcpro5.idx = 5; \
3300 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3301 gcpro6.name = __FILE__; gcpro6.lineno = __LINE__; gcpro6.idx = 6; \
3302 gcpro6.level = gcpro_level++; \
3303 gcprolist = &gcpro6; }
3305 #define GCPRO7(a, b, c, d, e, f, g) \
3306 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3307 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3308 gcpro1.level = gcpro_level; \
3309 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3310 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3311 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3312 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3313 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3314 gcpro4.name = __FILE__; gcpro4.lineno = __LINE__; gcpro4.idx = 4; \
3315 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3316 gcpro5.name = __FILE__; gcpro5.lineno = __LINE__; gcpro5.idx = 5; \
3317 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3318 gcpro6.name = __FILE__; gcpro6.lineno = __LINE__; gcpro6.idx = 6; \
3319 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3320 gcpro7.name = __FILE__; gcpro7.lineno = __LINE__; gcpro7.idx = 7; \
3321 gcpro7.level = gcpro_level++; \
3322 gcprolist = &gcpro7; }
3325 (--gcpro_level != gcpro1.level \
3327 : (void) (gcprolist = gcpro1.next))
3329 #endif /* DEBUG_GCPRO */
3330 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3333 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
3334 #define RETURN_UNGCPRO(expr) \
3337 Lisp_Object ret_ungc_val; \
3338 ret_ungc_val = (expr); \
3340 return ret_ungc_val; \
3344 /* Call staticpro (&var) to protect static variable `var'. */
3346 void staticpro (Lisp_Object
*);
3348 /* Forward declarations for prototypes. */
3352 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3355 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3357 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3358 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3361 /* Functions to modify hash tables. */
3364 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3366 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3370 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3372 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3375 /* Use these functions to set Lisp_Object
3376 or pointer slots of struct Lisp_Symbol. */
3379 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3381 XSYMBOL (sym
)->function
= function
;
3385 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3387 XSYMBOL (sym
)->plist
= plist
;
3391 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3393 XSYMBOL (sym
)->next
= next
;
3396 /* Buffer-local (also frame-local) variable access functions. */
3399 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3401 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3405 /* Set overlay's property list. */
3408 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3410 XOVERLAY (overlay
)->plist
= plist
;
3413 /* Get text properties of S. */
3416 string_intervals (Lisp_Object s
)
3418 return XSTRING (s
)->intervals
;
3421 /* Set text properties of S to I. */
3424 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3426 XSTRING (s
)->intervals
= i
;
3429 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3430 of setting slots directly. */
3433 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3435 XCHAR_TABLE (table
)->defalt
= val
;
3438 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3440 XCHAR_TABLE (table
)->purpose
= val
;
3443 /* Set different slots in (sub)character tables. */
3446 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3448 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3449 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3453 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3455 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3456 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3460 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3462 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3465 /* Defined in data.c. */
3466 extern Lisp_Object
indirect_function (Lisp_Object
);
3467 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3468 enum Arith_Comparison
{
3473 ARITH_LESS_OR_EQUAL
,
3476 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3477 enum Arith_Comparison comparison
);
3479 /* Convert the integer I to an Emacs representation, either the integer
3480 itself, or a cons of two or three integers, or if all else fails a float.
3481 I should not have side effects. */
3482 #define INTEGER_TO_CONS(i) \
3483 (! FIXNUM_OVERFLOW_P (i) \
3485 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3486 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3487 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3488 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3489 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3490 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3491 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3492 ? Fcons (make_number ((i) >> 16 >> 24), \
3493 Fcons (make_number ((i) >> 16 & 0xffffff), \
3494 make_number ((i) & 0xffff))) \
3497 /* Convert the Emacs representation CONS back to an integer of type
3498 TYPE, storing the result the variable VAR. Signal an error if CONS
3499 is not a valid representation or is out of range for TYPE. */
3500 #define CONS_TO_INTEGER(cons, type, var) \
3501 (TYPE_SIGNED (type) \
3502 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3503 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3504 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3505 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3507 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3508 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3509 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3511 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3512 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3513 extern void syms_of_data (void);
3514 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3516 /* Defined in cmds.c */
3517 extern void syms_of_cmds (void);
3518 extern void keys_of_cmds (void);
3520 /* Defined in coding.c. */
3521 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3522 ptrdiff_t, bool, bool, Lisp_Object
);
3523 extern void init_coding (void);
3524 extern void init_coding_once (void);
3525 extern void syms_of_coding (void);
3527 /* Defined in character.c. */
3528 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3529 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3530 extern void syms_of_character (void);
3532 /* Defined in charset.c. */
3533 extern void init_charset (void);
3534 extern void init_charset_once (void);
3535 extern void syms_of_charset (void);
3536 /* Structure forward declarations. */
3539 /* Defined in syntax.c. */
3540 extern void init_syntax_once (void);
3541 extern void syms_of_syntax (void);
3543 /* Defined in fns.c. */
3544 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3545 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3546 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3547 extern void sweep_weak_hash_tables (void);
3548 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3549 EMACS_UINT
sxhash (Lisp_Object
, int);
3550 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3551 Lisp_Object
, Lisp_Object
);
3552 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3553 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3555 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3556 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3557 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3558 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3559 ptrdiff_t, ptrdiff_t);
3560 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3561 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3562 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3563 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3564 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3565 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3566 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3567 extern void clear_string_char_byte_cache (void);
3568 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3569 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3570 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3571 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3572 extern void syms_of_fns (void);
3574 /* Defined in floatfns.c. */
3575 extern void syms_of_floatfns (void);
3576 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3578 /* Defined in fringe.c. */
3579 extern void syms_of_fringe (void);
3580 extern void init_fringe (void);
3581 #ifdef HAVE_WINDOW_SYSTEM
3582 extern void mark_fringe_data (void);
3583 extern void init_fringe_once (void);
3584 #endif /* HAVE_WINDOW_SYSTEM */
3586 /* Defined in image.c. */
3587 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3588 extern void reset_image_types (void);
3589 extern void syms_of_image (void);
3591 /* Defined in insdel.c. */
3592 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3593 extern _Noreturn
void buffer_overflow (void);
3594 extern void make_gap (ptrdiff_t);
3595 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3596 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3597 ptrdiff_t, bool, bool);
3598 extern int count_combining_before (const unsigned char *,
3599 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3600 extern int count_combining_after (const unsigned char *,
3601 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3602 extern void insert (const char *, ptrdiff_t);
3603 extern void insert_and_inherit (const char *, ptrdiff_t);
3604 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3606 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3607 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3608 ptrdiff_t, ptrdiff_t, bool);
3609 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3610 extern void insert_char (int);
3611 extern void insert_string (const char *);
3612 extern void insert_before_markers (const char *, ptrdiff_t);
3613 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3614 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3615 ptrdiff_t, ptrdiff_t,
3617 extern void del_range (ptrdiff_t, ptrdiff_t);
3618 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3619 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3620 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3621 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3622 ptrdiff_t, ptrdiff_t, bool);
3623 extern void modify_text (ptrdiff_t, ptrdiff_t);
3624 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3625 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3626 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3627 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3628 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3629 ptrdiff_t, ptrdiff_t);
3630 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3631 ptrdiff_t, ptrdiff_t);
3632 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3633 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3634 const char *, ptrdiff_t, ptrdiff_t, bool);
3635 extern void syms_of_insdel (void);
3637 /* Defined in dispnew.c. */
3638 #if (defined PROFILING \
3639 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3640 _Noreturn
void __executable_start (void);
3642 extern Lisp_Object Vwindow_system
;
3643 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3645 /* Defined in xdisp.c. */
3646 extern bool noninteractive_need_newline
;
3647 extern Lisp_Object echo_area_buffer
[2];
3648 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3649 extern void check_message_stack (void);
3650 extern void setup_echo_area_for_printing (bool);
3651 extern bool push_message (void);
3652 extern void pop_message_unwind (void);
3653 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3654 extern void restore_message (void);
3655 extern Lisp_Object
current_message (void);
3656 extern void clear_message (bool, bool);
3657 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3658 extern void message1 (const char *);
3659 extern void message1_nolog (const char *);
3660 extern void message3 (Lisp_Object
);
3661 extern void message3_nolog (Lisp_Object
);
3662 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3663 extern void message_with_string (const char *, Lisp_Object
, bool);
3664 extern void message_log_maybe_newline (void);
3665 extern void update_echo_area (void);
3666 extern void truncate_echo_area (ptrdiff_t);
3667 extern void redisplay (void);
3669 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3670 extern void syms_of_xdisp (void);
3671 extern void init_xdisp (void);
3672 extern Lisp_Object
safe_eval (Lisp_Object
);
3673 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3674 int *, int *, int *, int *, int *);
3676 /* Defined in xsettings.c. */
3677 extern void syms_of_xsettings (void);
3679 /* Defined in vm-limit.c. */
3680 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3682 /* Defined in character.c. */
3683 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3684 ptrdiff_t *, ptrdiff_t *);
3686 /* Defined in alloc.c. */
3687 extern void check_pure_size (void);
3688 extern void free_misc (Lisp_Object
);
3689 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3690 extern void malloc_warning (const char *);
3691 extern _Noreturn
void memory_full (size_t);
3692 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3693 extern bool survives_gc_p (Lisp_Object
);
3694 extern void mark_object (Lisp_Object
);
3695 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3696 extern void refill_memory_reserve (void);
3698 extern const char *pending_malloc_warning
;
3699 extern Lisp_Object zero_vector
;
3700 extern Lisp_Object
*stack_base
;
3701 extern EMACS_INT consing_since_gc
;
3702 extern EMACS_INT gc_relative_threshold
;
3703 extern EMACS_INT memory_full_cons_threshold
;
3704 extern Lisp_Object
list1 (Lisp_Object
);
3705 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3706 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3707 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3708 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3710 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3711 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3713 /* Build a frequently used 2/3/4-integer lists. */
3716 list2i (EMACS_INT x
, EMACS_INT y
)
3718 return list2 (make_number (x
), make_number (y
));
3722 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3724 return list3 (make_number (x
), make_number (y
), make_number (w
));
3728 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3730 return list4 (make_number (x
), make_number (y
),
3731 make_number (w
), make_number (h
));
3734 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3735 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3736 extern _Noreturn
void string_overflow (void);
3737 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3738 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3739 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3740 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3742 /* Make unibyte string from C string when the length isn't known. */
3745 build_unibyte_string (const char *str
)
3747 return make_unibyte_string (str
, strlen (str
));
3750 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3751 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3752 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3753 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3754 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3755 extern Lisp_Object
make_specified_string (const char *,
3756 ptrdiff_t, ptrdiff_t, bool);
3757 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3758 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3760 /* Make a string allocated in pure space, use STR as string data. */
3763 build_pure_c_string (const char *str
)
3765 return make_pure_c_string (str
, strlen (str
));
3768 /* Make a string from the data at STR, treating it as multibyte if the
3772 build_string (const char *str
)
3774 return make_string (str
, strlen (str
));
3777 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3778 extern void make_byte_code (struct Lisp_Vector
*);
3779 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3781 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3782 be sure that GC cannot happen until the vector is completely
3783 initialized. E.g. the following code is likely to crash:
3785 v = make_uninit_vector (3);
3787 ASET (v, 1, Ffunction_can_gc ());
3788 ASET (v, 2, obj1); */
3791 make_uninit_vector (ptrdiff_t size
)
3794 struct Lisp_Vector
*p
;
3796 p
= allocate_vector (size
);
3801 /* Like above, but special for sub char-tables. */
3804 make_uninit_sub_char_table (int depth
, int min_char
)
3806 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3807 Lisp_Object v
= make_uninit_vector (slots
);
3809 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3810 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3811 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3815 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3818 /* Allocate partially initialized pseudovector where all Lisp_Object
3819 slots are set to Qnil but the rest (if any) is left uninitialized. */
3821 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3822 ((type *) allocate_pseudovector (VECSIZE (type), \
3823 PSEUDOVECSIZE (type, field), \
3824 PSEUDOVECSIZE (type, field), tag))
3826 /* Allocate fully initialized pseudovector where all Lisp_Object
3827 slots are set to Qnil and the rest (if any) is zeroed. */
3829 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3830 ((type *) allocate_pseudovector (VECSIZE (type), \
3831 PSEUDOVECSIZE (type, field), \
3832 VECSIZE (type), tag))
3834 extern bool gc_in_progress
;
3835 extern bool abort_on_gc
;
3836 extern Lisp_Object
make_float (double);
3837 extern void display_malloc_warning (void);
3838 extern ptrdiff_t inhibit_garbage_collection (void);
3839 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3840 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3841 Lisp_Object
, Lisp_Object
);
3842 extern Lisp_Object
make_save_ptr (void *);
3843 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3844 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3845 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3847 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3848 extern void free_save_value (Lisp_Object
);
3849 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3850 extern void free_marker (Lisp_Object
);
3851 extern void free_cons (struct Lisp_Cons
*);
3852 extern void init_alloc_once (void);
3853 extern void init_alloc (void);
3854 extern void syms_of_alloc (void);
3855 extern struct buffer
* allocate_buffer (void);
3856 extern int valid_lisp_object_p (Lisp_Object
);
3857 extern int relocatable_string_data_p (const char *);
3858 #ifdef GC_CHECK_CONS_LIST
3859 extern void check_cons_list (void);
3861 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3865 /* Defined in ralloc.c. */
3866 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3867 extern void r_alloc_free (void **);
3868 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3869 extern void r_alloc_reset_variable (void **, void **);
3870 extern void r_alloc_inhibit_buffer_relocation (int);
3873 /* Defined in chartab.c. */
3874 extern Lisp_Object
copy_char_table (Lisp_Object
);
3875 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3877 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3878 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3880 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3881 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3882 Lisp_Object
, Lisp_Object
,
3883 Lisp_Object
, struct charset
*,
3884 unsigned, unsigned);
3885 extern Lisp_Object
uniprop_table (Lisp_Object
);
3886 extern void syms_of_chartab (void);
3888 /* Defined in print.c. */
3889 extern Lisp_Object Vprin1_to_string_buffer
;
3890 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3891 extern void temp_output_buffer_setup (const char *);
3892 extern int print_level
;
3893 extern void write_string (const char *, int);
3894 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3896 extern Lisp_Object internal_with_output_to_temp_buffer
3897 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3898 #define FLOAT_TO_STRING_BUFSIZE 350
3899 extern int float_to_string (char *, double);
3900 extern void init_print_once (void);
3901 extern void syms_of_print (void);
3903 /* Defined in doprnt.c. */
3904 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3906 extern ptrdiff_t esprintf (char *, char const *, ...)
3907 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3908 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3910 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3911 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3912 char const *, va_list)
3913 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3915 /* Defined in lread.c. */
3916 extern Lisp_Object
check_obarray (Lisp_Object
);
3917 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3918 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3919 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3920 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3921 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3923 LOADHIST_ATTACH (Lisp_Object x
)
3926 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3928 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3929 Lisp_Object
*, Lisp_Object
, bool);
3930 extern Lisp_Object
string_to_number (char const *, int, bool);
3931 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3933 extern void dir_warning (const char *, Lisp_Object
);
3934 extern void init_obarray (void);
3935 extern void init_lread (void);
3936 extern void syms_of_lread (void);
3939 intern (const char *str
)
3941 return intern_1 (str
, strlen (str
));
3945 intern_c_string (const char *str
)
3947 return intern_c_string_1 (str
, strlen (str
));
3950 /* Defined in eval.c. */
3951 extern EMACS_INT lisp_eval_depth
;
3952 extern Lisp_Object Vautoload_queue
;
3953 extern Lisp_Object Vrun_hooks
;
3954 extern Lisp_Object Vsignaling_function
;
3955 extern Lisp_Object inhibit_lisp_code
;
3956 extern struct handler
*handlerlist
;
3958 /* To run a normal hook, use the appropriate function from the list below.
3959 The calling convention:
3961 if (!NILP (Vrun_hooks))
3962 call1 (Vrun_hooks, Qmy_funny_hook);
3964 should no longer be used. */
3965 extern void run_hook (Lisp_Object
);
3966 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3967 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3968 Lisp_Object (*funcall
)
3969 (ptrdiff_t nargs
, Lisp_Object
*args
));
3970 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3971 extern _Noreturn
void xsignal0 (Lisp_Object
);
3972 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3973 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3974 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3976 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3977 extern Lisp_Object
eval_sub (Lisp_Object form
);
3978 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3979 extern Lisp_Object
call0 (Lisp_Object
);
3980 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3981 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3982 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3983 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3984 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3985 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3986 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3987 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3988 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3989 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3990 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3991 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3992 extern Lisp_Object internal_condition_case_n
3993 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3994 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3995 extern void specbind (Lisp_Object
, Lisp_Object
);
3996 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3997 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3998 extern void record_unwind_protect_int (void (*) (int), int);
3999 extern void record_unwind_protect_void (void (*) (void));
4000 extern void record_unwind_protect_nothing (void);
4001 extern void clear_unwind_protect (ptrdiff_t);
4002 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
4003 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
4004 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
4005 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
4006 extern _Noreturn
void verror (const char *, va_list)
4007 ATTRIBUTE_FORMAT_PRINTF (1, 0);
4008 extern void un_autoload (Lisp_Object
);
4009 extern Lisp_Object
call_debugger (Lisp_Object arg
);
4010 extern void init_eval_once (void);
4011 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
4012 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
4013 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4014 extern void init_eval (void);
4015 extern void syms_of_eval (void);
4016 extern void unwind_body (Lisp_Object
);
4017 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
4018 extern void mark_specpdl (void);
4019 extern void get_backtrace (Lisp_Object array
);
4020 Lisp_Object
backtrace_top_function (void);
4021 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
4022 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
4025 /* Defined in editfns.c. */
4026 extern void insert1 (Lisp_Object
);
4027 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
4028 extern Lisp_Object
save_excursion_save (void);
4029 extern Lisp_Object
save_restriction_save (void);
4030 extern void save_excursion_restore (Lisp_Object
);
4031 extern void save_restriction_restore (Lisp_Object
);
4032 extern _Noreturn
void time_overflow (void);
4033 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
4034 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
4036 extern void init_editfns (void);
4037 extern void syms_of_editfns (void);
4039 /* Defined in buffer.c. */
4040 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
4041 extern _Noreturn
void nsberror (Lisp_Object
);
4042 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
4043 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
4044 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
4045 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
4046 Lisp_Object
, Lisp_Object
, Lisp_Object
);
4047 extern bool overlay_touches_p (ptrdiff_t);
4048 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
4049 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
4050 extern void init_buffer_once (void);
4051 extern void init_buffer (int);
4052 extern void syms_of_buffer (void);
4053 extern void keys_of_buffer (void);
4055 /* Defined in marker.c. */
4057 extern ptrdiff_t marker_position (Lisp_Object
);
4058 extern ptrdiff_t marker_byte_position (Lisp_Object
);
4059 extern void clear_charpos_cache (struct buffer
*);
4060 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
4061 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
4062 extern void unchain_marker (struct Lisp_Marker
*marker
);
4063 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4064 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
4065 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
4066 ptrdiff_t, ptrdiff_t);
4067 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
4068 extern void syms_of_marker (void);
4070 /* Defined in fileio.c. */
4072 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
4073 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4074 Lisp_Object
, Lisp_Object
, Lisp_Object
,
4076 extern void close_file_unwind (int);
4077 extern void fclose_unwind (void *);
4078 extern void restore_point_unwind (Lisp_Object
);
4079 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
4080 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
4081 extern bool internal_delete_file (Lisp_Object
);
4082 extern Lisp_Object
emacs_readlinkat (int, const char *);
4083 extern bool file_directory_p (const char *);
4084 extern bool file_accessible_directory_p (Lisp_Object
);
4085 extern void init_fileio (void);
4086 extern void syms_of_fileio (void);
4087 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
4089 /* Defined in search.c. */
4090 extern void shrink_regexp_cache (void);
4091 extern void restore_search_regs (void);
4092 extern void record_unwind_save_match_data (void);
4093 struct re_registers
;
4094 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4095 struct re_registers
*,
4096 Lisp_Object
, bool, bool);
4097 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
4101 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
4103 return fast_string_match_internal (regexp
, string
, Qnil
);
4107 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
4109 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
4112 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4114 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4115 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4116 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4117 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4118 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4120 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
4121 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4122 ptrdiff_t, ptrdiff_t *);
4123 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4124 ptrdiff_t, ptrdiff_t *);
4125 extern void syms_of_search (void);
4126 extern void clear_regexp_cache (void);
4128 /* Defined in minibuf.c. */
4130 extern Lisp_Object Vminibuffer_list
;
4131 extern Lisp_Object last_minibuf_string
;
4132 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4133 extern void init_minibuf_once (void);
4134 extern void syms_of_minibuf (void);
4136 /* Defined in callint.c. */
4138 extern void syms_of_callint (void);
4140 /* Defined in casefiddle.c. */
4142 extern void syms_of_casefiddle (void);
4143 extern void keys_of_casefiddle (void);
4145 /* Defined in casetab.c. */
4147 extern void init_casetab_once (void);
4148 extern void syms_of_casetab (void);
4150 /* Defined in keyboard.c. */
4152 extern Lisp_Object echo_message_buffer
;
4153 extern struct kboard
*echo_kboard
;
4154 extern void cancel_echoing (void);
4155 extern Lisp_Object last_undo_boundary
;
4156 extern bool input_pending
;
4157 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4158 extern sigjmp_buf return_to_command_loop
;
4160 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4161 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4162 extern void discard_mouse_events (void);
4164 void handle_input_available_signal (int);
4166 extern Lisp_Object pending_funcalls
;
4167 extern bool detect_input_pending (void);
4168 extern bool detect_input_pending_ignore_squeezables (void);
4169 extern bool detect_input_pending_run_timers (bool);
4170 extern void safe_run_hooks (Lisp_Object
);
4171 extern void cmd_error_internal (Lisp_Object
, const char *);
4172 extern Lisp_Object
command_loop_1 (void);
4173 extern Lisp_Object
read_menu_command (void);
4174 extern Lisp_Object
recursive_edit_1 (void);
4175 extern void record_auto_save (void);
4176 extern void force_auto_save_soon (void);
4177 extern void init_keyboard (void);
4178 extern void syms_of_keyboard (void);
4179 extern void keys_of_keyboard (void);
4181 /* Defined in indent.c. */
4182 extern ptrdiff_t current_column (void);
4183 extern void invalidate_current_column (void);
4184 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4185 extern void syms_of_indent (void);
4187 /* Defined in frame.c. */
4188 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4189 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4190 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4191 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4192 extern void frames_discard_buffer (Lisp_Object
);
4193 extern void syms_of_frame (void);
4195 /* Defined in emacs.c. */
4196 extern char **initial_argv
;
4197 extern int initial_argc
;
4198 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4199 extern bool display_arg
;
4201 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4202 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4203 extern _Noreturn
void terminate_due_to_signal (int, int);
4205 extern Lisp_Object Vlibrary_cache
;
4208 void fixup_locale (void);
4209 void synchronize_system_messages_locale (void);
4210 void synchronize_system_time_locale (void);
4212 INLINE
void fixup_locale (void) {}
4213 INLINE
void synchronize_system_messages_locale (void) {}
4214 INLINE
void synchronize_system_time_locale (void) {}
4216 extern void shut_down_emacs (int, Lisp_Object
);
4218 /* True means don't do interactive redisplay and don't change tty modes. */
4219 extern bool noninteractive
;
4221 /* True means remove site-lisp directories from load-path. */
4222 extern bool no_site_lisp
;
4224 /* Pipe used to send exit notification to the daemon parent at
4226 extern int daemon_pipe
[2];
4227 #define IS_DAEMON (daemon_pipe[1] != 0)
4229 /* True if handling a fatal error already. */
4230 extern bool fatal_error_in_progress
;
4232 /* True means don't do use window-system-specific display code. */
4233 extern bool inhibit_window_system
;
4234 /* True means that a filter or a sentinel is running. */
4235 extern bool running_asynch_code
;
4237 /* Defined in process.c. */
4238 extern void kill_buffer_processes (Lisp_Object
);
4239 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4240 struct Lisp_Process
*, int);
4241 /* Max value for the first argument of wait_reading_process_output. */
4242 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4243 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4244 The bug merely causes a bogus warning, but the warning is annoying. */
4245 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4247 # define WAIT_READING_MAX INTMAX_MAX
4250 extern void add_timer_wait_descriptor (int);
4252 extern void add_keyboard_wait_descriptor (int);
4253 extern void delete_keyboard_wait_descriptor (int);
4255 extern void add_gpm_wait_descriptor (int);
4256 extern void delete_gpm_wait_descriptor (int);
4258 extern void init_process_emacs (void);
4259 extern void syms_of_process (void);
4260 extern void setup_process_coding_systems (Lisp_Object
);
4262 /* Defined in callproc.c. */
4266 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4267 extern void init_callproc_1 (void);
4268 extern void init_callproc (void);
4269 extern void set_initial_environment (void);
4270 extern void syms_of_callproc (void);
4272 /* Defined in doc.c. */
4273 extern Lisp_Object
read_doc_string (Lisp_Object
);
4274 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4275 extern void syms_of_doc (void);
4276 extern int read_bytecode_char (bool);
4278 /* Defined in bytecode.c. */
4279 extern void syms_of_bytecode (void);
4280 extern struct byte_stack
*byte_stack_list
;
4282 extern void mark_byte_stack (void);
4284 extern void unmark_byte_stack (void);
4285 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4286 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4288 /* Defined in macros.c. */
4289 extern void init_macros (void);
4290 extern void syms_of_macros (void);
4292 /* Defined in undo.c. */
4293 extern void truncate_undo_list (struct buffer
*);
4294 extern void record_insert (ptrdiff_t, ptrdiff_t);
4295 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4296 extern void record_first_change (void);
4297 extern void record_change (ptrdiff_t, ptrdiff_t);
4298 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4299 Lisp_Object
, Lisp_Object
,
4301 extern void syms_of_undo (void);
4303 /* Defined in textprop.c. */
4304 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4306 /* Defined in menu.c. */
4307 extern void syms_of_menu (void);
4309 /* Defined in xmenu.c. */
4310 extern void syms_of_xmenu (void);
4312 /* Defined in termchar.h. */
4313 struct tty_display_info
;
4315 /* Defined in termhooks.h. */
4318 /* Defined in sysdep.c. */
4319 #ifndef HAVE_GET_CURRENT_DIR_NAME
4320 extern char *get_current_dir_name (void);
4322 extern void stuff_char (char c
);
4323 extern void init_foreground_group (void);
4324 extern void sys_subshell (void);
4325 extern void sys_suspend (void);
4326 extern void discard_tty_input (void);
4327 extern void init_sys_modes (struct tty_display_info
*);
4328 extern void reset_sys_modes (struct tty_display_info
*);
4329 extern void init_all_sys_modes (void);
4330 extern void reset_all_sys_modes (void);
4331 extern void child_setup_tty (int);
4332 extern void setup_pty (int);
4333 extern int set_window_size (int, int, int);
4334 extern EMACS_INT
get_random (void);
4335 extern void seed_random (void *, ptrdiff_t);
4336 extern void init_random (void);
4337 extern void emacs_backtrace (int);
4338 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4339 extern int emacs_open (const char *, int, int);
4340 extern int emacs_pipe (int[2]);
4341 extern int emacs_close (int);
4342 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4343 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4344 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4345 extern void emacs_perror (char const *);
4347 extern void unlock_all_files (void);
4348 extern void lock_file (Lisp_Object
);
4349 extern void unlock_file (Lisp_Object
);
4350 extern void unlock_buffer (struct buffer
*);
4351 extern void syms_of_filelock (void);
4352 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4354 /* Defined in sound.c. */
4355 extern void syms_of_sound (void);
4357 /* Defined in category.c. */
4358 extern void init_category_once (void);
4359 extern Lisp_Object
char_category_set (int);
4360 extern void syms_of_category (void);
4362 /* Defined in ccl.c. */
4363 extern void syms_of_ccl (void);
4365 /* Defined in dired.c. */
4366 extern void syms_of_dired (void);
4367 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4368 Lisp_Object
, Lisp_Object
,
4371 /* Defined in term.c. */
4372 extern int *char_ins_del_vector
;
4373 extern void syms_of_term (void);
4374 extern _Noreturn
void fatal (const char *msgid
, ...)
4375 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4377 /* Defined in terminal.c. */
4378 extern void syms_of_terminal (void);
4380 /* Defined in font.c. */
4381 extern void syms_of_font (void);
4382 extern void init_font (void);
4384 #ifdef HAVE_WINDOW_SYSTEM
4385 /* Defined in fontset.c. */
4386 extern void syms_of_fontset (void);
4389 /* Defined in gfilenotify.c */
4390 #ifdef HAVE_GFILENOTIFY
4391 extern void globals_of_gfilenotify (void);
4392 extern void syms_of_gfilenotify (void);
4395 /* Defined in inotify.c */
4397 extern void syms_of_inotify (void);
4400 #ifdef HAVE_W32NOTIFY
4401 /* Defined on w32notify.c. */
4402 extern void syms_of_w32notify (void);
4405 /* Defined in xfaces.c. */
4406 extern Lisp_Object Vface_alternative_font_family_alist
;
4407 extern Lisp_Object Vface_alternative_font_registry_alist
;
4408 extern void syms_of_xfaces (void);
4410 #ifdef HAVE_X_WINDOWS
4411 /* Defined in xfns.c. */
4412 extern void syms_of_xfns (void);
4414 /* Defined in xsmfns.c. */
4415 extern void syms_of_xsmfns (void);
4417 /* Defined in xselect.c. */
4418 extern void syms_of_xselect (void);
4420 /* Defined in xterm.c. */
4421 extern void init_xterm (void);
4422 extern void syms_of_xterm (void);
4423 #endif /* HAVE_X_WINDOWS */
4425 #ifdef HAVE_WINDOW_SYSTEM
4426 /* Defined in xterm.c, nsterm.m, w32term.c. */
4427 extern char *x_get_keysym_name (int);
4428 #endif /* HAVE_WINDOW_SYSTEM */
4431 /* Defined in xml.c. */
4432 extern void syms_of_xml (void);
4433 extern void xml_cleanup_parser (void);
4437 /* Defined in decompress.c. */
4438 extern void syms_of_decompress (void);
4442 /* Defined in dbusbind.c. */
4443 void init_dbusbind (void);
4444 void syms_of_dbusbind (void);
4448 /* Defined in profiler.c. */
4449 extern bool profiler_memory_running
;
4450 extern void malloc_probe (size_t);
4451 extern void syms_of_profiler (void);
4455 /* Defined in msdos.c, w32.c. */
4456 extern char *emacs_root_dir (void);
4459 /* Defined in lastfile.c. */
4460 extern char my_edata
[];
4461 extern char my_endbss
[];
4462 extern char *my_endbss_static
;
4464 /* True means ^G can quit instantly. */
4465 extern bool immediate_quit
;
4467 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4468 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4469 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4470 extern void xfree (void *);
4471 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4472 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4473 ATTRIBUTE_ALLOC_SIZE ((2,3));
4474 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4476 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4477 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4478 extern void dupstring (char **, char const *);
4480 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4481 null byte. This is like stpcpy, except the source is a Lisp string. */
4484 lispstpcpy (char *dest
, Lisp_Object string
)
4486 ptrdiff_t len
= SBYTES (string
);
4487 memcpy (dest
, SDATA (string
), len
+ 1);
4491 extern void xputenv (const char *);
4493 extern char *egetenv_internal (const char *, ptrdiff_t);
4496 egetenv (const char *var
)
4498 /* When VAR is a string literal, strlen can be optimized away. */
4499 return egetenv_internal (var
, strlen (var
));
4502 /* Set up the name of the machine we're running on. */
4503 extern void init_system_name (void);
4505 /* Return the absolute value of X. X should be a signed integer
4506 expression without side effects, and X's absolute value should not
4507 exceed the maximum for its promoted type. This is called 'eabs'
4508 because 'abs' is reserved by the C standard. */
4509 #define eabs(x) ((x) < 0 ? -(x) : (x))
4511 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4514 #define make_fixnum_or_float(val) \
4515 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4517 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4518 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4520 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4522 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4524 #define USE_SAFE_ALLOCA \
4525 ptrdiff_t sa_avail = MAX_ALLOCA; \
4526 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4528 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4530 /* SAFE_ALLOCA allocates a simple buffer. */
4532 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4533 ? AVAIL_ALLOCA (size) \
4534 : (sa_must_free = true, record_xmalloc (size)))
4536 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4537 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4538 positive. The code is tuned for MULTIPLIER being a constant. */
4540 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4542 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4543 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4546 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4547 sa_must_free = true; \
4548 record_unwind_protect_ptr (xfree, buf); \
4552 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4554 #define SAFE_ALLOCA_STRING(ptr, string) \
4556 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4557 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4560 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4562 #define SAFE_FREE() \
4564 if (sa_must_free) { \
4565 sa_must_free = false; \
4566 unbind_to (sa_count, Qnil); \
4571 /* Return floor (NBYTES / WORD_SIZE). */
4574 lisp_word_count (ptrdiff_t nbytes
)
4579 case 2: return nbytes
>> 1;
4580 case 4: return nbytes
>> 2;
4581 case 8: return nbytes
>> 3;
4582 case 16: return nbytes
>> 4;
4584 return nbytes
/ word_size
- (nbytes
% word_size
< 0);
4587 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4589 #define SAFE_ALLOCA_LISP(buf, nelt) \
4591 if ((nelt) <= lisp_word_count (sa_avail)) \
4592 (buf) = AVAIL_ALLOCA ((nelt) * word_size); \
4593 else if ((nelt) <= min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4596 (buf) = xmalloc ((nelt) * word_size); \
4597 arg_ = make_save_memory (buf, nelt); \
4598 sa_must_free = true; \
4599 record_unwind_protect (free_save_value, arg_); \
4602 memory_full (SIZE_MAX); \
4606 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4607 block-scoped conses and strings. These objects are not
4608 managed by the garbage collector, so they are dangerous: passing them
4609 out of their scope (e.g., to user code) results in undefined behavior.
4610 Conversely, they have better performance because GC is not involved.
4612 This feature is experimental and requires careful debugging.
4613 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4615 #ifndef USE_STACK_LISP_OBJECTS
4616 # define USE_STACK_LISP_OBJECTS true
4619 /* USE_STACK_LISP_OBJECTS requires GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS. */
4621 #if GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS
4622 # undef USE_STACK_LISP_OBJECTS
4623 # define USE_STACK_LISP_OBJECTS false
4626 #ifdef GC_CHECK_STRING_BYTES
4627 enum { defined_GC_CHECK_STRING_BYTES
= true };
4629 enum { defined_GC_CHECK_STRING_BYTES
= false };
4632 /* Struct inside unions that are typically no larger and aligned enough. */
4637 double d
; intmax_t i
; void *p
;
4640 union Aligned_String
4642 struct Lisp_String s
;
4643 double d
; intmax_t i
; void *p
;
4646 /* True for stack-based cons and string implementations, respectively.
4647 Use stack-based strings only if stack-based cons also works.
4648 Otherwise, STACK_CONS would create heap-based cons cells that
4649 could point to stack-based strings, which is a no-no. */
4653 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4654 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4655 USE_STACK_STRING
= (USE_STACK_CONS
4656 && !defined_GC_CHECK_STRING_BYTES
4657 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4660 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4661 use these only in macros like AUTO_CONS that declare a local
4662 variable whose lifetime will be clear to the programmer. */
4663 #define STACK_CONS(a, b) \
4664 make_lisp_ptr (&(union Aligned_Cons) { { a, { b } } }.s, Lisp_Cons)
4665 #define AUTO_CONS_EXPR(a, b) \
4666 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4668 /* Declare NAME as an auto Lisp cons or short list if possible, a
4669 GC-based one otherwise. This is in the sense of the C keyword
4670 'auto'; i.e., the object has the lifetime of the containing block.
4671 The resulting object should not be made visible to user Lisp code. */
4673 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4674 #define AUTO_LIST1(name, a) \
4675 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4676 #define AUTO_LIST2(name, a, b) \
4677 Lisp_Object name = (USE_STACK_CONS \
4678 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4680 #define AUTO_LIST3(name, a, b, c) \
4681 Lisp_Object name = (USE_STACK_CONS \
4682 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4684 #define AUTO_LIST4(name, a, b, c, d) \
4687 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4688 STACK_CONS (d, Qnil)))) \
4689 : list4 (a, b, c, d))
4691 /* Check whether stack-allocated strings are ASCII-only. */
4693 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
4694 extern const char *verify_ascii (const char *);
4696 # define verify_ascii(str) (str)
4699 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4700 Take its value from STR. STR is not necessarily copied and should
4701 contain only ASCII characters. The resulting Lisp string should
4702 not be modified or made visible to user code. */
4704 #define AUTO_STRING(name, str) \
4705 Lisp_Object name = \
4708 ((&(union Aligned_String) \
4709 {{strlen (str), -1, 0, (unsigned char *) verify_ascii (str)}}.s), \
4711 : build_string (verify_ascii (str)))
4713 /* Loop over all tails of a list, checking for cycles.
4714 FIXME: Make tortoise and n internal declarations.
4715 FIXME: Unroll the loop body so we don't need `n'. */
4716 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4717 for ((tortoise) = (hare) = (list), (n) = true; \
4719 (hare = XCDR (hare), (n) = !(n), \
4721 ? (EQ (hare, tortoise) \
4722 ? xsignal1 (Qcircular_list, list) \
4724 /* Move tortoise before the next iteration, in case */ \
4725 /* the next iteration does an Fsetcdr. */ \
4726 : (void) ((tortoise) = XCDR (tortoise)))))
4728 /* Do a `for' loop over alist values. */
4730 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4731 for ((list_var) = (head_var); \
4732 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4733 (list_var) = XCDR (list_var))
4735 /* Check whether it's time for GC, and run it if so. */
4740 if ((consing_since_gc
> gc_cons_threshold
4741 && consing_since_gc
> gc_relative_threshold
)
4742 || (!NILP (Vmemory_full
)
4743 && consing_since_gc
> memory_full_cons_threshold
))
4744 Fgarbage_collect ();
4748 functionp (Lisp_Object object
)
4750 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4752 object
= Findirect_function (object
, Qt
);
4754 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4756 /* Autoloaded symbols are functions, except if they load
4757 macros or keymaps. */
4759 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4760 object
= XCDR (object
);
4762 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4767 return XSUBR (object
)->max_args
!= UNEVALLED
;
4768 else if (COMPILEDP (object
))
4770 else if (CONSP (object
))
4772 Lisp_Object car
= XCAR (object
);
4773 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4781 #endif /* EMACS_LISP_H */