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
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
39 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
40 # define ID (some integer preprocessor expression of type TYPE)
41 DEFINE_GDB_SYMBOL_END (ID)
43 This hack is for the benefit of compilers that do not make macro
44 definitions or enums visible to the debugger. It's used for symbols
45 that .gdbinit needs. */
47 #define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
49 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
50 # define DEFINE_GDB_SYMBOL_END(id) = id;
52 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
53 # define DEFINE_GDB_SYMBOL_END(val) ;
56 /* The ubiquitous max and min macros. */
59 #define max(a, b) ((a) > (b) ? (a) : (b))
60 #define min(a, b) ((a) < (b) ? (a) : (b))
62 /* Number of elements in an array. */
63 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
65 /* Number of bits in a Lisp_Object tag. */
66 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
68 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
70 /* 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."
266 # error "alignas not defined"
269 #ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
270 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
272 # define GCALIGNED /* empty */
275 /* Some operations are so commonly executed that they are implemented
276 as macros, not functions, because otherwise runtime performance would
277 suffer too much when compiling with GCC without optimization.
278 There's no need to inline everything, just the operations that
279 would otherwise cause a serious performance problem.
281 For each such operation OP, define a macro lisp_h_OP that contains
282 the operation's implementation. That way, OP can be implemented
283 via a macro definition like this:
285 #define OP(x) lisp_h_OP (x)
287 and/or via a function definition like this:
289 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
291 without worrying about the implementations diverging, since
292 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
293 are intended to be private to this include file, and should not be
296 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
297 functions, once most developers have access to GCC 4.8 or later and
298 can use "gcc -Og" to debug. Maybe in the year 2016. See
301 Commentary for these macros can be found near their corresponding
304 #if CHECK_LISP_OBJECT_TYPE
305 # define lisp_h_XLI(o) ((o).i)
306 # define lisp_h_XIL(i) ((Lisp_Object) { i })
308 # define lisp_h_XLI(o) (o)
309 # define lisp_h_XIL(i) (i)
311 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
312 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
313 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
314 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
315 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
316 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
317 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
318 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
319 #define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
320 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
321 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
322 #define lisp_h_NILP(x) EQ (x, Qnil)
323 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
324 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
325 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
326 #define lisp_h_SYMBOL_VAL(sym) \
327 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
328 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
329 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
330 #define lisp_h_XCAR(c) XCONS (c)->car
331 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
332 #define lisp_h_XCONS(a) \
333 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
334 #define lisp_h_XHASH(a) XUINT (a)
335 #ifndef GC_CHECK_CONS_LIST
336 # define lisp_h_check_cons_list() ((void) 0)
339 # define lisp_h_make_number(n) \
340 XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
341 # define lisp_h_XFASTINT(a) XINT (a)
342 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
343 # define lisp_h_XSYMBOL(a) \
344 (eassert (SYMBOLP (a)), \
345 (struct Lisp_Symbol *) ((intptr_t) XLI (a) - Lisp_Symbol \
347 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
348 # define lisp_h_XUNTAG(a, type) ((void *) (intptr_t) (XLI (a) - (type)))
351 /* When compiling via gcc -O0, define the key operations as macros, as
352 Emacs is too slow otherwise. To disable this optimization, compile
353 with -DINLINING=false. */
354 #if (defined __NO_INLINE__ \
355 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
356 && ! (defined INLINING && ! INLINING))
357 # define DEFINE_KEY_OPS_AS_MACROS true
359 # define DEFINE_KEY_OPS_AS_MACROS false
362 #if DEFINE_KEY_OPS_AS_MACROS
363 # define XLI(o) lisp_h_XLI (o)
364 # define XIL(i) lisp_h_XIL (i)
365 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
366 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
367 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
368 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
369 # define CONSP(x) lisp_h_CONSP (x)
370 # define EQ(x, y) lisp_h_EQ (x, y)
371 # define FLOATP(x) lisp_h_FLOATP (x)
372 # define INTEGERP(x) lisp_h_INTEGERP (x)
373 # define MARKERP(x) lisp_h_MARKERP (x)
374 # define MISCP(x) lisp_h_MISCP (x)
375 # define NILP(x) lisp_h_NILP (x)
376 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
377 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
378 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
379 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
380 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
381 # define XCAR(c) lisp_h_XCAR (c)
382 # define XCDR(c) lisp_h_XCDR (c)
383 # define XCONS(a) lisp_h_XCONS (a)
384 # define XHASH(a) lisp_h_XHASH (a)
385 # ifndef GC_CHECK_CONS_LIST
386 # define check_cons_list() lisp_h_check_cons_list ()
389 # define make_number(n) lisp_h_make_number (n)
390 # define XFASTINT(a) lisp_h_XFASTINT (a)
391 # define XINT(a) lisp_h_XINT (a)
392 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
393 # define XTYPE(a) lisp_h_XTYPE (a)
394 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
399 /* Define the fundamental Lisp data structures. */
401 /* This is the set of Lisp data types. If you want to define a new
402 data type, read the comments after Lisp_Fwd_Type definition
405 /* Lisp integers use 2 tags, to give them one extra bit, thus
406 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
407 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
408 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
410 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
411 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
412 vociferously about them. */
413 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
414 || (defined __SUNPRO_C && __STDC__))
415 #define ENUM_BF(TYPE) unsigned int
417 #define ENUM_BF(TYPE) enum TYPE
423 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
426 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
427 whose first member indicates the subtype. */
430 /* Integer. XINT (obj) is the integer value. */
432 Lisp_Int1
= USE_LSB_TAG
? 6 : 3,
434 /* String. XSTRING (object) points to a struct Lisp_String.
435 The length of the string, and its contents, are stored therein. */
438 /* Vector of Lisp objects, or something resembling it.
439 XVECTOR (object) points to a struct Lisp_Vector, which contains
440 the size and contents. The size field also contains the type
441 information, if it's not a real vector object. */
444 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
445 Lisp_Cons
= USE_LSB_TAG
? 3 : 6,
450 /* This is the set of data types that share a common structure.
451 The first member of the structure is a type code from this set.
452 The enum values are arbitrary, but we'll use large numbers to make it
453 more likely that we'll spot the error if a random word in memory is
454 mistakenly interpreted as a Lisp_Misc. */
457 Lisp_Misc_Free
= 0x5eab,
460 Lisp_Misc_Save_Value
,
465 /* Currently floats are not a misc type,
466 but let's define this in case we want to change that. */
468 /* This is not a type code. It is for range checking. */
472 /* These are the types of forwarding objects used in the value slot
473 of symbols for special built-in variables whose value is stored in
477 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
478 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
479 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
480 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
481 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
484 /* If you want to define a new Lisp data type, here are some
485 instructions. See the thread at
486 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
489 First, there are already a couple of Lisp types that can be used if
490 your new type does not need to be exposed to Lisp programs nor
491 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
492 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
493 is suitable for temporarily stashing away pointers and integers in
494 a Lisp object. The latter is useful for vector-like Lisp objects
495 that need to be used as part of other objects, but which are never
496 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
499 These two types don't look pretty when printed, so they are
500 unsuitable for Lisp objects that can be exposed to users.
502 To define a new data type, add one more Lisp_Misc subtype or one
503 more pseudovector subtype. Pseudovectors are more suitable for
504 objects with several slots that need to support fast random access,
505 while Lisp_Misc types are for everything else. A pseudovector object
506 provides one or more slots for Lisp objects, followed by struct
507 members that are accessible only from C. A Lisp_Misc object is a
508 wrapper for a C struct that can contain anything you like.
510 Explicit freeing is discouraged for Lisp objects in general. But if
511 you really need to exploit this, use Lisp_Misc (check free_misc in
512 alloc.c to see why). There is no way to free a vectorlike object.
514 To add a new pseudovector type, extend the pvec_type enumeration;
515 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
517 For a Lisp_Misc, you will also need to add your entry to union
518 Lisp_Misc (but make sure the first word has the same structure as
519 the others, starting with a 16-bit member of the Lisp_Misc_Type
520 enumeration and a 1-bit GC markbit) and make sure the overall size
521 of the union is not increased by your addition.
523 For a new pseudovector, it's highly desirable to limit the size
524 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
525 Otherwise you will need to change sweep_vectors (also in alloc.c).
527 Then you will need to add switch branches in print.c (in
528 print_object, to print your object, and possibly also in
529 print_preprocess) and to alloc.c, to mark your object (in
530 mark_object) and to free it (in gc_sweep). The latter is also the
531 right place to call any code specific to your data type that needs
532 to run when the object is recycled -- e.g., free any additional
533 resources allocated for it that are not Lisp objects. You can even
534 make a pointer to the function that frees the resources a slot in
535 your object -- this way, the same object could be used to represent
536 several disparate C structures. */
538 #ifdef CHECK_LISP_OBJECT_TYPE
540 typedef struct { EMACS_INT i
; } Lisp_Object
;
542 #define LISP_INITIALLY(i) {i}
544 #undef CHECK_LISP_OBJECT_TYPE
545 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
546 #else /* CHECK_LISP_OBJECT_TYPE */
548 /* If a struct type is not wanted, define Lisp_Object as just a number. */
550 typedef EMACS_INT Lisp_Object
;
551 #define LISP_INITIALLY(i) (i)
552 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
553 #endif /* CHECK_LISP_OBJECT_TYPE */
555 #define LISP_INITIALLY_ZERO LISP_INITIALLY (0)
557 /* Forward declarations. */
559 /* Defined in this file. */
561 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
562 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
563 INLINE
bool BUFFERP (Lisp_Object
);
564 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
565 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
566 INLINE
bool (CONSP
) (Lisp_Object
);
567 INLINE
bool (FLOATP
) (Lisp_Object
);
568 INLINE
bool functionp (Lisp_Object
);
569 INLINE
bool (INTEGERP
) (Lisp_Object
);
570 INLINE
bool (MARKERP
) (Lisp_Object
);
571 INLINE
bool (MISCP
) (Lisp_Object
);
572 INLINE
bool (NILP
) (Lisp_Object
);
573 INLINE
bool OVERLAYP (Lisp_Object
);
574 INLINE
bool PROCESSP (Lisp_Object
);
575 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
576 INLINE
bool SAVE_VALUEP (Lisp_Object
);
577 INLINE
bool FINALIZERP (Lisp_Object
);
580 INLINE
bool USER_PTRP (Lisp_Object
);
581 INLINE
struct Lisp_User_Ptr
*(XUSER_PTR
) (Lisp_Object
);
584 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
586 INLINE
bool STRINGP (Lisp_Object
);
587 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
588 INLINE
bool SUBRP (Lisp_Object
);
589 INLINE
bool (SYMBOLP
) (Lisp_Object
);
590 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
591 INLINE
bool WINDOWP (Lisp_Object
);
592 INLINE
bool TERMINALP (Lisp_Object
);
593 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
594 INLINE
struct Lisp_Finalizer
*XFINALIZER (Lisp_Object
);
595 INLINE
struct Lisp_Symbol
*(XSYMBOL
) (Lisp_Object
);
596 INLINE
void *(XUNTAG
) (Lisp_Object
, int);
598 /* Defined in chartab.c. */
599 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
600 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
602 /* Defined in data.c. */
603 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
604 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
606 /* Defined in emacs.c. */
607 #ifdef DOUG_LEA_MALLOC
608 extern bool might_dump
;
610 /* True means Emacs has already been initialized.
611 Used during startup to detect startup of dumped Emacs. */
612 extern bool initialized
;
614 /* Defined in floatfns.c. */
615 extern double extract_float (Lisp_Object
);
618 /* Interned state of a symbol. */
622 SYMBOL_UNINTERNED
= 0,
624 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
631 SYMBOL_LOCALIZED
= 2,
637 bool_bf gcmarkbit
: 1;
639 /* Indicates where the value can be found:
640 0 : it's a plain var, the value is in the `value' field.
641 1 : it's a varalias, the value is really in the `alias' symbol.
642 2 : it's a localized var, the value is in the `blv' object.
643 3 : it's a forwarding variable, the value is in `forward'. */
644 ENUM_BF (symbol_redirect
) redirect
: 3;
646 /* Non-zero means symbol is constant, i.e. changing its value
647 should signal an error. If the value is 3, then the var
648 can be changed, but only by `defconst'. */
649 unsigned constant
: 2;
651 /* Interned state of the symbol. This is an enumerator from
652 enum symbol_interned. */
653 unsigned interned
: 2;
655 /* True means that this variable has been explicitly declared
656 special (with `defvar' etc), and shouldn't be lexically bound. */
657 bool_bf declared_special
: 1;
659 /* True if pointed to from purespace and hence can't be GC'd. */
662 /* The symbol's name, as a Lisp string. */
665 /* Value of the symbol or Qunbound if unbound. Which alternative of the
666 union is used depends on the `redirect' field above. */
669 struct Lisp_Symbol
*alias
;
670 struct Lisp_Buffer_Local_Value
*blv
;
674 /* Function value of the symbol or Qnil if not fboundp. */
675 Lisp_Object function
;
677 /* The symbol's property list. */
680 /* Next symbol in obarray bucket, if the symbol is interned. */
681 struct Lisp_Symbol
*next
;
684 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
685 meaning as in the DEFUN macro, and is used to construct a prototype. */
686 /* We can use the same trick as in the DEFUN macro to generate the
687 appropriate prototype. */
688 #define EXFUN(fnname, maxargs) \
689 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
691 /* Note that the weird token-substitution semantics of ANSI C makes
692 this work for MANY and UNEVALLED. */
693 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
694 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
695 #define DEFUN_ARGS_0 (void)
696 #define DEFUN_ARGS_1 (Lisp_Object)
697 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
698 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
699 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
700 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
702 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
703 Lisp_Object, Lisp_Object)
704 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
705 Lisp_Object, Lisp_Object, Lisp_Object)
706 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
707 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
709 /* Yield a signed integer that contains TAG along with PTR.
711 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
712 and zero-extend otherwise (that’s a bit faster here).
713 Sign extension matters only when EMACS_INT is wider than a pointer. */
714 #define TAG_PTR(tag, ptr) \
716 ? (intptr_t) (ptr) + (tag) \
717 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
719 /* Yield an integer that contains a symbol tag along with OFFSET.
720 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
721 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
723 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
724 XLI (builtin_lisp_symbol (Qwhatever)),
725 except the former expands to an integer constant expression. */
726 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
728 /* Declare extern constants for Lisp symbols. These can be helpful
729 when using a debugger like GDB, on older platforms where the debug
730 format does not represent C macros. */
731 #define DEFINE_LISP_SYMBOL(name) \
732 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
733 DEFINE_GDB_SYMBOL_END (LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name)))
735 /* By default, define macros for Qt, etc., as this leads to a bit
736 better performance in the core Emacs interpreter. A plugin can
737 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
738 other Emacs instances that assign different values to Qt, etc. */
739 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
740 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
745 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
746 At the machine level, these operations are no-ops. */
749 (XLI
) (Lisp_Object o
)
751 return lisp_h_XLI (o
);
757 return lisp_h_XIL (i
);
760 /* In the size word of a vector, this bit means the vector has been marked. */
762 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
763 # define ARRAY_MARK_FLAG PTRDIFF_MIN
764 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
766 /* In the size word of a struct Lisp_Vector, this bit means it's really
767 some other vector-like object. */
768 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
769 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
770 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
772 /* In a pseudovector, the size field actually contains a word with one
773 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
774 with PVEC_TYPE_MASK to indicate the actual type. */
786 PVEC_WINDOW_CONFIGURATION
,
792 /* These should be last, check internal_equal to see why. */
796 PVEC_FONT
/* Should be last because it's used for range checking. */
801 /* For convenience, we also store the number of elements in these bits.
802 Note that this size is not necessarily the memory-footprint size, but
803 only the number of Lisp_Object fields (that need to be traced by GC).
804 The distinction is used, e.g., by Lisp_Process, which places extra
805 non-Lisp_Object fields at the end of the structure. */
806 PSEUDOVECTOR_SIZE_BITS
= 12,
807 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
809 /* To calculate the memory footprint of the pseudovector, it's useful
810 to store the size of non-Lisp area in word_size units here. */
811 PSEUDOVECTOR_REST_BITS
= 12,
812 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
813 << PSEUDOVECTOR_SIZE_BITS
),
815 /* Used to extract pseudovector subtype information. */
816 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
817 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
820 /* These functions extract various sorts of values from a Lisp_Object.
821 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
822 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
825 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
826 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
827 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
828 DEFINE_GDB_SYMBOL_END (VALMASK
)
830 /* Largest and smallest representable fixnum values. These are the C
831 values. They are macros for use in static initializers. */
832 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
833 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
838 (make_number
) (EMACS_INT n
)
840 return lisp_h_make_number (n
);
844 (XINT
) (Lisp_Object a
)
846 return lisp_h_XINT (a
);
850 (XFASTINT
) (Lisp_Object a
)
852 EMACS_INT n
= lisp_h_XFASTINT (a
);
857 INLINE
struct Lisp_Symbol
*
858 (XSYMBOL
) (Lisp_Object a
)
860 return lisp_h_XSYMBOL (a
);
863 INLINE
enum Lisp_Type
864 (XTYPE
) (Lisp_Object a
)
866 return lisp_h_XTYPE (a
);
870 (XUNTAG
) (Lisp_Object a
, int type
)
872 return lisp_h_XUNTAG (a
, type
);
875 #else /* ! USE_LSB_TAG */
877 /* Although compiled only if ! USE_LSB_TAG, the following functions
878 also work when USE_LSB_TAG; this is to aid future maintenance when
879 the lisp_h_* macros are eventually removed. */
881 /* Make a Lisp integer representing the value of the low order
884 make_number (EMACS_INT n
)
886 EMACS_INT int0
= Lisp_Int0
;
890 n
= u
<< INTTYPEBITS
;
896 n
+= (int0
<< VALBITS
);
901 /* Extract A's value as a signed integer. */
905 EMACS_INT i
= XLI (a
);
909 i
= u
<< INTTYPEBITS
;
911 return i
>> INTTYPEBITS
;
914 /* Like XINT (A), but may be faster. A must be nonnegative.
915 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
916 integers have zero-bits in their tags. */
918 XFASTINT (Lisp_Object a
)
920 EMACS_INT int0
= Lisp_Int0
;
921 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
) - (int0
<< VALBITS
);
926 /* Extract A's type. */
927 INLINE
enum Lisp_Type
928 XTYPE (Lisp_Object a
)
930 EMACS_UINT i
= XLI (a
);
931 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
934 /* Extract A's value as a symbol. */
935 INLINE
struct Lisp_Symbol
*
936 XSYMBOL (Lisp_Object a
)
938 eassert (SYMBOLP (a
));
939 intptr_t i
= (intptr_t) XUNTAG (a
, Lisp_Symbol
);
940 void *p
= (char *) lispsym
+ i
;
944 /* Extract A's pointer value, assuming A's type is TYPE. */
946 XUNTAG (Lisp_Object a
, int type
)
948 intptr_t i
= USE_LSB_TAG
? XLI (a
) - type
: XLI (a
) & VALMASK
;
952 #endif /* ! USE_LSB_TAG */
954 /* Extract A's value as an unsigned integer. */
956 XUINT (Lisp_Object a
)
958 EMACS_UINT i
= XLI (a
);
959 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
962 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
963 right now, but XUINT should only be applied to objects we know are
967 (XHASH
) (Lisp_Object a
)
969 return lisp_h_XHASH (a
);
972 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
974 make_natnum (EMACS_INT n
)
976 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
977 EMACS_INT int0
= Lisp_Int0
;
978 return USE_LSB_TAG
? make_number (n
) : XIL (n
+ (int0
<< VALBITS
));
981 /* Return true if X and Y are the same object. */
984 (EQ
) (Lisp_Object x
, Lisp_Object y
)
986 return lisp_h_EQ (x
, y
);
989 /* Value is true if I doesn't fit into a Lisp fixnum. It is
990 written this way so that it also works if I is of unsigned
991 type or if I is a NaN. */
993 #define FIXNUM_OVERFLOW_P(i) \
994 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
997 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
999 return num
< lower
? lower
: num
<= upper
? num
: upper
;
1003 /* Extract a value or address from a Lisp_Object. */
1005 INLINE
struct Lisp_Cons
*
1006 (XCONS
) (Lisp_Object a
)
1008 return lisp_h_XCONS (a
);
1011 INLINE
struct Lisp_Vector
*
1012 XVECTOR (Lisp_Object a
)
1014 eassert (VECTORLIKEP (a
));
1015 return XUNTAG (a
, Lisp_Vectorlike
);
1018 INLINE
struct Lisp_String
*
1019 XSTRING (Lisp_Object a
)
1021 eassert (STRINGP (a
));
1022 return XUNTAG (a
, Lisp_String
);
1025 /* The index of the C-defined Lisp symbol SYM.
1026 This can be used in a static initializer. */
1027 #define SYMBOL_INDEX(sym) i##sym
1029 INLINE
struct Lisp_Float
*
1030 XFLOAT (Lisp_Object a
)
1032 eassert (FLOATP (a
));
1033 return XUNTAG (a
, Lisp_Float
);
1036 /* Pseudovector types. */
1038 INLINE
struct Lisp_Process
*
1039 XPROCESS (Lisp_Object a
)
1041 eassert (PROCESSP (a
));
1042 return XUNTAG (a
, Lisp_Vectorlike
);
1045 INLINE
struct window
*
1046 XWINDOW (Lisp_Object a
)
1048 eassert (WINDOWP (a
));
1049 return XUNTAG (a
, Lisp_Vectorlike
);
1052 INLINE
struct terminal
*
1053 XTERMINAL (Lisp_Object a
)
1055 eassert (TERMINALP (a
));
1056 return XUNTAG (a
, Lisp_Vectorlike
);
1059 INLINE
struct Lisp_Subr
*
1060 XSUBR (Lisp_Object a
)
1062 eassert (SUBRP (a
));
1063 return XUNTAG (a
, Lisp_Vectorlike
);
1066 INLINE
struct buffer
*
1067 XBUFFER (Lisp_Object a
)
1069 eassert (BUFFERP (a
));
1070 return XUNTAG (a
, Lisp_Vectorlike
);
1073 INLINE
struct Lisp_Char_Table
*
1074 XCHAR_TABLE (Lisp_Object a
)
1076 eassert (CHAR_TABLE_P (a
));
1077 return XUNTAG (a
, Lisp_Vectorlike
);
1080 INLINE
struct Lisp_Sub_Char_Table
*
1081 XSUB_CHAR_TABLE (Lisp_Object a
)
1083 eassert (SUB_CHAR_TABLE_P (a
));
1084 return XUNTAG (a
, Lisp_Vectorlike
);
1087 INLINE
struct Lisp_Bool_Vector
*
1088 XBOOL_VECTOR (Lisp_Object a
)
1090 eassert (BOOL_VECTOR_P (a
));
1091 return XUNTAG (a
, Lisp_Vectorlike
);
1094 /* Construct a Lisp_Object from a value or address. */
1097 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
1099 Lisp_Object a
= XIL (TAG_PTR (type
, ptr
));
1100 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
1105 make_lisp_symbol (struct Lisp_Symbol
*sym
)
1107 Lisp_Object a
= XIL (TAG_SYMOFFSET ((char *) sym
- (char *) lispsym
));
1108 eassert (XSYMBOL (a
) == sym
);
1113 builtin_lisp_symbol (int index
)
1115 return make_lisp_symbol (lispsym
+ index
);
1118 #define XSETINT(a, b) ((a) = make_number (b))
1119 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1120 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1121 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1122 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1123 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1124 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1125 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1127 /* Pseudovector types. */
1129 #define XSETPVECTYPE(v, code) \
1130 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1131 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1132 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1133 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1134 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1137 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1138 #define XSETPSEUDOVECTOR(a, b, code) \
1139 XSETTYPED_PSEUDOVECTOR (a, b, \
1140 (((struct vectorlike_header *) \
1141 XUNTAG (a, Lisp_Vectorlike)) \
1144 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1145 (XSETVECTOR (a, b), \
1146 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1147 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1149 #define XSETWINDOW_CONFIGURATION(a, b) \
1150 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1151 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1152 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1153 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1154 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1155 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1156 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1157 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1158 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1159 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1161 /* Efficiently convert a pointer to a Lisp object and back. The
1162 pointer is represented as a Lisp integer, so the garbage collector
1163 does not know about it. The pointer should not have both Lisp_Int1
1164 bits set, which makes this conversion inherently unportable. */
1167 XINTPTR (Lisp_Object a
)
1169 return XUNTAG (a
, Lisp_Int0
);
1173 make_pointer_integer (void *p
)
1175 Lisp_Object a
= XIL (TAG_PTR (Lisp_Int0
, p
));
1176 eassert (INTEGERP (a
) && XINTPTR (a
) == p
);
1180 /* Type checking. */
1183 (CHECK_TYPE
) (int ok
, Lisp_Object predicate
, Lisp_Object x
)
1185 lisp_h_CHECK_TYPE (ok
, predicate
, x
);
1188 /* See the macros in intervals.h. */
1190 typedef struct interval
*INTERVAL
;
1192 struct GCALIGNED Lisp_Cons
1194 /* Car of this cons cell. */
1199 /* Cdr of this cons cell. */
1202 /* Used to chain conses on a free list. */
1203 struct Lisp_Cons
*chain
;
1207 /* Take the car or cdr of something known to be a cons cell. */
1208 /* The _addr functions shouldn't be used outside of the minimal set
1209 of code that has to know what a cons cell looks like. Other code not
1210 part of the basic lisp implementation should assume that the car and cdr
1211 fields are not accessible. (What if we want to switch to
1212 a copying collector someday? Cached cons cell field addresses may be
1213 invalidated at arbitrary points.) */
1214 INLINE Lisp_Object
*
1215 xcar_addr (Lisp_Object c
)
1217 return &XCONS (c
)->car
;
1219 INLINE Lisp_Object
*
1220 xcdr_addr (Lisp_Object c
)
1222 return &XCONS (c
)->u
.cdr
;
1225 /* Use these from normal code. */
1228 (XCAR
) (Lisp_Object c
)
1230 return lisp_h_XCAR (c
);
1234 (XCDR
) (Lisp_Object c
)
1236 return lisp_h_XCDR (c
);
1239 /* Use these to set the fields of a cons cell.
1241 Note that both arguments may refer to the same object, so 'n'
1242 should not be read after 'c' is first modified. */
1244 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1249 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1254 /* Take the car or cdr of something whose type is not known. */
1258 return (CONSP (c
) ? XCAR (c
)
1260 : wrong_type_argument (Qlistp
, c
));
1265 return (CONSP (c
) ? XCDR (c
)
1267 : wrong_type_argument (Qlistp
, c
));
1270 /* Take the car or cdr of something whose type is not known. */
1272 CAR_SAFE (Lisp_Object c
)
1274 return CONSP (c
) ? XCAR (c
) : Qnil
;
1277 CDR_SAFE (Lisp_Object c
)
1279 return CONSP (c
) ? XCDR (c
) : Qnil
;
1282 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1284 struct GCALIGNED Lisp_String
1287 ptrdiff_t size_byte
;
1288 INTERVAL intervals
; /* Text properties in this string. */
1289 unsigned char *data
;
1292 /* True if STR is a multibyte string. */
1294 STRING_MULTIBYTE (Lisp_Object str
)
1296 return 0 <= XSTRING (str
)->size_byte
;
1299 /* An upper bound on the number of bytes in a Lisp string, not
1300 counting the terminating null. This a tight enough bound to
1301 prevent integer overflow errors that would otherwise occur during
1302 string size calculations. A string cannot contain more bytes than
1303 a fixnum can represent, nor can it be so long that C pointer
1304 arithmetic stops working on the string plus its terminating null.
1305 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1306 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1307 would expose alloc.c internal details that we'd rather keep
1310 This is a macro for use in static initializers. The cast to
1311 ptrdiff_t ensures that the macro is signed. */
1312 #define STRING_BYTES_BOUND \
1313 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1315 /* Mark STR as a unibyte string. */
1316 #define STRING_SET_UNIBYTE(STR) \
1318 if (XSTRING (STR)->size == 0) \
1319 (STR) = empty_unibyte_string; \
1321 XSTRING (STR)->size_byte = -1; \
1324 /* Mark STR as a multibyte string. Assure that STR contains only
1325 ASCII characters in advance. */
1326 #define STRING_SET_MULTIBYTE(STR) \
1328 if (XSTRING (STR)->size == 0) \
1329 (STR) = empty_multibyte_string; \
1331 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1334 /* Convenience functions for dealing with Lisp strings. */
1336 INLINE
unsigned char *
1337 SDATA (Lisp_Object string
)
1339 return XSTRING (string
)->data
;
1342 SSDATA (Lisp_Object string
)
1344 /* Avoid "differ in sign" warnings. */
1345 return (char *) SDATA (string
);
1347 INLINE
unsigned char
1348 SREF (Lisp_Object string
, ptrdiff_t index
)
1350 return SDATA (string
)[index
];
1353 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1355 SDATA (string
)[index
] = new;
1358 SCHARS (Lisp_Object string
)
1360 return XSTRING (string
)->size
;
1363 #ifdef GC_CHECK_STRING_BYTES
1364 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1367 STRING_BYTES (struct Lisp_String
*s
)
1369 #ifdef GC_CHECK_STRING_BYTES
1370 return string_bytes (s
);
1372 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1377 SBYTES (Lisp_Object string
)
1379 return STRING_BYTES (XSTRING (string
));
1382 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1384 XSTRING (string
)->size
= newsize
;
1387 /* Header of vector-like objects. This documents the layout constraints on
1388 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1389 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1390 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1391 because when two such pointers potentially alias, a compiler won't
1392 incorrectly reorder loads and stores to their size fields. See
1394 struct vectorlike_header
1396 /* The only field contains various pieces of information:
1397 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1398 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1399 vector (0) or a pseudovector (1).
1400 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1401 of slots) of the vector.
1402 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1403 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1404 - b) number of Lisp_Objects slots at the beginning of the object
1405 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1407 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1408 measured in word_size units. Rest fields may also include
1409 Lisp_Objects, but these objects usually needs some special treatment
1411 There are some exceptions. For PVEC_FREE, b) is always zero. For
1412 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1413 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1414 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1418 /* A regular vector is just a header plus an array of Lisp_Objects. */
1422 struct vectorlike_header header
;
1423 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1426 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1429 ALIGNOF_STRUCT_LISP_VECTOR
1430 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1433 /* A boolvector is a kind of vectorlike, with contents like a string. */
1435 struct Lisp_Bool_Vector
1437 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1438 just the subtype information. */
1439 struct vectorlike_header header
;
1440 /* This is the size in bits. */
1442 /* The actual bits, packed into bytes.
1443 Zeros fill out the last word if needed.
1444 The bits are in little-endian order in the bytes, and
1445 the bytes are in little-endian order in the words. */
1446 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1450 bool_vector_size (Lisp_Object a
)
1452 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1453 eassume (0 <= size
);
1458 bool_vector_data (Lisp_Object a
)
1460 return XBOOL_VECTOR (a
)->data
;
1463 INLINE
unsigned char *
1464 bool_vector_uchar_data (Lisp_Object a
)
1466 return (unsigned char *) bool_vector_data (a
);
1469 /* The number of data words and bytes in a bool vector with SIZE bits. */
1472 bool_vector_words (EMACS_INT size
)
1474 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1475 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1479 bool_vector_bytes (EMACS_INT size
)
1481 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1482 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1485 /* True if A's Ith bit is set. */
1488 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1490 eassume (0 <= i
&& i
< bool_vector_size (a
));
1491 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1492 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1496 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1498 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1501 /* Set A's Ith bit to B. */
1504 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1506 unsigned char *addr
;
1508 eassume (0 <= i
&& i
< bool_vector_size (a
));
1509 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1512 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1514 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1517 /* Some handy constants for calculating sizes
1518 and offsets, mostly of vectorlike objects. */
1522 header_size
= offsetof (struct Lisp_Vector
, contents
),
1523 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1524 word_size
= sizeof (Lisp_Object
)
1527 /* Conveniences for dealing with Lisp arrays. */
1530 AREF (Lisp_Object array
, ptrdiff_t idx
)
1532 return XVECTOR (array
)->contents
[idx
];
1535 INLINE Lisp_Object
*
1536 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1538 return & XVECTOR (array
)->contents
[idx
];
1542 ASIZE (Lisp_Object array
)
1544 ptrdiff_t size
= XVECTOR (array
)->header
.size
;
1545 eassume (0 <= size
);
1550 gc_asize (Lisp_Object array
)
1552 /* Like ASIZE, but also can be used in the garbage collector. */
1553 return XVECTOR (array
)->header
.size
& ~ARRAY_MARK_FLAG
;
1557 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1559 eassert (0 <= idx
&& idx
< ASIZE (array
));
1560 XVECTOR (array
)->contents
[idx
] = val
;
1564 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1566 /* Like ASET, but also can be used in the garbage collector:
1567 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1568 eassert (0 <= idx
&& idx
< gc_asize (array
));
1569 XVECTOR (array
)->contents
[idx
] = val
;
1572 /* True, since Qnil's representation is zero. Every place in the code
1573 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1574 to find such assumptions later if we change Qnil to be nonzero. */
1575 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1577 /* Clear the object addressed by P, with size NBYTES, so that all its
1578 bytes are zero and all its Lisp values are nil. */
1580 memclear (void *p
, ptrdiff_t nbytes
)
1582 eassert (0 <= nbytes
);
1583 verify (NIL_IS_ZERO
);
1584 /* Since Qnil is zero, memset suffices. */
1585 memset (p
, 0, nbytes
);
1588 /* If a struct is made to look like a vector, this macro returns the length
1589 of the shortest vector that would hold that struct. */
1591 #define VECSIZE(type) \
1592 ((sizeof (type) - header_size + word_size - 1) / word_size)
1594 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1595 at the end and we need to compute the number of Lisp_Object fields (the
1596 ones that the GC needs to trace). */
1598 #define PSEUDOVECSIZE(type, nonlispfield) \
1599 ((offsetof (type, nonlispfield) - header_size) / word_size)
1601 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1602 should be integer expressions. This is not the same as
1603 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1604 returns true. For efficiency, prefer plain unsigned comparison if A
1605 and B's sizes both fit (after integer promotion). */
1606 #define UNSIGNED_CMP(a, op, b) \
1607 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1608 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1609 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1611 /* True iff C is an ASCII character. */
1612 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1614 /* A char-table is a kind of vectorlike, with contents are like a
1615 vector but with a few other slots. For some purposes, it makes
1616 sense to handle a char-table with type struct Lisp_Vector. An
1617 element of a char table can be any Lisp objects, but if it is a sub
1618 char-table, we treat it a table that contains information of a
1619 specific range of characters. A sub char-table is like a vector but
1620 with two integer fields between the header and Lisp data, which means
1621 that it has to be marked with some precautions (see mark_char_table
1622 in alloc.c). A sub char-table appears only in an element of a char-table,
1623 and there's no way to access it directly from Emacs Lisp program. */
1625 enum CHARTAB_SIZE_BITS
1627 CHARTAB_SIZE_BITS_0
= 6,
1628 CHARTAB_SIZE_BITS_1
= 4,
1629 CHARTAB_SIZE_BITS_2
= 5,
1630 CHARTAB_SIZE_BITS_3
= 7
1633 extern const int chartab_size
[4];
1635 struct Lisp_Char_Table
1637 /* HEADER.SIZE is the vector's size field, which also holds the
1638 pseudovector type information. It holds the size, too.
1639 The size counts the defalt, parent, purpose, ascii,
1640 contents, and extras slots. */
1641 struct vectorlike_header header
;
1643 /* This holds a default value,
1644 which is used whenever the value for a specific character is nil. */
1647 /* This points to another char table, which we inherit from when the
1648 value for a specific character is nil. The `defalt' slot takes
1649 precedence over this. */
1652 /* This is a symbol which says what kind of use this char-table is
1654 Lisp_Object purpose
;
1656 /* The bottom sub char-table for characters of the range 0..127. It
1657 is nil if none of ASCII character has a specific value. */
1660 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1662 /* These hold additional data. It is a vector. */
1663 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1666 struct Lisp_Sub_Char_Table
1668 /* HEADER.SIZE is the vector's size field, which also holds the
1669 pseudovector type information. It holds the size, too. */
1670 struct vectorlike_header header
;
1672 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1673 char-table of depth 1 contains 16 elements, and each element
1674 covers 4096 (128*32) characters. A sub char-table of depth 2
1675 contains 32 elements, and each element covers 128 characters. A
1676 sub char-table of depth 3 contains 128 elements, and each element
1677 is for one character. */
1680 /* Minimum character covered by the sub char-table. */
1683 /* Use set_sub_char_table_contents to set this. */
1684 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1688 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1690 struct Lisp_Char_Table
*tbl
= NULL
;
1694 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1695 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1696 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1700 while (NILP (val
) && ! NILP (tbl
->parent
));
1705 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1706 characters. Do not check validity of CT. */
1708 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1710 return (ASCII_CHAR_P (idx
)
1711 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1712 : char_table_ref (ct
, idx
));
1715 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1716 8-bit European characters. Do not check validity of CT. */
1718 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1720 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1721 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1723 char_table_set (ct
, idx
, val
);
1726 /* This structure describes a built-in function.
1727 It is generated by the DEFUN macro only.
1728 defsubr makes it into a Lisp object. */
1732 struct vectorlike_header header
;
1734 Lisp_Object (*a0
) (void);
1735 Lisp_Object (*a1
) (Lisp_Object
);
1736 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1737 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1738 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1739 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1740 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1741 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1742 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1743 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1744 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1746 short min_args
, max_args
;
1747 const char *symbol_name
;
1748 const char *intspec
;
1752 enum char_table_specials
1754 /* This is the number of slots that every char table must have. This
1755 counts the ordinary slots and the top, defalt, parent, and purpose
1757 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1759 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1760 when the latter is treated as an ordinary Lisp_Vector. */
1761 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1764 /* Return the number of "extra" slots in the char table CT. */
1767 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1769 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1770 - CHAR_TABLE_STANDARD_SLOTS
);
1773 /* Make sure that sub char-table contents slot is where we think it is. */
1774 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1775 == offsetof (struct Lisp_Vector
, contents
[SUB_CHAR_TABLE_OFFSET
]));
1777 /***********************************************************************
1779 ***********************************************************************/
1781 /* Value is name of symbol. */
1784 (SYMBOL_VAL
) (struct Lisp_Symbol
*sym
)
1786 return lisp_h_SYMBOL_VAL (sym
);
1789 INLINE
struct Lisp_Symbol
*
1790 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1792 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1793 return sym
->val
.alias
;
1795 INLINE
struct Lisp_Buffer_Local_Value
*
1796 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1798 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1799 return sym
->val
.blv
;
1801 INLINE
union Lisp_Fwd
*
1802 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1804 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1805 return sym
->val
.fwd
;
1809 (SET_SYMBOL_VAL
) (struct Lisp_Symbol
*sym
, Lisp_Object v
)
1811 lisp_h_SET_SYMBOL_VAL (sym
, v
);
1815 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1817 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1821 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1823 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1827 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1829 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1834 SYMBOL_NAME (Lisp_Object sym
)
1836 return XSYMBOL (sym
)->name
;
1839 /* Value is true if SYM is an interned symbol. */
1842 SYMBOL_INTERNED_P (Lisp_Object sym
)
1844 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1847 /* Value is true if SYM is interned in initial_obarray. */
1850 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1852 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1855 /* Value is non-zero if symbol is considered a constant, i.e. its
1856 value cannot be changed (there is an exception for keyword symbols,
1857 whose value can be set to the keyword symbol itself). */
1860 (SYMBOL_CONSTANT_P
) (Lisp_Object sym
)
1862 return lisp_h_SYMBOL_CONSTANT_P (sym
);
1865 /* Placeholder for make-docfile to process. The actual symbol
1866 definition is done by lread.c's defsym. */
1867 #define DEFSYM(sym, name) /* empty */
1870 /***********************************************************************
1872 ***********************************************************************/
1874 /* The structure of a Lisp hash table. */
1876 struct hash_table_test
1878 /* Name of the function used to compare keys. */
1881 /* User-supplied hash function, or nil. */
1882 Lisp_Object user_hash_function
;
1884 /* User-supplied key comparison function, or nil. */
1885 Lisp_Object user_cmp_function
;
1887 /* C function to compare two keys. */
1888 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1890 /* C function to compute hash code. */
1891 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1894 struct Lisp_Hash_Table
1896 /* This is for Lisp; the hash table code does not refer to it. */
1897 struct vectorlike_header header
;
1899 /* Nil if table is non-weak. Otherwise a symbol describing the
1900 weakness of the table. */
1903 /* When the table is resized, and this is an integer, compute the
1904 new size by adding this to the old size. If a float, compute the
1905 new size by multiplying the old size with this factor. */
1906 Lisp_Object rehash_size
;
1908 /* Resize hash table when number of entries/ table size is >= this
1910 Lisp_Object rehash_threshold
;
1912 /* Vector of hash codes. If hash[I] is nil, this means that the
1913 I-th entry is unused. */
1916 /* Vector used to chain entries. If entry I is free, next[I] is the
1917 entry number of the next free item. If entry I is non-free,
1918 next[I] is the index of the next entry in the collision chain. */
1921 /* Index of first free entry in free list. */
1922 Lisp_Object next_free
;
1924 /* Bucket vector. A non-nil entry is the index of the first item in
1925 a collision chain. This vector's size can be larger than the
1926 hash table size to reduce collisions. */
1929 /* Only the fields above are traced normally by the GC. The ones below
1930 `count' are special and are either ignored by the GC or traced in
1931 a special way (e.g. because of weakness). */
1933 /* Number of key/value entries in the table. */
1936 /* Vector of keys and values. The key of item I is found at index
1937 2 * I, the value is found at index 2 * I + 1.
1938 This is gc_marked specially if the table is weak. */
1939 Lisp_Object key_and_value
;
1941 /* The comparison and hash functions. */
1942 struct hash_table_test test
;
1944 /* Next weak hash table if this is a weak hash table. The head
1945 of the list is in weak_hash_tables. */
1946 struct Lisp_Hash_Table
*next_weak
;
1951 HASH_TABLE_P (Lisp_Object a
)
1953 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1956 INLINE
struct Lisp_Hash_Table
*
1957 XHASH_TABLE (Lisp_Object a
)
1959 eassert (HASH_TABLE_P (a
));
1960 return XUNTAG (a
, Lisp_Vectorlike
);
1963 #define XSET_HASH_TABLE(VAR, PTR) \
1964 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1966 /* Value is the key part of entry IDX in hash table H. */
1968 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1970 return AREF (h
->key_and_value
, 2 * idx
);
1973 /* Value is the value part of entry IDX in hash table H. */
1975 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1977 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1980 /* Value is the index of the next entry following the one at IDX
1983 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1985 return AREF (h
->next
, idx
);
1988 /* Value is the hash code computed for entry IDX in hash table H. */
1990 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1992 return AREF (h
->hash
, idx
);
1995 /* Value is the index of the element in hash table H that is the
1996 start of the collision list at index IDX in the index vector of H. */
1998 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2000 return AREF (h
->index
, idx
);
2003 /* Value is the size of hash table H. */
2005 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
2007 return ASIZE (h
->next
);
2010 /* Default size for hash tables if not specified. */
2012 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
2014 /* Default threshold specifying when to resize a hash table. The
2015 value gives the ratio of current entries in the hash table and the
2016 size of the hash table. */
2018 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
2020 /* Default factor by which to increase the size of a hash table. */
2022 static double const DEFAULT_REHASH_SIZE
= 1.5;
2024 /* Combine two integers X and Y for hashing. The result might not fit
2025 into a Lisp integer. */
2028 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
2030 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
2033 /* Hash X, returning a value that fits into a fixnum. */
2036 SXHASH_REDUCE (EMACS_UINT x
)
2038 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
2041 /* These structures are used for various misc types. */
2043 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
2045 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
2046 bool_bf gcmarkbit
: 1;
2047 unsigned spacer
: 15;
2052 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
2053 bool_bf gcmarkbit
: 1;
2054 unsigned spacer
: 13;
2055 /* This flag is temporarily used in the functions
2056 decode/encode_coding_object to record that the marker position
2057 must be adjusted after the conversion. */
2058 bool_bf need_adjustment
: 1;
2059 /* True means normal insertion at the marker's position
2060 leaves the marker after the inserted text. */
2061 bool_bf insertion_type
: 1;
2062 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2063 Note: a chain of markers can contain markers pointing into different
2064 buffers (the chain is per buffer_text rather than per buffer, so it's
2065 shared between indirect buffers). */
2066 /* This is used for (other than NULL-checking):
2068 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2069 - unchain_marker: to find the list from which to unchain.
2070 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2072 struct buffer
*buffer
;
2074 /* The remaining fields are meaningless in a marker that
2075 does not point anywhere. */
2077 /* For markers that point somewhere,
2078 this is used to chain of all the markers in a given buffer. */
2079 /* We could remove it and use an array in buffer_text instead.
2080 That would also allow us to preserve it ordered. */
2081 struct Lisp_Marker
*next
;
2082 /* This is the char position where the marker points. */
2084 /* This is the byte position.
2085 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2086 used to implement the functionality of markers, but rather to (ab)use
2087 markers as a cache for char<->byte mappings). */
2091 /* START and END are markers in the overlay's buffer, and
2092 PLIST is the overlay's property list. */
2094 /* An overlay's real data content is:
2096 - buffer (really there are two buffer pointers, one per marker,
2097 and both points to the same buffer)
2098 - insertion type of both ends (per-marker fields)
2099 - start & start byte (of start marker)
2100 - end & end byte (of end marker)
2101 - next (singly linked list of overlays)
2102 - next fields of start and end markers (singly linked list of markers).
2103 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2106 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2107 bool_bf gcmarkbit
: 1;
2108 unsigned spacer
: 15;
2109 struct Lisp_Overlay
*next
;
2115 /* Types of data which may be saved in a Lisp_Save_Value. */
2126 /* Number of bits needed to store one of the above values. */
2127 enum { SAVE_SLOT_BITS
= 3 };
2129 /* Number of slots in a save value where save_type is nonzero. */
2130 enum { SAVE_VALUE_SLOTS
= 4 };
2132 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2134 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2138 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2139 SAVE_TYPE_INT_INT_INT
2140 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2141 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2142 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2143 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2144 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2145 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2146 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2147 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2148 SAVE_TYPE_FUNCPTR_PTR_OBJ
2149 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2151 /* This has an extra bit indicating it's raw memory. */
2152 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2155 /* Special object used to hold a different values for later use.
2157 This is mostly used to package C integers and pointers to call
2158 record_unwind_protect when two or more values need to be saved.
2162 struct my_data *md = get_my_data ();
2163 ptrdiff_t mi = get_my_integer ();
2164 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2167 Lisp_Object my_unwind (Lisp_Object arg)
2169 struct my_data *md = XSAVE_POINTER (arg, 0);
2170 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2174 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2175 saved objects and raise eassert if type of the saved object doesn't match
2176 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2177 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2178 slot 0 is a pointer. */
2180 typedef void (*voidfuncptr
) (void);
2182 struct Lisp_Save_Value
2184 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2185 bool_bf gcmarkbit
: 1;
2186 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2188 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2189 V's data entries are determined by V->save_type. E.g., if
2190 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2191 V->data[1] is an integer, and V's other data entries are unused.
2193 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2194 a memory area containing V->data[1].integer potential Lisp_Objects. */
2195 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2198 voidfuncptr funcpointer
;
2201 } data
[SAVE_VALUE_SLOTS
];
2204 /* Return the type of V's Nth saved value. */
2206 save_type (struct Lisp_Save_Value
*v
, int n
)
2208 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2209 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2212 /* Get and set the Nth saved pointer. */
2215 XSAVE_POINTER (Lisp_Object obj
, int n
)
2217 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2218 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2221 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2223 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2224 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2227 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2229 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2230 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2233 /* Likewise for the saved integer. */
2236 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2238 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2239 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2242 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2244 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2245 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2248 /* Extract Nth saved object. */
2251 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2253 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2254 return XSAVE_VALUE (obj
)->data
[n
].object
;
2258 struct Lisp_User_Ptr
2260 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_User_Ptr */
2261 bool_bf gcmarkbit
: 1;
2262 unsigned spacer
: 15;
2264 void (*finalizer
) (void *);
2269 /* A finalizer sentinel. */
2270 struct Lisp_Finalizer
2272 struct Lisp_Misc_Any base
;
2274 /* Circular list of all active weak references. */
2275 struct Lisp_Finalizer
*prev
;
2276 struct Lisp_Finalizer
*next
;
2278 /* Call FUNCTION when the finalizer becomes unreachable, even if
2279 FUNCTION contains a reference to the finalizer; i.e., call
2280 FUNCTION when it is reachable _only_ through finalizers. */
2281 Lisp_Object function
;
2284 /* A miscellaneous object, when it's on the free list. */
2287 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2288 bool_bf gcmarkbit
: 1;
2289 unsigned spacer
: 15;
2290 union Lisp_Misc
*chain
;
2293 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2294 It uses one of these struct subtypes to get the type field. */
2298 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2299 struct Lisp_Free u_free
;
2300 struct Lisp_Marker u_marker
;
2301 struct Lisp_Overlay u_overlay
;
2302 struct Lisp_Save_Value u_save_value
;
2303 struct Lisp_Finalizer u_finalizer
;
2305 struct Lisp_User_Ptr u_user_ptr
;
2309 INLINE
union Lisp_Misc
*
2310 XMISC (Lisp_Object a
)
2312 return XUNTAG (a
, Lisp_Misc
);
2315 INLINE
struct Lisp_Misc_Any
*
2316 XMISCANY (Lisp_Object a
)
2318 eassert (MISCP (a
));
2319 return & XMISC (a
)->u_any
;
2322 INLINE
enum Lisp_Misc_Type
2323 XMISCTYPE (Lisp_Object a
)
2325 return XMISCANY (a
)->type
;
2328 INLINE
struct Lisp_Marker
*
2329 XMARKER (Lisp_Object a
)
2331 eassert (MARKERP (a
));
2332 return & XMISC (a
)->u_marker
;
2335 INLINE
struct Lisp_Overlay
*
2336 XOVERLAY (Lisp_Object a
)
2338 eassert (OVERLAYP (a
));
2339 return & XMISC (a
)->u_overlay
;
2342 INLINE
struct Lisp_Save_Value
*
2343 XSAVE_VALUE (Lisp_Object a
)
2345 eassert (SAVE_VALUEP (a
));
2346 return & XMISC (a
)->u_save_value
;
2349 INLINE
struct Lisp_Finalizer
*
2350 XFINALIZER (Lisp_Object a
)
2352 eassert (FINALIZERP (a
));
2353 return & XMISC (a
)->u_finalizer
;
2357 INLINE
struct Lisp_User_Ptr
*
2358 XUSER_PTR (Lisp_Object a
)
2360 eassert (USER_PTRP (a
));
2361 return & XMISC (a
)->u_user_ptr
;
2366 /* Forwarding pointer to an int variable.
2367 This is allowed only in the value cell of a symbol,
2368 and it means that the symbol's value really lives in the
2369 specified int variable. */
2372 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2376 /* Boolean forwarding pointer to an int variable.
2377 This is like Lisp_Intfwd except that the ostensible
2378 "value" of the symbol is t if the bool variable is true,
2379 nil if it is false. */
2382 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2386 /* Forwarding pointer to a Lisp_Object variable.
2387 This is allowed only in the value cell of a symbol,
2388 and it means that the symbol's value really lives in the
2389 specified variable. */
2392 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2393 Lisp_Object
*objvar
;
2396 /* Like Lisp_Objfwd except that value lives in a slot in the
2397 current buffer. Value is byte index of slot within buffer. */
2398 struct Lisp_Buffer_Objfwd
2400 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2402 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2403 Lisp_Object predicate
;
2406 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2407 the symbol has buffer-local or frame-local bindings. (Exception:
2408 some buffer-local variables are built-in, with their values stored
2409 in the buffer structure itself. They are handled differently,
2410 using struct Lisp_Buffer_Objfwd.)
2412 The `realvalue' slot holds the variable's current value, or a
2413 forwarding pointer to where that value is kept. This value is the
2414 one that corresponds to the loaded binding. To read or set the
2415 variable, you must first make sure the right binding is loaded;
2416 then you can access the value in (or through) `realvalue'.
2418 `buffer' and `frame' are the buffer and frame for which the loaded
2419 binding was found. If those have changed, to make sure the right
2420 binding is loaded it is necessary to find which binding goes with
2421 the current buffer and selected frame, then load it. To load it,
2422 first unload the previous binding, then copy the value of the new
2423 binding into `realvalue' (or through it). Also update
2424 LOADED-BINDING to point to the newly loaded binding.
2426 `local_if_set' indicates that merely setting the variable creates a
2427 local binding for the current buffer. Otherwise the latter, setting
2428 the variable does not do that; only make-local-variable does that. */
2430 struct Lisp_Buffer_Local_Value
2432 /* True means that merely setting the variable creates a local
2433 binding for the current buffer. */
2434 bool_bf local_if_set
: 1;
2435 /* True means this variable can have frame-local bindings, otherwise, it is
2436 can have buffer-local bindings. The two cannot be combined. */
2437 bool_bf frame_local
: 1;
2438 /* True means that the binding now loaded was found.
2439 Presumably equivalent to (defcell!=valcell). */
2441 /* If non-NULL, a forwarding to the C var where it should also be set. */
2442 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2443 /* The buffer or frame for which the loaded binding was found. */
2445 /* A cons cell that holds the default value. It has the form
2446 (SYMBOL . DEFAULT-VALUE). */
2447 Lisp_Object defcell
;
2448 /* The cons cell from `where's parameter alist.
2449 It always has the form (SYMBOL . VALUE)
2450 Note that if `forward' is non-nil, VALUE may be out of date.
2451 Also if the currently loaded binding is the default binding, then
2452 this is `eq'ual to defcell. */
2453 Lisp_Object valcell
;
2456 /* Like Lisp_Objfwd except that value lives in a slot in the
2458 struct Lisp_Kboard_Objfwd
2460 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2466 struct Lisp_Intfwd u_intfwd
;
2467 struct Lisp_Boolfwd u_boolfwd
;
2468 struct Lisp_Objfwd u_objfwd
;
2469 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2470 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2473 INLINE
enum Lisp_Fwd_Type
2474 XFWDTYPE (union Lisp_Fwd
*a
)
2476 return a
->u_intfwd
.type
;
2479 INLINE
struct Lisp_Buffer_Objfwd
*
2480 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2482 eassert (BUFFER_OBJFWDP (a
));
2483 return &a
->u_buffer_objfwd
;
2486 /* Lisp floating point type. */
2492 struct Lisp_Float
*chain
;
2497 XFLOAT_DATA (Lisp_Object f
)
2499 return XFLOAT (f
)->u
.data
;
2502 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2503 representations, have infinities and NaNs, and do not trap on
2504 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2505 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2506 wanted here, but is not quite right because Emacs does not require
2507 all the features of C11 Annex F (and does not require C11 at all,
2508 for that matter). */
2512 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2513 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2516 /* A character, declared with the following typedef, is a member
2517 of some character set associated with the current buffer. */
2518 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2520 typedef unsigned char UCHAR
;
2523 /* Meanings of slots in a Lisp_Compiled: */
2527 COMPILED_ARGLIST
= 0,
2528 COMPILED_BYTECODE
= 1,
2529 COMPILED_CONSTANTS
= 2,
2530 COMPILED_STACK_DEPTH
= 3,
2531 COMPILED_DOC_STRING
= 4,
2532 COMPILED_INTERACTIVE
= 5
2535 /* Flag bits in a character. These also get used in termhooks.h.
2536 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2537 (MUlti-Lingual Emacs) might need 22 bits for the character value
2538 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2541 CHAR_ALT
= 0x0400000,
2542 CHAR_SUPER
= 0x0800000,
2543 CHAR_HYPER
= 0x1000000,
2544 CHAR_SHIFT
= 0x2000000,
2545 CHAR_CTL
= 0x4000000,
2546 CHAR_META
= 0x8000000,
2548 CHAR_MODIFIER_MASK
=
2549 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2551 /* Actually, the current Emacs uses 22 bits for the character value
2556 /* Data type checking. */
2559 (NILP
) (Lisp_Object x
)
2561 return lisp_h_NILP (x
);
2565 NUMBERP (Lisp_Object x
)
2567 return INTEGERP (x
) || FLOATP (x
);
2570 NATNUMP (Lisp_Object x
)
2572 return INTEGERP (x
) && 0 <= XINT (x
);
2576 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2578 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2581 #define TYPE_RANGED_INTEGERP(type, x) \
2583 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2584 && XINT (x) <= TYPE_MAXIMUM (type))
2587 (CONSP
) (Lisp_Object x
)
2589 return lisp_h_CONSP (x
);
2592 (FLOATP
) (Lisp_Object x
)
2594 return lisp_h_FLOATP (x
);
2597 (MISCP
) (Lisp_Object x
)
2599 return lisp_h_MISCP (x
);
2602 (SYMBOLP
) (Lisp_Object x
)
2604 return lisp_h_SYMBOLP (x
);
2607 (INTEGERP
) (Lisp_Object x
)
2609 return lisp_h_INTEGERP (x
);
2612 (VECTORLIKEP
) (Lisp_Object x
)
2614 return lisp_h_VECTORLIKEP (x
);
2617 (MARKERP
) (Lisp_Object x
)
2619 return lisp_h_MARKERP (x
);
2623 STRINGP (Lisp_Object x
)
2625 return XTYPE (x
) == Lisp_String
;
2628 VECTORP (Lisp_Object x
)
2630 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2633 OVERLAYP (Lisp_Object x
)
2635 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2638 SAVE_VALUEP (Lisp_Object x
)
2640 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2644 FINALIZERP (Lisp_Object x
)
2646 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Finalizer
;
2651 USER_PTRP (Lisp_Object x
)
2653 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_User_Ptr
;
2658 AUTOLOADP (Lisp_Object x
)
2660 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2664 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2666 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2670 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2672 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2673 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2676 /* True if A is a pseudovector whose code is CODE. */
2678 PSEUDOVECTORP (Lisp_Object a
, int code
)
2680 if (! VECTORLIKEP (a
))
2684 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2685 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2686 return PSEUDOVECTOR_TYPEP (h
, code
);
2691 /* Test for specific pseudovector types. */
2694 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2696 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2700 PROCESSP (Lisp_Object a
)
2702 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2706 WINDOWP (Lisp_Object a
)
2708 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2712 TERMINALP (Lisp_Object a
)
2714 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2718 SUBRP (Lisp_Object a
)
2720 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2724 COMPILEDP (Lisp_Object a
)
2726 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2730 BUFFERP (Lisp_Object a
)
2732 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2736 CHAR_TABLE_P (Lisp_Object a
)
2738 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2742 SUB_CHAR_TABLE_P (Lisp_Object a
)
2744 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2748 BOOL_VECTOR_P (Lisp_Object a
)
2750 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2754 FRAMEP (Lisp_Object a
)
2756 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2759 /* Test for image (image . spec) */
2761 IMAGEP (Lisp_Object x
)
2763 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2768 ARRAYP (Lisp_Object x
)
2770 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2774 CHECK_LIST (Lisp_Object x
)
2776 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2780 (CHECK_LIST_CONS
) (Lisp_Object x
, Lisp_Object y
)
2782 lisp_h_CHECK_LIST_CONS (x
, y
);
2786 (CHECK_SYMBOL
) (Lisp_Object x
)
2788 lisp_h_CHECK_SYMBOL (x
);
2792 (CHECK_NUMBER
) (Lisp_Object x
)
2794 lisp_h_CHECK_NUMBER (x
);
2798 CHECK_STRING (Lisp_Object x
)
2800 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2803 CHECK_STRING_CAR (Lisp_Object x
)
2805 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2808 CHECK_CONS (Lisp_Object x
)
2810 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2813 CHECK_VECTOR (Lisp_Object x
)
2815 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2818 CHECK_BOOL_VECTOR (Lisp_Object x
)
2820 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2822 /* This is a bit special because we always need size afterwards. */
2824 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2830 wrong_type_argument (Qarrayp
, x
);
2833 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2835 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2838 CHECK_BUFFER (Lisp_Object x
)
2840 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2843 CHECK_WINDOW (Lisp_Object x
)
2845 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2849 CHECK_PROCESS (Lisp_Object x
)
2851 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2855 CHECK_NATNUM (Lisp_Object x
)
2857 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2860 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2863 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2864 args_out_of_range_3 \
2866 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2867 ? MOST_NEGATIVE_FIXNUM \
2869 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2871 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2873 if (TYPE_SIGNED (type)) \
2874 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2876 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2879 #define CHECK_NUMBER_COERCE_MARKER(x) \
2881 if (MARKERP ((x))) \
2882 XSETFASTINT (x, marker_position (x)); \
2884 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2888 XFLOATINT (Lisp_Object n
)
2890 return extract_float (n
);
2894 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2896 CHECK_TYPE (NUMBERP (x
), Qnumberp
, x
);
2899 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2902 XSETFASTINT (x, marker_position (x)); \
2904 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2907 /* Since we can't assign directly to the CAR or CDR fields of a cons
2908 cell, use these when checking that those fields contain numbers. */
2910 CHECK_NUMBER_CAR (Lisp_Object x
)
2912 Lisp_Object tmp
= XCAR (x
);
2918 CHECK_NUMBER_CDR (Lisp_Object x
)
2920 Lisp_Object tmp
= XCDR (x
);
2925 /* Define a built-in function for calling from Lisp.
2926 `lname' should be the name to give the function in Lisp,
2927 as a null-terminated C string.
2928 `fnname' should be the name of the function in C.
2929 By convention, it starts with F.
2930 `sname' should be the name for the C constant structure
2931 that records information on this function for internal use.
2932 By convention, it should be the same as `fnname' but with S instead of F.
2933 It's too bad that C macros can't compute this from `fnname'.
2934 `minargs' should be a number, the minimum number of arguments allowed.
2935 `maxargs' should be a number, the maximum number of arguments allowed,
2936 or else MANY or UNEVALLED.
2937 MANY means pass a vector of evaluated arguments,
2938 in the form of an integer number-of-arguments
2939 followed by the address of a vector of Lisp_Objects
2940 which contains the argument values.
2941 UNEVALLED means pass the list of unevaluated arguments
2942 `intspec' says how interactive arguments are to be fetched.
2943 If the string starts with a `(', `intspec' is evaluated and the resulting
2944 list is the list of arguments.
2945 If it's a string that doesn't start with `(', the value should follow
2946 the one of the doc string for `interactive'.
2947 A null string means call interactively with no arguments.
2948 `doc' is documentation for the user. */
2950 /* This version of DEFUN declares a function prototype with the right
2951 arguments, so we can catch errors with maxargs at compile-time. */
2953 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2954 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2955 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2956 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2957 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2958 { (Lisp_Object (__cdecl *)(void))fnname }, \
2959 minargs, maxargs, lname, intspec, 0}; \
2961 #else /* not _MSC_VER */
2962 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2963 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2964 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2965 { .a ## maxargs = fnname }, \
2966 minargs, maxargs, lname, intspec, 0}; \
2970 /* True if OBJ is a Lisp function. */
2972 FUNCTIONP (Lisp_Object obj
)
2974 return functionp (obj
);
2978 is how we define the symbol for function `name' at start-up time. */
2979 extern void defsubr (struct Lisp_Subr
*);
2987 /* Call a function F that accepts many args, passing it ARRAY's elements. */
2988 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
2990 /* Call a function F that accepts many args, passing it the remaining args,
2991 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
2992 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
2993 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
2994 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
2996 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2997 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2998 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2999 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
3000 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
3002 /* Macros we use to define forwarded Lisp variables.
3003 These are used in the syms_of_FILENAME functions.
3005 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
3006 lisp variable is actually a field in `struct emacs_globals'. The
3007 field's name begins with "f_", which is a convention enforced by
3008 these macros. Each such global has a corresponding #define in
3009 globals.h; the plain name should be used in the code.
3011 E.g., the global "cons_cells_consed" is declared as "int
3012 f_cons_cells_consed" in globals.h, but there is a define:
3014 #define cons_cells_consed globals.f_cons_cells_consed
3016 All C code uses the `cons_cells_consed' name. This is all done
3017 this way to support indirection for multi-threaded Emacs. */
3019 #define DEFVAR_LISP(lname, vname, doc) \
3021 static struct Lisp_Objfwd o_fwd; \
3022 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
3024 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
3026 static struct Lisp_Objfwd o_fwd; \
3027 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
3029 #define DEFVAR_BOOL(lname, vname, doc) \
3031 static struct Lisp_Boolfwd b_fwd; \
3032 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
3034 #define DEFVAR_INT(lname, vname, doc) \
3036 static struct Lisp_Intfwd i_fwd; \
3037 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
3040 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
3042 static struct Lisp_Objfwd o_fwd; \
3043 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
3046 #define DEFVAR_KBOARD(lname, vname, doc) \
3048 static struct Lisp_Kboard_Objfwd ko_fwd; \
3049 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
3052 /* Save and restore the instruction and environment pointers,
3053 without affecting the signal mask. */
3056 typedef jmp_buf sys_jmp_buf
;
3057 # define sys_setjmp(j) _setjmp (j)
3058 # define sys_longjmp(j, v) _longjmp (j, v)
3059 #elif defined HAVE_SIGSETJMP
3060 typedef sigjmp_buf sys_jmp_buf
;
3061 # define sys_setjmp(j) sigsetjmp (j, 0)
3062 # define sys_longjmp(j, v) siglongjmp (j, v)
3064 /* A platform that uses neither _longjmp nor siglongjmp; assume
3065 longjmp does not affect the sigmask. */
3066 typedef jmp_buf sys_jmp_buf
;
3067 # define sys_setjmp(j) setjmp (j)
3068 # define sys_longjmp(j, v) longjmp (j, v)
3072 /* Elisp uses several stacks:
3074 - the bytecode stack: used internally by the bytecode interpreter.
3075 Allocated from the C stack.
3076 - The specpdl stack: keeps track of active unwind-protect and
3077 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
3079 - The handler stack: keeps track of active catch tags and condition-case
3080 handlers. Allocated in a manually managed stack implemented by a
3081 doubly-linked list allocated via xmalloc and never freed. */
3083 /* Structure for recording Lisp call stack for backtrace purposes. */
3085 /* The special binding stack holds the outer values of variables while
3086 they are bound by a function application or a let form, stores the
3087 code to be executed for unwind-protect forms.
3089 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
3090 used all over the place, needs to be fast, and needs to know the size of
3091 union specbinding. But only eval.c should access it. */
3094 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
3095 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
3096 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
3097 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
3098 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
3099 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
3100 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3101 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
3102 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
3107 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3109 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3110 void (*func
) (Lisp_Object
);
3114 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3115 void (*func
) (void *);
3119 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3124 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3125 void (*func
) (void);
3128 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3129 /* `where' is not used in the case of SPECPDL_LET. */
3130 Lisp_Object symbol
, old_value
, where
;
3133 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3134 bool_bf debug_on_exit
: 1;
3135 Lisp_Object function
;
3141 extern union specbinding
*specpdl
;
3142 extern union specbinding
*specpdl_ptr
;
3143 extern ptrdiff_t specpdl_size
;
3146 SPECPDL_INDEX (void)
3148 return specpdl_ptr
- specpdl
;
3151 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3152 control structures. A struct handler contains all the information needed to
3153 restore the state of the interpreter after a non-local jump.
3155 handler structures are chained together in a doubly linked list; the `next'
3156 member points to the next outer catchtag and the `nextfree' member points in
3157 the other direction to the next inner element (which is typically the next
3158 free element since we mostly use it on the deepest handler).
3160 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3161 member is TAG, and then unbinds to it. The `val' member is used to
3162 hold VAL while the stack is unwound; `val' is returned as the value
3163 of the catch form. If there is a handler of type CATCHER_ALL, it will
3164 be treated as a handler for all invocations of `throw'; in this case
3165 `val' will be set to (TAG . VAL).
3167 All the other members are concerned with restoring the interpreter
3170 Members are volatile if their values need to survive _longjmp when
3171 a 'struct handler' is a local variable. */
3173 enum handlertype
{ CATCHER
, CONDITION_CASE
, CATCHER_ALL
};
3177 enum handlertype type
;
3178 Lisp_Object tag_or_ch
;
3180 struct handler
*next
;
3181 struct handler
*nextfree
;
3183 /* The bytecode interpreter can have several handlers active at the same
3184 time, so when we longjmp to one of them, it needs to know which handler
3185 this was and what was the corresponding internal state. This is stored
3186 here, and when we longjmp we make sure that handlerlist points to the
3188 Lisp_Object
*bytecode_top
;
3191 /* Most global vars are reset to their value via the specpdl mechanism,
3192 but a few others are handled by storing their value here. */
3194 EMACS_INT lisp_eval_depth
;
3196 int poll_suppress_count
;
3197 int interrupt_input_blocked
;
3198 struct byte_stack
*byte_stack
;
3201 extern Lisp_Object memory_signal_data
;
3203 /* An address near the bottom of the stack.
3204 Tells GC how to save a copy of the stack. */
3205 extern char *stack_bottom
;
3207 /* Check quit-flag and quit if it is non-nil.
3208 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
3209 So the program needs to do QUIT at times when it is safe to quit.
3210 Every loop that might run for a long time or might not exit
3211 ought to do QUIT at least once, at a safe place.
3212 Unless that is impossible, of course.
3213 But it is very desirable to avoid creating loops where QUIT is impossible.
3215 Exception: if you set immediate_quit to true,
3216 then the handler that responds to the C-g does the quit itself.
3217 This is a good thing to do around a loop that has no side effects
3218 and (in particular) cannot call arbitrary Lisp code.
3220 If quit-flag is set to `kill-emacs' the SIGINT handler has received
3221 a request to exit Emacs when it is safe to do. */
3223 extern void process_pending_signals (void);
3224 extern bool volatile pending_signals
;
3226 extern void process_quit_flag (void);
3229 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3230 process_quit_flag (); \
3231 else if (pending_signals) \
3232 process_pending_signals (); \
3236 /* True if ought to quit now. */
3238 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3240 extern Lisp_Object Vascii_downcase_table
;
3241 extern Lisp_Object Vascii_canon_table
;
3243 /* Call staticpro (&var) to protect static variable `var'. */
3245 void staticpro (Lisp_Object
*);
3247 /* Forward declarations for prototypes. */
3251 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3254 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3256 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3257 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3260 /* Functions to modify hash tables. */
3263 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3265 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3269 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3271 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3274 /* Use these functions to set Lisp_Object
3275 or pointer slots of struct Lisp_Symbol. */
3278 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3280 XSYMBOL (sym
)->function
= function
;
3284 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3286 XSYMBOL (sym
)->plist
= plist
;
3290 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3292 XSYMBOL (sym
)->next
= next
;
3295 /* Buffer-local (also frame-local) variable access functions. */
3298 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3300 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3304 /* Set overlay's property list. */
3307 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3309 XOVERLAY (overlay
)->plist
= plist
;
3312 /* Get text properties of S. */
3315 string_intervals (Lisp_Object s
)
3317 return XSTRING (s
)->intervals
;
3320 /* Set text properties of S to I. */
3323 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3325 XSTRING (s
)->intervals
= i
;
3328 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3329 of setting slots directly. */
3332 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3334 XCHAR_TABLE (table
)->defalt
= val
;
3337 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3339 XCHAR_TABLE (table
)->purpose
= val
;
3342 /* Set different slots in (sub)character tables. */
3345 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3347 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3348 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3352 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3354 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3355 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3359 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3361 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3364 /* Defined in data.c. */
3365 extern Lisp_Object
indirect_function (Lisp_Object
);
3366 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3367 enum Arith_Comparison
{
3372 ARITH_LESS_OR_EQUAL
,
3375 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3376 enum Arith_Comparison comparison
);
3378 /* Convert the integer I to an Emacs representation, either the integer
3379 itself, or a cons of two or three integers, or if all else fails a float.
3380 I should not have side effects. */
3381 #define INTEGER_TO_CONS(i) \
3382 (! FIXNUM_OVERFLOW_P (i) \
3384 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3385 extern Lisp_Object
intbig_to_lisp (intmax_t);
3386 extern Lisp_Object
uintbig_to_lisp (uintmax_t);
3388 /* Convert the Emacs representation CONS back to an integer of type
3389 TYPE, storing the result the variable VAR. Signal an error if CONS
3390 is not a valid representation or is out of range for TYPE. */
3391 #define CONS_TO_INTEGER(cons, type, var) \
3392 (TYPE_SIGNED (type) \
3393 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3394 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3395 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3396 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3398 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3399 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3400 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3402 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3403 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3404 extern void syms_of_data (void);
3405 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3407 /* Defined in cmds.c */
3408 extern void syms_of_cmds (void);
3409 extern void keys_of_cmds (void);
3411 /* Defined in coding.c. */
3412 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3413 ptrdiff_t, bool, bool, Lisp_Object
);
3414 extern void init_coding (void);
3415 extern void init_coding_once (void);
3416 extern void syms_of_coding (void);
3418 /* Defined in character.c. */
3419 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3420 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3421 extern void syms_of_character (void);
3423 /* Defined in charset.c. */
3424 extern void init_charset (void);
3425 extern void init_charset_once (void);
3426 extern void syms_of_charset (void);
3427 /* Structure forward declarations. */
3430 /* Defined in syntax.c. */
3431 extern void init_syntax_once (void);
3432 extern void syms_of_syntax (void);
3434 /* Defined in fns.c. */
3435 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3436 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3437 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3438 extern void sweep_weak_hash_tables (void);
3439 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3440 EMACS_UINT
sxhash (Lisp_Object
, int);
3441 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3442 Lisp_Object
, Lisp_Object
);
3443 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3444 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3446 void hash_remove_from_table (struct Lisp_Hash_Table
*, Lisp_Object
);
3447 extern struct hash_table_test hashtest_eq
, hashtest_eql
, hashtest_equal
;
3448 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3449 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3450 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3451 ptrdiff_t, ptrdiff_t);
3452 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3453 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3454 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3455 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3456 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3457 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3458 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3459 extern void clear_string_char_byte_cache (void);
3460 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3461 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3462 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3463 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3464 extern void syms_of_fns (void);
3466 /* Defined in floatfns.c. */
3467 extern void syms_of_floatfns (void);
3468 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3470 /* Defined in fringe.c. */
3471 extern void syms_of_fringe (void);
3472 extern void init_fringe (void);
3473 #ifdef HAVE_WINDOW_SYSTEM
3474 extern void mark_fringe_data (void);
3475 extern void init_fringe_once (void);
3476 #endif /* HAVE_WINDOW_SYSTEM */
3478 /* Defined in image.c. */
3479 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3480 extern void reset_image_types (void);
3481 extern void syms_of_image (void);
3483 /* Defined in insdel.c. */
3484 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3485 extern _Noreturn
void buffer_overflow (void);
3486 extern void make_gap (ptrdiff_t);
3487 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3488 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3489 ptrdiff_t, bool, bool);
3490 extern int count_combining_before (const unsigned char *,
3491 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3492 extern int count_combining_after (const unsigned char *,
3493 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3494 extern void insert (const char *, ptrdiff_t);
3495 extern void insert_and_inherit (const char *, ptrdiff_t);
3496 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3498 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3499 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3500 ptrdiff_t, ptrdiff_t, bool);
3501 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3502 extern void insert_char (int);
3503 extern void insert_string (const char *);
3504 extern void insert_before_markers (const char *, ptrdiff_t);
3505 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3506 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3507 ptrdiff_t, ptrdiff_t,
3509 extern void del_range (ptrdiff_t, ptrdiff_t);
3510 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3511 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3512 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3513 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3514 ptrdiff_t, ptrdiff_t, bool);
3515 extern void modify_text (ptrdiff_t, ptrdiff_t);
3516 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3517 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3518 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3519 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3520 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3521 ptrdiff_t, ptrdiff_t);
3522 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3523 ptrdiff_t, ptrdiff_t);
3524 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3525 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3526 const char *, ptrdiff_t, ptrdiff_t, bool);
3527 extern void syms_of_insdel (void);
3529 /* Defined in dispnew.c. */
3530 #if (defined PROFILING \
3531 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3532 _Noreturn
void __executable_start (void);
3534 extern Lisp_Object Vwindow_system
;
3535 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3537 /* Defined in xdisp.c. */
3538 extern bool noninteractive_need_newline
;
3539 extern Lisp_Object echo_area_buffer
[2];
3540 extern void add_to_log (char const *, ...);
3541 extern void vadd_to_log (char const *, va_list);
3542 extern void check_message_stack (void);
3543 extern void setup_echo_area_for_printing (bool);
3544 extern bool push_message (void);
3545 extern void pop_message_unwind (void);
3546 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3547 extern void restore_message (void);
3548 extern Lisp_Object
current_message (void);
3549 extern void clear_message (bool, bool);
3550 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3551 extern void message1 (const char *);
3552 extern void message1_nolog (const char *);
3553 extern void message3 (Lisp_Object
);
3554 extern void message3_nolog (Lisp_Object
);
3555 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3556 extern void message_with_string (const char *, Lisp_Object
, bool);
3557 extern void message_log_maybe_newline (void);
3558 extern void update_echo_area (void);
3559 extern void truncate_echo_area (ptrdiff_t);
3560 extern void redisplay (void);
3562 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3563 extern void syms_of_xdisp (void);
3564 extern void init_xdisp (void);
3565 extern Lisp_Object
safe_eval (Lisp_Object
);
3566 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3567 int *, int *, int *, int *, int *);
3569 /* Defined in xsettings.c. */
3570 extern void syms_of_xsettings (void);
3572 /* Defined in vm-limit.c. */
3573 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3575 /* Defined in character.c. */
3576 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3577 ptrdiff_t *, ptrdiff_t *);
3579 /* Defined in alloc.c. */
3580 extern void *my_heap_start (void);
3581 extern void check_pure_size (void);
3582 extern void free_misc (Lisp_Object
);
3583 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3584 extern void malloc_warning (const char *);
3585 extern _Noreturn
void memory_full (size_t);
3586 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3587 extern bool survives_gc_p (Lisp_Object
);
3588 extern void mark_object (Lisp_Object
);
3589 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3590 extern void refill_memory_reserve (void);
3592 extern void alloc_unexec_pre (void);
3593 extern void alloc_unexec_post (void);
3594 extern const char *pending_malloc_warning
;
3595 extern Lisp_Object zero_vector
;
3596 extern Lisp_Object
*stack_base
;
3597 extern EMACS_INT consing_since_gc
;
3598 extern EMACS_INT gc_relative_threshold
;
3599 extern EMACS_INT memory_full_cons_threshold
;
3600 extern Lisp_Object
list1 (Lisp_Object
);
3601 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3602 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3603 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3604 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3606 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3607 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3609 /* Build a frequently used 2/3/4-integer lists. */
3612 list2i (EMACS_INT x
, EMACS_INT y
)
3614 return list2 (make_number (x
), make_number (y
));
3618 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3620 return list3 (make_number (x
), make_number (y
), make_number (w
));
3624 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3626 return list4 (make_number (x
), make_number (y
),
3627 make_number (w
), make_number (h
));
3630 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3631 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3632 extern _Noreturn
void string_overflow (void);
3633 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3634 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3635 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3636 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3638 /* Make unibyte string from C string when the length isn't known. */
3641 build_unibyte_string (const char *str
)
3643 return make_unibyte_string (str
, strlen (str
));
3646 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3647 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3648 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3649 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3650 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3651 extern Lisp_Object
make_specified_string (const char *,
3652 ptrdiff_t, ptrdiff_t, bool);
3653 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3654 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3656 /* Make a string allocated in pure space, use STR as string data. */
3659 build_pure_c_string (const char *str
)
3661 return make_pure_c_string (str
, strlen (str
));
3664 /* Make a string from the data at STR, treating it as multibyte if the
3668 build_string (const char *str
)
3670 return make_string (str
, strlen (str
));
3673 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3674 extern void make_byte_code (struct Lisp_Vector
*);
3675 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3677 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3678 be sure that GC cannot happen until the vector is completely
3679 initialized. E.g. the following code is likely to crash:
3681 v = make_uninit_vector (3);
3683 ASET (v, 1, Ffunction_can_gc ());
3684 ASET (v, 2, obj1); */
3687 make_uninit_vector (ptrdiff_t size
)
3690 struct Lisp_Vector
*p
;
3692 p
= allocate_vector (size
);
3697 /* Like above, but special for sub char-tables. */
3700 make_uninit_sub_char_table (int depth
, int min_char
)
3702 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3703 Lisp_Object v
= make_uninit_vector (slots
);
3705 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3706 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3707 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3711 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3714 /* Allocate partially initialized pseudovector where all Lisp_Object
3715 slots are set to Qnil but the rest (if any) is left uninitialized. */
3717 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3718 ((type *) allocate_pseudovector (VECSIZE (type), \
3719 PSEUDOVECSIZE (type, field), \
3720 PSEUDOVECSIZE (type, field), tag))
3722 /* Allocate fully initialized pseudovector where all Lisp_Object
3723 slots are set to Qnil and the rest (if any) is zeroed. */
3725 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3726 ((type *) allocate_pseudovector (VECSIZE (type), \
3727 PSEUDOVECSIZE (type, field), \
3728 VECSIZE (type), tag))
3730 extern bool gc_in_progress
;
3731 extern bool abort_on_gc
;
3732 extern Lisp_Object
make_float (double);
3733 extern void display_malloc_warning (void);
3734 extern ptrdiff_t inhibit_garbage_collection (void);
3735 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3736 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3737 Lisp_Object
, Lisp_Object
);
3738 extern Lisp_Object
make_save_ptr (void *);
3739 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3740 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3741 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3743 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3744 extern void free_save_value (Lisp_Object
);
3745 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3746 extern void free_marker (Lisp_Object
);
3747 extern void free_cons (struct Lisp_Cons
*);
3748 extern void init_alloc_once (void);
3749 extern void init_alloc (void);
3750 extern void syms_of_alloc (void);
3751 extern struct buffer
* allocate_buffer (void);
3752 extern int valid_lisp_object_p (Lisp_Object
);
3753 #ifdef GC_CHECK_CONS_LIST
3754 extern void check_cons_list (void);
3756 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3759 /* Defined in gmalloc.c. */
3760 #if !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC && !defined SYSTEM_MALLOC
3761 extern size_t __malloc_extra_blocks
;
3763 #if !HAVE_DECL_ALIGNED_ALLOC
3764 extern void *aligned_alloc (size_t, size_t) ATTRIBUTE_MALLOC_SIZE ((2));
3766 extern void malloc_enable_thread (void);
3769 /* Defined in ralloc.c. */
3770 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3771 extern void r_alloc_free (void **);
3772 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3773 extern void r_alloc_reset_variable (void **, void **);
3774 extern void r_alloc_inhibit_buffer_relocation (int);
3777 /* Defined in chartab.c. */
3778 extern Lisp_Object
copy_char_table (Lisp_Object
);
3779 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3781 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3782 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3784 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3785 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3786 Lisp_Object
, Lisp_Object
,
3787 Lisp_Object
, struct charset
*,
3788 unsigned, unsigned);
3789 extern Lisp_Object
uniprop_table (Lisp_Object
);
3790 extern void syms_of_chartab (void);
3792 /* Defined in print.c. */
3793 extern Lisp_Object Vprin1_to_string_buffer
;
3794 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3795 extern void temp_output_buffer_setup (const char *);
3796 extern int print_level
;
3797 extern void write_string (const char *);
3798 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3800 extern Lisp_Object internal_with_output_to_temp_buffer
3801 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3802 #define FLOAT_TO_STRING_BUFSIZE 350
3803 extern int float_to_string (char *, double);
3804 extern void init_print_once (void);
3805 extern void syms_of_print (void);
3807 /* Defined in doprnt.c. */
3808 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3810 extern ptrdiff_t esprintf (char *, char const *, ...)
3811 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3812 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3814 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3815 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3816 char const *, va_list)
3817 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3819 /* Defined in lread.c. */
3820 extern Lisp_Object
check_obarray (Lisp_Object
);
3821 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3822 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3823 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3824 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3825 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3827 LOADHIST_ATTACH (Lisp_Object x
)
3830 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3832 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3833 Lisp_Object
*, Lisp_Object
, bool);
3834 extern Lisp_Object
string_to_number (char const *, int, bool);
3835 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3837 extern void dir_warning (const char *, Lisp_Object
);
3838 extern void init_obarray (void);
3839 extern void init_lread (void);
3840 extern void syms_of_lread (void);
3843 intern (const char *str
)
3845 return intern_1 (str
, strlen (str
));
3849 intern_c_string (const char *str
)
3851 return intern_c_string_1 (str
, strlen (str
));
3854 /* Defined in eval.c. */
3855 extern Lisp_Object Vautoload_queue
;
3856 extern Lisp_Object Vrun_hooks
;
3857 extern Lisp_Object Vsignaling_function
;
3858 extern Lisp_Object inhibit_lisp_code
;
3859 extern struct handler
*handlerlist
;
3861 /* To run a normal hook, use the appropriate function from the list below.
3862 The calling convention:
3864 if (!NILP (Vrun_hooks))
3865 call1 (Vrun_hooks, Qmy_funny_hook);
3867 should no longer be used. */
3868 extern void run_hook (Lisp_Object
);
3869 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3870 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3871 Lisp_Object (*funcall
)
3872 (ptrdiff_t nargs
, Lisp_Object
*args
));
3873 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3874 extern _Noreturn
void xsignal0 (Lisp_Object
);
3875 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3876 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3877 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3879 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3880 extern Lisp_Object
eval_sub (Lisp_Object form
);
3881 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3882 extern Lisp_Object
call0 (Lisp_Object
);
3883 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3884 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3885 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3886 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3887 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3888 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3889 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3890 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3891 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3892 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3893 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3894 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3895 extern Lisp_Object internal_condition_case_n
3896 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3897 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3898 extern struct handler
*push_handler (Lisp_Object
, enum handlertype
);
3899 extern struct handler
*push_handler_nosignal (Lisp_Object
, enum handlertype
);
3900 extern void specbind (Lisp_Object
, Lisp_Object
);
3901 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3902 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3903 extern void record_unwind_protect_int (void (*) (int), int);
3904 extern void record_unwind_protect_void (void (*) (void));
3905 extern void record_unwind_protect_nothing (void);
3906 extern void clear_unwind_protect (ptrdiff_t);
3907 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3908 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3909 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3910 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3911 extern _Noreturn
void verror (const char *, va_list)
3912 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3913 extern void un_autoload (Lisp_Object
);
3914 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3915 extern void *near_C_stack_top (void);
3916 extern void init_eval_once (void);
3917 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3918 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3919 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3920 extern void init_eval (void);
3921 extern void syms_of_eval (void);
3922 extern void unwind_body (Lisp_Object
);
3923 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
3924 extern void mark_specpdl (void);
3925 extern void get_backtrace (Lisp_Object array
);
3926 Lisp_Object
backtrace_top_function (void);
3927 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3928 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3931 /* Defined in alloc.c. */
3932 extern Lisp_Object
make_user_ptr (void (*finalizer
) (void *), void *p
);
3934 /* Defined in emacs-module.c. */
3935 extern void module_init (void);
3936 extern void syms_of_module (void);
3939 /* Defined in editfns.c. */
3940 extern void insert1 (Lisp_Object
);
3941 extern Lisp_Object
save_excursion_save (void);
3942 extern Lisp_Object
save_restriction_save (void);
3943 extern void save_excursion_restore (Lisp_Object
);
3944 extern void save_restriction_restore (Lisp_Object
);
3945 extern _Noreturn
void time_overflow (void);
3946 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3947 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3949 extern void init_editfns (bool);
3950 extern void syms_of_editfns (void);
3952 /* Defined in buffer.c. */
3953 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3954 extern _Noreturn
void nsberror (Lisp_Object
);
3955 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3956 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3957 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3958 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3959 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3960 extern bool overlay_touches_p (ptrdiff_t);
3961 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3962 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3963 extern void init_buffer_once (void);
3964 extern void init_buffer (int);
3965 extern void syms_of_buffer (void);
3966 extern void keys_of_buffer (void);
3968 /* Defined in marker.c. */
3970 extern ptrdiff_t marker_position (Lisp_Object
);
3971 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3972 extern void clear_charpos_cache (struct buffer
*);
3973 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3974 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3975 extern void unchain_marker (struct Lisp_Marker
*marker
);
3976 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3977 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3978 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3979 ptrdiff_t, ptrdiff_t);
3980 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3981 extern void syms_of_marker (void);
3983 /* Defined in fileio.c. */
3985 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3986 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3987 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3989 extern void close_file_unwind (int);
3990 extern void fclose_unwind (void *);
3991 extern void restore_point_unwind (Lisp_Object
);
3992 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3993 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3994 extern _Noreturn
void report_file_notify_error (const char *, Lisp_Object
);
3995 extern bool internal_delete_file (Lisp_Object
);
3996 extern Lisp_Object
emacs_readlinkat (int, const char *);
3997 extern bool file_directory_p (const char *);
3998 extern bool file_accessible_directory_p (Lisp_Object
);
3999 extern void init_fileio (void);
4000 extern void syms_of_fileio (void);
4001 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
4003 /* Defined in search.c. */
4004 extern void shrink_regexp_cache (void);
4005 extern void restore_search_regs (void);
4006 extern void record_unwind_save_match_data (void);
4007 struct re_registers
;
4008 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4009 struct re_registers
*,
4010 Lisp_Object
, bool, bool);
4011 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
4015 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
4017 return fast_string_match_internal (regexp
, string
, Qnil
);
4021 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
4023 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
4026 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4028 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4029 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4030 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4031 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4032 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4034 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
4035 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4036 ptrdiff_t, ptrdiff_t *);
4037 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4038 ptrdiff_t, ptrdiff_t *);
4039 extern void syms_of_search (void);
4040 extern void clear_regexp_cache (void);
4042 /* Defined in minibuf.c. */
4044 extern Lisp_Object Vminibuffer_list
;
4045 extern Lisp_Object last_minibuf_string
;
4046 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4047 extern void init_minibuf_once (void);
4048 extern void syms_of_minibuf (void);
4050 /* Defined in callint.c. */
4052 extern void syms_of_callint (void);
4054 /* Defined in casefiddle.c. */
4056 extern void syms_of_casefiddle (void);
4057 extern void keys_of_casefiddle (void);
4059 /* Defined in casetab.c. */
4061 extern void init_casetab_once (void);
4062 extern void syms_of_casetab (void);
4064 /* Defined in keyboard.c. */
4066 extern Lisp_Object echo_message_buffer
;
4067 extern struct kboard
*echo_kboard
;
4068 extern void cancel_echoing (void);
4069 extern bool input_pending
;
4070 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4071 extern sigjmp_buf return_to_command_loop
;
4073 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4074 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4075 extern void discard_mouse_events (void);
4077 void handle_input_available_signal (int);
4079 extern Lisp_Object pending_funcalls
;
4080 extern bool detect_input_pending (void);
4081 extern bool detect_input_pending_ignore_squeezables (void);
4082 extern bool detect_input_pending_run_timers (bool);
4083 extern void safe_run_hooks (Lisp_Object
);
4084 extern void cmd_error_internal (Lisp_Object
, const char *);
4085 extern Lisp_Object
command_loop_1 (void);
4086 extern Lisp_Object
read_menu_command (void);
4087 extern Lisp_Object
recursive_edit_1 (void);
4088 extern void record_auto_save (void);
4089 extern void force_auto_save_soon (void);
4090 extern void init_keyboard (void);
4091 extern void syms_of_keyboard (void);
4092 extern void keys_of_keyboard (void);
4094 /* Defined in indent.c. */
4095 extern ptrdiff_t current_column (void);
4096 extern void invalidate_current_column (void);
4097 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4098 extern void syms_of_indent (void);
4100 /* Defined in frame.c. */
4101 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4102 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4103 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4104 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4105 extern void frames_discard_buffer (Lisp_Object
);
4106 extern void syms_of_frame (void);
4108 /* Defined in emacs.c. */
4109 extern char **initial_argv
;
4110 extern int initial_argc
;
4111 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4112 extern bool display_arg
;
4114 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4115 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4116 extern _Noreturn
void terminate_due_to_signal (int, int);
4118 extern Lisp_Object Vlibrary_cache
;
4121 void fixup_locale (void);
4122 void synchronize_system_messages_locale (void);
4123 void synchronize_system_time_locale (void);
4125 INLINE
void fixup_locale (void) {}
4126 INLINE
void synchronize_system_messages_locale (void) {}
4127 INLINE
void synchronize_system_time_locale (void) {}
4129 extern void shut_down_emacs (int, Lisp_Object
);
4131 /* True means don't do interactive redisplay and don't change tty modes. */
4132 extern bool noninteractive
;
4134 /* True means remove site-lisp directories from load-path. */
4135 extern bool no_site_lisp
;
4137 /* Pipe used to send exit notification to the daemon parent at
4138 startup. On Windows, we use a kernel event instead. */
4140 extern int daemon_pipe
[2];
4141 #define IS_DAEMON (daemon_pipe[1] != 0)
4142 #define DAEMON_RUNNING (daemon_pipe[1] >= 0)
4143 #else /* WINDOWSNT */
4144 extern void *w32_daemon_event
;
4145 #define IS_DAEMON (w32_daemon_event != NULL)
4146 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4149 /* True if handling a fatal error already. */
4150 extern bool fatal_error_in_progress
;
4152 /* True means don't do use window-system-specific display code. */
4153 extern bool inhibit_window_system
;
4154 /* True means that a filter or a sentinel is running. */
4155 extern bool running_asynch_code
;
4157 /* Defined in process.c. */
4158 extern void kill_buffer_processes (Lisp_Object
);
4159 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4160 struct Lisp_Process
*, int);
4161 /* Max value for the first argument of wait_reading_process_output. */
4162 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4163 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4164 The bug merely causes a bogus warning, but the warning is annoying. */
4165 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4167 # define WAIT_READING_MAX INTMAX_MAX
4170 extern void add_timer_wait_descriptor (int);
4172 extern void add_keyboard_wait_descriptor (int);
4173 extern void delete_keyboard_wait_descriptor (int);
4175 extern void add_gpm_wait_descriptor (int);
4176 extern void delete_gpm_wait_descriptor (int);
4178 extern void init_process_emacs (void);
4179 extern void syms_of_process (void);
4180 extern void setup_process_coding_systems (Lisp_Object
);
4182 /* Defined in callproc.c. */
4186 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4187 extern void init_callproc_1 (void);
4188 extern void init_callproc (void);
4189 extern void set_initial_environment (void);
4190 extern void syms_of_callproc (void);
4192 /* Defined in doc.c. */
4193 enum text_quoting_style
4195 /* Use curved single quotes ‘like this’. */
4196 CURVE_QUOTING_STYLE
,
4198 /* Use grave accent and apostrophe `like this'. */
4199 GRAVE_QUOTING_STYLE
,
4201 /* Use apostrophes 'like this'. */
4202 STRAIGHT_QUOTING_STYLE
4204 extern enum text_quoting_style
text_quoting_style (void);
4205 extern Lisp_Object
read_doc_string (Lisp_Object
);
4206 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4207 extern void syms_of_doc (void);
4208 extern int read_bytecode_char (bool);
4210 /* Defined in bytecode.c. */
4211 extern void syms_of_bytecode (void);
4212 extern struct byte_stack
*byte_stack_list
;
4213 extern void relocate_byte_stack (void);
4214 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4215 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4217 /* Defined in macros.c. */
4218 extern void init_macros (void);
4219 extern void syms_of_macros (void);
4221 /* Defined in undo.c. */
4222 extern void truncate_undo_list (struct buffer
*);
4223 extern void record_insert (ptrdiff_t, ptrdiff_t);
4224 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4225 extern void record_first_change (void);
4226 extern void record_change (ptrdiff_t, ptrdiff_t);
4227 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4228 Lisp_Object
, Lisp_Object
,
4230 extern void syms_of_undo (void);
4232 /* Defined in textprop.c. */
4233 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4235 /* Defined in menu.c. */
4236 extern void syms_of_menu (void);
4238 /* Defined in xmenu.c. */
4239 extern void syms_of_xmenu (void);
4241 /* Defined in termchar.h. */
4242 struct tty_display_info
;
4244 /* Defined in termhooks.h. */
4247 /* Defined in sysdep.c. */
4248 extern char *emacs_get_current_dir_name (void);
4249 extern void stuff_char (char c
);
4250 extern void init_foreground_group (void);
4251 extern void sys_subshell (void);
4252 extern void sys_suspend (void);
4253 extern void discard_tty_input (void);
4254 extern void init_sys_modes (struct tty_display_info
*);
4255 extern void reset_sys_modes (struct tty_display_info
*);
4256 extern void init_all_sys_modes (void);
4257 extern void reset_all_sys_modes (void);
4258 extern void child_setup_tty (int);
4259 extern void setup_pty (int);
4260 extern int set_window_size (int, int, int);
4261 extern EMACS_INT
get_random (void);
4262 extern void seed_random (void *, ptrdiff_t);
4263 extern void init_random (void);
4264 extern void emacs_backtrace (int);
4265 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4266 extern int emacs_open (const char *, int, int);
4267 extern int emacs_pipe (int[2]);
4268 extern int emacs_close (int);
4269 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4270 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4271 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4272 extern void emacs_perror (char const *);
4274 extern void unlock_all_files (void);
4275 extern void lock_file (Lisp_Object
);
4276 extern void unlock_file (Lisp_Object
);
4277 extern void unlock_buffer (struct buffer
*);
4278 extern void syms_of_filelock (void);
4279 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4281 /* Defined in sound.c. */
4282 extern void syms_of_sound (void);
4284 /* Defined in category.c. */
4285 extern void init_category_once (void);
4286 extern Lisp_Object
char_category_set (int);
4287 extern void syms_of_category (void);
4289 /* Defined in ccl.c. */
4290 extern void syms_of_ccl (void);
4292 /* Defined in dired.c. */
4293 extern void syms_of_dired (void);
4294 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4295 Lisp_Object
, Lisp_Object
,
4298 /* Defined in term.c. */
4299 extern int *char_ins_del_vector
;
4300 extern void syms_of_term (void);
4301 extern _Noreturn
void fatal (const char *msgid
, ...)
4302 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4304 /* Defined in terminal.c. */
4305 extern void syms_of_terminal (void);
4307 /* Defined in font.c. */
4308 extern void syms_of_font (void);
4309 extern void init_font (void);
4311 #ifdef HAVE_WINDOW_SYSTEM
4312 /* Defined in fontset.c. */
4313 extern void syms_of_fontset (void);
4316 /* Defined in inotify.c */
4318 extern void syms_of_inotify (void);
4321 /* Defined in kqueue.c */
4323 extern void globals_of_kqueue (void);
4324 extern void syms_of_kqueue (void);
4327 /* Defined in gfilenotify.c */
4328 #ifdef HAVE_GFILENOTIFY
4329 extern void globals_of_gfilenotify (void);
4330 extern void syms_of_gfilenotify (void);
4333 #ifdef HAVE_W32NOTIFY
4334 /* Defined on w32notify.c. */
4335 extern void syms_of_w32notify (void);
4338 /* Defined in xfaces.c. */
4339 extern Lisp_Object Vface_alternative_font_family_alist
;
4340 extern Lisp_Object Vface_alternative_font_registry_alist
;
4341 extern void syms_of_xfaces (void);
4343 #ifdef HAVE_X_WINDOWS
4344 /* Defined in xfns.c. */
4345 extern void syms_of_xfns (void);
4347 /* Defined in xsmfns.c. */
4348 extern void syms_of_xsmfns (void);
4350 /* Defined in xselect.c. */
4351 extern void syms_of_xselect (void);
4353 /* Defined in xterm.c. */
4354 extern void init_xterm (void);
4355 extern void syms_of_xterm (void);
4356 #endif /* HAVE_X_WINDOWS */
4358 #ifdef HAVE_WINDOW_SYSTEM
4359 /* Defined in xterm.c, nsterm.m, w32term.c. */
4360 extern char *x_get_keysym_name (int);
4361 #endif /* HAVE_WINDOW_SYSTEM */
4364 /* Defined in xml.c. */
4365 extern void syms_of_xml (void);
4366 extern void xml_cleanup_parser (void);
4370 /* Defined in decompress.c. */
4371 extern void syms_of_decompress (void);
4375 /* Defined in dbusbind.c. */
4376 void init_dbusbind (void);
4377 void syms_of_dbusbind (void);
4381 /* Defined in profiler.c. */
4382 extern bool profiler_memory_running
;
4383 extern void malloc_probe (size_t);
4384 extern void syms_of_profiler (void);
4388 /* Defined in msdos.c, w32.c. */
4389 extern char *emacs_root_dir (void);
4392 /* Defined in lastfile.c. */
4393 extern char my_edata
[];
4394 extern char my_endbss
[];
4395 extern char *my_endbss_static
;
4397 /* True means ^G can quit instantly. */
4398 extern bool immediate_quit
;
4400 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4401 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4402 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4403 extern void xfree (void *);
4404 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4405 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4406 ATTRIBUTE_ALLOC_SIZE ((2,3));
4407 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4409 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4410 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4411 extern void dupstring (char **, char const *);
4413 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4414 null byte. This is like stpcpy, except the source is a Lisp string. */
4417 lispstpcpy (char *dest
, Lisp_Object string
)
4419 ptrdiff_t len
= SBYTES (string
);
4420 memcpy (dest
, SDATA (string
), len
+ 1);
4424 extern void xputenv (const char *);
4426 extern char *egetenv_internal (const char *, ptrdiff_t);
4429 egetenv (const char *var
)
4431 /* When VAR is a string literal, strlen can be optimized away. */
4432 return egetenv_internal (var
, strlen (var
));
4435 /* Set up the name of the machine we're running on. */
4436 extern void init_system_name (void);
4438 /* Return the absolute value of X. X should be a signed integer
4439 expression without side effects, and X's absolute value should not
4440 exceed the maximum for its promoted type. This is called 'eabs'
4441 because 'abs' is reserved by the C standard. */
4442 #define eabs(x) ((x) < 0 ? -(x) : (x))
4444 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4447 #define make_fixnum_or_float(val) \
4448 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4450 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4451 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4453 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4455 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4457 #define USE_SAFE_ALLOCA \
4458 ptrdiff_t sa_avail = MAX_ALLOCA; \
4459 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4461 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4463 /* SAFE_ALLOCA allocates a simple buffer. */
4465 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4466 ? AVAIL_ALLOCA (size) \
4467 : (sa_must_free = true, record_xmalloc (size)))
4469 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4470 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4471 positive. The code is tuned for MULTIPLIER being a constant. */
4473 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4475 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4476 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4479 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4480 sa_must_free = true; \
4481 record_unwind_protect_ptr (xfree, buf); \
4485 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4487 #define SAFE_ALLOCA_STRING(ptr, string) \
4489 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4490 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4493 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4495 #define SAFE_FREE() \
4497 if (sa_must_free) { \
4498 sa_must_free = false; \
4499 unbind_to (sa_count, Qnil); \
4503 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4505 #define SAFE_ALLOCA_LISP(buf, nelt) \
4507 ptrdiff_t alloca_nbytes; \
4508 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4509 || SIZE_MAX < alloca_nbytes) \
4510 memory_full (SIZE_MAX); \
4511 else if (alloca_nbytes <= sa_avail) \
4512 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4516 (buf) = xmalloc (alloca_nbytes); \
4517 arg_ = make_save_memory (buf, nelt); \
4518 sa_must_free = true; \
4519 record_unwind_protect (free_save_value, arg_); \
4524 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4525 block-scoped conses and strings. These objects are not
4526 managed by the garbage collector, so they are dangerous: passing them
4527 out of their scope (e.g., to user code) results in undefined behavior.
4528 Conversely, they have better performance because GC is not involved.
4530 This feature is experimental and requires careful debugging.
4531 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4533 #ifndef USE_STACK_LISP_OBJECTS
4534 # define USE_STACK_LISP_OBJECTS true
4537 #ifdef GC_CHECK_STRING_BYTES
4538 enum { defined_GC_CHECK_STRING_BYTES
= true };
4540 enum { defined_GC_CHECK_STRING_BYTES
= false };
4543 /* Struct inside unions that are typically no larger and aligned enough. */
4548 double d
; intmax_t i
; void *p
;
4551 union Aligned_String
4553 struct Lisp_String s
;
4554 double d
; intmax_t i
; void *p
;
4557 /* True for stack-based cons and string implementations, respectively.
4558 Use stack-based strings only if stack-based cons also works.
4559 Otherwise, STACK_CONS would create heap-based cons cells that
4560 could point to stack-based strings, which is a no-no. */
4564 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4565 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4566 USE_STACK_STRING
= (USE_STACK_CONS
4567 && !defined_GC_CHECK_STRING_BYTES
4568 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4571 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4572 use these only in macros like AUTO_CONS that declare a local
4573 variable whose lifetime will be clear to the programmer. */
4574 #define STACK_CONS(a, b) \
4575 make_lisp_ptr (&(union Aligned_Cons) { { a, { b } } }.s, Lisp_Cons)
4576 #define AUTO_CONS_EXPR(a, b) \
4577 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4579 /* Declare NAME as an auto Lisp cons or short list if possible, a
4580 GC-based one otherwise. This is in the sense of the C keyword
4581 'auto'; i.e., the object has the lifetime of the containing block.
4582 The resulting object should not be made visible to user Lisp code. */
4584 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4585 #define AUTO_LIST1(name, a) \
4586 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4587 #define AUTO_LIST2(name, a, b) \
4588 Lisp_Object name = (USE_STACK_CONS \
4589 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4591 #define AUTO_LIST3(name, a, b, c) \
4592 Lisp_Object name = (USE_STACK_CONS \
4593 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4595 #define AUTO_LIST4(name, a, b, c, d) \
4598 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4599 STACK_CONS (d, Qnil)))) \
4600 : list4 (a, b, c, d))
4602 /* Check whether stack-allocated strings are ASCII-only. */
4604 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
4605 extern const char *verify_ascii (const char *);
4607 # define verify_ascii(str) (str)
4610 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4611 Take its value from STR. STR is not necessarily copied and should
4612 contain only ASCII characters. The resulting Lisp string should
4613 not be modified or made visible to user code. */
4615 #define AUTO_STRING(name, str) \
4616 Lisp_Object name = \
4619 ((&(union Aligned_String) \
4620 {{strlen (str), -1, 0, (unsigned char *) verify_ascii (str)}}.s), \
4622 : build_string (verify_ascii (str)))
4624 /* Loop over all tails of a list, checking for cycles.
4625 FIXME: Make tortoise and n internal declarations.
4626 FIXME: Unroll the loop body so we don't need `n'. */
4627 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4628 for ((tortoise) = (hare) = (list), (n) = true; \
4630 (hare = XCDR (hare), (n) = !(n), \
4632 ? (EQ (hare, tortoise) \
4633 ? xsignal1 (Qcircular_list, list) \
4635 /* Move tortoise before the next iteration, in case */ \
4636 /* the next iteration does an Fsetcdr. */ \
4637 : (void) ((tortoise) = XCDR (tortoise)))))
4639 /* Do a `for' loop over alist values. */
4641 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4642 for ((list_var) = (head_var); \
4643 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4644 (list_var) = XCDR (list_var))
4646 /* Check whether it's time for GC, and run it if so. */
4651 if ((consing_since_gc
> gc_cons_threshold
4652 && consing_since_gc
> gc_relative_threshold
)
4653 || (!NILP (Vmemory_full
)
4654 && consing_since_gc
> memory_full_cons_threshold
))
4655 Fgarbage_collect ();
4659 functionp (Lisp_Object object
)
4661 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4663 object
= Findirect_function (object
, Qt
);
4665 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4667 /* Autoloaded symbols are functions, except if they load
4668 macros or keymaps. */
4670 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4671 object
= XCDR (object
);
4673 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4678 return XSUBR (object
)->max_args
!= UNEVALLED
;
4679 else if (COMPILEDP (object
))
4681 else if (CONSP (object
))
4683 Lisp_Object car
= XCAR (object
);
4684 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4692 #endif /* EMACS_LISP_H */