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 ID_val (some integer preprocessor expression)
41 DEFINE_GDB_SYMBOL_ENUM (ID)
43 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
45 DEFINE_GDB_SYMBOL_END (ID)
48 This hack is for the benefit of compilers that do not make macro
49 definitions visible to the debugger. It's used for symbols that
50 .gdbinit needs, symbols whose values may not fit in 'int' (where an
53 Some GCC versions before GCC 4.2 omit enums in debugging output;
54 see GCC bug 23336. So don't use enums with older GCC. */
56 #if !defined __GNUC__ || 4 < __GNUC__ + (2 <= __GNUC_MINOR__)
57 # define ENUMABLE(val) (INT_MIN <= (val) && (val) <= INT_MAX)
59 # define ENUMABLE(val) 0
62 #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val };
63 #if defined MAIN_PROGRAM
64 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
65 # define DEFINE_GDB_SYMBOL_END(id) = id;
67 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
68 # define DEFINE_GDB_SYMBOL_END(val)
71 /* The ubiquitous max and min macros. */
74 #define max(a, b) ((a) > (b) ? (a) : (b))
75 #define min(a, b) ((a) < (b) ? (a) : (b))
77 /* Number of elements in an array. */
78 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
80 /* Number of bits in a Lisp_Object tag. */
81 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
83 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
85 /* The number of bits needed in an EMACS_INT over and above the number
86 of bits in a pointer. This is 0 on systems where:
87 1. We can specify multiple-of-8 alignment on static variables.
88 2. We know malloc returns a multiple of 8. */
89 #if (defined alignas \
90 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
91 || defined DARWIN_OS || defined __sun || defined __MINGW32__))
92 # define NONPOINTER_BITS 0
94 # define NONPOINTER_BITS GCTYPEBITS
97 /* EMACS_INT - signed integer wide enough to hold an Emacs value
98 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
99 pI - printf length modifier for EMACS_INT
100 EMACS_UINT - unsigned variant of EMACS_INT */
101 #ifndef EMACS_INT_MAX
103 # error "INTPTR_MAX misconfigured"
104 # elif INTPTR_MAX <= INT_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
105 typedef int EMACS_INT
;
106 typedef unsigned int EMACS_UINT
;
107 # define EMACS_INT_MAX INT_MAX
109 # elif INTPTR_MAX <= LONG_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
110 typedef long int EMACS_INT
;
111 typedef unsigned long EMACS_UINT
;
112 # define EMACS_INT_MAX LONG_MAX
114 /* Check versus LLONG_MAX, not LLONG_MAX >> NONPOINTER_BITS.
115 In theory this is not safe, but in practice it seems to be OK. */
116 # elif INTPTR_MAX <= LLONG_MAX
117 typedef long long int EMACS_INT
;
118 typedef unsigned long long int EMACS_UINT
;
119 # define EMACS_INT_MAX LLONG_MAX
122 # error "INTPTR_MAX too large"
126 /* Number of bits to put in each character in the internal representation
127 of bool vectors. This should not vary across implementations. */
128 enum { BOOL_VECTOR_BITS_PER_CHAR
=
129 #define BOOL_VECTOR_BITS_PER_CHAR 8
130 BOOL_VECTOR_BITS_PER_CHAR
133 /* An unsigned integer type representing a fixed-length bit sequence,
134 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
135 for speed, but it is unsigned char on weird platforms. */
136 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
137 typedef size_t bits_word
;
138 # define BITS_WORD_MAX SIZE_MAX
139 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
141 typedef unsigned char bits_word
;
142 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
143 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
145 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
147 /* Number of bits in some machine integer types. */
150 BITS_PER_CHAR
= CHAR_BIT
,
151 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
152 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
153 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
156 /* printmax_t and uprintmax_t are types for printing large integers.
157 These are the widest integers that are supported for printing.
158 pMd etc. are conversions for printing them.
159 On C99 hosts, there's no problem, as even the widest integers work.
160 Fall back on EMACS_INT on pre-C99 hosts. */
162 typedef intmax_t printmax_t
;
163 typedef uintmax_t uprintmax_t
;
167 typedef EMACS_INT printmax_t
;
168 typedef EMACS_UINT uprintmax_t
;
173 /* Use pD to format ptrdiff_t values, which suffice for indexes into
174 buffers and strings. Emacs never allocates objects larger than
175 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
176 In C99, pD can always be "t"; configure it here for the sake of
177 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
178 #if PTRDIFF_MAX == INT_MAX
180 #elif PTRDIFF_MAX == LONG_MAX
182 #elif PTRDIFF_MAX == LLONG_MAX
188 /* Extra internal type checking? */
190 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
191 'assume (COND)'. COND should be free of side effects, as it may or
192 may not be evaluated.
194 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
195 defined and suppress_checking is false, and does nothing otherwise.
196 Emacs dies if COND is checked and is false. The suppress_checking
197 variable is initialized to 0 in alloc.c. Set it to 1 using a
198 debugger to temporarily disable aborting on detected internal
199 inconsistencies or error conditions.
201 In some cases, a good compiler may be able to optimize away the
202 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
203 uses eassert to test STRINGP (x), but a particular use of XSTRING
204 is invoked only after testing that STRINGP (x) is true, making the
207 eassume is like eassert except that it also causes the compiler to
208 assume that COND is true afterwards, regardless of whether runtime
209 checking is enabled. This can improve performance in some cases,
210 though it can degrade performance in others. It's often suboptimal
211 for COND to call external functions or access volatile storage. */
213 #ifndef ENABLE_CHECKING
214 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
215 # define eassume(cond) assume (cond)
216 #else /* ENABLE_CHECKING */
218 extern _Noreturn
void die (const char *, const char *, int);
220 extern bool suppress_checking EXTERNALLY_VISIBLE
;
222 # define eassert(cond) \
223 (suppress_checking || (cond) \
225 : die (# cond, __FILE__, __LINE__))
226 # define eassume(cond) \
231 : die (# cond, __FILE__, __LINE__))
232 #endif /* ENABLE_CHECKING */
235 /* Use the configure flag --enable-check-lisp-object-type to make
236 Lisp_Object use a struct type instead of the default int. The flag
237 causes CHECK_LISP_OBJECT_TYPE to be defined. */
239 /***** Select the tagging scheme. *****/
240 /* The following option controls the tagging scheme:
241 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
242 always 0, and we can thus use them to hold tag bits, without
243 restricting our addressing space.
245 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
246 restricting our possible address range.
248 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
249 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
250 on the few static Lisp_Objects used: all the defsubr as well
251 as the two special buffers buffer_defaults and buffer_local_symbols. */
255 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
256 integer constant, for MSVC. */
257 #define GCALIGNMENT 8
259 /* Number of bits in a Lisp_Object value, not counting the tag. */
260 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
262 /* Number of bits in a Lisp fixnum tag. */
263 INTTYPEBITS
= GCTYPEBITS
- 1,
265 /* Number of bits in a Lisp fixnum value, not counting the tag. */
266 FIXNUM_BITS
= VALBITS
+ 1
269 #if GCALIGNMENT != 1 << GCTYPEBITS
270 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
273 /* The maximum value that can be stored in a EMACS_INT, assuming all
274 bits other than the type bits contribute to a nonnegative signed value.
275 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
276 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
278 /* Whether the least-significant bits of an EMACS_INT contain the tag.
279 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
280 a. unnecessary, because the top bits of an EMACS_INT are unused, and
281 b. slower, because it typically requires extra masking.
282 So, USE_LSB_TAG is true only on hosts where it might be useful. */
283 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
284 #define USE_LSB_TAG (EMACS_INT_MAX >> GCTYPEBITS < INTPTR_MAX)
285 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
287 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
288 # error "USE_LSB_TAG not supported on this platform; please report this." \
289 "Try 'configure --with-wide-int' to work around the problem."
294 # define alignas(alignment) /* empty */
296 # error "USE_LSB_TAG requires alignas"
301 /* Some operations are so commonly executed that they are implemented
302 as macros, not functions, because otherwise runtime performance would
303 suffer too much when compiling with GCC without optimization.
304 There's no need to inline everything, just the operations that
305 would otherwise cause a serious performance problem.
307 For each such operation OP, define a macro lisp_h_OP that contains
308 the operation's implementation. That way, OP can be implemented
309 via a macro definition like this:
311 #define OP(x) lisp_h_OP (x)
313 and/or via a function definition like this:
315 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
317 which macro-expands to this:
319 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
321 without worrying about the implementations diverging, since
322 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
323 are intended to be private to this include file, and should not be
326 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
327 functions, once most developers have access to GCC 4.8 or later and
328 can use "gcc -Og" to debug. Maybe in the year 2016. See
331 Commentary for these macros can be found near their corresponding
334 #if CHECK_LISP_OBJECT_TYPE
335 # define lisp_h_XLI(o) ((o).i)
336 # define lisp_h_XIL(i) ((Lisp_Object) { i })
338 # define lisp_h_XLI(o) (o)
339 # define lisp_h_XIL(i) (i)
341 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
342 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
343 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
344 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
345 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
346 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
347 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
348 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
349 #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0)
350 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
351 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
352 #define lisp_h_NILP(x) EQ (x, Qnil)
353 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
354 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
355 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
356 #define lisp_h_SYMBOL_VAL(sym) \
357 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
358 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
359 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
360 #define lisp_h_XCAR(c) XCONS (c)->car
361 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
362 #define lisp_h_XCONS(a) \
363 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
364 #define lisp_h_XHASH(a) XUINT (a)
365 #define lisp_h_XPNTR(a) ((void *) (intptr_t) (XLI (a) & VALMASK))
366 #define lisp_h_XSYMBOL(a) \
367 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
368 #ifndef GC_CHECK_CONS_LIST
369 # define lisp_h_check_cons_list() ((void) 0)
372 # define lisp_h_make_number(n) \
373 XIL ((EMACS_INT) ((EMACS_UINT) (n) << INTTYPEBITS))
374 # define lisp_h_XFASTINT(a) XINT (a)
375 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
376 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
377 # define lisp_h_XUNTAG(a, type) ((void *) (XLI (a) - (type)))
380 /* When compiling via gcc -O0, define the key operations as macros, as
381 Emacs is too slow otherwise. To disable this optimization, compile
382 with -DINLINING=false. */
383 #if (defined __NO_INLINE__ \
384 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
385 && ! (defined INLINING && ! INLINING))
386 # define XLI(o) lisp_h_XLI (o)
387 # define XIL(i) lisp_h_XIL (i)
388 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
389 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
390 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
391 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
392 # define CONSP(x) lisp_h_CONSP (x)
393 # define EQ(x, y) lisp_h_EQ (x, y)
394 # define FLOATP(x) lisp_h_FLOATP (x)
395 # define INTEGERP(x) lisp_h_INTEGERP (x)
396 # define MARKERP(x) lisp_h_MARKERP (x)
397 # define MISCP(x) lisp_h_MISCP (x)
398 # define NILP(x) lisp_h_NILP (x)
399 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
400 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
401 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
402 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
403 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
404 # define XCAR(c) lisp_h_XCAR (c)
405 # define XCDR(c) lisp_h_XCDR (c)
406 # define XCONS(a) lisp_h_XCONS (a)
407 # define XHASH(a) lisp_h_XHASH (a)
408 # define XPNTR(a) lisp_h_XPNTR (a)
409 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
410 # ifndef GC_CHECK_CONS_LIST
411 # define check_cons_list() lisp_h_check_cons_list ()
414 # define make_number(n) lisp_h_make_number (n)
415 # define XFASTINT(a) lisp_h_XFASTINT (a)
416 # define XINT(a) lisp_h_XINT (a)
417 # define XTYPE(a) lisp_h_XTYPE (a)
418 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
422 /* Define NAME as a lisp.h inline function that returns TYPE and has
423 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
424 ARGS should be parenthesized. Implement the function by calling
426 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
427 INLINE type (name) argdecls { return lisp_h_##name args; }
429 /* like LISP_MACRO_DEFUN, except NAME returns void. */
430 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
431 INLINE void (name) argdecls { lisp_h_##name args; }
434 /* Define the fundamental Lisp data structures. */
436 /* This is the set of Lisp data types. If you want to define a new
437 data type, read the comments after Lisp_Fwd_Type definition
440 /* Lisp integers use 2 tags, to give them one extra bit, thus
441 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
442 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
443 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
445 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
446 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
447 vociferously about them. */
448 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
449 || (defined __SUNPRO_C && __STDC__))
450 #define ENUM_BF(TYPE) unsigned int
452 #define ENUM_BF(TYPE) enum TYPE
458 /* Integer. XINT (obj) is the integer value. */
460 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
462 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
465 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
466 whose first member indicates the subtype. */
469 /* String. XSTRING (object) points to a struct Lisp_String.
470 The length of the string, and its contents, are stored therein. */
471 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
473 /* Vector of Lisp objects, or something resembling it.
474 XVECTOR (object) points to a struct Lisp_Vector, which contains
475 the size and contents. The size field also contains the type
476 information, if it's not a real vector object. */
479 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
485 /* This is the set of data types that share a common structure.
486 The first member of the structure is a type code from this set.
487 The enum values are arbitrary, but we'll use large numbers to make it
488 more likely that we'll spot the error if a random word in memory is
489 mistakenly interpreted as a Lisp_Misc. */
492 Lisp_Misc_Free
= 0x5eab,
495 Lisp_Misc_Save_Value
,
496 /* Currently floats are not a misc type,
497 but let's define this in case we want to change that. */
499 /* This is not a type code. It is for range checking. */
503 /* These are the types of forwarding objects used in the value slot
504 of symbols for special built-in variables whose value is stored in
508 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
509 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
510 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
511 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
512 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
515 /* If you want to define a new Lisp data type, here are some
516 instructions. See the thread at
517 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
520 First, there are already a couple of Lisp types that can be used if
521 your new type does not need to be exposed to Lisp programs nor
522 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
523 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
524 is suitable for temporarily stashing away pointers and integers in
525 a Lisp object. The latter is useful for vector-like Lisp objects
526 that need to be used as part of other objects, but which are never
527 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
530 These two types don't look pretty when printed, so they are
531 unsuitable for Lisp objects that can be exposed to users.
533 To define a new data type, add one more Lisp_Misc subtype or one
534 more pseudovector subtype. Pseudovectors are more suitable for
535 objects with several slots that need to support fast random access,
536 while Lisp_Misc types are for everything else. A pseudovector object
537 provides one or more slots for Lisp objects, followed by struct
538 members that are accessible only from C. A Lisp_Misc object is a
539 wrapper for a C struct that can contain anything you like.
541 Explicit freeing is discouraged for Lisp objects in general. But if
542 you really need to exploit this, use Lisp_Misc (check free_misc in
543 alloc.c to see why). There is no way to free a vectorlike object.
545 To add a new pseudovector type, extend the pvec_type enumeration;
546 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
548 For a Lisp_Misc, you will also need to add your entry to union
549 Lisp_Misc (but make sure the first word has the same structure as
550 the others, starting with a 16-bit member of the Lisp_Misc_Type
551 enumeration and a 1-bit GC markbit) and make sure the overall size
552 of the union is not increased by your addition.
554 For a new pseudovector, it's highly desirable to limit the size
555 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
556 Otherwise you will need to change sweep_vectors (also in alloc.c).
558 Then you will need to add switch branches in print.c (in
559 print_object, to print your object, and possibly also in
560 print_preprocess) and to alloc.c, to mark your object (in
561 mark_object) and to free it (in gc_sweep). The latter is also the
562 right place to call any code specific to your data type that needs
563 to run when the object is recycled -- e.g., free any additional
564 resources allocated for it that are not Lisp objects. You can even
565 make a pointer to the function that frees the resources a slot in
566 your object -- this way, the same object could be used to represent
567 several disparate C structures. */
569 #ifdef CHECK_LISP_OBJECT_TYPE
571 typedef struct { EMACS_INT i
; } Lisp_Object
;
573 #define LISP_INITIALLY_ZERO {0}
575 #undef CHECK_LISP_OBJECT_TYPE
576 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
577 #else /* CHECK_LISP_OBJECT_TYPE */
579 /* If a struct type is not wanted, define Lisp_Object as just a number. */
581 typedef EMACS_INT Lisp_Object
;
582 #define LISP_INITIALLY_ZERO 0
583 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
584 #endif /* CHECK_LISP_OBJECT_TYPE */
586 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
587 At the machine level, these operations are no-ops. */
588 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
589 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
591 /* In the size word of a vector, this bit means the vector has been marked. */
593 #define ARRAY_MARK_FLAG_val PTRDIFF_MIN
594 #if ENUMABLE (ARRAY_MARK_FLAG_val)
595 DEFINE_GDB_SYMBOL_ENUM (ARRAY_MARK_FLAG
)
597 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
598 # define ARRAY_MARK_FLAG ARRAY_MARK_FLAG_val
599 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
602 /* In the size word of a struct Lisp_Vector, this bit means it's really
603 some other vector-like object. */
604 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
605 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
606 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
608 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
609 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
610 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
613 /* In a pseudovector, the size field actually contains a word with one
614 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
615 with PVEC_TYPE_MASK to indicate the actual type. */
627 PVEC_WINDOW_CONFIGURATION
,
630 /* These should be last, check internal_equal to see why. */
634 PVEC_FONT
/* Should be last because it's used for range checking. */
639 /* For convenience, we also store the number of elements in these bits.
640 Note that this size is not necessarily the memory-footprint size, but
641 only the number of Lisp_Object fields (that need to be traced by GC).
642 The distinction is used, e.g., by Lisp_Process, which places extra
643 non-Lisp_Object fields at the end of the structure. */
644 PSEUDOVECTOR_SIZE_BITS
= 12,
645 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
647 /* To calculate the memory footprint of the pseudovector, it's useful
648 to store the size of non-Lisp area in word_size units here. */
649 PSEUDOVECTOR_REST_BITS
= 12,
650 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
651 << PSEUDOVECTOR_SIZE_BITS
),
653 /* Used to extract pseudovector subtype information. */
654 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
655 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
658 /* These functions extract various sorts of values from a Lisp_Object.
659 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
660 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
663 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
664 #define VALMASK_val (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
665 #if ENUMABLE (VALMASK_val)
666 DEFINE_GDB_SYMBOL_ENUM (VALMASK
)
668 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
669 # define VALMASK VALMASK_val
670 DEFINE_GDB_SYMBOL_END (VALMASK
)
673 /* Largest and smallest representable fixnum values. These are the C
674 values. They are macros for use in static initializers. */
675 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
676 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
678 /* Extract the pointer hidden within A. */
679 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
683 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
684 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
685 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
686 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
687 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
689 #else /* ! USE_LSB_TAG */
691 /* Although compiled only if ! USE_LSB_TAG, the following functions
692 also work when USE_LSB_TAG; this is to aid future maintenance when
693 the lisp_h_* macros are eventually removed. */
695 /* Make a Lisp integer representing the value of the low order
698 make_number (EMACS_INT n
)
703 n
= u
<< INTTYPEBITS
;
710 /* Extract A's value as a signed integer. */
714 EMACS_INT i
= XLI (a
);
718 i
= u
<< INTTYPEBITS
;
720 return i
>> INTTYPEBITS
;
723 /* Like XINT (A), but may be faster. A must be nonnegative.
724 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
725 integers have zero-bits in their tags. */
727 XFASTINT (Lisp_Object a
)
729 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
734 /* Extract A's type. */
735 INLINE
enum Lisp_Type
736 XTYPE (Lisp_Object a
)
738 EMACS_UINT i
= XLI (a
);
739 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
742 /* Extract A's pointer value, assuming A's type is TYPE. */
744 XUNTAG (Lisp_Object a
, int type
)
748 intptr_t i
= XLI (a
) - type
;
754 #endif /* ! USE_LSB_TAG */
756 /* Extract A's value as an unsigned integer. */
758 XUINT (Lisp_Object a
)
760 EMACS_UINT i
= XLI (a
);
761 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
764 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
765 right now, but XUINT should only be applied to objects we know are
767 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
769 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
771 make_natnum (EMACS_INT n
)
773 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
774 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
777 /* Return true if X and Y are the same object. */
778 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
780 /* Value is true if I doesn't fit into a Lisp fixnum. It is
781 written this way so that it also works if I is of unsigned
782 type or if I is a NaN. */
784 #define FIXNUM_OVERFLOW_P(i) \
785 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
788 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
790 return num
< lower
? lower
: num
<= upper
? num
: upper
;
793 /* Forward declarations. */
795 /* Defined in this file. */
797 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
798 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
799 INLINE
bool BUFFERP (Lisp_Object
);
800 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
801 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
802 INLINE
bool (CONSP
) (Lisp_Object
);
803 INLINE
bool (FLOATP
) (Lisp_Object
);
804 INLINE
bool functionp (Lisp_Object
);
805 INLINE
bool (INTEGERP
) (Lisp_Object
);
806 INLINE
bool (MARKERP
) (Lisp_Object
);
807 INLINE
bool (MISCP
) (Lisp_Object
);
808 INLINE
bool (NILP
) (Lisp_Object
);
809 INLINE
bool OVERLAYP (Lisp_Object
);
810 INLINE
bool PROCESSP (Lisp_Object
);
811 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
812 INLINE
bool SAVE_VALUEP (Lisp_Object
);
813 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
815 INLINE
bool STRINGP (Lisp_Object
);
816 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
817 INLINE
bool SUBRP (Lisp_Object
);
818 INLINE
bool (SYMBOLP
) (Lisp_Object
);
819 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
820 INLINE
bool WINDOWP (Lisp_Object
);
821 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
823 /* Defined in chartab.c. */
824 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
825 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
826 extern int char_table_translate (Lisp_Object
, int);
828 /* Defined in data.c. */
829 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
830 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
831 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
832 extern Lisp_Object Qbool_vector_p
;
833 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
834 extern Lisp_Object Qwindow
;
835 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
837 /* Defined in emacs.c. */
838 extern bool might_dump
;
839 /* True means Emacs has already been initialized.
840 Used during startup to detect startup of dumped Emacs. */
841 extern bool initialized
;
843 /* Defined in eval.c. */
844 extern Lisp_Object Qautoload
;
846 /* Defined in floatfns.c. */
847 extern double extract_float (Lisp_Object
);
849 /* Defined in process.c. */
850 extern Lisp_Object Qprocessp
;
852 /* Defined in window.c. */
853 extern Lisp_Object Qwindowp
;
855 /* Defined in xdisp.c. */
856 extern Lisp_Object Qimage
;
859 /* Extract a value or address from a Lisp_Object. */
861 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
863 INLINE
struct Lisp_Vector
*
864 XVECTOR (Lisp_Object a
)
866 eassert (VECTORLIKEP (a
));
867 return XUNTAG (a
, Lisp_Vectorlike
);
870 INLINE
struct Lisp_String
*
871 XSTRING (Lisp_Object a
)
873 eassert (STRINGP (a
));
874 return XUNTAG (a
, Lisp_String
);
877 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
879 INLINE
struct Lisp_Float
*
880 XFLOAT (Lisp_Object a
)
882 eassert (FLOATP (a
));
883 return XUNTAG (a
, Lisp_Float
);
886 /* Pseudovector types. */
888 INLINE
struct Lisp_Process
*
889 XPROCESS (Lisp_Object a
)
891 eassert (PROCESSP (a
));
892 return XUNTAG (a
, Lisp_Vectorlike
);
895 INLINE
struct window
*
896 XWINDOW (Lisp_Object a
)
898 eassert (WINDOWP (a
));
899 return XUNTAG (a
, Lisp_Vectorlike
);
902 INLINE
struct terminal
*
903 XTERMINAL (Lisp_Object a
)
905 return XUNTAG (a
, Lisp_Vectorlike
);
908 INLINE
struct Lisp_Subr
*
909 XSUBR (Lisp_Object a
)
912 return XUNTAG (a
, Lisp_Vectorlike
);
915 INLINE
struct buffer
*
916 XBUFFER (Lisp_Object a
)
918 eassert (BUFFERP (a
));
919 return XUNTAG (a
, Lisp_Vectorlike
);
922 INLINE
struct Lisp_Char_Table
*
923 XCHAR_TABLE (Lisp_Object a
)
925 eassert (CHAR_TABLE_P (a
));
926 return XUNTAG (a
, Lisp_Vectorlike
);
929 INLINE
struct Lisp_Sub_Char_Table
*
930 XSUB_CHAR_TABLE (Lisp_Object a
)
932 eassert (SUB_CHAR_TABLE_P (a
));
933 return XUNTAG (a
, Lisp_Vectorlike
);
936 INLINE
struct Lisp_Bool_Vector
*
937 XBOOL_VECTOR (Lisp_Object a
)
939 eassert (BOOL_VECTOR_P (a
));
940 return XUNTAG (a
, Lisp_Vectorlike
);
943 /* Construct a Lisp_Object from a value or address. */
946 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
948 EMACS_UINT utype
= type
;
949 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
950 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
951 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
956 make_lisp_proc (struct Lisp_Process
*p
)
958 return make_lisp_ptr (p
, Lisp_Vectorlike
);
961 #define XSETINT(a, b) ((a) = make_number (b))
962 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
963 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
964 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
965 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
966 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
967 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
968 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
970 /* Pseudovector types. */
972 #define XSETPVECTYPE(v, code) \
973 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
974 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
975 ((v)->header.size = (PSEUDOVECTOR_FLAG \
976 | ((code) << PSEUDOVECTOR_AREA_BITS) \
977 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
980 /* The cast to struct vectorlike_header * avoids aliasing issues. */
981 #define XSETPSEUDOVECTOR(a, b, code) \
982 XSETTYPED_PSEUDOVECTOR (a, b, \
983 (((struct vectorlike_header *) \
984 XUNTAG (a, Lisp_Vectorlike)) \
987 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
988 (XSETVECTOR (a, b), \
989 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
990 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
992 #define XSETWINDOW_CONFIGURATION(a, b) \
993 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
994 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
995 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
996 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
997 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
998 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
999 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1000 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1001 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1002 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1004 /* Type checking. */
1006 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
1007 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
1010 /* Deprecated and will be removed soon. */
1012 #define INTERNAL_FIELD(field) field ## _
1014 /* See the macros in intervals.h. */
1016 typedef struct interval
*INTERVAL
;
1020 /* Car of this cons cell. */
1025 /* Cdr of this cons cell. */
1028 /* Used to chain conses on a free list. */
1029 struct Lisp_Cons
*chain
;
1033 /* Take the car or cdr of something known to be a cons cell. */
1034 /* The _addr functions shouldn't be used outside of the minimal set
1035 of code that has to know what a cons cell looks like. Other code not
1036 part of the basic lisp implementation should assume that the car and cdr
1037 fields are not accessible. (What if we want to switch to
1038 a copying collector someday? Cached cons cell field addresses may be
1039 invalidated at arbitrary points.) */
1040 INLINE Lisp_Object
*
1041 xcar_addr (Lisp_Object c
)
1043 return &XCONS (c
)->car
;
1045 INLINE Lisp_Object
*
1046 xcdr_addr (Lisp_Object c
)
1048 return &XCONS (c
)->u
.cdr
;
1051 /* Use these from normal code. */
1052 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
1053 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
1055 /* Use these to set the fields of a cons cell.
1057 Note that both arguments may refer to the same object, so 'n'
1058 should not be read after 'c' is first modified. */
1060 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1065 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1070 /* Take the car or cdr of something whose type is not known. */
1074 return (CONSP (c
) ? XCAR (c
)
1076 : wrong_type_argument (Qlistp
, c
));
1081 return (CONSP (c
) ? XCDR (c
)
1083 : wrong_type_argument (Qlistp
, c
));
1086 /* Take the car or cdr of something whose type is not known. */
1088 CAR_SAFE (Lisp_Object c
)
1090 return CONSP (c
) ? XCAR (c
) : Qnil
;
1093 CDR_SAFE (Lisp_Object c
)
1095 return CONSP (c
) ? XCDR (c
) : Qnil
;
1098 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1103 ptrdiff_t size_byte
;
1104 INTERVAL intervals
; /* Text properties in this string. */
1105 unsigned char *data
;
1108 /* True if STR is a multibyte string. */
1110 STRING_MULTIBYTE (Lisp_Object str
)
1112 return 0 <= XSTRING (str
)->size_byte
;
1115 /* An upper bound on the number of bytes in a Lisp string, not
1116 counting the terminating null. This a tight enough bound to
1117 prevent integer overflow errors that would otherwise occur during
1118 string size calculations. A string cannot contain more bytes than
1119 a fixnum can represent, nor can it be so long that C pointer
1120 arithmetic stops working on the string plus its terminating null.
1121 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1122 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1123 would expose alloc.c internal details that we'd rather keep
1126 This is a macro for use in static initializers. The cast to
1127 ptrdiff_t ensures that the macro is signed. */
1128 #define STRING_BYTES_BOUND \
1129 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1131 /* Mark STR as a unibyte string. */
1132 #define STRING_SET_UNIBYTE(STR) \
1134 if (EQ (STR, empty_multibyte_string)) \
1135 (STR) = empty_unibyte_string; \
1137 XSTRING (STR)->size_byte = -1; \
1140 /* Mark STR as a multibyte string. Assure that STR contains only
1141 ASCII characters in advance. */
1142 #define STRING_SET_MULTIBYTE(STR) \
1144 if (EQ (STR, empty_unibyte_string)) \
1145 (STR) = empty_multibyte_string; \
1147 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1150 /* Convenience functions for dealing with Lisp strings. */
1152 INLINE
unsigned char *
1153 SDATA (Lisp_Object string
)
1155 return XSTRING (string
)->data
;
1158 SSDATA (Lisp_Object string
)
1160 /* Avoid "differ in sign" warnings. */
1161 return (char *) SDATA (string
);
1163 INLINE
unsigned char
1164 SREF (Lisp_Object string
, ptrdiff_t index
)
1166 return SDATA (string
)[index
];
1169 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1171 SDATA (string
)[index
] = new;
1174 SCHARS (Lisp_Object string
)
1176 return XSTRING (string
)->size
;
1179 #ifdef GC_CHECK_STRING_BYTES
1180 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1183 STRING_BYTES (struct Lisp_String
*s
)
1185 #ifdef GC_CHECK_STRING_BYTES
1186 return string_bytes (s
);
1188 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1193 SBYTES (Lisp_Object string
)
1195 return STRING_BYTES (XSTRING (string
));
1198 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1200 XSTRING (string
)->size
= newsize
;
1203 /* Header of vector-like objects. This documents the layout constraints on
1204 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1205 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1206 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1207 because when two such pointers potentially alias, a compiler won't
1208 incorrectly reorder loads and stores to their size fields. See
1210 struct vectorlike_header
1212 /* The only field contains various pieces of information:
1213 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1214 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1215 vector (0) or a pseudovector (1).
1216 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1217 of slots) of the vector.
1218 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1219 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1220 - b) number of Lisp_Objects slots at the beginning of the object
1221 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1223 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1224 measured in word_size units. Rest fields may also include
1225 Lisp_Objects, but these objects usually needs some special treatment
1227 There are some exceptions. For PVEC_FREE, b) is always zero. For
1228 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1229 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1230 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1234 /* A regular vector is just a header plus an array of Lisp_Objects. */
1238 struct vectorlike_header header
;
1239 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1242 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1245 ALIGNOF_STRUCT_LISP_VECTOR
1246 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1249 /* A boolvector is a kind of vectorlike, with contents like a string. */
1251 struct Lisp_Bool_Vector
1253 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1254 just the subtype information. */
1255 struct vectorlike_header header
;
1256 /* This is the size in bits. */
1258 /* The actual bits, packed into bytes.
1259 Zeros fill out the last word if needed.
1260 The bits are in little-endian order in the bytes, and
1261 the bytes are in little-endian order in the words. */
1262 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1266 bool_vector_size (Lisp_Object a
)
1268 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1269 eassume (0 <= size
);
1274 bool_vector_data (Lisp_Object a
)
1276 return XBOOL_VECTOR (a
)->data
;
1279 INLINE
unsigned char *
1280 bool_vector_uchar_data (Lisp_Object a
)
1282 return (unsigned char *) bool_vector_data (a
);
1285 /* The number of data words and bytes in a bool vector with SIZE bits. */
1288 bool_vector_words (EMACS_INT size
)
1290 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1291 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1295 bool_vector_bytes (EMACS_INT size
)
1297 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1298 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1301 /* True if A's Ith bit is set. */
1304 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1306 eassume (0 <= i
&& i
< bool_vector_size (a
));
1307 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1308 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1312 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1314 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1317 /* Set A's Ith bit to B. */
1320 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1322 unsigned char *addr
;
1324 eassume (0 <= i
&& i
< bool_vector_size (a
));
1325 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1328 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1330 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1333 /* Some handy constants for calculating sizes
1334 and offsets, mostly of vectorlike objects. */
1338 header_size
= offsetof (struct Lisp_Vector
, contents
),
1339 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1340 word_size
= sizeof (Lisp_Object
)
1343 /* Conveniences for dealing with Lisp arrays. */
1346 AREF (Lisp_Object array
, ptrdiff_t idx
)
1348 return XVECTOR (array
)->contents
[idx
];
1351 INLINE Lisp_Object
*
1352 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1354 return & XVECTOR (array
)->contents
[idx
];
1358 ASIZE (Lisp_Object array
)
1360 return XVECTOR (array
)->header
.size
;
1364 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1366 eassert (0 <= idx
&& idx
< ASIZE (array
));
1367 XVECTOR (array
)->contents
[idx
] = val
;
1371 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1373 /* Like ASET, but also can be used in the garbage collector:
1374 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1375 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
1376 XVECTOR (array
)->contents
[idx
] = val
;
1379 /* If a struct is made to look like a vector, this macro returns the length
1380 of the shortest vector that would hold that struct. */
1382 #define VECSIZE(type) \
1383 ((sizeof (type) - header_size + word_size - 1) / word_size)
1385 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1386 at the end and we need to compute the number of Lisp_Object fields (the
1387 ones that the GC needs to trace). */
1389 #define PSEUDOVECSIZE(type, nonlispfield) \
1390 ((offsetof (type, nonlispfield) - header_size) / word_size)
1392 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1393 should be integer expressions. This is not the same as
1394 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1395 returns true. For efficiency, prefer plain unsigned comparison if A
1396 and B's sizes both fit (after integer promotion). */
1397 #define UNSIGNED_CMP(a, op, b) \
1398 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1399 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1400 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1402 /* True iff C is an ASCII character. */
1403 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1405 /* A char-table is a kind of vectorlike, with contents are like a
1406 vector but with a few other slots. For some purposes, it makes
1407 sense to handle a char-table with type struct Lisp_Vector. An
1408 element of a char table can be any Lisp objects, but if it is a sub
1409 char-table, we treat it a table that contains information of a
1410 specific range of characters. A sub char-table has the same
1411 structure as a vector. A sub char table appears only in an element
1412 of a char-table, and there's no way to access it directly from
1413 Emacs Lisp program. */
1415 enum CHARTAB_SIZE_BITS
1417 CHARTAB_SIZE_BITS_0
= 6,
1418 CHARTAB_SIZE_BITS_1
= 4,
1419 CHARTAB_SIZE_BITS_2
= 5,
1420 CHARTAB_SIZE_BITS_3
= 7
1423 extern const int chartab_size
[4];
1425 struct Lisp_Char_Table
1427 /* HEADER.SIZE is the vector's size field, which also holds the
1428 pseudovector type information. It holds the size, too.
1429 The size counts the defalt, parent, purpose, ascii,
1430 contents, and extras slots. */
1431 struct vectorlike_header header
;
1433 /* This holds a default value,
1434 which is used whenever the value for a specific character is nil. */
1437 /* This points to another char table, which we inherit from when the
1438 value for a specific character is nil. The `defalt' slot takes
1439 precedence over this. */
1442 /* This is a symbol which says what kind of use this char-table is
1444 Lisp_Object purpose
;
1446 /* The bottom sub char-table for characters of the range 0..127. It
1447 is nil if none of ASCII character has a specific value. */
1450 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1452 /* These hold additional data. It is a vector. */
1453 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1456 struct Lisp_Sub_Char_Table
1458 /* HEADER.SIZE is the vector's size field, which also holds the
1459 pseudovector type information. It holds the size, too. */
1460 struct vectorlike_header header
;
1462 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1463 char-table of depth 1 contains 16 elements, and each element
1464 covers 4096 (128*32) characters. A sub char-table of depth 2
1465 contains 32 elements, and each element covers 128 characters. A
1466 sub char-table of depth 3 contains 128 elements, and each element
1467 is for one character. */
1470 /* Minimum character covered by the sub char-table. */
1471 Lisp_Object min_char
;
1473 /* Use set_sub_char_table_contents to set this. */
1474 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1478 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1480 struct Lisp_Char_Table
*tbl
= NULL
;
1484 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1485 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1486 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1490 while (NILP (val
) && ! NILP (tbl
->parent
));
1495 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1496 characters. Do not check validity of CT. */
1498 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1500 return (ASCII_CHAR_P (idx
)
1501 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1502 : char_table_ref (ct
, idx
));
1505 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1506 8-bit European characters. Do not check validity of CT. */
1508 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1510 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1511 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1513 char_table_set (ct
, idx
, val
);
1516 /* This structure describes a built-in function.
1517 It is generated by the DEFUN macro only.
1518 defsubr makes it into a Lisp object. */
1522 struct vectorlike_header header
;
1524 Lisp_Object (*a0
) (void);
1525 Lisp_Object (*a1
) (Lisp_Object
);
1526 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1527 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1528 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1529 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1530 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1531 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1532 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1533 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1534 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1536 short min_args
, max_args
;
1537 const char *symbol_name
;
1538 const char *intspec
;
1542 /* This is the number of slots that every char table must have. This
1543 counts the ordinary slots and the top, defalt, parent, and purpose
1545 enum CHAR_TABLE_STANDARD_SLOTS
1547 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1550 /* Return the number of "extra" slots in the char table CT. */
1553 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1555 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1556 - CHAR_TABLE_STANDARD_SLOTS
);
1560 /***********************************************************************
1562 ***********************************************************************/
1564 /* Interned state of a symbol. */
1566 enum symbol_interned
1568 SYMBOL_UNINTERNED
= 0,
1569 SYMBOL_INTERNED
= 1,
1570 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1573 enum symbol_redirect
1575 SYMBOL_PLAINVAL
= 4,
1576 SYMBOL_VARALIAS
= 1,
1577 SYMBOL_LOCALIZED
= 2,
1578 SYMBOL_FORWARDED
= 3
1583 bool_bf gcmarkbit
: 1;
1585 /* Indicates where the value can be found:
1586 0 : it's a plain var, the value is in the `value' field.
1587 1 : it's a varalias, the value is really in the `alias' symbol.
1588 2 : it's a localized var, the value is in the `blv' object.
1589 3 : it's a forwarding variable, the value is in `forward'. */
1590 ENUM_BF (symbol_redirect
) redirect
: 3;
1592 /* Non-zero means symbol is constant, i.e. changing its value
1593 should signal an error. If the value is 3, then the var
1594 can be changed, but only by `defconst'. */
1595 unsigned constant
: 2;
1597 /* Interned state of the symbol. This is an enumerator from
1598 enum symbol_interned. */
1599 unsigned interned
: 2;
1601 /* True means that this variable has been explicitly declared
1602 special (with `defvar' etc), and shouldn't be lexically bound. */
1603 bool_bf declared_special
: 1;
1605 /* True if pointed to from purespace and hence can't be GC'd. */
1608 /* The symbol's name, as a Lisp string. */
1611 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1612 union is used depends on the `redirect' field above. */
1615 struct Lisp_Symbol
*alias
;
1616 struct Lisp_Buffer_Local_Value
*blv
;
1617 union Lisp_Fwd
*fwd
;
1620 /* Function value of the symbol or Qnil if not fboundp. */
1621 Lisp_Object function
;
1623 /* The symbol's property list. */
1626 /* Next symbol in obarray bucket, if the symbol is interned. */
1627 struct Lisp_Symbol
*next
;
1630 /* Value is name of symbol. */
1632 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1634 INLINE
struct Lisp_Symbol
*
1635 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1637 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1638 return sym
->val
.alias
;
1640 INLINE
struct Lisp_Buffer_Local_Value
*
1641 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1643 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1644 return sym
->val
.blv
;
1646 INLINE
union Lisp_Fwd
*
1647 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1649 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1650 return sym
->val
.fwd
;
1653 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1654 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1657 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1659 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1663 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1665 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1669 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1671 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1676 SYMBOL_NAME (Lisp_Object sym
)
1678 return XSYMBOL (sym
)->name
;
1681 /* Value is true if SYM is an interned symbol. */
1684 SYMBOL_INTERNED_P (Lisp_Object sym
)
1686 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1689 /* Value is true if SYM is interned in initial_obarray. */
1692 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1694 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1697 /* Value is non-zero if symbol is considered a constant, i.e. its
1698 value cannot be changed (there is an exception for keyword symbols,
1699 whose value can be set to the keyword symbol itself). */
1701 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1703 #define DEFSYM(sym, name) \
1704 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1707 /***********************************************************************
1709 ***********************************************************************/
1711 /* The structure of a Lisp hash table. */
1713 struct hash_table_test
1715 /* Name of the function used to compare keys. */
1718 /* User-supplied hash function, or nil. */
1719 Lisp_Object user_hash_function
;
1721 /* User-supplied key comparison function, or nil. */
1722 Lisp_Object user_cmp_function
;
1724 /* C function to compare two keys. */
1725 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1727 /* C function to compute hash code. */
1728 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1731 struct Lisp_Hash_Table
1733 /* This is for Lisp; the hash table code does not refer to it. */
1734 struct vectorlike_header header
;
1736 /* Nil if table is non-weak. Otherwise a symbol describing the
1737 weakness of the table. */
1740 /* When the table is resized, and this is an integer, compute the
1741 new size by adding this to the old size. If a float, compute the
1742 new size by multiplying the old size with this factor. */
1743 Lisp_Object rehash_size
;
1745 /* Resize hash table when number of entries/ table size is >= this
1747 Lisp_Object rehash_threshold
;
1749 /* Vector of hash codes. If hash[I] is nil, this means that the
1750 I-th entry is unused. */
1753 /* Vector used to chain entries. If entry I is free, next[I] is the
1754 entry number of the next free item. If entry I is non-free,
1755 next[I] is the index of the next entry in the collision chain. */
1758 /* Index of first free entry in free list. */
1759 Lisp_Object next_free
;
1761 /* Bucket vector. A non-nil entry is the index of the first item in
1762 a collision chain. This vector's size can be larger than the
1763 hash table size to reduce collisions. */
1766 /* Only the fields above are traced normally by the GC. The ones below
1767 `count' are special and are either ignored by the GC or traced in
1768 a special way (e.g. because of weakness). */
1770 /* Number of key/value entries in the table. */
1773 /* Vector of keys and values. The key of item I is found at index
1774 2 * I, the value is found at index 2 * I + 1.
1775 This is gc_marked specially if the table is weak. */
1776 Lisp_Object key_and_value
;
1778 /* The comparison and hash functions. */
1779 struct hash_table_test test
;
1781 /* Next weak hash table if this is a weak hash table. The head
1782 of the list is in weak_hash_tables. */
1783 struct Lisp_Hash_Table
*next_weak
;
1787 INLINE
struct Lisp_Hash_Table
*
1788 XHASH_TABLE (Lisp_Object a
)
1790 return XUNTAG (a
, Lisp_Vectorlike
);
1793 #define XSET_HASH_TABLE(VAR, PTR) \
1794 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1797 HASH_TABLE_P (Lisp_Object a
)
1799 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1802 /* Value is the key part of entry IDX in hash table H. */
1804 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1806 return AREF (h
->key_and_value
, 2 * idx
);
1809 /* Value is the value part of entry IDX in hash table H. */
1811 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1813 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1816 /* Value is the index of the next entry following the one at IDX
1819 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1821 return AREF (h
->next
, idx
);
1824 /* Value is the hash code computed for entry IDX in hash table H. */
1826 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1828 return AREF (h
->hash
, idx
);
1831 /* Value is the index of the element in hash table H that is the
1832 start of the collision list at index IDX in the index vector of H. */
1834 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1836 return AREF (h
->index
, idx
);
1839 /* Value is the size of hash table H. */
1841 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1843 return ASIZE (h
->next
);
1846 /* Default size for hash tables if not specified. */
1848 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1850 /* Default threshold specifying when to resize a hash table. The
1851 value gives the ratio of current entries in the hash table and the
1852 size of the hash table. */
1854 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1856 /* Default factor by which to increase the size of a hash table. */
1858 static double const DEFAULT_REHASH_SIZE
= 1.5;
1860 /* Combine two integers X and Y for hashing. The result might not fit
1861 into a Lisp integer. */
1864 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1866 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1869 /* Hash X, returning a value that fits into a fixnum. */
1872 SXHASH_REDUCE (EMACS_UINT x
)
1874 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1877 /* These structures are used for various misc types. */
1879 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1881 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1882 bool_bf gcmarkbit
: 1;
1883 unsigned spacer
: 15;
1888 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1889 bool_bf gcmarkbit
: 1;
1890 unsigned spacer
: 13;
1891 /* This flag is temporarily used in the functions
1892 decode/encode_coding_object to record that the marker position
1893 must be adjusted after the conversion. */
1894 bool_bf need_adjustment
: 1;
1895 /* True means normal insertion at the marker's position
1896 leaves the marker after the inserted text. */
1897 bool_bf insertion_type
: 1;
1898 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1899 Note: a chain of markers can contain markers pointing into different
1900 buffers (the chain is per buffer_text rather than per buffer, so it's
1901 shared between indirect buffers). */
1902 /* This is used for (other than NULL-checking):
1904 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1905 - unchain_marker: to find the list from which to unchain.
1906 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1908 struct buffer
*buffer
;
1910 /* The remaining fields are meaningless in a marker that
1911 does not point anywhere. */
1913 /* For markers that point somewhere,
1914 this is used to chain of all the markers in a given buffer. */
1915 /* We could remove it and use an array in buffer_text instead.
1916 That would also allow to preserve it ordered. */
1917 struct Lisp_Marker
*next
;
1918 /* This is the char position where the marker points. */
1920 /* This is the byte position.
1921 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1922 used to implement the functionality of markers, but rather to (ab)use
1923 markers as a cache for char<->byte mappings). */
1927 /* START and END are markers in the overlay's buffer, and
1928 PLIST is the overlay's property list. */
1930 /* An overlay's real data content is:
1932 - buffer (really there are two buffer pointers, one per marker,
1933 and both points to the same buffer)
1934 - insertion type of both ends (per-marker fields)
1935 - start & start byte (of start marker)
1936 - end & end byte (of end marker)
1937 - next (singly linked list of overlays)
1938 - next fields of start and end markers (singly linked list of markers).
1939 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1942 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1943 bool_bf gcmarkbit
: 1;
1944 unsigned spacer
: 15;
1945 struct Lisp_Overlay
*next
;
1951 /* Types of data which may be saved in a Lisp_Save_Value. */
1962 /* Number of bits needed to store one of the above values. */
1963 enum { SAVE_SLOT_BITS
= 3 };
1965 /* Number of slots in a save value where save_type is nonzero. */
1966 enum { SAVE_VALUE_SLOTS
= 4 };
1968 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1970 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1974 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1975 SAVE_TYPE_INT_INT_INT
1976 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1977 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1978 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1979 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1980 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1981 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1982 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1983 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1984 SAVE_TYPE_FUNCPTR_PTR_OBJ
1985 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1987 /* This has an extra bit indicating it's raw memory. */
1988 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1991 /* Special object used to hold a different values for later use.
1993 This is mostly used to package C integers and pointers to call
1994 record_unwind_protect when two or more values need to be saved.
1998 struct my_data *md = get_my_data ();
1999 ptrdiff_t mi = get_my_integer ();
2000 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2003 Lisp_Object my_unwind (Lisp_Object arg)
2005 struct my_data *md = XSAVE_POINTER (arg, 0);
2006 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2010 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2011 saved objects and raise eassert if type of the saved object doesn't match
2012 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2013 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2014 slot 0 is a pointer. */
2016 typedef void (*voidfuncptr
) (void);
2018 struct Lisp_Save_Value
2020 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2021 bool_bf gcmarkbit
: 1;
2022 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2024 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2025 V's data entries are determined by V->save_type. E.g., if
2026 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2027 V->data[1] is an integer, and V's other data entries are unused.
2029 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2030 a memory area containing V->data[1].integer potential Lisp_Objects. */
2031 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2034 voidfuncptr funcpointer
;
2037 } data
[SAVE_VALUE_SLOTS
];
2040 /* Return the type of V's Nth saved value. */
2042 save_type (struct Lisp_Save_Value
*v
, int n
)
2044 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2045 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2048 /* Get and set the Nth saved pointer. */
2051 XSAVE_POINTER (Lisp_Object obj
, int n
)
2053 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2054 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2057 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2059 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2060 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2063 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2065 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2066 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2069 /* Likewise for the saved integer. */
2072 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2074 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2075 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2078 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2080 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2081 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2084 /* Extract Nth saved object. */
2087 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2089 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2090 return XSAVE_VALUE (obj
)->data
[n
].object
;
2093 /* A miscellaneous object, when it's on the free list. */
2096 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2097 bool_bf gcmarkbit
: 1;
2098 unsigned spacer
: 15;
2099 union Lisp_Misc
*chain
;
2102 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2103 It uses one of these struct subtypes to get the type field. */
2107 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2108 struct Lisp_Free u_free
;
2109 struct Lisp_Marker u_marker
;
2110 struct Lisp_Overlay u_overlay
;
2111 struct Lisp_Save_Value u_save_value
;
2114 INLINE
union Lisp_Misc
*
2115 XMISC (Lisp_Object a
)
2117 return XUNTAG (a
, Lisp_Misc
);
2120 INLINE
struct Lisp_Misc_Any
*
2121 XMISCANY (Lisp_Object a
)
2123 eassert (MISCP (a
));
2124 return & XMISC (a
)->u_any
;
2127 INLINE
enum Lisp_Misc_Type
2128 XMISCTYPE (Lisp_Object a
)
2130 return XMISCANY (a
)->type
;
2133 INLINE
struct Lisp_Marker
*
2134 XMARKER (Lisp_Object a
)
2136 eassert (MARKERP (a
));
2137 return & XMISC (a
)->u_marker
;
2140 INLINE
struct Lisp_Overlay
*
2141 XOVERLAY (Lisp_Object a
)
2143 eassert (OVERLAYP (a
));
2144 return & XMISC (a
)->u_overlay
;
2147 INLINE
struct Lisp_Save_Value
*
2148 XSAVE_VALUE (Lisp_Object a
)
2150 eassert (SAVE_VALUEP (a
));
2151 return & XMISC (a
)->u_save_value
;
2154 /* Forwarding pointer to an int variable.
2155 This is allowed only in the value cell of a symbol,
2156 and it means that the symbol's value really lives in the
2157 specified int variable. */
2160 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2164 /* Boolean forwarding pointer to an int variable.
2165 This is like Lisp_Intfwd except that the ostensible
2166 "value" of the symbol is t if the bool variable is true,
2167 nil if it is false. */
2170 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2174 /* Forwarding pointer to a Lisp_Object variable.
2175 This is allowed only in the value cell of a symbol,
2176 and it means that the symbol's value really lives in the
2177 specified variable. */
2180 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2181 Lisp_Object
*objvar
;
2184 /* Like Lisp_Objfwd except that value lives in a slot in the
2185 current buffer. Value is byte index of slot within buffer. */
2186 struct Lisp_Buffer_Objfwd
2188 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2190 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2191 Lisp_Object predicate
;
2194 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2195 the symbol has buffer-local or frame-local bindings. (Exception:
2196 some buffer-local variables are built-in, with their values stored
2197 in the buffer structure itself. They are handled differently,
2198 using struct Lisp_Buffer_Objfwd.)
2200 The `realvalue' slot holds the variable's current value, or a
2201 forwarding pointer to where that value is kept. This value is the
2202 one that corresponds to the loaded binding. To read or set the
2203 variable, you must first make sure the right binding is loaded;
2204 then you can access the value in (or through) `realvalue'.
2206 `buffer' and `frame' are the buffer and frame for which the loaded
2207 binding was found. If those have changed, to make sure the right
2208 binding is loaded it is necessary to find which binding goes with
2209 the current buffer and selected frame, then load it. To load it,
2210 first unload the previous binding, then copy the value of the new
2211 binding into `realvalue' (or through it). Also update
2212 LOADED-BINDING to point to the newly loaded binding.
2214 `local_if_set' indicates that merely setting the variable creates a
2215 local binding for the current buffer. Otherwise the latter, setting
2216 the variable does not do that; only make-local-variable does that. */
2218 struct Lisp_Buffer_Local_Value
2220 /* True means that merely setting the variable creates a local
2221 binding for the current buffer. */
2222 bool_bf local_if_set
: 1;
2223 /* True means this variable can have frame-local bindings, otherwise, it is
2224 can have buffer-local bindings. The two cannot be combined. */
2225 bool_bf frame_local
: 1;
2226 /* True means that the binding now loaded was found.
2227 Presumably equivalent to (defcell!=valcell). */
2229 /* If non-NULL, a forwarding to the C var where it should also be set. */
2230 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2231 /* The buffer or frame for which the loaded binding was found. */
2233 /* A cons cell that holds the default value. It has the form
2234 (SYMBOL . DEFAULT-VALUE). */
2235 Lisp_Object defcell
;
2236 /* The cons cell from `where's parameter alist.
2237 It always has the form (SYMBOL . VALUE)
2238 Note that if `forward' is non-nil, VALUE may be out of date.
2239 Also if the currently loaded binding is the default binding, then
2240 this is `eq'ual to defcell. */
2241 Lisp_Object valcell
;
2244 /* Like Lisp_Objfwd except that value lives in a slot in the
2246 struct Lisp_Kboard_Objfwd
2248 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2254 struct Lisp_Intfwd u_intfwd
;
2255 struct Lisp_Boolfwd u_boolfwd
;
2256 struct Lisp_Objfwd u_objfwd
;
2257 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2258 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2261 INLINE
enum Lisp_Fwd_Type
2262 XFWDTYPE (union Lisp_Fwd
*a
)
2264 return a
->u_intfwd
.type
;
2267 INLINE
struct Lisp_Buffer_Objfwd
*
2268 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2270 eassert (BUFFER_OBJFWDP (a
));
2271 return &a
->u_buffer_objfwd
;
2274 /* Lisp floating point type. */
2280 struct Lisp_Float
*chain
;
2285 XFLOAT_DATA (Lisp_Object f
)
2287 return XFLOAT (f
)->u
.data
;
2290 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2291 representations, have infinities and NaNs, and do not trap on
2292 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2293 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2294 wanted here, but is not quite right because Emacs does not require
2295 all the features of C11 Annex F (and does not require C11 at all,
2296 for that matter). */
2300 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2301 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2304 /* A character, declared with the following typedef, is a member
2305 of some character set associated with the current buffer. */
2306 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2308 typedef unsigned char UCHAR
;
2311 /* Meanings of slots in a Lisp_Compiled: */
2315 COMPILED_ARGLIST
= 0,
2316 COMPILED_BYTECODE
= 1,
2317 COMPILED_CONSTANTS
= 2,
2318 COMPILED_STACK_DEPTH
= 3,
2319 COMPILED_DOC_STRING
= 4,
2320 COMPILED_INTERACTIVE
= 5
2323 /* Flag bits in a character. These also get used in termhooks.h.
2324 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2325 (MUlti-Lingual Emacs) might need 22 bits for the character value
2326 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2329 CHAR_ALT
= 0x0400000,
2330 CHAR_SUPER
= 0x0800000,
2331 CHAR_HYPER
= 0x1000000,
2332 CHAR_SHIFT
= 0x2000000,
2333 CHAR_CTL
= 0x4000000,
2334 CHAR_META
= 0x8000000,
2336 CHAR_MODIFIER_MASK
=
2337 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2339 /* Actually, the current Emacs uses 22 bits for the character value
2344 /* Data type checking. */
2346 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2349 NUMBERP (Lisp_Object x
)
2351 return INTEGERP (x
) || FLOATP (x
);
2354 NATNUMP (Lisp_Object x
)
2356 return INTEGERP (x
) && 0 <= XINT (x
);
2360 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2362 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2365 #define TYPE_RANGED_INTEGERP(type, x) \
2367 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2368 && XINT (x) <= TYPE_MAXIMUM (type))
2370 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2371 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2372 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2373 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2374 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2375 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2376 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2379 STRINGP (Lisp_Object x
)
2381 return XTYPE (x
) == Lisp_String
;
2384 VECTORP (Lisp_Object x
)
2386 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2389 OVERLAYP (Lisp_Object x
)
2391 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2394 SAVE_VALUEP (Lisp_Object x
)
2396 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2400 AUTOLOADP (Lisp_Object x
)
2402 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2406 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2408 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2412 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2414 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2415 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2418 /* True if A is a pseudovector whose code is CODE. */
2420 PSEUDOVECTORP (Lisp_Object a
, int code
)
2422 if (! VECTORLIKEP (a
))
2426 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2427 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2428 return PSEUDOVECTOR_TYPEP (h
, code
);
2433 /* Test for specific pseudovector types. */
2436 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2438 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2442 PROCESSP (Lisp_Object a
)
2444 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2448 WINDOWP (Lisp_Object a
)
2450 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2454 TERMINALP (Lisp_Object a
)
2456 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2460 SUBRP (Lisp_Object a
)
2462 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2466 COMPILEDP (Lisp_Object a
)
2468 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2472 BUFFERP (Lisp_Object a
)
2474 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2478 CHAR_TABLE_P (Lisp_Object a
)
2480 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2484 SUB_CHAR_TABLE_P (Lisp_Object a
)
2486 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2490 BOOL_VECTOR_P (Lisp_Object a
)
2492 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2496 FRAMEP (Lisp_Object a
)
2498 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2501 /* Test for image (image . spec) */
2503 IMAGEP (Lisp_Object x
)
2505 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2510 ARRAYP (Lisp_Object x
)
2512 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2516 CHECK_LIST (Lisp_Object x
)
2518 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2521 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2522 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2523 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2526 CHECK_STRING (Lisp_Object x
)
2528 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2531 CHECK_STRING_CAR (Lisp_Object x
)
2533 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2536 CHECK_CONS (Lisp_Object x
)
2538 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2541 CHECK_VECTOR (Lisp_Object x
)
2543 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2546 CHECK_BOOL_VECTOR (Lisp_Object x
)
2548 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2551 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2553 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2556 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2558 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2561 CHECK_BUFFER (Lisp_Object x
)
2563 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2566 CHECK_WINDOW (Lisp_Object x
)
2568 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2572 CHECK_PROCESS (Lisp_Object x
)
2574 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2578 CHECK_NATNUM (Lisp_Object x
)
2580 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2583 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2586 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2587 args_out_of_range_3 \
2589 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2590 ? MOST_NEGATIVE_FIXNUM \
2592 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2594 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2596 if (TYPE_SIGNED (type)) \
2597 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2599 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2602 #define CHECK_NUMBER_COERCE_MARKER(x) \
2604 if (MARKERP ((x))) \
2605 XSETFASTINT (x, marker_position (x)); \
2607 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2611 XFLOATINT (Lisp_Object n
)
2613 return extract_float (n
);
2617 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2619 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2622 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2625 XSETFASTINT (x, marker_position (x)); \
2627 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2630 /* Since we can't assign directly to the CAR or CDR fields of a cons
2631 cell, use these when checking that those fields contain numbers. */
2633 CHECK_NUMBER_CAR (Lisp_Object x
)
2635 Lisp_Object tmp
= XCAR (x
);
2641 CHECK_NUMBER_CDR (Lisp_Object x
)
2643 Lisp_Object tmp
= XCDR (x
);
2648 /* Define a built-in function for calling from Lisp.
2649 `lname' should be the name to give the function in Lisp,
2650 as a null-terminated C string.
2651 `fnname' should be the name of the function in C.
2652 By convention, it starts with F.
2653 `sname' should be the name for the C constant structure
2654 that records information on this function for internal use.
2655 By convention, it should be the same as `fnname' but with S instead of F.
2656 It's too bad that C macros can't compute this from `fnname'.
2657 `minargs' should be a number, the minimum number of arguments allowed.
2658 `maxargs' should be a number, the maximum number of arguments allowed,
2659 or else MANY or UNEVALLED.
2660 MANY means pass a vector of evaluated arguments,
2661 in the form of an integer number-of-arguments
2662 followed by the address of a vector of Lisp_Objects
2663 which contains the argument values.
2664 UNEVALLED means pass the list of unevaluated arguments
2665 `intspec' says how interactive arguments are to be fetched.
2666 If the string starts with a `(', `intspec' is evaluated and the resulting
2667 list is the list of arguments.
2668 If it's a string that doesn't start with `(', the value should follow
2669 the one of the doc string for `interactive'.
2670 A null string means call interactively with no arguments.
2671 `doc' is documentation for the user. */
2673 /* This version of DEFUN declares a function prototype with the right
2674 arguments, so we can catch errors with maxargs at compile-time. */
2676 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2677 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2678 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2679 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2680 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2681 { (Lisp_Object (__cdecl *)(void))fnname }, \
2682 minargs, maxargs, lname, intspec, 0}; \
2684 #else /* not _MSC_VER */
2685 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2686 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2687 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2688 { .a ## maxargs = fnname }, \
2689 minargs, maxargs, lname, intspec, 0}; \
2693 /* Note that the weird token-substitution semantics of ANSI C makes
2694 this work for MANY and UNEVALLED. */
2695 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2696 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2697 #define DEFUN_ARGS_0 (void)
2698 #define DEFUN_ARGS_1 (Lisp_Object)
2699 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2700 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2701 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2702 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2704 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2705 Lisp_Object, Lisp_Object)
2706 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2707 Lisp_Object, Lisp_Object, Lisp_Object)
2708 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2709 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2711 /* True if OBJ is a Lisp function. */
2713 FUNCTIONP (Lisp_Object obj
)
2715 return functionp (obj
);
2719 is how we define the symbol for function `name' at start-up time. */
2720 extern void defsubr (struct Lisp_Subr
*);
2728 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2729 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2730 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2731 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2732 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2734 /* Macros we use to define forwarded Lisp variables.
2735 These are used in the syms_of_FILENAME functions.
2737 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2738 lisp variable is actually a field in `struct emacs_globals'. The
2739 field's name begins with "f_", which is a convention enforced by
2740 these macros. Each such global has a corresponding #define in
2741 globals.h; the plain name should be used in the code.
2743 E.g., the global "cons_cells_consed" is declared as "int
2744 f_cons_cells_consed" in globals.h, but there is a define:
2746 #define cons_cells_consed globals.f_cons_cells_consed
2748 All C code uses the `cons_cells_consed' name. This is all done
2749 this way to support indirection for multi-threaded Emacs. */
2751 #define DEFVAR_LISP(lname, vname, doc) \
2753 static struct Lisp_Objfwd o_fwd; \
2754 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2756 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2758 static struct Lisp_Objfwd o_fwd; \
2759 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2761 #define DEFVAR_BOOL(lname, vname, doc) \
2763 static struct Lisp_Boolfwd b_fwd; \
2764 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2766 #define DEFVAR_INT(lname, vname, doc) \
2768 static struct Lisp_Intfwd i_fwd; \
2769 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2772 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2774 static struct Lisp_Objfwd o_fwd; \
2775 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2778 #define DEFVAR_KBOARD(lname, vname, doc) \
2780 static struct Lisp_Kboard_Objfwd ko_fwd; \
2781 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2784 /* Save and restore the instruction and environment pointers,
2785 without affecting the signal mask. */
2788 typedef jmp_buf sys_jmp_buf
;
2789 # define sys_setjmp(j) _setjmp (j)
2790 # define sys_longjmp(j, v) _longjmp (j, v)
2791 #elif defined HAVE_SIGSETJMP
2792 typedef sigjmp_buf sys_jmp_buf
;
2793 # define sys_setjmp(j) sigsetjmp (j, 0)
2794 # define sys_longjmp(j, v) siglongjmp (j, v)
2796 /* A platform that uses neither _longjmp nor siglongjmp; assume
2797 longjmp does not affect the sigmask. */
2798 typedef jmp_buf sys_jmp_buf
;
2799 # define sys_setjmp(j) setjmp (j)
2800 # define sys_longjmp(j, v) longjmp (j, v)
2804 /* Elisp uses several stacks:
2806 - the bytecode stack: used internally by the bytecode interpreter.
2807 Allocated from the C stack.
2808 - The specpdl stack: keeps track of active unwind-protect and
2809 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2811 - The handler stack: keeps track of active catch tags and condition-case
2812 handlers. Allocated in a manually managed stack implemented by a
2813 doubly-linked list allocated via xmalloc and never freed. */
2815 /* Structure for recording Lisp call stack for backtrace purposes. */
2817 /* The special binding stack holds the outer values of variables while
2818 they are bound by a function application or a let form, stores the
2819 code to be executed for unwind-protect forms.
2821 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2822 used all over the place, needs to be fast, and needs to know the size of
2823 union specbinding. But only eval.c should access it. */
2826 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2827 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2828 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2829 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2830 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2831 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2832 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2833 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2834 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2839 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2841 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2842 void (*func
) (Lisp_Object
);
2846 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2847 void (*func
) (void *);
2851 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2856 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2857 void (*func
) (void);
2860 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2861 /* `where' is not used in the case of SPECPDL_LET. */
2862 Lisp_Object symbol
, old_value
, where
;
2865 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2866 bool_bf debug_on_exit
: 1;
2867 Lisp_Object function
;
2873 extern union specbinding
*specpdl
;
2874 extern union specbinding
*specpdl_ptr
;
2875 extern ptrdiff_t specpdl_size
;
2878 SPECPDL_INDEX (void)
2880 return specpdl_ptr
- specpdl
;
2883 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2884 control structures. A struct handler contains all the information needed to
2885 restore the state of the interpreter after a non-local jump.
2887 handler structures are chained together in a doubly linked list; the `next'
2888 member points to the next outer catchtag and the `nextfree' member points in
2889 the other direction to the next inner element (which is typically the next
2890 free element since we mostly use it on the deepest handler).
2892 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2893 member is TAG, and then unbinds to it. The `val' member is used to
2894 hold VAL while the stack is unwound; `val' is returned as the value
2897 All the other members are concerned with restoring the interpreter
2900 Members are volatile if their values need to survive _longjmp when
2901 a 'struct handler' is a local variable. */
2903 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2907 enum handlertype type
;
2908 Lisp_Object tag_or_ch
;
2910 struct handler
*next
;
2911 struct handler
*nextfree
;
2913 /* The bytecode interpreter can have several handlers active at the same
2914 time, so when we longjmp to one of them, it needs to know which handler
2915 this was and what was the corresponding internal state. This is stored
2916 here, and when we longjmp we make sure that handlerlist points to the
2918 Lisp_Object
*bytecode_top
;
2921 /* Most global vars are reset to their value via the specpdl mechanism,
2922 but a few others are handled by storing their value here. */
2923 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
2924 struct gcpro
*gcpro
;
2927 EMACS_INT lisp_eval_depth
;
2929 int poll_suppress_count
;
2930 int interrupt_input_blocked
;
2931 struct byte_stack
*byte_stack
;
2934 /* Fill in the components of c, and put it on the list. */
2935 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2936 if (handlerlist->nextfree) \
2937 (c) = handlerlist->nextfree; \
2940 (c) = xmalloc (sizeof (struct handler)); \
2941 (c)->nextfree = NULL; \
2942 handlerlist->nextfree = (c); \
2944 (c)->type = (handlertype); \
2945 (c)->tag_or_ch = (tag_ch_val); \
2947 (c)->next = handlerlist; \
2948 (c)->lisp_eval_depth = lisp_eval_depth; \
2949 (c)->pdlcount = SPECPDL_INDEX (); \
2950 (c)->poll_suppress_count = poll_suppress_count; \
2951 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2952 (c)->gcpro = gcprolist; \
2953 (c)->byte_stack = byte_stack_list; \
2957 extern Lisp_Object memory_signal_data
;
2959 /* An address near the bottom of the stack.
2960 Tells GC how to save a copy of the stack. */
2961 extern char *stack_bottom
;
2963 /* Check quit-flag and quit if it is non-nil.
2964 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2965 So the program needs to do QUIT at times when it is safe to quit.
2966 Every loop that might run for a long time or might not exit
2967 ought to do QUIT at least once, at a safe place.
2968 Unless that is impossible, of course.
2969 But it is very desirable to avoid creating loops where QUIT is impossible.
2971 Exception: if you set immediate_quit to true,
2972 then the handler that responds to the C-g does the quit itself.
2973 This is a good thing to do around a loop that has no side effects
2974 and (in particular) cannot call arbitrary Lisp code.
2976 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2977 a request to exit Emacs when it is safe to do. */
2979 extern void process_pending_signals (void);
2980 extern bool volatile pending_signals
;
2982 extern void process_quit_flag (void);
2985 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2986 process_quit_flag (); \
2987 else if (pending_signals) \
2988 process_pending_signals (); \
2992 /* True if ought to quit now. */
2994 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2996 extern Lisp_Object Vascii_downcase_table
;
2997 extern Lisp_Object Vascii_canon_table
;
2999 /* Structure for recording stack slots that need marking. */
3001 /* This is a chain of structures, each of which points at a Lisp_Object
3002 variable whose value should be marked in garbage collection.
3003 Normally every link of the chain is an automatic variable of a function,
3004 and its `val' points to some argument or local variable of the function.
3005 On exit to the function, the chain is set back to the value it had on entry.
3006 This way, no link remains in the chain when the stack frame containing the
3009 Every function that can call Feval must protect in this fashion all
3010 Lisp_Object variables whose contents will be used again. */
3012 extern struct gcpro
*gcprolist
;
3018 /* Address of first protected variable. */
3019 volatile Lisp_Object
*var
;
3021 /* Number of consecutive protected variables. */
3029 /* Values of GC_MARK_STACK during compilation:
3031 0 Use GCPRO as before
3032 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
3033 2 Mark the stack, and check that everything GCPRO'd is
3035 3 Mark using GCPRO's, mark stack last, and count how many
3036 dead objects are kept alive.
3038 Formerly, method 0 was used. Currently, method 1 is used unless
3039 otherwise specified by hand when building, e.g.,
3040 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
3041 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
3043 #define GC_USE_GCPROS_AS_BEFORE 0
3044 #define GC_MAKE_GCPROS_NOOPS 1
3045 #define GC_MARK_STACK_CHECK_GCPROS 2
3046 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
3048 #ifndef GC_MARK_STACK
3049 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
3052 /* Whether we do the stack marking manually. */
3053 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
3054 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
3057 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
3059 /* Do something silly with gcproN vars just so gcc shuts up. */
3060 /* You get warnings from MIPSPro... */
3062 #define GCPRO1(varname) ((void) gcpro1)
3063 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
3064 #define GCPRO3(varname1, varname2, varname3) \
3065 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
3066 #define GCPRO4(varname1, varname2, varname3, varname4) \
3067 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3068 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3069 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3070 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3071 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
3073 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
3074 #define UNGCPRO ((void) 0)
3076 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3080 #define GCPRO1(varname) \
3081 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3082 gcprolist = &gcpro1; }
3084 #define GCPRO2(varname1, varname2) \
3085 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3086 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3087 gcprolist = &gcpro2; }
3089 #define GCPRO3(varname1, varname2, varname3) \
3090 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3091 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3092 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3093 gcprolist = &gcpro3; }
3095 #define GCPRO4(varname1, varname2, varname3, varname4) \
3096 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3097 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3098 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3099 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3100 gcprolist = &gcpro4; }
3102 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3103 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3104 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3105 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3106 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3107 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3108 gcprolist = &gcpro5; }
3110 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3111 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3112 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3113 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3114 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3115 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3116 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3117 gcprolist = &gcpro6; }
3119 #define GCPRO7(a, b, c, d, e, f, g) \
3120 {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3121 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3122 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3123 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3124 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3125 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3126 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3127 gcprolist = &gcpro7; }
3129 #define UNGCPRO (gcprolist = gcpro1.next)
3133 extern int gcpro_level
;
3135 #define GCPRO1(varname) \
3136 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3137 gcpro1.level = gcpro_level++; \
3138 gcprolist = &gcpro1; }
3140 #define GCPRO2(varname1, varname2) \
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 gcpro2.level = gcpro_level++; \
3145 gcprolist = &gcpro2; }
3147 #define GCPRO3(varname1, varname2, varname3) \
3148 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3149 gcpro1.level = gcpro_level; \
3150 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3151 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3152 gcpro3.level = gcpro_level++; \
3153 gcprolist = &gcpro3; }
3155 #define GCPRO4(varname1, varname2, varname3, varname4) \
3156 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3157 gcpro1.level = gcpro_level; \
3158 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3159 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3160 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3161 gcpro4.level = gcpro_level++; \
3162 gcprolist = &gcpro4; }
3164 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3165 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3166 gcpro1.level = gcpro_level; \
3167 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3168 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3169 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3170 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3171 gcpro5.level = gcpro_level++; \
3172 gcprolist = &gcpro5; }
3174 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3175 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3176 gcpro1.level = gcpro_level; \
3177 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3178 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3179 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3180 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3181 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3182 gcpro6.level = gcpro_level++; \
3183 gcprolist = &gcpro6; }
3185 #define GCPRO7(a, b, c, d, e, f, g) \
3186 {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3187 gcpro1.level = gcpro_level; \
3188 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3189 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3190 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3191 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3192 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3193 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3194 gcpro7.level = gcpro_level++; \
3195 gcprolist = &gcpro7; }
3198 (--gcpro_level != gcpro1.level \
3200 : (void) (gcprolist = gcpro1.next))
3202 #endif /* DEBUG_GCPRO */
3203 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3206 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
3207 #define RETURN_UNGCPRO(expr) \
3210 Lisp_Object ret_ungc_val; \
3211 ret_ungc_val = (expr); \
3213 return ret_ungc_val; \
3217 /* Call staticpro (&var) to protect static variable `var'. */
3219 void staticpro (Lisp_Object
*);
3221 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
3222 meaning as in the DEFUN macro, and is used to construct a prototype. */
3223 /* We can use the same trick as in the DEFUN macro to generate the
3224 appropriate prototype. */
3225 #define EXFUN(fnname, maxargs) \
3226 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
3228 #include "globals.h"
3230 /* Forward declarations for prototypes. */
3234 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3237 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3239 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3240 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3243 /* Functions to modify hash tables. */
3246 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3248 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3252 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3254 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3257 /* Use these functions to set Lisp_Object
3258 or pointer slots of struct Lisp_Symbol. */
3261 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3263 XSYMBOL (sym
)->function
= function
;
3267 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3269 XSYMBOL (sym
)->plist
= plist
;
3273 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3275 XSYMBOL (sym
)->next
= next
;
3278 /* Buffer-local (also frame-local) variable access functions. */
3281 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3283 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3287 /* Set overlay's property list. */
3290 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3292 XOVERLAY (overlay
)->plist
= plist
;
3295 /* Get text properties of S. */
3298 string_intervals (Lisp_Object s
)
3300 return XSTRING (s
)->intervals
;
3303 /* Set text properties of S to I. */
3306 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3308 XSTRING (s
)->intervals
= i
;
3311 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3312 of setting slots directly. */
3315 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3317 XCHAR_TABLE (table
)->defalt
= val
;
3320 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3322 XCHAR_TABLE (table
)->purpose
= val
;
3325 /* Set different slots in (sub)character tables. */
3328 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3330 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3331 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3335 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3337 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3338 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3342 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3344 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3347 /* Defined in data.c. */
3348 extern Lisp_Object Qquote
, Qunbound
;
3349 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3350 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3351 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3352 extern Lisp_Object Qinvalid_read_syntax
;
3353 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3354 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3355 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3356 extern Lisp_Object Qtext_read_only
;
3357 extern Lisp_Object Qinteractive_form
;
3358 extern Lisp_Object Qcircular_list
;
3359 extern Lisp_Object Qsequencep
;
3360 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
3361 extern Lisp_Object Qfboundp
;
3363 extern Lisp_Object Qcdr
;
3365 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3367 extern Lisp_Object Qnumber_or_marker_p
;
3369 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3371 /* Defined in data.c. */
3372 extern Lisp_Object
indirect_function (Lisp_Object
);
3373 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3374 enum Arith_Comparison
{
3379 ARITH_LESS_OR_EQUAL
,
3382 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3383 enum Arith_Comparison comparison
);
3385 /* Convert the integer I to an Emacs representation, either the integer
3386 itself, or a cons of two or three integers, or if all else fails a float.
3387 I should not have side effects. */
3388 #define INTEGER_TO_CONS(i) \
3389 (! FIXNUM_OVERFLOW_P (i) \
3391 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3392 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3393 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3394 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3395 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3396 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3397 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3398 ? Fcons (make_number ((i) >> 16 >> 24), \
3399 Fcons (make_number ((i) >> 16 & 0xffffff), \
3400 make_number ((i) & 0xffff))) \
3403 /* Convert the Emacs representation CONS back to an integer of type
3404 TYPE, storing the result the variable VAR. Signal an error if CONS
3405 is not a valid representation or is out of range for TYPE. */
3406 #define CONS_TO_INTEGER(cons, type, var) \
3407 (TYPE_SIGNED (type) \
3408 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3409 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3410 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3411 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3413 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3414 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3415 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3417 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3418 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3419 extern void syms_of_data (void);
3420 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3422 /* Defined in cmds.c */
3423 extern void syms_of_cmds (void);
3424 extern void keys_of_cmds (void);
3426 /* Defined in coding.c. */
3427 extern Lisp_Object Qcharset
;
3428 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3429 ptrdiff_t, bool, bool, Lisp_Object
);
3430 extern void init_coding (void);
3431 extern void init_coding_once (void);
3432 extern void syms_of_coding (void);
3434 /* Defined in character.c. */
3435 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3436 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3437 extern void syms_of_character (void);
3439 /* Defined in charset.c. */
3440 extern void init_charset (void);
3441 extern void init_charset_once (void);
3442 extern void syms_of_charset (void);
3443 /* Structure forward declarations. */
3446 /* Defined in syntax.c. */
3447 extern void init_syntax_once (void);
3448 extern void syms_of_syntax (void);
3450 /* Defined in fns.c. */
3451 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3452 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3453 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3454 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3455 extern void sweep_weak_hash_tables (void);
3456 extern Lisp_Object Qcursor_in_echo_area
;
3457 extern Lisp_Object Qstring_lessp
;
3458 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3459 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3460 EMACS_UINT
sxhash (Lisp_Object
, int);
3461 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3462 Lisp_Object
, Lisp_Object
);
3463 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3464 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3466 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3467 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3468 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3469 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3470 ptrdiff_t, ptrdiff_t);
3471 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3472 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3473 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3474 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3475 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3476 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3477 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3478 extern void clear_string_char_byte_cache (void);
3479 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3480 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3481 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3482 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3483 extern void syms_of_fns (void);
3485 /* Defined in floatfns.c. */
3486 extern void syms_of_floatfns (void);
3487 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3489 /* Defined in fringe.c. */
3490 extern void syms_of_fringe (void);
3491 extern void init_fringe (void);
3492 #ifdef HAVE_WINDOW_SYSTEM
3493 extern void mark_fringe_data (void);
3494 extern void init_fringe_once (void);
3495 #endif /* HAVE_WINDOW_SYSTEM */
3497 /* Defined in image.c. */
3498 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3499 extern Lisp_Object QCconversion
;
3500 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3501 extern void reset_image_types (void);
3502 extern void syms_of_image (void);
3504 /* Defined in insdel.c. */
3505 extern Lisp_Object Qinhibit_modification_hooks
;
3506 extern Lisp_Object Qregion_extract_function
;
3507 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3508 extern _Noreturn
void buffer_overflow (void);
3509 extern void make_gap (ptrdiff_t);
3510 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3511 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3512 ptrdiff_t, bool, bool);
3513 extern int count_combining_before (const unsigned char *,
3514 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3515 extern int count_combining_after (const unsigned char *,
3516 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3517 extern void insert (const char *, ptrdiff_t);
3518 extern void insert_and_inherit (const char *, ptrdiff_t);
3519 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3521 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3522 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3523 ptrdiff_t, ptrdiff_t, bool);
3524 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3525 extern void insert_char (int);
3526 extern void insert_string (const char *);
3527 extern void insert_before_markers (const char *, ptrdiff_t);
3528 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3529 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3530 ptrdiff_t, ptrdiff_t,
3532 extern void del_range (ptrdiff_t, ptrdiff_t);
3533 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3534 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3535 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3536 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3537 ptrdiff_t, ptrdiff_t, bool);
3538 extern void modify_text (ptrdiff_t, ptrdiff_t);
3539 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3540 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3541 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3542 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3543 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3544 ptrdiff_t, ptrdiff_t);
3545 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3546 ptrdiff_t, ptrdiff_t);
3547 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3548 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3549 const char *, ptrdiff_t, ptrdiff_t, bool);
3550 extern void syms_of_insdel (void);
3552 /* Defined in dispnew.c. */
3553 #if (defined PROFILING \
3554 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3555 _Noreturn
void __executable_start (void);
3557 extern Lisp_Object Vwindow_system
;
3558 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3560 /* Defined in xdisp.c. */
3561 extern Lisp_Object Qinhibit_point_motion_hooks
;
3562 extern Lisp_Object Qinhibit_redisplay
;
3563 extern Lisp_Object Qmenu_bar_update_hook
;
3564 extern Lisp_Object Qwindow_scroll_functions
;
3565 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3566 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3567 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3568 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3569 extern Lisp_Object Qleft_margin
, Qright_margin
;
3570 extern Lisp_Object QCdata
, QCfile
;
3571 extern Lisp_Object QCmap
;
3572 extern Lisp_Object Qrisky_local_variable
;
3573 extern bool noninteractive_need_newline
;
3574 extern Lisp_Object echo_area_buffer
[2];
3575 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3576 extern void check_message_stack (void);
3577 extern void setup_echo_area_for_printing (int);
3578 extern bool push_message (void);
3579 extern void pop_message_unwind (void);
3580 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3581 extern void restore_message (void);
3582 extern Lisp_Object
current_message (void);
3583 extern void clear_message (bool, bool);
3584 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3585 extern void message1 (const char *);
3586 extern void message1_nolog (const char *);
3587 extern void message3 (Lisp_Object
);
3588 extern void message3_nolog (Lisp_Object
);
3589 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3590 extern void message_with_string (const char *, Lisp_Object
, int);
3591 extern void message_log_maybe_newline (void);
3592 extern void update_echo_area (void);
3593 extern void truncate_echo_area (ptrdiff_t);
3594 extern void redisplay (void);
3596 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3597 extern void syms_of_xdisp (void);
3598 extern void init_xdisp (void);
3599 extern Lisp_Object
safe_eval (Lisp_Object
);
3600 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3601 int *, int *, int *, int *, int *);
3603 /* Defined in xsettings.c. */
3604 extern void syms_of_xsettings (void);
3606 /* Defined in vm-limit.c. */
3607 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3609 /* Defined in alloc.c. */
3610 extern void check_pure_size (void);
3611 extern void free_misc (Lisp_Object
);
3612 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3613 extern void malloc_warning (const char *);
3614 extern _Noreturn
void memory_full (size_t);
3615 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3616 extern bool survives_gc_p (Lisp_Object
);
3617 extern void mark_object (Lisp_Object
);
3618 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3619 extern void refill_memory_reserve (void);
3621 extern const char *pending_malloc_warning
;
3622 extern Lisp_Object zero_vector
;
3623 extern Lisp_Object
*stack_base
;
3624 extern EMACS_INT consing_since_gc
;
3625 extern EMACS_INT gc_relative_threshold
;
3626 extern EMACS_INT memory_full_cons_threshold
;
3627 extern Lisp_Object
list1 (Lisp_Object
);
3628 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3629 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3630 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3631 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3633 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3634 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3636 /* Build a frequently used 2/3/4-integer lists. */
3639 list2i (EMACS_INT x
, EMACS_INT y
)
3641 return list2 (make_number (x
), make_number (y
));
3645 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3647 return list3 (make_number (x
), make_number (y
), make_number (w
));
3651 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3653 return list4 (make_number (x
), make_number (y
),
3654 make_number (w
), make_number (h
));
3657 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3658 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3659 extern _Noreturn
void string_overflow (void);
3660 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3661 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3662 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3663 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3665 /* Make unibyte string from C string when the length isn't known. */
3668 build_unibyte_string (const char *str
)
3670 return make_unibyte_string (str
, strlen (str
));
3673 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3674 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3675 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3676 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3677 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3678 extern Lisp_Object
make_specified_string (const char *,
3679 ptrdiff_t, ptrdiff_t, bool);
3680 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3681 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3683 /* Make a string allocated in pure space, use STR as string data. */
3686 build_pure_c_string (const char *str
)
3688 return make_pure_c_string (str
, strlen (str
));
3691 /* Make a string from the data at STR, treating it as multibyte if the
3695 build_string (const char *str
)
3697 return make_string (str
, strlen (str
));
3700 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3701 extern void make_byte_code (struct Lisp_Vector
*);
3702 extern Lisp_Object Qautomatic_gc
;
3703 extern Lisp_Object Qchar_table_extra_slots
;
3704 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3706 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3707 be sure that GC cannot happen until the vector is completely
3708 initialized. E.g. the following code is likely to crash:
3710 v = make_uninit_vector (3);
3712 ASET (v, 1, Ffunction_can_gc ());
3713 ASET (v, 2, obj1); */
3716 make_uninit_vector (ptrdiff_t size
)
3719 struct Lisp_Vector
*p
;
3721 p
= allocate_vector (size
);
3726 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3727 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3729 allocate_pseudovector \
3730 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3731 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3732 extern struct window
*allocate_window (void);
3733 extern struct frame
*allocate_frame (void);
3734 extern struct Lisp_Process
*allocate_process (void);
3735 extern struct terminal
*allocate_terminal (void);
3736 extern bool gc_in_progress
;
3737 extern bool abort_on_gc
;
3738 extern Lisp_Object
make_float (double);
3739 extern void display_malloc_warning (void);
3740 extern ptrdiff_t inhibit_garbage_collection (void);
3741 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3742 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3743 Lisp_Object
, Lisp_Object
);
3744 extern Lisp_Object
make_save_ptr (void *);
3745 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3746 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3747 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3749 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3750 extern void free_save_value (Lisp_Object
);
3751 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3752 extern void free_marker (Lisp_Object
);
3753 extern void free_cons (struct Lisp_Cons
*);
3754 extern void init_alloc_once (void);
3755 extern void init_alloc (void);
3756 extern void syms_of_alloc (void);
3757 extern struct buffer
* allocate_buffer (void);
3758 extern int valid_lisp_object_p (Lisp_Object
);
3759 extern int relocatable_string_data_p (const char *);
3760 #ifdef GC_CHECK_CONS_LIST
3761 extern void check_cons_list (void);
3763 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3767 /* Defined in ralloc.c. */
3768 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3769 extern void r_alloc_free (void **);
3770 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3771 extern void r_alloc_reset_variable (void **, void **);
3772 extern void r_alloc_inhibit_buffer_relocation (int);
3775 /* Defined in chartab.c. */
3776 extern Lisp_Object
copy_char_table (Lisp_Object
);
3777 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3779 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3780 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3782 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3783 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3784 Lisp_Object
, Lisp_Object
,
3785 Lisp_Object
, struct charset
*,
3786 unsigned, unsigned);
3787 extern Lisp_Object
uniprop_table (Lisp_Object
);
3788 extern void syms_of_chartab (void);
3790 /* Defined in print.c. */
3791 extern Lisp_Object Vprin1_to_string_buffer
;
3792 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3793 extern Lisp_Object Qstandard_output
;
3794 extern Lisp_Object Qexternal_debugging_output
;
3795 extern void temp_output_buffer_setup (const char *);
3796 extern int print_level
;
3797 extern Lisp_Object Qprint_escape_newlines
;
3798 extern void write_string (const char *, int);
3799 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3801 extern Lisp_Object internal_with_output_to_temp_buffer
3802 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3803 #define FLOAT_TO_STRING_BUFSIZE 350
3804 extern int float_to_string (char *, double);
3805 extern void init_print_once (void);
3806 extern void syms_of_print (void);
3808 /* Defined in doprnt.c. */
3809 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3811 extern ptrdiff_t esprintf (char *, char const *, ...)
3812 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3813 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3815 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3816 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3817 char const *, va_list)
3818 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3820 /* Defined in lread.c. */
3821 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3822 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3823 extern Lisp_Object Qlexical_binding
;
3824 extern Lisp_Object
check_obarray (Lisp_Object
);
3825 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3826 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3827 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3829 LOADHIST_ATTACH (Lisp_Object x
)
3832 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3834 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3835 Lisp_Object
*, Lisp_Object
, bool);
3836 extern Lisp_Object
string_to_number (char const *, int, bool);
3837 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3839 extern void dir_warning (const char *, Lisp_Object
);
3840 extern void init_obarray (void);
3841 extern void init_lread (void);
3842 extern void syms_of_lread (void);
3845 intern (const char *str
)
3847 return intern_1 (str
, strlen (str
));
3851 intern_c_string (const char *str
)
3853 return intern_c_string_1 (str
, strlen (str
));
3856 /* Defined in eval.c. */
3857 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3858 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3859 extern Lisp_Object Qand_rest
;
3860 extern Lisp_Object Vautoload_queue
;
3861 extern Lisp_Object Vsignaling_function
;
3862 extern Lisp_Object inhibit_lisp_code
;
3863 extern struct handler
*handlerlist
;
3865 /* To run a normal hook, use the appropriate function from the list below.
3866 The calling convention:
3868 if (!NILP (Vrun_hooks))
3869 call1 (Vrun_hooks, Qmy_funny_hook);
3871 should no longer be used. */
3872 extern Lisp_Object Vrun_hooks
;
3873 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3874 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3875 Lisp_Object (*funcall
)
3876 (ptrdiff_t nargs
, Lisp_Object
*args
));
3877 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3878 extern _Noreturn
void xsignal0 (Lisp_Object
);
3879 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3880 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3881 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3883 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3884 extern Lisp_Object
eval_sub (Lisp_Object form
);
3885 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3886 extern Lisp_Object
call0 (Lisp_Object
);
3887 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3888 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3889 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3890 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3891 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3892 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3893 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3894 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3895 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3896 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3897 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3898 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3899 extern Lisp_Object internal_condition_case_n
3900 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3901 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3902 extern void specbind (Lisp_Object
, Lisp_Object
);
3903 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3904 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3905 extern void record_unwind_protect_int (void (*) (int), int);
3906 extern void record_unwind_protect_void (void (*) (void));
3907 extern void record_unwind_protect_nothing (void);
3908 extern void clear_unwind_protect (ptrdiff_t);
3909 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3910 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3911 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3912 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3913 extern _Noreturn
void verror (const char *, va_list)
3914 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3915 extern void un_autoload (Lisp_Object
);
3916 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3917 extern void init_eval_once (void);
3918 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3919 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3920 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3921 extern void init_eval (void);
3922 extern void syms_of_eval (void);
3923 extern void unwind_body (Lisp_Object
);
3924 extern void record_in_backtrace (Lisp_Object function
,
3925 Lisp_Object
*args
, ptrdiff_t nargs
);
3926 extern void mark_specpdl (void);
3927 extern void get_backtrace (Lisp_Object array
);
3928 Lisp_Object
backtrace_top_function (void);
3929 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3930 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3933 /* Defined in editfns.c. */
3934 extern Lisp_Object Qfield
;
3935 extern void insert1 (Lisp_Object
);
3936 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3937 extern Lisp_Object
save_excursion_save (void);
3938 extern Lisp_Object
save_restriction_save (void);
3939 extern void save_excursion_restore (Lisp_Object
);
3940 extern void save_restriction_restore (Lisp_Object
);
3941 extern _Noreturn
void time_overflow (void);
3942 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3943 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3945 extern void init_editfns (void);
3946 extern void syms_of_editfns (void);
3947 extern void set_time_zone_rule (const char *);
3949 /* Defined in buffer.c. */
3950 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3951 extern _Noreturn
void nsberror (Lisp_Object
);
3952 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3953 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3954 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3955 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3956 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3957 extern bool overlay_touches_p (ptrdiff_t);
3958 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3959 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3960 extern void init_buffer_once (void);
3961 extern void init_buffer (int);
3962 extern void syms_of_buffer (void);
3963 extern void keys_of_buffer (void);
3965 /* Defined in marker.c. */
3967 extern ptrdiff_t marker_position (Lisp_Object
);
3968 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3969 extern void clear_charpos_cache (struct buffer
*);
3970 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3971 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3972 extern void unchain_marker (struct Lisp_Marker
*marker
);
3973 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3974 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3975 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3976 ptrdiff_t, ptrdiff_t);
3977 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3978 extern void syms_of_marker (void);
3980 /* Defined in fileio.c. */
3982 extern Lisp_Object Qfile_error
;
3983 extern Lisp_Object Qfile_notify_error
;
3984 extern Lisp_Object Qfile_exists_p
;
3985 extern Lisp_Object Qfile_directory_p
;
3986 extern Lisp_Object Qinsert_file_contents
;
3987 extern Lisp_Object Qfile_name_history
;
3988 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3989 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3990 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3992 extern void close_file_unwind (int);
3993 extern void fclose_unwind (void *);
3994 extern void restore_point_unwind (Lisp_Object
);
3995 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3996 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3997 extern bool internal_delete_file (Lisp_Object
);
3998 extern Lisp_Object
emacs_readlinkat (int, const char *);
3999 extern bool file_directory_p (const char *);
4000 extern bool file_accessible_directory_p (const char *);
4001 extern void init_fileio (void);
4002 extern void syms_of_fileio (void);
4003 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
4004 extern Lisp_Object Qdelete_file
;
4006 /* Defined in search.c. */
4007 extern void shrink_regexp_cache (void);
4008 extern void restore_search_regs (void);
4009 extern void record_unwind_save_match_data (void);
4010 struct re_registers
;
4011 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4012 struct re_registers
*,
4013 Lisp_Object
, bool, bool);
4014 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
4015 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4017 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
4018 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4019 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4020 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4021 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4022 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4024 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4025 ptrdiff_t, ptrdiff_t *);
4026 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4027 ptrdiff_t, ptrdiff_t *);
4028 extern void syms_of_search (void);
4029 extern void clear_regexp_cache (void);
4031 /* Defined in minibuf.c. */
4033 extern Lisp_Object Qcompletion_ignore_case
;
4034 extern Lisp_Object Vminibuffer_list
;
4035 extern Lisp_Object last_minibuf_string
;
4036 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4037 extern void init_minibuf_once (void);
4038 extern void syms_of_minibuf (void);
4040 /* Defined in callint.c. */
4042 extern Lisp_Object Qminus
, Qplus
;
4043 extern Lisp_Object Qprogn
;
4044 extern Lisp_Object Qwhen
;
4045 extern Lisp_Object Qmouse_leave_buffer_hook
;
4046 extern void syms_of_callint (void);
4048 /* Defined in casefiddle.c. */
4050 extern Lisp_Object Qidentity
;
4051 extern void syms_of_casefiddle (void);
4052 extern void keys_of_casefiddle (void);
4054 /* Defined in casetab.c. */
4056 extern void init_casetab_once (void);
4057 extern void syms_of_casetab (void);
4059 /* Defined in keyboard.c. */
4061 extern Lisp_Object echo_message_buffer
;
4062 extern struct kboard
*echo_kboard
;
4063 extern void cancel_echoing (void);
4064 extern Lisp_Object Qdisabled
, QCfilter
;
4065 extern Lisp_Object Qup
, Qdown
;
4066 extern Lisp_Object last_undo_boundary
;
4067 extern bool input_pending
;
4068 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4069 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4070 extern void discard_mouse_events (void);
4072 void handle_input_available_signal (int);
4074 extern Lisp_Object pending_funcalls
;
4075 extern bool detect_input_pending (void);
4076 extern bool detect_input_pending_ignore_squeezables (void);
4077 extern bool detect_input_pending_run_timers (bool);
4078 extern void safe_run_hooks (Lisp_Object
);
4079 extern void cmd_error_internal (Lisp_Object
, const char *);
4080 extern Lisp_Object
command_loop_1 (void);
4081 extern Lisp_Object
read_menu_command (void);
4082 extern Lisp_Object
recursive_edit_1 (void);
4083 extern void record_auto_save (void);
4084 extern void force_auto_save_soon (void);
4085 extern void init_keyboard (void);
4086 extern void syms_of_keyboard (void);
4087 extern void keys_of_keyboard (void);
4089 /* Defined in indent.c. */
4090 extern ptrdiff_t current_column (void);
4091 extern void invalidate_current_column (void);
4092 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4093 extern void syms_of_indent (void);
4095 /* Defined in frame.c. */
4096 extern Lisp_Object Qonly
, Qnone
;
4097 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4098 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4099 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4100 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4101 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4102 extern void frames_discard_buffer (Lisp_Object
);
4103 extern void syms_of_frame (void);
4105 /* Defined in emacs.c. */
4106 extern char **initial_argv
;
4107 extern int initial_argc
;
4108 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4109 extern bool display_arg
;
4111 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4112 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4113 extern Lisp_Object Qfile_name_handler_alist
;
4114 extern _Noreturn
void terminate_due_to_signal (int, int);
4115 extern Lisp_Object Qkill_emacs
;
4117 extern Lisp_Object Vlibrary_cache
;
4120 void fixup_locale (void);
4121 void synchronize_system_messages_locale (void);
4122 void synchronize_system_time_locale (void);
4124 INLINE
void fixup_locale (void) {}
4125 INLINE
void synchronize_system_messages_locale (void) {}
4126 INLINE
void synchronize_system_time_locale (void) {}
4128 extern void shut_down_emacs (int, Lisp_Object
);
4130 /* True means don't do interactive redisplay and don't change tty modes. */
4131 extern bool noninteractive
;
4133 /* True means remove site-lisp directories from load-path. */
4134 extern bool no_site_lisp
;
4136 /* Pipe used to send exit notification to the daemon parent at
4138 extern int daemon_pipe
[2];
4139 #define IS_DAEMON (daemon_pipe[1] != 0)
4141 /* True if handling a fatal error already. */
4142 extern bool fatal_error_in_progress
;
4144 /* True means don't do use window-system-specific display code. */
4145 extern bool inhibit_window_system
;
4146 /* True means that a filter or a sentinel is running. */
4147 extern bool running_asynch_code
;
4149 /* Defined in process.c. */
4150 extern Lisp_Object QCtype
, Qlocal
;
4151 extern void kill_buffer_processes (Lisp_Object
);
4152 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4153 struct Lisp_Process
*, int);
4154 /* Max value for the first argument of wait_reading_process_output. */
4155 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4156 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4157 The bug merely causes a bogus warning, but the warning is annoying. */
4158 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4160 # define WAIT_READING_MAX INTMAX_MAX
4162 extern void add_keyboard_wait_descriptor (int);
4163 extern void delete_keyboard_wait_descriptor (int);
4165 extern void add_gpm_wait_descriptor (int);
4166 extern void delete_gpm_wait_descriptor (int);
4168 extern void init_process_emacs (void);
4169 extern void syms_of_process (void);
4170 extern void setup_process_coding_systems (Lisp_Object
);
4172 /* Defined in callproc.c. */
4176 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4177 extern void init_callproc_1 (void);
4178 extern void init_callproc (void);
4179 extern void set_initial_environment (void);
4180 extern void syms_of_callproc (void);
4182 /* Defined in doc.c. */
4183 extern Lisp_Object Qfunction_documentation
;
4184 extern Lisp_Object
read_doc_string (Lisp_Object
);
4185 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4186 extern void syms_of_doc (void);
4187 extern int read_bytecode_char (bool);
4189 /* Defined in bytecode.c. */
4190 extern void syms_of_bytecode (void);
4191 extern struct byte_stack
*byte_stack_list
;
4193 extern void mark_byte_stack (void);
4195 extern void unmark_byte_stack (void);
4196 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4197 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4199 /* Defined in macros.c. */
4200 extern void init_macros (void);
4201 extern void syms_of_macros (void);
4203 /* Defined in undo.c. */
4204 extern Lisp_Object Qapply
;
4205 extern Lisp_Object Qinhibit_read_only
;
4206 extern void truncate_undo_list (struct buffer
*);
4207 extern void record_insert (ptrdiff_t, ptrdiff_t);
4208 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4209 extern void record_first_change (void);
4210 extern void record_change (ptrdiff_t, ptrdiff_t);
4211 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4212 Lisp_Object
, Lisp_Object
,
4214 extern void syms_of_undo (void);
4215 /* Defined in textprop.c. */
4216 extern Lisp_Object Qmouse_face
;
4217 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
4218 extern Lisp_Object Qminibuffer_prompt
;
4220 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4222 /* Defined in menu.c. */
4223 extern void syms_of_menu (void);
4225 /* Defined in xmenu.c. */
4226 extern void syms_of_xmenu (void);
4228 /* Defined in termchar.h. */
4229 struct tty_display_info
;
4231 /* Defined in termhooks.h. */
4234 /* Defined in sysdep.c. */
4235 #ifndef HAVE_GET_CURRENT_DIR_NAME
4236 extern char *get_current_dir_name (void);
4238 extern void stuff_char (char c
);
4239 extern void init_foreground_group (void);
4240 extern void sys_subshell (void);
4241 extern void sys_suspend (void);
4242 extern void discard_tty_input (void);
4243 extern void init_sys_modes (struct tty_display_info
*);
4244 extern void reset_sys_modes (struct tty_display_info
*);
4245 extern void init_all_sys_modes (void);
4246 extern void reset_all_sys_modes (void);
4247 extern void child_setup_tty (int);
4248 extern void setup_pty (int);
4249 extern int set_window_size (int, int, int);
4250 extern EMACS_INT
get_random (void);
4251 extern void seed_random (void *, ptrdiff_t);
4252 extern void init_random (void);
4253 extern void emacs_backtrace (int);
4254 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4255 extern int emacs_open (const char *, int, int);
4256 extern int emacs_pipe (int[2]);
4257 extern int emacs_close (int);
4258 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4259 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4260 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4261 extern void emacs_perror (char const *);
4263 extern void unlock_all_files (void);
4264 extern void lock_file (Lisp_Object
);
4265 extern void unlock_file (Lisp_Object
);
4266 extern void unlock_buffer (struct buffer
*);
4267 extern void syms_of_filelock (void);
4269 /* Defined in sound.c. */
4270 extern void syms_of_sound (void);
4272 /* Defined in category.c. */
4273 extern void init_category_once (void);
4274 extern Lisp_Object
char_category_set (int);
4275 extern void syms_of_category (void);
4277 /* Defined in ccl.c. */
4278 extern void syms_of_ccl (void);
4280 /* Defined in dired.c. */
4281 extern void syms_of_dired (void);
4282 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4283 Lisp_Object
, Lisp_Object
,
4286 /* Defined in term.c. */
4287 extern int *char_ins_del_vector
;
4288 extern void syms_of_term (void);
4289 extern _Noreturn
void fatal (const char *msgid
, ...)
4290 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4292 /* Defined in terminal.c. */
4293 extern void syms_of_terminal (void);
4295 /* Defined in font.c. */
4296 extern void syms_of_font (void);
4297 extern void init_font (void);
4299 #ifdef HAVE_WINDOW_SYSTEM
4300 /* Defined in fontset.c. */
4301 extern void syms_of_fontset (void);
4303 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4304 extern Lisp_Object Qfont_param
;
4307 /* Defined in gfilenotify.c */
4308 #ifdef HAVE_GFILENOTIFY
4309 extern void globals_of_gfilenotify (void);
4310 extern void syms_of_gfilenotify (void);
4313 /* Defined in inotify.c */
4315 extern void syms_of_inotify (void);
4318 #ifdef HAVE_W32NOTIFY
4319 /* Defined on w32notify.c. */
4320 extern void syms_of_w32notify (void);
4323 /* Defined in xfaces.c. */
4324 extern Lisp_Object Qdefault
, Qfringe
;
4325 extern Lisp_Object Qscroll_bar
, Qcursor
;
4326 extern Lisp_Object Qmode_line_inactive
;
4327 extern Lisp_Object Qface
;
4328 extern Lisp_Object Qnormal
;
4329 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4330 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4331 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4332 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4333 extern Lisp_Object Qoblique
, Qitalic
;
4334 extern Lisp_Object Vface_alternative_font_family_alist
;
4335 extern Lisp_Object Vface_alternative_font_registry_alist
;
4336 extern void syms_of_xfaces (void);
4338 #ifdef HAVE_X_WINDOWS
4339 /* Defined in xfns.c. */
4340 extern void syms_of_xfns (void);
4342 /* Defined in xsmfns.c. */
4343 extern void syms_of_xsmfns (void);
4345 /* Defined in xselect.c. */
4346 extern void syms_of_xselect (void);
4348 /* Defined in xterm.c. */
4349 extern void syms_of_xterm (void);
4350 #endif /* HAVE_X_WINDOWS */
4352 #ifdef HAVE_WINDOW_SYSTEM
4353 /* Defined in xterm.c, nsterm.m, w32term.c. */
4354 extern char *x_get_keysym_name (int);
4355 #endif /* HAVE_WINDOW_SYSTEM */
4358 /* Defined in xml.c. */
4359 extern void syms_of_xml (void);
4360 extern void xml_cleanup_parser (void);
4364 /* Defined in decompress.c. */
4365 extern void syms_of_decompress (void);
4369 /* Defined in dbusbind.c. */
4370 void syms_of_dbusbind (void);
4374 /* Defined in profiler.c. */
4375 extern bool profiler_memory_running
;
4376 extern void malloc_probe (size_t);
4377 extern void syms_of_profiler (void);
4381 /* Defined in msdos.c, w32.c. */
4382 extern char *emacs_root_dir (void);
4385 /* True means ^G can quit instantly. */
4386 extern bool immediate_quit
;
4388 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4389 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4390 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4391 extern void xfree (void *);
4392 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4393 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4394 ATTRIBUTE_ALLOC_SIZE ((2,3));
4395 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4397 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4398 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4399 extern void dupstring (char **, char const *);
4400 extern void xputenv (const char *);
4402 extern char *egetenv (const char *);
4404 /* Copy Lisp string to temporary (allocated on stack) C string. */
4406 #define xlispstrdupa(string) \
4407 memcpy (alloca (SBYTES (string) + 1), \
4408 SSDATA (string), SBYTES (string) + 1)
4410 /* Set up the name of the machine we're running on. */
4411 extern void init_system_name (void);
4413 /* Return the absolute value of X. X should be a signed integer
4414 expression without side effects, and X's absolute value should not
4415 exceed the maximum for its promoted type. This is called 'eabs'
4416 because 'abs' is reserved by the C standard. */
4417 #define eabs(x) ((x) < 0 ? -(x) : (x))
4419 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4422 #define make_fixnum_or_float(val) \
4423 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4425 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4426 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4428 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4430 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4432 #define USE_SAFE_ALLOCA \
4433 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4435 /* SAFE_ALLOCA allocates a simple buffer. */
4437 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4439 : (sa_must_free = true, record_xmalloc (size)))
4441 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4442 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4443 positive. The code is tuned for MULTIPLIER being a constant. */
4445 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4447 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4448 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4451 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4452 sa_must_free = true; \
4453 record_unwind_protect_ptr (xfree, buf); \
4457 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4459 #define SAFE_FREE() \
4461 if (sa_must_free) { \
4462 sa_must_free = false; \
4463 unbind_to (sa_count, Qnil); \
4468 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4470 #define SAFE_ALLOCA_LISP(buf, nelt) \
4472 if ((nelt) < MAX_ALLOCA / word_size) \
4473 (buf) = alloca ((nelt) * word_size); \
4474 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4477 (buf) = xmalloc ((nelt) * word_size); \
4478 arg_ = make_save_memory (buf, nelt); \
4479 sa_must_free = true; \
4480 record_unwind_protect (free_save_value, arg_); \
4483 memory_full (SIZE_MAX); \
4486 /* Loop over all tails of a list, checking for cycles.
4487 FIXME: Make tortoise and n internal declarations.
4488 FIXME: Unroll the loop body so we don't need `n'. */
4489 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4490 for ((tortoise) = (hare) = (list), (n) = true; \
4492 (hare = XCDR (hare), (n) = !(n), \
4494 ? (EQ (hare, tortoise) \
4495 ? xsignal1 (Qcircular_list, list) \
4497 /* Move tortoise before the next iteration, in case */ \
4498 /* the next iteration does an Fsetcdr. */ \
4499 : (void) ((tortoise) = XCDR (tortoise)))))
4501 /* Do a `for' loop over alist values. */
4503 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4504 for ((list_var) = (head_var); \
4505 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4506 (list_var) = XCDR (list_var))
4508 /* Check whether it's time for GC, and run it if so. */
4513 if ((consing_since_gc
> gc_cons_threshold
4514 && consing_since_gc
> gc_relative_threshold
)
4515 || (!NILP (Vmemory_full
)
4516 && consing_since_gc
> memory_full_cons_threshold
))
4517 Fgarbage_collect ();
4521 functionp (Lisp_Object object
)
4523 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4525 object
= Findirect_function (object
, Qt
);
4527 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4529 /* Autoloaded symbols are functions, except if they load
4530 macros or keymaps. */
4532 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4533 object
= XCDR (object
);
4535 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4540 return XSUBR (object
)->max_args
!= UNEVALLED
;
4541 else if (COMPILEDP (object
))
4543 else if (CONSP (object
))
4545 Lisp_Object car
= XCAR (object
);
4546 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4554 #endif /* EMACS_LISP_H */