1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2014 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. */
48 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
49 # define DEFINE_GDB_SYMBOL_END(id) = id;
51 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
52 # define DEFINE_GDB_SYMBOL_END(val)
55 /* The ubiquitous max and min macros. */
58 #define max(a, b) ((a) > (b) ? (a) : (b))
59 #define min(a, b) ((a) < (b) ? (a) : (b))
61 /* Number of elements in an array. */
62 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
64 /* Number of bits in a Lisp_Object tag. */
65 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
67 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
69 /* The number of bits needed in an EMACS_INT over and above the number
70 of bits in a pointer. This is 0 on systems where:
71 1. We can specify multiple-of-8 alignment on static variables.
72 2. We know malloc returns a multiple of 8. */
73 #if (defined alignas \
74 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
75 || defined DARWIN_OS || defined __sun || defined __MINGW32__ \
77 # define NONPOINTER_BITS 0
79 # define NONPOINTER_BITS GCTYPEBITS
82 /* EMACS_INT - signed integer wide enough to hold an Emacs value
83 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
84 pI - printf length modifier for EMACS_INT
85 EMACS_UINT - unsigned variant of EMACS_INT */
88 # error "INTPTR_MAX misconfigured"
89 # elif INTPTR_MAX <= INT_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
90 typedef int EMACS_INT
;
91 typedef unsigned int EMACS_UINT
;
92 # define EMACS_INT_MAX INT_MAX
94 # elif INTPTR_MAX <= LONG_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
95 typedef long int EMACS_INT
;
96 typedef unsigned long EMACS_UINT
;
97 # define EMACS_INT_MAX LONG_MAX
99 /* Check versus LLONG_MAX, not LLONG_MAX >> NONPOINTER_BITS.
100 In theory this is not safe, but in practice it seems to be OK. */
101 # elif INTPTR_MAX <= LLONG_MAX
102 typedef long long int EMACS_INT
;
103 typedef unsigned long long int EMACS_UINT
;
104 # define EMACS_INT_MAX LLONG_MAX
107 # error "INTPTR_MAX too large"
111 /* Number of bits to put in each character in the internal representation
112 of bool vectors. This should not vary across implementations. */
113 enum { BOOL_VECTOR_BITS_PER_CHAR
=
114 #define BOOL_VECTOR_BITS_PER_CHAR 8
115 BOOL_VECTOR_BITS_PER_CHAR
118 /* An unsigned integer type representing a fixed-length bit sequence,
119 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
120 for speed, but it is unsigned char on weird platforms. */
121 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
122 typedef size_t bits_word
;
123 # define BITS_WORD_MAX SIZE_MAX
124 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
126 typedef unsigned char bits_word
;
127 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
128 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
130 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
132 /* Number of bits in some machine integer types. */
135 BITS_PER_CHAR
= CHAR_BIT
,
136 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
137 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
138 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
141 /* printmax_t and uprintmax_t are types for printing large integers.
142 These are the widest integers that are supported for printing.
143 pMd etc. are conversions for printing them.
144 On C99 hosts, there's no problem, as even the widest integers work.
145 Fall back on EMACS_INT on pre-C99 hosts. */
147 typedef intmax_t printmax_t
;
148 typedef uintmax_t uprintmax_t
;
152 typedef EMACS_INT printmax_t
;
153 typedef EMACS_UINT uprintmax_t
;
158 /* Use pD to format ptrdiff_t values, which suffice for indexes into
159 buffers and strings. Emacs never allocates objects larger than
160 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
161 In C99, pD can always be "t"; configure it here for the sake of
162 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
163 #if PTRDIFF_MAX == INT_MAX
165 #elif PTRDIFF_MAX == LONG_MAX
167 #elif PTRDIFF_MAX == LLONG_MAX
173 /* Extra internal type checking? */
175 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
176 'assume (COND)'. COND should be free of side effects, as it may or
177 may not be evaluated.
179 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
180 defined and suppress_checking is false, and does nothing otherwise.
181 Emacs dies if COND is checked and is false. The suppress_checking
182 variable is initialized to 0 in alloc.c. Set it to 1 using a
183 debugger to temporarily disable aborting on detected internal
184 inconsistencies or error conditions.
186 In some cases, a good compiler may be able to optimize away the
187 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
188 uses eassert to test STRINGP (x), but a particular use of XSTRING
189 is invoked only after testing that STRINGP (x) is true, making the
192 eassume is like eassert except that it also causes the compiler to
193 assume that COND is true afterwards, regardless of whether runtime
194 checking is enabled. This can improve performance in some cases,
195 though it can degrade performance in others. It's often suboptimal
196 for COND to call external functions or access volatile storage. */
198 #ifndef ENABLE_CHECKING
199 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
200 # define eassume(cond) assume (cond)
201 #else /* ENABLE_CHECKING */
203 extern _Noreturn
void die (const char *, const char *, int);
205 extern bool suppress_checking EXTERNALLY_VISIBLE
;
207 # define eassert(cond) \
208 (suppress_checking || (cond) \
210 : die (# cond, __FILE__, __LINE__))
211 # define eassume(cond) \
216 : die (# cond, __FILE__, __LINE__))
217 #endif /* ENABLE_CHECKING */
220 /* Use the configure flag --enable-check-lisp-object-type to make
221 Lisp_Object use a struct type instead of the default int. The flag
222 causes CHECK_LISP_OBJECT_TYPE to be defined. */
224 /***** Select the tagging scheme. *****/
225 /* The following option controls the tagging scheme:
226 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
227 always 0, and we can thus use them to hold tag bits, without
228 restricting our addressing space.
230 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
231 restricting our possible address range.
233 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
234 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
235 on the few static Lisp_Objects used: all the defsubr as well
236 as the two special buffers buffer_defaults and buffer_local_symbols. */
240 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
241 integer constant, for MSVC. */
242 #define GCALIGNMENT 8
244 /* Number of bits in a Lisp_Object value, not counting the tag. */
245 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
247 /* Number of bits in a Lisp fixnum tag. */
248 INTTYPEBITS
= GCTYPEBITS
- 1,
250 /* Number of bits in a Lisp fixnum value, not counting the tag. */
251 FIXNUM_BITS
= VALBITS
+ 1
254 #if GCALIGNMENT != 1 << GCTYPEBITS
255 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
258 /* The maximum value that can be stored in a EMACS_INT, assuming all
259 bits other than the type bits contribute to a nonnegative signed value.
260 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
261 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
263 /* Whether the least-significant bits of an EMACS_INT contain the tag.
264 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
265 a. unnecessary, because the top bits of an EMACS_INT are unused, and
266 b. slower, because it typically requires extra masking.
267 So, USE_LSB_TAG is true only on hosts where it might be useful. */
268 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
269 #define USE_LSB_TAG (EMACS_INT_MAX >> GCTYPEBITS < INTPTR_MAX)
270 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
272 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
273 # error "USE_LSB_TAG not supported on this platform; please report this." \
274 "Try 'configure --with-wide-int' to work around the problem."
279 # define alignas(alignment) /* empty */
281 # error "USE_LSB_TAG requires alignas"
285 /* This should work with GCC. Clang has known problems; see
286 http://lists.gnu.org/archive/html/emacs-devel/2014-09/msg00506.html. */
287 #ifndef USE_STACK_LISP_OBJECTS
288 # if defined __GNUC__ && !defined __clang__
289 # define USE_STACK_LISP_OBJECTS true
291 # define USE_STACK_LISP_OBJECTS false
295 #if defined HAVE_STRUCT_ATTRIBUTE_ALIGNED && USE_STACK_LISP_OBJECTS
296 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
298 # define GCALIGNED /* empty */
301 /* Some operations are so commonly executed that they are implemented
302 as macros, not functions, because otherwise runtime performance would
303 suffer too much when compiling with GCC without optimization.
304 There's no need to inline everything, just the operations that
305 would otherwise cause a serious performance problem.
307 For each such operation OP, define a macro lisp_h_OP that contains
308 the operation's implementation. That way, OP can be implemented
309 via a macro definition like this:
311 #define OP(x) lisp_h_OP (x)
313 and/or via a function definition like this:
315 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
317 which macro-expands to this:
319 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
321 without worrying about the implementations diverging, since
322 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
323 are intended to be private to this include file, and should not be
326 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
327 functions, once most developers have access to GCC 4.8 or later and
328 can use "gcc -Og" to debug. Maybe in the year 2016. See
331 Commentary for these macros can be found near their corresponding
334 #if CHECK_LISP_OBJECT_TYPE
335 # define lisp_h_XLI(o) ((o).i)
336 # define lisp_h_XIL(i) ((Lisp_Object) { i })
338 # define lisp_h_XLI(o) (o)
339 # define lisp_h_XIL(i) (i)
341 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
342 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
343 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
344 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
345 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
346 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
347 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
348 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
349 #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0)
350 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
351 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
352 #define lisp_h_NILP(x) EQ (x, Qnil)
353 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
354 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
355 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
356 #define lisp_h_SYMBOL_VAL(sym) \
357 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
358 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
359 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
360 #define lisp_h_XCAR(c) XCONS (c)->car
361 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
362 #define lisp_h_XCONS(a) \
363 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
364 #define lisp_h_XHASH(a) XUINT (a)
365 #define lisp_h_XPNTR(a) ((void *) (intptr_t) (XLI (a) & VALMASK))
366 #define lisp_h_XSYMBOL(a) \
367 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
368 #ifndef GC_CHECK_CONS_LIST
369 # define lisp_h_check_cons_list() ((void) 0)
372 # define lisp_h_make_number(n) \
373 XIL ((EMACS_INT) ((EMACS_UINT) (n) << INTTYPEBITS))
374 # define lisp_h_XFASTINT(a) XINT (a)
375 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
376 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
377 # define lisp_h_XUNTAG(a, type) ((void *) (XLI (a) - (type)))
380 /* When compiling via gcc -O0, define the key operations as macros, as
381 Emacs is too slow otherwise. To disable this optimization, compile
382 with -DINLINING=false. */
383 #if (defined __NO_INLINE__ \
384 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
385 && ! (defined INLINING && ! INLINING))
386 # define XLI(o) lisp_h_XLI (o)
387 # define XIL(i) lisp_h_XIL (i)
388 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
389 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
390 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
391 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
392 # define CONSP(x) lisp_h_CONSP (x)
393 # define EQ(x, y) lisp_h_EQ (x, y)
394 # define FLOATP(x) lisp_h_FLOATP (x)
395 # define INTEGERP(x) lisp_h_INTEGERP (x)
396 # define MARKERP(x) lisp_h_MARKERP (x)
397 # define MISCP(x) lisp_h_MISCP (x)
398 # define NILP(x) lisp_h_NILP (x)
399 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
400 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
401 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
402 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
403 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
404 # define XCAR(c) lisp_h_XCAR (c)
405 # define XCDR(c) lisp_h_XCDR (c)
406 # define XCONS(a) lisp_h_XCONS (a)
407 # define XHASH(a) lisp_h_XHASH (a)
408 # define XPNTR(a) lisp_h_XPNTR (a)
409 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
410 # ifndef GC_CHECK_CONS_LIST
411 # define check_cons_list() lisp_h_check_cons_list ()
414 # define make_number(n) lisp_h_make_number (n)
415 # define XFASTINT(a) lisp_h_XFASTINT (a)
416 # define XINT(a) lisp_h_XINT (a)
417 # define XTYPE(a) lisp_h_XTYPE (a)
418 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
422 /* Define NAME as a lisp.h inline function that returns TYPE and has
423 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
424 ARGS should be parenthesized. Implement the function by calling
426 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
427 INLINE type (name) argdecls { return lisp_h_##name args; }
429 /* like LISP_MACRO_DEFUN, except NAME returns void. */
430 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
431 INLINE void (name) argdecls { lisp_h_##name args; }
434 /* Define the fundamental Lisp data structures. */
436 /* This is the set of Lisp data types. If you want to define a new
437 data type, read the comments after Lisp_Fwd_Type definition
440 /* Lisp integers use 2 tags, to give them one extra bit, thus
441 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
442 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
443 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
445 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
446 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
447 vociferously about them. */
448 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
449 || (defined __SUNPRO_C && __STDC__))
450 #define ENUM_BF(TYPE) unsigned int
452 #define ENUM_BF(TYPE) enum TYPE
458 /* Integer. XINT (obj) is the integer value. */
460 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
462 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
465 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
466 whose first member indicates the subtype. */
469 /* String. XSTRING (object) points to a struct Lisp_String.
470 The length of the string, and its contents, are stored therein. */
471 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
473 /* Vector of Lisp objects, or something resembling it.
474 XVECTOR (object) points to a struct Lisp_Vector, which contains
475 the size and contents. The size field also contains the type
476 information, if it's not a real vector object. */
479 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
485 /* This is the set of data types that share a common structure.
486 The first member of the structure is a type code from this set.
487 The enum values are arbitrary, but we'll use large numbers to make it
488 more likely that we'll spot the error if a random word in memory is
489 mistakenly interpreted as a Lisp_Misc. */
492 Lisp_Misc_Free
= 0x5eab,
495 Lisp_Misc_Save_Value
,
496 /* Currently floats are not a misc type,
497 but let's define this in case we want to change that. */
499 /* This is not a type code. It is for range checking. */
503 /* These are the types of forwarding objects used in the value slot
504 of symbols for special built-in variables whose value is stored in
508 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
509 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
510 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
511 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
512 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
515 /* If you want to define a new Lisp data type, here are some
516 instructions. See the thread at
517 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
520 First, there are already a couple of Lisp types that can be used if
521 your new type does not need to be exposed to Lisp programs nor
522 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
523 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
524 is suitable for temporarily stashing away pointers and integers in
525 a Lisp object. The latter is useful for vector-like Lisp objects
526 that need to be used as part of other objects, but which are never
527 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
530 These two types don't look pretty when printed, so they are
531 unsuitable for Lisp objects that can be exposed to users.
533 To define a new data type, add one more Lisp_Misc subtype or one
534 more pseudovector subtype. Pseudovectors are more suitable for
535 objects with several slots that need to support fast random access,
536 while Lisp_Misc types are for everything else. A pseudovector object
537 provides one or more slots for Lisp objects, followed by struct
538 members that are accessible only from C. A Lisp_Misc object is a
539 wrapper for a C struct that can contain anything you like.
541 Explicit freeing is discouraged for Lisp objects in general. But if
542 you really need to exploit this, use Lisp_Misc (check free_misc in
543 alloc.c to see why). There is no way to free a vectorlike object.
545 To add a new pseudovector type, extend the pvec_type enumeration;
546 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
548 For a Lisp_Misc, you will also need to add your entry to union
549 Lisp_Misc (but make sure the first word has the same structure as
550 the others, starting with a 16-bit member of the Lisp_Misc_Type
551 enumeration and a 1-bit GC markbit) and make sure the overall size
552 of the union is not increased by your addition.
554 For a new pseudovector, it's highly desirable to limit the size
555 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
556 Otherwise you will need to change sweep_vectors (also in alloc.c).
558 Then you will need to add switch branches in print.c (in
559 print_object, to print your object, and possibly also in
560 print_preprocess) and to alloc.c, to mark your object (in
561 mark_object) and to free it (in gc_sweep). The latter is also the
562 right place to call any code specific to your data type that needs
563 to run when the object is recycled -- e.g., free any additional
564 resources allocated for it that are not Lisp objects. You can even
565 make a pointer to the function that frees the resources a slot in
566 your object -- this way, the same object could be used to represent
567 several disparate C structures. */
569 #ifdef CHECK_LISP_OBJECT_TYPE
571 typedef struct { EMACS_INT i
; } Lisp_Object
;
573 #define LISP_INITIALLY_ZERO {0}
575 #undef CHECK_LISP_OBJECT_TYPE
576 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
577 #else /* CHECK_LISP_OBJECT_TYPE */
579 /* If a struct type is not wanted, define Lisp_Object as just a number. */
581 typedef EMACS_INT Lisp_Object
;
582 #define LISP_INITIALLY_ZERO 0
583 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
584 #endif /* CHECK_LISP_OBJECT_TYPE */
586 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
587 At the machine level, these operations are no-ops. */
588 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
589 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
591 /* In the size word of a vector, this bit means the vector has been marked. */
593 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
594 # define ARRAY_MARK_FLAG PTRDIFF_MIN
595 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
597 /* In the size word of a struct Lisp_Vector, this bit means it's really
598 some other vector-like object. */
599 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
600 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
601 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
603 /* In a pseudovector, the size field actually contains a word with one
604 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
605 with PVEC_TYPE_MASK to indicate the actual type. */
617 PVEC_WINDOW_CONFIGURATION
,
620 /* These should be last, check internal_equal to see why. */
624 PVEC_FONT
/* Should be last because it's used for range checking. */
629 /* For convenience, we also store the number of elements in these bits.
630 Note that this size is not necessarily the memory-footprint size, but
631 only the number of Lisp_Object fields (that need to be traced by GC).
632 The distinction is used, e.g., by Lisp_Process, which places extra
633 non-Lisp_Object fields at the end of the structure. */
634 PSEUDOVECTOR_SIZE_BITS
= 12,
635 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
637 /* To calculate the memory footprint of the pseudovector, it's useful
638 to store the size of non-Lisp area in word_size units here. */
639 PSEUDOVECTOR_REST_BITS
= 12,
640 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
641 << PSEUDOVECTOR_SIZE_BITS
),
643 /* Used to extract pseudovector subtype information. */
644 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
645 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
648 /* These functions extract various sorts of values from a Lisp_Object.
649 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
650 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
653 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
654 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
655 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
656 DEFINE_GDB_SYMBOL_END (VALMASK
)
658 /* Largest and smallest representable fixnum values. These are the C
659 values. They are macros for use in static initializers. */
660 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
661 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
663 /* Extract the pointer hidden within A. */
664 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
668 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
669 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
670 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
671 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
672 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
674 #else /* ! USE_LSB_TAG */
676 /* Although compiled only if ! USE_LSB_TAG, the following functions
677 also work when USE_LSB_TAG; this is to aid future maintenance when
678 the lisp_h_* macros are eventually removed. */
680 /* Make a Lisp integer representing the value of the low order
683 make_number (EMACS_INT n
)
688 n
= u
<< INTTYPEBITS
;
695 /* Extract A's value as a signed integer. */
699 EMACS_INT i
= XLI (a
);
703 i
= u
<< INTTYPEBITS
;
705 return i
>> INTTYPEBITS
;
708 /* Like XINT (A), but may be faster. A must be nonnegative.
709 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
710 integers have zero-bits in their tags. */
712 XFASTINT (Lisp_Object a
)
714 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
719 /* Extract A's type. */
720 INLINE
enum Lisp_Type
721 XTYPE (Lisp_Object a
)
723 EMACS_UINT i
= XLI (a
);
724 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
727 /* Extract A's pointer value, assuming A's type is TYPE. */
729 XUNTAG (Lisp_Object a
, int type
)
733 intptr_t i
= XLI (a
) - type
;
739 #endif /* ! USE_LSB_TAG */
741 /* Extract A's value as an unsigned integer. */
743 XUINT (Lisp_Object a
)
745 EMACS_UINT i
= XLI (a
);
746 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
749 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
750 right now, but XUINT should only be applied to objects we know are
752 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
754 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
756 make_natnum (EMACS_INT n
)
758 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
759 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
762 /* Return true if X and Y are the same object. */
763 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
765 /* Value is true if I doesn't fit into a Lisp fixnum. It is
766 written this way so that it also works if I is of unsigned
767 type or if I is a NaN. */
769 #define FIXNUM_OVERFLOW_P(i) \
770 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
773 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
775 return num
< lower
? lower
: num
<= upper
? num
: upper
;
778 /* Forward declarations. */
780 /* Defined in this file. */
782 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
783 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
784 INLINE
bool BUFFERP (Lisp_Object
);
785 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
786 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
787 INLINE
bool (CONSP
) (Lisp_Object
);
788 INLINE
bool (FLOATP
) (Lisp_Object
);
789 INLINE
bool functionp (Lisp_Object
);
790 INLINE
bool (INTEGERP
) (Lisp_Object
);
791 INLINE
bool (MARKERP
) (Lisp_Object
);
792 INLINE
bool (MISCP
) (Lisp_Object
);
793 INLINE
bool (NILP
) (Lisp_Object
);
794 INLINE
bool OVERLAYP (Lisp_Object
);
795 INLINE
bool PROCESSP (Lisp_Object
);
796 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
797 INLINE
bool SAVE_VALUEP (Lisp_Object
);
798 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
800 INLINE
bool STRINGP (Lisp_Object
);
801 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
802 INLINE
bool SUBRP (Lisp_Object
);
803 INLINE
bool (SYMBOLP
) (Lisp_Object
);
804 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
805 INLINE
bool WINDOWP (Lisp_Object
);
806 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
808 /* Defined in chartab.c. */
809 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
810 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
812 /* Defined in data.c. */
813 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
814 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
815 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
816 extern Lisp_Object Qbool_vector_p
;
817 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
818 extern Lisp_Object Qwindow
;
819 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
820 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
822 /* Defined in emacs.c. */
823 extern bool might_dump
;
824 /* True means Emacs has already been initialized.
825 Used during startup to detect startup of dumped Emacs. */
826 extern bool initialized
;
828 /* Defined in eval.c. */
829 extern Lisp_Object Qautoload
;
831 /* Defined in floatfns.c. */
832 extern double extract_float (Lisp_Object
);
834 /* Defined in process.c. */
835 extern Lisp_Object Qprocessp
;
837 /* Defined in window.c. */
838 extern Lisp_Object Qwindowp
;
840 /* Defined in xdisp.c. */
841 extern Lisp_Object Qimage
;
844 /* Extract a value or address from a Lisp_Object. */
846 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
848 INLINE
struct Lisp_Vector
*
849 XVECTOR (Lisp_Object a
)
851 eassert (VECTORLIKEP (a
));
852 return XUNTAG (a
, Lisp_Vectorlike
);
855 INLINE
struct Lisp_String
*
856 XSTRING (Lisp_Object a
)
858 eassert (STRINGP (a
));
859 return XUNTAG (a
, Lisp_String
);
862 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
864 INLINE
struct Lisp_Float
*
865 XFLOAT (Lisp_Object a
)
867 eassert (FLOATP (a
));
868 return XUNTAG (a
, Lisp_Float
);
871 /* Pseudovector types. */
873 INLINE
struct Lisp_Process
*
874 XPROCESS (Lisp_Object a
)
876 eassert (PROCESSP (a
));
877 return XUNTAG (a
, Lisp_Vectorlike
);
880 INLINE
struct window
*
881 XWINDOW (Lisp_Object a
)
883 eassert (WINDOWP (a
));
884 return XUNTAG (a
, Lisp_Vectorlike
);
887 INLINE
struct terminal
*
888 XTERMINAL (Lisp_Object a
)
890 return XUNTAG (a
, Lisp_Vectorlike
);
893 INLINE
struct Lisp_Subr
*
894 XSUBR (Lisp_Object a
)
897 return XUNTAG (a
, Lisp_Vectorlike
);
900 INLINE
struct buffer
*
901 XBUFFER (Lisp_Object a
)
903 eassert (BUFFERP (a
));
904 return XUNTAG (a
, Lisp_Vectorlike
);
907 INLINE
struct Lisp_Char_Table
*
908 XCHAR_TABLE (Lisp_Object a
)
910 eassert (CHAR_TABLE_P (a
));
911 return XUNTAG (a
, Lisp_Vectorlike
);
914 INLINE
struct Lisp_Sub_Char_Table
*
915 XSUB_CHAR_TABLE (Lisp_Object a
)
917 eassert (SUB_CHAR_TABLE_P (a
));
918 return XUNTAG (a
, Lisp_Vectorlike
);
921 INLINE
struct Lisp_Bool_Vector
*
922 XBOOL_VECTOR (Lisp_Object a
)
924 eassert (BOOL_VECTOR_P (a
));
925 return XUNTAG (a
, Lisp_Vectorlike
);
928 /* Construct a Lisp_Object from a value or address. */
931 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
933 EMACS_UINT utype
= type
;
934 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
935 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
936 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
941 make_lisp_proc (struct Lisp_Process
*p
)
943 return make_lisp_ptr (p
, Lisp_Vectorlike
);
946 #define XSETINT(a, b) ((a) = make_number (b))
947 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
948 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
949 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
950 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
951 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
952 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
953 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
955 /* Pseudovector types. */
957 #define XSETPVECTYPE(v, code) \
958 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
959 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
960 ((v)->header.size = (PSEUDOVECTOR_FLAG \
961 | ((code) << PSEUDOVECTOR_AREA_BITS) \
962 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
965 /* The cast to struct vectorlike_header * avoids aliasing issues. */
966 #define XSETPSEUDOVECTOR(a, b, code) \
967 XSETTYPED_PSEUDOVECTOR (a, b, \
968 (((struct vectorlike_header *) \
969 XUNTAG (a, Lisp_Vectorlike)) \
972 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
973 (XSETVECTOR (a, b), \
974 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
975 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
977 #define XSETWINDOW_CONFIGURATION(a, b) \
978 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
979 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
980 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
981 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
982 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
983 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
984 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
985 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
986 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
987 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
991 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
992 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
995 /* Deprecated and will be removed soon. */
997 #define INTERNAL_FIELD(field) field ## _
999 /* See the macros in intervals.h. */
1001 typedef struct interval
*INTERVAL
;
1003 struct GCALIGNED Lisp_Cons
1005 /* Car of this cons cell. */
1010 /* Cdr of this cons cell. */
1013 /* Used to chain conses on a free list. */
1014 struct Lisp_Cons
*chain
;
1018 /* Take the car or cdr of something known to be a cons cell. */
1019 /* The _addr functions shouldn't be used outside of the minimal set
1020 of code that has to know what a cons cell looks like. Other code not
1021 part of the basic lisp implementation should assume that the car and cdr
1022 fields are not accessible. (What if we want to switch to
1023 a copying collector someday? Cached cons cell field addresses may be
1024 invalidated at arbitrary points.) */
1025 INLINE Lisp_Object
*
1026 xcar_addr (Lisp_Object c
)
1028 return &XCONS (c
)->car
;
1030 INLINE Lisp_Object
*
1031 xcdr_addr (Lisp_Object c
)
1033 return &XCONS (c
)->u
.cdr
;
1036 /* Use these from normal code. */
1037 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
1038 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
1040 /* Use these to set the fields of a cons cell.
1042 Note that both arguments may refer to the same object, so 'n'
1043 should not be read after 'c' is first modified. */
1045 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1050 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1055 /* Take the car or cdr of something whose type is not known. */
1059 return (CONSP (c
) ? XCAR (c
)
1061 : wrong_type_argument (Qlistp
, c
));
1066 return (CONSP (c
) ? XCDR (c
)
1068 : wrong_type_argument (Qlistp
, c
));
1071 /* Take the car or cdr of something whose type is not known. */
1073 CAR_SAFE (Lisp_Object c
)
1075 return CONSP (c
) ? XCAR (c
) : Qnil
;
1078 CDR_SAFE (Lisp_Object c
)
1080 return CONSP (c
) ? XCDR (c
) : Qnil
;
1083 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1088 ptrdiff_t size_byte
;
1089 INTERVAL intervals
; /* Text properties in this string. */
1090 unsigned char *data
;
1093 /* True if STR is a multibyte string. */
1095 STRING_MULTIBYTE (Lisp_Object str
)
1097 return 0 <= XSTRING (str
)->size_byte
;
1100 /* An upper bound on the number of bytes in a Lisp string, not
1101 counting the terminating null. This a tight enough bound to
1102 prevent integer overflow errors that would otherwise occur during
1103 string size calculations. A string cannot contain more bytes than
1104 a fixnum can represent, nor can it be so long that C pointer
1105 arithmetic stops working on the string plus its terminating null.
1106 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1107 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1108 would expose alloc.c internal details that we'd rather keep
1111 This is a macro for use in static initializers. The cast to
1112 ptrdiff_t ensures that the macro is signed. */
1113 #define STRING_BYTES_BOUND \
1114 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1116 /* Mark STR as a unibyte string. */
1117 #define STRING_SET_UNIBYTE(STR) \
1119 if (EQ (STR, empty_multibyte_string)) \
1120 (STR) = empty_unibyte_string; \
1122 XSTRING (STR)->size_byte = -1; \
1125 /* Mark STR as a multibyte string. Assure that STR contains only
1126 ASCII characters in advance. */
1127 #define STRING_SET_MULTIBYTE(STR) \
1129 if (EQ (STR, empty_unibyte_string)) \
1130 (STR) = empty_multibyte_string; \
1132 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1135 /* Convenience functions for dealing with Lisp strings. */
1137 INLINE
unsigned char *
1138 SDATA (Lisp_Object string
)
1140 return XSTRING (string
)->data
;
1143 SSDATA (Lisp_Object string
)
1145 /* Avoid "differ in sign" warnings. */
1146 return (char *) SDATA (string
);
1148 INLINE
unsigned char
1149 SREF (Lisp_Object string
, ptrdiff_t index
)
1151 return SDATA (string
)[index
];
1154 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1156 SDATA (string
)[index
] = new;
1159 SCHARS (Lisp_Object string
)
1161 return XSTRING (string
)->size
;
1164 #ifdef GC_CHECK_STRING_BYTES
1165 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1168 STRING_BYTES (struct Lisp_String
*s
)
1170 #ifdef GC_CHECK_STRING_BYTES
1171 return string_bytes (s
);
1173 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1178 SBYTES (Lisp_Object string
)
1180 return STRING_BYTES (XSTRING (string
));
1183 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1185 XSTRING (string
)->size
= newsize
;
1188 /* Header of vector-like objects. This documents the layout constraints on
1189 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1190 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1191 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1192 because when two such pointers potentially alias, a compiler won't
1193 incorrectly reorder loads and stores to their size fields. See
1195 struct vectorlike_header
1197 /* The only field contains various pieces of information:
1198 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1199 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1200 vector (0) or a pseudovector (1).
1201 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1202 of slots) of the vector.
1203 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1204 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1205 - b) number of Lisp_Objects slots at the beginning of the object
1206 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1208 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1209 measured in word_size units. Rest fields may also include
1210 Lisp_Objects, but these objects usually needs some special treatment
1212 There are some exceptions. For PVEC_FREE, b) is always zero. For
1213 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1214 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1215 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1219 /* A regular vector is just a header plus an array of Lisp_Objects. */
1223 struct vectorlike_header header
;
1224 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1227 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1230 ALIGNOF_STRUCT_LISP_VECTOR
1231 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1234 /* A boolvector is a kind of vectorlike, with contents like a string. */
1236 struct Lisp_Bool_Vector
1238 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1239 just the subtype information. */
1240 struct vectorlike_header header
;
1241 /* This is the size in bits. */
1243 /* The actual bits, packed into bytes.
1244 Zeros fill out the last word if needed.
1245 The bits are in little-endian order in the bytes, and
1246 the bytes are in little-endian order in the words. */
1247 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1251 bool_vector_size (Lisp_Object a
)
1253 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1254 eassume (0 <= size
);
1259 bool_vector_data (Lisp_Object a
)
1261 return XBOOL_VECTOR (a
)->data
;
1264 INLINE
unsigned char *
1265 bool_vector_uchar_data (Lisp_Object a
)
1267 return (unsigned char *) bool_vector_data (a
);
1270 /* The number of data words and bytes in a bool vector with SIZE bits. */
1273 bool_vector_words (EMACS_INT size
)
1275 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1276 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1280 bool_vector_bytes (EMACS_INT size
)
1282 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1283 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1286 /* True if A's Ith bit is set. */
1289 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1291 eassume (0 <= i
&& i
< bool_vector_size (a
));
1292 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1293 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1297 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1299 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1302 /* Set A's Ith bit to B. */
1305 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1307 unsigned char *addr
;
1309 eassume (0 <= i
&& i
< bool_vector_size (a
));
1310 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1313 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1315 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1318 /* Some handy constants for calculating sizes
1319 and offsets, mostly of vectorlike objects. */
1323 header_size
= offsetof (struct Lisp_Vector
, contents
),
1324 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1325 word_size
= sizeof (Lisp_Object
)
1328 /* Conveniences for dealing with Lisp arrays. */
1331 AREF (Lisp_Object array
, ptrdiff_t idx
)
1333 return XVECTOR (array
)->contents
[idx
];
1336 INLINE Lisp_Object
*
1337 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1339 return & XVECTOR (array
)->contents
[idx
];
1343 ASIZE (Lisp_Object array
)
1345 return XVECTOR (array
)->header
.size
;
1349 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1351 eassert (0 <= idx
&& idx
< ASIZE (array
));
1352 XVECTOR (array
)->contents
[idx
] = val
;
1356 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1358 /* Like ASET, but also can be used in the garbage collector:
1359 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1360 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
1361 XVECTOR (array
)->contents
[idx
] = val
;
1364 /* If a struct is made to look like a vector, this macro returns the length
1365 of the shortest vector that would hold that struct. */
1367 #define VECSIZE(type) \
1368 ((sizeof (type) - header_size + word_size - 1) / word_size)
1370 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1371 at the end and we need to compute the number of Lisp_Object fields (the
1372 ones that the GC needs to trace). */
1374 #define PSEUDOVECSIZE(type, nonlispfield) \
1375 ((offsetof (type, nonlispfield) - header_size) / word_size)
1377 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1378 should be integer expressions. This is not the same as
1379 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1380 returns true. For efficiency, prefer plain unsigned comparison if A
1381 and B's sizes both fit (after integer promotion). */
1382 #define UNSIGNED_CMP(a, op, b) \
1383 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1384 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1385 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1387 /* True iff C is an ASCII character. */
1388 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1390 /* A char-table is a kind of vectorlike, with contents are like a
1391 vector but with a few other slots. For some purposes, it makes
1392 sense to handle a char-table with type struct Lisp_Vector. An
1393 element of a char table can be any Lisp objects, but if it is a sub
1394 char-table, we treat it a table that contains information of a
1395 specific range of characters. A sub char-table is like a vector but
1396 with two integer fields between the header and Lisp data, which means
1397 that it has to be marked with some precautions (see mark_char_table
1398 in alloc.c). A sub char-table appears only in an element of a char-table,
1399 and there's no way to access it directly from Emacs Lisp program. */
1401 enum CHARTAB_SIZE_BITS
1403 CHARTAB_SIZE_BITS_0
= 6,
1404 CHARTAB_SIZE_BITS_1
= 4,
1405 CHARTAB_SIZE_BITS_2
= 5,
1406 CHARTAB_SIZE_BITS_3
= 7
1409 extern const int chartab_size
[4];
1411 struct Lisp_Char_Table
1413 /* HEADER.SIZE is the vector's size field, which also holds the
1414 pseudovector type information. It holds the size, too.
1415 The size counts the defalt, parent, purpose, ascii,
1416 contents, and extras slots. */
1417 struct vectorlike_header header
;
1419 /* This holds a default value,
1420 which is used whenever the value for a specific character is nil. */
1423 /* This points to another char table, which we inherit from when the
1424 value for a specific character is nil. The `defalt' slot takes
1425 precedence over this. */
1428 /* This is a symbol which says what kind of use this char-table is
1430 Lisp_Object purpose
;
1432 /* The bottom sub char-table for characters of the range 0..127. It
1433 is nil if none of ASCII character has a specific value. */
1436 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1438 /* These hold additional data. It is a vector. */
1439 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1442 struct Lisp_Sub_Char_Table
1444 /* HEADER.SIZE is the vector's size field, which also holds the
1445 pseudovector type information. It holds the size, too. */
1446 struct vectorlike_header header
;
1448 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1449 char-table of depth 1 contains 16 elements, and each element
1450 covers 4096 (128*32) characters. A sub char-table of depth 2
1451 contains 32 elements, and each element covers 128 characters. A
1452 sub char-table of depth 3 contains 128 elements, and each element
1453 is for one character. */
1456 /* Minimum character covered by the sub char-table. */
1459 /* Use set_sub_char_table_contents to set this. */
1460 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1464 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1466 struct Lisp_Char_Table
*tbl
= NULL
;
1470 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1471 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1472 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1476 while (NILP (val
) && ! NILP (tbl
->parent
));
1481 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1482 characters. Do not check validity of CT. */
1484 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1486 return (ASCII_CHAR_P (idx
)
1487 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1488 : char_table_ref (ct
, idx
));
1491 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1492 8-bit European characters. Do not check validity of CT. */
1494 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1496 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1497 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1499 char_table_set (ct
, idx
, val
);
1502 /* This structure describes a built-in function.
1503 It is generated by the DEFUN macro only.
1504 defsubr makes it into a Lisp object. */
1508 struct vectorlike_header header
;
1510 Lisp_Object (*a0
) (void);
1511 Lisp_Object (*a1
) (Lisp_Object
);
1512 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1513 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1514 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1515 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1516 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1517 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1518 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1519 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1520 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1522 short min_args
, max_args
;
1523 const char *symbol_name
;
1524 const char *intspec
;
1528 enum char_table_specials
1530 /* This is the number of slots that every char table must have. This
1531 counts the ordinary slots and the top, defalt, parent, and purpose
1533 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1535 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1536 when the latter is treated as an ordinary Lisp_Vector. */
1537 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1540 /* Return the number of "extra" slots in the char table CT. */
1543 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1545 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1546 - CHAR_TABLE_STANDARD_SLOTS
);
1549 /* Make sure that sub char-table contents slot
1550 is aligned on a multiple of Lisp_Objects. */
1551 verify ((offsetof (struct Lisp_Sub_Char_Table
, contents
)
1552 - offsetof (struct Lisp_Sub_Char_Table
, depth
)) % word_size
== 0);
1554 /***********************************************************************
1556 ***********************************************************************/
1558 /* Interned state of a symbol. */
1560 enum symbol_interned
1562 SYMBOL_UNINTERNED
= 0,
1563 SYMBOL_INTERNED
= 1,
1564 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1567 enum symbol_redirect
1569 SYMBOL_PLAINVAL
= 4,
1570 SYMBOL_VARALIAS
= 1,
1571 SYMBOL_LOCALIZED
= 2,
1572 SYMBOL_FORWARDED
= 3
1577 bool_bf gcmarkbit
: 1;
1579 /* Indicates where the value can be found:
1580 0 : it's a plain var, the value is in the `value' field.
1581 1 : it's a varalias, the value is really in the `alias' symbol.
1582 2 : it's a localized var, the value is in the `blv' object.
1583 3 : it's a forwarding variable, the value is in `forward'. */
1584 ENUM_BF (symbol_redirect
) redirect
: 3;
1586 /* Non-zero means symbol is constant, i.e. changing its value
1587 should signal an error. If the value is 3, then the var
1588 can be changed, but only by `defconst'. */
1589 unsigned constant
: 2;
1591 /* Interned state of the symbol. This is an enumerator from
1592 enum symbol_interned. */
1593 unsigned interned
: 2;
1595 /* True means that this variable has been explicitly declared
1596 special (with `defvar' etc), and shouldn't be lexically bound. */
1597 bool_bf declared_special
: 1;
1599 /* True if pointed to from purespace and hence can't be GC'd. */
1602 /* The symbol's name, as a Lisp string. */
1605 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1606 union is used depends on the `redirect' field above. */
1609 struct Lisp_Symbol
*alias
;
1610 struct Lisp_Buffer_Local_Value
*blv
;
1611 union Lisp_Fwd
*fwd
;
1614 /* Function value of the symbol or Qnil if not fboundp. */
1615 Lisp_Object function
;
1617 /* The symbol's property list. */
1620 /* Next symbol in obarray bucket, if the symbol is interned. */
1621 struct Lisp_Symbol
*next
;
1624 /* Value is name of symbol. */
1626 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1628 INLINE
struct Lisp_Symbol
*
1629 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1631 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1632 return sym
->val
.alias
;
1634 INLINE
struct Lisp_Buffer_Local_Value
*
1635 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1637 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1638 return sym
->val
.blv
;
1640 INLINE
union Lisp_Fwd
*
1641 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1643 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1644 return sym
->val
.fwd
;
1647 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1648 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1651 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1653 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1657 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1659 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1663 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1665 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1670 SYMBOL_NAME (Lisp_Object sym
)
1672 return XSYMBOL (sym
)->name
;
1675 /* Value is true if SYM is an interned symbol. */
1678 SYMBOL_INTERNED_P (Lisp_Object sym
)
1680 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1683 /* Value is true if SYM is interned in initial_obarray. */
1686 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1688 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1691 /* Value is non-zero if symbol is considered a constant, i.e. its
1692 value cannot be changed (there is an exception for keyword symbols,
1693 whose value can be set to the keyword symbol itself). */
1695 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1697 #define DEFSYM(sym, name) \
1698 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1701 /***********************************************************************
1703 ***********************************************************************/
1705 /* The structure of a Lisp hash table. */
1707 struct hash_table_test
1709 /* Name of the function used to compare keys. */
1712 /* User-supplied hash function, or nil. */
1713 Lisp_Object user_hash_function
;
1715 /* User-supplied key comparison function, or nil. */
1716 Lisp_Object user_cmp_function
;
1718 /* C function to compare two keys. */
1719 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1721 /* C function to compute hash code. */
1722 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1725 struct Lisp_Hash_Table
1727 /* This is for Lisp; the hash table code does not refer to it. */
1728 struct vectorlike_header header
;
1730 /* Nil if table is non-weak. Otherwise a symbol describing the
1731 weakness of the table. */
1734 /* When the table is resized, and this is an integer, compute the
1735 new size by adding this to the old size. If a float, compute the
1736 new size by multiplying the old size with this factor. */
1737 Lisp_Object rehash_size
;
1739 /* Resize hash table when number of entries/ table size is >= this
1741 Lisp_Object rehash_threshold
;
1743 /* Vector of hash codes. If hash[I] is nil, this means that the
1744 I-th entry is unused. */
1747 /* Vector used to chain entries. If entry I is free, next[I] is the
1748 entry number of the next free item. If entry I is non-free,
1749 next[I] is the index of the next entry in the collision chain. */
1752 /* Index of first free entry in free list. */
1753 Lisp_Object next_free
;
1755 /* Bucket vector. A non-nil entry is the index of the first item in
1756 a collision chain. This vector's size can be larger than the
1757 hash table size to reduce collisions. */
1760 /* Only the fields above are traced normally by the GC. The ones below
1761 `count' are special and are either ignored by the GC or traced in
1762 a special way (e.g. because of weakness). */
1764 /* Number of key/value entries in the table. */
1767 /* Vector of keys and values. The key of item I is found at index
1768 2 * I, the value is found at index 2 * I + 1.
1769 This is gc_marked specially if the table is weak. */
1770 Lisp_Object key_and_value
;
1772 /* The comparison and hash functions. */
1773 struct hash_table_test test
;
1775 /* Next weak hash table if this is a weak hash table. The head
1776 of the list is in weak_hash_tables. */
1777 struct Lisp_Hash_Table
*next_weak
;
1781 INLINE
struct Lisp_Hash_Table
*
1782 XHASH_TABLE (Lisp_Object a
)
1784 return XUNTAG (a
, Lisp_Vectorlike
);
1787 #define XSET_HASH_TABLE(VAR, PTR) \
1788 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1791 HASH_TABLE_P (Lisp_Object a
)
1793 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1796 /* Value is the key part of entry IDX in hash table H. */
1798 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1800 return AREF (h
->key_and_value
, 2 * idx
);
1803 /* Value is the value part of entry IDX in hash table H. */
1805 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1807 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1810 /* Value is the index of the next entry following the one at IDX
1813 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1815 return AREF (h
->next
, idx
);
1818 /* Value is the hash code computed for entry IDX in hash table H. */
1820 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1822 return AREF (h
->hash
, idx
);
1825 /* Value is the index of the element in hash table H that is the
1826 start of the collision list at index IDX in the index vector of H. */
1828 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1830 return AREF (h
->index
, idx
);
1833 /* Value is the size of hash table H. */
1835 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1837 return ASIZE (h
->next
);
1840 /* Default size for hash tables if not specified. */
1842 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1844 /* Default threshold specifying when to resize a hash table. The
1845 value gives the ratio of current entries in the hash table and the
1846 size of the hash table. */
1848 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1850 /* Default factor by which to increase the size of a hash table. */
1852 static double const DEFAULT_REHASH_SIZE
= 1.5;
1854 /* Combine two integers X and Y for hashing. The result might not fit
1855 into a Lisp integer. */
1858 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1860 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1863 /* Hash X, returning a value that fits into a fixnum. */
1866 SXHASH_REDUCE (EMACS_UINT x
)
1868 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1871 /* These structures are used for various misc types. */
1873 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1875 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1876 bool_bf gcmarkbit
: 1;
1877 unsigned spacer
: 15;
1882 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1883 bool_bf gcmarkbit
: 1;
1884 unsigned spacer
: 13;
1885 /* This flag is temporarily used in the functions
1886 decode/encode_coding_object to record that the marker position
1887 must be adjusted after the conversion. */
1888 bool_bf need_adjustment
: 1;
1889 /* True means normal insertion at the marker's position
1890 leaves the marker after the inserted text. */
1891 bool_bf insertion_type
: 1;
1892 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1893 Note: a chain of markers can contain markers pointing into different
1894 buffers (the chain is per buffer_text rather than per buffer, so it's
1895 shared between indirect buffers). */
1896 /* This is used for (other than NULL-checking):
1898 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1899 - unchain_marker: to find the list from which to unchain.
1900 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1902 struct buffer
*buffer
;
1904 /* The remaining fields are meaningless in a marker that
1905 does not point anywhere. */
1907 /* For markers that point somewhere,
1908 this is used to chain of all the markers in a given buffer. */
1909 /* We could remove it and use an array in buffer_text instead.
1910 That would also allow to preserve it ordered. */
1911 struct Lisp_Marker
*next
;
1912 /* This is the char position where the marker points. */
1914 /* This is the byte position.
1915 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1916 used to implement the functionality of markers, but rather to (ab)use
1917 markers as a cache for char<->byte mappings). */
1921 /* START and END are markers in the overlay's buffer, and
1922 PLIST is the overlay's property list. */
1924 /* An overlay's real data content is:
1926 - buffer (really there are two buffer pointers, one per marker,
1927 and both points to the same buffer)
1928 - insertion type of both ends (per-marker fields)
1929 - start & start byte (of start marker)
1930 - end & end byte (of end marker)
1931 - next (singly linked list of overlays)
1932 - next fields of start and end markers (singly linked list of markers).
1933 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1936 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1937 bool_bf gcmarkbit
: 1;
1938 unsigned spacer
: 15;
1939 struct Lisp_Overlay
*next
;
1945 /* Types of data which may be saved in a Lisp_Save_Value. */
1956 /* Number of bits needed to store one of the above values. */
1957 enum { SAVE_SLOT_BITS
= 3 };
1959 /* Number of slots in a save value where save_type is nonzero. */
1960 enum { SAVE_VALUE_SLOTS
= 4 };
1962 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1964 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1968 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1969 SAVE_TYPE_INT_INT_INT
1970 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1971 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1972 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1973 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1974 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1975 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1976 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1977 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1978 SAVE_TYPE_FUNCPTR_PTR_OBJ
1979 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1981 /* This has an extra bit indicating it's raw memory. */
1982 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1985 /* Special object used to hold a different values for later use.
1987 This is mostly used to package C integers and pointers to call
1988 record_unwind_protect when two or more values need to be saved.
1992 struct my_data *md = get_my_data ();
1993 ptrdiff_t mi = get_my_integer ();
1994 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1997 Lisp_Object my_unwind (Lisp_Object arg)
1999 struct my_data *md = XSAVE_POINTER (arg, 0);
2000 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2004 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2005 saved objects and raise eassert if type of the saved object doesn't match
2006 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2007 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2008 slot 0 is a pointer. */
2010 typedef void (*voidfuncptr
) (void);
2012 struct Lisp_Save_Value
2014 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2015 bool_bf gcmarkbit
: 1;
2016 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2018 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2019 V's data entries are determined by V->save_type. E.g., if
2020 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2021 V->data[1] is an integer, and V's other data entries are unused.
2023 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2024 a memory area containing V->data[1].integer potential Lisp_Objects. */
2025 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2028 voidfuncptr funcpointer
;
2031 } data
[SAVE_VALUE_SLOTS
];
2034 /* Return the type of V's Nth saved value. */
2036 save_type (struct Lisp_Save_Value
*v
, int n
)
2038 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2039 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2042 /* Get and set the Nth saved pointer. */
2045 XSAVE_POINTER (Lisp_Object obj
, int n
)
2047 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2048 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2051 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2053 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2054 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2057 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2059 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2060 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2063 /* Likewise for the saved integer. */
2066 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2068 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2069 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2072 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2074 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2075 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2078 /* Extract Nth saved object. */
2081 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2083 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2084 return XSAVE_VALUE (obj
)->data
[n
].object
;
2087 /* A miscellaneous object, when it's on the free list. */
2090 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2091 bool_bf gcmarkbit
: 1;
2092 unsigned spacer
: 15;
2093 union Lisp_Misc
*chain
;
2096 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2097 It uses one of these struct subtypes to get the type field. */
2101 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2102 struct Lisp_Free u_free
;
2103 struct Lisp_Marker u_marker
;
2104 struct Lisp_Overlay u_overlay
;
2105 struct Lisp_Save_Value u_save_value
;
2108 INLINE
union Lisp_Misc
*
2109 XMISC (Lisp_Object a
)
2111 return XUNTAG (a
, Lisp_Misc
);
2114 INLINE
struct Lisp_Misc_Any
*
2115 XMISCANY (Lisp_Object a
)
2117 eassert (MISCP (a
));
2118 return & XMISC (a
)->u_any
;
2121 INLINE
enum Lisp_Misc_Type
2122 XMISCTYPE (Lisp_Object a
)
2124 return XMISCANY (a
)->type
;
2127 INLINE
struct Lisp_Marker
*
2128 XMARKER (Lisp_Object a
)
2130 eassert (MARKERP (a
));
2131 return & XMISC (a
)->u_marker
;
2134 INLINE
struct Lisp_Overlay
*
2135 XOVERLAY (Lisp_Object a
)
2137 eassert (OVERLAYP (a
));
2138 return & XMISC (a
)->u_overlay
;
2141 INLINE
struct Lisp_Save_Value
*
2142 XSAVE_VALUE (Lisp_Object a
)
2144 eassert (SAVE_VALUEP (a
));
2145 return & XMISC (a
)->u_save_value
;
2148 /* Forwarding pointer to an int variable.
2149 This is allowed only in the value cell of a symbol,
2150 and it means that the symbol's value really lives in the
2151 specified int variable. */
2154 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2158 /* Boolean forwarding pointer to an int variable.
2159 This is like Lisp_Intfwd except that the ostensible
2160 "value" of the symbol is t if the bool variable is true,
2161 nil if it is false. */
2164 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2168 /* Forwarding pointer to a Lisp_Object variable.
2169 This is allowed only in the value cell of a symbol,
2170 and it means that the symbol's value really lives in the
2171 specified variable. */
2174 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2175 Lisp_Object
*objvar
;
2178 /* Like Lisp_Objfwd except that value lives in a slot in the
2179 current buffer. Value is byte index of slot within buffer. */
2180 struct Lisp_Buffer_Objfwd
2182 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2184 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2185 Lisp_Object predicate
;
2188 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2189 the symbol has buffer-local or frame-local bindings. (Exception:
2190 some buffer-local variables are built-in, with their values stored
2191 in the buffer structure itself. They are handled differently,
2192 using struct Lisp_Buffer_Objfwd.)
2194 The `realvalue' slot holds the variable's current value, or a
2195 forwarding pointer to where that value is kept. This value is the
2196 one that corresponds to the loaded binding. To read or set the
2197 variable, you must first make sure the right binding is loaded;
2198 then you can access the value in (or through) `realvalue'.
2200 `buffer' and `frame' are the buffer and frame for which the loaded
2201 binding was found. If those have changed, to make sure the right
2202 binding is loaded it is necessary to find which binding goes with
2203 the current buffer and selected frame, then load it. To load it,
2204 first unload the previous binding, then copy the value of the new
2205 binding into `realvalue' (or through it). Also update
2206 LOADED-BINDING to point to the newly loaded binding.
2208 `local_if_set' indicates that merely setting the variable creates a
2209 local binding for the current buffer. Otherwise the latter, setting
2210 the variable does not do that; only make-local-variable does that. */
2212 struct Lisp_Buffer_Local_Value
2214 /* True means that merely setting the variable creates a local
2215 binding for the current buffer. */
2216 bool_bf local_if_set
: 1;
2217 /* True means this variable can have frame-local bindings, otherwise, it is
2218 can have buffer-local bindings. The two cannot be combined. */
2219 bool_bf frame_local
: 1;
2220 /* True means that the binding now loaded was found.
2221 Presumably equivalent to (defcell!=valcell). */
2223 /* If non-NULL, a forwarding to the C var where it should also be set. */
2224 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2225 /* The buffer or frame for which the loaded binding was found. */
2227 /* A cons cell that holds the default value. It has the form
2228 (SYMBOL . DEFAULT-VALUE). */
2229 Lisp_Object defcell
;
2230 /* The cons cell from `where's parameter alist.
2231 It always has the form (SYMBOL . VALUE)
2232 Note that if `forward' is non-nil, VALUE may be out of date.
2233 Also if the currently loaded binding is the default binding, then
2234 this is `eq'ual to defcell. */
2235 Lisp_Object valcell
;
2238 /* Like Lisp_Objfwd except that value lives in a slot in the
2240 struct Lisp_Kboard_Objfwd
2242 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2248 struct Lisp_Intfwd u_intfwd
;
2249 struct Lisp_Boolfwd u_boolfwd
;
2250 struct Lisp_Objfwd u_objfwd
;
2251 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2252 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2255 INLINE
enum Lisp_Fwd_Type
2256 XFWDTYPE (union Lisp_Fwd
*a
)
2258 return a
->u_intfwd
.type
;
2261 INLINE
struct Lisp_Buffer_Objfwd
*
2262 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2264 eassert (BUFFER_OBJFWDP (a
));
2265 return &a
->u_buffer_objfwd
;
2268 /* Lisp floating point type. */
2274 struct Lisp_Float
*chain
;
2279 XFLOAT_DATA (Lisp_Object f
)
2281 return XFLOAT (f
)->u
.data
;
2284 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2285 representations, have infinities and NaNs, and do not trap on
2286 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2287 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2288 wanted here, but is not quite right because Emacs does not require
2289 all the features of C11 Annex F (and does not require C11 at all,
2290 for that matter). */
2294 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2295 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2298 /* A character, declared with the following typedef, is a member
2299 of some character set associated with the current buffer. */
2300 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2302 typedef unsigned char UCHAR
;
2305 /* Meanings of slots in a Lisp_Compiled: */
2309 COMPILED_ARGLIST
= 0,
2310 COMPILED_BYTECODE
= 1,
2311 COMPILED_CONSTANTS
= 2,
2312 COMPILED_STACK_DEPTH
= 3,
2313 COMPILED_DOC_STRING
= 4,
2314 COMPILED_INTERACTIVE
= 5
2317 /* Flag bits in a character. These also get used in termhooks.h.
2318 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2319 (MUlti-Lingual Emacs) might need 22 bits for the character value
2320 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2323 CHAR_ALT
= 0x0400000,
2324 CHAR_SUPER
= 0x0800000,
2325 CHAR_HYPER
= 0x1000000,
2326 CHAR_SHIFT
= 0x2000000,
2327 CHAR_CTL
= 0x4000000,
2328 CHAR_META
= 0x8000000,
2330 CHAR_MODIFIER_MASK
=
2331 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2333 /* Actually, the current Emacs uses 22 bits for the character value
2338 /* Data type checking. */
2340 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2343 NUMBERP (Lisp_Object x
)
2345 return INTEGERP (x
) || FLOATP (x
);
2348 NATNUMP (Lisp_Object x
)
2350 return INTEGERP (x
) && 0 <= XINT (x
);
2354 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2356 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2359 #define TYPE_RANGED_INTEGERP(type, x) \
2361 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2362 && XINT (x) <= TYPE_MAXIMUM (type))
2364 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2365 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2366 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2367 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2368 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2369 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2370 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2373 STRINGP (Lisp_Object x
)
2375 return XTYPE (x
) == Lisp_String
;
2378 VECTORP (Lisp_Object x
)
2380 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2383 OVERLAYP (Lisp_Object x
)
2385 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2388 SAVE_VALUEP (Lisp_Object x
)
2390 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2394 AUTOLOADP (Lisp_Object x
)
2396 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2400 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2402 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2406 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2408 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2409 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2412 /* True if A is a pseudovector whose code is CODE. */
2414 PSEUDOVECTORP (Lisp_Object a
, int code
)
2416 if (! VECTORLIKEP (a
))
2420 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2421 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2422 return PSEUDOVECTOR_TYPEP (h
, code
);
2427 /* Test for specific pseudovector types. */
2430 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2432 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2436 PROCESSP (Lisp_Object a
)
2438 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2442 WINDOWP (Lisp_Object a
)
2444 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2448 TERMINALP (Lisp_Object a
)
2450 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2454 SUBRP (Lisp_Object a
)
2456 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2460 COMPILEDP (Lisp_Object a
)
2462 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2466 BUFFERP (Lisp_Object a
)
2468 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2472 CHAR_TABLE_P (Lisp_Object a
)
2474 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2478 SUB_CHAR_TABLE_P (Lisp_Object a
)
2480 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2484 BOOL_VECTOR_P (Lisp_Object a
)
2486 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2490 FRAMEP (Lisp_Object a
)
2492 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2495 /* Test for image (image . spec) */
2497 IMAGEP (Lisp_Object x
)
2499 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2504 ARRAYP (Lisp_Object x
)
2506 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2510 CHECK_LIST (Lisp_Object x
)
2512 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2515 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2516 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2517 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2520 CHECK_STRING (Lisp_Object x
)
2522 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2525 CHECK_STRING_CAR (Lisp_Object x
)
2527 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2530 CHECK_CONS (Lisp_Object x
)
2532 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2535 CHECK_VECTOR (Lisp_Object x
)
2537 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2540 CHECK_BOOL_VECTOR (Lisp_Object x
)
2542 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2544 /* This is a bit special because we always need size afterwards. */
2546 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2552 wrong_type_argument (Qarrayp
, x
);
2555 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2557 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2560 CHECK_BUFFER (Lisp_Object x
)
2562 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2565 CHECK_WINDOW (Lisp_Object x
)
2567 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2571 CHECK_PROCESS (Lisp_Object x
)
2573 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2577 CHECK_NATNUM (Lisp_Object x
)
2579 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2582 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2585 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2586 args_out_of_range_3 \
2588 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2589 ? MOST_NEGATIVE_FIXNUM \
2591 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2593 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2595 if (TYPE_SIGNED (type)) \
2596 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2598 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2601 #define CHECK_NUMBER_COERCE_MARKER(x) \
2603 if (MARKERP ((x))) \
2604 XSETFASTINT (x, marker_position (x)); \
2606 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2610 XFLOATINT (Lisp_Object n
)
2612 return extract_float (n
);
2616 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2618 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2621 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2624 XSETFASTINT (x, marker_position (x)); \
2626 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2629 /* Since we can't assign directly to the CAR or CDR fields of a cons
2630 cell, use these when checking that those fields contain numbers. */
2632 CHECK_NUMBER_CAR (Lisp_Object x
)
2634 Lisp_Object tmp
= XCAR (x
);
2640 CHECK_NUMBER_CDR (Lisp_Object x
)
2642 Lisp_Object tmp
= XCDR (x
);
2647 /* Define a built-in function for calling from Lisp.
2648 `lname' should be the name to give the function in Lisp,
2649 as a null-terminated C string.
2650 `fnname' should be the name of the function in C.
2651 By convention, it starts with F.
2652 `sname' should be the name for the C constant structure
2653 that records information on this function for internal use.
2654 By convention, it should be the same as `fnname' but with S instead of F.
2655 It's too bad that C macros can't compute this from `fnname'.
2656 `minargs' should be a number, the minimum number of arguments allowed.
2657 `maxargs' should be a number, the maximum number of arguments allowed,
2658 or else MANY or UNEVALLED.
2659 MANY means pass a vector of evaluated arguments,
2660 in the form of an integer number-of-arguments
2661 followed by the address of a vector of Lisp_Objects
2662 which contains the argument values.
2663 UNEVALLED means pass the list of unevaluated arguments
2664 `intspec' says how interactive arguments are to be fetched.
2665 If the string starts with a `(', `intspec' is evaluated and the resulting
2666 list is the list of arguments.
2667 If it's a string that doesn't start with `(', the value should follow
2668 the one of the doc string for `interactive'.
2669 A null string means call interactively with no arguments.
2670 `doc' is documentation for the user. */
2672 /* This version of DEFUN declares a function prototype with the right
2673 arguments, so we can catch errors with maxargs at compile-time. */
2675 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2676 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2677 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2678 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2679 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2680 { (Lisp_Object (__cdecl *)(void))fnname }, \
2681 minargs, maxargs, lname, intspec, 0}; \
2683 #else /* not _MSC_VER */
2684 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2685 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2686 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2687 { .a ## maxargs = fnname }, \
2688 minargs, maxargs, lname, intspec, 0}; \
2692 /* Note that the weird token-substitution semantics of ANSI C makes
2693 this work for MANY and UNEVALLED. */
2694 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2695 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2696 #define DEFUN_ARGS_0 (void)
2697 #define DEFUN_ARGS_1 (Lisp_Object)
2698 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2699 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2700 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2701 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2703 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2704 Lisp_Object, Lisp_Object)
2705 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2706 Lisp_Object, Lisp_Object, Lisp_Object)
2707 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2708 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2710 /* True if OBJ is a Lisp function. */
2712 FUNCTIONP (Lisp_Object obj
)
2714 return functionp (obj
);
2718 is how we define the symbol for function `name' at start-up time. */
2719 extern void defsubr (struct Lisp_Subr
*);
2727 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2728 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2729 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2730 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2731 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2733 /* Macros we use to define forwarded Lisp variables.
2734 These are used in the syms_of_FILENAME functions.
2736 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2737 lisp variable is actually a field in `struct emacs_globals'. The
2738 field's name begins with "f_", which is a convention enforced by
2739 these macros. Each such global has a corresponding #define in
2740 globals.h; the plain name should be used in the code.
2742 E.g., the global "cons_cells_consed" is declared as "int
2743 f_cons_cells_consed" in globals.h, but there is a define:
2745 #define cons_cells_consed globals.f_cons_cells_consed
2747 All C code uses the `cons_cells_consed' name. This is all done
2748 this way to support indirection for multi-threaded Emacs. */
2750 #define DEFVAR_LISP(lname, vname, doc) \
2752 static struct Lisp_Objfwd o_fwd; \
2753 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2755 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2757 static struct Lisp_Objfwd o_fwd; \
2758 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2760 #define DEFVAR_BOOL(lname, vname, doc) \
2762 static struct Lisp_Boolfwd b_fwd; \
2763 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2765 #define DEFVAR_INT(lname, vname, doc) \
2767 static struct Lisp_Intfwd i_fwd; \
2768 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2771 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2773 static struct Lisp_Objfwd o_fwd; \
2774 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2777 #define DEFVAR_KBOARD(lname, vname, doc) \
2779 static struct Lisp_Kboard_Objfwd ko_fwd; \
2780 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2783 /* Save and restore the instruction and environment pointers,
2784 without affecting the signal mask. */
2787 typedef jmp_buf sys_jmp_buf
;
2788 # define sys_setjmp(j) _setjmp (j)
2789 # define sys_longjmp(j, v) _longjmp (j, v)
2790 #elif defined HAVE_SIGSETJMP
2791 typedef sigjmp_buf sys_jmp_buf
;
2792 # define sys_setjmp(j) sigsetjmp (j, 0)
2793 # define sys_longjmp(j, v) siglongjmp (j, v)
2795 /* A platform that uses neither _longjmp nor siglongjmp; assume
2796 longjmp does not affect the sigmask. */
2797 typedef jmp_buf sys_jmp_buf
;
2798 # define sys_setjmp(j) setjmp (j)
2799 # define sys_longjmp(j, v) longjmp (j, v)
2803 /* Elisp uses several stacks:
2805 - the bytecode stack: used internally by the bytecode interpreter.
2806 Allocated from the C stack.
2807 - The specpdl stack: keeps track of active unwind-protect and
2808 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2810 - The handler stack: keeps track of active catch tags and condition-case
2811 handlers. Allocated in a manually managed stack implemented by a
2812 doubly-linked list allocated via xmalloc and never freed. */
2814 /* Structure for recording Lisp call stack for backtrace purposes. */
2816 /* The special binding stack holds the outer values of variables while
2817 they are bound by a function application or a let form, stores the
2818 code to be executed for unwind-protect forms.
2820 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2821 used all over the place, needs to be fast, and needs to know the size of
2822 union specbinding. But only eval.c should access it. */
2825 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2826 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2827 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2828 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2829 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2830 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2831 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2832 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2833 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2838 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2840 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2841 void (*func
) (Lisp_Object
);
2845 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2846 void (*func
) (void *);
2850 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2855 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2856 void (*func
) (void);
2859 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2860 /* `where' is not used in the case of SPECPDL_LET. */
2861 Lisp_Object symbol
, old_value
, where
;
2864 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2865 bool_bf debug_on_exit
: 1;
2866 Lisp_Object function
;
2872 extern union specbinding
*specpdl
;
2873 extern union specbinding
*specpdl_ptr
;
2874 extern ptrdiff_t specpdl_size
;
2877 SPECPDL_INDEX (void)
2879 return specpdl_ptr
- specpdl
;
2882 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2883 control structures. A struct handler contains all the information needed to
2884 restore the state of the interpreter after a non-local jump.
2886 handler structures are chained together in a doubly linked list; the `next'
2887 member points to the next outer catchtag and the `nextfree' member points in
2888 the other direction to the next inner element (which is typically the next
2889 free element since we mostly use it on the deepest handler).
2891 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2892 member is TAG, and then unbinds to it. The `val' member is used to
2893 hold VAL while the stack is unwound; `val' is returned as the value
2896 All the other members are concerned with restoring the interpreter
2899 Members are volatile if their values need to survive _longjmp when
2900 a 'struct handler' is a local variable. */
2902 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2906 enum handlertype type
;
2907 Lisp_Object tag_or_ch
;
2909 struct handler
*next
;
2910 struct handler
*nextfree
;
2912 /* The bytecode interpreter can have several handlers active at the same
2913 time, so when we longjmp to one of them, it needs to know which handler
2914 this was and what was the corresponding internal state. This is stored
2915 here, and when we longjmp we make sure that handlerlist points to the
2917 Lisp_Object
*bytecode_top
;
2920 /* Most global vars are reset to their value via the specpdl mechanism,
2921 but a few others are handled by storing their value here. */
2922 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
2923 struct gcpro
*gcpro
;
2926 EMACS_INT lisp_eval_depth
;
2928 int poll_suppress_count
;
2929 int interrupt_input_blocked
;
2930 struct byte_stack
*byte_stack
;
2933 /* Fill in the components of c, and put it on the list. */
2934 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2935 if (handlerlist->nextfree) \
2936 (c) = handlerlist->nextfree; \
2939 (c) = xmalloc (sizeof (struct handler)); \
2940 (c)->nextfree = NULL; \
2941 handlerlist->nextfree = (c); \
2943 (c)->type = (handlertype); \
2944 (c)->tag_or_ch = (tag_ch_val); \
2946 (c)->next = handlerlist; \
2947 (c)->lisp_eval_depth = lisp_eval_depth; \
2948 (c)->pdlcount = SPECPDL_INDEX (); \
2949 (c)->poll_suppress_count = poll_suppress_count; \
2950 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2951 (c)->gcpro = gcprolist; \
2952 (c)->byte_stack = byte_stack_list; \
2956 extern Lisp_Object memory_signal_data
;
2958 /* An address near the bottom of the stack.
2959 Tells GC how to save a copy of the stack. */
2960 extern char *stack_bottom
;
2962 /* Check quit-flag and quit if it is non-nil.
2963 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2964 So the program needs to do QUIT at times when it is safe to quit.
2965 Every loop that might run for a long time or might not exit
2966 ought to do QUIT at least once, at a safe place.
2967 Unless that is impossible, of course.
2968 But it is very desirable to avoid creating loops where QUIT is impossible.
2970 Exception: if you set immediate_quit to true,
2971 then the handler that responds to the C-g does the quit itself.
2972 This is a good thing to do around a loop that has no side effects
2973 and (in particular) cannot call arbitrary Lisp code.
2975 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2976 a request to exit Emacs when it is safe to do. */
2978 extern void process_pending_signals (void);
2979 extern bool volatile pending_signals
;
2981 extern void process_quit_flag (void);
2984 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2985 process_quit_flag (); \
2986 else if (pending_signals) \
2987 process_pending_signals (); \
2991 /* True if ought to quit now. */
2993 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2995 extern Lisp_Object Vascii_downcase_table
;
2996 extern Lisp_Object Vascii_canon_table
;
2998 /* Structure for recording stack slots that need marking. */
3000 /* This is a chain of structures, each of which points at a Lisp_Object
3001 variable whose value should be marked in garbage collection.
3002 Normally every link of the chain is an automatic variable of a function,
3003 and its `val' points to some argument or local variable of the function.
3004 On exit to the function, the chain is set back to the value it had on entry.
3005 This way, no link remains in the chain when the stack frame containing the
3008 Every function that can call Feval must protect in this fashion all
3009 Lisp_Object variables whose contents will be used again. */
3011 extern struct gcpro
*gcprolist
;
3017 /* Address of first protected variable. */
3018 volatile Lisp_Object
*var
;
3020 /* Number of consecutive protected variables. */
3024 /* File name where this record is used. */
3027 /* Line number in this file. */
3030 /* Index in the local chain of records. */
3033 /* Nesting level. */
3038 /* Values of GC_MARK_STACK during compilation:
3040 0 Use GCPRO as before
3041 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
3042 2 Mark the stack, and check that everything GCPRO'd is
3044 3 Mark using GCPRO's, mark stack last, and count how many
3045 dead objects are kept alive.
3047 Formerly, method 0 was used. Currently, method 1 is used unless
3048 otherwise specified by hand when building, e.g.,
3049 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
3050 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
3052 #define GC_USE_GCPROS_AS_BEFORE 0
3053 #define GC_MAKE_GCPROS_NOOPS 1
3054 #define GC_MARK_STACK_CHECK_GCPROS 2
3055 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
3057 #ifndef GC_MARK_STACK
3058 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
3061 /* Whether we do the stack marking manually. */
3062 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
3063 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
3066 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
3068 /* Do something silly with gcproN vars just so gcc shuts up. */
3069 /* You get warnings from MIPSPro... */
3071 #define GCPRO1(varname) ((void) gcpro1)
3072 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
3073 #define GCPRO3(varname1, varname2, varname3) \
3074 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
3075 #define GCPRO4(varname1, varname2, varname3, varname4) \
3076 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3077 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3078 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3079 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3080 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
3082 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
3083 #define UNGCPRO ((void) 0)
3085 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3090 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3091 gcprolist = &gcpro1; }
3093 #define GCPRO2(a, b) \
3094 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3095 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3096 gcprolist = &gcpro2; }
3098 #define GCPRO3(a, b, c) \
3099 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3100 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3101 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3102 gcprolist = &gcpro3; }
3104 #define GCPRO4(a, b, c, d) \
3105 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3106 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3107 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3108 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3109 gcprolist = &gcpro4; }
3111 #define GCPRO5(a, b, c, d, e) \
3112 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3113 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3114 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3115 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3116 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3117 gcprolist = &gcpro5; }
3119 #define GCPRO6(a, b, c, d, e, f) \
3120 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3121 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3122 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3123 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3124 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3125 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3126 gcprolist = &gcpro6; }
3128 #define GCPRO7(a, b, c, d, e, f, g) \
3129 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3130 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3131 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3132 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3133 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3134 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3135 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3136 gcprolist = &gcpro7; }
3138 #define UNGCPRO (gcprolist = gcpro1.next)
3140 #else /* !DEBUG_GCPRO */
3142 extern int gcpro_level
;
3145 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3146 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3147 gcpro1.level = gcpro_level++; \
3148 gcprolist = &gcpro1; }
3150 #define GCPRO2(a, b) \
3151 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3152 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3153 gcpro1.level = gcpro_level; \
3154 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3155 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3156 gcpro2.level = gcpro_level++; \
3157 gcprolist = &gcpro2; }
3159 #define GCPRO3(a, b, c) \
3160 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3161 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3162 gcpro1.level = gcpro_level; \
3163 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3164 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3165 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3166 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3167 gcpro3.level = gcpro_level++; \
3168 gcprolist = &gcpro3; }
3170 #define GCPRO4(a, b, c, d) \
3171 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3172 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3173 gcpro1.level = gcpro_level; \
3174 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3175 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3176 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3177 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3178 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3179 gcpro4.name = __FILE__; gcpro4.lineno = __LINE__; gcpro4.idx = 4; \
3180 gcpro4.level = gcpro_level++; \
3181 gcprolist = &gcpro4; }
3183 #define GCPRO5(a, b, c, d, e) \
3184 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3185 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3186 gcpro1.level = gcpro_level; \
3187 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3188 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3189 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3190 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3191 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3192 gcpro4.name = __FILE__; gcpro4.lineno = __LINE__; gcpro4.idx = 4; \
3193 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3194 gcpro5.name = __FILE__; gcpro5.lineno = __LINE__; gcpro5.idx = 5; \
3195 gcpro5.level = gcpro_level++; \
3196 gcprolist = &gcpro5; }
3198 #define GCPRO6(a, b, c, d, e, f) \
3199 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3200 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3201 gcpro1.level = gcpro_level; \
3202 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3203 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3204 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3205 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3206 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3207 gcpro4.name = __FILE__; gcpro4.lineno = __LINE__; gcpro4.idx = 4; \
3208 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3209 gcpro5.name = __FILE__; gcpro5.lineno = __LINE__; gcpro5.idx = 5; \
3210 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3211 gcpro6.name = __FILE__; gcpro6.lineno = __LINE__; gcpro6.idx = 6; \
3212 gcpro6.level = gcpro_level++; \
3213 gcprolist = &gcpro6; }
3215 #define GCPRO7(a, b, c, d, e, f, g) \
3216 { gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3217 gcpro1.name = __FILE__; gcpro1.lineno = __LINE__; gcpro1.idx = 1; \
3218 gcpro1.level = gcpro_level; \
3219 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3220 gcpro2.name = __FILE__; gcpro2.lineno = __LINE__; gcpro2.idx = 2; \
3221 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3222 gcpro3.name = __FILE__; gcpro3.lineno = __LINE__; gcpro3.idx = 3; \
3223 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3224 gcpro4.name = __FILE__; gcpro4.lineno = __LINE__; gcpro4.idx = 4; \
3225 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3226 gcpro5.name = __FILE__; gcpro5.lineno = __LINE__; gcpro5.idx = 5; \
3227 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3228 gcpro6.name = __FILE__; gcpro6.lineno = __LINE__; gcpro6.idx = 6; \
3229 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3230 gcpro7.name = __FILE__; gcpro7.lineno = __LINE__; gcpro7.idx = 7; \
3231 gcpro7.level = gcpro_level++; \
3232 gcprolist = &gcpro7; }
3235 (--gcpro_level != gcpro1.level \
3237 : (void) (gcprolist = gcpro1.next))
3239 #endif /* DEBUG_GCPRO */
3240 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3243 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
3244 #define RETURN_UNGCPRO(expr) \
3247 Lisp_Object ret_ungc_val; \
3248 ret_ungc_val = (expr); \
3250 return ret_ungc_val; \
3254 /* Call staticpro (&var) to protect static variable `var'. */
3256 void staticpro (Lisp_Object
*);
3258 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
3259 meaning as in the DEFUN macro, and is used to construct a prototype. */
3260 /* We can use the same trick as in the DEFUN macro to generate the
3261 appropriate prototype. */
3262 #define EXFUN(fnname, maxargs) \
3263 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
3265 #include "globals.h"
3267 /* Forward declarations for prototypes. */
3271 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3274 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3276 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3277 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3280 /* Functions to modify hash tables. */
3283 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3285 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3289 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3291 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3294 /* Use these functions to set Lisp_Object
3295 or pointer slots of struct Lisp_Symbol. */
3298 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3300 XSYMBOL (sym
)->function
= function
;
3304 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3306 XSYMBOL (sym
)->plist
= plist
;
3310 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3312 XSYMBOL (sym
)->next
= next
;
3315 /* Buffer-local (also frame-local) variable access functions. */
3318 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3320 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3324 /* Set overlay's property list. */
3327 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3329 XOVERLAY (overlay
)->plist
= plist
;
3332 /* Get text properties of S. */
3335 string_intervals (Lisp_Object s
)
3337 return XSTRING (s
)->intervals
;
3340 /* Set text properties of S to I. */
3343 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3345 XSTRING (s
)->intervals
= i
;
3348 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3349 of setting slots directly. */
3352 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3354 XCHAR_TABLE (table
)->defalt
= val
;
3357 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3359 XCHAR_TABLE (table
)->purpose
= val
;
3362 /* Set different slots in (sub)character tables. */
3365 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3367 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3368 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3372 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3374 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3375 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3379 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3381 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3384 /* Defined in data.c. */
3385 extern Lisp_Object Qquote
, Qunbound
;
3386 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3387 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3388 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3389 extern Lisp_Object Qinvalid_read_syntax
;
3390 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3391 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3392 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3393 extern Lisp_Object Qtext_read_only
;
3394 extern Lisp_Object Qinteractive_form
;
3395 extern Lisp_Object Qcircular_list
;
3396 extern Lisp_Object Qsequencep
;
3397 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
3398 extern Lisp_Object Qfboundp
;
3400 extern Lisp_Object Qcdr
;
3402 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3404 extern Lisp_Object Qnumber_or_marker_p
;
3406 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3408 /* Defined in data.c. */
3409 extern Lisp_Object
indirect_function (Lisp_Object
);
3410 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3411 enum Arith_Comparison
{
3416 ARITH_LESS_OR_EQUAL
,
3419 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3420 enum Arith_Comparison comparison
);
3422 /* Convert the integer I to an Emacs representation, either the integer
3423 itself, or a cons of two or three integers, or if all else fails a float.
3424 I should not have side effects. */
3425 #define INTEGER_TO_CONS(i) \
3426 (! FIXNUM_OVERFLOW_P (i) \
3428 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3429 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3430 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3431 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3432 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3433 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3434 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3435 ? Fcons (make_number ((i) >> 16 >> 24), \
3436 Fcons (make_number ((i) >> 16 & 0xffffff), \
3437 make_number ((i) & 0xffff))) \
3440 /* Convert the Emacs representation CONS back to an integer of type
3441 TYPE, storing the result the variable VAR. Signal an error if CONS
3442 is not a valid representation or is out of range for TYPE. */
3443 #define CONS_TO_INTEGER(cons, type, var) \
3444 (TYPE_SIGNED (type) \
3445 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3446 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3447 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3448 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3450 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3451 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3452 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3454 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3455 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3456 extern void syms_of_data (void);
3457 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3459 /* Defined in cmds.c */
3460 extern void syms_of_cmds (void);
3461 extern void keys_of_cmds (void);
3463 /* Defined in coding.c. */
3464 extern Lisp_Object Qcharset
;
3465 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3466 ptrdiff_t, bool, bool, Lisp_Object
);
3467 extern void init_coding (void);
3468 extern void init_coding_once (void);
3469 extern void syms_of_coding (void);
3471 /* Defined in character.c. */
3472 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3473 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3474 extern void syms_of_character (void);
3476 /* Defined in charset.c. */
3477 extern void init_charset (void);
3478 extern void init_charset_once (void);
3479 extern void syms_of_charset (void);
3480 /* Structure forward declarations. */
3483 /* Defined in syntax.c. */
3484 extern void init_syntax_once (void);
3485 extern void syms_of_syntax (void);
3487 /* Defined in fns.c. */
3488 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3489 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3490 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3491 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3492 extern void sweep_weak_hash_tables (void);
3493 extern Lisp_Object Qcursor_in_echo_area
;
3494 extern Lisp_Object Qstring_lessp
;
3495 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3496 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3497 EMACS_UINT
sxhash (Lisp_Object
, int);
3498 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3499 Lisp_Object
, Lisp_Object
);
3500 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3501 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3503 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3504 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3505 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3506 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3507 ptrdiff_t, ptrdiff_t);
3508 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3509 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3510 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3511 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3512 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3513 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3514 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3515 extern void clear_string_char_byte_cache (void);
3516 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3517 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3518 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3519 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3520 extern void syms_of_fns (void);
3522 /* Defined in floatfns.c. */
3523 extern void syms_of_floatfns (void);
3524 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3526 /* Defined in fringe.c. */
3527 extern void syms_of_fringe (void);
3528 extern void init_fringe (void);
3529 #ifdef HAVE_WINDOW_SYSTEM
3530 extern void mark_fringe_data (void);
3531 extern void init_fringe_once (void);
3532 #endif /* HAVE_WINDOW_SYSTEM */
3534 /* Defined in image.c. */
3535 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3536 extern Lisp_Object QCconversion
;
3537 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3538 extern void reset_image_types (void);
3539 extern void syms_of_image (void);
3541 /* Defined in insdel.c. */
3542 extern Lisp_Object Qinhibit_modification_hooks
;
3543 extern Lisp_Object Qregion_extract_function
;
3544 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3545 extern _Noreturn
void buffer_overflow (void);
3546 extern void make_gap (ptrdiff_t);
3547 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3548 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3549 ptrdiff_t, bool, bool);
3550 extern int count_combining_before (const unsigned char *,
3551 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3552 extern int count_combining_after (const unsigned char *,
3553 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3554 extern void insert (const char *, ptrdiff_t);
3555 extern void insert_and_inherit (const char *, ptrdiff_t);
3556 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3558 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3559 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3560 ptrdiff_t, ptrdiff_t, bool);
3561 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3562 extern void insert_char (int);
3563 extern void insert_string (const char *);
3564 extern void insert_before_markers (const char *, ptrdiff_t);
3565 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3566 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3567 ptrdiff_t, ptrdiff_t,
3569 extern void del_range (ptrdiff_t, ptrdiff_t);
3570 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3571 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3572 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3573 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3574 ptrdiff_t, ptrdiff_t, bool);
3575 extern void modify_text (ptrdiff_t, ptrdiff_t);
3576 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3577 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3578 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3579 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3580 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3581 ptrdiff_t, ptrdiff_t);
3582 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3583 ptrdiff_t, ptrdiff_t);
3584 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3585 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3586 const char *, ptrdiff_t, ptrdiff_t, bool);
3587 extern void syms_of_insdel (void);
3589 /* Defined in dispnew.c. */
3590 #if (defined PROFILING \
3591 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3592 _Noreturn
void __executable_start (void);
3594 extern Lisp_Object Vwindow_system
;
3595 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3597 /* Defined in xdisp.c. */
3598 extern Lisp_Object Qinhibit_point_motion_hooks
;
3599 extern Lisp_Object Qinhibit_redisplay
;
3600 extern Lisp_Object Qmenu_bar_update_hook
;
3601 extern Lisp_Object Qwindow_scroll_functions
;
3602 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3603 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3604 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3605 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3606 extern Lisp_Object Qleft_margin
, Qright_margin
;
3607 extern Lisp_Object QCdata
, QCfile
;
3608 extern Lisp_Object QCmap
;
3609 extern Lisp_Object Qrisky_local_variable
;
3610 extern bool noninteractive_need_newline
;
3611 extern Lisp_Object echo_area_buffer
[2];
3612 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3613 extern void check_message_stack (void);
3614 extern void setup_echo_area_for_printing (int);
3615 extern bool push_message (void);
3616 extern void pop_message_unwind (void);
3617 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3618 extern void restore_message (void);
3619 extern Lisp_Object
current_message (void);
3620 extern void clear_message (bool, bool);
3621 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3622 extern void message1 (const char *);
3623 extern void message1_nolog (const char *);
3624 extern void message3 (Lisp_Object
);
3625 extern void message3_nolog (Lisp_Object
);
3626 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3627 extern void message_with_string (const char *, Lisp_Object
, int);
3628 extern void message_log_maybe_newline (void);
3629 extern void update_echo_area (void);
3630 extern void truncate_echo_area (ptrdiff_t);
3631 extern void redisplay (void);
3633 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3634 extern void syms_of_xdisp (void);
3635 extern void init_xdisp (void);
3636 extern Lisp_Object
safe_eval (Lisp_Object
);
3637 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3638 int *, int *, int *, int *, int *);
3640 /* Defined in xsettings.c. */
3641 extern void syms_of_xsettings (void);
3643 /* Defined in vm-limit.c. */
3644 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3646 /* Defined in character.c. */
3647 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3648 ptrdiff_t *, ptrdiff_t *);
3650 /* Defined in alloc.c. */
3651 extern void check_pure_size (void);
3652 extern void free_misc (Lisp_Object
);
3653 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3654 extern void malloc_warning (const char *);
3655 extern _Noreturn
void memory_full (size_t);
3656 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3657 extern bool survives_gc_p (Lisp_Object
);
3658 extern void mark_object (Lisp_Object
);
3659 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3660 extern void refill_memory_reserve (void);
3662 extern const char *pending_malloc_warning
;
3663 extern Lisp_Object zero_vector
;
3664 extern Lisp_Object
*stack_base
;
3665 extern EMACS_INT consing_since_gc
;
3666 extern EMACS_INT gc_relative_threshold
;
3667 extern EMACS_INT memory_full_cons_threshold
;
3668 extern Lisp_Object
list1 (Lisp_Object
);
3669 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3670 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3671 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3672 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3674 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3675 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3677 /* Build a frequently used 2/3/4-integer lists. */
3680 list2i (EMACS_INT x
, EMACS_INT y
)
3682 return list2 (make_number (x
), make_number (y
));
3686 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3688 return list3 (make_number (x
), make_number (y
), make_number (w
));
3692 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3694 return list4 (make_number (x
), make_number (y
),
3695 make_number (w
), make_number (h
));
3698 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3699 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3700 extern _Noreturn
void string_overflow (void);
3701 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3702 extern Lisp_Object
local_string_init (struct Lisp_String
*, char const *,
3704 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3705 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3706 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3708 /* Make unibyte string from C string when the length isn't known. */
3711 build_unibyte_string (const char *str
)
3713 return make_unibyte_string (str
, strlen (str
));
3716 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3717 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3718 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3719 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3720 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3721 extern Lisp_Object
make_specified_string (const char *,
3722 ptrdiff_t, ptrdiff_t, bool);
3723 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3724 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3726 /* Make a string allocated in pure space, use STR as string data. */
3729 build_pure_c_string (const char *str
)
3731 return make_pure_c_string (str
, strlen (str
));
3734 /* Make a string from the data at STR, treating it as multibyte if the
3738 build_string (const char *str
)
3740 return make_string (str
, strlen (str
));
3743 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3744 extern void make_byte_code (struct Lisp_Vector
*);
3745 extern Lisp_Object Qautomatic_gc
;
3746 extern Lisp_Object Qchar_table_extra_slots
;
3747 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3749 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3750 be sure that GC cannot happen until the vector is completely
3751 initialized. E.g. the following code is likely to crash:
3753 v = make_uninit_vector (3);
3755 ASET (v, 1, Ffunction_can_gc ());
3756 ASET (v, 2, obj1); */
3759 make_uninit_vector (ptrdiff_t size
)
3762 struct Lisp_Vector
*p
;
3764 p
= allocate_vector (size
);
3769 /* Like above, but special for sub char-tables. */
3772 make_uninit_sub_char_table (int depth
, int min_char
)
3774 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3775 Lisp_Object v
= make_uninit_vector (slots
);
3777 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3778 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3779 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3783 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3784 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3786 allocate_pseudovector \
3787 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3788 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3789 extern struct window
*allocate_window (void);
3790 extern struct frame
*allocate_frame (void);
3791 extern struct Lisp_Process
*allocate_process (void);
3792 extern Lisp_Object
local_vector_init (struct Lisp_Vector
*, ptrdiff_t,
3794 extern struct terminal
*allocate_terminal (void);
3795 extern bool gc_in_progress
;
3796 extern bool abort_on_gc
;
3797 extern Lisp_Object
make_float (double);
3798 extern void display_malloc_warning (void);
3799 extern ptrdiff_t inhibit_garbage_collection (void);
3800 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3801 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3802 Lisp_Object
, Lisp_Object
);
3803 extern Lisp_Object
make_save_ptr (void *);
3804 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3805 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3806 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3808 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3809 extern void free_save_value (Lisp_Object
);
3810 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3811 extern void free_marker (Lisp_Object
);
3812 extern void free_cons (struct Lisp_Cons
*);
3813 extern void init_alloc_once (void);
3814 extern void init_alloc (void);
3815 extern void syms_of_alloc (void);
3816 extern struct buffer
* allocate_buffer (void);
3817 extern int valid_lisp_object_p (Lisp_Object
);
3818 extern int relocatable_string_data_p (const char *);
3819 #ifdef GC_CHECK_CONS_LIST
3820 extern void check_cons_list (void);
3822 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3826 /* Defined in ralloc.c. */
3827 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3828 extern void r_alloc_free (void **);
3829 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3830 extern void r_alloc_reset_variable (void **, void **);
3831 extern void r_alloc_inhibit_buffer_relocation (int);
3834 /* Defined in chartab.c. */
3835 extern Lisp_Object
copy_char_table (Lisp_Object
);
3836 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3838 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3839 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3841 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3842 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3843 Lisp_Object
, Lisp_Object
,
3844 Lisp_Object
, struct charset
*,
3845 unsigned, unsigned);
3846 extern Lisp_Object
uniprop_table (Lisp_Object
);
3847 extern void syms_of_chartab (void);
3849 /* Defined in print.c. */
3850 extern Lisp_Object Vprin1_to_string_buffer
;
3851 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3852 extern Lisp_Object Qstandard_output
;
3853 extern Lisp_Object Qexternal_debugging_output
;
3854 extern void temp_output_buffer_setup (const char *);
3855 extern int print_level
;
3856 extern Lisp_Object Qprint_escape_newlines
;
3857 extern void write_string (const char *, int);
3858 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3860 extern Lisp_Object internal_with_output_to_temp_buffer
3861 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3862 #define FLOAT_TO_STRING_BUFSIZE 350
3863 extern int float_to_string (char *, double);
3864 extern void init_print_once (void);
3865 extern void syms_of_print (void);
3867 /* Defined in doprnt.c. */
3868 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3870 extern ptrdiff_t esprintf (char *, char const *, ...)
3871 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3872 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3874 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3875 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3876 char const *, va_list)
3877 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3879 /* Defined in lread.c. */
3880 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3881 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3882 extern Lisp_Object Qlexical_binding
;
3883 extern Lisp_Object
check_obarray (Lisp_Object
);
3884 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3885 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3886 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, ptrdiff_t);
3887 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3889 LOADHIST_ATTACH (Lisp_Object x
)
3892 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3894 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3895 Lisp_Object
*, Lisp_Object
, bool);
3896 extern Lisp_Object
string_to_number (char const *, int, bool);
3897 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3899 extern void dir_warning (const char *, Lisp_Object
);
3900 extern void init_obarray (void);
3901 extern void init_lread (void);
3902 extern void syms_of_lread (void);
3905 intern (const char *str
)
3907 return intern_1 (str
, strlen (str
));
3911 intern_c_string (const char *str
)
3913 return intern_c_string_1 (str
, strlen (str
));
3916 /* Defined in eval.c. */
3917 extern EMACS_INT lisp_eval_depth
;
3918 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3919 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3920 extern Lisp_Object Qand_rest
;
3921 extern Lisp_Object Vautoload_queue
;
3922 extern Lisp_Object Vsignaling_function
;
3923 extern Lisp_Object inhibit_lisp_code
;
3924 extern struct handler
*handlerlist
;
3926 /* To run a normal hook, use the appropriate function from the list below.
3927 The calling convention:
3929 if (!NILP (Vrun_hooks))
3930 call1 (Vrun_hooks, Qmy_funny_hook);
3932 should no longer be used. */
3933 extern Lisp_Object Vrun_hooks
;
3934 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3935 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3936 Lisp_Object (*funcall
)
3937 (ptrdiff_t nargs
, Lisp_Object
*args
));
3938 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3939 extern _Noreturn
void xsignal0 (Lisp_Object
);
3940 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3941 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3942 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3944 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3945 extern Lisp_Object
eval_sub (Lisp_Object form
);
3946 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3947 extern Lisp_Object
call0 (Lisp_Object
);
3948 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3949 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3950 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3951 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3952 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3953 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3954 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3955 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3956 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3957 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3958 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3959 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3960 extern Lisp_Object internal_condition_case_n
3961 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3962 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3963 extern void specbind (Lisp_Object
, Lisp_Object
);
3964 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3965 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3966 extern void record_unwind_protect_int (void (*) (int), int);
3967 extern void record_unwind_protect_void (void (*) (void));
3968 extern void record_unwind_protect_nothing (void);
3969 extern void clear_unwind_protect (ptrdiff_t);
3970 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3971 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3972 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3973 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3974 extern _Noreturn
void verror (const char *, va_list)
3975 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3976 extern void un_autoload (Lisp_Object
);
3977 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3978 extern void init_eval_once (void);
3979 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3980 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3981 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3982 extern void init_eval (void);
3983 extern void syms_of_eval (void);
3984 extern void unwind_body (Lisp_Object
);
3985 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
3986 extern void mark_specpdl (void);
3987 extern void get_backtrace (Lisp_Object array
);
3988 Lisp_Object
backtrace_top_function (void);
3989 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3990 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3993 /* Defined in editfns.c. */
3994 extern Lisp_Object Qfield
;
3995 extern void insert1 (Lisp_Object
);
3996 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3997 extern Lisp_Object
save_excursion_save (void);
3998 extern Lisp_Object
save_restriction_save (void);
3999 extern void save_excursion_restore (Lisp_Object
);
4000 extern void save_restriction_restore (Lisp_Object
);
4001 extern _Noreturn
void time_overflow (void);
4002 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
4003 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
4005 extern void init_editfns (void);
4006 extern void syms_of_editfns (void);
4007 extern void set_time_zone_rule (const char *);
4009 /* Defined in buffer.c. */
4010 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
4011 extern _Noreturn
void nsberror (Lisp_Object
);
4012 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
4013 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
4014 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
4015 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
4016 Lisp_Object
, Lisp_Object
, Lisp_Object
);
4017 extern bool overlay_touches_p (ptrdiff_t);
4018 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
4019 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
4020 extern void init_buffer_once (void);
4021 extern void init_buffer (int);
4022 extern void syms_of_buffer (void);
4023 extern void keys_of_buffer (void);
4025 /* Defined in marker.c. */
4027 extern ptrdiff_t marker_position (Lisp_Object
);
4028 extern ptrdiff_t marker_byte_position (Lisp_Object
);
4029 extern void clear_charpos_cache (struct buffer
*);
4030 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
4031 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
4032 extern void unchain_marker (struct Lisp_Marker
*marker
);
4033 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4034 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
4035 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
4036 ptrdiff_t, ptrdiff_t);
4037 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
4038 extern void syms_of_marker (void);
4040 /* Defined in fileio.c. */
4042 extern Lisp_Object Qfile_error
;
4043 extern Lisp_Object Qfile_notify_error
;
4044 extern Lisp_Object Qfile_exists_p
;
4045 extern Lisp_Object Qfile_directory_p
;
4046 extern Lisp_Object Qinsert_file_contents
;
4047 extern Lisp_Object Qfile_name_history
;
4048 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
4049 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4050 Lisp_Object
, Lisp_Object
, Lisp_Object
,
4052 extern void close_file_unwind (int);
4053 extern void fclose_unwind (void *);
4054 extern void restore_point_unwind (Lisp_Object
);
4055 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
4056 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
4057 extern bool internal_delete_file (Lisp_Object
);
4058 extern Lisp_Object
emacs_readlinkat (int, const char *);
4059 extern bool file_directory_p (const char *);
4060 extern bool file_accessible_directory_p (Lisp_Object
);
4061 extern void init_fileio (void);
4062 extern void syms_of_fileio (void);
4063 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
4064 extern Lisp_Object Qdelete_file
;
4066 /* Defined in search.c. */
4067 extern void shrink_regexp_cache (void);
4068 extern void restore_search_regs (void);
4069 extern void record_unwind_save_match_data (void);
4070 struct re_registers
;
4071 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4072 struct re_registers
*,
4073 Lisp_Object
, bool, bool);
4074 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
4075 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4077 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
4078 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4079 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4080 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4081 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4082 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4084 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4085 ptrdiff_t, ptrdiff_t *);
4086 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4087 ptrdiff_t, ptrdiff_t *);
4088 extern void syms_of_search (void);
4089 extern void clear_regexp_cache (void);
4091 /* Defined in minibuf.c. */
4093 extern Lisp_Object Qcompletion_ignore_case
;
4094 extern Lisp_Object Vminibuffer_list
;
4095 extern Lisp_Object last_minibuf_string
;
4096 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4097 extern void init_minibuf_once (void);
4098 extern void syms_of_minibuf (void);
4100 /* Defined in callint.c. */
4102 extern Lisp_Object Qminus
, Qplus
;
4103 extern Lisp_Object Qprogn
;
4104 extern Lisp_Object Qwhen
;
4105 extern Lisp_Object Qmouse_leave_buffer_hook
;
4106 extern void syms_of_callint (void);
4108 /* Defined in casefiddle.c. */
4110 extern Lisp_Object Qidentity
;
4111 extern void syms_of_casefiddle (void);
4112 extern void keys_of_casefiddle (void);
4114 /* Defined in casetab.c. */
4116 extern void init_casetab_once (void);
4117 extern void syms_of_casetab (void);
4119 /* Defined in keyboard.c. */
4121 extern Lisp_Object echo_message_buffer
;
4122 extern struct kboard
*echo_kboard
;
4123 extern void cancel_echoing (void);
4124 extern Lisp_Object Qdisabled
, QCfilter
;
4125 extern Lisp_Object Qup
, Qdown
;
4126 extern Lisp_Object last_undo_boundary
;
4127 extern bool input_pending
;
4128 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4129 extern sigjmp_buf return_to_command_loop
;
4131 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4132 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4133 extern void discard_mouse_events (void);
4135 void handle_input_available_signal (int);
4137 extern Lisp_Object pending_funcalls
;
4138 extern bool detect_input_pending (void);
4139 extern bool detect_input_pending_ignore_squeezables (void);
4140 extern bool detect_input_pending_run_timers (bool);
4141 extern void safe_run_hooks (Lisp_Object
);
4142 extern void cmd_error_internal (Lisp_Object
, const char *);
4143 extern Lisp_Object
command_loop_1 (void);
4144 extern Lisp_Object
read_menu_command (void);
4145 extern Lisp_Object
recursive_edit_1 (void);
4146 extern void record_auto_save (void);
4147 extern void force_auto_save_soon (void);
4148 extern void init_keyboard (void);
4149 extern void syms_of_keyboard (void);
4150 extern void keys_of_keyboard (void);
4152 /* Defined in indent.c. */
4153 extern ptrdiff_t current_column (void);
4154 extern void invalidate_current_column (void);
4155 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4156 extern void syms_of_indent (void);
4158 /* Defined in frame.c. */
4159 extern Lisp_Object Qonly
, Qnone
;
4160 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4161 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4162 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4163 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4164 extern void frames_discard_buffer (Lisp_Object
);
4165 extern void syms_of_frame (void);
4167 /* Defined in emacs.c. */
4168 extern char **initial_argv
;
4169 extern int initial_argc
;
4170 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4171 extern bool display_arg
;
4173 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4174 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4175 extern Lisp_Object Qfile_name_handler_alist
;
4176 extern _Noreturn
void terminate_due_to_signal (int, int);
4177 extern Lisp_Object Qkill_emacs
;
4179 extern Lisp_Object Vlibrary_cache
;
4182 void fixup_locale (void);
4183 void synchronize_system_messages_locale (void);
4184 void synchronize_system_time_locale (void);
4186 INLINE
void fixup_locale (void) {}
4187 INLINE
void synchronize_system_messages_locale (void) {}
4188 INLINE
void synchronize_system_time_locale (void) {}
4190 extern void shut_down_emacs (int, Lisp_Object
);
4192 /* True means don't do interactive redisplay and don't change tty modes. */
4193 extern bool noninteractive
;
4195 /* True means remove site-lisp directories from load-path. */
4196 extern bool no_site_lisp
;
4198 /* Pipe used to send exit notification to the daemon parent at
4200 extern int daemon_pipe
[2];
4201 #define IS_DAEMON (daemon_pipe[1] != 0)
4203 /* True if handling a fatal error already. */
4204 extern bool fatal_error_in_progress
;
4206 /* True means don't do use window-system-specific display code. */
4207 extern bool inhibit_window_system
;
4208 /* True means that a filter or a sentinel is running. */
4209 extern bool running_asynch_code
;
4211 /* Defined in process.c. */
4212 extern Lisp_Object QCtype
, Qlocal
;
4213 extern void kill_buffer_processes (Lisp_Object
);
4214 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4215 struct Lisp_Process
*, int);
4216 /* Max value for the first argument of wait_reading_process_output. */
4217 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4218 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4219 The bug merely causes a bogus warning, but the warning is annoying. */
4220 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4222 # define WAIT_READING_MAX INTMAX_MAX
4225 extern void add_timer_wait_descriptor (int);
4227 extern void add_keyboard_wait_descriptor (int);
4228 extern void delete_keyboard_wait_descriptor (int);
4230 extern void add_gpm_wait_descriptor (int);
4231 extern void delete_gpm_wait_descriptor (int);
4233 extern void init_process_emacs (void);
4234 extern void syms_of_process (void);
4235 extern void setup_process_coding_systems (Lisp_Object
);
4237 /* Defined in callproc.c. */
4241 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4242 extern void init_callproc_1 (void);
4243 extern void init_callproc (void);
4244 extern void set_initial_environment (void);
4245 extern void syms_of_callproc (void);
4247 /* Defined in doc.c. */
4248 extern Lisp_Object Qfunction_documentation
;
4249 extern Lisp_Object
read_doc_string (Lisp_Object
);
4250 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4251 extern void syms_of_doc (void);
4252 extern int read_bytecode_char (bool);
4254 /* Defined in bytecode.c. */
4255 extern void syms_of_bytecode (void);
4256 extern struct byte_stack
*byte_stack_list
;
4258 extern void mark_byte_stack (void);
4260 extern void unmark_byte_stack (void);
4261 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4262 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4264 /* Defined in macros.c. */
4265 extern void init_macros (void);
4266 extern void syms_of_macros (void);
4268 /* Defined in undo.c. */
4269 extern Lisp_Object Qapply
;
4270 extern Lisp_Object Qinhibit_read_only
;
4271 extern void truncate_undo_list (struct buffer
*);
4272 extern void record_insert (ptrdiff_t, ptrdiff_t);
4273 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4274 extern void record_first_change (void);
4275 extern void record_change (ptrdiff_t, ptrdiff_t);
4276 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4277 Lisp_Object
, Lisp_Object
,
4279 extern void syms_of_undo (void);
4280 /* Defined in textprop.c. */
4281 extern Lisp_Object Qmouse_face
;
4282 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
4283 extern Lisp_Object Qminibuffer_prompt
;
4285 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4287 /* Defined in menu.c. */
4288 extern void syms_of_menu (void);
4290 /* Defined in xmenu.c. */
4291 extern void syms_of_xmenu (void);
4293 /* Defined in termchar.h. */
4294 struct tty_display_info
;
4296 /* Defined in termhooks.h. */
4299 /* Defined in sysdep.c. */
4300 #ifndef HAVE_GET_CURRENT_DIR_NAME
4301 extern char *get_current_dir_name (void);
4303 extern void stuff_char (char c
);
4304 extern void init_foreground_group (void);
4305 extern void sys_subshell (void);
4306 extern void sys_suspend (void);
4307 extern void discard_tty_input (void);
4308 extern void init_sys_modes (struct tty_display_info
*);
4309 extern void reset_sys_modes (struct tty_display_info
*);
4310 extern void init_all_sys_modes (void);
4311 extern void reset_all_sys_modes (void);
4312 extern void child_setup_tty (int);
4313 extern void setup_pty (int);
4314 extern int set_window_size (int, int, int);
4315 extern EMACS_INT
get_random (void);
4316 extern void seed_random (void *, ptrdiff_t);
4317 extern void init_random (void);
4318 extern void emacs_backtrace (int);
4319 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4320 extern int emacs_open (const char *, int, int);
4321 extern int emacs_pipe (int[2]);
4322 extern int emacs_close (int);
4323 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4324 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4325 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4326 extern void emacs_perror (char const *);
4328 extern void unlock_all_files (void);
4329 extern void lock_file (Lisp_Object
);
4330 extern void unlock_file (Lisp_Object
);
4331 extern void unlock_buffer (struct buffer
*);
4332 extern void syms_of_filelock (void);
4333 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4335 /* Defined in sound.c. */
4336 extern void syms_of_sound (void);
4338 /* Defined in category.c. */
4339 extern void init_category_once (void);
4340 extern Lisp_Object
char_category_set (int);
4341 extern void syms_of_category (void);
4343 /* Defined in ccl.c. */
4344 extern void syms_of_ccl (void);
4346 /* Defined in dired.c. */
4347 extern void syms_of_dired (void);
4348 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4349 Lisp_Object
, Lisp_Object
,
4352 /* Defined in term.c. */
4353 extern int *char_ins_del_vector
;
4354 extern void syms_of_term (void);
4355 extern _Noreturn
void fatal (const char *msgid
, ...)
4356 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4358 /* Defined in terminal.c. */
4359 extern void syms_of_terminal (void);
4361 /* Defined in font.c. */
4362 extern void syms_of_font (void);
4363 extern void init_font (void);
4365 #ifdef HAVE_WINDOW_SYSTEM
4366 /* Defined in fontset.c. */
4367 extern void syms_of_fontset (void);
4369 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4370 extern Lisp_Object Qfont_param
;
4373 /* Defined in gfilenotify.c */
4374 #ifdef HAVE_GFILENOTIFY
4375 extern void globals_of_gfilenotify (void);
4376 extern void syms_of_gfilenotify (void);
4379 /* Defined in inotify.c */
4381 extern void syms_of_inotify (void);
4384 #ifdef HAVE_W32NOTIFY
4385 /* Defined on w32notify.c. */
4386 extern void syms_of_w32notify (void);
4389 /* Defined in xfaces.c. */
4390 extern Lisp_Object Qdefault
, Qfringe
;
4391 extern Lisp_Object Qscroll_bar
, Qcursor
;
4392 extern Lisp_Object Qmode_line_inactive
;
4393 extern Lisp_Object Qface
;
4394 extern Lisp_Object Qnormal
;
4395 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4396 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4397 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4398 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4399 extern Lisp_Object Qoblique
, Qitalic
;
4400 extern Lisp_Object Vface_alternative_font_family_alist
;
4401 extern Lisp_Object Vface_alternative_font_registry_alist
;
4402 extern void syms_of_xfaces (void);
4404 #ifdef HAVE_X_WINDOWS
4405 /* Defined in xfns.c. */
4406 extern void syms_of_xfns (void);
4408 /* Defined in xsmfns.c. */
4409 extern void syms_of_xsmfns (void);
4411 /* Defined in xselect.c. */
4412 extern void syms_of_xselect (void);
4414 /* Defined in xterm.c. */
4415 extern void syms_of_xterm (void);
4416 #endif /* HAVE_X_WINDOWS */
4418 #ifdef HAVE_WINDOW_SYSTEM
4419 /* Defined in xterm.c, nsterm.m, w32term.c. */
4420 extern char *x_get_keysym_name (int);
4421 #endif /* HAVE_WINDOW_SYSTEM */
4424 /* Defined in xml.c. */
4425 extern void syms_of_xml (void);
4426 extern void xml_cleanup_parser (void);
4430 /* Defined in decompress.c. */
4431 extern void syms_of_decompress (void);
4435 /* Defined in dbusbind.c. */
4436 void syms_of_dbusbind (void);
4440 /* Defined in profiler.c. */
4441 extern bool profiler_memory_running
;
4442 extern void malloc_probe (size_t);
4443 extern void syms_of_profiler (void);
4447 /* Defined in msdos.c, w32.c. */
4448 extern char *emacs_root_dir (void);
4451 /* Defined in lastfile.c. */
4452 extern char my_edata
[];
4453 extern char my_endbss
[];
4454 extern char *my_endbss_static
;
4456 /* True means ^G can quit instantly. */
4457 extern bool immediate_quit
;
4459 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4460 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4461 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4462 extern void xfree (void *);
4463 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4464 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4465 ATTRIBUTE_ALLOC_SIZE ((2,3));
4466 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4468 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4469 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4470 extern void dupstring (char **, char const *);
4472 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4473 null byte. This is like stpcpy, except the source is a Lisp string. */
4476 lispstpcpy (char *dest
, Lisp_Object string
)
4478 ptrdiff_t len
= SBYTES (string
);
4479 memcpy (dest
, SDATA (string
), len
+ 1);
4483 extern void xputenv (const char *);
4485 extern char *egetenv_internal (const char *, ptrdiff_t);
4488 egetenv (const char *var
)
4490 /* When VAR is a string literal, strlen can be optimized away. */
4491 return egetenv_internal (var
, strlen (var
));
4494 /* Set up the name of the machine we're running on. */
4495 extern void init_system_name (void);
4497 /* Return the absolute value of X. X should be a signed integer
4498 expression without side effects, and X's absolute value should not
4499 exceed the maximum for its promoted type. This is called 'eabs'
4500 because 'abs' is reserved by the C standard. */
4501 #define eabs(x) ((x) < 0 ? -(x) : (x))
4503 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4506 #define make_fixnum_or_float(val) \
4507 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4509 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4510 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4512 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4514 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4516 #define USE_SAFE_ALLOCA \
4517 ptrdiff_t sa_avail = MAX_ALLOCA; \
4518 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4520 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4522 /* SAFE_ALLOCA allocates a simple buffer. */
4524 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4525 ? AVAIL_ALLOCA (size) \
4526 : (sa_must_free = true, record_xmalloc (size)))
4528 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4529 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4530 positive. The code is tuned for MULTIPLIER being a constant. */
4532 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4534 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4535 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4538 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4539 sa_must_free = true; \
4540 record_unwind_protect_ptr (xfree, buf); \
4544 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4546 #define SAFE_ALLOCA_STRING(ptr, string) \
4548 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4549 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4552 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4554 #define SAFE_FREE() \
4556 if (sa_must_free) { \
4557 sa_must_free = false; \
4558 unbind_to (sa_count, Qnil); \
4563 /* Return floor (NBYTES / WORD_SIZE). */
4566 lisp_word_count (ptrdiff_t nbytes
)
4571 case 2: return nbytes
>> 1;
4572 case 4: return nbytes
>> 2;
4573 case 8: return nbytes
>> 3;
4574 case 16: return nbytes
>> 4;
4576 return nbytes
/ word_size
- (nbytes
% word_size
< 0);
4579 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4581 #define SAFE_ALLOCA_LISP(buf, nelt) \
4583 if ((nelt) <= lisp_word_count (sa_avail)) \
4584 (buf) = AVAIL_ALLOCA ((nelt) * word_size); \
4585 else if ((nelt) <= min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4588 (buf) = xmalloc ((nelt) * word_size); \
4589 arg_ = make_save_memory (buf, nelt); \
4590 sa_must_free = true; \
4591 record_unwind_protect (free_save_value, arg_); \
4594 memory_full (SIZE_MAX); \
4598 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4599 block-scoped conses and function-scoped vectors and strings. These objects
4600 are not managed by the garbage collector, so they are dangerous: passing
4601 them out of their scope (e.g., to user code) results in undefined behavior.
4602 Conversely, they have better performance because GC is not involved.
4604 This feature is experimental and requires careful debugging. It's enabled
4605 by default if GCC or a compiler that mimics GCC well (like Intel C/C++) is
4606 used, except clang (see notice above). For other compilers, brave users can
4607 compile with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS' to get into the game.
4608 Note that this feature requires GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS. */
4610 /* A struct Lisp_Cons inside a union that is no larger and may be
4616 double d
; intmax_t i
; void *p
;
4618 verify (sizeof (struct Lisp_Cons
) == sizeof (union Aligned_Cons
));
4620 /* Allocate a block-scoped cons. */
4622 #define scoped_cons(car, cdr) \
4623 ((USE_STACK_LISP_OBJECTS \
4624 && alignof (union Aligned_Cons) % GCALIGNMENT == 0) \
4625 ? make_lisp_ptr (&((union Aligned_Cons) {{car, {cdr}}}).s, Lisp_Cons) \
4628 /* Convenient utility macros similar to listX functions. */
4630 #if USE_STACK_LISP_OBJECTS
4631 # define scoped_list1(a) scoped_cons (a, Qnil)
4632 # define scoped_list2(a, b) scoped_cons (a, scoped_list1 (b))
4633 # define scoped_list3(a, b, c) scoped_cons (a, scoped_list2 (b, c))
4634 # define scoped_list4(a, b, c, d) scoped_cons (a, scoped_list3 (b, c, d))
4636 # define scoped_list1(a) list1 (a)
4637 # define scoped_list2(a, b) list2 (a, b)
4638 # define scoped_list3(a, b, c) list3 (a, b, c)
4639 # define scoped_list4(a, b, c, d) list4 (a, b, c, d)
4642 /* Local allocators require both statement expressions and a
4643 GCALIGNMENT-aligned alloca. clang's alloca isn't properly aligned
4644 in some cases. In the absence of solid information, play it safe
4645 for other non-GCC compilers. */
4646 #if (USE_STACK_LISP_OBJECTS && HAVE_STATEMENT_EXPRESSIONS \
4647 && __GNUC__ && !__clang__)
4648 # define USE_LOCAL_ALLOCATORS
4651 /* Any function that uses a local allocator should start with either
4652 'USE_SAFE_ALLOCA; or 'USE_LOCAL_ALLOCA;' (but not both). */
4653 #ifdef USE_LOCAL_ALLOCATORS
4654 # define USE_LOCAL_ALLOCA ptrdiff_t sa_avail = MAX_ALLOCA
4656 # define USE_LOCAL_ALLOCA
4659 #ifdef USE_LOCAL_ALLOCATORS
4661 /* Return a function-scoped cons whose car is X and cdr is Y. */
4663 # define local_cons(x, y) \
4664 (sizeof (struct Lisp_Cons) <= sa_avail \
4666 struct Lisp_Cons *c_ = AVAIL_ALLOCA (sizeof (struct Lisp_Cons)); \
4669 make_lisp_ptr (c_, Lisp_Cons); \
4673 # define local_list1(a) local_cons (a, Qnil)
4674 # define local_list2(a, b) local_cons (a, local_list1 (b))
4675 # define local_list3(a, b, c) local_cons (a, local_list2 (b, c))
4676 # define local_list4(a, b, c, d) local_cons (a, local_list3 (b, c, d))
4678 /* Return a function-scoped vector of length SIZE, with each element
4681 # define make_local_vector(size, init) \
4683 ptrdiff_t size_ = size; \
4685 if (size_ <= lisp_word_count (sa_avail - header_size)) \
4687 void *ptr_ = AVAIL_ALLOCA (size_ * word_size + header_size); \
4688 vec_ = local_vector_init (ptr_, size_, init); \
4691 vec_ = Fmake_vector (make_number (size_), init); \
4695 enum { LISP_STRING_OVERHEAD
= sizeof (struct Lisp_String
) + 1 };
4697 /* Return a function-scoped string with contents DATA and length NBYTES. */
4699 # define make_local_string(data, nbytes) \
4701 ptrdiff_t nbytes_ = nbytes; \
4702 Lisp_Object string_; \
4703 if (nbytes_ <= sa_avail - LISP_STRING_OVERHEAD) \
4705 struct Lisp_String *ptr_ = AVAIL_ALLOCA (LISP_STRING_OVERHEAD \
4707 string_ = local_string_init (ptr_, data, nbytes_); \
4710 string_ = make_string (data, nbytes_); \
4714 /* Return a function-scoped string with contents DATA. */
4716 # define build_local_string(data) \
4717 ({ char const *data1_ = (data); \
4718 make_local_string (data1_, strlen (data1_)); })
4722 /* Safer but slower implementations. */
4724 local_cons (Lisp_Object car
, Lisp_Object cdr
)
4726 return Fcons (car
, cdr
);
4729 local_list1 (Lisp_Object a
)
4734 local_list2 (Lisp_Object a
, Lisp_Object b
)
4736 return list2 (a
, b
);
4739 local_list3 (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
)
4741 return list3 (a
, b
, c
);
4744 local_list4 (Lisp_Object a
, Lisp_Object b
, Lisp_Object c
, Lisp_Object d
)
4746 return list4 (a
, b
, c
, d
);
4749 make_local_vector (ptrdiff_t size
, Lisp_Object init
)
4751 return Fmake_vector (make_number (size
), init
);
4754 make_local_string (char const *str
, ptrdiff_t nbytes
)
4756 return make_string (str
, nbytes
);
4759 build_local_string (const char *str
)
4761 return build_string (str
);
4766 /* Loop over all tails of a list, checking for cycles.
4767 FIXME: Make tortoise and n internal declarations.
4768 FIXME: Unroll the loop body so we don't need `n'. */
4769 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4770 for ((tortoise) = (hare) = (list), (n) = true; \
4772 (hare = XCDR (hare), (n) = !(n), \
4774 ? (EQ (hare, tortoise) \
4775 ? xsignal1 (Qcircular_list, list) \
4777 /* Move tortoise before the next iteration, in case */ \
4778 /* the next iteration does an Fsetcdr. */ \
4779 : (void) ((tortoise) = XCDR (tortoise)))))
4781 /* Do a `for' loop over alist values. */
4783 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4784 for ((list_var) = (head_var); \
4785 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4786 (list_var) = XCDR (list_var))
4788 /* Check whether it's time for GC, and run it if so. */
4793 if ((consing_since_gc
> gc_cons_threshold
4794 && consing_since_gc
> gc_relative_threshold
)
4795 || (!NILP (Vmemory_full
)
4796 && consing_since_gc
> memory_full_cons_threshold
))
4797 Fgarbage_collect ();
4801 functionp (Lisp_Object object
)
4803 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4805 object
= Findirect_function (object
, Qt
);
4807 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4809 /* Autoloaded symbols are functions, except if they load
4810 macros or keymaps. */
4812 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4813 object
= XCDR (object
);
4815 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4820 return XSUBR (object
)->max_args
!= UNEVALLED
;
4821 else if (COMPILEDP (object
))
4823 else if (CONSP (object
))
4825 Lisp_Object car
= XCAR (object
);
4826 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4834 #endif /* EMACS_LISP_H */