1 /* Fundamental definitions for GNU Emacs Lisp interpreter. -*- coding: utf-8 -*-
3 Copyright (C) 1985-1987, 1993-1995, 1997-2016 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 #include "systhread.h"
41 /* Define a TYPE constant ID as an externally visible name. Use like this:
43 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
44 # define ID (some integer preprocessor expression of type TYPE)
45 DEFINE_GDB_SYMBOL_END (ID)
47 This hack is for the benefit of compilers that do not make macro
48 definitions or enums visible to the debugger. It's used for symbols
49 that .gdbinit needs. */
51 #define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
53 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
54 # define DEFINE_GDB_SYMBOL_END(id) = id;
56 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
57 # define DEFINE_GDB_SYMBOL_END(val) ;
60 /* The ubiquitous max and min macros. */
63 #define max(a, b) ((a) > (b) ? (a) : (b))
64 #define min(a, b) ((a) < (b) ? (a) : (b))
66 /* Number of elements in an array. */
67 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
69 /* Number of bits in a Lisp_Object tag. */
70 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
72 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
74 /* EMACS_INT - signed integer wide enough to hold an Emacs value
75 EMACS_INT_WIDTH - width in bits of EMACS_INT
76 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
77 pI - printf length modifier for EMACS_INT
78 EMACS_UINT - unsigned variant of EMACS_INT */
81 # error "INTPTR_MAX misconfigured"
82 # elif INTPTR_MAX <= INT_MAX && !defined WIDE_EMACS_INT
83 typedef int EMACS_INT
;
84 typedef unsigned int EMACS_UINT
;
85 enum { EMACS_INT_WIDTH
= INT_WIDTH
};
86 # define EMACS_INT_MAX INT_MAX
88 # elif INTPTR_MAX <= LONG_MAX && !defined WIDE_EMACS_INT
89 typedef long int EMACS_INT
;
90 typedef unsigned long EMACS_UINT
;
91 enum { EMACS_INT_WIDTH
= LONG_WIDTH
};
92 # define EMACS_INT_MAX LONG_MAX
94 # elif INTPTR_MAX <= LLONG_MAX
95 typedef long long int EMACS_INT
;
96 typedef unsigned long long int EMACS_UINT
;
97 enum { EMACS_INT_WIDTH
= LLONG_WIDTH
};
98 # define EMACS_INT_MAX LLONG_MAX
105 # error "INTPTR_MAX too large"
109 /* Number of bits to put in each character in the internal representation
110 of bool vectors. This should not vary across implementations. */
111 enum { BOOL_VECTOR_BITS_PER_CHAR
=
112 #define BOOL_VECTOR_BITS_PER_CHAR 8
113 BOOL_VECTOR_BITS_PER_CHAR
116 /* An unsigned integer type representing a fixed-length bit sequence,
117 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
118 for speed, but on weird platforms it is unsigned char and not all
119 its bits are used. */
120 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
121 typedef size_t bits_word
;
122 # define BITS_WORD_MAX SIZE_MAX
123 enum { BITS_PER_BITS_WORD
= SIZE_WIDTH
};
125 typedef unsigned char bits_word
;
126 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
127 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
129 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
131 /* printmax_t and uprintmax_t are types for printing large integers.
132 These are the widest integers that are supported for printing.
133 pMd etc. are conversions for printing them.
134 On C99 hosts, there's no problem, as even the widest integers work.
135 Fall back on EMACS_INT on pre-C99 hosts. */
137 typedef intmax_t printmax_t
;
138 typedef uintmax_t uprintmax_t
;
142 typedef EMACS_INT printmax_t
;
143 typedef EMACS_UINT uprintmax_t
;
148 /* Use pD to format ptrdiff_t values, which suffice for indexes into
149 buffers and strings. Emacs never allocates objects larger than
150 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
151 In C99, pD can always be "t"; configure it here for the sake of
152 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
153 #if PTRDIFF_MAX == INT_MAX
155 #elif PTRDIFF_MAX == LONG_MAX
157 #elif PTRDIFF_MAX == LLONG_MAX
163 /* Extra internal type checking? */
165 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
166 'assume (COND)'. COND should be free of side effects, as it may or
167 may not be evaluated.
169 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
170 defined and suppress_checking is false, and does nothing otherwise.
171 Emacs dies if COND is checked and is false. The suppress_checking
172 variable is initialized to 0 in alloc.c. Set it to 1 using a
173 debugger to temporarily disable aborting on detected internal
174 inconsistencies or error conditions.
176 In some cases, a good compiler may be able to optimize away the
177 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
178 uses eassert to test STRINGP (x), but a particular use of XSTRING
179 is invoked only after testing that STRINGP (x) is true, making the
182 eassume is like eassert except that it also causes the compiler to
183 assume that COND is true afterwards, regardless of whether runtime
184 checking is enabled. This can improve performance in some cases,
185 though it can degrade performance in others. It's often suboptimal
186 for COND to call external functions or access volatile storage. */
188 #ifndef ENABLE_CHECKING
189 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
190 # define eassume(cond) assume (cond)
191 #else /* ENABLE_CHECKING */
193 extern _Noreturn
void die (const char *, const char *, int);
195 extern bool suppress_checking EXTERNALLY_VISIBLE
;
197 # define eassert(cond) \
198 (suppress_checking || (cond) \
200 : die (# cond, __FILE__, __LINE__))
201 # define eassume(cond) \
206 : die (# cond, __FILE__, __LINE__))
207 #endif /* ENABLE_CHECKING */
210 /* Use the configure flag --enable-check-lisp-object-type to make
211 Lisp_Object use a struct type instead of the default int. The flag
212 causes CHECK_LISP_OBJECT_TYPE to be defined. */
214 /***** Select the tagging scheme. *****/
215 /* The following option controls the tagging scheme:
216 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
217 always 0, and we can thus use them to hold tag bits, without
218 restricting our addressing space.
220 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
221 restricting our possible address range.
223 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
224 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
225 on the few static Lisp_Objects used: lispsym, all the defsubr, and
226 the two special buffers buffer_defaults and buffer_local_symbols. */
230 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
231 integer constant, for MSVC. */
232 #define GCALIGNMENT 8
234 /* Number of bits in a Lisp_Object value, not counting the tag. */
235 VALBITS
= EMACS_INT_WIDTH
- GCTYPEBITS
,
237 /* Number of bits in a Lisp fixnum tag. */
238 INTTYPEBITS
= GCTYPEBITS
- 1,
240 /* Number of bits in a Lisp fixnum value, not counting the tag. */
241 FIXNUM_BITS
= VALBITS
+ 1
244 #if GCALIGNMENT != 1 << GCTYPEBITS
245 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
248 /* The maximum value that can be stored in a EMACS_INT, assuming all
249 bits other than the type bits contribute to a nonnegative signed value.
250 This can be used in #if, e.g., '#if USE_LSB_TAG' below expands to an
251 expression involving VAL_MAX. */
252 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
254 /* Whether the least-significant bits of an EMACS_INT contain the tag.
255 On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
256 a. unnecessary, because the top bits of an EMACS_INT are unused, and
257 b. slower, because it typically requires extra masking.
258 So, USE_LSB_TAG is true only on hosts where it might be useful. */
259 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
260 #define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
261 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
263 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
264 # error "USE_LSB_TAG not supported on this platform; please report this." \
265 "Try 'configure --with-wide-int' to work around the problem."
269 #ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
270 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
272 # define GCALIGNED /* empty */
275 /* Some operations are so commonly executed that they are implemented
276 as macros, not functions, because otherwise runtime performance would
277 suffer too much when compiling with GCC without optimization.
278 There's no need to inline everything, just the operations that
279 would otherwise cause a serious performance problem.
281 For each such operation OP, define a macro lisp_h_OP that contains
282 the operation's implementation. That way, OP can be implemented
283 via a macro definition like this:
285 #define OP(x) lisp_h_OP (x)
287 and/or via a function definition like this:
289 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
291 without worrying about the implementations diverging, since
292 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
293 are intended to be private to this include file, and should not be
296 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
297 functions, once "gcc -Og" (new to GCC 4.8) works well enough for
298 Emacs developers. Maybe in the year 2020. See Bug#11935.
300 Commentary for these macros can be found near their corresponding
303 #if CHECK_LISP_OBJECT_TYPE
304 # define lisp_h_XLI(o) ((o).i)
305 # define lisp_h_XIL(i) ((Lisp_Object) { i })
307 # define lisp_h_XLI(o) (o)
308 # define lisp_h_XIL(i) (i)
310 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
311 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
312 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
313 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
314 ((ok) ? (void) 0 : wrong_type_argument (predicate, x))
315 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
316 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
317 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
318 #define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
319 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
320 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
321 #define lisp_h_NILP(x) EQ (x, Qnil)
322 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
323 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
324 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->trapped_write == SYMBOL_NOWRITE)
325 #define lisp_h_SYMBOL_TRAPPED_WRITE_P(sym) (XSYMBOL (sym)->trapped_write)
326 #define lisp_h_SYMBOL_VAL(sym) \
327 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
328 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
329 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
330 #define lisp_h_XCAR(c) XCONS (c)->car
331 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
332 #define lisp_h_XCONS(a) \
333 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
334 #define lisp_h_XHASH(a) XUINT (a)
335 #ifndef GC_CHECK_CONS_LIST
336 # define lisp_h_check_cons_list() ((void) 0)
339 # define lisp_h_make_number(n) \
340 XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
341 # define lisp_h_XFASTINT(a) XINT (a)
342 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
343 # define lisp_h_XSYMBOL(a) \
344 (eassert (SYMBOLP (a)), \
345 (struct Lisp_Symbol *) ((intptr_t) XLI (a) - Lisp_Symbol \
347 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
348 # define lisp_h_XUNTAG(a, type) \
349 __builtin_assume_aligned ((void *) (intptr_t) (XLI (a) - (type)), \
353 /* When compiling via gcc -O0, define the key operations as macros, as
354 Emacs is too slow otherwise. To disable this optimization, compile
355 with -DINLINING=false. */
356 #if (defined __NO_INLINE__ \
357 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
358 && ! (defined INLINING && ! INLINING))
359 # define DEFINE_KEY_OPS_AS_MACROS true
361 # define DEFINE_KEY_OPS_AS_MACROS false
364 #if DEFINE_KEY_OPS_AS_MACROS
365 # define XLI(o) lisp_h_XLI (o)
366 # define XIL(i) lisp_h_XIL (i)
367 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
368 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
369 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
370 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
371 # define CONSP(x) lisp_h_CONSP (x)
372 # define EQ(x, y) lisp_h_EQ (x, y)
373 # define FLOATP(x) lisp_h_FLOATP (x)
374 # define INTEGERP(x) lisp_h_INTEGERP (x)
375 # define MARKERP(x) lisp_h_MARKERP (x)
376 # define MISCP(x) lisp_h_MISCP (x)
377 # define NILP(x) lisp_h_NILP (x)
378 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
379 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
380 # define SYMBOL_TRAPPED_WRITE_P(sym) lisp_h_SYMBOL_TRAPPED_WRITE_P (sym)
381 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
382 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
383 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
384 # define XCAR(c) lisp_h_XCAR (c)
385 # define XCDR(c) lisp_h_XCDR (c)
386 # define XCONS(a) lisp_h_XCONS (a)
387 # define XHASH(a) lisp_h_XHASH (a)
388 # ifndef GC_CHECK_CONS_LIST
389 # define check_cons_list() lisp_h_check_cons_list ()
392 # define make_number(n) lisp_h_make_number (n)
393 # define XFASTINT(a) lisp_h_XFASTINT (a)
394 # define XINT(a) lisp_h_XINT (a)
395 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
396 # define XTYPE(a) lisp_h_XTYPE (a)
397 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
402 /* Define the fundamental Lisp data structures. */
404 /* This is the set of Lisp data types. If you want to define a new
405 data type, read the comments after Lisp_Fwd_Type definition
408 /* Lisp integers use 2 tags, to give them one extra bit, thus
409 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
410 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
411 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
413 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
414 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
415 vociferously about them. */
416 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
417 || (defined __SUNPRO_C && __STDC__))
418 #define ENUM_BF(TYPE) unsigned int
420 #define ENUM_BF(TYPE) enum TYPE
426 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
429 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
430 whose first member indicates the subtype. */
433 /* Integer. XINT (obj) is the integer value. */
435 Lisp_Int1
= USE_LSB_TAG
? 6 : 3,
437 /* String. XSTRING (object) points to a struct Lisp_String.
438 The length of the string, and its contents, are stored therein. */
441 /* Vector of Lisp objects, or something resembling it.
442 XVECTOR (object) points to a struct Lisp_Vector, which contains
443 the size and contents. The size field also contains the type
444 information, if it's not a real vector object. */
447 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
448 Lisp_Cons
= USE_LSB_TAG
? 3 : 6,
453 /* This is the set of data types that share a common structure.
454 The first member of the structure is a type code from this set.
455 The enum values are arbitrary, but we'll use large numbers to make it
456 more likely that we'll spot the error if a random word in memory is
457 mistakenly interpreted as a Lisp_Misc. */
460 Lisp_Misc_Free
= 0x5eab,
463 Lisp_Misc_Save_Value
,
468 /* Currently floats are not a misc type,
469 but let's define this in case we want to change that. */
471 /* This is not a type code. It is for range checking. */
475 /* These are the types of forwarding objects used in the value slot
476 of symbols for special built-in variables whose value is stored in
480 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
481 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
482 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
483 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
484 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
487 /* If you want to define a new Lisp data type, here are some
488 instructions. See the thread at
489 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
492 First, there are already a couple of Lisp types that can be used if
493 your new type does not need to be exposed to Lisp programs nor
494 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
495 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
496 is suitable for temporarily stashing away pointers and integers in
497 a Lisp object. The latter is useful for vector-like Lisp objects
498 that need to be used as part of other objects, but which are never
499 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
502 These two types don't look pretty when printed, so they are
503 unsuitable for Lisp objects that can be exposed to users.
505 To define a new data type, add one more Lisp_Misc subtype or one
506 more pseudovector subtype. Pseudovectors are more suitable for
507 objects with several slots that need to support fast random access,
508 while Lisp_Misc types are for everything else. A pseudovector object
509 provides one or more slots for Lisp objects, followed by struct
510 members that are accessible only from C. A Lisp_Misc object is a
511 wrapper for a C struct that can contain anything you like.
513 Explicit freeing is discouraged for Lisp objects in general. But if
514 you really need to exploit this, use Lisp_Misc (check free_misc in
515 alloc.c to see why). There is no way to free a vectorlike object.
517 To add a new pseudovector type, extend the pvec_type enumeration;
518 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
520 For a Lisp_Misc, you will also need to add your entry to union
521 Lisp_Misc (but make sure the first word has the same structure as
522 the others, starting with a 16-bit member of the Lisp_Misc_Type
523 enumeration and a 1-bit GC markbit) and make sure the overall size
524 of the union is not increased by your addition.
526 For a new pseudovector, it's highly desirable to limit the size
527 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
528 Otherwise you will need to change sweep_vectors (also in alloc.c).
530 Then you will need to add switch branches in print.c (in
531 print_object, to print your object, and possibly also in
532 print_preprocess) and to alloc.c, to mark your object (in
533 mark_object) and to free it (in gc_sweep). The latter is also the
534 right place to call any code specific to your data type that needs
535 to run when the object is recycled -- e.g., free any additional
536 resources allocated for it that are not Lisp objects. You can even
537 make a pointer to the function that frees the resources a slot in
538 your object -- this way, the same object could be used to represent
539 several disparate C structures. */
541 #ifdef CHECK_LISP_OBJECT_TYPE
543 typedef struct { EMACS_INT i
; } Lisp_Object
;
545 #define LISP_INITIALLY(i) {i}
547 #undef CHECK_LISP_OBJECT_TYPE
548 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
549 #else /* CHECK_LISP_OBJECT_TYPE */
551 /* If a struct type is not wanted, define Lisp_Object as just a number. */
553 typedef EMACS_INT Lisp_Object
;
554 #define LISP_INITIALLY(i) (i)
555 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
556 #endif /* CHECK_LISP_OBJECT_TYPE */
558 /* Forward declarations. */
560 /* Defined in this file. */
562 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
563 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
564 INLINE
bool BUFFERP (Lisp_Object
);
565 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
566 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
567 INLINE
bool (CONSP
) (Lisp_Object
);
568 INLINE
bool (FLOATP
) (Lisp_Object
);
569 INLINE
bool (INTEGERP
) (Lisp_Object
);
570 INLINE
bool (MARKERP
) (Lisp_Object
);
571 INLINE
bool (MISCP
) (Lisp_Object
);
572 INLINE
bool (NILP
) (Lisp_Object
);
573 INLINE
bool OVERLAYP (Lisp_Object
);
574 INLINE
bool PROCESSP (Lisp_Object
);
575 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
576 INLINE
bool SAVE_VALUEP (Lisp_Object
);
577 INLINE
bool FINALIZERP (Lisp_Object
);
580 INLINE
bool USER_PTRP (Lisp_Object
);
581 INLINE
struct Lisp_User_Ptr
*(XUSER_PTR
) (Lisp_Object
);
584 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
586 INLINE
bool STRINGP (Lisp_Object
);
587 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
588 INLINE
bool SUBRP (Lisp_Object
);
589 INLINE
bool (SYMBOLP
) (Lisp_Object
);
590 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
591 INLINE
bool WINDOWP (Lisp_Object
);
592 INLINE
bool TERMINALP (Lisp_Object
);
593 INLINE
bool THREADP (Lisp_Object
);
594 INLINE
bool MUTEXP (Lisp_Object
);
595 INLINE
bool CONDVARP (Lisp_Object
);
596 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
597 INLINE
struct Lisp_Finalizer
*XFINALIZER (Lisp_Object
);
598 INLINE
struct Lisp_Symbol
*(XSYMBOL
) (Lisp_Object
);
599 INLINE
void *(XUNTAG
) (Lisp_Object
, int);
601 /* Defined in chartab.c. */
602 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
603 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
605 /* Defined in data.c. */
606 extern _Noreturn
void wrong_type_argument (Lisp_Object
, Lisp_Object
);
607 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
608 extern void notify_variable_watchers (Lisp_Object symbol
, Lisp_Object newval
,
609 Lisp_Object operation
, Lisp_Object where
);
613 enum { might_dump
= false };
614 #elif defined DOUG_LEA_MALLOC
615 /* Defined in emacs.c. */
616 extern bool might_dump
;
618 /* True means Emacs has already been initialized.
619 Used during startup to detect startup of dumped Emacs. */
620 extern bool initialized
;
622 /* Defined in floatfns.c. */
623 extern double extract_float (Lisp_Object
);
626 /* Interned state of a symbol. */
630 SYMBOL_UNINTERNED
= 0,
632 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
639 SYMBOL_LOCALIZED
= 2,
643 enum symbol_trapped_write
645 SYMBOL_UNTRAPPED_WRITE
= 0,
647 SYMBOL_TRAPPED_WRITE
= 2
652 bool_bf gcmarkbit
: 1;
654 /* Indicates where the value can be found:
655 0 : it's a plain var, the value is in the `value' field.
656 1 : it's a varalias, the value is really in the `alias' symbol.
657 2 : it's a localized var, the value is in the `blv' object.
658 3 : it's a forwarding variable, the value is in `forward'. */
659 ENUM_BF (symbol_redirect
) redirect
: 3;
661 /* 0 : normal case, just set the value
662 1 : constant, cannot set, e.g. nil, t, :keywords.
663 2 : trap the write, call watcher functions. */
664 ENUM_BF (symbol_trapped_write
) trapped_write
: 2;
666 /* Interned state of the symbol. This is an enumerator from
667 enum symbol_interned. */
668 unsigned interned
: 2;
670 /* True means that this variable has been explicitly declared
671 special (with `defvar' etc), and shouldn't be lexically bound. */
672 bool_bf declared_special
: 1;
674 /* True if pointed to from purespace and hence can't be GC'd. */
677 /* The symbol's name, as a Lisp string. */
680 /* Value of the symbol or Qunbound if unbound. Which alternative of the
681 union is used depends on the `redirect' field above. */
684 struct Lisp_Symbol
*alias
;
685 struct Lisp_Buffer_Local_Value
*blv
;
689 /* Function value of the symbol or Qnil if not fboundp. */
690 Lisp_Object function
;
692 /* The symbol's property list. */
695 /* Next symbol in obarray bucket, if the symbol is interned. */
696 struct Lisp_Symbol
*next
;
699 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
700 meaning as in the DEFUN macro, and is used to construct a prototype. */
701 /* We can use the same trick as in the DEFUN macro to generate the
702 appropriate prototype. */
703 #define EXFUN(fnname, maxargs) \
704 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
706 /* Note that the weird token-substitution semantics of ANSI C makes
707 this work for MANY and UNEVALLED. */
708 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
709 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
710 #define DEFUN_ARGS_0 (void)
711 #define DEFUN_ARGS_1 (Lisp_Object)
712 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
713 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
714 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
715 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
717 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
718 Lisp_Object, Lisp_Object)
719 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
720 Lisp_Object, Lisp_Object, Lisp_Object)
721 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
722 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
724 /* Yield a signed integer that contains TAG along with PTR.
726 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
727 and zero-extend otherwise (that’s a bit faster here).
728 Sign extension matters only when EMACS_INT is wider than a pointer. */
729 #define TAG_PTR(tag, ptr) \
731 ? (intptr_t) (ptr) + (tag) \
732 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
734 /* Yield an integer that contains a symbol tag along with OFFSET.
735 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
736 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
738 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
739 XLI (builtin_lisp_symbol (Qwhatever)),
740 except the former expands to an integer constant expression. */
741 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
743 /* LISPSYM_INITIALLY (Qfoo) is equivalent to Qfoo except it is
744 designed for use as an initializer, even for a constant initializer. */
745 #define LISPSYM_INITIALLY(name) LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name))
747 /* Declare extern constants for Lisp symbols. These can be helpful
748 when using a debugger like GDB, on older platforms where the debug
749 format does not represent C macros. */
750 #define DEFINE_LISP_SYMBOL(name) \
751 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
752 DEFINE_GDB_SYMBOL_END (LISPSYM_INITIALLY (name))
754 /* By default, define macros for Qt, etc., as this leads to a bit
755 better performance in the core Emacs interpreter. A plugin can
756 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
757 other Emacs instances that assign different values to Qt, etc. */
758 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
759 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
764 /* Header of vector-like objects. This documents the layout constraints on
765 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
766 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
767 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
768 because when two such pointers potentially alias, a compiler won't
769 incorrectly reorder loads and stores to their size fields. See
771 struct vectorlike_header
773 /* The only field contains various pieces of information:
774 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
775 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
776 vector (0) or a pseudovector (1).
777 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
778 of slots) of the vector.
779 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
780 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
781 - b) number of Lisp_Objects slots at the beginning of the object
782 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
784 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
785 measured in word_size units. Rest fields may also include
786 Lisp_Objects, but these objects usually needs some special treatment
788 There are some exceptions. For PVEC_FREE, b) is always zero. For
789 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
790 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
791 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
797 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
798 At the machine level, these operations are no-ops. */
801 (XLI
) (Lisp_Object o
)
803 return lisp_h_XLI (o
);
809 return lisp_h_XIL (i
);
812 /* In the size word of a vector, this bit means the vector has been marked. */
814 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
815 # define ARRAY_MARK_FLAG PTRDIFF_MIN
816 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
818 /* In the size word of a struct Lisp_Vector, this bit means it's really
819 some other vector-like object. */
820 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
821 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
822 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
824 /* In a pseudovector, the size field actually contains a word with one
825 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
826 with PVEC_TYPE_MASK to indicate the actual type. */
838 PVEC_WINDOW_CONFIGURATION
,
847 /* These should be last, check internal_equal to see why. */
851 PVEC_FONT
/* Should be last because it's used for range checking. */
856 /* For convenience, we also store the number of elements in these bits.
857 Note that this size is not necessarily the memory-footprint size, but
858 only the number of Lisp_Object fields (that need to be traced by GC).
859 The distinction is used, e.g., by Lisp_Process, which places extra
860 non-Lisp_Object fields at the end of the structure. */
861 PSEUDOVECTOR_SIZE_BITS
= 12,
862 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
864 /* To calculate the memory footprint of the pseudovector, it's useful
865 to store the size of non-Lisp area in word_size units here. */
866 PSEUDOVECTOR_REST_BITS
= 12,
867 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
868 << PSEUDOVECTOR_SIZE_BITS
),
870 /* Used to extract pseudovector subtype information. */
871 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
872 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
875 /* These functions extract various sorts of values from a Lisp_Object.
876 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
877 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
880 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
881 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
882 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
883 DEFINE_GDB_SYMBOL_END (VALMASK
)
885 /* Largest and smallest representable fixnum values. These are the C
886 values. They are macros for use in static initializers. */
887 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
888 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
893 (make_number
) (EMACS_INT n
)
895 return lisp_h_make_number (n
);
899 (XINT
) (Lisp_Object a
)
901 return lisp_h_XINT (a
);
905 (XFASTINT
) (Lisp_Object a
)
907 EMACS_INT n
= lisp_h_XFASTINT (a
);
912 INLINE
struct Lisp_Symbol
*
913 (XSYMBOL
) (Lisp_Object a
)
915 return lisp_h_XSYMBOL (a
);
918 INLINE
enum Lisp_Type
919 (XTYPE
) (Lisp_Object a
)
921 return lisp_h_XTYPE (a
);
925 (XUNTAG
) (Lisp_Object a
, int type
)
927 return lisp_h_XUNTAG (a
, type
);
930 #else /* ! USE_LSB_TAG */
932 /* Although compiled only if ! USE_LSB_TAG, the following functions
933 also work when USE_LSB_TAG; this is to aid future maintenance when
934 the lisp_h_* macros are eventually removed. */
936 /* Make a Lisp integer representing the value of the low order
939 make_number (EMACS_INT n
)
941 EMACS_INT int0
= Lisp_Int0
;
945 n
= u
<< INTTYPEBITS
;
951 n
+= (int0
<< VALBITS
);
956 /* Extract A's value as a signed integer. */
960 EMACS_INT i
= XLI (a
);
964 i
= u
<< INTTYPEBITS
;
966 return i
>> INTTYPEBITS
;
969 /* Like XINT (A), but may be faster. A must be nonnegative.
970 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
971 integers have zero-bits in their tags. */
973 XFASTINT (Lisp_Object a
)
975 EMACS_INT int0
= Lisp_Int0
;
976 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
) - (int0
<< VALBITS
);
981 /* Extract A's type. */
982 INLINE
enum Lisp_Type
983 XTYPE (Lisp_Object a
)
985 EMACS_UINT i
= XLI (a
);
986 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
989 /* Extract A's value as a symbol. */
990 INLINE
struct Lisp_Symbol
*
991 XSYMBOL (Lisp_Object a
)
993 eassert (SYMBOLP (a
));
994 intptr_t i
= (intptr_t) XUNTAG (a
, Lisp_Symbol
);
995 void *p
= (char *) lispsym
+ i
;
999 /* Extract A's pointer value, assuming A's type is TYPE. */
1001 XUNTAG (Lisp_Object a
, int type
)
1003 intptr_t i
= USE_LSB_TAG
? XLI (a
) - type
: XLI (a
) & VALMASK
;
1007 #endif /* ! USE_LSB_TAG */
1009 /* Extract A's value as an unsigned integer. */
1011 XUINT (Lisp_Object a
)
1013 EMACS_UINT i
= XLI (a
);
1014 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
1017 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
1018 right now, but XUINT should only be applied to objects we know are
1022 (XHASH
) (Lisp_Object a
)
1024 return lisp_h_XHASH (a
);
1027 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
1029 make_natnum (EMACS_INT n
)
1031 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
1032 EMACS_INT int0
= Lisp_Int0
;
1033 return USE_LSB_TAG
? make_number (n
) : XIL (n
+ (int0
<< VALBITS
));
1036 /* Return true if X and Y are the same object. */
1039 (EQ
) (Lisp_Object x
, Lisp_Object y
)
1041 return lisp_h_EQ (x
, y
);
1044 /* Value is true if I doesn't fit into a Lisp fixnum. It is
1045 written this way so that it also works if I is of unsigned
1046 type or if I is a NaN. */
1048 #define FIXNUM_OVERFLOW_P(i) \
1049 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
1052 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
1054 return num
< lower
? lower
: num
<= upper
? num
: upper
;
1058 /* Extract a value or address from a Lisp_Object. */
1060 INLINE
struct Lisp_Cons
*
1061 (XCONS
) (Lisp_Object a
)
1063 return lisp_h_XCONS (a
);
1066 INLINE
struct Lisp_Vector
*
1067 XVECTOR (Lisp_Object a
)
1069 eassert (VECTORLIKEP (a
));
1070 return XUNTAG (a
, Lisp_Vectorlike
);
1073 INLINE
struct Lisp_String
*
1074 XSTRING (Lisp_Object a
)
1076 eassert (STRINGP (a
));
1077 return XUNTAG (a
, Lisp_String
);
1080 /* The index of the C-defined Lisp symbol SYM.
1081 This can be used in a static initializer. */
1082 #define SYMBOL_INDEX(sym) i##sym
1084 INLINE
struct Lisp_Float
*
1085 XFLOAT (Lisp_Object a
)
1087 eassert (FLOATP (a
));
1088 return XUNTAG (a
, Lisp_Float
);
1091 /* Pseudovector types. */
1093 INLINE
struct Lisp_Process
*
1094 XPROCESS (Lisp_Object a
)
1096 eassert (PROCESSP (a
));
1097 return XUNTAG (a
, Lisp_Vectorlike
);
1100 INLINE
struct window
*
1101 XWINDOW (Lisp_Object a
)
1103 eassert (WINDOWP (a
));
1104 return XUNTAG (a
, Lisp_Vectorlike
);
1107 INLINE
struct terminal
*
1108 XTERMINAL (Lisp_Object a
)
1110 eassert (TERMINALP (a
));
1111 return XUNTAG (a
, Lisp_Vectorlike
);
1114 INLINE
struct Lisp_Subr
*
1115 XSUBR (Lisp_Object a
)
1117 eassert (SUBRP (a
));
1118 return XUNTAG (a
, Lisp_Vectorlike
);
1121 INLINE
struct buffer
*
1122 XBUFFER (Lisp_Object a
)
1124 eassert (BUFFERP (a
));
1125 return XUNTAG (a
, Lisp_Vectorlike
);
1128 INLINE
struct Lisp_Char_Table
*
1129 XCHAR_TABLE (Lisp_Object a
)
1131 eassert (CHAR_TABLE_P (a
));
1132 return XUNTAG (a
, Lisp_Vectorlike
);
1135 INLINE
struct Lisp_Sub_Char_Table
*
1136 XSUB_CHAR_TABLE (Lisp_Object a
)
1138 eassert (SUB_CHAR_TABLE_P (a
));
1139 return XUNTAG (a
, Lisp_Vectorlike
);
1142 INLINE
struct Lisp_Bool_Vector
*
1143 XBOOL_VECTOR (Lisp_Object a
)
1145 eassert (BOOL_VECTOR_P (a
));
1146 return XUNTAG (a
, Lisp_Vectorlike
);
1149 INLINE
struct thread_state
*
1150 XTHREAD (Lisp_Object a
)
1152 eassert (THREADP (a
));
1153 return XUNTAG (a
, Lisp_Vectorlike
);
1156 INLINE
struct Lisp_Mutex
*
1157 XMUTEX (Lisp_Object a
)
1159 eassert (MUTEXP (a
));
1160 return XUNTAG (a
, Lisp_Vectorlike
);
1163 INLINE
struct Lisp_CondVar
*
1164 XCONDVAR (Lisp_Object a
)
1166 eassert (CONDVARP (a
));
1167 return XUNTAG (a
, Lisp_Vectorlike
);
1170 /* Construct a Lisp_Object from a value or address. */
1173 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
1175 Lisp_Object a
= XIL (TAG_PTR (type
, ptr
));
1176 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
1181 make_lisp_symbol (struct Lisp_Symbol
*sym
)
1183 Lisp_Object a
= XIL (TAG_SYMOFFSET ((char *) sym
- (char *) lispsym
));
1184 eassert (XSYMBOL (a
) == sym
);
1189 builtin_lisp_symbol (int index
)
1191 return make_lisp_symbol (lispsym
+ index
);
1194 #define XSETINT(a, b) ((a) = make_number (b))
1195 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1196 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1197 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1198 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1199 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1200 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1201 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1203 /* Pseudovector types. */
1205 #define XSETPVECTYPE(v, code) \
1206 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1207 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1208 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1209 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1210 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1213 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1214 #define XSETPSEUDOVECTOR(a, b, code) \
1215 XSETTYPED_PSEUDOVECTOR (a, b, \
1216 (((struct vectorlike_header *) \
1217 XUNTAG (a, Lisp_Vectorlike)) \
1220 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1221 (XSETVECTOR (a, b), \
1222 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1223 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1225 #define XSETWINDOW_CONFIGURATION(a, b) \
1226 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1227 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1228 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1229 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1230 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1231 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1232 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1233 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1234 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1235 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1236 #define XSETTHREAD(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_THREAD))
1237 #define XSETMUTEX(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_MUTEX))
1238 #define XSETCONDVAR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CONDVAR))
1240 /* Efficiently convert a pointer to a Lisp object and back. The
1241 pointer is represented as a Lisp integer, so the garbage collector
1242 does not know about it. The pointer should not have both Lisp_Int1
1243 bits set, which makes this conversion inherently unportable. */
1246 XINTPTR (Lisp_Object a
)
1248 return XUNTAG (a
, Lisp_Int0
);
1252 make_pointer_integer (void *p
)
1254 Lisp_Object a
= XIL (TAG_PTR (Lisp_Int0
, p
));
1255 eassert (INTEGERP (a
) && XINTPTR (a
) == p
);
1259 /* Type checking. */
1262 (CHECK_TYPE
) (int ok
, Lisp_Object predicate
, Lisp_Object x
)
1264 lisp_h_CHECK_TYPE (ok
, predicate
, x
);
1267 /* See the macros in intervals.h. */
1269 typedef struct interval
*INTERVAL
;
1271 struct GCALIGNED Lisp_Cons
1273 /* Car of this cons cell. */
1278 /* Cdr of this cons cell. */
1281 /* Used to chain conses on a free list. */
1282 struct Lisp_Cons
*chain
;
1286 /* Take the car or cdr of something known to be a cons cell. */
1287 /* The _addr functions shouldn't be used outside of the minimal set
1288 of code that has to know what a cons cell looks like. Other code not
1289 part of the basic lisp implementation should assume that the car and cdr
1290 fields are not accessible. (What if we want to switch to
1291 a copying collector someday? Cached cons cell field addresses may be
1292 invalidated at arbitrary points.) */
1293 INLINE Lisp_Object
*
1294 xcar_addr (Lisp_Object c
)
1296 return &XCONS (c
)->car
;
1298 INLINE Lisp_Object
*
1299 xcdr_addr (Lisp_Object c
)
1301 return &XCONS (c
)->u
.cdr
;
1304 /* Use these from normal code. */
1307 (XCAR
) (Lisp_Object c
)
1309 return lisp_h_XCAR (c
);
1313 (XCDR
) (Lisp_Object c
)
1315 return lisp_h_XCDR (c
);
1318 /* Use these to set the fields of a cons cell.
1320 Note that both arguments may refer to the same object, so 'n'
1321 should not be read after 'c' is first modified. */
1323 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1328 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1333 /* Take the car or cdr of something whose type is not known. */
1340 wrong_type_argument (Qlistp
, c
);
1349 wrong_type_argument (Qlistp
, c
);
1353 /* Take the car or cdr of something whose type is not known. */
1355 CAR_SAFE (Lisp_Object c
)
1357 return CONSP (c
) ? XCAR (c
) : Qnil
;
1360 CDR_SAFE (Lisp_Object c
)
1362 return CONSP (c
) ? XCDR (c
) : Qnil
;
1365 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1367 struct GCALIGNED Lisp_String
1370 ptrdiff_t size_byte
;
1371 INTERVAL intervals
; /* Text properties in this string. */
1372 unsigned char *data
;
1375 /* True if STR is a multibyte string. */
1377 STRING_MULTIBYTE (Lisp_Object str
)
1379 return 0 <= XSTRING (str
)->size_byte
;
1382 /* An upper bound on the number of bytes in a Lisp string, not
1383 counting the terminating null. This a tight enough bound to
1384 prevent integer overflow errors that would otherwise occur during
1385 string size calculations. A string cannot contain more bytes than
1386 a fixnum can represent, nor can it be so long that C pointer
1387 arithmetic stops working on the string plus its terminating null.
1388 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1389 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1390 would expose alloc.c internal details that we'd rather keep
1393 This is a macro for use in static initializers. The cast to
1394 ptrdiff_t ensures that the macro is signed. */
1395 #define STRING_BYTES_BOUND \
1396 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1398 /* Mark STR as a unibyte string. */
1399 #define STRING_SET_UNIBYTE(STR) \
1401 if (XSTRING (STR)->size == 0) \
1402 (STR) = empty_unibyte_string; \
1404 XSTRING (STR)->size_byte = -1; \
1407 /* Mark STR as a multibyte string. Assure that STR contains only
1408 ASCII characters in advance. */
1409 #define STRING_SET_MULTIBYTE(STR) \
1411 if (XSTRING (STR)->size == 0) \
1412 (STR) = empty_multibyte_string; \
1414 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1417 /* Convenience functions for dealing with Lisp strings. */
1419 INLINE
unsigned char *
1420 SDATA (Lisp_Object string
)
1422 return XSTRING (string
)->data
;
1425 SSDATA (Lisp_Object string
)
1427 /* Avoid "differ in sign" warnings. */
1428 return (char *) SDATA (string
);
1430 INLINE
unsigned char
1431 SREF (Lisp_Object string
, ptrdiff_t index
)
1433 return SDATA (string
)[index
];
1436 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1438 SDATA (string
)[index
] = new;
1441 SCHARS (Lisp_Object string
)
1443 return XSTRING (string
)->size
;
1446 #ifdef GC_CHECK_STRING_BYTES
1447 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1450 STRING_BYTES (struct Lisp_String
*s
)
1452 #ifdef GC_CHECK_STRING_BYTES
1453 return string_bytes (s
);
1455 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1460 SBYTES (Lisp_Object string
)
1462 return STRING_BYTES (XSTRING (string
));
1465 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1467 XSTRING (string
)->size
= newsize
;
1470 /* A regular vector is just a header plus an array of Lisp_Objects. */
1474 struct vectorlike_header header
;
1475 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1478 /* A boolvector is a kind of vectorlike, with contents like a string. */
1480 struct Lisp_Bool_Vector
1482 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1483 just the subtype information. */
1484 struct vectorlike_header header
;
1485 /* This is the size in bits. */
1487 /* The actual bits, packed into bytes.
1488 Zeros fill out the last word if needed.
1489 The bits are in little-endian order in the bytes, and
1490 the bytes are in little-endian order in the words. */
1491 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1495 bool_vector_size (Lisp_Object a
)
1497 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1498 eassume (0 <= size
);
1503 bool_vector_data (Lisp_Object a
)
1505 return XBOOL_VECTOR (a
)->data
;
1508 INLINE
unsigned char *
1509 bool_vector_uchar_data (Lisp_Object a
)
1511 return (unsigned char *) bool_vector_data (a
);
1514 /* The number of data words and bytes in a bool vector with SIZE bits. */
1517 bool_vector_words (EMACS_INT size
)
1519 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1520 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1524 bool_vector_bytes (EMACS_INT size
)
1526 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1527 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1530 /* True if A's Ith bit is set. */
1533 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1535 eassume (0 <= i
&& i
< bool_vector_size (a
));
1536 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1537 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1541 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1543 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1546 /* Set A's Ith bit to B. */
1549 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1551 unsigned char *addr
;
1553 eassume (0 <= i
&& i
< bool_vector_size (a
));
1554 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1557 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1559 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1562 /* Some handy constants for calculating sizes
1563 and offsets, mostly of vectorlike objects. */
1567 header_size
= offsetof (struct Lisp_Vector
, contents
),
1568 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1569 word_size
= sizeof (Lisp_Object
)
1572 /* Conveniences for dealing with Lisp arrays. */
1575 AREF (Lisp_Object array
, ptrdiff_t idx
)
1577 return XVECTOR (array
)->contents
[idx
];
1580 INLINE Lisp_Object
*
1581 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1583 return & XVECTOR (array
)->contents
[idx
];
1587 ASIZE (Lisp_Object array
)
1589 ptrdiff_t size
= XVECTOR (array
)->header
.size
;
1590 eassume (0 <= size
);
1595 gc_asize (Lisp_Object array
)
1597 /* Like ASIZE, but also can be used in the garbage collector. */
1598 return XVECTOR (array
)->header
.size
& ~ARRAY_MARK_FLAG
;
1602 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1604 eassert (0 <= idx
&& idx
< ASIZE (array
));
1605 XVECTOR (array
)->contents
[idx
] = val
;
1609 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1611 /* Like ASET, but also can be used in the garbage collector:
1612 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1613 eassert (0 <= idx
&& idx
< gc_asize (array
));
1614 XVECTOR (array
)->contents
[idx
] = val
;
1617 /* True, since Qnil's representation is zero. Every place in the code
1618 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1619 to find such assumptions later if we change Qnil to be nonzero. */
1620 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1622 /* Clear the object addressed by P, with size NBYTES, so that all its
1623 bytes are zero and all its Lisp values are nil. */
1625 memclear (void *p
, ptrdiff_t nbytes
)
1627 eassert (0 <= nbytes
);
1628 verify (NIL_IS_ZERO
);
1629 /* Since Qnil is zero, memset suffices. */
1630 memset (p
, 0, nbytes
);
1633 /* If a struct is made to look like a vector, this macro returns the length
1634 of the shortest vector that would hold that struct. */
1636 #define VECSIZE(type) \
1637 ((sizeof (type) - header_size + word_size - 1) / word_size)
1639 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1640 at the end and we need to compute the number of Lisp_Object fields (the
1641 ones that the GC needs to trace). */
1643 #define PSEUDOVECSIZE(type, nonlispfield) \
1644 ((offsetof (type, nonlispfield) - header_size) / word_size)
1646 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1647 should be integer expressions. This is not the same as
1648 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1649 returns true. For efficiency, prefer plain unsigned comparison if A
1650 and B's sizes both fit (after integer promotion). */
1651 #define UNSIGNED_CMP(a, op, b) \
1652 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1653 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1654 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1656 /* True iff C is an ASCII character. */
1657 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1659 /* A char-table is a kind of vectorlike, with contents are like a
1660 vector but with a few other slots. For some purposes, it makes
1661 sense to handle a char-table with type struct Lisp_Vector. An
1662 element of a char table can be any Lisp objects, but if it is a sub
1663 char-table, we treat it a table that contains information of a
1664 specific range of characters. A sub char-table is like a vector but
1665 with two integer fields between the header and Lisp data, which means
1666 that it has to be marked with some precautions (see mark_char_table
1667 in alloc.c). A sub char-table appears only in an element of a char-table,
1668 and there's no way to access it directly from Emacs Lisp program. */
1670 enum CHARTAB_SIZE_BITS
1672 CHARTAB_SIZE_BITS_0
= 6,
1673 CHARTAB_SIZE_BITS_1
= 4,
1674 CHARTAB_SIZE_BITS_2
= 5,
1675 CHARTAB_SIZE_BITS_3
= 7
1678 extern const int chartab_size
[4];
1680 struct Lisp_Char_Table
1682 /* HEADER.SIZE is the vector's size field, which also holds the
1683 pseudovector type information. It holds the size, too.
1684 The size counts the defalt, parent, purpose, ascii,
1685 contents, and extras slots. */
1686 struct vectorlike_header header
;
1688 /* This holds a default value,
1689 which is used whenever the value for a specific character is nil. */
1692 /* This points to another char table, which we inherit from when the
1693 value for a specific character is nil. The `defalt' slot takes
1694 precedence over this. */
1697 /* This is a symbol which says what kind of use this char-table is
1699 Lisp_Object purpose
;
1701 /* The bottom sub char-table for characters of the range 0..127. It
1702 is nil if none of ASCII character has a specific value. */
1705 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1707 /* These hold additional data. It is a vector. */
1708 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1711 struct Lisp_Sub_Char_Table
1713 /* HEADER.SIZE is the vector's size field, which also holds the
1714 pseudovector type information. It holds the size, too. */
1715 struct vectorlike_header header
;
1717 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1718 char-table of depth 1 contains 16 elements, and each element
1719 covers 4096 (128*32) characters. A sub char-table of depth 2
1720 contains 32 elements, and each element covers 128 characters. A
1721 sub char-table of depth 3 contains 128 elements, and each element
1722 is for one character. */
1725 /* Minimum character covered by the sub char-table. */
1728 /* Use set_sub_char_table_contents to set this. */
1729 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1733 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1735 struct Lisp_Char_Table
*tbl
= NULL
;
1739 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1740 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1741 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1745 while (NILP (val
) && ! NILP (tbl
->parent
));
1750 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1751 characters. Do not check validity of CT. */
1753 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1755 return (ASCII_CHAR_P (idx
)
1756 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1757 : char_table_ref (ct
, idx
));
1760 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1761 8-bit European characters. Do not check validity of CT. */
1763 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1765 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1766 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1768 char_table_set (ct
, idx
, val
);
1771 /* This structure describes a built-in function.
1772 It is generated by the DEFUN macro only.
1773 defsubr makes it into a Lisp object. */
1777 struct vectorlike_header header
;
1779 Lisp_Object (*a0
) (void);
1780 Lisp_Object (*a1
) (Lisp_Object
);
1781 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1782 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1783 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1784 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1785 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1786 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1787 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1788 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1789 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1791 short min_args
, max_args
;
1792 const char *symbol_name
;
1793 const char *intspec
;
1797 enum char_table_specials
1799 /* This is the number of slots that every char table must have. This
1800 counts the ordinary slots and the top, defalt, parent, and purpose
1802 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1804 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1805 when the latter is treated as an ordinary Lisp_Vector. */
1806 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1809 /* Return the number of "extra" slots in the char table CT. */
1812 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1814 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1815 - CHAR_TABLE_STANDARD_SLOTS
);
1818 /* Make sure that sub char-table contents slot is where we think it is. */
1819 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1820 == (offsetof (struct Lisp_Vector
, contents
)
1821 + SUB_CHAR_TABLE_OFFSET
* sizeof (Lisp_Object
)));
1823 /***********************************************************************
1825 ***********************************************************************/
1827 /* Value is name of symbol. */
1830 (SYMBOL_VAL
) (struct Lisp_Symbol
*sym
)
1832 return lisp_h_SYMBOL_VAL (sym
);
1835 INLINE
struct Lisp_Symbol
*
1836 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1838 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1839 return sym
->val
.alias
;
1841 INLINE
struct Lisp_Buffer_Local_Value
*
1842 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1844 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1845 return sym
->val
.blv
;
1847 INLINE
union Lisp_Fwd
*
1848 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1850 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1851 return sym
->val
.fwd
;
1855 (SET_SYMBOL_VAL
) (struct Lisp_Symbol
*sym
, Lisp_Object v
)
1857 lisp_h_SET_SYMBOL_VAL (sym
, v
);
1861 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1863 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1867 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1869 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1873 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1875 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1880 SYMBOL_NAME (Lisp_Object sym
)
1882 return XSYMBOL (sym
)->name
;
1885 /* Value is true if SYM is an interned symbol. */
1888 SYMBOL_INTERNED_P (Lisp_Object sym
)
1890 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1893 /* Value is true if SYM is interned in initial_obarray. */
1896 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1898 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1901 /* Value is non-zero if symbol cannot be changed through a simple set,
1902 i.e. it's a constant (e.g. nil, t, :keywords), or it has some
1903 watching functions. */
1906 (SYMBOL_TRAPPED_WRITE_P
) (Lisp_Object sym
)
1908 return lisp_h_SYMBOL_TRAPPED_WRITE_P (sym
);
1911 /* Value is non-zero if symbol cannot be changed at all, i.e. it's a
1912 constant (e.g. nil, t, :keywords). Code that actually wants to
1913 write to SYM, should also check whether there are any watching
1917 (SYMBOL_CONSTANT_P
) (Lisp_Object sym
)
1919 return lisp_h_SYMBOL_CONSTANT_P (sym
);
1922 /* Placeholder for make-docfile to process. The actual symbol
1923 definition is done by lread.c's defsym. */
1924 #define DEFSYM(sym, name) /* empty */
1927 /***********************************************************************
1929 ***********************************************************************/
1931 /* The structure of a Lisp hash table. */
1933 struct hash_table_test
1935 /* Name of the function used to compare keys. */
1938 /* User-supplied hash function, or nil. */
1939 Lisp_Object user_hash_function
;
1941 /* User-supplied key comparison function, or nil. */
1942 Lisp_Object user_cmp_function
;
1944 /* C function to compare two keys. */
1945 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1947 /* C function to compute hash code. */
1948 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1951 struct Lisp_Hash_Table
1953 /* This is for Lisp; the hash table code does not refer to it. */
1954 struct vectorlike_header header
;
1956 /* Nil if table is non-weak. Otherwise a symbol describing the
1957 weakness of the table. */
1960 /* When the table is resized, and this is an integer, compute the
1961 new size by adding this to the old size. If a float, compute the
1962 new size by multiplying the old size with this factor. */
1963 Lisp_Object rehash_size
;
1965 /* Resize hash table when number of entries/ table size is >= this
1967 Lisp_Object rehash_threshold
;
1969 /* Vector of hash codes. If hash[I] is nil, this means that the
1970 I-th entry is unused. */
1973 /* Vector used to chain entries. If entry I is free, next[I] is the
1974 entry number of the next free item. If entry I is non-free,
1975 next[I] is the index of the next entry in the collision chain. */
1978 /* Index of first free entry in free list. */
1979 Lisp_Object next_free
;
1981 /* Bucket vector. A non-nil entry is the index of the first item in
1982 a collision chain. This vector's size can be larger than the
1983 hash table size to reduce collisions. */
1986 /* Only the fields above are traced normally by the GC. The ones below
1987 `count' are special and are either ignored by the GC or traced in
1988 a special way (e.g. because of weakness). */
1990 /* Number of key/value entries in the table. */
1993 /* Vector of keys and values. The key of item I is found at index
1994 2 * I, the value is found at index 2 * I + 1.
1995 This is gc_marked specially if the table is weak. */
1996 Lisp_Object key_and_value
;
1998 /* The comparison and hash functions. */
1999 struct hash_table_test test
;
2001 /* Next weak hash table if this is a weak hash table. The head
2002 of the list is in weak_hash_tables. */
2003 struct Lisp_Hash_Table
*next_weak
;
2008 HASH_TABLE_P (Lisp_Object a
)
2010 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
2013 INLINE
struct Lisp_Hash_Table
*
2014 XHASH_TABLE (Lisp_Object a
)
2016 eassert (HASH_TABLE_P (a
));
2017 return XUNTAG (a
, Lisp_Vectorlike
);
2020 #define XSET_HASH_TABLE(VAR, PTR) \
2021 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
2023 /* Value is the key part of entry IDX in hash table H. */
2025 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2027 return AREF (h
->key_and_value
, 2 * idx
);
2030 /* Value is the value part of entry IDX in hash table H. */
2032 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2034 return AREF (h
->key_and_value
, 2 * idx
+ 1);
2037 /* Value is the index of the next entry following the one at IDX
2040 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2042 return AREF (h
->next
, idx
);
2045 /* Value is the hash code computed for entry IDX in hash table H. */
2047 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2049 return AREF (h
->hash
, idx
);
2052 /* Value is the index of the element in hash table H that is the
2053 start of the collision list at index IDX in the index vector of H. */
2055 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2057 return AREF (h
->index
, idx
);
2060 /* Value is the size of hash table H. */
2062 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
2064 return ASIZE (h
->next
);
2067 /* Default size for hash tables if not specified. */
2069 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
2071 /* Default threshold specifying when to resize a hash table. The
2072 value gives the ratio of current entries in the hash table and the
2073 size of the hash table. */
2075 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
2077 /* Default factor by which to increase the size of a hash table. */
2079 static double const DEFAULT_REHASH_SIZE
= 1.5;
2081 /* Combine two integers X and Y for hashing. The result might not fit
2082 into a Lisp integer. */
2085 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
2087 return (x
<< 4) + (x
>> (EMACS_INT_WIDTH
- 4)) + y
;
2090 /* Hash X, returning a value that fits into a fixnum. */
2093 SXHASH_REDUCE (EMACS_UINT x
)
2095 return (x
^ x
>> (EMACS_INT_WIDTH
- FIXNUM_BITS
)) & INTMASK
;
2098 /* These structures are used for various misc types. */
2100 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
2102 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
2103 bool_bf gcmarkbit
: 1;
2104 unsigned spacer
: 15;
2109 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
2110 bool_bf gcmarkbit
: 1;
2111 unsigned spacer
: 13;
2112 /* This flag is temporarily used in the functions
2113 decode/encode_coding_object to record that the marker position
2114 must be adjusted after the conversion. */
2115 bool_bf need_adjustment
: 1;
2116 /* True means normal insertion at the marker's position
2117 leaves the marker after the inserted text. */
2118 bool_bf insertion_type
: 1;
2119 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2120 Note: a chain of markers can contain markers pointing into different
2121 buffers (the chain is per buffer_text rather than per buffer, so it's
2122 shared between indirect buffers). */
2123 /* This is used for (other than NULL-checking):
2125 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2126 - unchain_marker: to find the list from which to unchain.
2127 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2129 struct buffer
*buffer
;
2131 /* The remaining fields are meaningless in a marker that
2132 does not point anywhere. */
2134 /* For markers that point somewhere,
2135 this is used to chain of all the markers in a given buffer. */
2136 /* We could remove it and use an array in buffer_text instead.
2137 That would also allow us to preserve it ordered. */
2138 struct Lisp_Marker
*next
;
2139 /* This is the char position where the marker points. */
2141 /* This is the byte position.
2142 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2143 used to implement the functionality of markers, but rather to (ab)use
2144 markers as a cache for char<->byte mappings). */
2148 /* START and END are markers in the overlay's buffer, and
2149 PLIST is the overlay's property list. */
2151 /* An overlay's real data content is:
2153 - buffer (really there are two buffer pointers, one per marker,
2154 and both points to the same buffer)
2155 - insertion type of both ends (per-marker fields)
2156 - start & start byte (of start marker)
2157 - end & end byte (of end marker)
2158 - next (singly linked list of overlays)
2159 - next fields of start and end markers (singly linked list of markers).
2160 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2163 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2164 bool_bf gcmarkbit
: 1;
2165 unsigned spacer
: 15;
2166 struct Lisp_Overlay
*next
;
2172 /* Number of bits needed to store one of the values
2173 SAVE_UNUSED..SAVE_OBJECT. */
2174 enum { SAVE_SLOT_BITS
= 3 };
2176 /* Number of slots in a save value where save_type is nonzero. */
2177 enum { SAVE_VALUE_SLOTS
= 4 };
2179 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2181 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2183 /* Types of data which may be saved in a Lisp_Save_Value. */
2192 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2193 SAVE_TYPE_INT_INT_INT
2194 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2195 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2196 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2197 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2198 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2199 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2200 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2201 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2202 SAVE_TYPE_FUNCPTR_PTR_OBJ
2203 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2205 /* This has an extra bit indicating it's raw memory. */
2206 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2209 /* SAVE_SLOT_BITS must be large enough to represent these values. */
2210 verify (((SAVE_UNUSED
| SAVE_INTEGER
| SAVE_FUNCPOINTER
2211 | SAVE_POINTER
| SAVE_OBJECT
)
2215 /* Special object used to hold a different values for later use.
2217 This is mostly used to package C integers and pointers to call
2218 record_unwind_protect when two or more values need to be saved.
2222 struct my_data *md = get_my_data ();
2223 ptrdiff_t mi = get_my_integer ();
2224 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2227 Lisp_Object my_unwind (Lisp_Object arg)
2229 struct my_data *md = XSAVE_POINTER (arg, 0);
2230 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2234 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2235 saved objects and raise eassert if type of the saved object doesn't match
2236 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2237 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2238 slot 0 is a pointer. */
2240 typedef void (*voidfuncptr
) (void);
2242 struct Lisp_Save_Value
2244 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2245 bool_bf gcmarkbit
: 1;
2246 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2248 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2249 V's data entries are determined by V->save_type. E.g., if
2250 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2251 V->data[1] is an integer, and V's other data entries are unused.
2253 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2254 a memory area containing V->data[1].integer potential Lisp_Objects. */
2255 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2258 voidfuncptr funcpointer
;
2261 } data
[SAVE_VALUE_SLOTS
];
2264 /* Return the type of V's Nth saved value. */
2266 save_type (struct Lisp_Save_Value
*v
, int n
)
2268 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2269 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2272 /* Get and set the Nth saved pointer. */
2275 XSAVE_POINTER (Lisp_Object obj
, int n
)
2277 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2278 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2281 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2283 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2284 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2287 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2289 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2290 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2293 /* Likewise for the saved integer. */
2296 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2298 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2299 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2302 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2304 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2305 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2308 /* Extract Nth saved object. */
2311 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2313 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2314 return XSAVE_VALUE (obj
)->data
[n
].object
;
2318 struct Lisp_User_Ptr
2320 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_User_Ptr */
2321 bool_bf gcmarkbit
: 1;
2322 unsigned spacer
: 15;
2324 void (*finalizer
) (void *);
2329 /* A finalizer sentinel. */
2330 struct Lisp_Finalizer
2332 struct Lisp_Misc_Any base
;
2334 /* Circular list of all active weak references. */
2335 struct Lisp_Finalizer
*prev
;
2336 struct Lisp_Finalizer
*next
;
2338 /* Call FUNCTION when the finalizer becomes unreachable, even if
2339 FUNCTION contains a reference to the finalizer; i.e., call
2340 FUNCTION when it is reachable _only_ through finalizers. */
2341 Lisp_Object function
;
2344 /* A miscellaneous object, when it's on the free list. */
2347 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2348 bool_bf gcmarkbit
: 1;
2349 unsigned spacer
: 15;
2350 union Lisp_Misc
*chain
;
2353 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2354 It uses one of these struct subtypes to get the type field. */
2358 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2359 struct Lisp_Free u_free
;
2360 struct Lisp_Marker u_marker
;
2361 struct Lisp_Overlay u_overlay
;
2362 struct Lisp_Save_Value u_save_value
;
2363 struct Lisp_Finalizer u_finalizer
;
2365 struct Lisp_User_Ptr u_user_ptr
;
2369 INLINE
union Lisp_Misc
*
2370 XMISC (Lisp_Object a
)
2372 return XUNTAG (a
, Lisp_Misc
);
2375 INLINE
struct Lisp_Misc_Any
*
2376 XMISCANY (Lisp_Object a
)
2378 eassert (MISCP (a
));
2379 return & XMISC (a
)->u_any
;
2382 INLINE
enum Lisp_Misc_Type
2383 XMISCTYPE (Lisp_Object a
)
2385 return XMISCANY (a
)->type
;
2388 INLINE
struct Lisp_Marker
*
2389 XMARKER (Lisp_Object a
)
2391 eassert (MARKERP (a
));
2392 return & XMISC (a
)->u_marker
;
2395 INLINE
struct Lisp_Overlay
*
2396 XOVERLAY (Lisp_Object a
)
2398 eassert (OVERLAYP (a
));
2399 return & XMISC (a
)->u_overlay
;
2402 INLINE
struct Lisp_Save_Value
*
2403 XSAVE_VALUE (Lisp_Object a
)
2405 eassert (SAVE_VALUEP (a
));
2406 return & XMISC (a
)->u_save_value
;
2409 INLINE
struct Lisp_Finalizer
*
2410 XFINALIZER (Lisp_Object a
)
2412 eassert (FINALIZERP (a
));
2413 return & XMISC (a
)->u_finalizer
;
2417 INLINE
struct Lisp_User_Ptr
*
2418 XUSER_PTR (Lisp_Object a
)
2420 eassert (USER_PTRP (a
));
2421 return & XMISC (a
)->u_user_ptr
;
2426 /* Forwarding pointer to an int variable.
2427 This is allowed only in the value cell of a symbol,
2428 and it means that the symbol's value really lives in the
2429 specified int variable. */
2432 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2436 /* Boolean forwarding pointer to an int variable.
2437 This is like Lisp_Intfwd except that the ostensible
2438 "value" of the symbol is t if the bool variable is true,
2439 nil if it is false. */
2442 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2446 /* Forwarding pointer to a Lisp_Object variable.
2447 This is allowed only in the value cell of a symbol,
2448 and it means that the symbol's value really lives in the
2449 specified variable. */
2452 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2453 Lisp_Object
*objvar
;
2456 /* Like Lisp_Objfwd except that value lives in a slot in the
2457 current buffer. Value is byte index of slot within buffer. */
2458 struct Lisp_Buffer_Objfwd
2460 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2462 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2463 Lisp_Object predicate
;
2466 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2467 the symbol has buffer-local or frame-local bindings. (Exception:
2468 some buffer-local variables are built-in, with their values stored
2469 in the buffer structure itself. They are handled differently,
2470 using struct Lisp_Buffer_Objfwd.)
2472 The `realvalue' slot holds the variable's current value, or a
2473 forwarding pointer to where that value is kept. This value is the
2474 one that corresponds to the loaded binding. To read or set the
2475 variable, you must first make sure the right binding is loaded;
2476 then you can access the value in (or through) `realvalue'.
2478 `buffer' and `frame' are the buffer and frame for which the loaded
2479 binding was found. If those have changed, to make sure the right
2480 binding is loaded it is necessary to find which binding goes with
2481 the current buffer and selected frame, then load it. To load it,
2482 first unload the previous binding, then copy the value of the new
2483 binding into `realvalue' (or through it). Also update
2484 LOADED-BINDING to point to the newly loaded binding.
2486 `local_if_set' indicates that merely setting the variable creates a
2487 local binding for the current buffer. Otherwise the latter, setting
2488 the variable does not do that; only make-local-variable does that. */
2490 struct Lisp_Buffer_Local_Value
2492 /* True means that merely setting the variable creates a local
2493 binding for the current buffer. */
2494 bool_bf local_if_set
: 1;
2495 /* True means this variable can have frame-local bindings, otherwise, it is
2496 can have buffer-local bindings. The two cannot be combined. */
2497 bool_bf frame_local
: 1;
2498 /* True means that the binding now loaded was found.
2499 Presumably equivalent to (defcell!=valcell). */
2501 /* If non-NULL, a forwarding to the C var where it should also be set. */
2502 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2503 /* The buffer or frame for which the loaded binding was found. */
2505 /* A cons cell that holds the default value. It has the form
2506 (SYMBOL . DEFAULT-VALUE). */
2507 Lisp_Object defcell
;
2508 /* The cons cell from `where's parameter alist.
2509 It always has the form (SYMBOL . VALUE)
2510 Note that if `forward' is non-nil, VALUE may be out of date.
2511 Also if the currently loaded binding is the default binding, then
2512 this is `eq'ual to defcell. */
2513 Lisp_Object valcell
;
2516 /* Like Lisp_Objfwd except that value lives in a slot in the
2518 struct Lisp_Kboard_Objfwd
2520 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2526 struct Lisp_Intfwd u_intfwd
;
2527 struct Lisp_Boolfwd u_boolfwd
;
2528 struct Lisp_Objfwd u_objfwd
;
2529 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2530 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2533 INLINE
enum Lisp_Fwd_Type
2534 XFWDTYPE (union Lisp_Fwd
*a
)
2536 return a
->u_intfwd
.type
;
2539 INLINE
struct Lisp_Buffer_Objfwd
*
2540 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2542 eassert (BUFFER_OBJFWDP (a
));
2543 return &a
->u_buffer_objfwd
;
2546 /* Lisp floating point type. */
2552 struct Lisp_Float
*chain
;
2557 XFLOAT_DATA (Lisp_Object f
)
2559 return XFLOAT (f
)->u
.data
;
2562 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2563 representations, have infinities and NaNs, and do not trap on
2564 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2565 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2566 wanted here, but is not quite right because Emacs does not require
2567 all the features of C11 Annex F (and does not require C11 at all,
2568 for that matter). */
2572 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2573 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2576 /* A character, declared with the following typedef, is a member
2577 of some character set associated with the current buffer. */
2578 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2580 typedef unsigned char UCHAR
;
2583 /* Meanings of slots in a Lisp_Compiled: */
2587 COMPILED_ARGLIST
= 0,
2588 COMPILED_BYTECODE
= 1,
2589 COMPILED_CONSTANTS
= 2,
2590 COMPILED_STACK_DEPTH
= 3,
2591 COMPILED_DOC_STRING
= 4,
2592 COMPILED_INTERACTIVE
= 5
2595 /* Flag bits in a character. These also get used in termhooks.h.
2596 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2597 (MUlti-Lingual Emacs) might need 22 bits for the character value
2598 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2601 CHAR_ALT
= 0x0400000,
2602 CHAR_SUPER
= 0x0800000,
2603 CHAR_HYPER
= 0x1000000,
2604 CHAR_SHIFT
= 0x2000000,
2605 CHAR_CTL
= 0x4000000,
2606 CHAR_META
= 0x8000000,
2608 CHAR_MODIFIER_MASK
=
2609 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2611 /* Actually, the current Emacs uses 22 bits for the character value
2616 /* Data type checking. */
2619 (NILP
) (Lisp_Object x
)
2621 return lisp_h_NILP (x
);
2625 NUMBERP (Lisp_Object x
)
2627 return INTEGERP (x
) || FLOATP (x
);
2630 NATNUMP (Lisp_Object x
)
2632 return INTEGERP (x
) && 0 <= XINT (x
);
2636 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2638 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2641 #define TYPE_RANGED_INTEGERP(type, x) \
2643 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2644 && XINT (x) <= TYPE_MAXIMUM (type))
2647 (CONSP
) (Lisp_Object x
)
2649 return lisp_h_CONSP (x
);
2652 (FLOATP
) (Lisp_Object x
)
2654 return lisp_h_FLOATP (x
);
2657 (MISCP
) (Lisp_Object x
)
2659 return lisp_h_MISCP (x
);
2662 (SYMBOLP
) (Lisp_Object x
)
2664 return lisp_h_SYMBOLP (x
);
2667 (INTEGERP
) (Lisp_Object x
)
2669 return lisp_h_INTEGERP (x
);
2672 (VECTORLIKEP
) (Lisp_Object x
)
2674 return lisp_h_VECTORLIKEP (x
);
2677 (MARKERP
) (Lisp_Object x
)
2679 return lisp_h_MARKERP (x
);
2683 STRINGP (Lisp_Object x
)
2685 return XTYPE (x
) == Lisp_String
;
2688 VECTORP (Lisp_Object x
)
2690 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2693 OVERLAYP (Lisp_Object x
)
2695 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2698 SAVE_VALUEP (Lisp_Object x
)
2700 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2704 FINALIZERP (Lisp_Object x
)
2706 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Finalizer
;
2711 USER_PTRP (Lisp_Object x
)
2713 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_User_Ptr
;
2718 AUTOLOADP (Lisp_Object x
)
2720 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2724 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2726 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2730 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2732 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2733 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2736 /* True if A is a pseudovector whose code is CODE. */
2738 PSEUDOVECTORP (Lisp_Object a
, int code
)
2740 if (! VECTORLIKEP (a
))
2744 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2745 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2746 return PSEUDOVECTOR_TYPEP (h
, code
);
2751 /* Test for specific pseudovector types. */
2754 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2756 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2760 PROCESSP (Lisp_Object a
)
2762 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2766 WINDOWP (Lisp_Object a
)
2768 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2772 TERMINALP (Lisp_Object a
)
2774 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2778 SUBRP (Lisp_Object a
)
2780 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2784 COMPILEDP (Lisp_Object a
)
2786 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2790 BUFFERP (Lisp_Object a
)
2792 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2796 CHAR_TABLE_P (Lisp_Object a
)
2798 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2802 SUB_CHAR_TABLE_P (Lisp_Object a
)
2804 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2808 BOOL_VECTOR_P (Lisp_Object a
)
2810 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2814 FRAMEP (Lisp_Object a
)
2816 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2820 THREADP (Lisp_Object a
)
2822 return PSEUDOVECTORP (a
, PVEC_THREAD
);
2826 MUTEXP (Lisp_Object a
)
2828 return PSEUDOVECTORP (a
, PVEC_MUTEX
);
2832 CONDVARP (Lisp_Object a
)
2834 return PSEUDOVECTORP (a
, PVEC_CONDVAR
);
2837 /* Test for image (image . spec) */
2839 IMAGEP (Lisp_Object x
)
2841 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2846 ARRAYP (Lisp_Object x
)
2848 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2852 CHECK_LIST (Lisp_Object x
)
2854 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2858 (CHECK_LIST_CONS
) (Lisp_Object x
, Lisp_Object y
)
2860 lisp_h_CHECK_LIST_CONS (x
, y
);
2864 (CHECK_SYMBOL
) (Lisp_Object x
)
2866 lisp_h_CHECK_SYMBOL (x
);
2870 (CHECK_NUMBER
) (Lisp_Object x
)
2872 lisp_h_CHECK_NUMBER (x
);
2876 CHECK_STRING (Lisp_Object x
)
2878 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2881 CHECK_STRING_CAR (Lisp_Object x
)
2883 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2886 CHECK_CONS (Lisp_Object x
)
2888 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2891 CHECK_VECTOR (Lisp_Object x
)
2893 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2896 CHECK_BOOL_VECTOR (Lisp_Object x
)
2898 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2900 /* This is a bit special because we always need size afterwards. */
2902 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2908 wrong_type_argument (Qarrayp
, x
);
2911 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2913 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2916 CHECK_BUFFER (Lisp_Object x
)
2918 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2921 CHECK_WINDOW (Lisp_Object x
)
2923 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2927 CHECK_PROCESS (Lisp_Object x
)
2929 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2933 CHECK_NATNUM (Lisp_Object x
)
2935 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2938 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2941 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2942 args_out_of_range_3 \
2944 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2945 ? MOST_NEGATIVE_FIXNUM \
2947 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2949 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2951 if (TYPE_SIGNED (type)) \
2952 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2954 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2957 #define CHECK_NUMBER_COERCE_MARKER(x) \
2959 if (MARKERP ((x))) \
2960 XSETFASTINT (x, marker_position (x)); \
2962 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2966 XFLOATINT (Lisp_Object n
)
2968 return extract_float (n
);
2972 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2974 CHECK_TYPE (NUMBERP (x
), Qnumberp
, x
);
2977 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2980 XSETFASTINT (x, marker_position (x)); \
2982 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2987 CHECK_THREAD (Lisp_Object x
)
2989 CHECK_TYPE (THREADP (x
), Qthreadp
, x
);
2993 CHECK_MUTEX (Lisp_Object x
)
2995 CHECK_TYPE (MUTEXP (x
), Qmutexp
, x
);
2999 CHECK_CONDVAR (Lisp_Object x
)
3001 CHECK_TYPE (CONDVARP (x
), Qcondition_variable_p
, x
);
3004 /* Since we can't assign directly to the CAR or CDR fields of a cons
3005 cell, use these when checking that those fields contain numbers. */
3007 CHECK_NUMBER_CAR (Lisp_Object x
)
3009 Lisp_Object tmp
= XCAR (x
);
3015 CHECK_NUMBER_CDR (Lisp_Object x
)
3017 Lisp_Object tmp
= XCDR (x
);
3022 /* Define a built-in function for calling from Lisp.
3023 `lname' should be the name to give the function in Lisp,
3024 as a null-terminated C string.
3025 `fnname' should be the name of the function in C.
3026 By convention, it starts with F.
3027 `sname' should be the name for the C constant structure
3028 that records information on this function for internal use.
3029 By convention, it should be the same as `fnname' but with S instead of F.
3030 It's too bad that C macros can't compute this from `fnname'.
3031 `minargs' should be a number, the minimum number of arguments allowed.
3032 `maxargs' should be a number, the maximum number of arguments allowed,
3033 or else MANY or UNEVALLED.
3034 MANY means pass a vector of evaluated arguments,
3035 in the form of an integer number-of-arguments
3036 followed by the address of a vector of Lisp_Objects
3037 which contains the argument values.
3038 UNEVALLED means pass the list of unevaluated arguments
3039 `intspec' says how interactive arguments are to be fetched.
3040 If the string starts with a `(', `intspec' is evaluated and the resulting
3041 list is the list of arguments.
3042 If it's a string that doesn't start with `(', the value should follow
3043 the one of the doc string for `interactive'.
3044 A null string means call interactively with no arguments.
3045 `doc' is documentation for the user. */
3047 /* This version of DEFUN declares a function prototype with the right
3048 arguments, so we can catch errors with maxargs at compile-time. */
3050 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
3051 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
3052 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
3053 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
3054 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
3055 { (Lisp_Object (__cdecl *)(void))fnname }, \
3056 minargs, maxargs, lname, intspec, 0}; \
3058 #else /* not _MSC_VER */
3059 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
3060 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
3061 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
3062 { .a ## maxargs = fnname }, \
3063 minargs, maxargs, lname, intspec, 0}; \
3068 is how we define the symbol for function `name' at start-up time. */
3069 extern void defsubr (struct Lisp_Subr
*);
3077 /* Call a function F that accepts many args, passing it ARRAY's elements. */
3078 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
3080 /* Call a function F that accepts many args, passing it the remaining args,
3081 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
3082 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
3083 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
3084 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
3086 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
3087 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
3088 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
3089 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
3090 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
3092 /* Macros we use to define forwarded Lisp variables.
3093 These are used in the syms_of_FILENAME functions.
3095 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
3096 lisp variable is actually a field in `struct emacs_globals'. The
3097 field's name begins with "f_", which is a convention enforced by
3098 these macros. Each such global has a corresponding #define in
3099 globals.h; the plain name should be used in the code.
3101 E.g., the global "cons_cells_consed" is declared as "int
3102 f_cons_cells_consed" in globals.h, but there is a define:
3104 #define cons_cells_consed globals.f_cons_cells_consed
3106 All C code uses the `cons_cells_consed' name. This is all done
3107 this way to support indirection for multi-threaded Emacs. */
3109 #define DEFVAR_LISP(lname, vname, doc) \
3111 static struct Lisp_Objfwd o_fwd; \
3112 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
3114 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
3116 static struct Lisp_Objfwd o_fwd; \
3117 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
3119 #define DEFVAR_BOOL(lname, vname, doc) \
3121 static struct Lisp_Boolfwd b_fwd; \
3122 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
3124 #define DEFVAR_INT(lname, vname, doc) \
3126 static struct Lisp_Intfwd i_fwd; \
3127 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
3130 #define DEFVAR_KBOARD(lname, vname, doc) \
3132 static struct Lisp_Kboard_Objfwd ko_fwd; \
3133 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
3136 /* Save and restore the instruction and environment pointers,
3137 without affecting the signal mask. */
3140 typedef jmp_buf sys_jmp_buf
;
3141 # define sys_setjmp(j) _setjmp (j)
3142 # define sys_longjmp(j, v) _longjmp (j, v)
3143 #elif defined HAVE_SIGSETJMP
3144 typedef sigjmp_buf sys_jmp_buf
;
3145 # define sys_setjmp(j) sigsetjmp (j, 0)
3146 # define sys_longjmp(j, v) siglongjmp (j, v)
3148 /* A platform that uses neither _longjmp nor siglongjmp; assume
3149 longjmp does not affect the sigmask. */
3150 typedef jmp_buf sys_jmp_buf
;
3151 # define sys_setjmp(j) setjmp (j)
3152 # define sys_longjmp(j, v) longjmp (j, v)
3156 /* Elisp uses several stacks:
3158 - the bytecode stack: used internally by the bytecode interpreter.
3159 Allocated from the C stack.
3160 - The specpdl stack: keeps track of active unwind-protect and
3161 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
3163 - The handler stack: keeps track of active catch tags and condition-case
3164 handlers. Allocated in a manually managed stack implemented by a
3165 doubly-linked list allocated via xmalloc and never freed. */
3167 /* Structure for recording Lisp call stack for backtrace purposes. */
3169 /* The special binding stack holds the outer values of variables while
3170 they are bound by a function application or a let form, stores the
3171 code to be executed for unwind-protect forms.
3173 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
3174 used all over the place, needs to be fast, and needs to know the size of
3175 union specbinding. But only eval.c should access it. */
3178 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
3179 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
3180 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
3181 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
3182 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
3183 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
3184 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3185 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
3186 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
3191 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3193 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3194 void (*func
) (Lisp_Object
);
3198 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3199 void (*func
) (void *);
3203 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3208 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3209 void (*func
) (void);
3212 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3213 /* `where' is not used in the case of SPECPDL_LET. */
3214 Lisp_Object symbol
, old_value
, where
;
3215 /* Normally this is unused; but it is set to the symbol's
3216 current value when a thread is swapped out. */
3217 Lisp_Object saved_value
;
3220 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3221 bool_bf debug_on_exit
: 1;
3222 Lisp_Object function
;
3228 /* These 3 are defined as macros in thread.h. */
3229 /* extern union specbinding *specpdl; */
3230 /* extern union specbinding *specpdl_ptr; */
3231 /* extern ptrdiff_t specpdl_size; */
3234 SPECPDL_INDEX (void)
3236 return specpdl_ptr
- specpdl
;
3239 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3240 control structures. A struct handler contains all the information needed to
3241 restore the state of the interpreter after a non-local jump.
3243 handler structures are chained together in a doubly linked list; the `next'
3244 member points to the next outer catchtag and the `nextfree' member points in
3245 the other direction to the next inner element (which is typically the next
3246 free element since we mostly use it on the deepest handler).
3248 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3249 member is TAG, and then unbinds to it. The `val' member is used to
3250 hold VAL while the stack is unwound; `val' is returned as the value
3251 of the catch form. If there is a handler of type CATCHER_ALL, it will
3252 be treated as a handler for all invocations of `throw'; in this case
3253 `val' will be set to (TAG . VAL).
3255 All the other members are concerned with restoring the interpreter
3258 Members are volatile if their values need to survive _longjmp when
3259 a 'struct handler' is a local variable. */
3261 enum handlertype
{ CATCHER
, CONDITION_CASE
, CATCHER_ALL
};
3265 enum handlertype type
;
3266 Lisp_Object tag_or_ch
;
3268 struct handler
*next
;
3269 struct handler
*nextfree
;
3271 /* The bytecode interpreter can have several handlers active at the same
3272 time, so when we longjmp to one of them, it needs to know which handler
3273 this was and what was the corresponding internal state. This is stored
3274 here, and when we longjmp we make sure that handlerlist points to the
3276 Lisp_Object
*bytecode_top
;
3279 /* Most global vars are reset to their value via the specpdl mechanism,
3280 but a few others are handled by storing their value here. */
3282 EMACS_INT f_lisp_eval_depth
;
3284 int poll_suppress_count
;
3285 int interrupt_input_blocked
;
3286 struct byte_stack
*byte_stack
;
3289 extern Lisp_Object memory_signal_data
;
3291 /* Check quit-flag and quit if it is non-nil.
3292 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
3293 So the program needs to do QUIT at times when it is safe to quit.
3294 Every loop that might run for a long time or might not exit
3295 ought to do QUIT at least once, at a safe place.
3296 Unless that is impossible, of course.
3297 But it is very desirable to avoid creating loops where QUIT is impossible.
3299 Exception: if you set immediate_quit to true,
3300 then the handler that responds to the C-g does the quit itself.
3301 This is a good thing to do around a loop that has no side effects
3302 and (in particular) cannot call arbitrary Lisp code.
3304 If quit-flag is set to `kill-emacs' the SIGINT handler has received
3305 a request to exit Emacs when it is safe to do. */
3307 extern void process_pending_signals (void);
3308 extern bool volatile pending_signals
;
3310 extern void process_quit_flag (void);
3313 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3314 process_quit_flag (); \
3315 else if (pending_signals) \
3316 process_pending_signals (); \
3320 /* True if ought to quit now. */
3322 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3324 extern Lisp_Object Vascii_downcase_table
;
3325 extern Lisp_Object Vascii_canon_table
;
3327 /* Call staticpro (&var) to protect static variable `var'. */
3329 void staticpro (Lisp_Object
*);
3331 /* Forward declarations for prototypes. */
3335 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3338 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3340 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3341 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3344 /* Functions to modify hash tables. */
3347 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3349 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3353 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3355 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3358 /* Use these functions to set Lisp_Object
3359 or pointer slots of struct Lisp_Symbol. */
3362 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3364 XSYMBOL (sym
)->function
= function
;
3368 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3370 XSYMBOL (sym
)->plist
= plist
;
3374 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3376 XSYMBOL (sym
)->next
= next
;
3380 make_symbol_constant (Lisp_Object sym
)
3382 XSYMBOL (sym
)->trapped_write
= SYMBOL_NOWRITE
;
3385 /* Buffer-local (also frame-local) variable access functions. */
3388 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3390 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3394 /* Set overlay's property list. */
3397 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3399 XOVERLAY (overlay
)->plist
= plist
;
3402 /* Get text properties of S. */
3405 string_intervals (Lisp_Object s
)
3407 return XSTRING (s
)->intervals
;
3410 /* Set text properties of S to I. */
3413 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3415 XSTRING (s
)->intervals
= i
;
3418 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3419 of setting slots directly. */
3422 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3424 XCHAR_TABLE (table
)->defalt
= val
;
3427 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3429 XCHAR_TABLE (table
)->purpose
= val
;
3432 /* Set different slots in (sub)character tables. */
3435 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3437 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3438 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3442 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3444 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3445 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3449 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3451 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3454 /* Defined in data.c. */
3455 extern Lisp_Object
indirect_function (Lisp_Object
);
3456 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3457 enum Arith_Comparison
{
3462 ARITH_LESS_OR_EQUAL
,
3465 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3466 enum Arith_Comparison comparison
);
3468 /* Convert the integer I to an Emacs representation, either the integer
3469 itself, or a cons of two or three integers, or if all else fails a float.
3470 I should not have side effects. */
3471 #define INTEGER_TO_CONS(i) \
3472 (! FIXNUM_OVERFLOW_P (i) \
3474 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3475 extern Lisp_Object
intbig_to_lisp (intmax_t);
3476 extern Lisp_Object
uintbig_to_lisp (uintmax_t);
3478 /* Convert the Emacs representation CONS back to an integer of type
3479 TYPE, storing the result the variable VAR. Signal an error if CONS
3480 is not a valid representation or is out of range for TYPE. */
3481 #define CONS_TO_INTEGER(cons, type, var) \
3482 (TYPE_SIGNED (type) \
3483 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3484 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3485 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3486 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3488 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3489 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3490 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3492 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3493 enum Set_Internal_Bind
{
3496 SET_INTERNAL_UNBIND
,
3497 SET_INTERNAL_THREAD_SWITCH
3499 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3500 enum Set_Internal_Bind
);
3501 extern void set_default_internal (Lisp_Object
, Lisp_Object
,
3502 enum Set_Internal_Bind bindflag
);
3504 extern void syms_of_data (void);
3505 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3507 /* Defined in cmds.c */
3508 extern void syms_of_cmds (void);
3509 extern void keys_of_cmds (void);
3511 /* Defined in coding.c. */
3512 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3513 ptrdiff_t, bool, bool, Lisp_Object
);
3514 extern void init_coding (void);
3515 extern void init_coding_once (void);
3516 extern void syms_of_coding (void);
3518 /* Defined in character.c. */
3519 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3520 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3521 extern void syms_of_character (void);
3523 /* Defined in charset.c. */
3524 extern void init_charset (void);
3525 extern void init_charset_once (void);
3526 extern void syms_of_charset (void);
3527 /* Structure forward declarations. */
3530 /* Defined in syntax.c. */
3531 extern void init_syntax_once (void);
3532 extern void syms_of_syntax (void);
3534 /* Defined in fns.c. */
3535 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3536 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3537 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3538 extern void sweep_weak_hash_tables (void);
3539 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3540 EMACS_UINT
sxhash (Lisp_Object
, int);
3541 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3542 Lisp_Object
, Lisp_Object
);
3543 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3544 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3546 void hash_remove_from_table (struct Lisp_Hash_Table
*, Lisp_Object
);
3547 extern struct hash_table_test
const hashtest_eq
, hashtest_eql
, hashtest_equal
;
3548 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3549 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3550 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3551 ptrdiff_t, ptrdiff_t);
3552 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3553 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3554 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3555 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3556 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3557 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3558 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3559 extern void clear_string_char_byte_cache (void);
3560 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3561 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3562 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3563 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3564 extern void syms_of_fns (void);
3566 /* Defined in floatfns.c. */
3567 extern void syms_of_floatfns (void);
3568 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3570 /* Defined in fringe.c. */
3571 extern void syms_of_fringe (void);
3572 extern void init_fringe (void);
3573 #ifdef HAVE_WINDOW_SYSTEM
3574 extern void mark_fringe_data (void);
3575 extern void init_fringe_once (void);
3576 #endif /* HAVE_WINDOW_SYSTEM */
3578 /* Defined in image.c. */
3579 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3580 extern void reset_image_types (void);
3581 extern void syms_of_image (void);
3583 /* Defined in insdel.c. */
3584 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3585 extern _Noreturn
void buffer_overflow (void);
3586 extern void make_gap (ptrdiff_t);
3587 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3588 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3589 ptrdiff_t, bool, bool);
3590 extern int count_combining_before (const unsigned char *,
3591 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3592 extern int count_combining_after (const unsigned char *,
3593 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3594 extern void insert (const char *, ptrdiff_t);
3595 extern void insert_and_inherit (const char *, ptrdiff_t);
3596 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3598 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3599 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3600 ptrdiff_t, ptrdiff_t, bool);
3601 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3602 extern void insert_char (int);
3603 extern void insert_string (const char *);
3604 extern void insert_before_markers (const char *, ptrdiff_t);
3605 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3606 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3607 ptrdiff_t, ptrdiff_t,
3609 extern void del_range (ptrdiff_t, ptrdiff_t);
3610 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3611 extern void del_range_byte (ptrdiff_t, ptrdiff_t);
3612 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3613 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3614 ptrdiff_t, ptrdiff_t, bool);
3615 extern void modify_text (ptrdiff_t, ptrdiff_t);
3616 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3617 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3618 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3619 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3620 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3621 ptrdiff_t, ptrdiff_t);
3622 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3623 ptrdiff_t, ptrdiff_t);
3624 extern void adjust_markers_bytepos (ptrdiff_t, ptrdiff_t,
3625 ptrdiff_t, ptrdiff_t, int);
3626 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool, bool);
3627 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3628 const char *, ptrdiff_t, ptrdiff_t, bool);
3629 extern void syms_of_insdel (void);
3631 /* Defined in dispnew.c. */
3632 #if (defined PROFILING \
3633 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3634 _Noreturn
void __executable_start (void);
3636 extern Lisp_Object Vwindow_system
;
3637 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3639 /* Defined in xdisp.c. */
3640 extern bool noninteractive_need_newline
;
3641 extern Lisp_Object echo_area_buffer
[2];
3642 extern void add_to_log (char const *, ...);
3643 extern void vadd_to_log (char const *, va_list);
3644 extern void check_message_stack (void);
3645 extern void setup_echo_area_for_printing (bool);
3646 extern bool push_message (void);
3647 extern void pop_message_unwind (void);
3648 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3649 extern void restore_message (void);
3650 extern Lisp_Object
current_message (void);
3651 extern void clear_message (bool, bool);
3652 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3653 extern void message1 (const char *);
3654 extern void message1_nolog (const char *);
3655 extern void message3 (Lisp_Object
);
3656 extern void message3_nolog (Lisp_Object
);
3657 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3658 extern void message_with_string (const char *, Lisp_Object
, bool);
3659 extern void message_log_maybe_newline (void);
3660 extern void update_echo_area (void);
3661 extern void truncate_echo_area (ptrdiff_t);
3662 extern void redisplay (void);
3664 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3665 extern void syms_of_xdisp (void);
3666 extern void init_xdisp (void);
3667 extern Lisp_Object
safe_eval (Lisp_Object
);
3668 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3669 int *, int *, int *, int *, int *);
3671 /* Defined in xsettings.c. */
3672 extern void syms_of_xsettings (void);
3674 /* Defined in vm-limit.c. */
3675 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3677 /* Defined in character.c. */
3678 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3679 ptrdiff_t *, ptrdiff_t *);
3681 /* Defined in alloc.c. */
3682 extern void *my_heap_start (void);
3683 extern void check_pure_size (void);
3684 extern void free_misc (Lisp_Object
);
3685 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3686 extern void malloc_warning (const char *);
3687 extern _Noreturn
void memory_full (size_t);
3688 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3689 extern bool survives_gc_p (Lisp_Object
);
3690 extern void mark_object (Lisp_Object
);
3691 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3692 extern void refill_memory_reserve (void);
3694 extern void alloc_unexec_pre (void);
3695 extern void alloc_unexec_post (void);
3696 extern void mark_stack (char *, char *);
3697 extern void flush_stack_call_func (void (*func
) (void *arg
), void *arg
);
3698 extern const char *pending_malloc_warning
;
3699 extern Lisp_Object zero_vector
;
3700 extern EMACS_INT consing_since_gc
;
3701 extern EMACS_INT gc_relative_threshold
;
3702 extern EMACS_INT memory_full_cons_threshold
;
3703 extern Lisp_Object
list1 (Lisp_Object
);
3704 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3705 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3706 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3707 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3709 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3710 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3712 /* Build a frequently used 2/3/4-integer lists. */
3715 list2i (EMACS_INT x
, EMACS_INT y
)
3717 return list2 (make_number (x
), make_number (y
));
3721 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3723 return list3 (make_number (x
), make_number (y
), make_number (w
));
3727 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3729 return list4 (make_number (x
), make_number (y
),
3730 make_number (w
), make_number (h
));
3733 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3734 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3735 extern _Noreturn
void string_overflow (void);
3736 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3737 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3738 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3739 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3741 /* Make unibyte string from C string when the length isn't known. */
3744 build_unibyte_string (const char *str
)
3746 return make_unibyte_string (str
, strlen (str
));
3749 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3750 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3751 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3752 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3753 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3754 extern Lisp_Object
make_specified_string (const char *,
3755 ptrdiff_t, ptrdiff_t, bool);
3756 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3757 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3759 /* Make a string allocated in pure space, use STR as string data. */
3762 build_pure_c_string (const char *str
)
3764 return make_pure_c_string (str
, strlen (str
));
3767 /* Make a string from the data at STR, treating it as multibyte if the
3771 build_string (const char *str
)
3773 return make_string (str
, strlen (str
));
3776 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3777 extern void make_byte_code (struct Lisp_Vector
*);
3778 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3780 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3781 be sure that GC cannot happen until the vector is completely
3782 initialized. E.g. the following code is likely to crash:
3784 v = make_uninit_vector (3);
3786 ASET (v, 1, Ffunction_can_gc ());
3787 ASET (v, 2, obj1); */
3790 make_uninit_vector (ptrdiff_t size
)
3793 struct Lisp_Vector
*p
;
3795 p
= allocate_vector (size
);
3800 /* Like above, but special for sub char-tables. */
3803 make_uninit_sub_char_table (int depth
, int min_char
)
3805 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3806 Lisp_Object v
= make_uninit_vector (slots
);
3808 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3809 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3810 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3814 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3817 /* Allocate partially initialized pseudovector where all Lisp_Object
3818 slots are set to Qnil but the rest (if any) is left uninitialized. */
3820 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3821 ((type *) allocate_pseudovector (VECSIZE (type), \
3822 PSEUDOVECSIZE (type, field), \
3823 PSEUDOVECSIZE (type, field), tag))
3825 /* Allocate fully initialized pseudovector where all Lisp_Object
3826 slots are set to Qnil and the rest (if any) is zeroed. */
3828 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3829 ((type *) allocate_pseudovector (VECSIZE (type), \
3830 PSEUDOVECSIZE (type, field), \
3831 VECSIZE (type), tag))
3833 extern bool gc_in_progress
;
3834 extern Lisp_Object
make_float (double);
3835 extern void display_malloc_warning (void);
3836 extern ptrdiff_t inhibit_garbage_collection (void);
3837 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3838 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3839 Lisp_Object
, Lisp_Object
);
3840 extern Lisp_Object
make_save_ptr (void *);
3841 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3842 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3843 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3845 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3846 extern void free_save_value (Lisp_Object
);
3847 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3848 extern void free_marker (Lisp_Object
);
3849 extern void free_cons (struct Lisp_Cons
*);
3850 extern void init_alloc_once (void);
3851 extern void init_alloc (void);
3852 extern void syms_of_alloc (void);
3853 extern struct buffer
* allocate_buffer (void);
3854 extern int valid_lisp_object_p (Lisp_Object
);
3855 #ifdef GC_CHECK_CONS_LIST
3856 extern void check_cons_list (void);
3858 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3861 /* Defined in gmalloc.c. */
3862 #if !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC && !defined SYSTEM_MALLOC
3863 extern size_t __malloc_extra_blocks
;
3865 #if !HAVE_DECL_ALIGNED_ALLOC
3866 extern void *aligned_alloc (size_t, size_t) ATTRIBUTE_MALLOC_SIZE ((2));
3868 extern void malloc_enable_thread (void);
3871 /* Defined in ralloc.c. */
3872 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3873 extern void r_alloc_free (void **);
3874 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3875 extern void r_alloc_reset_variable (void **, void **);
3876 extern void r_alloc_inhibit_buffer_relocation (int);
3879 /* Defined in chartab.c. */
3880 extern Lisp_Object
copy_char_table (Lisp_Object
);
3881 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3883 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3884 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3886 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3887 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3888 Lisp_Object
, Lisp_Object
,
3889 Lisp_Object
, struct charset
*,
3890 unsigned, unsigned);
3891 extern Lisp_Object
uniprop_table (Lisp_Object
);
3892 extern void syms_of_chartab (void);
3894 /* Defined in print.c. */
3895 extern Lisp_Object Vprin1_to_string_buffer
;
3896 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3897 extern void temp_output_buffer_setup (const char *);
3898 extern int print_level
;
3899 extern void write_string (const char *);
3900 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3902 extern Lisp_Object internal_with_output_to_temp_buffer
3903 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3904 #define FLOAT_TO_STRING_BUFSIZE 350
3905 extern int float_to_string (char *, double);
3906 extern void init_print_once (void);
3907 extern void syms_of_print (void);
3909 /* Defined in doprnt.c. */
3910 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3912 extern ptrdiff_t esprintf (char *, char const *, ...)
3913 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3914 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3916 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3917 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3918 char const *, va_list)
3919 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3921 /* Defined in lread.c. */
3922 extern Lisp_Object
check_obarray (Lisp_Object
);
3923 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3924 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3925 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3926 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3927 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3929 LOADHIST_ATTACH (Lisp_Object x
)
3932 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3934 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3935 Lisp_Object
*, Lisp_Object
, bool);
3936 extern Lisp_Object
string_to_number (char const *, int, bool);
3937 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3939 extern void dir_warning (const char *, Lisp_Object
);
3940 extern void init_obarray (void);
3941 extern void init_lread (void);
3942 extern void syms_of_lread (void);
3945 intern (const char *str
)
3947 return intern_1 (str
, strlen (str
));
3951 intern_c_string (const char *str
)
3953 return intern_c_string_1 (str
, strlen (str
));
3956 /* Defined in eval.c. */
3957 extern Lisp_Object Vautoload_queue
;
3958 extern Lisp_Object Vrun_hooks
;
3959 extern Lisp_Object Vsignaling_function
;
3960 extern Lisp_Object inhibit_lisp_code
;
3962 /* To run a normal hook, use the appropriate function from the list below.
3963 The calling convention:
3965 if (!NILP (Vrun_hooks))
3966 call1 (Vrun_hooks, Qmy_funny_hook);
3968 should no longer be used. */
3969 extern void run_hook (Lisp_Object
);
3970 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3971 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3972 Lisp_Object (*funcall
)
3973 (ptrdiff_t nargs
, Lisp_Object
*args
));
3974 extern Lisp_Object
quit (void);
3975 INLINE _Noreturn
void
3976 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
3978 Fsignal (error_symbol
, data
);
3980 extern _Noreturn
void xsignal0 (Lisp_Object
);
3981 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3982 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3983 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3985 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3986 extern bool FUNCTIONP (Lisp_Object
);
3987 extern Lisp_Object
funcall_subr (struct Lisp_Subr
*subr
, ptrdiff_t numargs
, Lisp_Object
*arg_vector
);
3988 extern Lisp_Object
eval_sub (Lisp_Object form
);
3989 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3990 extern Lisp_Object
call0 (Lisp_Object
);
3991 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3992 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3993 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3994 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3995 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3996 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3997 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3998 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3999 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4000 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
4001 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
4002 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
4003 extern Lisp_Object internal_condition_case_n
4004 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
4005 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
4006 extern struct handler
*push_handler (Lisp_Object
, enum handlertype
);
4007 extern struct handler
*push_handler_nosignal (Lisp_Object
, enum handlertype
);
4008 extern void specbind (Lisp_Object
, Lisp_Object
);
4009 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
4010 extern void record_unwind_protect_ptr (void (*) (void *), void *);
4011 extern void record_unwind_protect_int (void (*) (int), int);
4012 extern void record_unwind_protect_void (void (*) (void));
4013 extern void record_unwind_protect_nothing (void);
4014 extern void clear_unwind_protect (ptrdiff_t);
4015 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
4016 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
4017 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
4018 extern void rebind_for_thread_switch (void);
4019 extern void unbind_for_thread_switch (struct thread_state
*);
4020 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
4021 extern _Noreturn
void verror (const char *, va_list)
4022 ATTRIBUTE_FORMAT_PRINTF (1, 0);
4023 extern Lisp_Object
vformat_string (const char *, va_list)
4024 ATTRIBUTE_FORMAT_PRINTF (1, 0);
4025 extern void un_autoload (Lisp_Object
);
4026 extern Lisp_Object
call_debugger (Lisp_Object arg
);
4027 extern void *near_C_stack_top (void);
4028 extern void init_eval_once (void);
4029 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
4030 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
4031 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4032 extern void init_eval (void);
4033 extern void syms_of_eval (void);
4034 extern void unwind_body (Lisp_Object
);
4035 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
4036 extern void mark_specpdl (union specbinding
*first
, union specbinding
*ptr
);
4037 extern void get_backtrace (Lisp_Object array
);
4038 Lisp_Object
backtrace_top_function (void);
4039 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
4040 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
4043 /* Defined in alloc.c. */
4044 extern Lisp_Object
make_user_ptr (void (*finalizer
) (void *), void *p
);
4046 /* Defined in emacs-module.c. */
4047 extern void module_init (void);
4048 extern void syms_of_module (void);
4051 /* Defined in thread.c. */
4052 extern void mark_threads (void);
4054 /* Defined in editfns.c. */
4055 extern void insert1 (Lisp_Object
);
4056 extern Lisp_Object
save_excursion_save (void);
4057 extern Lisp_Object
save_restriction_save (void);
4058 extern void save_excursion_restore (Lisp_Object
);
4059 extern void save_restriction_restore (Lisp_Object
);
4060 extern _Noreturn
void time_overflow (void);
4061 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
4062 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
4064 extern void init_editfns (bool);
4065 extern void syms_of_editfns (void);
4067 /* Defined in buffer.c. */
4068 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
4069 extern _Noreturn
void nsberror (Lisp_Object
);
4070 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
4071 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
4072 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
4073 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
4074 Lisp_Object
, Lisp_Object
, Lisp_Object
);
4075 extern bool overlay_touches_p (ptrdiff_t);
4076 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
4077 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
4078 extern void init_buffer_once (void);
4079 extern void init_buffer (int);
4080 extern void syms_of_buffer (void);
4081 extern void keys_of_buffer (void);
4083 /* Defined in marker.c. */
4085 extern ptrdiff_t marker_position (Lisp_Object
);
4086 extern ptrdiff_t marker_byte_position (Lisp_Object
);
4087 extern void clear_charpos_cache (struct buffer
*);
4088 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
4089 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
4090 extern void unchain_marker (struct Lisp_Marker
*marker
);
4091 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4092 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
4093 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
4094 ptrdiff_t, ptrdiff_t);
4095 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
4096 extern void syms_of_marker (void);
4098 /* Defined in fileio.c. */
4100 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
4101 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4102 Lisp_Object
, Lisp_Object
, Lisp_Object
,
4104 extern void close_file_unwind (int);
4105 extern void fclose_unwind (void *);
4106 extern void restore_point_unwind (Lisp_Object
);
4107 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
4108 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
4109 extern _Noreturn
void report_file_notify_error (const char *, Lisp_Object
);
4110 extern bool internal_delete_file (Lisp_Object
);
4111 extern Lisp_Object
emacs_readlinkat (int, const char *);
4112 extern bool file_directory_p (const char *);
4113 extern bool file_accessible_directory_p (Lisp_Object
);
4114 extern void init_fileio (void);
4115 extern void syms_of_fileio (void);
4116 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
4118 /* Defined in search.c. */
4119 extern void shrink_regexp_cache (void);
4120 extern void restore_search_regs (void);
4121 extern void update_search_regs (ptrdiff_t oldstart
,
4122 ptrdiff_t oldend
, ptrdiff_t newend
);
4123 extern void record_unwind_save_match_data (void);
4124 struct re_registers
;
4125 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4126 struct re_registers
*,
4127 Lisp_Object
, bool, bool);
4128 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
4132 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
4134 return fast_string_match_internal (regexp
, string
, Qnil
);
4138 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
4140 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
4143 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4145 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4146 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4147 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4148 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4149 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4151 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
4152 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4153 ptrdiff_t, ptrdiff_t *);
4154 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4155 ptrdiff_t, ptrdiff_t *);
4156 extern void syms_of_search (void);
4157 extern void clear_regexp_cache (void);
4159 /* Defined in minibuf.c. */
4161 extern Lisp_Object Vminibuffer_list
;
4162 extern Lisp_Object last_minibuf_string
;
4163 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4164 extern void init_minibuf_once (void);
4165 extern void syms_of_minibuf (void);
4167 /* Defined in callint.c. */
4169 extern void syms_of_callint (void);
4171 /* Defined in casefiddle.c. */
4173 extern void syms_of_casefiddle (void);
4174 extern void keys_of_casefiddle (void);
4176 /* Defined in casetab.c. */
4178 extern void init_casetab_once (void);
4179 extern void syms_of_casetab (void);
4181 /* Defined in keyboard.c. */
4183 extern Lisp_Object echo_message_buffer
;
4184 extern struct kboard
*echo_kboard
;
4185 extern void cancel_echoing (void);
4186 extern bool input_pending
;
4187 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4188 extern sigjmp_buf return_to_command_loop
;
4190 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4191 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4192 extern void discard_mouse_events (void);
4194 void handle_input_available_signal (int);
4196 extern Lisp_Object pending_funcalls
;
4197 extern bool detect_input_pending (void);
4198 extern bool detect_input_pending_ignore_squeezables (void);
4199 extern bool detect_input_pending_run_timers (bool);
4200 extern void safe_run_hooks (Lisp_Object
);
4201 extern void cmd_error_internal (Lisp_Object
, const char *);
4202 extern Lisp_Object
command_loop_1 (void);
4203 extern Lisp_Object
read_menu_command (void);
4204 extern Lisp_Object
recursive_edit_1 (void);
4205 extern void record_auto_save (void);
4206 extern void force_auto_save_soon (void);
4207 extern void init_keyboard (void);
4208 extern void syms_of_keyboard (void);
4209 extern void keys_of_keyboard (void);
4211 /* Defined in indent.c. */
4212 extern ptrdiff_t current_column (void);
4213 extern void invalidate_current_column (void);
4214 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4215 extern void syms_of_indent (void);
4217 /* Defined in frame.c. */
4218 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4219 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4220 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4221 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4222 extern void frames_discard_buffer (Lisp_Object
);
4223 extern void syms_of_frame (void);
4225 /* Defined in emacs.c. */
4226 extern char **initial_argv
;
4227 extern int initial_argc
;
4228 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4229 extern bool display_arg
;
4231 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4232 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4233 extern _Noreturn
void terminate_due_to_signal (int, int);
4235 extern Lisp_Object Vlibrary_cache
;
4238 void fixup_locale (void);
4239 void synchronize_system_messages_locale (void);
4240 void synchronize_system_time_locale (void);
4242 INLINE
void fixup_locale (void) {}
4243 INLINE
void synchronize_system_messages_locale (void) {}
4244 INLINE
void synchronize_system_time_locale (void) {}
4246 extern char *emacs_strerror (int);
4247 extern void shut_down_emacs (int, Lisp_Object
);
4249 /* True means don't do interactive redisplay and don't change tty modes. */
4250 extern bool noninteractive
;
4252 /* True means remove site-lisp directories from load-path. */
4253 extern bool no_site_lisp
;
4255 /* True means put details like time stamps into builds. */
4256 extern bool build_details
;
4259 /* 0 not a daemon, 1 new-style (foreground), 2 old-style (background). */
4260 extern int daemon_type
;
4261 #define IS_DAEMON (daemon_type != 0)
4262 #define DAEMON_RUNNING (daemon_type >= 0)
4263 #else /* WINDOWSNT */
4264 extern void *w32_daemon_event
;
4265 #define IS_DAEMON (w32_daemon_event != NULL)
4266 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4269 /* True if handling a fatal error already. */
4270 extern bool fatal_error_in_progress
;
4272 /* True means don't do use window-system-specific display code. */
4273 extern bool inhibit_window_system
;
4274 /* True means that a filter or a sentinel is running. */
4275 extern bool running_asynch_code
;
4277 /* Defined in process.c. */
4278 extern void kill_buffer_processes (Lisp_Object
);
4279 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4280 struct Lisp_Process
*, int);
4281 /* Max value for the first argument of wait_reading_process_output. */
4282 #if GNUC_PREREQ (3, 0, 0) && ! GNUC_PREREQ (4, 6, 0)
4283 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.0.
4284 The bug merely causes a bogus warning, but the warning is annoying. */
4285 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4287 # define WAIT_READING_MAX INTMAX_MAX
4290 extern void add_timer_wait_descriptor (int);
4292 extern void add_keyboard_wait_descriptor (int);
4293 extern void delete_keyboard_wait_descriptor (int);
4295 extern void add_gpm_wait_descriptor (int);
4296 extern void delete_gpm_wait_descriptor (int);
4298 extern void init_process_emacs (int);
4299 extern void syms_of_process (void);
4300 extern void setup_process_coding_systems (Lisp_Object
);
4302 /* Defined in callproc.c. */
4304 # define CHILD_SETUP_TYPE _Noreturn void
4306 # define CHILD_SETUP_TYPE int
4308 extern CHILD_SETUP_TYPE
child_setup (int, int, int, char **, bool, Lisp_Object
);
4309 extern void init_callproc_1 (void);
4310 extern void init_callproc (void);
4311 extern void set_initial_environment (void);
4312 extern void syms_of_callproc (void);
4314 /* Defined in doc.c. */
4315 enum text_quoting_style
4317 /* Use curved single quotes ‘like this’. */
4318 CURVE_QUOTING_STYLE
,
4320 /* Use grave accent and apostrophe `like this'. */
4321 GRAVE_QUOTING_STYLE
,
4323 /* Use apostrophes 'like this'. */
4324 STRAIGHT_QUOTING_STYLE
4326 extern enum text_quoting_style
text_quoting_style (void);
4327 extern Lisp_Object
read_doc_string (Lisp_Object
);
4328 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4329 extern void syms_of_doc (void);
4330 extern int read_bytecode_char (bool);
4332 /* Defined in bytecode.c. */
4333 extern void syms_of_bytecode (void);
4334 extern void relocate_byte_stack (struct byte_stack
*);
4335 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4336 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4337 extern Lisp_Object
get_byte_code_arity (Lisp_Object
);
4339 /* Defined in macros.c. */
4340 extern void init_macros (void);
4341 extern void syms_of_macros (void);
4343 /* Defined in undo.c. */
4344 extern void truncate_undo_list (struct buffer
*);
4345 extern void record_insert (ptrdiff_t, ptrdiff_t);
4346 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4347 extern void record_first_change (void);
4348 extern void record_change (ptrdiff_t, ptrdiff_t);
4349 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4350 Lisp_Object
, Lisp_Object
,
4352 extern void syms_of_undo (void);
4354 /* Defined in textprop.c. */
4355 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4357 /* Defined in menu.c. */
4358 extern void syms_of_menu (void);
4360 /* Defined in xmenu.c. */
4361 extern void syms_of_xmenu (void);
4363 /* Defined in termchar.h. */
4364 struct tty_display_info
;
4366 /* Defined in sysdep.c. */
4367 #ifdef HAVE_PERSONALITY_ADDR_NO_RANDOMIZE
4368 extern bool disable_address_randomization (void);
4370 INLINE
bool disable_address_randomization (void) { return false; }
4372 extern int emacs_exec_file (char const *, char *const *, char *const *);
4373 extern void init_standard_fds (void);
4374 extern char *emacs_get_current_dir_name (void);
4375 extern void stuff_char (char c
);
4376 extern void init_foreground_group (void);
4377 extern void sys_subshell (void);
4378 extern void sys_suspend (void);
4379 extern void discard_tty_input (void);
4380 extern void init_sys_modes (struct tty_display_info
*);
4381 extern void reset_sys_modes (struct tty_display_info
*);
4382 extern void init_all_sys_modes (void);
4383 extern void reset_all_sys_modes (void);
4384 extern void child_setup_tty (int);
4385 extern void setup_pty (int);
4386 extern int set_window_size (int, int, int);
4387 extern EMACS_INT
get_random (void);
4388 extern void seed_random (void *, ptrdiff_t);
4389 extern void init_random (void);
4390 extern void emacs_backtrace (int);
4391 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4392 extern int emacs_open (const char *, int, int);
4393 extern int emacs_pipe (int[2]);
4394 extern int emacs_close (int);
4395 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4396 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4397 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4398 extern void emacs_perror (char const *);
4400 extern void unlock_all_files (void);
4401 extern void lock_file (Lisp_Object
);
4402 extern void unlock_file (Lisp_Object
);
4403 extern void unlock_buffer (struct buffer
*);
4404 extern void syms_of_filelock (void);
4405 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4407 /* Defined in sound.c. */
4408 extern void syms_of_sound (void);
4410 /* Defined in category.c. */
4411 extern void init_category_once (void);
4412 extern Lisp_Object
char_category_set (int);
4413 extern void syms_of_category (void);
4415 /* Defined in ccl.c. */
4416 extern void syms_of_ccl (void);
4418 /* Defined in dired.c. */
4419 extern void syms_of_dired (void);
4420 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4421 Lisp_Object
, Lisp_Object
,
4424 /* Defined in term.c. */
4425 extern int *char_ins_del_vector
;
4426 extern void syms_of_term (void);
4427 extern _Noreturn
void fatal (const char *msgid
, ...)
4428 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4430 /* Defined in terminal.c. */
4431 extern void syms_of_terminal (void);
4433 /* Defined in font.c. */
4434 extern void syms_of_font (void);
4435 extern void init_font (void);
4437 #ifdef HAVE_WINDOW_SYSTEM
4438 /* Defined in fontset.c. */
4439 extern void syms_of_fontset (void);
4442 /* Defined in inotify.c */
4444 extern void syms_of_inotify (void);
4447 /* Defined in kqueue.c */
4449 extern void globals_of_kqueue (void);
4450 extern void syms_of_kqueue (void);
4453 /* Defined in gfilenotify.c */
4454 #ifdef HAVE_GFILENOTIFY
4455 extern void globals_of_gfilenotify (void);
4456 extern void syms_of_gfilenotify (void);
4459 #ifdef HAVE_W32NOTIFY
4460 /* Defined on w32notify.c. */
4461 extern void syms_of_w32notify (void);
4464 /* Defined in xfaces.c. */
4465 extern Lisp_Object Vface_alternative_font_family_alist
;
4466 extern Lisp_Object Vface_alternative_font_registry_alist
;
4467 extern void syms_of_xfaces (void);
4469 #ifdef HAVE_X_WINDOWS
4470 /* Defined in xfns.c. */
4471 extern void syms_of_xfns (void);
4473 /* Defined in xsmfns.c. */
4474 extern void syms_of_xsmfns (void);
4476 /* Defined in xselect.c. */
4477 extern void syms_of_xselect (void);
4479 /* Defined in xterm.c. */
4480 extern void init_xterm (void);
4481 extern void syms_of_xterm (void);
4482 #endif /* HAVE_X_WINDOWS */
4484 #ifdef HAVE_WINDOW_SYSTEM
4485 /* Defined in xterm.c, nsterm.m, w32term.c. */
4486 extern char *x_get_keysym_name (int);
4487 #endif /* HAVE_WINDOW_SYSTEM */
4490 /* Defined in xml.c. */
4491 extern void syms_of_xml (void);
4492 extern void xml_cleanup_parser (void);
4496 /* Defined in decompress.c. */
4497 extern void syms_of_decompress (void);
4501 /* Defined in dbusbind.c. */
4502 void init_dbusbind (void);
4503 void syms_of_dbusbind (void);
4507 /* Defined in profiler.c. */
4508 extern bool profiler_memory_running
;
4509 extern void malloc_probe (size_t);
4510 extern void syms_of_profiler (void);
4514 /* Defined in msdos.c, w32.c. */
4515 extern char *emacs_root_dir (void);
4518 /* Defined in lastfile.c. */
4519 extern char my_edata
[];
4520 extern char my_endbss
[];
4521 extern char *my_endbss_static
;
4523 /* True means ^G can quit instantly. */
4524 extern bool immediate_quit
;
4526 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4527 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4528 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4529 extern void xfree (void *);
4530 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4531 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4532 ATTRIBUTE_ALLOC_SIZE ((2,3));
4533 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4535 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4536 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4537 extern void dupstring (char **, char const *);
4539 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4540 null byte. This is like stpcpy, except the source is a Lisp string. */
4543 lispstpcpy (char *dest
, Lisp_Object string
)
4545 ptrdiff_t len
= SBYTES (string
);
4546 memcpy (dest
, SDATA (string
), len
+ 1);
4550 extern void xputenv (const char *);
4552 extern char *egetenv_internal (const char *, ptrdiff_t);
4555 egetenv (const char *var
)
4557 /* When VAR is a string literal, strlen can be optimized away. */
4558 return egetenv_internal (var
, strlen (var
));
4561 /* Set up the name of the machine we're running on. */
4562 extern void init_system_name (void);
4564 /* Return the absolute value of X. X should be a signed integer
4565 expression without side effects, and X's absolute value should not
4566 exceed the maximum for its promoted type. This is called 'eabs'
4567 because 'abs' is reserved by the C standard. */
4568 #define eabs(x) ((x) < 0 ? -(x) : (x))
4570 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4573 #define make_fixnum_or_float(val) \
4574 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4576 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4577 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4579 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4581 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4583 #define USE_SAFE_ALLOCA \
4584 ptrdiff_t sa_avail = MAX_ALLOCA; \
4585 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4587 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4589 /* SAFE_ALLOCA allocates a simple buffer. */
4591 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4592 ? AVAIL_ALLOCA (size) \
4593 : (sa_must_free = true, record_xmalloc (size)))
4595 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4596 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4597 positive. The code is tuned for MULTIPLIER being a constant. */
4599 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4601 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4602 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4605 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4606 sa_must_free = true; \
4607 record_unwind_protect_ptr (xfree, buf); \
4611 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4613 #define SAFE_ALLOCA_STRING(ptr, string) \
4615 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4616 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4619 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4621 #define SAFE_FREE() \
4623 if (sa_must_free) { \
4624 sa_must_free = false; \
4625 unbind_to (sa_count, Qnil); \
4629 /* Set BUF to point to an allocated array of NELT Lisp_Objects,
4630 immediately followed by EXTRA spare bytes. */
4632 #define SAFE_ALLOCA_LISP_EXTRA(buf, nelt, extra) \
4634 ptrdiff_t alloca_nbytes; \
4635 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4636 || INT_ADD_WRAPV (alloca_nbytes, extra, &alloca_nbytes) \
4637 || SIZE_MAX < alloca_nbytes) \
4638 memory_full (SIZE_MAX); \
4639 else if (alloca_nbytes <= sa_avail) \
4640 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4644 (buf) = xmalloc (alloca_nbytes); \
4645 arg_ = make_save_memory (buf, nelt); \
4646 sa_must_free = true; \
4647 record_unwind_protect (free_save_value, arg_); \
4651 /* Set BUF to point to an allocated array of NELT Lisp_Objects. */
4653 #define SAFE_ALLOCA_LISP(buf, nelt) SAFE_ALLOCA_LISP_EXTRA (buf, nelt, 0)
4656 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4657 block-scoped conses and strings. These objects are not
4658 managed by the garbage collector, so they are dangerous: passing them
4659 out of their scope (e.g., to user code) results in undefined behavior.
4660 Conversely, they have better performance because GC is not involved.
4662 This feature is experimental and requires careful debugging.
4663 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4665 #if (!defined USE_STACK_LISP_OBJECTS \
4666 && defined __GNUC__ && !defined __clang__ && ! GNUC_PREREQ (4, 3, 2))
4667 /* Work around GCC bugs 36584 and 35271, which were fixed in GCC 4.3.2. */
4668 # define USE_STACK_LISP_OBJECTS false
4670 #ifndef USE_STACK_LISP_OBJECTS
4671 # define USE_STACK_LISP_OBJECTS true
4674 #ifdef GC_CHECK_STRING_BYTES
4675 enum { defined_GC_CHECK_STRING_BYTES
= true };
4677 enum { defined_GC_CHECK_STRING_BYTES
= false };
4680 /* Struct inside unions that are typically no larger and aligned enough. */
4685 double d
; intmax_t i
; void *p
;
4688 union Aligned_String
4690 struct Lisp_String s
;
4691 double d
; intmax_t i
; void *p
;
4694 /* True for stack-based cons and string implementations, respectively.
4695 Use stack-based strings only if stack-based cons also works.
4696 Otherwise, STACK_CONS would create heap-based cons cells that
4697 could point to stack-based strings, which is a no-no. */
4701 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4702 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4703 USE_STACK_STRING
= (USE_STACK_CONS
4704 && !defined_GC_CHECK_STRING_BYTES
4705 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4708 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4709 use these only in macros like AUTO_CONS that declare a local
4710 variable whose lifetime will be clear to the programmer. */
4711 #define STACK_CONS(a, b) \
4712 make_lisp_ptr (&(union Aligned_Cons) { { a, { b } } }.s, Lisp_Cons)
4713 #define AUTO_CONS_EXPR(a, b) \
4714 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4716 /* Declare NAME as an auto Lisp cons or short list if possible, a
4717 GC-based one otherwise. This is in the sense of the C keyword
4718 'auto'; i.e., the object has the lifetime of the containing block.
4719 The resulting object should not be made visible to user Lisp code. */
4721 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4722 #define AUTO_LIST1(name, a) \
4723 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4724 #define AUTO_LIST2(name, a, b) \
4725 Lisp_Object name = (USE_STACK_CONS \
4726 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4728 #define AUTO_LIST3(name, a, b, c) \
4729 Lisp_Object name = (USE_STACK_CONS \
4730 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4732 #define AUTO_LIST4(name, a, b, c, d) \
4735 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4736 STACK_CONS (d, Qnil)))) \
4737 : list4 (a, b, c, d))
4739 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4740 Take its unibyte value from the null-terminated string STR,
4741 an expression that should not have side effects.
4742 STR's value is not necessarily copied. The resulting Lisp string
4743 should not be modified or made visible to user code. */
4745 #define AUTO_STRING(name, str) \
4746 AUTO_STRING_WITH_LEN (name, str, strlen (str))
4748 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4749 Take its unibyte value from the null-terminated string STR with length LEN.
4750 STR may have side effects and may contain null bytes.
4751 STR's value is not necessarily copied. The resulting Lisp string
4752 should not be modified or made visible to user code. */
4754 #define AUTO_STRING_WITH_LEN(name, str, len) \
4755 Lisp_Object name = \
4758 ((&(union Aligned_String) \
4759 {{len, -1, 0, (unsigned char *) (str)}}.s), \
4761 : make_unibyte_string (str, len))
4763 /* Loop over all tails of a list, checking for cycles.
4764 FIXME: Make tortoise and n internal declarations.
4765 FIXME: Unroll the loop body so we don't need `n'. */
4766 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4767 for ((tortoise) = (hare) = (list), (n) = true; \
4769 (hare = XCDR (hare), (n) = !(n), \
4771 ? (EQ (hare, tortoise) \
4772 ? xsignal1 (Qcircular_list, list) \
4774 /* Move tortoise before the next iteration, in case */ \
4775 /* the next iteration does an Fsetcdr. */ \
4776 : (void) ((tortoise) = XCDR (tortoise)))))
4778 /* Do a `for' loop over alist values. */
4780 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4781 for ((list_var) = (head_var); \
4782 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4783 (list_var) = XCDR (list_var))
4785 /* Check whether it's time for GC, and run it if so. */
4790 if ((consing_since_gc
> gc_cons_threshold
4791 && consing_since_gc
> gc_relative_threshold
)
4792 || (!NILP (Vmemory_full
)
4793 && consing_since_gc
> memory_full_cons_threshold
))
4794 Fgarbage_collect ();
4799 #endif /* EMACS_LISP_H */