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)
41 DEFINE_GDB_SYMBOL_END (ID)
43 This hack is for the benefit of compilers that do not make macro
44 definitions visible to the debugger. It's used for symbols that
45 .gdbinit needs, symbols whose values may not fit in 'int' (where an
46 enum would suffice). */
47 #if defined MAIN_PROGRAM
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__))
76 # define NONPOINTER_BITS 0
78 # define NONPOINTER_BITS GCTYPEBITS
81 /* EMACS_INT - signed integer wide enough to hold an Emacs value
82 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
83 pI - printf length modifier for EMACS_INT
84 EMACS_UINT - unsigned variant of EMACS_INT */
87 # error "INTPTR_MAX misconfigured"
88 # elif INTPTR_MAX <= INT_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
89 typedef int EMACS_INT
;
90 typedef unsigned int EMACS_UINT
;
91 # define EMACS_INT_MAX INT_MAX
93 # elif INTPTR_MAX <= LONG_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
94 typedef long int EMACS_INT
;
95 typedef unsigned long EMACS_UINT
;
96 # define EMACS_INT_MAX LONG_MAX
98 /* Check versus LLONG_MAX, not LLONG_MAX >> NONPOINTER_BITS.
99 In theory this is not safe, but in practice it seems to be OK. */
100 # elif INTPTR_MAX <= LLONG_MAX
101 typedef long long int EMACS_INT
;
102 typedef unsigned long long int EMACS_UINT
;
103 # define EMACS_INT_MAX LLONG_MAX
106 # error "INTPTR_MAX too large"
110 /* Number of bits to put in each character in the internal representation
111 of bool vectors. This should not vary across implementations. */
112 enum { BOOL_VECTOR_BITS_PER_CHAR
=
113 #define BOOL_VECTOR_BITS_PER_CHAR 8
114 BOOL_VECTOR_BITS_PER_CHAR
117 /* An unsigned integer type representing a fixed-length bit sequence,
118 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
119 for speed, but it is unsigned char on weird platforms. */
120 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
121 typedef size_t bits_word
;
122 # define BITS_WORD_MAX SIZE_MAX
123 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
125 typedef unsigned char bits_word
;
126 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
127 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
129 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
131 /* Number of bits in some machine integer types. */
134 BITS_PER_CHAR
= CHAR_BIT
,
135 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
136 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
137 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
140 /* printmax_t and uprintmax_t are types for printing large integers.
141 These are the widest integers that are supported for printing.
142 pMd etc. are conversions for printing them.
143 On C99 hosts, there's no problem, as even the widest integers work.
144 Fall back on EMACS_INT on pre-C99 hosts. */
146 typedef intmax_t printmax_t
;
147 typedef uintmax_t uprintmax_t
;
151 typedef EMACS_INT printmax_t
;
152 typedef EMACS_UINT uprintmax_t
;
157 /* Use pD to format ptrdiff_t values, which suffice for indexes into
158 buffers and strings. Emacs never allocates objects larger than
159 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
160 In C99, pD can always be "t"; configure it here for the sake of
161 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
162 #if PTRDIFF_MAX == INT_MAX
164 #elif PTRDIFF_MAX == LONG_MAX
166 #elif PTRDIFF_MAX == LLONG_MAX
172 /* Extra internal type checking? */
174 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
175 'assume (COND)'. COND should be free of side effects, as it may or
176 may not be evaluated.
178 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
179 defined and suppress_checking is false, and does nothing otherwise.
180 Emacs dies if COND is checked and is false. The suppress_checking
181 variable is initialized to 0 in alloc.c. Set it to 1 using a
182 debugger to temporarily disable aborting on detected internal
183 inconsistencies or error conditions.
185 In some cases, a good compiler may be able to optimize away the
186 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
187 uses eassert to test STRINGP (x), but a particular use of XSTRING
188 is invoked only after testing that STRINGP (x) is true, making the
191 eassume is like eassert except that it also causes the compiler to
192 assume that COND is true afterwards, regardless of whether runtime
193 checking is enabled. This can improve performance in some cases,
194 though it can degrade performance in others. It's often suboptimal
195 for COND to call external functions or access volatile storage. */
197 #ifndef ENABLE_CHECKING
198 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
199 # define eassume(cond) assume (cond)
200 #else /* ENABLE_CHECKING */
202 extern _Noreturn
void die (const char *, const char *, int);
204 extern bool suppress_checking EXTERNALLY_VISIBLE
;
206 # define eassert(cond) \
207 (suppress_checking || (cond) \
209 : die (# cond, __FILE__, __LINE__))
210 # define eassume(cond) \
215 : die (# cond, __FILE__, __LINE__))
216 #endif /* ENABLE_CHECKING */
219 /* Use the configure flag --enable-check-lisp-object-type to make
220 Lisp_Object use a struct type instead of the default int. The flag
221 causes CHECK_LISP_OBJECT_TYPE to be defined. */
223 /***** Select the tagging scheme. *****/
224 /* The following option controls the tagging scheme:
225 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
226 always 0, and we can thus use them to hold tag bits, without
227 restricting our addressing space.
229 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
230 restricting our possible address range.
232 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
233 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
234 on the few static Lisp_Objects used: all the defsubr as well
235 as the two special buffers buffer_defaults and buffer_local_symbols. */
239 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
240 integer constant, for MSVC. */
241 #define GCALIGNMENT 8
243 /* Number of bits in a Lisp_Object value, not counting the tag. */
244 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
246 /* Number of bits in a Lisp fixnum tag. */
247 INTTYPEBITS
= GCTYPEBITS
- 1,
249 /* Number of bits in a Lisp fixnum value, not counting the tag. */
250 FIXNUM_BITS
= VALBITS
+ 1
253 #if GCALIGNMENT != 1 << GCTYPEBITS
254 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
257 /* The maximum value that can be stored in a EMACS_INT, assuming all
258 bits other than the type bits contribute to a nonnegative signed value.
259 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
260 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
262 /* Whether the least-significant bits of an EMACS_INT contain the tag.
263 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
264 a. unnecessary, because the top bits of an EMACS_INT are unused, and
265 b. slower, because it typically requires extra masking.
266 So, USE_LSB_TAG is true only on hosts where it might be useful. */
267 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
268 #define USE_LSB_TAG (EMACS_INT_MAX >> GCTYPEBITS < INTPTR_MAX)
269 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
271 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
272 # error "USE_LSB_TAG not supported on this platform; please report this." \
273 "Try 'configure --with-wide-int' to work around the problem."
278 # define alignas(alignment) /* empty */
280 # error "USE_LSB_TAG requires alignas"
285 /* Some operations are so commonly executed that they are implemented
286 as macros, not functions, because otherwise runtime performance would
287 suffer too much when compiling with GCC without optimization.
288 There's no need to inline everything, just the operations that
289 would otherwise cause a serious performance problem.
291 For each such operation OP, define a macro lisp_h_OP that contains
292 the operation's implementation. That way, OP can be implemented
293 via a macro definition like this:
295 #define OP(x) lisp_h_OP (x)
297 and/or via a function definition like this:
299 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
301 which macro-expands to this:
303 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
305 without worrying about the implementations diverging, since
306 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
307 are intended to be private to this include file, and should not be
310 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
311 functions, once most developers have access to GCC 4.8 or later and
312 can use "gcc -Og" to debug. Maybe in the year 2016. See
315 Commentary for these macros can be found near their corresponding
318 #if CHECK_LISP_OBJECT_TYPE
319 # define lisp_h_XLI(o) ((o).i)
320 # define lisp_h_XIL(i) ((Lisp_Object) { i })
322 # define lisp_h_XLI(o) (o)
323 # define lisp_h_XIL(i) (i)
325 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
326 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
327 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
328 #define lisp_h_CHECK_TYPE(ok, Qxxxp, x) \
329 ((ok) ? (void) 0 : (void) wrong_type_argument (Qxxxp, x))
330 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
331 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
332 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
333 #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0)
334 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
335 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
336 #define lisp_h_NILP(x) EQ (x, Qnil)
337 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
338 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
339 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
340 #define lisp_h_SYMBOL_VAL(sym) \
341 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
342 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
343 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
344 #define lisp_h_XCAR(c) XCONS (c)->car
345 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
346 #define lisp_h_XCONS(a) \
347 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
348 #define lisp_h_XHASH(a) XUINT (a)
349 #define lisp_h_XPNTR(a) ((void *) (intptr_t) (XLI (a) & VALMASK))
350 #define lisp_h_XSYMBOL(a) \
351 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
352 #ifndef GC_CHECK_CONS_LIST
353 # define lisp_h_check_cons_list() ((void) 0)
356 # define lisp_h_make_number(n) \
357 XIL ((EMACS_INT) ((EMACS_UINT) (n) << INTTYPEBITS))
358 # define lisp_h_XFASTINT(a) XINT (a)
359 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
360 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
361 # define lisp_h_XUNTAG(a, type) ((void *) (XLI (a) - (type)))
364 /* When compiling via gcc -O0, define the key operations as macros, as
365 Emacs is too slow otherwise. To disable this optimization, compile
366 with -DINLINING=false. */
367 #if (defined __NO_INLINE__ \
368 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
369 && ! (defined INLINING && ! INLINING))
370 # define XLI(o) lisp_h_XLI (o)
371 # define XIL(i) lisp_h_XIL (i)
372 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
373 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
374 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
375 # define CHECK_TYPE(ok, Qxxxp, x) lisp_h_CHECK_TYPE (ok, Qxxxp, x)
376 # define CONSP(x) lisp_h_CONSP (x)
377 # define EQ(x, y) lisp_h_EQ (x, y)
378 # define FLOATP(x) lisp_h_FLOATP (x)
379 # define INTEGERP(x) lisp_h_INTEGERP (x)
380 # define MARKERP(x) lisp_h_MARKERP (x)
381 # define MISCP(x) lisp_h_MISCP (x)
382 # define NILP(x) lisp_h_NILP (x)
383 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
384 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
385 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
386 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
387 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
388 # define XCAR(c) lisp_h_XCAR (c)
389 # define XCDR(c) lisp_h_XCDR (c)
390 # define XCONS(a) lisp_h_XCONS (a)
391 # define XHASH(a) lisp_h_XHASH (a)
392 # define XPNTR(a) lisp_h_XPNTR (a)
393 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
394 # ifndef GC_CHECK_CONS_LIST
395 # define check_cons_list() lisp_h_check_cons_list ()
398 # define make_number(n) lisp_h_make_number (n)
399 # define XFASTINT(a) lisp_h_XFASTINT (a)
400 # define XINT(a) lisp_h_XINT (a)
401 # define XTYPE(a) lisp_h_XTYPE (a)
402 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
406 /* Define NAME as a lisp.h inline function that returns TYPE and has
407 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
408 ARGS should be parenthesized. Implement the function by calling
410 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
411 INLINE type (name) argdecls { return lisp_h_##name args; }
413 /* like LISP_MACRO_DEFUN, except NAME returns void. */
414 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
415 INLINE void (name) argdecls { lisp_h_##name args; }
418 /* Define the fundamental Lisp data structures. */
420 /* This is the set of Lisp data types. If you want to define a new
421 data type, read the comments after Lisp_Fwd_Type definition
424 /* Lisp integers use 2 tags, to give them one extra bit, thus
425 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
426 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
427 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
429 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
430 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
431 vociferously about them. */
432 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
433 || (defined __SUNPRO_C && __STDC__))
434 #define ENUM_BF(TYPE) unsigned int
436 #define ENUM_BF(TYPE) enum TYPE
442 /* Integer. XINT (obj) is the integer value. */
444 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
446 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
449 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
450 whose first member indicates the subtype. */
453 /* String. XSTRING (object) points to a struct Lisp_String.
454 The length of the string, and its contents, are stored therein. */
455 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
457 /* Vector of Lisp objects, or something resembling it.
458 XVECTOR (object) points to a struct Lisp_Vector, which contains
459 the size and contents. The size field also contains the type
460 information, if it's not a real vector object. */
463 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
469 /* This is the set of data types that share a common structure.
470 The first member of the structure is a type code from this set.
471 The enum values are arbitrary, but we'll use large numbers to make it
472 more likely that we'll spot the error if a random word in memory is
473 mistakenly interpreted as a Lisp_Misc. */
476 Lisp_Misc_Free
= 0x5eab,
479 Lisp_Misc_Save_Value
,
480 /* Currently floats are not a misc type,
481 but let's define this in case we want to change that. */
483 /* This is not a type code. It is for range checking. */
487 /* These are the types of forwarding objects used in the value slot
488 of symbols for special built-in variables whose value is stored in
492 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
493 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
494 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
495 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
496 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
499 /* If you want to define a new Lisp data type, here are some
500 instructions. See the thread at
501 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
504 First, there are already a couple of Lisp types that can be used if
505 your new type does not need to be exposed to Lisp programs nor
506 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
507 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
508 is suitable for temporarily stashing away pointers and integers in
509 a Lisp object. The latter is useful for vector-like Lisp objects
510 that need to be used as part of other objects, but which are never
511 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
514 These two types don't look pretty when printed, so they are
515 unsuitable for Lisp objects that can be exposed to users.
517 To define a new data type, add one more Lisp_Misc subtype or one
518 more pseudovector subtype. Pseudovectors are more suitable for
519 objects with several slots that need to support fast random access,
520 while Lisp_Misc types are for everything else. A pseudovector object
521 provides one or more slots for Lisp objects, followed by struct
522 members that are accessible only from C. A Lisp_Misc object is a
523 wrapper for a C struct that can contain anything you like.
525 Explicit freeing is discouraged for Lisp objects in general. But if
526 you really need to exploit this, use Lisp_Misc (check free_misc in
527 alloc.c to see why). There is no way to free a vectorlike object.
529 To add a new pseudovector type, extend the pvec_type enumeration;
530 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
532 For a Lisp_Misc, you will also need to add your entry to union
533 Lisp_Misc (but make sure the first word has the same structure as
534 the others, starting with a 16-bit member of the Lisp_Misc_Type
535 enumeration and a 1-bit GC markbit) and make sure the overall size
536 of the union is not increased by your addition.
538 For a new pseudovector, it's highly desirable to limit the size
539 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
540 Otherwise you will need to change sweep_vectors (also in alloc.c).
542 Then you will need to add switch branches in print.c (in
543 print_object, to print your object, and possibly also in
544 print_preprocess) and to alloc.c, to mark your object (in
545 mark_object) and to free it (in gc_sweep). The latter is also the
546 right place to call any code specific to your data type that needs
547 to run when the object is recycled -- e.g., free any additional
548 resources allocated for it that are not Lisp objects. You can even
549 make a pointer to the function that frees the resources a slot in
550 your object -- this way, the same object could be used to represent
551 several disparate C structures. */
553 #ifdef CHECK_LISP_OBJECT_TYPE
555 typedef struct { EMACS_INT i
; } Lisp_Object
;
557 #define LISP_INITIALLY_ZERO {0}
559 #undef CHECK_LISP_OBJECT_TYPE
560 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
561 #else /* CHECK_LISP_OBJECT_TYPE */
563 /* If a struct type is not wanted, define Lisp_Object as just a number. */
565 typedef EMACS_INT Lisp_Object
;
566 #define LISP_INITIALLY_ZERO 0
567 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
568 #endif /* CHECK_LISP_OBJECT_TYPE */
570 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
571 At the machine level, these operations are no-ops. */
572 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
573 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
575 /* In the size word of a vector, this bit means the vector has been marked. */
577 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
578 #define ARRAY_MARK_FLAG PTRDIFF_MIN
579 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
581 /* In the size word of a struct Lisp_Vector, this bit means it's really
582 some other vector-like object. */
583 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
584 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
585 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
587 /* In a pseudovector, the size field actually contains a word with one
588 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
589 with PVEC_TYPE_MASK to indicate the actual type. */
601 PVEC_WINDOW_CONFIGURATION
,
604 /* These should be last, check internal_equal to see why. */
608 PVEC_FONT
/* Should be last because it's used for range checking. */
613 /* For convenience, we also store the number of elements in these bits.
614 Note that this size is not necessarily the memory-footprint size, but
615 only the number of Lisp_Object fields (that need to be traced by GC).
616 The distinction is used, e.g., by Lisp_Process, which places extra
617 non-Lisp_Object fields at the end of the structure. */
618 PSEUDOVECTOR_SIZE_BITS
= 12,
619 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
621 /* To calculate the memory footprint of the pseudovector, it's useful
622 to store the size of non-Lisp area in word_size units here. */
623 PSEUDOVECTOR_REST_BITS
= 12,
624 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
625 << PSEUDOVECTOR_SIZE_BITS
),
627 /* Used to extract pseudovector subtype information. */
628 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
629 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
632 /* These functions extract various sorts of values from a Lisp_Object.
633 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
634 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
637 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
638 #define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
639 DEFINE_GDB_SYMBOL_END (VALMASK
)
641 /* Largest and smallest representable fixnum values. These are the C
642 values. They are macros for use in static initializers. */
643 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
644 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
646 /* Extract the pointer hidden within A. */
647 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
651 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
652 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
653 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
654 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
655 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
657 #else /* ! USE_LSB_TAG */
659 /* Although compiled only if ! USE_LSB_TAG, the following functions
660 also work when USE_LSB_TAG; this is to aid future maintenance when
661 the lisp_h_* macros are eventually removed. */
663 /* Make a Lisp integer representing the value of the low order
666 make_number (EMACS_INT n
)
671 n
= u
<< INTTYPEBITS
;
678 /* Extract A's value as a signed integer. */
682 EMACS_INT i
= XLI (a
);
686 i
= u
<< INTTYPEBITS
;
688 return i
>> INTTYPEBITS
;
691 /* Like XINT (A), but may be faster. A must be nonnegative.
692 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
693 integers have zero-bits in their tags. */
695 XFASTINT (Lisp_Object a
)
697 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
702 /* Extract A's type. */
703 INLINE
enum Lisp_Type
704 XTYPE (Lisp_Object a
)
706 EMACS_UINT i
= XLI (a
);
707 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
710 /* Extract A's pointer value, assuming A's type is TYPE. */
712 XUNTAG (Lisp_Object a
, int type
)
716 intptr_t i
= XLI (a
) - type
;
722 #endif /* ! USE_LSB_TAG */
724 /* Extract A's value as an unsigned integer. */
726 XUINT (Lisp_Object a
)
728 EMACS_UINT i
= XLI (a
);
729 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
732 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
733 right now, but XUINT should only be applied to objects we know are
735 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
737 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
739 make_natnum (EMACS_INT n
)
741 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
742 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
745 /* Return true if X and Y are the same object. */
746 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
748 /* Value is true if I doesn't fit into a Lisp fixnum. It is
749 written this way so that it also works if I is of unsigned
750 type or if I is a NaN. */
752 #define FIXNUM_OVERFLOW_P(i) \
753 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
756 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
758 return num
< lower
? lower
: num
<= upper
? num
: upper
;
761 /* Forward declarations. */
763 /* Defined in this file. */
765 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
766 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
767 INLINE
bool BUFFERP (Lisp_Object
);
768 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
769 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
770 INLINE
bool (CONSP
) (Lisp_Object
);
771 INLINE
bool (FLOATP
) (Lisp_Object
);
772 INLINE
bool functionp (Lisp_Object
);
773 INLINE
bool (INTEGERP
) (Lisp_Object
);
774 INLINE
bool (MARKERP
) (Lisp_Object
);
775 INLINE
bool (MISCP
) (Lisp_Object
);
776 INLINE
bool (NILP
) (Lisp_Object
);
777 INLINE
bool OVERLAYP (Lisp_Object
);
778 INLINE
bool PROCESSP (Lisp_Object
);
779 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
780 INLINE
bool SAVE_VALUEP (Lisp_Object
);
781 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
783 INLINE
bool STRINGP (Lisp_Object
);
784 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
785 INLINE
bool SUBRP (Lisp_Object
);
786 INLINE
bool (SYMBOLP
) (Lisp_Object
);
787 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
788 INLINE
bool WINDOWP (Lisp_Object
);
789 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
791 /* Defined in chartab.c. */
792 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
793 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
794 extern int char_table_translate (Lisp_Object
, int);
796 /* Defined in data.c. */
797 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
798 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
799 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
800 extern Lisp_Object Qbool_vector_p
;
801 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
802 extern Lisp_Object Qwindow
;
803 extern Lisp_Object
Ffboundp (Lisp_Object
);
804 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
806 /* Defined in emacs.c. */
807 extern bool initialized
;
808 extern bool might_dump
;
810 /* Defined in eval.c. */
811 extern Lisp_Object Qautoload
;
813 /* Defined in floatfns.c. */
814 extern double extract_float (Lisp_Object
);
816 /* Defined in process.c. */
817 extern Lisp_Object Qprocessp
;
819 /* Defined in window.c. */
820 extern Lisp_Object Qwindowp
;
822 /* Defined in xdisp.c. */
823 extern Lisp_Object Qimage
;
826 /* Extract a value or address from a Lisp_Object. */
828 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
830 INLINE
struct Lisp_Vector
*
831 XVECTOR (Lisp_Object a
)
833 eassert (VECTORLIKEP (a
));
834 return XUNTAG (a
, Lisp_Vectorlike
);
837 INLINE
struct Lisp_String
*
838 XSTRING (Lisp_Object a
)
840 eassert (STRINGP (a
));
841 return XUNTAG (a
, Lisp_String
);
844 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
846 INLINE
struct Lisp_Float
*
847 XFLOAT (Lisp_Object a
)
849 eassert (FLOATP (a
));
850 return XUNTAG (a
, Lisp_Float
);
853 /* Pseudovector types. */
855 INLINE
struct Lisp_Process
*
856 XPROCESS (Lisp_Object a
)
858 eassert (PROCESSP (a
));
859 return XUNTAG (a
, Lisp_Vectorlike
);
862 INLINE
struct window
*
863 XWINDOW (Lisp_Object a
)
865 eassert (WINDOWP (a
));
866 return XUNTAG (a
, Lisp_Vectorlike
);
869 INLINE
struct terminal
*
870 XTERMINAL (Lisp_Object a
)
872 return XUNTAG (a
, Lisp_Vectorlike
);
875 INLINE
struct Lisp_Subr
*
876 XSUBR (Lisp_Object a
)
879 return XUNTAG (a
, Lisp_Vectorlike
);
882 INLINE
struct buffer
*
883 XBUFFER (Lisp_Object a
)
885 eassert (BUFFERP (a
));
886 return XUNTAG (a
, Lisp_Vectorlike
);
889 INLINE
struct Lisp_Char_Table
*
890 XCHAR_TABLE (Lisp_Object a
)
892 eassert (CHAR_TABLE_P (a
));
893 return XUNTAG (a
, Lisp_Vectorlike
);
896 INLINE
struct Lisp_Sub_Char_Table
*
897 XSUB_CHAR_TABLE (Lisp_Object a
)
899 eassert (SUB_CHAR_TABLE_P (a
));
900 return XUNTAG (a
, Lisp_Vectorlike
);
903 INLINE
struct Lisp_Bool_Vector
*
904 XBOOL_VECTOR (Lisp_Object a
)
906 eassert (BOOL_VECTOR_P (a
));
907 return XUNTAG (a
, Lisp_Vectorlike
);
910 /* Construct a Lisp_Object from a value or address. */
913 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
915 EMACS_UINT utype
= type
;
916 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
917 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
918 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
923 make_lisp_proc (struct Lisp_Process
*p
)
925 return make_lisp_ptr (p
, Lisp_Vectorlike
);
928 #define XSETINT(a, b) ((a) = make_number (b))
929 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
930 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
931 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
932 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
933 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
934 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
935 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
937 /* Pseudovector types. */
939 #define XSETPVECTYPE(v, code) \
940 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
941 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
942 ((v)->header.size = (PSEUDOVECTOR_FLAG \
943 | ((code) << PSEUDOVECTOR_AREA_BITS) \
944 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
947 /* The cast to struct vectorlike_header * avoids aliasing issues. */
948 #define XSETPSEUDOVECTOR(a, b, code) \
949 XSETTYPED_PSEUDOVECTOR (a, b, \
950 (((struct vectorlike_header *) \
951 XUNTAG (a, Lisp_Vectorlike)) \
954 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
955 (XSETVECTOR (a, b), \
956 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
957 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
959 #define XSETWINDOW_CONFIGURATION(a, b) \
960 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
961 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
962 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
963 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
964 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
965 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
966 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
967 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
968 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
969 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
973 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
, (int ok
, Lisp_Object Qxxxp
, Lisp_Object x
),
976 /* Deprecated and will be removed soon. */
978 #define INTERNAL_FIELD(field) field ## _
980 /* See the macros in intervals.h. */
982 typedef struct interval
*INTERVAL
;
986 /* Car of this cons cell. */
991 /* Cdr of this cons cell. */
994 /* Used to chain conses on a free list. */
995 struct Lisp_Cons
*chain
;
999 /* Take the car or cdr of something known to be a cons cell. */
1000 /* The _addr functions shouldn't be used outside of the minimal set
1001 of code that has to know what a cons cell looks like. Other code not
1002 part of the basic lisp implementation should assume that the car and cdr
1003 fields are not accessible. (What if we want to switch to
1004 a copying collector someday? Cached cons cell field addresses may be
1005 invalidated at arbitrary points.) */
1006 INLINE Lisp_Object
*
1007 xcar_addr (Lisp_Object c
)
1009 return &XCONS (c
)->car
;
1011 INLINE Lisp_Object
*
1012 xcdr_addr (Lisp_Object c
)
1014 return &XCONS (c
)->u
.cdr
;
1017 /* Use these from normal code. */
1018 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
1019 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
1021 /* Use these to set the fields of a cons cell.
1023 Note that both arguments may refer to the same object, so 'n'
1024 should not be read after 'c' is first modified. */
1026 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1031 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1036 /* Take the car or cdr of something whose type is not known. */
1040 return (CONSP (c
) ? XCAR (c
)
1042 : wrong_type_argument (Qlistp
, c
));
1047 return (CONSP (c
) ? XCDR (c
)
1049 : wrong_type_argument (Qlistp
, c
));
1052 /* Take the car or cdr of something whose type is not known. */
1054 CAR_SAFE (Lisp_Object c
)
1056 return CONSP (c
) ? XCAR (c
) : Qnil
;
1059 CDR_SAFE (Lisp_Object c
)
1061 return CONSP (c
) ? XCDR (c
) : Qnil
;
1064 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1069 ptrdiff_t size_byte
;
1070 INTERVAL intervals
; /* Text properties in this string. */
1071 unsigned char *data
;
1074 /* True if STR is a multibyte string. */
1076 STRING_MULTIBYTE (Lisp_Object str
)
1078 return 0 <= XSTRING (str
)->size_byte
;
1081 /* An upper bound on the number of bytes in a Lisp string, not
1082 counting the terminating null. This a tight enough bound to
1083 prevent integer overflow errors that would otherwise occur during
1084 string size calculations. A string cannot contain more bytes than
1085 a fixnum can represent, nor can it be so long that C pointer
1086 arithmetic stops working on the string plus its terminating null.
1087 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1088 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1089 would expose alloc.c internal details that we'd rather keep
1092 This is a macro for use in static initializers. The cast to
1093 ptrdiff_t ensures that the macro is signed. */
1094 #define STRING_BYTES_BOUND \
1095 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1097 /* Mark STR as a unibyte string. */
1098 #define STRING_SET_UNIBYTE(STR) \
1100 if (EQ (STR, empty_multibyte_string)) \
1101 (STR) = empty_unibyte_string; \
1103 XSTRING (STR)->size_byte = -1; \
1106 /* Mark STR as a multibyte string. Assure that STR contains only
1107 ASCII characters in advance. */
1108 #define STRING_SET_MULTIBYTE(STR) \
1110 if (EQ (STR, empty_unibyte_string)) \
1111 (STR) = empty_multibyte_string; \
1113 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1116 /* Convenience functions for dealing with Lisp strings. */
1118 INLINE
unsigned char *
1119 SDATA (Lisp_Object string
)
1121 return XSTRING (string
)->data
;
1124 SSDATA (Lisp_Object string
)
1126 /* Avoid "differ in sign" warnings. */
1127 return (char *) SDATA (string
);
1129 INLINE
unsigned char
1130 SREF (Lisp_Object string
, ptrdiff_t index
)
1132 return SDATA (string
)[index
];
1135 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1137 SDATA (string
)[index
] = new;
1140 SCHARS (Lisp_Object string
)
1142 return XSTRING (string
)->size
;
1145 #ifdef GC_CHECK_STRING_BYTES
1146 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1149 STRING_BYTES (struct Lisp_String
*s
)
1151 #ifdef GC_CHECK_STRING_BYTES
1152 return string_bytes (s
);
1154 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1159 SBYTES (Lisp_Object string
)
1161 return STRING_BYTES (XSTRING (string
));
1164 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1166 XSTRING (string
)->size
= newsize
;
1169 STRING_COPYIN (Lisp_Object string
, ptrdiff_t index
, char const *new,
1172 memcpy (SDATA (string
) + index
, new, count
);
1175 /* Header of vector-like objects. This documents the layout constraints on
1176 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1177 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1178 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1179 because when two such pointers potentially alias, a compiler won't
1180 incorrectly reorder loads and stores to their size fields. See
1182 struct vectorlike_header
1184 /* The only field contains various pieces of information:
1185 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1186 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1187 vector (0) or a pseudovector (1).
1188 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1189 of slots) of the vector.
1190 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1191 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1192 - b) number of Lisp_Objects slots at the beginning of the object
1193 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1195 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1196 measured in word_size units. Rest fields may also include
1197 Lisp_Objects, but these objects usually needs some special treatment
1199 There are some exceptions. For PVEC_FREE, b) is always zero. For
1200 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1201 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1202 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1206 /* A regular vector is just a header plus an array of Lisp_Objects. */
1210 struct vectorlike_header header
;
1211 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1214 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1217 ALIGNOF_STRUCT_LISP_VECTOR
1218 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1221 /* A boolvector is a kind of vectorlike, with contents like a string. */
1223 struct Lisp_Bool_Vector
1225 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1226 just the subtype information. */
1227 struct vectorlike_header header
;
1228 /* This is the size in bits. */
1230 /* The actual bits, packed into bytes.
1231 Zeros fill out the last word if needed.
1232 The bits are in little-endian order in the bytes, and
1233 the bytes are in little-endian order in the words. */
1234 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1238 bool_vector_size (Lisp_Object a
)
1240 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1241 eassume (0 <= size
);
1246 bool_vector_data (Lisp_Object a
)
1248 return XBOOL_VECTOR (a
)->data
;
1251 INLINE
unsigned char *
1252 bool_vector_uchar_data (Lisp_Object a
)
1254 return (unsigned char *) bool_vector_data (a
);
1257 /* The number of data words and bytes in a bool vector with SIZE bits. */
1260 bool_vector_words (EMACS_INT size
)
1262 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1263 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1267 bool_vector_bytes (EMACS_INT size
)
1269 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1270 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1273 /* True if A's Ith bit is set. */
1276 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1278 eassume (0 <= i
&& i
< bool_vector_size (a
));
1279 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1280 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1284 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1286 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1289 /* Set A's Ith bit to B. */
1292 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1294 unsigned char *addr
;
1296 eassume (0 <= i
&& i
< bool_vector_size (a
));
1297 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1300 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1302 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1305 /* Some handy constants for calculating sizes
1306 and offsets, mostly of vectorlike objects. */
1310 header_size
= offsetof (struct Lisp_Vector
, contents
),
1311 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1312 word_size
= sizeof (Lisp_Object
)
1315 /* Conveniences for dealing with Lisp arrays. */
1318 AREF (Lisp_Object array
, ptrdiff_t idx
)
1320 return XVECTOR (array
)->contents
[idx
];
1323 INLINE Lisp_Object
*
1324 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1326 return & XVECTOR (array
)->contents
[idx
];
1330 ASIZE (Lisp_Object array
)
1332 return XVECTOR (array
)->header
.size
;
1336 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1338 eassert (0 <= idx
&& idx
< ASIZE (array
));
1339 XVECTOR (array
)->contents
[idx
] = val
;
1343 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1345 /* Like ASET, but also can be used in the garbage collector:
1346 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1347 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
1348 XVECTOR (array
)->contents
[idx
] = val
;
1351 /* If a struct is made to look like a vector, this macro returns the length
1352 of the shortest vector that would hold that struct. */
1354 #define VECSIZE(type) \
1355 ((sizeof (type) - header_size + word_size - 1) / word_size)
1357 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1358 at the end and we need to compute the number of Lisp_Object fields (the
1359 ones that the GC needs to trace). */
1361 #define PSEUDOVECSIZE(type, nonlispfield) \
1362 ((offsetof (type, nonlispfield) - header_size) / word_size)
1364 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1365 should be integer expressions. This is not the same as
1366 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1367 returns true. For efficiency, prefer plain unsigned comparison if A
1368 and B's sizes both fit (after integer promotion). */
1369 #define UNSIGNED_CMP(a, op, b) \
1370 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1371 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1372 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1374 /* True iff C is an ASCII character. */
1375 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1377 /* A char-table is a kind of vectorlike, with contents are like a
1378 vector but with a few other slots. For some purposes, it makes
1379 sense to handle a char-table with type struct Lisp_Vector. An
1380 element of a char table can be any Lisp objects, but if it is a sub
1381 char-table, we treat it a table that contains information of a
1382 specific range of characters. A sub char-table has the same
1383 structure as a vector. A sub char table appears only in an element
1384 of a char-table, and there's no way to access it directly from
1385 Emacs Lisp program. */
1387 enum CHARTAB_SIZE_BITS
1389 CHARTAB_SIZE_BITS_0
= 6,
1390 CHARTAB_SIZE_BITS_1
= 4,
1391 CHARTAB_SIZE_BITS_2
= 5,
1392 CHARTAB_SIZE_BITS_3
= 7
1395 extern const int chartab_size
[4];
1397 struct Lisp_Char_Table
1399 /* HEADER.SIZE is the vector's size field, which also holds the
1400 pseudovector type information. It holds the size, too.
1401 The size counts the defalt, parent, purpose, ascii,
1402 contents, and extras slots. */
1403 struct vectorlike_header header
;
1405 /* This holds a default value,
1406 which is used whenever the value for a specific character is nil. */
1409 /* This points to another char table, which we inherit from when the
1410 value for a specific character is nil. The `defalt' slot takes
1411 precedence over this. */
1414 /* This is a symbol which says what kind of use this char-table is
1416 Lisp_Object purpose
;
1418 /* The bottom sub char-table for characters of the range 0..127. It
1419 is nil if none of ASCII character has a specific value. */
1422 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1424 /* These hold additional data. It is a vector. */
1425 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1428 struct Lisp_Sub_Char_Table
1430 /* HEADER.SIZE is the vector's size field, which also holds the
1431 pseudovector type information. It holds the size, too. */
1432 struct vectorlike_header header
;
1434 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1435 char-table of depth 1 contains 16 elements, and each element
1436 covers 4096 (128*32) characters. A sub char-table of depth 2
1437 contains 32 elements, and each element covers 128 characters. A
1438 sub char-table of depth 3 contains 128 elements, and each element
1439 is for one character. */
1442 /* Minimum character covered by the sub char-table. */
1443 Lisp_Object min_char
;
1445 /* Use set_sub_char_table_contents to set this. */
1446 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1450 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1452 struct Lisp_Char_Table
*tbl
= NULL
;
1456 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1457 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1458 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1462 while (NILP (val
) && ! NILP (tbl
->parent
));
1467 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1468 characters. Do not check validity of CT. */
1470 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1472 return (ASCII_CHAR_P (idx
)
1473 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1474 : char_table_ref (ct
, idx
));
1477 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1478 8-bit European characters. Do not check validity of CT. */
1480 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1482 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1483 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1485 char_table_set (ct
, idx
, val
);
1488 /* This structure describes a built-in function.
1489 It is generated by the DEFUN macro only.
1490 defsubr makes it into a Lisp object. */
1494 struct vectorlike_header header
;
1496 Lisp_Object (*a0
) (void);
1497 Lisp_Object (*a1
) (Lisp_Object
);
1498 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1499 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1500 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1501 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1502 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1503 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1504 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1505 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1506 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1508 short min_args
, max_args
;
1509 const char *symbol_name
;
1510 const char *intspec
;
1514 /* This is the number of slots that every char table must have. This
1515 counts the ordinary slots and the top, defalt, parent, and purpose
1517 enum CHAR_TABLE_STANDARD_SLOTS
1519 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1522 /* Return the number of "extra" slots in the char table CT. */
1525 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1527 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1528 - CHAR_TABLE_STANDARD_SLOTS
);
1532 /***********************************************************************
1534 ***********************************************************************/
1536 /* Interned state of a symbol. */
1538 enum symbol_interned
1540 SYMBOL_UNINTERNED
= 0,
1541 SYMBOL_INTERNED
= 1,
1542 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1545 enum symbol_redirect
1547 SYMBOL_PLAINVAL
= 4,
1548 SYMBOL_VARALIAS
= 1,
1549 SYMBOL_LOCALIZED
= 2,
1550 SYMBOL_FORWARDED
= 3
1555 bool_bf gcmarkbit
: 1;
1557 /* Indicates where the value can be found:
1558 0 : it's a plain var, the value is in the `value' field.
1559 1 : it's a varalias, the value is really in the `alias' symbol.
1560 2 : it's a localized var, the value is in the `blv' object.
1561 3 : it's a forwarding variable, the value is in `forward'. */
1562 ENUM_BF (symbol_redirect
) redirect
: 3;
1564 /* Non-zero means symbol is constant, i.e. changing its value
1565 should signal an error. If the value is 3, then the var
1566 can be changed, but only by `defconst'. */
1567 unsigned constant
: 2;
1569 /* Interned state of the symbol. This is an enumerator from
1570 enum symbol_interned. */
1571 unsigned interned
: 2;
1573 /* True means that this variable has been explicitly declared
1574 special (with `defvar' etc), and shouldn't be lexically bound. */
1575 bool_bf declared_special
: 1;
1577 /* True if pointed to from purespace and hence can't be GC'd. */
1580 /* The symbol's name, as a Lisp string. */
1583 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1584 union is used depends on the `redirect' field above. */
1587 struct Lisp_Symbol
*alias
;
1588 struct Lisp_Buffer_Local_Value
*blv
;
1589 union Lisp_Fwd
*fwd
;
1592 /* Function value of the symbol or Qnil if not fboundp. */
1593 Lisp_Object function
;
1595 /* The symbol's property list. */
1598 /* Next symbol in obarray bucket, if the symbol is interned. */
1599 struct Lisp_Symbol
*next
;
1602 /* Value is name of symbol. */
1604 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1606 INLINE
struct Lisp_Symbol
*
1607 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1609 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1610 return sym
->val
.alias
;
1612 INLINE
struct Lisp_Buffer_Local_Value
*
1613 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1615 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1616 return sym
->val
.blv
;
1618 INLINE
union Lisp_Fwd
*
1619 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1621 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1622 return sym
->val
.fwd
;
1625 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1626 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1629 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1631 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1635 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1637 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1641 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1643 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1648 SYMBOL_NAME (Lisp_Object sym
)
1650 return XSYMBOL (sym
)->name
;
1653 /* Value is true if SYM is an interned symbol. */
1656 SYMBOL_INTERNED_P (Lisp_Object sym
)
1658 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1661 /* Value is true if SYM is interned in initial_obarray. */
1664 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1666 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1669 /* Value is non-zero if symbol is considered a constant, i.e. its
1670 value cannot be changed (there is an exception for keyword symbols,
1671 whose value can be set to the keyword symbol itself). */
1673 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1675 #define DEFSYM(sym, name) \
1676 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1679 /***********************************************************************
1681 ***********************************************************************/
1683 /* The structure of a Lisp hash table. */
1685 struct hash_table_test
1687 /* Name of the function used to compare keys. */
1690 /* User-supplied hash function, or nil. */
1691 Lisp_Object user_hash_function
;
1693 /* User-supplied key comparison function, or nil. */
1694 Lisp_Object user_cmp_function
;
1696 /* C function to compare two keys. */
1697 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1699 /* C function to compute hash code. */
1700 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1703 struct Lisp_Hash_Table
1705 /* This is for Lisp; the hash table code does not refer to it. */
1706 struct vectorlike_header header
;
1708 /* Nil if table is non-weak. Otherwise a symbol describing the
1709 weakness of the table. */
1712 /* When the table is resized, and this is an integer, compute the
1713 new size by adding this to the old size. If a float, compute the
1714 new size by multiplying the old size with this factor. */
1715 Lisp_Object rehash_size
;
1717 /* Resize hash table when number of entries/ table size is >= this
1719 Lisp_Object rehash_threshold
;
1721 /* Vector of hash codes. If hash[I] is nil, this means that the
1722 I-th entry is unused. */
1725 /* Vector used to chain entries. If entry I is free, next[I] is the
1726 entry number of the next free item. If entry I is non-free,
1727 next[I] is the index of the next entry in the collision chain. */
1730 /* Index of first free entry in free list. */
1731 Lisp_Object next_free
;
1733 /* Bucket vector. A non-nil entry is the index of the first item in
1734 a collision chain. This vector's size can be larger than the
1735 hash table size to reduce collisions. */
1738 /* Only the fields above are traced normally by the GC. The ones below
1739 `count' are special and are either ignored by the GC or traced in
1740 a special way (e.g. because of weakness). */
1742 /* Number of key/value entries in the table. */
1745 /* Vector of keys and values. The key of item I is found at index
1746 2 * I, the value is found at index 2 * I + 1.
1747 This is gc_marked specially if the table is weak. */
1748 Lisp_Object key_and_value
;
1750 /* The comparison and hash functions. */
1751 struct hash_table_test test
;
1753 /* Next weak hash table if this is a weak hash table. The head
1754 of the list is in weak_hash_tables. */
1755 struct Lisp_Hash_Table
*next_weak
;
1759 INLINE
struct Lisp_Hash_Table
*
1760 XHASH_TABLE (Lisp_Object a
)
1762 return XUNTAG (a
, Lisp_Vectorlike
);
1765 #define XSET_HASH_TABLE(VAR, PTR) \
1766 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1769 HASH_TABLE_P (Lisp_Object a
)
1771 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1774 /* Value is the key part of entry IDX in hash table H. */
1776 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1778 return AREF (h
->key_and_value
, 2 * idx
);
1781 /* Value is the value part of entry IDX in hash table H. */
1783 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1785 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1788 /* Value is the index of the next entry following the one at IDX
1791 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1793 return AREF (h
->next
, idx
);
1796 /* Value is the hash code computed for entry IDX in hash table H. */
1798 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1800 return AREF (h
->hash
, idx
);
1803 /* Value is the index of the element in hash table H that is the
1804 start of the collision list at index IDX in the index vector of H. */
1806 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1808 return AREF (h
->index
, idx
);
1811 /* Value is the size of hash table H. */
1813 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1815 return ASIZE (h
->next
);
1818 /* Default size for hash tables if not specified. */
1820 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1822 /* Default threshold specifying when to resize a hash table. The
1823 value gives the ratio of current entries in the hash table and the
1824 size of the hash table. */
1826 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1828 /* Default factor by which to increase the size of a hash table. */
1830 static double const DEFAULT_REHASH_SIZE
= 1.5;
1832 /* Combine two integers X and Y for hashing. The result might not fit
1833 into a Lisp integer. */
1836 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1838 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1841 /* Hash X, returning a value that fits into a fixnum. */
1844 SXHASH_REDUCE (EMACS_UINT x
)
1846 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1849 /* These structures are used for various misc types. */
1851 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1853 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1854 bool_bf gcmarkbit
: 1;
1855 unsigned spacer
: 15;
1860 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1861 bool_bf gcmarkbit
: 1;
1862 unsigned spacer
: 13;
1863 /* This flag is temporarily used in the functions
1864 decode/encode_coding_object to record that the marker position
1865 must be adjusted after the conversion. */
1866 bool_bf need_adjustment
: 1;
1867 /* True means normal insertion at the marker's position
1868 leaves the marker after the inserted text. */
1869 bool_bf insertion_type
: 1;
1870 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1871 Note: a chain of markers can contain markers pointing into different
1872 buffers (the chain is per buffer_text rather than per buffer, so it's
1873 shared between indirect buffers). */
1874 /* This is used for (other than NULL-checking):
1876 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1877 - unchain_marker: to find the list from which to unchain.
1878 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1880 struct buffer
*buffer
;
1882 /* The remaining fields are meaningless in a marker that
1883 does not point anywhere. */
1885 /* For markers that point somewhere,
1886 this is used to chain of all the markers in a given buffer. */
1887 /* We could remove it and use an array in buffer_text instead.
1888 That would also allow to preserve it ordered. */
1889 struct Lisp_Marker
*next
;
1890 /* This is the char position where the marker points. */
1892 /* This is the byte position.
1893 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1894 used to implement the functionality of markers, but rather to (ab)use
1895 markers as a cache for char<->byte mappings). */
1899 /* START and END are markers in the overlay's buffer, and
1900 PLIST is the overlay's property list. */
1902 /* An overlay's real data content is:
1904 - buffer (really there are two buffer pointers, one per marker,
1905 and both points to the same buffer)
1906 - insertion type of both ends (per-marker fields)
1907 - start & start byte (of start marker)
1908 - end & end byte (of end marker)
1909 - next (singly linked list of overlays)
1910 - next fields of start and end markers (singly linked list of markers).
1911 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1914 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1915 bool_bf gcmarkbit
: 1;
1916 unsigned spacer
: 15;
1917 struct Lisp_Overlay
*next
;
1923 /* Types of data which may be saved in a Lisp_Save_Value. */
1934 /* Number of bits needed to store one of the above values. */
1935 enum { SAVE_SLOT_BITS
= 3 };
1937 /* Number of slots in a save value where save_type is nonzero. */
1938 enum { SAVE_VALUE_SLOTS
= 4 };
1940 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1942 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1946 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1947 SAVE_TYPE_INT_INT_INT
1948 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1949 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1950 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1951 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1952 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1953 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1954 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1955 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1956 SAVE_TYPE_FUNCPTR_PTR_OBJ
1957 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1959 /* This has an extra bit indicating it's raw memory. */
1960 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1963 /* Special object used to hold a different values for later use.
1965 This is mostly used to package C integers and pointers to call
1966 record_unwind_protect when two or more values need to be saved.
1970 struct my_data *md = get_my_data ();
1971 ptrdiff_t mi = get_my_integer ();
1972 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1975 Lisp_Object my_unwind (Lisp_Object arg)
1977 struct my_data *md = XSAVE_POINTER (arg, 0);
1978 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1982 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1983 saved objects and raise eassert if type of the saved object doesn't match
1984 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1985 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1986 slot 0 is a pointer. */
1988 typedef void (*voidfuncptr
) (void);
1990 struct Lisp_Save_Value
1992 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1993 bool_bf gcmarkbit
: 1;
1994 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
1996 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1997 V's data entries are determined by V->save_type. E.g., if
1998 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1999 V->data[1] is an integer, and V's other data entries are unused.
2001 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2002 a memory area containing V->data[1].integer potential Lisp_Objects. */
2003 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2006 voidfuncptr funcpointer
;
2009 } data
[SAVE_VALUE_SLOTS
];
2012 /* Return the type of V's Nth saved value. */
2014 save_type (struct Lisp_Save_Value
*v
, int n
)
2016 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2017 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2020 /* Get and set the Nth saved pointer. */
2023 XSAVE_POINTER (Lisp_Object obj
, int n
)
2025 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2026 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2029 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2031 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2032 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2035 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2037 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2038 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2041 /* Likewise for the saved integer. */
2044 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2046 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2047 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2050 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2052 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2053 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2056 /* Extract Nth saved object. */
2059 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2061 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2062 return XSAVE_VALUE (obj
)->data
[n
].object
;
2065 /* A miscellaneous object, when it's on the free list. */
2068 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2069 bool_bf gcmarkbit
: 1;
2070 unsigned spacer
: 15;
2071 union Lisp_Misc
*chain
;
2074 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2075 It uses one of these struct subtypes to get the type field. */
2079 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2080 struct Lisp_Free u_free
;
2081 struct Lisp_Marker u_marker
;
2082 struct Lisp_Overlay u_overlay
;
2083 struct Lisp_Save_Value u_save_value
;
2086 INLINE
union Lisp_Misc
*
2087 XMISC (Lisp_Object a
)
2089 return XUNTAG (a
, Lisp_Misc
);
2092 INLINE
struct Lisp_Misc_Any
*
2093 XMISCANY (Lisp_Object a
)
2095 eassert (MISCP (a
));
2096 return & XMISC (a
)->u_any
;
2099 INLINE
enum Lisp_Misc_Type
2100 XMISCTYPE (Lisp_Object a
)
2102 return XMISCANY (a
)->type
;
2105 INLINE
struct Lisp_Marker
*
2106 XMARKER (Lisp_Object a
)
2108 eassert (MARKERP (a
));
2109 return & XMISC (a
)->u_marker
;
2112 INLINE
struct Lisp_Overlay
*
2113 XOVERLAY (Lisp_Object a
)
2115 eassert (OVERLAYP (a
));
2116 return & XMISC (a
)->u_overlay
;
2119 INLINE
struct Lisp_Save_Value
*
2120 XSAVE_VALUE (Lisp_Object a
)
2122 eassert (SAVE_VALUEP (a
));
2123 return & XMISC (a
)->u_save_value
;
2126 /* Forwarding pointer to an int variable.
2127 This is allowed only in the value cell of a symbol,
2128 and it means that the symbol's value really lives in the
2129 specified int variable. */
2132 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2136 /* Boolean forwarding pointer to an int variable.
2137 This is like Lisp_Intfwd except that the ostensible
2138 "value" of the symbol is t if the bool variable is true,
2139 nil if it is false. */
2142 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2146 /* Forwarding pointer to a Lisp_Object variable.
2147 This is allowed only in the value cell of a symbol,
2148 and it means that the symbol's value really lives in the
2149 specified variable. */
2152 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2153 Lisp_Object
*objvar
;
2156 /* Like Lisp_Objfwd except that value lives in a slot in the
2157 current buffer. Value is byte index of slot within buffer. */
2158 struct Lisp_Buffer_Objfwd
2160 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2162 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2163 Lisp_Object predicate
;
2166 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2167 the symbol has buffer-local or frame-local bindings. (Exception:
2168 some buffer-local variables are built-in, with their values stored
2169 in the buffer structure itself. They are handled differently,
2170 using struct Lisp_Buffer_Objfwd.)
2172 The `realvalue' slot holds the variable's current value, or a
2173 forwarding pointer to where that value is kept. This value is the
2174 one that corresponds to the loaded binding. To read or set the
2175 variable, you must first make sure the right binding is loaded;
2176 then you can access the value in (or through) `realvalue'.
2178 `buffer' and `frame' are the buffer and frame for which the loaded
2179 binding was found. If those have changed, to make sure the right
2180 binding is loaded it is necessary to find which binding goes with
2181 the current buffer and selected frame, then load it. To load it,
2182 first unload the previous binding, then copy the value of the new
2183 binding into `realvalue' (or through it). Also update
2184 LOADED-BINDING to point to the newly loaded binding.
2186 `local_if_set' indicates that merely setting the variable creates a
2187 local binding for the current buffer. Otherwise the latter, setting
2188 the variable does not do that; only make-local-variable does that. */
2190 struct Lisp_Buffer_Local_Value
2192 /* True means that merely setting the variable creates a local
2193 binding for the current buffer. */
2194 bool_bf local_if_set
: 1;
2195 /* True means this variable can have frame-local bindings, otherwise, it is
2196 can have buffer-local bindings. The two cannot be combined. */
2197 bool_bf frame_local
: 1;
2198 /* True means that the binding now loaded was found.
2199 Presumably equivalent to (defcell!=valcell). */
2201 /* If non-NULL, a forwarding to the C var where it should also be set. */
2202 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2203 /* The buffer or frame for which the loaded binding was found. */
2205 /* A cons cell that holds the default value. It has the form
2206 (SYMBOL . DEFAULT-VALUE). */
2207 Lisp_Object defcell
;
2208 /* The cons cell from `where's parameter alist.
2209 It always has the form (SYMBOL . VALUE)
2210 Note that if `forward' is non-nil, VALUE may be out of date.
2211 Also if the currently loaded binding is the default binding, then
2212 this is `eq'ual to defcell. */
2213 Lisp_Object valcell
;
2216 /* Like Lisp_Objfwd except that value lives in a slot in the
2218 struct Lisp_Kboard_Objfwd
2220 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2226 struct Lisp_Intfwd u_intfwd
;
2227 struct Lisp_Boolfwd u_boolfwd
;
2228 struct Lisp_Objfwd u_objfwd
;
2229 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2230 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2233 INLINE
enum Lisp_Fwd_Type
2234 XFWDTYPE (union Lisp_Fwd
*a
)
2236 return a
->u_intfwd
.type
;
2239 INLINE
struct Lisp_Buffer_Objfwd
*
2240 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2242 eassert (BUFFER_OBJFWDP (a
));
2243 return &a
->u_buffer_objfwd
;
2246 /* Lisp floating point type. */
2252 struct Lisp_Float
*chain
;
2257 XFLOAT_DATA (Lisp_Object f
)
2259 return XFLOAT (f
)->u
.data
;
2262 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2263 representations, have infinities and NaNs, and do not trap on
2264 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2265 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2266 wanted here, but is not quite right because Emacs does not require
2267 all the features of C11 Annex F (and does not require C11 at all,
2268 for that matter). */
2272 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2273 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2276 /* A character, declared with the following typedef, is a member
2277 of some character set associated with the current buffer. */
2278 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2280 typedef unsigned char UCHAR
;
2283 /* Meanings of slots in a Lisp_Compiled: */
2287 COMPILED_ARGLIST
= 0,
2288 COMPILED_BYTECODE
= 1,
2289 COMPILED_CONSTANTS
= 2,
2290 COMPILED_STACK_DEPTH
= 3,
2291 COMPILED_DOC_STRING
= 4,
2292 COMPILED_INTERACTIVE
= 5
2295 /* Flag bits in a character. These also get used in termhooks.h.
2296 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2297 (MUlti-Lingual Emacs) might need 22 bits for the character value
2298 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2301 CHAR_ALT
= 0x0400000,
2302 CHAR_SUPER
= 0x0800000,
2303 CHAR_HYPER
= 0x1000000,
2304 CHAR_SHIFT
= 0x2000000,
2305 CHAR_CTL
= 0x4000000,
2306 CHAR_META
= 0x8000000,
2308 CHAR_MODIFIER_MASK
=
2309 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2311 /* Actually, the current Emacs uses 22 bits for the character value
2316 /* Data type checking. */
2318 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2321 NUMBERP (Lisp_Object x
)
2323 return INTEGERP (x
) || FLOATP (x
);
2326 NATNUMP (Lisp_Object x
)
2328 return INTEGERP (x
) && 0 <= XINT (x
);
2332 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2334 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2337 #define TYPE_RANGED_INTEGERP(type, x) \
2339 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2340 && XINT (x) <= TYPE_MAXIMUM (type))
2342 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2343 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2344 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2345 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2346 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2347 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2348 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2351 STRINGP (Lisp_Object x
)
2353 return XTYPE (x
) == Lisp_String
;
2356 VECTORP (Lisp_Object x
)
2358 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2361 OVERLAYP (Lisp_Object x
)
2363 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2366 SAVE_VALUEP (Lisp_Object x
)
2368 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2372 AUTOLOADP (Lisp_Object x
)
2374 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2378 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2380 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2384 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2386 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2387 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2390 /* True if A is a pseudovector whose code is CODE. */
2392 PSEUDOVECTORP (Lisp_Object a
, int code
)
2394 if (! VECTORLIKEP (a
))
2398 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2399 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2400 return PSEUDOVECTOR_TYPEP (h
, code
);
2405 /* Test for specific pseudovector types. */
2408 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2410 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2414 PROCESSP (Lisp_Object a
)
2416 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2420 WINDOWP (Lisp_Object a
)
2422 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2426 TERMINALP (Lisp_Object a
)
2428 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2432 SUBRP (Lisp_Object a
)
2434 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2438 COMPILEDP (Lisp_Object a
)
2440 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2444 BUFFERP (Lisp_Object a
)
2446 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2450 CHAR_TABLE_P (Lisp_Object a
)
2452 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2456 SUB_CHAR_TABLE_P (Lisp_Object a
)
2458 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2462 BOOL_VECTOR_P (Lisp_Object a
)
2464 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2468 FRAMEP (Lisp_Object a
)
2470 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2473 /* Test for image (image . spec) */
2475 IMAGEP (Lisp_Object x
)
2477 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2482 ARRAYP (Lisp_Object x
)
2484 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2488 CHECK_LIST (Lisp_Object x
)
2490 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2493 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2494 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2495 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2498 CHECK_STRING (Lisp_Object x
)
2500 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2503 CHECK_STRING_CAR (Lisp_Object x
)
2505 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2508 CHECK_CONS (Lisp_Object x
)
2510 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2513 CHECK_VECTOR (Lisp_Object x
)
2515 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2518 CHECK_BOOL_VECTOR (Lisp_Object x
)
2520 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2523 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2525 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2528 CHECK_ARRAY (Lisp_Object x
, Lisp_Object Qxxxp
)
2530 CHECK_TYPE (ARRAYP (x
), Qxxxp
, x
);
2533 CHECK_BUFFER (Lisp_Object x
)
2535 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2538 CHECK_WINDOW (Lisp_Object x
)
2540 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2544 CHECK_PROCESS (Lisp_Object x
)
2546 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2550 CHECK_NATNUM (Lisp_Object x
)
2552 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2555 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2558 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2559 args_out_of_range_3 \
2561 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2562 ? MOST_NEGATIVE_FIXNUM \
2564 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2566 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2568 if (TYPE_SIGNED (type)) \
2569 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2571 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2574 #define CHECK_NUMBER_COERCE_MARKER(x) \
2576 if (MARKERP ((x))) \
2577 XSETFASTINT (x, marker_position (x)); \
2579 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2583 XFLOATINT (Lisp_Object n
)
2585 return extract_float (n
);
2589 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2591 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2594 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2597 XSETFASTINT (x, marker_position (x)); \
2599 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2602 /* Since we can't assign directly to the CAR or CDR fields of a cons
2603 cell, use these when checking that those fields contain numbers. */
2605 CHECK_NUMBER_CAR (Lisp_Object x
)
2607 Lisp_Object tmp
= XCAR (x
);
2613 CHECK_NUMBER_CDR (Lisp_Object x
)
2615 Lisp_Object tmp
= XCDR (x
);
2620 /* Define a built-in function for calling from Lisp.
2621 `lname' should be the name to give the function in Lisp,
2622 as a null-terminated C string.
2623 `fnname' should be the name of the function in C.
2624 By convention, it starts with F.
2625 `sname' should be the name for the C constant structure
2626 that records information on this function for internal use.
2627 By convention, it should be the same as `fnname' but with S instead of F.
2628 It's too bad that C macros can't compute this from `fnname'.
2629 `minargs' should be a number, the minimum number of arguments allowed.
2630 `maxargs' should be a number, the maximum number of arguments allowed,
2631 or else MANY or UNEVALLED.
2632 MANY means pass a vector of evaluated arguments,
2633 in the form of an integer number-of-arguments
2634 followed by the address of a vector of Lisp_Objects
2635 which contains the argument values.
2636 UNEVALLED means pass the list of unevaluated arguments
2637 `intspec' says how interactive arguments are to be fetched.
2638 If the string starts with a `(', `intspec' is evaluated and the resulting
2639 list is the list of arguments.
2640 If it's a string that doesn't start with `(', the value should follow
2641 the one of the doc string for `interactive'.
2642 A null string means call interactively with no arguments.
2643 `doc' is documentation for the user. */
2645 /* This version of DEFUN declares a function prototype with the right
2646 arguments, so we can catch errors with maxargs at compile-time. */
2648 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2649 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2650 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2651 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2652 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2653 { (Lisp_Object (__cdecl *)(void))fnname }, \
2654 minargs, maxargs, lname, intspec, 0}; \
2656 #else /* not _MSC_VER */
2657 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2658 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2659 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2660 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2661 { .a ## maxargs = fnname }, \
2662 minargs, maxargs, lname, intspec, 0}; \
2666 /* Note that the weird token-substitution semantics of ANSI C makes
2667 this work for MANY and UNEVALLED. */
2668 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2669 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2670 #define DEFUN_ARGS_0 (void)
2671 #define DEFUN_ARGS_1 (Lisp_Object)
2672 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2673 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2674 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2675 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2677 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2678 Lisp_Object, Lisp_Object)
2679 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2680 Lisp_Object, Lisp_Object, Lisp_Object)
2681 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2682 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2684 /* True if OBJ is a Lisp function. */
2686 FUNCTIONP (Lisp_Object obj
)
2688 return functionp (obj
);
2692 is how we define the symbol for function `name' at start-up time. */
2693 extern void defsubr (struct Lisp_Subr
*);
2701 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2702 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2703 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2704 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2705 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2707 /* Macros we use to define forwarded Lisp variables.
2708 These are used in the syms_of_FILENAME functions.
2710 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2711 lisp variable is actually a field in `struct emacs_globals'. The
2712 field's name begins with "f_", which is a convention enforced by
2713 these macros. Each such global has a corresponding #define in
2714 globals.h; the plain name should be used in the code.
2716 E.g., the global "cons_cells_consed" is declared as "int
2717 f_cons_cells_consed" in globals.h, but there is a define:
2719 #define cons_cells_consed globals.f_cons_cells_consed
2721 All C code uses the `cons_cells_consed' name. This is all done
2722 this way to support indirection for multi-threaded Emacs. */
2724 #define DEFVAR_LISP(lname, vname, doc) \
2726 static struct Lisp_Objfwd o_fwd; \
2727 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2729 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2731 static struct Lisp_Objfwd o_fwd; \
2732 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2734 #define DEFVAR_BOOL(lname, vname, doc) \
2736 static struct Lisp_Boolfwd b_fwd; \
2737 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2739 #define DEFVAR_INT(lname, vname, doc) \
2741 static struct Lisp_Intfwd i_fwd; \
2742 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2745 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2747 static struct Lisp_Objfwd o_fwd; \
2748 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2751 #define DEFVAR_KBOARD(lname, vname, doc) \
2753 static struct Lisp_Kboard_Objfwd ko_fwd; \
2754 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2757 /* Save and restore the instruction and environment pointers,
2758 without affecting the signal mask. */
2761 typedef jmp_buf sys_jmp_buf
;
2762 # define sys_setjmp(j) _setjmp (j)
2763 # define sys_longjmp(j, v) _longjmp (j, v)
2764 #elif defined HAVE_SIGSETJMP
2765 typedef sigjmp_buf sys_jmp_buf
;
2766 # define sys_setjmp(j) sigsetjmp (j, 0)
2767 # define sys_longjmp(j, v) siglongjmp (j, v)
2769 /* A platform that uses neither _longjmp nor siglongjmp; assume
2770 longjmp does not affect the sigmask. */
2771 typedef jmp_buf sys_jmp_buf
;
2772 # define sys_setjmp(j) setjmp (j)
2773 # define sys_longjmp(j, v) longjmp (j, v)
2777 /* Elisp uses several stacks:
2779 - the bytecode stack: used internally by the bytecode interpreter.
2780 Allocated from the C stack.
2781 - The specpdl stack: keeps track of active unwind-protect and
2782 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2784 - The handler stack: keeps track of active catch tags and condition-case
2785 handlers. Allocated in a manually managed stack implemented by a
2786 doubly-linked list allocated via xmalloc and never freed. */
2788 /* Structure for recording Lisp call stack for backtrace purposes. */
2790 /* The special binding stack holds the outer values of variables while
2791 they are bound by a function application or a let form, stores the
2792 code to be executed for unwind-protect forms.
2794 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2795 used all over the place, needs to be fast, and needs to know the size of
2796 union specbinding. But only eval.c should access it. */
2799 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2800 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2801 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2802 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2803 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2804 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2805 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2806 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2807 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2812 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2814 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2815 void (*func
) (Lisp_Object
);
2819 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2820 void (*func
) (void *);
2824 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2829 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2830 void (*func
) (void);
2833 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2834 /* `where' is not used in the case of SPECPDL_LET. */
2835 Lisp_Object symbol
, old_value
, where
;
2838 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2839 bool_bf debug_on_exit
: 1;
2840 Lisp_Object function
;
2846 extern union specbinding
*specpdl
;
2847 extern union specbinding
*specpdl_ptr
;
2848 extern ptrdiff_t specpdl_size
;
2851 SPECPDL_INDEX (void)
2853 return specpdl_ptr
- specpdl
;
2856 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2857 control structures. A struct handler contains all the information needed to
2858 restore the state of the interpreter after a non-local jump.
2860 handler structures are chained together in a doubly linked list; the `next'
2861 member points to the next outer catchtag and the `nextfree' member points in
2862 the other direction to the next inner element (which is typically the next
2863 free element since we mostly use it on the deepest handler).
2865 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2866 member is TAG, and then unbinds to it. The `val' member is used to
2867 hold VAL while the stack is unwound; `val' is returned as the value
2870 All the other members are concerned with restoring the interpreter
2873 Members are volatile if their values need to survive _longjmp when
2874 a 'struct handler' is a local variable. */
2876 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2880 enum handlertype type
;
2881 Lisp_Object tag_or_ch
;
2883 struct handler
*next
;
2884 struct handler
*nextfree
;
2886 /* The bytecode interpreter can have several handlers active at the same
2887 time, so when we longjmp to one of them, it needs to know which handler
2888 this was and what was the corresponding internal state. This is stored
2889 here, and when we longjmp we make sure that handlerlist points to the
2891 Lisp_Object
*bytecode_top
;
2894 /* Most global vars are reset to their value via the specpdl mechanism,
2895 but a few others are handled by storing their value here. */
2896 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
2897 struct gcpro
*gcpro
;
2900 EMACS_INT lisp_eval_depth
;
2902 int poll_suppress_count
;
2903 int interrupt_input_blocked
;
2904 struct byte_stack
*byte_stack
;
2907 /* Fill in the components of c, and put it on the list. */
2908 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2909 if (handlerlist->nextfree) \
2910 (c) = handlerlist->nextfree; \
2913 (c) = xmalloc (sizeof (struct handler)); \
2914 (c)->nextfree = NULL; \
2915 handlerlist->nextfree = (c); \
2917 (c)->type = (handlertype); \
2918 (c)->tag_or_ch = (tag_ch_val); \
2920 (c)->next = handlerlist; \
2921 (c)->lisp_eval_depth = lisp_eval_depth; \
2922 (c)->pdlcount = SPECPDL_INDEX (); \
2923 (c)->poll_suppress_count = poll_suppress_count; \
2924 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2925 (c)->gcpro = gcprolist; \
2926 (c)->byte_stack = byte_stack_list; \
2930 extern Lisp_Object memory_signal_data
;
2932 /* An address near the bottom of the stack.
2933 Tells GC how to save a copy of the stack. */
2934 extern char *stack_bottom
;
2936 /* Check quit-flag and quit if it is non-nil.
2937 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2938 So the program needs to do QUIT at times when it is safe to quit.
2939 Every loop that might run for a long time or might not exit
2940 ought to do QUIT at least once, at a safe place.
2941 Unless that is impossible, of course.
2942 But it is very desirable to avoid creating loops where QUIT is impossible.
2944 Exception: if you set immediate_quit to true,
2945 then the handler that responds to the C-g does the quit itself.
2946 This is a good thing to do around a loop that has no side effects
2947 and (in particular) cannot call arbitrary Lisp code.
2949 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2950 a request to exit Emacs when it is safe to do. */
2952 extern void process_pending_signals (void);
2953 extern bool volatile pending_signals
;
2955 extern void process_quit_flag (void);
2958 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2959 process_quit_flag (); \
2960 else if (pending_signals) \
2961 process_pending_signals (); \
2965 /* True if ought to quit now. */
2967 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2969 extern Lisp_Object Vascii_downcase_table
;
2970 extern Lisp_Object Vascii_canon_table
;
2972 /* Structure for recording stack slots that need marking. */
2974 /* This is a chain of structures, each of which points at a Lisp_Object
2975 variable whose value should be marked in garbage collection.
2976 Normally every link of the chain is an automatic variable of a function,
2977 and its `val' points to some argument or local variable of the function.
2978 On exit to the function, the chain is set back to the value it had on entry.
2979 This way, no link remains in the chain when the stack frame containing the
2982 Every function that can call Feval must protect in this fashion all
2983 Lisp_Object variables whose contents will be used again. */
2985 extern struct gcpro
*gcprolist
;
2991 /* Address of first protected variable. */
2992 volatile Lisp_Object
*var
;
2994 /* Number of consecutive protected variables. */
3002 /* Values of GC_MARK_STACK during compilation:
3004 0 Use GCPRO as before
3005 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
3006 2 Mark the stack, and check that everything GCPRO'd is
3008 3 Mark using GCPRO's, mark stack last, and count how many
3009 dead objects are kept alive.
3011 Formerly, method 0 was used. Currently, method 1 is used unless
3012 otherwise specified by hand when building, e.g.,
3013 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
3014 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
3016 #define GC_USE_GCPROS_AS_BEFORE 0
3017 #define GC_MAKE_GCPROS_NOOPS 1
3018 #define GC_MARK_STACK_CHECK_GCPROS 2
3019 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
3021 #ifndef GC_MARK_STACK
3022 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
3025 /* Whether we do the stack marking manually. */
3026 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
3027 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
3030 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
3032 /* Do something silly with gcproN vars just so gcc shuts up. */
3033 /* You get warnings from MIPSPro... */
3035 #define GCPRO1(varname) ((void) gcpro1)
3036 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
3037 #define GCPRO3(varname1, varname2, varname3) \
3038 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
3039 #define GCPRO4(varname1, varname2, varname3, varname4) \
3040 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3041 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3042 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3043 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3044 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
3046 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
3047 #define UNGCPRO ((void) 0)
3049 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3053 #define GCPRO1(varname) \
3054 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3055 gcprolist = &gcpro1; }
3057 #define GCPRO2(varname1, varname2) \
3058 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3059 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3060 gcprolist = &gcpro2; }
3062 #define GCPRO3(varname1, varname2, varname3) \
3063 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3064 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3065 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3066 gcprolist = &gcpro3; }
3068 #define GCPRO4(varname1, varname2, varname3, varname4) \
3069 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3070 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3071 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3072 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3073 gcprolist = &gcpro4; }
3075 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3076 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3077 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3078 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3079 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3080 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3081 gcprolist = &gcpro5; }
3083 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3084 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3085 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3086 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3087 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3088 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3089 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3090 gcprolist = &gcpro6; }
3092 #define GCPRO7(a, b, c, d, e, f, g) \
3093 {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3094 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3095 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3096 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3097 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3098 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3099 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3100 gcprolist = &gcpro7; }
3102 #define UNGCPRO (gcprolist = gcpro1.next)
3106 extern int gcpro_level
;
3108 #define GCPRO1(varname) \
3109 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3110 gcpro1.level = gcpro_level++; \
3111 gcprolist = &gcpro1; }
3113 #define GCPRO2(varname1, varname2) \
3114 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3115 gcpro1.level = gcpro_level; \
3116 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3117 gcpro2.level = gcpro_level++; \
3118 gcprolist = &gcpro2; }
3120 #define GCPRO3(varname1, varname2, varname3) \
3121 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3122 gcpro1.level = gcpro_level; \
3123 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3124 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3125 gcpro3.level = gcpro_level++; \
3126 gcprolist = &gcpro3; }
3128 #define GCPRO4(varname1, varname2, varname3, varname4) \
3129 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3130 gcpro1.level = gcpro_level; \
3131 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3132 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3133 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3134 gcpro4.level = gcpro_level++; \
3135 gcprolist = &gcpro4; }
3137 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3138 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3139 gcpro1.level = gcpro_level; \
3140 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3141 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3142 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3143 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3144 gcpro5.level = gcpro_level++; \
3145 gcprolist = &gcpro5; }
3147 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3148 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3149 gcpro1.level = gcpro_level; \
3150 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3151 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3152 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3153 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3154 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3155 gcpro6.level = gcpro_level++; \
3156 gcprolist = &gcpro6; }
3158 #define GCPRO7(a, b, c, d, e, f, g) \
3159 {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3160 gcpro1.level = gcpro_level; \
3161 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3162 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3163 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3164 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3165 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3166 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3167 gcpro7.level = gcpro_level++; \
3168 gcprolist = &gcpro7; }
3171 (--gcpro_level != gcpro1.level \
3173 : (void) (gcprolist = gcpro1.next))
3175 #endif /* DEBUG_GCPRO */
3176 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3179 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
3180 #define RETURN_UNGCPRO(expr) \
3183 Lisp_Object ret_ungc_val; \
3184 ret_ungc_val = (expr); \
3186 return ret_ungc_val; \
3190 /* Call staticpro (&var) to protect static variable `var'. */
3192 void staticpro (Lisp_Object
*);
3194 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
3195 meaning as in the DEFUN macro, and is used to construct a prototype. */
3196 /* We can use the same trick as in the DEFUN macro to generate the
3197 appropriate prototype. */
3198 #define EXFUN(fnname, maxargs) \
3199 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
3201 #include "globals.h"
3203 /* Forward declarations for prototypes. */
3207 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3210 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3212 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3213 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3216 /* Functions to modify hash tables. */
3219 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3221 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3225 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3227 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3230 /* Use these functions to set Lisp_Object
3231 or pointer slots of struct Lisp_Symbol. */
3234 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3236 XSYMBOL (sym
)->function
= function
;
3240 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3242 XSYMBOL (sym
)->plist
= plist
;
3246 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3248 XSYMBOL (sym
)->next
= next
;
3251 /* Buffer-local (also frame-local) variable access functions. */
3254 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3256 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3260 /* Set overlay's property list. */
3263 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3265 XOVERLAY (overlay
)->plist
= plist
;
3268 /* Get text properties of S. */
3271 string_intervals (Lisp_Object s
)
3273 return XSTRING (s
)->intervals
;
3276 /* Set text properties of S to I. */
3279 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3281 XSTRING (s
)->intervals
= i
;
3284 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3285 of setting slots directly. */
3288 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3290 XCHAR_TABLE (table
)->defalt
= val
;
3293 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3295 XCHAR_TABLE (table
)->purpose
= val
;
3298 /* Set different slots in (sub)character tables. */
3301 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3303 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3304 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3308 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3310 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3311 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3315 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3317 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3320 /* Defined in data.c. */
3321 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
3322 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3323 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3324 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3325 extern Lisp_Object Qinvalid_read_syntax
;
3326 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3327 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3328 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3329 extern Lisp_Object Qtext_read_only
;
3330 extern Lisp_Object Qinteractive_form
;
3331 extern Lisp_Object Qcircular_list
;
3332 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
3333 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
3334 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
3335 extern Lisp_Object Qbuffer_or_string_p
;
3336 extern Lisp_Object Qfboundp
;
3337 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
3339 extern Lisp_Object Qcdr
;
3341 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3343 extern Lisp_Object Qfloatp
;
3344 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
3346 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3348 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
3350 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
3352 /* Defined in data.c. */
3353 extern Lisp_Object
indirect_function (Lisp_Object
);
3354 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3355 enum Arith_Comparison
{
3360 ARITH_LESS_OR_EQUAL
,
3363 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3364 enum Arith_Comparison comparison
);
3366 /* Convert the integer I to an Emacs representation, either the integer
3367 itself, or a cons of two or three integers, or if all else fails a float.
3368 I should not have side effects. */
3369 #define INTEGER_TO_CONS(i) \
3370 (! FIXNUM_OVERFLOW_P (i) \
3372 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3373 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3374 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3375 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3376 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3377 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3378 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3379 ? Fcons (make_number ((i) >> 16 >> 24), \
3380 Fcons (make_number ((i) >> 16 & 0xffffff), \
3381 make_number ((i) & 0xffff))) \
3384 /* Convert the Emacs representation CONS back to an integer of type
3385 TYPE, storing the result the variable VAR. Signal an error if CONS
3386 is not a valid representation or is out of range for TYPE. */
3387 #define CONS_TO_INTEGER(cons, type, var) \
3388 (TYPE_SIGNED (type) \
3389 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3390 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3391 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3392 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3394 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3395 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3396 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3398 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
3399 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3400 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3401 extern void syms_of_data (void);
3402 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3404 /* Defined in cmds.c */
3405 extern void syms_of_cmds (void);
3406 extern void keys_of_cmds (void);
3408 /* Defined in coding.c. */
3409 extern Lisp_Object Qcharset
;
3410 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3411 ptrdiff_t, bool, bool, Lisp_Object
);
3412 extern void init_coding (void);
3413 extern void init_coding_once (void);
3414 extern void syms_of_coding (void);
3416 /* Defined in character.c. */
3417 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
3418 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3419 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3420 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
3421 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
3422 extern void syms_of_character (void);
3424 /* Defined in charset.c. */
3425 extern void init_charset (void);
3426 extern void init_charset_once (void);
3427 extern void syms_of_charset (void);
3428 /* Structure forward declarations. */
3431 /* Defined in composite.c. */
3432 extern void syms_of_composite (void);
3434 /* Defined in syntax.c. */
3435 extern void init_syntax_once (void);
3436 extern void syms_of_syntax (void);
3438 /* Defined in fns.c. */
3439 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3440 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3441 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
3442 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3443 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3444 extern void sweep_weak_hash_tables (void);
3445 extern Lisp_Object Qcursor_in_echo_area
;
3446 extern Lisp_Object Qstring_lessp
;
3447 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3448 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3449 EMACS_UINT
sxhash (Lisp_Object
, int);
3450 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3451 Lisp_Object
, Lisp_Object
);
3452 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3453 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3455 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3457 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3458 ptrdiff_t, ptrdiff_t);
3459 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3460 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3461 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3462 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3463 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3464 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3465 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3466 extern void clear_string_char_byte_cache (void);
3467 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3468 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3469 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3470 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3471 extern void syms_of_fns (void);
3473 /* Defined in floatfns.c. */
3474 extern double extract_float (Lisp_Object
);
3475 extern void syms_of_floatfns (void);
3476 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3478 /* Defined in fringe.c. */
3479 extern void syms_of_fringe (void);
3480 extern void init_fringe (void);
3481 #ifdef HAVE_WINDOW_SYSTEM
3482 extern void mark_fringe_data (void);
3483 extern void init_fringe_once (void);
3484 #endif /* HAVE_WINDOW_SYSTEM */
3486 /* Defined in image.c. */
3487 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3488 extern Lisp_Object QCconversion
;
3489 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3490 extern void reset_image_types (void);
3491 extern void syms_of_image (void);
3493 /* Defined in insdel.c. */
3494 extern Lisp_Object Qinhibit_modification_hooks
;
3495 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3496 extern _Noreturn
void buffer_overflow (void);
3497 extern void make_gap (ptrdiff_t);
3498 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3499 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3500 ptrdiff_t, bool, bool);
3501 extern int count_combining_before (const unsigned char *,
3502 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3503 extern int count_combining_after (const unsigned char *,
3504 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3505 extern void insert (const char *, ptrdiff_t);
3506 extern void insert_and_inherit (const char *, ptrdiff_t);
3507 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3509 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3510 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3511 ptrdiff_t, ptrdiff_t, bool);
3512 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3513 extern void insert_char (int);
3514 extern void insert_string (const char *);
3515 extern void insert_before_markers (const char *, ptrdiff_t);
3516 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3517 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3518 ptrdiff_t, ptrdiff_t,
3520 extern void del_range (ptrdiff_t, ptrdiff_t);
3521 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3522 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3523 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3524 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3525 ptrdiff_t, ptrdiff_t, bool);
3526 extern void modify_text (ptrdiff_t, ptrdiff_t);
3527 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3528 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3529 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3530 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3531 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3532 ptrdiff_t, ptrdiff_t);
3533 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3534 ptrdiff_t, ptrdiff_t);
3535 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3536 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3537 const char *, ptrdiff_t, ptrdiff_t, bool);
3538 extern void syms_of_insdel (void);
3540 /* Defined in dispnew.c. */
3541 #if (defined PROFILING \
3542 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3543 _Noreturn
void __executable_start (void);
3545 extern Lisp_Object Vwindow_system
;
3546 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3547 extern void init_display (void);
3548 extern void syms_of_display (void);
3550 /* Defined in xdisp.c. */
3551 extern Lisp_Object Qinhibit_point_motion_hooks
;
3552 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
3553 extern Lisp_Object Qmenu_bar_update_hook
;
3554 extern Lisp_Object Qwindow_scroll_functions
;
3555 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3556 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3557 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3558 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
3559 extern Lisp_Object Qleft_margin
, Qright_margin
;
3560 extern Lisp_Object QCdata
, QCfile
;
3561 extern Lisp_Object QCmap
;
3562 extern Lisp_Object Qrisky_local_variable
;
3563 extern bool noninteractive_need_newline
;
3564 extern Lisp_Object echo_area_buffer
[2];
3565 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3566 extern void check_message_stack (void);
3567 extern void setup_echo_area_for_printing (int);
3568 extern bool push_message (void);
3569 extern void pop_message_unwind (void);
3570 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3571 extern void restore_message (void);
3572 extern Lisp_Object
current_message (void);
3573 extern void clear_message (bool, bool);
3574 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3575 extern void message1 (const char *);
3576 extern void message1_nolog (const char *);
3577 extern void message3 (Lisp_Object
);
3578 extern void message3_nolog (Lisp_Object
);
3579 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3580 extern void message_with_string (const char *, Lisp_Object
, int);
3581 extern void message_log_maybe_newline (void);
3582 extern void update_echo_area (void);
3583 extern void truncate_echo_area (ptrdiff_t);
3584 extern void redisplay (void);
3585 extern void redisplay_preserve_echo_area (int);
3587 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3588 extern void syms_of_xdisp (void);
3589 extern void init_xdisp (void);
3590 extern Lisp_Object
safe_eval (Lisp_Object
);
3591 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3592 int *, int *, int *, int *, int *);
3594 /* Defined in xsettings.c. */
3595 extern void syms_of_xsettings (void);
3597 /* Defined in vm-limit.c. */
3598 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3600 /* Defined in alloc.c. */
3601 extern void check_pure_size (void);
3602 extern void free_misc (Lisp_Object
);
3603 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3604 extern void malloc_warning (const char *);
3605 extern _Noreturn
void memory_full (size_t);
3606 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3607 extern bool survives_gc_p (Lisp_Object
);
3608 extern void mark_object (Lisp_Object
);
3609 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3610 extern void refill_memory_reserve (void);
3612 extern const char *pending_malloc_warning
;
3613 extern Lisp_Object zero_vector
;
3614 extern Lisp_Object
*stack_base
;
3615 extern EMACS_INT consing_since_gc
;
3616 extern EMACS_INT gc_relative_threshold
;
3617 extern EMACS_INT memory_full_cons_threshold
;
3618 extern Lisp_Object
list1 (Lisp_Object
);
3619 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3620 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3621 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3622 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3624 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3625 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3627 /* Build a frequently used 2/3/4-integer lists. */
3630 list2i (EMACS_INT x
, EMACS_INT y
)
3632 return list2 (make_number (x
), make_number (y
));
3636 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3638 return list3 (make_number (x
), make_number (y
), make_number (w
));
3642 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3644 return list4 (make_number (x
), make_number (y
),
3645 make_number (w
), make_number (h
));
3648 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3649 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3650 extern _Noreturn
void string_overflow (void);
3651 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3652 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3653 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3654 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3656 /* Make unibyte string from C string when the length isn't known. */
3659 build_unibyte_string (const char *str
)
3661 return make_unibyte_string (str
, strlen (str
));
3664 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3665 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3666 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3667 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3668 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3669 extern Lisp_Object
make_specified_string (const char *,
3670 ptrdiff_t, ptrdiff_t, bool);
3671 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3672 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3674 /* Make a string allocated in pure space, use STR as string data. */
3677 build_pure_c_string (const char *str
)
3679 return make_pure_c_string (str
, strlen (str
));
3682 /* Make a string from the data at STR, treating it as multibyte if the
3686 build_string (const char *str
)
3688 return make_string (str
, strlen (str
));
3691 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3692 extern void make_byte_code (struct Lisp_Vector
*);
3693 extern Lisp_Object Qautomatic_gc
;
3694 extern Lisp_Object Qchar_table_extra_slots
;
3695 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3697 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3698 be sure that GC cannot happen until the vector is completely
3699 initialized. E.g. the following code is likely to crash:
3701 v = make_uninit_vector (3);
3703 ASET (v, 1, Ffunction_can_gc ());
3704 ASET (v, 2, obj1); */
3707 make_uninit_vector (ptrdiff_t size
)
3710 struct Lisp_Vector
*p
;
3712 p
= allocate_vector (size
);
3717 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3718 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3720 allocate_pseudovector \
3721 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3722 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3723 extern struct window
*allocate_window (void);
3724 extern struct frame
*allocate_frame (void);
3725 extern struct Lisp_Process
*allocate_process (void);
3726 extern struct terminal
*allocate_terminal (void);
3727 extern bool gc_in_progress
;
3728 extern bool abort_on_gc
;
3729 extern Lisp_Object
make_float (double);
3730 extern void display_malloc_warning (void);
3731 extern ptrdiff_t inhibit_garbage_collection (void);
3732 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3733 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3734 Lisp_Object
, Lisp_Object
);
3735 extern Lisp_Object
make_save_ptr (void *);
3736 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3737 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3738 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3740 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3741 extern void free_save_value (Lisp_Object
);
3742 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3743 extern void free_marker (Lisp_Object
);
3744 extern void free_cons (struct Lisp_Cons
*);
3745 extern void init_alloc_once (void);
3746 extern void init_alloc (void);
3747 extern void syms_of_alloc (void);
3748 extern struct buffer
* allocate_buffer (void);
3749 extern int valid_lisp_object_p (Lisp_Object
);
3750 #ifdef GC_CHECK_CONS_LIST
3751 extern void check_cons_list (void);
3753 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3757 /* Defined in ralloc.c. */
3758 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3759 extern void r_alloc_free (void **);
3760 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3761 extern void r_alloc_reset_variable (void **, void **);
3762 extern void r_alloc_inhibit_buffer_relocation (int);
3765 /* Defined in chartab.c. */
3766 extern Lisp_Object
copy_char_table (Lisp_Object
);
3767 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
3768 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3770 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3771 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3772 extern int char_table_translate (Lisp_Object
, int);
3773 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3775 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3776 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3777 Lisp_Object
, Lisp_Object
,
3778 Lisp_Object
, struct charset
*,
3779 unsigned, unsigned);
3780 extern Lisp_Object
uniprop_table (Lisp_Object
);
3781 extern void syms_of_chartab (void);
3783 /* Defined in print.c. */
3784 extern Lisp_Object Vprin1_to_string_buffer
;
3785 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3786 extern Lisp_Object Qstandard_output
;
3787 extern Lisp_Object Qexternal_debugging_output
;
3788 extern void temp_output_buffer_setup (const char *);
3789 extern int print_level
;
3790 extern Lisp_Object Qprint_escape_newlines
;
3791 extern void write_string (const char *, int);
3792 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3794 extern Lisp_Object internal_with_output_to_temp_buffer
3795 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3796 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3797 extern int float_to_string (char *, double);
3798 extern void init_print_once (void);
3799 extern void syms_of_print (void);
3801 /* Defined in doprnt.c. */
3802 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3804 extern ptrdiff_t esprintf (char *, char const *, ...)
3805 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3806 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3808 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3809 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3810 char const *, va_list)
3811 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3813 /* Defined in lread.c. */
3814 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3815 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3816 extern Lisp_Object Qlexical_binding
;
3817 extern Lisp_Object
check_obarray (Lisp_Object
);
3818 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3819 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3820 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3822 LOADHIST_ATTACH (Lisp_Object x
)
3825 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3827 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3828 Lisp_Object
*, Lisp_Object
, bool);
3829 extern Lisp_Object
string_to_number (char const *, int, bool);
3830 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3832 extern void dir_warning (const char *, Lisp_Object
);
3833 extern void init_obarray (void);
3834 extern void init_lread (void);
3835 extern void syms_of_lread (void);
3838 intern (const char *str
)
3840 return intern_1 (str
, strlen (str
));
3844 intern_c_string (const char *str
)
3846 return intern_c_string_1 (str
, strlen (str
));
3849 /* Defined in eval.c. */
3850 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3851 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3852 extern Lisp_Object Qand_rest
;
3853 extern Lisp_Object Vautoload_queue
;
3854 extern Lisp_Object Vsignaling_function
;
3855 extern Lisp_Object inhibit_lisp_code
;
3856 extern struct handler
*handlerlist
;
3858 /* To run a normal hook, use the appropriate function from the list below.
3859 The calling convention:
3861 if (!NILP (Vrun_hooks))
3862 call1 (Vrun_hooks, Qmy_funny_hook);
3864 should no longer be used. */
3865 extern Lisp_Object Vrun_hooks
;
3866 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3867 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3868 Lisp_Object (*funcall
)
3869 (ptrdiff_t nargs
, Lisp_Object
*args
));
3870 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3871 extern _Noreturn
void xsignal0 (Lisp_Object
);
3872 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3873 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3874 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3876 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3877 extern Lisp_Object
eval_sub (Lisp_Object form
);
3878 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3879 extern Lisp_Object
call0 (Lisp_Object
);
3880 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3881 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3882 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3883 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3884 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3885 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3886 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3887 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3888 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3889 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3890 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3891 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3892 extern Lisp_Object internal_condition_case_n
3893 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3894 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3895 extern void specbind (Lisp_Object
, Lisp_Object
);
3896 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3897 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3898 extern void record_unwind_protect_int (void (*) (int), int);
3899 extern void record_unwind_protect_void (void (*) (void));
3900 extern void record_unwind_protect_nothing (void);
3901 extern void clear_unwind_protect (ptrdiff_t);
3902 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3903 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3904 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3905 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3906 extern _Noreturn
void verror (const char *, va_list)
3907 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3908 extern void un_autoload (Lisp_Object
);
3909 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3910 extern void init_eval_once (void);
3911 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3912 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3913 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3914 extern void init_eval (void);
3915 extern void syms_of_eval (void);
3916 extern void unwind_body (Lisp_Object
);
3917 extern void record_in_backtrace (Lisp_Object function
,
3918 Lisp_Object
*args
, ptrdiff_t nargs
);
3919 extern void mark_specpdl (void);
3920 extern void get_backtrace (Lisp_Object array
);
3921 Lisp_Object
backtrace_top_function (void);
3922 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3923 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3926 /* Defined in editfns.c. */
3927 extern Lisp_Object Qfield
;
3928 extern void insert1 (Lisp_Object
);
3929 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3930 extern Lisp_Object
save_excursion_save (void);
3931 extern Lisp_Object
save_restriction_save (void);
3932 extern void save_excursion_restore (Lisp_Object
);
3933 extern void save_restriction_restore (Lisp_Object
);
3934 extern _Noreturn
void time_overflow (void);
3935 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3936 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3938 extern void init_editfns (void);
3939 extern void syms_of_editfns (void);
3940 extern void set_time_zone_rule (const char *);
3942 /* Defined in buffer.c. */
3943 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3944 extern _Noreturn
void nsberror (Lisp_Object
);
3945 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3946 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3947 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3948 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3949 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3950 extern bool overlay_touches_p (ptrdiff_t);
3951 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3952 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3953 extern void init_buffer_once (void);
3954 extern void init_buffer (void);
3955 extern void syms_of_buffer (void);
3956 extern void keys_of_buffer (void);
3958 /* Defined in marker.c. */
3960 extern ptrdiff_t marker_position (Lisp_Object
);
3961 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3962 extern void clear_charpos_cache (struct buffer
*);
3963 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3964 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3965 extern void unchain_marker (struct Lisp_Marker
*marker
);
3966 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3967 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3968 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3969 ptrdiff_t, ptrdiff_t);
3970 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3971 extern void syms_of_marker (void);
3973 /* Defined in fileio.c. */
3975 extern Lisp_Object Qfile_error
;
3976 extern Lisp_Object Qfile_notify_error
;
3977 extern Lisp_Object Qfile_exists_p
;
3978 extern Lisp_Object Qfile_directory_p
;
3979 extern Lisp_Object Qinsert_file_contents
;
3980 extern Lisp_Object Qfile_name_history
;
3981 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3982 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3983 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3985 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3986 extern void close_file_unwind (int);
3987 extern void fclose_unwind (void *);
3988 extern void restore_point_unwind (Lisp_Object
);
3989 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3990 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3991 extern bool internal_delete_file (Lisp_Object
);
3992 extern Lisp_Object
emacs_readlinkat (int, const char *);
3993 extern bool file_directory_p (const char *);
3994 extern bool file_accessible_directory_p (const char *);
3995 extern void init_fileio (void);
3996 extern void syms_of_fileio (void);
3997 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3998 extern Lisp_Object Qdelete_file
;
4000 /* Defined in search.c. */
4001 extern void shrink_regexp_cache (void);
4002 extern void restore_search_regs (void);
4003 extern void record_unwind_save_match_data (void);
4004 struct re_registers
;
4005 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4006 struct re_registers
*,
4007 Lisp_Object
, bool, bool);
4008 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
4009 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4011 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
4012 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4013 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4014 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4015 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4016 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4018 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4019 ptrdiff_t, ptrdiff_t *);
4020 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4021 ptrdiff_t, ptrdiff_t *);
4022 extern void syms_of_search (void);
4023 extern void clear_regexp_cache (void);
4025 /* Defined in minibuf.c. */
4027 extern Lisp_Object Qcompletion_ignore_case
;
4028 extern Lisp_Object Vminibuffer_list
;
4029 extern Lisp_Object last_minibuf_string
;
4030 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4031 extern void init_minibuf_once (void);
4032 extern void syms_of_minibuf (void);
4034 /* Defined in callint.c. */
4036 extern Lisp_Object Qminus
, Qplus
;
4037 extern Lisp_Object Qprogn
;
4038 extern Lisp_Object Qwhen
;
4039 extern Lisp_Object Qmouse_leave_buffer_hook
;
4040 extern void syms_of_callint (void);
4042 /* Defined in casefiddle.c. */
4044 extern Lisp_Object Qidentity
;
4045 extern void syms_of_casefiddle (void);
4046 extern void keys_of_casefiddle (void);
4048 /* Defined in casetab.c. */
4050 extern void init_casetab_once (void);
4051 extern void syms_of_casetab (void);
4053 /* Defined in keyboard.c. */
4055 extern Lisp_Object echo_message_buffer
;
4056 extern struct kboard
*echo_kboard
;
4057 extern void cancel_echoing (void);
4058 extern Lisp_Object Qdisabled
, QCfilter
;
4059 extern Lisp_Object Qup
, Qdown
, Qbottom
;
4060 extern Lisp_Object Qtop
;
4061 extern Lisp_Object last_undo_boundary
;
4062 extern bool input_pending
;
4063 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4064 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4065 extern void discard_mouse_events (void);
4067 void handle_input_available_signal (int);
4069 extern Lisp_Object pending_funcalls
;
4070 extern bool detect_input_pending (void);
4071 extern bool detect_input_pending_ignore_squeezables (void);
4072 extern bool detect_input_pending_run_timers (bool);
4073 extern void safe_run_hooks (Lisp_Object
);
4074 extern void cmd_error_internal (Lisp_Object
, const char *);
4075 extern Lisp_Object
command_loop_1 (void);
4076 extern Lisp_Object
read_menu_command (void);
4077 extern Lisp_Object
recursive_edit_1 (void);
4078 extern void record_auto_save (void);
4079 extern void force_auto_save_soon (void);
4080 extern void init_keyboard (void);
4081 extern void syms_of_keyboard (void);
4082 extern void keys_of_keyboard (void);
4084 /* Defined in indent.c. */
4085 extern ptrdiff_t current_column (void);
4086 extern void invalidate_current_column (void);
4087 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4088 extern void syms_of_indent (void);
4090 /* Defined in frame.c. */
4091 extern Lisp_Object Qonly
, Qnone
;
4092 extern Lisp_Object Qvisible
;
4093 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4094 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4095 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4096 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4097 #if HAVE_NS || HAVE_NTGUI
4098 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4100 extern void frames_discard_buffer (Lisp_Object
);
4101 extern void syms_of_frame (void);
4103 /* Defined in emacs.c. */
4104 extern char **initial_argv
;
4105 extern int initial_argc
;
4106 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4107 extern bool display_arg
;
4109 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4110 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4111 extern Lisp_Object Qfile_name_handler_alist
;
4112 extern _Noreturn
void terminate_due_to_signal (int, int);
4113 extern Lisp_Object Qkill_emacs
;
4115 extern Lisp_Object Vlibrary_cache
;
4118 void fixup_locale (void);
4119 void synchronize_system_messages_locale (void);
4120 void synchronize_system_time_locale (void);
4122 INLINE
void fixup_locale (void) {}
4123 INLINE
void synchronize_system_messages_locale (void) {}
4124 INLINE
void synchronize_system_time_locale (void) {}
4126 extern void shut_down_emacs (int, Lisp_Object
);
4128 /* True means don't do interactive redisplay and don't change tty modes. */
4129 extern bool noninteractive
;
4131 /* True means remove site-lisp directories from load-path. */
4132 extern bool no_site_lisp
;
4134 /* Pipe used to send exit notification to the daemon parent at
4136 extern int daemon_pipe
[2];
4137 #define IS_DAEMON (daemon_pipe[1] != 0)
4139 /* True if handling a fatal error already. */
4140 extern bool fatal_error_in_progress
;
4142 /* True means don't do use window-system-specific display code. */
4143 extern bool inhibit_window_system
;
4144 /* True means that a filter or a sentinel is running. */
4145 extern bool running_asynch_code
;
4147 /* Defined in process.c. */
4148 extern Lisp_Object QCtype
, Qlocal
;
4149 extern void kill_buffer_processes (Lisp_Object
);
4150 extern bool wait_reading_process_output (intmax_t, int, int, bool,
4152 struct Lisp_Process
*,
4154 /* Max value for the first argument of wait_reading_process_output. */
4155 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4156 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4157 The bug merely causes a bogus warning, but the warning is annoying. */
4158 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4160 # define WAIT_READING_MAX INTMAX_MAX
4162 extern void add_keyboard_wait_descriptor (int);
4163 extern void delete_keyboard_wait_descriptor (int);
4165 extern void add_gpm_wait_descriptor (int);
4166 extern void delete_gpm_wait_descriptor (int);
4168 extern void init_process_emacs (void);
4169 extern void syms_of_process (void);
4170 extern void setup_process_coding_systems (Lisp_Object
);
4172 /* Defined in callproc.c. */
4176 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4177 extern void init_callproc_1 (void);
4178 extern void init_callproc (void);
4179 extern void set_initial_environment (void);
4180 extern void syms_of_callproc (void);
4182 /* Defined in doc.c. */
4183 extern Lisp_Object Qfunction_documentation
;
4184 extern Lisp_Object
read_doc_string (Lisp_Object
);
4185 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4186 extern void syms_of_doc (void);
4187 extern int read_bytecode_char (bool);
4189 /* Defined in bytecode.c. */
4190 extern void syms_of_bytecode (void);
4191 extern struct byte_stack
*byte_stack_list
;
4193 extern void mark_byte_stack (void);
4195 extern void unmark_byte_stack (void);
4196 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4197 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4199 /* Defined in macros.c. */
4200 extern void init_macros (void);
4201 extern void syms_of_macros (void);
4203 /* Defined in undo.c. */
4204 extern Lisp_Object Qapply
;
4205 extern Lisp_Object Qinhibit_read_only
;
4206 extern void truncate_undo_list (struct buffer
*);
4207 extern void record_insert (ptrdiff_t, ptrdiff_t);
4208 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4209 extern void record_first_change (void);
4210 extern void record_change (ptrdiff_t, ptrdiff_t);
4211 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4212 Lisp_Object
, Lisp_Object
,
4214 extern void syms_of_undo (void);
4215 /* Defined in textprop.c. */
4216 extern Lisp_Object Qfont
, Qmouse_face
;
4217 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
4218 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
4219 extern Lisp_Object Qminibuffer_prompt
;
4221 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4223 /* Defined in menu.c. */
4224 extern void syms_of_menu (void);
4226 /* Defined in xmenu.c. */
4227 extern void syms_of_xmenu (void);
4229 /* Defined in termchar.h. */
4230 struct tty_display_info
;
4232 /* Defined in termhooks.h. */
4235 /* Defined in sysdep.c. */
4236 #ifndef HAVE_GET_CURRENT_DIR_NAME
4237 extern char *get_current_dir_name (void);
4239 extern void stuff_char (char c
);
4240 extern void init_foreground_group (void);
4241 extern void init_sigio (int);
4242 extern void sys_subshell (void);
4243 extern void sys_suspend (void);
4244 extern void discard_tty_input (void);
4245 extern void init_sys_modes (struct tty_display_info
*);
4246 extern void reset_sys_modes (struct tty_display_info
*);
4247 extern void init_all_sys_modes (void);
4248 extern void reset_all_sys_modes (void);
4249 extern void child_setup_tty (int);
4250 extern void setup_pty (int);
4251 extern int set_window_size (int, int, int);
4252 extern EMACS_INT
get_random (void);
4253 extern void seed_random (void *, ptrdiff_t);
4254 extern void init_random (void);
4255 extern void emacs_backtrace (int);
4256 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4257 extern int emacs_open (const char *, int, int);
4258 extern int emacs_pipe (int[2]);
4259 extern int emacs_close (int);
4260 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4261 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4262 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4263 extern void emacs_perror (char const *);
4265 extern void unlock_all_files (void);
4266 extern void lock_file (Lisp_Object
);
4267 extern void unlock_file (Lisp_Object
);
4268 extern void unlock_buffer (struct buffer
*);
4269 extern void syms_of_filelock (void);
4271 /* Defined in sound.c. */
4272 extern void syms_of_sound (void);
4274 /* Defined in category.c. */
4275 extern void init_category_once (void);
4276 extern Lisp_Object
char_category_set (int);
4277 extern void syms_of_category (void);
4279 /* Defined in ccl.c. */
4280 extern void syms_of_ccl (void);
4282 /* Defined in dired.c. */
4283 extern void syms_of_dired (void);
4284 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4285 Lisp_Object
, Lisp_Object
,
4288 /* Defined in term.c. */
4289 extern int *char_ins_del_vector
;
4290 extern void syms_of_term (void);
4291 extern _Noreturn
void fatal (const char *msgid
, ...)
4292 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4294 /* Defined in terminal.c. */
4295 extern void syms_of_terminal (void);
4297 /* Defined in font.c. */
4298 extern void syms_of_font (void);
4299 extern void init_font (void);
4301 #ifdef HAVE_WINDOW_SYSTEM
4302 /* Defined in fontset.c. */
4303 extern void syms_of_fontset (void);
4305 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4306 extern Lisp_Object Qfont_param
;
4309 /* Defined in gfilenotify.c */
4310 #ifdef HAVE_GFILENOTIFY
4311 extern void globals_of_gfilenotify (void);
4312 extern void syms_of_gfilenotify (void);
4315 /* Defined in inotify.c */
4317 extern void syms_of_inotify (void);
4320 #ifdef HAVE_W32NOTIFY
4321 /* Defined on w32notify.c. */
4322 extern void syms_of_w32notify (void);
4325 /* Defined in xfaces.c. */
4326 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
4327 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
4328 extern Lisp_Object Qmode_line_inactive
;
4329 extern Lisp_Object Qface
;
4330 extern Lisp_Object Qnormal
;
4331 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4332 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4333 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4334 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4335 extern Lisp_Object Qoblique
, Qitalic
;
4336 extern Lisp_Object Vface_alternative_font_family_alist
;
4337 extern Lisp_Object Vface_alternative_font_registry_alist
;
4338 extern void syms_of_xfaces (void);
4340 #ifdef HAVE_X_WINDOWS
4341 /* Defined in xfns.c. */
4342 extern void syms_of_xfns (void);
4344 /* Defined in xsmfns.c. */
4345 extern void syms_of_xsmfns (void);
4347 /* Defined in xselect.c. */
4348 extern void syms_of_xselect (void);
4350 /* Defined in xterm.c. */
4351 extern void syms_of_xterm (void);
4352 #endif /* HAVE_X_WINDOWS */
4354 #ifdef HAVE_WINDOW_SYSTEM
4355 /* Defined in xterm.c, nsterm.m, w32term.c. */
4356 extern char *x_get_keysym_name (int);
4357 #endif /* HAVE_WINDOW_SYSTEM */
4360 /* Defined in xml.c. */
4361 extern void syms_of_xml (void);
4362 extern void xml_cleanup_parser (void);
4366 /* Defined in decompress.c. */
4367 extern void syms_of_decompress (void);
4371 /* Defined in dbusbind.c. */
4372 void syms_of_dbusbind (void);
4376 /* Defined in profiler.c. */
4377 extern bool profiler_memory_running
;
4378 extern void malloc_probe (size_t);
4379 extern void syms_of_profiler (void);
4383 /* Defined in msdos.c, w32.c. */
4384 extern char *emacs_root_dir (void);
4387 /* True means Emacs has already been initialized.
4388 Used during startup to detect startup of dumped Emacs. */
4389 extern bool initialized
;
4391 /* True means ^G can quit instantly. */
4392 extern bool immediate_quit
;
4394 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4395 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4396 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4397 extern void xfree (void *);
4398 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4399 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4400 ATTRIBUTE_ALLOC_SIZE ((2,3));
4401 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4403 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4404 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4405 extern void dupstring (char **, char const *);
4406 extern void xputenv (const char *);
4408 extern char *egetenv (const char *);
4410 /* Copy Lisp string to temporary (allocated on stack) C string. */
4412 #define xlispstrdupa(string) \
4413 memcpy (alloca (SBYTES (string) + 1), \
4414 SSDATA (string), SBYTES (string) + 1)
4416 /* Set up the name of the machine we're running on. */
4417 extern void init_system_name (void);
4419 /* Return the absolute value of X. X should be a signed integer
4420 expression without side effects, and X's absolute value should not
4421 exceed the maximum for its promoted type. This is called 'eabs'
4422 because 'abs' is reserved by the C standard. */
4423 #define eabs(x) ((x) < 0 ? -(x) : (x))
4425 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4428 #define make_fixnum_or_float(val) \
4429 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4431 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4432 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4434 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4436 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4438 #define USE_SAFE_ALLOCA \
4439 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4441 /* SAFE_ALLOCA allocates a simple buffer. */
4443 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4445 : (sa_must_free = true, record_xmalloc (size)))
4447 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4448 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4449 positive. The code is tuned for MULTIPLIER being a constant. */
4451 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4453 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4454 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4457 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4458 sa_must_free = true; \
4459 record_unwind_protect_ptr (xfree, buf); \
4463 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4465 #define SAFE_FREE() \
4467 if (sa_must_free) { \
4468 sa_must_free = false; \
4469 unbind_to (sa_count, Qnil); \
4474 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4476 #define SAFE_ALLOCA_LISP(buf, nelt) \
4478 if ((nelt) < MAX_ALLOCA / word_size) \
4479 (buf) = alloca ((nelt) * word_size); \
4480 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4483 (buf) = xmalloc ((nelt) * word_size); \
4484 arg_ = make_save_memory (buf, nelt); \
4485 sa_must_free = true; \
4486 record_unwind_protect (free_save_value, arg_); \
4489 memory_full (SIZE_MAX); \
4492 /* Loop over all tails of a list, checking for cycles.
4493 FIXME: Make tortoise and n internal declarations.
4494 FIXME: Unroll the loop body so we don't need `n'. */
4495 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4496 for ((tortoise) = (hare) = (list), (n) = true; \
4498 (hare = XCDR (hare), (n) = !(n), \
4500 ? (EQ (hare, tortoise) \
4501 ? xsignal1 (Qcircular_list, list) \
4503 /* Move tortoise before the next iteration, in case */ \
4504 /* the next iteration does an Fsetcdr. */ \
4505 : (void) ((tortoise) = XCDR (tortoise)))))
4507 /* Do a `for' loop over alist values. */
4509 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4510 for ((list_var) = (head_var); \
4511 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4512 (list_var) = XCDR (list_var))
4514 /* Check whether it's time for GC, and run it if so. */
4519 if ((consing_since_gc
> gc_cons_threshold
4520 && consing_since_gc
> gc_relative_threshold
)
4521 || (!NILP (Vmemory_full
)
4522 && consing_since_gc
> memory_full_cons_threshold
))
4523 Fgarbage_collect ();
4527 functionp (Lisp_Object object
)
4529 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4531 object
= Findirect_function (object
, Qt
);
4533 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4535 /* Autoloaded symbols are functions, except if they load
4536 macros or keymaps. */
4538 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4539 object
= XCDR (object
);
4541 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4546 return XSUBR (object
)->max_args
!= UNEVALLED
;
4547 else if (COMPILEDP (object
))
4549 else if (CONSP (object
))
4551 Lisp_Object car
= XCAR (object
);
4552 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4560 #endif /* EMACS_LISP_H */