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 /* On AIX 7.1 ENUMABLE should return true when possible, otherwise the
63 linker can optimize the symbols away, making it harder to debug.
64 This was discovered only late in the release process, so to play it
65 safe for now, non-AIX platforms do not use enums for debugging symbols.
66 FIXME: remove this comment and the following four lines of code. */
69 # define ENUMABLE(val) 0
72 #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val };
73 #if defined MAIN_PROGRAM
74 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
75 # define DEFINE_GDB_SYMBOL_END(id) = id;
77 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
78 # define DEFINE_GDB_SYMBOL_END(val)
81 /* The ubiquitous max and min macros. */
84 #define max(a, b) ((a) > (b) ? (a) : (b))
85 #define min(a, b) ((a) < (b) ? (a) : (b))
87 /* Number of elements in an array. */
88 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
90 /* Number of bits in a Lisp_Object tag. */
91 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
93 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
95 /* The number of bits needed in an EMACS_INT over and above the number
96 of bits in a pointer. This is 0 on systems where:
97 1. We can specify multiple-of-8 alignment on static variables.
98 2. We know malloc returns a multiple of 8. */
99 #if (defined alignas \
100 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
101 || defined DARWIN_OS || defined __sun || defined __MINGW32__))
102 # define NONPOINTER_BITS 0
104 # define NONPOINTER_BITS GCTYPEBITS
107 /* EMACS_INT - signed integer wide enough to hold an Emacs value
108 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
109 pI - printf length modifier for EMACS_INT
110 EMACS_UINT - unsigned variant of EMACS_INT */
111 #ifndef EMACS_INT_MAX
113 # error "INTPTR_MAX misconfigured"
114 # elif INTPTR_MAX <= INT_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
115 typedef int EMACS_INT
;
116 typedef unsigned int EMACS_UINT
;
117 # define EMACS_INT_MAX INT_MAX
119 # elif INTPTR_MAX <= LONG_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
120 typedef long int EMACS_INT
;
121 typedef unsigned long EMACS_UINT
;
122 # define EMACS_INT_MAX LONG_MAX
124 /* Check versus LLONG_MAX, not LLONG_MAX >> NONPOINTER_BITS.
125 In theory this is not safe, but in practice it seems to be OK. */
126 # elif INTPTR_MAX <= LLONG_MAX
127 typedef long long int EMACS_INT
;
128 typedef unsigned long long int EMACS_UINT
;
129 # define EMACS_INT_MAX LLONG_MAX
132 # error "INTPTR_MAX too large"
136 /* Number of bits to put in each character in the internal representation
137 of bool vectors. This should not vary across implementations. */
138 enum { BOOL_VECTOR_BITS_PER_CHAR
=
139 #define BOOL_VECTOR_BITS_PER_CHAR 8
140 BOOL_VECTOR_BITS_PER_CHAR
143 /* An unsigned integer type representing a fixed-length bit sequence,
144 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
145 for speed, but it is unsigned char on weird platforms. */
146 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
147 typedef size_t bits_word
;
148 # define BITS_WORD_MAX SIZE_MAX
149 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
151 typedef unsigned char bits_word
;
152 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
153 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
155 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
157 /* Number of bits in some machine integer types. */
160 BITS_PER_CHAR
= CHAR_BIT
,
161 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
162 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
163 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
166 /* printmax_t and uprintmax_t are types for printing large integers.
167 These are the widest integers that are supported for printing.
168 pMd etc. are conversions for printing them.
169 On C99 hosts, there's no problem, as even the widest integers work.
170 Fall back on EMACS_INT on pre-C99 hosts. */
172 typedef intmax_t printmax_t
;
173 typedef uintmax_t uprintmax_t
;
177 typedef EMACS_INT printmax_t
;
178 typedef EMACS_UINT uprintmax_t
;
183 /* Use pD to format ptrdiff_t values, which suffice for indexes into
184 buffers and strings. Emacs never allocates objects larger than
185 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
186 In C99, pD can always be "t"; configure it here for the sake of
187 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
188 #if PTRDIFF_MAX == INT_MAX
190 #elif PTRDIFF_MAX == LONG_MAX
192 #elif PTRDIFF_MAX == LLONG_MAX
198 /* Extra internal type checking? */
200 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
201 'assume (COND)'. COND should be free of side effects, as it may or
202 may not be evaluated.
204 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
205 defined and suppress_checking is false, and does nothing otherwise.
206 Emacs dies if COND is checked and is false. The suppress_checking
207 variable is initialized to 0 in alloc.c. Set it to 1 using a
208 debugger to temporarily disable aborting on detected internal
209 inconsistencies or error conditions.
211 In some cases, a good compiler may be able to optimize away the
212 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
213 uses eassert to test STRINGP (x), but a particular use of XSTRING
214 is invoked only after testing that STRINGP (x) is true, making the
217 eassume is like eassert except that it also causes the compiler to
218 assume that COND is true afterwards, regardless of whether runtime
219 checking is enabled. This can improve performance in some cases,
220 though it can degrade performance in others. It's often suboptimal
221 for COND to call external functions or access volatile storage. */
223 #ifndef ENABLE_CHECKING
224 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
225 # define eassume(cond) assume (cond)
226 #else /* ENABLE_CHECKING */
228 extern _Noreturn
void die (const char *, const char *, int);
230 extern bool suppress_checking EXTERNALLY_VISIBLE
;
232 # define eassert(cond) \
233 (suppress_checking || (cond) \
235 : die (# cond, __FILE__, __LINE__))
236 # define eassume(cond) \
241 : die (# cond, __FILE__, __LINE__))
242 #endif /* ENABLE_CHECKING */
245 /* Use the configure flag --enable-check-lisp-object-type to make
246 Lisp_Object use a struct type instead of the default int. The flag
247 causes CHECK_LISP_OBJECT_TYPE to be defined. */
249 /***** Select the tagging scheme. *****/
250 /* The following option controls the tagging scheme:
251 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
252 always 0, and we can thus use them to hold tag bits, without
253 restricting our addressing space.
255 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
256 restricting our possible address range.
258 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
259 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
260 on the few static Lisp_Objects used: all the defsubr as well
261 as the two special buffers buffer_defaults and buffer_local_symbols. */
265 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
266 integer constant, for MSVC. */
267 #define GCALIGNMENT 8
269 /* Number of bits in a Lisp_Object value, not counting the tag. */
270 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
272 /* Number of bits in a Lisp fixnum tag. */
273 INTTYPEBITS
= GCTYPEBITS
- 1,
275 /* Number of bits in a Lisp fixnum value, not counting the tag. */
276 FIXNUM_BITS
= VALBITS
+ 1
279 #if GCALIGNMENT != 1 << GCTYPEBITS
280 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
283 /* The maximum value that can be stored in a EMACS_INT, assuming all
284 bits other than the type bits contribute to a nonnegative signed value.
285 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
286 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
288 /* Whether the least-significant bits of an EMACS_INT contain the tag.
289 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
290 a. unnecessary, because the top bits of an EMACS_INT are unused, and
291 b. slower, because it typically requires extra masking.
292 So, USE_LSB_TAG is true only on hosts where it might be useful. */
293 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
294 #define USE_LSB_TAG (EMACS_INT_MAX >> GCTYPEBITS < INTPTR_MAX)
295 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
297 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
298 # error "USE_LSB_TAG not supported on this platform; please report this." \
299 "Try 'configure --with-wide-int' to work around the problem."
304 # define alignas(alignment) /* empty */
306 # error "USE_LSB_TAG requires alignas"
311 /* Some operations are so commonly executed that they are implemented
312 as macros, not functions, because otherwise runtime performance would
313 suffer too much when compiling with GCC without optimization.
314 There's no need to inline everything, just the operations that
315 would otherwise cause a serious performance problem.
317 For each such operation OP, define a macro lisp_h_OP that contains
318 the operation's implementation. That way, OP can be implemented
319 via a macro definition like this:
321 #define OP(x) lisp_h_OP (x)
323 and/or via a function definition like this:
325 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
327 which macro-expands to this:
329 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
331 without worrying about the implementations diverging, since
332 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
333 are intended to be private to this include file, and should not be
336 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
337 functions, once most developers have access to GCC 4.8 or later and
338 can use "gcc -Og" to debug. Maybe in the year 2016. See
341 Commentary for these macros can be found near their corresponding
344 #if CHECK_LISP_OBJECT_TYPE
345 # define lisp_h_XLI(o) ((o).i)
346 # define lisp_h_XIL(i) ((Lisp_Object) { i })
348 # define lisp_h_XLI(o) (o)
349 # define lisp_h_XIL(i) (i)
351 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
352 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
353 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
354 #define lisp_h_CHECK_TYPE(ok, Qxxxp, x) \
355 ((ok) ? (void) 0 : (void) wrong_type_argument (Qxxxp, x))
356 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
357 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
358 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
359 #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0)
360 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
361 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
362 #define lisp_h_NILP(x) EQ (x, Qnil)
363 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
364 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
365 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
366 #define lisp_h_SYMBOL_VAL(sym) \
367 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
368 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
369 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
370 #define lisp_h_XCAR(c) XCONS (c)->car
371 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
372 #define lisp_h_XCONS(a) \
373 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
374 #define lisp_h_XHASH(a) XUINT (a)
375 #define lisp_h_XPNTR(a) ((void *) (intptr_t) (XLI (a) & VALMASK))
376 #define lisp_h_XSYMBOL(a) \
377 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
378 #ifndef GC_CHECK_CONS_LIST
379 # define lisp_h_check_cons_list() ((void) 0)
382 # define lisp_h_make_number(n) \
383 XIL ((EMACS_INT) ((EMACS_UINT) (n) << INTTYPEBITS))
384 # define lisp_h_XFASTINT(a) XINT (a)
385 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
386 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
387 # define lisp_h_XUNTAG(a, type) ((void *) (XLI (a) - (type)))
390 /* When compiling via gcc -O0, define the key operations as macros, as
391 Emacs is too slow otherwise. To disable this optimization, compile
392 with -DINLINING=false. */
393 #if (defined __NO_INLINE__ \
394 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
395 && ! (defined INLINING && ! INLINING))
396 # define XLI(o) lisp_h_XLI (o)
397 # define XIL(i) lisp_h_XIL (i)
398 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
399 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
400 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
401 # define CHECK_TYPE(ok, Qxxxp, x) lisp_h_CHECK_TYPE (ok, Qxxxp, x)
402 # define CONSP(x) lisp_h_CONSP (x)
403 # define EQ(x, y) lisp_h_EQ (x, y)
404 # define FLOATP(x) lisp_h_FLOATP (x)
405 # define INTEGERP(x) lisp_h_INTEGERP (x)
406 # define MARKERP(x) lisp_h_MARKERP (x)
407 # define MISCP(x) lisp_h_MISCP (x)
408 # define NILP(x) lisp_h_NILP (x)
409 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
410 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
411 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
412 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
413 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
414 # define XCAR(c) lisp_h_XCAR (c)
415 # define XCDR(c) lisp_h_XCDR (c)
416 # define XCONS(a) lisp_h_XCONS (a)
417 # define XHASH(a) lisp_h_XHASH (a)
418 # define XPNTR(a) lisp_h_XPNTR (a)
419 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
420 # ifndef GC_CHECK_CONS_LIST
421 # define check_cons_list() lisp_h_check_cons_list ()
424 # define make_number(n) lisp_h_make_number (n)
425 # define XFASTINT(a) lisp_h_XFASTINT (a)
426 # define XINT(a) lisp_h_XINT (a)
427 # define XTYPE(a) lisp_h_XTYPE (a)
428 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
432 /* Define NAME as a lisp.h inline function that returns TYPE and has
433 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
434 ARGS should be parenthesized. Implement the function by calling
436 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
437 INLINE type (name) argdecls { return lisp_h_##name args; }
439 /* like LISP_MACRO_DEFUN, except NAME returns void. */
440 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
441 INLINE void (name) argdecls { lisp_h_##name args; }
444 /* Define the fundamental Lisp data structures. */
446 /* This is the set of Lisp data types. If you want to define a new
447 data type, read the comments after Lisp_Fwd_Type definition
450 /* Lisp integers use 2 tags, to give them one extra bit, thus
451 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
452 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
453 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
455 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
456 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
457 vociferously about them. */
458 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
459 || (defined __SUNPRO_C && __STDC__))
460 #define ENUM_BF(TYPE) unsigned int
462 #define ENUM_BF(TYPE) enum TYPE
468 /* Integer. XINT (obj) is the integer value. */
470 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
472 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
475 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
476 whose first member indicates the subtype. */
479 /* String. XSTRING (object) points to a struct Lisp_String.
480 The length of the string, and its contents, are stored therein. */
481 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
483 /* Vector of Lisp objects, or something resembling it.
484 XVECTOR (object) points to a struct Lisp_Vector, which contains
485 the size and contents. The size field also contains the type
486 information, if it's not a real vector object. */
489 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
495 /* This is the set of data types that share a common structure.
496 The first member of the structure is a type code from this set.
497 The enum values are arbitrary, but we'll use large numbers to make it
498 more likely that we'll spot the error if a random word in memory is
499 mistakenly interpreted as a Lisp_Misc. */
502 Lisp_Misc_Free
= 0x5eab,
505 Lisp_Misc_Save_Value
,
506 /* Currently floats are not a misc type,
507 but let's define this in case we want to change that. */
509 /* This is not a type code. It is for range checking. */
513 /* These are the types of forwarding objects used in the value slot
514 of symbols for special built-in variables whose value is stored in
518 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
519 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
520 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
521 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
522 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
525 /* If you want to define a new Lisp data type, here are some
526 instructions. See the thread at
527 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
530 First, there are already a couple of Lisp types that can be used if
531 your new type does not need to be exposed to Lisp programs nor
532 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
533 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
534 is suitable for temporarily stashing away pointers and integers in
535 a Lisp object. The latter is useful for vector-like Lisp objects
536 that need to be used as part of other objects, but which are never
537 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
540 These two types don't look pretty when printed, so they are
541 unsuitable for Lisp objects that can be exposed to users.
543 To define a new data type, add one more Lisp_Misc subtype or one
544 more pseudovector subtype. Pseudovectors are more suitable for
545 objects with several slots that need to support fast random access,
546 while Lisp_Misc types are for everything else. A pseudovector object
547 provides one or more slots for Lisp objects, followed by struct
548 members that are accessible only from C. A Lisp_Misc object is a
549 wrapper for a C struct that can contain anything you like.
551 Explicit freeing is discouraged for Lisp objects in general. But if
552 you really need to exploit this, use Lisp_Misc (check free_misc in
553 alloc.c to see why). There is no way to free a vectorlike object.
555 To add a new pseudovector type, extend the pvec_type enumeration;
556 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
558 For a Lisp_Misc, you will also need to add your entry to union
559 Lisp_Misc (but make sure the first word has the same structure as
560 the others, starting with a 16-bit member of the Lisp_Misc_Type
561 enumeration and a 1-bit GC markbit) and make sure the overall size
562 of the union is not increased by your addition.
564 For a new pseudovector, it's highly desirable to limit the size
565 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
566 Otherwise you will need to change sweep_vectors (also in alloc.c).
568 Then you will need to add switch branches in print.c (in
569 print_object, to print your object, and possibly also in
570 print_preprocess) and to alloc.c, to mark your object (in
571 mark_object) and to free it (in gc_sweep). The latter is also the
572 right place to call any code specific to your data type that needs
573 to run when the object is recycled -- e.g., free any additional
574 resources allocated for it that are not Lisp objects. You can even
575 make a pointer to the function that frees the resources a slot in
576 your object -- this way, the same object could be used to represent
577 several disparate C structures. */
579 #ifdef CHECK_LISP_OBJECT_TYPE
581 typedef struct { EMACS_INT i
; } Lisp_Object
;
583 #define LISP_INITIALLY_ZERO {0}
585 #undef CHECK_LISP_OBJECT_TYPE
586 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
587 #else /* CHECK_LISP_OBJECT_TYPE */
589 /* If a struct type is not wanted, define Lisp_Object as just a number. */
591 typedef EMACS_INT Lisp_Object
;
592 #define LISP_INITIALLY_ZERO 0
593 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
594 #endif /* CHECK_LISP_OBJECT_TYPE */
596 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
597 At the machine level, these operations are no-ops. */
598 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
599 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
601 /* In the size word of a vector, this bit means the vector has been marked. */
603 #define ARRAY_MARK_FLAG_val PTRDIFF_MIN
604 #if ENUMABLE (ARRAY_MARK_FLAG_val)
605 DEFINE_GDB_SYMBOL_ENUM (ARRAY_MARK_FLAG
)
607 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
608 # define ARRAY_MARK_FLAG ARRAY_MARK_FLAG_val
609 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
612 /* In the size word of a struct Lisp_Vector, this bit means it's really
613 some other vector-like object. */
614 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
615 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
616 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
618 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
619 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
620 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
623 /* In a pseudovector, the size field actually contains a word with one
624 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
625 with PVEC_TYPE_MASK to indicate the actual type. */
637 PVEC_WINDOW_CONFIGURATION
,
640 /* These should be last, check internal_equal to see why. */
644 PVEC_FONT
/* Should be last because it's used for range checking. */
649 /* For convenience, we also store the number of elements in these bits.
650 Note that this size is not necessarily the memory-footprint size, but
651 only the number of Lisp_Object fields (that need to be traced by GC).
652 The distinction is used, e.g., by Lisp_Process, which places extra
653 non-Lisp_Object fields at the end of the structure. */
654 PSEUDOVECTOR_SIZE_BITS
= 12,
655 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
657 /* To calculate the memory footprint of the pseudovector, it's useful
658 to store the size of non-Lisp area in word_size units here. */
659 PSEUDOVECTOR_REST_BITS
= 12,
660 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
661 << PSEUDOVECTOR_SIZE_BITS
),
663 /* Used to extract pseudovector subtype information. */
664 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
665 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
668 /* These functions extract various sorts of values from a Lisp_Object.
669 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
670 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
673 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
674 #define VALMASK_val (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
675 #if ENUMABLE (VALMASK_val)
676 DEFINE_GDB_SYMBOL_ENUM (VALMASK
)
678 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
679 # define VALMASK VALMASK_val
680 DEFINE_GDB_SYMBOL_END (VALMASK
)
683 /* Largest and smallest representable fixnum values. These are the C
684 values. They are macros for use in static initializers. */
685 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
686 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
688 /* Extract the pointer hidden within A. */
689 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
693 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
694 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
695 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
696 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
697 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
699 #else /* ! USE_LSB_TAG */
701 /* Although compiled only if ! USE_LSB_TAG, the following functions
702 also work when USE_LSB_TAG; this is to aid future maintenance when
703 the lisp_h_* macros are eventually removed. */
705 /* Make a Lisp integer representing the value of the low order
708 make_number (EMACS_INT n
)
713 n
= u
<< INTTYPEBITS
;
720 /* Extract A's value as a signed integer. */
724 EMACS_INT i
= XLI (a
);
728 i
= u
<< INTTYPEBITS
;
730 return i
>> INTTYPEBITS
;
733 /* Like XINT (A), but may be faster. A must be nonnegative.
734 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
735 integers have zero-bits in their tags. */
737 XFASTINT (Lisp_Object a
)
739 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
744 /* Extract A's type. */
745 INLINE
enum Lisp_Type
746 XTYPE (Lisp_Object a
)
748 EMACS_UINT i
= XLI (a
);
749 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
752 /* Extract A's pointer value, assuming A's type is TYPE. */
754 XUNTAG (Lisp_Object a
, int type
)
758 intptr_t i
= XLI (a
) - type
;
764 #endif /* ! USE_LSB_TAG */
766 /* Extract A's value as an unsigned integer. */
768 XUINT (Lisp_Object a
)
770 EMACS_UINT i
= XLI (a
);
771 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
774 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
775 right now, but XUINT should only be applied to objects we know are
777 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
779 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
781 make_natnum (EMACS_INT n
)
783 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
784 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
787 /* Return true if X and Y are the same object. */
788 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
790 /* Value is true if I doesn't fit into a Lisp fixnum. It is
791 written this way so that it also works if I is of unsigned
792 type or if I is a NaN. */
794 #define FIXNUM_OVERFLOW_P(i) \
795 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
798 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
800 return num
< lower
? lower
: num
<= upper
? num
: upper
;
803 /* Forward declarations. */
805 /* Defined in this file. */
807 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
808 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
809 INLINE
bool BUFFERP (Lisp_Object
);
810 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
811 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
812 INLINE
bool (CONSP
) (Lisp_Object
);
813 INLINE
bool (FLOATP
) (Lisp_Object
);
814 INLINE
bool functionp (Lisp_Object
);
815 INLINE
bool (INTEGERP
) (Lisp_Object
);
816 INLINE
bool (MARKERP
) (Lisp_Object
);
817 INLINE
bool (MISCP
) (Lisp_Object
);
818 INLINE
bool (NILP
) (Lisp_Object
);
819 INLINE
bool OVERLAYP (Lisp_Object
);
820 INLINE
bool PROCESSP (Lisp_Object
);
821 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
822 INLINE
bool SAVE_VALUEP (Lisp_Object
);
823 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
825 INLINE
bool STRINGP (Lisp_Object
);
826 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
827 INLINE
bool SUBRP (Lisp_Object
);
828 INLINE
bool (SYMBOLP
) (Lisp_Object
);
829 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
830 INLINE
bool WINDOWP (Lisp_Object
);
831 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
833 /* Defined in chartab.c. */
834 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
835 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
836 extern int char_table_translate (Lisp_Object
, int);
838 /* Defined in data.c. */
839 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
840 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
841 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
842 extern Lisp_Object Qbool_vector_p
;
843 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
844 extern Lisp_Object Qwindow
;
845 extern Lisp_Object
Ffboundp (Lisp_Object
);
846 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
848 /* Defined in emacs.c. */
849 extern bool initialized
;
850 extern bool might_dump
;
852 /* Defined in eval.c. */
853 extern Lisp_Object Qautoload
;
855 /* Defined in floatfns.c. */
856 extern double extract_float (Lisp_Object
);
858 /* Defined in process.c. */
859 extern Lisp_Object Qprocessp
;
861 /* Defined in window.c. */
862 extern Lisp_Object Qwindowp
;
864 /* Defined in xdisp.c. */
865 extern Lisp_Object Qimage
;
868 /* Extract a value or address from a Lisp_Object. */
870 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
872 INLINE
struct Lisp_Vector
*
873 XVECTOR (Lisp_Object a
)
875 eassert (VECTORLIKEP (a
));
876 return XUNTAG (a
, Lisp_Vectorlike
);
879 INLINE
struct Lisp_String
*
880 XSTRING (Lisp_Object a
)
882 eassert (STRINGP (a
));
883 return XUNTAG (a
, Lisp_String
);
886 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
888 INLINE
struct Lisp_Float
*
889 XFLOAT (Lisp_Object a
)
891 eassert (FLOATP (a
));
892 return XUNTAG (a
, Lisp_Float
);
895 /* Pseudovector types. */
897 INLINE
struct Lisp_Process
*
898 XPROCESS (Lisp_Object a
)
900 eassert (PROCESSP (a
));
901 return XUNTAG (a
, Lisp_Vectorlike
);
904 INLINE
struct window
*
905 XWINDOW (Lisp_Object a
)
907 eassert (WINDOWP (a
));
908 return XUNTAG (a
, Lisp_Vectorlike
);
911 INLINE
struct terminal
*
912 XTERMINAL (Lisp_Object a
)
914 return XUNTAG (a
, Lisp_Vectorlike
);
917 INLINE
struct Lisp_Subr
*
918 XSUBR (Lisp_Object a
)
921 return XUNTAG (a
, Lisp_Vectorlike
);
924 INLINE
struct buffer
*
925 XBUFFER (Lisp_Object a
)
927 eassert (BUFFERP (a
));
928 return XUNTAG (a
, Lisp_Vectorlike
);
931 INLINE
struct Lisp_Char_Table
*
932 XCHAR_TABLE (Lisp_Object a
)
934 eassert (CHAR_TABLE_P (a
));
935 return XUNTAG (a
, Lisp_Vectorlike
);
938 INLINE
struct Lisp_Sub_Char_Table
*
939 XSUB_CHAR_TABLE (Lisp_Object a
)
941 eassert (SUB_CHAR_TABLE_P (a
));
942 return XUNTAG (a
, Lisp_Vectorlike
);
945 INLINE
struct Lisp_Bool_Vector
*
946 XBOOL_VECTOR (Lisp_Object a
)
948 eassert (BOOL_VECTOR_P (a
));
949 return XUNTAG (a
, Lisp_Vectorlike
);
952 /* Construct a Lisp_Object from a value or address. */
955 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
957 EMACS_UINT utype
= type
;
958 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
959 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
960 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
965 make_lisp_proc (struct Lisp_Process
*p
)
967 return make_lisp_ptr (p
, Lisp_Vectorlike
);
970 #define XSETINT(a, b) ((a) = make_number (b))
971 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
972 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
973 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
974 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
975 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
976 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
977 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
979 /* Pseudovector types. */
981 #define XSETPVECTYPE(v, code) \
982 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
983 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
984 ((v)->header.size = (PSEUDOVECTOR_FLAG \
985 | ((code) << PSEUDOVECTOR_AREA_BITS) \
986 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
989 /* The cast to struct vectorlike_header * avoids aliasing issues. */
990 #define XSETPSEUDOVECTOR(a, b, code) \
991 XSETTYPED_PSEUDOVECTOR (a, b, \
992 (((struct vectorlike_header *) \
993 XUNTAG (a, Lisp_Vectorlike)) \
996 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
997 (XSETVECTOR (a, b), \
998 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
999 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1001 #define XSETWINDOW_CONFIGURATION(a, b) \
1002 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1003 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1004 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1005 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1006 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1007 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1008 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1009 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1010 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1011 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1013 /* Type checking. */
1015 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
, (int ok
, Lisp_Object Qxxxp
, Lisp_Object x
),
1018 /* Deprecated and will be removed soon. */
1020 #define INTERNAL_FIELD(field) field ## _
1022 /* See the macros in intervals.h. */
1024 typedef struct interval
*INTERVAL
;
1028 /* Car of this cons cell. */
1033 /* Cdr of this cons cell. */
1036 /* Used to chain conses on a free list. */
1037 struct Lisp_Cons
*chain
;
1041 /* Take the car or cdr of something known to be a cons cell. */
1042 /* The _addr functions shouldn't be used outside of the minimal set
1043 of code that has to know what a cons cell looks like. Other code not
1044 part of the basic lisp implementation should assume that the car and cdr
1045 fields are not accessible. (What if we want to switch to
1046 a copying collector someday? Cached cons cell field addresses may be
1047 invalidated at arbitrary points.) */
1048 INLINE Lisp_Object
*
1049 xcar_addr (Lisp_Object c
)
1051 return &XCONS (c
)->car
;
1053 INLINE Lisp_Object
*
1054 xcdr_addr (Lisp_Object c
)
1056 return &XCONS (c
)->u
.cdr
;
1059 /* Use these from normal code. */
1060 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
1061 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
1063 /* Use these to set the fields of a cons cell.
1065 Note that both arguments may refer to the same object, so 'n'
1066 should not be read after 'c' is first modified. */
1068 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1073 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1078 /* Take the car or cdr of something whose type is not known. */
1082 return (CONSP (c
) ? XCAR (c
)
1084 : wrong_type_argument (Qlistp
, c
));
1089 return (CONSP (c
) ? XCDR (c
)
1091 : wrong_type_argument (Qlistp
, c
));
1094 /* Take the car or cdr of something whose type is not known. */
1096 CAR_SAFE (Lisp_Object c
)
1098 return CONSP (c
) ? XCAR (c
) : Qnil
;
1101 CDR_SAFE (Lisp_Object c
)
1103 return CONSP (c
) ? XCDR (c
) : Qnil
;
1106 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1111 ptrdiff_t size_byte
;
1112 INTERVAL intervals
; /* Text properties in this string. */
1113 unsigned char *data
;
1116 /* True if STR is a multibyte string. */
1118 STRING_MULTIBYTE (Lisp_Object str
)
1120 return 0 <= XSTRING (str
)->size_byte
;
1123 /* An upper bound on the number of bytes in a Lisp string, not
1124 counting the terminating null. This a tight enough bound to
1125 prevent integer overflow errors that would otherwise occur during
1126 string size calculations. A string cannot contain more bytes than
1127 a fixnum can represent, nor can it be so long that C pointer
1128 arithmetic stops working on the string plus its terminating null.
1129 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1130 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1131 would expose alloc.c internal details that we'd rather keep
1134 This is a macro for use in static initializers. The cast to
1135 ptrdiff_t ensures that the macro is signed. */
1136 #define STRING_BYTES_BOUND \
1137 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1139 /* Mark STR as a unibyte string. */
1140 #define STRING_SET_UNIBYTE(STR) \
1142 if (EQ (STR, empty_multibyte_string)) \
1143 (STR) = empty_unibyte_string; \
1145 XSTRING (STR)->size_byte = -1; \
1148 /* Mark STR as a multibyte string. Assure that STR contains only
1149 ASCII characters in advance. */
1150 #define STRING_SET_MULTIBYTE(STR) \
1152 if (EQ (STR, empty_unibyte_string)) \
1153 (STR) = empty_multibyte_string; \
1155 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1158 /* Convenience functions for dealing with Lisp strings. */
1160 INLINE
unsigned char *
1161 SDATA (Lisp_Object string
)
1163 return XSTRING (string
)->data
;
1166 SSDATA (Lisp_Object string
)
1168 /* Avoid "differ in sign" warnings. */
1169 return (char *) SDATA (string
);
1171 INLINE
unsigned char
1172 SREF (Lisp_Object string
, ptrdiff_t index
)
1174 return SDATA (string
)[index
];
1177 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1179 SDATA (string
)[index
] = new;
1182 SCHARS (Lisp_Object string
)
1184 return XSTRING (string
)->size
;
1187 #ifdef GC_CHECK_STRING_BYTES
1188 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1191 STRING_BYTES (struct Lisp_String
*s
)
1193 #ifdef GC_CHECK_STRING_BYTES
1194 return string_bytes (s
);
1196 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1201 SBYTES (Lisp_Object string
)
1203 return STRING_BYTES (XSTRING (string
));
1206 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1208 XSTRING (string
)->size
= newsize
;
1211 STRING_COPYIN (Lisp_Object string
, ptrdiff_t index
, char const *new,
1214 memcpy (SDATA (string
) + index
, new, count
);
1217 /* Header of vector-like objects. This documents the layout constraints on
1218 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1219 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1220 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1221 because when two such pointers potentially alias, a compiler won't
1222 incorrectly reorder loads and stores to their size fields. See
1224 struct vectorlike_header
1226 /* The only field contains various pieces of information:
1227 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1228 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1229 vector (0) or a pseudovector (1).
1230 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1231 of slots) of the vector.
1232 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1233 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1234 - b) number of Lisp_Objects slots at the beginning of the object
1235 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1237 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1238 measured in word_size units. Rest fields may also include
1239 Lisp_Objects, but these objects usually needs some special treatment
1241 There are some exceptions. For PVEC_FREE, b) is always zero. For
1242 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1243 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1244 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1248 /* A regular vector is just a header plus an array of Lisp_Objects. */
1252 struct vectorlike_header header
;
1253 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1256 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1259 ALIGNOF_STRUCT_LISP_VECTOR
1260 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1263 /* A boolvector is a kind of vectorlike, with contents like a string. */
1265 struct Lisp_Bool_Vector
1267 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1268 just the subtype information. */
1269 struct vectorlike_header header
;
1270 /* This is the size in bits. */
1272 /* The actual bits, packed into bytes.
1273 Zeros fill out the last word if needed.
1274 The bits are in little-endian order in the bytes, and
1275 the bytes are in little-endian order in the words. */
1276 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1280 bool_vector_size (Lisp_Object a
)
1282 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1283 eassume (0 <= size
);
1288 bool_vector_data (Lisp_Object a
)
1290 return XBOOL_VECTOR (a
)->data
;
1293 INLINE
unsigned char *
1294 bool_vector_uchar_data (Lisp_Object a
)
1296 return (unsigned char *) bool_vector_data (a
);
1299 /* The number of data words and bytes in a bool vector with SIZE bits. */
1302 bool_vector_words (EMACS_INT size
)
1304 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1305 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1309 bool_vector_bytes (EMACS_INT size
)
1311 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1312 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1315 /* True if A's Ith bit is set. */
1318 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1320 eassume (0 <= i
&& i
< bool_vector_size (a
));
1321 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1322 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1326 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1328 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1331 /* Set A's Ith bit to B. */
1334 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1336 unsigned char *addr
;
1338 eassume (0 <= i
&& i
< bool_vector_size (a
));
1339 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1342 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1344 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1347 /* Some handy constants for calculating sizes
1348 and offsets, mostly of vectorlike objects. */
1352 header_size
= offsetof (struct Lisp_Vector
, contents
),
1353 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1354 word_size
= sizeof (Lisp_Object
)
1357 /* Conveniences for dealing with Lisp arrays. */
1360 AREF (Lisp_Object array
, ptrdiff_t idx
)
1362 return XVECTOR (array
)->contents
[idx
];
1365 INLINE Lisp_Object
*
1366 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1368 return & XVECTOR (array
)->contents
[idx
];
1372 ASIZE (Lisp_Object array
)
1374 return XVECTOR (array
)->header
.size
;
1378 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1380 eassert (0 <= idx
&& idx
< ASIZE (array
));
1381 XVECTOR (array
)->contents
[idx
] = val
;
1385 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1387 /* Like ASET, but also can be used in the garbage collector:
1388 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1389 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
1390 XVECTOR (array
)->contents
[idx
] = val
;
1393 /* If a struct is made to look like a vector, this macro returns the length
1394 of the shortest vector that would hold that struct. */
1396 #define VECSIZE(type) \
1397 ((sizeof (type) - header_size + word_size - 1) / word_size)
1399 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1400 at the end and we need to compute the number of Lisp_Object fields (the
1401 ones that the GC needs to trace). */
1403 #define PSEUDOVECSIZE(type, nonlispfield) \
1404 ((offsetof (type, nonlispfield) - header_size) / word_size)
1406 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1407 should be integer expressions. This is not the same as
1408 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1409 returns true. For efficiency, prefer plain unsigned comparison if A
1410 and B's sizes both fit (after integer promotion). */
1411 #define UNSIGNED_CMP(a, op, b) \
1412 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1413 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1414 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1416 /* True iff C is an ASCII character. */
1417 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1419 /* A char-table is a kind of vectorlike, with contents are like a
1420 vector but with a few other slots. For some purposes, it makes
1421 sense to handle a char-table with type struct Lisp_Vector. An
1422 element of a char table can be any Lisp objects, but if it is a sub
1423 char-table, we treat it a table that contains information of a
1424 specific range of characters. A sub char-table has the same
1425 structure as a vector. A sub char table appears only in an element
1426 of a char-table, and there's no way to access it directly from
1427 Emacs Lisp program. */
1429 enum CHARTAB_SIZE_BITS
1431 CHARTAB_SIZE_BITS_0
= 6,
1432 CHARTAB_SIZE_BITS_1
= 4,
1433 CHARTAB_SIZE_BITS_2
= 5,
1434 CHARTAB_SIZE_BITS_3
= 7
1437 extern const int chartab_size
[4];
1439 struct Lisp_Char_Table
1441 /* HEADER.SIZE is the vector's size field, which also holds the
1442 pseudovector type information. It holds the size, too.
1443 The size counts the defalt, parent, purpose, ascii,
1444 contents, and extras slots. */
1445 struct vectorlike_header header
;
1447 /* This holds a default value,
1448 which is used whenever the value for a specific character is nil. */
1451 /* This points to another char table, which we inherit from when the
1452 value for a specific character is nil. The `defalt' slot takes
1453 precedence over this. */
1456 /* This is a symbol which says what kind of use this char-table is
1458 Lisp_Object purpose
;
1460 /* The bottom sub char-table for characters of the range 0..127. It
1461 is nil if none of ASCII character has a specific value. */
1464 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1466 /* These hold additional data. It is a vector. */
1467 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1470 struct Lisp_Sub_Char_Table
1472 /* HEADER.SIZE is the vector's size field, which also holds the
1473 pseudovector type information. It holds the size, too. */
1474 struct vectorlike_header header
;
1476 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1477 char-table of depth 1 contains 16 elements, and each element
1478 covers 4096 (128*32) characters. A sub char-table of depth 2
1479 contains 32 elements, and each element covers 128 characters. A
1480 sub char-table of depth 3 contains 128 elements, and each element
1481 is for one character. */
1484 /* Minimum character covered by the sub char-table. */
1485 Lisp_Object min_char
;
1487 /* Use set_sub_char_table_contents to set this. */
1488 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1492 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1494 struct Lisp_Char_Table
*tbl
= NULL
;
1498 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1499 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1500 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1504 while (NILP (val
) && ! NILP (tbl
->parent
));
1509 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1510 characters. Do not check validity of CT. */
1512 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1514 return (ASCII_CHAR_P (idx
)
1515 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1516 : char_table_ref (ct
, idx
));
1519 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1520 8-bit European characters. Do not check validity of CT. */
1522 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1524 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1525 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1527 char_table_set (ct
, idx
, val
);
1530 /* This structure describes a built-in function.
1531 It is generated by the DEFUN macro only.
1532 defsubr makes it into a Lisp object. */
1536 struct vectorlike_header header
;
1538 Lisp_Object (*a0
) (void);
1539 Lisp_Object (*a1
) (Lisp_Object
);
1540 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1541 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1542 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1543 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1544 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1545 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1546 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1547 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1548 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1550 short min_args
, max_args
;
1551 const char *symbol_name
;
1552 const char *intspec
;
1556 /* This is the number of slots that every char table must have. This
1557 counts the ordinary slots and the top, defalt, parent, and purpose
1559 enum CHAR_TABLE_STANDARD_SLOTS
1561 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1564 /* Return the number of "extra" slots in the char table CT. */
1567 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1569 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1570 - CHAR_TABLE_STANDARD_SLOTS
);
1574 /***********************************************************************
1576 ***********************************************************************/
1578 /* Interned state of a symbol. */
1580 enum symbol_interned
1582 SYMBOL_UNINTERNED
= 0,
1583 SYMBOL_INTERNED
= 1,
1584 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1587 enum symbol_redirect
1589 SYMBOL_PLAINVAL
= 4,
1590 SYMBOL_VARALIAS
= 1,
1591 SYMBOL_LOCALIZED
= 2,
1592 SYMBOL_FORWARDED
= 3
1597 bool_bf gcmarkbit
: 1;
1599 /* Indicates where the value can be found:
1600 0 : it's a plain var, the value is in the `value' field.
1601 1 : it's a varalias, the value is really in the `alias' symbol.
1602 2 : it's a localized var, the value is in the `blv' object.
1603 3 : it's a forwarding variable, the value is in `forward'. */
1604 ENUM_BF (symbol_redirect
) redirect
: 3;
1606 /* Non-zero means symbol is constant, i.e. changing its value
1607 should signal an error. If the value is 3, then the var
1608 can be changed, but only by `defconst'. */
1609 unsigned constant
: 2;
1611 /* Interned state of the symbol. This is an enumerator from
1612 enum symbol_interned. */
1613 unsigned interned
: 2;
1615 /* True means that this variable has been explicitly declared
1616 special (with `defvar' etc), and shouldn't be lexically bound. */
1617 bool_bf declared_special
: 1;
1619 /* True if pointed to from purespace and hence can't be GC'd. */
1622 /* The symbol's name, as a Lisp string. */
1625 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1626 union is used depends on the `redirect' field above. */
1629 struct Lisp_Symbol
*alias
;
1630 struct Lisp_Buffer_Local_Value
*blv
;
1631 union Lisp_Fwd
*fwd
;
1634 /* Function value of the symbol or Qnil if not fboundp. */
1635 Lisp_Object function
;
1637 /* The symbol's property list. */
1640 /* Next symbol in obarray bucket, if the symbol is interned. */
1641 struct Lisp_Symbol
*next
;
1644 /* Value is name of symbol. */
1646 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1648 INLINE
struct Lisp_Symbol
*
1649 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1651 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1652 return sym
->val
.alias
;
1654 INLINE
struct Lisp_Buffer_Local_Value
*
1655 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1657 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1658 return sym
->val
.blv
;
1660 INLINE
union Lisp_Fwd
*
1661 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1663 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1664 return sym
->val
.fwd
;
1667 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1668 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1671 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1673 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1677 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1679 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1683 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1685 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1690 SYMBOL_NAME (Lisp_Object sym
)
1692 return XSYMBOL (sym
)->name
;
1695 /* Value is true if SYM is an interned symbol. */
1698 SYMBOL_INTERNED_P (Lisp_Object sym
)
1700 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1703 /* Value is true if SYM is interned in initial_obarray. */
1706 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1708 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1711 /* Value is non-zero if symbol is considered a constant, i.e. its
1712 value cannot be changed (there is an exception for keyword symbols,
1713 whose value can be set to the keyword symbol itself). */
1715 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1717 #define DEFSYM(sym, name) \
1718 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1721 /***********************************************************************
1723 ***********************************************************************/
1725 /* The structure of a Lisp hash table. */
1727 struct hash_table_test
1729 /* Name of the function used to compare keys. */
1732 /* User-supplied hash function, or nil. */
1733 Lisp_Object user_hash_function
;
1735 /* User-supplied key comparison function, or nil. */
1736 Lisp_Object user_cmp_function
;
1738 /* C function to compare two keys. */
1739 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1741 /* C function to compute hash code. */
1742 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1745 struct Lisp_Hash_Table
1747 /* This is for Lisp; the hash table code does not refer to it. */
1748 struct vectorlike_header header
;
1750 /* Nil if table is non-weak. Otherwise a symbol describing the
1751 weakness of the table. */
1754 /* When the table is resized, and this is an integer, compute the
1755 new size by adding this to the old size. If a float, compute the
1756 new size by multiplying the old size with this factor. */
1757 Lisp_Object rehash_size
;
1759 /* Resize hash table when number of entries/ table size is >= this
1761 Lisp_Object rehash_threshold
;
1763 /* Vector of hash codes. If hash[I] is nil, this means that the
1764 I-th entry is unused. */
1767 /* Vector used to chain entries. If entry I is free, next[I] is the
1768 entry number of the next free item. If entry I is non-free,
1769 next[I] is the index of the next entry in the collision chain. */
1772 /* Index of first free entry in free list. */
1773 Lisp_Object next_free
;
1775 /* Bucket vector. A non-nil entry is the index of the first item in
1776 a collision chain. This vector's size can be larger than the
1777 hash table size to reduce collisions. */
1780 /* Only the fields above are traced normally by the GC. The ones below
1781 `count' are special and are either ignored by the GC or traced in
1782 a special way (e.g. because of weakness). */
1784 /* Number of key/value entries in the table. */
1787 /* Vector of keys and values. The key of item I is found at index
1788 2 * I, the value is found at index 2 * I + 1.
1789 This is gc_marked specially if the table is weak. */
1790 Lisp_Object key_and_value
;
1792 /* The comparison and hash functions. */
1793 struct hash_table_test test
;
1795 /* Next weak hash table if this is a weak hash table. The head
1796 of the list is in weak_hash_tables. */
1797 struct Lisp_Hash_Table
*next_weak
;
1801 INLINE
struct Lisp_Hash_Table
*
1802 XHASH_TABLE (Lisp_Object a
)
1804 return XUNTAG (a
, Lisp_Vectorlike
);
1807 #define XSET_HASH_TABLE(VAR, PTR) \
1808 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1811 HASH_TABLE_P (Lisp_Object a
)
1813 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1816 /* Value is the key part of entry IDX in hash table H. */
1818 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1820 return AREF (h
->key_and_value
, 2 * idx
);
1823 /* Value is the value part of entry IDX in hash table H. */
1825 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1827 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1830 /* Value is the index of the next entry following the one at IDX
1833 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1835 return AREF (h
->next
, idx
);
1838 /* Value is the hash code computed for entry IDX in hash table H. */
1840 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1842 return AREF (h
->hash
, idx
);
1845 /* Value is the index of the element in hash table H that is the
1846 start of the collision list at index IDX in the index vector of H. */
1848 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1850 return AREF (h
->index
, idx
);
1853 /* Value is the size of hash table H. */
1855 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1857 return ASIZE (h
->next
);
1860 /* Default size for hash tables if not specified. */
1862 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1864 /* Default threshold specifying when to resize a hash table. The
1865 value gives the ratio of current entries in the hash table and the
1866 size of the hash table. */
1868 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1870 /* Default factor by which to increase the size of a hash table. */
1872 static double const DEFAULT_REHASH_SIZE
= 1.5;
1874 /* Combine two integers X and Y for hashing. The result might not fit
1875 into a Lisp integer. */
1878 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1880 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1883 /* Hash X, returning a value that fits into a fixnum. */
1886 SXHASH_REDUCE (EMACS_UINT x
)
1888 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1891 /* These structures are used for various misc types. */
1893 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1895 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1896 bool_bf gcmarkbit
: 1;
1897 unsigned spacer
: 15;
1902 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1903 bool_bf gcmarkbit
: 1;
1904 unsigned spacer
: 13;
1905 /* This flag is temporarily used in the functions
1906 decode/encode_coding_object to record that the marker position
1907 must be adjusted after the conversion. */
1908 bool_bf need_adjustment
: 1;
1909 /* True means normal insertion at the marker's position
1910 leaves the marker after the inserted text. */
1911 bool_bf insertion_type
: 1;
1912 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1913 Note: a chain of markers can contain markers pointing into different
1914 buffers (the chain is per buffer_text rather than per buffer, so it's
1915 shared between indirect buffers). */
1916 /* This is used for (other than NULL-checking):
1918 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1919 - unchain_marker: to find the list from which to unchain.
1920 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1922 struct buffer
*buffer
;
1924 /* The remaining fields are meaningless in a marker that
1925 does not point anywhere. */
1927 /* For markers that point somewhere,
1928 this is used to chain of all the markers in a given buffer. */
1929 /* We could remove it and use an array in buffer_text instead.
1930 That would also allow to preserve it ordered. */
1931 struct Lisp_Marker
*next
;
1932 /* This is the char position where the marker points. */
1934 /* This is the byte position.
1935 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1936 used to implement the functionality of markers, but rather to (ab)use
1937 markers as a cache for char<->byte mappings). */
1941 /* START and END are markers in the overlay's buffer, and
1942 PLIST is the overlay's property list. */
1944 /* An overlay's real data content is:
1946 - buffer (really there are two buffer pointers, one per marker,
1947 and both points to the same buffer)
1948 - insertion type of both ends (per-marker fields)
1949 - start & start byte (of start marker)
1950 - end & end byte (of end marker)
1951 - next (singly linked list of overlays)
1952 - next fields of start and end markers (singly linked list of markers).
1953 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1956 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1957 bool_bf gcmarkbit
: 1;
1958 unsigned spacer
: 15;
1959 struct Lisp_Overlay
*next
;
1965 /* Types of data which may be saved in a Lisp_Save_Value. */
1976 /* Number of bits needed to store one of the above values. */
1977 enum { SAVE_SLOT_BITS
= 3 };
1979 /* Number of slots in a save value where save_type is nonzero. */
1980 enum { SAVE_VALUE_SLOTS
= 4 };
1982 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1984 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1988 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1989 SAVE_TYPE_INT_INT_INT
1990 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1991 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1992 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1993 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1994 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1995 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1996 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1997 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1998 SAVE_TYPE_FUNCPTR_PTR_OBJ
1999 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2001 /* This has an extra bit indicating it's raw memory. */
2002 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2005 /* Special object used to hold a different values for later use.
2007 This is mostly used to package C integers and pointers to call
2008 record_unwind_protect when two or more values need to be saved.
2012 struct my_data *md = get_my_data ();
2013 ptrdiff_t mi = get_my_integer ();
2014 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2017 Lisp_Object my_unwind (Lisp_Object arg)
2019 struct my_data *md = XSAVE_POINTER (arg, 0);
2020 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2024 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2025 saved objects and raise eassert if type of the saved object doesn't match
2026 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2027 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2028 slot 0 is a pointer. */
2030 typedef void (*voidfuncptr
) (void);
2032 struct Lisp_Save_Value
2034 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2035 bool_bf gcmarkbit
: 1;
2036 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2038 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2039 V's data entries are determined by V->save_type. E.g., if
2040 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2041 V->data[1] is an integer, and V's other data entries are unused.
2043 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2044 a memory area containing V->data[1].integer potential Lisp_Objects. */
2045 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2048 voidfuncptr funcpointer
;
2051 } data
[SAVE_VALUE_SLOTS
];
2054 /* Return the type of V's Nth saved value. */
2056 save_type (struct Lisp_Save_Value
*v
, int n
)
2058 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2059 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2062 /* Get and set the Nth saved pointer. */
2065 XSAVE_POINTER (Lisp_Object obj
, int n
)
2067 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2068 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2071 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2073 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2074 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2077 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2079 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2080 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2083 /* Likewise for the saved integer. */
2086 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2088 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2089 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2092 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2094 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2095 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2098 /* Extract Nth saved object. */
2101 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2103 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2104 return XSAVE_VALUE (obj
)->data
[n
].object
;
2107 /* A miscellaneous object, when it's on the free list. */
2110 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2111 bool_bf gcmarkbit
: 1;
2112 unsigned spacer
: 15;
2113 union Lisp_Misc
*chain
;
2116 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2117 It uses one of these struct subtypes to get the type field. */
2121 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2122 struct Lisp_Free u_free
;
2123 struct Lisp_Marker u_marker
;
2124 struct Lisp_Overlay u_overlay
;
2125 struct Lisp_Save_Value u_save_value
;
2128 INLINE
union Lisp_Misc
*
2129 XMISC (Lisp_Object a
)
2131 return XUNTAG (a
, Lisp_Misc
);
2134 INLINE
struct Lisp_Misc_Any
*
2135 XMISCANY (Lisp_Object a
)
2137 eassert (MISCP (a
));
2138 return & XMISC (a
)->u_any
;
2141 INLINE
enum Lisp_Misc_Type
2142 XMISCTYPE (Lisp_Object a
)
2144 return XMISCANY (a
)->type
;
2147 INLINE
struct Lisp_Marker
*
2148 XMARKER (Lisp_Object a
)
2150 eassert (MARKERP (a
));
2151 return & XMISC (a
)->u_marker
;
2154 INLINE
struct Lisp_Overlay
*
2155 XOVERLAY (Lisp_Object a
)
2157 eassert (OVERLAYP (a
));
2158 return & XMISC (a
)->u_overlay
;
2161 INLINE
struct Lisp_Save_Value
*
2162 XSAVE_VALUE (Lisp_Object a
)
2164 eassert (SAVE_VALUEP (a
));
2165 return & XMISC (a
)->u_save_value
;
2168 /* Forwarding pointer to an int variable.
2169 This is allowed only in the value cell of a symbol,
2170 and it means that the symbol's value really lives in the
2171 specified int variable. */
2174 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2178 /* Boolean forwarding pointer to an int variable.
2179 This is like Lisp_Intfwd except that the ostensible
2180 "value" of the symbol is t if the bool variable is true,
2181 nil if it is false. */
2184 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2188 /* Forwarding pointer to a Lisp_Object variable.
2189 This is allowed only in the value cell of a symbol,
2190 and it means that the symbol's value really lives in the
2191 specified variable. */
2194 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2195 Lisp_Object
*objvar
;
2198 /* Like Lisp_Objfwd except that value lives in a slot in the
2199 current buffer. Value is byte index of slot within buffer. */
2200 struct Lisp_Buffer_Objfwd
2202 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2204 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2205 Lisp_Object predicate
;
2208 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2209 the symbol has buffer-local or frame-local bindings. (Exception:
2210 some buffer-local variables are built-in, with their values stored
2211 in the buffer structure itself. They are handled differently,
2212 using struct Lisp_Buffer_Objfwd.)
2214 The `realvalue' slot holds the variable's current value, or a
2215 forwarding pointer to where that value is kept. This value is the
2216 one that corresponds to the loaded binding. To read or set the
2217 variable, you must first make sure the right binding is loaded;
2218 then you can access the value in (or through) `realvalue'.
2220 `buffer' and `frame' are the buffer and frame for which the loaded
2221 binding was found. If those have changed, to make sure the right
2222 binding is loaded it is necessary to find which binding goes with
2223 the current buffer and selected frame, then load it. To load it,
2224 first unload the previous binding, then copy the value of the new
2225 binding into `realvalue' (or through it). Also update
2226 LOADED-BINDING to point to the newly loaded binding.
2228 `local_if_set' indicates that merely setting the variable creates a
2229 local binding for the current buffer. Otherwise the latter, setting
2230 the variable does not do that; only make-local-variable does that. */
2232 struct Lisp_Buffer_Local_Value
2234 /* True means that merely setting the variable creates a local
2235 binding for the current buffer. */
2236 bool_bf local_if_set
: 1;
2237 /* True means this variable can have frame-local bindings, otherwise, it is
2238 can have buffer-local bindings. The two cannot be combined. */
2239 bool_bf frame_local
: 1;
2240 /* True means that the binding now loaded was found.
2241 Presumably equivalent to (defcell!=valcell). */
2243 /* If non-NULL, a forwarding to the C var where it should also be set. */
2244 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2245 /* The buffer or frame for which the loaded binding was found. */
2247 /* A cons cell that holds the default value. It has the form
2248 (SYMBOL . DEFAULT-VALUE). */
2249 Lisp_Object defcell
;
2250 /* The cons cell from `where's parameter alist.
2251 It always has the form (SYMBOL . VALUE)
2252 Note that if `forward' is non-nil, VALUE may be out of date.
2253 Also if the currently loaded binding is the default binding, then
2254 this is `eq'ual to defcell. */
2255 Lisp_Object valcell
;
2258 /* Like Lisp_Objfwd except that value lives in a slot in the
2260 struct Lisp_Kboard_Objfwd
2262 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2268 struct Lisp_Intfwd u_intfwd
;
2269 struct Lisp_Boolfwd u_boolfwd
;
2270 struct Lisp_Objfwd u_objfwd
;
2271 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2272 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2275 INLINE
enum Lisp_Fwd_Type
2276 XFWDTYPE (union Lisp_Fwd
*a
)
2278 return a
->u_intfwd
.type
;
2281 INLINE
struct Lisp_Buffer_Objfwd
*
2282 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2284 eassert (BUFFER_OBJFWDP (a
));
2285 return &a
->u_buffer_objfwd
;
2288 /* Lisp floating point type. */
2294 struct Lisp_Float
*chain
;
2299 XFLOAT_DATA (Lisp_Object f
)
2301 return XFLOAT (f
)->u
.data
;
2304 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2305 representations, have infinities and NaNs, and do not trap on
2306 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2307 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2308 wanted here, but is not quite right because Emacs does not require
2309 all the features of C11 Annex F (and does not require C11 at all,
2310 for that matter). */
2314 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2315 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2318 /* A character, declared with the following typedef, is a member
2319 of some character set associated with the current buffer. */
2320 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2322 typedef unsigned char UCHAR
;
2325 /* Meanings of slots in a Lisp_Compiled: */
2329 COMPILED_ARGLIST
= 0,
2330 COMPILED_BYTECODE
= 1,
2331 COMPILED_CONSTANTS
= 2,
2332 COMPILED_STACK_DEPTH
= 3,
2333 COMPILED_DOC_STRING
= 4,
2334 COMPILED_INTERACTIVE
= 5
2337 /* Flag bits in a character. These also get used in termhooks.h.
2338 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2339 (MUlti-Lingual Emacs) might need 22 bits for the character value
2340 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2343 CHAR_ALT
= 0x0400000,
2344 CHAR_SUPER
= 0x0800000,
2345 CHAR_HYPER
= 0x1000000,
2346 CHAR_SHIFT
= 0x2000000,
2347 CHAR_CTL
= 0x4000000,
2348 CHAR_META
= 0x8000000,
2350 CHAR_MODIFIER_MASK
=
2351 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2353 /* Actually, the current Emacs uses 22 bits for the character value
2358 /* Data type checking. */
2360 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2363 NUMBERP (Lisp_Object x
)
2365 return INTEGERP (x
) || FLOATP (x
);
2368 NATNUMP (Lisp_Object x
)
2370 return INTEGERP (x
) && 0 <= XINT (x
);
2374 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2376 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2379 #define TYPE_RANGED_INTEGERP(type, x) \
2381 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2382 && XINT (x) <= TYPE_MAXIMUM (type))
2384 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2385 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2386 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2387 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2388 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2389 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2390 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2393 STRINGP (Lisp_Object x
)
2395 return XTYPE (x
) == Lisp_String
;
2398 VECTORP (Lisp_Object x
)
2400 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2403 OVERLAYP (Lisp_Object x
)
2405 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2408 SAVE_VALUEP (Lisp_Object x
)
2410 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2414 AUTOLOADP (Lisp_Object x
)
2416 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2420 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2422 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2426 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2428 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2429 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2432 /* True if A is a pseudovector whose code is CODE. */
2434 PSEUDOVECTORP (Lisp_Object a
, int code
)
2436 if (! VECTORLIKEP (a
))
2440 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2441 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2442 return PSEUDOVECTOR_TYPEP (h
, code
);
2447 /* Test for specific pseudovector types. */
2450 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2452 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2456 PROCESSP (Lisp_Object a
)
2458 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2462 WINDOWP (Lisp_Object a
)
2464 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2468 TERMINALP (Lisp_Object a
)
2470 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2474 SUBRP (Lisp_Object a
)
2476 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2480 COMPILEDP (Lisp_Object a
)
2482 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2486 BUFFERP (Lisp_Object a
)
2488 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2492 CHAR_TABLE_P (Lisp_Object a
)
2494 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2498 SUB_CHAR_TABLE_P (Lisp_Object a
)
2500 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2504 BOOL_VECTOR_P (Lisp_Object a
)
2506 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2510 FRAMEP (Lisp_Object a
)
2512 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2515 /* Test for image (image . spec) */
2517 IMAGEP (Lisp_Object x
)
2519 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2524 ARRAYP (Lisp_Object x
)
2526 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2530 CHECK_LIST (Lisp_Object x
)
2532 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2535 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2536 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2537 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2540 CHECK_STRING (Lisp_Object x
)
2542 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2545 CHECK_STRING_CAR (Lisp_Object x
)
2547 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2550 CHECK_CONS (Lisp_Object x
)
2552 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2555 CHECK_VECTOR (Lisp_Object x
)
2557 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2560 CHECK_BOOL_VECTOR (Lisp_Object x
)
2562 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2565 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2567 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2570 CHECK_ARRAY (Lisp_Object x
, Lisp_Object Qxxxp
)
2572 CHECK_TYPE (ARRAYP (x
), Qxxxp
, x
);
2575 CHECK_BUFFER (Lisp_Object x
)
2577 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2580 CHECK_WINDOW (Lisp_Object x
)
2582 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2586 CHECK_PROCESS (Lisp_Object x
)
2588 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2592 CHECK_NATNUM (Lisp_Object x
)
2594 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2597 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2600 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2601 args_out_of_range_3 \
2603 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2604 ? MOST_NEGATIVE_FIXNUM \
2606 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2608 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2610 if (TYPE_SIGNED (type)) \
2611 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2613 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2616 #define CHECK_NUMBER_COERCE_MARKER(x) \
2618 if (MARKERP ((x))) \
2619 XSETFASTINT (x, marker_position (x)); \
2621 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2625 XFLOATINT (Lisp_Object n
)
2627 return extract_float (n
);
2631 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2633 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2636 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2639 XSETFASTINT (x, marker_position (x)); \
2641 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2644 /* Since we can't assign directly to the CAR or CDR fields of a cons
2645 cell, use these when checking that those fields contain numbers. */
2647 CHECK_NUMBER_CAR (Lisp_Object x
)
2649 Lisp_Object tmp
= XCAR (x
);
2655 CHECK_NUMBER_CDR (Lisp_Object x
)
2657 Lisp_Object tmp
= XCDR (x
);
2662 /* Define a built-in function for calling from Lisp.
2663 `lname' should be the name to give the function in Lisp,
2664 as a null-terminated C string.
2665 `fnname' should be the name of the function in C.
2666 By convention, it starts with F.
2667 `sname' should be the name for the C constant structure
2668 that records information on this function for internal use.
2669 By convention, it should be the same as `fnname' but with S instead of F.
2670 It's too bad that C macros can't compute this from `fnname'.
2671 `minargs' should be a number, the minimum number of arguments allowed.
2672 `maxargs' should be a number, the maximum number of arguments allowed,
2673 or else MANY or UNEVALLED.
2674 MANY means pass a vector of evaluated arguments,
2675 in the form of an integer number-of-arguments
2676 followed by the address of a vector of Lisp_Objects
2677 which contains the argument values.
2678 UNEVALLED means pass the list of unevaluated arguments
2679 `intspec' says how interactive arguments are to be fetched.
2680 If the string starts with a `(', `intspec' is evaluated and the resulting
2681 list is the list of arguments.
2682 If it's a string that doesn't start with `(', the value should follow
2683 the one of the doc string for `interactive'.
2684 A null string means call interactively with no arguments.
2685 `doc' is documentation for the user. */
2687 /* This version of DEFUN declares a function prototype with the right
2688 arguments, so we can catch errors with maxargs at compile-time. */
2690 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2691 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2692 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2693 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2694 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2695 { (Lisp_Object (__cdecl *)(void))fnname }, \
2696 minargs, maxargs, lname, intspec, 0}; \
2698 #else /* not _MSC_VER */
2699 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2700 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2701 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2702 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2703 { .a ## maxargs = fnname }, \
2704 minargs, maxargs, lname, intspec, 0}; \
2708 /* Note that the weird token-substitution semantics of ANSI C makes
2709 this work for MANY and UNEVALLED. */
2710 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2711 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2712 #define DEFUN_ARGS_0 (void)
2713 #define DEFUN_ARGS_1 (Lisp_Object)
2714 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2715 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2716 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2717 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2719 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2720 Lisp_Object, Lisp_Object)
2721 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2722 Lisp_Object, Lisp_Object, Lisp_Object)
2723 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2724 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2726 /* True if OBJ is a Lisp function. */
2728 FUNCTIONP (Lisp_Object obj
)
2730 return functionp (obj
);
2734 is how we define the symbol for function `name' at start-up time. */
2735 extern void defsubr (struct Lisp_Subr
*);
2743 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2744 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2745 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2746 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2747 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2749 /* Macros we use to define forwarded Lisp variables.
2750 These are used in the syms_of_FILENAME functions.
2752 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2753 lisp variable is actually a field in `struct emacs_globals'. The
2754 field's name begins with "f_", which is a convention enforced by
2755 these macros. Each such global has a corresponding #define in
2756 globals.h; the plain name should be used in the code.
2758 E.g., the global "cons_cells_consed" is declared as "int
2759 f_cons_cells_consed" in globals.h, but there is a define:
2761 #define cons_cells_consed globals.f_cons_cells_consed
2763 All C code uses the `cons_cells_consed' name. This is all done
2764 this way to support indirection for multi-threaded Emacs. */
2766 #define DEFVAR_LISP(lname, vname, doc) \
2768 static struct Lisp_Objfwd o_fwd; \
2769 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2771 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2773 static struct Lisp_Objfwd o_fwd; \
2774 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2776 #define DEFVAR_BOOL(lname, vname, doc) \
2778 static struct Lisp_Boolfwd b_fwd; \
2779 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2781 #define DEFVAR_INT(lname, vname, doc) \
2783 static struct Lisp_Intfwd i_fwd; \
2784 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2787 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2789 static struct Lisp_Objfwd o_fwd; \
2790 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2793 #define DEFVAR_KBOARD(lname, vname, doc) \
2795 static struct Lisp_Kboard_Objfwd ko_fwd; \
2796 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2799 /* Save and restore the instruction and environment pointers,
2800 without affecting the signal mask. */
2803 typedef jmp_buf sys_jmp_buf
;
2804 # define sys_setjmp(j) _setjmp (j)
2805 # define sys_longjmp(j, v) _longjmp (j, v)
2806 #elif defined HAVE_SIGSETJMP
2807 typedef sigjmp_buf sys_jmp_buf
;
2808 # define sys_setjmp(j) sigsetjmp (j, 0)
2809 # define sys_longjmp(j, v) siglongjmp (j, v)
2811 /* A platform that uses neither _longjmp nor siglongjmp; assume
2812 longjmp does not affect the sigmask. */
2813 typedef jmp_buf sys_jmp_buf
;
2814 # define sys_setjmp(j) setjmp (j)
2815 # define sys_longjmp(j, v) longjmp (j, v)
2819 /* Elisp uses several stacks:
2821 - the bytecode stack: used internally by the bytecode interpreter.
2822 Allocated from the C stack.
2823 - The specpdl stack: keeps track of active unwind-protect and
2824 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2826 - The handler stack: keeps track of active catch tags and condition-case
2827 handlers. Allocated in a manually managed stack implemented by a
2828 doubly-linked list allocated via xmalloc and never freed. */
2830 /* Structure for recording Lisp call stack for backtrace purposes. */
2832 /* The special binding stack holds the outer values of variables while
2833 they are bound by a function application or a let form, stores the
2834 code to be executed for unwind-protect forms.
2836 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2837 used all over the place, needs to be fast, and needs to know the size of
2838 union specbinding. But only eval.c should access it. */
2841 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2842 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2843 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2844 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2845 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2846 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2847 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2848 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2849 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2854 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2856 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2857 void (*func
) (Lisp_Object
);
2861 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2862 void (*func
) (void *);
2866 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2871 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2872 void (*func
) (void);
2875 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2876 /* `where' is not used in the case of SPECPDL_LET. */
2877 Lisp_Object symbol
, old_value
, where
;
2880 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2881 bool_bf debug_on_exit
: 1;
2882 Lisp_Object function
;
2888 extern union specbinding
*specpdl
;
2889 extern union specbinding
*specpdl_ptr
;
2890 extern ptrdiff_t specpdl_size
;
2893 SPECPDL_INDEX (void)
2895 return specpdl_ptr
- specpdl
;
2898 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2899 control structures. A struct handler contains all the information needed to
2900 restore the state of the interpreter after a non-local jump.
2902 handler structures are chained together in a doubly linked list; the `next'
2903 member points to the next outer catchtag and the `nextfree' member points in
2904 the other direction to the next inner element (which is typically the next
2905 free element since we mostly use it on the deepest handler).
2907 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2908 member is TAG, and then unbinds to it. The `val' member is used to
2909 hold VAL while the stack is unwound; `val' is returned as the value
2912 All the other members are concerned with restoring the interpreter
2915 Members are volatile if their values need to survive _longjmp when
2916 a 'struct handler' is a local variable. */
2918 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2922 enum handlertype type
;
2923 Lisp_Object tag_or_ch
;
2925 struct handler
*next
;
2926 struct handler
*nextfree
;
2928 /* The bytecode interpreter can have several handlers active at the same
2929 time, so when we longjmp to one of them, it needs to know which handler
2930 this was and what was the corresponding internal state. This is stored
2931 here, and when we longjmp we make sure that handlerlist points to the
2933 Lisp_Object
*bytecode_top
;
2936 /* Most global vars are reset to their value via the specpdl mechanism,
2937 but a few others are handled by storing their value here. */
2938 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
2939 struct gcpro
*gcpro
;
2942 EMACS_INT lisp_eval_depth
;
2944 int poll_suppress_count
;
2945 int interrupt_input_blocked
;
2946 struct byte_stack
*byte_stack
;
2949 /* Fill in the components of c, and put it on the list. */
2950 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2951 if (handlerlist->nextfree) \
2952 (c) = handlerlist->nextfree; \
2955 (c) = xmalloc (sizeof (struct handler)); \
2956 (c)->nextfree = NULL; \
2957 handlerlist->nextfree = (c); \
2959 (c)->type = (handlertype); \
2960 (c)->tag_or_ch = (tag_ch_val); \
2962 (c)->next = handlerlist; \
2963 (c)->lisp_eval_depth = lisp_eval_depth; \
2964 (c)->pdlcount = SPECPDL_INDEX (); \
2965 (c)->poll_suppress_count = poll_suppress_count; \
2966 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2967 (c)->gcpro = gcprolist; \
2968 (c)->byte_stack = byte_stack_list; \
2972 extern Lisp_Object memory_signal_data
;
2974 /* An address near the bottom of the stack.
2975 Tells GC how to save a copy of the stack. */
2976 extern char *stack_bottom
;
2978 /* Check quit-flag and quit if it is non-nil.
2979 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2980 So the program needs to do QUIT at times when it is safe to quit.
2981 Every loop that might run for a long time or might not exit
2982 ought to do QUIT at least once, at a safe place.
2983 Unless that is impossible, of course.
2984 But it is very desirable to avoid creating loops where QUIT is impossible.
2986 Exception: if you set immediate_quit to true,
2987 then the handler that responds to the C-g does the quit itself.
2988 This is a good thing to do around a loop that has no side effects
2989 and (in particular) cannot call arbitrary Lisp code.
2991 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2992 a request to exit Emacs when it is safe to do. */
2994 extern void process_pending_signals (void);
2995 extern bool volatile pending_signals
;
2997 extern void process_quit_flag (void);
3000 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3001 process_quit_flag (); \
3002 else if (pending_signals) \
3003 process_pending_signals (); \
3007 /* True if ought to quit now. */
3009 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3011 extern Lisp_Object Vascii_downcase_table
;
3012 extern Lisp_Object Vascii_canon_table
;
3014 /* Structure for recording stack slots that need marking. */
3016 /* This is a chain of structures, each of which points at a Lisp_Object
3017 variable whose value should be marked in garbage collection.
3018 Normally every link of the chain is an automatic variable of a function,
3019 and its `val' points to some argument or local variable of the function.
3020 On exit to the function, the chain is set back to the value it had on entry.
3021 This way, no link remains in the chain when the stack frame containing the
3024 Every function that can call Feval must protect in this fashion all
3025 Lisp_Object variables whose contents will be used again. */
3027 extern struct gcpro
*gcprolist
;
3033 /* Address of first protected variable. */
3034 volatile Lisp_Object
*var
;
3036 /* Number of consecutive protected variables. */
3044 /* Values of GC_MARK_STACK during compilation:
3046 0 Use GCPRO as before
3047 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
3048 2 Mark the stack, and check that everything GCPRO'd is
3050 3 Mark using GCPRO's, mark stack last, and count how many
3051 dead objects are kept alive.
3053 Formerly, method 0 was used. Currently, method 1 is used unless
3054 otherwise specified by hand when building, e.g.,
3055 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
3056 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
3058 #define GC_USE_GCPROS_AS_BEFORE 0
3059 #define GC_MAKE_GCPROS_NOOPS 1
3060 #define GC_MARK_STACK_CHECK_GCPROS 2
3061 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
3063 #ifndef GC_MARK_STACK
3064 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
3067 /* Whether we do the stack marking manually. */
3068 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
3069 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
3072 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
3074 /* Do something silly with gcproN vars just so gcc shuts up. */
3075 /* You get warnings from MIPSPro... */
3077 #define GCPRO1(varname) ((void) gcpro1)
3078 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
3079 #define GCPRO3(varname1, varname2, varname3) \
3080 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
3081 #define GCPRO4(varname1, varname2, varname3, varname4) \
3082 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3083 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3084 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3085 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3086 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
3088 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
3089 #define UNGCPRO ((void) 0)
3091 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3095 #define GCPRO1(varname) \
3096 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3097 gcprolist = &gcpro1; }
3099 #define GCPRO2(varname1, varname2) \
3100 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3101 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3102 gcprolist = &gcpro2; }
3104 #define GCPRO3(varname1, varname2, varname3) \
3105 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3106 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3107 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3108 gcprolist = &gcpro3; }
3110 #define GCPRO4(varname1, varname2, varname3, varname4) \
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 gcprolist = &gcpro4; }
3117 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3118 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3119 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3120 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3121 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3122 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3123 gcprolist = &gcpro5; }
3125 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3126 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3127 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3128 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3129 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3130 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3131 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3132 gcprolist = &gcpro6; }
3134 #define GCPRO7(a, b, c, d, e, f, g) \
3135 {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3136 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3137 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3138 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3139 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3140 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3141 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3142 gcprolist = &gcpro7; }
3144 #define UNGCPRO (gcprolist = gcpro1.next)
3148 extern int gcpro_level
;
3150 #define GCPRO1(varname) \
3151 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3152 gcpro1.level = gcpro_level++; \
3153 gcprolist = &gcpro1; }
3155 #define GCPRO2(varname1, varname2) \
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 gcpro2.level = gcpro_level++; \
3160 gcprolist = &gcpro2; }
3162 #define GCPRO3(varname1, varname2, varname3) \
3163 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3164 gcpro1.level = gcpro_level; \
3165 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3166 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3167 gcpro3.level = gcpro_level++; \
3168 gcprolist = &gcpro3; }
3170 #define GCPRO4(varname1, varname2, varname3, varname4) \
3171 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3172 gcpro1.level = gcpro_level; \
3173 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3174 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3175 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3176 gcpro4.level = gcpro_level++; \
3177 gcprolist = &gcpro4; }
3179 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3180 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3181 gcpro1.level = gcpro_level; \
3182 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3183 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3184 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3185 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3186 gcpro5.level = gcpro_level++; \
3187 gcprolist = &gcpro5; }
3189 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3190 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3191 gcpro1.level = gcpro_level; \
3192 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3193 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3194 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3195 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3196 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3197 gcpro6.level = gcpro_level++; \
3198 gcprolist = &gcpro6; }
3200 #define GCPRO7(a, b, c, d, e, f, g) \
3201 {gcpro1.next = gcprolist; gcpro1.var = &(a); gcpro1.nvars = 1; \
3202 gcpro1.level = gcpro_level; \
3203 gcpro2.next = &gcpro1; gcpro2.var = &(b); gcpro2.nvars = 1; \
3204 gcpro3.next = &gcpro2; gcpro3.var = &(c); gcpro3.nvars = 1; \
3205 gcpro4.next = &gcpro3; gcpro4.var = &(d); gcpro4.nvars = 1; \
3206 gcpro5.next = &gcpro4; gcpro5.var = &(e); gcpro5.nvars = 1; \
3207 gcpro6.next = &gcpro5; gcpro6.var = &(f); gcpro6.nvars = 1; \
3208 gcpro7.next = &gcpro6; gcpro7.var = &(g); gcpro7.nvars = 1; \
3209 gcpro7.level = gcpro_level++; \
3210 gcprolist = &gcpro7; }
3213 (--gcpro_level != gcpro1.level \
3215 : (void) (gcprolist = gcpro1.next))
3217 #endif /* DEBUG_GCPRO */
3218 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3221 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
3222 #define RETURN_UNGCPRO(expr) \
3225 Lisp_Object ret_ungc_val; \
3226 ret_ungc_val = (expr); \
3228 return ret_ungc_val; \
3232 /* Call staticpro (&var) to protect static variable `var'. */
3234 void staticpro (Lisp_Object
*);
3236 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
3237 meaning as in the DEFUN macro, and is used to construct a prototype. */
3238 /* We can use the same trick as in the DEFUN macro to generate the
3239 appropriate prototype. */
3240 #define EXFUN(fnname, maxargs) \
3241 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
3243 #include "globals.h"
3245 /* Forward declarations for prototypes. */
3249 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3252 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3254 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3255 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3258 /* Functions to modify hash tables. */
3261 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3263 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3267 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3269 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3272 /* Use these functions to set Lisp_Object
3273 or pointer slots of struct Lisp_Symbol. */
3276 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3278 XSYMBOL (sym
)->function
= function
;
3282 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3284 XSYMBOL (sym
)->plist
= plist
;
3288 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3290 XSYMBOL (sym
)->next
= next
;
3293 /* Buffer-local (also frame-local) variable access functions. */
3296 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3298 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3302 /* Set overlay's property list. */
3305 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3307 XOVERLAY (overlay
)->plist
= plist
;
3310 /* Get text properties of S. */
3313 string_intervals (Lisp_Object s
)
3315 return XSTRING (s
)->intervals
;
3318 /* Set text properties of S to I. */
3321 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3323 XSTRING (s
)->intervals
= i
;
3326 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3327 of setting slots directly. */
3330 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3332 XCHAR_TABLE (table
)->defalt
= val
;
3335 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3337 XCHAR_TABLE (table
)->purpose
= val
;
3340 /* Set different slots in (sub)character tables. */
3343 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3345 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3346 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3350 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3352 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3353 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3357 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3359 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3362 /* Defined in data.c. */
3363 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
3364 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3365 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3366 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3367 extern Lisp_Object Qinvalid_read_syntax
;
3368 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3369 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3370 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3371 extern Lisp_Object Qtext_read_only
;
3372 extern Lisp_Object Qinteractive_form
;
3373 extern Lisp_Object Qcircular_list
;
3374 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
3375 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
3376 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
3377 extern Lisp_Object Qbuffer_or_string_p
;
3378 extern Lisp_Object Qfboundp
;
3379 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
3381 extern Lisp_Object Qcdr
;
3383 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3385 extern Lisp_Object Qfloatp
;
3386 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
3388 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3390 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
3392 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
3394 /* Defined in data.c. */
3395 extern Lisp_Object
indirect_function (Lisp_Object
);
3396 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3397 enum Arith_Comparison
{
3402 ARITH_LESS_OR_EQUAL
,
3405 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3406 enum Arith_Comparison comparison
);
3408 /* Convert the integer I to an Emacs representation, either the integer
3409 itself, or a cons of two or three integers, or if all else fails a float.
3410 I should not have side effects. */
3411 #define INTEGER_TO_CONS(i) \
3412 (! FIXNUM_OVERFLOW_P (i) \
3414 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3415 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3416 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3417 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3418 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3419 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3420 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3421 ? Fcons (make_number ((i) >> 16 >> 24), \
3422 Fcons (make_number ((i) >> 16 & 0xffffff), \
3423 make_number ((i) & 0xffff))) \
3426 /* Convert the Emacs representation CONS back to an integer of type
3427 TYPE, storing the result the variable VAR. Signal an error if CONS
3428 is not a valid representation or is out of range for TYPE. */
3429 #define CONS_TO_INTEGER(cons, type, var) \
3430 (TYPE_SIGNED (type) \
3431 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3432 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3433 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3434 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3436 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3437 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3438 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3440 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
3441 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3442 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3443 extern void syms_of_data (void);
3444 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3446 /* Defined in cmds.c */
3447 extern void syms_of_cmds (void);
3448 extern void keys_of_cmds (void);
3450 /* Defined in coding.c. */
3451 extern Lisp_Object Qcharset
;
3452 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3453 ptrdiff_t, bool, bool, Lisp_Object
);
3454 extern void init_coding (void);
3455 extern void init_coding_once (void);
3456 extern void syms_of_coding (void);
3458 /* Defined in character.c. */
3459 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
3460 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3461 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3462 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
3463 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
3464 extern void syms_of_character (void);
3466 /* Defined in charset.c. */
3467 extern void init_charset (void);
3468 extern void init_charset_once (void);
3469 extern void syms_of_charset (void);
3470 /* Structure forward declarations. */
3473 /* Defined in composite.c. */
3474 extern void syms_of_composite (void);
3476 /* Defined in syntax.c. */
3477 extern void init_syntax_once (void);
3478 extern void syms_of_syntax (void);
3480 /* Defined in fns.c. */
3481 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3482 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3483 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
3484 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3485 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3486 extern void sweep_weak_hash_tables (void);
3487 extern Lisp_Object Qcursor_in_echo_area
;
3488 extern Lisp_Object Qstring_lessp
;
3489 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3490 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3491 EMACS_UINT
sxhash (Lisp_Object
, int);
3492 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3493 Lisp_Object
, Lisp_Object
);
3494 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3495 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3497 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3499 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3500 ptrdiff_t, ptrdiff_t);
3501 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3502 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3503 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3504 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3505 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3506 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3507 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3508 extern void clear_string_char_byte_cache (void);
3509 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3510 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3511 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3512 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3513 extern void syms_of_fns (void);
3515 /* Defined in floatfns.c. */
3516 extern double extract_float (Lisp_Object
);
3517 extern void syms_of_floatfns (void);
3518 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3520 /* Defined in fringe.c. */
3521 extern void syms_of_fringe (void);
3522 extern void init_fringe (void);
3523 #ifdef HAVE_WINDOW_SYSTEM
3524 extern void mark_fringe_data (void);
3525 extern void init_fringe_once (void);
3526 #endif /* HAVE_WINDOW_SYSTEM */
3528 /* Defined in image.c. */
3529 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3530 extern Lisp_Object QCconversion
;
3531 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3532 extern void reset_image_types (void);
3533 extern void syms_of_image (void);
3535 /* Defined in insdel.c. */
3536 extern Lisp_Object Qinhibit_modification_hooks
;
3537 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3538 extern _Noreturn
void buffer_overflow (void);
3539 extern void make_gap (ptrdiff_t);
3540 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3541 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3542 ptrdiff_t, bool, bool);
3543 extern int count_combining_before (const unsigned char *,
3544 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3545 extern int count_combining_after (const unsigned char *,
3546 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3547 extern void insert (const char *, ptrdiff_t);
3548 extern void insert_and_inherit (const char *, ptrdiff_t);
3549 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3551 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3552 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3553 ptrdiff_t, ptrdiff_t, bool);
3554 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3555 extern void insert_char (int);
3556 extern void insert_string (const char *);
3557 extern void insert_before_markers (const char *, ptrdiff_t);
3558 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3559 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3560 ptrdiff_t, ptrdiff_t,
3562 extern void del_range (ptrdiff_t, ptrdiff_t);
3563 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3564 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3565 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3566 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3567 ptrdiff_t, ptrdiff_t, bool);
3568 extern void modify_text (ptrdiff_t, ptrdiff_t);
3569 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3570 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3571 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3572 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3573 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3574 ptrdiff_t, ptrdiff_t);
3575 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3576 ptrdiff_t, ptrdiff_t);
3577 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3578 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3579 const char *, ptrdiff_t, ptrdiff_t, bool);
3580 extern void syms_of_insdel (void);
3582 /* Defined in dispnew.c. */
3583 #if (defined PROFILING \
3584 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3585 _Noreturn
void __executable_start (void);
3587 extern Lisp_Object Vwindow_system
;
3588 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3589 extern void init_display (void);
3590 extern void syms_of_display (void);
3592 /* Defined in xdisp.c. */
3593 extern Lisp_Object Qinhibit_point_motion_hooks
;
3594 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
3595 extern Lisp_Object Qmenu_bar_update_hook
;
3596 extern Lisp_Object Qwindow_scroll_functions
;
3597 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3598 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3599 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3600 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
3601 extern Lisp_Object Qleft_margin
, Qright_margin
;
3602 extern Lisp_Object QCdata
, QCfile
;
3603 extern Lisp_Object QCmap
;
3604 extern Lisp_Object Qrisky_local_variable
;
3605 extern bool noninteractive_need_newline
;
3606 extern Lisp_Object echo_area_buffer
[2];
3607 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3608 extern void check_message_stack (void);
3609 extern void setup_echo_area_for_printing (int);
3610 extern bool push_message (void);
3611 extern void pop_message_unwind (void);
3612 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3613 extern void restore_message (void);
3614 extern Lisp_Object
current_message (void);
3615 extern void clear_message (bool, bool);
3616 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3617 extern void message1 (const char *);
3618 extern void message1_nolog (const char *);
3619 extern void message3 (Lisp_Object
);
3620 extern void message3_nolog (Lisp_Object
);
3621 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3622 extern void message_with_string (const char *, Lisp_Object
, int);
3623 extern void message_log_maybe_newline (void);
3624 extern void update_echo_area (void);
3625 extern void truncate_echo_area (ptrdiff_t);
3626 extern void redisplay (void);
3627 extern void redisplay_preserve_echo_area (int);
3629 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3630 extern void syms_of_xdisp (void);
3631 extern void init_xdisp (void);
3632 extern Lisp_Object
safe_eval (Lisp_Object
);
3633 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3634 int *, int *, int *, int *, int *);
3636 /* Defined in xsettings.c. */
3637 extern void syms_of_xsettings (void);
3639 /* Defined in vm-limit.c. */
3640 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3642 /* Defined in alloc.c. */
3643 extern void check_pure_size (void);
3644 extern void free_misc (Lisp_Object
);
3645 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3646 extern void malloc_warning (const char *);
3647 extern _Noreturn
void memory_full (size_t);
3648 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3649 extern bool survives_gc_p (Lisp_Object
);
3650 extern void mark_object (Lisp_Object
);
3651 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3652 extern void refill_memory_reserve (void);
3654 extern const char *pending_malloc_warning
;
3655 extern Lisp_Object zero_vector
;
3656 extern Lisp_Object
*stack_base
;
3657 extern EMACS_INT consing_since_gc
;
3658 extern EMACS_INT gc_relative_threshold
;
3659 extern EMACS_INT memory_full_cons_threshold
;
3660 extern Lisp_Object
list1 (Lisp_Object
);
3661 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3662 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3663 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3664 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3666 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3667 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3669 /* Build a frequently used 2/3/4-integer lists. */
3672 list2i (EMACS_INT x
, EMACS_INT y
)
3674 return list2 (make_number (x
), make_number (y
));
3678 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3680 return list3 (make_number (x
), make_number (y
), make_number (w
));
3684 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3686 return list4 (make_number (x
), make_number (y
),
3687 make_number (w
), make_number (h
));
3690 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3691 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3692 extern _Noreturn
void string_overflow (void);
3693 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3694 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3695 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3696 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3698 /* Make unibyte string from C string when the length isn't known. */
3701 build_unibyte_string (const char *str
)
3703 return make_unibyte_string (str
, strlen (str
));
3706 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3707 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3708 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3709 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3710 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3711 extern Lisp_Object
make_specified_string (const char *,
3712 ptrdiff_t, ptrdiff_t, bool);
3713 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3714 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3716 /* Make a string allocated in pure space, use STR as string data. */
3719 build_pure_c_string (const char *str
)
3721 return make_pure_c_string (str
, strlen (str
));
3724 /* Make a string from the data at STR, treating it as multibyte if the
3728 build_string (const char *str
)
3730 return make_string (str
, strlen (str
));
3733 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3734 extern void make_byte_code (struct Lisp_Vector
*);
3735 extern Lisp_Object Qautomatic_gc
;
3736 extern Lisp_Object Qchar_table_extra_slots
;
3737 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3739 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3740 be sure that GC cannot happen until the vector is completely
3741 initialized. E.g. the following code is likely to crash:
3743 v = make_uninit_vector (3);
3745 ASET (v, 1, Ffunction_can_gc ());
3746 ASET (v, 2, obj1); */
3749 make_uninit_vector (ptrdiff_t size
)
3752 struct Lisp_Vector
*p
;
3754 p
= allocate_vector (size
);
3759 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3760 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3762 allocate_pseudovector \
3763 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3764 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3765 extern struct window
*allocate_window (void);
3766 extern struct frame
*allocate_frame (void);
3767 extern struct Lisp_Process
*allocate_process (void);
3768 extern struct terminal
*allocate_terminal (void);
3769 extern bool gc_in_progress
;
3770 extern bool abort_on_gc
;
3771 extern Lisp_Object
make_float (double);
3772 extern void display_malloc_warning (void);
3773 extern ptrdiff_t inhibit_garbage_collection (void);
3774 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3775 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3776 Lisp_Object
, Lisp_Object
);
3777 extern Lisp_Object
make_save_ptr (void *);
3778 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3779 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3780 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3782 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3783 extern void free_save_value (Lisp_Object
);
3784 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3785 extern void free_marker (Lisp_Object
);
3786 extern void free_cons (struct Lisp_Cons
*);
3787 extern void init_alloc_once (void);
3788 extern void init_alloc (void);
3789 extern void syms_of_alloc (void);
3790 extern struct buffer
* allocate_buffer (void);
3791 extern int valid_lisp_object_p (Lisp_Object
);
3792 extern int relocatable_string_data_p (const char *);
3793 #ifdef GC_CHECK_CONS_LIST
3794 extern void check_cons_list (void);
3796 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3800 /* Defined in ralloc.c. */
3801 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3802 extern void r_alloc_free (void **);
3803 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3804 extern void r_alloc_reset_variable (void **, void **);
3805 extern void r_alloc_inhibit_buffer_relocation (int);
3808 /* Defined in chartab.c. */
3809 extern Lisp_Object
copy_char_table (Lisp_Object
);
3810 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
3811 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3813 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3814 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3815 extern int char_table_translate (Lisp_Object
, int);
3816 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3818 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3819 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3820 Lisp_Object
, Lisp_Object
,
3821 Lisp_Object
, struct charset
*,
3822 unsigned, unsigned);
3823 extern Lisp_Object
uniprop_table (Lisp_Object
);
3824 extern void syms_of_chartab (void);
3826 /* Defined in print.c. */
3827 extern Lisp_Object Vprin1_to_string_buffer
;
3828 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3829 extern Lisp_Object Qstandard_output
;
3830 extern Lisp_Object Qexternal_debugging_output
;
3831 extern void temp_output_buffer_setup (const char *);
3832 extern int print_level
;
3833 extern Lisp_Object Qprint_escape_newlines
;
3834 extern void write_string (const char *, int);
3835 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3837 extern Lisp_Object internal_with_output_to_temp_buffer
3838 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3839 #define FLOAT_TO_STRING_BUFSIZE 350
3840 extern int float_to_string (char *, double);
3841 extern void init_print_once (void);
3842 extern void syms_of_print (void);
3844 /* Defined in doprnt.c. */
3845 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3847 extern ptrdiff_t esprintf (char *, char const *, ...)
3848 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3849 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3851 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3852 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3853 char const *, va_list)
3854 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3856 /* Defined in lread.c. */
3857 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3858 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3859 extern Lisp_Object Qlexical_binding
;
3860 extern Lisp_Object
check_obarray (Lisp_Object
);
3861 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3862 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3863 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3865 LOADHIST_ATTACH (Lisp_Object x
)
3868 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3870 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3871 Lisp_Object
*, Lisp_Object
, bool);
3872 extern Lisp_Object
string_to_number (char const *, int, bool);
3873 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3875 extern void dir_warning (const char *, Lisp_Object
);
3876 extern void init_obarray (void);
3877 extern void init_lread (void);
3878 extern void syms_of_lread (void);
3881 intern (const char *str
)
3883 return intern_1 (str
, strlen (str
));
3887 intern_c_string (const char *str
)
3889 return intern_c_string_1 (str
, strlen (str
));
3892 /* Defined in eval.c. */
3893 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3894 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3895 extern Lisp_Object Qand_rest
;
3896 extern Lisp_Object Vautoload_queue
;
3897 extern Lisp_Object Vsignaling_function
;
3898 extern Lisp_Object inhibit_lisp_code
;
3899 extern struct handler
*handlerlist
;
3901 /* To run a normal hook, use the appropriate function from the list below.
3902 The calling convention:
3904 if (!NILP (Vrun_hooks))
3905 call1 (Vrun_hooks, Qmy_funny_hook);
3907 should no longer be used. */
3908 extern Lisp_Object Vrun_hooks
;
3909 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3910 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3911 Lisp_Object (*funcall
)
3912 (ptrdiff_t nargs
, Lisp_Object
*args
));
3913 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3914 extern _Noreturn
void xsignal0 (Lisp_Object
);
3915 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3916 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3917 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3919 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3920 extern Lisp_Object
eval_sub (Lisp_Object form
);
3921 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3922 extern Lisp_Object
call0 (Lisp_Object
);
3923 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3924 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3925 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3926 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3927 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3928 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3929 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3930 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3931 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3932 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3933 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3934 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3935 extern Lisp_Object internal_condition_case_n
3936 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3937 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3938 extern void specbind (Lisp_Object
, Lisp_Object
);
3939 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3940 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3941 extern void record_unwind_protect_int (void (*) (int), int);
3942 extern void record_unwind_protect_void (void (*) (void));
3943 extern void record_unwind_protect_nothing (void);
3944 extern void clear_unwind_protect (ptrdiff_t);
3945 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3946 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3947 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3948 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3949 extern _Noreturn
void verror (const char *, va_list)
3950 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3951 extern void un_autoload (Lisp_Object
);
3952 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3953 extern void init_eval_once (void);
3954 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3955 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3956 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3957 extern void init_eval (void);
3958 extern void syms_of_eval (void);
3959 extern void unwind_body (Lisp_Object
);
3960 extern void record_in_backtrace (Lisp_Object function
,
3961 Lisp_Object
*args
, ptrdiff_t nargs
);
3962 extern void mark_specpdl (void);
3963 extern void get_backtrace (Lisp_Object array
);
3964 Lisp_Object
backtrace_top_function (void);
3965 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3966 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3969 /* Defined in editfns.c. */
3970 extern Lisp_Object Qfield
;
3971 extern void insert1 (Lisp_Object
);
3972 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3973 extern Lisp_Object
save_excursion_save (void);
3974 extern Lisp_Object
save_restriction_save (void);
3975 extern void save_excursion_restore (Lisp_Object
);
3976 extern void save_restriction_restore (Lisp_Object
);
3977 extern _Noreturn
void time_overflow (void);
3978 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3979 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3981 extern void init_editfns (void);
3982 extern void syms_of_editfns (void);
3983 extern void set_time_zone_rule (const char *);
3985 /* Defined in buffer.c. */
3986 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3987 extern _Noreturn
void nsberror (Lisp_Object
);
3988 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3989 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3990 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3991 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3992 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3993 extern bool overlay_touches_p (ptrdiff_t);
3994 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3995 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3996 extern void init_buffer_once (void);
3997 extern void init_buffer (int);
3998 extern void syms_of_buffer (void);
3999 extern void keys_of_buffer (void);
4001 /* Defined in marker.c. */
4003 extern ptrdiff_t marker_position (Lisp_Object
);
4004 extern ptrdiff_t marker_byte_position (Lisp_Object
);
4005 extern void clear_charpos_cache (struct buffer
*);
4006 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
4007 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
4008 extern void unchain_marker (struct Lisp_Marker
*marker
);
4009 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4010 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
4011 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
4012 ptrdiff_t, ptrdiff_t);
4013 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
4014 extern void syms_of_marker (void);
4016 /* Defined in fileio.c. */
4018 extern Lisp_Object Qfile_error
;
4019 extern Lisp_Object Qfile_notify_error
;
4020 extern Lisp_Object Qfile_exists_p
;
4021 extern Lisp_Object Qfile_directory_p
;
4022 extern Lisp_Object Qinsert_file_contents
;
4023 extern Lisp_Object Qfile_name_history
;
4024 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
4025 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4026 Lisp_Object
, Lisp_Object
, Lisp_Object
,
4028 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
4029 extern void close_file_unwind (int);
4030 extern void fclose_unwind (void *);
4031 extern void restore_point_unwind (Lisp_Object
);
4032 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
4033 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
4034 extern bool internal_delete_file (Lisp_Object
);
4035 extern Lisp_Object
emacs_readlinkat (int, const char *);
4036 extern bool file_directory_p (const char *);
4037 extern bool file_accessible_directory_p (const char *);
4038 extern void init_fileio (void);
4039 extern void syms_of_fileio (void);
4040 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
4041 extern Lisp_Object Qdelete_file
;
4043 /* Defined in search.c. */
4044 extern void shrink_regexp_cache (void);
4045 extern void restore_search_regs (void);
4046 extern void record_unwind_save_match_data (void);
4047 struct re_registers
;
4048 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4049 struct re_registers
*,
4050 Lisp_Object
, bool, bool);
4051 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
4052 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4054 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
4055 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4056 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4057 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4058 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4059 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4061 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4062 ptrdiff_t, ptrdiff_t *);
4063 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4064 ptrdiff_t, ptrdiff_t *);
4065 extern void syms_of_search (void);
4066 extern void clear_regexp_cache (void);
4068 /* Defined in minibuf.c. */
4070 extern Lisp_Object Qcompletion_ignore_case
;
4071 extern Lisp_Object Vminibuffer_list
;
4072 extern Lisp_Object last_minibuf_string
;
4073 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4074 extern void init_minibuf_once (void);
4075 extern void syms_of_minibuf (void);
4077 /* Defined in callint.c. */
4079 extern Lisp_Object Qminus
, Qplus
;
4080 extern Lisp_Object Qprogn
;
4081 extern Lisp_Object Qwhen
;
4082 extern Lisp_Object Qmouse_leave_buffer_hook
;
4083 extern void syms_of_callint (void);
4085 /* Defined in casefiddle.c. */
4087 extern Lisp_Object Qidentity
;
4088 extern void syms_of_casefiddle (void);
4089 extern void keys_of_casefiddle (void);
4091 /* Defined in casetab.c. */
4093 extern void init_casetab_once (void);
4094 extern void syms_of_casetab (void);
4096 /* Defined in keyboard.c. */
4098 extern Lisp_Object echo_message_buffer
;
4099 extern struct kboard
*echo_kboard
;
4100 extern void cancel_echoing (void);
4101 extern Lisp_Object Qdisabled
, QCfilter
;
4102 extern Lisp_Object Qup
, Qdown
, Qbottom
;
4103 extern Lisp_Object Qtop
;
4104 extern Lisp_Object last_undo_boundary
;
4105 extern bool input_pending
;
4106 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4107 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4108 extern void discard_mouse_events (void);
4110 void handle_input_available_signal (int);
4112 extern Lisp_Object pending_funcalls
;
4113 extern bool detect_input_pending (void);
4114 extern bool detect_input_pending_ignore_squeezables (void);
4115 extern bool detect_input_pending_run_timers (bool);
4116 extern void safe_run_hooks (Lisp_Object
);
4117 extern void cmd_error_internal (Lisp_Object
, const char *);
4118 extern Lisp_Object
command_loop_1 (void);
4119 extern Lisp_Object
read_menu_command (void);
4120 extern Lisp_Object
recursive_edit_1 (void);
4121 extern void record_auto_save (void);
4122 extern void force_auto_save_soon (void);
4123 extern void init_keyboard (void);
4124 extern void syms_of_keyboard (void);
4125 extern void keys_of_keyboard (void);
4127 /* Defined in indent.c. */
4128 extern ptrdiff_t current_column (void);
4129 extern void invalidate_current_column (void);
4130 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4131 extern void syms_of_indent (void);
4133 /* Defined in frame.c. */
4134 extern Lisp_Object Qonly
, Qnone
;
4135 extern Lisp_Object Qvisible
;
4136 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4137 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4138 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4139 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4140 #if HAVE_NS || HAVE_NTGUI
4141 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4143 extern void frames_discard_buffer (Lisp_Object
);
4144 extern void syms_of_frame (void);
4146 /* Defined in emacs.c. */
4147 extern char **initial_argv
;
4148 extern int initial_argc
;
4149 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4150 extern bool display_arg
;
4152 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4153 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4154 extern Lisp_Object Qfile_name_handler_alist
;
4155 extern _Noreturn
void terminate_due_to_signal (int, int);
4156 extern Lisp_Object Qkill_emacs
;
4158 extern Lisp_Object Vlibrary_cache
;
4161 void fixup_locale (void);
4162 void synchronize_system_messages_locale (void);
4163 void synchronize_system_time_locale (void);
4165 INLINE
void fixup_locale (void) {}
4166 INLINE
void synchronize_system_messages_locale (void) {}
4167 INLINE
void synchronize_system_time_locale (void) {}
4169 extern void shut_down_emacs (int, Lisp_Object
);
4171 /* True means don't do interactive redisplay and don't change tty modes. */
4172 extern bool noninteractive
;
4174 /* True means remove site-lisp directories from load-path. */
4175 extern bool no_site_lisp
;
4177 /* Pipe used to send exit notification to the daemon parent at
4179 extern int daemon_pipe
[2];
4180 #define IS_DAEMON (daemon_pipe[1] != 0)
4182 /* True if handling a fatal error already. */
4183 extern bool fatal_error_in_progress
;
4185 /* True means don't do use window-system-specific display code. */
4186 extern bool inhibit_window_system
;
4187 /* True means that a filter or a sentinel is running. */
4188 extern bool running_asynch_code
;
4190 /* Defined in process.c. */
4191 extern Lisp_Object QCtype
, Qlocal
;
4192 extern void kill_buffer_processes (Lisp_Object
);
4193 extern bool wait_reading_process_output (intmax_t, int, int, bool,
4195 struct Lisp_Process
*,
4197 /* Max value for the first argument of wait_reading_process_output. */
4198 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4199 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4200 The bug merely causes a bogus warning, but the warning is annoying. */
4201 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4203 # define WAIT_READING_MAX INTMAX_MAX
4205 extern void add_keyboard_wait_descriptor (int);
4206 extern void delete_keyboard_wait_descriptor (int);
4208 extern void add_gpm_wait_descriptor (int);
4209 extern void delete_gpm_wait_descriptor (int);
4211 extern void init_process_emacs (void);
4212 extern void syms_of_process (void);
4213 extern void setup_process_coding_systems (Lisp_Object
);
4215 /* Defined in callproc.c. */
4219 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4220 extern void init_callproc_1 (void);
4221 extern void init_callproc (void);
4222 extern void set_initial_environment (void);
4223 extern void syms_of_callproc (void);
4225 /* Defined in doc.c. */
4226 extern Lisp_Object Qfunction_documentation
;
4227 extern Lisp_Object
read_doc_string (Lisp_Object
);
4228 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4229 extern void syms_of_doc (void);
4230 extern int read_bytecode_char (bool);
4232 /* Defined in bytecode.c. */
4233 extern void syms_of_bytecode (void);
4234 extern struct byte_stack
*byte_stack_list
;
4236 extern void mark_byte_stack (void);
4238 extern void unmark_byte_stack (void);
4239 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4240 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4242 /* Defined in macros.c. */
4243 extern void init_macros (void);
4244 extern void syms_of_macros (void);
4246 /* Defined in undo.c. */
4247 extern Lisp_Object Qapply
;
4248 extern Lisp_Object Qinhibit_read_only
;
4249 extern void truncate_undo_list (struct buffer
*);
4250 extern void record_insert (ptrdiff_t, ptrdiff_t);
4251 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4252 extern void record_first_change (void);
4253 extern void record_change (ptrdiff_t, ptrdiff_t);
4254 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4255 Lisp_Object
, Lisp_Object
,
4257 extern void syms_of_undo (void);
4258 /* Defined in textprop.c. */
4259 extern Lisp_Object Qfont
, Qmouse_face
;
4260 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
4261 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
4262 extern Lisp_Object Qminibuffer_prompt
;
4264 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4266 /* Defined in menu.c. */
4267 extern void syms_of_menu (void);
4269 /* Defined in xmenu.c. */
4270 extern void syms_of_xmenu (void);
4272 /* Defined in termchar.h. */
4273 struct tty_display_info
;
4275 /* Defined in termhooks.h. */
4278 /* Defined in sysdep.c. */
4279 #ifndef HAVE_GET_CURRENT_DIR_NAME
4280 extern char *get_current_dir_name (void);
4282 extern void stuff_char (char c
);
4283 extern void init_foreground_group (void);
4284 extern void init_sigio (int);
4285 extern void sys_subshell (void);
4286 extern void sys_suspend (void);
4287 extern void discard_tty_input (void);
4288 extern void init_sys_modes (struct tty_display_info
*);
4289 extern void reset_sys_modes (struct tty_display_info
*);
4290 extern void init_all_sys_modes (void);
4291 extern void reset_all_sys_modes (void);
4292 extern void child_setup_tty (int);
4293 extern void setup_pty (int);
4294 extern int set_window_size (int, int, int);
4295 extern EMACS_INT
get_random (void);
4296 extern void seed_random (void *, ptrdiff_t);
4297 extern void init_random (void);
4298 extern void emacs_backtrace (int);
4299 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4300 extern int emacs_open (const char *, int, int);
4301 extern int emacs_pipe (int[2]);
4302 extern int emacs_close (int);
4303 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4304 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4305 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4306 extern void emacs_perror (char const *);
4308 extern void unlock_all_files (void);
4309 extern void lock_file (Lisp_Object
);
4310 extern void unlock_file (Lisp_Object
);
4311 extern void unlock_buffer (struct buffer
*);
4312 extern void syms_of_filelock (void);
4314 /* Defined in sound.c. */
4315 extern void syms_of_sound (void);
4317 /* Defined in category.c. */
4318 extern void init_category_once (void);
4319 extern Lisp_Object
char_category_set (int);
4320 extern void syms_of_category (void);
4322 /* Defined in ccl.c. */
4323 extern void syms_of_ccl (void);
4325 /* Defined in dired.c. */
4326 extern void syms_of_dired (void);
4327 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4328 Lisp_Object
, Lisp_Object
,
4331 /* Defined in term.c. */
4332 extern int *char_ins_del_vector
;
4333 extern void syms_of_term (void);
4334 extern _Noreturn
void fatal (const char *msgid
, ...)
4335 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4337 /* Defined in terminal.c. */
4338 extern void syms_of_terminal (void);
4340 /* Defined in font.c. */
4341 extern void syms_of_font (void);
4342 extern void init_font (void);
4344 #ifdef HAVE_WINDOW_SYSTEM
4345 /* Defined in fontset.c. */
4346 extern void syms_of_fontset (void);
4348 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4349 extern Lisp_Object Qfont_param
;
4352 /* Defined in gfilenotify.c */
4353 #ifdef HAVE_GFILENOTIFY
4354 extern void globals_of_gfilenotify (void);
4355 extern void syms_of_gfilenotify (void);
4358 /* Defined in inotify.c */
4360 extern void syms_of_inotify (void);
4363 #ifdef HAVE_W32NOTIFY
4364 /* Defined on w32notify.c. */
4365 extern void syms_of_w32notify (void);
4368 /* Defined in xfaces.c. */
4369 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
4370 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
4371 extern Lisp_Object Qmode_line_inactive
;
4372 extern Lisp_Object Qface
;
4373 extern Lisp_Object Qnormal
;
4374 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4375 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4376 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4377 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4378 extern Lisp_Object Qoblique
, Qitalic
;
4379 extern Lisp_Object Vface_alternative_font_family_alist
;
4380 extern Lisp_Object Vface_alternative_font_registry_alist
;
4381 extern void syms_of_xfaces (void);
4383 #ifdef HAVE_X_WINDOWS
4384 /* Defined in xfns.c. */
4385 extern void syms_of_xfns (void);
4387 /* Defined in xsmfns.c. */
4388 extern void syms_of_xsmfns (void);
4390 /* Defined in xselect.c. */
4391 extern void syms_of_xselect (void);
4393 /* Defined in xterm.c. */
4394 extern void syms_of_xterm (void);
4395 #endif /* HAVE_X_WINDOWS */
4397 #ifdef HAVE_WINDOW_SYSTEM
4398 /* Defined in xterm.c, nsterm.m, w32term.c. */
4399 extern char *x_get_keysym_name (int);
4400 #endif /* HAVE_WINDOW_SYSTEM */
4403 /* Defined in xml.c. */
4404 extern void syms_of_xml (void);
4405 extern void xml_cleanup_parser (void);
4409 /* Defined in decompress.c. */
4410 extern void syms_of_decompress (void);
4414 /* Defined in dbusbind.c. */
4415 void syms_of_dbusbind (void);
4419 /* Defined in profiler.c. */
4420 extern bool profiler_memory_running
;
4421 extern void malloc_probe (size_t);
4422 extern void syms_of_profiler (void);
4426 /* Defined in msdos.c, w32.c. */
4427 extern char *emacs_root_dir (void);
4430 /* True means Emacs has already been initialized.
4431 Used during startup to detect startup of dumped Emacs. */
4432 extern bool initialized
;
4434 /* True means ^G can quit instantly. */
4435 extern bool immediate_quit
;
4437 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4438 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4439 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4440 extern void xfree (void *);
4441 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4442 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4443 ATTRIBUTE_ALLOC_SIZE ((2,3));
4444 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4446 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4447 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4448 extern void dupstring (char **, char const *);
4449 extern void xputenv (const char *);
4451 extern char *egetenv (const char *);
4453 /* Copy Lisp string to temporary (allocated on stack) C string. */
4455 #define xlispstrdupa(string) \
4456 memcpy (alloca (SBYTES (string) + 1), \
4457 SSDATA (string), SBYTES (string) + 1)
4459 /* Set up the name of the machine we're running on. */
4460 extern void init_system_name (void);
4462 /* Return the absolute value of X. X should be a signed integer
4463 expression without side effects, and X's absolute value should not
4464 exceed the maximum for its promoted type. This is called 'eabs'
4465 because 'abs' is reserved by the C standard. */
4466 #define eabs(x) ((x) < 0 ? -(x) : (x))
4468 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4471 #define make_fixnum_or_float(val) \
4472 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4474 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4475 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4477 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4479 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4481 #define USE_SAFE_ALLOCA \
4482 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4484 /* SAFE_ALLOCA allocates a simple buffer. */
4486 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4488 : (sa_must_free = true, record_xmalloc (size)))
4490 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4491 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4492 positive. The code is tuned for MULTIPLIER being a constant. */
4494 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4496 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4497 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4500 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4501 sa_must_free = true; \
4502 record_unwind_protect_ptr (xfree, buf); \
4506 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4508 #define SAFE_FREE() \
4510 if (sa_must_free) { \
4511 sa_must_free = false; \
4512 unbind_to (sa_count, Qnil); \
4517 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4519 #define SAFE_ALLOCA_LISP(buf, nelt) \
4521 if ((nelt) < MAX_ALLOCA / word_size) \
4522 (buf) = alloca ((nelt) * word_size); \
4523 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4526 (buf) = xmalloc ((nelt) * word_size); \
4527 arg_ = make_save_memory (buf, nelt); \
4528 sa_must_free = true; \
4529 record_unwind_protect (free_save_value, arg_); \
4532 memory_full (SIZE_MAX); \
4535 /* Loop over all tails of a list, checking for cycles.
4536 FIXME: Make tortoise and n internal declarations.
4537 FIXME: Unroll the loop body so we don't need `n'. */
4538 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4539 for ((tortoise) = (hare) = (list), (n) = true; \
4541 (hare = XCDR (hare), (n) = !(n), \
4543 ? (EQ (hare, tortoise) \
4544 ? xsignal1 (Qcircular_list, list) \
4546 /* Move tortoise before the next iteration, in case */ \
4547 /* the next iteration does an Fsetcdr. */ \
4548 : (void) ((tortoise) = XCDR (tortoise)))))
4550 /* Do a `for' loop over alist values. */
4552 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4553 for ((list_var) = (head_var); \
4554 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4555 (list_var) = XCDR (list_var))
4557 /* Check whether it's time for GC, and run it if so. */
4562 if ((consing_since_gc
> gc_cons_threshold
4563 && consing_since_gc
> gc_relative_threshold
)
4564 || (!NILP (Vmemory_full
)
4565 && consing_since_gc
> memory_full_cons_threshold
))
4566 Fgarbage_collect ();
4570 functionp (Lisp_Object object
)
4572 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4574 object
= Findirect_function (object
, Qt
);
4576 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4578 /* Autoloaded symbols are functions, except if they load
4579 macros or keymaps. */
4581 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4582 object
= XCDR (object
);
4584 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4589 return XSUBR (object
)->max_args
!= UNEVALLED
;
4590 else if (COMPILEDP (object
))
4592 else if (CONSP (object
))
4594 Lisp_Object car
= XCAR (object
);
4595 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4603 #endif /* EMACS_LISP_H */