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
};
84 # define EMACS_INT_MAX INT_MAX
86 # elif INTPTR_MAX <= LONG_MAX && !defined WIDE_EMACS_INT
87 typedef long int EMACS_INT
;
88 typedef unsigned long EMACS_UINT
;
89 enum { EMACS_INT_WIDTH
= LONG_WIDTH
};
90 # define EMACS_INT_MAX LONG_MAX
92 # elif INTPTR_MAX <= LLONG_MAX
93 typedef long long int EMACS_INT
;
94 typedef unsigned long long int EMACS_UINT
;
95 enum { EMACS_INT_WIDTH
= LLONG_WIDTH
};
96 # define EMACS_INT_MAX LLONG_MAX
103 # error "INTPTR_MAX too large"
107 /* Number of bits to put in each character in the internal representation
108 of bool vectors. This should not vary across implementations. */
109 enum { BOOL_VECTOR_BITS_PER_CHAR
=
110 #define BOOL_VECTOR_BITS_PER_CHAR 8
111 BOOL_VECTOR_BITS_PER_CHAR
114 /* An unsigned integer type representing a fixed-length bit sequence,
115 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
116 for speed, but on weird platforms it is unsigned char and not all
117 its bits are used. */
118 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
119 typedef size_t bits_word
;
120 # define BITS_WORD_MAX SIZE_MAX
121 enum { BITS_PER_BITS_WORD
= SIZE_WIDTH
};
123 typedef unsigned char bits_word
;
124 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
125 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
127 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
129 /* printmax_t and uprintmax_t are types for printing large integers.
130 These are the widest integers that are supported for printing.
131 pMd etc. are conversions for printing them.
132 On C99 hosts, there's no problem, as even the widest integers work.
133 Fall back on EMACS_INT on pre-C99 hosts. */
135 typedef intmax_t printmax_t
;
136 typedef uintmax_t uprintmax_t
;
140 typedef EMACS_INT printmax_t
;
141 typedef EMACS_UINT uprintmax_t
;
146 /* Use pD to format ptrdiff_t values, which suffice for indexes into
147 buffers and strings. Emacs never allocates objects larger than
148 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
149 In C99, pD can always be "t"; configure it here for the sake of
150 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
151 #if PTRDIFF_MAX == INT_MAX
153 #elif PTRDIFF_MAX == LONG_MAX
155 #elif PTRDIFF_MAX == LLONG_MAX
161 /* Extra internal type checking? */
163 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
164 'assume (COND)'. COND should be free of side effects, as it may or
165 may not be evaluated.
167 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
168 defined and suppress_checking is false, and does nothing otherwise.
169 Emacs dies if COND is checked and is false. The suppress_checking
170 variable is initialized to 0 in alloc.c. Set it to 1 using a
171 debugger to temporarily disable aborting on detected internal
172 inconsistencies or error conditions.
174 In some cases, a good compiler may be able to optimize away the
175 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
176 uses eassert to test STRINGP (x), but a particular use of XSTRING
177 is invoked only after testing that STRINGP (x) is true, making the
180 eassume is like eassert except that it also causes the compiler to
181 assume that COND is true afterwards, regardless of whether runtime
182 checking is enabled. This can improve performance in some cases,
183 though it can degrade performance in others. It's often suboptimal
184 for COND to call external functions or access volatile storage. */
186 #ifndef ENABLE_CHECKING
187 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
188 # define eassume(cond) assume (cond)
189 #else /* ENABLE_CHECKING */
191 extern _Noreturn
void die (const char *, const char *, int);
193 extern bool suppress_checking EXTERNALLY_VISIBLE
;
195 # define eassert(cond) \
196 (suppress_checking || (cond) \
198 : die (# cond, __FILE__, __LINE__))
199 # define eassume(cond) \
204 : die (# cond, __FILE__, __LINE__))
205 #endif /* ENABLE_CHECKING */
208 /* Use the configure flag --enable-check-lisp-object-type to make
209 Lisp_Object use a struct type instead of the default int. The flag
210 causes CHECK_LISP_OBJECT_TYPE to be defined. */
212 /***** Select the tagging scheme. *****/
213 /* The following option controls the tagging scheme:
214 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
215 always 0, and we can thus use them to hold tag bits, without
216 restricting our addressing space.
218 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
219 restricting our possible address range.
221 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
222 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
223 on the few static Lisp_Objects used: lispsym, all the defsubr, and
224 the two special buffers buffer_defaults and buffer_local_symbols. */
228 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
229 integer constant, for MSVC. */
230 #define GCALIGNMENT 8
232 /* Number of bits in a Lisp_Object value, not counting the tag. */
233 VALBITS
= EMACS_INT_WIDTH
- GCTYPEBITS
,
235 /* Number of bits in a Lisp fixnum tag. */
236 INTTYPEBITS
= GCTYPEBITS
- 1,
238 /* Number of bits in a Lisp fixnum value, not counting the tag. */
239 FIXNUM_BITS
= VALBITS
+ 1
242 #if GCALIGNMENT != 1 << GCTYPEBITS
243 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
246 /* The maximum value that can be stored in a EMACS_INT, assuming all
247 bits other than the type bits contribute to a nonnegative signed value.
248 This can be used in #if, e.g., '#if USE_LSB_TAG' below expands to an
249 expression involving VAL_MAX. */
250 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
252 /* Whether the least-significant bits of an EMACS_INT contain the tag.
253 On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
254 a. unnecessary, because the top bits of an EMACS_INT are unused, and
255 b. slower, because it typically requires extra masking.
256 So, USE_LSB_TAG is true only on hosts where it might be useful. */
257 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
258 #define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
259 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
261 /* 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 extern bool generating_ldefs_boot
;
585 /* Defined in floatfns.c. */
586 extern double extract_float (Lisp_Object
);
589 /* Low-level conversion and type checking. */
591 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
592 At the machine level, these operations are no-ops. */
595 (XLI
) (Lisp_Object o
)
597 return lisp_h_XLI (o
);
603 return lisp_h_XIL (i
);
606 /* Extract A's type. */
608 INLINE
enum Lisp_Type
609 (XTYPE
) (Lisp_Object a
)
612 return lisp_h_XTYPE (a
);
614 EMACS_UINT i
= XLI (a
);
615 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
620 (CHECK_TYPE
) (int ok
, Lisp_Object predicate
, Lisp_Object x
)
622 lisp_h_CHECK_TYPE (ok
, predicate
, x
);
625 /* Extract A's pointer value, assuming A's type is TYPE. */
628 (XUNTAG
) (Lisp_Object a
, int type
)
631 return lisp_h_XUNTAG (a
, type
);
633 intptr_t i
= USE_LSB_TAG
? XLI (a
) - type
: XLI (a
) & VALMASK
;
639 /* Interned state of a symbol. */
643 SYMBOL_UNINTERNED
= 0,
645 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
652 SYMBOL_LOCALIZED
= 2,
656 enum symbol_trapped_write
658 SYMBOL_UNTRAPPED_WRITE
= 0,
660 SYMBOL_TRAPPED_WRITE
= 2
665 bool_bf gcmarkbit
: 1;
667 /* Indicates where the value can be found:
668 0 : it's a plain var, the value is in the `value' field.
669 1 : it's a varalias, the value is really in the `alias' symbol.
670 2 : it's a localized var, the value is in the `blv' object.
671 3 : it's a forwarding variable, the value is in `forward'. */
672 ENUM_BF (symbol_redirect
) redirect
: 3;
674 /* 0 : normal case, just set the value
675 1 : constant, cannot set, e.g. nil, t, :keywords.
676 2 : trap the write, call watcher functions. */
677 ENUM_BF (symbol_trapped_write
) trapped_write
: 2;
679 /* Interned state of the symbol. This is an enumerator from
680 enum symbol_interned. */
681 unsigned interned
: 2;
683 /* True means that this variable has been explicitly declared
684 special (with `defvar' etc), and shouldn't be lexically bound. */
685 bool_bf declared_special
: 1;
687 /* True if pointed to from purespace and hence can't be GC'd. */
690 /* The symbol's name, as a Lisp string. */
693 /* Value of the symbol or Qunbound if unbound. Which alternative of the
694 union is used depends on the `redirect' field above. */
697 struct Lisp_Symbol
*alias
;
698 struct Lisp_Buffer_Local_Value
*blv
;
702 /* Function value of the symbol or Qnil if not fboundp. */
703 Lisp_Object function
;
705 /* The symbol's property list. */
708 /* Next symbol in obarray bucket, if the symbol is interned. */
709 struct Lisp_Symbol
*next
;
712 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
713 meaning as in the DEFUN macro, and is used to construct a prototype. */
714 /* We can use the same trick as in the DEFUN macro to generate the
715 appropriate prototype. */
716 #define EXFUN(fnname, maxargs) \
717 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
719 /* Note that the weird token-substitution semantics of ANSI C makes
720 this work for MANY and UNEVALLED. */
721 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
722 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
723 #define DEFUN_ARGS_0 (void)
724 #define DEFUN_ARGS_1 (Lisp_Object)
725 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
726 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
727 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
728 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
730 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
731 Lisp_Object, Lisp_Object)
732 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
733 Lisp_Object, Lisp_Object, Lisp_Object)
734 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
735 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
737 /* Yield a signed integer that contains TAG along with PTR.
739 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
740 and zero-extend otherwise (that’s a bit faster here).
741 Sign extension matters only when EMACS_INT is wider than a pointer. */
742 #define TAG_PTR(tag, ptr) \
744 ? (intptr_t) (ptr) + (tag) \
745 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
747 /* Yield an integer that contains a symbol tag along with OFFSET.
748 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
749 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
751 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
752 XLI (builtin_lisp_symbol (Qwhatever)),
753 except the former expands to an integer constant expression. */
754 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
756 /* LISPSYM_INITIALLY (Qfoo) is equivalent to Qfoo except it is
757 designed for use as an initializer, even for a constant initializer. */
758 #define LISPSYM_INITIALLY(name) LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name))
760 /* Declare extern constants for Lisp symbols. These can be helpful
761 when using a debugger like GDB, on older platforms where the debug
762 format does not represent C macros. */
763 #define DEFINE_LISP_SYMBOL(name) \
764 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
765 DEFINE_GDB_SYMBOL_END (LISPSYM_INITIALLY (name))
767 /* The index of the C-defined Lisp symbol SYM.
768 This can be used in a static initializer. */
769 #define SYMBOL_INDEX(sym) i##sym
771 /* By default, define macros for Qt, etc., as this leads to a bit
772 better performance in the core Emacs interpreter. A plugin can
773 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
774 other Emacs instances that assign different values to Qt, etc. */
775 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
776 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
781 /* Header of vector-like objects. This documents the layout constraints on
782 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
783 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
784 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
785 because when two such pointers potentially alias, a compiler won't
786 incorrectly reorder loads and stores to their size fields. See
788 struct vectorlike_header
790 /* The only field contains various pieces of information:
791 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
792 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
793 vector (0) or a pseudovector (1).
794 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
795 of slots) of the vector.
796 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
797 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
798 - b) number of Lisp_Objects slots at the beginning of the object
799 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
801 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
802 measured in word_size units. Rest fields may also include
803 Lisp_Objects, but these objects usually needs some special treatment
805 There are some exceptions. For PVEC_FREE, b) is always zero. For
806 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
807 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
808 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
813 (SYMBOLP
) (Lisp_Object x
)
815 return lisp_h_SYMBOLP (x
);
818 INLINE
struct Lisp_Symbol
*
819 (XSYMBOL
) (Lisp_Object a
)
822 return lisp_h_XSYMBOL (a
);
824 eassert (SYMBOLP (a
));
825 intptr_t i
= (intptr_t) XUNTAG (a
, Lisp_Symbol
);
826 void *p
= (char *) lispsym
+ i
;
832 make_lisp_symbol (struct Lisp_Symbol
*sym
)
834 Lisp_Object a
= XIL (TAG_SYMOFFSET ((char *) sym
- (char *) lispsym
));
835 eassert (XSYMBOL (a
) == sym
);
840 builtin_lisp_symbol (int index
)
842 return make_lisp_symbol (lispsym
+ index
);
846 (CHECK_SYMBOL
) (Lisp_Object x
)
848 lisp_h_CHECK_SYMBOL (x
);
851 /* In the size word of a vector, this bit means the vector has been marked. */
853 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
854 # define ARRAY_MARK_FLAG PTRDIFF_MIN
855 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
857 /* In the size word of a struct Lisp_Vector, this bit means it's really
858 some other vector-like object. */
859 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
860 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
861 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
863 /* In a pseudovector, the size field actually contains a word with one
864 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
865 with PVEC_TYPE_MASK to indicate the actual type. */
877 PVEC_WINDOW_CONFIGURATION
,
886 /* These should be last, check internal_equal to see why. */
890 PVEC_FONT
/* Should be last because it's used for range checking. */
895 /* For convenience, we also store the number of elements in these bits.
896 Note that this size is not necessarily the memory-footprint size, but
897 only the number of Lisp_Object fields (that need to be traced by GC).
898 The distinction is used, e.g., by Lisp_Process, which places extra
899 non-Lisp_Object fields at the end of the structure. */
900 PSEUDOVECTOR_SIZE_BITS
= 12,
901 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
903 /* To calculate the memory footprint of the pseudovector, it's useful
904 to store the size of non-Lisp area in word_size units here. */
905 PSEUDOVECTOR_REST_BITS
= 12,
906 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
907 << PSEUDOVECTOR_SIZE_BITS
),
909 /* Used to extract pseudovector subtype information. */
910 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
911 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
914 /* These functions extract various sorts of values from a Lisp_Object.
915 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
916 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
919 /* Largest and smallest representable fixnum values. These are the C
920 values. They are macros for use in static initializers. */
921 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
922 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
927 (make_number
) (EMACS_INT n
)
929 return lisp_h_make_number (n
);
933 (XINT
) (Lisp_Object a
)
935 return lisp_h_XINT (a
);
939 (XFASTINT
) (Lisp_Object a
)
941 EMACS_INT n
= lisp_h_XFASTINT (a
);
946 #else /* ! USE_LSB_TAG */
948 /* Although compiled only if ! USE_LSB_TAG, the following functions
949 also work when USE_LSB_TAG; this is to aid future maintenance when
950 the lisp_h_* macros are eventually removed. */
952 /* Make a Lisp integer representing the value of the low order
955 make_number (EMACS_INT n
)
957 EMACS_INT int0
= Lisp_Int0
;
961 n
= u
<< INTTYPEBITS
;
967 n
+= (int0
<< VALBITS
);
972 /* Extract A's value as a signed integer. */
976 EMACS_INT i
= XLI (a
);
980 i
= u
<< INTTYPEBITS
;
982 return i
>> INTTYPEBITS
;
985 /* Like XINT (A), but may be faster. A must be nonnegative.
986 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
987 integers have zero-bits in their tags. */
989 XFASTINT (Lisp_Object a
)
991 EMACS_INT int0
= Lisp_Int0
;
992 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
) - (int0
<< VALBITS
);
997 #endif /* ! USE_LSB_TAG */
999 /* Extract A's value as an unsigned integer. */
1001 XUINT (Lisp_Object a
)
1003 EMACS_UINT i
= XLI (a
);
1004 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
1007 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
1008 right now, but XUINT should only be applied to objects we know are
1012 (XHASH
) (Lisp_Object a
)
1014 return lisp_h_XHASH (a
);
1017 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
1019 make_natnum (EMACS_INT n
)
1021 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
1022 EMACS_INT int0
= Lisp_Int0
;
1023 return USE_LSB_TAG
? make_number (n
) : XIL (n
+ (int0
<< VALBITS
));
1026 /* Return true if X and Y are the same object. */
1029 (EQ
) (Lisp_Object x
, Lisp_Object y
)
1031 return lisp_h_EQ (x
, y
);
1034 /* Value is true if I doesn't fit into a Lisp fixnum. It is
1035 written this way so that it also works if I is of unsigned
1036 type or if I is a NaN. */
1038 #define FIXNUM_OVERFLOW_P(i) \
1039 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
1042 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
1044 return num
< lower
? lower
: num
<= upper
? num
: upper
;
1047 /* Construct a Lisp_Object from a value or address. */
1050 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
1052 Lisp_Object a
= XIL (TAG_PTR (type
, ptr
));
1053 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
1058 (INTEGERP
) (Lisp_Object x
)
1060 return lisp_h_INTEGERP (x
);
1063 #define XSETINT(a, b) ((a) = make_number (b))
1064 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1065 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1066 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1067 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1068 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1069 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1070 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1072 /* Pseudovector types. */
1074 #define XSETPVECTYPE(v, code) \
1075 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1076 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1077 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1078 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1079 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1082 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1083 #define XSETPSEUDOVECTOR(a, b, code) \
1084 XSETTYPED_PSEUDOVECTOR (a, b, \
1085 (((struct vectorlike_header *) \
1086 XUNTAG (a, Lisp_Vectorlike)) \
1089 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1090 (XSETVECTOR (a, b), \
1091 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1092 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1094 #define XSETWINDOW_CONFIGURATION(a, b) \
1095 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1096 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1097 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1098 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1099 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1100 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1101 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1102 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1103 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1104 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1105 #define XSETTHREAD(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_THREAD))
1106 #define XSETMUTEX(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_MUTEX))
1107 #define XSETCONDVAR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CONDVAR))
1109 /* Efficiently convert a pointer to a Lisp object and back. The
1110 pointer is represented as a Lisp integer, so the garbage collector
1111 does not know about it. The pointer should not have both Lisp_Int1
1112 bits set, which makes this conversion inherently unportable. */
1115 XINTPTR (Lisp_Object a
)
1117 return XUNTAG (a
, Lisp_Int0
);
1121 make_pointer_integer (void *p
)
1123 Lisp_Object a
= XIL (TAG_PTR (Lisp_Int0
, p
));
1124 eassert (INTEGERP (a
) && XINTPTR (a
) == p
);
1128 /* See the macros in intervals.h. */
1130 typedef struct interval
*INTERVAL
;
1132 struct GCALIGNED Lisp_Cons
1134 /* Car of this cons cell. */
1139 /* Cdr of this cons cell. */
1142 /* Used to chain conses on a free list. */
1143 struct Lisp_Cons
*chain
;
1148 (NILP
) (Lisp_Object x
)
1150 return lisp_h_NILP (x
);
1154 (CONSP
) (Lisp_Object x
)
1156 return lisp_h_CONSP (x
);
1160 CHECK_CONS (Lisp_Object x
)
1162 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
1165 INLINE
struct Lisp_Cons
*
1166 (XCONS
) (Lisp_Object a
)
1168 return lisp_h_XCONS (a
);
1171 /* Take the car or cdr of something known to be a cons cell. */
1172 /* The _addr functions shouldn't be used outside of the minimal set
1173 of code that has to know what a cons cell looks like. Other code not
1174 part of the basic lisp implementation should assume that the car and cdr
1175 fields are not accessible. (What if we want to switch to
1176 a copying collector someday? Cached cons cell field addresses may be
1177 invalidated at arbitrary points.) */
1178 INLINE Lisp_Object
*
1179 xcar_addr (Lisp_Object c
)
1181 return &XCONS (c
)->car
;
1183 INLINE Lisp_Object
*
1184 xcdr_addr (Lisp_Object c
)
1186 return &XCONS (c
)->u
.cdr
;
1189 /* Use these from normal code. */
1192 (XCAR
) (Lisp_Object c
)
1194 return lisp_h_XCAR (c
);
1198 (XCDR
) (Lisp_Object c
)
1200 return lisp_h_XCDR (c
);
1203 /* Use these to set the fields of a cons cell.
1205 Note that both arguments may refer to the same object, so 'n'
1206 should not be read after 'c' is first modified. */
1208 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1213 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1218 /* Take the car or cdr of something whose type is not known. */
1225 wrong_type_argument (Qlistp
, c
);
1234 wrong_type_argument (Qlistp
, c
);
1238 /* Take the car or cdr of something whose type is not known. */
1240 CAR_SAFE (Lisp_Object c
)
1242 return CONSP (c
) ? XCAR (c
) : Qnil
;
1245 CDR_SAFE (Lisp_Object c
)
1247 return CONSP (c
) ? XCDR (c
) : Qnil
;
1250 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1252 struct GCALIGNED Lisp_String
1255 ptrdiff_t size_byte
;
1256 INTERVAL intervals
; /* Text properties in this string. */
1257 unsigned char *data
;
1261 STRINGP (Lisp_Object x
)
1263 return XTYPE (x
) == Lisp_String
;
1267 CHECK_STRING (Lisp_Object x
)
1269 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
1272 INLINE
struct Lisp_String
*
1273 XSTRING (Lisp_Object a
)
1275 eassert (STRINGP (a
));
1276 return XUNTAG (a
, Lisp_String
);
1279 /* True if STR is a multibyte string. */
1281 STRING_MULTIBYTE (Lisp_Object str
)
1283 return 0 <= XSTRING (str
)->size_byte
;
1286 /* An upper bound on the number of bytes in a Lisp string, not
1287 counting the terminating null. This a tight enough bound to
1288 prevent integer overflow errors that would otherwise occur during
1289 string size calculations. A string cannot contain more bytes than
1290 a fixnum can represent, nor can it be so long that C pointer
1291 arithmetic stops working on the string plus its terminating null.
1292 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1293 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1294 would expose alloc.c internal details that we'd rather keep
1297 This is a macro for use in static initializers. The cast to
1298 ptrdiff_t ensures that the macro is signed. */
1299 #define STRING_BYTES_BOUND \
1300 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1302 /* Mark STR as a unibyte string. */
1303 #define STRING_SET_UNIBYTE(STR) \
1305 if (XSTRING (STR)->size == 0) \
1306 (STR) = empty_unibyte_string; \
1308 XSTRING (STR)->size_byte = -1; \
1311 /* Mark STR as a multibyte string. Assure that STR contains only
1312 ASCII characters in advance. */
1313 #define STRING_SET_MULTIBYTE(STR) \
1315 if (XSTRING (STR)->size == 0) \
1316 (STR) = empty_multibyte_string; \
1318 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1321 /* Convenience functions for dealing with Lisp strings. */
1323 INLINE
unsigned char *
1324 SDATA (Lisp_Object string
)
1326 return XSTRING (string
)->data
;
1329 SSDATA (Lisp_Object string
)
1331 /* Avoid "differ in sign" warnings. */
1332 return (char *) SDATA (string
);
1334 INLINE
unsigned char
1335 SREF (Lisp_Object string
, ptrdiff_t index
)
1337 return SDATA (string
)[index
];
1340 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1342 SDATA (string
)[index
] = new;
1345 SCHARS (Lisp_Object string
)
1347 return XSTRING (string
)->size
;
1350 #ifdef GC_CHECK_STRING_BYTES
1351 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1354 STRING_BYTES (struct Lisp_String
*s
)
1356 #ifdef GC_CHECK_STRING_BYTES
1357 return string_bytes (s
);
1359 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1364 SBYTES (Lisp_Object string
)
1366 return STRING_BYTES (XSTRING (string
));
1369 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1371 XSTRING (string
)->size
= newsize
;
1374 /* A regular vector is just a header plus an array of Lisp_Objects. */
1378 struct vectorlike_header header
;
1379 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1383 (VECTORLIKEP
) (Lisp_Object x
)
1385 return lisp_h_VECTORLIKEP (x
);
1388 INLINE
struct Lisp_Vector
*
1389 XVECTOR (Lisp_Object a
)
1391 eassert (VECTORLIKEP (a
));
1392 return XUNTAG (a
, Lisp_Vectorlike
);
1396 ASIZE (Lisp_Object array
)
1398 ptrdiff_t size
= XVECTOR (array
)->header
.size
;
1399 eassume (0 <= size
);
1404 VECTORP (Lisp_Object x
)
1406 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
1410 CHECK_VECTOR (Lisp_Object x
)
1412 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
1415 /* A pseudovector is like a vector, but has other non-Lisp components. */
1418 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
1420 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
1421 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
1424 /* True if A is a pseudovector whose code is CODE. */
1426 PSEUDOVECTORP (Lisp_Object a
, int code
)
1428 if (! VECTORLIKEP (a
))
1432 /* Converting to struct vectorlike_header * avoids aliasing issues. */
1433 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
1434 return PSEUDOVECTOR_TYPEP (h
, code
);
1438 /* A boolvector is a kind of vectorlike, with contents like a string. */
1440 struct Lisp_Bool_Vector
1442 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1443 just the subtype information. */
1444 struct vectorlike_header header
;
1445 /* This is the size in bits. */
1447 /* The actual bits, packed into bytes.
1448 Zeros fill out the last word if needed.
1449 The bits are in little-endian order in the bytes, and
1450 the bytes are in little-endian order in the words. */
1451 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1454 /* Some handy constants for calculating sizes
1455 and offsets, mostly of vectorlike objects. */
1459 header_size
= offsetof (struct Lisp_Vector
, contents
),
1460 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1461 word_size
= sizeof (Lisp_Object
)
1464 /* The number of data words and bytes in a bool vector with SIZE bits. */
1467 bool_vector_words (EMACS_INT size
)
1469 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1470 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1474 bool_vector_bytes (EMACS_INT size
)
1476 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1477 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1481 BOOL_VECTOR_P (Lisp_Object a
)
1483 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
1487 CHECK_BOOL_VECTOR (Lisp_Object x
)
1489 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
1492 INLINE
struct Lisp_Bool_Vector
*
1493 XBOOL_VECTOR (Lisp_Object a
)
1495 eassert (BOOL_VECTOR_P (a
));
1496 return XUNTAG (a
, Lisp_Vectorlike
);
1500 bool_vector_size (Lisp_Object a
)
1502 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1503 eassume (0 <= size
);
1508 bool_vector_data (Lisp_Object a
)
1510 return XBOOL_VECTOR (a
)->data
;
1513 INLINE
unsigned char *
1514 bool_vector_uchar_data (Lisp_Object a
)
1516 return (unsigned char *) bool_vector_data (a
);
1519 /* True if A's Ith bit is set. */
1522 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1524 eassume (0 <= i
&& i
< bool_vector_size (a
));
1525 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1526 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1530 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1532 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1535 /* Set A's Ith bit to B. */
1538 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1540 unsigned char *addr
;
1542 eassume (0 <= i
&& i
< bool_vector_size (a
));
1543 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1546 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1548 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1551 /* Conveniences for dealing with Lisp arrays. */
1554 AREF (Lisp_Object array
, ptrdiff_t idx
)
1556 return XVECTOR (array
)->contents
[idx
];
1559 INLINE Lisp_Object
*
1560 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1562 return & XVECTOR (array
)->contents
[idx
];
1566 gc_asize (Lisp_Object array
)
1568 /* Like ASIZE, but also can be used in the garbage collector. */
1569 return XVECTOR (array
)->header
.size
& ~ARRAY_MARK_FLAG
;
1573 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1575 eassert (0 <= idx
&& idx
< ASIZE (array
));
1576 XVECTOR (array
)->contents
[idx
] = val
;
1580 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1582 /* Like ASET, but also can be used in the garbage collector:
1583 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1584 eassert (0 <= idx
&& idx
< gc_asize (array
));
1585 XVECTOR (array
)->contents
[idx
] = val
;
1588 /* True, since Qnil's representation is zero. Every place in the code
1589 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1590 to find such assumptions later if we change Qnil to be nonzero. */
1591 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1593 /* Clear the object addressed by P, with size NBYTES, so that all its
1594 bytes are zero and all its Lisp values are nil. */
1596 memclear (void *p
, ptrdiff_t nbytes
)
1598 eassert (0 <= nbytes
);
1599 verify (NIL_IS_ZERO
);
1600 /* Since Qnil is zero, memset suffices. */
1601 memset (p
, 0, nbytes
);
1604 /* If a struct is made to look like a vector, this macro returns the length
1605 of the shortest vector that would hold that struct. */
1607 #define VECSIZE(type) \
1608 ((sizeof (type) - header_size + word_size - 1) / word_size)
1610 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1611 at the end and we need to compute the number of Lisp_Object fields (the
1612 ones that the GC needs to trace). */
1614 #define PSEUDOVECSIZE(type, nonlispfield) \
1615 ((offsetof (type, nonlispfield) - header_size) / word_size)
1617 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1618 should be integer expressions. This is not the same as
1619 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1620 returns true. For efficiency, prefer plain unsigned comparison if A
1621 and B's sizes both fit (after integer promotion). */
1622 #define UNSIGNED_CMP(a, op, b) \
1623 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1624 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1625 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1627 /* True iff C is an ASCII character. */
1628 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1630 /* A char-table is a kind of vectorlike, with contents are like a
1631 vector but with a few other slots. For some purposes, it makes
1632 sense to handle a char-table with type struct Lisp_Vector. An
1633 element of a char table can be any Lisp objects, but if it is a sub
1634 char-table, we treat it a table that contains information of a
1635 specific range of characters. A sub char-table is like a vector but
1636 with two integer fields between the header and Lisp data, which means
1637 that it has to be marked with some precautions (see mark_char_table
1638 in alloc.c). A sub char-table appears only in an element of a char-table,
1639 and there's no way to access it directly from Emacs Lisp program. */
1641 enum CHARTAB_SIZE_BITS
1643 CHARTAB_SIZE_BITS_0
= 6,
1644 CHARTAB_SIZE_BITS_1
= 4,
1645 CHARTAB_SIZE_BITS_2
= 5,
1646 CHARTAB_SIZE_BITS_3
= 7
1649 extern const int chartab_size
[4];
1651 struct Lisp_Char_Table
1653 /* HEADER.SIZE is the vector's size field, which also holds the
1654 pseudovector type information. It holds the size, too.
1655 The size counts the defalt, parent, purpose, ascii,
1656 contents, and extras slots. */
1657 struct vectorlike_header header
;
1659 /* This holds a default value,
1660 which is used whenever the value for a specific character is nil. */
1663 /* This points to another char table, which we inherit from when the
1664 value for a specific character is nil. The `defalt' slot takes
1665 precedence over this. */
1668 /* This is a symbol which says what kind of use this char-table is
1670 Lisp_Object purpose
;
1672 /* The bottom sub char-table for characters of the range 0..127. It
1673 is nil if none of ASCII character has a specific value. */
1676 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1678 /* These hold additional data. It is a vector. */
1679 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1683 CHAR_TABLE_P (Lisp_Object a
)
1685 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
1688 INLINE
struct Lisp_Char_Table
*
1689 XCHAR_TABLE (Lisp_Object a
)
1691 eassert (CHAR_TABLE_P (a
));
1692 return XUNTAG (a
, Lisp_Vectorlike
);
1695 struct Lisp_Sub_Char_Table
1697 /* HEADER.SIZE is the vector's size field, which also holds the
1698 pseudovector type information. It holds the size, too. */
1699 struct vectorlike_header header
;
1701 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1702 char-table of depth 1 contains 16 elements, and each element
1703 covers 4096 (128*32) characters. A sub char-table of depth 2
1704 contains 32 elements, and each element covers 128 characters. A
1705 sub char-table of depth 3 contains 128 elements, and each element
1706 is for one character. */
1709 /* Minimum character covered by the sub char-table. */
1712 /* Use set_sub_char_table_contents to set this. */
1713 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1717 SUB_CHAR_TABLE_P (Lisp_Object a
)
1719 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
1722 INLINE
struct Lisp_Sub_Char_Table
*
1723 XSUB_CHAR_TABLE (Lisp_Object a
)
1725 eassert (SUB_CHAR_TABLE_P (a
));
1726 return XUNTAG (a
, Lisp_Vectorlike
);
1730 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1732 struct Lisp_Char_Table
*tbl
= NULL
;
1736 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1737 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1738 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1742 while (NILP (val
) && ! NILP (tbl
->parent
));
1747 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1748 characters. Do not check validity of CT. */
1750 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1752 return (ASCII_CHAR_P (idx
)
1753 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1754 : char_table_ref (ct
, idx
));
1757 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1758 8-bit European characters. Do not check validity of CT. */
1760 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1762 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1763 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1765 char_table_set (ct
, idx
, val
);
1768 /* This structure describes a built-in function.
1769 It is generated by the DEFUN macro only.
1770 defsubr makes it into a Lisp object. */
1774 struct vectorlike_header header
;
1776 Lisp_Object (*a0
) (void);
1777 Lisp_Object (*a1
) (Lisp_Object
);
1778 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1779 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1780 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1781 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1782 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1783 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1784 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1785 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1786 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1788 short min_args
, max_args
;
1789 const char *symbol_name
;
1790 const char *intspec
;
1795 SUBRP (Lisp_Object a
)
1797 return PSEUDOVECTORP (a
, PVEC_SUBR
);
1800 INLINE
struct Lisp_Subr
*
1801 XSUBR (Lisp_Object a
)
1803 eassert (SUBRP (a
));
1804 return XUNTAG (a
, Lisp_Vectorlike
);
1807 enum char_table_specials
1809 /* This is the number of slots that every char table must have. This
1810 counts the ordinary slots and the top, defalt, parent, and purpose
1812 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1814 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1815 when the latter is treated as an ordinary Lisp_Vector. */
1816 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1819 /* Return the number of "extra" slots in the char table CT. */
1822 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1824 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1825 - CHAR_TABLE_STANDARD_SLOTS
);
1828 /* Make sure that sub char-table contents slot is where we think it is. */
1829 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1830 == (offsetof (struct Lisp_Vector
, contents
)
1831 + SUB_CHAR_TABLE_OFFSET
* sizeof (Lisp_Object
)));
1835 /***********************************************************************
1837 ***********************************************************************/
1839 /* Value is name of symbol. */
1842 (SYMBOL_VAL
) (struct Lisp_Symbol
*sym
)
1844 return lisp_h_SYMBOL_VAL (sym
);
1847 INLINE
struct Lisp_Symbol
*
1848 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1850 eassume (sym
->redirect
== SYMBOL_VARALIAS
&& sym
->val
.alias
);
1851 return sym
->val
.alias
;
1853 INLINE
struct Lisp_Buffer_Local_Value
*
1854 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1856 eassume (sym
->redirect
== SYMBOL_LOCALIZED
&& sym
->val
.blv
);
1857 return sym
->val
.blv
;
1859 INLINE
union Lisp_Fwd
*
1860 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1862 eassume (sym
->redirect
== SYMBOL_FORWARDED
&& sym
->val
.fwd
);
1863 return sym
->val
.fwd
;
1867 (SET_SYMBOL_VAL
) (struct Lisp_Symbol
*sym
, Lisp_Object v
)
1869 lisp_h_SET_SYMBOL_VAL (sym
, v
);
1873 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1875 eassume (sym
->redirect
== SYMBOL_VARALIAS
&& v
);
1879 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1881 eassume (sym
->redirect
== SYMBOL_LOCALIZED
&& v
);
1885 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1887 eassume (sym
->redirect
== SYMBOL_FORWARDED
&& v
);
1892 SYMBOL_NAME (Lisp_Object sym
)
1894 return XSYMBOL (sym
)->name
;
1897 /* Value is true if SYM is an interned symbol. */
1900 SYMBOL_INTERNED_P (Lisp_Object sym
)
1902 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1905 /* Value is true if SYM is interned in initial_obarray. */
1908 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1910 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1913 /* Value is non-zero if symbol cannot be changed through a simple set,
1914 i.e. it's a constant (e.g. nil, t, :keywords), or it has some
1915 watching functions. */
1918 (SYMBOL_TRAPPED_WRITE_P
) (Lisp_Object sym
)
1920 return lisp_h_SYMBOL_TRAPPED_WRITE_P (sym
);
1923 /* Value is non-zero if symbol cannot be changed at all, i.e. it's a
1924 constant (e.g. nil, t, :keywords). Code that actually wants to
1925 write to SYM, should also check whether there are any watching
1929 (SYMBOL_CONSTANT_P
) (Lisp_Object sym
)
1931 return lisp_h_SYMBOL_CONSTANT_P (sym
);
1934 /* Placeholder for make-docfile to process. The actual symbol
1935 definition is done by lread.c's defsym. */
1936 #define DEFSYM(sym, name) /* empty */
1939 /***********************************************************************
1941 ***********************************************************************/
1943 /* The structure of a Lisp hash table. */
1945 struct hash_table_test
1947 /* Name of the function used to compare keys. */
1950 /* User-supplied hash function, or nil. */
1951 Lisp_Object user_hash_function
;
1953 /* User-supplied key comparison function, or nil. */
1954 Lisp_Object user_cmp_function
;
1956 /* C function to compare two keys. */
1957 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1959 /* C function to compute hash code. */
1960 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1963 struct Lisp_Hash_Table
1965 /* This is for Lisp; the hash table code does not refer to it. */
1966 struct vectorlike_header header
;
1968 /* Nil if table is non-weak. Otherwise a symbol describing the
1969 weakness of the table. */
1972 /* Vector of hash codes. If hash[I] is nil, this means that the
1973 I-th entry is unused. */
1976 /* Vector used to chain entries. If entry I is free, next[I] is the
1977 entry number of the next free item. If entry I is non-free,
1978 next[I] is the index of the next entry in the collision chain,
1979 or -1 if there is such entry. */
1982 /* Bucket vector. An entry of -1 indicates no item is present,
1983 and a nonnegative entry is the index of the first item in
1984 a collision chain. This vector's size can be larger than the
1985 hash table size to reduce collisions. */
1988 /* Only the fields above are traced normally by the GC. The ones below
1989 `count' are special and are either ignored by the GC or traced in
1990 a special way (e.g. because of weakness). */
1992 /* Number of key/value entries in the table. */
1995 /* Index of first free entry in free list, or -1 if none. */
1996 ptrdiff_t next_free
;
1998 /* True if the table can be purecopied. The table cannot be
1999 changed afterwards. */
2002 /* Resize hash table when number of entries / table size is >= this
2004 float rehash_threshold
;
2006 /* Used when the table is resized. If equal to a negative integer,
2007 the user rehash-size is the integer -REHASH_SIZE, and the new
2008 size is the old size plus -REHASH_SIZE. If positive, the user
2009 rehash-size is the floating-point value REHASH_SIZE + 1, and the
2010 new size is the old size times REHASH_SIZE + 1. */
2013 /* Vector of keys and values. The key of item I is found at index
2014 2 * I, the value is found at index 2 * I + 1.
2015 This is gc_marked specially if the table is weak. */
2016 Lisp_Object key_and_value
;
2018 /* The comparison and hash functions. */
2019 struct hash_table_test test
;
2021 /* Next weak hash table if this is a weak hash table. The head
2022 of the list is in weak_hash_tables. */
2023 struct Lisp_Hash_Table
*next_weak
;
2028 HASH_TABLE_P (Lisp_Object a
)
2030 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
2033 INLINE
struct Lisp_Hash_Table
*
2034 XHASH_TABLE (Lisp_Object a
)
2036 eassert (HASH_TABLE_P (a
));
2037 return XUNTAG (a
, Lisp_Vectorlike
);
2040 #define XSET_HASH_TABLE(VAR, PTR) \
2041 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
2043 /* Value is the key part of entry IDX in hash table H. */
2045 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2047 return AREF (h
->key_and_value
, 2 * idx
);
2050 /* Value is the value part of entry IDX in hash table H. */
2052 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2054 return AREF (h
->key_and_value
, 2 * idx
+ 1);
2057 /* Value is the hash code computed for entry IDX in hash table H. */
2059 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2061 return AREF (h
->hash
, idx
);
2064 /* Value is the size of hash table H. */
2066 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
2068 return ASIZE (h
->next
);
2071 /* Default size for hash tables if not specified. */
2073 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
2075 /* Default threshold specifying when to resize a hash table. The
2076 value gives the ratio of current entries in the hash table and the
2077 size of the hash table. */
2079 static float const DEFAULT_REHASH_THRESHOLD
= 0.8125;
2081 /* Default factor by which to increase the size of a hash table, minus 1. */
2083 static float const DEFAULT_REHASH_SIZE
= 1.5 - 1;
2085 /* Combine two integers X and Y for hashing. The result might not fit
2086 into a Lisp integer. */
2089 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
2091 return (x
<< 4) + (x
>> (EMACS_INT_WIDTH
- 4)) + y
;
2094 /* Hash X, returning a value that fits into a fixnum. */
2097 SXHASH_REDUCE (EMACS_UINT x
)
2099 return (x
^ x
>> (EMACS_INT_WIDTH
- FIXNUM_BITS
)) & INTMASK
;
2102 /* These structures are used for various misc types. */
2104 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
2106 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
2107 bool_bf gcmarkbit
: 1;
2108 unsigned spacer
: 15;
2112 (MISCP
) (Lisp_Object x
)
2114 return lisp_h_MISCP (x
);
2117 INLINE
struct Lisp_Misc_Any
*
2118 XMISCANY (Lisp_Object a
)
2120 eassert (MISCP (a
));
2121 return XUNTAG (a
, Lisp_Misc
);
2124 INLINE
enum Lisp_Misc_Type
2125 XMISCTYPE (Lisp_Object a
)
2127 return XMISCANY (a
)->type
;
2132 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
2133 bool_bf gcmarkbit
: 1;
2134 unsigned spacer
: 13;
2135 /* This flag is temporarily used in the functions
2136 decode/encode_coding_object to record that the marker position
2137 must be adjusted after the conversion. */
2138 bool_bf need_adjustment
: 1;
2139 /* True means normal insertion at the marker's position
2140 leaves the marker after the inserted text. */
2141 bool_bf insertion_type
: 1;
2142 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2143 Note: a chain of markers can contain markers pointing into different
2144 buffers (the chain is per buffer_text rather than per buffer, so it's
2145 shared between indirect buffers). */
2146 /* This is used for (other than NULL-checking):
2148 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2149 - unchain_marker: to find the list from which to unchain.
2150 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2152 struct buffer
*buffer
;
2154 /* The remaining fields are meaningless in a marker that
2155 does not point anywhere. */
2157 /* For markers that point somewhere,
2158 this is used to chain of all the markers in a given buffer. */
2159 /* We could remove it and use an array in buffer_text instead.
2160 That would also allow us to preserve it ordered. */
2161 struct Lisp_Marker
*next
;
2162 /* This is the char position where the marker points. */
2164 /* This is the byte position.
2165 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2166 used to implement the functionality of markers, but rather to (ab)use
2167 markers as a cache for char<->byte mappings). */
2171 /* START and END are markers in the overlay's buffer, and
2172 PLIST is the overlay's property list. */
2174 /* An overlay's real data content is:
2176 - buffer (really there are two buffer pointers, one per marker,
2177 and both points to the same buffer)
2178 - insertion type of both ends (per-marker fields)
2179 - start & start byte (of start marker)
2180 - end & end byte (of end marker)
2181 - next (singly linked list of overlays)
2182 - next fields of start and end markers (singly linked list of markers).
2183 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2186 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2187 bool_bf gcmarkbit
: 1;
2188 unsigned spacer
: 15;
2189 struct Lisp_Overlay
*next
;
2195 /* Number of bits needed to store one of the values
2196 SAVE_UNUSED..SAVE_OBJECT. */
2197 enum { SAVE_SLOT_BITS
= 3 };
2199 /* Number of slots in a save value where save_type is nonzero. */
2200 enum { SAVE_VALUE_SLOTS
= 4 };
2202 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2204 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2206 /* Types of data which may be saved in a Lisp_Save_Value. */
2215 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2216 SAVE_TYPE_INT_INT_INT
2217 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2218 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2219 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2220 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2221 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2222 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2223 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2224 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2225 SAVE_TYPE_FUNCPTR_PTR_OBJ
2226 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2228 /* This has an extra bit indicating it's raw memory. */
2229 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2232 /* SAVE_SLOT_BITS must be large enough to represent these values. */
2233 verify (((SAVE_UNUSED
| SAVE_INTEGER
| SAVE_FUNCPOINTER
2234 | SAVE_POINTER
| SAVE_OBJECT
)
2238 /* Special object used to hold a different values for later use.
2240 This is mostly used to package C integers and pointers to call
2241 record_unwind_protect when two or more values need to be saved.
2245 struct my_data *md = get_my_data ();
2246 ptrdiff_t mi = get_my_integer ();
2247 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2250 Lisp_Object my_unwind (Lisp_Object arg)
2252 struct my_data *md = XSAVE_POINTER (arg, 0);
2253 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2257 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2258 saved objects and raise eassert if type of the saved object doesn't match
2259 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2260 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2261 slot 0 is a pointer. */
2263 typedef void (*voidfuncptr
) (void);
2265 struct Lisp_Save_Value
2267 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2268 bool_bf gcmarkbit
: 1;
2269 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2271 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2272 V's data entries are determined by V->save_type. E.g., if
2273 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2274 V->data[1] is an integer, and V's other data entries are unused.
2276 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2277 a memory area containing V->data[1].integer potential Lisp_Objects. */
2278 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2281 voidfuncptr funcpointer
;
2284 } data
[SAVE_VALUE_SLOTS
];
2288 SAVE_VALUEP (Lisp_Object x
)
2290 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2293 INLINE
struct Lisp_Save_Value
*
2294 XSAVE_VALUE (Lisp_Object a
)
2296 eassert (SAVE_VALUEP (a
));
2297 return XUNTAG (a
, Lisp_Misc
);
2300 /* Return the type of V's Nth saved value. */
2302 save_type (struct Lisp_Save_Value
*v
, int n
)
2304 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2305 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2308 /* Get and set the Nth saved pointer. */
2311 XSAVE_POINTER (Lisp_Object obj
, int n
)
2313 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2314 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2317 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2319 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2320 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2323 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2325 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2326 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2329 /* Likewise for the saved integer. */
2332 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2334 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2335 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2338 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2340 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2341 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2344 /* Extract Nth saved object. */
2347 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2349 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2350 return XSAVE_VALUE (obj
)->data
[n
].object
;
2354 struct Lisp_User_Ptr
2356 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_User_Ptr */
2357 bool_bf gcmarkbit
: 1;
2358 unsigned spacer
: 15;
2360 void (*finalizer
) (void *);
2365 /* A finalizer sentinel. */
2366 struct Lisp_Finalizer
2368 struct Lisp_Misc_Any base
;
2370 /* Circular list of all active weak references. */
2371 struct Lisp_Finalizer
*prev
;
2372 struct Lisp_Finalizer
*next
;
2374 /* Call FUNCTION when the finalizer becomes unreachable, even if
2375 FUNCTION contains a reference to the finalizer; i.e., call
2376 FUNCTION when it is reachable _only_ through finalizers. */
2377 Lisp_Object function
;
2381 FINALIZERP (Lisp_Object x
)
2383 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Finalizer
;
2386 INLINE
struct Lisp_Finalizer
*
2387 XFINALIZER (Lisp_Object a
)
2389 eassert (FINALIZERP (a
));
2390 return XUNTAG (a
, Lisp_Misc
);
2393 /* A miscellaneous object, when it's on the free list. */
2396 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2397 bool_bf gcmarkbit
: 1;
2398 unsigned spacer
: 15;
2399 union Lisp_Misc
*chain
;
2402 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2403 It uses one of these struct subtypes to get the type field. */
2407 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2408 struct Lisp_Free u_free
;
2409 struct Lisp_Marker u_marker
;
2410 struct Lisp_Overlay u_overlay
;
2411 struct Lisp_Save_Value u_save_value
;
2412 struct Lisp_Finalizer u_finalizer
;
2414 struct Lisp_User_Ptr u_user_ptr
;
2418 INLINE
union Lisp_Misc
*
2419 XMISC (Lisp_Object a
)
2421 return XUNTAG (a
, Lisp_Misc
);
2425 (MARKERP
) (Lisp_Object x
)
2427 return lisp_h_MARKERP (x
);
2430 INLINE
struct Lisp_Marker
*
2431 XMARKER (Lisp_Object a
)
2433 eassert (MARKERP (a
));
2434 return XUNTAG (a
, Lisp_Misc
);
2438 OVERLAYP (Lisp_Object x
)
2440 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2443 INLINE
struct Lisp_Overlay
*
2444 XOVERLAY (Lisp_Object a
)
2446 eassert (OVERLAYP (a
));
2447 return XUNTAG (a
, Lisp_Misc
);
2452 USER_PTRP (Lisp_Object x
)
2454 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_User_Ptr
;
2457 INLINE
struct Lisp_User_Ptr
*
2458 XUSER_PTR (Lisp_Object a
)
2460 eassert (USER_PTRP (a
));
2461 return XUNTAG (a
, Lisp_Misc
);
2466 /* Forwarding pointer to an int variable.
2467 This is allowed only in the value cell of a symbol,
2468 and it means that the symbol's value really lives in the
2469 specified int variable. */
2472 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2476 /* Boolean forwarding pointer to an int variable.
2477 This is like Lisp_Intfwd except that the ostensible
2478 "value" of the symbol is t if the bool variable is true,
2479 nil if it is false. */
2482 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2486 /* Forwarding pointer to a Lisp_Object variable.
2487 This is allowed only in the value cell of a symbol,
2488 and it means that the symbol's value really lives in the
2489 specified variable. */
2492 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2493 Lisp_Object
*objvar
;
2496 /* Like Lisp_Objfwd except that value lives in a slot in the
2497 current buffer. Value is byte index of slot within buffer. */
2498 struct Lisp_Buffer_Objfwd
2500 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2502 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2503 Lisp_Object predicate
;
2506 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2507 the symbol has buffer-local bindings. (Exception:
2508 some buffer-local variables are built-in, with their values stored
2509 in the buffer structure itself. They are handled differently,
2510 using struct Lisp_Buffer_Objfwd.)
2512 The `realvalue' slot holds the variable's current value, or a
2513 forwarding pointer to where that value is kept. This value is the
2514 one that corresponds to the loaded binding. To read or set the
2515 variable, you must first make sure the right binding is loaded;
2516 then you can access the value in (or through) `realvalue'.
2518 `buffer' and `frame' are the buffer and frame for which the loaded
2519 binding was found. If those have changed, to make sure the right
2520 binding is loaded it is necessary to find which binding goes with
2521 the current buffer and selected frame, then load it. To load it,
2522 first unload the previous binding, then copy the value of the new
2523 binding into `realvalue' (or through it). Also update
2524 LOADED-BINDING to point to the newly loaded binding.
2526 `local_if_set' indicates that merely setting the variable creates a
2527 local binding for the current buffer. Otherwise the latter, setting
2528 the variable does not do that; only make-local-variable does that. */
2530 struct Lisp_Buffer_Local_Value
2532 /* True means that merely setting the variable creates a local
2533 binding for the current buffer. */
2534 bool_bf local_if_set
: 1;
2535 /* True means that the binding now loaded was found.
2536 Presumably equivalent to (defcell!=valcell). */
2538 /* If non-NULL, a forwarding to the C var where it should also be set. */
2539 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2540 /* The buffer or frame for which the loaded binding was found. */
2542 /* A cons cell that holds the default value. It has the form
2543 (SYMBOL . DEFAULT-VALUE). */
2544 Lisp_Object defcell
;
2545 /* The cons cell from `where's parameter alist.
2546 It always has the form (SYMBOL . VALUE)
2547 Note that if `forward' is non-nil, VALUE may be out of date.
2548 Also if the currently loaded binding is the default binding, then
2549 this is `eq'ual to defcell. */
2550 Lisp_Object valcell
;
2553 /* Like Lisp_Objfwd except that value lives in a slot in the
2555 struct Lisp_Kboard_Objfwd
2557 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2563 struct Lisp_Intfwd u_intfwd
;
2564 struct Lisp_Boolfwd u_boolfwd
;
2565 struct Lisp_Objfwd u_objfwd
;
2566 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2567 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2570 INLINE
enum Lisp_Fwd_Type
2571 XFWDTYPE (union Lisp_Fwd
*a
)
2573 return a
->u_intfwd
.type
;
2577 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2579 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2582 INLINE
struct Lisp_Buffer_Objfwd
*
2583 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2585 eassert (BUFFER_OBJFWDP (a
));
2586 return &a
->u_buffer_objfwd
;
2589 /* Lisp floating point type. */
2595 struct Lisp_Float
*chain
;
2600 (FLOATP
) (Lisp_Object x
)
2602 return lisp_h_FLOATP (x
);
2605 INLINE
struct Lisp_Float
*
2606 XFLOAT (Lisp_Object a
)
2608 eassert (FLOATP (a
));
2609 return XUNTAG (a
, Lisp_Float
);
2613 XFLOAT_DATA (Lisp_Object f
)
2615 return XFLOAT (f
)->u
.data
;
2618 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2619 representations, have infinities and NaNs, and do not trap on
2620 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2621 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2622 wanted here, but is not quite right because Emacs does not require
2623 all the features of C11 Annex F (and does not require C11 at all,
2624 for that matter). */
2628 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2629 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2632 /* A character, declared with the following typedef, is a member
2633 of some character set associated with the current buffer. */
2634 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2636 typedef unsigned char UCHAR
;
2639 /* Meanings of slots in a Lisp_Compiled: */
2643 COMPILED_ARGLIST
= 0,
2644 COMPILED_BYTECODE
= 1,
2645 COMPILED_CONSTANTS
= 2,
2646 COMPILED_STACK_DEPTH
= 3,
2647 COMPILED_DOC_STRING
= 4,
2648 COMPILED_INTERACTIVE
= 5
2651 /* Flag bits in a character. These also get used in termhooks.h.
2652 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2653 (MUlti-Lingual Emacs) might need 22 bits for the character value
2654 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2657 CHAR_ALT
= 0x0400000,
2658 CHAR_SUPER
= 0x0800000,
2659 CHAR_HYPER
= 0x1000000,
2660 CHAR_SHIFT
= 0x2000000,
2661 CHAR_CTL
= 0x4000000,
2662 CHAR_META
= 0x8000000,
2664 CHAR_MODIFIER_MASK
=
2665 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2667 /* Actually, the current Emacs uses 22 bits for the character value
2672 /* Data type checking. */
2675 NUMBERP (Lisp_Object x
)
2677 return INTEGERP (x
) || FLOATP (x
);
2680 NATNUMP (Lisp_Object x
)
2682 return INTEGERP (x
) && 0 <= XINT (x
);
2686 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2688 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2691 #define TYPE_RANGED_INTEGERP(type, x) \
2693 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2694 && XINT (x) <= TYPE_MAXIMUM (type))
2697 AUTOLOADP (Lisp_Object x
)
2699 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2703 /* Test for specific pseudovector types. */
2706 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2708 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2712 COMPILEDP (Lisp_Object a
)
2714 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2718 FRAMEP (Lisp_Object a
)
2720 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2723 /* Test for image (image . spec) */
2725 IMAGEP (Lisp_Object x
)
2727 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2732 ARRAYP (Lisp_Object x
)
2734 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2738 CHECK_LIST (Lisp_Object x
)
2740 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2744 CHECK_LIST_END (Lisp_Object x
, Lisp_Object y
)
2746 CHECK_TYPE (NILP (x
), Qlistp
, y
);
2750 (CHECK_NUMBER
) (Lisp_Object x
)
2752 lisp_h_CHECK_NUMBER (x
);
2756 CHECK_STRING_CAR (Lisp_Object x
)
2758 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2760 /* This is a bit special because we always need size afterwards. */
2762 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2768 wrong_type_argument (Qarrayp
, x
);
2771 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2773 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2776 CHECK_NATNUM (Lisp_Object x
)
2778 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2781 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2784 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2785 args_out_of_range_3 \
2787 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2788 ? MOST_NEGATIVE_FIXNUM \
2790 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2792 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2794 if (TYPE_SIGNED (type)) \
2795 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2797 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2800 #define CHECK_NUMBER_COERCE_MARKER(x) \
2802 if (MARKERP ((x))) \
2803 XSETFASTINT (x, marker_position (x)); \
2805 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2809 XFLOATINT (Lisp_Object n
)
2811 return extract_float (n
);
2815 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2817 CHECK_TYPE (NUMBERP (x
), Qnumberp
, x
);
2820 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2823 XSETFASTINT (x, marker_position (x)); \
2825 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2828 /* Since we can't assign directly to the CAR or CDR fields of a cons
2829 cell, use these when checking that those fields contain numbers. */
2831 CHECK_NUMBER_CAR (Lisp_Object x
)
2833 Lisp_Object tmp
= XCAR (x
);
2839 CHECK_NUMBER_CDR (Lisp_Object x
)
2841 Lisp_Object tmp
= XCDR (x
);
2846 /* Define a built-in function for calling from Lisp.
2847 `lname' should be the name to give the function in Lisp,
2848 as a null-terminated C string.
2849 `fnname' should be the name of the function in C.
2850 By convention, it starts with F.
2851 `sname' should be the name for the C constant structure
2852 that records information on this function for internal use.
2853 By convention, it should be the same as `fnname' but with S instead of F.
2854 It's too bad that C macros can't compute this from `fnname'.
2855 `minargs' should be a number, the minimum number of arguments allowed.
2856 `maxargs' should be a number, the maximum number of arguments allowed,
2857 or else MANY or UNEVALLED.
2858 MANY means pass a vector of evaluated arguments,
2859 in the form of an integer number-of-arguments
2860 followed by the address of a vector of Lisp_Objects
2861 which contains the argument values.
2862 UNEVALLED means pass the list of unevaluated arguments
2863 `intspec' says how interactive arguments are to be fetched.
2864 If the string starts with a `(', `intspec' is evaluated and the resulting
2865 list is the list of arguments.
2866 If it's a string that doesn't start with `(', the value should follow
2867 the one of the doc string for `interactive'.
2868 A null string means call interactively with no arguments.
2869 `doc' is documentation for the user. */
2871 /* This version of DEFUN declares a function prototype with the right
2872 arguments, so we can catch errors with maxargs at compile-time. */
2874 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2875 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2876 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2877 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2878 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2879 { (Lisp_Object (__cdecl *)(void))fnname }, \
2880 minargs, maxargs, lname, intspec, 0}; \
2882 #else /* not _MSC_VER */
2883 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2884 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2885 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2886 { .a ## maxargs = fnname }, \
2887 minargs, maxargs, lname, intspec, 0}; \
2892 is how we define the symbol for function `name' at start-up time. */
2893 extern void defsubr (struct Lisp_Subr
*);
2901 /* Call a function F that accepts many args, passing it ARRAY's elements. */
2902 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
2904 /* Call a function F that accepts many args, passing it the remaining args,
2905 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
2906 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
2907 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
2908 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
2910 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2911 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2912 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2913 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2914 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2916 /* Macros we use to define forwarded Lisp variables.
2917 These are used in the syms_of_FILENAME functions.
2919 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2920 lisp variable is actually a field in `struct emacs_globals'. The
2921 field's name begins with "f_", which is a convention enforced by
2922 these macros. Each such global has a corresponding #define in
2923 globals.h; the plain name should be used in the code.
2925 E.g., the global "cons_cells_consed" is declared as "int
2926 f_cons_cells_consed" in globals.h, but there is a define:
2928 #define cons_cells_consed globals.f_cons_cells_consed
2930 All C code uses the `cons_cells_consed' name. This is all done
2931 this way to support indirection for multi-threaded Emacs. */
2933 #define DEFVAR_LISP(lname, vname, doc) \
2935 static struct Lisp_Objfwd o_fwd; \
2936 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2938 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2940 static struct Lisp_Objfwd o_fwd; \
2941 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2943 #define DEFVAR_BOOL(lname, vname, doc) \
2945 static struct Lisp_Boolfwd b_fwd; \
2946 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2948 #define DEFVAR_INT(lname, vname, doc) \
2950 static struct Lisp_Intfwd i_fwd; \
2951 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2954 #define DEFVAR_KBOARD(lname, vname, doc) \
2956 static struct Lisp_Kboard_Objfwd ko_fwd; \
2957 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2960 /* Save and restore the instruction and environment pointers,
2961 without affecting the signal mask. */
2964 typedef jmp_buf sys_jmp_buf
;
2965 # define sys_setjmp(j) _setjmp (j)
2966 # define sys_longjmp(j, v) _longjmp (j, v)
2967 #elif defined HAVE_SIGSETJMP
2968 typedef sigjmp_buf sys_jmp_buf
;
2969 # define sys_setjmp(j) sigsetjmp (j, 0)
2970 # define sys_longjmp(j, v) siglongjmp (j, v)
2972 /* A platform that uses neither _longjmp nor siglongjmp; assume
2973 longjmp does not affect the sigmask. */
2974 typedef jmp_buf sys_jmp_buf
;
2975 # define sys_setjmp(j) setjmp (j)
2976 # define sys_longjmp(j, v) longjmp (j, v)
2980 /* Elisp uses several stacks:
2982 - the bytecode stack: used internally by the bytecode interpreter.
2983 Allocated from the C stack.
2984 - The specpdl stack: keeps track of active unwind-protect and
2985 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2987 - The handler stack: keeps track of active catch tags and condition-case
2988 handlers. Allocated in a manually managed stack implemented by a
2989 doubly-linked list allocated via xmalloc and never freed. */
2991 /* Structure for recording Lisp call stack for backtrace purposes. */
2993 /* The special binding stack holds the outer values of variables while
2994 they are bound by a function application or a let form, stores the
2995 code to be executed for unwind-protect forms.
2997 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2998 used all over the place, needs to be fast, and needs to know the size of
2999 union specbinding. But only eval.c should access it. */
3002 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
3003 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
3004 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
3005 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
3006 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
3007 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
3008 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3009 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
3010 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
3015 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3017 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3018 void (*func
) (Lisp_Object
);
3022 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3023 void (*func
) (void *);
3027 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3032 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3033 void (*func
) (void);
3036 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3037 /* `where' is not used in the case of SPECPDL_LET. */
3038 Lisp_Object symbol
, old_value
, where
;
3039 /* Normally this is unused; but it is set to the symbol's
3040 current value when a thread is swapped out. */
3041 Lisp_Object saved_value
;
3044 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3045 bool_bf debug_on_exit
: 1;
3046 Lisp_Object function
;
3052 /* These 3 are defined as macros in thread.h. */
3053 /* extern union specbinding *specpdl; */
3054 /* extern union specbinding *specpdl_ptr; */
3055 /* extern ptrdiff_t specpdl_size; */
3058 SPECPDL_INDEX (void)
3060 return specpdl_ptr
- specpdl
;
3063 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3064 control structures. A struct handler contains all the information needed to
3065 restore the state of the interpreter after a non-local jump.
3067 handler structures are chained together in a doubly linked list; the `next'
3068 member points to the next outer catchtag and the `nextfree' member points in
3069 the other direction to the next inner element (which is typically the next
3070 free element since we mostly use it on the deepest handler).
3072 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3073 member is TAG, and then unbinds to it. The `val' member is used to
3074 hold VAL while the stack is unwound; `val' is returned as the value
3075 of the catch form. If there is a handler of type CATCHER_ALL, it will
3076 be treated as a handler for all invocations of `throw'; in this case
3077 `val' will be set to (TAG . VAL).
3079 All the other members are concerned with restoring the interpreter
3082 Members are volatile if their values need to survive _longjmp when
3083 a 'struct handler' is a local variable. */
3085 enum handlertype
{ CATCHER
, CONDITION_CASE
, CATCHER_ALL
};
3089 enum handlertype type
;
3090 Lisp_Object tag_or_ch
;
3092 struct handler
*next
;
3093 struct handler
*nextfree
;
3095 /* The bytecode interpreter can have several handlers active at the same
3096 time, so when we longjmp to one of them, it needs to know which handler
3097 this was and what was the corresponding internal state. This is stored
3098 here, and when we longjmp we make sure that handlerlist points to the
3100 Lisp_Object
*bytecode_top
;
3103 /* Most global vars are reset to their value via the specpdl mechanism,
3104 but a few others are handled by storing their value here. */
3106 EMACS_INT f_lisp_eval_depth
;
3108 int poll_suppress_count
;
3109 int interrupt_input_blocked
;
3112 extern Lisp_Object memory_signal_data
;
3114 extern void maybe_quit (void);
3116 /* True if ought to quit now. */
3118 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3120 /* Process a quit rarely, based on a counter COUNT, for efficiency.
3121 "Rarely" means once per USHRT_MAX + 1 times; this is somewhat
3122 arbitrary, but efficient. */
3125 rarely_quit (unsigned short int count
)
3131 extern Lisp_Object Vascii_downcase_table
;
3132 extern Lisp_Object Vascii_canon_table
;
3134 /* Call staticpro (&var) to protect static variable `var'. */
3136 void staticpro (Lisp_Object
*);
3138 /* Forward declarations for prototypes. */
3142 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3145 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3147 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3148 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3151 /* Functions to modify hash tables. */
3154 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3156 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3160 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3162 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3165 /* Use these functions to set Lisp_Object
3166 or pointer slots of struct Lisp_Symbol. */
3169 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3171 XSYMBOL (sym
)->function
= function
;
3175 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3177 XSYMBOL (sym
)->plist
= plist
;
3181 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3183 XSYMBOL (sym
)->next
= next
;
3187 make_symbol_constant (Lisp_Object sym
)
3189 XSYMBOL (sym
)->trapped_write
= SYMBOL_NOWRITE
;
3192 /* Buffer-local variable access functions. */
3195 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3197 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3201 /* Set overlay's property list. */
3204 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3206 XOVERLAY (overlay
)->plist
= plist
;
3209 /* Get text properties of S. */
3212 string_intervals (Lisp_Object s
)
3214 return XSTRING (s
)->intervals
;
3217 /* Set text properties of S to I. */
3220 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3222 XSTRING (s
)->intervals
= i
;
3225 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3226 of setting slots directly. */
3229 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3231 XCHAR_TABLE (table
)->defalt
= val
;
3234 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3236 XCHAR_TABLE (table
)->purpose
= val
;
3239 /* Set different slots in (sub)character tables. */
3242 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3244 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3245 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3249 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3251 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3252 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3256 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3258 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3261 /* Defined in data.c. */
3262 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
3263 extern void notify_variable_watchers (Lisp_Object
, Lisp_Object
,
3264 Lisp_Object
, Lisp_Object
);
3265 extern Lisp_Object
indirect_function (Lisp_Object
);
3266 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3267 enum Arith_Comparison
{
3272 ARITH_LESS_OR_EQUAL
,
3275 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3276 enum Arith_Comparison comparison
);
3278 /* Convert the integer I to an Emacs representation, either the integer
3279 itself, or a cons of two or three integers, or if all else fails a float.
3280 I should not have side effects. */
3281 #define INTEGER_TO_CONS(i) \
3282 (! FIXNUM_OVERFLOW_P (i) \
3284 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3285 extern Lisp_Object
intbig_to_lisp (intmax_t);
3286 extern Lisp_Object
uintbig_to_lisp (uintmax_t);
3288 /* Convert the Emacs representation CONS back to an integer of type
3289 TYPE, storing the result the variable VAR. Signal an error if CONS
3290 is not a valid representation or is out of range for TYPE. */
3291 #define CONS_TO_INTEGER(cons, type, var) \
3292 (TYPE_SIGNED (type) \
3293 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3294 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3295 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3296 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3298 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3299 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3300 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3302 extern _Noreturn
void circular_list (Lisp_Object
);
3303 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3304 enum Set_Internal_Bind
{
3307 SET_INTERNAL_UNBIND
,
3308 SET_INTERNAL_THREAD_SWITCH
3310 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3311 enum Set_Internal_Bind
);
3312 extern void set_default_internal (Lisp_Object
, Lisp_Object
,
3313 enum Set_Internal_Bind bindflag
);
3315 extern void syms_of_data (void);
3316 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3318 /* Defined in cmds.c */
3319 extern void syms_of_cmds (void);
3320 extern void keys_of_cmds (void);
3322 /* Defined in coding.c. */
3323 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3324 ptrdiff_t, bool, bool, Lisp_Object
);
3325 extern void init_coding (void);
3326 extern void init_coding_once (void);
3327 extern void syms_of_coding (void);
3329 /* Defined in character.c. */
3330 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3331 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3332 extern void syms_of_character (void);
3334 /* Defined in charset.c. */
3335 extern void init_charset (void);
3336 extern void init_charset_once (void);
3337 extern void syms_of_charset (void);
3338 /* Structure forward declarations. */
3341 /* Defined in syntax.c. */
3342 extern void init_syntax_once (void);
3343 extern void syms_of_syntax (void);
3345 /* Defined in fns.c. */
3346 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3347 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3348 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3349 extern void sweep_weak_hash_tables (void);
3350 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3351 EMACS_UINT
sxhash (Lisp_Object
, int);
3352 Lisp_Object
make_hash_table (struct hash_table_test
, EMACS_INT
, float, float,
3354 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3355 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3357 void hash_remove_from_table (struct Lisp_Hash_Table
*, Lisp_Object
);
3358 extern struct hash_table_test
const hashtest_eq
, hashtest_eql
, hashtest_equal
;
3359 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3360 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3361 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3362 ptrdiff_t, ptrdiff_t);
3363 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3364 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3365 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3366 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3367 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3368 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3369 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3370 extern void clear_string_char_byte_cache (void);
3371 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3372 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3373 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3374 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3375 extern void syms_of_fns (void);
3377 /* Defined in floatfns.c. */
3378 extern void syms_of_floatfns (void);
3379 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3381 /* Defined in fringe.c. */
3382 extern void syms_of_fringe (void);
3383 extern void init_fringe (void);
3384 #ifdef HAVE_WINDOW_SYSTEM
3385 extern void mark_fringe_data (void);
3386 extern void init_fringe_once (void);
3387 #endif /* HAVE_WINDOW_SYSTEM */
3389 /* Defined in image.c. */
3390 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3391 extern void reset_image_types (void);
3392 extern void syms_of_image (void);
3394 /* Defined in insdel.c. */
3395 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3396 extern _Noreturn
void buffer_overflow (void);
3397 extern void make_gap (ptrdiff_t);
3398 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3399 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3400 ptrdiff_t, bool, bool);
3401 extern int count_combining_before (const unsigned char *,
3402 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3403 extern int count_combining_after (const unsigned char *,
3404 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3405 extern void insert (const char *, ptrdiff_t);
3406 extern void insert_and_inherit (const char *, ptrdiff_t);
3407 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3409 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3410 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3411 ptrdiff_t, ptrdiff_t, bool);
3412 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3413 extern void insert_char (int);
3414 extern void insert_string (const char *);
3415 extern void insert_before_markers (const char *, ptrdiff_t);
3416 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3417 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3418 ptrdiff_t, ptrdiff_t,
3420 extern void del_range (ptrdiff_t, ptrdiff_t);
3421 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3422 extern void del_range_byte (ptrdiff_t, ptrdiff_t);
3423 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3424 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3425 ptrdiff_t, ptrdiff_t, bool);
3426 extern void modify_text (ptrdiff_t, ptrdiff_t);
3427 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3428 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3429 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3430 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3431 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3432 ptrdiff_t, ptrdiff_t);
3433 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3434 ptrdiff_t, ptrdiff_t);
3435 extern void adjust_markers_bytepos (ptrdiff_t, ptrdiff_t,
3436 ptrdiff_t, ptrdiff_t, int);
3437 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool, bool);
3438 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3439 const char *, ptrdiff_t, ptrdiff_t, bool);
3440 extern void syms_of_insdel (void);
3442 /* Defined in dispnew.c. */
3443 #if (defined PROFILING \
3444 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3445 _Noreturn
void __executable_start (void);
3447 extern Lisp_Object Vwindow_system
;
3448 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3450 /* Defined in xdisp.c. */
3451 extern bool noninteractive_need_newline
;
3452 extern Lisp_Object echo_area_buffer
[2];
3453 extern void add_to_log (char const *, ...);
3454 extern void vadd_to_log (char const *, va_list);
3455 extern void check_message_stack (void);
3456 extern void setup_echo_area_for_printing (bool);
3457 extern bool push_message (void);
3458 extern void pop_message_unwind (void);
3459 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3460 extern void restore_message (void);
3461 extern Lisp_Object
current_message (void);
3462 extern void clear_message (bool, bool);
3463 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3464 extern void message1 (const char *);
3465 extern void message1_nolog (const char *);
3466 extern void message3 (Lisp_Object
);
3467 extern void message3_nolog (Lisp_Object
);
3468 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3469 extern void message_with_string (const char *, Lisp_Object
, bool);
3470 extern void message_log_maybe_newline (void);
3471 extern void update_echo_area (void);
3472 extern void truncate_echo_area (ptrdiff_t);
3473 extern void redisplay (void);
3475 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3476 extern void syms_of_xdisp (void);
3477 extern void init_xdisp (void);
3478 extern Lisp_Object
safe_eval (Lisp_Object
);
3479 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3480 int *, int *, int *, int *, int *);
3482 /* Defined in xsettings.c. */
3483 extern void syms_of_xsettings (void);
3485 /* Defined in vm-limit.c. */
3486 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3488 /* Defined in character.c. */
3489 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3490 ptrdiff_t *, ptrdiff_t *);
3492 /* Defined in alloc.c. */
3493 extern void *my_heap_start (void);
3494 extern void check_pure_size (void);
3495 extern void free_misc (Lisp_Object
);
3496 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3497 extern void malloc_warning (const char *);
3498 extern _Noreturn
void memory_full (size_t);
3499 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3500 extern bool survives_gc_p (Lisp_Object
);
3501 extern void mark_object (Lisp_Object
);
3502 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3503 extern void refill_memory_reserve (void);
3505 extern void alloc_unexec_pre (void);
3506 extern void alloc_unexec_post (void);
3507 extern void mark_stack (char *, char *);
3508 extern void flush_stack_call_func (void (*func
) (void *arg
), void *arg
);
3509 extern const char *pending_malloc_warning
;
3510 extern Lisp_Object zero_vector
;
3511 extern EMACS_INT consing_since_gc
;
3512 extern EMACS_INT gc_relative_threshold
;
3513 extern EMACS_INT memory_full_cons_threshold
;
3514 extern Lisp_Object
list1 (Lisp_Object
);
3515 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3516 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3517 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3518 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3520 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3521 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3523 /* Build a frequently used 2/3/4-integer lists. */
3526 list2i (EMACS_INT x
, EMACS_INT y
)
3528 return list2 (make_number (x
), make_number (y
));
3532 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3534 return list3 (make_number (x
), make_number (y
), make_number (w
));
3538 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3540 return list4 (make_number (x
), make_number (y
),
3541 make_number (w
), make_number (h
));
3544 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3545 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3546 extern _Noreturn
void string_overflow (void);
3547 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3548 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3549 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3550 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3552 /* Make unibyte string from C string when the length isn't known. */
3555 build_unibyte_string (const char *str
)
3557 return make_unibyte_string (str
, strlen (str
));
3560 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3561 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3562 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3563 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3564 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3565 extern Lisp_Object
make_specified_string (const char *,
3566 ptrdiff_t, ptrdiff_t, bool);
3567 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3568 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3570 /* Make a string allocated in pure space, use STR as string data. */
3573 build_pure_c_string (const char *str
)
3575 return make_pure_c_string (str
, strlen (str
));
3578 /* Make a string from the data at STR, treating it as multibyte if the
3582 build_string (const char *str
)
3584 return make_string (str
, strlen (str
));
3587 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3588 extern void make_byte_code (struct Lisp_Vector
*);
3589 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3591 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3592 be sure that GC cannot happen until the vector is completely
3593 initialized. E.g. the following code is likely to crash:
3595 v = make_uninit_vector (3);
3597 ASET (v, 1, Ffunction_can_gc ());
3598 ASET (v, 2, obj1); */
3601 make_uninit_vector (ptrdiff_t size
)
3604 struct Lisp_Vector
*p
;
3606 p
= allocate_vector (size
);
3611 /* Like above, but special for sub char-tables. */
3614 make_uninit_sub_char_table (int depth
, int min_char
)
3616 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3617 Lisp_Object v
= make_uninit_vector (slots
);
3619 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3620 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3621 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3625 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3628 /* Allocate partially initialized pseudovector where all Lisp_Object
3629 slots are set to Qnil but the rest (if any) is left uninitialized. */
3631 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3632 ((type *) allocate_pseudovector (VECSIZE (type), \
3633 PSEUDOVECSIZE (type, field), \
3634 PSEUDOVECSIZE (type, field), tag))
3636 /* Allocate fully initialized pseudovector where all Lisp_Object
3637 slots are set to Qnil and the rest (if any) is zeroed. */
3639 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3640 ((type *) allocate_pseudovector (VECSIZE (type), \
3641 PSEUDOVECSIZE (type, field), \
3642 VECSIZE (type), tag))
3644 extern bool gc_in_progress
;
3645 extern Lisp_Object
make_float (double);
3646 extern void display_malloc_warning (void);
3647 extern ptrdiff_t inhibit_garbage_collection (void);
3648 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3649 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3650 Lisp_Object
, Lisp_Object
);
3651 extern Lisp_Object
make_save_ptr (void *);
3652 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3653 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3654 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3656 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3657 extern void free_save_value (Lisp_Object
);
3658 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3659 extern void free_marker (Lisp_Object
);
3660 extern void free_cons (struct Lisp_Cons
*);
3661 extern void init_alloc_once (void);
3662 extern void init_alloc (void);
3663 extern void syms_of_alloc (void);
3664 extern struct buffer
* allocate_buffer (void);
3665 extern int valid_lisp_object_p (Lisp_Object
);
3666 #ifdef GC_CHECK_CONS_LIST
3667 extern void check_cons_list (void);
3669 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3672 /* Defined in gmalloc.c. */
3673 #if !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC && !defined SYSTEM_MALLOC
3674 extern size_t __malloc_extra_blocks
;
3676 #if !HAVE_DECL_ALIGNED_ALLOC
3677 extern void *aligned_alloc (size_t, size_t) ATTRIBUTE_MALLOC_SIZE ((2));
3679 extern void malloc_enable_thread (void);
3682 /* Defined in ralloc.c. */
3683 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3684 extern void r_alloc_free (void **);
3685 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3686 extern void r_alloc_reset_variable (void **, void **);
3687 extern void r_alloc_inhibit_buffer_relocation (int);
3690 /* Defined in chartab.c. */
3691 extern Lisp_Object
copy_char_table (Lisp_Object
);
3692 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3694 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3695 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3697 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3698 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3699 Lisp_Object
, Lisp_Object
,
3700 Lisp_Object
, struct charset
*,
3701 unsigned, unsigned);
3702 extern Lisp_Object
uniprop_table (Lisp_Object
);
3703 extern void syms_of_chartab (void);
3705 /* Defined in print.c. */
3706 extern Lisp_Object Vprin1_to_string_buffer
;
3707 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3708 extern void temp_output_buffer_setup (const char *);
3709 extern int print_level
;
3710 extern void write_string (const char *);
3711 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3713 extern Lisp_Object internal_with_output_to_temp_buffer
3714 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3715 #define FLOAT_TO_STRING_BUFSIZE 350
3716 extern int float_to_string (char *, double);
3717 extern void init_print_once (void);
3718 extern void syms_of_print (void);
3720 /* Defined in doprnt.c. */
3721 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3723 extern ptrdiff_t esprintf (char *, char const *, ...)
3724 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3725 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3727 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3728 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3729 char const *, va_list)
3730 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3732 /* Defined in lread.c. */
3733 extern Lisp_Object
check_obarray (Lisp_Object
);
3734 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3735 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3736 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3737 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3738 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3740 LOADHIST_ATTACH (Lisp_Object x
)
3743 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3745 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3746 Lisp_Object
*, Lisp_Object
, bool);
3747 extern Lisp_Object
string_to_number (char const *, int, bool);
3748 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3750 extern void dir_warning (const char *, Lisp_Object
);
3751 extern void init_obarray (void);
3752 extern void init_lread (void);
3753 extern void syms_of_lread (void);
3756 intern (const char *str
)
3758 return intern_1 (str
, strlen (str
));
3762 intern_c_string (const char *str
)
3764 return intern_c_string_1 (str
, strlen (str
));
3767 /* Defined in eval.c. */
3768 extern Lisp_Object Vautoload_queue
;
3769 extern Lisp_Object Vrun_hooks
;
3770 extern Lisp_Object Vsignaling_function
;
3771 extern Lisp_Object inhibit_lisp_code
;
3773 /* To run a normal hook, use the appropriate function from the list below.
3774 The calling convention:
3776 if (!NILP (Vrun_hooks))
3777 call1 (Vrun_hooks, Qmy_funny_hook);
3779 should no longer be used. */
3780 extern void run_hook (Lisp_Object
);
3781 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3782 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3783 Lisp_Object (*funcall
)
3784 (ptrdiff_t nargs
, Lisp_Object
*args
));
3785 extern Lisp_Object
quit (void);
3786 INLINE _Noreturn
void
3787 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
3789 Fsignal (error_symbol
, data
);
3791 extern _Noreturn
void xsignal0 (Lisp_Object
);
3792 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3793 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3794 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3796 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3797 extern bool FUNCTIONP (Lisp_Object
);
3798 extern Lisp_Object
funcall_subr (struct Lisp_Subr
*subr
, ptrdiff_t numargs
, Lisp_Object
*arg_vector
);
3799 extern Lisp_Object
eval_sub (Lisp_Object form
);
3800 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3801 extern Lisp_Object
call0 (Lisp_Object
);
3802 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3803 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3804 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3805 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3806 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3807 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3808 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3809 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3810 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3811 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3812 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3813 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3814 extern Lisp_Object internal_condition_case_n
3815 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3816 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3817 extern struct handler
*push_handler (Lisp_Object
, enum handlertype
);
3818 extern struct handler
*push_handler_nosignal (Lisp_Object
, enum handlertype
);
3819 extern void specbind (Lisp_Object
, Lisp_Object
);
3820 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3821 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3822 extern void record_unwind_protect_int (void (*) (int), int);
3823 extern void record_unwind_protect_void (void (*) (void));
3824 extern void record_unwind_protect_nothing (void);
3825 extern void clear_unwind_protect (ptrdiff_t);
3826 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3827 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3828 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3829 extern void rebind_for_thread_switch (void);
3830 extern void unbind_for_thread_switch (struct thread_state
*);
3831 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3832 extern _Noreturn
void verror (const char *, va_list)
3833 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3834 extern Lisp_Object
vformat_string (const char *, va_list)
3835 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3836 extern void un_autoload (Lisp_Object
);
3837 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3838 extern void *near_C_stack_top (void);
3839 extern void init_eval_once (void);
3840 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3841 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3842 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3843 extern void init_eval (void);
3844 extern void syms_of_eval (void);
3845 extern void prog_ignore (Lisp_Object
);
3846 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
3847 extern void mark_specpdl (union specbinding
*first
, union specbinding
*ptr
);
3848 extern void get_backtrace (Lisp_Object array
);
3849 Lisp_Object
backtrace_top_function (void);
3850 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3851 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3854 /* Defined in alloc.c. */
3855 extern Lisp_Object
make_user_ptr (void (*finalizer
) (void *), void *p
);
3857 /* Defined in emacs-module.c. */
3858 extern void syms_of_module (void);
3861 /* Defined in thread.c. */
3862 extern void mark_threads (void);
3864 /* Defined in editfns.c. */
3865 extern void insert1 (Lisp_Object
);
3866 extern Lisp_Object
save_excursion_save (void);
3867 extern Lisp_Object
save_restriction_save (void);
3868 extern void save_excursion_restore (Lisp_Object
);
3869 extern void save_restriction_restore (Lisp_Object
);
3870 extern _Noreturn
void time_overflow (void);
3871 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3872 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3874 extern void init_editfns (bool);
3875 extern void syms_of_editfns (void);
3877 /* Defined in buffer.c. */
3878 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3879 extern _Noreturn
void nsberror (Lisp_Object
);
3880 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3881 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3882 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3883 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3884 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3885 extern bool overlay_touches_p (ptrdiff_t);
3886 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3887 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3888 extern void init_buffer_once (void);
3889 extern void init_buffer (int);
3890 extern void syms_of_buffer (void);
3891 extern void keys_of_buffer (void);
3893 /* Defined in marker.c. */
3895 extern ptrdiff_t marker_position (Lisp_Object
);
3896 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3897 extern void clear_charpos_cache (struct buffer
*);
3898 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3899 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3900 extern void unchain_marker (struct Lisp_Marker
*marker
);
3901 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3902 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3903 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3904 ptrdiff_t, ptrdiff_t);
3905 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3906 extern void syms_of_marker (void);
3908 /* Defined in fileio.c. */
3910 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3911 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3912 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3914 extern void close_file_unwind (int);
3915 extern void fclose_unwind (void *);
3916 extern void restore_point_unwind (Lisp_Object
);
3917 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3918 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3919 extern _Noreturn
void report_file_notify_error (const char *, Lisp_Object
);
3920 extern bool internal_delete_file (Lisp_Object
);
3921 extern Lisp_Object
emacs_readlinkat (int, const char *);
3922 extern bool file_directory_p (const char *);
3923 extern bool file_accessible_directory_p (Lisp_Object
);
3924 extern void init_fileio (void);
3925 extern void syms_of_fileio (void);
3926 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3928 /* Defined in search.c. */
3929 extern void shrink_regexp_cache (void);
3930 extern void restore_search_regs (void);
3931 extern void update_search_regs (ptrdiff_t oldstart
,
3932 ptrdiff_t oldend
, ptrdiff_t newend
);
3933 extern void record_unwind_save_match_data (void);
3934 struct re_registers
;
3935 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3936 struct re_registers
*,
3937 Lisp_Object
, bool, bool);
3938 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
3942 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
3944 return fast_string_match_internal (regexp
, string
, Qnil
);
3948 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
3950 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
3953 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3955 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3956 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3957 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3958 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3959 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3961 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3962 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3963 ptrdiff_t, ptrdiff_t *);
3964 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3965 ptrdiff_t, ptrdiff_t *);
3966 extern void syms_of_search (void);
3967 extern void clear_regexp_cache (void);
3969 /* Defined in minibuf.c. */
3971 extern Lisp_Object Vminibuffer_list
;
3972 extern Lisp_Object last_minibuf_string
;
3973 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3974 extern void init_minibuf_once (void);
3975 extern void syms_of_minibuf (void);
3977 /* Defined in callint.c. */
3979 extern void syms_of_callint (void);
3981 /* Defined in casefiddle.c. */
3983 extern void syms_of_casefiddle (void);
3984 extern void keys_of_casefiddle (void);
3986 /* Defined in casetab.c. */
3988 extern void init_casetab_once (void);
3989 extern void syms_of_casetab (void);
3991 /* Defined in keyboard.c. */
3993 extern Lisp_Object echo_message_buffer
;
3994 extern struct kboard
*echo_kboard
;
3995 extern void cancel_echoing (void);
3996 extern bool input_pending
;
3997 #ifdef HAVE_STACK_OVERFLOW_HANDLING
3998 extern sigjmp_buf return_to_command_loop
;
4000 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4001 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4002 extern void discard_mouse_events (void);
4004 void handle_input_available_signal (int);
4006 extern Lisp_Object pending_funcalls
;
4007 extern bool detect_input_pending (void);
4008 extern bool detect_input_pending_ignore_squeezables (void);
4009 extern bool detect_input_pending_run_timers (bool);
4010 extern void safe_run_hooks (Lisp_Object
);
4011 extern void cmd_error_internal (Lisp_Object
, const char *);
4012 extern Lisp_Object
command_loop_1 (void);
4013 extern Lisp_Object
read_menu_command (void);
4014 extern Lisp_Object
recursive_edit_1 (void);
4015 extern void record_auto_save (void);
4016 extern void force_auto_save_soon (void);
4017 extern void init_keyboard (void);
4018 extern void syms_of_keyboard (void);
4019 extern void keys_of_keyboard (void);
4021 /* Defined in indent.c. */
4022 extern ptrdiff_t current_column (void);
4023 extern void invalidate_current_column (void);
4024 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4025 extern void syms_of_indent (void);
4027 /* Defined in frame.c. */
4028 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4029 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4030 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4031 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4032 extern void frames_discard_buffer (Lisp_Object
);
4033 extern void syms_of_frame (void);
4035 /* Defined in emacs.c. */
4036 extern char **initial_argv
;
4037 extern int initial_argc
;
4038 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4039 extern bool display_arg
;
4041 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4042 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4043 extern _Noreturn
void terminate_due_to_signal (int, int);
4045 extern Lisp_Object Vlibrary_cache
;
4048 void fixup_locale (void);
4049 void synchronize_system_messages_locale (void);
4050 void synchronize_system_time_locale (void);
4052 INLINE
void fixup_locale (void) {}
4053 INLINE
void synchronize_system_messages_locale (void) {}
4054 INLINE
void synchronize_system_time_locale (void) {}
4056 extern char *emacs_strerror (int);
4057 extern void shut_down_emacs (int, Lisp_Object
);
4059 /* True means don't do interactive redisplay and don't change tty modes. */
4060 extern bool noninteractive
;
4062 /* True means remove site-lisp directories from load-path. */
4063 extern bool no_site_lisp
;
4065 /* True means put details like time stamps into builds. */
4066 extern bool build_details
;
4069 /* 0 not a daemon, 1 new-style (foreground), 2 old-style (background). */
4070 extern int daemon_type
;
4071 #define IS_DAEMON (daemon_type != 0)
4072 #define DAEMON_RUNNING (daemon_type >= 0)
4073 #else /* WINDOWSNT */
4074 extern void *w32_daemon_event
;
4075 #define IS_DAEMON (w32_daemon_event != NULL)
4076 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4079 /* True if handling a fatal error already. */
4080 extern bool fatal_error_in_progress
;
4082 /* True means don't do use window-system-specific display code. */
4083 extern bool inhibit_window_system
;
4084 /* True means that a filter or a sentinel is running. */
4085 extern bool running_asynch_code
;
4087 /* Defined in process.c. */
4088 struct Lisp_Process
;
4089 extern void kill_buffer_processes (Lisp_Object
);
4090 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4091 struct Lisp_Process
*, int);
4092 /* Max value for the first argument of wait_reading_process_output. */
4093 #if GNUC_PREREQ (3, 0, 0) && ! GNUC_PREREQ (4, 6, 0)
4094 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.0.
4095 The bug merely causes a bogus warning, but the warning is annoying. */
4096 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4098 # define WAIT_READING_MAX INTMAX_MAX
4101 extern void add_timer_wait_descriptor (int);
4103 extern void add_keyboard_wait_descriptor (int);
4104 extern void delete_keyboard_wait_descriptor (int);
4106 extern void add_gpm_wait_descriptor (int);
4107 extern void delete_gpm_wait_descriptor (int);
4109 extern void init_process_emacs (int);
4110 extern void syms_of_process (void);
4111 extern void setup_process_coding_systems (Lisp_Object
);
4113 /* Defined in callproc.c. */
4115 # define CHILD_SETUP_TYPE _Noreturn void
4117 # define CHILD_SETUP_TYPE int
4119 extern CHILD_SETUP_TYPE
child_setup (int, int, int, char **, bool, Lisp_Object
);
4120 extern void init_callproc_1 (void);
4121 extern void init_callproc (void);
4122 extern void set_initial_environment (void);
4123 extern void syms_of_callproc (void);
4125 /* Defined in doc.c. */
4126 enum text_quoting_style
4128 /* Use curved single quotes ‘like this’. */
4129 CURVE_QUOTING_STYLE
,
4131 /* Use grave accent and apostrophe `like this'. */
4132 GRAVE_QUOTING_STYLE
,
4134 /* Use apostrophes 'like this'. */
4135 STRAIGHT_QUOTING_STYLE
4137 extern enum text_quoting_style
text_quoting_style (void);
4138 extern Lisp_Object
read_doc_string (Lisp_Object
);
4139 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4140 extern void syms_of_doc (void);
4141 extern int read_bytecode_char (bool);
4143 /* Defined in bytecode.c. */
4144 extern void syms_of_bytecode (void);
4145 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4146 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4147 extern Lisp_Object
get_byte_code_arity (Lisp_Object
);
4149 /* Defined in macros.c. */
4150 extern void init_macros (void);
4151 extern void syms_of_macros (void);
4153 /* Defined in undo.c. */
4154 extern void truncate_undo_list (struct buffer
*);
4155 extern void record_insert (ptrdiff_t, ptrdiff_t);
4156 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4157 extern void record_first_change (void);
4158 extern void record_change (ptrdiff_t, ptrdiff_t);
4159 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4160 Lisp_Object
, Lisp_Object
,
4162 extern void syms_of_undo (void);
4164 /* Defined in textprop.c. */
4165 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4167 /* Defined in menu.c. */
4168 extern void syms_of_menu (void);
4170 /* Defined in xmenu.c. */
4171 extern void syms_of_xmenu (void);
4173 /* Defined in termchar.h. */
4174 struct tty_display_info
;
4176 /* Defined in sysdep.c. */
4177 #ifdef HAVE_PERSONALITY_ADDR_NO_RANDOMIZE
4178 extern bool disable_address_randomization (void);
4180 INLINE
bool disable_address_randomization (void) { return false; }
4182 extern int emacs_exec_file (char const *, char *const *, char *const *);
4183 extern void init_standard_fds (void);
4184 extern char *emacs_get_current_dir_name (void);
4185 extern void stuff_char (char c
);
4186 extern void init_foreground_group (void);
4187 extern void sys_subshell (void);
4188 extern void sys_suspend (void);
4189 extern void discard_tty_input (void);
4190 extern void init_sys_modes (struct tty_display_info
*);
4191 extern void reset_sys_modes (struct tty_display_info
*);
4192 extern void init_all_sys_modes (void);
4193 extern void reset_all_sys_modes (void);
4194 extern void child_setup_tty (int);
4195 extern void setup_pty (int);
4196 extern int set_window_size (int, int, int);
4197 extern EMACS_INT
get_random (void);
4198 extern void seed_random (void *, ptrdiff_t);
4199 extern void init_random (void);
4200 extern void emacs_backtrace (int);
4201 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4202 extern int emacs_open (const char *, int, int);
4203 extern int emacs_pipe (int[2]);
4204 extern int emacs_close (int);
4205 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4206 extern ptrdiff_t emacs_read_quit (int, void *, ptrdiff_t);
4207 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4208 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4209 extern ptrdiff_t emacs_write_quit (int, void const *, ptrdiff_t);
4210 extern void emacs_perror (char const *);
4212 extern void unlock_all_files (void);
4213 extern void lock_file (Lisp_Object
);
4214 extern void unlock_file (Lisp_Object
);
4215 extern void unlock_buffer (struct buffer
*);
4216 extern void syms_of_filelock (void);
4217 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4219 /* Defined in sound.c. */
4220 extern void syms_of_sound (void);
4222 /* Defined in category.c. */
4223 extern void init_category_once (void);
4224 extern Lisp_Object
char_category_set (int);
4225 extern void syms_of_category (void);
4227 /* Defined in ccl.c. */
4228 extern void syms_of_ccl (void);
4230 /* Defined in dired.c. */
4231 extern void syms_of_dired (void);
4232 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4233 Lisp_Object
, Lisp_Object
,
4236 /* Defined in term.c. */
4237 extern int *char_ins_del_vector
;
4238 extern void syms_of_term (void);
4239 extern _Noreturn
void fatal (const char *msgid
, ...)
4240 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4242 /* Defined in terminal.c. */
4243 extern void syms_of_terminal (void);
4245 /* Defined in font.c. */
4246 extern void syms_of_font (void);
4247 extern void init_font (void);
4249 #ifdef HAVE_WINDOW_SYSTEM
4250 /* Defined in fontset.c. */
4251 extern void syms_of_fontset (void);
4254 /* Defined in inotify.c */
4256 extern void syms_of_inotify (void);
4259 /* Defined in kqueue.c */
4261 extern void globals_of_kqueue (void);
4262 extern void syms_of_kqueue (void);
4265 /* Defined in gfilenotify.c */
4266 #ifdef HAVE_GFILENOTIFY
4267 extern void globals_of_gfilenotify (void);
4268 extern void syms_of_gfilenotify (void);
4271 #ifdef HAVE_W32NOTIFY
4272 /* Defined on w32notify.c. */
4273 extern void syms_of_w32notify (void);
4276 /* Defined in xfaces.c. */
4277 extern Lisp_Object Vface_alternative_font_family_alist
;
4278 extern Lisp_Object Vface_alternative_font_registry_alist
;
4279 extern void syms_of_xfaces (void);
4281 #ifdef HAVE_X_WINDOWS
4282 /* Defined in xfns.c. */
4283 extern void syms_of_xfns (void);
4285 /* Defined in xsmfns.c. */
4286 extern void syms_of_xsmfns (void);
4288 /* Defined in xselect.c. */
4289 extern void syms_of_xselect (void);
4291 /* Defined in xterm.c. */
4292 extern void init_xterm (void);
4293 extern void syms_of_xterm (void);
4294 #endif /* HAVE_X_WINDOWS */
4296 #ifdef HAVE_WINDOW_SYSTEM
4297 /* Defined in xterm.c, nsterm.m, w32term.c. */
4298 extern char *x_get_keysym_name (int);
4299 #endif /* HAVE_WINDOW_SYSTEM */
4302 /* Defined in xml.c. */
4303 extern void syms_of_xml (void);
4304 extern void xml_cleanup_parser (void);
4308 /* Defined in decompress.c. */
4309 extern void syms_of_decompress (void);
4313 /* Defined in dbusbind.c. */
4314 void init_dbusbind (void);
4315 void syms_of_dbusbind (void);
4319 /* Defined in profiler.c. */
4320 extern bool profiler_memory_running
;
4321 extern void malloc_probe (size_t);
4322 extern void syms_of_profiler (void);
4326 /* Defined in msdos.c, w32.c. */
4327 extern char *emacs_root_dir (void);
4330 /* Defined in lastfile.c. */
4331 extern char my_edata
[];
4332 extern char my_endbss
[];
4333 extern char *my_endbss_static
;
4335 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4336 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4337 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4338 extern void xfree (void *);
4339 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4340 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4341 ATTRIBUTE_ALLOC_SIZE ((2,3));
4342 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4344 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4345 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4346 extern void dupstring (char **, char const *);
4348 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4349 null byte. This is like stpcpy, except the source is a Lisp string. */
4352 lispstpcpy (char *dest
, Lisp_Object string
)
4354 ptrdiff_t len
= SBYTES (string
);
4355 memcpy (dest
, SDATA (string
), len
+ 1);
4359 extern void xputenv (const char *);
4361 extern char *egetenv_internal (const char *, ptrdiff_t);
4364 egetenv (const char *var
)
4366 /* When VAR is a string literal, strlen can be optimized away. */
4367 return egetenv_internal (var
, strlen (var
));
4370 /* Set up the name of the machine we're running on. */
4371 extern void init_system_name (void);
4373 /* Return the absolute value of X. X should be a signed integer
4374 expression without side effects, and X's absolute value should not
4375 exceed the maximum for its promoted type. This is called 'eabs'
4376 because 'abs' is reserved by the C standard. */
4377 #define eabs(x) ((x) < 0 ? -(x) : (x))
4379 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4382 #define make_fixnum_or_float(val) \
4383 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4385 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4386 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4388 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4390 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4392 #define USE_SAFE_ALLOCA \
4393 ptrdiff_t sa_avail = MAX_ALLOCA; \
4394 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4396 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4398 /* SAFE_ALLOCA allocates a simple buffer. */
4400 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4401 ? AVAIL_ALLOCA (size) \
4402 : (sa_must_free = true, record_xmalloc (size)))
4404 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4405 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4406 positive. The code is tuned for MULTIPLIER being a constant. */
4408 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4410 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4411 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4414 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4415 sa_must_free = true; \
4416 record_unwind_protect_ptr (xfree, buf); \
4420 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4422 #define SAFE_ALLOCA_STRING(ptr, string) \
4424 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4425 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4428 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4430 #define SAFE_FREE() \
4432 if (sa_must_free) { \
4433 sa_must_free = false; \
4434 unbind_to (sa_count, Qnil); \
4438 /* Set BUF to point to an allocated array of NELT Lisp_Objects,
4439 immediately followed by EXTRA spare bytes. */
4441 #define SAFE_ALLOCA_LISP_EXTRA(buf, nelt, extra) \
4443 ptrdiff_t alloca_nbytes; \
4444 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4445 || INT_ADD_WRAPV (alloca_nbytes, extra, &alloca_nbytes) \
4446 || SIZE_MAX < alloca_nbytes) \
4447 memory_full (SIZE_MAX); \
4448 else if (alloca_nbytes <= sa_avail) \
4449 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4453 (buf) = xmalloc (alloca_nbytes); \
4454 arg_ = make_save_memory (buf, nelt); \
4455 sa_must_free = true; \
4456 record_unwind_protect (free_save_value, arg_); \
4460 /* Set BUF to point to an allocated array of NELT Lisp_Objects. */
4462 #define SAFE_ALLOCA_LISP(buf, nelt) SAFE_ALLOCA_LISP_EXTRA (buf, nelt, 0)
4465 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4466 block-scoped conses and strings. These objects are not
4467 managed by the garbage collector, so they are dangerous: passing them
4468 out of their scope (e.g., to user code) results in undefined behavior.
4469 Conversely, they have better performance because GC is not involved.
4471 This feature is experimental and requires careful debugging.
4472 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4474 #if (!defined USE_STACK_LISP_OBJECTS \
4475 && defined __GNUC__ && !defined __clang__ && ! GNUC_PREREQ (4, 3, 2))
4476 /* Work around GCC bugs 36584 and 35271, which were fixed in GCC 4.3.2. */
4477 # define USE_STACK_LISP_OBJECTS false
4479 #ifndef USE_STACK_LISP_OBJECTS
4480 # define USE_STACK_LISP_OBJECTS true
4483 #ifdef GC_CHECK_STRING_BYTES
4484 enum { defined_GC_CHECK_STRING_BYTES
= true };
4486 enum { defined_GC_CHECK_STRING_BYTES
= false };
4489 /* Struct inside unions that are typically no larger and aligned enough. */
4494 double d
; intmax_t i
; void *p
;
4497 union Aligned_String
4499 struct Lisp_String s
;
4500 double d
; intmax_t i
; void *p
;
4503 /* True for stack-based cons and string implementations, respectively.
4504 Use stack-based strings only if stack-based cons also works.
4505 Otherwise, STACK_CONS would create heap-based cons cells that
4506 could point to stack-based strings, which is a no-no. */
4510 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4511 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4512 USE_STACK_STRING
= (USE_STACK_CONS
4513 && !defined_GC_CHECK_STRING_BYTES
4514 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4517 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4518 use these only in macros like AUTO_CONS that declare a local
4519 variable whose lifetime will be clear to the programmer. */
4520 #define STACK_CONS(a, b) \
4521 make_lisp_ptr (&((union Aligned_Cons) { { a, { b } } }).s, Lisp_Cons)
4522 #define AUTO_CONS_EXPR(a, b) \
4523 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4525 /* Declare NAME as an auto Lisp cons or short list if possible, a
4526 GC-based one otherwise. This is in the sense of the C keyword
4527 'auto'; i.e., the object has the lifetime of the containing block.
4528 The resulting object should not be made visible to user Lisp code. */
4530 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4531 #define AUTO_LIST1(name, a) \
4532 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4533 #define AUTO_LIST2(name, a, b) \
4534 Lisp_Object name = (USE_STACK_CONS \
4535 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4537 #define AUTO_LIST3(name, a, b, c) \
4538 Lisp_Object name = (USE_STACK_CONS \
4539 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4541 #define AUTO_LIST4(name, a, b, c, d) \
4544 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4545 STACK_CONS (d, Qnil)))) \
4546 : list4 (a, b, c, d))
4548 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4549 Take its unibyte value from the null-terminated string STR,
4550 an expression that should not have side effects.
4551 STR's value is not necessarily copied. The resulting Lisp string
4552 should not be modified or made visible to user code. */
4554 #define AUTO_STRING(name, str) \
4555 AUTO_STRING_WITH_LEN (name, str, strlen (str))
4557 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4558 Take its unibyte value from the null-terminated string STR with length LEN.
4559 STR may have side effects and may contain null bytes.
4560 STR's value is not necessarily copied. The resulting Lisp string
4561 should not be modified or made visible to user code. */
4563 #define AUTO_STRING_WITH_LEN(name, str, len) \
4564 Lisp_Object name = \
4567 ((&((union Aligned_String) {{len, -1, 0, (unsigned char *) (str)}}).s), \
4569 : make_unibyte_string (str, len))
4571 /* Loop over conses of the list TAIL, signaling if a cycle is found,
4572 and possibly quitting after each loop iteration. In the loop body,
4573 set TAIL to the current cons. If the loop exits normally,
4574 set TAIL to the terminating non-cons, typically nil. The loop body
4575 should not modify the list’s top level structure other than by
4576 perhaps deleting the current cons. */
4578 #define FOR_EACH_TAIL(tail) \
4579 FOR_EACH_TAIL_INTERNAL (tail, circular_list (tail), true)
4581 /* Like FOR_EACH_TAIL (LIST), except do not signal or quit.
4582 If the loop exits due to a cycle, TAIL’s value is undefined. */
4584 #define FOR_EACH_TAIL_SAFE(tail) \
4585 FOR_EACH_TAIL_INTERNAL (tail, (void) ((tail) = Qnil), false)
4587 /* Iterator intended for use only within FOR_EACH_TAIL_INTERNAL. */
4588 struct for_each_tail_internal
4590 Lisp_Object tortoise
;
4592 unsigned short int q
;
4595 /* Like FOR_EACH_TAIL (LIST), except evaluate CYCLE if a cycle is
4596 found, and check for quit if CHECK_QUIT. This is an internal macro
4597 intended for use only by the above macros.
4599 Use Brent’s teleporting tortoise-hare algorithm. See:
4600 Brent RP. BIT. 1980;20(2):176-84. doi:10.1007/BF01933190
4601 http://maths-people.anu.edu.au/~brent/pd/rpb051i.pdf
4603 This macro uses maybe_quit because of an excess of caution. The
4604 call to maybe_quit should not be needed in practice, as a very long
4605 list, whether circular or not, will cause Emacs to be so slow in
4606 other uninterruptible areas (e.g., garbage collection) that there
4607 is little point to calling maybe_quit here. */
4609 #define FOR_EACH_TAIL_INTERNAL(tail, cycle, check_quit) \
4610 for (struct for_each_tail_internal li = { tail, 2, 0, 2 }; \
4612 ((tail) = XCDR (tail), \
4614 || ((check_quit) ? maybe_quit () : (void) 0, 0 < --li.n) \
4615 || (li.q = li.n = li.max <<= 1, li.n >>= USHRT_WIDTH, \
4616 li.tortoise = (tail), false)) \
4617 && EQ (tail, li.tortoise)) \
4618 ? (cycle) : (void) 0))
4620 /* Do a `for' loop over alist values. */
4622 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4623 for ((list_var) = (head_var); \
4624 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4625 (list_var) = XCDR (list_var))
4627 /* Check whether it's time for GC, and run it if so. */
4632 if ((consing_since_gc
> gc_cons_threshold
4633 && consing_since_gc
> gc_relative_threshold
)
4634 || (!NILP (Vmemory_full
)
4635 && consing_since_gc
> memory_full_cons_threshold
))
4636 Fgarbage_collect ();
4641 #endif /* EMACS_LISP_H */