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))
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 words in a Lisp bool vector. 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_INT
= CHAR_BIT
* sizeof (int),
137 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
138 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
141 /* printmax_t and uprintmax_t are types for printing large integers.
142 These are the widest integers that are supported for printing.
143 pMd etc. are conversions for printing them.
144 On C99 hosts, there's no problem, as even the widest integers work.
145 Fall back on EMACS_INT on pre-C99 hosts. */
147 typedef intmax_t printmax_t
;
148 typedef uintmax_t uprintmax_t
;
152 typedef EMACS_INT printmax_t
;
153 typedef EMACS_UINT uprintmax_t
;
158 /* Use pD to format ptrdiff_t values, which suffice for indexes into
159 buffers and strings. Emacs never allocates objects larger than
160 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
161 In C99, pD can always be "t"; configure it here for the sake of
162 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
163 #if PTRDIFF_MAX == INT_MAX
165 #elif PTRDIFF_MAX == LONG_MAX
167 #elif PTRDIFF_MAX == LLONG_MAX
173 /* Extra internal type checking? */
175 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
176 'assume (COND)'. COND should be free of side effects, as it may or
177 may not be evaluated.
179 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
180 defined and suppress_checking is false, and does nothing otherwise.
181 Emacs dies if COND is checked and is false. The suppress_checking
182 variable is initialized to 0 in alloc.c. Set it to 1 using a
183 debugger to temporarily disable aborting on detected internal
184 inconsistencies or error conditions.
186 In some cases, a good compiler may be able to optimize away the
187 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
188 uses eassert to test STRINGP (x), but a particular use of XSTRING
189 is invoked only after testing that STRINGP (x) is true, making the
192 eassume is like eassert except that it also causes the compiler to
193 assume that COND is true afterwards, regardless of whether runtime
194 checking is enabled. This can improve performance in some cases,
195 though it can degrade performance in others. It's often suboptimal
196 for COND to call external functions or access volatile storage. */
198 #ifndef ENABLE_CHECKING
199 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
200 # define eassume(cond) assume (cond)
201 #else /* ENABLE_CHECKING */
203 extern _Noreturn
void die (const char *, const char *, int);
205 extern bool suppress_checking EXTERNALLY_VISIBLE
;
207 # define eassert(cond) \
208 (suppress_checking || (cond) \
210 : die (# cond, __FILE__, __LINE__))
211 # define eassume(cond) \
216 : die (# cond, __FILE__, __LINE__))
217 #endif /* ENABLE_CHECKING */
220 /* Use the configure flag --enable-check-lisp-object-type to make
221 Lisp_Object use a struct type instead of the default int. The flag
222 causes CHECK_LISP_OBJECT_TYPE to be defined. */
224 /***** Select the tagging scheme. *****/
225 /* The following option controls the tagging scheme:
226 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
227 always 0, and we can thus use them to hold tag bits, without
228 restricting our addressing space.
230 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
231 restricting our possible address range.
233 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
234 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
235 on the few static Lisp_Objects used: all the defsubr as well
236 as the two special buffers buffer_defaults and buffer_local_symbols. */
240 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
241 integer constant, for MSVC. */
242 #define GCALIGNMENT 8
244 /* Number of bits in a Lisp_Object value, not counting the tag. */
245 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
247 /* Number of bits in a Lisp fixnum tag. */
248 INTTYPEBITS
= GCTYPEBITS
- 1,
250 /* Number of bits in a Lisp fixnum value, not counting the tag. */
251 FIXNUM_BITS
= VALBITS
+ 1
254 #if GCALIGNMENT != 1 << GCTYPEBITS
255 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
258 /* The maximum value that can be stored in a EMACS_INT, assuming all
259 bits other than the type bits contribute to a nonnegative signed value.
260 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
261 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
263 /* Whether the least-significant bits of an EMACS_INT contain the tag.
264 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
265 a. unnecessary, because the top bits of an EMACS_INT are unused, and
266 b. slower, because it typically requires extra masking.
267 So, USE_LSB_TAG is true only on hosts where it might be useful. */
268 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
269 #define USE_LSB_TAG (EMACS_INT_MAX >> GCTYPEBITS < INTPTR_MAX)
270 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
272 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
273 # error "USE_LSB_TAG not supported on this platform; please report this." \
274 "Try 'configure --with-wide-int' to work around the problem."
279 # define alignas(alignment) /* empty */
281 # error "USE_LSB_TAG requires alignas"
286 /* Some operations are so commonly executed that they are implemented
287 as macros, not functions, because otherwise runtime performance would
288 suffer too much when compiling with GCC without optimization.
289 There's no need to inline everything, just the operations that
290 would otherwise cause a serious performance problem.
292 For each such operation OP, define a macro lisp_h_OP that contains
293 the operation's implementation. That way, OP can be implemented
294 via a macro definition like this:
296 #define OP(x) lisp_h_OP (x)
298 and/or via a function definition like this:
300 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
302 which macro-expands to this:
304 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
306 without worrying about the implementations diverging, since
307 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
308 are intended to be private to this include file, and should not be
311 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
312 functions, once most developers have access to GCC 4.8 or later and
313 can use "gcc -Og" to debug. Maybe in the year 2016. See
316 Commentary for these macros can be found near their corresponding
319 #if CHECK_LISP_OBJECT_TYPE
320 # define lisp_h_XLI(o) ((o).i)
321 # define lisp_h_XIL(i) ((Lisp_Object) { i })
323 # define lisp_h_XLI(o) (o)
324 # define lisp_h_XIL(i) (i)
326 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
327 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
328 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
329 #define lisp_h_CHECK_TYPE(ok, Qxxxp, x) \
330 ((ok) ? (void) 0 : (void) wrong_type_argument (Qxxxp, x))
331 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
332 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
333 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
334 #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0)
335 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
336 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
337 #define lisp_h_NILP(x) EQ (x, Qnil)
338 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
339 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
340 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
341 #define lisp_h_SYMBOL_VAL(sym) \
342 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
343 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
344 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
345 #define lisp_h_XCAR(c) XCONS (c)->car
346 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
347 #define lisp_h_XCONS(a) \
348 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
349 #define lisp_h_XHASH(a) XUINT (a)
350 #define lisp_h_XPNTR(a) ((void *) (intptr_t) (XLI (a) & VALMASK))
351 #define lisp_h_XSYMBOL(a) \
352 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
353 #ifndef GC_CHECK_CONS_LIST
354 # define lisp_h_check_cons_list() ((void) 0)
357 # define lisp_h_make_number(n) XIL ((EMACS_INT) (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
)
668 return XIL (USE_LSB_TAG
? n
<< INTTYPEBITS
: n
& INTMASK
);
671 /* Extract A's value as a signed integer. */
675 EMACS_INT i
= XLI (a
);
676 return (USE_LSB_TAG
? i
: i
<< INTTYPEBITS
) >> INTTYPEBITS
;
679 /* Like XINT (A), but may be faster. A must be nonnegative.
680 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
681 integers have zero-bits in their tags. */
683 XFASTINT (Lisp_Object a
)
685 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
690 /* Extract A's type. */
691 INLINE
enum Lisp_Type
692 XTYPE (Lisp_Object a
)
694 EMACS_UINT i
= XLI (a
);
695 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
698 /* Extract A's pointer value, assuming A's type is TYPE. */
700 XUNTAG (Lisp_Object a
, int type
)
704 intptr_t i
= XLI (a
) - type
;
710 #endif /* ! USE_LSB_TAG */
712 /* Extract A's value as an unsigned integer. */
714 XUINT (Lisp_Object a
)
716 EMACS_UINT i
= XLI (a
);
717 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
720 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
721 right now, but XUINT should only be applied to objects we know are
723 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
725 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
727 make_natnum (EMACS_INT n
)
729 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
730 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
733 /* Return true if X and Y are the same object. */
734 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
736 /* Value is true if I doesn't fit into a Lisp fixnum. It is
737 written this way so that it also works if I is of unsigned
738 type or if I is a NaN. */
740 #define FIXNUM_OVERFLOW_P(i) \
741 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
744 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
746 return num
< lower
? lower
: num
<= upper
? num
: upper
;
749 /* Forward declarations. */
751 /* Defined in this file. */
753 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
754 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
755 INLINE
bool BUFFERP (Lisp_Object
);
756 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
757 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
758 INLINE
bool (CONSP
) (Lisp_Object
);
759 INLINE
bool (FLOATP
) (Lisp_Object
);
760 INLINE
bool functionp (Lisp_Object
);
761 INLINE
bool (INTEGERP
) (Lisp_Object
);
762 INLINE
bool (MARKERP
) (Lisp_Object
);
763 INLINE
bool (MISCP
) (Lisp_Object
);
764 INLINE
bool (NILP
) (Lisp_Object
);
765 INLINE
bool OVERLAYP (Lisp_Object
);
766 INLINE
bool PROCESSP (Lisp_Object
);
767 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
768 INLINE
bool SAVE_VALUEP (Lisp_Object
);
769 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
771 INLINE
bool STRINGP (Lisp_Object
);
772 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
773 INLINE
bool SUBRP (Lisp_Object
);
774 INLINE
bool (SYMBOLP
) (Lisp_Object
);
775 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
776 INLINE
bool WINDOWP (Lisp_Object
);
777 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
779 /* Defined in chartab.c. */
780 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
781 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
782 extern int char_table_translate (Lisp_Object
, int);
784 /* Defined in data.c. */
785 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
786 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
787 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
788 extern Lisp_Object Qbool_vector_p
;
789 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
790 extern Lisp_Object Qwindow
;
791 extern Lisp_Object
Ffboundp (Lisp_Object
);
792 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
794 /* Defined in emacs.c. */
795 extern bool initialized
;
796 extern bool might_dump
;
798 /* Defined in eval.c. */
799 extern Lisp_Object Qautoload
;
801 /* Defined in floatfns.c. */
802 extern double extract_float (Lisp_Object
);
804 /* Defined in process.c. */
805 extern Lisp_Object Qprocessp
;
807 /* Defined in window.c. */
808 extern Lisp_Object Qwindowp
;
810 /* Defined in xdisp.c. */
811 extern Lisp_Object Qimage
;
814 /* Extract a value or address from a Lisp_Object. */
816 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
818 INLINE
struct Lisp_Vector
*
819 XVECTOR (Lisp_Object a
)
821 eassert (VECTORLIKEP (a
));
822 return XUNTAG (a
, Lisp_Vectorlike
);
825 INLINE
struct Lisp_String
*
826 XSTRING (Lisp_Object a
)
828 eassert (STRINGP (a
));
829 return XUNTAG (a
, Lisp_String
);
832 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
834 INLINE
struct Lisp_Float
*
835 XFLOAT (Lisp_Object a
)
837 eassert (FLOATP (a
));
838 return XUNTAG (a
, Lisp_Float
);
841 /* Pseudovector types. */
843 INLINE
struct Lisp_Process
*
844 XPROCESS (Lisp_Object a
)
846 eassert (PROCESSP (a
));
847 return XUNTAG (a
, Lisp_Vectorlike
);
850 INLINE
struct window
*
851 XWINDOW (Lisp_Object a
)
853 eassert (WINDOWP (a
));
854 return XUNTAG (a
, Lisp_Vectorlike
);
857 INLINE
struct terminal
*
858 XTERMINAL (Lisp_Object a
)
860 return XUNTAG (a
, Lisp_Vectorlike
);
863 INLINE
struct Lisp_Subr
*
864 XSUBR (Lisp_Object a
)
867 return XUNTAG (a
, Lisp_Vectorlike
);
870 INLINE
struct buffer
*
871 XBUFFER (Lisp_Object a
)
873 eassert (BUFFERP (a
));
874 return XUNTAG (a
, Lisp_Vectorlike
);
877 INLINE
struct Lisp_Char_Table
*
878 XCHAR_TABLE (Lisp_Object a
)
880 eassert (CHAR_TABLE_P (a
));
881 return XUNTAG (a
, Lisp_Vectorlike
);
884 INLINE
struct Lisp_Sub_Char_Table
*
885 XSUB_CHAR_TABLE (Lisp_Object a
)
887 eassert (SUB_CHAR_TABLE_P (a
));
888 return XUNTAG (a
, Lisp_Vectorlike
);
891 INLINE
struct Lisp_Bool_Vector
*
892 XBOOL_VECTOR (Lisp_Object a
)
894 eassert (BOOL_VECTOR_P (a
));
895 return XUNTAG (a
, Lisp_Vectorlike
);
898 /* Construct a Lisp_Object from a value or address. */
901 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
903 EMACS_UINT utype
= type
;
904 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
905 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
906 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
911 make_lisp_proc (struct Lisp_Process
*p
)
913 return make_lisp_ptr (p
, Lisp_Vectorlike
);
916 #define XSETINT(a, b) ((a) = make_number (b))
917 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
918 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
919 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
920 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
921 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
922 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
923 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
925 /* Pseudovector types. */
927 #define XSETPVECTYPE(v, code) \
928 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
929 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
930 ((v)->header.size = (PSEUDOVECTOR_FLAG \
931 | ((code) << PSEUDOVECTOR_AREA_BITS) \
932 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
935 /* The cast to struct vectorlike_header * avoids aliasing issues. */
936 #define XSETPSEUDOVECTOR(a, b, code) \
937 XSETTYPED_PSEUDOVECTOR (a, b, \
938 (((struct vectorlike_header *) \
939 XUNTAG (a, Lisp_Vectorlike)) \
942 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
943 (XSETVECTOR (a, b), \
944 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
945 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
947 #define XSETWINDOW_CONFIGURATION(a, b) \
948 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
949 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
950 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
951 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
952 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
953 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
954 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
955 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
956 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
957 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
961 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
, (int ok
, Lisp_Object Qxxxp
, Lisp_Object x
),
964 /* Deprecated and will be removed soon. */
966 #define INTERNAL_FIELD(field) field ## _
968 /* See the macros in intervals.h. */
970 typedef struct interval
*INTERVAL
;
974 /* Car of this cons cell. */
979 /* Cdr of this cons cell. */
982 /* Used to chain conses on a free list. */
983 struct Lisp_Cons
*chain
;
987 /* Take the car or cdr of something known to be a cons cell. */
988 /* The _addr functions shouldn't be used outside of the minimal set
989 of code that has to know what a cons cell looks like. Other code not
990 part of the basic lisp implementation should assume that the car and cdr
991 fields are not accessible. (What if we want to switch to
992 a copying collector someday? Cached cons cell field addresses may be
993 invalidated at arbitrary points.) */
995 xcar_addr (Lisp_Object c
)
997 return &XCONS (c
)->car
;
1000 xcdr_addr (Lisp_Object c
)
1002 return &XCONS (c
)->u
.cdr
;
1005 /* Use these from normal code. */
1006 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
1007 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
1009 /* Use these to set the fields of a cons cell.
1011 Note that both arguments may refer to the same object, so 'n'
1012 should not be read after 'c' is first modified. */
1014 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1019 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1024 /* Take the car or cdr of something whose type is not known. */
1028 return (CONSP (c
) ? XCAR (c
)
1030 : wrong_type_argument (Qlistp
, c
));
1035 return (CONSP (c
) ? XCDR (c
)
1037 : wrong_type_argument (Qlistp
, c
));
1040 /* Take the car or cdr of something whose type is not known. */
1042 CAR_SAFE (Lisp_Object c
)
1044 return CONSP (c
) ? XCAR (c
) : Qnil
;
1047 CDR_SAFE (Lisp_Object c
)
1049 return CONSP (c
) ? XCDR (c
) : Qnil
;
1052 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1057 ptrdiff_t size_byte
;
1058 INTERVAL intervals
; /* Text properties in this string. */
1059 unsigned char *data
;
1062 /* True if STR is a multibyte string. */
1064 STRING_MULTIBYTE (Lisp_Object str
)
1066 return 0 <= XSTRING (str
)->size_byte
;
1069 /* An upper bound on the number of bytes in a Lisp string, not
1070 counting the terminating null. This a tight enough bound to
1071 prevent integer overflow errors that would otherwise occur during
1072 string size calculations. A string cannot contain more bytes than
1073 a fixnum can represent, nor can it be so long that C pointer
1074 arithmetic stops working on the string plus its terminating null.
1075 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1076 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1077 would expose alloc.c internal details that we'd rather keep
1080 This is a macro for use in static initializers. The cast to
1081 ptrdiff_t ensures that the macro is signed. */
1082 #define STRING_BYTES_BOUND \
1083 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1085 /* Mark STR as a unibyte string. */
1086 #define STRING_SET_UNIBYTE(STR) \
1088 if (EQ (STR, empty_multibyte_string)) \
1089 (STR) = empty_unibyte_string; \
1091 XSTRING (STR)->size_byte = -1; \
1094 /* Mark STR as a multibyte string. Assure that STR contains only
1095 ASCII characters in advance. */
1096 #define STRING_SET_MULTIBYTE(STR) \
1098 if (EQ (STR, empty_unibyte_string)) \
1099 (STR) = empty_multibyte_string; \
1101 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1104 /* Convenience functions for dealing with Lisp strings. */
1106 INLINE
unsigned char *
1107 SDATA (Lisp_Object string
)
1109 return XSTRING (string
)->data
;
1112 SSDATA (Lisp_Object string
)
1114 /* Avoid "differ in sign" warnings. */
1115 return (char *) SDATA (string
);
1117 INLINE
unsigned char
1118 SREF (Lisp_Object string
, ptrdiff_t index
)
1120 return SDATA (string
)[index
];
1123 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1125 SDATA (string
)[index
] = new;
1128 SCHARS (Lisp_Object string
)
1130 return XSTRING (string
)->size
;
1133 #ifdef GC_CHECK_STRING_BYTES
1134 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1137 STRING_BYTES (struct Lisp_String
*s
)
1139 #ifdef GC_CHECK_STRING_BYTES
1140 return string_bytes (s
);
1142 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1147 SBYTES (Lisp_Object string
)
1149 return STRING_BYTES (XSTRING (string
));
1152 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1154 XSTRING (string
)->size
= newsize
;
1157 STRING_COPYIN (Lisp_Object string
, ptrdiff_t index
, char const *new,
1160 memcpy (SDATA (string
) + index
, new, count
);
1163 /* Header of vector-like objects. This documents the layout constraints on
1164 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1165 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1166 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1167 because when two such pointers potentially alias, a compiler won't
1168 incorrectly reorder loads and stores to their size fields. See
1170 struct vectorlike_header
1172 /* The only field contains various pieces of information:
1173 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1174 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1175 vector (0) or a pseudovector (1).
1176 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1177 of slots) of the vector.
1178 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1179 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1180 - b) number of Lisp_Objects slots at the beginning of the object
1181 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1183 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1184 measured in word_size units. Rest fields may also include
1185 Lisp_Objects, but these objects usually needs some special treatment
1187 There are some exceptions. For PVEC_FREE, b) is always zero. For
1188 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1189 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1190 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1194 /* A regular vector is just a header plus an array of Lisp_Objects. */
1198 struct vectorlike_header header
;
1199 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1202 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1205 ALIGNOF_STRUCT_LISP_VECTOR
1206 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1209 /* A boolvector is a kind of vectorlike, with contents like a string. */
1211 struct Lisp_Bool_Vector
1213 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1214 just the subtype information. */
1215 struct vectorlike_header header
;
1216 /* This is the size in bits. */
1218 /* The actual bits, packed into bytes.
1219 Zeros fill out the last word if needed.
1220 The bits are in little-endian order in the bytes, and
1221 the bytes are in little-endian order in the words. */
1222 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1226 bool_vector_size (Lisp_Object a
)
1228 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1229 eassume (0 <= size
);
1234 bool_vector_data (Lisp_Object a
)
1236 return XBOOL_VECTOR (a
)->data
;
1239 INLINE
unsigned char *
1240 bool_vector_uchar_data (Lisp_Object a
)
1242 return (unsigned char *) bool_vector_data (a
);
1245 /* The number of data words and bytes in a bool vector with SIZE bits. */
1248 bool_vector_words (EMACS_INT size
)
1250 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1251 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1255 bool_vector_bytes (EMACS_INT size
)
1257 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1258 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1261 /* True if A's Ith bit is set. */
1264 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1266 eassume (0 <= i
&& i
< bool_vector_size (a
));
1267 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1268 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1272 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1274 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1277 /* Set A's Ith bit to B. */
1280 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1282 unsigned char *addr
;
1284 eassume (0 <= i
&& i
< bool_vector_size (a
));
1285 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1288 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1290 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1293 /* Some handy constants for calculating sizes
1294 and offsets, mostly of vectorlike objects. */
1298 header_size
= offsetof (struct Lisp_Vector
, contents
),
1299 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1300 word_size
= sizeof (Lisp_Object
)
1303 /* Conveniences for dealing with Lisp arrays. */
1306 AREF (Lisp_Object array
, ptrdiff_t idx
)
1308 return XVECTOR (array
)->contents
[idx
];
1311 INLINE Lisp_Object
*
1312 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1314 return & XVECTOR (array
)->contents
[idx
];
1318 ASIZE (Lisp_Object array
)
1320 return XVECTOR (array
)->header
.size
;
1324 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1326 eassert (0 <= idx
&& idx
< ASIZE (array
));
1327 XVECTOR (array
)->contents
[idx
] = val
;
1331 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1333 /* Like ASET, but also can be used in the garbage collector:
1334 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1335 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
1336 XVECTOR (array
)->contents
[idx
] = val
;
1339 /* If a struct is made to look like a vector, this macro returns the length
1340 of the shortest vector that would hold that struct. */
1342 #define VECSIZE(type) \
1343 ((sizeof (type) - header_size + word_size - 1) / word_size)
1345 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1346 at the end and we need to compute the number of Lisp_Object fields (the
1347 ones that the GC needs to trace). */
1349 #define PSEUDOVECSIZE(type, nonlispfield) \
1350 ((offsetof (type, nonlispfield) - header_size) / word_size)
1352 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1353 should be integer expressions. This is not the same as
1354 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1355 returns true. For efficiency, prefer plain unsigned comparison if A
1356 and B's sizes both fit (after integer promotion). */
1357 #define UNSIGNED_CMP(a, op, b) \
1358 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1359 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1360 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1362 /* True iff C is an ASCII character. */
1363 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1365 /* A char-table is a kind of vectorlike, with contents are like a
1366 vector but with a few other slots. For some purposes, it makes
1367 sense to handle a char-table with type struct Lisp_Vector. An
1368 element of a char table can be any Lisp objects, but if it is a sub
1369 char-table, we treat it a table that contains information of a
1370 specific range of characters. A sub char-table has the same
1371 structure as a vector. A sub char table appears only in an element
1372 of a char-table, and there's no way to access it directly from
1373 Emacs Lisp program. */
1375 enum CHARTAB_SIZE_BITS
1377 CHARTAB_SIZE_BITS_0
= 6,
1378 CHARTAB_SIZE_BITS_1
= 4,
1379 CHARTAB_SIZE_BITS_2
= 5,
1380 CHARTAB_SIZE_BITS_3
= 7
1383 extern const int chartab_size
[4];
1385 struct Lisp_Char_Table
1387 /* HEADER.SIZE is the vector's size field, which also holds the
1388 pseudovector type information. It holds the size, too.
1389 The size counts the defalt, parent, purpose, ascii,
1390 contents, and extras slots. */
1391 struct vectorlike_header header
;
1393 /* This holds a default value,
1394 which is used whenever the value for a specific character is nil. */
1397 /* This points to another char table, which we inherit from when the
1398 value for a specific character is nil. The `defalt' slot takes
1399 precedence over this. */
1402 /* This is a symbol which says what kind of use this char-table is
1404 Lisp_Object purpose
;
1406 /* The bottom sub char-table for characters of the range 0..127. It
1407 is nil if none of ASCII character has a specific value. */
1410 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1412 /* These hold additional data. It is a vector. */
1413 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1416 struct Lisp_Sub_Char_Table
1418 /* HEADER.SIZE is the vector's size field, which also holds the
1419 pseudovector type information. It holds the size, too. */
1420 struct vectorlike_header header
;
1422 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1423 char-table of depth 1 contains 16 elements, and each element
1424 covers 4096 (128*32) characters. A sub char-table of depth 2
1425 contains 32 elements, and each element covers 128 characters. A
1426 sub char-table of depth 3 contains 128 elements, and each element
1427 is for one character. */
1430 /* Minimum character covered by the sub char-table. */
1431 Lisp_Object min_char
;
1433 /* Use set_sub_char_table_contents to set this. */
1434 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1438 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1440 struct Lisp_Char_Table
*tbl
= NULL
;
1444 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1445 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1446 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1450 while (NILP (val
) && ! NILP (tbl
->parent
));
1455 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1456 characters. Do not check validity of CT. */
1458 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1460 return (ASCII_CHAR_P (idx
)
1461 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1462 : char_table_ref (ct
, idx
));
1465 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1466 8-bit European characters. Do not check validity of CT. */
1468 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1470 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1471 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1473 char_table_set (ct
, idx
, val
);
1476 /* This structure describes a built-in function.
1477 It is generated by the DEFUN macro only.
1478 defsubr makes it into a Lisp object. */
1482 struct vectorlike_header header
;
1484 Lisp_Object (*a0
) (void);
1485 Lisp_Object (*a1
) (Lisp_Object
);
1486 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1487 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1488 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1489 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1490 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1491 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1492 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1493 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1494 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1496 short min_args
, max_args
;
1497 const char *symbol_name
;
1498 const char *intspec
;
1502 /* This is the number of slots that every char table must have. This
1503 counts the ordinary slots and the top, defalt, parent, and purpose
1505 enum CHAR_TABLE_STANDARD_SLOTS
1507 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1510 /* Return the number of "extra" slots in the char table CT. */
1513 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1515 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1516 - CHAR_TABLE_STANDARD_SLOTS
);
1520 /***********************************************************************
1522 ***********************************************************************/
1524 /* Interned state of a symbol. */
1526 enum symbol_interned
1528 SYMBOL_UNINTERNED
= 0,
1529 SYMBOL_INTERNED
= 1,
1530 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1533 enum symbol_redirect
1535 SYMBOL_PLAINVAL
= 4,
1536 SYMBOL_VARALIAS
= 1,
1537 SYMBOL_LOCALIZED
= 2,
1538 SYMBOL_FORWARDED
= 3
1543 bool_bf gcmarkbit
: 1;
1545 /* Indicates where the value can be found:
1546 0 : it's a plain var, the value is in the `value' field.
1547 1 : it's a varalias, the value is really in the `alias' symbol.
1548 2 : it's a localized var, the value is in the `blv' object.
1549 3 : it's a forwarding variable, the value is in `forward'. */
1550 ENUM_BF (symbol_redirect
) redirect
: 3;
1552 /* Non-zero means symbol is constant, i.e. changing its value
1553 should signal an error. If the value is 3, then the var
1554 can be changed, but only by `defconst'. */
1555 unsigned constant
: 2;
1557 /* Interned state of the symbol. This is an enumerator from
1558 enum symbol_interned. */
1559 unsigned interned
: 2;
1561 /* True means that this variable has been explicitly declared
1562 special (with `defvar' etc), and shouldn't be lexically bound. */
1563 bool_bf declared_special
: 1;
1565 /* True if pointed to from purespace and hence can't be GC'd. */
1568 /* The symbol's name, as a Lisp string. */
1571 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1572 union is used depends on the `redirect' field above. */
1575 struct Lisp_Symbol
*alias
;
1576 struct Lisp_Buffer_Local_Value
*blv
;
1577 union Lisp_Fwd
*fwd
;
1580 /* Function value of the symbol or Qnil if not fboundp. */
1581 Lisp_Object function
;
1583 /* The symbol's property list. */
1586 /* Next symbol in obarray bucket, if the symbol is interned. */
1587 struct Lisp_Symbol
*next
;
1590 /* Value is name of symbol. */
1592 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1594 INLINE
struct Lisp_Symbol
*
1595 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1597 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1598 return sym
->val
.alias
;
1600 INLINE
struct Lisp_Buffer_Local_Value
*
1601 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1603 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1604 return sym
->val
.blv
;
1606 INLINE
union Lisp_Fwd
*
1607 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1609 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1610 return sym
->val
.fwd
;
1613 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1614 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1617 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1619 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1623 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1625 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1629 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1631 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1636 SYMBOL_NAME (Lisp_Object sym
)
1638 return XSYMBOL (sym
)->name
;
1641 /* Value is true if SYM is an interned symbol. */
1644 SYMBOL_INTERNED_P (Lisp_Object sym
)
1646 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1649 /* Value is true if SYM is interned in initial_obarray. */
1652 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1654 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1657 /* Value is non-zero if symbol is considered a constant, i.e. its
1658 value cannot be changed (there is an exception for keyword symbols,
1659 whose value can be set to the keyword symbol itself). */
1661 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1663 #define DEFSYM(sym, name) \
1664 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1667 /***********************************************************************
1669 ***********************************************************************/
1671 /* The structure of a Lisp hash table. */
1673 struct hash_table_test
1675 /* Name of the function used to compare keys. */
1678 /* User-supplied hash function, or nil. */
1679 Lisp_Object user_hash_function
;
1681 /* User-supplied key comparison function, or nil. */
1682 Lisp_Object user_cmp_function
;
1684 /* C function to compare two keys. */
1685 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1687 /* C function to compute hash code. */
1688 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1691 struct Lisp_Hash_Table
1693 /* This is for Lisp; the hash table code does not refer to it. */
1694 struct vectorlike_header header
;
1696 /* Nil if table is non-weak. Otherwise a symbol describing the
1697 weakness of the table. */
1700 /* When the table is resized, and this is an integer, compute the
1701 new size by adding this to the old size. If a float, compute the
1702 new size by multiplying the old size with this factor. */
1703 Lisp_Object rehash_size
;
1705 /* Resize hash table when number of entries/ table size is >= this
1707 Lisp_Object rehash_threshold
;
1709 /* Vector of hash codes.. If hash[I] is nil, this means that that
1710 entry I is unused. */
1713 /* Vector used to chain entries. If entry I is free, next[I] is the
1714 entry number of the next free item. If entry I is non-free,
1715 next[I] is the index of the next entry in the collision chain. */
1718 /* Index of first free entry in free list. */
1719 Lisp_Object next_free
;
1721 /* Bucket vector. A non-nil entry is the index of the first item in
1722 a collision chain. This vector's size can be larger than the
1723 hash table size to reduce collisions. */
1726 /* Only the fields above are traced normally by the GC. The ones below
1727 `count' are special and are either ignored by the GC or traced in
1728 a special way (e.g. because of weakness). */
1730 /* Number of key/value entries in the table. */
1733 /* Vector of keys and values. The key of item I is found at index
1734 2 * I, the value is found at index 2 * I + 1.
1735 This is gc_marked specially if the table is weak. */
1736 Lisp_Object key_and_value
;
1738 /* The comparison and hash functions. */
1739 struct hash_table_test test
;
1741 /* Next weak hash table if this is a weak hash table. The head
1742 of the list is in weak_hash_tables. */
1743 struct Lisp_Hash_Table
*next_weak
;
1747 INLINE
struct Lisp_Hash_Table
*
1748 XHASH_TABLE (Lisp_Object a
)
1750 return XUNTAG (a
, Lisp_Vectorlike
);
1753 #define XSET_HASH_TABLE(VAR, PTR) \
1754 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1757 HASH_TABLE_P (Lisp_Object a
)
1759 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1762 /* Value is the key part of entry IDX in hash table H. */
1764 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1766 return AREF (h
->key_and_value
, 2 * idx
);
1769 /* Value is the value part of entry IDX in hash table H. */
1771 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1773 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1776 /* Value is the index of the next entry following the one at IDX
1779 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1781 return AREF (h
->next
, idx
);
1784 /* Value is the hash code computed for entry IDX in hash table H. */
1786 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1788 return AREF (h
->hash
, idx
);
1791 /* Value is the index of the element in hash table H that is the
1792 start of the collision list at index IDX in the index vector of H. */
1794 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1796 return AREF (h
->index
, idx
);
1799 /* Value is the size of hash table H. */
1801 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1803 return ASIZE (h
->next
);
1806 /* Default size for hash tables if not specified. */
1808 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1810 /* Default threshold specifying when to resize a hash table. The
1811 value gives the ratio of current entries in the hash table and the
1812 size of the hash table. */
1814 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1816 /* Default factor by which to increase the size of a hash table. */
1818 static double const DEFAULT_REHASH_SIZE
= 1.5;
1820 /* Combine two integers X and Y for hashing. The result might not fit
1821 into a Lisp integer. */
1824 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1826 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1829 /* Hash X, returning a value that fits into a fixnum. */
1832 SXHASH_REDUCE (EMACS_UINT x
)
1834 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1837 /* These structures are used for various misc types. */
1839 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1841 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1842 bool_bf gcmarkbit
: 1;
1843 unsigned spacer
: 15;
1848 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1849 bool_bf gcmarkbit
: 1;
1850 unsigned spacer
: 13;
1851 /* This flag is temporarily used in the functions
1852 decode/encode_coding_object to record that the marker position
1853 must be adjusted after the conversion. */
1854 bool_bf need_adjustment
: 1;
1855 /* True means normal insertion at the marker's position
1856 leaves the marker after the inserted text. */
1857 bool_bf insertion_type
: 1;
1858 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1859 Note: a chain of markers can contain markers pointing into different
1860 buffers (the chain is per buffer_text rather than per buffer, so it's
1861 shared between indirect buffers). */
1862 /* This is used for (other than NULL-checking):
1864 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1865 - unchain_marker: to find the list from which to unchain.
1866 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1868 struct buffer
*buffer
;
1870 /* The remaining fields are meaningless in a marker that
1871 does not point anywhere. */
1873 /* For markers that point somewhere,
1874 this is used to chain of all the markers in a given buffer. */
1875 /* We could remove it and use an array in buffer_text instead.
1876 That would also allow to preserve it ordered. */
1877 struct Lisp_Marker
*next
;
1878 /* This is the char position where the marker points. */
1880 /* This is the byte position.
1881 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1882 used to implement the functionality of markers, but rather to (ab)use
1883 markers as a cache for char<->byte mappings). */
1887 /* START and END are markers in the overlay's buffer, and
1888 PLIST is the overlay's property list. */
1890 /* An overlay's real data content is:
1892 - buffer (really there are two buffer pointers, one per marker,
1893 and both points to the same buffer)
1894 - insertion type of both ends (per-marker fields)
1895 - start & start byte (of start marker)
1896 - end & end byte (of end marker)
1897 - next (singly linked list of overlays)
1898 - next fields of start and end markers (singly linked list of markers).
1899 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1902 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1903 bool_bf gcmarkbit
: 1;
1904 unsigned spacer
: 15;
1905 struct Lisp_Overlay
*next
;
1911 /* Types of data which may be saved in a Lisp_Save_Value. */
1922 /* Number of bits needed to store one of the above values. */
1923 enum { SAVE_SLOT_BITS
= 3 };
1925 /* Number of slots in a save value where save_type is nonzero. */
1926 enum { SAVE_VALUE_SLOTS
= 4 };
1928 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1930 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1934 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1935 SAVE_TYPE_INT_INT_INT
1936 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1937 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1938 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1939 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1940 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1941 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1942 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1943 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1944 SAVE_TYPE_FUNCPTR_PTR_OBJ
1945 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1947 /* This has an extra bit indicating it's raw memory. */
1948 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1951 /* Special object used to hold a different values for later use.
1953 This is mostly used to package C integers and pointers to call
1954 record_unwind_protect when two or more values need to be saved.
1958 struct my_data *md = get_my_data ();
1959 ptrdiff_t mi = get_my_integer ();
1960 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1963 Lisp_Object my_unwind (Lisp_Object arg)
1965 struct my_data *md = XSAVE_POINTER (arg, 0);
1966 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1970 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1971 saved objects and raise eassert if type of the saved object doesn't match
1972 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1973 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1974 slot 0 is a pointer. */
1976 typedef void (*voidfuncptr
) (void);
1978 struct Lisp_Save_Value
1980 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1981 bool_bf gcmarkbit
: 1;
1982 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
1984 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1985 V's data entries are determined by V->save_type. E.g., if
1986 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1987 V->data[1] is an integer, and V's other data entries are unused.
1989 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1990 a memory area containing V->data[1].integer potential Lisp_Objects. */
1991 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1994 voidfuncptr funcpointer
;
1997 } data
[SAVE_VALUE_SLOTS
];
2000 /* Return the type of V's Nth saved value. */
2002 save_type (struct Lisp_Save_Value
*v
, int n
)
2004 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2005 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2008 /* Get and set the Nth saved pointer. */
2011 XSAVE_POINTER (Lisp_Object obj
, int n
)
2013 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2014 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2017 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2019 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2020 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2023 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2025 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2026 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2029 /* Likewise for the saved integer. */
2032 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2034 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2035 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2038 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2040 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2041 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2044 /* Extract Nth saved object. */
2047 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2049 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2050 return XSAVE_VALUE (obj
)->data
[n
].object
;
2053 /* A miscellaneous object, when it's on the free list. */
2056 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2057 bool_bf gcmarkbit
: 1;
2058 unsigned spacer
: 15;
2059 union Lisp_Misc
*chain
;
2062 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2063 It uses one of these struct subtypes to get the type field. */
2067 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2068 struct Lisp_Free u_free
;
2069 struct Lisp_Marker u_marker
;
2070 struct Lisp_Overlay u_overlay
;
2071 struct Lisp_Save_Value u_save_value
;
2074 INLINE
union Lisp_Misc
*
2075 XMISC (Lisp_Object a
)
2077 return XUNTAG (a
, Lisp_Misc
);
2080 INLINE
struct Lisp_Misc_Any
*
2081 XMISCANY (Lisp_Object a
)
2083 eassert (MISCP (a
));
2084 return & XMISC (a
)->u_any
;
2087 INLINE
enum Lisp_Misc_Type
2088 XMISCTYPE (Lisp_Object a
)
2090 return XMISCANY (a
)->type
;
2093 INLINE
struct Lisp_Marker
*
2094 XMARKER (Lisp_Object a
)
2096 eassert (MARKERP (a
));
2097 return & XMISC (a
)->u_marker
;
2100 INLINE
struct Lisp_Overlay
*
2101 XOVERLAY (Lisp_Object a
)
2103 eassert (OVERLAYP (a
));
2104 return & XMISC (a
)->u_overlay
;
2107 INLINE
struct Lisp_Save_Value
*
2108 XSAVE_VALUE (Lisp_Object a
)
2110 eassert (SAVE_VALUEP (a
));
2111 return & XMISC (a
)->u_save_value
;
2114 /* Forwarding pointer to an int variable.
2115 This is allowed only in the value cell of a symbol,
2116 and it means that the symbol's value really lives in the
2117 specified int variable. */
2120 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2124 /* Boolean forwarding pointer to an int variable.
2125 This is like Lisp_Intfwd except that the ostensible
2126 "value" of the symbol is t if the bool variable is true,
2127 nil if it is false. */
2130 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2134 /* Forwarding pointer to a Lisp_Object variable.
2135 This is allowed only in the value cell of a symbol,
2136 and it means that the symbol's value really lives in the
2137 specified variable. */
2140 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2141 Lisp_Object
*objvar
;
2144 /* Like Lisp_Objfwd except that value lives in a slot in the
2145 current buffer. Value is byte index of slot within buffer. */
2146 struct Lisp_Buffer_Objfwd
2148 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2150 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2151 Lisp_Object predicate
;
2154 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2155 the symbol has buffer-local or frame-local bindings. (Exception:
2156 some buffer-local variables are built-in, with their values stored
2157 in the buffer structure itself. They are handled differently,
2158 using struct Lisp_Buffer_Objfwd.)
2160 The `realvalue' slot holds the variable's current value, or a
2161 forwarding pointer to where that value is kept. This value is the
2162 one that corresponds to the loaded binding. To read or set the
2163 variable, you must first make sure the right binding is loaded;
2164 then you can access the value in (or through) `realvalue'.
2166 `buffer' and `frame' are the buffer and frame for which the loaded
2167 binding was found. If those have changed, to make sure the right
2168 binding is loaded it is necessary to find which binding goes with
2169 the current buffer and selected frame, then load it. To load it,
2170 first unload the previous binding, then copy the value of the new
2171 binding into `realvalue' (or through it). Also update
2172 LOADED-BINDING to point to the newly loaded binding.
2174 `local_if_set' indicates that merely setting the variable creates a
2175 local binding for the current buffer. Otherwise the latter, setting
2176 the variable does not do that; only make-local-variable does that. */
2178 struct Lisp_Buffer_Local_Value
2180 /* True means that merely setting the variable creates a local
2181 binding for the current buffer. */
2182 bool_bf local_if_set
: 1;
2183 /* True means this variable can have frame-local bindings, otherwise, it is
2184 can have buffer-local bindings. The two cannot be combined. */
2185 bool_bf frame_local
: 1;
2186 /* True means that the binding now loaded was found.
2187 Presumably equivalent to (defcell!=valcell). */
2189 /* If non-NULL, a forwarding to the C var where it should also be set. */
2190 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2191 /* The buffer or frame for which the loaded binding was found. */
2193 /* A cons cell that holds the default value. It has the form
2194 (SYMBOL . DEFAULT-VALUE). */
2195 Lisp_Object defcell
;
2196 /* The cons cell from `where's parameter alist.
2197 It always has the form (SYMBOL . VALUE)
2198 Note that if `forward' is non-nil, VALUE may be out of date.
2199 Also if the currently loaded binding is the default binding, then
2200 this is `eq'ual to defcell. */
2201 Lisp_Object valcell
;
2204 /* Like Lisp_Objfwd except that value lives in a slot in the
2206 struct Lisp_Kboard_Objfwd
2208 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2214 struct Lisp_Intfwd u_intfwd
;
2215 struct Lisp_Boolfwd u_boolfwd
;
2216 struct Lisp_Objfwd u_objfwd
;
2217 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2218 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2221 INLINE
enum Lisp_Fwd_Type
2222 XFWDTYPE (union Lisp_Fwd
*a
)
2224 return a
->u_intfwd
.type
;
2227 INLINE
struct Lisp_Buffer_Objfwd
*
2228 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2230 eassert (BUFFER_OBJFWDP (a
));
2231 return &a
->u_buffer_objfwd
;
2234 /* Lisp floating point type. */
2240 struct Lisp_Float
*chain
;
2245 XFLOAT_DATA (Lisp_Object f
)
2247 return XFLOAT (f
)->u
.data
;
2250 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2251 representations, have infinities and NaNs, and do not trap on
2252 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2253 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2254 wanted here, but is not quite right because Emacs does not require
2255 all the features of C11 Annex F (and does not require C11 at all,
2256 for that matter). */
2260 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2261 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2264 /* A character, declared with the following typedef, is a member
2265 of some character set associated with the current buffer. */
2266 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2268 typedef unsigned char UCHAR
;
2271 /* Meanings of slots in a Lisp_Compiled: */
2275 COMPILED_ARGLIST
= 0,
2276 COMPILED_BYTECODE
= 1,
2277 COMPILED_CONSTANTS
= 2,
2278 COMPILED_STACK_DEPTH
= 3,
2279 COMPILED_DOC_STRING
= 4,
2280 COMPILED_INTERACTIVE
= 5
2283 /* Flag bits in a character. These also get used in termhooks.h.
2284 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2285 (MUlti-Lingual Emacs) might need 22 bits for the character value
2286 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2289 CHAR_ALT
= 0x0400000,
2290 CHAR_SUPER
= 0x0800000,
2291 CHAR_HYPER
= 0x1000000,
2292 CHAR_SHIFT
= 0x2000000,
2293 CHAR_CTL
= 0x4000000,
2294 CHAR_META
= 0x8000000,
2296 CHAR_MODIFIER_MASK
=
2297 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2299 /* Actually, the current Emacs uses 22 bits for the character value
2304 /* Data type checking. */
2306 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2309 NUMBERP (Lisp_Object x
)
2311 return INTEGERP (x
) || FLOATP (x
);
2314 NATNUMP (Lisp_Object x
)
2316 return INTEGERP (x
) && 0 <= XINT (x
);
2320 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2322 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2325 #define TYPE_RANGED_INTEGERP(type, x) \
2327 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2328 && XINT (x) <= TYPE_MAXIMUM (type))
2330 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2331 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2332 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2333 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2334 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2335 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2336 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2339 STRINGP (Lisp_Object x
)
2341 return XTYPE (x
) == Lisp_String
;
2344 VECTORP (Lisp_Object x
)
2346 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2349 OVERLAYP (Lisp_Object x
)
2351 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2354 SAVE_VALUEP (Lisp_Object x
)
2356 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2360 AUTOLOADP (Lisp_Object x
)
2362 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2366 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2368 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2372 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2374 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2375 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2378 /* True if A is a pseudovector whose code is CODE. */
2380 PSEUDOVECTORP (Lisp_Object a
, int code
)
2382 if (! VECTORLIKEP (a
))
2386 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2387 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2388 return PSEUDOVECTOR_TYPEP (h
, code
);
2393 /* Test for specific pseudovector types. */
2396 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2398 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2402 PROCESSP (Lisp_Object a
)
2404 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2408 WINDOWP (Lisp_Object a
)
2410 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2414 TERMINALP (Lisp_Object a
)
2416 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2420 SUBRP (Lisp_Object a
)
2422 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2426 COMPILEDP (Lisp_Object a
)
2428 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2432 BUFFERP (Lisp_Object a
)
2434 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2438 CHAR_TABLE_P (Lisp_Object a
)
2440 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2444 SUB_CHAR_TABLE_P (Lisp_Object a
)
2446 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2450 BOOL_VECTOR_P (Lisp_Object a
)
2452 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2456 FRAMEP (Lisp_Object a
)
2458 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2461 /* Test for image (image . spec) */
2463 IMAGEP (Lisp_Object x
)
2465 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2470 ARRAYP (Lisp_Object x
)
2472 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2476 CHECK_LIST (Lisp_Object x
)
2478 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2481 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2482 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2483 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2486 CHECK_STRING (Lisp_Object x
)
2488 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2491 CHECK_STRING_CAR (Lisp_Object x
)
2493 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2496 CHECK_CONS (Lisp_Object x
)
2498 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2501 CHECK_VECTOR (Lisp_Object x
)
2503 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2506 CHECK_BOOL_VECTOR (Lisp_Object x
)
2508 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2511 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2513 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2516 CHECK_ARRAY (Lisp_Object x
, Lisp_Object Qxxxp
)
2518 CHECK_TYPE (ARRAYP (x
), Qxxxp
, x
);
2521 CHECK_BUFFER (Lisp_Object x
)
2523 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2526 CHECK_WINDOW (Lisp_Object x
)
2528 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2532 CHECK_PROCESS (Lisp_Object x
)
2534 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2538 CHECK_NATNUM (Lisp_Object x
)
2540 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2543 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2546 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2547 args_out_of_range_3 \
2549 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2550 ? MOST_NEGATIVE_FIXNUM \
2552 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2554 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2556 if (TYPE_SIGNED (type)) \
2557 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2559 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2562 #define CHECK_NUMBER_COERCE_MARKER(x) \
2564 if (MARKERP ((x))) \
2565 XSETFASTINT (x, marker_position (x)); \
2567 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2571 XFLOATINT (Lisp_Object n
)
2573 return extract_float (n
);
2577 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2579 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2582 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2585 XSETFASTINT (x, marker_position (x)); \
2587 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2590 /* Since we can't assign directly to the CAR or CDR fields of a cons
2591 cell, use these when checking that those fields contain numbers. */
2593 CHECK_NUMBER_CAR (Lisp_Object x
)
2595 Lisp_Object tmp
= XCAR (x
);
2601 CHECK_NUMBER_CDR (Lisp_Object x
)
2603 Lisp_Object tmp
= XCDR (x
);
2608 /* Define a built-in function for calling from Lisp.
2609 `lname' should be the name to give the function in Lisp,
2610 as a null-terminated C string.
2611 `fnname' should be the name of the function in C.
2612 By convention, it starts with F.
2613 `sname' should be the name for the C constant structure
2614 that records information on this function for internal use.
2615 By convention, it should be the same as `fnname' but with S instead of F.
2616 It's too bad that C macros can't compute this from `fnname'.
2617 `minargs' should be a number, the minimum number of arguments allowed.
2618 `maxargs' should be a number, the maximum number of arguments allowed,
2619 or else MANY or UNEVALLED.
2620 MANY means pass a vector of evaluated arguments,
2621 in the form of an integer number-of-arguments
2622 followed by the address of a vector of Lisp_Objects
2623 which contains the argument values.
2624 UNEVALLED means pass the list of unevaluated arguments
2625 `intspec' says how interactive arguments are to be fetched.
2626 If the string starts with a `(', `intspec' is evaluated and the resulting
2627 list is the list of arguments.
2628 If it's a string that doesn't start with `(', the value should follow
2629 the one of the doc string for `interactive'.
2630 A null string means call interactively with no arguments.
2631 `doc' is documentation for the user. */
2633 /* This version of DEFUN declares a function prototype with the right
2634 arguments, so we can catch errors with maxargs at compile-time. */
2636 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2637 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2638 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2639 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2640 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2641 { (Lisp_Object (__cdecl *)(void))fnname }, \
2642 minargs, maxargs, lname, intspec, 0}; \
2644 #else /* not _MSC_VER */
2645 # if __STDC_VERSION__ < 199901
2646 # define DEFUN_FUNCTION_INIT(fnname, maxargs) (Lisp_Object (*) (void)) fnname
2648 # define DEFUN_FUNCTION_INIT(fnname, maxargs) .a ## maxargs = fnname
2650 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2651 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2652 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2653 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2654 { DEFUN_FUNCTION_INIT (fnname, maxargs) }, \
2655 minargs, maxargs, lname, intspec, 0}; \
2659 /* Note that the weird token-substitution semantics of ANSI C makes
2660 this work for MANY and UNEVALLED. */
2661 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2662 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2663 #define DEFUN_ARGS_0 (void)
2664 #define DEFUN_ARGS_1 (Lisp_Object)
2665 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2666 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2667 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2668 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2670 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2671 Lisp_Object, Lisp_Object)
2672 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2673 Lisp_Object, Lisp_Object, Lisp_Object)
2674 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2675 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2677 /* True if OBJ is a Lisp function. */
2679 FUNCTIONP (Lisp_Object obj
)
2681 return functionp (obj
);
2685 is how we define the symbol for function `name' at start-up time. */
2686 extern void defsubr (struct Lisp_Subr
*);
2694 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2695 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2696 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2697 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2698 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2700 /* Macros we use to define forwarded Lisp variables.
2701 These are used in the syms_of_FILENAME functions.
2703 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2704 lisp variable is actually a field in `struct emacs_globals'. The
2705 field's name begins with "f_", which is a convention enforced by
2706 these macros. Each such global has a corresponding #define in
2707 globals.h; the plain name should be used in the code.
2709 E.g., the global "cons_cells_consed" is declared as "int
2710 f_cons_cells_consed" in globals.h, but there is a define:
2712 #define cons_cells_consed globals.f_cons_cells_consed
2714 All C code uses the `cons_cells_consed' name. This is all done
2715 this way to support indirection for multi-threaded Emacs. */
2717 #define DEFVAR_LISP(lname, vname, doc) \
2719 static struct Lisp_Objfwd o_fwd; \
2720 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2722 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2724 static struct Lisp_Objfwd o_fwd; \
2725 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2727 #define DEFVAR_BOOL(lname, vname, doc) \
2729 static struct Lisp_Boolfwd b_fwd; \
2730 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2732 #define DEFVAR_INT(lname, vname, doc) \
2734 static struct Lisp_Intfwd i_fwd; \
2735 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2738 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2740 static struct Lisp_Objfwd o_fwd; \
2741 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2744 #define DEFVAR_KBOARD(lname, vname, doc) \
2746 static struct Lisp_Kboard_Objfwd ko_fwd; \
2747 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2750 /* Save and restore the instruction and environment pointers,
2751 without affecting the signal mask. */
2754 typedef jmp_buf sys_jmp_buf
;
2755 # define sys_setjmp(j) _setjmp (j)
2756 # define sys_longjmp(j, v) _longjmp (j, v)
2757 #elif defined HAVE_SIGSETJMP
2758 typedef sigjmp_buf sys_jmp_buf
;
2759 # define sys_setjmp(j) sigsetjmp (j, 0)
2760 # define sys_longjmp(j, v) siglongjmp (j, v)
2762 /* A platform that uses neither _longjmp nor siglongjmp; assume
2763 longjmp does not affect the sigmask. */
2764 typedef jmp_buf sys_jmp_buf
;
2765 # define sys_setjmp(j) setjmp (j)
2766 # define sys_longjmp(j, v) longjmp (j, v)
2770 /* Elisp uses several stacks:
2772 - the bytecode stack: used internally by the bytecode interpreter.
2773 Allocated from the C stack.
2774 - The specpdl stack: keeps track of active unwind-protect and
2775 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2777 - The handler stack: keeps track of active catch tags and condition-case
2778 handlers. Allocated in a manually managed stack implemented by a
2779 doubly-linked list allocated via xmalloc and never freed. */
2781 /* Structure for recording Lisp call stack for backtrace purposes. */
2783 /* The special binding stack holds the outer values of variables while
2784 they are bound by a function application or a let form, stores the
2785 code to be executed for unwind-protect forms.
2787 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2788 used all over the place, needs to be fast, and needs to know the size of
2789 union specbinding. But only eval.c should access it. */
2792 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2793 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2794 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2795 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2796 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2797 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2798 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2799 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2800 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2805 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2807 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2808 void (*func
) (Lisp_Object
);
2812 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2813 void (*func
) (void *);
2817 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2822 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2823 void (*func
) (void);
2826 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2827 /* `where' is not used in the case of SPECPDL_LET. */
2828 Lisp_Object symbol
, old_value
, where
;
2831 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2832 bool_bf debug_on_exit
: 1;
2833 Lisp_Object function
;
2839 extern union specbinding
*specpdl
;
2840 extern union specbinding
*specpdl_ptr
;
2841 extern ptrdiff_t specpdl_size
;
2844 SPECPDL_INDEX (void)
2846 return specpdl_ptr
- specpdl
;
2849 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2850 control structures. A struct handler contains all the information needed to
2851 restore the state of the interpreter after a non-local jump.
2853 handler structures are chained together in a doubly linked list; the `next'
2854 member points to the next outer catchtag and the `nextfree' member points in
2855 the other direction to the next inner element (which is typically the next
2856 free element since we mostly use it on the deepest handler).
2858 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2859 member is TAG, and then unbinds to it. The `val' member is used to
2860 hold VAL while the stack is unwound; `val' is returned as the value
2863 All the other members are concerned with restoring the interpreter
2866 Members are volatile if their values need to survive _longjmp when
2867 a 'struct handler' is a local variable. */
2869 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2873 enum handlertype type
;
2874 Lisp_Object tag_or_ch
;
2876 struct handler
*next
;
2877 struct handler
*nextfree
;
2879 /* The bytecode interpreter can have several handlers active at the same
2880 time, so when we longjmp to one of them, it needs to know which handler
2881 this was and what was the corresponding internal state. This is stored
2882 here, and when we longjmp we make sure that handlerlist points to the
2884 Lisp_Object
*bytecode_top
;
2887 /* Most global vars are reset to their value via the specpdl mechanism,
2888 but a few others are handled by storing their value here. */
2889 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
2890 struct gcpro
*gcpro
;
2893 EMACS_INT lisp_eval_depth
;
2895 int poll_suppress_count
;
2896 int interrupt_input_blocked
;
2897 struct byte_stack
*byte_stack
;
2900 /* Fill in the components of c, and put it on the list. */
2901 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2902 if (handlerlist->nextfree) \
2903 (c) = handlerlist->nextfree; \
2906 (c) = xmalloc (sizeof (struct handler)); \
2907 (c)->nextfree = NULL; \
2908 handlerlist->nextfree = (c); \
2910 (c)->type = (handlertype); \
2911 (c)->tag_or_ch = (tag_ch_val); \
2913 (c)->next = handlerlist; \
2914 (c)->lisp_eval_depth = lisp_eval_depth; \
2915 (c)->pdlcount = SPECPDL_INDEX (); \
2916 (c)->poll_suppress_count = poll_suppress_count; \
2917 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2918 (c)->gcpro = gcprolist; \
2919 (c)->byte_stack = byte_stack_list; \
2923 extern Lisp_Object memory_signal_data
;
2925 /* An address near the bottom of the stack.
2926 Tells GC how to save a copy of the stack. */
2927 extern char *stack_bottom
;
2929 /* Check quit-flag and quit if it is non-nil.
2930 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2931 So the program needs to do QUIT at times when it is safe to quit.
2932 Every loop that might run for a long time or might not exit
2933 ought to do QUIT at least once, at a safe place.
2934 Unless that is impossible, of course.
2935 But it is very desirable to avoid creating loops where QUIT is impossible.
2937 Exception: if you set immediate_quit to true,
2938 then the handler that responds to the C-g does the quit itself.
2939 This is a good thing to do around a loop that has no side effects
2940 and (in particular) cannot call arbitrary Lisp code.
2942 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2943 a request to exit Emacs when it is safe to do. */
2945 extern void process_pending_signals (void);
2946 extern bool volatile pending_signals
;
2948 extern void process_quit_flag (void);
2951 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2952 process_quit_flag (); \
2953 else if (pending_signals) \
2954 process_pending_signals (); \
2958 /* True if ought to quit now. */
2960 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2962 extern Lisp_Object Vascii_downcase_table
;
2963 extern Lisp_Object Vascii_canon_table
;
2965 /* Structure for recording stack slots that need marking. */
2967 /* This is a chain of structures, each of which points at a Lisp_Object
2968 variable whose value should be marked in garbage collection.
2969 Normally every link of the chain is an automatic variable of a function,
2970 and its `val' points to some argument or local variable of the function.
2971 On exit to the function, the chain is set back to the value it had on entry.
2972 This way, no link remains in the chain when the stack frame containing the
2975 Every function that can call Feval must protect in this fashion all
2976 Lisp_Object variables whose contents will be used again. */
2978 extern struct gcpro
*gcprolist
;
2984 /* Address of first protected variable. */
2985 volatile Lisp_Object
*var
;
2987 /* Number of consecutive protected variables. */
2995 /* Values of GC_MARK_STACK during compilation:
2997 0 Use GCPRO as before
2998 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2999 2 Mark the stack, and check that everything GCPRO'd is
3001 3 Mark using GCPRO's, mark stack last, and count how many
3002 dead objects are kept alive.
3004 Formerly, method 0 was used. Currently, method 1 is used unless
3005 otherwise specified by hand when building, e.g.,
3006 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
3007 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
3009 #define GC_USE_GCPROS_AS_BEFORE 0
3010 #define GC_MAKE_GCPROS_NOOPS 1
3011 #define GC_MARK_STACK_CHECK_GCPROS 2
3012 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
3014 #ifndef GC_MARK_STACK
3015 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
3018 /* Whether we do the stack marking manually. */
3019 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
3020 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
3023 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
3025 /* Do something silly with gcproN vars just so gcc shuts up. */
3026 /* You get warnings from MIPSPro... */
3028 #define GCPRO1(varname) ((void) gcpro1)
3029 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
3030 #define GCPRO3(varname1, varname2, varname3) \
3031 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
3032 #define GCPRO4(varname1, varname2, varname3, varname4) \
3033 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3034 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3035 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3036 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3037 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
3039 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
3040 #define UNGCPRO ((void) 0)
3042 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3046 #define GCPRO1(varname) \
3047 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3048 gcprolist = &gcpro1; }
3050 #define GCPRO2(varname1, varname2) \
3051 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3052 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3053 gcprolist = &gcpro2; }
3055 #define GCPRO3(varname1, varname2, varname3) \
3056 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3057 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3058 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3059 gcprolist = &gcpro3; }
3061 #define GCPRO4(varname1, varname2, varname3, varname4) \
3062 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3063 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3064 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3065 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3066 gcprolist = &gcpro4; }
3068 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
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 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3074 gcprolist = &gcpro5; }
3076 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3077 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3078 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3079 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3080 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3081 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3082 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3083 gcprolist = &gcpro6; }
3085 #define GCPRO7(a, b, c, d, e, f, g) \
3086 {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3087 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3088 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3089 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3090 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3091 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3092 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3093 gcprolist = &gcpro7; }
3095 #define UNGCPRO (gcprolist = gcpro1.next)
3099 extern int gcpro_level
;
3101 #define GCPRO1(varname) \
3102 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3103 gcpro1.level = gcpro_level++; \
3104 gcprolist = &gcpro1; }
3106 #define GCPRO2(varname1, varname2) \
3107 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3108 gcpro1.level = gcpro_level; \
3109 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3110 gcpro2.level = gcpro_level++; \
3111 gcprolist = &gcpro2; }
3113 #define GCPRO3(varname1, varname2, varname3) \
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 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3118 gcpro3.level = gcpro_level++; \
3119 gcprolist = &gcpro3; }
3121 #define GCPRO4(varname1, varname2, varname3, varname4) \
3122 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3123 gcpro1.level = gcpro_level; \
3124 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3125 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3126 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3127 gcpro4.level = gcpro_level++; \
3128 gcprolist = &gcpro4; }
3130 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3131 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3132 gcpro1.level = gcpro_level; \
3133 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3134 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3135 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3136 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3137 gcpro5.level = gcpro_level++; \
3138 gcprolist = &gcpro5; }
3140 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3141 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3142 gcpro1.level = gcpro_level; \
3143 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3144 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3145 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3146 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3147 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3148 gcpro6.level = gcpro_level++; \
3149 gcprolist = &gcpro6; }
3151 #define GCPRO7(a, b, c, d, e, f, g) \
3152 {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3153 gcpro1.level = gcpro_level; \
3154 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3155 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3156 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3157 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3158 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3159 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3160 gcpro7.level = gcpro_level++; \
3161 gcprolist = &gcpro7; }
3164 (--gcpro_level != gcpro1.level \
3166 : (void) (gcprolist = gcpro1.next))
3168 #endif /* DEBUG_GCPRO */
3169 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3172 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
3173 #define RETURN_UNGCPRO(expr) \
3176 Lisp_Object ret_ungc_val; \
3177 ret_ungc_val = (expr); \
3179 return ret_ungc_val; \
3183 /* Call staticpro (&var) to protect static variable `var'. */
3185 void staticpro (Lisp_Object
*);
3187 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
3188 meaning as in the DEFUN macro, and is used to construct a prototype. */
3189 /* We can use the same trick as in the DEFUN macro to generate the
3190 appropriate prototype. */
3191 #define EXFUN(fnname, maxargs) \
3192 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
3194 #include "globals.h"
3196 /* Forward declarations for prototypes. */
3200 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3203 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3205 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3206 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3209 /* Functions to modify hash tables. */
3212 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3214 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3218 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3220 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3223 /* Use these functions to set Lisp_Object
3224 or pointer slots of struct Lisp_Symbol. */
3227 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3229 XSYMBOL (sym
)->function
= function
;
3233 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3235 XSYMBOL (sym
)->plist
= plist
;
3239 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3241 XSYMBOL (sym
)->next
= next
;
3244 /* Buffer-local (also frame-local) variable access functions. */
3247 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3249 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3253 /* Set overlay's property list. */
3256 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3258 XOVERLAY (overlay
)->plist
= plist
;
3261 /* Get text properties of S. */
3264 string_intervals (Lisp_Object s
)
3266 return XSTRING (s
)->intervals
;
3269 /* Set text properties of S to I. */
3272 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3274 XSTRING (s
)->intervals
= i
;
3277 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3278 of setting slots directly. */
3281 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3283 XCHAR_TABLE (table
)->defalt
= val
;
3286 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3288 XCHAR_TABLE (table
)->purpose
= val
;
3291 /* Set different slots in (sub)character tables. */
3294 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3296 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3297 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3301 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3303 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3304 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3308 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3310 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3313 /* Defined in data.c. */
3314 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
3315 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3316 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3317 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3318 extern Lisp_Object Qinvalid_read_syntax
;
3319 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3320 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3321 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3322 extern Lisp_Object Qtext_read_only
;
3323 extern Lisp_Object Qinteractive_form
;
3324 extern Lisp_Object Qcircular_list
;
3325 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
3326 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
3327 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
3328 extern Lisp_Object Qbuffer_or_string_p
;
3329 extern Lisp_Object Qfboundp
;
3330 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
3332 extern Lisp_Object Qcdr
;
3334 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3336 extern Lisp_Object Qfloatp
;
3337 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
3339 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3341 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
3343 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
3345 /* Defined in data.c. */
3346 extern Lisp_Object
indirect_function (Lisp_Object
);
3347 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3348 enum Arith_Comparison
{
3353 ARITH_LESS_OR_EQUAL
,
3356 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3357 enum Arith_Comparison comparison
);
3359 /* Convert the integer I to an Emacs representation, either the integer
3360 itself, or a cons of two or three integers, or if all else fails a float.
3361 I should not have side effects. */
3362 #define INTEGER_TO_CONS(i) \
3363 (! FIXNUM_OVERFLOW_P (i) \
3365 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3366 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3367 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3368 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3369 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3370 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3371 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3372 ? Fcons (make_number ((i) >> 16 >> 24), \
3373 Fcons (make_number ((i) >> 16 & 0xffffff), \
3374 make_number ((i) & 0xffff))) \
3377 /* Convert the Emacs representation CONS back to an integer of type
3378 TYPE, storing the result the variable VAR. Signal an error if CONS
3379 is not a valid representation or is out of range for TYPE. */
3380 #define CONS_TO_INTEGER(cons, type, var) \
3381 (TYPE_SIGNED (type) \
3382 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3383 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3384 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3385 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3387 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3388 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3389 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3391 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
3392 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3393 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3394 extern void syms_of_data (void);
3395 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3397 /* Defined in cmds.c */
3398 extern void syms_of_cmds (void);
3399 extern void keys_of_cmds (void);
3401 /* Defined in coding.c. */
3402 extern Lisp_Object Qcharset
;
3403 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3404 ptrdiff_t, bool, bool, Lisp_Object
);
3405 extern void init_coding (void);
3406 extern void init_coding_once (void);
3407 extern void syms_of_coding (void);
3409 /* Defined in character.c. */
3410 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
3411 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3412 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3413 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
3414 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
3415 extern void syms_of_character (void);
3417 /* Defined in charset.c. */
3418 extern void init_charset (void);
3419 extern void init_charset_once (void);
3420 extern void syms_of_charset (void);
3421 /* Structure forward declarations. */
3424 /* Defined in composite.c. */
3425 extern void syms_of_composite (void);
3427 /* Defined in syntax.c. */
3428 extern void init_syntax_once (void);
3429 extern void syms_of_syntax (void);
3431 /* Defined in fns.c. */
3432 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3433 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3434 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
3435 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3436 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3437 extern void sweep_weak_hash_tables (void);
3438 extern Lisp_Object Qcursor_in_echo_area
;
3439 extern Lisp_Object Qstring_lessp
;
3440 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3441 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3442 EMACS_UINT
sxhash (Lisp_Object
, int);
3443 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3444 Lisp_Object
, Lisp_Object
);
3445 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3446 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3448 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3450 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3451 ptrdiff_t, ptrdiff_t);
3452 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3453 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3454 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3455 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3456 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3457 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3458 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3459 extern void clear_string_char_byte_cache (void);
3460 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3461 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3462 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3463 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3464 extern void syms_of_fns (void);
3466 /* Defined in floatfns.c. */
3467 extern double extract_float (Lisp_Object
);
3468 extern void syms_of_floatfns (void);
3469 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3471 /* Defined in fringe.c. */
3472 extern void syms_of_fringe (void);
3473 extern void init_fringe (void);
3474 #ifdef HAVE_WINDOW_SYSTEM
3475 extern void mark_fringe_data (void);
3476 extern void init_fringe_once (void);
3477 #endif /* HAVE_WINDOW_SYSTEM */
3479 /* Defined in image.c. */
3480 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3481 extern Lisp_Object QCconversion
;
3482 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3483 extern void reset_image_types (void);
3484 extern void syms_of_image (void);
3486 /* Defined in insdel.c. */
3487 extern Lisp_Object Qinhibit_modification_hooks
;
3488 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3489 extern _Noreturn
void buffer_overflow (void);
3490 extern void make_gap (ptrdiff_t);
3491 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3492 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3493 ptrdiff_t, bool, bool);
3494 extern int count_combining_before (const unsigned char *,
3495 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3496 extern int count_combining_after (const unsigned char *,
3497 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3498 extern void insert (const char *, ptrdiff_t);
3499 extern void insert_and_inherit (const char *, ptrdiff_t);
3500 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3502 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3503 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3504 ptrdiff_t, ptrdiff_t, bool);
3505 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3506 extern void insert_char (int);
3507 extern void insert_string (const char *);
3508 extern void insert_before_markers (const char *, ptrdiff_t);
3509 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3510 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3511 ptrdiff_t, ptrdiff_t,
3513 extern void del_range (ptrdiff_t, ptrdiff_t);
3514 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3515 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3516 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3517 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3518 ptrdiff_t, ptrdiff_t, bool);
3519 extern void modify_text (ptrdiff_t, ptrdiff_t);
3520 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3521 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3522 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3523 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3524 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3525 ptrdiff_t, ptrdiff_t);
3526 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3527 ptrdiff_t, ptrdiff_t);
3528 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3529 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3530 const char *, ptrdiff_t, ptrdiff_t, bool);
3531 extern void syms_of_insdel (void);
3533 /* Defined in dispnew.c. */
3534 #if (defined PROFILING \
3535 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3536 _Noreturn
void __executable_start (void);
3538 extern Lisp_Object Vwindow_system
;
3539 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3540 extern void init_display (void);
3541 extern void syms_of_display (void);
3543 /* Defined in xdisp.c. */
3544 extern Lisp_Object Qinhibit_point_motion_hooks
;
3545 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
3546 extern Lisp_Object Qmenu_bar_update_hook
;
3547 extern Lisp_Object Qwindow_scroll_functions
;
3548 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3549 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3550 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3551 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
3552 extern Lisp_Object Qleft_margin
, Qright_margin
;
3553 extern Lisp_Object QCdata
, QCfile
;
3554 extern Lisp_Object QCmap
;
3555 extern Lisp_Object Qrisky_local_variable
;
3556 extern bool noninteractive_need_newline
;
3557 extern Lisp_Object echo_area_buffer
[2];
3558 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3559 extern void check_message_stack (void);
3560 extern void setup_echo_area_for_printing (int);
3561 extern bool push_message (void);
3562 extern void pop_message_unwind (void);
3563 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3564 extern void restore_message (void);
3565 extern Lisp_Object
current_message (void);
3566 extern void clear_message (bool, bool);
3567 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3568 extern void message1 (const char *);
3569 extern void message1_nolog (const char *);
3570 extern void message3 (Lisp_Object
);
3571 extern void message3_nolog (Lisp_Object
);
3572 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3573 extern void message_with_string (const char *, Lisp_Object
, int);
3574 extern void message_log_maybe_newline (void);
3575 extern void update_echo_area (void);
3576 extern void truncate_echo_area (ptrdiff_t);
3577 extern void redisplay (void);
3578 extern void redisplay_preserve_echo_area (int);
3580 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3581 extern void syms_of_xdisp (void);
3582 extern void init_xdisp (void);
3583 extern Lisp_Object
safe_eval (Lisp_Object
);
3584 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3585 int *, int *, int *, int *, int *);
3587 /* Defined in xsettings.c. */
3588 extern void syms_of_xsettings (void);
3590 /* Defined in vm-limit.c. */
3591 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3593 /* Defined in alloc.c. */
3594 extern void check_pure_size (void);
3595 extern void free_misc (Lisp_Object
);
3596 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3597 extern void malloc_warning (const char *);
3598 extern _Noreturn
void memory_full (size_t);
3599 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3600 extern bool survives_gc_p (Lisp_Object
);
3601 extern void mark_object (Lisp_Object
);
3602 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3603 extern void refill_memory_reserve (void);
3605 extern const char *pending_malloc_warning
;
3606 extern Lisp_Object zero_vector
;
3607 extern Lisp_Object
*stack_base
;
3608 extern EMACS_INT consing_since_gc
;
3609 extern EMACS_INT gc_relative_threshold
;
3610 extern EMACS_INT memory_full_cons_threshold
;
3611 extern Lisp_Object
list1 (Lisp_Object
);
3612 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3613 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3614 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3615 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3617 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3618 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3620 /* Build a frequently used 2/3/4-integer lists. */
3623 list2i (EMACS_INT x
, EMACS_INT y
)
3625 return list2 (make_number (x
), make_number (y
));
3629 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3631 return list3 (make_number (x
), make_number (y
), make_number (w
));
3635 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3637 return list4 (make_number (x
), make_number (y
),
3638 make_number (w
), make_number (h
));
3641 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3642 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3643 extern _Noreturn
void string_overflow (void);
3644 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3645 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3646 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3647 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3649 /* Make unibyte string from C string when the length isn't known. */
3652 build_unibyte_string (const char *str
)
3654 return make_unibyte_string (str
, strlen (str
));
3657 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3658 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3659 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3660 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3661 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3662 extern Lisp_Object
make_specified_string (const char *,
3663 ptrdiff_t, ptrdiff_t, bool);
3664 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3665 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3667 /* Make a string allocated in pure space, use STR as string data. */
3670 build_pure_c_string (const char *str
)
3672 return make_pure_c_string (str
, strlen (str
));
3675 /* Make a string from the data at STR, treating it as multibyte if the
3679 build_string (const char *str
)
3681 return make_string (str
, strlen (str
));
3684 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3685 extern void make_byte_code (struct Lisp_Vector
*);
3686 extern Lisp_Object Qautomatic_gc
;
3687 extern Lisp_Object Qchar_table_extra_slots
;
3688 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3690 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3691 be sure that GC cannot happen until the vector is completely
3692 initialized. E.g. the following code is likely to crash:
3694 v = make_uninit_vector (3);
3696 ASET (v, 1, Ffunction_can_gc ());
3697 ASET (v, 2, obj1); */
3700 make_uninit_vector (ptrdiff_t size
)
3703 struct Lisp_Vector
*p
;
3705 p
= allocate_vector (size
);
3710 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3711 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3713 allocate_pseudovector \
3714 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3715 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3716 extern struct window
*allocate_window (void);
3717 extern struct frame
*allocate_frame (void);
3718 extern struct Lisp_Process
*allocate_process (void);
3719 extern struct terminal
*allocate_terminal (void);
3720 extern bool gc_in_progress
;
3721 extern bool abort_on_gc
;
3722 extern Lisp_Object
make_float (double);
3723 extern void display_malloc_warning (void);
3724 extern ptrdiff_t inhibit_garbage_collection (void);
3725 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3726 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3727 Lisp_Object
, Lisp_Object
);
3728 extern Lisp_Object
make_save_ptr (void *);
3729 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3730 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3731 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3733 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3734 extern void free_save_value (Lisp_Object
);
3735 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3736 extern void free_marker (Lisp_Object
);
3737 extern void free_cons (struct Lisp_Cons
*);
3738 extern void init_alloc_once (void);
3739 extern void init_alloc (void);
3740 extern void syms_of_alloc (void);
3741 extern struct buffer
* allocate_buffer (void);
3742 extern int valid_lisp_object_p (Lisp_Object
);
3743 #ifdef GC_CHECK_CONS_LIST
3744 extern void check_cons_list (void);
3746 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3750 /* Defined in ralloc.c. */
3751 extern void *r_alloc (void **, size_t);
3752 extern void r_alloc_free (void **);
3753 extern void *r_re_alloc (void **, size_t);
3754 extern void r_alloc_reset_variable (void **, void **);
3755 extern void r_alloc_inhibit_buffer_relocation (int);
3758 /* Defined in chartab.c. */
3759 extern Lisp_Object
copy_char_table (Lisp_Object
);
3760 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
3761 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3763 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3764 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3765 extern int char_table_translate (Lisp_Object
, int);
3766 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3768 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3769 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3770 Lisp_Object
, Lisp_Object
,
3771 Lisp_Object
, struct charset
*,
3772 unsigned, unsigned);
3773 extern Lisp_Object
uniprop_table (Lisp_Object
);
3774 extern void syms_of_chartab (void);
3776 /* Defined in print.c. */
3777 extern Lisp_Object Vprin1_to_string_buffer
;
3778 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3779 extern Lisp_Object Qstandard_output
;
3780 extern Lisp_Object Qexternal_debugging_output
;
3781 extern void temp_output_buffer_setup (const char *);
3782 extern int print_level
;
3783 extern Lisp_Object Qprint_escape_newlines
;
3784 extern void write_string (const char *, int);
3785 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3787 extern Lisp_Object internal_with_output_to_temp_buffer
3788 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3789 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3790 extern int float_to_string (char *, double);
3791 extern void init_print_once (void);
3792 extern void syms_of_print (void);
3794 /* Defined in doprnt.c. */
3795 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3797 extern ptrdiff_t esprintf (char *, char const *, ...)
3798 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3799 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3801 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3802 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3803 char const *, va_list)
3804 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3806 /* Defined in lread.c. */
3807 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3808 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3809 extern Lisp_Object Qlexical_binding
;
3810 extern Lisp_Object
check_obarray (Lisp_Object
);
3811 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3812 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3813 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3815 LOADHIST_ATTACH (Lisp_Object x
)
3818 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3820 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3821 Lisp_Object
*, Lisp_Object
, bool);
3822 extern Lisp_Object
string_to_number (char const *, int, bool);
3823 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3825 extern void dir_warning (const char *, Lisp_Object
);
3826 extern void init_obarray (void);
3827 extern void init_lread (void);
3828 extern void syms_of_lread (void);
3831 intern (const char *str
)
3833 return intern_1 (str
, strlen (str
));
3837 intern_c_string (const char *str
)
3839 return intern_c_string_1 (str
, strlen (str
));
3842 /* Defined in eval.c. */
3843 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3844 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3845 extern Lisp_Object Qand_rest
;
3846 extern Lisp_Object Vautoload_queue
;
3847 extern Lisp_Object Vsignaling_function
;
3848 extern Lisp_Object inhibit_lisp_code
;
3849 extern struct handler
*handlerlist
;
3851 /* To run a normal hook, use the appropriate function from the list below.
3852 The calling convention:
3854 if (!NILP (Vrun_hooks))
3855 call1 (Vrun_hooks, Qmy_funny_hook);
3857 should no longer be used. */
3858 extern Lisp_Object Vrun_hooks
;
3859 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3860 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3861 Lisp_Object (*funcall
)
3862 (ptrdiff_t nargs
, Lisp_Object
*args
));
3863 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3864 extern _Noreturn
void xsignal0 (Lisp_Object
);
3865 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3866 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3867 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3869 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3870 extern Lisp_Object
eval_sub (Lisp_Object form
);
3871 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3872 extern Lisp_Object
call0 (Lisp_Object
);
3873 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3874 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3875 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3876 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3877 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3878 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3879 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3880 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3881 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3882 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3883 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3884 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3885 extern Lisp_Object internal_condition_case_n
3886 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3887 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3888 extern void specbind (Lisp_Object
, Lisp_Object
);
3889 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3890 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3891 extern void record_unwind_protect_int (void (*) (int), int);
3892 extern void record_unwind_protect_void (void (*) (void));
3893 extern void record_unwind_protect_nothing (void);
3894 extern void clear_unwind_protect (ptrdiff_t);
3895 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3896 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3897 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3898 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3899 extern _Noreturn
void verror (const char *, va_list)
3900 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3901 extern void un_autoload (Lisp_Object
);
3902 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3903 extern void init_eval_once (void);
3904 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3905 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3906 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3907 extern void init_eval (void);
3908 extern void syms_of_eval (void);
3909 extern void unwind_body (Lisp_Object
);
3910 extern void record_in_backtrace (Lisp_Object function
,
3911 Lisp_Object
*args
, ptrdiff_t nargs
);
3912 extern void mark_specpdl (void);
3913 extern void get_backtrace (Lisp_Object array
);
3914 Lisp_Object
backtrace_top_function (void);
3915 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3916 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3919 /* Defined in editfns.c. */
3920 extern Lisp_Object Qfield
;
3921 extern void insert1 (Lisp_Object
);
3922 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3923 extern Lisp_Object
save_excursion_save (void);
3924 extern Lisp_Object
save_restriction_save (void);
3925 extern void save_excursion_restore (Lisp_Object
);
3926 extern void save_restriction_restore (Lisp_Object
);
3927 extern _Noreturn
void time_overflow (void);
3928 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3929 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3931 extern void init_editfns (void);
3932 extern void syms_of_editfns (void);
3933 extern void set_time_zone_rule (const char *);
3935 /* Defined in buffer.c. */
3936 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3937 extern _Noreturn
void nsberror (Lisp_Object
);
3938 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3939 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3940 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3941 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3942 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3943 extern bool overlay_touches_p (ptrdiff_t);
3944 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3945 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3946 extern void init_buffer_once (void);
3947 extern void init_buffer (void);
3948 extern void syms_of_buffer (void);
3949 extern void keys_of_buffer (void);
3951 /* Defined in marker.c. */
3953 extern ptrdiff_t marker_position (Lisp_Object
);
3954 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3955 extern void clear_charpos_cache (struct buffer
*);
3956 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3957 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3958 extern void unchain_marker (struct Lisp_Marker
*marker
);
3959 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3960 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3961 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3962 ptrdiff_t, ptrdiff_t);
3963 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3964 extern void syms_of_marker (void);
3966 /* Defined in fileio.c. */
3968 extern Lisp_Object Qfile_error
;
3969 extern Lisp_Object Qfile_notify_error
;
3970 extern Lisp_Object Qfile_exists_p
;
3971 extern Lisp_Object Qfile_directory_p
;
3972 extern Lisp_Object Qinsert_file_contents
;
3973 extern Lisp_Object Qfile_name_history
;
3974 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3975 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3976 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3978 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3979 extern void close_file_unwind (int);
3980 extern void fclose_unwind (void *);
3981 extern void restore_point_unwind (Lisp_Object
);
3982 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3983 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3984 extern bool internal_delete_file (Lisp_Object
);
3985 extern Lisp_Object
emacs_readlinkat (int, const char *);
3986 extern bool file_directory_p (const char *);
3987 extern bool file_accessible_directory_p (const char *);
3988 extern void init_fileio (void);
3989 extern void syms_of_fileio (void);
3990 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3991 extern Lisp_Object Qdelete_file
;
3993 /* Defined in search.c. */
3994 extern void shrink_regexp_cache (void);
3995 extern void restore_search_regs (void);
3996 extern void record_unwind_save_match_data (void);
3997 struct re_registers
;
3998 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3999 struct re_registers
*,
4000 Lisp_Object
, bool, bool);
4001 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
4002 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4004 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
4005 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4006 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4007 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4008 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4009 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4011 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4012 ptrdiff_t, ptrdiff_t *);
4013 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4014 ptrdiff_t, ptrdiff_t *);
4015 extern void syms_of_search (void);
4016 extern void clear_regexp_cache (void);
4018 /* Defined in minibuf.c. */
4020 extern Lisp_Object Qcompletion_ignore_case
;
4021 extern Lisp_Object Vminibuffer_list
;
4022 extern Lisp_Object last_minibuf_string
;
4023 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4024 extern void init_minibuf_once (void);
4025 extern void syms_of_minibuf (void);
4027 /* Defined in callint.c. */
4029 extern Lisp_Object Qminus
, Qplus
;
4030 extern Lisp_Object Qwhen
;
4031 extern Lisp_Object Qmouse_leave_buffer_hook
;
4032 extern void syms_of_callint (void);
4034 /* Defined in casefiddle.c. */
4036 extern Lisp_Object Qidentity
;
4037 extern void syms_of_casefiddle (void);
4038 extern void keys_of_casefiddle (void);
4040 /* Defined in casetab.c. */
4042 extern void init_casetab_once (void);
4043 extern void syms_of_casetab (void);
4045 /* Defined in keyboard.c. */
4047 extern Lisp_Object echo_message_buffer
;
4048 extern struct kboard
*echo_kboard
;
4049 extern void cancel_echoing (void);
4050 extern Lisp_Object Qdisabled
, QCfilter
;
4051 extern Lisp_Object Qup
, Qdown
, Qbottom
;
4052 extern Lisp_Object Qtop
;
4053 extern Lisp_Object last_undo_boundary
;
4054 extern bool input_pending
;
4055 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4056 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4057 extern void discard_mouse_events (void);
4059 void handle_input_available_signal (int);
4061 extern Lisp_Object pending_funcalls
;
4062 extern bool detect_input_pending (void);
4063 extern bool detect_input_pending_ignore_squeezables (void);
4064 extern bool detect_input_pending_run_timers (bool);
4065 extern void safe_run_hooks (Lisp_Object
);
4066 extern void cmd_error_internal (Lisp_Object
, const char *);
4067 extern Lisp_Object
command_loop_1 (void);
4068 extern Lisp_Object
read_menu_command (void);
4069 extern Lisp_Object
recursive_edit_1 (void);
4070 extern void record_auto_save (void);
4071 extern void force_auto_save_soon (void);
4072 extern void init_keyboard (void);
4073 extern void syms_of_keyboard (void);
4074 extern void keys_of_keyboard (void);
4076 /* Defined in indent.c. */
4077 extern ptrdiff_t current_column (void);
4078 extern void invalidate_current_column (void);
4079 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4080 extern void syms_of_indent (void);
4082 /* Defined in frame.c. */
4083 extern Lisp_Object Qonly
, Qnone
;
4084 extern Lisp_Object Qvisible
;
4085 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4086 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4087 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4088 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4089 #if HAVE_NS || HAVE_NTGUI
4090 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4092 extern void frames_discard_buffer (Lisp_Object
);
4093 extern void syms_of_frame (void);
4095 /* Defined in emacs.c. */
4096 extern char **initial_argv
;
4097 extern int initial_argc
;
4098 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4099 extern bool display_arg
;
4101 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4102 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4103 extern Lisp_Object Qfile_name_handler_alist
;
4104 extern _Noreturn
void terminate_due_to_signal (int, int);
4105 extern Lisp_Object Qkill_emacs
;
4107 extern Lisp_Object Vlibrary_cache
;
4110 void fixup_locale (void);
4111 void synchronize_system_messages_locale (void);
4112 void synchronize_system_time_locale (void);
4114 INLINE
void fixup_locale (void) {}
4115 INLINE
void synchronize_system_messages_locale (void) {}
4116 INLINE
void synchronize_system_time_locale (void) {}
4118 extern void shut_down_emacs (int, Lisp_Object
);
4120 /* True means don't do interactive redisplay and don't change tty modes. */
4121 extern bool noninteractive
;
4123 /* True means remove site-lisp directories from load-path. */
4124 extern bool no_site_lisp
;
4126 /* Pipe used to send exit notification to the daemon parent at
4128 extern int daemon_pipe
[2];
4129 #define IS_DAEMON (daemon_pipe[1] != 0)
4131 /* True if handling a fatal error already. */
4132 extern bool fatal_error_in_progress
;
4134 /* True means don't do use window-system-specific display code. */
4135 extern bool inhibit_window_system
;
4136 /* True means that a filter or a sentinel is running. */
4137 extern bool running_asynch_code
;
4139 /* Defined in process.c. */
4140 extern Lisp_Object QCtype
, Qlocal
;
4141 extern void kill_buffer_processes (Lisp_Object
);
4142 extern bool wait_reading_process_output (intmax_t, int, int, bool,
4144 struct Lisp_Process
*,
4146 /* Max value for the first argument of wait_reading_process_output. */
4147 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4148 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4149 The bug merely causes a bogus warning, but the warning is annoying. */
4150 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4152 # define WAIT_READING_MAX INTMAX_MAX
4154 extern void add_keyboard_wait_descriptor (int);
4155 extern void delete_keyboard_wait_descriptor (int);
4157 extern void add_gpm_wait_descriptor (int);
4158 extern void delete_gpm_wait_descriptor (int);
4160 extern void init_process_emacs (void);
4161 extern void syms_of_process (void);
4162 extern void setup_process_coding_systems (Lisp_Object
);
4164 /* Defined in callproc.c. */
4168 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4169 extern void init_callproc_1 (void);
4170 extern void init_callproc (void);
4171 extern void set_initial_environment (void);
4172 extern void syms_of_callproc (void);
4174 /* Defined in doc.c. */
4175 extern Lisp_Object Qfunction_documentation
;
4176 extern Lisp_Object
read_doc_string (Lisp_Object
);
4177 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4178 extern void syms_of_doc (void);
4179 extern int read_bytecode_char (bool);
4181 /* Defined in bytecode.c. */
4182 extern void syms_of_bytecode (void);
4183 extern struct byte_stack
*byte_stack_list
;
4185 extern void mark_byte_stack (void);
4187 extern void unmark_byte_stack (void);
4188 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4189 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4191 /* Defined in macros.c. */
4192 extern void init_macros (void);
4193 extern void syms_of_macros (void);
4195 /* Defined in undo.c. */
4196 extern Lisp_Object Qapply
;
4197 extern Lisp_Object Qinhibit_read_only
;
4198 extern void truncate_undo_list (struct buffer
*);
4199 extern void record_insert (ptrdiff_t, ptrdiff_t);
4200 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4201 extern void record_first_change (void);
4202 extern void record_change (ptrdiff_t, ptrdiff_t);
4203 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4204 Lisp_Object
, Lisp_Object
,
4206 extern void syms_of_undo (void);
4207 /* Defined in textprop.c. */
4208 extern Lisp_Object Qfont
, Qmouse_face
;
4209 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
4210 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
4211 extern Lisp_Object Qminibuffer_prompt
;
4213 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4215 /* Defined in menu.c. */
4216 extern void syms_of_menu (void);
4218 /* Defined in xmenu.c. */
4219 extern void syms_of_xmenu (void);
4221 /* Defined in termchar.h. */
4222 struct tty_display_info
;
4224 /* Defined in termhooks.h. */
4227 /* Defined in sysdep.c. */
4228 #ifndef HAVE_GET_CURRENT_DIR_NAME
4229 extern char *get_current_dir_name (void);
4231 extern void stuff_char (char c
);
4232 extern void init_foreground_group (void);
4233 extern void init_sigio (int);
4234 extern void sys_subshell (void);
4235 extern void sys_suspend (void);
4236 extern void discard_tty_input (void);
4237 extern void init_sys_modes (struct tty_display_info
*);
4238 extern void reset_sys_modes (struct tty_display_info
*);
4239 extern void init_all_sys_modes (void);
4240 extern void reset_all_sys_modes (void);
4241 extern void child_setup_tty (int);
4242 extern void setup_pty (int);
4243 extern int set_window_size (int, int, int);
4244 extern EMACS_INT
get_random (void);
4245 extern void seed_random (void *, ptrdiff_t);
4246 extern void init_random (void);
4247 extern void emacs_backtrace (int);
4248 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4249 extern int emacs_open (const char *, int, int);
4250 extern int emacs_pipe (int[2]);
4251 extern int emacs_close (int);
4252 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4253 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4254 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4255 extern void emacs_perror (char const *);
4257 extern void unlock_all_files (void);
4258 extern void lock_file (Lisp_Object
);
4259 extern void unlock_file (Lisp_Object
);
4260 extern void unlock_buffer (struct buffer
*);
4261 extern void syms_of_filelock (void);
4263 /* Defined in sound.c. */
4264 extern void syms_of_sound (void);
4266 /* Defined in category.c. */
4267 extern void init_category_once (void);
4268 extern Lisp_Object
char_category_set (int);
4269 extern void syms_of_category (void);
4271 /* Defined in ccl.c. */
4272 extern void syms_of_ccl (void);
4274 /* Defined in dired.c. */
4275 extern void syms_of_dired (void);
4276 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4277 Lisp_Object
, Lisp_Object
,
4280 /* Defined in term.c. */
4281 extern int *char_ins_del_vector
;
4282 extern void syms_of_term (void);
4283 extern _Noreturn
void fatal (const char *msgid
, ...)
4284 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4286 /* Defined in terminal.c. */
4287 extern void syms_of_terminal (void);
4289 /* Defined in font.c. */
4290 extern void syms_of_font (void);
4291 extern void init_font (void);
4293 #ifdef HAVE_WINDOW_SYSTEM
4294 /* Defined in fontset.c. */
4295 extern void syms_of_fontset (void);
4297 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4298 extern Lisp_Object Qfont_param
;
4301 /* Defined in gfilenotify.c */
4302 #ifdef HAVE_GFILENOTIFY
4303 extern void globals_of_gfilenotify (void);
4304 extern void syms_of_gfilenotify (void);
4307 /* Defined in inotify.c */
4309 extern void syms_of_inotify (void);
4312 #ifdef HAVE_W32NOTIFY
4313 /* Defined on w32notify.c. */
4314 extern void syms_of_w32notify (void);
4317 /* Defined in xfaces.c. */
4318 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
4319 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
4320 extern Lisp_Object Qmode_line_inactive
;
4321 extern Lisp_Object Qface
;
4322 extern Lisp_Object Qnormal
;
4323 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4324 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4325 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4326 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4327 extern Lisp_Object Qoblique
, Qitalic
;
4328 extern Lisp_Object Vface_alternative_font_family_alist
;
4329 extern Lisp_Object Vface_alternative_font_registry_alist
;
4330 extern void syms_of_xfaces (void);
4332 #ifdef HAVE_X_WINDOWS
4333 /* Defined in xfns.c. */
4334 extern void syms_of_xfns (void);
4336 /* Defined in xsmfns.c. */
4337 extern void syms_of_xsmfns (void);
4339 /* Defined in xselect.c. */
4340 extern void syms_of_xselect (void);
4342 /* Defined in xterm.c. */
4343 extern void syms_of_xterm (void);
4344 #endif /* HAVE_X_WINDOWS */
4346 #ifdef HAVE_WINDOW_SYSTEM
4347 /* Defined in xterm.c, nsterm.m, w32term.c. */
4348 extern char *x_get_keysym_name (int);
4349 #endif /* HAVE_WINDOW_SYSTEM */
4352 /* Defined in xml.c. */
4353 extern void syms_of_xml (void);
4354 extern void xml_cleanup_parser (void);
4358 /* Defined in decompress.c. */
4359 extern void syms_of_decompress (void);
4363 /* Defined in dbusbind.c. */
4364 void syms_of_dbusbind (void);
4368 /* Defined in profiler.c. */
4369 extern bool profiler_memory_running
;
4370 extern void malloc_probe (size_t);
4371 extern void syms_of_profiler (void);
4375 /* Defined in msdos.c, w32.c. */
4376 extern char *emacs_root_dir (void);
4379 /* True means Emacs has already been initialized.
4380 Used during startup to detect startup of dumped Emacs. */
4381 extern bool initialized
;
4383 /* True means ^G can quit instantly. */
4384 extern bool immediate_quit
;
4386 extern void *xmalloc (size_t);
4387 extern void *xzalloc (size_t);
4388 extern void *xrealloc (void *, size_t);
4389 extern void xfree (void *);
4390 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
4391 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
4392 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4394 extern char *xstrdup (const char *);
4395 extern char *xlispstrdup (Lisp_Object
);
4396 extern void dupstring (char **, char const *);
4397 extern void xputenv (const char *);
4399 extern char *egetenv (const char *);
4401 /* Copy Lisp string to temporary (allocated on stack) C string. */
4403 #define xlispstrdupa(string) \
4404 memcpy (alloca (SBYTES (string) + 1), \
4405 SSDATA (string), SBYTES (string) + 1)
4407 /* Set up the name of the machine we're running on. */
4408 extern void init_system_name (void);
4410 /* Return the absolute value of X. X should be a signed integer
4411 expression without side effects, and X's absolute value should not
4412 exceed the maximum for its promoted type. This is called 'eabs'
4413 because 'abs' is reserved by the C standard. */
4414 #define eabs(x) ((x) < 0 ? -(x) : (x))
4416 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4419 #define make_fixnum_or_float(val) \
4420 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4422 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4423 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4425 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4427 extern void *record_xmalloc (size_t);
4429 #define USE_SAFE_ALLOCA \
4430 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4432 /* SAFE_ALLOCA allocates a simple buffer. */
4434 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4436 : (sa_must_free = true, record_xmalloc (size)))
4438 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4439 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4440 positive. The code is tuned for MULTIPLIER being a constant. */
4442 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4444 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4445 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4448 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4449 sa_must_free = true; \
4450 record_unwind_protect_ptr (xfree, buf); \
4454 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4456 #define SAFE_FREE() \
4458 if (sa_must_free) { \
4459 sa_must_free = false; \
4460 unbind_to (sa_count, Qnil); \
4465 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4467 #define SAFE_ALLOCA_LISP(buf, nelt) \
4469 if ((nelt) < MAX_ALLOCA / word_size) \
4470 (buf) = alloca ((nelt) * word_size); \
4471 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4474 (buf) = xmalloc ((nelt) * word_size); \
4475 arg_ = make_save_memory (buf, nelt); \
4476 sa_must_free = true; \
4477 record_unwind_protect (free_save_value, arg_); \
4480 memory_full (SIZE_MAX); \
4483 /* Loop over all tails of a list, checking for cycles.
4484 FIXME: Make tortoise and n internal declarations.
4485 FIXME: Unroll the loop body so we don't need `n'. */
4486 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4487 for ((tortoise) = (hare) = (list), (n) = true; \
4489 (hare = XCDR (hare), (n) = !(n), \
4491 ? (EQ (hare, tortoise) \
4492 ? xsignal1 (Qcircular_list, list) \
4494 /* Move tortoise before the next iteration, in case */ \
4495 /* the next iteration does an Fsetcdr. */ \
4496 : (void) ((tortoise) = XCDR (tortoise)))))
4498 /* Do a `for' loop over alist values. */
4500 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4501 for ((list_var) = (head_var); \
4502 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4503 (list_var) = XCDR (list_var))
4505 /* Check whether it's time for GC, and run it if so. */
4510 if ((consing_since_gc
> gc_cons_threshold
4511 && consing_since_gc
> gc_relative_threshold
)
4512 || (!NILP (Vmemory_full
)
4513 && consing_since_gc
> memory_full_cons_threshold
))
4514 Fgarbage_collect ();
4518 functionp (Lisp_Object object
)
4520 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4522 object
= Findirect_function (object
, Qt
);
4524 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4526 /* Autoloaded symbols are functions, except if they load
4527 macros or keymaps. */
4529 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4530 object
= XCDR (object
);
4532 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4537 return XSUBR (object
)->max_args
!= UNEVALLED
;
4538 else if (COMPILEDP (object
))
4540 else if (CONSP (object
))
4542 Lisp_Object car
= XCAR (object
);
4543 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4551 #endif /* EMACS_LISP_H */