1 /* Fundamental definitions for GNU Emacs Lisp interpreter. -*- coding: utf-8 -*-
3 Copyright (C) 1985-1987, 1993-1995, 1997-2017 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
39 /* Define a TYPE constant ID as an externally visible name. Use like this:
41 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
42 # define ID (some integer preprocessor expression of type TYPE)
43 DEFINE_GDB_SYMBOL_END (ID)
45 This hack is for the benefit of compilers that do not make macro
46 definitions or enums visible to the debugger. It's used for symbols
47 that .gdbinit needs. */
49 #define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
51 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
52 # define DEFINE_GDB_SYMBOL_END(id) = id;
54 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
55 # define DEFINE_GDB_SYMBOL_END(val) ;
58 /* The ubiquitous max and min macros. */
61 #define max(a, b) ((a) > (b) ? (a) : (b))
62 #define min(a, b) ((a) < (b) ? (a) : (b))
64 /* Number of elements in an array. */
65 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
67 /* Number of bits in a Lisp_Object tag. */
68 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
70 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
72 /* EMACS_INT - signed integer wide enough to hold an Emacs value
73 EMACS_INT_WIDTH - width in bits of EMACS_INT
74 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
75 pI - printf length modifier for EMACS_INT
76 EMACS_UINT - unsigned variant of EMACS_INT */
79 # error "INTPTR_MAX misconfigured"
80 # elif INTPTR_MAX <= INT_MAX && !defined WIDE_EMACS_INT
81 typedef int EMACS_INT
;
82 typedef unsigned int EMACS_UINT
;
83 enum { EMACS_INT_WIDTH
= INT_WIDTH
, EMACS_UINT_WIDTH
= UINT_WIDTH
};
84 # define EMACS_INT_MAX INT_MAX
86 # elif INTPTR_MAX <= LONG_MAX && !defined WIDE_EMACS_INT
87 typedef long int EMACS_INT
;
88 typedef unsigned long EMACS_UINT
;
89 enum { EMACS_INT_WIDTH
= LONG_WIDTH
, EMACS_UINT_WIDTH
= ULONG_WIDTH
};
90 # define EMACS_INT_MAX LONG_MAX
92 # elif INTPTR_MAX <= LLONG_MAX
93 typedef long long int EMACS_INT
;
94 typedef unsigned long long int EMACS_UINT
;
95 enum { EMACS_INT_WIDTH
= LLONG_WIDTH
, EMACS_UINT_WIDTH
= ULLONG_WIDTH
};
96 # define EMACS_INT_MAX LLONG_MAX
103 # error "INTPTR_MAX too large"
107 /* Number of bits to put in each character in the internal representation
108 of bool vectors. This should not vary across implementations. */
109 enum { BOOL_VECTOR_BITS_PER_CHAR
=
110 #define BOOL_VECTOR_BITS_PER_CHAR 8
111 BOOL_VECTOR_BITS_PER_CHAR
114 /* An unsigned integer type representing a fixed-length bit sequence,
115 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
116 for speed, but on weird platforms it is unsigned char and not all
117 its bits are used. */
118 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
119 typedef size_t bits_word
;
120 # define BITS_WORD_MAX SIZE_MAX
121 enum { BITS_PER_BITS_WORD
= SIZE_WIDTH
};
123 typedef unsigned char bits_word
;
124 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
125 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
127 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
129 /* printmax_t and uprintmax_t are types for printing large integers.
130 These are the widest integers that are supported for printing.
131 pMd etc. are conversions for printing them.
132 On C99 hosts, there's no problem, as even the widest integers work.
133 Fall back on EMACS_INT on pre-C99 hosts. */
135 typedef intmax_t printmax_t
;
136 typedef uintmax_t uprintmax_t
;
140 typedef EMACS_INT printmax_t
;
141 typedef EMACS_UINT uprintmax_t
;
146 /* Use pD to format ptrdiff_t values, which suffice for indexes into
147 buffers and strings. Emacs never allocates objects larger than
148 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
149 In C99, pD can always be "t"; configure it here for the sake of
150 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
151 #if PTRDIFF_MAX == INT_MAX
153 #elif PTRDIFF_MAX == LONG_MAX
155 #elif PTRDIFF_MAX == LLONG_MAX
161 /* Extra internal type checking? */
163 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
164 'assume (COND)'. COND should be free of side effects, as it may or
165 may not be evaluated.
167 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
168 defined and suppress_checking is false, and does nothing otherwise.
169 Emacs dies if COND is checked and is false. The suppress_checking
170 variable is initialized to 0 in alloc.c. Set it to 1 using a
171 debugger to temporarily disable aborting on detected internal
172 inconsistencies or error conditions.
174 In some cases, a good compiler may be able to optimize away the
175 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
176 uses eassert to test STRINGP (x), but a particular use of XSTRING
177 is invoked only after testing that STRINGP (x) is true, making the
180 eassume is like eassert except that it also causes the compiler to
181 assume that COND is true afterwards, regardless of whether runtime
182 checking is enabled. This can improve performance in some cases,
183 though it can degrade performance in others. It's often suboptimal
184 for COND to call external functions or access volatile storage. */
186 #ifndef ENABLE_CHECKING
187 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
188 # define eassume(cond) assume (cond)
189 #else /* ENABLE_CHECKING */
191 extern _Noreturn
void die (const char *, const char *, int);
193 extern bool suppress_checking EXTERNALLY_VISIBLE
;
195 # define eassert(cond) \
196 (suppress_checking || (cond) \
198 : die (# cond, __FILE__, __LINE__))
199 # define eassume(cond) \
204 : die (# cond, __FILE__, __LINE__))
205 #endif /* ENABLE_CHECKING */
208 /* Use the configure flag --enable-check-lisp-object-type to make
209 Lisp_Object use a struct type instead of the default int. The flag
210 causes CHECK_LISP_OBJECT_TYPE to be defined. */
212 /***** Select the tagging scheme. *****/
213 /* The following option controls the tagging scheme:
214 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
215 always 0, and we can thus use them to hold tag bits, without
216 restricting our addressing space.
218 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
219 restricting our possible address range.
221 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
222 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
223 on the few static Lisp_Objects used: lispsym, all the defsubr, and
224 the two special buffers buffer_defaults and buffer_local_symbols. */
228 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
229 integer constant, for MSVC. */
230 #define GCALIGNMENT 8
232 /* Number of bits in a Lisp_Object value, not counting the tag. */
233 VALBITS
= EMACS_INT_WIDTH
- GCTYPEBITS
,
235 /* Number of bits in a Lisp fixnum tag. */
236 INTTYPEBITS
= GCTYPEBITS
- 1,
238 /* Number of bits in a Lisp fixnum value, not counting the tag. */
239 FIXNUM_BITS
= VALBITS
+ 1
242 #if GCALIGNMENT != 1 << GCTYPEBITS
243 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
246 /* The maximum value that can be stored in a EMACS_INT, assuming all
247 bits other than the type bits contribute to a nonnegative signed value.
248 This can be used in #if, e.g., '#if USE_LSB_TAG' below expands to an
249 expression involving VAL_MAX. */
250 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
252 /* Whether the least-significant bits of an EMACS_INT contain the tag.
253 On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
254 a. unnecessary, because the top bits of an EMACS_INT are unused, and
255 b. slower, because it typically requires extra masking.
256 So, USE_LSB_TAG is true only on hosts where it might be useful. */
257 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
258 #define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
259 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
261 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
262 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
263 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
264 DEFINE_GDB_SYMBOL_END (VALMASK
)
266 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
267 # error "USE_LSB_TAG not supported on this platform; please report this." \
268 "Try 'configure --with-wide-int' to work around the problem."
272 #ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
273 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
275 # define GCALIGNED /* empty */
278 /* Some operations are so commonly executed that they are implemented
279 as macros, not functions, because otherwise runtime performance would
280 suffer too much when compiling with GCC without optimization.
281 There's no need to inline everything, just the operations that
282 would otherwise cause a serious performance problem.
284 For each such operation OP, define a macro lisp_h_OP that contains
285 the operation's implementation. That way, OP can be implemented
286 via a macro definition like this:
288 #define OP(x) lisp_h_OP (x)
290 and/or via a function definition like this:
292 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
294 without worrying about the implementations diverging, since
295 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
296 are intended to be private to this include file, and should not be
299 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
300 functions, once "gcc -Og" (new to GCC 4.8) works well enough for
301 Emacs developers. Maybe in the year 2020. See Bug#11935.
303 Commentary for these macros can be found near their corresponding
306 #if CHECK_LISP_OBJECT_TYPE
307 # define lisp_h_XLI(o) ((o).i)
308 # define lisp_h_XIL(i) ((Lisp_Object) { i })
310 # define lisp_h_XLI(o) (o)
311 # define lisp_h_XIL(i) (i)
313 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
314 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
315 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
316 ((ok) ? (void) 0 : wrong_type_argument (predicate, x))
317 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
318 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
319 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
320 #define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
321 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
322 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
323 #define lisp_h_NILP(x) EQ (x, Qnil)
324 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
325 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
326 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->trapped_write == SYMBOL_NOWRITE)
327 #define lisp_h_SYMBOL_TRAPPED_WRITE_P(sym) (XSYMBOL (sym)->trapped_write)
328 #define lisp_h_SYMBOL_VAL(sym) \
329 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
330 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
331 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
332 #define lisp_h_XCAR(c) XCONS (c)->car
333 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
334 #define lisp_h_XCONS(a) \
335 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
336 #define lisp_h_XHASH(a) XUINT (a)
337 #ifndef GC_CHECK_CONS_LIST
338 # define lisp_h_check_cons_list() ((void) 0)
341 # define lisp_h_make_number(n) \
342 XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
343 # define lisp_h_XFASTINT(a) XINT (a)
344 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
345 # define lisp_h_XSYMBOL(a) \
346 (eassert (SYMBOLP (a)), \
347 (struct Lisp_Symbol *) ((intptr_t) XLI (a) - Lisp_Symbol \
349 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
350 # define lisp_h_XUNTAG(a, type) \
351 __builtin_assume_aligned ((void *) (intptr_t) (XLI (a) - (type)), \
355 /* When compiling via gcc -O0, define the key operations as macros, as
356 Emacs is too slow otherwise. To disable this optimization, compile
357 with -DINLINING=false. */
358 #if (defined __NO_INLINE__ \
359 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
360 && ! (defined INLINING && ! INLINING))
361 # define DEFINE_KEY_OPS_AS_MACROS true
363 # define DEFINE_KEY_OPS_AS_MACROS false
366 #if DEFINE_KEY_OPS_AS_MACROS
367 # define XLI(o) lisp_h_XLI (o)
368 # define XIL(i) lisp_h_XIL (i)
369 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
370 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
371 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
372 # define CONSP(x) lisp_h_CONSP (x)
373 # define EQ(x, y) lisp_h_EQ (x, y)
374 # define FLOATP(x) lisp_h_FLOATP (x)
375 # define INTEGERP(x) lisp_h_INTEGERP (x)
376 # define MARKERP(x) lisp_h_MARKERP (x)
377 # define MISCP(x) lisp_h_MISCP (x)
378 # define NILP(x) lisp_h_NILP (x)
379 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
380 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
381 # define SYMBOL_TRAPPED_WRITE_P(sym) lisp_h_SYMBOL_TRAPPED_WRITE_P (sym)
382 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
383 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
384 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
385 # define XCAR(c) lisp_h_XCAR (c)
386 # define XCDR(c) lisp_h_XCDR (c)
387 # define XCONS(a) lisp_h_XCONS (a)
388 # define XHASH(a) lisp_h_XHASH (a)
389 # ifndef GC_CHECK_CONS_LIST
390 # define check_cons_list() lisp_h_check_cons_list ()
393 # define make_number(n) lisp_h_make_number (n)
394 # define XFASTINT(a) lisp_h_XFASTINT (a)
395 # define XINT(a) lisp_h_XINT (a)
396 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
397 # define XTYPE(a) lisp_h_XTYPE (a)
398 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
403 /* Define the fundamental Lisp data structures. */
405 /* This is the set of Lisp data types. If you want to define a new
406 data type, read the comments after Lisp_Fwd_Type definition
409 /* Lisp integers use 2 tags, to give them one extra bit, thus
410 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
411 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
412 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
414 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
415 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
416 vociferously about them. */
417 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
418 || (defined __SUNPRO_C && __STDC__))
419 #define ENUM_BF(TYPE) unsigned int
421 #define ENUM_BF(TYPE) enum TYPE
427 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
430 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
431 whose first member indicates the subtype. */
434 /* Integer. XINT (obj) is the integer value. */
436 Lisp_Int1
= USE_LSB_TAG
? 6 : 3,
438 /* String. XSTRING (object) points to a struct Lisp_String.
439 The length of the string, and its contents, are stored therein. */
442 /* Vector of Lisp objects, or something resembling it.
443 XVECTOR (object) points to a struct Lisp_Vector, which contains
444 the size and contents. The size field also contains the type
445 information, if it's not a real vector object. */
448 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
449 Lisp_Cons
= USE_LSB_TAG
? 3 : 6,
454 /* This is the set of data types that share a common structure.
455 The first member of the structure is a type code from this set.
456 The enum values are arbitrary, but we'll use large numbers to make it
457 more likely that we'll spot the error if a random word in memory is
458 mistakenly interpreted as a Lisp_Misc. */
461 Lisp_Misc_Free
= 0x5eab,
464 Lisp_Misc_Save_Value
,
469 /* Currently floats are not a misc type,
470 but let's define this in case we want to change that. */
472 /* This is not a type code. It is for range checking. */
476 /* These are the types of forwarding objects used in the value slot
477 of symbols for special built-in variables whose value is stored in
481 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
482 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
483 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
484 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
485 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
488 /* If you want to define a new Lisp data type, here are some
489 instructions. See the thread at
490 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
493 First, there are already a couple of Lisp types that can be used if
494 your new type does not need to be exposed to Lisp programs nor
495 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
496 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
497 is suitable for temporarily stashing away pointers and integers in
498 a Lisp object. The latter is useful for vector-like Lisp objects
499 that need to be used as part of other objects, but which are never
500 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
503 These two types don't look pretty when printed, so they are
504 unsuitable for Lisp objects that can be exposed to users.
506 To define a new data type, add one more Lisp_Misc subtype or one
507 more pseudovector subtype. Pseudovectors are more suitable for
508 objects with several slots that need to support fast random access,
509 while Lisp_Misc types are for everything else. A pseudovector object
510 provides one or more slots for Lisp objects, followed by struct
511 members that are accessible only from C. A Lisp_Misc object is a
512 wrapper for a C struct that can contain anything you like.
514 Explicit freeing is discouraged for Lisp objects in general. But if
515 you really need to exploit this, use Lisp_Misc (check free_misc in
516 alloc.c to see why). There is no way to free a vectorlike object.
518 To add a new pseudovector type, extend the pvec_type enumeration;
519 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
521 For a Lisp_Misc, you will also need to add your entry to union
522 Lisp_Misc (but make sure the first word has the same structure as
523 the others, starting with a 16-bit member of the Lisp_Misc_Type
524 enumeration and a 1-bit GC markbit) and make sure the overall size
525 of the union is not increased by your addition.
527 For a new pseudovector, it's highly desirable to limit the size
528 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
529 Otherwise you will need to change sweep_vectors (also in alloc.c).
531 Then you will need to add switch branches in print.c (in
532 print_object, to print your object, and possibly also in
533 print_preprocess) and to alloc.c, to mark your object (in
534 mark_object) and to free it (in gc_sweep). The latter is also the
535 right place to call any code specific to your data type that needs
536 to run when the object is recycled -- e.g., free any additional
537 resources allocated for it that are not Lisp objects. You can even
538 make a pointer to the function that frees the resources a slot in
539 your object -- this way, the same object could be used to represent
540 several disparate C structures. */
542 #ifdef CHECK_LISP_OBJECT_TYPE
544 typedef struct { EMACS_INT i
; } Lisp_Object
;
546 #define LISP_INITIALLY(i) {i}
548 #undef CHECK_LISP_OBJECT_TYPE
549 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
550 #else /* CHECK_LISP_OBJECT_TYPE */
552 /* If a struct type is not wanted, define Lisp_Object as just a number. */
554 typedef EMACS_INT Lisp_Object
;
555 #define LISP_INITIALLY(i) (i)
556 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
557 #endif /* CHECK_LISP_OBJECT_TYPE */
559 /* Forward declarations. */
561 /* Defined in this file. */
562 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
565 /* Defined in chartab.c. */
566 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
567 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
569 /* Defined in data.c. */
570 extern _Noreturn
void wrong_type_argument (Lisp_Object
, Lisp_Object
);
574 enum { might_dump
= false };
575 #elif defined DOUG_LEA_MALLOC
576 /* Defined in emacs.c. */
577 extern bool might_dump
;
579 /* True means Emacs has already been initialized.
580 Used during startup to detect startup of dumped Emacs. */
581 extern bool initialized
;
583 /* Defined in floatfns.c. */
584 extern double extract_float (Lisp_Object
);
587 /* Low-level conversion and type checking. */
589 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
590 At the machine level, these operations are no-ops. */
593 (XLI
) (Lisp_Object o
)
595 return lisp_h_XLI (o
);
601 return lisp_h_XIL (i
);
604 /* Extract A's type. */
606 INLINE
enum Lisp_Type
607 (XTYPE
) (Lisp_Object a
)
610 return lisp_h_XTYPE (a
);
612 EMACS_UINT i
= XLI (a
);
613 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
618 (CHECK_TYPE
) (int ok
, Lisp_Object predicate
, Lisp_Object x
)
620 lisp_h_CHECK_TYPE (ok
, predicate
, x
);
623 /* Extract A's pointer value, assuming A's type is TYPE. */
626 (XUNTAG
) (Lisp_Object a
, int type
)
629 return lisp_h_XUNTAG (a
, type
);
631 intptr_t i
= USE_LSB_TAG
? XLI (a
) - type
: XLI (a
) & VALMASK
;
637 /* Interned state of a symbol. */
641 SYMBOL_UNINTERNED
= 0,
643 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
650 SYMBOL_LOCALIZED
= 2,
654 enum symbol_trapped_write
656 SYMBOL_UNTRAPPED_WRITE
= 0,
658 SYMBOL_TRAPPED_WRITE
= 2
663 bool_bf gcmarkbit
: 1;
665 /* Indicates where the value can be found:
666 0 : it's a plain var, the value is in the `value' field.
667 1 : it's a varalias, the value is really in the `alias' symbol.
668 2 : it's a localized var, the value is in the `blv' object.
669 3 : it's a forwarding variable, the value is in `forward'. */
670 ENUM_BF (symbol_redirect
) redirect
: 3;
672 /* 0 : normal case, just set the value
673 1 : constant, cannot set, e.g. nil, t, :keywords.
674 2 : trap the write, call watcher functions. */
675 ENUM_BF (symbol_trapped_write
) trapped_write
: 2;
677 /* Interned state of the symbol. This is an enumerator from
678 enum symbol_interned. */
679 unsigned interned
: 2;
681 /* True means that this variable has been explicitly declared
682 special (with `defvar' etc), and shouldn't be lexically bound. */
683 bool_bf declared_special
: 1;
685 /* True if pointed to from purespace and hence can't be GC'd. */
688 /* The symbol's name, as a Lisp string. */
691 /* Value of the symbol or Qunbound if unbound. Which alternative of the
692 union is used depends on the `redirect' field above. */
695 struct Lisp_Symbol
*alias
;
696 struct Lisp_Buffer_Local_Value
*blv
;
700 /* Function value of the symbol or Qnil if not fboundp. */
701 Lisp_Object function
;
703 /* The symbol's property list. */
706 /* Next symbol in obarray bucket, if the symbol is interned. */
707 struct Lisp_Symbol
*next
;
710 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
711 meaning as in the DEFUN macro, and is used to construct a prototype. */
712 /* We can use the same trick as in the DEFUN macro to generate the
713 appropriate prototype. */
714 #define EXFUN(fnname, maxargs) \
715 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
717 /* Note that the weird token-substitution semantics of ANSI C makes
718 this work for MANY and UNEVALLED. */
719 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
720 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
721 #define DEFUN_ARGS_0 (void)
722 #define DEFUN_ARGS_1 (Lisp_Object)
723 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
724 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
725 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
726 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
728 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
729 Lisp_Object, Lisp_Object)
730 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
731 Lisp_Object, Lisp_Object, Lisp_Object)
732 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
733 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
735 /* Yield a signed integer that contains TAG along with PTR.
737 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
738 and zero-extend otherwise (that’s a bit faster here).
739 Sign extension matters only when EMACS_INT is wider than a pointer. */
740 #define TAG_PTR(tag, ptr) \
742 ? (intptr_t) (ptr) + (tag) \
743 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
745 /* Yield an integer that contains a symbol tag along with OFFSET.
746 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
747 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
749 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
750 XLI (builtin_lisp_symbol (Qwhatever)),
751 except the former expands to an integer constant expression. */
752 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
754 /* LISPSYM_INITIALLY (Qfoo) is equivalent to Qfoo except it is
755 designed for use as an initializer, even for a constant initializer. */
756 #define LISPSYM_INITIALLY(name) LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name))
758 /* Declare extern constants for Lisp symbols. These can be helpful
759 when using a debugger like GDB, on older platforms where the debug
760 format does not represent C macros. */
761 #define DEFINE_LISP_SYMBOL(name) \
762 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
763 DEFINE_GDB_SYMBOL_END (LISPSYM_INITIALLY (name))
765 /* The index of the C-defined Lisp symbol SYM.
766 This can be used in a static initializer. */
767 #define SYMBOL_INDEX(sym) i##sym
769 /* By default, define macros for Qt, etc., as this leads to a bit
770 better performance in the core Emacs interpreter. A plugin can
771 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
772 other Emacs instances that assign different values to Qt, etc. */
773 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
774 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
779 /* Header of vector-like objects. This documents the layout constraints on
780 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
781 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
782 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
783 because when two such pointers potentially alias, a compiler won't
784 incorrectly reorder loads and stores to their size fields. See
786 struct vectorlike_header
788 /* The only field contains various pieces of information:
789 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
790 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
791 vector (0) or a pseudovector (1).
792 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
793 of slots) of the vector.
794 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
795 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
796 - b) number of Lisp_Objects slots at the beginning of the object
797 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
799 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
800 measured in word_size units. Rest fields may also include
801 Lisp_Objects, but these objects usually needs some special treatment
803 There are some exceptions. For PVEC_FREE, b) is always zero. For
804 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
805 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
806 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
811 (SYMBOLP
) (Lisp_Object x
)
813 return lisp_h_SYMBOLP (x
);
816 INLINE
struct Lisp_Symbol
*
817 (XSYMBOL
) (Lisp_Object a
)
820 return lisp_h_XSYMBOL (a
);
822 eassert (SYMBOLP (a
));
823 intptr_t i
= (intptr_t) XUNTAG (a
, Lisp_Symbol
);
824 void *p
= (char *) lispsym
+ i
;
830 make_lisp_symbol (struct Lisp_Symbol
*sym
)
832 Lisp_Object a
= XIL (TAG_SYMOFFSET ((char *) sym
- (char *) lispsym
));
833 eassert (XSYMBOL (a
) == sym
);
838 builtin_lisp_symbol (int index
)
840 return make_lisp_symbol (lispsym
+ index
);
844 (CHECK_SYMBOL
) (Lisp_Object x
)
846 lisp_h_CHECK_SYMBOL (x
);
849 /* In the size word of a vector, this bit means the vector has been marked. */
851 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
852 # define ARRAY_MARK_FLAG PTRDIFF_MIN
853 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
855 /* In the size word of a struct Lisp_Vector, this bit means it's really
856 some other vector-like object. */
857 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
858 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
859 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
861 /* In a pseudovector, the size field actually contains a word with one
862 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
863 with PVEC_TYPE_MASK to indicate the actual type. */
875 PVEC_WINDOW_CONFIGURATION
,
884 /* These should be last, check internal_equal to see why. */
888 PVEC_FONT
/* Should be last because it's used for range checking. */
893 /* For convenience, we also store the number of elements in these bits.
894 Note that this size is not necessarily the memory-footprint size, but
895 only the number of Lisp_Object fields (that need to be traced by GC).
896 The distinction is used, e.g., by Lisp_Process, which places extra
897 non-Lisp_Object fields at the end of the structure. */
898 PSEUDOVECTOR_SIZE_BITS
= 12,
899 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
901 /* To calculate the memory footprint of the pseudovector, it's useful
902 to store the size of non-Lisp area in word_size units here. */
903 PSEUDOVECTOR_REST_BITS
= 12,
904 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
905 << PSEUDOVECTOR_SIZE_BITS
),
907 /* Used to extract pseudovector subtype information. */
908 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
909 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
912 /* These functions extract various sorts of values from a Lisp_Object.
913 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
914 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
917 /* Largest and smallest representable fixnum values. These are the C
918 values. They are macros for use in static initializers. */
919 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
920 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
925 (make_number
) (EMACS_INT n
)
927 return lisp_h_make_number (n
);
931 (XINT
) (Lisp_Object a
)
933 return lisp_h_XINT (a
);
937 (XFASTINT
) (Lisp_Object a
)
939 EMACS_INT n
= lisp_h_XFASTINT (a
);
944 #else /* ! USE_LSB_TAG */
946 /* Although compiled only if ! USE_LSB_TAG, the following functions
947 also work when USE_LSB_TAG; this is to aid future maintenance when
948 the lisp_h_* macros are eventually removed. */
950 /* Make a Lisp integer representing the value of the low order
953 make_number (EMACS_INT n
)
955 EMACS_INT int0
= Lisp_Int0
;
959 n
= u
<< INTTYPEBITS
;
965 n
+= (int0
<< VALBITS
);
970 /* Extract A's value as a signed integer. */
974 EMACS_INT i
= XLI (a
);
978 i
= u
<< INTTYPEBITS
;
980 return i
>> INTTYPEBITS
;
983 /* Like XINT (A), but may be faster. A must be nonnegative.
984 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
985 integers have zero-bits in their tags. */
987 XFASTINT (Lisp_Object a
)
989 EMACS_INT int0
= Lisp_Int0
;
990 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
) - (int0
<< VALBITS
);
995 #endif /* ! USE_LSB_TAG */
997 /* Extract A's value as an unsigned integer. */
999 XUINT (Lisp_Object a
)
1001 EMACS_UINT i
= XLI (a
);
1002 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
1005 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
1006 right now, but XUINT should only be applied to objects we know are
1010 (XHASH
) (Lisp_Object a
)
1012 return lisp_h_XHASH (a
);
1015 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
1017 make_natnum (EMACS_INT n
)
1019 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
1020 EMACS_INT int0
= Lisp_Int0
;
1021 return USE_LSB_TAG
? make_number (n
) : XIL (n
+ (int0
<< VALBITS
));
1024 /* Return true if X and Y are the same object. */
1027 (EQ
) (Lisp_Object x
, Lisp_Object y
)
1029 return lisp_h_EQ (x
, y
);
1032 /* True if the possibly-unsigned integer I doesn't fit in a Lisp fixnum. */
1034 #define FIXNUM_OVERFLOW_P(i) \
1035 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
1038 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
1040 return num
< lower
? lower
: num
<= upper
? num
: upper
;
1043 /* Construct a Lisp_Object from a value or address. */
1046 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
1048 Lisp_Object a
= XIL (TAG_PTR (type
, ptr
));
1049 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
1054 (INTEGERP
) (Lisp_Object x
)
1056 return lisp_h_INTEGERP (x
);
1059 #define XSETINT(a, b) ((a) = make_number (b))
1060 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1061 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1062 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1063 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1064 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1065 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1066 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1068 /* Pseudovector types. */
1070 #define XSETPVECTYPE(v, code) \
1071 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1072 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1073 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1074 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1075 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1078 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1079 #define XSETPSEUDOVECTOR(a, b, code) \
1080 XSETTYPED_PSEUDOVECTOR (a, b, \
1081 (((struct vectorlike_header *) \
1082 XUNTAG (a, Lisp_Vectorlike)) \
1085 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1086 (XSETVECTOR (a, b), \
1087 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1088 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1090 #define XSETWINDOW_CONFIGURATION(a, b) \
1091 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1092 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1093 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1094 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1095 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1096 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1097 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1098 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1099 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1100 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1101 #define XSETTHREAD(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_THREAD))
1102 #define XSETMUTEX(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_MUTEX))
1103 #define XSETCONDVAR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CONDVAR))
1105 /* Efficiently convert a pointer to a Lisp object and back. The
1106 pointer is represented as a Lisp integer, so the garbage collector
1107 does not know about it. The pointer should not have both Lisp_Int1
1108 bits set, which makes this conversion inherently unportable. */
1111 XINTPTR (Lisp_Object a
)
1113 return XUNTAG (a
, Lisp_Int0
);
1117 make_pointer_integer (void *p
)
1119 Lisp_Object a
= XIL (TAG_PTR (Lisp_Int0
, p
));
1120 eassert (INTEGERP (a
) && XINTPTR (a
) == p
);
1124 /* See the macros in intervals.h. */
1126 typedef struct interval
*INTERVAL
;
1128 struct GCALIGNED Lisp_Cons
1130 /* Car of this cons cell. */
1135 /* Cdr of this cons cell. */
1138 /* Used to chain conses on a free list. */
1139 struct Lisp_Cons
*chain
;
1144 (NILP
) (Lisp_Object x
)
1146 return lisp_h_NILP (x
);
1150 (CONSP
) (Lisp_Object x
)
1152 return lisp_h_CONSP (x
);
1156 CHECK_CONS (Lisp_Object x
)
1158 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
1161 INLINE
struct Lisp_Cons
*
1162 (XCONS
) (Lisp_Object a
)
1164 return lisp_h_XCONS (a
);
1167 /* Take the car or cdr of something known to be a cons cell. */
1168 /* The _addr functions shouldn't be used outside of the minimal set
1169 of code that has to know what a cons cell looks like. Other code not
1170 part of the basic lisp implementation should assume that the car and cdr
1171 fields are not accessible. (What if we want to switch to
1172 a copying collector someday? Cached cons cell field addresses may be
1173 invalidated at arbitrary points.) */
1174 INLINE Lisp_Object
*
1175 xcar_addr (Lisp_Object c
)
1177 return &XCONS (c
)->car
;
1179 INLINE Lisp_Object
*
1180 xcdr_addr (Lisp_Object c
)
1182 return &XCONS (c
)->u
.cdr
;
1185 /* Use these from normal code. */
1188 (XCAR
) (Lisp_Object c
)
1190 return lisp_h_XCAR (c
);
1194 (XCDR
) (Lisp_Object c
)
1196 return lisp_h_XCDR (c
);
1199 /* Use these to set the fields of a cons cell.
1201 Note that both arguments may refer to the same object, so 'n'
1202 should not be read after 'c' is first modified. */
1204 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1209 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1214 /* Take the car or cdr of something whose type is not known. */
1221 wrong_type_argument (Qlistp
, c
);
1230 wrong_type_argument (Qlistp
, c
);
1234 /* Take the car or cdr of something whose type is not known. */
1236 CAR_SAFE (Lisp_Object c
)
1238 return CONSP (c
) ? XCAR (c
) : Qnil
;
1241 CDR_SAFE (Lisp_Object c
)
1243 return CONSP (c
) ? XCDR (c
) : Qnil
;
1246 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1248 struct GCALIGNED Lisp_String
1251 ptrdiff_t size_byte
;
1252 INTERVAL intervals
; /* Text properties in this string. */
1253 unsigned char *data
;
1257 STRINGP (Lisp_Object x
)
1259 return XTYPE (x
) == Lisp_String
;
1263 CHECK_STRING (Lisp_Object x
)
1265 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
1268 INLINE
struct Lisp_String
*
1269 XSTRING (Lisp_Object a
)
1271 eassert (STRINGP (a
));
1272 return XUNTAG (a
, Lisp_String
);
1275 /* True if STR is a multibyte string. */
1277 STRING_MULTIBYTE (Lisp_Object str
)
1279 return 0 <= XSTRING (str
)->size_byte
;
1282 /* An upper bound on the number of bytes in a Lisp string, not
1283 counting the terminating null. This a tight enough bound to
1284 prevent integer overflow errors that would otherwise occur during
1285 string size calculations. A string cannot contain more bytes than
1286 a fixnum can represent, nor can it be so long that C pointer
1287 arithmetic stops working on the string plus its terminating null.
1288 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1289 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1290 would expose alloc.c internal details that we'd rather keep
1293 This is a macro for use in static initializers. The cast to
1294 ptrdiff_t ensures that the macro is signed. */
1295 #define STRING_BYTES_BOUND \
1296 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1298 /* Mark STR as a unibyte string. */
1299 #define STRING_SET_UNIBYTE(STR) \
1301 if (XSTRING (STR)->size == 0) \
1302 (STR) = empty_unibyte_string; \
1304 XSTRING (STR)->size_byte = -1; \
1307 /* Mark STR as a multibyte string. Assure that STR contains only
1308 ASCII characters in advance. */
1309 #define STRING_SET_MULTIBYTE(STR) \
1311 if (XSTRING (STR)->size == 0) \
1312 (STR) = empty_multibyte_string; \
1314 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1317 /* Convenience functions for dealing with Lisp strings. */
1319 INLINE
unsigned char *
1320 SDATA (Lisp_Object string
)
1322 return XSTRING (string
)->data
;
1325 SSDATA (Lisp_Object string
)
1327 /* Avoid "differ in sign" warnings. */
1328 return (char *) SDATA (string
);
1330 INLINE
unsigned char
1331 SREF (Lisp_Object string
, ptrdiff_t index
)
1333 return SDATA (string
)[index
];
1336 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1338 SDATA (string
)[index
] = new;
1341 SCHARS (Lisp_Object string
)
1343 return XSTRING (string
)->size
;
1346 #ifdef GC_CHECK_STRING_BYTES
1347 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1350 STRING_BYTES (struct Lisp_String
*s
)
1352 #ifdef GC_CHECK_STRING_BYTES
1353 return string_bytes (s
);
1355 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1360 SBYTES (Lisp_Object string
)
1362 return STRING_BYTES (XSTRING (string
));
1365 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1367 XSTRING (string
)->size
= newsize
;
1370 /* A regular vector is just a header plus an array of Lisp_Objects. */
1374 struct vectorlike_header header
;
1375 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1379 (VECTORLIKEP
) (Lisp_Object x
)
1381 return lisp_h_VECTORLIKEP (x
);
1384 INLINE
struct Lisp_Vector
*
1385 XVECTOR (Lisp_Object a
)
1387 eassert (VECTORLIKEP (a
));
1388 return XUNTAG (a
, Lisp_Vectorlike
);
1392 ASIZE (Lisp_Object array
)
1394 ptrdiff_t size
= XVECTOR (array
)->header
.size
;
1395 eassume (0 <= size
);
1400 VECTORP (Lisp_Object x
)
1402 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
1406 CHECK_VECTOR (Lisp_Object x
)
1408 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
1411 /* A pseudovector is like a vector, but has other non-Lisp components. */
1414 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
1416 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
1417 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
1420 /* True if A is a pseudovector whose code is CODE. */
1422 PSEUDOVECTORP (Lisp_Object a
, int code
)
1424 if (! VECTORLIKEP (a
))
1428 /* Converting to struct vectorlike_header * avoids aliasing issues. */
1429 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
1430 return PSEUDOVECTOR_TYPEP (h
, code
);
1434 /* A boolvector is a kind of vectorlike, with contents like a string. */
1436 struct Lisp_Bool_Vector
1438 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1439 just the subtype information. */
1440 struct vectorlike_header header
;
1441 /* This is the size in bits. */
1443 /* The actual bits, packed into bytes.
1444 Zeros fill out the last word if needed.
1445 The bits are in little-endian order in the bytes, and
1446 the bytes are in little-endian order in the words. */
1447 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1450 /* Some handy constants for calculating sizes
1451 and offsets, mostly of vectorlike objects. */
1455 header_size
= offsetof (struct Lisp_Vector
, contents
),
1456 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1457 word_size
= sizeof (Lisp_Object
)
1460 /* The number of data words and bytes in a bool vector with SIZE bits. */
1463 bool_vector_words (EMACS_INT size
)
1465 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1466 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1470 bool_vector_bytes (EMACS_INT size
)
1472 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1473 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1477 BOOL_VECTOR_P (Lisp_Object a
)
1479 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
1483 CHECK_BOOL_VECTOR (Lisp_Object x
)
1485 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
1488 INLINE
struct Lisp_Bool_Vector
*
1489 XBOOL_VECTOR (Lisp_Object a
)
1491 eassert (BOOL_VECTOR_P (a
));
1492 return XUNTAG (a
, Lisp_Vectorlike
);
1496 bool_vector_size (Lisp_Object a
)
1498 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1499 eassume (0 <= size
);
1504 bool_vector_data (Lisp_Object a
)
1506 return XBOOL_VECTOR (a
)->data
;
1509 INLINE
unsigned char *
1510 bool_vector_uchar_data (Lisp_Object a
)
1512 return (unsigned char *) bool_vector_data (a
);
1515 /* True if A's Ith bit is set. */
1518 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1520 eassume (0 <= i
&& i
< bool_vector_size (a
));
1521 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1522 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1526 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1528 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1531 /* Set A's Ith bit to B. */
1534 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1536 unsigned char *addr
;
1538 eassume (0 <= i
&& i
< bool_vector_size (a
));
1539 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1542 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1544 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1547 /* Conveniences for dealing with Lisp arrays. */
1550 AREF (Lisp_Object array
, ptrdiff_t idx
)
1552 return XVECTOR (array
)->contents
[idx
];
1555 INLINE Lisp_Object
*
1556 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1558 return & XVECTOR (array
)->contents
[idx
];
1562 gc_asize (Lisp_Object array
)
1564 /* Like ASIZE, but also can be used in the garbage collector. */
1565 return XVECTOR (array
)->header
.size
& ~ARRAY_MARK_FLAG
;
1569 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1571 eassert (0 <= idx
&& idx
< ASIZE (array
));
1572 XVECTOR (array
)->contents
[idx
] = val
;
1576 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1578 /* Like ASET, but also can be used in the garbage collector:
1579 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1580 eassert (0 <= idx
&& idx
< gc_asize (array
));
1581 XVECTOR (array
)->contents
[idx
] = val
;
1584 /* True, since Qnil's representation is zero. Every place in the code
1585 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1586 to find such assumptions later if we change Qnil to be nonzero. */
1587 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1589 /* Clear the object addressed by P, with size NBYTES, so that all its
1590 bytes are zero and all its Lisp values are nil. */
1592 memclear (void *p
, ptrdiff_t nbytes
)
1594 eassert (0 <= nbytes
);
1595 verify (NIL_IS_ZERO
);
1596 /* Since Qnil is zero, memset suffices. */
1597 memset (p
, 0, nbytes
);
1600 /* If a struct is made to look like a vector, this macro returns the length
1601 of the shortest vector that would hold that struct. */
1603 #define VECSIZE(type) \
1604 ((sizeof (type) - header_size + word_size - 1) / word_size)
1606 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1607 at the end and we need to compute the number of Lisp_Object fields (the
1608 ones that the GC needs to trace). */
1610 #define PSEUDOVECSIZE(type, nonlispfield) \
1611 ((offsetof (type, nonlispfield) - header_size) / word_size)
1613 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1614 should be integer expressions. This is not the same as
1615 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1616 returns true. For efficiency, prefer plain unsigned comparison if A
1617 and B's sizes both fit (after integer promotion). */
1618 #define UNSIGNED_CMP(a, op, b) \
1619 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1620 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1621 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1623 /* True iff C is an ASCII character. */
1624 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1626 /* A char-table is a kind of vectorlike, with contents are like a
1627 vector but with a few other slots. For some purposes, it makes
1628 sense to handle a char-table with type struct Lisp_Vector. An
1629 element of a char table can be any Lisp objects, but if it is a sub
1630 char-table, we treat it a table that contains information of a
1631 specific range of characters. A sub char-table is like a vector but
1632 with two integer fields between the header and Lisp data, which means
1633 that it has to be marked with some precautions (see mark_char_table
1634 in alloc.c). A sub char-table appears only in an element of a char-table,
1635 and there's no way to access it directly from Emacs Lisp program. */
1637 enum CHARTAB_SIZE_BITS
1639 CHARTAB_SIZE_BITS_0
= 6,
1640 CHARTAB_SIZE_BITS_1
= 4,
1641 CHARTAB_SIZE_BITS_2
= 5,
1642 CHARTAB_SIZE_BITS_3
= 7
1645 extern const int chartab_size
[4];
1647 struct Lisp_Char_Table
1649 /* HEADER.SIZE is the vector's size field, which also holds the
1650 pseudovector type information. It holds the size, too.
1651 The size counts the defalt, parent, purpose, ascii,
1652 contents, and extras slots. */
1653 struct vectorlike_header header
;
1655 /* This holds a default value,
1656 which is used whenever the value for a specific character is nil. */
1659 /* This points to another char table, which we inherit from when the
1660 value for a specific character is nil. The `defalt' slot takes
1661 precedence over this. */
1664 /* This is a symbol which says what kind of use this char-table is
1666 Lisp_Object purpose
;
1668 /* The bottom sub char-table for characters of the range 0..127. It
1669 is nil if none of ASCII character has a specific value. */
1672 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1674 /* These hold additional data. It is a vector. */
1675 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1679 CHAR_TABLE_P (Lisp_Object a
)
1681 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
1684 INLINE
struct Lisp_Char_Table
*
1685 XCHAR_TABLE (Lisp_Object a
)
1687 eassert (CHAR_TABLE_P (a
));
1688 return XUNTAG (a
, Lisp_Vectorlike
);
1691 struct Lisp_Sub_Char_Table
1693 /* HEADER.SIZE is the vector's size field, which also holds the
1694 pseudovector type information. It holds the size, too. */
1695 struct vectorlike_header header
;
1697 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1698 char-table of depth 1 contains 16 elements, and each element
1699 covers 4096 (128*32) characters. A sub char-table of depth 2
1700 contains 32 elements, and each element covers 128 characters. A
1701 sub char-table of depth 3 contains 128 elements, and each element
1702 is for one character. */
1705 /* Minimum character covered by the sub char-table. */
1708 /* Use set_sub_char_table_contents to set this. */
1709 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1713 SUB_CHAR_TABLE_P (Lisp_Object a
)
1715 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
1718 INLINE
struct Lisp_Sub_Char_Table
*
1719 XSUB_CHAR_TABLE (Lisp_Object a
)
1721 eassert (SUB_CHAR_TABLE_P (a
));
1722 return XUNTAG (a
, Lisp_Vectorlike
);
1726 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1728 struct Lisp_Char_Table
*tbl
= NULL
;
1732 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1733 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1734 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1738 while (NILP (val
) && ! NILP (tbl
->parent
));
1743 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1744 characters. Do not check validity of CT. */
1746 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1748 return (ASCII_CHAR_P (idx
)
1749 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1750 : char_table_ref (ct
, idx
));
1753 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1754 8-bit European characters. Do not check validity of CT. */
1756 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1758 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1759 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1761 char_table_set (ct
, idx
, val
);
1764 /* This structure describes a built-in function.
1765 It is generated by the DEFUN macro only.
1766 defsubr makes it into a Lisp object. */
1770 struct vectorlike_header header
;
1772 Lisp_Object (*a0
) (void);
1773 Lisp_Object (*a1
) (Lisp_Object
);
1774 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1775 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1776 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1777 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1778 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1779 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1780 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1781 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1782 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1784 short min_args
, max_args
;
1785 const char *symbol_name
;
1786 const char *intspec
;
1791 SUBRP (Lisp_Object a
)
1793 return PSEUDOVECTORP (a
, PVEC_SUBR
);
1796 INLINE
struct Lisp_Subr
*
1797 XSUBR (Lisp_Object a
)
1799 eassert (SUBRP (a
));
1800 return XUNTAG (a
, Lisp_Vectorlike
);
1803 enum char_table_specials
1805 /* This is the number of slots that every char table must have. This
1806 counts the ordinary slots and the top, defalt, parent, and purpose
1808 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1810 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1811 when the latter is treated as an ordinary Lisp_Vector. */
1812 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1815 /* Return the number of "extra" slots in the char table CT. */
1818 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1820 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1821 - CHAR_TABLE_STANDARD_SLOTS
);
1824 /* Make sure that sub char-table contents slot is where we think it is. */
1825 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1826 == (offsetof (struct Lisp_Vector
, contents
)
1827 + SUB_CHAR_TABLE_OFFSET
* sizeof (Lisp_Object
)));
1831 /***********************************************************************
1833 ***********************************************************************/
1835 /* Value is name of symbol. */
1838 (SYMBOL_VAL
) (struct Lisp_Symbol
*sym
)
1840 return lisp_h_SYMBOL_VAL (sym
);
1843 INLINE
struct Lisp_Symbol
*
1844 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1846 eassume (sym
->redirect
== SYMBOL_VARALIAS
&& sym
->val
.alias
);
1847 return sym
->val
.alias
;
1849 INLINE
struct Lisp_Buffer_Local_Value
*
1850 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1852 eassume (sym
->redirect
== SYMBOL_LOCALIZED
&& sym
->val
.blv
);
1853 return sym
->val
.blv
;
1855 INLINE
union Lisp_Fwd
*
1856 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1858 eassume (sym
->redirect
== SYMBOL_FORWARDED
&& sym
->val
.fwd
);
1859 return sym
->val
.fwd
;
1863 (SET_SYMBOL_VAL
) (struct Lisp_Symbol
*sym
, Lisp_Object v
)
1865 lisp_h_SET_SYMBOL_VAL (sym
, v
);
1869 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1871 eassume (sym
->redirect
== SYMBOL_VARALIAS
&& v
);
1875 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1877 eassume (sym
->redirect
== SYMBOL_LOCALIZED
&& v
);
1881 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1883 eassume (sym
->redirect
== SYMBOL_FORWARDED
&& v
);
1888 SYMBOL_NAME (Lisp_Object sym
)
1890 return XSYMBOL (sym
)->name
;
1893 /* Value is true if SYM is an interned symbol. */
1896 SYMBOL_INTERNED_P (Lisp_Object sym
)
1898 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1901 /* Value is true if SYM is interned in initial_obarray. */
1904 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1906 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1909 /* Value is non-zero if symbol cannot be changed through a simple set,
1910 i.e. it's a constant (e.g. nil, t, :keywords), or it has some
1911 watching functions. */
1914 (SYMBOL_TRAPPED_WRITE_P
) (Lisp_Object sym
)
1916 return lisp_h_SYMBOL_TRAPPED_WRITE_P (sym
);
1919 /* Value is non-zero if symbol cannot be changed at all, i.e. it's a
1920 constant (e.g. nil, t, :keywords). Code that actually wants to
1921 write to SYM, should also check whether there are any watching
1925 (SYMBOL_CONSTANT_P
) (Lisp_Object sym
)
1927 return lisp_h_SYMBOL_CONSTANT_P (sym
);
1930 /* Placeholder for make-docfile to process. The actual symbol
1931 definition is done by lread.c's defsym. */
1932 #define DEFSYM(sym, name) /* empty */
1935 /***********************************************************************
1937 ***********************************************************************/
1939 /* The structure of a Lisp hash table. */
1941 struct hash_table_test
1943 /* Name of the function used to compare keys. */
1946 /* User-supplied hash function, or nil. */
1947 Lisp_Object user_hash_function
;
1949 /* User-supplied key comparison function, or nil. */
1950 Lisp_Object user_cmp_function
;
1952 /* C function to compare two keys. */
1953 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1955 /* C function to compute hash code. */
1956 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1959 struct Lisp_Hash_Table
1961 /* This is for Lisp; the hash table code does not refer to it. */
1962 struct vectorlike_header header
;
1964 /* Nil if table is non-weak. Otherwise a symbol describing the
1965 weakness of the table. */
1968 /* Vector of hash codes. If hash[I] is nil, this means that the
1969 I-th entry is unused. */
1972 /* Vector used to chain entries. If entry I is free, next[I] is the
1973 entry number of the next free item. If entry I is non-free,
1974 next[I] is the index of the next entry in the collision chain,
1975 or -1 if there is such entry. */
1978 /* Bucket vector. An entry of -1 indicates no item is present,
1979 and a nonnegative entry is the index of the first item in
1980 a collision chain. This vector's size can be larger than the
1981 hash table size to reduce collisions. */
1984 /* Only the fields above are traced normally by the GC. The ones below
1985 `count' are special and are either ignored by the GC or traced in
1986 a special way (e.g. because of weakness). */
1988 /* Number of key/value entries in the table. */
1991 /* Index of first free entry in free list, or -1 if none. */
1992 ptrdiff_t next_free
;
1994 /* True if the table can be purecopied. The table cannot be
1995 changed afterwards. */
1998 /* Resize hash table when number of entries / table size is >= this
2000 float rehash_threshold
;
2002 /* Used when the table is resized. If equal to a negative integer,
2003 the user rehash-size is the integer -REHASH_SIZE, and the new
2004 size is the old size plus -REHASH_SIZE. If positive, the user
2005 rehash-size is the floating-point value REHASH_SIZE + 1, and the
2006 new size is the old size times REHASH_SIZE + 1. */
2009 /* Vector of keys and values. The key of item I is found at index
2010 2 * I, the value is found at index 2 * I + 1.
2011 This is gc_marked specially if the table is weak. */
2012 Lisp_Object key_and_value
;
2014 /* The comparison and hash functions. */
2015 struct hash_table_test test
;
2017 /* Next weak hash table if this is a weak hash table. The head
2018 of the list is in weak_hash_tables. */
2019 struct Lisp_Hash_Table
*next_weak
;
2024 HASH_TABLE_P (Lisp_Object a
)
2026 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
2029 INLINE
struct Lisp_Hash_Table
*
2030 XHASH_TABLE (Lisp_Object a
)
2032 eassert (HASH_TABLE_P (a
));
2033 return XUNTAG (a
, Lisp_Vectorlike
);
2036 #define XSET_HASH_TABLE(VAR, PTR) \
2037 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
2039 /* Value is the key part of entry IDX in hash table H. */
2041 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2043 return AREF (h
->key_and_value
, 2 * idx
);
2046 /* Value is the value part of entry IDX in hash table H. */
2048 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2050 return AREF (h
->key_and_value
, 2 * idx
+ 1);
2053 /* Value is the hash code computed for entry IDX in hash table H. */
2055 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2057 return AREF (h
->hash
, idx
);
2060 /* Value is the size of hash table H. */
2062 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
2064 return ASIZE (h
->next
);
2067 /* Default size for hash tables if not specified. */
2069 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
2071 /* Default threshold specifying when to resize a hash table. The
2072 value gives the ratio of current entries in the hash table and the
2073 size of the hash table. */
2075 static float const DEFAULT_REHASH_THRESHOLD
= 0.8125;
2077 /* Default factor by which to increase the size of a hash table, minus 1. */
2079 static float const DEFAULT_REHASH_SIZE
= 1.5 - 1;
2081 /* Combine two integers X and Y for hashing. The result might not fit
2082 into a Lisp integer. */
2085 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
2087 return (x
<< 4) + (x
>> (EMACS_INT_WIDTH
- 4)) + y
;
2090 /* Hash X, returning a value that fits into a fixnum. */
2093 SXHASH_REDUCE (EMACS_UINT x
)
2095 return (x
^ x
>> (EMACS_INT_WIDTH
- FIXNUM_BITS
)) & INTMASK
;
2098 /* These structures are used for various misc types. */
2100 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
2102 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
2103 bool_bf gcmarkbit
: 1;
2104 unsigned spacer
: 15;
2108 (MISCP
) (Lisp_Object x
)
2110 return lisp_h_MISCP (x
);
2113 INLINE
struct Lisp_Misc_Any
*
2114 XMISCANY (Lisp_Object a
)
2116 eassert (MISCP (a
));
2117 return XUNTAG (a
, Lisp_Misc
);
2120 INLINE
enum Lisp_Misc_Type
2121 XMISCTYPE (Lisp_Object a
)
2123 return XMISCANY (a
)->type
;
2128 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
2129 bool_bf gcmarkbit
: 1;
2130 unsigned spacer
: 13;
2131 /* This flag is temporarily used in the functions
2132 decode/encode_coding_object to record that the marker position
2133 must be adjusted after the conversion. */
2134 bool_bf need_adjustment
: 1;
2135 /* True means normal insertion at the marker's position
2136 leaves the marker after the inserted text. */
2137 bool_bf insertion_type
: 1;
2138 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2139 Note: a chain of markers can contain markers pointing into different
2140 buffers (the chain is per buffer_text rather than per buffer, so it's
2141 shared between indirect buffers). */
2142 /* This is used for (other than NULL-checking):
2144 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2145 - unchain_marker: to find the list from which to unchain.
2146 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2148 struct buffer
*buffer
;
2150 /* The remaining fields are meaningless in a marker that
2151 does not point anywhere. */
2153 /* For markers that point somewhere,
2154 this is used to chain of all the markers in a given buffer. */
2155 /* We could remove it and use an array in buffer_text instead.
2156 That would also allow us to preserve it ordered. */
2157 struct Lisp_Marker
*next
;
2158 /* This is the char position where the marker points. */
2160 /* This is the byte position.
2161 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2162 used to implement the functionality of markers, but rather to (ab)use
2163 markers as a cache for char<->byte mappings). */
2167 /* START and END are markers in the overlay's buffer, and
2168 PLIST is the overlay's property list. */
2170 /* An overlay's real data content is:
2172 - buffer (really there are two buffer pointers, one per marker,
2173 and both points to the same buffer)
2174 - insertion type of both ends (per-marker fields)
2175 - start & start byte (of start marker)
2176 - end & end byte (of end marker)
2177 - next (singly linked list of overlays)
2178 - next fields of start and end markers (singly linked list of markers).
2179 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2182 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2183 bool_bf gcmarkbit
: 1;
2184 unsigned spacer
: 15;
2185 struct Lisp_Overlay
*next
;
2191 /* Number of bits needed to store one of the values
2192 SAVE_UNUSED..SAVE_OBJECT. */
2193 enum { SAVE_SLOT_BITS
= 3 };
2195 /* Number of slots in a save value where save_type is nonzero. */
2196 enum { SAVE_VALUE_SLOTS
= 4 };
2198 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2200 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2202 /* Types of data which may be saved in a Lisp_Save_Value. */
2211 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2212 SAVE_TYPE_INT_INT_INT
2213 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2214 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2215 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2216 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2217 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2218 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2219 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2220 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2221 SAVE_TYPE_FUNCPTR_PTR_OBJ
2222 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2224 /* This has an extra bit indicating it's raw memory. */
2225 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2228 /* SAVE_SLOT_BITS must be large enough to represent these values. */
2229 verify (((SAVE_UNUSED
| SAVE_INTEGER
| SAVE_FUNCPOINTER
2230 | SAVE_POINTER
| SAVE_OBJECT
)
2234 /* Special object used to hold a different values for later use.
2236 This is mostly used to package C integers and pointers to call
2237 record_unwind_protect when two or more values need to be saved.
2241 struct my_data *md = get_my_data ();
2242 ptrdiff_t mi = get_my_integer ();
2243 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2246 Lisp_Object my_unwind (Lisp_Object arg)
2248 struct my_data *md = XSAVE_POINTER (arg, 0);
2249 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2253 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2254 saved objects and raise eassert if type of the saved object doesn't match
2255 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2256 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2257 slot 0 is a pointer. */
2259 typedef void (*voidfuncptr
) (void);
2261 struct Lisp_Save_Value
2263 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2264 bool_bf gcmarkbit
: 1;
2265 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2267 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2268 V's data entries are determined by V->save_type. E.g., if
2269 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2270 V->data[1] is an integer, and V's other data entries are unused.
2272 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2273 a memory area containing V->data[1].integer potential Lisp_Objects. */
2274 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2277 voidfuncptr funcpointer
;
2280 } data
[SAVE_VALUE_SLOTS
];
2284 SAVE_VALUEP (Lisp_Object x
)
2286 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2289 INLINE
struct Lisp_Save_Value
*
2290 XSAVE_VALUE (Lisp_Object a
)
2292 eassert (SAVE_VALUEP (a
));
2293 return XUNTAG (a
, Lisp_Misc
);
2296 /* Return the type of V's Nth saved value. */
2298 save_type (struct Lisp_Save_Value
*v
, int n
)
2300 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2301 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2304 /* Get and set the Nth saved pointer. */
2307 XSAVE_POINTER (Lisp_Object obj
, int n
)
2309 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2310 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2313 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2315 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2316 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2319 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2321 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2322 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2325 /* Likewise for the saved integer. */
2328 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2330 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2331 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2334 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2336 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2337 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2340 /* Extract Nth saved object. */
2343 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2345 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2346 return XSAVE_VALUE (obj
)->data
[n
].object
;
2350 struct Lisp_User_Ptr
2352 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_User_Ptr */
2353 bool_bf gcmarkbit
: 1;
2354 unsigned spacer
: 15;
2356 void (*finalizer
) (void *);
2361 /* A finalizer sentinel. */
2362 struct Lisp_Finalizer
2364 struct Lisp_Misc_Any base
;
2366 /* Circular list of all active weak references. */
2367 struct Lisp_Finalizer
*prev
;
2368 struct Lisp_Finalizer
*next
;
2370 /* Call FUNCTION when the finalizer becomes unreachable, even if
2371 FUNCTION contains a reference to the finalizer; i.e., call
2372 FUNCTION when it is reachable _only_ through finalizers. */
2373 Lisp_Object function
;
2377 FINALIZERP (Lisp_Object x
)
2379 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Finalizer
;
2382 INLINE
struct Lisp_Finalizer
*
2383 XFINALIZER (Lisp_Object a
)
2385 eassert (FINALIZERP (a
));
2386 return XUNTAG (a
, Lisp_Misc
);
2389 /* A miscellaneous object, when it's on the free list. */
2392 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2393 bool_bf gcmarkbit
: 1;
2394 unsigned spacer
: 15;
2395 union Lisp_Misc
*chain
;
2398 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2399 It uses one of these struct subtypes to get the type field. */
2403 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2404 struct Lisp_Free u_free
;
2405 struct Lisp_Marker u_marker
;
2406 struct Lisp_Overlay u_overlay
;
2407 struct Lisp_Save_Value u_save_value
;
2408 struct Lisp_Finalizer u_finalizer
;
2410 struct Lisp_User_Ptr u_user_ptr
;
2414 INLINE
union Lisp_Misc
*
2415 XMISC (Lisp_Object a
)
2417 return XUNTAG (a
, Lisp_Misc
);
2421 (MARKERP
) (Lisp_Object x
)
2423 return lisp_h_MARKERP (x
);
2426 INLINE
struct Lisp_Marker
*
2427 XMARKER (Lisp_Object a
)
2429 eassert (MARKERP (a
));
2430 return XUNTAG (a
, Lisp_Misc
);
2434 OVERLAYP (Lisp_Object x
)
2436 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2439 INLINE
struct Lisp_Overlay
*
2440 XOVERLAY (Lisp_Object a
)
2442 eassert (OVERLAYP (a
));
2443 return XUNTAG (a
, Lisp_Misc
);
2448 USER_PTRP (Lisp_Object x
)
2450 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_User_Ptr
;
2453 INLINE
struct Lisp_User_Ptr
*
2454 XUSER_PTR (Lisp_Object a
)
2456 eassert (USER_PTRP (a
));
2457 return XUNTAG (a
, Lisp_Misc
);
2462 /* Forwarding pointer to an int variable.
2463 This is allowed only in the value cell of a symbol,
2464 and it means that the symbol's value really lives in the
2465 specified int variable. */
2468 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2472 /* Boolean forwarding pointer to an int variable.
2473 This is like Lisp_Intfwd except that the ostensible
2474 "value" of the symbol is t if the bool variable is true,
2475 nil if it is false. */
2478 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2482 /* Forwarding pointer to a Lisp_Object variable.
2483 This is allowed only in the value cell of a symbol,
2484 and it means that the symbol's value really lives in the
2485 specified variable. */
2488 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2489 Lisp_Object
*objvar
;
2492 /* Like Lisp_Objfwd except that value lives in a slot in the
2493 current buffer. Value is byte index of slot within buffer. */
2494 struct Lisp_Buffer_Objfwd
2496 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2498 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2499 Lisp_Object predicate
;
2502 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2503 the symbol has buffer-local bindings. (Exception:
2504 some buffer-local variables are built-in, with their values stored
2505 in the buffer structure itself. They are handled differently,
2506 using struct Lisp_Buffer_Objfwd.)
2508 The `realvalue' slot holds the variable's current value, or a
2509 forwarding pointer to where that value is kept. This value is the
2510 one that corresponds to the loaded binding. To read or set the
2511 variable, you must first make sure the right binding is loaded;
2512 then you can access the value in (or through) `realvalue'.
2514 `buffer' and `frame' are the buffer and frame for which the loaded
2515 binding was found. If those have changed, to make sure the right
2516 binding is loaded it is necessary to find which binding goes with
2517 the current buffer and selected frame, then load it. To load it,
2518 first unload the previous binding, then copy the value of the new
2519 binding into `realvalue' (or through it). Also update
2520 LOADED-BINDING to point to the newly loaded binding.
2522 `local_if_set' indicates that merely setting the variable creates a
2523 local binding for the current buffer. Otherwise the latter, setting
2524 the variable does not do that; only make-local-variable does that. */
2526 struct Lisp_Buffer_Local_Value
2528 /* True means that merely setting the variable creates a local
2529 binding for the current buffer. */
2530 bool_bf local_if_set
: 1;
2531 /* True means that the binding now loaded was found.
2532 Presumably equivalent to (defcell!=valcell). */
2534 /* If non-NULL, a forwarding to the C var where it should also be set. */
2535 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2536 /* The buffer or frame for which the loaded binding was found. */
2538 /* A cons cell that holds the default value. It has the form
2539 (SYMBOL . DEFAULT-VALUE). */
2540 Lisp_Object defcell
;
2541 /* The cons cell from `where's parameter alist.
2542 It always has the form (SYMBOL . VALUE)
2543 Note that if `forward' is non-nil, VALUE may be out of date.
2544 Also if the currently loaded binding is the default binding, then
2545 this is `eq'ual to defcell. */
2546 Lisp_Object valcell
;
2549 /* Like Lisp_Objfwd except that value lives in a slot in the
2551 struct Lisp_Kboard_Objfwd
2553 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2559 struct Lisp_Intfwd u_intfwd
;
2560 struct Lisp_Boolfwd u_boolfwd
;
2561 struct Lisp_Objfwd u_objfwd
;
2562 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2563 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2566 INLINE
enum Lisp_Fwd_Type
2567 XFWDTYPE (union Lisp_Fwd
*a
)
2569 return a
->u_intfwd
.type
;
2573 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2575 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2578 INLINE
struct Lisp_Buffer_Objfwd
*
2579 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2581 eassert (BUFFER_OBJFWDP (a
));
2582 return &a
->u_buffer_objfwd
;
2585 /* Lisp floating point type. */
2591 struct Lisp_Float
*chain
;
2596 (FLOATP
) (Lisp_Object x
)
2598 return lisp_h_FLOATP (x
);
2601 INLINE
struct Lisp_Float
*
2602 XFLOAT (Lisp_Object a
)
2604 eassert (FLOATP (a
));
2605 return XUNTAG (a
, Lisp_Float
);
2609 XFLOAT_DATA (Lisp_Object f
)
2611 return XFLOAT (f
)->u
.data
;
2614 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2615 representations, have infinities and NaNs, and do not trap on
2616 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2617 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2618 wanted here, but is not quite right because Emacs does not require
2619 all the features of C11 Annex F (and does not require C11 at all,
2620 for that matter). */
2624 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2625 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2628 /* A character, declared with the following typedef, is a member
2629 of some character set associated with the current buffer. */
2630 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2632 typedef unsigned char UCHAR
;
2635 /* Meanings of slots in a Lisp_Compiled: */
2639 COMPILED_ARGLIST
= 0,
2640 COMPILED_BYTECODE
= 1,
2641 COMPILED_CONSTANTS
= 2,
2642 COMPILED_STACK_DEPTH
= 3,
2643 COMPILED_DOC_STRING
= 4,
2644 COMPILED_INTERACTIVE
= 5
2647 /* Flag bits in a character. These also get used in termhooks.h.
2648 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2649 (MUlti-Lingual Emacs) might need 22 bits for the character value
2650 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2653 CHAR_ALT
= 0x0400000,
2654 CHAR_SUPER
= 0x0800000,
2655 CHAR_HYPER
= 0x1000000,
2656 CHAR_SHIFT
= 0x2000000,
2657 CHAR_CTL
= 0x4000000,
2658 CHAR_META
= 0x8000000,
2660 CHAR_MODIFIER_MASK
=
2661 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2663 /* Actually, the current Emacs uses 22 bits for the character value
2668 /* Data type checking. */
2671 NUMBERP (Lisp_Object x
)
2673 return INTEGERP (x
) || FLOATP (x
);
2676 NATNUMP (Lisp_Object x
)
2678 return INTEGERP (x
) && 0 <= XINT (x
);
2682 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2684 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2687 #define TYPE_RANGED_INTEGERP(type, x) \
2689 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2690 && XINT (x) <= TYPE_MAXIMUM (type))
2693 AUTOLOADP (Lisp_Object x
)
2695 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2699 /* Test for specific pseudovector types. */
2702 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2704 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2708 COMPILEDP (Lisp_Object a
)
2710 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2714 FRAMEP (Lisp_Object a
)
2716 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2719 /* Test for image (image . spec) */
2721 IMAGEP (Lisp_Object x
)
2723 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2728 ARRAYP (Lisp_Object x
)
2730 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2734 CHECK_LIST (Lisp_Object x
)
2736 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2740 CHECK_LIST_END (Lisp_Object x
, Lisp_Object y
)
2742 CHECK_TYPE (NILP (x
), Qlistp
, y
);
2746 (CHECK_NUMBER
) (Lisp_Object x
)
2748 lisp_h_CHECK_NUMBER (x
);
2752 CHECK_STRING_CAR (Lisp_Object x
)
2754 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2756 /* This is a bit special because we always need size afterwards. */
2758 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2764 wrong_type_argument (Qarrayp
, x
);
2767 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2769 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2772 CHECK_NATNUM (Lisp_Object x
)
2774 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2777 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2780 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2781 args_out_of_range_3 \
2783 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2784 ? MOST_NEGATIVE_FIXNUM \
2786 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2788 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2790 if (TYPE_SIGNED (type)) \
2791 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2793 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2796 #define CHECK_NUMBER_COERCE_MARKER(x) \
2798 if (MARKERP ((x))) \
2799 XSETFASTINT (x, marker_position (x)); \
2801 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2805 XFLOATINT (Lisp_Object n
)
2807 return FLOATP (n
) ? XFLOAT_DATA (n
) : XINT (n
);
2811 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2813 CHECK_TYPE (NUMBERP (x
), Qnumberp
, x
);
2816 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2819 XSETFASTINT (x, marker_position (x)); \
2821 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2824 /* Since we can't assign directly to the CAR or CDR fields of a cons
2825 cell, use these when checking that those fields contain numbers. */
2827 CHECK_NUMBER_CAR (Lisp_Object x
)
2829 Lisp_Object tmp
= XCAR (x
);
2835 CHECK_NUMBER_CDR (Lisp_Object x
)
2837 Lisp_Object tmp
= XCDR (x
);
2842 /* Define a built-in function for calling from Lisp.
2843 `lname' should be the name to give the function in Lisp,
2844 as a null-terminated C string.
2845 `fnname' should be the name of the function in C.
2846 By convention, it starts with F.
2847 `sname' should be the name for the C constant structure
2848 that records information on this function for internal use.
2849 By convention, it should be the same as `fnname' but with S instead of F.
2850 It's too bad that C macros can't compute this from `fnname'.
2851 `minargs' should be a number, the minimum number of arguments allowed.
2852 `maxargs' should be a number, the maximum number of arguments allowed,
2853 or else MANY or UNEVALLED.
2854 MANY means pass a vector of evaluated arguments,
2855 in the form of an integer number-of-arguments
2856 followed by the address of a vector of Lisp_Objects
2857 which contains the argument values.
2858 UNEVALLED means pass the list of unevaluated arguments
2859 `intspec' says how interactive arguments are to be fetched.
2860 If the string starts with a `(', `intspec' is evaluated and the resulting
2861 list is the list of arguments.
2862 If it's a string that doesn't start with `(', the value should follow
2863 the one of the doc string for `interactive'.
2864 A null string means call interactively with no arguments.
2865 `doc' is documentation for the user. */
2867 /* This version of DEFUN declares a function prototype with the right
2868 arguments, so we can catch errors with maxargs at compile-time. */
2870 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2871 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2872 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2873 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2874 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2875 { (Lisp_Object (__cdecl *)(void))fnname }, \
2876 minargs, maxargs, lname, intspec, 0}; \
2878 #else /* not _MSC_VER */
2879 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2880 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2881 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2882 { .a ## maxargs = fnname }, \
2883 minargs, maxargs, lname, intspec, 0}; \
2888 is how we define the symbol for function `name' at start-up time. */
2889 extern void defsubr (struct Lisp_Subr
*);
2897 /* Call a function F that accepts many args, passing it ARRAY's elements. */
2898 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
2900 /* Call a function F that accepts many args, passing it the remaining args,
2901 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
2902 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
2903 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
2904 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
2906 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2907 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2908 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2909 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2910 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2912 /* Macros we use to define forwarded Lisp variables.
2913 These are used in the syms_of_FILENAME functions.
2915 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2916 lisp variable is actually a field in `struct emacs_globals'. The
2917 field's name begins with "f_", which is a convention enforced by
2918 these macros. Each such global has a corresponding #define in
2919 globals.h; the plain name should be used in the code.
2921 E.g., the global "cons_cells_consed" is declared as "int
2922 f_cons_cells_consed" in globals.h, but there is a define:
2924 #define cons_cells_consed globals.f_cons_cells_consed
2926 All C code uses the `cons_cells_consed' name. This is all done
2927 this way to support indirection for multi-threaded Emacs. */
2929 #define DEFVAR_LISP(lname, vname, doc) \
2931 static struct Lisp_Objfwd o_fwd; \
2932 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2934 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2936 static struct Lisp_Objfwd o_fwd; \
2937 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2939 #define DEFVAR_BOOL(lname, vname, doc) \
2941 static struct Lisp_Boolfwd b_fwd; \
2942 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2944 #define DEFVAR_INT(lname, vname, doc) \
2946 static struct Lisp_Intfwd i_fwd; \
2947 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2950 #define DEFVAR_KBOARD(lname, vname, doc) \
2952 static struct Lisp_Kboard_Objfwd ko_fwd; \
2953 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2956 /* Save and restore the instruction and environment pointers,
2957 without affecting the signal mask. */
2960 typedef jmp_buf sys_jmp_buf
;
2961 # define sys_setjmp(j) _setjmp (j)
2962 # define sys_longjmp(j, v) _longjmp (j, v)
2963 #elif defined HAVE_SIGSETJMP
2964 typedef sigjmp_buf sys_jmp_buf
;
2965 # define sys_setjmp(j) sigsetjmp (j, 0)
2966 # define sys_longjmp(j, v) siglongjmp (j, v)
2968 /* A platform that uses neither _longjmp nor siglongjmp; assume
2969 longjmp does not affect the sigmask. */
2970 typedef jmp_buf sys_jmp_buf
;
2971 # define sys_setjmp(j) setjmp (j)
2972 # define sys_longjmp(j, v) longjmp (j, v)
2976 /* Elisp uses several stacks:
2978 - the bytecode stack: used internally by the bytecode interpreter.
2979 Allocated from the C stack.
2980 - The specpdl stack: keeps track of active unwind-protect and
2981 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2983 - The handler stack: keeps track of active catch tags and condition-case
2984 handlers. Allocated in a manually managed stack implemented by a
2985 doubly-linked list allocated via xmalloc and never freed. */
2987 /* Structure for recording Lisp call stack for backtrace purposes. */
2989 /* The special binding stack holds the outer values of variables while
2990 they are bound by a function application or a let form, stores the
2991 code to be executed for unwind-protect forms.
2993 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2994 used all over the place, needs to be fast, and needs to know the size of
2995 union specbinding. But only eval.c should access it. */
2998 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2999 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
3000 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
3001 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
3002 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
3003 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
3004 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3005 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
3006 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
3011 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3013 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3014 void (*func
) (Lisp_Object
);
3018 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3019 void (*func
) (void *);
3023 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3028 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3029 void (*func
) (void);
3032 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3033 /* `where' is not used in the case of SPECPDL_LET. */
3034 Lisp_Object symbol
, old_value
, where
;
3035 /* Normally this is unused; but it is set to the symbol's
3036 current value when a thread is swapped out. */
3037 Lisp_Object saved_value
;
3040 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3041 bool_bf debug_on_exit
: 1;
3042 Lisp_Object function
;
3048 /* These 3 are defined as macros in thread.h. */
3049 /* extern union specbinding *specpdl; */
3050 /* extern union specbinding *specpdl_ptr; */
3051 /* extern ptrdiff_t specpdl_size; */
3054 SPECPDL_INDEX (void)
3056 return specpdl_ptr
- specpdl
;
3059 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3060 control structures. A struct handler contains all the information needed to
3061 restore the state of the interpreter after a non-local jump.
3063 handler structures are chained together in a doubly linked list; the `next'
3064 member points to the next outer catchtag and the `nextfree' member points in
3065 the other direction to the next inner element (which is typically the next
3066 free element since we mostly use it on the deepest handler).
3068 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3069 member is TAG, and then unbinds to it. The `val' member is used to
3070 hold VAL while the stack is unwound; `val' is returned as the value
3071 of the catch form. If there is a handler of type CATCHER_ALL, it will
3072 be treated as a handler for all invocations of `throw'; in this case
3073 `val' will be set to (TAG . VAL).
3075 All the other members are concerned with restoring the interpreter
3078 Members are volatile if their values need to survive _longjmp when
3079 a 'struct handler' is a local variable. */
3081 enum handlertype
{ CATCHER
, CONDITION_CASE
, CATCHER_ALL
};
3085 enum handlertype type
;
3086 Lisp_Object tag_or_ch
;
3088 struct handler
*next
;
3089 struct handler
*nextfree
;
3091 /* The bytecode interpreter can have several handlers active at the same
3092 time, so when we longjmp to one of them, it needs to know which handler
3093 this was and what was the corresponding internal state. This is stored
3094 here, and when we longjmp we make sure that handlerlist points to the
3096 Lisp_Object
*bytecode_top
;
3099 /* Most global vars are reset to their value via the specpdl mechanism,
3100 but a few others are handled by storing their value here. */
3102 EMACS_INT f_lisp_eval_depth
;
3104 int poll_suppress_count
;
3105 int interrupt_input_blocked
;
3108 extern Lisp_Object memory_signal_data
;
3110 extern void maybe_quit (void);
3112 /* True if ought to quit now. */
3114 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3116 /* Process a quit rarely, based on a counter COUNT, for efficiency.
3117 "Rarely" means once per USHRT_MAX + 1 times; this is somewhat
3118 arbitrary, but efficient. */
3121 rarely_quit (unsigned short int count
)
3127 extern Lisp_Object Vascii_downcase_table
;
3128 extern Lisp_Object Vascii_canon_table
;
3130 /* Call staticpro (&var) to protect static variable `var'. */
3132 void staticpro (Lisp_Object
*);
3134 /* Forward declarations for prototypes. */
3138 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3141 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3143 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3144 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3147 /* Functions to modify hash tables. */
3150 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3152 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3156 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3158 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3161 /* Use these functions to set Lisp_Object
3162 or pointer slots of struct Lisp_Symbol. */
3165 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3167 XSYMBOL (sym
)->function
= function
;
3171 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3173 XSYMBOL (sym
)->plist
= plist
;
3177 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3179 XSYMBOL (sym
)->next
= next
;
3183 make_symbol_constant (Lisp_Object sym
)
3185 XSYMBOL (sym
)->trapped_write
= SYMBOL_NOWRITE
;
3188 /* Buffer-local variable access functions. */
3191 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3193 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3197 /* Set overlay's property list. */
3200 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3202 XOVERLAY (overlay
)->plist
= plist
;
3205 /* Get text properties of S. */
3208 string_intervals (Lisp_Object s
)
3210 return XSTRING (s
)->intervals
;
3213 /* Set text properties of S to I. */
3216 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3218 XSTRING (s
)->intervals
= i
;
3221 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3222 of setting slots directly. */
3225 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3227 XCHAR_TABLE (table
)->defalt
= val
;
3230 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3232 XCHAR_TABLE (table
)->purpose
= val
;
3235 /* Set different slots in (sub)character tables. */
3238 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3240 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3241 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3245 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3247 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3248 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3252 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3254 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3257 /* Defined in data.c. */
3258 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
3259 extern void notify_variable_watchers (Lisp_Object
, Lisp_Object
,
3260 Lisp_Object
, Lisp_Object
);
3261 extern Lisp_Object
indirect_function (Lisp_Object
);
3262 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3263 enum Arith_Comparison
{
3268 ARITH_LESS_OR_EQUAL
,
3271 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3272 enum Arith_Comparison comparison
);
3274 /* Convert the integer I to an Emacs representation, either the integer
3275 itself, or a cons of two or three integers, or if all else fails a float.
3276 I should not have side effects. */
3277 #define INTEGER_TO_CONS(i) \
3278 (! FIXNUM_OVERFLOW_P (i) \
3280 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3281 extern Lisp_Object
intbig_to_lisp (intmax_t);
3282 extern Lisp_Object
uintbig_to_lisp (uintmax_t);
3284 /* Convert the Emacs representation CONS back to an integer of type
3285 TYPE, storing the result the variable VAR. Signal an error if CONS
3286 is not a valid representation or is out of range for TYPE. */
3287 #define CONS_TO_INTEGER(cons, type, var) \
3288 (TYPE_SIGNED (type) \
3289 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3290 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3291 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3292 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3294 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3295 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3296 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3298 extern _Noreturn
void circular_list (Lisp_Object
);
3299 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3300 enum Set_Internal_Bind
{
3303 SET_INTERNAL_UNBIND
,
3304 SET_INTERNAL_THREAD_SWITCH
3306 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3307 enum Set_Internal_Bind
);
3308 extern void set_default_internal (Lisp_Object
, Lisp_Object
,
3309 enum Set_Internal_Bind bindflag
);
3311 extern void syms_of_data (void);
3312 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3314 /* Defined in cmds.c */
3315 extern void syms_of_cmds (void);
3316 extern void keys_of_cmds (void);
3318 /* Defined in coding.c. */
3319 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3320 ptrdiff_t, bool, bool, Lisp_Object
);
3321 extern void init_coding (void);
3322 extern void init_coding_once (void);
3323 extern void syms_of_coding (void);
3325 /* Defined in character.c. */
3326 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3327 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3328 extern void syms_of_character (void);
3330 /* Defined in charset.c. */
3331 extern void init_charset (void);
3332 extern void init_charset_once (void);
3333 extern void syms_of_charset (void);
3334 /* Structure forward declarations. */
3337 /* Defined in syntax.c. */
3338 extern void init_syntax_once (void);
3339 extern void syms_of_syntax (void);
3341 /* Defined in fns.c. */
3342 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3343 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3344 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3345 extern void sweep_weak_hash_tables (void);
3346 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3347 EMACS_UINT
sxhash (Lisp_Object
, int);
3348 Lisp_Object
make_hash_table (struct hash_table_test
, EMACS_INT
, float, float,
3350 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3351 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3353 void hash_remove_from_table (struct Lisp_Hash_Table
*, Lisp_Object
);
3354 extern struct hash_table_test
const hashtest_eq
, hashtest_eql
, hashtest_equal
;
3355 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3356 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3357 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3358 ptrdiff_t, ptrdiff_t);
3359 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3360 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3361 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3362 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3363 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3364 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3365 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3366 extern void clear_string_char_byte_cache (void);
3367 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3368 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3369 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3370 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3371 extern void syms_of_fns (void);
3373 /* Defined in floatfns.c. */
3374 extern void syms_of_floatfns (void);
3375 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3377 /* Defined in fringe.c. */
3378 extern void syms_of_fringe (void);
3379 extern void init_fringe (void);
3380 #ifdef HAVE_WINDOW_SYSTEM
3381 extern void mark_fringe_data (void);
3382 extern void init_fringe_once (void);
3383 #endif /* HAVE_WINDOW_SYSTEM */
3385 /* Defined in image.c. */
3386 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3387 extern void reset_image_types (void);
3388 extern void syms_of_image (void);
3390 /* Defined in insdel.c. */
3391 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3392 extern _Noreturn
void buffer_overflow (void);
3393 extern void make_gap (ptrdiff_t);
3394 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3395 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3396 ptrdiff_t, bool, bool);
3397 extern int count_combining_before (const unsigned char *,
3398 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3399 extern int count_combining_after (const unsigned char *,
3400 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3401 extern void insert (const char *, ptrdiff_t);
3402 extern void insert_and_inherit (const char *, ptrdiff_t);
3403 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3405 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3406 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3407 ptrdiff_t, ptrdiff_t, bool);
3408 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3409 extern void insert_char (int);
3410 extern void insert_string (const char *);
3411 extern void insert_before_markers (const char *, ptrdiff_t);
3412 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3413 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3414 ptrdiff_t, ptrdiff_t,
3416 extern void del_range (ptrdiff_t, ptrdiff_t);
3417 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3418 extern void del_range_byte (ptrdiff_t, ptrdiff_t);
3419 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3420 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3421 ptrdiff_t, ptrdiff_t, bool);
3422 extern void modify_text (ptrdiff_t, ptrdiff_t);
3423 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3424 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3425 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3426 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3427 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3428 ptrdiff_t, ptrdiff_t);
3429 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3430 ptrdiff_t, ptrdiff_t);
3431 extern void adjust_markers_bytepos (ptrdiff_t, ptrdiff_t,
3432 ptrdiff_t, ptrdiff_t, int);
3433 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool, bool);
3434 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3435 const char *, ptrdiff_t, ptrdiff_t, bool);
3436 extern void syms_of_insdel (void);
3438 /* Defined in dispnew.c. */
3439 #if (defined PROFILING \
3440 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3441 _Noreturn
void __executable_start (void);
3443 extern Lisp_Object Vwindow_system
;
3444 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3446 /* Defined in xdisp.c. */
3447 extern bool noninteractive_need_newline
;
3448 extern Lisp_Object echo_area_buffer
[2];
3449 extern void add_to_log (char const *, ...);
3450 extern void vadd_to_log (char const *, va_list);
3451 extern void check_message_stack (void);
3452 extern void setup_echo_area_for_printing (bool);
3453 extern bool push_message (void);
3454 extern void pop_message_unwind (void);
3455 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3456 extern void restore_message (void);
3457 extern Lisp_Object
current_message (void);
3458 extern void clear_message (bool, bool);
3459 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3460 extern void message1 (const char *);
3461 extern void message1_nolog (const char *);
3462 extern void message3 (Lisp_Object
);
3463 extern void message3_nolog (Lisp_Object
);
3464 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3465 extern void message_with_string (const char *, Lisp_Object
, bool);
3466 extern void message_log_maybe_newline (void);
3467 extern void update_echo_area (void);
3468 extern void truncate_echo_area (ptrdiff_t);
3469 extern void redisplay (void);
3471 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3472 extern void syms_of_xdisp (void);
3473 extern void init_xdisp (void);
3474 extern Lisp_Object
safe_eval (Lisp_Object
);
3475 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3476 int *, int *, int *, int *, int *);
3478 /* Defined in xsettings.c. */
3479 extern void syms_of_xsettings (void);
3481 /* Defined in vm-limit.c. */
3482 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3484 /* Defined in character.c. */
3485 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3486 ptrdiff_t *, ptrdiff_t *);
3488 /* Defined in alloc.c. */
3489 extern void *my_heap_start (void);
3490 extern void check_pure_size (void);
3491 extern void free_misc (Lisp_Object
);
3492 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3493 extern void malloc_warning (const char *);
3494 extern _Noreturn
void memory_full (size_t);
3495 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3496 extern bool survives_gc_p (Lisp_Object
);
3497 extern void mark_object (Lisp_Object
);
3498 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3499 extern void refill_memory_reserve (void);
3501 extern void alloc_unexec_pre (void);
3502 extern void alloc_unexec_post (void);
3503 extern void mark_stack (char *, char *);
3504 extern void flush_stack_call_func (void (*func
) (void *arg
), void *arg
);
3505 extern const char *pending_malloc_warning
;
3506 extern Lisp_Object zero_vector
;
3507 extern EMACS_INT consing_since_gc
;
3508 extern EMACS_INT gc_relative_threshold
;
3509 extern EMACS_INT memory_full_cons_threshold
;
3510 extern Lisp_Object
list1 (Lisp_Object
);
3511 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3512 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3513 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3514 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3516 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3517 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3519 /* Build a frequently used 2/3/4-integer lists. */
3522 list2i (EMACS_INT x
, EMACS_INT y
)
3524 return list2 (make_number (x
), make_number (y
));
3528 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3530 return list3 (make_number (x
), make_number (y
), make_number (w
));
3534 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3536 return list4 (make_number (x
), make_number (y
),
3537 make_number (w
), make_number (h
));
3540 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3541 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3542 extern _Noreturn
void string_overflow (void);
3543 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3544 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3545 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3546 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3548 /* Make unibyte string from C string when the length isn't known. */
3551 build_unibyte_string (const char *str
)
3553 return make_unibyte_string (str
, strlen (str
));
3556 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3557 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3558 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3559 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3560 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3561 extern Lisp_Object
make_specified_string (const char *,
3562 ptrdiff_t, ptrdiff_t, bool);
3563 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3564 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3566 /* Make a string allocated in pure space, use STR as string data. */
3569 build_pure_c_string (const char *str
)
3571 return make_pure_c_string (str
, strlen (str
));
3574 /* Make a string from the data at STR, treating it as multibyte if the
3578 build_string (const char *str
)
3580 return make_string (str
, strlen (str
));
3583 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3584 extern void make_byte_code (struct Lisp_Vector
*);
3585 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3587 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3588 be sure that GC cannot happen until the vector is completely
3589 initialized. E.g. the following code is likely to crash:
3591 v = make_uninit_vector (3);
3593 ASET (v, 1, Ffunction_can_gc ());
3594 ASET (v, 2, obj1); */
3597 make_uninit_vector (ptrdiff_t size
)
3600 struct Lisp_Vector
*p
;
3602 p
= allocate_vector (size
);
3607 /* Like above, but special for sub char-tables. */
3610 make_uninit_sub_char_table (int depth
, int min_char
)
3612 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3613 Lisp_Object v
= make_uninit_vector (slots
);
3615 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3616 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3617 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3621 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3624 /* Allocate partially initialized pseudovector where all Lisp_Object
3625 slots are set to Qnil but the rest (if any) is left uninitialized. */
3627 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3628 ((type *) allocate_pseudovector (VECSIZE (type), \
3629 PSEUDOVECSIZE (type, field), \
3630 PSEUDOVECSIZE (type, field), tag))
3632 /* Allocate fully initialized pseudovector where all Lisp_Object
3633 slots are set to Qnil and the rest (if any) is zeroed. */
3635 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3636 ((type *) allocate_pseudovector (VECSIZE (type), \
3637 PSEUDOVECSIZE (type, field), \
3638 VECSIZE (type), tag))
3640 extern bool gc_in_progress
;
3641 extern Lisp_Object
make_float (double);
3642 extern void display_malloc_warning (void);
3643 extern ptrdiff_t inhibit_garbage_collection (void);
3644 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3645 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3646 Lisp_Object
, Lisp_Object
);
3647 extern Lisp_Object
make_save_ptr (void *);
3648 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3649 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3650 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3652 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3653 extern void free_save_value (Lisp_Object
);
3654 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3655 extern void free_marker (Lisp_Object
);
3656 extern void free_cons (struct Lisp_Cons
*);
3657 extern void init_alloc_once (void);
3658 extern void init_alloc (void);
3659 extern void syms_of_alloc (void);
3660 extern struct buffer
* allocate_buffer (void);
3661 extern int valid_lisp_object_p (Lisp_Object
);
3662 #ifdef GC_CHECK_CONS_LIST
3663 extern void check_cons_list (void);
3665 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3668 /* Defined in gmalloc.c. */
3669 #if !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC && !defined SYSTEM_MALLOC
3670 extern size_t __malloc_extra_blocks
;
3672 #if !HAVE_DECL_ALIGNED_ALLOC
3673 extern void *aligned_alloc (size_t, size_t) ATTRIBUTE_MALLOC_SIZE ((2));
3675 extern void malloc_enable_thread (void);
3678 /* Defined in ralloc.c. */
3679 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3680 extern void r_alloc_free (void **);
3681 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3682 extern void r_alloc_reset_variable (void **, void **);
3683 extern void r_alloc_inhibit_buffer_relocation (int);
3686 /* Defined in chartab.c. */
3687 extern Lisp_Object
copy_char_table (Lisp_Object
);
3688 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3690 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3691 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3693 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3694 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3695 Lisp_Object
, Lisp_Object
,
3696 Lisp_Object
, struct charset
*,
3697 unsigned, unsigned);
3698 extern Lisp_Object
uniprop_table (Lisp_Object
);
3699 extern void syms_of_chartab (void);
3701 /* Defined in print.c. */
3702 extern Lisp_Object Vprin1_to_string_buffer
;
3703 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3704 extern void temp_output_buffer_setup (const char *);
3705 extern int print_level
;
3706 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3708 extern Lisp_Object internal_with_output_to_temp_buffer
3709 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3710 #define FLOAT_TO_STRING_BUFSIZE 350
3711 extern int float_to_string (char *, double);
3712 extern void init_print_once (void);
3713 extern void syms_of_print (void);
3715 /* Defined in doprnt.c. */
3716 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3718 extern ptrdiff_t esprintf (char *, char const *, ...)
3719 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3720 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3722 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3723 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3724 char const *, va_list)
3725 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3727 /* Defined in lread.c. */
3728 extern Lisp_Object
check_obarray (Lisp_Object
);
3729 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3730 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3731 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3732 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3733 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3735 LOADHIST_ATTACH (Lisp_Object x
)
3738 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3740 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3741 Lisp_Object
*, Lisp_Object
, bool);
3742 extern Lisp_Object
string_to_number (char const *, int, bool);
3743 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3745 extern void dir_warning (const char *, Lisp_Object
);
3746 extern void init_obarray (void);
3747 extern void init_lread (void);
3748 extern void syms_of_lread (void);
3751 intern (const char *str
)
3753 return intern_1 (str
, strlen (str
));
3757 intern_c_string (const char *str
)
3759 return intern_c_string_1 (str
, strlen (str
));
3762 /* Defined in eval.c. */
3763 extern Lisp_Object Vautoload_queue
;
3764 extern Lisp_Object Vrun_hooks
;
3765 extern Lisp_Object Vsignaling_function
;
3766 extern Lisp_Object inhibit_lisp_code
;
3768 /* To run a normal hook, use the appropriate function from the list below.
3769 The calling convention:
3771 if (!NILP (Vrun_hooks))
3772 call1 (Vrun_hooks, Qmy_funny_hook);
3774 should no longer be used. */
3775 extern void run_hook (Lisp_Object
);
3776 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3777 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3778 Lisp_Object (*funcall
)
3779 (ptrdiff_t nargs
, Lisp_Object
*args
));
3780 extern Lisp_Object
quit (void);
3781 INLINE _Noreturn
void
3782 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
3784 Fsignal (error_symbol
, data
);
3786 extern _Noreturn
void xsignal0 (Lisp_Object
);
3787 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3788 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3789 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3791 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3792 extern bool FUNCTIONP (Lisp_Object
);
3793 extern Lisp_Object
funcall_subr (struct Lisp_Subr
*subr
, ptrdiff_t numargs
, Lisp_Object
*arg_vector
);
3794 extern Lisp_Object
eval_sub (Lisp_Object form
);
3795 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3796 extern Lisp_Object
call0 (Lisp_Object
);
3797 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3798 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3799 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3800 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3801 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3802 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3803 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3804 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3805 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3806 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3807 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3808 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3809 extern Lisp_Object internal_condition_case_n
3810 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3811 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3812 extern struct handler
*push_handler (Lisp_Object
, enum handlertype
);
3813 extern struct handler
*push_handler_nosignal (Lisp_Object
, enum handlertype
);
3814 extern void specbind (Lisp_Object
, Lisp_Object
);
3815 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3816 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3817 extern void record_unwind_protect_int (void (*) (int), int);
3818 extern void record_unwind_protect_void (void (*) (void));
3819 extern void record_unwind_protect_nothing (void);
3820 extern void clear_unwind_protect (ptrdiff_t);
3821 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3822 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3823 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3824 extern void rebind_for_thread_switch (void);
3825 extern void unbind_for_thread_switch (struct thread_state
*);
3826 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3827 extern _Noreturn
void verror (const char *, va_list)
3828 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3829 extern Lisp_Object
vformat_string (const char *, va_list)
3830 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3831 extern void un_autoload (Lisp_Object
);
3832 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3833 extern void *near_C_stack_top (void);
3834 extern void init_eval_once (void);
3835 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3836 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3837 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3838 extern void init_eval (void);
3839 extern void syms_of_eval (void);
3840 extern void prog_ignore (Lisp_Object
);
3841 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
3842 extern void mark_specpdl (union specbinding
*first
, union specbinding
*ptr
);
3843 extern void get_backtrace (Lisp_Object array
);
3844 Lisp_Object
backtrace_top_function (void);
3845 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3848 /* Defined in alloc.c. */
3849 extern Lisp_Object
make_user_ptr (void (*finalizer
) (void *), void *p
);
3851 /* Defined in emacs-module.c. */
3852 extern void syms_of_module (void);
3855 /* Defined in thread.c. */
3856 extern void mark_threads (void);
3858 /* Defined in editfns.c. */
3859 extern void insert1 (Lisp_Object
);
3860 extern Lisp_Object
save_excursion_save (void);
3861 extern Lisp_Object
save_restriction_save (void);
3862 extern void save_excursion_restore (Lisp_Object
);
3863 extern void save_restriction_restore (Lisp_Object
);
3864 extern _Noreturn
void time_overflow (void);
3865 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3866 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3868 extern void init_editfns (bool);
3869 extern void syms_of_editfns (void);
3871 /* Defined in buffer.c. */
3872 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3873 extern _Noreturn
void nsberror (Lisp_Object
);
3874 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3875 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3876 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3877 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3878 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3879 extern bool overlay_touches_p (ptrdiff_t);
3880 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3881 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3882 extern void init_buffer_once (void);
3883 extern void init_buffer (int);
3884 extern void syms_of_buffer (void);
3885 extern void keys_of_buffer (void);
3887 /* Defined in marker.c. */
3889 extern ptrdiff_t marker_position (Lisp_Object
);
3890 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3891 extern void clear_charpos_cache (struct buffer
*);
3892 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3893 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3894 extern void unchain_marker (struct Lisp_Marker
*marker
);
3895 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3896 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3897 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3898 ptrdiff_t, ptrdiff_t);
3899 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3900 extern void syms_of_marker (void);
3902 /* Defined in fileio.c. */
3904 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3905 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3906 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3908 extern void close_file_unwind (int);
3909 extern void fclose_unwind (void *);
3910 extern void restore_point_unwind (Lisp_Object
);
3911 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3912 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3913 extern _Noreturn
void report_file_notify_error (const char *, Lisp_Object
);
3914 extern bool internal_delete_file (Lisp_Object
);
3915 extern Lisp_Object
emacs_readlinkat (int, const char *);
3916 extern bool file_directory_p (const char *);
3917 extern bool file_accessible_directory_p (Lisp_Object
);
3918 extern void init_fileio (void);
3919 extern void syms_of_fileio (void);
3920 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3922 /* Defined in search.c. */
3923 extern void shrink_regexp_cache (void);
3924 extern void restore_search_regs (void);
3925 extern void update_search_regs (ptrdiff_t oldstart
,
3926 ptrdiff_t oldend
, ptrdiff_t newend
);
3927 extern void record_unwind_save_match_data (void);
3928 struct re_registers
;
3929 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3930 struct re_registers
*,
3931 Lisp_Object
, bool, bool);
3932 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
3936 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
3938 return fast_string_match_internal (regexp
, string
, Qnil
);
3942 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
3944 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
3947 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3949 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3950 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3951 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3952 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3953 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3955 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3956 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3957 ptrdiff_t, ptrdiff_t *);
3958 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3959 ptrdiff_t, ptrdiff_t *);
3960 extern void syms_of_search (void);
3961 extern void clear_regexp_cache (void);
3963 /* Defined in minibuf.c. */
3965 extern Lisp_Object Vminibuffer_list
;
3966 extern Lisp_Object last_minibuf_string
;
3967 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3968 extern void init_minibuf_once (void);
3969 extern void syms_of_minibuf (void);
3971 /* Defined in callint.c. */
3973 extern void syms_of_callint (void);
3975 /* Defined in casefiddle.c. */
3977 extern void syms_of_casefiddle (void);
3978 extern void keys_of_casefiddle (void);
3980 /* Defined in casetab.c. */
3982 extern void init_casetab_once (void);
3983 extern void syms_of_casetab (void);
3985 /* Defined in keyboard.c. */
3987 extern Lisp_Object echo_message_buffer
;
3988 extern struct kboard
*echo_kboard
;
3989 extern void cancel_echoing (void);
3990 extern bool input_pending
;
3991 #ifdef HAVE_STACK_OVERFLOW_HANDLING
3992 extern sigjmp_buf return_to_command_loop
;
3994 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3995 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3996 extern void discard_mouse_events (void);
3998 void handle_input_available_signal (int);
4000 extern Lisp_Object pending_funcalls
;
4001 extern bool detect_input_pending (void);
4002 extern bool detect_input_pending_ignore_squeezables (void);
4003 extern bool detect_input_pending_run_timers (bool);
4004 extern void safe_run_hooks (Lisp_Object
);
4005 extern void cmd_error_internal (Lisp_Object
, const char *);
4006 extern Lisp_Object
command_loop_1 (void);
4007 extern Lisp_Object
read_menu_command (void);
4008 extern Lisp_Object
recursive_edit_1 (void);
4009 extern void record_auto_save (void);
4010 extern void force_auto_save_soon (void);
4011 extern void init_keyboard (void);
4012 extern void syms_of_keyboard (void);
4013 extern void keys_of_keyboard (void);
4015 /* Defined in indent.c. */
4016 extern ptrdiff_t current_column (void);
4017 extern void invalidate_current_column (void);
4018 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4019 extern void syms_of_indent (void);
4021 /* Defined in frame.c. */
4022 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4023 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4024 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4025 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4026 extern void frames_discard_buffer (Lisp_Object
);
4027 extern void syms_of_frame (void);
4029 /* Defined in emacs.c. */
4030 extern char **initial_argv
;
4031 extern int initial_argc
;
4032 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4033 extern bool display_arg
;
4035 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4036 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4037 extern _Noreturn
void terminate_due_to_signal (int, int);
4039 extern Lisp_Object Vlibrary_cache
;
4042 void fixup_locale (void);
4043 void synchronize_system_messages_locale (void);
4044 void synchronize_system_time_locale (void);
4046 INLINE
void fixup_locale (void) {}
4047 INLINE
void synchronize_system_messages_locale (void) {}
4048 INLINE
void synchronize_system_time_locale (void) {}
4050 extern char *emacs_strerror (int);
4051 extern void shut_down_emacs (int, Lisp_Object
);
4053 /* True means don't do interactive redisplay and don't change tty modes. */
4054 extern bool noninteractive
;
4056 /* True means remove site-lisp directories from load-path. */
4057 extern bool no_site_lisp
;
4059 /* True means put details like time stamps into builds. */
4060 extern bool build_details
;
4063 /* 0 not a daemon, 1 new-style (foreground), 2 old-style (background). */
4064 extern int daemon_type
;
4065 #define IS_DAEMON (daemon_type != 0)
4066 #define DAEMON_RUNNING (daemon_type >= 0)
4067 #else /* WINDOWSNT */
4068 extern void *w32_daemon_event
;
4069 #define IS_DAEMON (w32_daemon_event != NULL)
4070 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4073 /* True if handling a fatal error already. */
4074 extern bool fatal_error_in_progress
;
4076 /* True means don't do use window-system-specific display code. */
4077 extern bool inhibit_window_system
;
4078 /* True means that a filter or a sentinel is running. */
4079 extern bool running_asynch_code
;
4081 /* Defined in process.c. */
4082 struct Lisp_Process
;
4083 extern void kill_buffer_processes (Lisp_Object
);
4084 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4085 struct Lisp_Process
*, int);
4086 /* Max value for the first argument of wait_reading_process_output. */
4087 #if GNUC_PREREQ (3, 0, 0) && ! GNUC_PREREQ (4, 6, 0)
4088 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.0.
4089 The bug merely causes a bogus warning, but the warning is annoying. */
4090 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4092 # define WAIT_READING_MAX INTMAX_MAX
4095 extern void add_timer_wait_descriptor (int);
4097 extern void add_keyboard_wait_descriptor (int);
4098 extern void delete_keyboard_wait_descriptor (int);
4100 extern void add_gpm_wait_descriptor (int);
4101 extern void delete_gpm_wait_descriptor (int);
4103 extern void init_process_emacs (int);
4104 extern void syms_of_process (void);
4105 extern void setup_process_coding_systems (Lisp_Object
);
4107 /* Defined in callproc.c. */
4109 # define CHILD_SETUP_TYPE _Noreturn void
4111 # define CHILD_SETUP_TYPE int
4113 extern CHILD_SETUP_TYPE
child_setup (int, int, int, char **, bool, Lisp_Object
);
4114 extern void init_callproc_1 (void);
4115 extern void init_callproc (void);
4116 extern void set_initial_environment (void);
4117 extern void syms_of_callproc (void);
4119 /* Defined in doc.c. */
4120 enum text_quoting_style
4122 /* Use curved single quotes ‘like this’. */
4123 CURVE_QUOTING_STYLE
,
4125 /* Use grave accent and apostrophe `like this'. */
4126 GRAVE_QUOTING_STYLE
,
4128 /* Use apostrophes 'like this'. */
4129 STRAIGHT_QUOTING_STYLE
4131 extern enum text_quoting_style
text_quoting_style (void);
4132 extern Lisp_Object
read_doc_string (Lisp_Object
);
4133 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4134 extern void syms_of_doc (void);
4135 extern int read_bytecode_char (bool);
4137 /* Defined in bytecode.c. */
4138 extern void syms_of_bytecode (void);
4139 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4140 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4141 extern Lisp_Object
get_byte_code_arity (Lisp_Object
);
4143 /* Defined in macros.c. */
4144 extern void init_macros (void);
4145 extern void syms_of_macros (void);
4147 /* Defined in undo.c. */
4148 extern void truncate_undo_list (struct buffer
*);
4149 extern void record_insert (ptrdiff_t, ptrdiff_t);
4150 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4151 extern void record_first_change (void);
4152 extern void record_change (ptrdiff_t, ptrdiff_t);
4153 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4154 Lisp_Object
, Lisp_Object
,
4156 extern void syms_of_undo (void);
4158 /* Defined in textprop.c. */
4159 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4161 /* Defined in menu.c. */
4162 extern void syms_of_menu (void);
4164 /* Defined in xmenu.c. */
4165 extern void syms_of_xmenu (void);
4167 /* Defined in termchar.h. */
4168 struct tty_display_info
;
4170 /* Defined in sysdep.c. */
4171 #ifdef HAVE_PERSONALITY_ADDR_NO_RANDOMIZE
4172 extern bool disable_address_randomization (void);
4174 INLINE
bool disable_address_randomization (void) { return false; }
4176 extern int emacs_exec_file (char const *, char *const *, char *const *);
4177 extern void init_standard_fds (void);
4178 extern char *emacs_get_current_dir_name (void);
4179 extern void stuff_char (char c
);
4180 extern void init_foreground_group (void);
4181 extern void sys_subshell (void);
4182 extern void sys_suspend (void);
4183 extern void discard_tty_input (void);
4184 extern void init_sys_modes (struct tty_display_info
*);
4185 extern void reset_sys_modes (struct tty_display_info
*);
4186 extern void init_all_sys_modes (void);
4187 extern void reset_all_sys_modes (void);
4188 extern void child_setup_tty (int);
4189 extern void setup_pty (int);
4190 extern int set_window_size (int, int, int);
4191 extern EMACS_INT
get_random (void);
4192 extern void seed_random (void *, ptrdiff_t);
4193 extern void init_random (void);
4194 extern void emacs_backtrace (int);
4195 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4196 extern int emacs_open (const char *, int, int);
4197 extern int emacs_pipe (int[2]);
4198 extern int emacs_close (int);
4199 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4200 extern ptrdiff_t emacs_read_quit (int, void *, ptrdiff_t);
4201 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4202 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4203 extern ptrdiff_t emacs_write_quit (int, void const *, ptrdiff_t);
4204 extern void emacs_perror (char const *);
4206 extern void unlock_all_files (void);
4207 extern void lock_file (Lisp_Object
);
4208 extern void unlock_file (Lisp_Object
);
4209 extern void unlock_buffer (struct buffer
*);
4210 extern void syms_of_filelock (void);
4211 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4213 /* Defined in sound.c. */
4214 extern void syms_of_sound (void);
4216 /* Defined in category.c. */
4217 extern void init_category_once (void);
4218 extern Lisp_Object
char_category_set (int);
4219 extern void syms_of_category (void);
4221 /* Defined in ccl.c. */
4222 extern void syms_of_ccl (void);
4224 /* Defined in dired.c. */
4225 extern void syms_of_dired (void);
4226 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4227 Lisp_Object
, Lisp_Object
,
4230 /* Defined in term.c. */
4231 extern int *char_ins_del_vector
;
4232 extern void syms_of_term (void);
4233 extern _Noreturn
void fatal (const char *msgid
, ...)
4234 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4236 /* Defined in terminal.c. */
4237 extern void syms_of_terminal (void);
4239 /* Defined in font.c. */
4240 extern void syms_of_font (void);
4241 extern void init_font (void);
4243 #ifdef HAVE_WINDOW_SYSTEM
4244 /* Defined in fontset.c. */
4245 extern void syms_of_fontset (void);
4248 /* Defined in inotify.c */
4250 extern void syms_of_inotify (void);
4253 /* Defined in kqueue.c */
4255 extern void globals_of_kqueue (void);
4256 extern void syms_of_kqueue (void);
4259 /* Defined in gfilenotify.c */
4260 #ifdef HAVE_GFILENOTIFY
4261 extern void globals_of_gfilenotify (void);
4262 extern void syms_of_gfilenotify (void);
4265 #ifdef HAVE_W32NOTIFY
4266 /* Defined on w32notify.c. */
4267 extern void syms_of_w32notify (void);
4270 /* Defined in xfaces.c. */
4271 extern Lisp_Object Vface_alternative_font_family_alist
;
4272 extern Lisp_Object Vface_alternative_font_registry_alist
;
4273 extern void syms_of_xfaces (void);
4275 #ifdef HAVE_X_WINDOWS
4276 /* Defined in xfns.c. */
4277 extern void syms_of_xfns (void);
4279 /* Defined in xsmfns.c. */
4280 extern void syms_of_xsmfns (void);
4282 /* Defined in xselect.c. */
4283 extern void syms_of_xselect (void);
4285 /* Defined in xterm.c. */
4286 extern void init_xterm (void);
4287 extern void syms_of_xterm (void);
4288 #endif /* HAVE_X_WINDOWS */
4290 #ifdef HAVE_WINDOW_SYSTEM
4291 /* Defined in xterm.c, nsterm.m, w32term.c. */
4292 extern char *x_get_keysym_name (int);
4293 #endif /* HAVE_WINDOW_SYSTEM */
4296 /* Defined in xml.c. */
4297 extern void syms_of_xml (void);
4298 extern void xml_cleanup_parser (void);
4302 /* Defined in decompress.c. */
4303 extern void syms_of_decompress (void);
4307 /* Defined in dbusbind.c. */
4308 void init_dbusbind (void);
4309 void syms_of_dbusbind (void);
4313 /* Defined in profiler.c. */
4314 extern bool profiler_memory_running
;
4315 extern void malloc_probe (size_t);
4316 extern void syms_of_profiler (void);
4320 /* Defined in msdos.c, w32.c. */
4321 extern char *emacs_root_dir (void);
4324 /* Defined in lastfile.c. */
4325 extern char my_edata
[];
4326 extern char my_endbss
[];
4327 extern char *my_endbss_static
;
4329 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4330 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4331 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4332 extern void xfree (void *);
4333 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4334 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4335 ATTRIBUTE_ALLOC_SIZE ((2,3));
4336 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4338 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4339 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4340 extern void dupstring (char **, char const *);
4342 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4343 null byte. This is like stpcpy, except the source is a Lisp string. */
4346 lispstpcpy (char *dest
, Lisp_Object string
)
4348 ptrdiff_t len
= SBYTES (string
);
4349 memcpy (dest
, SDATA (string
), len
+ 1);
4353 extern void xputenv (const char *);
4355 extern char *egetenv_internal (const char *, ptrdiff_t);
4358 egetenv (const char *var
)
4360 /* When VAR is a string literal, strlen can be optimized away. */
4361 return egetenv_internal (var
, strlen (var
));
4364 /* Set up the name of the machine we're running on. */
4365 extern void init_system_name (void);
4367 /* Return the absolute value of X. X should be a signed integer
4368 expression without side effects, and X's absolute value should not
4369 exceed the maximum for its promoted type. This is called 'eabs'
4370 because 'abs' is reserved by the C standard. */
4371 #define eabs(x) ((x) < 0 ? -(x) : (x))
4373 /* Return a fixnum or float, depending on whether the integer VAL fits
4374 in a Lisp fixnum. */
4376 #define make_fixnum_or_float(val) \
4377 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4379 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4380 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4382 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4384 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4386 #define USE_SAFE_ALLOCA \
4387 ptrdiff_t sa_avail = MAX_ALLOCA; \
4388 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4390 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4392 /* SAFE_ALLOCA allocates a simple buffer. */
4394 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4395 ? AVAIL_ALLOCA (size) \
4396 : (sa_must_free = true, record_xmalloc (size)))
4398 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4399 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4400 positive. The code is tuned for MULTIPLIER being a constant. */
4402 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4404 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4405 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4408 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4409 sa_must_free = true; \
4410 record_unwind_protect_ptr (xfree, buf); \
4414 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4416 #define SAFE_ALLOCA_STRING(ptr, string) \
4418 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4419 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4422 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4424 #define SAFE_FREE() \
4426 if (sa_must_free) { \
4427 sa_must_free = false; \
4428 unbind_to (sa_count, Qnil); \
4432 /* Set BUF to point to an allocated array of NELT Lisp_Objects,
4433 immediately followed by EXTRA spare bytes. */
4435 #define SAFE_ALLOCA_LISP_EXTRA(buf, nelt, extra) \
4437 ptrdiff_t alloca_nbytes; \
4438 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4439 || INT_ADD_WRAPV (alloca_nbytes, extra, &alloca_nbytes) \
4440 || SIZE_MAX < alloca_nbytes) \
4441 memory_full (SIZE_MAX); \
4442 else if (alloca_nbytes <= sa_avail) \
4443 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4447 (buf) = xmalloc (alloca_nbytes); \
4448 arg_ = make_save_memory (buf, nelt); \
4449 sa_must_free = true; \
4450 record_unwind_protect (free_save_value, arg_); \
4454 /* Set BUF to point to an allocated array of NELT Lisp_Objects. */
4456 #define SAFE_ALLOCA_LISP(buf, nelt) SAFE_ALLOCA_LISP_EXTRA (buf, nelt, 0)
4459 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4460 block-scoped conses and strings. These objects are not
4461 managed by the garbage collector, so they are dangerous: passing them
4462 out of their scope (e.g., to user code) results in undefined behavior.
4463 Conversely, they have better performance because GC is not involved.
4465 This feature is experimental and requires careful debugging.
4466 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4468 #if (!defined USE_STACK_LISP_OBJECTS \
4469 && defined __GNUC__ && !defined __clang__ && ! GNUC_PREREQ (4, 3, 2))
4470 /* Work around GCC bugs 36584 and 35271, which were fixed in GCC 4.3.2. */
4471 # define USE_STACK_LISP_OBJECTS false
4473 #ifndef USE_STACK_LISP_OBJECTS
4474 # define USE_STACK_LISP_OBJECTS true
4477 #ifdef GC_CHECK_STRING_BYTES
4478 enum { defined_GC_CHECK_STRING_BYTES
= true };
4480 enum { defined_GC_CHECK_STRING_BYTES
= false };
4483 /* Struct inside unions that are typically no larger and aligned enough. */
4488 double d
; intmax_t i
; void *p
;
4491 union Aligned_String
4493 struct Lisp_String s
;
4494 double d
; intmax_t i
; void *p
;
4497 /* True for stack-based cons and string implementations, respectively.
4498 Use stack-based strings only if stack-based cons also works.
4499 Otherwise, STACK_CONS would create heap-based cons cells that
4500 could point to stack-based strings, which is a no-no. */
4504 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4505 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4506 USE_STACK_STRING
= (USE_STACK_CONS
4507 && !defined_GC_CHECK_STRING_BYTES
4508 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4511 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4512 use these only in macros like AUTO_CONS that declare a local
4513 variable whose lifetime will be clear to the programmer. */
4514 #define STACK_CONS(a, b) \
4515 make_lisp_ptr (&((union Aligned_Cons) { { a, { b } } }).s, Lisp_Cons)
4516 #define AUTO_CONS_EXPR(a, b) \
4517 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4519 /* Declare NAME as an auto Lisp cons or short list if possible, a
4520 GC-based one otherwise. This is in the sense of the C keyword
4521 'auto'; i.e., the object has the lifetime of the containing block.
4522 The resulting object should not be made visible to user Lisp code. */
4524 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4525 #define AUTO_LIST1(name, a) \
4526 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4527 #define AUTO_LIST2(name, a, b) \
4528 Lisp_Object name = (USE_STACK_CONS \
4529 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4531 #define AUTO_LIST3(name, a, b, c) \
4532 Lisp_Object name = (USE_STACK_CONS \
4533 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4535 #define AUTO_LIST4(name, a, b, c, d) \
4538 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4539 STACK_CONS (d, Qnil)))) \
4540 : list4 (a, b, c, d))
4542 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4543 Take its unibyte value from the null-terminated string STR,
4544 an expression that should not have side effects.
4545 STR's value is not necessarily copied. The resulting Lisp string
4546 should not be modified or made visible to user code. */
4548 #define AUTO_STRING(name, str) \
4549 AUTO_STRING_WITH_LEN (name, str, strlen (str))
4551 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4552 Take its unibyte value from the null-terminated string STR with length LEN.
4553 STR may have side effects and may contain null bytes.
4554 STR's value is not necessarily copied. The resulting Lisp string
4555 should not be modified or made visible to user code. */
4557 #define AUTO_STRING_WITH_LEN(name, str, len) \
4558 Lisp_Object name = \
4561 ((&((union Aligned_String) {{len, -1, 0, (unsigned char *) (str)}}).s), \
4563 : make_unibyte_string (str, len))
4565 /* Loop over conses of the list TAIL, signaling if a cycle is found,
4566 and possibly quitting after each loop iteration. In the loop body,
4567 set TAIL to the current cons. If the loop exits normally,
4568 set TAIL to the terminating non-cons, typically nil. The loop body
4569 should not modify the list’s top level structure other than by
4570 perhaps deleting the current cons. */
4572 #define FOR_EACH_TAIL(tail) \
4573 FOR_EACH_TAIL_INTERNAL (tail, circular_list (tail), true)
4575 /* Like FOR_EACH_TAIL (LIST), except do not signal or quit.
4576 If the loop exits due to a cycle, TAIL’s value is undefined. */
4578 #define FOR_EACH_TAIL_SAFE(tail) \
4579 FOR_EACH_TAIL_INTERNAL (tail, (void) ((tail) = Qnil), false)
4581 /* Iterator intended for use only within FOR_EACH_TAIL_INTERNAL. */
4582 struct for_each_tail_internal
4584 Lisp_Object tortoise
;
4586 unsigned short int q
;
4589 /* Like FOR_EACH_TAIL (LIST), except evaluate CYCLE if a cycle is
4590 found, and check for quit if CHECK_QUIT. This is an internal macro
4591 intended for use only by the above macros.
4593 Use Brent’s teleporting tortoise-hare algorithm. See:
4594 Brent RP. BIT. 1980;20(2):176-84. doi:10.1007/BF01933190
4595 http://maths-people.anu.edu.au/~brent/pd/rpb051i.pdf
4597 This macro uses maybe_quit because of an excess of caution. The
4598 call to maybe_quit should not be needed in practice, as a very long
4599 list, whether circular or not, will cause Emacs to be so slow in
4600 other uninterruptible areas (e.g., garbage collection) that there
4601 is little point to calling maybe_quit here. */
4603 #define FOR_EACH_TAIL_INTERNAL(tail, cycle, check_quit) \
4604 for (struct for_each_tail_internal li = { tail, 2, 0, 2 }; \
4606 ((tail) = XCDR (tail), \
4608 || ((check_quit) ? maybe_quit () : (void) 0, 0 < --li.n) \
4609 || (li.q = li.n = li.max <<= 1, li.n >>= USHRT_WIDTH, \
4610 li.tortoise = (tail), false)) \
4611 && EQ (tail, li.tortoise)) \
4612 ? (cycle) : (void) 0))
4614 /* Do a `for' loop over alist values. */
4616 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4617 for ((list_var) = (head_var); \
4618 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4619 (list_var) = XCDR (list_var))
4621 /* Check whether it's time for GC, and run it if so. */
4626 if ((consing_since_gc
> gc_cons_threshold
4627 && consing_since_gc
> gc_relative_threshold
)
4628 || (!NILP (Vmemory_full
)
4629 && consing_since_gc
> memory_full_cons_threshold
))
4630 Fgarbage_collect ();
4635 #endif /* EMACS_LISP_H */