1 /* Fundamental definitions for GNU Emacs Lisp interpreter. -*- coding: utf-8 -*-
3 Copyright (C) 1985-1987, 1993-1995, 1997-2015 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
39 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
40 # define ID (some integer preprocessor expression of type TYPE)
41 DEFINE_GDB_SYMBOL_END (ID)
43 This hack is for the benefit of compilers that do not make macro
44 definitions or enums visible to the debugger. It's used for symbols
45 that .gdbinit needs. */
47 #define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
49 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
50 # define DEFINE_GDB_SYMBOL_END(id) = id;
52 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
53 # define DEFINE_GDB_SYMBOL_END(val) ;
56 /* The ubiquitous max and min macros. */
59 #define max(a, b) ((a) > (b) ? (a) : (b))
60 #define min(a, b) ((a) < (b) ? (a) : (b))
62 /* Number of elements in an array. */
63 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
65 /* Number of bits in a Lisp_Object tag. */
66 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
68 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
70 /* The number of bits needed in an EMACS_INT over and above the number
71 of bits in a pointer. This is 0 on systems where:
72 1. We can specify multiple-of-8 alignment on static variables.
73 2. We know malloc returns a multiple of 8. */
74 #if (defined alignas \
75 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
76 || defined DARWIN_OS || defined __sun || defined __MINGW32__ \
78 # define NONPOINTER_BITS 0
80 # define NONPOINTER_BITS GCTYPEBITS
83 /* EMACS_INT - signed integer wide enough to hold an Emacs value
84 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
85 pI - printf length modifier for EMACS_INT
86 EMACS_UINT - unsigned variant of EMACS_INT */
89 # error "INTPTR_MAX misconfigured"
90 # elif INTPTR_MAX <= INT_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
91 typedef int EMACS_INT
;
92 typedef unsigned int EMACS_UINT
;
93 # define EMACS_INT_MAX INT_MAX
95 # elif INTPTR_MAX <= LONG_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
96 typedef long int EMACS_INT
;
97 typedef unsigned long EMACS_UINT
;
98 # define EMACS_INT_MAX LONG_MAX
100 /* Check versus LLONG_MAX, not LLONG_MAX >> NONPOINTER_BITS.
101 In theory this is not safe, but in practice it seems to be OK. */
102 # elif INTPTR_MAX <= LLONG_MAX
103 typedef long long int EMACS_INT
;
104 typedef unsigned long long int EMACS_UINT
;
105 # define EMACS_INT_MAX LLONG_MAX
108 # error "INTPTR_MAX too large"
112 /* Number of bits to put in each character in the internal representation
113 of bool vectors. This should not vary across implementations. */
114 enum { BOOL_VECTOR_BITS_PER_CHAR
=
115 #define BOOL_VECTOR_BITS_PER_CHAR 8
116 BOOL_VECTOR_BITS_PER_CHAR
119 /* An unsigned integer type representing a fixed-length bit sequence,
120 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
121 for speed, but it is unsigned char on weird platforms. */
122 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
123 typedef size_t bits_word
;
124 # define BITS_WORD_MAX SIZE_MAX
125 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
127 typedef unsigned char bits_word
;
128 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
129 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
131 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
133 /* Number of bits in some machine integer types. */
136 BITS_PER_CHAR
= CHAR_BIT
,
137 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
138 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
139 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
142 /* printmax_t and uprintmax_t are types for printing large integers.
143 These are the widest integers that are supported for printing.
144 pMd etc. are conversions for printing them.
145 On C99 hosts, there's no problem, as even the widest integers work.
146 Fall back on EMACS_INT on pre-C99 hosts. */
148 typedef intmax_t printmax_t
;
149 typedef uintmax_t uprintmax_t
;
153 typedef EMACS_INT printmax_t
;
154 typedef EMACS_UINT uprintmax_t
;
159 /* Use pD to format ptrdiff_t values, which suffice for indexes into
160 buffers and strings. Emacs never allocates objects larger than
161 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
162 In C99, pD can always be "t"; configure it here for the sake of
163 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
164 #if PTRDIFF_MAX == INT_MAX
166 #elif PTRDIFF_MAX == LONG_MAX
168 #elif PTRDIFF_MAX == LLONG_MAX
174 /* Extra internal type checking? */
176 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
177 'assume (COND)'. COND should be free of side effects, as it may or
178 may not be evaluated.
180 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
181 defined and suppress_checking is false, and does nothing otherwise.
182 Emacs dies if COND is checked and is false. The suppress_checking
183 variable is initialized to 0 in alloc.c. Set it to 1 using a
184 debugger to temporarily disable aborting on detected internal
185 inconsistencies or error conditions.
187 In some cases, a good compiler may be able to optimize away the
188 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
189 uses eassert to test STRINGP (x), but a particular use of XSTRING
190 is invoked only after testing that STRINGP (x) is true, making the
193 eassume is like eassert except that it also causes the compiler to
194 assume that COND is true afterwards, regardless of whether runtime
195 checking is enabled. This can improve performance in some cases,
196 though it can degrade performance in others. It's often suboptimal
197 for COND to call external functions or access volatile storage. */
199 #ifndef ENABLE_CHECKING
200 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
201 # define eassume(cond) assume (cond)
202 #else /* ENABLE_CHECKING */
204 extern _Noreturn
void die (const char *, const char *, int);
206 extern bool suppress_checking EXTERNALLY_VISIBLE
;
208 # define eassert(cond) \
209 (suppress_checking || (cond) \
211 : die (# cond, __FILE__, __LINE__))
212 # define eassume(cond) \
217 : die (# cond, __FILE__, __LINE__))
218 #endif /* ENABLE_CHECKING */
221 /* Use the configure flag --enable-check-lisp-object-type to make
222 Lisp_Object use a struct type instead of the default int. The flag
223 causes CHECK_LISP_OBJECT_TYPE to be defined. */
225 /***** Select the tagging scheme. *****/
226 /* The following option controls the tagging scheme:
227 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
228 always 0, and we can thus use them to hold tag bits, without
229 restricting our addressing space.
231 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
232 restricting our possible address range.
234 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
235 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
236 on the few static Lisp_Objects used: lispsym, all the defsubr, and
237 the two special buffers buffer_defaults and buffer_local_symbols. */
241 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
242 integer constant, for MSVC. */
243 #define GCALIGNMENT 8
245 /* Number of bits in a Lisp_Object value, not counting the tag. */
246 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
248 /* Number of bits in a Lisp fixnum tag. */
249 INTTYPEBITS
= GCTYPEBITS
- 1,
251 /* Number of bits in a Lisp fixnum value, not counting the tag. */
252 FIXNUM_BITS
= VALBITS
+ 1
255 #if GCALIGNMENT != 1 << GCTYPEBITS
256 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
259 /* The maximum value that can be stored in a EMACS_INT, assuming all
260 bits other than the type bits contribute to a nonnegative signed value.
261 This can be used in #if, e.g., '#if USE_LSB_TAG' below expands to an
262 expression involving VAL_MAX. */
263 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
265 /* Whether the least-significant bits of an EMACS_INT contain the tag.
266 On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
267 a. unnecessary, because the top bits of an EMACS_INT are unused, and
268 b. slower, because it typically requires extra masking.
269 So, USE_LSB_TAG is true only on hosts where it might be useful. */
270 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
271 #define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
272 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
274 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
275 # error "USE_LSB_TAG not supported on this platform; please report this." \
276 "Try 'configure --with-wide-int' to work around the problem."
281 # error "alignas not defined"
284 #ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
285 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
287 # define GCALIGNED /* empty */
290 /* Some operations are so commonly executed that they are implemented
291 as macros, not functions, because otherwise runtime performance would
292 suffer too much when compiling with GCC without optimization.
293 There's no need to inline everything, just the operations that
294 would otherwise cause a serious performance problem.
296 For each such operation OP, define a macro lisp_h_OP that contains
297 the operation's implementation. That way, OP can be implemented
298 via a macro definition like this:
300 #define OP(x) lisp_h_OP (x)
302 and/or via a function definition like this:
304 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
306 without worrying about the implementations diverging, since
307 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
308 are intended to be private to this include file, and should not be
311 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
312 functions, once most developers have access to GCC 4.8 or later and
313 can use "gcc -Og" to debug. Maybe in the year 2016. See
316 Commentary for these macros can be found near their corresponding
319 #if CHECK_LISP_OBJECT_TYPE
320 # define lisp_h_XLI(o) ((o).i)
321 # define lisp_h_XIL(i) ((Lisp_Object) { i })
323 # define lisp_h_XLI(o) (o)
324 # define lisp_h_XIL(i) (i)
326 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
327 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
328 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
329 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
330 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
331 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
332 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
333 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
334 #define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
335 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
336 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
337 #define lisp_h_NILP(x) EQ (x, Qnil)
338 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
339 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
340 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
341 #define lisp_h_SYMBOL_VAL(sym) \
342 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
343 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
344 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
345 #define lisp_h_XCAR(c) XCONS (c)->car
346 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
347 #define lisp_h_XCONS(a) \
348 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
349 #define lisp_h_XHASH(a) XUINT (a)
350 #ifndef GC_CHECK_CONS_LIST
351 # define lisp_h_check_cons_list() ((void) 0)
354 # define lisp_h_make_number(n) \
355 XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
356 # define lisp_h_XFASTINT(a) XINT (a)
357 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
358 # define lisp_h_XSYMBOL(a) \
359 (eassert (SYMBOLP (a)), \
360 (struct Lisp_Symbol *) ((intptr_t) XLI (a) - Lisp_Symbol \
362 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
363 # define lisp_h_XUNTAG(a, type) ((void *) (intptr_t) (XLI (a) - (type)))
366 /* When compiling via gcc -O0, define the key operations as macros, as
367 Emacs is too slow otherwise. To disable this optimization, compile
368 with -DINLINING=false. */
369 #if (defined __NO_INLINE__ \
370 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
371 && ! (defined INLINING && ! INLINING))
372 # define XLI(o) lisp_h_XLI (o)
373 # define XIL(i) lisp_h_XIL (i)
374 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
375 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
376 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
377 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
378 # define CONSP(x) lisp_h_CONSP (x)
379 # define EQ(x, y) lisp_h_EQ (x, y)
380 # define FLOATP(x) lisp_h_FLOATP (x)
381 # define INTEGERP(x) lisp_h_INTEGERP (x)
382 # define MARKERP(x) lisp_h_MARKERP (x)
383 # define MISCP(x) lisp_h_MISCP (x)
384 # define NILP(x) lisp_h_NILP (x)
385 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
386 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
387 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
388 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
389 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
390 # define XCAR(c) lisp_h_XCAR (c)
391 # define XCDR(c) lisp_h_XCDR (c)
392 # define XCONS(a) lisp_h_XCONS (a)
393 # define XHASH(a) lisp_h_XHASH (a)
394 # ifndef GC_CHECK_CONS_LIST
395 # define check_cons_list() lisp_h_check_cons_list ()
398 # define make_number(n) lisp_h_make_number (n)
399 # define XFASTINT(a) lisp_h_XFASTINT (a)
400 # define XINT(a) lisp_h_XINT (a)
401 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
402 # define XTYPE(a) lisp_h_XTYPE (a)
403 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
408 /* Define the fundamental Lisp data structures. */
410 /* This is the set of Lisp data types. If you want to define a new
411 data type, read the comments after Lisp_Fwd_Type definition
414 /* Lisp integers use 2 tags, to give them one extra bit, thus
415 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
416 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
417 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
419 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
420 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
421 vociferously about them. */
422 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
423 || (defined __SUNPRO_C && __STDC__))
424 #define ENUM_BF(TYPE) unsigned int
426 #define ENUM_BF(TYPE) enum TYPE
432 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
435 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
436 whose first member indicates the subtype. */
439 /* Integer. XINT (obj) is the integer value. */
441 Lisp_Int1
= USE_LSB_TAG
? 6 : 3,
443 /* String. XSTRING (object) points to a struct Lisp_String.
444 The length of the string, and its contents, are stored therein. */
447 /* Vector of Lisp objects, or something resembling it.
448 XVECTOR (object) points to a struct Lisp_Vector, which contains
449 the size and contents. The size field also contains the type
450 information, if it's not a real vector object. */
453 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
454 Lisp_Cons
= USE_LSB_TAG
? 3 : 6,
459 /* This is the set of data types that share a common structure.
460 The first member of the structure is a type code from this set.
461 The enum values are arbitrary, but we'll use large numbers to make it
462 more likely that we'll spot the error if a random word in memory is
463 mistakenly interpreted as a Lisp_Misc. */
466 Lisp_Misc_Free
= 0x5eab,
469 Lisp_Misc_Save_Value
,
474 /* Currently floats are not a misc type,
475 but let's define this in case we want to change that. */
477 /* This is not a type code. It is for range checking. */
481 /* These are the types of forwarding objects used in the value slot
482 of symbols for special built-in variables whose value is stored in
486 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
487 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
488 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
489 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
490 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
493 /* If you want to define a new Lisp data type, here are some
494 instructions. See the thread at
495 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
498 First, there are already a couple of Lisp types that can be used if
499 your new type does not need to be exposed to Lisp programs nor
500 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
501 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
502 is suitable for temporarily stashing away pointers and integers in
503 a Lisp object. The latter is useful for vector-like Lisp objects
504 that need to be used as part of other objects, but which are never
505 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
508 These two types don't look pretty when printed, so they are
509 unsuitable for Lisp objects that can be exposed to users.
511 To define a new data type, add one more Lisp_Misc subtype or one
512 more pseudovector subtype. Pseudovectors are more suitable for
513 objects with several slots that need to support fast random access,
514 while Lisp_Misc types are for everything else. A pseudovector object
515 provides one or more slots for Lisp objects, followed by struct
516 members that are accessible only from C. A Lisp_Misc object is a
517 wrapper for a C struct that can contain anything you like.
519 Explicit freeing is discouraged for Lisp objects in general. But if
520 you really need to exploit this, use Lisp_Misc (check free_misc in
521 alloc.c to see why). There is no way to free a vectorlike object.
523 To add a new pseudovector type, extend the pvec_type enumeration;
524 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
526 For a Lisp_Misc, you will also need to add your entry to union
527 Lisp_Misc (but make sure the first word has the same structure as
528 the others, starting with a 16-bit member of the Lisp_Misc_Type
529 enumeration and a 1-bit GC markbit) and make sure the overall size
530 of the union is not increased by your addition.
532 For a new pseudovector, it's highly desirable to limit the size
533 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
534 Otherwise you will need to change sweep_vectors (also in alloc.c).
536 Then you will need to add switch branches in print.c (in
537 print_object, to print your object, and possibly also in
538 print_preprocess) and to alloc.c, to mark your object (in
539 mark_object) and to free it (in gc_sweep). The latter is also the
540 right place to call any code specific to your data type that needs
541 to run when the object is recycled -- e.g., free any additional
542 resources allocated for it that are not Lisp objects. You can even
543 make a pointer to the function that frees the resources a slot in
544 your object -- this way, the same object could be used to represent
545 several disparate C structures. */
547 #ifdef CHECK_LISP_OBJECT_TYPE
549 typedef struct { EMACS_INT i
; } Lisp_Object
;
551 #define LISP_INITIALLY(i) {i}
553 #undef CHECK_LISP_OBJECT_TYPE
554 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
555 #else /* CHECK_LISP_OBJECT_TYPE */
557 /* If a struct type is not wanted, define Lisp_Object as just a number. */
559 typedef EMACS_INT Lisp_Object
;
560 #define LISP_INITIALLY(i) (i)
561 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
562 #endif /* CHECK_LISP_OBJECT_TYPE */
564 #define LISP_INITIALLY_ZERO LISP_INITIALLY (0)
566 /* Forward declarations. */
568 /* Defined in this file. */
570 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
571 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
572 INLINE
bool BUFFERP (Lisp_Object
);
573 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
574 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
575 INLINE
bool (CONSP
) (Lisp_Object
);
576 INLINE
bool (FLOATP
) (Lisp_Object
);
577 INLINE
bool functionp (Lisp_Object
);
578 INLINE
bool (INTEGERP
) (Lisp_Object
);
579 INLINE
bool (MARKERP
) (Lisp_Object
);
580 INLINE
bool (MISCP
) (Lisp_Object
);
581 INLINE
bool (NILP
) (Lisp_Object
);
582 INLINE
bool OVERLAYP (Lisp_Object
);
583 INLINE
bool PROCESSP (Lisp_Object
);
584 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
585 INLINE
bool SAVE_VALUEP (Lisp_Object
);
586 INLINE
bool FINALIZERP (Lisp_Object
);
589 INLINE
bool USER_PTRP (Lisp_Object
);
590 INLINE
struct Lisp_User_Ptr
*(XUSER_PTR
) (Lisp_Object
);
593 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
595 INLINE
bool STRINGP (Lisp_Object
);
596 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
597 INLINE
bool SUBRP (Lisp_Object
);
598 INLINE
bool (SYMBOLP
) (Lisp_Object
);
599 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
600 INLINE
bool WINDOWP (Lisp_Object
);
601 INLINE
bool TERMINALP (Lisp_Object
);
602 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
603 INLINE
struct Lisp_Finalizer
*XFINALIZER (Lisp_Object
);
604 INLINE
struct Lisp_Symbol
*(XSYMBOL
) (Lisp_Object
);
605 INLINE
void *(XUNTAG
) (Lisp_Object
, int);
607 /* Defined in chartab.c. */
608 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
609 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
611 /* Defined in data.c. */
612 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
613 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
615 /* Defined in emacs.c. */
616 extern bool might_dump
;
617 /* True means Emacs has already been initialized.
618 Used during startup to detect startup of dumped Emacs. */
619 extern bool initialized
;
621 /* Defined in floatfns.c. */
622 extern double extract_float (Lisp_Object
);
625 /* Interned state of a symbol. */
629 SYMBOL_UNINTERNED
= 0,
631 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
638 SYMBOL_LOCALIZED
= 2,
644 bool_bf gcmarkbit
: 1;
646 /* Indicates where the value can be found:
647 0 : it's a plain var, the value is in the `value' field.
648 1 : it's a varalias, the value is really in the `alias' symbol.
649 2 : it's a localized var, the value is in the `blv' object.
650 3 : it's a forwarding variable, the value is in `forward'. */
651 ENUM_BF (symbol_redirect
) redirect
: 3;
653 /* Non-zero means symbol is constant, i.e. changing its value
654 should signal an error. If the value is 3, then the var
655 can be changed, but only by `defconst'. */
656 unsigned constant
: 2;
658 /* Interned state of the symbol. This is an enumerator from
659 enum symbol_interned. */
660 unsigned interned
: 2;
662 /* True means that this variable has been explicitly declared
663 special (with `defvar' etc), and shouldn't be lexically bound. */
664 bool_bf declared_special
: 1;
666 /* True if pointed to from purespace and hence can't be GC'd. */
669 /* The symbol's name, as a Lisp string. */
672 /* Value of the symbol or Qunbound if unbound. Which alternative of the
673 union is used depends on the `redirect' field above. */
676 struct Lisp_Symbol
*alias
;
677 struct Lisp_Buffer_Local_Value
*blv
;
681 /* Function value of the symbol or Qnil if not fboundp. */
682 Lisp_Object function
;
684 /* The symbol's property list. */
687 /* Next symbol in obarray bucket, if the symbol is interned. */
688 struct Lisp_Symbol
*next
;
691 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
692 meaning as in the DEFUN macro, and is used to construct a prototype. */
693 /* We can use the same trick as in the DEFUN macro to generate the
694 appropriate prototype. */
695 #define EXFUN(fnname, maxargs) \
696 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
698 /* Note that the weird token-substitution semantics of ANSI C makes
699 this work for MANY and UNEVALLED. */
700 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
701 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
702 #define DEFUN_ARGS_0 (void)
703 #define DEFUN_ARGS_1 (Lisp_Object)
704 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
705 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
706 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
707 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
709 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
710 Lisp_Object, Lisp_Object)
711 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
712 Lisp_Object, Lisp_Object, Lisp_Object)
713 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
714 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
716 /* Yield a signed integer that contains TAG along with PTR.
718 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
719 and zero-extend otherwise (that’s a bit faster here).
720 Sign extension matters only when EMACS_INT is wider than a pointer. */
721 #define TAG_PTR(tag, ptr) \
723 ? (intptr_t) (ptr) + (tag) \
724 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
726 /* Yield an integer that contains a symbol tag along with OFFSET.
727 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
728 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
730 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
731 XLI (builtin_lisp_symbol (Qwhatever)),
732 except the former expands to an integer constant expression. */
733 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
735 /* Declare extern constants for Lisp symbols. These can be helpful
736 when using a debugger like GDB, on older platforms where the debug
737 format does not represent C macros. */
738 #define DEFINE_LISP_SYMBOL(name) \
739 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
740 DEFINE_GDB_SYMBOL_END (LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name)))
742 /* By default, define macros for Qt, etc., as this leads to a bit
743 better performance in the core Emacs interpreter. A plugin can
744 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
745 other Emacs instances that assign different values to Qt, etc. */
746 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
747 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
752 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
753 At the machine level, these operations are no-ops. */
756 (XLI
) (Lisp_Object o
)
758 return lisp_h_XLI (o
);
764 return lisp_h_XIL (i
);
767 /* In the size word of a vector, this bit means the vector has been marked. */
769 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
770 # define ARRAY_MARK_FLAG PTRDIFF_MIN
771 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
773 /* In the size word of a struct Lisp_Vector, this bit means it's really
774 some other vector-like object. */
775 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
776 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
777 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
779 /* In a pseudovector, the size field actually contains a word with one
780 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
781 with PVEC_TYPE_MASK to indicate the actual type. */
793 PVEC_WINDOW_CONFIGURATION
,
796 /* These should be last, check internal_equal to see why. */
800 PVEC_FONT
/* Should be last because it's used for range checking. */
805 /* For convenience, we also store the number of elements in these bits.
806 Note that this size is not necessarily the memory-footprint size, but
807 only the number of Lisp_Object fields (that need to be traced by GC).
808 The distinction is used, e.g., by Lisp_Process, which places extra
809 non-Lisp_Object fields at the end of the structure. */
810 PSEUDOVECTOR_SIZE_BITS
= 12,
811 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
813 /* To calculate the memory footprint of the pseudovector, it's useful
814 to store the size of non-Lisp area in word_size units here. */
815 PSEUDOVECTOR_REST_BITS
= 12,
816 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
817 << PSEUDOVECTOR_SIZE_BITS
),
819 /* Used to extract pseudovector subtype information. */
820 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
821 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
824 /* These functions extract various sorts of values from a Lisp_Object.
825 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
826 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
829 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
830 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
831 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
832 DEFINE_GDB_SYMBOL_END (VALMASK
)
834 /* Largest and smallest representable fixnum values. These are the C
835 values. They are macros for use in static initializers. */
836 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
837 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
842 (make_number
) (EMACS_INT n
)
844 return lisp_h_make_number (n
);
848 (XINT
) (Lisp_Object a
)
850 return lisp_h_XINT (a
);
854 (XFASTINT
) (Lisp_Object a
)
856 EMACS_INT n
= lisp_h_XFASTINT (a
);
861 INLINE
struct Lisp_Symbol
*
862 (XSYMBOL
) (Lisp_Object a
)
864 return lisp_h_XSYMBOL (a
);
867 INLINE
enum Lisp_Type
868 (XTYPE
) (Lisp_Object a
)
870 return lisp_h_XTYPE (a
);
874 (XUNTAG
) (Lisp_Object a
, int type
)
876 return lisp_h_XUNTAG (a
, type
);
879 #else /* ! USE_LSB_TAG */
881 /* Although compiled only if ! USE_LSB_TAG, the following functions
882 also work when USE_LSB_TAG; this is to aid future maintenance when
883 the lisp_h_* macros are eventually removed. */
885 /* Make a Lisp integer representing the value of the low order
888 make_number (EMACS_INT n
)
890 EMACS_INT int0
= Lisp_Int0
;
894 n
= u
<< INTTYPEBITS
;
900 n
+= (int0
<< VALBITS
);
905 /* Extract A's value as a signed integer. */
909 EMACS_INT i
= XLI (a
);
913 i
= u
<< INTTYPEBITS
;
915 return i
>> INTTYPEBITS
;
918 /* Like XINT (A), but may be faster. A must be nonnegative.
919 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
920 integers have zero-bits in their tags. */
922 XFASTINT (Lisp_Object a
)
924 EMACS_INT int0
= Lisp_Int0
;
925 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
) - (int0
<< VALBITS
);
930 /* Extract A's type. */
931 INLINE
enum Lisp_Type
932 XTYPE (Lisp_Object a
)
934 EMACS_UINT i
= XLI (a
);
935 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
938 /* Extract A's value as a symbol. */
939 INLINE
struct Lisp_Symbol
*
940 XSYMBOL (Lisp_Object a
)
942 eassert (SYMBOLP (a
));
943 intptr_t i
= (intptr_t) XUNTAG (a
, Lisp_Symbol
);
944 void *p
= (char *) lispsym
+ i
;
948 /* Extract A's pointer value, assuming A's type is TYPE. */
950 XUNTAG (Lisp_Object a
, int type
)
952 intptr_t i
= USE_LSB_TAG
? XLI (a
) - type
: XLI (a
) & VALMASK
;
956 #endif /* ! USE_LSB_TAG */
958 /* Extract A's value as an unsigned integer. */
960 XUINT (Lisp_Object a
)
962 EMACS_UINT i
= XLI (a
);
963 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
966 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
967 right now, but XUINT should only be applied to objects we know are
971 (XHASH
) (Lisp_Object a
)
973 return lisp_h_XHASH (a
);
976 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
978 make_natnum (EMACS_INT n
)
980 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
981 EMACS_INT int0
= Lisp_Int0
;
982 return USE_LSB_TAG
? make_number (n
) : XIL (n
+ (int0
<< VALBITS
));
985 /* Return true if X and Y are the same object. */
988 (EQ
) (Lisp_Object x
, Lisp_Object y
)
990 return lisp_h_EQ (x
, y
);
993 /* Value is true if I doesn't fit into a Lisp fixnum. It is
994 written this way so that it also works if I is of unsigned
995 type or if I is a NaN. */
997 #define FIXNUM_OVERFLOW_P(i) \
998 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
1001 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
1003 return num
< lower
? lower
: num
<= upper
? num
: upper
;
1007 /* Extract a value or address from a Lisp_Object. */
1009 INLINE
struct Lisp_Cons
*
1010 (XCONS
) (Lisp_Object a
)
1012 return lisp_h_XCONS (a
);
1015 INLINE
struct Lisp_Vector
*
1016 XVECTOR (Lisp_Object a
)
1018 eassert (VECTORLIKEP (a
));
1019 return XUNTAG (a
, Lisp_Vectorlike
);
1022 INLINE
struct Lisp_String
*
1023 XSTRING (Lisp_Object a
)
1025 eassert (STRINGP (a
));
1026 return XUNTAG (a
, Lisp_String
);
1029 /* The index of the C-defined Lisp symbol SYM.
1030 This can be used in a static initializer. */
1031 #define SYMBOL_INDEX(sym) i##sym
1033 INLINE
struct Lisp_Float
*
1034 XFLOAT (Lisp_Object a
)
1036 eassert (FLOATP (a
));
1037 return XUNTAG (a
, Lisp_Float
);
1040 /* Pseudovector types. */
1042 INLINE
struct Lisp_Process
*
1043 XPROCESS (Lisp_Object a
)
1045 eassert (PROCESSP (a
));
1046 return XUNTAG (a
, Lisp_Vectorlike
);
1049 INLINE
struct window
*
1050 XWINDOW (Lisp_Object a
)
1052 eassert (WINDOWP (a
));
1053 return XUNTAG (a
, Lisp_Vectorlike
);
1056 INLINE
struct terminal
*
1057 XTERMINAL (Lisp_Object a
)
1059 eassert (TERMINALP (a
));
1060 return XUNTAG (a
, Lisp_Vectorlike
);
1063 INLINE
struct Lisp_Subr
*
1064 XSUBR (Lisp_Object a
)
1066 eassert (SUBRP (a
));
1067 return XUNTAG (a
, Lisp_Vectorlike
);
1070 INLINE
struct buffer
*
1071 XBUFFER (Lisp_Object a
)
1073 eassert (BUFFERP (a
));
1074 return XUNTAG (a
, Lisp_Vectorlike
);
1077 INLINE
struct Lisp_Char_Table
*
1078 XCHAR_TABLE (Lisp_Object a
)
1080 eassert (CHAR_TABLE_P (a
));
1081 return XUNTAG (a
, Lisp_Vectorlike
);
1084 INLINE
struct Lisp_Sub_Char_Table
*
1085 XSUB_CHAR_TABLE (Lisp_Object a
)
1087 eassert (SUB_CHAR_TABLE_P (a
));
1088 return XUNTAG (a
, Lisp_Vectorlike
);
1091 INLINE
struct Lisp_Bool_Vector
*
1092 XBOOL_VECTOR (Lisp_Object a
)
1094 eassert (BOOL_VECTOR_P (a
));
1095 return XUNTAG (a
, Lisp_Vectorlike
);
1098 /* Construct a Lisp_Object from a value or address. */
1101 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
1103 Lisp_Object a
= XIL (TAG_PTR (type
, ptr
));
1104 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
1109 make_lisp_symbol (struct Lisp_Symbol
*sym
)
1111 Lisp_Object a
= XIL (TAG_SYMOFFSET ((char *) sym
- (char *) lispsym
));
1112 eassert (XSYMBOL (a
) == sym
);
1117 builtin_lisp_symbol (int index
)
1119 return make_lisp_symbol (lispsym
+ index
);
1122 #define XSETINT(a, b) ((a) = make_number (b))
1123 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1124 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1125 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1126 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1127 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1128 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1129 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1131 /* Pseudovector types. */
1133 #define XSETPVECTYPE(v, code) \
1134 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1135 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1136 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1137 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1138 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1141 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1142 #define XSETPSEUDOVECTOR(a, b, code) \
1143 XSETTYPED_PSEUDOVECTOR (a, b, \
1144 (((struct vectorlike_header *) \
1145 XUNTAG (a, Lisp_Vectorlike)) \
1148 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1149 (XSETVECTOR (a, b), \
1150 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1151 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1153 #define XSETWINDOW_CONFIGURATION(a, b) \
1154 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1155 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1156 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1157 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1158 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1159 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1160 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1161 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1162 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1163 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1165 /* Efficiently convert a pointer to a Lisp object and back. The
1166 pointer is represented as a Lisp integer, so the garbage collector
1167 does not know about it. The pointer should not have both Lisp_Int1
1168 bits set, which makes this conversion inherently unportable. */
1171 XINTPTR (Lisp_Object a
)
1173 return XUNTAG (a
, Lisp_Int0
);
1177 make_pointer_integer (void *p
)
1179 Lisp_Object a
= XIL (TAG_PTR (Lisp_Int0
, p
));
1180 eassert (INTEGERP (a
) && XINTPTR (a
) == p
);
1184 /* Type checking. */
1187 (CHECK_TYPE
) (int ok
, Lisp_Object predicate
, Lisp_Object x
)
1189 lisp_h_CHECK_TYPE (ok
, predicate
, x
);
1192 /* See the macros in intervals.h. */
1194 typedef struct interval
*INTERVAL
;
1196 struct GCALIGNED Lisp_Cons
1198 /* Car of this cons cell. */
1203 /* Cdr of this cons cell. */
1206 /* Used to chain conses on a free list. */
1207 struct Lisp_Cons
*chain
;
1211 /* Take the car or cdr of something known to be a cons cell. */
1212 /* The _addr functions shouldn't be used outside of the minimal set
1213 of code that has to know what a cons cell looks like. Other code not
1214 part of the basic lisp implementation should assume that the car and cdr
1215 fields are not accessible. (What if we want to switch to
1216 a copying collector someday? Cached cons cell field addresses may be
1217 invalidated at arbitrary points.) */
1218 INLINE Lisp_Object
*
1219 xcar_addr (Lisp_Object c
)
1221 return &XCONS (c
)->car
;
1223 INLINE Lisp_Object
*
1224 xcdr_addr (Lisp_Object c
)
1226 return &XCONS (c
)->u
.cdr
;
1229 /* Use these from normal code. */
1232 (XCAR
) (Lisp_Object c
)
1234 return lisp_h_XCAR (c
);
1238 (XCDR
) (Lisp_Object c
)
1240 return lisp_h_XCDR (c
);
1243 /* Use these to set the fields of a cons cell.
1245 Note that both arguments may refer to the same object, so 'n'
1246 should not be read after 'c' is first modified. */
1248 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1253 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1258 /* Take the car or cdr of something whose type is not known. */
1262 return (CONSP (c
) ? XCAR (c
)
1264 : wrong_type_argument (Qlistp
, c
));
1269 return (CONSP (c
) ? XCDR (c
)
1271 : wrong_type_argument (Qlistp
, c
));
1274 /* Take the car or cdr of something whose type is not known. */
1276 CAR_SAFE (Lisp_Object c
)
1278 return CONSP (c
) ? XCAR (c
) : Qnil
;
1281 CDR_SAFE (Lisp_Object c
)
1283 return CONSP (c
) ? XCDR (c
) : Qnil
;
1286 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1288 struct GCALIGNED Lisp_String
1291 ptrdiff_t size_byte
;
1292 INTERVAL intervals
; /* Text properties in this string. */
1293 unsigned char *data
;
1296 /* True if STR is a multibyte string. */
1298 STRING_MULTIBYTE (Lisp_Object str
)
1300 return 0 <= XSTRING (str
)->size_byte
;
1303 /* An upper bound on the number of bytes in a Lisp string, not
1304 counting the terminating null. This a tight enough bound to
1305 prevent integer overflow errors that would otherwise occur during
1306 string size calculations. A string cannot contain more bytes than
1307 a fixnum can represent, nor can it be so long that C pointer
1308 arithmetic stops working on the string plus its terminating null.
1309 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1310 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1311 would expose alloc.c internal details that we'd rather keep
1314 This is a macro for use in static initializers. The cast to
1315 ptrdiff_t ensures that the macro is signed. */
1316 #define STRING_BYTES_BOUND \
1317 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1319 /* Mark STR as a unibyte string. */
1320 #define STRING_SET_UNIBYTE(STR) \
1322 if (EQ (STR, empty_multibyte_string)) \
1323 (STR) = empty_unibyte_string; \
1325 XSTRING (STR)->size_byte = -1; \
1328 /* Mark STR as a multibyte string. Assure that STR contains only
1329 ASCII characters in advance. */
1330 #define STRING_SET_MULTIBYTE(STR) \
1332 if (EQ (STR, empty_unibyte_string)) \
1333 (STR) = empty_multibyte_string; \
1335 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1338 /* Convenience functions for dealing with Lisp strings. */
1340 INLINE
unsigned char *
1341 SDATA (Lisp_Object string
)
1343 return XSTRING (string
)->data
;
1346 SSDATA (Lisp_Object string
)
1348 /* Avoid "differ in sign" warnings. */
1349 return (char *) SDATA (string
);
1351 INLINE
unsigned char
1352 SREF (Lisp_Object string
, ptrdiff_t index
)
1354 return SDATA (string
)[index
];
1357 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1359 SDATA (string
)[index
] = new;
1362 SCHARS (Lisp_Object string
)
1364 return XSTRING (string
)->size
;
1367 #ifdef GC_CHECK_STRING_BYTES
1368 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1371 STRING_BYTES (struct Lisp_String
*s
)
1373 #ifdef GC_CHECK_STRING_BYTES
1374 return string_bytes (s
);
1376 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1381 SBYTES (Lisp_Object string
)
1383 return STRING_BYTES (XSTRING (string
));
1386 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1388 XSTRING (string
)->size
= newsize
;
1391 /* Header of vector-like objects. This documents the layout constraints on
1392 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1393 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1394 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1395 because when two such pointers potentially alias, a compiler won't
1396 incorrectly reorder loads and stores to their size fields. See
1398 struct vectorlike_header
1400 /* The only field contains various pieces of information:
1401 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1402 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1403 vector (0) or a pseudovector (1).
1404 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1405 of slots) of the vector.
1406 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1407 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1408 - b) number of Lisp_Objects slots at the beginning of the object
1409 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1411 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1412 measured in word_size units. Rest fields may also include
1413 Lisp_Objects, but these objects usually needs some special treatment
1415 There are some exceptions. For PVEC_FREE, b) is always zero. For
1416 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1417 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1418 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1422 /* A regular vector is just a header plus an array of Lisp_Objects. */
1426 struct vectorlike_header header
;
1427 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1430 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1433 ALIGNOF_STRUCT_LISP_VECTOR
1434 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1437 /* A boolvector is a kind of vectorlike, with contents like a string. */
1439 struct Lisp_Bool_Vector
1441 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1442 just the subtype information. */
1443 struct vectorlike_header header
;
1444 /* This is the size in bits. */
1446 /* The actual bits, packed into bytes.
1447 Zeros fill out the last word if needed.
1448 The bits are in little-endian order in the bytes, and
1449 the bytes are in little-endian order in the words. */
1450 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1454 bool_vector_size (Lisp_Object a
)
1456 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1457 eassume (0 <= size
);
1462 bool_vector_data (Lisp_Object a
)
1464 return XBOOL_VECTOR (a
)->data
;
1467 INLINE
unsigned char *
1468 bool_vector_uchar_data (Lisp_Object a
)
1470 return (unsigned char *) bool_vector_data (a
);
1473 /* The number of data words and bytes in a bool vector with SIZE bits. */
1476 bool_vector_words (EMACS_INT size
)
1478 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1479 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1483 bool_vector_bytes (EMACS_INT size
)
1485 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1486 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1489 /* True if A's Ith bit is set. */
1492 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1494 eassume (0 <= i
&& i
< bool_vector_size (a
));
1495 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1496 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1500 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1502 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1505 /* Set A's Ith bit to B. */
1508 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1510 unsigned char *addr
;
1512 eassume (0 <= i
&& i
< bool_vector_size (a
));
1513 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1516 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1518 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1521 /* Some handy constants for calculating sizes
1522 and offsets, mostly of vectorlike objects. */
1526 header_size
= offsetof (struct Lisp_Vector
, contents
),
1527 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1528 word_size
= sizeof (Lisp_Object
)
1531 /* Conveniences for dealing with Lisp arrays. */
1534 AREF (Lisp_Object array
, ptrdiff_t idx
)
1536 return XVECTOR (array
)->contents
[idx
];
1539 INLINE Lisp_Object
*
1540 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1542 return & XVECTOR (array
)->contents
[idx
];
1546 ASIZE (Lisp_Object array
)
1548 ptrdiff_t size
= XVECTOR (array
)->header
.size
;
1549 eassume (0 <= size
);
1554 gc_asize (Lisp_Object array
)
1556 /* Like ASIZE, but also can be used in the garbage collector. */
1557 return XVECTOR (array
)->header
.size
& ~ARRAY_MARK_FLAG
;
1561 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1563 eassert (0 <= idx
&& idx
< ASIZE (array
));
1564 XVECTOR (array
)->contents
[idx
] = val
;
1568 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1570 /* Like ASET, but also can be used in the garbage collector:
1571 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1572 eassert (0 <= idx
&& idx
< gc_asize (array
));
1573 XVECTOR (array
)->contents
[idx
] = val
;
1576 /* True, since Qnil's representation is zero. Every place in the code
1577 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1578 to find such assumptions later if we change Qnil to be nonzero. */
1579 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1581 /* Clear the object addressed by P, with size NBYTES, so that all its
1582 bytes are zero and all its Lisp values are nil. */
1584 memclear (void *p
, ptrdiff_t nbytes
)
1586 eassert (0 <= nbytes
);
1587 verify (NIL_IS_ZERO
);
1588 /* Since Qnil is zero, memset suffices. */
1589 memset (p
, 0, nbytes
);
1592 /* If a struct is made to look like a vector, this macro returns the length
1593 of the shortest vector that would hold that struct. */
1595 #define VECSIZE(type) \
1596 ((sizeof (type) - header_size + word_size - 1) / word_size)
1598 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1599 at the end and we need to compute the number of Lisp_Object fields (the
1600 ones that the GC needs to trace). */
1602 #define PSEUDOVECSIZE(type, nonlispfield) \
1603 ((offsetof (type, nonlispfield) - header_size) / word_size)
1605 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1606 should be integer expressions. This is not the same as
1607 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1608 returns true. For efficiency, prefer plain unsigned comparison if A
1609 and B's sizes both fit (after integer promotion). */
1610 #define UNSIGNED_CMP(a, op, b) \
1611 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1612 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1613 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1615 /* True iff C is an ASCII character. */
1616 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1618 /* A char-table is a kind of vectorlike, with contents are like a
1619 vector but with a few other slots. For some purposes, it makes
1620 sense to handle a char-table with type struct Lisp_Vector. An
1621 element of a char table can be any Lisp objects, but if it is a sub
1622 char-table, we treat it a table that contains information of a
1623 specific range of characters. A sub char-table is like a vector but
1624 with two integer fields between the header and Lisp data, which means
1625 that it has to be marked with some precautions (see mark_char_table
1626 in alloc.c). A sub char-table appears only in an element of a char-table,
1627 and there's no way to access it directly from Emacs Lisp program. */
1629 enum CHARTAB_SIZE_BITS
1631 CHARTAB_SIZE_BITS_0
= 6,
1632 CHARTAB_SIZE_BITS_1
= 4,
1633 CHARTAB_SIZE_BITS_2
= 5,
1634 CHARTAB_SIZE_BITS_3
= 7
1637 extern const int chartab_size
[4];
1639 struct Lisp_Char_Table
1641 /* HEADER.SIZE is the vector's size field, which also holds the
1642 pseudovector type information. It holds the size, too.
1643 The size counts the defalt, parent, purpose, ascii,
1644 contents, and extras slots. */
1645 struct vectorlike_header header
;
1647 /* This holds a default value,
1648 which is used whenever the value for a specific character is nil. */
1651 /* This points to another char table, which we inherit from when the
1652 value for a specific character is nil. The `defalt' slot takes
1653 precedence over this. */
1656 /* This is a symbol which says what kind of use this char-table is
1658 Lisp_Object purpose
;
1660 /* The bottom sub char-table for characters of the range 0..127. It
1661 is nil if none of ASCII character has a specific value. */
1664 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1666 /* These hold additional data. It is a vector. */
1667 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1670 struct Lisp_Sub_Char_Table
1672 /* HEADER.SIZE is the vector's size field, which also holds the
1673 pseudovector type information. It holds the size, too. */
1674 struct vectorlike_header header
;
1676 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1677 char-table of depth 1 contains 16 elements, and each element
1678 covers 4096 (128*32) characters. A sub char-table of depth 2
1679 contains 32 elements, and each element covers 128 characters. A
1680 sub char-table of depth 3 contains 128 elements, and each element
1681 is for one character. */
1684 /* Minimum character covered by the sub char-table. */
1687 /* Use set_sub_char_table_contents to set this. */
1688 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1692 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1694 struct Lisp_Char_Table
*tbl
= NULL
;
1698 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1699 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1700 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1704 while (NILP (val
) && ! NILP (tbl
->parent
));
1709 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1710 characters. Do not check validity of CT. */
1712 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1714 return (ASCII_CHAR_P (idx
)
1715 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1716 : char_table_ref (ct
, idx
));
1719 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1720 8-bit European characters. Do not check validity of CT. */
1722 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1724 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1725 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1727 char_table_set (ct
, idx
, val
);
1730 /* This structure describes a built-in function.
1731 It is generated by the DEFUN macro only.
1732 defsubr makes it into a Lisp object. */
1736 struct vectorlike_header header
;
1738 Lisp_Object (*a0
) (void);
1739 Lisp_Object (*a1
) (Lisp_Object
);
1740 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1741 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1742 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1743 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1744 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1745 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1746 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1747 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1748 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1750 short min_args
, max_args
;
1751 const char *symbol_name
;
1752 const char *intspec
;
1756 enum char_table_specials
1758 /* This is the number of slots that every char table must have. This
1759 counts the ordinary slots and the top, defalt, parent, and purpose
1761 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1763 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1764 when the latter is treated as an ordinary Lisp_Vector. */
1765 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1768 /* Return the number of "extra" slots in the char table CT. */
1771 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1773 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1774 - CHAR_TABLE_STANDARD_SLOTS
);
1777 /* Make sure that sub char-table contents slot is where we think it is. */
1778 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1779 == offsetof (struct Lisp_Vector
, contents
[SUB_CHAR_TABLE_OFFSET
]));
1781 /***********************************************************************
1783 ***********************************************************************/
1785 /* Value is name of symbol. */
1788 (SYMBOL_VAL
) (struct Lisp_Symbol
*sym
)
1790 return lisp_h_SYMBOL_VAL (sym
);
1793 INLINE
struct Lisp_Symbol
*
1794 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1796 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1797 return sym
->val
.alias
;
1799 INLINE
struct Lisp_Buffer_Local_Value
*
1800 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1802 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1803 return sym
->val
.blv
;
1805 INLINE
union Lisp_Fwd
*
1806 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1808 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1809 return sym
->val
.fwd
;
1813 (SET_SYMBOL_VAL
) (struct Lisp_Symbol
*sym
, Lisp_Object v
)
1815 lisp_h_SET_SYMBOL_VAL (sym
, v
);
1819 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1821 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1825 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1827 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1831 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1833 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1838 SYMBOL_NAME (Lisp_Object sym
)
1840 return XSYMBOL (sym
)->name
;
1843 /* Value is true if SYM is an interned symbol. */
1846 SYMBOL_INTERNED_P (Lisp_Object sym
)
1848 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1851 /* Value is true if SYM is interned in initial_obarray. */
1854 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1856 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1859 /* Value is non-zero if symbol is considered a constant, i.e. its
1860 value cannot be changed (there is an exception for keyword symbols,
1861 whose value can be set to the keyword symbol itself). */
1864 (SYMBOL_CONSTANT_P
) (Lisp_Object sym
)
1866 return lisp_h_SYMBOL_CONSTANT_P (sym
);
1869 /* Placeholder for make-docfile to process. The actual symbol
1870 definition is done by lread.c's defsym. */
1871 #define DEFSYM(sym, name) /* empty */
1874 /***********************************************************************
1876 ***********************************************************************/
1878 /* The structure of a Lisp hash table. */
1880 struct hash_table_test
1882 /* Name of the function used to compare keys. */
1885 /* User-supplied hash function, or nil. */
1886 Lisp_Object user_hash_function
;
1888 /* User-supplied key comparison function, or nil. */
1889 Lisp_Object user_cmp_function
;
1891 /* C function to compare two keys. */
1892 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1894 /* C function to compute hash code. */
1895 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1898 struct Lisp_Hash_Table
1900 /* This is for Lisp; the hash table code does not refer to it. */
1901 struct vectorlike_header header
;
1903 /* Nil if table is non-weak. Otherwise a symbol describing the
1904 weakness of the table. */
1907 /* When the table is resized, and this is an integer, compute the
1908 new size by adding this to the old size. If a float, compute the
1909 new size by multiplying the old size with this factor. */
1910 Lisp_Object rehash_size
;
1912 /* Resize hash table when number of entries/ table size is >= this
1914 Lisp_Object rehash_threshold
;
1916 /* Vector of hash codes. If hash[I] is nil, this means that the
1917 I-th entry is unused. */
1920 /* Vector used to chain entries. If entry I is free, next[I] is the
1921 entry number of the next free item. If entry I is non-free,
1922 next[I] is the index of the next entry in the collision chain. */
1925 /* Index of first free entry in free list. */
1926 Lisp_Object next_free
;
1928 /* Bucket vector. A non-nil entry is the index of the first item in
1929 a collision chain. This vector's size can be larger than the
1930 hash table size to reduce collisions. */
1933 /* Only the fields above are traced normally by the GC. The ones below
1934 `count' are special and are either ignored by the GC or traced in
1935 a special way (e.g. because of weakness). */
1937 /* Number of key/value entries in the table. */
1940 /* Vector of keys and values. The key of item I is found at index
1941 2 * I, the value is found at index 2 * I + 1.
1942 This is gc_marked specially if the table is weak. */
1943 Lisp_Object key_and_value
;
1945 /* The comparison and hash functions. */
1946 struct hash_table_test test
;
1948 /* Next weak hash table if this is a weak hash table. The head
1949 of the list is in weak_hash_tables. */
1950 struct Lisp_Hash_Table
*next_weak
;
1955 HASH_TABLE_P (Lisp_Object a
)
1957 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1960 INLINE
struct Lisp_Hash_Table
*
1961 XHASH_TABLE (Lisp_Object a
)
1963 eassert (HASH_TABLE_P (a
));
1964 return XUNTAG (a
, Lisp_Vectorlike
);
1967 #define XSET_HASH_TABLE(VAR, PTR) \
1968 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1970 /* Value is the key part of entry IDX in hash table H. */
1972 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1974 return AREF (h
->key_and_value
, 2 * idx
);
1977 /* Value is the value part of entry IDX in hash table H. */
1979 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1981 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1984 /* Value is the index of the next entry following the one at IDX
1987 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1989 return AREF (h
->next
, idx
);
1992 /* Value is the hash code computed for entry IDX in hash table H. */
1994 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1996 return AREF (h
->hash
, idx
);
1999 /* Value is the index of the element in hash table H that is the
2000 start of the collision list at index IDX in the index vector of H. */
2002 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2004 return AREF (h
->index
, idx
);
2007 /* Value is the size of hash table H. */
2009 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
2011 return ASIZE (h
->next
);
2014 /* Default size for hash tables if not specified. */
2016 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
2018 /* Default threshold specifying when to resize a hash table. The
2019 value gives the ratio of current entries in the hash table and the
2020 size of the hash table. */
2022 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
2024 /* Default factor by which to increase the size of a hash table. */
2026 static double const DEFAULT_REHASH_SIZE
= 1.5;
2028 /* Combine two integers X and Y for hashing. The result might not fit
2029 into a Lisp integer. */
2032 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
2034 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
2037 /* Hash X, returning a value that fits into a fixnum. */
2040 SXHASH_REDUCE (EMACS_UINT x
)
2042 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
2045 /* These structures are used for various misc types. */
2047 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
2049 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
2050 bool_bf gcmarkbit
: 1;
2051 unsigned spacer
: 15;
2056 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
2057 bool_bf gcmarkbit
: 1;
2058 unsigned spacer
: 13;
2059 /* This flag is temporarily used in the functions
2060 decode/encode_coding_object to record that the marker position
2061 must be adjusted after the conversion. */
2062 bool_bf need_adjustment
: 1;
2063 /* True means normal insertion at the marker's position
2064 leaves the marker after the inserted text. */
2065 bool_bf insertion_type
: 1;
2066 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2067 Note: a chain of markers can contain markers pointing into different
2068 buffers (the chain is per buffer_text rather than per buffer, so it's
2069 shared between indirect buffers). */
2070 /* This is used for (other than NULL-checking):
2072 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2073 - unchain_marker: to find the list from which to unchain.
2074 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2076 struct buffer
*buffer
;
2078 /* The remaining fields are meaningless in a marker that
2079 does not point anywhere. */
2081 /* For markers that point somewhere,
2082 this is used to chain of all the markers in a given buffer. */
2083 /* We could remove it and use an array in buffer_text instead.
2084 That would also allow to preserve it ordered. */
2085 struct Lisp_Marker
*next
;
2086 /* This is the char position where the marker points. */
2088 /* This is the byte position.
2089 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2090 used to implement the functionality of markers, but rather to (ab)use
2091 markers as a cache for char<->byte mappings). */
2095 /* START and END are markers in the overlay's buffer, and
2096 PLIST is the overlay's property list. */
2098 /* An overlay's real data content is:
2100 - buffer (really there are two buffer pointers, one per marker,
2101 and both points to the same buffer)
2102 - insertion type of both ends (per-marker fields)
2103 - start & start byte (of start marker)
2104 - end & end byte (of end marker)
2105 - next (singly linked list of overlays)
2106 - next fields of start and end markers (singly linked list of markers).
2107 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2110 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2111 bool_bf gcmarkbit
: 1;
2112 unsigned spacer
: 15;
2113 struct Lisp_Overlay
*next
;
2119 /* Types of data which may be saved in a Lisp_Save_Value. */
2130 /* Number of bits needed to store one of the above values. */
2131 enum { SAVE_SLOT_BITS
= 3 };
2133 /* Number of slots in a save value where save_type is nonzero. */
2134 enum { SAVE_VALUE_SLOTS
= 4 };
2136 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2138 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2142 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2143 SAVE_TYPE_INT_INT_INT
2144 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2145 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2146 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2147 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2148 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2149 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2150 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2151 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2152 SAVE_TYPE_FUNCPTR_PTR_OBJ
2153 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2155 /* This has an extra bit indicating it's raw memory. */
2156 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2159 /* Special object used to hold a different values for later use.
2161 This is mostly used to package C integers and pointers to call
2162 record_unwind_protect when two or more values need to be saved.
2166 struct my_data *md = get_my_data ();
2167 ptrdiff_t mi = get_my_integer ();
2168 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2171 Lisp_Object my_unwind (Lisp_Object arg)
2173 struct my_data *md = XSAVE_POINTER (arg, 0);
2174 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2178 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2179 saved objects and raise eassert if type of the saved object doesn't match
2180 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2181 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2182 slot 0 is a pointer. */
2184 typedef void (*voidfuncptr
) (void);
2186 struct Lisp_Save_Value
2188 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2189 bool_bf gcmarkbit
: 1;
2190 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2192 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2193 V's data entries are determined by V->save_type. E.g., if
2194 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2195 V->data[1] is an integer, and V's other data entries are unused.
2197 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2198 a memory area containing V->data[1].integer potential Lisp_Objects. */
2199 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2202 voidfuncptr funcpointer
;
2205 } data
[SAVE_VALUE_SLOTS
];
2208 /* Return the type of V's Nth saved value. */
2210 save_type (struct Lisp_Save_Value
*v
, int n
)
2212 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2213 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2216 /* Get and set the Nth saved pointer. */
2219 XSAVE_POINTER (Lisp_Object obj
, int n
)
2221 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2222 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2225 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2227 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2228 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2231 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2233 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2234 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2237 /* Likewise for the saved integer. */
2240 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2242 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2243 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2246 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2248 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2249 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2252 /* Extract Nth saved object. */
2255 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2257 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2258 return XSAVE_VALUE (obj
)->data
[n
].object
;
2262 struct Lisp_User_Ptr
2264 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_User_Ptr */
2265 bool_bf gcmarkbit
: 1;
2266 unsigned spacer
: 15;
2268 void (*finalizer
) (void *);
2273 /* A finalizer sentinel. */
2274 struct Lisp_Finalizer
2276 struct Lisp_Misc_Any base
;
2278 /* Circular list of all active weak references. */
2279 struct Lisp_Finalizer
*prev
;
2280 struct Lisp_Finalizer
*next
;
2282 /* Call FUNCTION when the finalizer becomes unreachable, even if
2283 FUNCTION contains a reference to the finalizer; i.e., call
2284 FUNCTION when it is reachable _only_ through finalizers. */
2285 Lisp_Object function
;
2288 /* A miscellaneous object, when it's on the free list. */
2291 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2292 bool_bf gcmarkbit
: 1;
2293 unsigned spacer
: 15;
2294 union Lisp_Misc
*chain
;
2297 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2298 It uses one of these struct subtypes to get the type field. */
2302 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2303 struct Lisp_Free u_free
;
2304 struct Lisp_Marker u_marker
;
2305 struct Lisp_Overlay u_overlay
;
2306 struct Lisp_Save_Value u_save_value
;
2307 struct Lisp_Finalizer u_finalizer
;
2309 struct Lisp_User_Ptr u_user_ptr
;
2313 INLINE
union Lisp_Misc
*
2314 XMISC (Lisp_Object a
)
2316 return XUNTAG (a
, Lisp_Misc
);
2319 INLINE
struct Lisp_Misc_Any
*
2320 XMISCANY (Lisp_Object a
)
2322 eassert (MISCP (a
));
2323 return & XMISC (a
)->u_any
;
2326 INLINE
enum Lisp_Misc_Type
2327 XMISCTYPE (Lisp_Object a
)
2329 return XMISCANY (a
)->type
;
2332 INLINE
struct Lisp_Marker
*
2333 XMARKER (Lisp_Object a
)
2335 eassert (MARKERP (a
));
2336 return & XMISC (a
)->u_marker
;
2339 INLINE
struct Lisp_Overlay
*
2340 XOVERLAY (Lisp_Object a
)
2342 eassert (OVERLAYP (a
));
2343 return & XMISC (a
)->u_overlay
;
2346 INLINE
struct Lisp_Save_Value
*
2347 XSAVE_VALUE (Lisp_Object a
)
2349 eassert (SAVE_VALUEP (a
));
2350 return & XMISC (a
)->u_save_value
;
2353 INLINE
struct Lisp_Finalizer
*
2354 XFINALIZER (Lisp_Object a
)
2356 eassert (FINALIZERP (a
));
2357 return & XMISC (a
)->u_finalizer
;
2361 INLINE
struct Lisp_User_Ptr
*
2362 XUSER_PTR (Lisp_Object a
)
2364 eassert (USER_PTRP (a
));
2365 return & XMISC (a
)->u_user_ptr
;
2370 /* Forwarding pointer to an int variable.
2371 This is allowed only in the value cell of a symbol,
2372 and it means that the symbol's value really lives in the
2373 specified int variable. */
2376 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2380 /* Boolean forwarding pointer to an int variable.
2381 This is like Lisp_Intfwd except that the ostensible
2382 "value" of the symbol is t if the bool variable is true,
2383 nil if it is false. */
2386 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2390 /* Forwarding pointer to a Lisp_Object variable.
2391 This is allowed only in the value cell of a symbol,
2392 and it means that the symbol's value really lives in the
2393 specified variable. */
2396 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2397 Lisp_Object
*objvar
;
2400 /* Like Lisp_Objfwd except that value lives in a slot in the
2401 current buffer. Value is byte index of slot within buffer. */
2402 struct Lisp_Buffer_Objfwd
2404 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2406 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2407 Lisp_Object predicate
;
2410 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2411 the symbol has buffer-local or frame-local bindings. (Exception:
2412 some buffer-local variables are built-in, with their values stored
2413 in the buffer structure itself. They are handled differently,
2414 using struct Lisp_Buffer_Objfwd.)
2416 The `realvalue' slot holds the variable's current value, or a
2417 forwarding pointer to where that value is kept. This value is the
2418 one that corresponds to the loaded binding. To read or set the
2419 variable, you must first make sure the right binding is loaded;
2420 then you can access the value in (or through) `realvalue'.
2422 `buffer' and `frame' are the buffer and frame for which the loaded
2423 binding was found. If those have changed, to make sure the right
2424 binding is loaded it is necessary to find which binding goes with
2425 the current buffer and selected frame, then load it. To load it,
2426 first unload the previous binding, then copy the value of the new
2427 binding into `realvalue' (or through it). Also update
2428 LOADED-BINDING to point to the newly loaded binding.
2430 `local_if_set' indicates that merely setting the variable creates a
2431 local binding for the current buffer. Otherwise the latter, setting
2432 the variable does not do that; only make-local-variable does that. */
2434 struct Lisp_Buffer_Local_Value
2436 /* True means that merely setting the variable creates a local
2437 binding for the current buffer. */
2438 bool_bf local_if_set
: 1;
2439 /* True means this variable can have frame-local bindings, otherwise, it is
2440 can have buffer-local bindings. The two cannot be combined. */
2441 bool_bf frame_local
: 1;
2442 /* True means that the binding now loaded was found.
2443 Presumably equivalent to (defcell!=valcell). */
2445 /* If non-NULL, a forwarding to the C var where it should also be set. */
2446 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2447 /* The buffer or frame for which the loaded binding was found. */
2449 /* A cons cell that holds the default value. It has the form
2450 (SYMBOL . DEFAULT-VALUE). */
2451 Lisp_Object defcell
;
2452 /* The cons cell from `where's parameter alist.
2453 It always has the form (SYMBOL . VALUE)
2454 Note that if `forward' is non-nil, VALUE may be out of date.
2455 Also if the currently loaded binding is the default binding, then
2456 this is `eq'ual to defcell. */
2457 Lisp_Object valcell
;
2460 /* Like Lisp_Objfwd except that value lives in a slot in the
2462 struct Lisp_Kboard_Objfwd
2464 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2470 struct Lisp_Intfwd u_intfwd
;
2471 struct Lisp_Boolfwd u_boolfwd
;
2472 struct Lisp_Objfwd u_objfwd
;
2473 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2474 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2477 INLINE
enum Lisp_Fwd_Type
2478 XFWDTYPE (union Lisp_Fwd
*a
)
2480 return a
->u_intfwd
.type
;
2483 INLINE
struct Lisp_Buffer_Objfwd
*
2484 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2486 eassert (BUFFER_OBJFWDP (a
));
2487 return &a
->u_buffer_objfwd
;
2490 /* Lisp floating point type. */
2496 struct Lisp_Float
*chain
;
2501 XFLOAT_DATA (Lisp_Object f
)
2503 return XFLOAT (f
)->u
.data
;
2506 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2507 representations, have infinities and NaNs, and do not trap on
2508 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2509 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2510 wanted here, but is not quite right because Emacs does not require
2511 all the features of C11 Annex F (and does not require C11 at all,
2512 for that matter). */
2516 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2517 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2520 /* A character, declared with the following typedef, is a member
2521 of some character set associated with the current buffer. */
2522 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2524 typedef unsigned char UCHAR
;
2527 /* Meanings of slots in a Lisp_Compiled: */
2531 COMPILED_ARGLIST
= 0,
2532 COMPILED_BYTECODE
= 1,
2533 COMPILED_CONSTANTS
= 2,
2534 COMPILED_STACK_DEPTH
= 3,
2535 COMPILED_DOC_STRING
= 4,
2536 COMPILED_INTERACTIVE
= 5
2539 /* Flag bits in a character. These also get used in termhooks.h.
2540 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2541 (MUlti-Lingual Emacs) might need 22 bits for the character value
2542 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2545 CHAR_ALT
= 0x0400000,
2546 CHAR_SUPER
= 0x0800000,
2547 CHAR_HYPER
= 0x1000000,
2548 CHAR_SHIFT
= 0x2000000,
2549 CHAR_CTL
= 0x4000000,
2550 CHAR_META
= 0x8000000,
2552 CHAR_MODIFIER_MASK
=
2553 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2555 /* Actually, the current Emacs uses 22 bits for the character value
2560 /* Data type checking. */
2563 (NILP
) (Lisp_Object x
)
2565 return lisp_h_NILP (x
);
2569 NUMBERP (Lisp_Object x
)
2571 return INTEGERP (x
) || FLOATP (x
);
2574 NATNUMP (Lisp_Object x
)
2576 return INTEGERP (x
) && 0 <= XINT (x
);
2580 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2582 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2585 #define TYPE_RANGED_INTEGERP(type, x) \
2587 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2588 && XINT (x) <= TYPE_MAXIMUM (type))
2591 (CONSP
) (Lisp_Object x
)
2593 return lisp_h_CONSP (x
);
2596 (FLOATP
) (Lisp_Object x
)
2598 return lisp_h_FLOATP (x
);
2601 (MISCP
) (Lisp_Object x
)
2603 return lisp_h_MISCP (x
);
2606 (SYMBOLP
) (Lisp_Object x
)
2608 return lisp_h_SYMBOLP (x
);
2611 (INTEGERP
) (Lisp_Object x
)
2613 return lisp_h_INTEGERP (x
);
2616 (VECTORLIKEP
) (Lisp_Object x
)
2618 return lisp_h_VECTORLIKEP (x
);
2621 (MARKERP
) (Lisp_Object x
)
2623 return lisp_h_MARKERP (x
);
2627 STRINGP (Lisp_Object x
)
2629 return XTYPE (x
) == Lisp_String
;
2632 VECTORP (Lisp_Object x
)
2634 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2637 OVERLAYP (Lisp_Object x
)
2639 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2642 SAVE_VALUEP (Lisp_Object x
)
2644 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2648 FINALIZERP (Lisp_Object x
)
2650 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Finalizer
;
2655 USER_PTRP (Lisp_Object x
)
2657 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_User_Ptr
;
2662 AUTOLOADP (Lisp_Object x
)
2664 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2668 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2670 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2674 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2676 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2677 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2680 /* True if A is a pseudovector whose code is CODE. */
2682 PSEUDOVECTORP (Lisp_Object a
, int code
)
2684 if (! VECTORLIKEP (a
))
2688 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2689 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2690 return PSEUDOVECTOR_TYPEP (h
, code
);
2695 /* Test for specific pseudovector types. */
2698 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2700 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2704 PROCESSP (Lisp_Object a
)
2706 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2710 WINDOWP (Lisp_Object a
)
2712 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2716 TERMINALP (Lisp_Object a
)
2718 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2722 SUBRP (Lisp_Object a
)
2724 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2728 COMPILEDP (Lisp_Object a
)
2730 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2734 BUFFERP (Lisp_Object a
)
2736 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2740 CHAR_TABLE_P (Lisp_Object a
)
2742 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2746 SUB_CHAR_TABLE_P (Lisp_Object a
)
2748 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2752 BOOL_VECTOR_P (Lisp_Object a
)
2754 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2758 FRAMEP (Lisp_Object a
)
2760 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2763 /* Test for image (image . spec) */
2765 IMAGEP (Lisp_Object x
)
2767 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2772 ARRAYP (Lisp_Object x
)
2774 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2778 CHECK_LIST (Lisp_Object x
)
2780 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2784 (CHECK_LIST_CONS
) (Lisp_Object x
, Lisp_Object y
)
2786 lisp_h_CHECK_LIST_CONS (x
, y
);
2790 (CHECK_SYMBOL
) (Lisp_Object x
)
2792 lisp_h_CHECK_SYMBOL (x
);
2796 (CHECK_NUMBER
) (Lisp_Object x
)
2798 lisp_h_CHECK_NUMBER (x
);
2802 CHECK_STRING (Lisp_Object x
)
2804 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2807 CHECK_STRING_CAR (Lisp_Object x
)
2809 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2812 CHECK_CONS (Lisp_Object x
)
2814 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2817 CHECK_VECTOR (Lisp_Object x
)
2819 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2822 CHECK_BOOL_VECTOR (Lisp_Object x
)
2824 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2826 /* This is a bit special because we always need size afterwards. */
2828 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2834 wrong_type_argument (Qarrayp
, x
);
2837 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2839 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2842 CHECK_BUFFER (Lisp_Object x
)
2844 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2847 CHECK_WINDOW (Lisp_Object x
)
2849 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2853 CHECK_PROCESS (Lisp_Object x
)
2855 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2859 CHECK_NATNUM (Lisp_Object x
)
2861 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2864 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2867 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2868 args_out_of_range_3 \
2870 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2871 ? MOST_NEGATIVE_FIXNUM \
2873 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2875 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2877 if (TYPE_SIGNED (type)) \
2878 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2880 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2883 #define CHECK_NUMBER_COERCE_MARKER(x) \
2885 if (MARKERP ((x))) \
2886 XSETFASTINT (x, marker_position (x)); \
2888 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2892 XFLOATINT (Lisp_Object n
)
2894 return extract_float (n
);
2898 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2900 CHECK_TYPE (NUMBERP (x
), Qnumberp
, x
);
2903 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2906 XSETFASTINT (x, marker_position (x)); \
2908 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2911 /* Since we can't assign directly to the CAR or CDR fields of a cons
2912 cell, use these when checking that those fields contain numbers. */
2914 CHECK_NUMBER_CAR (Lisp_Object x
)
2916 Lisp_Object tmp
= XCAR (x
);
2922 CHECK_NUMBER_CDR (Lisp_Object x
)
2924 Lisp_Object tmp
= XCDR (x
);
2929 /* Define a built-in function for calling from Lisp.
2930 `lname' should be the name to give the function in Lisp,
2931 as a null-terminated C string.
2932 `fnname' should be the name of the function in C.
2933 By convention, it starts with F.
2934 `sname' should be the name for the C constant structure
2935 that records information on this function for internal use.
2936 By convention, it should be the same as `fnname' but with S instead of F.
2937 It's too bad that C macros can't compute this from `fnname'.
2938 `minargs' should be a number, the minimum number of arguments allowed.
2939 `maxargs' should be a number, the maximum number of arguments allowed,
2940 or else MANY or UNEVALLED.
2941 MANY means pass a vector of evaluated arguments,
2942 in the form of an integer number-of-arguments
2943 followed by the address of a vector of Lisp_Objects
2944 which contains the argument values.
2945 UNEVALLED means pass the list of unevaluated arguments
2946 `intspec' says how interactive arguments are to be fetched.
2947 If the string starts with a `(', `intspec' is evaluated and the resulting
2948 list is the list of arguments.
2949 If it's a string that doesn't start with `(', the value should follow
2950 the one of the doc string for `interactive'.
2951 A null string means call interactively with no arguments.
2952 `doc' is documentation for the user. */
2954 /* This version of DEFUN declares a function prototype with the right
2955 arguments, so we can catch errors with maxargs at compile-time. */
2957 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2958 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2959 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2960 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2961 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2962 { (Lisp_Object (__cdecl *)(void))fnname }, \
2963 minargs, maxargs, lname, intspec, 0}; \
2965 #else /* not _MSC_VER */
2966 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2967 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2968 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2969 { .a ## maxargs = fnname }, \
2970 minargs, maxargs, lname, intspec, 0}; \
2974 /* True if OBJ is a Lisp function. */
2976 FUNCTIONP (Lisp_Object obj
)
2978 return functionp (obj
);
2982 is how we define the symbol for function `name' at start-up time. */
2983 extern void defsubr (struct Lisp_Subr
*);
2991 /* Call a function F that accepts many args, passing it ARRAY's elements. */
2992 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
2994 /* Call a function F that accepts many args, passing it the remaining args,
2995 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
2996 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
2997 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
2998 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
3000 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
3001 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
3002 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
3003 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
3004 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
3006 /* Macros we use to define forwarded Lisp variables.
3007 These are used in the syms_of_FILENAME functions.
3009 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
3010 lisp variable is actually a field in `struct emacs_globals'. The
3011 field's name begins with "f_", which is a convention enforced by
3012 these macros. Each such global has a corresponding #define in
3013 globals.h; the plain name should be used in the code.
3015 E.g., the global "cons_cells_consed" is declared as "int
3016 f_cons_cells_consed" in globals.h, but there is a define:
3018 #define cons_cells_consed globals.f_cons_cells_consed
3020 All C code uses the `cons_cells_consed' name. This is all done
3021 this way to support indirection for multi-threaded Emacs. */
3023 #define DEFVAR_LISP(lname, vname, doc) \
3025 static struct Lisp_Objfwd o_fwd; \
3026 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
3028 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
3030 static struct Lisp_Objfwd o_fwd; \
3031 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
3033 #define DEFVAR_BOOL(lname, vname, doc) \
3035 static struct Lisp_Boolfwd b_fwd; \
3036 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
3038 #define DEFVAR_INT(lname, vname, doc) \
3040 static struct Lisp_Intfwd i_fwd; \
3041 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
3044 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
3046 static struct Lisp_Objfwd o_fwd; \
3047 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
3050 #define DEFVAR_KBOARD(lname, vname, doc) \
3052 static struct Lisp_Kboard_Objfwd ko_fwd; \
3053 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
3056 /* Save and restore the instruction and environment pointers,
3057 without affecting the signal mask. */
3060 typedef jmp_buf sys_jmp_buf
;
3061 # define sys_setjmp(j) _setjmp (j)
3062 # define sys_longjmp(j, v) _longjmp (j, v)
3063 #elif defined HAVE_SIGSETJMP
3064 typedef sigjmp_buf sys_jmp_buf
;
3065 # define sys_setjmp(j) sigsetjmp (j, 0)
3066 # define sys_longjmp(j, v) siglongjmp (j, v)
3068 /* A platform that uses neither _longjmp nor siglongjmp; assume
3069 longjmp does not affect the sigmask. */
3070 typedef jmp_buf sys_jmp_buf
;
3071 # define sys_setjmp(j) setjmp (j)
3072 # define sys_longjmp(j, v) longjmp (j, v)
3076 /* Elisp uses several stacks:
3078 - the bytecode stack: used internally by the bytecode interpreter.
3079 Allocated from the C stack.
3080 - The specpdl stack: keeps track of active unwind-protect and
3081 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
3083 - The handler stack: keeps track of active catch tags and condition-case
3084 handlers. Allocated in a manually managed stack implemented by a
3085 doubly-linked list allocated via xmalloc and never freed. */
3087 /* Structure for recording Lisp call stack for backtrace purposes. */
3089 /* The special binding stack holds the outer values of variables while
3090 they are bound by a function application or a let form, stores the
3091 code to be executed for unwind-protect forms.
3093 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
3094 used all over the place, needs to be fast, and needs to know the size of
3095 union specbinding. But only eval.c should access it. */
3098 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
3099 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
3100 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
3101 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
3102 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
3103 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
3104 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3105 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
3106 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
3111 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3113 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3114 void (*func
) (Lisp_Object
);
3118 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3119 void (*func
) (void *);
3123 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3128 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3129 void (*func
) (void);
3132 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3133 /* `where' is not used in the case of SPECPDL_LET. */
3134 Lisp_Object symbol
, old_value
, where
;
3137 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3138 bool_bf debug_on_exit
: 1;
3139 Lisp_Object function
;
3145 extern union specbinding
*specpdl
;
3146 extern union specbinding
*specpdl_ptr
;
3147 extern ptrdiff_t specpdl_size
;
3150 SPECPDL_INDEX (void)
3152 return specpdl_ptr
- specpdl
;
3155 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3156 control structures. A struct handler contains all the information needed to
3157 restore the state of the interpreter after a non-local jump.
3159 handler structures are chained together in a doubly linked list; the `next'
3160 member points to the next outer catchtag and the `nextfree' member points in
3161 the other direction to the next inner element (which is typically the next
3162 free element since we mostly use it on the deepest handler).
3164 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3165 member is TAG, and then unbinds to it. The `val' member is used to
3166 hold VAL while the stack is unwound; `val' is returned as the value
3167 of the catch form. If there is a handler of type CATCHER_ALL, it will
3168 be treated as a handler for all invocations of `throw'; in this case
3169 `val' will be set to (TAG . VAL).
3171 All the other members are concerned with restoring the interpreter
3174 Members are volatile if their values need to survive _longjmp when
3175 a 'struct handler' is a local variable. */
3177 enum handlertype
{ CATCHER
, CONDITION_CASE
, CATCHER_ALL
};
3181 enum handlertype type
;
3182 Lisp_Object tag_or_ch
;
3184 struct handler
*next
;
3185 struct handler
*nextfree
;
3187 /* The bytecode interpreter can have several handlers active at the same
3188 time, so when we longjmp to one of them, it needs to know which handler
3189 this was and what was the corresponding internal state. This is stored
3190 here, and when we longjmp we make sure that handlerlist points to the
3192 Lisp_Object
*bytecode_top
;
3195 /* Most global vars are reset to their value via the specpdl mechanism,
3196 but a few others are handled by storing their value here. */
3198 EMACS_INT lisp_eval_depth
;
3200 int poll_suppress_count
;
3201 int interrupt_input_blocked
;
3202 struct byte_stack
*byte_stack
;
3205 extern Lisp_Object memory_signal_data
;
3207 /* An address near the bottom of the stack.
3208 Tells GC how to save a copy of the stack. */
3209 extern char *stack_bottom
;
3211 /* Check quit-flag and quit if it is non-nil.
3212 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
3213 So the program needs to do QUIT at times when it is safe to quit.
3214 Every loop that might run for a long time or might not exit
3215 ought to do QUIT at least once, at a safe place.
3216 Unless that is impossible, of course.
3217 But it is very desirable to avoid creating loops where QUIT is impossible.
3219 Exception: if you set immediate_quit to true,
3220 then the handler that responds to the C-g does the quit itself.
3221 This is a good thing to do around a loop that has no side effects
3222 and (in particular) cannot call arbitrary Lisp code.
3224 If quit-flag is set to `kill-emacs' the SIGINT handler has received
3225 a request to exit Emacs when it is safe to do. */
3227 extern void process_pending_signals (void);
3228 extern bool volatile pending_signals
;
3230 extern void process_quit_flag (void);
3233 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3234 process_quit_flag (); \
3235 else if (pending_signals) \
3236 process_pending_signals (); \
3240 /* True if ought to quit now. */
3242 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3244 extern Lisp_Object Vascii_downcase_table
;
3245 extern Lisp_Object Vascii_canon_table
;
3247 /* Call staticpro (&var) to protect static variable `var'. */
3249 void staticpro (Lisp_Object
*);
3251 /* Forward declarations for prototypes. */
3255 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3258 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3260 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3261 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3264 /* Functions to modify hash tables. */
3267 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3269 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3273 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3275 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3278 /* Use these functions to set Lisp_Object
3279 or pointer slots of struct Lisp_Symbol. */
3282 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3284 XSYMBOL (sym
)->function
= function
;
3288 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3290 XSYMBOL (sym
)->plist
= plist
;
3294 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3296 XSYMBOL (sym
)->next
= next
;
3299 /* Buffer-local (also frame-local) variable access functions. */
3302 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3304 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3308 /* Set overlay's property list. */
3311 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3313 XOVERLAY (overlay
)->plist
= plist
;
3316 /* Get text properties of S. */
3319 string_intervals (Lisp_Object s
)
3321 return XSTRING (s
)->intervals
;
3324 /* Set text properties of S to I. */
3327 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3329 XSTRING (s
)->intervals
= i
;
3332 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3333 of setting slots directly. */
3336 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3338 XCHAR_TABLE (table
)->defalt
= val
;
3341 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3343 XCHAR_TABLE (table
)->purpose
= val
;
3346 /* Set different slots in (sub)character tables. */
3349 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3351 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3352 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3356 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3358 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3359 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3363 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3365 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3368 /* Defined in data.c. */
3369 extern Lisp_Object
indirect_function (Lisp_Object
);
3370 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3371 enum Arith_Comparison
{
3376 ARITH_LESS_OR_EQUAL
,
3379 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3380 enum Arith_Comparison comparison
);
3382 /* Convert the integer I to an Emacs representation, either the integer
3383 itself, or a cons of two or three integers, or if all else fails a float.
3384 I should not have side effects. */
3385 #define INTEGER_TO_CONS(i) \
3386 (! FIXNUM_OVERFLOW_P (i) \
3388 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3389 extern Lisp_Object
intbig_to_lisp (intmax_t);
3390 extern Lisp_Object
uintbig_to_lisp (uintmax_t);
3392 /* Convert the Emacs representation CONS back to an integer of type
3393 TYPE, storing the result the variable VAR. Signal an error if CONS
3394 is not a valid representation or is out of range for TYPE. */
3395 #define CONS_TO_INTEGER(cons, type, var) \
3396 (TYPE_SIGNED (type) \
3397 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3398 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3399 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3400 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3402 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3403 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3404 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3406 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3407 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3408 extern void syms_of_data (void);
3409 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3411 /* Defined in cmds.c */
3412 extern void syms_of_cmds (void);
3413 extern void keys_of_cmds (void);
3415 /* Defined in coding.c. */
3416 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3417 ptrdiff_t, bool, bool, Lisp_Object
);
3418 extern void init_coding (void);
3419 extern void init_coding_once (void);
3420 extern void syms_of_coding (void);
3422 /* Defined in character.c. */
3423 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3424 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3425 extern void syms_of_character (void);
3427 /* Defined in charset.c. */
3428 extern void init_charset (void);
3429 extern void init_charset_once (void);
3430 extern void syms_of_charset (void);
3431 /* Structure forward declarations. */
3434 /* Defined in syntax.c. */
3435 extern void init_syntax_once (void);
3436 extern void syms_of_syntax (void);
3438 /* Defined in fns.c. */
3439 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3440 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3441 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3442 extern void sweep_weak_hash_tables (void);
3443 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3444 EMACS_UINT
sxhash (Lisp_Object
, int);
3445 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3446 Lisp_Object
, Lisp_Object
);
3447 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3448 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3450 void hash_remove_from_table (struct Lisp_Hash_Table
*, Lisp_Object
);
3451 extern struct hash_table_test hashtest_eq
, hashtest_eql
, hashtest_equal
;
3452 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3453 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3454 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3455 ptrdiff_t, ptrdiff_t);
3456 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3457 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3458 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3459 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3460 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3461 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3462 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3463 extern void clear_string_char_byte_cache (void);
3464 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3465 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3466 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3467 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3468 extern void syms_of_fns (void);
3470 /* Defined in floatfns.c. */
3471 extern void syms_of_floatfns (void);
3472 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3474 /* Defined in fringe.c. */
3475 extern void syms_of_fringe (void);
3476 extern void init_fringe (void);
3477 #ifdef HAVE_WINDOW_SYSTEM
3478 extern void mark_fringe_data (void);
3479 extern void init_fringe_once (void);
3480 #endif /* HAVE_WINDOW_SYSTEM */
3482 /* Defined in image.c. */
3483 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3484 extern void reset_image_types (void);
3485 extern void syms_of_image (void);
3487 /* Defined in insdel.c. */
3488 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3489 extern _Noreturn
void buffer_overflow (void);
3490 extern void make_gap (ptrdiff_t);
3491 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3492 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3493 ptrdiff_t, bool, bool);
3494 extern int count_combining_before (const unsigned char *,
3495 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3496 extern int count_combining_after (const unsigned char *,
3497 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3498 extern void insert (const char *, ptrdiff_t);
3499 extern void insert_and_inherit (const char *, ptrdiff_t);
3500 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3502 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3503 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3504 ptrdiff_t, ptrdiff_t, bool);
3505 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3506 extern void insert_char (int);
3507 extern void insert_string (const char *);
3508 extern void insert_before_markers (const char *, ptrdiff_t);
3509 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3510 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3511 ptrdiff_t, ptrdiff_t,
3513 extern void del_range (ptrdiff_t, ptrdiff_t);
3514 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3515 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3516 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3517 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3518 ptrdiff_t, ptrdiff_t, bool);
3519 extern void modify_text (ptrdiff_t, ptrdiff_t);
3520 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3521 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3522 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3523 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3524 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3525 ptrdiff_t, ptrdiff_t);
3526 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3527 ptrdiff_t, ptrdiff_t);
3528 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3529 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3530 const char *, ptrdiff_t, ptrdiff_t, bool);
3531 extern void syms_of_insdel (void);
3533 /* Defined in dispnew.c. */
3534 #if (defined PROFILING \
3535 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3536 _Noreturn
void __executable_start (void);
3538 extern Lisp_Object Vwindow_system
;
3539 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3541 /* Defined in xdisp.c. */
3542 extern bool noninteractive_need_newline
;
3543 extern Lisp_Object echo_area_buffer
[2];
3544 extern void add_to_log (char const *, ...);
3545 extern void vadd_to_log (char const *, va_list);
3546 extern void check_message_stack (void);
3547 extern void setup_echo_area_for_printing (bool);
3548 extern bool push_message (void);
3549 extern void pop_message_unwind (void);
3550 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3551 extern void restore_message (void);
3552 extern Lisp_Object
current_message (void);
3553 extern void clear_message (bool, bool);
3554 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3555 extern void message1 (const char *);
3556 extern void message1_nolog (const char *);
3557 extern void message3 (Lisp_Object
);
3558 extern void message3_nolog (Lisp_Object
);
3559 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3560 extern void message_with_string (const char *, Lisp_Object
, bool);
3561 extern void message_log_maybe_newline (void);
3562 extern void update_echo_area (void);
3563 extern void truncate_echo_area (ptrdiff_t);
3564 extern void redisplay (void);
3566 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3567 extern void syms_of_xdisp (void);
3568 extern void init_xdisp (void);
3569 extern Lisp_Object
safe_eval (Lisp_Object
);
3570 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3571 int *, int *, int *, int *, int *);
3573 /* Defined in xsettings.c. */
3574 extern void syms_of_xsettings (void);
3576 /* Defined in vm-limit.c. */
3577 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3579 /* Defined in character.c. */
3580 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3581 ptrdiff_t *, ptrdiff_t *);
3583 /* Defined in alloc.c. */
3584 extern void check_pure_size (void);
3585 extern void free_misc (Lisp_Object
);
3586 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3587 extern void malloc_warning (const char *);
3588 extern _Noreturn
void memory_full (size_t);
3589 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3590 extern bool survives_gc_p (Lisp_Object
);
3591 extern void mark_object (Lisp_Object
);
3592 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3593 extern void refill_memory_reserve (void);
3595 extern const char *pending_malloc_warning
;
3596 extern Lisp_Object zero_vector
;
3597 extern Lisp_Object
*stack_base
;
3598 extern EMACS_INT consing_since_gc
;
3599 extern EMACS_INT gc_relative_threshold
;
3600 extern EMACS_INT memory_full_cons_threshold
;
3601 extern Lisp_Object
list1 (Lisp_Object
);
3602 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3603 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3604 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3605 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3607 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3608 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3610 /* Build a frequently used 2/3/4-integer lists. */
3613 list2i (EMACS_INT x
, EMACS_INT y
)
3615 return list2 (make_number (x
), make_number (y
));
3619 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3621 return list3 (make_number (x
), make_number (y
), make_number (w
));
3625 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3627 return list4 (make_number (x
), make_number (y
),
3628 make_number (w
), make_number (h
));
3631 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3632 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3633 extern _Noreturn
void string_overflow (void);
3634 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3635 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3636 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3637 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3639 /* Make unibyte string from C string when the length isn't known. */
3642 build_unibyte_string (const char *str
)
3644 return make_unibyte_string (str
, strlen (str
));
3647 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3648 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3649 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3650 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3651 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3652 extern Lisp_Object
make_specified_string (const char *,
3653 ptrdiff_t, ptrdiff_t, bool);
3654 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3655 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3657 /* Make a string allocated in pure space, use STR as string data. */
3660 build_pure_c_string (const char *str
)
3662 return make_pure_c_string (str
, strlen (str
));
3665 /* Make a string from the data at STR, treating it as multibyte if the
3669 build_string (const char *str
)
3671 return make_string (str
, strlen (str
));
3674 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3675 extern void make_byte_code (struct Lisp_Vector
*);
3676 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3678 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3679 be sure that GC cannot happen until the vector is completely
3680 initialized. E.g. the following code is likely to crash:
3682 v = make_uninit_vector (3);
3684 ASET (v, 1, Ffunction_can_gc ());
3685 ASET (v, 2, obj1); */
3688 make_uninit_vector (ptrdiff_t size
)
3691 struct Lisp_Vector
*p
;
3693 p
= allocate_vector (size
);
3698 /* Like above, but special for sub char-tables. */
3701 make_uninit_sub_char_table (int depth
, int min_char
)
3703 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3704 Lisp_Object v
= make_uninit_vector (slots
);
3706 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3707 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3708 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3712 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3715 /* Allocate partially initialized pseudovector where all Lisp_Object
3716 slots are set to Qnil but the rest (if any) is left uninitialized. */
3718 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3719 ((type *) allocate_pseudovector (VECSIZE (type), \
3720 PSEUDOVECSIZE (type, field), \
3721 PSEUDOVECSIZE (type, field), tag))
3723 /* Allocate fully initialized pseudovector where all Lisp_Object
3724 slots are set to Qnil and the rest (if any) is zeroed. */
3726 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3727 ((type *) allocate_pseudovector (VECSIZE (type), \
3728 PSEUDOVECSIZE (type, field), \
3729 VECSIZE (type), tag))
3731 extern bool gc_in_progress
;
3732 extern bool abort_on_gc
;
3733 extern Lisp_Object
make_float (double);
3734 extern void display_malloc_warning (void);
3735 extern ptrdiff_t inhibit_garbage_collection (void);
3736 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3737 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3738 Lisp_Object
, Lisp_Object
);
3739 extern Lisp_Object
make_save_ptr (void *);
3740 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3741 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3742 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3744 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3745 extern void free_save_value (Lisp_Object
);
3746 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3747 extern void free_marker (Lisp_Object
);
3748 extern void free_cons (struct Lisp_Cons
*);
3749 extern void init_alloc_once (void);
3750 extern void init_alloc (void);
3751 extern void syms_of_alloc (void);
3752 extern struct buffer
* allocate_buffer (void);
3753 extern int valid_lisp_object_p (Lisp_Object
);
3754 #ifdef GC_CHECK_CONS_LIST
3755 extern void check_cons_list (void);
3757 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3761 /* Defined in ralloc.c. */
3762 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3763 extern void r_alloc_free (void **);
3764 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3765 extern void r_alloc_reset_variable (void **, void **);
3766 extern void r_alloc_inhibit_buffer_relocation (int);
3769 /* Defined in chartab.c. */
3770 extern Lisp_Object
copy_char_table (Lisp_Object
);
3771 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3773 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3774 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3776 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3777 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3778 Lisp_Object
, Lisp_Object
,
3779 Lisp_Object
, struct charset
*,
3780 unsigned, unsigned);
3781 extern Lisp_Object
uniprop_table (Lisp_Object
);
3782 extern void syms_of_chartab (void);
3784 /* Defined in print.c. */
3785 extern Lisp_Object Vprin1_to_string_buffer
;
3786 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3787 extern void temp_output_buffer_setup (const char *);
3788 extern int print_level
;
3789 extern void write_string (const char *);
3790 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3792 extern Lisp_Object internal_with_output_to_temp_buffer
3793 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3794 #define FLOAT_TO_STRING_BUFSIZE 350
3795 extern int float_to_string (char *, double);
3796 extern void init_print_once (void);
3797 extern void syms_of_print (void);
3799 /* Defined in doprnt.c. */
3800 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3802 extern ptrdiff_t esprintf (char *, char const *, ...)
3803 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3804 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3806 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3807 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3808 char const *, va_list)
3809 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3811 /* Defined in lread.c. */
3812 extern Lisp_Object
check_obarray (Lisp_Object
);
3813 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3814 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3815 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3816 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3817 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3819 LOADHIST_ATTACH (Lisp_Object x
)
3822 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3824 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3825 Lisp_Object
*, Lisp_Object
, bool);
3826 extern Lisp_Object
string_to_number (char const *, int, bool);
3827 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3829 extern void dir_warning (const char *, Lisp_Object
);
3830 extern void init_obarray (void);
3831 extern void init_lread (void);
3832 extern void syms_of_lread (void);
3835 intern (const char *str
)
3837 return intern_1 (str
, strlen (str
));
3841 intern_c_string (const char *str
)
3843 return intern_c_string_1 (str
, strlen (str
));
3846 /* Defined in eval.c. */
3847 extern Lisp_Object Vautoload_queue
;
3848 extern Lisp_Object Vrun_hooks
;
3849 extern Lisp_Object Vsignaling_function
;
3850 extern Lisp_Object inhibit_lisp_code
;
3851 extern struct handler
*handlerlist
;
3853 /* To run a normal hook, use the appropriate function from the list below.
3854 The calling convention:
3856 if (!NILP (Vrun_hooks))
3857 call1 (Vrun_hooks, Qmy_funny_hook);
3859 should no longer be used. */
3860 extern void run_hook (Lisp_Object
);
3861 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3862 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3863 Lisp_Object (*funcall
)
3864 (ptrdiff_t nargs
, Lisp_Object
*args
));
3865 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3866 extern _Noreturn
void xsignal0 (Lisp_Object
);
3867 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3868 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3869 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3871 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3872 extern Lisp_Object
eval_sub (Lisp_Object form
);
3873 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3874 extern Lisp_Object
call0 (Lisp_Object
);
3875 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3876 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3877 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3878 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3879 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3880 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3881 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3882 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3883 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3884 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3885 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3886 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3887 extern Lisp_Object internal_condition_case_n
3888 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3889 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3890 extern struct handler
*push_handler (Lisp_Object
, enum handlertype
);
3891 extern struct handler
*push_handler_nosignal (Lisp_Object
, enum handlertype
);
3892 extern void specbind (Lisp_Object
, Lisp_Object
);
3893 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3894 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3895 extern void record_unwind_protect_int (void (*) (int), int);
3896 extern void record_unwind_protect_void (void (*) (void));
3897 extern void record_unwind_protect_nothing (void);
3898 extern void clear_unwind_protect (ptrdiff_t);
3899 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3900 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3901 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3902 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3903 extern _Noreturn
void verror (const char *, va_list)
3904 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3905 extern void un_autoload (Lisp_Object
);
3906 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3907 extern void *near_C_stack_top (void);
3908 extern void init_eval_once (void);
3909 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3910 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3911 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3912 extern void init_eval (void);
3913 extern void syms_of_eval (void);
3914 extern void unwind_body (Lisp_Object
);
3915 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
3916 extern void mark_specpdl (void);
3917 extern void get_backtrace (Lisp_Object array
);
3918 Lisp_Object
backtrace_top_function (void);
3919 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3920 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3923 /* Defined in alloc.c. */
3924 extern Lisp_Object
make_user_ptr (void (*finalizer
) (void*), void *p
);
3926 /* Defined in emacs-module.c. */
3927 extern void module_init (void);
3928 extern void syms_of_module (void);
3931 /* Defined in editfns.c. */
3932 extern void insert1 (Lisp_Object
);
3933 extern Lisp_Object
save_excursion_save (void);
3934 extern Lisp_Object
save_restriction_save (void);
3935 extern void save_excursion_restore (Lisp_Object
);
3936 extern void save_restriction_restore (Lisp_Object
);
3937 extern _Noreturn
void time_overflow (void);
3938 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3939 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3941 extern void init_editfns (bool);
3942 extern void syms_of_editfns (void);
3944 /* Defined in buffer.c. */
3945 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3946 extern _Noreturn
void nsberror (Lisp_Object
);
3947 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3948 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3949 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3950 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3951 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3952 extern bool overlay_touches_p (ptrdiff_t);
3953 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3954 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3955 extern void init_buffer_once (void);
3956 extern void init_buffer (int);
3957 extern void syms_of_buffer (void);
3958 extern void keys_of_buffer (void);
3960 /* Defined in marker.c. */
3962 extern ptrdiff_t marker_position (Lisp_Object
);
3963 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3964 extern void clear_charpos_cache (struct buffer
*);
3965 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3966 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3967 extern void unchain_marker (struct Lisp_Marker
*marker
);
3968 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3969 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3970 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3971 ptrdiff_t, ptrdiff_t);
3972 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3973 extern void syms_of_marker (void);
3975 /* Defined in fileio.c. */
3977 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3978 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3979 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3981 extern void close_file_unwind (int);
3982 extern void fclose_unwind (void *);
3983 extern void restore_point_unwind (Lisp_Object
);
3984 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3985 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3986 extern _Noreturn
void report_file_notify_error (const char *, Lisp_Object
);
3987 extern bool internal_delete_file (Lisp_Object
);
3988 extern Lisp_Object
emacs_readlinkat (int, const char *);
3989 extern bool file_directory_p (const char *);
3990 extern bool file_accessible_directory_p (Lisp_Object
);
3991 extern void init_fileio (void);
3992 extern void syms_of_fileio (void);
3993 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3995 /* Defined in search.c. */
3996 extern void shrink_regexp_cache (void);
3997 extern void restore_search_regs (void);
3998 extern void record_unwind_save_match_data (void);
3999 struct re_registers
;
4000 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4001 struct re_registers
*,
4002 Lisp_Object
, bool, bool);
4003 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
4007 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
4009 return fast_string_match_internal (regexp
, string
, Qnil
);
4013 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
4015 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
4018 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4020 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4021 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4022 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4023 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4024 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4026 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
4027 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4028 ptrdiff_t, ptrdiff_t *);
4029 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4030 ptrdiff_t, ptrdiff_t *);
4031 extern void syms_of_search (void);
4032 extern void clear_regexp_cache (void);
4034 /* Defined in minibuf.c. */
4036 extern Lisp_Object Vminibuffer_list
;
4037 extern Lisp_Object last_minibuf_string
;
4038 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4039 extern void init_minibuf_once (void);
4040 extern void syms_of_minibuf (void);
4042 /* Defined in callint.c. */
4044 extern void syms_of_callint (void);
4046 /* Defined in casefiddle.c. */
4048 extern void syms_of_casefiddle (void);
4049 extern void keys_of_casefiddle (void);
4051 /* Defined in casetab.c. */
4053 extern void init_casetab_once (void);
4054 extern void syms_of_casetab (void);
4056 /* Defined in keyboard.c. */
4058 extern Lisp_Object echo_message_buffer
;
4059 extern struct kboard
*echo_kboard
;
4060 extern void cancel_echoing (void);
4061 extern bool input_pending
;
4062 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4063 extern sigjmp_buf return_to_command_loop
;
4065 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4066 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4067 extern void discard_mouse_events (void);
4069 void handle_input_available_signal (int);
4071 extern Lisp_Object pending_funcalls
;
4072 extern bool detect_input_pending (void);
4073 extern bool detect_input_pending_ignore_squeezables (void);
4074 extern bool detect_input_pending_run_timers (bool);
4075 extern void safe_run_hooks (Lisp_Object
);
4076 extern void cmd_error_internal (Lisp_Object
, const char *);
4077 extern Lisp_Object
command_loop_1 (void);
4078 extern Lisp_Object
read_menu_command (void);
4079 extern Lisp_Object
recursive_edit_1 (void);
4080 extern void record_auto_save (void);
4081 extern void force_auto_save_soon (void);
4082 extern void init_keyboard (void);
4083 extern void syms_of_keyboard (void);
4084 extern void keys_of_keyboard (void);
4086 /* Defined in indent.c. */
4087 extern ptrdiff_t current_column (void);
4088 extern void invalidate_current_column (void);
4089 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4090 extern void syms_of_indent (void);
4092 /* Defined in frame.c. */
4093 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4094 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4095 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4096 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4097 extern void frames_discard_buffer (Lisp_Object
);
4098 extern void syms_of_frame (void);
4100 /* Defined in emacs.c. */
4101 extern char **initial_argv
;
4102 extern int initial_argc
;
4103 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4104 extern bool display_arg
;
4106 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4107 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4108 extern _Noreturn
void terminate_due_to_signal (int, int);
4110 extern Lisp_Object Vlibrary_cache
;
4113 void fixup_locale (void);
4114 void synchronize_system_messages_locale (void);
4115 void synchronize_system_time_locale (void);
4117 INLINE
void fixup_locale (void) {}
4118 INLINE
void synchronize_system_messages_locale (void) {}
4119 INLINE
void synchronize_system_time_locale (void) {}
4121 extern void shut_down_emacs (int, Lisp_Object
);
4123 /* True means don't do interactive redisplay and don't change tty modes. */
4124 extern bool noninteractive
;
4126 /* True means remove site-lisp directories from load-path. */
4127 extern bool no_site_lisp
;
4129 /* Pipe used to send exit notification to the daemon parent at
4130 startup. On Windows, we use a kernel event instead. */
4132 extern int daemon_pipe
[2];
4133 #define IS_DAEMON (daemon_pipe[1] != 0)
4134 #define DAEMON_RUNNING (daemon_pipe[1] >= 0)
4135 #else /* WINDOWSNT */
4136 extern void *w32_daemon_event
;
4137 #define IS_DAEMON (w32_daemon_event != NULL)
4138 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4141 /* True if handling a fatal error already. */
4142 extern bool fatal_error_in_progress
;
4144 /* True means don't do use window-system-specific display code. */
4145 extern bool inhibit_window_system
;
4146 /* True means that a filter or a sentinel is running. */
4147 extern bool running_asynch_code
;
4149 /* Defined in process.c. */
4150 extern void kill_buffer_processes (Lisp_Object
);
4151 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4152 struct Lisp_Process
*, int);
4153 /* Max value for the first argument of wait_reading_process_output. */
4154 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4155 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4156 The bug merely causes a bogus warning, but the warning is annoying. */
4157 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4159 # define WAIT_READING_MAX INTMAX_MAX
4162 extern void add_timer_wait_descriptor (int);
4164 extern void add_keyboard_wait_descriptor (int);
4165 extern void delete_keyboard_wait_descriptor (int);
4167 extern void add_gpm_wait_descriptor (int);
4168 extern void delete_gpm_wait_descriptor (int);
4170 extern void init_process_emacs (void);
4171 extern void syms_of_process (void);
4172 extern void setup_process_coding_systems (Lisp_Object
);
4174 /* Defined in callproc.c. */
4178 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4179 extern void init_callproc_1 (void);
4180 extern void init_callproc (void);
4181 extern void set_initial_environment (void);
4182 extern void syms_of_callproc (void);
4184 /* Defined in doc.c. */
4185 enum text_quoting_style
4187 /* Use curved single quotes ‘like this’. */
4188 CURVE_QUOTING_STYLE
,
4190 /* Use grave accent and apostrophe `like this'. */
4191 GRAVE_QUOTING_STYLE
,
4193 /* Use apostrophes 'like this'. */
4194 STRAIGHT_QUOTING_STYLE
4196 extern enum text_quoting_style
text_quoting_style (void);
4197 extern Lisp_Object
read_doc_string (Lisp_Object
);
4198 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4199 extern void syms_of_doc (void);
4200 extern int read_bytecode_char (bool);
4202 /* Defined in bytecode.c. */
4203 extern void syms_of_bytecode (void);
4204 extern struct byte_stack
*byte_stack_list
;
4205 extern void relocate_byte_stack (void);
4206 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4207 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4209 /* Defined in macros.c. */
4210 extern void init_macros (void);
4211 extern void syms_of_macros (void);
4213 /* Defined in undo.c. */
4214 extern void truncate_undo_list (struct buffer
*);
4215 extern void record_insert (ptrdiff_t, ptrdiff_t);
4216 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4217 extern void record_first_change (void);
4218 extern void record_change (ptrdiff_t, ptrdiff_t);
4219 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4220 Lisp_Object
, Lisp_Object
,
4222 extern void syms_of_undo (void);
4224 /* Defined in textprop.c. */
4225 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4227 /* Defined in menu.c. */
4228 extern void syms_of_menu (void);
4230 /* Defined in xmenu.c. */
4231 extern void syms_of_xmenu (void);
4233 /* Defined in termchar.h. */
4234 struct tty_display_info
;
4236 /* Defined in termhooks.h. */
4239 /* Defined in sysdep.c. */
4240 #ifndef HAVE_GET_CURRENT_DIR_NAME
4241 extern char *get_current_dir_name (void);
4243 extern void stuff_char (char c
);
4244 extern void init_foreground_group (void);
4245 extern void sys_subshell (void);
4246 extern void sys_suspend (void);
4247 extern void discard_tty_input (void);
4248 extern void init_sys_modes (struct tty_display_info
*);
4249 extern void reset_sys_modes (struct tty_display_info
*);
4250 extern void init_all_sys_modes (void);
4251 extern void reset_all_sys_modes (void);
4252 extern void child_setup_tty (int);
4253 extern void setup_pty (int);
4254 extern int set_window_size (int, int, int);
4255 extern EMACS_INT
get_random (void);
4256 extern void seed_random (void *, ptrdiff_t);
4257 extern void init_random (void);
4258 extern void emacs_backtrace (int);
4259 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4260 extern int emacs_open (const char *, int, int);
4261 extern int emacs_pipe (int[2]);
4262 extern int emacs_close (int);
4263 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4264 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4265 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4266 extern void emacs_perror (char const *);
4268 extern void unlock_all_files (void);
4269 extern void lock_file (Lisp_Object
);
4270 extern void unlock_file (Lisp_Object
);
4271 extern void unlock_buffer (struct buffer
*);
4272 extern void syms_of_filelock (void);
4273 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4275 /* Defined in sound.c. */
4276 extern void syms_of_sound (void);
4278 /* Defined in category.c. */
4279 extern void init_category_once (void);
4280 extern Lisp_Object
char_category_set (int);
4281 extern void syms_of_category (void);
4283 /* Defined in ccl.c. */
4284 extern void syms_of_ccl (void);
4286 /* Defined in dired.c. */
4287 extern void syms_of_dired (void);
4288 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4289 Lisp_Object
, Lisp_Object
,
4292 /* Defined in term.c. */
4293 extern int *char_ins_del_vector
;
4294 extern void syms_of_term (void);
4295 extern _Noreturn
void fatal (const char *msgid
, ...)
4296 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4298 /* Defined in terminal.c. */
4299 extern void syms_of_terminal (void);
4301 /* Defined in font.c. */
4302 extern void syms_of_font (void);
4303 extern void init_font (void);
4305 #ifdef HAVE_WINDOW_SYSTEM
4306 /* Defined in fontset.c. */
4307 extern void syms_of_fontset (void);
4310 /* Defined in gfilenotify.c */
4311 #ifdef HAVE_GFILENOTIFY
4312 extern void globals_of_gfilenotify (void);
4313 extern void syms_of_gfilenotify (void);
4316 /* Defined in inotify.c */
4318 extern void syms_of_inotify (void);
4321 #ifdef HAVE_W32NOTIFY
4322 /* Defined on w32notify.c. */
4323 extern void syms_of_w32notify (void);
4326 /* Defined in xfaces.c. */
4327 extern Lisp_Object Vface_alternative_font_family_alist
;
4328 extern Lisp_Object Vface_alternative_font_registry_alist
;
4329 extern void syms_of_xfaces (void);
4331 #ifdef HAVE_X_WINDOWS
4332 /* Defined in xfns.c. */
4333 extern void syms_of_xfns (void);
4335 /* Defined in xsmfns.c. */
4336 extern void syms_of_xsmfns (void);
4338 /* Defined in xselect.c. */
4339 extern void syms_of_xselect (void);
4341 /* Defined in xterm.c. */
4342 extern void init_xterm (void);
4343 extern void syms_of_xterm (void);
4344 #endif /* HAVE_X_WINDOWS */
4346 #ifdef HAVE_WINDOW_SYSTEM
4347 /* Defined in xterm.c, nsterm.m, w32term.c. */
4348 extern char *x_get_keysym_name (int);
4349 #endif /* HAVE_WINDOW_SYSTEM */
4352 /* Defined in xml.c. */
4353 extern void syms_of_xml (void);
4354 extern void xml_cleanup_parser (void);
4358 /* Defined in decompress.c. */
4359 extern void syms_of_decompress (void);
4363 /* Defined in dbusbind.c. */
4364 void init_dbusbind (void);
4365 void syms_of_dbusbind (void);
4369 /* Defined in profiler.c. */
4370 extern bool profiler_memory_running
;
4371 extern void malloc_probe (size_t);
4372 extern void syms_of_profiler (void);
4376 /* Defined in msdos.c, w32.c. */
4377 extern char *emacs_root_dir (void);
4380 /* Defined in lastfile.c. */
4381 extern char my_edata
[];
4382 extern char my_endbss
[];
4383 extern char *my_endbss_static
;
4385 /* True means ^G can quit instantly. */
4386 extern bool immediate_quit
;
4388 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4389 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4390 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4391 extern void xfree (void *);
4392 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4393 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4394 ATTRIBUTE_ALLOC_SIZE ((2,3));
4395 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4397 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4398 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4399 extern void dupstring (char **, char const *);
4401 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4402 null byte. This is like stpcpy, except the source is a Lisp string. */
4405 lispstpcpy (char *dest
, Lisp_Object string
)
4407 ptrdiff_t len
= SBYTES (string
);
4408 memcpy (dest
, SDATA (string
), len
+ 1);
4412 extern void xputenv (const char *);
4414 extern char *egetenv_internal (const char *, ptrdiff_t);
4417 egetenv (const char *var
)
4419 /* When VAR is a string literal, strlen can be optimized away. */
4420 return egetenv_internal (var
, strlen (var
));
4423 /* Set up the name of the machine we're running on. */
4424 extern void init_system_name (void);
4426 /* Return the absolute value of X. X should be a signed integer
4427 expression without side effects, and X's absolute value should not
4428 exceed the maximum for its promoted type. This is called 'eabs'
4429 because 'abs' is reserved by the C standard. */
4430 #define eabs(x) ((x) < 0 ? -(x) : (x))
4432 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4435 #define make_fixnum_or_float(val) \
4436 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4438 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4439 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4441 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4443 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4445 #define USE_SAFE_ALLOCA \
4446 ptrdiff_t sa_avail = MAX_ALLOCA; \
4447 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4449 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4451 /* SAFE_ALLOCA allocates a simple buffer. */
4453 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4454 ? AVAIL_ALLOCA (size) \
4455 : (sa_must_free = true, record_xmalloc (size)))
4457 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4458 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4459 positive. The code is tuned for MULTIPLIER being a constant. */
4461 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4463 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4464 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4467 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4468 sa_must_free = true; \
4469 record_unwind_protect_ptr (xfree, buf); \
4473 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4475 #define SAFE_ALLOCA_STRING(ptr, string) \
4477 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4478 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4481 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4483 #define SAFE_FREE() \
4485 if (sa_must_free) { \
4486 sa_must_free = false; \
4487 unbind_to (sa_count, Qnil); \
4491 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4493 #define SAFE_ALLOCA_LISP(buf, nelt) \
4495 ptrdiff_t alloca_nbytes; \
4496 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4497 || SIZE_MAX < alloca_nbytes) \
4498 memory_full (SIZE_MAX); \
4499 else if (alloca_nbytes <= sa_avail) \
4500 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4504 (buf) = xmalloc (alloca_nbytes); \
4505 arg_ = make_save_memory (buf, nelt); \
4506 sa_must_free = true; \
4507 record_unwind_protect (free_save_value, arg_); \
4512 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4513 block-scoped conses and strings. These objects are not
4514 managed by the garbage collector, so they are dangerous: passing them
4515 out of their scope (e.g., to user code) results in undefined behavior.
4516 Conversely, they have better performance because GC is not involved.
4518 This feature is experimental and requires careful debugging.
4519 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4521 #ifndef USE_STACK_LISP_OBJECTS
4522 # define USE_STACK_LISP_OBJECTS true
4525 #ifdef GC_CHECK_STRING_BYTES
4526 enum { defined_GC_CHECK_STRING_BYTES
= true };
4528 enum { defined_GC_CHECK_STRING_BYTES
= false };
4531 /* Struct inside unions that are typically no larger and aligned enough. */
4536 double d
; intmax_t i
; void *p
;
4539 union Aligned_String
4541 struct Lisp_String s
;
4542 double d
; intmax_t i
; void *p
;
4545 /* True for stack-based cons and string implementations, respectively.
4546 Use stack-based strings only if stack-based cons also works.
4547 Otherwise, STACK_CONS would create heap-based cons cells that
4548 could point to stack-based strings, which is a no-no. */
4552 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4553 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4554 USE_STACK_STRING
= (USE_STACK_CONS
4555 && !defined_GC_CHECK_STRING_BYTES
4556 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4559 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4560 use these only in macros like AUTO_CONS that declare a local
4561 variable whose lifetime will be clear to the programmer. */
4562 #define STACK_CONS(a, b) \
4563 make_lisp_ptr (&(union Aligned_Cons) { { a, { b } } }.s, Lisp_Cons)
4564 #define AUTO_CONS_EXPR(a, b) \
4565 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4567 /* Declare NAME as an auto Lisp cons or short list if possible, a
4568 GC-based one otherwise. This is in the sense of the C keyword
4569 'auto'; i.e., the object has the lifetime of the containing block.
4570 The resulting object should not be made visible to user Lisp code. */
4572 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4573 #define AUTO_LIST1(name, a) \
4574 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4575 #define AUTO_LIST2(name, a, b) \
4576 Lisp_Object name = (USE_STACK_CONS \
4577 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4579 #define AUTO_LIST3(name, a, b, c) \
4580 Lisp_Object name = (USE_STACK_CONS \
4581 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4583 #define AUTO_LIST4(name, a, b, c, d) \
4586 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4587 STACK_CONS (d, Qnil)))) \
4588 : list4 (a, b, c, d))
4590 /* Check whether stack-allocated strings are ASCII-only. */
4592 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
4593 extern const char *verify_ascii (const char *);
4595 # define verify_ascii(str) (str)
4598 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4599 Take its value from STR. STR is not necessarily copied and should
4600 contain only ASCII characters. The resulting Lisp string should
4601 not be modified or made visible to user code. */
4603 #define AUTO_STRING(name, str) \
4604 Lisp_Object name = \
4607 ((&(union Aligned_String) \
4608 {{strlen (str), -1, 0, (unsigned char *) verify_ascii (str)}}.s), \
4610 : build_string (verify_ascii (str)))
4612 /* Loop over all tails of a list, checking for cycles.
4613 FIXME: Make tortoise and n internal declarations.
4614 FIXME: Unroll the loop body so we don't need `n'. */
4615 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4616 for ((tortoise) = (hare) = (list), (n) = true; \
4618 (hare = XCDR (hare), (n) = !(n), \
4620 ? (EQ (hare, tortoise) \
4621 ? xsignal1 (Qcircular_list, list) \
4623 /* Move tortoise before the next iteration, in case */ \
4624 /* the next iteration does an Fsetcdr. */ \
4625 : (void) ((tortoise) = XCDR (tortoise)))))
4627 /* Do a `for' loop over alist values. */
4629 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4630 for ((list_var) = (head_var); \
4631 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4632 (list_var) = XCDR (list_var))
4634 /* Check whether it's time for GC, and run it if so. */
4639 if ((consing_since_gc
> gc_cons_threshold
4640 && consing_since_gc
> gc_relative_threshold
)
4641 || (!NILP (Vmemory_full
)
4642 && consing_since_gc
> memory_full_cons_threshold
))
4643 Fgarbage_collect ();
4647 functionp (Lisp_Object object
)
4649 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4651 object
= Findirect_function (object
, Qt
);
4653 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4655 /* Autoloaded symbols are functions, except if they load
4656 macros or keymaps. */
4658 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4659 object
= XCDR (object
);
4661 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4666 return XSUBR (object
)->max_args
!= UNEVALLED
;
4667 else if (COMPILEDP (object
))
4669 else if (CONSP (object
))
4671 Lisp_Object car
= XCAR (object
);
4672 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4680 #endif /* EMACS_LISP_H */