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/>. */
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
39 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
40 # define ID (some integer preprocessor expression of type TYPE)
41 DEFINE_GDB_SYMBOL_END (ID)
43 This hack is for the benefit of compilers that do not make macro
44 definitions or enums visible to the debugger. It's used for symbols
45 that .gdbinit needs. */
47 #define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
49 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
50 # define DEFINE_GDB_SYMBOL_END(id) = id;
52 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
53 # define DEFINE_GDB_SYMBOL_END(val) ;
56 /* The ubiquitous max and min macros. */
59 #define max(a, b) ((a) > (b) ? (a) : (b))
60 #define min(a, b) ((a) < (b) ? (a) : (b))
62 /* Number of elements in an array. */
63 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
65 /* Number of bits in a Lisp_Object tag. */
66 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
68 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
70 /* EMACS_INT - signed integer wide enough to hold an Emacs value
71 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
72 pI - printf length modifier for EMACS_INT
73 EMACS_UINT - unsigned variant of EMACS_INT */
76 # error "INTPTR_MAX misconfigured"
77 # elif INTPTR_MAX <= INT_MAX && !defined WIDE_EMACS_INT
78 typedef int EMACS_INT
;
79 typedef unsigned int EMACS_UINT
;
80 # define EMACS_INT_MAX INT_MAX
82 # elif INTPTR_MAX <= LONG_MAX && !defined WIDE_EMACS_INT
83 typedef long int EMACS_INT
;
84 typedef unsigned long EMACS_UINT
;
85 # define EMACS_INT_MAX LONG_MAX
87 # elif INTPTR_MAX <= LLONG_MAX
88 typedef long long int EMACS_INT
;
89 typedef unsigned long long int EMACS_UINT
;
90 # define EMACS_INT_MAX LLONG_MAX
93 # error "INTPTR_MAX too large"
97 /* Number of bits to put in each character in the internal representation
98 of bool vectors. This should not vary across implementations. */
99 enum { BOOL_VECTOR_BITS_PER_CHAR
=
100 #define BOOL_VECTOR_BITS_PER_CHAR 8
101 BOOL_VECTOR_BITS_PER_CHAR
104 /* An unsigned integer type representing a fixed-length bit sequence,
105 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
106 for speed, but it is unsigned char on weird platforms. */
107 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
108 typedef size_t bits_word
;
109 # define BITS_WORD_MAX SIZE_MAX
110 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
112 typedef unsigned char bits_word
;
113 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
114 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
116 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
118 /* Number of bits in some machine integer types. */
121 BITS_PER_CHAR
= CHAR_BIT
,
122 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
123 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
124 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
127 /* printmax_t and uprintmax_t are types for printing large integers.
128 These are the widest integers that are supported for printing.
129 pMd etc. are conversions for printing them.
130 On C99 hosts, there's no problem, as even the widest integers work.
131 Fall back on EMACS_INT on pre-C99 hosts. */
133 typedef intmax_t printmax_t
;
134 typedef uintmax_t uprintmax_t
;
138 typedef EMACS_INT printmax_t
;
139 typedef EMACS_UINT uprintmax_t
;
144 /* Use pD to format ptrdiff_t values, which suffice for indexes into
145 buffers and strings. Emacs never allocates objects larger than
146 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
147 In C99, pD can always be "t"; configure it here for the sake of
148 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
149 #if PTRDIFF_MAX == INT_MAX
151 #elif PTRDIFF_MAX == LONG_MAX
153 #elif PTRDIFF_MAX == LLONG_MAX
159 /* Extra internal type checking? */
161 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
162 'assume (COND)'. COND should be free of side effects, as it may or
163 may not be evaluated.
165 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
166 defined and suppress_checking is false, and does nothing otherwise.
167 Emacs dies if COND is checked and is false. The suppress_checking
168 variable is initialized to 0 in alloc.c. Set it to 1 using a
169 debugger to temporarily disable aborting on detected internal
170 inconsistencies or error conditions.
172 In some cases, a good compiler may be able to optimize away the
173 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
174 uses eassert to test STRINGP (x), but a particular use of XSTRING
175 is invoked only after testing that STRINGP (x) is true, making the
178 eassume is like eassert except that it also causes the compiler to
179 assume that COND is true afterwards, regardless of whether runtime
180 checking is enabled. This can improve performance in some cases,
181 though it can degrade performance in others. It's often suboptimal
182 for COND to call external functions or access volatile storage. */
184 #ifndef ENABLE_CHECKING
185 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
186 # define eassume(cond) assume (cond)
187 #else /* ENABLE_CHECKING */
189 extern _Noreturn
void die (const char *, const char *, int);
191 extern bool suppress_checking EXTERNALLY_VISIBLE
;
193 # define eassert(cond) \
194 (suppress_checking || (cond) \
196 : die (# cond, __FILE__, __LINE__))
197 # define eassume(cond) \
202 : die (# cond, __FILE__, __LINE__))
203 #endif /* ENABLE_CHECKING */
206 /* Use the configure flag --enable-check-lisp-object-type to make
207 Lisp_Object use a struct type instead of the default int. The flag
208 causes CHECK_LISP_OBJECT_TYPE to be defined. */
210 /***** Select the tagging scheme. *****/
211 /* The following option controls the tagging scheme:
212 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
213 always 0, and we can thus use them to hold tag bits, without
214 restricting our addressing space.
216 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
217 restricting our possible address range.
219 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
220 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
221 on the few static Lisp_Objects used: lispsym, all the defsubr, and
222 the two special buffers buffer_defaults and buffer_local_symbols. */
226 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
227 integer constant, for MSVC. */
228 #define GCALIGNMENT 8
230 /* Number of bits in a Lisp_Object value, not counting the tag. */
231 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
233 /* Number of bits in a Lisp fixnum tag. */
234 INTTYPEBITS
= GCTYPEBITS
- 1,
236 /* Number of bits in a Lisp fixnum value, not counting the tag. */
237 FIXNUM_BITS
= VALBITS
+ 1
240 #if GCALIGNMENT != 1 << GCTYPEBITS
241 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
244 /* The maximum value that can be stored in a EMACS_INT, assuming all
245 bits other than the type bits contribute to a nonnegative signed value.
246 This can be used in #if, e.g., '#if USE_LSB_TAG' below expands to an
247 expression involving VAL_MAX. */
248 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
250 /* Whether the least-significant bits of an EMACS_INT contain the tag.
251 On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
252 a. unnecessary, because the top bits of an EMACS_INT are unused, and
253 b. slower, because it typically requires extra masking.
254 So, USE_LSB_TAG is true only on hosts where it might be useful. */
255 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
256 #define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
257 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
259 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
260 # error "USE_LSB_TAG not supported on this platform; please report this." \
261 "Try 'configure --with-wide-int' to work around the problem."
265 #ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
266 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
268 # define GCALIGNED /* empty */
271 /* Some operations are so commonly executed that they are implemented
272 as macros, not functions, because otherwise runtime performance would
273 suffer too much when compiling with GCC without optimization.
274 There's no need to inline everything, just the operations that
275 would otherwise cause a serious performance problem.
277 For each such operation OP, define a macro lisp_h_OP that contains
278 the operation's implementation. That way, OP can be implemented
279 via a macro definition like this:
281 #define OP(x) lisp_h_OP (x)
283 and/or via a function definition like this:
285 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
287 without worrying about the implementations diverging, since
288 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
289 are intended to be private to this include file, and should not be
292 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
293 functions, once most developers have access to GCC 4.8 or later and
294 can use "gcc -Og" to debug. Maybe in the year 2016. See
297 Commentary for these macros can be found near their corresponding
300 #if CHECK_LISP_OBJECT_TYPE
301 # define lisp_h_XLI(o) ((o).i)
302 # define lisp_h_XIL(i) ((Lisp_Object) { i })
304 # define lisp_h_XLI(o) (o)
305 # define lisp_h_XIL(i) (i)
307 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
308 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
309 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
310 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
311 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
312 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
313 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
314 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
315 #define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
316 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
317 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
318 #define lisp_h_NILP(x) EQ (x, Qnil)
319 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
320 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
321 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
322 #define lisp_h_SYMBOL_VAL(sym) \
323 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
324 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
325 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
326 #define lisp_h_XCAR(c) XCONS (c)->car
327 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
328 #define lisp_h_XCONS(a) \
329 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
330 #define lisp_h_XHASH(a) XUINT (a)
331 #ifndef GC_CHECK_CONS_LIST
332 # define lisp_h_check_cons_list() ((void) 0)
335 # define lisp_h_make_number(n) \
336 XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
337 # define lisp_h_XFASTINT(a) XINT (a)
338 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
339 # define lisp_h_XSYMBOL(a) \
340 (eassert (SYMBOLP (a)), \
341 (struct Lisp_Symbol *) ((intptr_t) XLI (a) - Lisp_Symbol \
343 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
344 # define lisp_h_XUNTAG(a, type) \
345 __builtin_assume_aligned ((void *) (intptr_t) (XLI (a) - (type)), \
349 /* When compiling via gcc -O0, define the key operations as macros, as
350 Emacs is too slow otherwise. To disable this optimization, compile
351 with -DINLINING=false. */
352 #if (defined __NO_INLINE__ \
353 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
354 && ! (defined INLINING && ! INLINING))
355 # define DEFINE_KEY_OPS_AS_MACROS true
357 # define DEFINE_KEY_OPS_AS_MACROS false
360 #if DEFINE_KEY_OPS_AS_MACROS
361 # define XLI(o) lisp_h_XLI (o)
362 # define XIL(i) lisp_h_XIL (i)
363 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
364 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
365 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
366 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
367 # define CONSP(x) lisp_h_CONSP (x)
368 # define EQ(x, y) lisp_h_EQ (x, y)
369 # define FLOATP(x) lisp_h_FLOATP (x)
370 # define INTEGERP(x) lisp_h_INTEGERP (x)
371 # define MARKERP(x) lisp_h_MARKERP (x)
372 # define MISCP(x) lisp_h_MISCP (x)
373 # define NILP(x) lisp_h_NILP (x)
374 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
375 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
376 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
377 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
378 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
379 # define XCAR(c) lisp_h_XCAR (c)
380 # define XCDR(c) lisp_h_XCDR (c)
381 # define XCONS(a) lisp_h_XCONS (a)
382 # define XHASH(a) lisp_h_XHASH (a)
383 # ifndef GC_CHECK_CONS_LIST
384 # define check_cons_list() lisp_h_check_cons_list ()
387 # define make_number(n) lisp_h_make_number (n)
388 # define XFASTINT(a) lisp_h_XFASTINT (a)
389 # define XINT(a) lisp_h_XINT (a)
390 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
391 # define XTYPE(a) lisp_h_XTYPE (a)
392 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
397 /* Define the fundamental Lisp data structures. */
399 /* This is the set of Lisp data types. If you want to define a new
400 data type, read the comments after Lisp_Fwd_Type definition
403 /* Lisp integers use 2 tags, to give them one extra bit, thus
404 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
405 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
406 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
408 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
409 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
410 vociferously about them. */
411 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
412 || (defined __SUNPRO_C && __STDC__))
413 #define ENUM_BF(TYPE) unsigned int
415 #define ENUM_BF(TYPE) enum TYPE
421 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
424 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
425 whose first member indicates the subtype. */
428 /* Integer. XINT (obj) is the integer value. */
430 Lisp_Int1
= USE_LSB_TAG
? 6 : 3,
432 /* String. XSTRING (object) points to a struct Lisp_String.
433 The length of the string, and its contents, are stored therein. */
436 /* Vector of Lisp objects, or something resembling it.
437 XVECTOR (object) points to a struct Lisp_Vector, which contains
438 the size and contents. The size field also contains the type
439 information, if it's not a real vector object. */
442 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
443 Lisp_Cons
= USE_LSB_TAG
? 3 : 6,
448 /* This is the set of data types that share a common structure.
449 The first member of the structure is a type code from this set.
450 The enum values are arbitrary, but we'll use large numbers to make it
451 more likely that we'll spot the error if a random word in memory is
452 mistakenly interpreted as a Lisp_Misc. */
455 Lisp_Misc_Free
= 0x5eab,
458 Lisp_Misc_Save_Value
,
463 /* Currently floats are not a misc type,
464 but let's define this in case we want to change that. */
466 /* This is not a type code. It is for range checking. */
470 /* These are the types of forwarding objects used in the value slot
471 of symbols for special built-in variables whose value is stored in
475 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
476 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
477 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
478 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
479 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
482 /* If you want to define a new Lisp data type, here are some
483 instructions. See the thread at
484 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
487 First, there are already a couple of Lisp types that can be used if
488 your new type does not need to be exposed to Lisp programs nor
489 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
490 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
491 is suitable for temporarily stashing away pointers and integers in
492 a Lisp object. The latter is useful for vector-like Lisp objects
493 that need to be used as part of other objects, but which are never
494 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
497 These two types don't look pretty when printed, so they are
498 unsuitable for Lisp objects that can be exposed to users.
500 To define a new data type, add one more Lisp_Misc subtype or one
501 more pseudovector subtype. Pseudovectors are more suitable for
502 objects with several slots that need to support fast random access,
503 while Lisp_Misc types are for everything else. A pseudovector object
504 provides one or more slots for Lisp objects, followed by struct
505 members that are accessible only from C. A Lisp_Misc object is a
506 wrapper for a C struct that can contain anything you like.
508 Explicit freeing is discouraged for Lisp objects in general. But if
509 you really need to exploit this, use Lisp_Misc (check free_misc in
510 alloc.c to see why). There is no way to free a vectorlike object.
512 To add a new pseudovector type, extend the pvec_type enumeration;
513 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
515 For a Lisp_Misc, you will also need to add your entry to union
516 Lisp_Misc (but make sure the first word has the same structure as
517 the others, starting with a 16-bit member of the Lisp_Misc_Type
518 enumeration and a 1-bit GC markbit) and make sure the overall size
519 of the union is not increased by your addition.
521 For a new pseudovector, it's highly desirable to limit the size
522 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
523 Otherwise you will need to change sweep_vectors (also in alloc.c).
525 Then you will need to add switch branches in print.c (in
526 print_object, to print your object, and possibly also in
527 print_preprocess) and to alloc.c, to mark your object (in
528 mark_object) and to free it (in gc_sweep). The latter is also the
529 right place to call any code specific to your data type that needs
530 to run when the object is recycled -- e.g., free any additional
531 resources allocated for it that are not Lisp objects. You can even
532 make a pointer to the function that frees the resources a slot in
533 your object -- this way, the same object could be used to represent
534 several disparate C structures. */
536 #ifdef CHECK_LISP_OBJECT_TYPE
538 typedef struct { EMACS_INT i
; } Lisp_Object
;
540 #define LISP_INITIALLY(i) {i}
542 #undef CHECK_LISP_OBJECT_TYPE
543 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
544 #else /* CHECK_LISP_OBJECT_TYPE */
546 /* If a struct type is not wanted, define Lisp_Object as just a number. */
548 typedef EMACS_INT Lisp_Object
;
549 #define LISP_INITIALLY(i) (i)
550 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
551 #endif /* CHECK_LISP_OBJECT_TYPE */
553 #define LISP_INITIALLY_ZERO LISP_INITIALLY (0)
555 /* Forward declarations. */
557 /* Defined in this file. */
559 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
560 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
561 INLINE
bool BUFFERP (Lisp_Object
);
562 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
563 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
564 INLINE
bool (CONSP
) (Lisp_Object
);
565 INLINE
bool (FLOATP
) (Lisp_Object
);
566 INLINE
bool functionp (Lisp_Object
);
567 INLINE
bool (INTEGERP
) (Lisp_Object
);
568 INLINE
bool (MARKERP
) (Lisp_Object
);
569 INLINE
bool (MISCP
) (Lisp_Object
);
570 INLINE
bool (NILP
) (Lisp_Object
);
571 INLINE
bool OVERLAYP (Lisp_Object
);
572 INLINE
bool PROCESSP (Lisp_Object
);
573 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
574 INLINE
bool SAVE_VALUEP (Lisp_Object
);
575 INLINE
bool FINALIZERP (Lisp_Object
);
578 INLINE
bool USER_PTRP (Lisp_Object
);
579 INLINE
struct Lisp_User_Ptr
*(XUSER_PTR
) (Lisp_Object
);
582 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
584 INLINE
bool STRINGP (Lisp_Object
);
585 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
586 INLINE
bool SUBRP (Lisp_Object
);
587 INLINE
bool (SYMBOLP
) (Lisp_Object
);
588 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
589 INLINE
bool WINDOWP (Lisp_Object
);
590 INLINE
bool TERMINALP (Lisp_Object
);
591 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
592 INLINE
struct Lisp_Finalizer
*XFINALIZER (Lisp_Object
);
593 INLINE
struct Lisp_Symbol
*(XSYMBOL
) (Lisp_Object
);
594 INLINE
void *(XUNTAG
) (Lisp_Object
, int);
596 /* Defined in chartab.c. */
597 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
598 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
600 /* Defined in data.c. */
601 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
602 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
604 /* Defined in emacs.c. */
605 #ifdef DOUG_LEA_MALLOC
606 extern bool might_dump
;
608 /* True means Emacs has already been initialized.
609 Used during startup to detect startup of dumped Emacs. */
610 extern bool initialized
;
612 /* Defined in floatfns.c. */
613 extern double extract_float (Lisp_Object
);
616 /* Interned state of a symbol. */
620 SYMBOL_UNINTERNED
= 0,
622 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
629 SYMBOL_LOCALIZED
= 2,
635 bool_bf gcmarkbit
: 1;
637 /* Indicates where the value can be found:
638 0 : it's a plain var, the value is in the `value' field.
639 1 : it's a varalias, the value is really in the `alias' symbol.
640 2 : it's a localized var, the value is in the `blv' object.
641 3 : it's a forwarding variable, the value is in `forward'. */
642 ENUM_BF (symbol_redirect
) redirect
: 3;
644 /* Non-zero means symbol is constant, i.e. changing its value
645 should signal an error. If the value is 3, then the var
646 can be changed, but only by `defconst'. */
647 unsigned constant
: 2;
649 /* Interned state of the symbol. This is an enumerator from
650 enum symbol_interned. */
651 unsigned interned
: 2;
653 /* True means that this variable has been explicitly declared
654 special (with `defvar' etc), and shouldn't be lexically bound. */
655 bool_bf declared_special
: 1;
657 /* True if pointed to from purespace and hence can't be GC'd. */
660 /* The symbol's name, as a Lisp string. */
663 /* Value of the symbol or Qunbound if unbound. Which alternative of the
664 union is used depends on the `redirect' field above. */
667 struct Lisp_Symbol
*alias
;
668 struct Lisp_Buffer_Local_Value
*blv
;
672 /* Function value of the symbol or Qnil if not fboundp. */
673 Lisp_Object function
;
675 /* The symbol's property list. */
678 /* Next symbol in obarray bucket, if the symbol is interned. */
679 struct Lisp_Symbol
*next
;
682 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
683 meaning as in the DEFUN macro, and is used to construct a prototype. */
684 /* We can use the same trick as in the DEFUN macro to generate the
685 appropriate prototype. */
686 #define EXFUN(fnname, maxargs) \
687 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
689 /* Note that the weird token-substitution semantics of ANSI C makes
690 this work for MANY and UNEVALLED. */
691 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
692 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
693 #define DEFUN_ARGS_0 (void)
694 #define DEFUN_ARGS_1 (Lisp_Object)
695 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
696 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
697 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
698 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
700 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
701 Lisp_Object, Lisp_Object)
702 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
703 Lisp_Object, Lisp_Object, Lisp_Object)
704 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
705 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
707 /* Yield a signed integer that contains TAG along with PTR.
709 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
710 and zero-extend otherwise (that’s a bit faster here).
711 Sign extension matters only when EMACS_INT is wider than a pointer. */
712 #define TAG_PTR(tag, ptr) \
714 ? (intptr_t) (ptr) + (tag) \
715 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
717 /* Yield an integer that contains a symbol tag along with OFFSET.
718 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
719 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
721 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
722 XLI (builtin_lisp_symbol (Qwhatever)),
723 except the former expands to an integer constant expression. */
724 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
726 /* LISPSYM_INITIALLY (Qfoo) is equivalent to Qfoo except it is
727 designed for use as an initializer, even for a constant initializer. */
728 #define LISPSYM_INITIALLY(name) LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name))
730 /* Declare extern constants for Lisp symbols. These can be helpful
731 when using a debugger like GDB, on older platforms where the debug
732 format does not represent C macros. */
733 #define DEFINE_LISP_SYMBOL(name) \
734 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
735 DEFINE_GDB_SYMBOL_END (LISPSYM_INITIALLY (name))
737 /* By default, define macros for Qt, etc., as this leads to a bit
738 better performance in the core Emacs interpreter. A plugin can
739 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
740 other Emacs instances that assign different values to Qt, etc. */
741 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
742 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
747 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
748 At the machine level, these operations are no-ops. */
751 (XLI
) (Lisp_Object o
)
753 return lisp_h_XLI (o
);
759 return lisp_h_XIL (i
);
762 /* In the size word of a vector, this bit means the vector has been marked. */
764 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
765 # define ARRAY_MARK_FLAG PTRDIFF_MIN
766 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
768 /* In the size word of a struct Lisp_Vector, this bit means it's really
769 some other vector-like object. */
770 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
771 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
772 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
774 /* In a pseudovector, the size field actually contains a word with one
775 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
776 with PVEC_TYPE_MASK to indicate the actual type. */
788 PVEC_WINDOW_CONFIGURATION
,
794 /* These should be last, check internal_equal to see why. */
798 PVEC_FONT
/* Should be last because it's used for range checking. */
803 /* For convenience, we also store the number of elements in these bits.
804 Note that this size is not necessarily the memory-footprint size, but
805 only the number of Lisp_Object fields (that need to be traced by GC).
806 The distinction is used, e.g., by Lisp_Process, which places extra
807 non-Lisp_Object fields at the end of the structure. */
808 PSEUDOVECTOR_SIZE_BITS
= 12,
809 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
811 /* To calculate the memory footprint of the pseudovector, it's useful
812 to store the size of non-Lisp area in word_size units here. */
813 PSEUDOVECTOR_REST_BITS
= 12,
814 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
815 << PSEUDOVECTOR_SIZE_BITS
),
817 /* Used to extract pseudovector subtype information. */
818 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
819 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
822 /* These functions extract various sorts of values from a Lisp_Object.
823 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
824 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
827 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
828 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
829 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
830 DEFINE_GDB_SYMBOL_END (VALMASK
)
832 /* Largest and smallest representable fixnum values. These are the C
833 values. They are macros for use in static initializers. */
834 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
835 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
840 (make_number
) (EMACS_INT n
)
842 return lisp_h_make_number (n
);
846 (XINT
) (Lisp_Object a
)
848 return lisp_h_XINT (a
);
852 (XFASTINT
) (Lisp_Object a
)
854 EMACS_INT n
= lisp_h_XFASTINT (a
);
859 INLINE
struct Lisp_Symbol
*
860 (XSYMBOL
) (Lisp_Object a
)
862 return lisp_h_XSYMBOL (a
);
865 INLINE
enum Lisp_Type
866 (XTYPE
) (Lisp_Object a
)
868 return lisp_h_XTYPE (a
);
872 (XUNTAG
) (Lisp_Object a
, int type
)
874 return lisp_h_XUNTAG (a
, type
);
877 #else /* ! USE_LSB_TAG */
879 /* Although compiled only if ! USE_LSB_TAG, the following functions
880 also work when USE_LSB_TAG; this is to aid future maintenance when
881 the lisp_h_* macros are eventually removed. */
883 /* Make a Lisp integer representing the value of the low order
886 make_number (EMACS_INT n
)
888 EMACS_INT int0
= Lisp_Int0
;
892 n
= u
<< INTTYPEBITS
;
898 n
+= (int0
<< VALBITS
);
903 /* Extract A's value as a signed integer. */
907 EMACS_INT i
= XLI (a
);
911 i
= u
<< INTTYPEBITS
;
913 return i
>> INTTYPEBITS
;
916 /* Like XINT (A), but may be faster. A must be nonnegative.
917 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
918 integers have zero-bits in their tags. */
920 XFASTINT (Lisp_Object a
)
922 EMACS_INT int0
= Lisp_Int0
;
923 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
) - (int0
<< VALBITS
);
928 /* Extract A's type. */
929 INLINE
enum Lisp_Type
930 XTYPE (Lisp_Object a
)
932 EMACS_UINT i
= XLI (a
);
933 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
936 /* Extract A's value as a symbol. */
937 INLINE
struct Lisp_Symbol
*
938 XSYMBOL (Lisp_Object a
)
940 eassert (SYMBOLP (a
));
941 intptr_t i
= (intptr_t) XUNTAG (a
, Lisp_Symbol
);
942 void *p
= (char *) lispsym
+ i
;
946 /* Extract A's pointer value, assuming A's type is TYPE. */
948 XUNTAG (Lisp_Object a
, int type
)
950 intptr_t i
= USE_LSB_TAG
? XLI (a
) - type
: XLI (a
) & VALMASK
;
954 #endif /* ! USE_LSB_TAG */
956 /* Extract A's value as an unsigned integer. */
958 XUINT (Lisp_Object a
)
960 EMACS_UINT i
= XLI (a
);
961 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
964 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
965 right now, but XUINT should only be applied to objects we know are
969 (XHASH
) (Lisp_Object a
)
971 return lisp_h_XHASH (a
);
974 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
976 make_natnum (EMACS_INT n
)
978 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
979 EMACS_INT int0
= Lisp_Int0
;
980 return USE_LSB_TAG
? make_number (n
) : XIL (n
+ (int0
<< VALBITS
));
983 /* Return true if X and Y are the same object. */
986 (EQ
) (Lisp_Object x
, Lisp_Object y
)
988 return lisp_h_EQ (x
, y
);
991 /* Value is true if I doesn't fit into a Lisp fixnum. It is
992 written this way so that it also works if I is of unsigned
993 type or if I is a NaN. */
995 #define FIXNUM_OVERFLOW_P(i) \
996 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
999 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
1001 return num
< lower
? lower
: num
<= upper
? num
: upper
;
1005 /* Extract a value or address from a Lisp_Object. */
1007 INLINE
struct Lisp_Cons
*
1008 (XCONS
) (Lisp_Object a
)
1010 return lisp_h_XCONS (a
);
1013 INLINE
struct Lisp_Vector
*
1014 XVECTOR (Lisp_Object a
)
1016 eassert (VECTORLIKEP (a
));
1017 return XUNTAG (a
, Lisp_Vectorlike
);
1020 INLINE
struct Lisp_String
*
1021 XSTRING (Lisp_Object a
)
1023 eassert (STRINGP (a
));
1024 return XUNTAG (a
, Lisp_String
);
1027 /* The index of the C-defined Lisp symbol SYM.
1028 This can be used in a static initializer. */
1029 #define SYMBOL_INDEX(sym) i##sym
1031 INLINE
struct Lisp_Float
*
1032 XFLOAT (Lisp_Object a
)
1034 eassert (FLOATP (a
));
1035 return XUNTAG (a
, Lisp_Float
);
1038 /* Pseudovector types. */
1040 INLINE
struct Lisp_Process
*
1041 XPROCESS (Lisp_Object a
)
1043 eassert (PROCESSP (a
));
1044 return XUNTAG (a
, Lisp_Vectorlike
);
1047 INLINE
struct window
*
1048 XWINDOW (Lisp_Object a
)
1050 eassert (WINDOWP (a
));
1051 return XUNTAG (a
, Lisp_Vectorlike
);
1054 INLINE
struct terminal
*
1055 XTERMINAL (Lisp_Object a
)
1057 eassert (TERMINALP (a
));
1058 return XUNTAG (a
, Lisp_Vectorlike
);
1061 INLINE
struct Lisp_Subr
*
1062 XSUBR (Lisp_Object a
)
1064 eassert (SUBRP (a
));
1065 return XUNTAG (a
, Lisp_Vectorlike
);
1068 INLINE
struct buffer
*
1069 XBUFFER (Lisp_Object a
)
1071 eassert (BUFFERP (a
));
1072 return XUNTAG (a
, Lisp_Vectorlike
);
1075 INLINE
struct Lisp_Char_Table
*
1076 XCHAR_TABLE (Lisp_Object a
)
1078 eassert (CHAR_TABLE_P (a
));
1079 return XUNTAG (a
, Lisp_Vectorlike
);
1082 INLINE
struct Lisp_Sub_Char_Table
*
1083 XSUB_CHAR_TABLE (Lisp_Object a
)
1085 eassert (SUB_CHAR_TABLE_P (a
));
1086 return XUNTAG (a
, Lisp_Vectorlike
);
1089 INLINE
struct Lisp_Bool_Vector
*
1090 XBOOL_VECTOR (Lisp_Object a
)
1092 eassert (BOOL_VECTOR_P (a
));
1093 return XUNTAG (a
, Lisp_Vectorlike
);
1096 /* Construct a Lisp_Object from a value or address. */
1099 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
1101 Lisp_Object a
= XIL (TAG_PTR (type
, ptr
));
1102 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
1107 make_lisp_symbol (struct Lisp_Symbol
*sym
)
1109 Lisp_Object a
= XIL (TAG_SYMOFFSET ((char *) sym
- (char *) lispsym
));
1110 eassert (XSYMBOL (a
) == sym
);
1115 builtin_lisp_symbol (int index
)
1117 return make_lisp_symbol (lispsym
+ index
);
1120 #define XSETINT(a, b) ((a) = make_number (b))
1121 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1122 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1123 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1124 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1125 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1126 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1127 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1129 /* Pseudovector types. */
1131 #define XSETPVECTYPE(v, code) \
1132 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1133 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1134 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1135 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1136 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1139 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1140 #define XSETPSEUDOVECTOR(a, b, code) \
1141 XSETTYPED_PSEUDOVECTOR (a, b, \
1142 (((struct vectorlike_header *) \
1143 XUNTAG (a, Lisp_Vectorlike)) \
1146 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1147 (XSETVECTOR (a, b), \
1148 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1149 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1151 #define XSETWINDOW_CONFIGURATION(a, b) \
1152 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1153 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1154 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1155 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1156 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1157 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1158 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1159 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1160 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1161 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1163 /* Efficiently convert a pointer to a Lisp object and back. The
1164 pointer is represented as a Lisp integer, so the garbage collector
1165 does not know about it. The pointer should not have both Lisp_Int1
1166 bits set, which makes this conversion inherently unportable. */
1169 XINTPTR (Lisp_Object a
)
1171 return XUNTAG (a
, Lisp_Int0
);
1175 make_pointer_integer (void *p
)
1177 Lisp_Object a
= XIL (TAG_PTR (Lisp_Int0
, p
));
1178 eassert (INTEGERP (a
) && XINTPTR (a
) == p
);
1182 /* Type checking. */
1185 (CHECK_TYPE
) (int ok
, Lisp_Object predicate
, Lisp_Object x
)
1187 lisp_h_CHECK_TYPE (ok
, predicate
, x
);
1190 /* See the macros in intervals.h. */
1192 typedef struct interval
*INTERVAL
;
1194 struct GCALIGNED Lisp_Cons
1196 /* Car of this cons cell. */
1201 /* Cdr of this cons cell. */
1204 /* Used to chain conses on a free list. */
1205 struct Lisp_Cons
*chain
;
1209 /* Take the car or cdr of something known to be a cons cell. */
1210 /* The _addr functions shouldn't be used outside of the minimal set
1211 of code that has to know what a cons cell looks like. Other code not
1212 part of the basic lisp implementation should assume that the car and cdr
1213 fields are not accessible. (What if we want to switch to
1214 a copying collector someday? Cached cons cell field addresses may be
1215 invalidated at arbitrary points.) */
1216 INLINE Lisp_Object
*
1217 xcar_addr (Lisp_Object c
)
1219 return &XCONS (c
)->car
;
1221 INLINE Lisp_Object
*
1222 xcdr_addr (Lisp_Object c
)
1224 return &XCONS (c
)->u
.cdr
;
1227 /* Use these from normal code. */
1230 (XCAR
) (Lisp_Object c
)
1232 return lisp_h_XCAR (c
);
1236 (XCDR
) (Lisp_Object c
)
1238 return lisp_h_XCDR (c
);
1241 /* Use these to set the fields of a cons cell.
1243 Note that both arguments may refer to the same object, so 'n'
1244 should not be read after 'c' is first modified. */
1246 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1251 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1256 /* Take the car or cdr of something whose type is not known. */
1260 return (CONSP (c
) ? XCAR (c
)
1262 : wrong_type_argument (Qlistp
, c
));
1267 return (CONSP (c
) ? XCDR (c
)
1269 : wrong_type_argument (Qlistp
, c
));
1272 /* Take the car or cdr of something whose type is not known. */
1274 CAR_SAFE (Lisp_Object c
)
1276 return CONSP (c
) ? XCAR (c
) : Qnil
;
1279 CDR_SAFE (Lisp_Object c
)
1281 return CONSP (c
) ? XCDR (c
) : Qnil
;
1284 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1286 struct GCALIGNED Lisp_String
1289 ptrdiff_t size_byte
;
1290 INTERVAL intervals
; /* Text properties in this string. */
1291 unsigned char *data
;
1294 /* True if STR is a multibyte string. */
1296 STRING_MULTIBYTE (Lisp_Object str
)
1298 return 0 <= XSTRING (str
)->size_byte
;
1301 /* An upper bound on the number of bytes in a Lisp string, not
1302 counting the terminating null. This a tight enough bound to
1303 prevent integer overflow errors that would otherwise occur during
1304 string size calculations. A string cannot contain more bytes than
1305 a fixnum can represent, nor can it be so long that C pointer
1306 arithmetic stops working on the string plus its terminating null.
1307 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1308 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1309 would expose alloc.c internal details that we'd rather keep
1312 This is a macro for use in static initializers. The cast to
1313 ptrdiff_t ensures that the macro is signed. */
1314 #define STRING_BYTES_BOUND \
1315 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1317 /* Mark STR as a unibyte string. */
1318 #define STRING_SET_UNIBYTE(STR) \
1320 if (XSTRING (STR)->size == 0) \
1321 (STR) = empty_unibyte_string; \
1323 XSTRING (STR)->size_byte = -1; \
1326 /* Mark STR as a multibyte string. Assure that STR contains only
1327 ASCII characters in advance. */
1328 #define STRING_SET_MULTIBYTE(STR) \
1330 if (XSTRING (STR)->size == 0) \
1331 (STR) = empty_multibyte_string; \
1333 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1336 /* Convenience functions for dealing with Lisp strings. */
1338 INLINE
unsigned char *
1339 SDATA (Lisp_Object string
)
1341 return XSTRING (string
)->data
;
1344 SSDATA (Lisp_Object string
)
1346 /* Avoid "differ in sign" warnings. */
1347 return (char *) SDATA (string
);
1349 INLINE
unsigned char
1350 SREF (Lisp_Object string
, ptrdiff_t index
)
1352 return SDATA (string
)[index
];
1355 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1357 SDATA (string
)[index
] = new;
1360 SCHARS (Lisp_Object string
)
1362 return XSTRING (string
)->size
;
1365 #ifdef GC_CHECK_STRING_BYTES
1366 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1369 STRING_BYTES (struct Lisp_String
*s
)
1371 #ifdef GC_CHECK_STRING_BYTES
1372 return string_bytes (s
);
1374 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1379 SBYTES (Lisp_Object string
)
1381 return STRING_BYTES (XSTRING (string
));
1384 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1386 XSTRING (string
)->size
= newsize
;
1389 /* Header of vector-like objects. This documents the layout constraints on
1390 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1391 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1392 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1393 because when two such pointers potentially alias, a compiler won't
1394 incorrectly reorder loads and stores to their size fields. See
1396 struct vectorlike_header
1398 /* The only field contains various pieces of information:
1399 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1400 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1401 vector (0) or a pseudovector (1).
1402 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1403 of slots) of the vector.
1404 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1405 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1406 - b) number of Lisp_Objects slots at the beginning of the object
1407 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1409 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1410 measured in word_size units. Rest fields may also include
1411 Lisp_Objects, but these objects usually needs some special treatment
1413 There are some exceptions. For PVEC_FREE, b) is always zero. For
1414 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1415 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1416 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1420 /* A regular vector is just a header plus an array of Lisp_Objects. */
1424 struct vectorlike_header header
;
1425 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1428 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1431 ALIGNOF_STRUCT_LISP_VECTOR
1432 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1435 /* A boolvector is a kind of vectorlike, with contents like a string. */
1437 struct Lisp_Bool_Vector
1439 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1440 just the subtype information. */
1441 struct vectorlike_header header
;
1442 /* This is the size in bits. */
1444 /* The actual bits, packed into bytes.
1445 Zeros fill out the last word if needed.
1446 The bits are in little-endian order in the bytes, and
1447 the bytes are in little-endian order in the words. */
1448 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1452 bool_vector_size (Lisp_Object a
)
1454 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1455 eassume (0 <= size
);
1460 bool_vector_data (Lisp_Object a
)
1462 return XBOOL_VECTOR (a
)->data
;
1465 INLINE
unsigned char *
1466 bool_vector_uchar_data (Lisp_Object a
)
1468 return (unsigned char *) bool_vector_data (a
);
1471 /* The number of data words and bytes in a bool vector with SIZE bits. */
1474 bool_vector_words (EMACS_INT size
)
1476 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1477 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1481 bool_vector_bytes (EMACS_INT size
)
1483 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1484 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1487 /* True if A's Ith bit is set. */
1490 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1492 eassume (0 <= i
&& i
< bool_vector_size (a
));
1493 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1494 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1498 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1500 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1503 /* Set A's Ith bit to B. */
1506 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1508 unsigned char *addr
;
1510 eassume (0 <= i
&& i
< bool_vector_size (a
));
1511 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1514 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1516 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1519 /* Some handy constants for calculating sizes
1520 and offsets, mostly of vectorlike objects. */
1524 header_size
= offsetof (struct Lisp_Vector
, contents
),
1525 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1526 word_size
= sizeof (Lisp_Object
)
1529 /* Conveniences for dealing with Lisp arrays. */
1532 AREF (Lisp_Object array
, ptrdiff_t idx
)
1534 return XVECTOR (array
)->contents
[idx
];
1537 INLINE Lisp_Object
*
1538 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1540 return & XVECTOR (array
)->contents
[idx
];
1544 ASIZE (Lisp_Object array
)
1546 ptrdiff_t size
= XVECTOR (array
)->header
.size
;
1547 eassume (0 <= size
);
1552 gc_asize (Lisp_Object array
)
1554 /* Like ASIZE, but also can be used in the garbage collector. */
1555 return XVECTOR (array
)->header
.size
& ~ARRAY_MARK_FLAG
;
1559 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1561 eassert (0 <= idx
&& idx
< ASIZE (array
));
1562 XVECTOR (array
)->contents
[idx
] = val
;
1566 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1568 /* Like ASET, but also can be used in the garbage collector:
1569 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1570 eassert (0 <= idx
&& idx
< gc_asize (array
));
1571 XVECTOR (array
)->contents
[idx
] = val
;
1574 /* True, since Qnil's representation is zero. Every place in the code
1575 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1576 to find such assumptions later if we change Qnil to be nonzero. */
1577 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1579 /* Clear the object addressed by P, with size NBYTES, so that all its
1580 bytes are zero and all its Lisp values are nil. */
1582 memclear (void *p
, ptrdiff_t nbytes
)
1584 eassert (0 <= nbytes
);
1585 verify (NIL_IS_ZERO
);
1586 /* Since Qnil is zero, memset suffices. */
1587 memset (p
, 0, nbytes
);
1590 /* If a struct is made to look like a vector, this macro returns the length
1591 of the shortest vector that would hold that struct. */
1593 #define VECSIZE(type) \
1594 ((sizeof (type) - header_size + word_size - 1) / word_size)
1596 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1597 at the end and we need to compute the number of Lisp_Object fields (the
1598 ones that the GC needs to trace). */
1600 #define PSEUDOVECSIZE(type, nonlispfield) \
1601 ((offsetof (type, nonlispfield) - header_size) / word_size)
1603 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1604 should be integer expressions. This is not the same as
1605 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1606 returns true. For efficiency, prefer plain unsigned comparison if A
1607 and B's sizes both fit (after integer promotion). */
1608 #define UNSIGNED_CMP(a, op, b) \
1609 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1610 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1611 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1613 /* True iff C is an ASCII character. */
1614 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1616 /* A char-table is a kind of vectorlike, with contents are like a
1617 vector but with a few other slots. For some purposes, it makes
1618 sense to handle a char-table with type struct Lisp_Vector. An
1619 element of a char table can be any Lisp objects, but if it is a sub
1620 char-table, we treat it a table that contains information of a
1621 specific range of characters. A sub char-table is like a vector but
1622 with two integer fields between the header and Lisp data, which means
1623 that it has to be marked with some precautions (see mark_char_table
1624 in alloc.c). A sub char-table appears only in an element of a char-table,
1625 and there's no way to access it directly from Emacs Lisp program. */
1627 enum CHARTAB_SIZE_BITS
1629 CHARTAB_SIZE_BITS_0
= 6,
1630 CHARTAB_SIZE_BITS_1
= 4,
1631 CHARTAB_SIZE_BITS_2
= 5,
1632 CHARTAB_SIZE_BITS_3
= 7
1635 extern const int chartab_size
[4];
1637 struct Lisp_Char_Table
1639 /* HEADER.SIZE is the vector's size field, which also holds the
1640 pseudovector type information. It holds the size, too.
1641 The size counts the defalt, parent, purpose, ascii,
1642 contents, and extras slots. */
1643 struct vectorlike_header header
;
1645 /* This holds a default value,
1646 which is used whenever the value for a specific character is nil. */
1649 /* This points to another char table, which we inherit from when the
1650 value for a specific character is nil. The `defalt' slot takes
1651 precedence over this. */
1654 /* This is a symbol which says what kind of use this char-table is
1656 Lisp_Object purpose
;
1658 /* The bottom sub char-table for characters of the range 0..127. It
1659 is nil if none of ASCII character has a specific value. */
1662 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1664 /* These hold additional data. It is a vector. */
1665 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1668 struct Lisp_Sub_Char_Table
1670 /* HEADER.SIZE is the vector's size field, which also holds the
1671 pseudovector type information. It holds the size, too. */
1672 struct vectorlike_header header
;
1674 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1675 char-table of depth 1 contains 16 elements, and each element
1676 covers 4096 (128*32) characters. A sub char-table of depth 2
1677 contains 32 elements, and each element covers 128 characters. A
1678 sub char-table of depth 3 contains 128 elements, and each element
1679 is for one character. */
1682 /* Minimum character covered by the sub char-table. */
1685 /* Use set_sub_char_table_contents to set this. */
1686 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1690 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1692 struct Lisp_Char_Table
*tbl
= NULL
;
1696 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1697 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1698 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1702 while (NILP (val
) && ! NILP (tbl
->parent
));
1707 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1708 characters. Do not check validity of CT. */
1710 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1712 return (ASCII_CHAR_P (idx
)
1713 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1714 : char_table_ref (ct
, idx
));
1717 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1718 8-bit European characters. Do not check validity of CT. */
1720 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1722 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1723 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1725 char_table_set (ct
, idx
, val
);
1728 /* This structure describes a built-in function.
1729 It is generated by the DEFUN macro only.
1730 defsubr makes it into a Lisp object. */
1734 struct vectorlike_header header
;
1736 Lisp_Object (*a0
) (void);
1737 Lisp_Object (*a1
) (Lisp_Object
);
1738 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1739 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1740 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1741 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1742 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1743 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1744 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1745 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1746 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1748 short min_args
, max_args
;
1749 const char *symbol_name
;
1750 const char *intspec
;
1754 enum char_table_specials
1756 /* This is the number of slots that every char table must have. This
1757 counts the ordinary slots and the top, defalt, parent, and purpose
1759 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1761 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1762 when the latter is treated as an ordinary Lisp_Vector. */
1763 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1766 /* Return the number of "extra" slots in the char table CT. */
1769 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1771 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1772 - CHAR_TABLE_STANDARD_SLOTS
);
1775 /* Make sure that sub char-table contents slot is where we think it is. */
1776 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1777 == (offsetof (struct Lisp_Vector
, contents
)
1778 + SUB_CHAR_TABLE_OFFSET
* sizeof (Lisp_Object
)));
1780 /***********************************************************************
1782 ***********************************************************************/
1784 /* Value is name of symbol. */
1787 (SYMBOL_VAL
) (struct Lisp_Symbol
*sym
)
1789 return lisp_h_SYMBOL_VAL (sym
);
1792 INLINE
struct Lisp_Symbol
*
1793 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1795 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1796 return sym
->val
.alias
;
1798 INLINE
struct Lisp_Buffer_Local_Value
*
1799 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1801 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1802 return sym
->val
.blv
;
1804 INLINE
union Lisp_Fwd
*
1805 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1807 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1808 return sym
->val
.fwd
;
1812 (SET_SYMBOL_VAL
) (struct Lisp_Symbol
*sym
, Lisp_Object v
)
1814 lisp_h_SET_SYMBOL_VAL (sym
, v
);
1818 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1820 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1824 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1826 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1830 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1832 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1837 SYMBOL_NAME (Lisp_Object sym
)
1839 return XSYMBOL (sym
)->name
;
1842 /* Value is true if SYM is an interned symbol. */
1845 SYMBOL_INTERNED_P (Lisp_Object sym
)
1847 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1850 /* Value is true if SYM is interned in initial_obarray. */
1853 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1855 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1858 /* Value is non-zero if symbol is considered a constant, i.e. its
1859 value cannot be changed (there is an exception for keyword symbols,
1860 whose value can be set to the keyword symbol itself). */
1863 (SYMBOL_CONSTANT_P
) (Lisp_Object sym
)
1865 return lisp_h_SYMBOL_CONSTANT_P (sym
);
1868 /* Placeholder for make-docfile to process. The actual symbol
1869 definition is done by lread.c's defsym. */
1870 #define DEFSYM(sym, name) /* empty */
1873 /***********************************************************************
1875 ***********************************************************************/
1877 /* The structure of a Lisp hash table. */
1879 struct hash_table_test
1881 /* Name of the function used to compare keys. */
1884 /* User-supplied hash function, or nil. */
1885 Lisp_Object user_hash_function
;
1887 /* User-supplied key comparison function, or nil. */
1888 Lisp_Object user_cmp_function
;
1890 /* C function to compare two keys. */
1891 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1893 /* C function to compute hash code. */
1894 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1897 struct Lisp_Hash_Table
1899 /* This is for Lisp; the hash table code does not refer to it. */
1900 struct vectorlike_header header
;
1902 /* Nil if table is non-weak. Otherwise a symbol describing the
1903 weakness of the table. */
1906 /* When the table is resized, and this is an integer, compute the
1907 new size by adding this to the old size. If a float, compute the
1908 new size by multiplying the old size with this factor. */
1909 Lisp_Object rehash_size
;
1911 /* Resize hash table when number of entries/ table size is >= this
1913 Lisp_Object rehash_threshold
;
1915 /* Vector of hash codes. If hash[I] is nil, this means that the
1916 I-th entry is unused. */
1919 /* Vector used to chain entries. If entry I is free, next[I] is the
1920 entry number of the next free item. If entry I is non-free,
1921 next[I] is the index of the next entry in the collision chain. */
1924 /* Index of first free entry in free list. */
1925 Lisp_Object next_free
;
1927 /* Bucket vector. A non-nil entry is the index of the first item in
1928 a collision chain. This vector's size can be larger than the
1929 hash table size to reduce collisions. */
1932 /* Only the fields above are traced normally by the GC. The ones below
1933 `count' are special and are either ignored by the GC or traced in
1934 a special way (e.g. because of weakness). */
1936 /* Number of key/value entries in the table. */
1939 /* Vector of keys and values. The key of item I is found at index
1940 2 * I, the value is found at index 2 * I + 1.
1941 This is gc_marked specially if the table is weak. */
1942 Lisp_Object key_and_value
;
1944 /* The comparison and hash functions. */
1945 struct hash_table_test test
;
1947 /* Next weak hash table if this is a weak hash table. The head
1948 of the list is in weak_hash_tables. */
1949 struct Lisp_Hash_Table
*next_weak
;
1954 HASH_TABLE_P (Lisp_Object a
)
1956 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1959 INLINE
struct Lisp_Hash_Table
*
1960 XHASH_TABLE (Lisp_Object a
)
1962 eassert (HASH_TABLE_P (a
));
1963 return XUNTAG (a
, Lisp_Vectorlike
);
1966 #define XSET_HASH_TABLE(VAR, PTR) \
1967 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1969 /* Value is the key part of entry IDX in hash table H. */
1971 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1973 return AREF (h
->key_and_value
, 2 * idx
);
1976 /* Value is the value part of entry IDX in hash table H. */
1978 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1980 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1983 /* Value is the index of the next entry following the one at IDX
1986 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1988 return AREF (h
->next
, idx
);
1991 /* Value is the hash code computed for entry IDX in hash table H. */
1993 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1995 return AREF (h
->hash
, idx
);
1998 /* Value is the index of the element in hash table H that is the
1999 start of the collision list at index IDX in the index vector of H. */
2001 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2003 return AREF (h
->index
, idx
);
2006 /* Value is the size of hash table H. */
2008 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
2010 return ASIZE (h
->next
);
2013 /* Default size for hash tables if not specified. */
2015 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
2017 /* Default threshold specifying when to resize a hash table. The
2018 value gives the ratio of current entries in the hash table and the
2019 size of the hash table. */
2021 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
2023 /* Default factor by which to increase the size of a hash table. */
2025 static double const DEFAULT_REHASH_SIZE
= 1.5;
2027 /* Combine two integers X and Y for hashing. The result might not fit
2028 into a Lisp integer. */
2031 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
2033 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
2036 /* Hash X, returning a value that fits into a fixnum. */
2039 SXHASH_REDUCE (EMACS_UINT x
)
2041 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
2044 /* These structures are used for various misc types. */
2046 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
2048 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
2049 bool_bf gcmarkbit
: 1;
2050 unsigned spacer
: 15;
2055 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
2056 bool_bf gcmarkbit
: 1;
2057 unsigned spacer
: 13;
2058 /* This flag is temporarily used in the functions
2059 decode/encode_coding_object to record that the marker position
2060 must be adjusted after the conversion. */
2061 bool_bf need_adjustment
: 1;
2062 /* True means normal insertion at the marker's position
2063 leaves the marker after the inserted text. */
2064 bool_bf insertion_type
: 1;
2065 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2066 Note: a chain of markers can contain markers pointing into different
2067 buffers (the chain is per buffer_text rather than per buffer, so it's
2068 shared between indirect buffers). */
2069 /* This is used for (other than NULL-checking):
2071 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2072 - unchain_marker: to find the list from which to unchain.
2073 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2075 struct buffer
*buffer
;
2077 /* The remaining fields are meaningless in a marker that
2078 does not point anywhere. */
2080 /* For markers that point somewhere,
2081 this is used to chain of all the markers in a given buffer. */
2082 /* We could remove it and use an array in buffer_text instead.
2083 That would also allow us to preserve it ordered. */
2084 struct Lisp_Marker
*next
;
2085 /* This is the char position where the marker points. */
2087 /* This is the byte position.
2088 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2089 used to implement the functionality of markers, but rather to (ab)use
2090 markers as a cache for char<->byte mappings). */
2094 /* START and END are markers in the overlay's buffer, and
2095 PLIST is the overlay's property list. */
2097 /* An overlay's real data content is:
2099 - buffer (really there are two buffer pointers, one per marker,
2100 and both points to the same buffer)
2101 - insertion type of both ends (per-marker fields)
2102 - start & start byte (of start marker)
2103 - end & end byte (of end marker)
2104 - next (singly linked list of overlays)
2105 - next fields of start and end markers (singly linked list of markers).
2106 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2109 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2110 bool_bf gcmarkbit
: 1;
2111 unsigned spacer
: 15;
2112 struct Lisp_Overlay
*next
;
2118 /* Types of data which may be saved in a Lisp_Save_Value. */
2129 /* Number of bits needed to store one of the above values. */
2130 enum { SAVE_SLOT_BITS
= 3 };
2132 /* Number of slots in a save value where save_type is nonzero. */
2133 enum { SAVE_VALUE_SLOTS
= 4 };
2135 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2137 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2141 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2142 SAVE_TYPE_INT_INT_INT
2143 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2144 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2145 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2146 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2147 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2148 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2149 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2150 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2151 SAVE_TYPE_FUNCPTR_PTR_OBJ
2152 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2154 /* This has an extra bit indicating it's raw memory. */
2155 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2158 /* Special object used to hold a different values for later use.
2160 This is mostly used to package C integers and pointers to call
2161 record_unwind_protect when two or more values need to be saved.
2165 struct my_data *md = get_my_data ();
2166 ptrdiff_t mi = get_my_integer ();
2167 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2170 Lisp_Object my_unwind (Lisp_Object arg)
2172 struct my_data *md = XSAVE_POINTER (arg, 0);
2173 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2177 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2178 saved objects and raise eassert if type of the saved object doesn't match
2179 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2180 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2181 slot 0 is a pointer. */
2183 typedef void (*voidfuncptr
) (void);
2185 struct Lisp_Save_Value
2187 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2188 bool_bf gcmarkbit
: 1;
2189 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2191 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2192 V's data entries are determined by V->save_type. E.g., if
2193 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2194 V->data[1] is an integer, and V's other data entries are unused.
2196 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2197 a memory area containing V->data[1].integer potential Lisp_Objects. */
2198 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2201 voidfuncptr funcpointer
;
2204 } data
[SAVE_VALUE_SLOTS
];
2207 /* Return the type of V's Nth saved value. */
2209 save_type (struct Lisp_Save_Value
*v
, int n
)
2211 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2212 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2215 /* Get and set the Nth saved pointer. */
2218 XSAVE_POINTER (Lisp_Object obj
, int n
)
2220 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2221 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2224 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2226 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2227 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2230 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2232 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2233 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2236 /* Likewise for the saved integer. */
2239 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2241 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2242 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2245 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2247 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2248 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2251 /* Extract Nth saved object. */
2254 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2256 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2257 return XSAVE_VALUE (obj
)->data
[n
].object
;
2261 struct Lisp_User_Ptr
2263 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_User_Ptr */
2264 bool_bf gcmarkbit
: 1;
2265 unsigned spacer
: 15;
2267 void (*finalizer
) (void *);
2272 /* A finalizer sentinel. */
2273 struct Lisp_Finalizer
2275 struct Lisp_Misc_Any base
;
2277 /* Circular list of all active weak references. */
2278 struct Lisp_Finalizer
*prev
;
2279 struct Lisp_Finalizer
*next
;
2281 /* Call FUNCTION when the finalizer becomes unreachable, even if
2282 FUNCTION contains a reference to the finalizer; i.e., call
2283 FUNCTION when it is reachable _only_ through finalizers. */
2284 Lisp_Object function
;
2287 /* A miscellaneous object, when it's on the free list. */
2290 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2291 bool_bf gcmarkbit
: 1;
2292 unsigned spacer
: 15;
2293 union Lisp_Misc
*chain
;
2296 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2297 It uses one of these struct subtypes to get the type field. */
2301 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2302 struct Lisp_Free u_free
;
2303 struct Lisp_Marker u_marker
;
2304 struct Lisp_Overlay u_overlay
;
2305 struct Lisp_Save_Value u_save_value
;
2306 struct Lisp_Finalizer u_finalizer
;
2308 struct Lisp_User_Ptr u_user_ptr
;
2312 INLINE
union Lisp_Misc
*
2313 XMISC (Lisp_Object a
)
2315 return XUNTAG (a
, Lisp_Misc
);
2318 INLINE
struct Lisp_Misc_Any
*
2319 XMISCANY (Lisp_Object a
)
2321 eassert (MISCP (a
));
2322 return & XMISC (a
)->u_any
;
2325 INLINE
enum Lisp_Misc_Type
2326 XMISCTYPE (Lisp_Object a
)
2328 return XMISCANY (a
)->type
;
2331 INLINE
struct Lisp_Marker
*
2332 XMARKER (Lisp_Object a
)
2334 eassert (MARKERP (a
));
2335 return & XMISC (a
)->u_marker
;
2338 INLINE
struct Lisp_Overlay
*
2339 XOVERLAY (Lisp_Object a
)
2341 eassert (OVERLAYP (a
));
2342 return & XMISC (a
)->u_overlay
;
2345 INLINE
struct Lisp_Save_Value
*
2346 XSAVE_VALUE (Lisp_Object a
)
2348 eassert (SAVE_VALUEP (a
));
2349 return & XMISC (a
)->u_save_value
;
2352 INLINE
struct Lisp_Finalizer
*
2353 XFINALIZER (Lisp_Object a
)
2355 eassert (FINALIZERP (a
));
2356 return & XMISC (a
)->u_finalizer
;
2360 INLINE
struct Lisp_User_Ptr
*
2361 XUSER_PTR (Lisp_Object a
)
2363 eassert (USER_PTRP (a
));
2364 return & XMISC (a
)->u_user_ptr
;
2369 /* Forwarding pointer to an int variable.
2370 This is allowed only in the value cell of a symbol,
2371 and it means that the symbol's value really lives in the
2372 specified int variable. */
2375 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2379 /* Boolean forwarding pointer to an int variable.
2380 This is like Lisp_Intfwd except that the ostensible
2381 "value" of the symbol is t if the bool variable is true,
2382 nil if it is false. */
2385 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2389 /* Forwarding pointer to a Lisp_Object variable.
2390 This is allowed only in the value cell of a symbol,
2391 and it means that the symbol's value really lives in the
2392 specified variable. */
2395 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2396 Lisp_Object
*objvar
;
2399 /* Like Lisp_Objfwd except that value lives in a slot in the
2400 current buffer. Value is byte index of slot within buffer. */
2401 struct Lisp_Buffer_Objfwd
2403 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2405 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2406 Lisp_Object predicate
;
2409 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2410 the symbol has buffer-local or frame-local bindings. (Exception:
2411 some buffer-local variables are built-in, with their values stored
2412 in the buffer structure itself. They are handled differently,
2413 using struct Lisp_Buffer_Objfwd.)
2415 The `realvalue' slot holds the variable's current value, or a
2416 forwarding pointer to where that value is kept. This value is the
2417 one that corresponds to the loaded binding. To read or set the
2418 variable, you must first make sure the right binding is loaded;
2419 then you can access the value in (or through) `realvalue'.
2421 `buffer' and `frame' are the buffer and frame for which the loaded
2422 binding was found. If those have changed, to make sure the right
2423 binding is loaded it is necessary to find which binding goes with
2424 the current buffer and selected frame, then load it. To load it,
2425 first unload the previous binding, then copy the value of the new
2426 binding into `realvalue' (or through it). Also update
2427 LOADED-BINDING to point to the newly loaded binding.
2429 `local_if_set' indicates that merely setting the variable creates a
2430 local binding for the current buffer. Otherwise the latter, setting
2431 the variable does not do that; only make-local-variable does that. */
2433 struct Lisp_Buffer_Local_Value
2435 /* True means that merely setting the variable creates a local
2436 binding for the current buffer. */
2437 bool_bf local_if_set
: 1;
2438 /* True means this variable can have frame-local bindings, otherwise, it is
2439 can have buffer-local bindings. The two cannot be combined. */
2440 bool_bf frame_local
: 1;
2441 /* True means that the binding now loaded was found.
2442 Presumably equivalent to (defcell!=valcell). */
2444 /* If non-NULL, a forwarding to the C var where it should also be set. */
2445 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2446 /* The buffer or frame for which the loaded binding was found. */
2448 /* A cons cell that holds the default value. It has the form
2449 (SYMBOL . DEFAULT-VALUE). */
2450 Lisp_Object defcell
;
2451 /* The cons cell from `where's parameter alist.
2452 It always has the form (SYMBOL . VALUE)
2453 Note that if `forward' is non-nil, VALUE may be out of date.
2454 Also if the currently loaded binding is the default binding, then
2455 this is `eq'ual to defcell. */
2456 Lisp_Object valcell
;
2459 /* Like Lisp_Objfwd except that value lives in a slot in the
2461 struct Lisp_Kboard_Objfwd
2463 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2469 struct Lisp_Intfwd u_intfwd
;
2470 struct Lisp_Boolfwd u_boolfwd
;
2471 struct Lisp_Objfwd u_objfwd
;
2472 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2473 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2476 INLINE
enum Lisp_Fwd_Type
2477 XFWDTYPE (union Lisp_Fwd
*a
)
2479 return a
->u_intfwd
.type
;
2482 INLINE
struct Lisp_Buffer_Objfwd
*
2483 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2485 eassert (BUFFER_OBJFWDP (a
));
2486 return &a
->u_buffer_objfwd
;
2489 /* Lisp floating point type. */
2495 struct Lisp_Float
*chain
;
2500 XFLOAT_DATA (Lisp_Object f
)
2502 return XFLOAT (f
)->u
.data
;
2505 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2506 representations, have infinities and NaNs, and do not trap on
2507 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2508 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2509 wanted here, but is not quite right because Emacs does not require
2510 all the features of C11 Annex F (and does not require C11 at all,
2511 for that matter). */
2515 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2516 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2519 /* A character, declared with the following typedef, is a member
2520 of some character set associated with the current buffer. */
2521 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2523 typedef unsigned char UCHAR
;
2526 /* Meanings of slots in a Lisp_Compiled: */
2530 COMPILED_ARGLIST
= 0,
2531 COMPILED_BYTECODE
= 1,
2532 COMPILED_CONSTANTS
= 2,
2533 COMPILED_STACK_DEPTH
= 3,
2534 COMPILED_DOC_STRING
= 4,
2535 COMPILED_INTERACTIVE
= 5
2538 /* Flag bits in a character. These also get used in termhooks.h.
2539 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2540 (MUlti-Lingual Emacs) might need 22 bits for the character value
2541 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2544 CHAR_ALT
= 0x0400000,
2545 CHAR_SUPER
= 0x0800000,
2546 CHAR_HYPER
= 0x1000000,
2547 CHAR_SHIFT
= 0x2000000,
2548 CHAR_CTL
= 0x4000000,
2549 CHAR_META
= 0x8000000,
2551 CHAR_MODIFIER_MASK
=
2552 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2554 /* Actually, the current Emacs uses 22 bits for the character value
2559 /* Data type checking. */
2562 (NILP
) (Lisp_Object x
)
2564 return lisp_h_NILP (x
);
2568 NUMBERP (Lisp_Object x
)
2570 return INTEGERP (x
) || FLOATP (x
);
2573 NATNUMP (Lisp_Object x
)
2575 return INTEGERP (x
) && 0 <= XINT (x
);
2579 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2581 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2584 #define TYPE_RANGED_INTEGERP(type, x) \
2586 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2587 && XINT (x) <= TYPE_MAXIMUM (type))
2590 (CONSP
) (Lisp_Object x
)
2592 return lisp_h_CONSP (x
);
2595 (FLOATP
) (Lisp_Object x
)
2597 return lisp_h_FLOATP (x
);
2600 (MISCP
) (Lisp_Object x
)
2602 return lisp_h_MISCP (x
);
2605 (SYMBOLP
) (Lisp_Object x
)
2607 return lisp_h_SYMBOLP (x
);
2610 (INTEGERP
) (Lisp_Object x
)
2612 return lisp_h_INTEGERP (x
);
2615 (VECTORLIKEP
) (Lisp_Object x
)
2617 return lisp_h_VECTORLIKEP (x
);
2620 (MARKERP
) (Lisp_Object x
)
2622 return lisp_h_MARKERP (x
);
2626 STRINGP (Lisp_Object x
)
2628 return XTYPE (x
) == Lisp_String
;
2631 VECTORP (Lisp_Object x
)
2633 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2636 OVERLAYP (Lisp_Object x
)
2638 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2641 SAVE_VALUEP (Lisp_Object x
)
2643 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2647 FINALIZERP (Lisp_Object x
)
2649 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Finalizer
;
2654 USER_PTRP (Lisp_Object x
)
2656 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_User_Ptr
;
2661 AUTOLOADP (Lisp_Object x
)
2663 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2667 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2669 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2673 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2675 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2676 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2679 /* True if A is a pseudovector whose code is CODE. */
2681 PSEUDOVECTORP (Lisp_Object a
, int code
)
2683 if (! VECTORLIKEP (a
))
2687 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2688 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2689 return PSEUDOVECTOR_TYPEP (h
, code
);
2694 /* Test for specific pseudovector types. */
2697 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2699 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2703 PROCESSP (Lisp_Object a
)
2705 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2709 WINDOWP (Lisp_Object a
)
2711 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2715 TERMINALP (Lisp_Object a
)
2717 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2721 SUBRP (Lisp_Object a
)
2723 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2727 COMPILEDP (Lisp_Object a
)
2729 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2733 BUFFERP (Lisp_Object a
)
2735 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2739 CHAR_TABLE_P (Lisp_Object a
)
2741 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2745 SUB_CHAR_TABLE_P (Lisp_Object a
)
2747 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2751 BOOL_VECTOR_P (Lisp_Object a
)
2753 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2757 FRAMEP (Lisp_Object a
)
2759 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2762 /* Test for image (image . spec) */
2764 IMAGEP (Lisp_Object x
)
2766 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2771 ARRAYP (Lisp_Object x
)
2773 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2777 CHECK_LIST (Lisp_Object x
)
2779 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2783 (CHECK_LIST_CONS
) (Lisp_Object x
, Lisp_Object y
)
2785 lisp_h_CHECK_LIST_CONS (x
, y
);
2789 (CHECK_SYMBOL
) (Lisp_Object x
)
2791 lisp_h_CHECK_SYMBOL (x
);
2795 (CHECK_NUMBER
) (Lisp_Object x
)
2797 lisp_h_CHECK_NUMBER (x
);
2801 CHECK_STRING (Lisp_Object x
)
2803 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2806 CHECK_STRING_CAR (Lisp_Object x
)
2808 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2811 CHECK_CONS (Lisp_Object x
)
2813 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2816 CHECK_VECTOR (Lisp_Object x
)
2818 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2821 CHECK_BOOL_VECTOR (Lisp_Object x
)
2823 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2825 /* This is a bit special because we always need size afterwards. */
2827 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2833 wrong_type_argument (Qarrayp
, x
);
2836 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2838 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2841 CHECK_BUFFER (Lisp_Object x
)
2843 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2846 CHECK_WINDOW (Lisp_Object x
)
2848 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2852 CHECK_PROCESS (Lisp_Object x
)
2854 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2858 CHECK_NATNUM (Lisp_Object x
)
2860 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2863 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2866 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2867 args_out_of_range_3 \
2869 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2870 ? MOST_NEGATIVE_FIXNUM \
2872 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2874 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2876 if (TYPE_SIGNED (type)) \
2877 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2879 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2882 #define CHECK_NUMBER_COERCE_MARKER(x) \
2884 if (MARKERP ((x))) \
2885 XSETFASTINT (x, marker_position (x)); \
2887 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2891 XFLOATINT (Lisp_Object n
)
2893 return extract_float (n
);
2897 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2899 CHECK_TYPE (NUMBERP (x
), Qnumberp
, x
);
2902 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2905 XSETFASTINT (x, marker_position (x)); \
2907 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2910 /* Since we can't assign directly to the CAR or CDR fields of a cons
2911 cell, use these when checking that those fields contain numbers. */
2913 CHECK_NUMBER_CAR (Lisp_Object x
)
2915 Lisp_Object tmp
= XCAR (x
);
2921 CHECK_NUMBER_CDR (Lisp_Object x
)
2923 Lisp_Object tmp
= XCDR (x
);
2928 /* Define a built-in function for calling from Lisp.
2929 `lname' should be the name to give the function in Lisp,
2930 as a null-terminated C string.
2931 `fnname' should be the name of the function in C.
2932 By convention, it starts with F.
2933 `sname' should be the name for the C constant structure
2934 that records information on this function for internal use.
2935 By convention, it should be the same as `fnname' but with S instead of F.
2936 It's too bad that C macros can't compute this from `fnname'.
2937 `minargs' should be a number, the minimum number of arguments allowed.
2938 `maxargs' should be a number, the maximum number of arguments allowed,
2939 or else MANY or UNEVALLED.
2940 MANY means pass a vector of evaluated arguments,
2941 in the form of an integer number-of-arguments
2942 followed by the address of a vector of Lisp_Objects
2943 which contains the argument values.
2944 UNEVALLED means pass the list of unevaluated arguments
2945 `intspec' says how interactive arguments are to be fetched.
2946 If the string starts with a `(', `intspec' is evaluated and the resulting
2947 list is the list of arguments.
2948 If it's a string that doesn't start with `(', the value should follow
2949 the one of the doc string for `interactive'.
2950 A null string means call interactively with no arguments.
2951 `doc' is documentation for the user. */
2953 /* This version of DEFUN declares a function prototype with the right
2954 arguments, so we can catch errors with maxargs at compile-time. */
2956 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2957 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2958 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2959 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2960 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2961 { (Lisp_Object (__cdecl *)(void))fnname }, \
2962 minargs, maxargs, lname, intspec, 0}; \
2964 #else /* not _MSC_VER */
2965 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2966 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2967 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2968 { .a ## maxargs = fnname }, \
2969 minargs, maxargs, lname, intspec, 0}; \
2973 /* True if OBJ is a Lisp function. */
2975 FUNCTIONP (Lisp_Object obj
)
2977 return functionp (obj
);
2981 is how we define the symbol for function `name' at start-up time. */
2982 extern void defsubr (struct Lisp_Subr
*);
2990 /* Call a function F that accepts many args, passing it ARRAY's elements. */
2991 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
2993 /* Call a function F that accepts many args, passing it the remaining args,
2994 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
2995 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
2996 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
2997 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
2999 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
3000 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
3001 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
3002 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
3003 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
3005 /* Macros we use to define forwarded Lisp variables.
3006 These are used in the syms_of_FILENAME functions.
3008 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
3009 lisp variable is actually a field in `struct emacs_globals'. The
3010 field's name begins with "f_", which is a convention enforced by
3011 these macros. Each such global has a corresponding #define in
3012 globals.h; the plain name should be used in the code.
3014 E.g., the global "cons_cells_consed" is declared as "int
3015 f_cons_cells_consed" in globals.h, but there is a define:
3017 #define cons_cells_consed globals.f_cons_cells_consed
3019 All C code uses the `cons_cells_consed' name. This is all done
3020 this way to support indirection for multi-threaded Emacs. */
3022 #define DEFVAR_LISP(lname, vname, doc) \
3024 static struct Lisp_Objfwd o_fwd; \
3025 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
3027 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
3029 static struct Lisp_Objfwd o_fwd; \
3030 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
3032 #define DEFVAR_BOOL(lname, vname, doc) \
3034 static struct Lisp_Boolfwd b_fwd; \
3035 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
3037 #define DEFVAR_INT(lname, vname, doc) \
3039 static struct Lisp_Intfwd i_fwd; \
3040 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
3043 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
3045 static struct Lisp_Objfwd o_fwd; \
3046 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
3049 #define DEFVAR_KBOARD(lname, vname, doc) \
3051 static struct Lisp_Kboard_Objfwd ko_fwd; \
3052 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
3055 /* Save and restore the instruction and environment pointers,
3056 without affecting the signal mask. */
3059 typedef jmp_buf sys_jmp_buf
;
3060 # define sys_setjmp(j) _setjmp (j)
3061 # define sys_longjmp(j, v) _longjmp (j, v)
3062 #elif defined HAVE_SIGSETJMP
3063 typedef sigjmp_buf sys_jmp_buf
;
3064 # define sys_setjmp(j) sigsetjmp (j, 0)
3065 # define sys_longjmp(j, v) siglongjmp (j, v)
3067 /* A platform that uses neither _longjmp nor siglongjmp; assume
3068 longjmp does not affect the sigmask. */
3069 typedef jmp_buf sys_jmp_buf
;
3070 # define sys_setjmp(j) setjmp (j)
3071 # define sys_longjmp(j, v) longjmp (j, v)
3075 /* Elisp uses several stacks:
3077 - the bytecode stack: used internally by the bytecode interpreter.
3078 Allocated from the C stack.
3079 - The specpdl stack: keeps track of active unwind-protect and
3080 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
3082 - The handler stack: keeps track of active catch tags and condition-case
3083 handlers. Allocated in a manually managed stack implemented by a
3084 doubly-linked list allocated via xmalloc and never freed. */
3086 /* Structure for recording Lisp call stack for backtrace purposes. */
3088 /* The special binding stack holds the outer values of variables while
3089 they are bound by a function application or a let form, stores the
3090 code to be executed for unwind-protect forms.
3092 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
3093 used all over the place, needs to be fast, and needs to know the size of
3094 union specbinding. But only eval.c should access it. */
3097 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
3098 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
3099 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
3100 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
3101 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
3102 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
3103 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3104 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
3105 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
3110 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3112 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3113 void (*func
) (Lisp_Object
);
3117 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3118 void (*func
) (void *);
3122 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3127 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3128 void (*func
) (void);
3131 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3132 /* `where' is not used in the case of SPECPDL_LET. */
3133 Lisp_Object symbol
, old_value
, where
;
3136 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3137 bool_bf debug_on_exit
: 1;
3138 Lisp_Object function
;
3144 extern union specbinding
*specpdl
;
3145 extern union specbinding
*specpdl_ptr
;
3146 extern ptrdiff_t specpdl_size
;
3149 SPECPDL_INDEX (void)
3151 return specpdl_ptr
- specpdl
;
3154 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3155 control structures. A struct handler contains all the information needed to
3156 restore the state of the interpreter after a non-local jump.
3158 handler structures are chained together in a doubly linked list; the `next'
3159 member points to the next outer catchtag and the `nextfree' member points in
3160 the other direction to the next inner element (which is typically the next
3161 free element since we mostly use it on the deepest handler).
3163 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3164 member is TAG, and then unbinds to it. The `val' member is used to
3165 hold VAL while the stack is unwound; `val' is returned as the value
3166 of the catch form. If there is a handler of type CATCHER_ALL, it will
3167 be treated as a handler for all invocations of `throw'; in this case
3168 `val' will be set to (TAG . VAL).
3170 All the other members are concerned with restoring the interpreter
3173 Members are volatile if their values need to survive _longjmp when
3174 a 'struct handler' is a local variable. */
3176 enum handlertype
{ CATCHER
, CONDITION_CASE
, CATCHER_ALL
};
3180 enum handlertype type
;
3181 Lisp_Object tag_or_ch
;
3183 struct handler
*next
;
3184 struct handler
*nextfree
;
3186 /* The bytecode interpreter can have several handlers active at the same
3187 time, so when we longjmp to one of them, it needs to know which handler
3188 this was and what was the corresponding internal state. This is stored
3189 here, and when we longjmp we make sure that handlerlist points to the
3191 Lisp_Object
*bytecode_top
;
3194 /* Most global vars are reset to their value via the specpdl mechanism,
3195 but a few others are handled by storing their value here. */
3197 EMACS_INT lisp_eval_depth
;
3199 int poll_suppress_count
;
3200 int interrupt_input_blocked
;
3201 struct byte_stack
*byte_stack
;
3204 extern Lisp_Object memory_signal_data
;
3206 /* An address near the bottom of the stack.
3207 Tells GC how to save a copy of the stack. */
3208 extern char *stack_bottom
;
3210 /* Check quit-flag and quit if it is non-nil.
3211 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
3212 So the program needs to do QUIT at times when it is safe to quit.
3213 Every loop that might run for a long time or might not exit
3214 ought to do QUIT at least once, at a safe place.
3215 Unless that is impossible, of course.
3216 But it is very desirable to avoid creating loops where QUIT is impossible.
3218 Exception: if you set immediate_quit to true,
3219 then the handler that responds to the C-g does the quit itself.
3220 This is a good thing to do around a loop that has no side effects
3221 and (in particular) cannot call arbitrary Lisp code.
3223 If quit-flag is set to `kill-emacs' the SIGINT handler has received
3224 a request to exit Emacs when it is safe to do. */
3226 extern void process_pending_signals (void);
3227 extern bool volatile pending_signals
;
3229 extern void process_quit_flag (void);
3232 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3233 process_quit_flag (); \
3234 else if (pending_signals) \
3235 process_pending_signals (); \
3239 /* True if ought to quit now. */
3241 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3243 extern Lisp_Object Vascii_downcase_table
;
3244 extern Lisp_Object Vascii_canon_table
;
3246 /* Call staticpro (&var) to protect static variable `var'. */
3248 void staticpro (Lisp_Object
*);
3250 /* Forward declarations for prototypes. */
3254 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3257 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3259 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3260 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3263 /* Functions to modify hash tables. */
3266 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3268 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3272 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3274 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3277 /* Use these functions to set Lisp_Object
3278 or pointer slots of struct Lisp_Symbol. */
3281 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3283 XSYMBOL (sym
)->function
= function
;
3287 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3289 XSYMBOL (sym
)->plist
= plist
;
3293 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3295 XSYMBOL (sym
)->next
= next
;
3298 /* Buffer-local (also frame-local) variable access functions. */
3301 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3303 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3307 /* Set overlay's property list. */
3310 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3312 XOVERLAY (overlay
)->plist
= plist
;
3315 /* Get text properties of S. */
3318 string_intervals (Lisp_Object s
)
3320 return XSTRING (s
)->intervals
;
3323 /* Set text properties of S to I. */
3326 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3328 XSTRING (s
)->intervals
= i
;
3331 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3332 of setting slots directly. */
3335 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3337 XCHAR_TABLE (table
)->defalt
= val
;
3340 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3342 XCHAR_TABLE (table
)->purpose
= val
;
3345 /* Set different slots in (sub)character tables. */
3348 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3350 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3351 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3355 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3357 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3358 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3362 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3364 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3367 /* Defined in data.c. */
3368 extern Lisp_Object
indirect_function (Lisp_Object
);
3369 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3370 enum Arith_Comparison
{
3375 ARITH_LESS_OR_EQUAL
,
3378 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3379 enum Arith_Comparison comparison
);
3381 /* Convert the integer I to an Emacs representation, either the integer
3382 itself, or a cons of two or three integers, or if all else fails a float.
3383 I should not have side effects. */
3384 #define INTEGER_TO_CONS(i) \
3385 (! FIXNUM_OVERFLOW_P (i) \
3387 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3388 extern Lisp_Object
intbig_to_lisp (intmax_t);
3389 extern Lisp_Object
uintbig_to_lisp (uintmax_t);
3391 /* Convert the Emacs representation CONS back to an integer of type
3392 TYPE, storing the result the variable VAR. Signal an error if CONS
3393 is not a valid representation or is out of range for TYPE. */
3394 #define CONS_TO_INTEGER(cons, type, var) \
3395 (TYPE_SIGNED (type) \
3396 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3397 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3398 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3399 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3401 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3402 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3403 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3405 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3406 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3407 extern void syms_of_data (void);
3408 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3410 /* Defined in cmds.c */
3411 extern void syms_of_cmds (void);
3412 extern void keys_of_cmds (void);
3414 /* Defined in coding.c. */
3415 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3416 ptrdiff_t, bool, bool, Lisp_Object
);
3417 extern void init_coding (void);
3418 extern void init_coding_once (void);
3419 extern void syms_of_coding (void);
3421 /* Defined in character.c. */
3422 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3423 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3424 extern void syms_of_character (void);
3426 /* Defined in charset.c. */
3427 extern void init_charset (void);
3428 extern void init_charset_once (void);
3429 extern void syms_of_charset (void);
3430 /* Structure forward declarations. */
3433 /* Defined in syntax.c. */
3434 extern void init_syntax_once (void);
3435 extern void syms_of_syntax (void);
3437 /* Defined in fns.c. */
3438 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3439 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3440 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3441 extern void sweep_weak_hash_tables (void);
3442 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3443 EMACS_UINT
sxhash (Lisp_Object
, int);
3444 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3445 Lisp_Object
, Lisp_Object
);
3446 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3447 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3449 void hash_remove_from_table (struct Lisp_Hash_Table
*, Lisp_Object
);
3450 extern struct hash_table_test
const hashtest_eq
, hashtest_eql
, hashtest_equal
;
3451 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3452 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3453 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3454 ptrdiff_t, ptrdiff_t);
3455 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3456 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3457 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3458 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3459 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3460 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3461 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3462 extern void clear_string_char_byte_cache (void);
3463 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3464 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3465 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3466 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3467 extern void syms_of_fns (void);
3469 /* Defined in floatfns.c. */
3470 extern void syms_of_floatfns (void);
3471 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3473 /* Defined in fringe.c. */
3474 extern void syms_of_fringe (void);
3475 extern void init_fringe (void);
3476 #ifdef HAVE_WINDOW_SYSTEM
3477 extern void mark_fringe_data (void);
3478 extern void init_fringe_once (void);
3479 #endif /* HAVE_WINDOW_SYSTEM */
3481 /* Defined in image.c. */
3482 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3483 extern void reset_image_types (void);
3484 extern void syms_of_image (void);
3486 /* Defined in insdel.c. */
3487 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3488 extern _Noreturn
void buffer_overflow (void);
3489 extern void make_gap (ptrdiff_t);
3490 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3491 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3492 ptrdiff_t, bool, bool);
3493 extern int count_combining_before (const unsigned char *,
3494 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3495 extern int count_combining_after (const unsigned char *,
3496 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3497 extern void insert (const char *, ptrdiff_t);
3498 extern void insert_and_inherit (const char *, ptrdiff_t);
3499 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3501 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3502 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3503 ptrdiff_t, ptrdiff_t, bool);
3504 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3505 extern void insert_char (int);
3506 extern void insert_string (const char *);
3507 extern void insert_before_markers (const char *, ptrdiff_t);
3508 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3509 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3510 ptrdiff_t, ptrdiff_t,
3512 extern void del_range (ptrdiff_t, ptrdiff_t);
3513 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3514 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3515 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3516 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3517 ptrdiff_t, ptrdiff_t, bool);
3518 extern void modify_text (ptrdiff_t, ptrdiff_t);
3519 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3520 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3521 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3522 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3523 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3524 ptrdiff_t, ptrdiff_t);
3525 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3526 ptrdiff_t, ptrdiff_t);
3527 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3528 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3529 const char *, ptrdiff_t, ptrdiff_t, bool);
3530 extern void syms_of_insdel (void);
3532 /* Defined in dispnew.c. */
3533 #if (defined PROFILING \
3534 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3535 _Noreturn
void __executable_start (void);
3537 extern Lisp_Object Vwindow_system
;
3538 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3540 /* Defined in xdisp.c. */
3541 extern bool noninteractive_need_newline
;
3542 extern Lisp_Object echo_area_buffer
[2];
3543 extern void add_to_log (char const *, ...);
3544 extern void vadd_to_log (char const *, va_list);
3545 extern void check_message_stack (void);
3546 extern void setup_echo_area_for_printing (bool);
3547 extern bool push_message (void);
3548 extern void pop_message_unwind (void);
3549 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3550 extern void restore_message (void);
3551 extern Lisp_Object
current_message (void);
3552 extern void clear_message (bool, bool);
3553 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3554 extern void message1 (const char *);
3555 extern void message1_nolog (const char *);
3556 extern void message3 (Lisp_Object
);
3557 extern void message3_nolog (Lisp_Object
);
3558 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3559 extern void message_with_string (const char *, Lisp_Object
, bool);
3560 extern void message_log_maybe_newline (void);
3561 extern void update_echo_area (void);
3562 extern void truncate_echo_area (ptrdiff_t);
3563 extern void redisplay (void);
3565 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3566 extern void syms_of_xdisp (void);
3567 extern void init_xdisp (void);
3568 extern Lisp_Object
safe_eval (Lisp_Object
);
3569 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3570 int *, int *, int *, int *, int *);
3572 /* Defined in xsettings.c. */
3573 extern void syms_of_xsettings (void);
3575 /* Defined in vm-limit.c. */
3576 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3578 /* Defined in character.c. */
3579 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3580 ptrdiff_t *, ptrdiff_t *);
3582 /* Defined in alloc.c. */
3583 extern void *my_heap_start (void);
3584 extern void check_pure_size (void);
3585 extern void free_misc (Lisp_Object
);
3586 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3587 extern void malloc_warning (const char *);
3588 extern _Noreturn
void memory_full (size_t);
3589 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3590 extern bool survives_gc_p (Lisp_Object
);
3591 extern void mark_object (Lisp_Object
);
3592 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3593 extern void refill_memory_reserve (void);
3595 extern void alloc_unexec_pre (void);
3596 extern void alloc_unexec_post (void);
3597 extern const char *pending_malloc_warning
;
3598 extern Lisp_Object zero_vector
;
3599 extern Lisp_Object
*stack_base
;
3600 extern EMACS_INT consing_since_gc
;
3601 extern EMACS_INT gc_relative_threshold
;
3602 extern EMACS_INT memory_full_cons_threshold
;
3603 extern Lisp_Object
list1 (Lisp_Object
);
3604 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3605 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3606 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3607 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3609 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3610 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3612 /* Build a frequently used 2/3/4-integer lists. */
3615 list2i (EMACS_INT x
, EMACS_INT y
)
3617 return list2 (make_number (x
), make_number (y
));
3621 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3623 return list3 (make_number (x
), make_number (y
), make_number (w
));
3627 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3629 return list4 (make_number (x
), make_number (y
),
3630 make_number (w
), make_number (h
));
3633 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3634 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3635 extern _Noreturn
void string_overflow (void);
3636 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3637 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3638 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3639 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3641 /* Make unibyte string from C string when the length isn't known. */
3644 build_unibyte_string (const char *str
)
3646 return make_unibyte_string (str
, strlen (str
));
3649 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3650 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3651 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3652 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3653 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3654 extern Lisp_Object
make_specified_string (const char *,
3655 ptrdiff_t, ptrdiff_t, bool);
3656 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3657 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3659 /* Make a string allocated in pure space, use STR as string data. */
3662 build_pure_c_string (const char *str
)
3664 return make_pure_c_string (str
, strlen (str
));
3667 /* Make a string from the data at STR, treating it as multibyte if the
3671 build_string (const char *str
)
3673 return make_string (str
, strlen (str
));
3676 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3677 extern void make_byte_code (struct Lisp_Vector
*);
3678 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3680 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3681 be sure that GC cannot happen until the vector is completely
3682 initialized. E.g. the following code is likely to crash:
3684 v = make_uninit_vector (3);
3686 ASET (v, 1, Ffunction_can_gc ());
3687 ASET (v, 2, obj1); */
3690 make_uninit_vector (ptrdiff_t size
)
3693 struct Lisp_Vector
*p
;
3695 p
= allocate_vector (size
);
3700 /* Like above, but special for sub char-tables. */
3703 make_uninit_sub_char_table (int depth
, int min_char
)
3705 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3706 Lisp_Object v
= make_uninit_vector (slots
);
3708 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3709 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3710 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3714 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3717 /* Allocate partially initialized pseudovector where all Lisp_Object
3718 slots are set to Qnil but the rest (if any) is left uninitialized. */
3720 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3721 ((type *) allocate_pseudovector (VECSIZE (type), \
3722 PSEUDOVECSIZE (type, field), \
3723 PSEUDOVECSIZE (type, field), tag))
3725 /* Allocate fully initialized pseudovector where all Lisp_Object
3726 slots are set to Qnil and the rest (if any) is zeroed. */
3728 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3729 ((type *) allocate_pseudovector (VECSIZE (type), \
3730 PSEUDOVECSIZE (type, field), \
3731 VECSIZE (type), tag))
3733 extern bool gc_in_progress
;
3734 extern bool abort_on_gc
;
3735 extern Lisp_Object
make_float (double);
3736 extern void display_malloc_warning (void);
3737 extern ptrdiff_t inhibit_garbage_collection (void);
3738 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3739 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3740 Lisp_Object
, Lisp_Object
);
3741 extern Lisp_Object
make_save_ptr (void *);
3742 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3743 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3744 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3746 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3747 extern void free_save_value (Lisp_Object
);
3748 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3749 extern void free_marker (Lisp_Object
);
3750 extern void free_cons (struct Lisp_Cons
*);
3751 extern void init_alloc_once (void);
3752 extern void init_alloc (void);
3753 extern void syms_of_alloc (void);
3754 extern struct buffer
* allocate_buffer (void);
3755 extern int valid_lisp_object_p (Lisp_Object
);
3756 #ifdef GC_CHECK_CONS_LIST
3757 extern void check_cons_list (void);
3759 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3762 /* Defined in gmalloc.c. */
3763 #if !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC && !defined SYSTEM_MALLOC
3764 extern size_t __malloc_extra_blocks
;
3766 #if !HAVE_DECL_ALIGNED_ALLOC
3767 extern void *aligned_alloc (size_t, size_t) ATTRIBUTE_MALLOC_SIZE ((2));
3769 extern void malloc_enable_thread (void);
3772 /* Defined in ralloc.c. */
3773 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3774 extern void r_alloc_free (void **);
3775 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3776 extern void r_alloc_reset_variable (void **, void **);
3777 extern void r_alloc_inhibit_buffer_relocation (int);
3780 /* Defined in chartab.c. */
3781 extern Lisp_Object
copy_char_table (Lisp_Object
);
3782 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3784 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3785 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3787 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3788 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3789 Lisp_Object
, Lisp_Object
,
3790 Lisp_Object
, struct charset
*,
3791 unsigned, unsigned);
3792 extern Lisp_Object
uniprop_table (Lisp_Object
);
3793 extern void syms_of_chartab (void);
3795 /* Defined in print.c. */
3796 extern Lisp_Object Vprin1_to_string_buffer
;
3797 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3798 extern void temp_output_buffer_setup (const char *);
3799 extern int print_level
;
3800 extern void write_string (const char *);
3801 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3803 extern Lisp_Object internal_with_output_to_temp_buffer
3804 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3805 #define FLOAT_TO_STRING_BUFSIZE 350
3806 extern int float_to_string (char *, double);
3807 extern void init_print_once (void);
3808 extern void syms_of_print (void);
3810 /* Defined in doprnt.c. */
3811 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3813 extern ptrdiff_t esprintf (char *, char const *, ...)
3814 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3815 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3817 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3818 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3819 char const *, va_list)
3820 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3822 /* Defined in lread.c. */
3823 extern Lisp_Object
check_obarray (Lisp_Object
);
3824 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3825 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3826 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3827 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3828 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3830 LOADHIST_ATTACH (Lisp_Object x
)
3833 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3835 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3836 Lisp_Object
*, Lisp_Object
, bool);
3837 extern Lisp_Object
string_to_number (char const *, int, bool);
3838 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3840 extern void dir_warning (const char *, Lisp_Object
);
3841 extern void init_obarray (void);
3842 extern void init_lread (void);
3843 extern void syms_of_lread (void);
3846 intern (const char *str
)
3848 return intern_1 (str
, strlen (str
));
3852 intern_c_string (const char *str
)
3854 return intern_c_string_1 (str
, strlen (str
));
3857 /* Defined in eval.c. */
3858 extern Lisp_Object Vautoload_queue
;
3859 extern Lisp_Object Vrun_hooks
;
3860 extern Lisp_Object Vsignaling_function
;
3861 extern Lisp_Object inhibit_lisp_code
;
3862 extern struct handler
*handlerlist
;
3864 /* To run a normal hook, use the appropriate function from the list below.
3865 The calling convention:
3867 if (!NILP (Vrun_hooks))
3868 call1 (Vrun_hooks, Qmy_funny_hook);
3870 should no longer be used. */
3871 extern void run_hook (Lisp_Object
);
3872 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3873 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3874 Lisp_Object (*funcall
)
3875 (ptrdiff_t nargs
, Lisp_Object
*args
));
3876 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
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 record_unwind_save_match_data (void);
4012 struct re_registers
;
4013 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4014 struct re_registers
*,
4015 Lisp_Object
, bool, bool);
4016 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
4020 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
4022 return fast_string_match_internal (regexp
, string
, Qnil
);
4026 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
4028 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
4031 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4033 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4034 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4035 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4036 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4037 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4039 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
4040 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4041 ptrdiff_t, ptrdiff_t *);
4042 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4043 ptrdiff_t, ptrdiff_t *);
4044 extern void syms_of_search (void);
4045 extern void clear_regexp_cache (void);
4047 /* Defined in minibuf.c. */
4049 extern Lisp_Object Vminibuffer_list
;
4050 extern Lisp_Object last_minibuf_string
;
4051 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4052 extern void init_minibuf_once (void);
4053 extern void syms_of_minibuf (void);
4055 /* Defined in callint.c. */
4057 extern void syms_of_callint (void);
4059 /* Defined in casefiddle.c. */
4061 extern void syms_of_casefiddle (void);
4062 extern void keys_of_casefiddle (void);
4064 /* Defined in casetab.c. */
4066 extern void init_casetab_once (void);
4067 extern void syms_of_casetab (void);
4069 /* Defined in keyboard.c. */
4071 extern Lisp_Object echo_message_buffer
;
4072 extern struct kboard
*echo_kboard
;
4073 extern void cancel_echoing (void);
4074 extern bool input_pending
;
4075 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4076 extern sigjmp_buf return_to_command_loop
;
4078 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4079 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4080 extern void discard_mouse_events (void);
4082 void handle_input_available_signal (int);
4084 extern Lisp_Object pending_funcalls
;
4085 extern bool detect_input_pending (void);
4086 extern bool detect_input_pending_ignore_squeezables (void);
4087 extern bool detect_input_pending_run_timers (bool);
4088 extern void safe_run_hooks (Lisp_Object
);
4089 extern void cmd_error_internal (Lisp_Object
, const char *);
4090 extern Lisp_Object
command_loop_1 (void);
4091 extern Lisp_Object
read_menu_command (void);
4092 extern Lisp_Object
recursive_edit_1 (void);
4093 extern void record_auto_save (void);
4094 extern void force_auto_save_soon (void);
4095 extern void init_keyboard (void);
4096 extern void syms_of_keyboard (void);
4097 extern void keys_of_keyboard (void);
4099 /* Defined in indent.c. */
4100 extern ptrdiff_t current_column (void);
4101 extern void invalidate_current_column (void);
4102 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4103 extern void syms_of_indent (void);
4105 /* Defined in frame.c. */
4106 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4107 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4108 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4109 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4110 extern void frames_discard_buffer (Lisp_Object
);
4111 extern void syms_of_frame (void);
4113 /* Defined in emacs.c. */
4114 extern char **initial_argv
;
4115 extern int initial_argc
;
4116 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4117 extern bool display_arg
;
4119 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4120 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4121 extern _Noreturn
void terminate_due_to_signal (int, int);
4123 extern Lisp_Object Vlibrary_cache
;
4126 void fixup_locale (void);
4127 void synchronize_system_messages_locale (void);
4128 void synchronize_system_time_locale (void);
4130 INLINE
void fixup_locale (void) {}
4131 INLINE
void synchronize_system_messages_locale (void) {}
4132 INLINE
void synchronize_system_time_locale (void) {}
4134 extern void shut_down_emacs (int, Lisp_Object
);
4136 /* True means don't do interactive redisplay and don't change tty modes. */
4137 extern bool noninteractive
;
4139 /* True means remove site-lisp directories from load-path. */
4140 extern bool no_site_lisp
;
4142 /* True means put details like time stamps into builds. */
4143 extern bool build_details
;
4145 /* Pipe used to send exit notification to the daemon parent at
4146 startup. On Windows, we use a kernel event instead. */
4148 extern int daemon_pipe
[2];
4149 #define IS_DAEMON (daemon_pipe[1] != 0)
4150 #define DAEMON_RUNNING (daemon_pipe[1] >= 0)
4151 #else /* WINDOWSNT */
4152 extern void *w32_daemon_event
;
4153 #define IS_DAEMON (w32_daemon_event != NULL)
4154 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4157 /* True if handling a fatal error already. */
4158 extern bool fatal_error_in_progress
;
4160 /* True means don't do use window-system-specific display code. */
4161 extern bool inhibit_window_system
;
4162 /* True means that a filter or a sentinel is running. */
4163 extern bool running_asynch_code
;
4165 /* Defined in process.c. */
4166 extern void kill_buffer_processes (Lisp_Object
);
4167 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4168 struct Lisp_Process
*, int);
4169 /* Max value for the first argument of wait_reading_process_output. */
4170 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4171 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4172 The bug merely causes a bogus warning, but the warning is annoying. */
4173 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4175 # define WAIT_READING_MAX INTMAX_MAX
4178 extern void add_timer_wait_descriptor (int);
4180 extern void add_keyboard_wait_descriptor (int);
4181 extern void delete_keyboard_wait_descriptor (int);
4183 extern void add_gpm_wait_descriptor (int);
4184 extern void delete_gpm_wait_descriptor (int);
4186 extern void init_process_emacs (int);
4187 extern void syms_of_process (void);
4188 extern void setup_process_coding_systems (Lisp_Object
);
4190 /* Defined in callproc.c. */
4194 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4195 extern void init_callproc_1 (void);
4196 extern void init_callproc (void);
4197 extern void set_initial_environment (void);
4198 extern void syms_of_callproc (void);
4200 /* Defined in doc.c. */
4201 enum text_quoting_style
4203 /* Use curved single quotes ‘like this’. */
4204 CURVE_QUOTING_STYLE
,
4206 /* Use grave accent and apostrophe `like this'. */
4207 GRAVE_QUOTING_STYLE
,
4209 /* Use apostrophes 'like this'. */
4210 STRAIGHT_QUOTING_STYLE
4212 extern enum text_quoting_style
text_quoting_style (void);
4213 extern Lisp_Object
read_doc_string (Lisp_Object
);
4214 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4215 extern void syms_of_doc (void);
4216 extern int read_bytecode_char (bool);
4218 /* Defined in bytecode.c. */
4219 extern void syms_of_bytecode (void);
4220 extern struct byte_stack
*byte_stack_list
;
4221 extern void relocate_byte_stack (void);
4222 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4223 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4224 extern Lisp_Object
get_byte_code_arity (Lisp_Object
);
4226 /* Defined in macros.c. */
4227 extern void init_macros (void);
4228 extern void syms_of_macros (void);
4230 /* Defined in undo.c. */
4231 extern void truncate_undo_list (struct buffer
*);
4232 extern void record_insert (ptrdiff_t, ptrdiff_t);
4233 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4234 extern void record_first_change (void);
4235 extern void record_change (ptrdiff_t, ptrdiff_t);
4236 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4237 Lisp_Object
, Lisp_Object
,
4239 extern void syms_of_undo (void);
4241 /* Defined in textprop.c. */
4242 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4244 /* Defined in menu.c. */
4245 extern void syms_of_menu (void);
4247 /* Defined in xmenu.c. */
4248 extern void syms_of_xmenu (void);
4250 /* Defined in termchar.h. */
4251 struct tty_display_info
;
4253 /* Defined in termhooks.h. */
4256 /* Defined in sysdep.c. */
4257 extern void init_standard_fds (void);
4258 extern char *emacs_get_current_dir_name (void);
4259 extern void stuff_char (char c
);
4260 extern void init_foreground_group (void);
4261 extern void sys_subshell (void);
4262 extern void sys_suspend (void);
4263 extern void discard_tty_input (void);
4264 extern void init_sys_modes (struct tty_display_info
*);
4265 extern void reset_sys_modes (struct tty_display_info
*);
4266 extern void init_all_sys_modes (void);
4267 extern void reset_all_sys_modes (void);
4268 extern void child_setup_tty (int);
4269 extern void setup_pty (int);
4270 extern int set_window_size (int, int, int);
4271 extern EMACS_INT
get_random (void);
4272 extern void seed_random (void *, ptrdiff_t);
4273 extern void init_random (void);
4274 extern void emacs_backtrace (int);
4275 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4276 extern int emacs_open (const char *, int, int);
4277 extern int emacs_pipe (int[2]);
4278 extern int emacs_close (int);
4279 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4280 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4281 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4282 extern void emacs_perror (char const *);
4284 extern void unlock_all_files (void);
4285 extern void lock_file (Lisp_Object
);
4286 extern void unlock_file (Lisp_Object
);
4287 extern void unlock_buffer (struct buffer
*);
4288 extern void syms_of_filelock (void);
4289 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4291 /* Defined in sound.c. */
4292 extern void syms_of_sound (void);
4294 /* Defined in category.c. */
4295 extern void init_category_once (void);
4296 extern Lisp_Object
char_category_set (int);
4297 extern void syms_of_category (void);
4299 /* Defined in ccl.c. */
4300 extern void syms_of_ccl (void);
4302 /* Defined in dired.c. */
4303 extern void syms_of_dired (void);
4304 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4305 Lisp_Object
, Lisp_Object
,
4308 /* Defined in term.c. */
4309 extern int *char_ins_del_vector
;
4310 extern void syms_of_term (void);
4311 extern _Noreturn
void fatal (const char *msgid
, ...)
4312 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4314 /* Defined in terminal.c. */
4315 extern void syms_of_terminal (void);
4317 /* Defined in font.c. */
4318 extern void syms_of_font (void);
4319 extern void init_font (void);
4321 #ifdef HAVE_WINDOW_SYSTEM
4322 /* Defined in fontset.c. */
4323 extern void syms_of_fontset (void);
4326 /* Defined in inotify.c */
4328 extern void syms_of_inotify (void);
4331 /* Defined in kqueue.c */
4333 extern void globals_of_kqueue (void);
4334 extern void syms_of_kqueue (void);
4337 /* Defined in gfilenotify.c */
4338 #ifdef HAVE_GFILENOTIFY
4339 extern void globals_of_gfilenotify (void);
4340 extern void syms_of_gfilenotify (void);
4343 #ifdef HAVE_W32NOTIFY
4344 /* Defined on w32notify.c. */
4345 extern void syms_of_w32notify (void);
4348 /* Defined in xfaces.c. */
4349 extern Lisp_Object Vface_alternative_font_family_alist
;
4350 extern Lisp_Object Vface_alternative_font_registry_alist
;
4351 extern void syms_of_xfaces (void);
4353 #ifdef HAVE_X_WINDOWS
4354 /* Defined in xfns.c. */
4355 extern void syms_of_xfns (void);
4357 /* Defined in xsmfns.c. */
4358 extern void syms_of_xsmfns (void);
4360 /* Defined in xselect.c. */
4361 extern void syms_of_xselect (void);
4363 /* Defined in xterm.c. */
4364 extern void init_xterm (void);
4365 extern void syms_of_xterm (void);
4366 #endif /* HAVE_X_WINDOWS */
4368 #ifdef HAVE_WINDOW_SYSTEM
4369 /* Defined in xterm.c, nsterm.m, w32term.c. */
4370 extern char *x_get_keysym_name (int);
4371 #endif /* HAVE_WINDOW_SYSTEM */
4374 /* Defined in xml.c. */
4375 extern void syms_of_xml (void);
4376 extern void xml_cleanup_parser (void);
4380 /* Defined in decompress.c. */
4381 extern void syms_of_decompress (void);
4385 /* Defined in dbusbind.c. */
4386 void init_dbusbind (void);
4387 void syms_of_dbusbind (void);
4391 /* Defined in profiler.c. */
4392 extern bool profiler_memory_running
;
4393 extern void malloc_probe (size_t);
4394 extern void syms_of_profiler (void);
4398 /* Defined in msdos.c, w32.c. */
4399 extern char *emacs_root_dir (void);
4402 /* Defined in lastfile.c. */
4403 extern char my_edata
[];
4404 extern char my_endbss
[];
4405 extern char *my_endbss_static
;
4407 /* True means ^G can quit instantly. */
4408 extern bool immediate_quit
;
4410 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4411 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4412 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4413 extern void xfree (void *);
4414 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4415 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4416 ATTRIBUTE_ALLOC_SIZE ((2,3));
4417 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4419 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4420 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4421 extern void dupstring (char **, char const *);
4423 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4424 null byte. This is like stpcpy, except the source is a Lisp string. */
4427 lispstpcpy (char *dest
, Lisp_Object string
)
4429 ptrdiff_t len
= SBYTES (string
);
4430 memcpy (dest
, SDATA (string
), len
+ 1);
4434 extern void xputenv (const char *);
4436 extern char *egetenv_internal (const char *, ptrdiff_t);
4439 egetenv (const char *var
)
4441 /* When VAR is a string literal, strlen can be optimized away. */
4442 return egetenv_internal (var
, strlen (var
));
4445 /* Set up the name of the machine we're running on. */
4446 extern void init_system_name (void);
4448 /* Return the absolute value of X. X should be a signed integer
4449 expression without side effects, and X's absolute value should not
4450 exceed the maximum for its promoted type. This is called 'eabs'
4451 because 'abs' is reserved by the C standard. */
4452 #define eabs(x) ((x) < 0 ? -(x) : (x))
4454 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4457 #define make_fixnum_or_float(val) \
4458 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4460 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4461 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4463 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4465 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4467 #define USE_SAFE_ALLOCA \
4468 ptrdiff_t sa_avail = MAX_ALLOCA; \
4469 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4471 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4473 /* SAFE_ALLOCA allocates a simple buffer. */
4475 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4476 ? AVAIL_ALLOCA (size) \
4477 : (sa_must_free = true, record_xmalloc (size)))
4479 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4480 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4481 positive. The code is tuned for MULTIPLIER being a constant. */
4483 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4485 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4486 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4489 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4490 sa_must_free = true; \
4491 record_unwind_protect_ptr (xfree, buf); \
4495 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4497 #define SAFE_ALLOCA_STRING(ptr, string) \
4499 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4500 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4503 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4505 #define SAFE_FREE() \
4507 if (sa_must_free) { \
4508 sa_must_free = false; \
4509 unbind_to (sa_count, Qnil); \
4513 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4515 #define SAFE_ALLOCA_LISP(buf, nelt) \
4517 ptrdiff_t alloca_nbytes; \
4518 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4519 || SIZE_MAX < alloca_nbytes) \
4520 memory_full (SIZE_MAX); \
4521 else if (alloca_nbytes <= sa_avail) \
4522 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4526 (buf) = xmalloc (alloca_nbytes); \
4527 arg_ = make_save_memory (buf, nelt); \
4528 sa_must_free = true; \
4529 record_unwind_protect (free_save_value, arg_); \
4534 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4535 block-scoped conses and strings. These objects are not
4536 managed by the garbage collector, so they are dangerous: passing them
4537 out of their scope (e.g., to user code) results in undefined behavior.
4538 Conversely, they have better performance because GC is not involved.
4540 This feature is experimental and requires careful debugging.
4541 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4543 #if (!defined USE_STACK_LISP_OBJECTS \
4544 && defined __GNUC__ && !defined __clang__ \
4545 && !(4 < __GNUC__ + (3 < __GNUC_MINOR__ + (2 <= __GNUC_PATCHLEVEL__))))
4546 /* Work around GCC bugs 36584 and 35271, which were fixed in GCC 4.3.2. */
4547 # define USE_STACK_LISP_OBJECTS false
4549 #ifndef USE_STACK_LISP_OBJECTS
4550 # define USE_STACK_LISP_OBJECTS true
4553 #ifdef GC_CHECK_STRING_BYTES
4554 enum { defined_GC_CHECK_STRING_BYTES
= true };
4556 enum { defined_GC_CHECK_STRING_BYTES
= false };
4559 /* Struct inside unions that are typically no larger and aligned enough. */
4564 double d
; intmax_t i
; void *p
;
4567 union Aligned_String
4569 struct Lisp_String s
;
4570 double d
; intmax_t i
; void *p
;
4573 /* True for stack-based cons and string implementations, respectively.
4574 Use stack-based strings only if stack-based cons also works.
4575 Otherwise, STACK_CONS would create heap-based cons cells that
4576 could point to stack-based strings, which is a no-no. */
4580 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4581 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4582 USE_STACK_STRING
= (USE_STACK_CONS
4583 && !defined_GC_CHECK_STRING_BYTES
4584 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4587 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4588 use these only in macros like AUTO_CONS that declare a local
4589 variable whose lifetime will be clear to the programmer. */
4590 #define STACK_CONS(a, b) \
4591 make_lisp_ptr (&(union Aligned_Cons) { { a, { b } } }.s, Lisp_Cons)
4592 #define AUTO_CONS_EXPR(a, b) \
4593 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4595 /* Declare NAME as an auto Lisp cons or short list if possible, a
4596 GC-based one otherwise. This is in the sense of the C keyword
4597 'auto'; i.e., the object has the lifetime of the containing block.
4598 The resulting object should not be made visible to user Lisp code. */
4600 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4601 #define AUTO_LIST1(name, a) \
4602 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4603 #define AUTO_LIST2(name, a, b) \
4604 Lisp_Object name = (USE_STACK_CONS \
4605 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4607 #define AUTO_LIST3(name, a, b, c) \
4608 Lisp_Object name = (USE_STACK_CONS \
4609 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4611 #define AUTO_LIST4(name, a, b, c, d) \
4614 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4615 STACK_CONS (d, Qnil)))) \
4616 : list4 (a, b, c, d))
4618 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4619 Take its unibyte value from the null-terminated string STR,
4620 an expression that should not have side effects.
4621 STR's value is not necessarily copied. The resulting Lisp string
4622 should not be modified or made visible to user code. */
4624 #define AUTO_STRING(name, str) \
4625 AUTO_STRING_WITH_LEN (name, str, strlen (str))
4627 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4628 Take its unibyte value from the null-terminated string STR with length LEN.
4629 STR may have side effects and may contain null bytes.
4630 STR's value is not necessarily copied. The resulting Lisp string
4631 should not be modified or made visible to user code. */
4633 #define AUTO_STRING_WITH_LEN(name, str, len) \
4634 Lisp_Object name = \
4637 ((&(union Aligned_String) \
4638 {{len, -1, 0, (unsigned char *) (str)}}.s), \
4640 : make_unibyte_string (str, len))
4642 /* Loop over all tails of a list, checking for cycles.
4643 FIXME: Make tortoise and n internal declarations.
4644 FIXME: Unroll the loop body so we don't need `n'. */
4645 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4646 for ((tortoise) = (hare) = (list), (n) = true; \
4648 (hare = XCDR (hare), (n) = !(n), \
4650 ? (EQ (hare, tortoise) \
4651 ? xsignal1 (Qcircular_list, list) \
4653 /* Move tortoise before the next iteration, in case */ \
4654 /* the next iteration does an Fsetcdr. */ \
4655 : (void) ((tortoise) = XCDR (tortoise)))))
4657 /* Do a `for' loop over alist values. */
4659 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4660 for ((list_var) = (head_var); \
4661 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4662 (list_var) = XCDR (list_var))
4664 /* Check whether it's time for GC, and run it if so. */
4669 if ((consing_since_gc
> gc_cons_threshold
4670 && consing_since_gc
> gc_relative_threshold
)
4671 || (!NILP (Vmemory_full
)
4672 && consing_since_gc
> memory_full_cons_threshold
))
4673 Fgarbage_collect ();
4677 functionp (Lisp_Object object
)
4679 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4681 object
= Findirect_function (object
, Qt
);
4683 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4685 /* Autoloaded symbols are functions, except if they load
4686 macros or keymaps. */
4688 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4689 object
= XCDR (object
);
4691 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4696 return XSUBR (object
)->max_args
!= UNEVALLED
;
4697 else if (COMPILEDP (object
))
4699 else if (CONSP (object
))
4701 Lisp_Object car
= XCAR (object
);
4702 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4710 #endif /* EMACS_LISP_H */