1 /* Fundamental definitions for GNU Emacs Lisp interpreter. -*- coding: utf-8 -*-
3 Copyright (C) 1985-1987, 1993-1995, 1997-2016 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 (at
11 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/>. */
39 /* Define a TYPE constant ID as an externally visible name. Use like this:
41 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
42 # define ID (some integer preprocessor expression of type TYPE)
43 DEFINE_GDB_SYMBOL_END (ID)
45 This hack is for the benefit of compilers that do not make macro
46 definitions or enums visible to the debugger. It's used for symbols
47 that .gdbinit needs. */
49 #define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
51 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
52 # define DEFINE_GDB_SYMBOL_END(id) = id;
54 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
55 # define DEFINE_GDB_SYMBOL_END(val) ;
58 /* The ubiquitous max and min macros. */
61 #define max(a, b) ((a) > (b) ? (a) : (b))
62 #define min(a, b) ((a) < (b) ? (a) : (b))
64 /* Number of elements in an array. */
65 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
67 /* Number of bits in a Lisp_Object tag. */
68 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
70 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
72 /* EMACS_INT - signed integer wide enough to hold an Emacs value
73 EMACS_INT_WIDTH - width in bits of EMACS_INT
74 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
75 pI - printf length modifier for EMACS_INT
76 EMACS_UINT - unsigned variant of EMACS_INT */
79 # error "INTPTR_MAX misconfigured"
80 # elif INTPTR_MAX <= INT_MAX && !defined WIDE_EMACS_INT
81 typedef int EMACS_INT
;
82 typedef unsigned int EMACS_UINT
;
83 enum { EMACS_INT_WIDTH
= INT_WIDTH
};
84 # define EMACS_INT_MAX INT_MAX
86 # elif INTPTR_MAX <= LONG_MAX && !defined WIDE_EMACS_INT
87 typedef long int EMACS_INT
;
88 typedef unsigned long EMACS_UINT
;
89 enum { EMACS_INT_WIDTH
= LONG_WIDTH
};
90 # define EMACS_INT_MAX LONG_MAX
92 # elif INTPTR_MAX <= LLONG_MAX
93 typedef long long int EMACS_INT
;
94 typedef unsigned long long int EMACS_UINT
;
95 enum { EMACS_INT_WIDTH
= LLONG_WIDTH
};
96 # define EMACS_INT_MAX LLONG_MAX
103 # error "INTPTR_MAX too large"
107 /* Number of bits to put in each character in the internal representation
108 of bool vectors. This should not vary across implementations. */
109 enum { BOOL_VECTOR_BITS_PER_CHAR
=
110 #define BOOL_VECTOR_BITS_PER_CHAR 8
111 BOOL_VECTOR_BITS_PER_CHAR
114 /* An unsigned integer type representing a fixed-length bit sequence,
115 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
116 for speed, but on weird platforms it is unsigned char and not all
117 its bits are used. */
118 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
119 typedef size_t bits_word
;
120 # define BITS_WORD_MAX SIZE_MAX
121 enum { BITS_PER_BITS_WORD
= SIZE_WIDTH
};
123 typedef unsigned char bits_word
;
124 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
125 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
127 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
129 /* printmax_t and uprintmax_t are types for printing large integers.
130 These are the widest integers that are supported for printing.
131 pMd etc. are conversions for printing them.
132 On C99 hosts, there's no problem, as even the widest integers work.
133 Fall back on EMACS_INT on pre-C99 hosts. */
135 typedef intmax_t printmax_t
;
136 typedef uintmax_t uprintmax_t
;
140 typedef EMACS_INT printmax_t
;
141 typedef EMACS_UINT uprintmax_t
;
146 /* Use pD to format ptrdiff_t values, which suffice for indexes into
147 buffers and strings. Emacs never allocates objects larger than
148 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
149 In C99, pD can always be "t"; configure it here for the sake of
150 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
151 #if PTRDIFF_MAX == INT_MAX
153 #elif PTRDIFF_MAX == LONG_MAX
155 #elif PTRDIFF_MAX == LLONG_MAX
161 /* Extra internal type checking? */
163 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
164 'assume (COND)'. COND should be free of side effects, as it may or
165 may not be evaluated.
167 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
168 defined and suppress_checking is false, and does nothing otherwise.
169 Emacs dies if COND is checked and is false. The suppress_checking
170 variable is initialized to 0 in alloc.c. Set it to 1 using a
171 debugger to temporarily disable aborting on detected internal
172 inconsistencies or error conditions.
174 In some cases, a good compiler may be able to optimize away the
175 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
176 uses eassert to test STRINGP (x), but a particular use of XSTRING
177 is invoked only after testing that STRINGP (x) is true, making the
180 eassume is like eassert except that it also causes the compiler to
181 assume that COND is true afterwards, regardless of whether runtime
182 checking is enabled. This can improve performance in some cases,
183 though it can degrade performance in others. It's often suboptimal
184 for COND to call external functions or access volatile storage. */
186 #ifndef ENABLE_CHECKING
187 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
188 # define eassume(cond) assume (cond)
189 #else /* ENABLE_CHECKING */
191 extern _Noreturn
void die (const char *, const char *, int);
193 extern bool suppress_checking EXTERNALLY_VISIBLE
;
195 # define eassert(cond) \
196 (suppress_checking || (cond) \
198 : die (# cond, __FILE__, __LINE__))
199 # define eassume(cond) \
204 : die (# cond, __FILE__, __LINE__))
205 #endif /* ENABLE_CHECKING */
208 /* Use the configure flag --enable-check-lisp-object-type to make
209 Lisp_Object use a struct type instead of the default int. The flag
210 causes CHECK_LISP_OBJECT_TYPE to be defined. */
212 /***** Select the tagging scheme. *****/
213 /* The following option controls the tagging scheme:
214 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
215 always 0, and we can thus use them to hold tag bits, without
216 restricting our addressing space.
218 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
219 restricting our possible address range.
221 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
222 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
223 on the few static Lisp_Objects used: lispsym, all the defsubr, and
224 the two special buffers buffer_defaults and buffer_local_symbols. */
228 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
229 integer constant, for MSVC. */
230 #define GCALIGNMENT 8
232 /* Number of bits in a Lisp_Object value, not counting the tag. */
233 VALBITS
= EMACS_INT_WIDTH
- GCTYPEBITS
,
235 /* Number of bits in a Lisp fixnum tag. */
236 INTTYPEBITS
= GCTYPEBITS
- 1,
238 /* Number of bits in a Lisp fixnum value, not counting the tag. */
239 FIXNUM_BITS
= VALBITS
+ 1
242 #if GCALIGNMENT != 1 << GCTYPEBITS
243 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
246 /* The maximum value that can be stored in a EMACS_INT, assuming all
247 bits other than the type bits contribute to a nonnegative signed value.
248 This can be used in #if, e.g., '#if USE_LSB_TAG' below expands to an
249 expression involving VAL_MAX. */
250 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
252 /* Whether the least-significant bits of an EMACS_INT contain the tag.
253 On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
254 a. unnecessary, because the top bits of an EMACS_INT are unused, and
255 b. slower, because it typically requires extra masking.
256 So, USE_LSB_TAG is true only on hosts where it might be useful. */
257 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
258 #define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
259 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
261 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
262 # error "USE_LSB_TAG not supported on this platform; please report this." \
263 "Try 'configure --with-wide-int' to work around the problem."
267 #ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
268 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
270 # define GCALIGNED /* empty */
273 /* Some operations are so commonly executed that they are implemented
274 as macros, not functions, because otherwise runtime performance would
275 suffer too much when compiling with GCC without optimization.
276 There's no need to inline everything, just the operations that
277 would otherwise cause a serious performance problem.
279 For each such operation OP, define a macro lisp_h_OP that contains
280 the operation's implementation. That way, OP can be implemented
281 via a macro definition like this:
283 #define OP(x) lisp_h_OP (x)
285 and/or via a function definition like this:
287 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
289 without worrying about the implementations diverging, since
290 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
291 are intended to be private to this include file, and should not be
294 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
295 functions, once most developers have access to GCC 4.8 or later and
296 can use "gcc -Og" to debug. Maybe in the year 2016. See
299 Commentary for these macros can be found near their corresponding
302 #if CHECK_LISP_OBJECT_TYPE
303 # define lisp_h_XLI(o) ((o).i)
304 # define lisp_h_XIL(i) ((Lisp_Object) { i })
306 # define lisp_h_XLI(o) (o)
307 # define lisp_h_XIL(i) (i)
309 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
310 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
311 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
312 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
313 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
314 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
315 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
316 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
317 #define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
318 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
319 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
320 #define lisp_h_NILP(x) EQ (x, Qnil)
321 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
322 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
323 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
324 #define lisp_h_SYMBOL_VAL(sym) \
325 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
326 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
327 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
328 #define lisp_h_XCAR(c) XCONS (c)->car
329 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
330 #define lisp_h_XCONS(a) \
331 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
332 #define lisp_h_XHASH(a) XUINT (a)
333 #ifndef GC_CHECK_CONS_LIST
334 # define lisp_h_check_cons_list() ((void) 0)
337 # define lisp_h_make_number(n) \
338 XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
339 # define lisp_h_XFASTINT(a) XINT (a)
340 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
341 # define lisp_h_XSYMBOL(a) \
342 (eassert (SYMBOLP (a)), \
343 (struct Lisp_Symbol *) ((intptr_t) XLI (a) - Lisp_Symbol \
345 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
346 # define lisp_h_XUNTAG(a, type) \
347 __builtin_assume_aligned ((void *) (intptr_t) (XLI (a) - (type)), \
351 /* When compiling via gcc -O0, define the key operations as macros, as
352 Emacs is too slow otherwise. To disable this optimization, compile
353 with -DINLINING=false. */
354 #if (defined __NO_INLINE__ \
355 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
356 && ! (defined INLINING && ! INLINING))
357 # define DEFINE_KEY_OPS_AS_MACROS true
359 # define DEFINE_KEY_OPS_AS_MACROS false
362 #if DEFINE_KEY_OPS_AS_MACROS
363 # define XLI(o) lisp_h_XLI (o)
364 # define XIL(i) lisp_h_XIL (i)
365 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
366 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
367 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
368 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
369 # define CONSP(x) lisp_h_CONSP (x)
370 # define EQ(x, y) lisp_h_EQ (x, y)
371 # define FLOATP(x) lisp_h_FLOATP (x)
372 # define INTEGERP(x) lisp_h_INTEGERP (x)
373 # define MARKERP(x) lisp_h_MARKERP (x)
374 # define MISCP(x) lisp_h_MISCP (x)
375 # define NILP(x) lisp_h_NILP (x)
376 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
377 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
378 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
379 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
380 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
381 # define XCAR(c) lisp_h_XCAR (c)
382 # define XCDR(c) lisp_h_XCDR (c)
383 # define XCONS(a) lisp_h_XCONS (a)
384 # define XHASH(a) lisp_h_XHASH (a)
385 # ifndef GC_CHECK_CONS_LIST
386 # define check_cons_list() lisp_h_check_cons_list ()
389 # define make_number(n) lisp_h_make_number (n)
390 # define XFASTINT(a) lisp_h_XFASTINT (a)
391 # define XINT(a) lisp_h_XINT (a)
392 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
393 # define XTYPE(a) lisp_h_XTYPE (a)
394 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
399 /* Define the fundamental Lisp data structures. */
401 /* This is the set of Lisp data types. If you want to define a new
402 data type, read the comments after Lisp_Fwd_Type definition
405 /* Lisp integers use 2 tags, to give them one extra bit, thus
406 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
407 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
408 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
410 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
411 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
412 vociferously about them. */
413 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
414 || (defined __SUNPRO_C && __STDC__))
415 #define ENUM_BF(TYPE) unsigned int
417 #define ENUM_BF(TYPE) enum TYPE
423 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
426 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
427 whose first member indicates the subtype. */
430 /* Integer. XINT (obj) is the integer value. */
432 Lisp_Int1
= USE_LSB_TAG
? 6 : 3,
434 /* String. XSTRING (object) points to a struct Lisp_String.
435 The length of the string, and its contents, are stored therein. */
438 /* Vector of Lisp objects, or something resembling it.
439 XVECTOR (object) points to a struct Lisp_Vector, which contains
440 the size and contents. The size field also contains the type
441 information, if it's not a real vector object. */
444 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
445 Lisp_Cons
= USE_LSB_TAG
? 3 : 6,
450 /* This is the set of data types that share a common structure.
451 The first member of the structure is a type code from this set.
452 The enum values are arbitrary, but we'll use large numbers to make it
453 more likely that we'll spot the error if a random word in memory is
454 mistakenly interpreted as a Lisp_Misc. */
457 Lisp_Misc_Free
= 0x5eab,
460 Lisp_Misc_Save_Value
,
465 /* Currently floats are not a misc type,
466 but let's define this in case we want to change that. */
468 /* This is not a type code. It is for range checking. */
472 /* These are the types of forwarding objects used in the value slot
473 of symbols for special built-in variables whose value is stored in
477 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
478 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
479 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
480 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
481 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
484 /* If you want to define a new Lisp data type, here are some
485 instructions. See the thread at
486 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
489 First, there are already a couple of Lisp types that can be used if
490 your new type does not need to be exposed to Lisp programs nor
491 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
492 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
493 is suitable for temporarily stashing away pointers and integers in
494 a Lisp object. The latter is useful for vector-like Lisp objects
495 that need to be used as part of other objects, but which are never
496 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
499 These two types don't look pretty when printed, so they are
500 unsuitable for Lisp objects that can be exposed to users.
502 To define a new data type, add one more Lisp_Misc subtype or one
503 more pseudovector subtype. Pseudovectors are more suitable for
504 objects with several slots that need to support fast random access,
505 while Lisp_Misc types are for everything else. A pseudovector object
506 provides one or more slots for Lisp objects, followed by struct
507 members that are accessible only from C. A Lisp_Misc object is a
508 wrapper for a C struct that can contain anything you like.
510 Explicit freeing is discouraged for Lisp objects in general. But if
511 you really need to exploit this, use Lisp_Misc (check free_misc in
512 alloc.c to see why). There is no way to free a vectorlike object.
514 To add a new pseudovector type, extend the pvec_type enumeration;
515 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
517 For a Lisp_Misc, you will also need to add your entry to union
518 Lisp_Misc (but make sure the first word has the same structure as
519 the others, starting with a 16-bit member of the Lisp_Misc_Type
520 enumeration and a 1-bit GC markbit) and make sure the overall size
521 of the union is not increased by your addition.
523 For a new pseudovector, it's highly desirable to limit the size
524 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
525 Otherwise you will need to change sweep_vectors (also in alloc.c).
527 Then you will need to add switch branches in print.c (in
528 print_object, to print your object, and possibly also in
529 print_preprocess) and to alloc.c, to mark your object (in
530 mark_object) and to free it (in gc_sweep). The latter is also the
531 right place to call any code specific to your data type that needs
532 to run when the object is recycled -- e.g., free any additional
533 resources allocated for it that are not Lisp objects. You can even
534 make a pointer to the function that frees the resources a slot in
535 your object -- this way, the same object could be used to represent
536 several disparate C structures. */
538 #ifdef CHECK_LISP_OBJECT_TYPE
540 typedef struct { EMACS_INT i
; } Lisp_Object
;
542 #define LISP_INITIALLY(i) {i}
544 #undef CHECK_LISP_OBJECT_TYPE
545 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
546 #else /* CHECK_LISP_OBJECT_TYPE */
548 /* If a struct type is not wanted, define Lisp_Object as just a number. */
550 typedef EMACS_INT Lisp_Object
;
551 #define LISP_INITIALLY(i) (i)
552 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
553 #endif /* CHECK_LISP_OBJECT_TYPE */
555 #define LISP_INITIALLY_ZERO LISP_INITIALLY (0)
557 /* Forward declarations. */
559 /* Defined in this file. */
561 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
562 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
563 INLINE
bool BUFFERP (Lisp_Object
);
564 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
565 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
566 INLINE
bool (CONSP
) (Lisp_Object
);
567 INLINE
bool (FLOATP
) (Lisp_Object
);
568 INLINE
bool functionp (Lisp_Object
);
569 INLINE
bool (INTEGERP
) (Lisp_Object
);
570 INLINE
bool (MARKERP
) (Lisp_Object
);
571 INLINE
bool (MISCP
) (Lisp_Object
);
572 INLINE
bool (NILP
) (Lisp_Object
);
573 INLINE
bool OVERLAYP (Lisp_Object
);
574 INLINE
bool PROCESSP (Lisp_Object
);
575 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
576 INLINE
bool SAVE_VALUEP (Lisp_Object
);
577 INLINE
bool FINALIZERP (Lisp_Object
);
580 INLINE
bool USER_PTRP (Lisp_Object
);
581 INLINE
struct Lisp_User_Ptr
*(XUSER_PTR
) (Lisp_Object
);
584 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
586 INLINE
bool STRINGP (Lisp_Object
);
587 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
588 INLINE
bool SUBRP (Lisp_Object
);
589 INLINE
bool (SYMBOLP
) (Lisp_Object
);
590 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
591 INLINE
bool WINDOWP (Lisp_Object
);
592 INLINE
bool TERMINALP (Lisp_Object
);
593 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
594 INLINE
struct Lisp_Finalizer
*XFINALIZER (Lisp_Object
);
595 INLINE
struct Lisp_Symbol
*(XSYMBOL
) (Lisp_Object
);
596 INLINE
void *(XUNTAG
) (Lisp_Object
, int);
598 /* Defined in chartab.c. */
599 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
600 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
602 /* Defined in data.c. */
603 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
604 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
606 /* Defined in emacs.c. */
607 #ifdef DOUG_LEA_MALLOC
608 extern bool might_dump
;
610 /* True means Emacs has already been initialized.
611 Used during startup to detect startup of dumped Emacs. */
612 extern bool initialized
;
614 /* Defined in floatfns.c. */
615 extern double extract_float (Lisp_Object
);
618 /* Interned state of a symbol. */
622 SYMBOL_UNINTERNED
= 0,
624 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
631 SYMBOL_LOCALIZED
= 2,
637 bool_bf gcmarkbit
: 1;
639 /* Indicates where the value can be found:
640 0 : it's a plain var, the value is in the `value' field.
641 1 : it's a varalias, the value is really in the `alias' symbol.
642 2 : it's a localized var, the value is in the `blv' object.
643 3 : it's a forwarding variable, the value is in `forward'. */
644 ENUM_BF (symbol_redirect
) redirect
: 3;
646 /* Non-zero means symbol is constant, i.e. changing its value
647 should signal an error. If the value is 3, then the var
648 can be changed, but only by `defconst'. */
649 unsigned constant
: 2;
651 /* Interned state of the symbol. This is an enumerator from
652 enum symbol_interned. */
653 unsigned interned
: 2;
655 /* True means that this variable has been explicitly declared
656 special (with `defvar' etc), and shouldn't be lexically bound. */
657 bool_bf declared_special
: 1;
659 /* True if pointed to from purespace and hence can't be GC'd. */
662 /* The symbol's name, as a Lisp string. */
665 /* Value of the symbol or Qunbound if unbound. Which alternative of the
666 union is used depends on the `redirect' field above. */
669 struct Lisp_Symbol
*alias
;
670 struct Lisp_Buffer_Local_Value
*blv
;
674 /* Function value of the symbol or Qnil if not fboundp. */
675 Lisp_Object function
;
677 /* The symbol's property list. */
680 /* Next symbol in obarray bucket, if the symbol is interned. */
681 struct Lisp_Symbol
*next
;
684 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
685 meaning as in the DEFUN macro, and is used to construct a prototype. */
686 /* We can use the same trick as in the DEFUN macro to generate the
687 appropriate prototype. */
688 #define EXFUN(fnname, maxargs) \
689 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
691 /* Note that the weird token-substitution semantics of ANSI C makes
692 this work for MANY and UNEVALLED. */
693 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
694 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
695 #define DEFUN_ARGS_0 (void)
696 #define DEFUN_ARGS_1 (Lisp_Object)
697 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
698 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
699 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
700 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
702 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
703 Lisp_Object, Lisp_Object)
704 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
705 Lisp_Object, Lisp_Object, Lisp_Object)
706 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
707 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
709 /* Yield a signed integer that contains TAG along with PTR.
711 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
712 and zero-extend otherwise (that’s a bit faster here).
713 Sign extension matters only when EMACS_INT is wider than a pointer. */
714 #define TAG_PTR(tag, ptr) \
716 ? (intptr_t) (ptr) + (tag) \
717 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
719 /* Yield an integer that contains a symbol tag along with OFFSET.
720 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
721 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
723 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
724 XLI (builtin_lisp_symbol (Qwhatever)),
725 except the former expands to an integer constant expression. */
726 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
728 /* LISPSYM_INITIALLY (Qfoo) is equivalent to Qfoo except it is
729 designed for use as an initializer, even for a constant initializer. */
730 #define LISPSYM_INITIALLY(name) LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name))
732 /* Declare extern constants for Lisp symbols. These can be helpful
733 when using a debugger like GDB, on older platforms where the debug
734 format does not represent C macros. */
735 #define DEFINE_LISP_SYMBOL(name) \
736 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
737 DEFINE_GDB_SYMBOL_END (LISPSYM_INITIALLY (name))
739 /* By default, define macros for Qt, etc., as this leads to a bit
740 better performance in the core Emacs interpreter. A plugin can
741 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
742 other Emacs instances that assign different values to Qt, etc. */
743 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
744 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
749 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
750 At the machine level, these operations are no-ops. */
753 (XLI
) (Lisp_Object o
)
755 return lisp_h_XLI (o
);
761 return lisp_h_XIL (i
);
764 /* In the size word of a vector, this bit means the vector has been marked. */
766 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
767 # define ARRAY_MARK_FLAG PTRDIFF_MIN
768 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
770 /* In the size word of a struct Lisp_Vector, this bit means it's really
771 some other vector-like object. */
772 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
773 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
774 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
776 /* In a pseudovector, the size field actually contains a word with one
777 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
778 with PVEC_TYPE_MASK to indicate the actual type. */
790 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 (XSTRING (STR)->size == 0) \
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 (XSTRING (STR)->size == 0) \
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 /* A boolvector is a kind of vectorlike, with contents like a string. */
1432 struct Lisp_Bool_Vector
1434 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1435 just the subtype information. */
1436 struct vectorlike_header header
;
1437 /* This is the size in bits. */
1439 /* The actual bits, packed into bytes.
1440 Zeros fill out the last word if needed.
1441 The bits are in little-endian order in the bytes, and
1442 the bytes are in little-endian order in the words. */
1443 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1447 bool_vector_size (Lisp_Object a
)
1449 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1450 eassume (0 <= size
);
1455 bool_vector_data (Lisp_Object a
)
1457 return XBOOL_VECTOR (a
)->data
;
1460 INLINE
unsigned char *
1461 bool_vector_uchar_data (Lisp_Object a
)
1463 return (unsigned char *) bool_vector_data (a
);
1466 /* The number of data words and bytes in a bool vector with SIZE bits. */
1469 bool_vector_words (EMACS_INT size
)
1471 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1472 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1476 bool_vector_bytes (EMACS_INT size
)
1478 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1479 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1482 /* True if A's Ith bit is set. */
1485 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1487 eassume (0 <= i
&& i
< bool_vector_size (a
));
1488 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1489 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1493 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1495 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1498 /* Set A's Ith bit to B. */
1501 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1503 unsigned char *addr
;
1505 eassume (0 <= i
&& i
< bool_vector_size (a
));
1506 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1509 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1511 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1514 /* Some handy constants for calculating sizes
1515 and offsets, mostly of vectorlike objects. */
1519 header_size
= offsetof (struct Lisp_Vector
, contents
),
1520 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1521 word_size
= sizeof (Lisp_Object
)
1524 /* Conveniences for dealing with Lisp arrays. */
1527 AREF (Lisp_Object array
, ptrdiff_t idx
)
1529 return XVECTOR (array
)->contents
[idx
];
1532 INLINE Lisp_Object
*
1533 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1535 return & XVECTOR (array
)->contents
[idx
];
1539 ASIZE (Lisp_Object array
)
1541 ptrdiff_t size
= XVECTOR (array
)->header
.size
;
1542 eassume (0 <= size
);
1547 gc_asize (Lisp_Object array
)
1549 /* Like ASIZE, but also can be used in the garbage collector. */
1550 return XVECTOR (array
)->header
.size
& ~ARRAY_MARK_FLAG
;
1554 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1556 eassert (0 <= idx
&& idx
< ASIZE (array
));
1557 XVECTOR (array
)->contents
[idx
] = val
;
1561 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1563 /* Like ASET, but also can be used in the garbage collector:
1564 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1565 eassert (0 <= idx
&& idx
< gc_asize (array
));
1566 XVECTOR (array
)->contents
[idx
] = val
;
1569 /* True, since Qnil's representation is zero. Every place in the code
1570 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1571 to find such assumptions later if we change Qnil to be nonzero. */
1572 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1574 /* Clear the object addressed by P, with size NBYTES, so that all its
1575 bytes are zero and all its Lisp values are nil. */
1577 memclear (void *p
, ptrdiff_t nbytes
)
1579 eassert (0 <= nbytes
);
1580 verify (NIL_IS_ZERO
);
1581 /* Since Qnil is zero, memset suffices. */
1582 memset (p
, 0, nbytes
);
1585 /* If a struct is made to look like a vector, this macro returns the length
1586 of the shortest vector that would hold that struct. */
1588 #define VECSIZE(type) \
1589 ((sizeof (type) - header_size + word_size - 1) / word_size)
1591 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1592 at the end and we need to compute the number of Lisp_Object fields (the
1593 ones that the GC needs to trace). */
1595 #define PSEUDOVECSIZE(type, nonlispfield) \
1596 ((offsetof (type, nonlispfield) - header_size) / word_size)
1598 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1599 should be integer expressions. This is not the same as
1600 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1601 returns true. For efficiency, prefer plain unsigned comparison if A
1602 and B's sizes both fit (after integer promotion). */
1603 #define UNSIGNED_CMP(a, op, b) \
1604 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1605 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1606 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1608 /* True iff C is an ASCII character. */
1609 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1611 /* A char-table is a kind of vectorlike, with contents are like a
1612 vector but with a few other slots. For some purposes, it makes
1613 sense to handle a char-table with type struct Lisp_Vector. An
1614 element of a char table can be any Lisp objects, but if it is a sub
1615 char-table, we treat it a table that contains information of a
1616 specific range of characters. A sub char-table is like a vector but
1617 with two integer fields between the header and Lisp data, which means
1618 that it has to be marked with some precautions (see mark_char_table
1619 in alloc.c). A sub char-table appears only in an element of a char-table,
1620 and there's no way to access it directly from Emacs Lisp program. */
1622 enum CHARTAB_SIZE_BITS
1624 CHARTAB_SIZE_BITS_0
= 6,
1625 CHARTAB_SIZE_BITS_1
= 4,
1626 CHARTAB_SIZE_BITS_2
= 5,
1627 CHARTAB_SIZE_BITS_3
= 7
1630 extern const int chartab_size
[4];
1632 struct Lisp_Char_Table
1634 /* HEADER.SIZE is the vector's size field, which also holds the
1635 pseudovector type information. It holds the size, too.
1636 The size counts the defalt, parent, purpose, ascii,
1637 contents, and extras slots. */
1638 struct vectorlike_header header
;
1640 /* This holds a default value,
1641 which is used whenever the value for a specific character is nil. */
1644 /* This points to another char table, which we inherit from when the
1645 value for a specific character is nil. The `defalt' slot takes
1646 precedence over this. */
1649 /* This is a symbol which says what kind of use this char-table is
1651 Lisp_Object purpose
;
1653 /* The bottom sub char-table for characters of the range 0..127. It
1654 is nil if none of ASCII character has a specific value. */
1657 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1659 /* These hold additional data. It is a vector. */
1660 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1663 struct Lisp_Sub_Char_Table
1665 /* HEADER.SIZE is the vector's size field, which also holds the
1666 pseudovector type information. It holds the size, too. */
1667 struct vectorlike_header header
;
1669 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1670 char-table of depth 1 contains 16 elements, and each element
1671 covers 4096 (128*32) characters. A sub char-table of depth 2
1672 contains 32 elements, and each element covers 128 characters. A
1673 sub char-table of depth 3 contains 128 elements, and each element
1674 is for one character. */
1677 /* Minimum character covered by the sub char-table. */
1680 /* Use set_sub_char_table_contents to set this. */
1681 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1685 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1687 struct Lisp_Char_Table
*tbl
= NULL
;
1691 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1692 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1693 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1697 while (NILP (val
) && ! NILP (tbl
->parent
));
1702 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1703 characters. Do not check validity of CT. */
1705 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1707 return (ASCII_CHAR_P (idx
)
1708 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1709 : char_table_ref (ct
, idx
));
1712 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1713 8-bit European characters. Do not check validity of CT. */
1715 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1717 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1718 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1720 char_table_set (ct
, idx
, val
);
1723 /* This structure describes a built-in function.
1724 It is generated by the DEFUN macro only.
1725 defsubr makes it into a Lisp object. */
1729 struct vectorlike_header header
;
1731 Lisp_Object (*a0
) (void);
1732 Lisp_Object (*a1
) (Lisp_Object
);
1733 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1734 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1735 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1736 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1737 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1738 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1739 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1740 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1741 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1743 short min_args
, max_args
;
1744 const char *symbol_name
;
1745 const char *intspec
;
1749 enum char_table_specials
1751 /* This is the number of slots that every char table must have. This
1752 counts the ordinary slots and the top, defalt, parent, and purpose
1754 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1756 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1757 when the latter is treated as an ordinary Lisp_Vector. */
1758 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1761 /* Return the number of "extra" slots in the char table CT. */
1764 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1766 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1767 - CHAR_TABLE_STANDARD_SLOTS
);
1770 /* Make sure that sub char-table contents slot is where we think it is. */
1771 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1772 == (offsetof (struct Lisp_Vector
, contents
)
1773 + SUB_CHAR_TABLE_OFFSET
* sizeof (Lisp_Object
)));
1775 /***********************************************************************
1777 ***********************************************************************/
1779 /* Value is name of symbol. */
1782 (SYMBOL_VAL
) (struct Lisp_Symbol
*sym
)
1784 return lisp_h_SYMBOL_VAL (sym
);
1787 INLINE
struct Lisp_Symbol
*
1788 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1790 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1791 return sym
->val
.alias
;
1793 INLINE
struct Lisp_Buffer_Local_Value
*
1794 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1796 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1797 return sym
->val
.blv
;
1799 INLINE
union Lisp_Fwd
*
1800 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1802 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1803 return sym
->val
.fwd
;
1807 (SET_SYMBOL_VAL
) (struct Lisp_Symbol
*sym
, Lisp_Object v
)
1809 lisp_h_SET_SYMBOL_VAL (sym
, v
);
1813 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1815 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1819 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1821 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1825 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1827 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1832 SYMBOL_NAME (Lisp_Object sym
)
1834 return XSYMBOL (sym
)->name
;
1837 /* Value is true if SYM is an interned symbol. */
1840 SYMBOL_INTERNED_P (Lisp_Object sym
)
1842 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1845 /* Value is true if SYM is interned in initial_obarray. */
1848 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1850 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1853 /* Value is non-zero if symbol is considered a constant, i.e. its
1854 value cannot be changed (there is an exception for keyword symbols,
1855 whose value can be set to the keyword symbol itself). */
1858 (SYMBOL_CONSTANT_P
) (Lisp_Object sym
)
1860 return lisp_h_SYMBOL_CONSTANT_P (sym
);
1863 /* Placeholder for make-docfile to process. The actual symbol
1864 definition is done by lread.c's defsym. */
1865 #define DEFSYM(sym, name) /* empty */
1868 /***********************************************************************
1870 ***********************************************************************/
1872 /* The structure of a Lisp hash table. */
1874 struct hash_table_test
1876 /* Name of the function used to compare keys. */
1879 /* User-supplied hash function, or nil. */
1880 Lisp_Object user_hash_function
;
1882 /* User-supplied key comparison function, or nil. */
1883 Lisp_Object user_cmp_function
;
1885 /* C function to compare two keys. */
1886 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1888 /* C function to compute hash code. */
1889 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1892 struct Lisp_Hash_Table
1894 /* This is for Lisp; the hash table code does not refer to it. */
1895 struct vectorlike_header header
;
1897 /* Nil if table is non-weak. Otherwise a symbol describing the
1898 weakness of the table. */
1901 /* When the table is resized, and this is an integer, compute the
1902 new size by adding this to the old size. If a float, compute the
1903 new size by multiplying the old size with this factor. */
1904 Lisp_Object rehash_size
;
1906 /* Resize hash table when number of entries/ table size is >= this
1908 Lisp_Object rehash_threshold
;
1910 /* Vector of hash codes. If hash[I] is nil, this means that the
1911 I-th entry is unused. */
1914 /* Vector used to chain entries. If entry I is free, next[I] is the
1915 entry number of the next free item. If entry I is non-free,
1916 next[I] is the index of the next entry in the collision chain. */
1919 /* Index of first free entry in free list. */
1920 Lisp_Object next_free
;
1922 /* Bucket vector. A non-nil entry is the index of the first item in
1923 a collision chain. This vector's size can be larger than the
1924 hash table size to reduce collisions. */
1927 /* Only the fields above are traced normally by the GC. The ones below
1928 `count' are special and are either ignored by the GC or traced in
1929 a special way (e.g. because of weakness). */
1931 /* Number of key/value entries in the table. */
1934 /* Vector of keys and values. The key of item I is found at index
1935 2 * I, the value is found at index 2 * I + 1.
1936 This is gc_marked specially if the table is weak. */
1937 Lisp_Object key_and_value
;
1939 /* The comparison and hash functions. */
1940 struct hash_table_test test
;
1942 /* Next weak hash table if this is a weak hash table. The head
1943 of the list is in weak_hash_tables. */
1944 struct Lisp_Hash_Table
*next_weak
;
1949 HASH_TABLE_P (Lisp_Object a
)
1951 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1954 INLINE
struct Lisp_Hash_Table
*
1955 XHASH_TABLE (Lisp_Object a
)
1957 eassert (HASH_TABLE_P (a
));
1958 return XUNTAG (a
, Lisp_Vectorlike
);
1961 #define XSET_HASH_TABLE(VAR, PTR) \
1962 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1964 /* Value is the key part of entry IDX in hash table H. */
1966 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1968 return AREF (h
->key_and_value
, 2 * idx
);
1971 /* Value is the value part of entry IDX in hash table H. */
1973 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1975 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1978 /* Value is the index of the next entry following the one at IDX
1981 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1983 return AREF (h
->next
, idx
);
1986 /* Value is the hash code computed for entry IDX in hash table H. */
1988 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1990 return AREF (h
->hash
, idx
);
1993 /* Value is the index of the element in hash table H that is the
1994 start of the collision list at index IDX in the index vector of H. */
1996 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1998 return AREF (h
->index
, idx
);
2001 /* Value is the size of hash table H. */
2003 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
2005 return ASIZE (h
->next
);
2008 /* Default size for hash tables if not specified. */
2010 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
2012 /* Default threshold specifying when to resize a hash table. The
2013 value gives the ratio of current entries in the hash table and the
2014 size of the hash table. */
2016 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
2018 /* Default factor by which to increase the size of a hash table. */
2020 static double const DEFAULT_REHASH_SIZE
= 1.5;
2022 /* Combine two integers X and Y for hashing. The result might not fit
2023 into a Lisp integer. */
2026 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
2028 return (x
<< 4) + (x
>> (EMACS_INT_WIDTH
- 4)) + y
;
2031 /* Hash X, returning a value that fits into a fixnum. */
2034 SXHASH_REDUCE (EMACS_UINT x
)
2036 return (x
^ x
>> (EMACS_INT_WIDTH
- FIXNUM_BITS
)) & INTMASK
;
2039 /* These structures are used for various misc types. */
2041 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
2043 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
2044 bool_bf gcmarkbit
: 1;
2045 unsigned spacer
: 15;
2050 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
2051 bool_bf gcmarkbit
: 1;
2052 unsigned spacer
: 13;
2053 /* This flag is temporarily used in the functions
2054 decode/encode_coding_object to record that the marker position
2055 must be adjusted after the conversion. */
2056 bool_bf need_adjustment
: 1;
2057 /* True means normal insertion at the marker's position
2058 leaves the marker after the inserted text. */
2059 bool_bf insertion_type
: 1;
2060 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2061 Note: a chain of markers can contain markers pointing into different
2062 buffers (the chain is per buffer_text rather than per buffer, so it's
2063 shared between indirect buffers). */
2064 /* This is used for (other than NULL-checking):
2066 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2067 - unchain_marker: to find the list from which to unchain.
2068 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2070 struct buffer
*buffer
;
2072 /* The remaining fields are meaningless in a marker that
2073 does not point anywhere. */
2075 /* For markers that point somewhere,
2076 this is used to chain of all the markers in a given buffer. */
2077 /* We could remove it and use an array in buffer_text instead.
2078 That would also allow us to preserve it ordered. */
2079 struct Lisp_Marker
*next
;
2080 /* This is the char position where the marker points. */
2082 /* This is the byte position.
2083 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2084 used to implement the functionality of markers, but rather to (ab)use
2085 markers as a cache for char<->byte mappings). */
2089 /* START and END are markers in the overlay's buffer, and
2090 PLIST is the overlay's property list. */
2092 /* An overlay's real data content is:
2094 - buffer (really there are two buffer pointers, one per marker,
2095 and both points to the same buffer)
2096 - insertion type of both ends (per-marker fields)
2097 - start & start byte (of start marker)
2098 - end & end byte (of end marker)
2099 - next (singly linked list of overlays)
2100 - next fields of start and end markers (singly linked list of markers).
2101 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2104 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2105 bool_bf gcmarkbit
: 1;
2106 unsigned spacer
: 15;
2107 struct Lisp_Overlay
*next
;
2113 /* Types of data which may be saved in a Lisp_Save_Value. */
2124 /* Number of bits needed to store one of the above values. */
2125 enum { SAVE_SLOT_BITS
= 3 };
2127 /* Number of slots in a save value where save_type is nonzero. */
2128 enum { SAVE_VALUE_SLOTS
= 4 };
2130 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2132 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2136 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2137 SAVE_TYPE_INT_INT_INT
2138 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2139 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2140 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2141 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2142 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2143 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2144 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2145 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2146 SAVE_TYPE_FUNCPTR_PTR_OBJ
2147 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2149 /* This has an extra bit indicating it's raw memory. */
2150 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2153 /* Special object used to hold a different values for later use.
2155 This is mostly used to package C integers and pointers to call
2156 record_unwind_protect when two or more values need to be saved.
2160 struct my_data *md = get_my_data ();
2161 ptrdiff_t mi = get_my_integer ();
2162 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2165 Lisp_Object my_unwind (Lisp_Object arg)
2167 struct my_data *md = XSAVE_POINTER (arg, 0);
2168 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2172 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2173 saved objects and raise eassert if type of the saved object doesn't match
2174 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2175 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2176 slot 0 is a pointer. */
2178 typedef void (*voidfuncptr
) (void);
2180 struct Lisp_Save_Value
2182 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2183 bool_bf gcmarkbit
: 1;
2184 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2186 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2187 V's data entries are determined by V->save_type. E.g., if
2188 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2189 V->data[1] is an integer, and V's other data entries are unused.
2191 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2192 a memory area containing V->data[1].integer potential Lisp_Objects. */
2193 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2196 voidfuncptr funcpointer
;
2199 } data
[SAVE_VALUE_SLOTS
];
2202 /* Return the type of V's Nth saved value. */
2204 save_type (struct Lisp_Save_Value
*v
, int n
)
2206 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2207 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2210 /* Get and set the Nth saved pointer. */
2213 XSAVE_POINTER (Lisp_Object obj
, int n
)
2215 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2216 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2219 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2221 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2222 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2225 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2227 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2228 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2231 /* Likewise for the saved integer. */
2234 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2236 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2237 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2240 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2242 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2243 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2246 /* Extract Nth saved object. */
2249 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2251 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2252 return XSAVE_VALUE (obj
)->data
[n
].object
;
2256 struct Lisp_User_Ptr
2258 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_User_Ptr */
2259 bool_bf gcmarkbit
: 1;
2260 unsigned spacer
: 15;
2262 void (*finalizer
) (void *);
2267 /* A finalizer sentinel. */
2268 struct Lisp_Finalizer
2270 struct Lisp_Misc_Any base
;
2272 /* Circular list of all active weak references. */
2273 struct Lisp_Finalizer
*prev
;
2274 struct Lisp_Finalizer
*next
;
2276 /* Call FUNCTION when the finalizer becomes unreachable, even if
2277 FUNCTION contains a reference to the finalizer; i.e., call
2278 FUNCTION when it is reachable _only_ through finalizers. */
2279 Lisp_Object function
;
2282 /* A miscellaneous object, when it's on the free list. */
2285 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2286 bool_bf gcmarkbit
: 1;
2287 unsigned spacer
: 15;
2288 union Lisp_Misc
*chain
;
2291 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2292 It uses one of these struct subtypes to get the type field. */
2296 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2297 struct Lisp_Free u_free
;
2298 struct Lisp_Marker u_marker
;
2299 struct Lisp_Overlay u_overlay
;
2300 struct Lisp_Save_Value u_save_value
;
2301 struct Lisp_Finalizer u_finalizer
;
2303 struct Lisp_User_Ptr u_user_ptr
;
2307 INLINE
union Lisp_Misc
*
2308 XMISC (Lisp_Object a
)
2310 return XUNTAG (a
, Lisp_Misc
);
2313 INLINE
struct Lisp_Misc_Any
*
2314 XMISCANY (Lisp_Object a
)
2316 eassert (MISCP (a
));
2317 return & XMISC (a
)->u_any
;
2320 INLINE
enum Lisp_Misc_Type
2321 XMISCTYPE (Lisp_Object a
)
2323 return XMISCANY (a
)->type
;
2326 INLINE
struct Lisp_Marker
*
2327 XMARKER (Lisp_Object a
)
2329 eassert (MARKERP (a
));
2330 return & XMISC (a
)->u_marker
;
2333 INLINE
struct Lisp_Overlay
*
2334 XOVERLAY (Lisp_Object a
)
2336 eassert (OVERLAYP (a
));
2337 return & XMISC (a
)->u_overlay
;
2340 INLINE
struct Lisp_Save_Value
*
2341 XSAVE_VALUE (Lisp_Object a
)
2343 eassert (SAVE_VALUEP (a
));
2344 return & XMISC (a
)->u_save_value
;
2347 INLINE
struct Lisp_Finalizer
*
2348 XFINALIZER (Lisp_Object a
)
2350 eassert (FINALIZERP (a
));
2351 return & XMISC (a
)->u_finalizer
;
2355 INLINE
struct Lisp_User_Ptr
*
2356 XUSER_PTR (Lisp_Object a
)
2358 eassert (USER_PTRP (a
));
2359 return & XMISC (a
)->u_user_ptr
;
2364 /* Forwarding pointer to an int variable.
2365 This is allowed only in the value cell of a symbol,
2366 and it means that the symbol's value really lives in the
2367 specified int variable. */
2370 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2374 /* Boolean forwarding pointer to an int variable.
2375 This is like Lisp_Intfwd except that the ostensible
2376 "value" of the symbol is t if the bool variable is true,
2377 nil if it is false. */
2380 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2384 /* Forwarding pointer to a Lisp_Object variable.
2385 This is allowed only in the value cell of a symbol,
2386 and it means that the symbol's value really lives in the
2387 specified variable. */
2390 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2391 Lisp_Object
*objvar
;
2394 /* Like Lisp_Objfwd except that value lives in a slot in the
2395 current buffer. Value is byte index of slot within buffer. */
2396 struct Lisp_Buffer_Objfwd
2398 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2400 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2401 Lisp_Object predicate
;
2404 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2405 the symbol has buffer-local or frame-local bindings. (Exception:
2406 some buffer-local variables are built-in, with their values stored
2407 in the buffer structure itself. They are handled differently,
2408 using struct Lisp_Buffer_Objfwd.)
2410 The `realvalue' slot holds the variable's current value, or a
2411 forwarding pointer to where that value is kept. This value is the
2412 one that corresponds to the loaded binding. To read or set the
2413 variable, you must first make sure the right binding is loaded;
2414 then you can access the value in (or through) `realvalue'.
2416 `buffer' and `frame' are the buffer and frame for which the loaded
2417 binding was found. If those have changed, to make sure the right
2418 binding is loaded it is necessary to find which binding goes with
2419 the current buffer and selected frame, then load it. To load it,
2420 first unload the previous binding, then copy the value of the new
2421 binding into `realvalue' (or through it). Also update
2422 LOADED-BINDING to point to the newly loaded binding.
2424 `local_if_set' indicates that merely setting the variable creates a
2425 local binding for the current buffer. Otherwise the latter, setting
2426 the variable does not do that; only make-local-variable does that. */
2428 struct Lisp_Buffer_Local_Value
2430 /* True means that merely setting the variable creates a local
2431 binding for the current buffer. */
2432 bool_bf local_if_set
: 1;
2433 /* True means this variable can have frame-local bindings, otherwise, it is
2434 can have buffer-local bindings. The two cannot be combined. */
2435 bool_bf frame_local
: 1;
2436 /* True means that the binding now loaded was found.
2437 Presumably equivalent to (defcell!=valcell). */
2439 /* If non-NULL, a forwarding to the C var where it should also be set. */
2440 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2441 /* The buffer or frame for which the loaded binding was found. */
2443 /* A cons cell that holds the default value. It has the form
2444 (SYMBOL . DEFAULT-VALUE). */
2445 Lisp_Object defcell
;
2446 /* The cons cell from `where's parameter alist.
2447 It always has the form (SYMBOL . VALUE)
2448 Note that if `forward' is non-nil, VALUE may be out of date.
2449 Also if the currently loaded binding is the default binding, then
2450 this is `eq'ual to defcell. */
2451 Lisp_Object valcell
;
2454 /* Like Lisp_Objfwd except that value lives in a slot in the
2456 struct Lisp_Kboard_Objfwd
2458 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2464 struct Lisp_Intfwd u_intfwd
;
2465 struct Lisp_Boolfwd u_boolfwd
;
2466 struct Lisp_Objfwd u_objfwd
;
2467 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2468 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2471 INLINE
enum Lisp_Fwd_Type
2472 XFWDTYPE (union Lisp_Fwd
*a
)
2474 return a
->u_intfwd
.type
;
2477 INLINE
struct Lisp_Buffer_Objfwd
*
2478 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2480 eassert (BUFFER_OBJFWDP (a
));
2481 return &a
->u_buffer_objfwd
;
2484 /* Lisp floating point type. */
2490 struct Lisp_Float
*chain
;
2495 XFLOAT_DATA (Lisp_Object f
)
2497 return XFLOAT (f
)->u
.data
;
2500 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2501 representations, have infinities and NaNs, and do not trap on
2502 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2503 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2504 wanted here, but is not quite right because Emacs does not require
2505 all the features of C11 Annex F (and does not require C11 at all,
2506 for that matter). */
2510 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2511 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2514 /* A character, declared with the following typedef, is a member
2515 of some character set associated with the current buffer. */
2516 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2518 typedef unsigned char UCHAR
;
2521 /* Meanings of slots in a Lisp_Compiled: */
2525 COMPILED_ARGLIST
= 0,
2526 COMPILED_BYTECODE
= 1,
2527 COMPILED_CONSTANTS
= 2,
2528 COMPILED_STACK_DEPTH
= 3,
2529 COMPILED_DOC_STRING
= 4,
2530 COMPILED_INTERACTIVE
= 5
2533 /* Flag bits in a character. These also get used in termhooks.h.
2534 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2535 (MUlti-Lingual Emacs) might need 22 bits for the character value
2536 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2539 CHAR_ALT
= 0x0400000,
2540 CHAR_SUPER
= 0x0800000,
2541 CHAR_HYPER
= 0x1000000,
2542 CHAR_SHIFT
= 0x2000000,
2543 CHAR_CTL
= 0x4000000,
2544 CHAR_META
= 0x8000000,
2546 CHAR_MODIFIER_MASK
=
2547 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2549 /* Actually, the current Emacs uses 22 bits for the character value
2554 /* Data type checking. */
2557 (NILP
) (Lisp_Object x
)
2559 return lisp_h_NILP (x
);
2563 NUMBERP (Lisp_Object x
)
2565 return INTEGERP (x
) || FLOATP (x
);
2568 NATNUMP (Lisp_Object x
)
2570 return INTEGERP (x
) && 0 <= XINT (x
);
2574 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2576 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2579 #define TYPE_RANGED_INTEGERP(type, x) \
2581 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2582 && XINT (x) <= TYPE_MAXIMUM (type))
2585 (CONSP
) (Lisp_Object x
)
2587 return lisp_h_CONSP (x
);
2590 (FLOATP
) (Lisp_Object x
)
2592 return lisp_h_FLOATP (x
);
2595 (MISCP
) (Lisp_Object x
)
2597 return lisp_h_MISCP (x
);
2600 (SYMBOLP
) (Lisp_Object x
)
2602 return lisp_h_SYMBOLP (x
);
2605 (INTEGERP
) (Lisp_Object x
)
2607 return lisp_h_INTEGERP (x
);
2610 (VECTORLIKEP
) (Lisp_Object x
)
2612 return lisp_h_VECTORLIKEP (x
);
2615 (MARKERP
) (Lisp_Object x
)
2617 return lisp_h_MARKERP (x
);
2621 STRINGP (Lisp_Object x
)
2623 return XTYPE (x
) == Lisp_String
;
2626 VECTORP (Lisp_Object x
)
2628 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2631 OVERLAYP (Lisp_Object x
)
2633 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2636 SAVE_VALUEP (Lisp_Object x
)
2638 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2642 FINALIZERP (Lisp_Object x
)
2644 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Finalizer
;
2649 USER_PTRP (Lisp_Object x
)
2651 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_User_Ptr
;
2656 AUTOLOADP (Lisp_Object x
)
2658 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2662 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2664 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2668 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2670 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2671 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2674 /* True if A is a pseudovector whose code is CODE. */
2676 PSEUDOVECTORP (Lisp_Object a
, int code
)
2678 if (! VECTORLIKEP (a
))
2682 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2683 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2684 return PSEUDOVECTOR_TYPEP (h
, code
);
2689 /* Test for specific pseudovector types. */
2692 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2694 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2698 PROCESSP (Lisp_Object a
)
2700 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2704 WINDOWP (Lisp_Object a
)
2706 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2710 TERMINALP (Lisp_Object a
)
2712 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2716 SUBRP (Lisp_Object a
)
2718 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2722 COMPILEDP (Lisp_Object a
)
2724 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2728 BUFFERP (Lisp_Object a
)
2730 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2734 CHAR_TABLE_P (Lisp_Object a
)
2736 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2740 SUB_CHAR_TABLE_P (Lisp_Object a
)
2742 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2746 BOOL_VECTOR_P (Lisp_Object a
)
2748 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2752 FRAMEP (Lisp_Object a
)
2754 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2757 /* Test for image (image . spec) */
2759 IMAGEP (Lisp_Object x
)
2761 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2766 ARRAYP (Lisp_Object x
)
2768 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2772 CHECK_LIST (Lisp_Object x
)
2774 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2778 (CHECK_LIST_CONS
) (Lisp_Object x
, Lisp_Object y
)
2780 lisp_h_CHECK_LIST_CONS (x
, y
);
2784 (CHECK_SYMBOL
) (Lisp_Object x
)
2786 lisp_h_CHECK_SYMBOL (x
);
2790 (CHECK_NUMBER
) (Lisp_Object x
)
2792 lisp_h_CHECK_NUMBER (x
);
2796 CHECK_STRING (Lisp_Object x
)
2798 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2801 CHECK_STRING_CAR (Lisp_Object x
)
2803 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2806 CHECK_CONS (Lisp_Object x
)
2808 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2811 CHECK_VECTOR (Lisp_Object x
)
2813 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2816 CHECK_BOOL_VECTOR (Lisp_Object x
)
2818 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2820 /* This is a bit special because we always need size afterwards. */
2822 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2828 wrong_type_argument (Qarrayp
, x
);
2831 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2833 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2836 CHECK_BUFFER (Lisp_Object x
)
2838 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2841 CHECK_WINDOW (Lisp_Object x
)
2843 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2847 CHECK_PROCESS (Lisp_Object x
)
2849 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2853 CHECK_NATNUM (Lisp_Object x
)
2855 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2858 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2861 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2862 args_out_of_range_3 \
2864 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2865 ? MOST_NEGATIVE_FIXNUM \
2867 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2869 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2871 if (TYPE_SIGNED (type)) \
2872 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2874 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2877 #define CHECK_NUMBER_COERCE_MARKER(x) \
2879 if (MARKERP ((x))) \
2880 XSETFASTINT (x, marker_position (x)); \
2882 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2886 XFLOATINT (Lisp_Object n
)
2888 return extract_float (n
);
2892 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2894 CHECK_TYPE (NUMBERP (x
), Qnumberp
, x
);
2897 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2900 XSETFASTINT (x, marker_position (x)); \
2902 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2905 /* Since we can't assign directly to the CAR or CDR fields of a cons
2906 cell, use these when checking that those fields contain numbers. */
2908 CHECK_NUMBER_CAR (Lisp_Object x
)
2910 Lisp_Object tmp
= XCAR (x
);
2916 CHECK_NUMBER_CDR (Lisp_Object x
)
2918 Lisp_Object tmp
= XCDR (x
);
2923 /* Define a built-in function for calling from Lisp.
2924 `lname' should be the name to give the function in Lisp,
2925 as a null-terminated C string.
2926 `fnname' should be the name of the function in C.
2927 By convention, it starts with F.
2928 `sname' should be the name for the C constant structure
2929 that records information on this function for internal use.
2930 By convention, it should be the same as `fnname' but with S instead of F.
2931 It's too bad that C macros can't compute this from `fnname'.
2932 `minargs' should be a number, the minimum number of arguments allowed.
2933 `maxargs' should be a number, the maximum number of arguments allowed,
2934 or else MANY or UNEVALLED.
2935 MANY means pass a vector of evaluated arguments,
2936 in the form of an integer number-of-arguments
2937 followed by the address of a vector of Lisp_Objects
2938 which contains the argument values.
2939 UNEVALLED means pass the list of unevaluated arguments
2940 `intspec' says how interactive arguments are to be fetched.
2941 If the string starts with a `(', `intspec' is evaluated and the resulting
2942 list is the list of arguments.
2943 If it's a string that doesn't start with `(', the value should follow
2944 the one of the doc string for `interactive'.
2945 A null string means call interactively with no arguments.
2946 `doc' is documentation for the user. */
2948 /* This version of DEFUN declares a function prototype with the right
2949 arguments, so we can catch errors with maxargs at compile-time. */
2951 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2952 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2953 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2954 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2955 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2956 { (Lisp_Object (__cdecl *)(void))fnname }, \
2957 minargs, maxargs, lname, intspec, 0}; \
2959 #else /* not _MSC_VER */
2960 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2961 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2962 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2963 { .a ## maxargs = fnname }, \
2964 minargs, maxargs, lname, intspec, 0}; \
2968 /* True if OBJ is a Lisp function. */
2970 FUNCTIONP (Lisp_Object obj
)
2972 return functionp (obj
);
2976 is how we define the symbol for function `name' at start-up time. */
2977 extern void defsubr (struct Lisp_Subr
*);
2985 /* Call a function F that accepts many args, passing it ARRAY's elements. */
2986 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
2988 /* Call a function F that accepts many args, passing it the remaining args,
2989 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
2990 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
2991 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
2992 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
2994 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2995 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2996 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2997 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2998 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
3000 /* Macros we use to define forwarded Lisp variables.
3001 These are used in the syms_of_FILENAME functions.
3003 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
3004 lisp variable is actually a field in `struct emacs_globals'. The
3005 field's name begins with "f_", which is a convention enforced by
3006 these macros. Each such global has a corresponding #define in
3007 globals.h; the plain name should be used in the code.
3009 E.g., the global "cons_cells_consed" is declared as "int
3010 f_cons_cells_consed" in globals.h, but there is a define:
3012 #define cons_cells_consed globals.f_cons_cells_consed
3014 All C code uses the `cons_cells_consed' name. This is all done
3015 this way to support indirection for multi-threaded Emacs. */
3017 #define DEFVAR_LISP(lname, vname, doc) \
3019 static struct Lisp_Objfwd o_fwd; \
3020 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
3022 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
3024 static struct Lisp_Objfwd o_fwd; \
3025 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
3027 #define DEFVAR_BOOL(lname, vname, doc) \
3029 static struct Lisp_Boolfwd b_fwd; \
3030 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
3032 #define DEFVAR_INT(lname, vname, doc) \
3034 static struct Lisp_Intfwd i_fwd; \
3035 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
3038 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
3040 static struct Lisp_Objfwd o_fwd; \
3041 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
3044 #define DEFVAR_KBOARD(lname, vname, doc) \
3046 static struct Lisp_Kboard_Objfwd ko_fwd; \
3047 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
3050 /* Save and restore the instruction and environment pointers,
3051 without affecting the signal mask. */
3054 typedef jmp_buf sys_jmp_buf
;
3055 # define sys_setjmp(j) _setjmp (j)
3056 # define sys_longjmp(j, v) _longjmp (j, v)
3057 #elif defined HAVE_SIGSETJMP
3058 typedef sigjmp_buf sys_jmp_buf
;
3059 # define sys_setjmp(j) sigsetjmp (j, 0)
3060 # define sys_longjmp(j, v) siglongjmp (j, v)
3062 /* A platform that uses neither _longjmp nor siglongjmp; assume
3063 longjmp does not affect the sigmask. */
3064 typedef jmp_buf sys_jmp_buf
;
3065 # define sys_setjmp(j) setjmp (j)
3066 # define sys_longjmp(j, v) longjmp (j, v)
3070 /* Elisp uses several stacks:
3072 - the bytecode stack: used internally by the bytecode interpreter.
3073 Allocated from the C stack.
3074 - The specpdl stack: keeps track of active unwind-protect and
3075 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
3077 - The handler stack: keeps track of active catch tags and condition-case
3078 handlers. Allocated in a manually managed stack implemented by a
3079 doubly-linked list allocated via xmalloc and never freed. */
3081 /* Structure for recording Lisp call stack for backtrace purposes. */
3083 /* The special binding stack holds the outer values of variables while
3084 they are bound by a function application or a let form, stores the
3085 code to be executed for unwind-protect forms.
3087 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
3088 used all over the place, needs to be fast, and needs to know the size of
3089 union specbinding. But only eval.c should access it. */
3092 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
3093 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
3094 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
3095 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
3096 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
3097 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
3098 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3099 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
3100 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
3105 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3107 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3108 void (*func
) (Lisp_Object
);
3112 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3113 void (*func
) (void *);
3117 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3122 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3123 void (*func
) (void);
3126 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3127 /* `where' is not used in the case of SPECPDL_LET. */
3128 Lisp_Object symbol
, old_value
, where
;
3131 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3132 bool_bf debug_on_exit
: 1;
3133 Lisp_Object function
;
3139 extern union specbinding
*specpdl
;
3140 extern union specbinding
*specpdl_ptr
;
3141 extern ptrdiff_t specpdl_size
;
3144 SPECPDL_INDEX (void)
3146 return specpdl_ptr
- specpdl
;
3149 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3150 control structures. A struct handler contains all the information needed to
3151 restore the state of the interpreter after a non-local jump.
3153 handler structures are chained together in a doubly linked list; the `next'
3154 member points to the next outer catchtag and the `nextfree' member points in
3155 the other direction to the next inner element (which is typically the next
3156 free element since we mostly use it on the deepest handler).
3158 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3159 member is TAG, and then unbinds to it. The `val' member is used to
3160 hold VAL while the stack is unwound; `val' is returned as the value
3161 of the catch form. If there is a handler of type CATCHER_ALL, it will
3162 be treated as a handler for all invocations of `throw'; in this case
3163 `val' will be set to (TAG . VAL).
3165 All the other members are concerned with restoring the interpreter
3168 Members are volatile if their values need to survive _longjmp when
3169 a 'struct handler' is a local variable. */
3171 enum handlertype
{ CATCHER
, CONDITION_CASE
, CATCHER_ALL
};
3175 enum handlertype type
;
3176 Lisp_Object tag_or_ch
;
3178 struct handler
*next
;
3179 struct handler
*nextfree
;
3181 /* The bytecode interpreter can have several handlers active at the same
3182 time, so when we longjmp to one of them, it needs to know which handler
3183 this was and what was the corresponding internal state. This is stored
3184 here, and when we longjmp we make sure that handlerlist points to the
3186 Lisp_Object
*bytecode_top
;
3189 /* Most global vars are reset to their value via the specpdl mechanism,
3190 but a few others are handled by storing their value here. */
3192 EMACS_INT lisp_eval_depth
;
3194 int poll_suppress_count
;
3195 int interrupt_input_blocked
;
3198 extern Lisp_Object memory_signal_data
;
3200 /* An address near the bottom of the stack.
3201 Tells GC how to save a copy of the stack. */
3202 extern char *stack_bottom
;
3204 /* Check quit-flag and quit if it is non-nil.
3205 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
3206 So the program needs to do QUIT at times when it is safe to quit.
3207 Every loop that might run for a long time or might not exit
3208 ought to do QUIT at least once, at a safe place.
3209 Unless that is impossible, of course.
3210 But it is very desirable to avoid creating loops where QUIT is impossible.
3212 Exception: if you set immediate_quit to true,
3213 then the handler that responds to the C-g does the quit itself.
3214 This is a good thing to do around a loop that has no side effects
3215 and (in particular) cannot call arbitrary Lisp code.
3217 If quit-flag is set to `kill-emacs' the SIGINT handler has received
3218 a request to exit Emacs when it is safe to do. */
3220 extern void process_pending_signals (void);
3221 extern bool volatile pending_signals
;
3223 extern void process_quit_flag (void);
3226 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3227 process_quit_flag (); \
3228 else if (pending_signals) \
3229 process_pending_signals (); \
3233 /* True if ought to quit now. */
3235 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3237 extern Lisp_Object Vascii_downcase_table
;
3238 extern Lisp_Object Vascii_canon_table
;
3240 /* Call staticpro (&var) to protect static variable `var'. */
3242 void staticpro (Lisp_Object
*);
3244 /* Forward declarations for prototypes. */
3248 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3251 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3253 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3254 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3257 /* Functions to modify hash tables. */
3260 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3262 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3266 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3268 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3271 /* Use these functions to set Lisp_Object
3272 or pointer slots of struct Lisp_Symbol. */
3275 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3277 XSYMBOL (sym
)->function
= function
;
3281 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3283 XSYMBOL (sym
)->plist
= plist
;
3287 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3289 XSYMBOL (sym
)->next
= next
;
3292 /* Buffer-local (also frame-local) variable access functions. */
3295 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3297 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3301 /* Set overlay's property list. */
3304 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3306 XOVERLAY (overlay
)->plist
= plist
;
3309 /* Get text properties of S. */
3312 string_intervals (Lisp_Object s
)
3314 return XSTRING (s
)->intervals
;
3317 /* Set text properties of S to I. */
3320 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3322 XSTRING (s
)->intervals
= i
;
3325 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3326 of setting slots directly. */
3329 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3331 XCHAR_TABLE (table
)->defalt
= val
;
3334 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3336 XCHAR_TABLE (table
)->purpose
= val
;
3339 /* Set different slots in (sub)character tables. */
3342 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3344 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3345 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3349 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3351 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3352 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3356 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3358 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3361 /* Defined in data.c. */
3362 extern Lisp_Object
indirect_function (Lisp_Object
);
3363 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3364 enum Arith_Comparison
{
3369 ARITH_LESS_OR_EQUAL
,
3372 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3373 enum Arith_Comparison comparison
);
3375 /* Convert the integer I to an Emacs representation, either the integer
3376 itself, or a cons of two or three integers, or if all else fails a float.
3377 I should not have side effects. */
3378 #define INTEGER_TO_CONS(i) \
3379 (! FIXNUM_OVERFLOW_P (i) \
3381 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3382 extern Lisp_Object
intbig_to_lisp (intmax_t);
3383 extern Lisp_Object
uintbig_to_lisp (uintmax_t);
3385 /* Convert the Emacs representation CONS back to an integer of type
3386 TYPE, storing the result the variable VAR. Signal an error if CONS
3387 is not a valid representation or is out of range for TYPE. */
3388 #define CONS_TO_INTEGER(cons, type, var) \
3389 (TYPE_SIGNED (type) \
3390 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3391 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3392 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3393 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3395 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3396 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3397 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3399 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3400 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3401 extern void syms_of_data (void);
3402 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3404 /* Defined in cmds.c */
3405 extern void syms_of_cmds (void);
3406 extern void keys_of_cmds (void);
3408 /* Defined in coding.c. */
3409 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3410 ptrdiff_t, bool, bool, Lisp_Object
);
3411 extern void init_coding (void);
3412 extern void init_coding_once (void);
3413 extern void syms_of_coding (void);
3415 /* Defined in character.c. */
3416 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3417 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3418 extern void syms_of_character (void);
3420 /* Defined in charset.c. */
3421 extern void init_charset (void);
3422 extern void init_charset_once (void);
3423 extern void syms_of_charset (void);
3424 /* Structure forward declarations. */
3427 /* Defined in syntax.c. */
3428 extern void init_syntax_once (void);
3429 extern void syms_of_syntax (void);
3431 /* Defined in fns.c. */
3432 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3433 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3434 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3435 extern void sweep_weak_hash_tables (void);
3436 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3437 EMACS_UINT
sxhash (Lisp_Object
, int);
3438 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3439 Lisp_Object
, Lisp_Object
);
3440 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3441 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3443 void hash_remove_from_table (struct Lisp_Hash_Table
*, Lisp_Object
);
3444 extern struct hash_table_test
const hashtest_eq
, hashtest_eql
, hashtest_equal
;
3445 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3446 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3447 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3448 ptrdiff_t, ptrdiff_t);
3449 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3450 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3451 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3452 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3453 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3454 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3455 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3456 extern void clear_string_char_byte_cache (void);
3457 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3458 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3459 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3460 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3461 extern void syms_of_fns (void);
3463 /* Defined in floatfns.c. */
3464 extern void syms_of_floatfns (void);
3465 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3467 /* Defined in fringe.c. */
3468 extern void syms_of_fringe (void);
3469 extern void init_fringe (void);
3470 #ifdef HAVE_WINDOW_SYSTEM
3471 extern void mark_fringe_data (void);
3472 extern void init_fringe_once (void);
3473 #endif /* HAVE_WINDOW_SYSTEM */
3475 /* Defined in image.c. */
3476 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3477 extern void reset_image_types (void);
3478 extern void syms_of_image (void);
3480 /* Defined in insdel.c. */
3481 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3482 extern _Noreturn
void buffer_overflow (void);
3483 extern void make_gap (ptrdiff_t);
3484 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3485 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3486 ptrdiff_t, bool, bool);
3487 extern int count_combining_before (const unsigned char *,
3488 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3489 extern int count_combining_after (const unsigned char *,
3490 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3491 extern void insert (const char *, ptrdiff_t);
3492 extern void insert_and_inherit (const char *, ptrdiff_t);
3493 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3495 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3496 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3497 ptrdiff_t, ptrdiff_t, bool);
3498 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3499 extern void insert_char (int);
3500 extern void insert_string (const char *);
3501 extern void insert_before_markers (const char *, ptrdiff_t);
3502 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3503 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3504 ptrdiff_t, ptrdiff_t,
3506 extern void del_range (ptrdiff_t, ptrdiff_t);
3507 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3508 extern void del_range_byte (ptrdiff_t, ptrdiff_t);
3509 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3510 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3511 ptrdiff_t, ptrdiff_t, bool);
3512 extern void modify_text (ptrdiff_t, ptrdiff_t);
3513 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3514 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3515 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3516 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3517 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3518 ptrdiff_t, ptrdiff_t);
3519 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3520 ptrdiff_t, ptrdiff_t);
3521 extern void adjust_markers_bytepos (ptrdiff_t, ptrdiff_t,
3522 ptrdiff_t, ptrdiff_t, int);
3523 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool, bool);
3524 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3525 const char *, ptrdiff_t, ptrdiff_t, bool);
3526 extern void syms_of_insdel (void);
3528 /* Defined in dispnew.c. */
3529 #if (defined PROFILING \
3530 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3531 _Noreturn
void __executable_start (void);
3533 extern Lisp_Object Vwindow_system
;
3534 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3536 /* Defined in xdisp.c. */
3537 extern bool noninteractive_need_newline
;
3538 extern Lisp_Object echo_area_buffer
[2];
3539 extern void add_to_log (char const *, ...);
3540 extern void vadd_to_log (char const *, va_list);
3541 extern void check_message_stack (void);
3542 extern void setup_echo_area_for_printing (bool);
3543 extern bool push_message (void);
3544 extern void pop_message_unwind (void);
3545 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3546 extern void restore_message (void);
3547 extern Lisp_Object
current_message (void);
3548 extern void clear_message (bool, bool);
3549 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3550 extern void message1 (const char *);
3551 extern void message1_nolog (const char *);
3552 extern void message3 (Lisp_Object
);
3553 extern void message3_nolog (Lisp_Object
);
3554 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3555 extern void message_with_string (const char *, Lisp_Object
, bool);
3556 extern void message_log_maybe_newline (void);
3557 extern void update_echo_area (void);
3558 extern void truncate_echo_area (ptrdiff_t);
3559 extern void redisplay (void);
3561 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3562 extern void syms_of_xdisp (void);
3563 extern void init_xdisp (void);
3564 extern Lisp_Object
safe_eval (Lisp_Object
);
3565 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3566 int *, int *, int *, int *, int *);
3568 /* Defined in xsettings.c. */
3569 extern void syms_of_xsettings (void);
3571 /* Defined in vm-limit.c. */
3572 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3574 /* Defined in character.c. */
3575 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3576 ptrdiff_t *, ptrdiff_t *);
3578 /* Defined in alloc.c. */
3579 extern void *my_heap_start (void);
3580 extern void check_pure_size (void);
3581 extern void free_misc (Lisp_Object
);
3582 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3583 extern void malloc_warning (const char *);
3584 extern _Noreturn
void memory_full (size_t);
3585 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3586 extern bool survives_gc_p (Lisp_Object
);
3587 extern void mark_object (Lisp_Object
);
3588 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3589 extern void refill_memory_reserve (void);
3591 extern void alloc_unexec_pre (void);
3592 extern void alloc_unexec_post (void);
3593 extern const char *pending_malloc_warning
;
3594 extern Lisp_Object zero_vector
;
3595 extern Lisp_Object
*stack_base
;
3596 extern EMACS_INT consing_since_gc
;
3597 extern EMACS_INT gc_relative_threshold
;
3598 extern EMACS_INT memory_full_cons_threshold
;
3599 extern Lisp_Object
list1 (Lisp_Object
);
3600 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3601 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3602 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3603 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3605 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3606 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3608 /* Build a frequently used 2/3/4-integer lists. */
3611 list2i (EMACS_INT x
, EMACS_INT y
)
3613 return list2 (make_number (x
), make_number (y
));
3617 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3619 return list3 (make_number (x
), make_number (y
), make_number (w
));
3623 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3625 return list4 (make_number (x
), make_number (y
),
3626 make_number (w
), make_number (h
));
3629 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3630 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3631 extern _Noreturn
void string_overflow (void);
3632 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3633 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3634 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3635 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3637 /* Make unibyte string from C string when the length isn't known. */
3640 build_unibyte_string (const char *str
)
3642 return make_unibyte_string (str
, strlen (str
));
3645 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3646 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3647 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3648 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3649 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3650 extern Lisp_Object
make_specified_string (const char *,
3651 ptrdiff_t, ptrdiff_t, bool);
3652 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3653 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3655 /* Make a string allocated in pure space, use STR as string data. */
3658 build_pure_c_string (const char *str
)
3660 return make_pure_c_string (str
, strlen (str
));
3663 /* Make a string from the data at STR, treating it as multibyte if the
3667 build_string (const char *str
)
3669 return make_string (str
, strlen (str
));
3672 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3673 extern void make_byte_code (struct Lisp_Vector
*);
3674 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3676 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3677 be sure that GC cannot happen until the vector is completely
3678 initialized. E.g. the following code is likely to crash:
3680 v = make_uninit_vector (3);
3682 ASET (v, 1, Ffunction_can_gc ());
3683 ASET (v, 2, obj1); */
3686 make_uninit_vector (ptrdiff_t size
)
3689 struct Lisp_Vector
*p
;
3691 p
= allocate_vector (size
);
3696 /* Like above, but special for sub char-tables. */
3699 make_uninit_sub_char_table (int depth
, int min_char
)
3701 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3702 Lisp_Object v
= make_uninit_vector (slots
);
3704 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3705 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3706 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3710 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3713 /* Allocate partially initialized pseudovector where all Lisp_Object
3714 slots are set to Qnil but the rest (if any) is left uninitialized. */
3716 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3717 ((type *) allocate_pseudovector (VECSIZE (type), \
3718 PSEUDOVECSIZE (type, field), \
3719 PSEUDOVECSIZE (type, field), tag))
3721 /* Allocate fully initialized pseudovector where all Lisp_Object
3722 slots are set to Qnil and the rest (if any) is zeroed. */
3724 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3725 ((type *) allocate_pseudovector (VECSIZE (type), \
3726 PSEUDOVECSIZE (type, field), \
3727 VECSIZE (type), tag))
3729 extern bool gc_in_progress
;
3730 extern Lisp_Object
make_float (double);
3731 extern void display_malloc_warning (void);
3732 extern ptrdiff_t inhibit_garbage_collection (void);
3733 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3734 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3735 Lisp_Object
, Lisp_Object
);
3736 extern Lisp_Object
make_save_ptr (void *);
3737 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3738 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3739 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3741 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3742 extern void free_save_value (Lisp_Object
);
3743 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3744 extern void free_marker (Lisp_Object
);
3745 extern void free_cons (struct Lisp_Cons
*);
3746 extern void init_alloc_once (void);
3747 extern void init_alloc (void);
3748 extern void syms_of_alloc (void);
3749 extern struct buffer
* allocate_buffer (void);
3750 extern int valid_lisp_object_p (Lisp_Object
);
3751 #ifdef GC_CHECK_CONS_LIST
3752 extern void check_cons_list (void);
3754 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3757 /* Defined in gmalloc.c. */
3758 #if !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC && !defined SYSTEM_MALLOC
3759 extern size_t __malloc_extra_blocks
;
3761 #if !HAVE_DECL_ALIGNED_ALLOC
3762 extern void *aligned_alloc (size_t, size_t) ATTRIBUTE_MALLOC_SIZE ((2));
3764 extern void malloc_enable_thread (void);
3767 /* Defined in ralloc.c. */
3768 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3769 extern void r_alloc_free (void **);
3770 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3771 extern void r_alloc_reset_variable (void **, void **);
3772 extern void r_alloc_inhibit_buffer_relocation (int);
3775 /* Defined in chartab.c. */
3776 extern Lisp_Object
copy_char_table (Lisp_Object
);
3777 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3779 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3780 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3782 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3783 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3784 Lisp_Object
, Lisp_Object
,
3785 Lisp_Object
, struct charset
*,
3786 unsigned, unsigned);
3787 extern Lisp_Object
uniprop_table (Lisp_Object
);
3788 extern void syms_of_chartab (void);
3790 /* Defined in print.c. */
3791 extern Lisp_Object Vprin1_to_string_buffer
;
3792 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3793 extern void temp_output_buffer_setup (const char *);
3794 extern int print_level
;
3795 extern void write_string (const char *);
3796 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3798 extern Lisp_Object internal_with_output_to_temp_buffer
3799 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3800 #define FLOAT_TO_STRING_BUFSIZE 350
3801 extern int float_to_string (char *, double);
3802 extern void init_print_once (void);
3803 extern void syms_of_print (void);
3805 /* Defined in doprnt.c. */
3806 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3808 extern ptrdiff_t esprintf (char *, char const *, ...)
3809 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3810 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3812 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3813 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3814 char const *, va_list)
3815 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3817 /* Defined in lread.c. */
3818 extern Lisp_Object
check_obarray (Lisp_Object
);
3819 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3820 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3821 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3822 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3823 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3825 LOADHIST_ATTACH (Lisp_Object x
)
3828 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3830 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3831 Lisp_Object
*, Lisp_Object
, bool);
3832 extern Lisp_Object
string_to_number (char const *, int, bool);
3833 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3835 extern void dir_warning (const char *, Lisp_Object
);
3836 extern void init_obarray (void);
3837 extern void init_lread (void);
3838 extern void syms_of_lread (void);
3841 intern (const char *str
)
3843 return intern_1 (str
, strlen (str
));
3847 intern_c_string (const char *str
)
3849 return intern_c_string_1 (str
, strlen (str
));
3852 /* Defined in eval.c. */
3853 extern Lisp_Object Vautoload_queue
;
3854 extern Lisp_Object Vrun_hooks
;
3855 extern Lisp_Object Vsignaling_function
;
3856 extern Lisp_Object inhibit_lisp_code
;
3857 extern struct handler
*handlerlist
;
3859 /* To run a normal hook, use the appropriate function from the list below.
3860 The calling convention:
3862 if (!NILP (Vrun_hooks))
3863 call1 (Vrun_hooks, Qmy_funny_hook);
3865 should no longer be used. */
3866 extern void run_hook (Lisp_Object
);
3867 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3868 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3869 Lisp_Object (*funcall
)
3870 (ptrdiff_t nargs
, Lisp_Object
*args
));
3871 extern Lisp_Object
quit (void);
3872 INLINE _Noreturn
void
3873 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
3875 Fsignal (error_symbol
, data
);
3877 extern _Noreturn
void xsignal0 (Lisp_Object
);
3878 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3879 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3880 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3882 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3883 extern Lisp_Object
eval_sub (Lisp_Object form
);
3884 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3885 extern Lisp_Object
call0 (Lisp_Object
);
3886 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3887 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3888 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3889 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3890 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3891 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3892 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3893 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3894 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3895 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3896 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3897 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3898 extern Lisp_Object internal_condition_case_n
3899 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3900 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3901 extern struct handler
*push_handler (Lisp_Object
, enum handlertype
);
3902 extern struct handler
*push_handler_nosignal (Lisp_Object
, enum handlertype
);
3903 extern void specbind (Lisp_Object
, Lisp_Object
);
3904 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3905 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3906 extern void record_unwind_protect_int (void (*) (int), int);
3907 extern void record_unwind_protect_void (void (*) (void));
3908 extern void record_unwind_protect_nothing (void);
3909 extern void clear_unwind_protect (ptrdiff_t);
3910 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3911 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3912 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3913 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3914 extern _Noreturn
void verror (const char *, va_list)
3915 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3916 extern Lisp_Object
vformat_string (const char *, va_list)
3917 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3918 extern void un_autoload (Lisp_Object
);
3919 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3920 extern void *near_C_stack_top (void);
3921 extern void init_eval_once (void);
3922 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3923 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3924 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3925 extern void init_eval (void);
3926 extern void syms_of_eval (void);
3927 extern void unwind_body (Lisp_Object
);
3928 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
3929 extern void mark_specpdl (void);
3930 extern void get_backtrace (Lisp_Object array
);
3931 Lisp_Object
backtrace_top_function (void);
3932 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3933 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3936 /* Defined in alloc.c. */
3937 extern Lisp_Object
make_user_ptr (void (*finalizer
) (void *), void *p
);
3939 /* Defined in emacs-module.c. */
3940 extern void module_init (void);
3941 extern void syms_of_module (void);
3944 /* Defined in editfns.c. */
3945 extern void insert1 (Lisp_Object
);
3946 extern Lisp_Object
save_excursion_save (void);
3947 extern Lisp_Object
save_restriction_save (void);
3948 extern void save_excursion_restore (Lisp_Object
);
3949 extern void save_restriction_restore (Lisp_Object
);
3950 extern _Noreturn
void time_overflow (void);
3951 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3952 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3954 extern void init_editfns (bool);
3955 extern void syms_of_editfns (void);
3957 /* Defined in buffer.c. */
3958 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3959 extern _Noreturn
void nsberror (Lisp_Object
);
3960 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3961 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3962 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3963 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3964 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3965 extern bool overlay_touches_p (ptrdiff_t);
3966 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3967 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3968 extern void init_buffer_once (void);
3969 extern void init_buffer (int);
3970 extern void syms_of_buffer (void);
3971 extern void keys_of_buffer (void);
3973 /* Defined in marker.c. */
3975 extern ptrdiff_t marker_position (Lisp_Object
);
3976 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3977 extern void clear_charpos_cache (struct buffer
*);
3978 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3979 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3980 extern void unchain_marker (struct Lisp_Marker
*marker
);
3981 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3982 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3983 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3984 ptrdiff_t, ptrdiff_t);
3985 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3986 extern void syms_of_marker (void);
3988 /* Defined in fileio.c. */
3990 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3991 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3992 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3994 extern void close_file_unwind (int);
3995 extern void fclose_unwind (void *);
3996 extern void restore_point_unwind (Lisp_Object
);
3997 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3998 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3999 extern _Noreturn
void report_file_notify_error (const char *, Lisp_Object
);
4000 extern bool internal_delete_file (Lisp_Object
);
4001 extern Lisp_Object
emacs_readlinkat (int, const char *);
4002 extern bool file_directory_p (const char *);
4003 extern bool file_accessible_directory_p (Lisp_Object
);
4004 extern void init_fileio (void);
4005 extern void syms_of_fileio (void);
4006 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
4008 /* Defined in search.c. */
4009 extern void shrink_regexp_cache (void);
4010 extern void restore_search_regs (void);
4011 extern void update_search_regs (ptrdiff_t oldstart
,
4012 ptrdiff_t oldend
, ptrdiff_t newend
);
4013 extern void record_unwind_save_match_data (void);
4014 struct re_registers
;
4015 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4016 struct re_registers
*,
4017 Lisp_Object
, bool, bool);
4018 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
4022 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
4024 return fast_string_match_internal (regexp
, string
, Qnil
);
4028 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
4030 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
4033 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4035 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4036 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4037 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4038 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4039 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4041 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
4042 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4043 ptrdiff_t, ptrdiff_t *);
4044 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4045 ptrdiff_t, ptrdiff_t *);
4046 extern void syms_of_search (void);
4047 extern void clear_regexp_cache (void);
4049 /* Defined in minibuf.c. */
4051 extern Lisp_Object Vminibuffer_list
;
4052 extern Lisp_Object last_minibuf_string
;
4053 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4054 extern void init_minibuf_once (void);
4055 extern void syms_of_minibuf (void);
4057 /* Defined in callint.c. */
4059 extern void syms_of_callint (void);
4061 /* Defined in casefiddle.c. */
4063 extern void syms_of_casefiddle (void);
4064 extern void keys_of_casefiddle (void);
4066 /* Defined in casetab.c. */
4068 extern void init_casetab_once (void);
4069 extern void syms_of_casetab (void);
4071 /* Defined in keyboard.c. */
4073 extern Lisp_Object echo_message_buffer
;
4074 extern struct kboard
*echo_kboard
;
4075 extern void cancel_echoing (void);
4076 extern bool input_pending
;
4077 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4078 extern sigjmp_buf return_to_command_loop
;
4080 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4081 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4082 extern void discard_mouse_events (void);
4084 void handle_input_available_signal (int);
4086 extern Lisp_Object pending_funcalls
;
4087 extern bool detect_input_pending (void);
4088 extern bool detect_input_pending_ignore_squeezables (void);
4089 extern bool detect_input_pending_run_timers (bool);
4090 extern void safe_run_hooks (Lisp_Object
);
4091 extern void cmd_error_internal (Lisp_Object
, const char *);
4092 extern Lisp_Object
command_loop_1 (void);
4093 extern Lisp_Object
read_menu_command (void);
4094 extern Lisp_Object
recursive_edit_1 (void);
4095 extern void record_auto_save (void);
4096 extern void force_auto_save_soon (void);
4097 extern void init_keyboard (void);
4098 extern void syms_of_keyboard (void);
4099 extern void keys_of_keyboard (void);
4101 /* Defined in indent.c. */
4102 extern ptrdiff_t current_column (void);
4103 extern void invalidate_current_column (void);
4104 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4105 extern void syms_of_indent (void);
4107 /* Defined in frame.c. */
4108 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4109 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4110 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4111 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4112 extern void frames_discard_buffer (Lisp_Object
);
4113 extern void syms_of_frame (void);
4115 /* Defined in emacs.c. */
4116 extern char **initial_argv
;
4117 extern int initial_argc
;
4118 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4119 extern bool display_arg
;
4121 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4122 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4123 extern _Noreturn
void terminate_due_to_signal (int, int);
4125 extern Lisp_Object Vlibrary_cache
;
4128 void fixup_locale (void);
4129 void synchronize_system_messages_locale (void);
4130 void synchronize_system_time_locale (void);
4132 INLINE
void fixup_locale (void) {}
4133 INLINE
void synchronize_system_messages_locale (void) {}
4134 INLINE
void synchronize_system_time_locale (void) {}
4136 extern char *emacs_strerror (int);
4137 extern void shut_down_emacs (int, Lisp_Object
);
4139 /* True means don't do interactive redisplay and don't change tty modes. */
4140 extern bool noninteractive
;
4142 /* True means remove site-lisp directories from load-path. */
4143 extern bool no_site_lisp
;
4145 /* True means put details like time stamps into builds. */
4146 extern bool build_details
;
4148 /* Pipe used to send exit notification to the daemon parent at
4149 startup. On Windows, we use a kernel event instead. */
4151 extern int daemon_pipe
[2];
4152 #define IS_DAEMON (daemon_pipe[1] != 0)
4153 #define DAEMON_RUNNING (daemon_pipe[1] >= 0)
4154 #else /* WINDOWSNT */
4155 extern void *w32_daemon_event
;
4156 #define IS_DAEMON (w32_daemon_event != NULL)
4157 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4160 /* True if handling a fatal error already. */
4161 extern bool fatal_error_in_progress
;
4163 /* True means don't do use window-system-specific display code. */
4164 extern bool inhibit_window_system
;
4165 /* True means that a filter or a sentinel is running. */
4166 extern bool running_asynch_code
;
4168 /* Defined in process.c. */
4169 extern void kill_buffer_processes (Lisp_Object
);
4170 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4171 struct Lisp_Process
*, int);
4172 /* Max value for the first argument of wait_reading_process_output. */
4173 #if GNUC_PREREQ (3, 0, 0) && ! GNUC_PREREQ (4, 6, 0)
4174 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.0.
4175 The bug merely causes a bogus warning, but the warning is annoying. */
4176 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4178 # define WAIT_READING_MAX INTMAX_MAX
4181 extern void add_timer_wait_descriptor (int);
4183 extern void add_keyboard_wait_descriptor (int);
4184 extern void delete_keyboard_wait_descriptor (int);
4186 extern void add_gpm_wait_descriptor (int);
4187 extern void delete_gpm_wait_descriptor (int);
4189 extern void init_process_emacs (int);
4190 extern void syms_of_process (void);
4191 extern void setup_process_coding_systems (Lisp_Object
);
4193 /* Defined in callproc.c. */
4197 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4198 extern void init_callproc_1 (void);
4199 extern void init_callproc (void);
4200 extern void set_initial_environment (void);
4201 extern void syms_of_callproc (void);
4203 /* Defined in doc.c. */
4204 enum text_quoting_style
4206 /* Use curved single quotes ‘like this’. */
4207 CURVE_QUOTING_STYLE
,
4209 /* Use grave accent and apostrophe `like this'. */
4210 GRAVE_QUOTING_STYLE
,
4212 /* Use apostrophes 'like this'. */
4213 STRAIGHT_QUOTING_STYLE
4215 extern enum text_quoting_style
text_quoting_style (void);
4216 extern Lisp_Object
read_doc_string (Lisp_Object
);
4217 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4218 extern void syms_of_doc (void);
4219 extern int read_bytecode_char (bool);
4221 /* Defined in bytecode.c. */
4222 extern void syms_of_bytecode (void);
4223 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4224 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4225 extern Lisp_Object
get_byte_code_arity (Lisp_Object
);
4227 /* Defined in macros.c. */
4228 extern void init_macros (void);
4229 extern void syms_of_macros (void);
4231 /* Defined in undo.c. */
4232 extern void truncate_undo_list (struct buffer
*);
4233 extern void record_insert (ptrdiff_t, ptrdiff_t);
4234 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4235 extern void record_first_change (void);
4236 extern void record_change (ptrdiff_t, ptrdiff_t);
4237 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4238 Lisp_Object
, Lisp_Object
,
4240 extern void syms_of_undo (void);
4242 /* Defined in textprop.c. */
4243 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4245 /* Defined in menu.c. */
4246 extern void syms_of_menu (void);
4248 /* Defined in xmenu.c. */
4249 extern void syms_of_xmenu (void);
4251 /* Defined in termchar.h. */
4252 struct tty_display_info
;
4254 /* Defined in termhooks.h. */
4257 /* Defined in sysdep.c. */
4258 #ifdef HAVE_PERSONALITY_ADDR_NO_RANDOMIZE
4259 extern bool disable_address_randomization (void);
4261 INLINE
bool disable_address_randomization (void) { return false; }
4263 extern int emacs_exec_file (char const *, char *const *, char *const *);
4264 extern void init_standard_fds (void);
4265 extern char *emacs_get_current_dir_name (void);
4266 extern void stuff_char (char c
);
4267 extern void init_foreground_group (void);
4268 extern void sys_subshell (void);
4269 extern void sys_suspend (void);
4270 extern void discard_tty_input (void);
4271 extern void init_sys_modes (struct tty_display_info
*);
4272 extern void reset_sys_modes (struct tty_display_info
*);
4273 extern void init_all_sys_modes (void);
4274 extern void reset_all_sys_modes (void);
4275 extern void child_setup_tty (int);
4276 extern void setup_pty (int);
4277 extern int set_window_size (int, int, int);
4278 extern EMACS_INT
get_random (void);
4279 extern void seed_random (void *, ptrdiff_t);
4280 extern void init_random (void);
4281 extern void emacs_backtrace (int);
4282 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4283 extern int emacs_open (const char *, int, int);
4284 extern int emacs_pipe (int[2]);
4285 extern int emacs_close (int);
4286 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4287 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4288 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4289 extern void emacs_perror (char const *);
4291 extern void unlock_all_files (void);
4292 extern void lock_file (Lisp_Object
);
4293 extern void unlock_file (Lisp_Object
);
4294 extern void unlock_buffer (struct buffer
*);
4295 extern void syms_of_filelock (void);
4296 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4298 /* Defined in sound.c. */
4299 extern void syms_of_sound (void);
4301 /* Defined in category.c. */
4302 extern void init_category_once (void);
4303 extern Lisp_Object
char_category_set (int);
4304 extern void syms_of_category (void);
4306 /* Defined in ccl.c. */
4307 extern void syms_of_ccl (void);
4309 /* Defined in dired.c. */
4310 extern void syms_of_dired (void);
4311 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4312 Lisp_Object
, Lisp_Object
,
4315 /* Defined in term.c. */
4316 extern int *char_ins_del_vector
;
4317 extern void syms_of_term (void);
4318 extern _Noreturn
void fatal (const char *msgid
, ...)
4319 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4321 /* Defined in terminal.c. */
4322 extern void syms_of_terminal (void);
4324 /* Defined in font.c. */
4325 extern void syms_of_font (void);
4326 extern void init_font (void);
4328 #ifdef HAVE_WINDOW_SYSTEM
4329 /* Defined in fontset.c. */
4330 extern void syms_of_fontset (void);
4333 /* Defined in inotify.c */
4335 extern void syms_of_inotify (void);
4338 /* Defined in kqueue.c */
4340 extern void globals_of_kqueue (void);
4341 extern void syms_of_kqueue (void);
4344 /* Defined in gfilenotify.c */
4345 #ifdef HAVE_GFILENOTIFY
4346 extern void globals_of_gfilenotify (void);
4347 extern void syms_of_gfilenotify (void);
4350 #ifdef HAVE_W32NOTIFY
4351 /* Defined on w32notify.c. */
4352 extern void syms_of_w32notify (void);
4355 /* Defined in xfaces.c. */
4356 extern Lisp_Object Vface_alternative_font_family_alist
;
4357 extern Lisp_Object Vface_alternative_font_registry_alist
;
4358 extern void syms_of_xfaces (void);
4360 #ifdef HAVE_X_WINDOWS
4361 /* Defined in xfns.c. */
4362 extern void syms_of_xfns (void);
4364 /* Defined in xsmfns.c. */
4365 extern void syms_of_xsmfns (void);
4367 /* Defined in xselect.c. */
4368 extern void syms_of_xselect (void);
4370 /* Defined in xterm.c. */
4371 extern void init_xterm (void);
4372 extern void syms_of_xterm (void);
4373 #endif /* HAVE_X_WINDOWS */
4375 #ifdef HAVE_WINDOW_SYSTEM
4376 /* Defined in xterm.c, nsterm.m, w32term.c. */
4377 extern char *x_get_keysym_name (int);
4378 #endif /* HAVE_WINDOW_SYSTEM */
4381 /* Defined in xml.c. */
4382 extern void syms_of_xml (void);
4383 extern void xml_cleanup_parser (void);
4387 /* Defined in decompress.c. */
4388 extern void syms_of_decompress (void);
4392 /* Defined in dbusbind.c. */
4393 void init_dbusbind (void);
4394 void syms_of_dbusbind (void);
4398 /* Defined in profiler.c. */
4399 extern bool profiler_memory_running
;
4400 extern void malloc_probe (size_t);
4401 extern void syms_of_profiler (void);
4405 /* Defined in msdos.c, w32.c. */
4406 extern char *emacs_root_dir (void);
4409 /* Defined in lastfile.c. */
4410 extern char my_edata
[];
4411 extern char my_endbss
[];
4412 extern char *my_endbss_static
;
4414 /* True means ^G can quit instantly. */
4415 extern bool immediate_quit
;
4417 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4418 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4419 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4420 extern void xfree (void *);
4421 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4422 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4423 ATTRIBUTE_ALLOC_SIZE ((2,3));
4424 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4426 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4427 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4428 extern void dupstring (char **, char const *);
4430 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4431 null byte. This is like stpcpy, except the source is a Lisp string. */
4434 lispstpcpy (char *dest
, Lisp_Object string
)
4436 ptrdiff_t len
= SBYTES (string
);
4437 memcpy (dest
, SDATA (string
), len
+ 1);
4441 extern void xputenv (const char *);
4443 extern char *egetenv_internal (const char *, ptrdiff_t);
4446 egetenv (const char *var
)
4448 /* When VAR is a string literal, strlen can be optimized away. */
4449 return egetenv_internal (var
, strlen (var
));
4452 /* Set up the name of the machine we're running on. */
4453 extern void init_system_name (void);
4455 /* Return the absolute value of X. X should be a signed integer
4456 expression without side effects, and X's absolute value should not
4457 exceed the maximum for its promoted type. This is called 'eabs'
4458 because 'abs' is reserved by the C standard. */
4459 #define eabs(x) ((x) < 0 ? -(x) : (x))
4461 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4464 #define make_fixnum_or_float(val) \
4465 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4467 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4468 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4470 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4472 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4474 #define USE_SAFE_ALLOCA \
4475 ptrdiff_t sa_avail = MAX_ALLOCA; \
4476 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4478 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4480 /* SAFE_ALLOCA allocates a simple buffer. */
4482 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4483 ? AVAIL_ALLOCA (size) \
4484 : (sa_must_free = true, record_xmalloc (size)))
4486 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4487 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4488 positive. The code is tuned for MULTIPLIER being a constant. */
4490 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4492 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4493 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4496 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4497 sa_must_free = true; \
4498 record_unwind_protect_ptr (xfree, buf); \
4502 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4504 #define SAFE_ALLOCA_STRING(ptr, string) \
4506 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4507 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4510 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4512 #define SAFE_FREE() \
4514 if (sa_must_free) { \
4515 sa_must_free = false; \
4516 unbind_to (sa_count, Qnil); \
4520 /* Set BUF to point to an allocated array of NELT Lisp_Objects,
4521 immediately followed by EXTRA spare bytes. */
4523 #define SAFE_ALLOCA_LISP_EXTRA(buf, nelt, extra) \
4525 ptrdiff_t alloca_nbytes; \
4526 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4527 || INT_ADD_WRAPV (alloca_nbytes, extra, &alloca_nbytes) \
4528 || SIZE_MAX < alloca_nbytes) \
4529 memory_full (SIZE_MAX); \
4530 else if (alloca_nbytes <= sa_avail) \
4531 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4535 (buf) = xmalloc (alloca_nbytes); \
4536 arg_ = make_save_memory (buf, nelt); \
4537 sa_must_free = true; \
4538 record_unwind_protect (free_save_value, arg_); \
4542 /* Set BUF to point to an allocated array of NELT Lisp_Objects. */
4544 #define SAFE_ALLOCA_LISP(buf, nelt) SAFE_ALLOCA_LISP_EXTRA (buf, nelt, 0)
4547 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4548 block-scoped conses and strings. These objects are not
4549 managed by the garbage collector, so they are dangerous: passing them
4550 out of their scope (e.g., to user code) results in undefined behavior.
4551 Conversely, they have better performance because GC is not involved.
4553 This feature is experimental and requires careful debugging.
4554 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4556 #if (!defined USE_STACK_LISP_OBJECTS \
4557 && defined __GNUC__ && !defined __clang__ && ! GNUC_PREREQ (4, 3, 2))
4558 /* Work around GCC bugs 36584 and 35271, which were fixed in GCC 4.3.2. */
4559 # define USE_STACK_LISP_OBJECTS false
4561 #ifndef USE_STACK_LISP_OBJECTS
4562 # define USE_STACK_LISP_OBJECTS true
4565 #ifdef GC_CHECK_STRING_BYTES
4566 enum { defined_GC_CHECK_STRING_BYTES
= true };
4568 enum { defined_GC_CHECK_STRING_BYTES
= false };
4571 /* Struct inside unions that are typically no larger and aligned enough. */
4576 double d
; intmax_t i
; void *p
;
4579 union Aligned_String
4581 struct Lisp_String s
;
4582 double d
; intmax_t i
; void *p
;
4585 /* True for stack-based cons and string implementations, respectively.
4586 Use stack-based strings only if stack-based cons also works.
4587 Otherwise, STACK_CONS would create heap-based cons cells that
4588 could point to stack-based strings, which is a no-no. */
4592 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4593 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4594 USE_STACK_STRING
= (USE_STACK_CONS
4595 && !defined_GC_CHECK_STRING_BYTES
4596 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4599 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4600 use these only in macros like AUTO_CONS that declare a local
4601 variable whose lifetime will be clear to the programmer. */
4602 #define STACK_CONS(a, b) \
4603 make_lisp_ptr (&(union Aligned_Cons) { { a, { b } } }.s, Lisp_Cons)
4604 #define AUTO_CONS_EXPR(a, b) \
4605 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4607 /* Declare NAME as an auto Lisp cons or short list if possible, a
4608 GC-based one otherwise. This is in the sense of the C keyword
4609 'auto'; i.e., the object has the lifetime of the containing block.
4610 The resulting object should not be made visible to user Lisp code. */
4612 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4613 #define AUTO_LIST1(name, a) \
4614 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4615 #define AUTO_LIST2(name, a, b) \
4616 Lisp_Object name = (USE_STACK_CONS \
4617 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4619 #define AUTO_LIST3(name, a, b, c) \
4620 Lisp_Object name = (USE_STACK_CONS \
4621 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4623 #define AUTO_LIST4(name, a, b, c, d) \
4626 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4627 STACK_CONS (d, Qnil)))) \
4628 : list4 (a, b, c, d))
4630 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4631 Take its unibyte value from the null-terminated string STR,
4632 an expression that should not have side effects.
4633 STR's value is not necessarily copied. The resulting Lisp string
4634 should not be modified or made visible to user code. */
4636 #define AUTO_STRING(name, str) \
4637 AUTO_STRING_WITH_LEN (name, str, strlen (str))
4639 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4640 Take its unibyte value from the null-terminated string STR with length LEN.
4641 STR may have side effects and may contain null bytes.
4642 STR's value is not necessarily copied. The resulting Lisp string
4643 should not be modified or made visible to user code. */
4645 #define AUTO_STRING_WITH_LEN(name, str, len) \
4646 Lisp_Object name = \
4649 ((&(union Aligned_String) \
4650 {{len, -1, 0, (unsigned char *) (str)}}.s), \
4652 : make_unibyte_string (str, len))
4654 /* Loop over all tails of a list, checking for cycles.
4655 FIXME: Make tortoise and n internal declarations.
4656 FIXME: Unroll the loop body so we don't need `n'. */
4657 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4658 for ((tortoise) = (hare) = (list), (n) = true; \
4660 (hare = XCDR (hare), (n) = !(n), \
4662 ? (EQ (hare, tortoise) \
4663 ? xsignal1 (Qcircular_list, list) \
4665 /* Move tortoise before the next iteration, in case */ \
4666 /* the next iteration does an Fsetcdr. */ \
4667 : (void) ((tortoise) = XCDR (tortoise)))))
4669 /* Do a `for' loop over alist values. */
4671 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4672 for ((list_var) = (head_var); \
4673 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4674 (list_var) = XCDR (list_var))
4676 /* Check whether it's time for GC, and run it if so. */
4681 if ((consing_since_gc
> gc_cons_threshold
4682 && consing_since_gc
> gc_relative_threshold
)
4683 || (!NILP (Vmemory_full
)
4684 && consing_since_gc
> memory_full_cons_threshold
))
4685 Fgarbage_collect ();
4689 functionp (Lisp_Object object
)
4691 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4693 object
= Findirect_function (object
, Qt
);
4695 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4697 /* Autoloaded symbols are functions, except if they load
4698 macros or keymaps. */
4700 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4701 object
= XCDR (object
);
4703 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4708 return XSUBR (object
)->max_args
!= UNEVALLED
;
4709 else if (COMPILEDP (object
))
4711 else if (CONSP (object
))
4713 Lisp_Object car
= XCAR (object
);
4714 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4722 #endif /* EMACS_LISP_H */