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 extern bool generating_ldefs_boot
;
624 /* Defined in floatfns.c. */
625 extern double extract_float (Lisp_Object
);
628 /* Interned state of a symbol. */
632 SYMBOL_UNINTERNED
= 0,
634 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
641 SYMBOL_LOCALIZED
= 2,
645 enum symbol_trapped_write
647 SYMBOL_UNTRAPPED_WRITE
= 0,
649 SYMBOL_TRAPPED_WRITE
= 2
654 bool_bf gcmarkbit
: 1;
656 /* Indicates where the value can be found:
657 0 : it's a plain var, the value is in the `value' field.
658 1 : it's a varalias, the value is really in the `alias' symbol.
659 2 : it's a localized var, the value is in the `blv' object.
660 3 : it's a forwarding variable, the value is in `forward'. */
661 ENUM_BF (symbol_redirect
) redirect
: 3;
663 /* 0 : normal case, just set the value
664 1 : constant, cannot set, e.g. nil, t, :keywords.
665 2 : trap the write, call watcher functions. */
666 ENUM_BF (symbol_trapped_write
) trapped_write
: 2;
668 /* Interned state of the symbol. This is an enumerator from
669 enum symbol_interned. */
670 unsigned interned
: 2;
672 /* True means that this variable has been explicitly declared
673 special (with `defvar' etc), and shouldn't be lexically bound. */
674 bool_bf declared_special
: 1;
676 /* True if pointed to from purespace and hence can't be GC'd. */
679 /* The symbol's name, as a Lisp string. */
682 /* Value of the symbol or Qunbound if unbound. Which alternative of the
683 union is used depends on the `redirect' field above. */
686 struct Lisp_Symbol
*alias
;
687 struct Lisp_Buffer_Local_Value
*blv
;
691 /* Function value of the symbol or Qnil if not fboundp. */
692 Lisp_Object function
;
694 /* The symbol's property list. */
697 /* Next symbol in obarray bucket, if the symbol is interned. */
698 struct Lisp_Symbol
*next
;
701 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
702 meaning as in the DEFUN macro, and is used to construct a prototype. */
703 /* We can use the same trick as in the DEFUN macro to generate the
704 appropriate prototype. */
705 #define EXFUN(fnname, maxargs) \
706 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
708 /* Note that the weird token-substitution semantics of ANSI C makes
709 this work for MANY and UNEVALLED. */
710 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
711 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
712 #define DEFUN_ARGS_0 (void)
713 #define DEFUN_ARGS_1 (Lisp_Object)
714 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
715 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
716 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
717 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
719 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
720 Lisp_Object, Lisp_Object)
721 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
722 Lisp_Object, Lisp_Object, Lisp_Object)
723 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
724 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
726 /* Yield a signed integer that contains TAG along with PTR.
728 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
729 and zero-extend otherwise (that’s a bit faster here).
730 Sign extension matters only when EMACS_INT is wider than a pointer. */
731 #define TAG_PTR(tag, ptr) \
733 ? (intptr_t) (ptr) + (tag) \
734 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
736 /* Yield an integer that contains a symbol tag along with OFFSET.
737 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
738 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
740 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
741 XLI (builtin_lisp_symbol (Qwhatever)),
742 except the former expands to an integer constant expression. */
743 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
745 /* LISPSYM_INITIALLY (Qfoo) is equivalent to Qfoo except it is
746 designed for use as an initializer, even for a constant initializer. */
747 #define LISPSYM_INITIALLY(name) LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name))
749 /* Declare extern constants for Lisp symbols. These can be helpful
750 when using a debugger like GDB, on older platforms where the debug
751 format does not represent C macros. */
752 #define DEFINE_LISP_SYMBOL(name) \
753 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
754 DEFINE_GDB_SYMBOL_END (LISPSYM_INITIALLY (name))
756 /* By default, define macros for Qt, etc., as this leads to a bit
757 better performance in the core Emacs interpreter. A plugin can
758 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
759 other Emacs instances that assign different values to Qt, etc. */
760 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
761 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
766 /* Header of vector-like objects. This documents the layout constraints on
767 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
768 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
769 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
770 because when two such pointers potentially alias, a compiler won't
771 incorrectly reorder loads and stores to their size fields. See
773 struct vectorlike_header
775 /* The only field contains various pieces of information:
776 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
777 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
778 vector (0) or a pseudovector (1).
779 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
780 of slots) of the vector.
781 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
782 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
783 - b) number of Lisp_Objects slots at the beginning of the object
784 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
786 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
787 measured in word_size units. Rest fields may also include
788 Lisp_Objects, but these objects usually needs some special treatment
790 There are some exceptions. For PVEC_FREE, b) is always zero. For
791 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
792 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
793 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
799 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
800 At the machine level, these operations are no-ops. */
803 (XLI
) (Lisp_Object o
)
805 return lisp_h_XLI (o
);
811 return lisp_h_XIL (i
);
814 /* In the size word of a vector, this bit means the vector has been marked. */
816 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
817 # define ARRAY_MARK_FLAG PTRDIFF_MIN
818 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
820 /* In the size word of a struct Lisp_Vector, this bit means it's really
821 some other vector-like object. */
822 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
823 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
824 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
826 /* In a pseudovector, the size field actually contains a word with one
827 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
828 with PVEC_TYPE_MASK to indicate the actual type. */
840 PVEC_WINDOW_CONFIGURATION
,
849 /* These should be last, check internal_equal to see why. */
853 PVEC_FONT
/* Should be last because it's used for range checking. */
858 /* For convenience, we also store the number of elements in these bits.
859 Note that this size is not necessarily the memory-footprint size, but
860 only the number of Lisp_Object fields (that need to be traced by GC).
861 The distinction is used, e.g., by Lisp_Process, which places extra
862 non-Lisp_Object fields at the end of the structure. */
863 PSEUDOVECTOR_SIZE_BITS
= 12,
864 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
866 /* To calculate the memory footprint of the pseudovector, it's useful
867 to store the size of non-Lisp area in word_size units here. */
868 PSEUDOVECTOR_REST_BITS
= 12,
869 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
870 << PSEUDOVECTOR_SIZE_BITS
),
872 /* Used to extract pseudovector subtype information. */
873 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
874 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
877 /* These functions extract various sorts of values from a Lisp_Object.
878 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
879 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
882 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
883 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
884 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
885 DEFINE_GDB_SYMBOL_END (VALMASK
)
887 /* Largest and smallest representable fixnum values. These are the C
888 values. They are macros for use in static initializers. */
889 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
890 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
895 (make_number
) (EMACS_INT n
)
897 return lisp_h_make_number (n
);
901 (XINT
) (Lisp_Object a
)
903 return lisp_h_XINT (a
);
907 (XFASTINT
) (Lisp_Object a
)
909 EMACS_INT n
= lisp_h_XFASTINT (a
);
914 INLINE
struct Lisp_Symbol
*
915 (XSYMBOL
) (Lisp_Object a
)
917 return lisp_h_XSYMBOL (a
);
920 INLINE
enum Lisp_Type
921 (XTYPE
) (Lisp_Object a
)
923 return lisp_h_XTYPE (a
);
927 (XUNTAG
) (Lisp_Object a
, int type
)
929 return lisp_h_XUNTAG (a
, type
);
932 #else /* ! USE_LSB_TAG */
934 /* Although compiled only if ! USE_LSB_TAG, the following functions
935 also work when USE_LSB_TAG; this is to aid future maintenance when
936 the lisp_h_* macros are eventually removed. */
938 /* Make a Lisp integer representing the value of the low order
941 make_number (EMACS_INT n
)
943 EMACS_INT int0
= Lisp_Int0
;
947 n
= u
<< INTTYPEBITS
;
953 n
+= (int0
<< VALBITS
);
958 /* Extract A's value as a signed integer. */
962 EMACS_INT i
= XLI (a
);
966 i
= u
<< INTTYPEBITS
;
968 return i
>> INTTYPEBITS
;
971 /* Like XINT (A), but may be faster. A must be nonnegative.
972 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
973 integers have zero-bits in their tags. */
975 XFASTINT (Lisp_Object a
)
977 EMACS_INT int0
= Lisp_Int0
;
978 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
) - (int0
<< VALBITS
);
983 /* Extract A's type. */
984 INLINE
enum Lisp_Type
985 XTYPE (Lisp_Object a
)
987 EMACS_UINT i
= XLI (a
);
988 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
991 /* Extract A's value as a symbol. */
992 INLINE
struct Lisp_Symbol
*
993 XSYMBOL (Lisp_Object a
)
995 eassert (SYMBOLP (a
));
996 intptr_t i
= (intptr_t) XUNTAG (a
, Lisp_Symbol
);
997 void *p
= (char *) lispsym
+ i
;
1001 /* Extract A's pointer value, assuming A's type is TYPE. */
1003 XUNTAG (Lisp_Object a
, int type
)
1005 intptr_t i
= USE_LSB_TAG
? XLI (a
) - type
: XLI (a
) & VALMASK
;
1009 #endif /* ! USE_LSB_TAG */
1011 /* Extract A's value as an unsigned integer. */
1013 XUINT (Lisp_Object a
)
1015 EMACS_UINT i
= XLI (a
);
1016 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
1019 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
1020 right now, but XUINT should only be applied to objects we know are
1024 (XHASH
) (Lisp_Object a
)
1026 return lisp_h_XHASH (a
);
1029 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
1031 make_natnum (EMACS_INT n
)
1033 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
1034 EMACS_INT int0
= Lisp_Int0
;
1035 return USE_LSB_TAG
? make_number (n
) : XIL (n
+ (int0
<< VALBITS
));
1038 /* Return true if X and Y are the same object. */
1041 (EQ
) (Lisp_Object x
, Lisp_Object y
)
1043 return lisp_h_EQ (x
, y
);
1046 /* Value is true if I doesn't fit into a Lisp fixnum. It is
1047 written this way so that it also works if I is of unsigned
1048 type or if I is a NaN. */
1050 #define FIXNUM_OVERFLOW_P(i) \
1051 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
1054 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
1056 return num
< lower
? lower
: num
<= upper
? num
: upper
;
1060 /* Extract a value or address from a Lisp_Object. */
1062 INLINE
struct Lisp_Cons
*
1063 (XCONS
) (Lisp_Object a
)
1065 return lisp_h_XCONS (a
);
1068 INLINE
struct Lisp_Vector
*
1069 XVECTOR (Lisp_Object a
)
1071 eassert (VECTORLIKEP (a
));
1072 return XUNTAG (a
, Lisp_Vectorlike
);
1075 INLINE
struct Lisp_String
*
1076 XSTRING (Lisp_Object a
)
1078 eassert (STRINGP (a
));
1079 return XUNTAG (a
, Lisp_String
);
1082 /* The index of the C-defined Lisp symbol SYM.
1083 This can be used in a static initializer. */
1084 #define SYMBOL_INDEX(sym) i##sym
1086 INLINE
struct Lisp_Float
*
1087 XFLOAT (Lisp_Object a
)
1089 eassert (FLOATP (a
));
1090 return XUNTAG (a
, Lisp_Float
);
1093 /* Pseudovector types. */
1095 INLINE
struct Lisp_Process
*
1096 XPROCESS (Lisp_Object a
)
1098 eassert (PROCESSP (a
));
1099 return XUNTAG (a
, Lisp_Vectorlike
);
1102 INLINE
struct window
*
1103 XWINDOW (Lisp_Object a
)
1105 eassert (WINDOWP (a
));
1106 return XUNTAG (a
, Lisp_Vectorlike
);
1109 INLINE
struct terminal
*
1110 XTERMINAL (Lisp_Object a
)
1112 eassert (TERMINALP (a
));
1113 return XUNTAG (a
, Lisp_Vectorlike
);
1116 INLINE
struct Lisp_Subr
*
1117 XSUBR (Lisp_Object a
)
1119 eassert (SUBRP (a
));
1120 return XUNTAG (a
, Lisp_Vectorlike
);
1123 INLINE
struct buffer
*
1124 XBUFFER (Lisp_Object a
)
1126 eassert (BUFFERP (a
));
1127 return XUNTAG (a
, Lisp_Vectorlike
);
1130 INLINE
struct Lisp_Char_Table
*
1131 XCHAR_TABLE (Lisp_Object a
)
1133 eassert (CHAR_TABLE_P (a
));
1134 return XUNTAG (a
, Lisp_Vectorlike
);
1137 INLINE
struct Lisp_Sub_Char_Table
*
1138 XSUB_CHAR_TABLE (Lisp_Object a
)
1140 eassert (SUB_CHAR_TABLE_P (a
));
1141 return XUNTAG (a
, Lisp_Vectorlike
);
1144 INLINE
struct Lisp_Bool_Vector
*
1145 XBOOL_VECTOR (Lisp_Object a
)
1147 eassert (BOOL_VECTOR_P (a
));
1148 return XUNTAG (a
, Lisp_Vectorlike
);
1151 INLINE
struct thread_state
*
1152 XTHREAD (Lisp_Object a
)
1154 eassert (THREADP (a
));
1155 return XUNTAG (a
, Lisp_Vectorlike
);
1158 INLINE
struct Lisp_Mutex
*
1159 XMUTEX (Lisp_Object a
)
1161 eassert (MUTEXP (a
));
1162 return XUNTAG (a
, Lisp_Vectorlike
);
1165 INLINE
struct Lisp_CondVar
*
1166 XCONDVAR (Lisp_Object a
)
1168 eassert (CONDVARP (a
));
1169 return XUNTAG (a
, Lisp_Vectorlike
);
1172 /* Construct a Lisp_Object from a value or address. */
1175 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
1177 Lisp_Object a
= XIL (TAG_PTR (type
, ptr
));
1178 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
1183 make_lisp_symbol (struct Lisp_Symbol
*sym
)
1185 Lisp_Object a
= XIL (TAG_SYMOFFSET ((char *) sym
- (char *) lispsym
));
1186 eassert (XSYMBOL (a
) == sym
);
1191 builtin_lisp_symbol (int index
)
1193 return make_lisp_symbol (lispsym
+ index
);
1196 #define XSETINT(a, b) ((a) = make_number (b))
1197 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1198 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1199 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1200 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1201 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1202 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1203 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1205 /* Pseudovector types. */
1207 #define XSETPVECTYPE(v, code) \
1208 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1209 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1210 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1211 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1212 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1215 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1216 #define XSETPSEUDOVECTOR(a, b, code) \
1217 XSETTYPED_PSEUDOVECTOR (a, b, \
1218 (((struct vectorlike_header *) \
1219 XUNTAG (a, Lisp_Vectorlike)) \
1222 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1223 (XSETVECTOR (a, b), \
1224 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1225 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1227 #define XSETWINDOW_CONFIGURATION(a, b) \
1228 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1229 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1230 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1231 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1232 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1233 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1234 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1235 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1236 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1237 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1238 #define XSETTHREAD(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_THREAD))
1239 #define XSETMUTEX(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_MUTEX))
1240 #define XSETCONDVAR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CONDVAR))
1242 /* Efficiently convert a pointer to a Lisp object and back. The
1243 pointer is represented as a Lisp integer, so the garbage collector
1244 does not know about it. The pointer should not have both Lisp_Int1
1245 bits set, which makes this conversion inherently unportable. */
1248 XINTPTR (Lisp_Object a
)
1250 return XUNTAG (a
, Lisp_Int0
);
1254 make_pointer_integer (void *p
)
1256 Lisp_Object a
= XIL (TAG_PTR (Lisp_Int0
, p
));
1257 eassert (INTEGERP (a
) && XINTPTR (a
) == p
);
1261 /* Type checking. */
1264 (CHECK_TYPE
) (int ok
, Lisp_Object predicate
, Lisp_Object x
)
1266 lisp_h_CHECK_TYPE (ok
, predicate
, x
);
1269 /* See the macros in intervals.h. */
1271 typedef struct interval
*INTERVAL
;
1273 struct GCALIGNED Lisp_Cons
1275 /* Car of this cons cell. */
1280 /* Cdr of this cons cell. */
1283 /* Used to chain conses on a free list. */
1284 struct Lisp_Cons
*chain
;
1288 /* Take the car or cdr of something known to be a cons cell. */
1289 /* The _addr functions shouldn't be used outside of the minimal set
1290 of code that has to know what a cons cell looks like. Other code not
1291 part of the basic lisp implementation should assume that the car and cdr
1292 fields are not accessible. (What if we want to switch to
1293 a copying collector someday? Cached cons cell field addresses may be
1294 invalidated at arbitrary points.) */
1295 INLINE Lisp_Object
*
1296 xcar_addr (Lisp_Object c
)
1298 return &XCONS (c
)->car
;
1300 INLINE Lisp_Object
*
1301 xcdr_addr (Lisp_Object c
)
1303 return &XCONS (c
)->u
.cdr
;
1306 /* Use these from normal code. */
1309 (XCAR
) (Lisp_Object c
)
1311 return lisp_h_XCAR (c
);
1315 (XCDR
) (Lisp_Object c
)
1317 return lisp_h_XCDR (c
);
1320 /* Use these to set the fields of a cons cell.
1322 Note that both arguments may refer to the same object, so 'n'
1323 should not be read after 'c' is first modified. */
1325 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1330 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1335 /* Take the car or cdr of something whose type is not known. */
1342 wrong_type_argument (Qlistp
, c
);
1351 wrong_type_argument (Qlistp
, c
);
1355 /* Take the car or cdr of something whose type is not known. */
1357 CAR_SAFE (Lisp_Object c
)
1359 return CONSP (c
) ? XCAR (c
) : Qnil
;
1362 CDR_SAFE (Lisp_Object c
)
1364 return CONSP (c
) ? XCDR (c
) : Qnil
;
1367 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1369 struct GCALIGNED Lisp_String
1372 ptrdiff_t size_byte
;
1373 INTERVAL intervals
; /* Text properties in this string. */
1374 unsigned char *data
;
1377 /* True if STR is a multibyte string. */
1379 STRING_MULTIBYTE (Lisp_Object str
)
1381 return 0 <= XSTRING (str
)->size_byte
;
1384 /* An upper bound on the number of bytes in a Lisp string, not
1385 counting the terminating null. This a tight enough bound to
1386 prevent integer overflow errors that would otherwise occur during
1387 string size calculations. A string cannot contain more bytes than
1388 a fixnum can represent, nor can it be so long that C pointer
1389 arithmetic stops working on the string plus its terminating null.
1390 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1391 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1392 would expose alloc.c internal details that we'd rather keep
1395 This is a macro for use in static initializers. The cast to
1396 ptrdiff_t ensures that the macro is signed. */
1397 #define STRING_BYTES_BOUND \
1398 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1400 /* Mark STR as a unibyte string. */
1401 #define STRING_SET_UNIBYTE(STR) \
1403 if (XSTRING (STR)->size == 0) \
1404 (STR) = empty_unibyte_string; \
1406 XSTRING (STR)->size_byte = -1; \
1409 /* Mark STR as a multibyte string. Assure that STR contains only
1410 ASCII characters in advance. */
1411 #define STRING_SET_MULTIBYTE(STR) \
1413 if (XSTRING (STR)->size == 0) \
1414 (STR) = empty_multibyte_string; \
1416 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1419 /* Convenience functions for dealing with Lisp strings. */
1421 INLINE
unsigned char *
1422 SDATA (Lisp_Object string
)
1424 return XSTRING (string
)->data
;
1427 SSDATA (Lisp_Object string
)
1429 /* Avoid "differ in sign" warnings. */
1430 return (char *) SDATA (string
);
1432 INLINE
unsigned char
1433 SREF (Lisp_Object string
, ptrdiff_t index
)
1435 return SDATA (string
)[index
];
1438 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1440 SDATA (string
)[index
] = new;
1443 SCHARS (Lisp_Object string
)
1445 return XSTRING (string
)->size
;
1448 #ifdef GC_CHECK_STRING_BYTES
1449 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1452 STRING_BYTES (struct Lisp_String
*s
)
1454 #ifdef GC_CHECK_STRING_BYTES
1455 return string_bytes (s
);
1457 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1462 SBYTES (Lisp_Object string
)
1464 return STRING_BYTES (XSTRING (string
));
1467 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1469 XSTRING (string
)->size
= newsize
;
1472 /* A regular vector is just a header plus an array of Lisp_Objects. */
1476 struct vectorlike_header header
;
1477 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1480 /* A boolvector is a kind of vectorlike, with contents like a string. */
1482 struct Lisp_Bool_Vector
1484 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1485 just the subtype information. */
1486 struct vectorlike_header header
;
1487 /* This is the size in bits. */
1489 /* The actual bits, packed into bytes.
1490 Zeros fill out the last word if needed.
1491 The bits are in little-endian order in the bytes, and
1492 the bytes are in little-endian order in the words. */
1493 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1497 bool_vector_size (Lisp_Object a
)
1499 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1500 eassume (0 <= size
);
1505 bool_vector_data (Lisp_Object a
)
1507 return XBOOL_VECTOR (a
)->data
;
1510 INLINE
unsigned char *
1511 bool_vector_uchar_data (Lisp_Object a
)
1513 return (unsigned char *) bool_vector_data (a
);
1516 /* The number of data words and bytes in a bool vector with SIZE bits. */
1519 bool_vector_words (EMACS_INT size
)
1521 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1522 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1526 bool_vector_bytes (EMACS_INT size
)
1528 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1529 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1532 /* True if A's Ith bit is set. */
1535 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1537 eassume (0 <= i
&& i
< bool_vector_size (a
));
1538 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1539 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1543 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1545 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1548 /* Set A's Ith bit to B. */
1551 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1553 unsigned char *addr
;
1555 eassume (0 <= i
&& i
< bool_vector_size (a
));
1556 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1559 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1561 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1564 /* Some handy constants for calculating sizes
1565 and offsets, mostly of vectorlike objects. */
1569 header_size
= offsetof (struct Lisp_Vector
, contents
),
1570 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1571 word_size
= sizeof (Lisp_Object
)
1574 /* Conveniences for dealing with Lisp arrays. */
1577 AREF (Lisp_Object array
, ptrdiff_t idx
)
1579 return XVECTOR (array
)->contents
[idx
];
1582 INLINE Lisp_Object
*
1583 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1585 return & XVECTOR (array
)->contents
[idx
];
1589 ASIZE (Lisp_Object array
)
1591 ptrdiff_t size
= XVECTOR (array
)->header
.size
;
1592 eassume (0 <= size
);
1597 gc_asize (Lisp_Object array
)
1599 /* Like ASIZE, but also can be used in the garbage collector. */
1600 return XVECTOR (array
)->header
.size
& ~ARRAY_MARK_FLAG
;
1604 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1606 eassert (0 <= idx
&& idx
< ASIZE (array
));
1607 XVECTOR (array
)->contents
[idx
] = val
;
1611 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1613 /* Like ASET, but also can be used in the garbage collector:
1614 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1615 eassert (0 <= idx
&& idx
< gc_asize (array
));
1616 XVECTOR (array
)->contents
[idx
] = val
;
1619 /* True, since Qnil's representation is zero. Every place in the code
1620 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1621 to find such assumptions later if we change Qnil to be nonzero. */
1622 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1624 /* Clear the object addressed by P, with size NBYTES, so that all its
1625 bytes are zero and all its Lisp values are nil. */
1627 memclear (void *p
, ptrdiff_t nbytes
)
1629 eassert (0 <= nbytes
);
1630 verify (NIL_IS_ZERO
);
1631 /* Since Qnil is zero, memset suffices. */
1632 memset (p
, 0, nbytes
);
1635 /* If a struct is made to look like a vector, this macro returns the length
1636 of the shortest vector that would hold that struct. */
1638 #define VECSIZE(type) \
1639 ((sizeof (type) - header_size + word_size - 1) / word_size)
1641 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1642 at the end and we need to compute the number of Lisp_Object fields (the
1643 ones that the GC needs to trace). */
1645 #define PSEUDOVECSIZE(type, nonlispfield) \
1646 ((offsetof (type, nonlispfield) - header_size) / word_size)
1648 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1649 should be integer expressions. This is not the same as
1650 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1651 returns true. For efficiency, prefer plain unsigned comparison if A
1652 and B's sizes both fit (after integer promotion). */
1653 #define UNSIGNED_CMP(a, op, b) \
1654 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1655 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1656 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1658 /* True iff C is an ASCII character. */
1659 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1661 /* A char-table is a kind of vectorlike, with contents are like a
1662 vector but with a few other slots. For some purposes, it makes
1663 sense to handle a char-table with type struct Lisp_Vector. An
1664 element of a char table can be any Lisp objects, but if it is a sub
1665 char-table, we treat it a table that contains information of a
1666 specific range of characters. A sub char-table is like a vector but
1667 with two integer fields between the header and Lisp data, which means
1668 that it has to be marked with some precautions (see mark_char_table
1669 in alloc.c). A sub char-table appears only in an element of a char-table,
1670 and there's no way to access it directly from Emacs Lisp program. */
1672 enum CHARTAB_SIZE_BITS
1674 CHARTAB_SIZE_BITS_0
= 6,
1675 CHARTAB_SIZE_BITS_1
= 4,
1676 CHARTAB_SIZE_BITS_2
= 5,
1677 CHARTAB_SIZE_BITS_3
= 7
1680 extern const int chartab_size
[4];
1682 struct Lisp_Char_Table
1684 /* HEADER.SIZE is the vector's size field, which also holds the
1685 pseudovector type information. It holds the size, too.
1686 The size counts the defalt, parent, purpose, ascii,
1687 contents, and extras slots. */
1688 struct vectorlike_header header
;
1690 /* This holds a default value,
1691 which is used whenever the value for a specific character is nil. */
1694 /* This points to another char table, which we inherit from when the
1695 value for a specific character is nil. The `defalt' slot takes
1696 precedence over this. */
1699 /* This is a symbol which says what kind of use this char-table is
1701 Lisp_Object purpose
;
1703 /* The bottom sub char-table for characters of the range 0..127. It
1704 is nil if none of ASCII character has a specific value. */
1707 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1709 /* These hold additional data. It is a vector. */
1710 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1713 struct Lisp_Sub_Char_Table
1715 /* HEADER.SIZE is the vector's size field, which also holds the
1716 pseudovector type information. It holds the size, too. */
1717 struct vectorlike_header header
;
1719 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1720 char-table of depth 1 contains 16 elements, and each element
1721 covers 4096 (128*32) characters. A sub char-table of depth 2
1722 contains 32 elements, and each element covers 128 characters. A
1723 sub char-table of depth 3 contains 128 elements, and each element
1724 is for one character. */
1727 /* Minimum character covered by the sub char-table. */
1730 /* Use set_sub_char_table_contents to set this. */
1731 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1735 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1737 struct Lisp_Char_Table
*tbl
= NULL
;
1741 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1742 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1743 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1747 while (NILP (val
) && ! NILP (tbl
->parent
));
1752 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1753 characters. Do not check validity of CT. */
1755 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1757 return (ASCII_CHAR_P (idx
)
1758 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1759 : char_table_ref (ct
, idx
));
1762 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1763 8-bit European characters. Do not check validity of CT. */
1765 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1767 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1768 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1770 char_table_set (ct
, idx
, val
);
1773 /* This structure describes a built-in function.
1774 It is generated by the DEFUN macro only.
1775 defsubr makes it into a Lisp object. */
1779 struct vectorlike_header header
;
1781 Lisp_Object (*a0
) (void);
1782 Lisp_Object (*a1
) (Lisp_Object
);
1783 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1784 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1785 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1786 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1787 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1788 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1789 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1790 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1791 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1793 short min_args
, max_args
;
1794 const char *symbol_name
;
1795 const char *intspec
;
1799 enum char_table_specials
1801 /* This is the number of slots that every char table must have. This
1802 counts the ordinary slots and the top, defalt, parent, and purpose
1804 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1806 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1807 when the latter is treated as an ordinary Lisp_Vector. */
1808 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1811 /* Return the number of "extra" slots in the char table CT. */
1814 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1816 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1817 - CHAR_TABLE_STANDARD_SLOTS
);
1820 /* Make sure that sub char-table contents slot is where we think it is. */
1821 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1822 == (offsetof (struct Lisp_Vector
, contents
)
1823 + SUB_CHAR_TABLE_OFFSET
* sizeof (Lisp_Object
)));
1825 /***********************************************************************
1827 ***********************************************************************/
1829 /* Value is name of symbol. */
1832 (SYMBOL_VAL
) (struct Lisp_Symbol
*sym
)
1834 return lisp_h_SYMBOL_VAL (sym
);
1837 INLINE
struct Lisp_Symbol
*
1838 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1840 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1841 return sym
->val
.alias
;
1843 INLINE
struct Lisp_Buffer_Local_Value
*
1844 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1846 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1847 return sym
->val
.blv
;
1849 INLINE
union Lisp_Fwd
*
1850 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1852 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1853 return sym
->val
.fwd
;
1857 (SET_SYMBOL_VAL
) (struct Lisp_Symbol
*sym
, Lisp_Object v
)
1859 lisp_h_SET_SYMBOL_VAL (sym
, v
);
1863 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1865 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1869 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1871 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1875 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1877 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1882 SYMBOL_NAME (Lisp_Object sym
)
1884 return XSYMBOL (sym
)->name
;
1887 /* Value is true if SYM is an interned symbol. */
1890 SYMBOL_INTERNED_P (Lisp_Object sym
)
1892 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1895 /* Value is true if SYM is interned in initial_obarray. */
1898 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1900 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1903 /* Value is non-zero if symbol cannot be changed through a simple set,
1904 i.e. it's a constant (e.g. nil, t, :keywords), or it has some
1905 watching functions. */
1908 (SYMBOL_TRAPPED_WRITE_P
) (Lisp_Object sym
)
1910 return lisp_h_SYMBOL_TRAPPED_WRITE_P (sym
);
1913 /* Value is non-zero if symbol cannot be changed at all, i.e. it's a
1914 constant (e.g. nil, t, :keywords). Code that actually wants to
1915 write to SYM, should also check whether there are any watching
1919 (SYMBOL_CONSTANT_P
) (Lisp_Object sym
)
1921 return lisp_h_SYMBOL_CONSTANT_P (sym
);
1924 /* Placeholder for make-docfile to process. The actual symbol
1925 definition is done by lread.c's defsym. */
1926 #define DEFSYM(sym, name) /* empty */
1929 /***********************************************************************
1931 ***********************************************************************/
1933 /* The structure of a Lisp hash table. */
1935 struct hash_table_test
1937 /* Name of the function used to compare keys. */
1940 /* User-supplied hash function, or nil. */
1941 Lisp_Object user_hash_function
;
1943 /* User-supplied key comparison function, or nil. */
1944 Lisp_Object user_cmp_function
;
1946 /* C function to compare two keys. */
1947 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1949 /* C function to compute hash code. */
1950 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1953 struct Lisp_Hash_Table
1955 /* This is for Lisp; the hash table code does not refer to it. */
1956 struct vectorlike_header header
;
1958 /* Nil if table is non-weak. Otherwise a symbol describing the
1959 weakness of the table. */
1962 /* When the table is resized, and this is an integer, compute the
1963 new size by adding this to the old size. If a float, compute the
1964 new size by multiplying the old size with this factor. */
1965 Lisp_Object rehash_size
;
1967 /* Resize hash table when number of entries/ table size is >= this
1969 Lisp_Object rehash_threshold
;
1971 /* Vector of hash codes. If hash[I] is nil, this means that the
1972 I-th entry is unused. */
1975 /* Vector used to chain entries. If entry I is free, next[I] is the
1976 entry number of the next free item. If entry I is non-free,
1977 next[I] is the index of the next entry in the collision chain. */
1980 /* Index of first free entry in free list. */
1981 Lisp_Object next_free
;
1983 /* Bucket vector. A non-nil entry is the index of the first item in
1984 a collision chain. This vector's size can be larger than the
1985 hash table size to reduce collisions. */
1988 /* Only the fields above are traced normally by the GC. The ones below
1989 `count' are special and are either ignored by the GC or traced in
1990 a special way (e.g. because of weakness). */
1992 /* Number of key/value entries in the table. */
1995 /* Vector of keys and values. The key of item I is found at index
1996 2 * I, the value is found at index 2 * I + 1.
1997 This is gc_marked specially if the table is weak. */
1998 Lisp_Object key_and_value
;
2000 /* The comparison and hash functions. */
2001 struct hash_table_test test
;
2003 /* Next weak hash table if this is a weak hash table. The head
2004 of the list is in weak_hash_tables. */
2005 struct Lisp_Hash_Table
*next_weak
;
2010 HASH_TABLE_P (Lisp_Object a
)
2012 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
2015 INLINE
struct Lisp_Hash_Table
*
2016 XHASH_TABLE (Lisp_Object a
)
2018 eassert (HASH_TABLE_P (a
));
2019 return XUNTAG (a
, Lisp_Vectorlike
);
2022 #define XSET_HASH_TABLE(VAR, PTR) \
2023 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
2025 /* Value is the key part of entry IDX in hash table H. */
2027 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2029 return AREF (h
->key_and_value
, 2 * idx
);
2032 /* Value is the value part of entry IDX in hash table H. */
2034 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2036 return AREF (h
->key_and_value
, 2 * idx
+ 1);
2039 /* Value is the index of the next entry following the one at IDX
2042 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2044 return AREF (h
->next
, idx
);
2047 /* Value is the hash code computed for entry IDX in hash table H. */
2049 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2051 return AREF (h
->hash
, idx
);
2054 /* Value is the index of the element in hash table H that is the
2055 start of the collision list at index IDX in the index vector of H. */
2057 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2059 return AREF (h
->index
, idx
);
2062 /* Value is the size of hash table H. */
2064 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
2066 return ASIZE (h
->next
);
2069 /* Default size for hash tables if not specified. */
2071 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
2073 /* Default threshold specifying when to resize a hash table. The
2074 value gives the ratio of current entries in the hash table and the
2075 size of the hash table. */
2077 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
2079 /* Default factor by which to increase the size of a hash table. */
2081 static double const DEFAULT_REHASH_SIZE
= 1.5;
2083 /* Combine two integers X and Y for hashing. The result might not fit
2084 into a Lisp integer. */
2087 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
2089 return (x
<< 4) + (x
>> (EMACS_INT_WIDTH
- 4)) + y
;
2092 /* Hash X, returning a value that fits into a fixnum. */
2095 SXHASH_REDUCE (EMACS_UINT x
)
2097 return (x
^ x
>> (EMACS_INT_WIDTH
- FIXNUM_BITS
)) & INTMASK
;
2100 /* These structures are used for various misc types. */
2102 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
2104 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
2105 bool_bf gcmarkbit
: 1;
2106 unsigned spacer
: 15;
2111 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
2112 bool_bf gcmarkbit
: 1;
2113 unsigned spacer
: 13;
2114 /* This flag is temporarily used in the functions
2115 decode/encode_coding_object to record that the marker position
2116 must be adjusted after the conversion. */
2117 bool_bf need_adjustment
: 1;
2118 /* True means normal insertion at the marker's position
2119 leaves the marker after the inserted text. */
2120 bool_bf insertion_type
: 1;
2121 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2122 Note: a chain of markers can contain markers pointing into different
2123 buffers (the chain is per buffer_text rather than per buffer, so it's
2124 shared between indirect buffers). */
2125 /* This is used for (other than NULL-checking):
2127 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2128 - unchain_marker: to find the list from which to unchain.
2129 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2131 struct buffer
*buffer
;
2133 /* The remaining fields are meaningless in a marker that
2134 does not point anywhere. */
2136 /* For markers that point somewhere,
2137 this is used to chain of all the markers in a given buffer. */
2138 /* We could remove it and use an array in buffer_text instead.
2139 That would also allow us to preserve it ordered. */
2140 struct Lisp_Marker
*next
;
2141 /* This is the char position where the marker points. */
2143 /* This is the byte position.
2144 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2145 used to implement the functionality of markers, but rather to (ab)use
2146 markers as a cache for char<->byte mappings). */
2150 /* START and END are markers in the overlay's buffer, and
2151 PLIST is the overlay's property list. */
2153 /* An overlay's real data content is:
2155 - buffer (really there are two buffer pointers, one per marker,
2156 and both points to the same buffer)
2157 - insertion type of both ends (per-marker fields)
2158 - start & start byte (of start marker)
2159 - end & end byte (of end marker)
2160 - next (singly linked list of overlays)
2161 - next fields of start and end markers (singly linked list of markers).
2162 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2165 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2166 bool_bf gcmarkbit
: 1;
2167 unsigned spacer
: 15;
2168 struct Lisp_Overlay
*next
;
2174 /* Number of bits needed to store one of the values
2175 SAVE_UNUSED..SAVE_OBJECT. */
2176 enum { SAVE_SLOT_BITS
= 3 };
2178 /* Number of slots in a save value where save_type is nonzero. */
2179 enum { SAVE_VALUE_SLOTS
= 4 };
2181 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2183 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2185 /* Types of data which may be saved in a Lisp_Save_Value. */
2194 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2195 SAVE_TYPE_INT_INT_INT
2196 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2197 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2198 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2199 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2200 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2201 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2202 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2203 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2204 SAVE_TYPE_FUNCPTR_PTR_OBJ
2205 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2207 /* This has an extra bit indicating it's raw memory. */
2208 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2211 /* SAVE_SLOT_BITS must be large enough to represent these values. */
2212 verify (((SAVE_UNUSED
| SAVE_INTEGER
| SAVE_FUNCPOINTER
2213 | SAVE_POINTER
| SAVE_OBJECT
)
2217 /* Special object used to hold a different values for later use.
2219 This is mostly used to package C integers and pointers to call
2220 record_unwind_protect when two or more values need to be saved.
2224 struct my_data *md = get_my_data ();
2225 ptrdiff_t mi = get_my_integer ();
2226 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2229 Lisp_Object my_unwind (Lisp_Object arg)
2231 struct my_data *md = XSAVE_POINTER (arg, 0);
2232 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2236 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2237 saved objects and raise eassert if type of the saved object doesn't match
2238 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2239 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2240 slot 0 is a pointer. */
2242 typedef void (*voidfuncptr
) (void);
2244 struct Lisp_Save_Value
2246 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2247 bool_bf gcmarkbit
: 1;
2248 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2250 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2251 V's data entries are determined by V->save_type. E.g., if
2252 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2253 V->data[1] is an integer, and V's other data entries are unused.
2255 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2256 a memory area containing V->data[1].integer potential Lisp_Objects. */
2257 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2260 voidfuncptr funcpointer
;
2263 } data
[SAVE_VALUE_SLOTS
];
2266 /* Return the type of V's Nth saved value. */
2268 save_type (struct Lisp_Save_Value
*v
, int n
)
2270 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2271 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2274 /* Get and set the Nth saved pointer. */
2277 XSAVE_POINTER (Lisp_Object obj
, int n
)
2279 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2280 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2283 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2285 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2286 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2289 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2291 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2292 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2295 /* Likewise for the saved integer. */
2298 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2300 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2301 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2304 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2306 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2307 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2310 /* Extract Nth saved object. */
2313 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2315 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2316 return XSAVE_VALUE (obj
)->data
[n
].object
;
2320 struct Lisp_User_Ptr
2322 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_User_Ptr */
2323 bool_bf gcmarkbit
: 1;
2324 unsigned spacer
: 15;
2326 void (*finalizer
) (void *);
2331 /* A finalizer sentinel. */
2332 struct Lisp_Finalizer
2334 struct Lisp_Misc_Any base
;
2336 /* Circular list of all active weak references. */
2337 struct Lisp_Finalizer
*prev
;
2338 struct Lisp_Finalizer
*next
;
2340 /* Call FUNCTION when the finalizer becomes unreachable, even if
2341 FUNCTION contains a reference to the finalizer; i.e., call
2342 FUNCTION when it is reachable _only_ through finalizers. */
2343 Lisp_Object function
;
2346 /* A miscellaneous object, when it's on the free list. */
2349 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2350 bool_bf gcmarkbit
: 1;
2351 unsigned spacer
: 15;
2352 union Lisp_Misc
*chain
;
2355 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2356 It uses one of these struct subtypes to get the type field. */
2360 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2361 struct Lisp_Free u_free
;
2362 struct Lisp_Marker u_marker
;
2363 struct Lisp_Overlay u_overlay
;
2364 struct Lisp_Save_Value u_save_value
;
2365 struct Lisp_Finalizer u_finalizer
;
2367 struct Lisp_User_Ptr u_user_ptr
;
2371 INLINE
union Lisp_Misc
*
2372 XMISC (Lisp_Object a
)
2374 return XUNTAG (a
, Lisp_Misc
);
2377 INLINE
struct Lisp_Misc_Any
*
2378 XMISCANY (Lisp_Object a
)
2380 eassert (MISCP (a
));
2381 return & XMISC (a
)->u_any
;
2384 INLINE
enum Lisp_Misc_Type
2385 XMISCTYPE (Lisp_Object a
)
2387 return XMISCANY (a
)->type
;
2390 INLINE
struct Lisp_Marker
*
2391 XMARKER (Lisp_Object a
)
2393 eassert (MARKERP (a
));
2394 return & XMISC (a
)->u_marker
;
2397 INLINE
struct Lisp_Overlay
*
2398 XOVERLAY (Lisp_Object a
)
2400 eassert (OVERLAYP (a
));
2401 return & XMISC (a
)->u_overlay
;
2404 INLINE
struct Lisp_Save_Value
*
2405 XSAVE_VALUE (Lisp_Object a
)
2407 eassert (SAVE_VALUEP (a
));
2408 return & XMISC (a
)->u_save_value
;
2411 INLINE
struct Lisp_Finalizer
*
2412 XFINALIZER (Lisp_Object a
)
2414 eassert (FINALIZERP (a
));
2415 return & XMISC (a
)->u_finalizer
;
2419 INLINE
struct Lisp_User_Ptr
*
2420 XUSER_PTR (Lisp_Object a
)
2422 eassert (USER_PTRP (a
));
2423 return & XMISC (a
)->u_user_ptr
;
2428 /* Forwarding pointer to an int variable.
2429 This is allowed only in the value cell of a symbol,
2430 and it means that the symbol's value really lives in the
2431 specified int variable. */
2434 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2438 /* Boolean forwarding pointer to an int variable.
2439 This is like Lisp_Intfwd except that the ostensible
2440 "value" of the symbol is t if the bool variable is true,
2441 nil if it is false. */
2444 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2448 /* Forwarding pointer to a Lisp_Object variable.
2449 This is allowed only in the value cell of a symbol,
2450 and it means that the symbol's value really lives in the
2451 specified variable. */
2454 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2455 Lisp_Object
*objvar
;
2458 /* Like Lisp_Objfwd except that value lives in a slot in the
2459 current buffer. Value is byte index of slot within buffer. */
2460 struct Lisp_Buffer_Objfwd
2462 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2464 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2465 Lisp_Object predicate
;
2468 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2469 the symbol has buffer-local bindings. (Exception:
2470 some buffer-local variables are built-in, with their values stored
2471 in the buffer structure itself. They are handled differently,
2472 using struct Lisp_Buffer_Objfwd.)
2474 The `realvalue' slot holds the variable's current value, or a
2475 forwarding pointer to where that value is kept. This value is the
2476 one that corresponds to the loaded binding. To read or set the
2477 variable, you must first make sure the right binding is loaded;
2478 then you can access the value in (or through) `realvalue'.
2480 `buffer' and `frame' are the buffer and frame for which the loaded
2481 binding was found. If those have changed, to make sure the right
2482 binding is loaded it is necessary to find which binding goes with
2483 the current buffer and selected frame, then load it. To load it,
2484 first unload the previous binding, then copy the value of the new
2485 binding into `realvalue' (or through it). Also update
2486 LOADED-BINDING to point to the newly loaded binding.
2488 `local_if_set' indicates that merely setting the variable creates a
2489 local binding for the current buffer. Otherwise the latter, setting
2490 the variable does not do that; only make-local-variable does that. */
2492 struct Lisp_Buffer_Local_Value
2494 /* True means that merely setting the variable creates a local
2495 binding for the current buffer. */
2496 bool_bf local_if_set
: 1;
2497 /* True means that the binding now loaded was found.
2498 Presumably equivalent to (defcell!=valcell). */
2500 /* If non-NULL, a forwarding to the C var where it should also be set. */
2501 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2502 /* The buffer or frame for which the loaded binding was found. */
2504 /* A cons cell that holds the default value. It has the form
2505 (SYMBOL . DEFAULT-VALUE). */
2506 Lisp_Object defcell
;
2507 /* The cons cell from `where's parameter alist.
2508 It always has the form (SYMBOL . VALUE)
2509 Note that if `forward' is non-nil, VALUE may be out of date.
2510 Also if the currently loaded binding is the default binding, then
2511 this is `eq'ual to defcell. */
2512 Lisp_Object valcell
;
2515 /* Like Lisp_Objfwd except that value lives in a slot in the
2517 struct Lisp_Kboard_Objfwd
2519 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2525 struct Lisp_Intfwd u_intfwd
;
2526 struct Lisp_Boolfwd u_boolfwd
;
2527 struct Lisp_Objfwd u_objfwd
;
2528 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2529 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2532 INLINE
enum Lisp_Fwd_Type
2533 XFWDTYPE (union Lisp_Fwd
*a
)
2535 return a
->u_intfwd
.type
;
2538 INLINE
struct Lisp_Buffer_Objfwd
*
2539 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2541 eassert (BUFFER_OBJFWDP (a
));
2542 return &a
->u_buffer_objfwd
;
2545 /* Lisp floating point type. */
2551 struct Lisp_Float
*chain
;
2556 XFLOAT_DATA (Lisp_Object f
)
2558 return XFLOAT (f
)->u
.data
;
2561 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2562 representations, have infinities and NaNs, and do not trap on
2563 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2564 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2565 wanted here, but is not quite right because Emacs does not require
2566 all the features of C11 Annex F (and does not require C11 at all,
2567 for that matter). */
2571 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2572 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2575 /* A character, declared with the following typedef, is a member
2576 of some character set associated with the current buffer. */
2577 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2579 typedef unsigned char UCHAR
;
2582 /* Meanings of slots in a Lisp_Compiled: */
2586 COMPILED_ARGLIST
= 0,
2587 COMPILED_BYTECODE
= 1,
2588 COMPILED_CONSTANTS
= 2,
2589 COMPILED_STACK_DEPTH
= 3,
2590 COMPILED_DOC_STRING
= 4,
2591 COMPILED_INTERACTIVE
= 5
2594 /* Flag bits in a character. These also get used in termhooks.h.
2595 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2596 (MUlti-Lingual Emacs) might need 22 bits for the character value
2597 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2600 CHAR_ALT
= 0x0400000,
2601 CHAR_SUPER
= 0x0800000,
2602 CHAR_HYPER
= 0x1000000,
2603 CHAR_SHIFT
= 0x2000000,
2604 CHAR_CTL
= 0x4000000,
2605 CHAR_META
= 0x8000000,
2607 CHAR_MODIFIER_MASK
=
2608 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2610 /* Actually, the current Emacs uses 22 bits for the character value
2615 /* Data type checking. */
2618 (NILP
) (Lisp_Object x
)
2620 return lisp_h_NILP (x
);
2624 NUMBERP (Lisp_Object x
)
2626 return INTEGERP (x
) || FLOATP (x
);
2629 NATNUMP (Lisp_Object x
)
2631 return INTEGERP (x
) && 0 <= XINT (x
);
2635 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2637 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2640 #define TYPE_RANGED_INTEGERP(type, x) \
2642 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2643 && XINT (x) <= TYPE_MAXIMUM (type))
2646 (CONSP
) (Lisp_Object x
)
2648 return lisp_h_CONSP (x
);
2651 (FLOATP
) (Lisp_Object x
)
2653 return lisp_h_FLOATP (x
);
2656 (MISCP
) (Lisp_Object x
)
2658 return lisp_h_MISCP (x
);
2661 (SYMBOLP
) (Lisp_Object x
)
2663 return lisp_h_SYMBOLP (x
);
2666 (INTEGERP
) (Lisp_Object x
)
2668 return lisp_h_INTEGERP (x
);
2671 (VECTORLIKEP
) (Lisp_Object x
)
2673 return lisp_h_VECTORLIKEP (x
);
2676 (MARKERP
) (Lisp_Object x
)
2678 return lisp_h_MARKERP (x
);
2682 STRINGP (Lisp_Object x
)
2684 return XTYPE (x
) == Lisp_String
;
2687 VECTORP (Lisp_Object x
)
2689 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2692 OVERLAYP (Lisp_Object x
)
2694 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2697 SAVE_VALUEP (Lisp_Object x
)
2699 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2703 FINALIZERP (Lisp_Object x
)
2705 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Finalizer
;
2710 USER_PTRP (Lisp_Object x
)
2712 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_User_Ptr
;
2717 AUTOLOADP (Lisp_Object x
)
2719 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2723 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2725 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2729 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2731 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2732 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2735 /* True if A is a pseudovector whose code is CODE. */
2737 PSEUDOVECTORP (Lisp_Object a
, int code
)
2739 if (! VECTORLIKEP (a
))
2743 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2744 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2745 return PSEUDOVECTOR_TYPEP (h
, code
);
2750 /* Test for specific pseudovector types. */
2753 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2755 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2759 PROCESSP (Lisp_Object a
)
2761 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2765 WINDOWP (Lisp_Object a
)
2767 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2771 TERMINALP (Lisp_Object a
)
2773 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2777 SUBRP (Lisp_Object a
)
2779 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2783 COMPILEDP (Lisp_Object a
)
2785 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2789 BUFFERP (Lisp_Object a
)
2791 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2795 CHAR_TABLE_P (Lisp_Object a
)
2797 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2801 SUB_CHAR_TABLE_P (Lisp_Object a
)
2803 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2807 BOOL_VECTOR_P (Lisp_Object a
)
2809 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2813 FRAMEP (Lisp_Object a
)
2815 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2819 THREADP (Lisp_Object a
)
2821 return PSEUDOVECTORP (a
, PVEC_THREAD
);
2825 MUTEXP (Lisp_Object a
)
2827 return PSEUDOVECTORP (a
, PVEC_MUTEX
);
2831 CONDVARP (Lisp_Object a
)
2833 return PSEUDOVECTORP (a
, PVEC_CONDVAR
);
2836 /* Test for image (image . spec) */
2838 IMAGEP (Lisp_Object x
)
2840 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2845 ARRAYP (Lisp_Object x
)
2847 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2851 CHECK_LIST (Lisp_Object x
)
2853 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2857 (CHECK_LIST_CONS
) (Lisp_Object x
, Lisp_Object y
)
2859 lisp_h_CHECK_LIST_CONS (x
, y
);
2863 (CHECK_SYMBOL
) (Lisp_Object x
)
2865 lisp_h_CHECK_SYMBOL (x
);
2869 (CHECK_NUMBER
) (Lisp_Object x
)
2871 lisp_h_CHECK_NUMBER (x
);
2875 CHECK_STRING (Lisp_Object x
)
2877 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2880 CHECK_STRING_CAR (Lisp_Object x
)
2882 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2885 CHECK_CONS (Lisp_Object x
)
2887 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2890 CHECK_VECTOR (Lisp_Object x
)
2892 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2895 CHECK_BOOL_VECTOR (Lisp_Object x
)
2897 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2899 /* This is a bit special because we always need size afterwards. */
2901 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2907 wrong_type_argument (Qarrayp
, x
);
2910 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2912 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2915 CHECK_BUFFER (Lisp_Object x
)
2917 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2920 CHECK_WINDOW (Lisp_Object x
)
2922 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2926 CHECK_PROCESS (Lisp_Object x
)
2928 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2932 CHECK_NATNUM (Lisp_Object x
)
2934 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2937 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2940 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2941 args_out_of_range_3 \
2943 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2944 ? MOST_NEGATIVE_FIXNUM \
2946 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2948 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2950 if (TYPE_SIGNED (type)) \
2951 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2953 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2956 #define CHECK_NUMBER_COERCE_MARKER(x) \
2958 if (MARKERP ((x))) \
2959 XSETFASTINT (x, marker_position (x)); \
2961 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2965 XFLOATINT (Lisp_Object n
)
2967 return extract_float (n
);
2971 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2973 CHECK_TYPE (NUMBERP (x
), Qnumberp
, x
);
2976 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2979 XSETFASTINT (x, marker_position (x)); \
2981 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2986 CHECK_THREAD (Lisp_Object x
)
2988 CHECK_TYPE (THREADP (x
), Qthreadp
, x
);
2992 CHECK_MUTEX (Lisp_Object x
)
2994 CHECK_TYPE (MUTEXP (x
), Qmutexp
, x
);
2998 CHECK_CONDVAR (Lisp_Object x
)
3000 CHECK_TYPE (CONDVARP (x
), Qcondition_variable_p
, x
);
3003 /* Since we can't assign directly to the CAR or CDR fields of a cons
3004 cell, use these when checking that those fields contain numbers. */
3006 CHECK_NUMBER_CAR (Lisp_Object x
)
3008 Lisp_Object tmp
= XCAR (x
);
3014 CHECK_NUMBER_CDR (Lisp_Object x
)
3016 Lisp_Object tmp
= XCDR (x
);
3021 /* Define a built-in function for calling from Lisp.
3022 `lname' should be the name to give the function in Lisp,
3023 as a null-terminated C string.
3024 `fnname' should be the name of the function in C.
3025 By convention, it starts with F.
3026 `sname' should be the name for the C constant structure
3027 that records information on this function for internal use.
3028 By convention, it should be the same as `fnname' but with S instead of F.
3029 It's too bad that C macros can't compute this from `fnname'.
3030 `minargs' should be a number, the minimum number of arguments allowed.
3031 `maxargs' should be a number, the maximum number of arguments allowed,
3032 or else MANY or UNEVALLED.
3033 MANY means pass a vector of evaluated arguments,
3034 in the form of an integer number-of-arguments
3035 followed by the address of a vector of Lisp_Objects
3036 which contains the argument values.
3037 UNEVALLED means pass the list of unevaluated arguments
3038 `intspec' says how interactive arguments are to be fetched.
3039 If the string starts with a `(', `intspec' is evaluated and the resulting
3040 list is the list of arguments.
3041 If it's a string that doesn't start with `(', the value should follow
3042 the one of the doc string for `interactive'.
3043 A null string means call interactively with no arguments.
3044 `doc' is documentation for the user. */
3046 /* This version of DEFUN declares a function prototype with the right
3047 arguments, so we can catch errors with maxargs at compile-time. */
3049 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
3050 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
3051 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
3052 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
3053 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
3054 { (Lisp_Object (__cdecl *)(void))fnname }, \
3055 minargs, maxargs, lname, intspec, 0}; \
3057 #else /* not _MSC_VER */
3058 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
3059 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
3060 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
3061 { .a ## maxargs = fnname }, \
3062 minargs, maxargs, lname, intspec, 0}; \
3067 is how we define the symbol for function `name' at start-up time. */
3068 extern void defsubr (struct Lisp_Subr
*);
3076 /* Call a function F that accepts many args, passing it ARRAY's elements. */
3077 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
3079 /* Call a function F that accepts many args, passing it the remaining args,
3080 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
3081 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
3082 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
3083 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
3085 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
3086 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
3087 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
3088 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
3089 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
3091 /* Macros we use to define forwarded Lisp variables.
3092 These are used in the syms_of_FILENAME functions.
3094 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
3095 lisp variable is actually a field in `struct emacs_globals'. The
3096 field's name begins with "f_", which is a convention enforced by
3097 these macros. Each such global has a corresponding #define in
3098 globals.h; the plain name should be used in the code.
3100 E.g., the global "cons_cells_consed" is declared as "int
3101 f_cons_cells_consed" in globals.h, but there is a define:
3103 #define cons_cells_consed globals.f_cons_cells_consed
3105 All C code uses the `cons_cells_consed' name. This is all done
3106 this way to support indirection for multi-threaded Emacs. */
3108 #define DEFVAR_LISP(lname, vname, doc) \
3110 static struct Lisp_Objfwd o_fwd; \
3111 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
3113 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
3115 static struct Lisp_Objfwd o_fwd; \
3116 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
3118 #define DEFVAR_BOOL(lname, vname, doc) \
3120 static struct Lisp_Boolfwd b_fwd; \
3121 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
3123 #define DEFVAR_INT(lname, vname, doc) \
3125 static struct Lisp_Intfwd i_fwd; \
3126 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
3129 #define DEFVAR_KBOARD(lname, vname, doc) \
3131 static struct Lisp_Kboard_Objfwd ko_fwd; \
3132 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
3135 /* Save and restore the instruction and environment pointers,
3136 without affecting the signal mask. */
3139 typedef jmp_buf sys_jmp_buf
;
3140 # define sys_setjmp(j) _setjmp (j)
3141 # define sys_longjmp(j, v) _longjmp (j, v)
3142 #elif defined HAVE_SIGSETJMP
3143 typedef sigjmp_buf sys_jmp_buf
;
3144 # define sys_setjmp(j) sigsetjmp (j, 0)
3145 # define sys_longjmp(j, v) siglongjmp (j, v)
3147 /* A platform that uses neither _longjmp nor siglongjmp; assume
3148 longjmp does not affect the sigmask. */
3149 typedef jmp_buf sys_jmp_buf
;
3150 # define sys_setjmp(j) setjmp (j)
3151 # define sys_longjmp(j, v) longjmp (j, v)
3155 /* Elisp uses several stacks:
3157 - the bytecode stack: used internally by the bytecode interpreter.
3158 Allocated from the C stack.
3159 - The specpdl stack: keeps track of active unwind-protect and
3160 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
3162 - The handler stack: keeps track of active catch tags and condition-case
3163 handlers. Allocated in a manually managed stack implemented by a
3164 doubly-linked list allocated via xmalloc and never freed. */
3166 /* Structure for recording Lisp call stack for backtrace purposes. */
3168 /* The special binding stack holds the outer values of variables while
3169 they are bound by a function application or a let form, stores the
3170 code to be executed for unwind-protect forms.
3172 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
3173 used all over the place, needs to be fast, and needs to know the size of
3174 union specbinding. But only eval.c should access it. */
3177 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
3178 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
3179 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
3180 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
3181 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
3182 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
3183 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3184 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
3185 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
3190 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3192 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3193 void (*func
) (Lisp_Object
);
3197 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3198 void (*func
) (void *);
3202 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3207 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3208 void (*func
) (void);
3211 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3212 /* `where' is not used in the case of SPECPDL_LET. */
3213 Lisp_Object symbol
, old_value
, where
;
3214 /* Normally this is unused; but it is set to the symbol's
3215 current value when a thread is swapped out. */
3216 Lisp_Object saved_value
;
3219 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3220 bool_bf debug_on_exit
: 1;
3221 Lisp_Object function
;
3227 /* These 3 are defined as macros in thread.h. */
3228 /* extern union specbinding *specpdl; */
3229 /* extern union specbinding *specpdl_ptr; */
3230 /* extern ptrdiff_t specpdl_size; */
3233 SPECPDL_INDEX (void)
3235 return specpdl_ptr
- specpdl
;
3238 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3239 control structures. A struct handler contains all the information needed to
3240 restore the state of the interpreter after a non-local jump.
3242 handler structures are chained together in a doubly linked list; the `next'
3243 member points to the next outer catchtag and the `nextfree' member points in
3244 the other direction to the next inner element (which is typically the next
3245 free element since we mostly use it on the deepest handler).
3247 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3248 member is TAG, and then unbinds to it. The `val' member is used to
3249 hold VAL while the stack is unwound; `val' is returned as the value
3250 of the catch form. If there is a handler of type CATCHER_ALL, it will
3251 be treated as a handler for all invocations of `throw'; in this case
3252 `val' will be set to (TAG . VAL).
3254 All the other members are concerned with restoring the interpreter
3257 Members are volatile if their values need to survive _longjmp when
3258 a 'struct handler' is a local variable. */
3260 enum handlertype
{ CATCHER
, CONDITION_CASE
, CATCHER_ALL
};
3264 enum handlertype type
;
3265 Lisp_Object tag_or_ch
;
3267 struct handler
*next
;
3268 struct handler
*nextfree
;
3270 /* The bytecode interpreter can have several handlers active at the same
3271 time, so when we longjmp to one of them, it needs to know which handler
3272 this was and what was the corresponding internal state. This is stored
3273 here, and when we longjmp we make sure that handlerlist points to the
3275 Lisp_Object
*bytecode_top
;
3278 /* Most global vars are reset to their value via the specpdl mechanism,
3279 but a few others are handled by storing their value here. */
3281 EMACS_INT f_lisp_eval_depth
;
3283 int poll_suppress_count
;
3284 int interrupt_input_blocked
;
3285 struct byte_stack
*byte_stack
;
3288 extern Lisp_Object memory_signal_data
;
3290 /* Check quit-flag and quit if it is non-nil.
3291 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
3292 So the program needs to do QUIT at times when it is safe to quit.
3293 Every loop that might run for a long time or might not exit
3294 ought to do QUIT at least once, at a safe place.
3295 Unless that is impossible, of course.
3296 But it is very desirable to avoid creating loops where QUIT is impossible.
3298 Exception: if you set immediate_quit to true,
3299 then the handler that responds to the C-g does the quit itself.
3300 This is a good thing to do around a loop that has no side effects
3301 and (in particular) cannot call arbitrary Lisp code.
3303 If quit-flag is set to `kill-emacs' the SIGINT handler has received
3304 a request to exit Emacs when it is safe to do. */
3306 extern void process_pending_signals (void);
3307 extern bool volatile pending_signals
;
3309 extern void process_quit_flag (void);
3312 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3313 process_quit_flag (); \
3314 else if (pending_signals) \
3315 process_pending_signals (); \
3319 /* True if ought to quit now. */
3321 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3323 extern Lisp_Object Vascii_downcase_table
;
3324 extern Lisp_Object Vascii_canon_table
;
3326 /* Call staticpro (&var) to protect static variable `var'. */
3328 void staticpro (Lisp_Object
*);
3330 /* Forward declarations for prototypes. */
3334 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3337 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3339 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3340 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3343 /* Functions to modify hash tables. */
3346 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3348 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3352 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3354 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3357 /* Use these functions to set Lisp_Object
3358 or pointer slots of struct Lisp_Symbol. */
3361 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3363 XSYMBOL (sym
)->function
= function
;
3367 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3369 XSYMBOL (sym
)->plist
= plist
;
3373 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3375 XSYMBOL (sym
)->next
= next
;
3379 make_symbol_constant (Lisp_Object sym
)
3381 XSYMBOL (sym
)->trapped_write
= SYMBOL_NOWRITE
;
3384 /* Buffer-local variable access functions. */
3387 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3389 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3393 /* Set overlay's property list. */
3396 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3398 XOVERLAY (overlay
)->plist
= plist
;
3401 /* Get text properties of S. */
3404 string_intervals (Lisp_Object s
)
3406 return XSTRING (s
)->intervals
;
3409 /* Set text properties of S to I. */
3412 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3414 XSTRING (s
)->intervals
= i
;
3417 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3418 of setting slots directly. */
3421 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3423 XCHAR_TABLE (table
)->defalt
= val
;
3426 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3428 XCHAR_TABLE (table
)->purpose
= val
;
3431 /* Set different slots in (sub)character tables. */
3434 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3436 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3437 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3441 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3443 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3444 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3448 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3450 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3453 /* Defined in data.c. */
3454 extern Lisp_Object
indirect_function (Lisp_Object
);
3455 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3456 enum Arith_Comparison
{
3461 ARITH_LESS_OR_EQUAL
,
3464 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3465 enum Arith_Comparison comparison
);
3467 /* Convert the integer I to an Emacs representation, either the integer
3468 itself, or a cons of two or three integers, or if all else fails a float.
3469 I should not have side effects. */
3470 #define INTEGER_TO_CONS(i) \
3471 (! FIXNUM_OVERFLOW_P (i) \
3473 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3474 extern Lisp_Object
intbig_to_lisp (intmax_t);
3475 extern Lisp_Object
uintbig_to_lisp (uintmax_t);
3477 /* Convert the Emacs representation CONS back to an integer of type
3478 TYPE, storing the result the variable VAR. Signal an error if CONS
3479 is not a valid representation or is out of range for TYPE. */
3480 #define CONS_TO_INTEGER(cons, type, var) \
3481 (TYPE_SIGNED (type) \
3482 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3483 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3484 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3485 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3487 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3488 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3489 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3491 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3492 enum Set_Internal_Bind
{
3495 SET_INTERNAL_UNBIND
,
3496 SET_INTERNAL_THREAD_SWITCH
3498 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3499 enum Set_Internal_Bind
);
3500 extern void set_default_internal (Lisp_Object
, Lisp_Object
,
3501 enum Set_Internal_Bind bindflag
);
3503 extern void syms_of_data (void);
3504 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3506 /* Defined in cmds.c */
3507 extern void syms_of_cmds (void);
3508 extern void keys_of_cmds (void);
3510 /* Defined in coding.c. */
3511 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3512 ptrdiff_t, bool, bool, Lisp_Object
);
3513 extern void init_coding (void);
3514 extern void init_coding_once (void);
3515 extern void syms_of_coding (void);
3517 /* Defined in character.c. */
3518 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3519 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3520 extern void syms_of_character (void);
3522 /* Defined in charset.c. */
3523 extern void init_charset (void);
3524 extern void init_charset_once (void);
3525 extern void syms_of_charset (void);
3526 /* Structure forward declarations. */
3529 /* Defined in syntax.c. */
3530 extern void init_syntax_once (void);
3531 extern void syms_of_syntax (void);
3533 /* Defined in fns.c. */
3534 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3535 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3536 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3537 extern void sweep_weak_hash_tables (void);
3538 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3539 EMACS_UINT
sxhash (Lisp_Object
, int);
3540 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3541 Lisp_Object
, Lisp_Object
);
3542 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3543 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3545 void hash_remove_from_table (struct Lisp_Hash_Table
*, Lisp_Object
);
3546 extern struct hash_table_test
const hashtest_eq
, hashtest_eql
, hashtest_equal
;
3547 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3548 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3549 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3550 ptrdiff_t, ptrdiff_t);
3551 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3552 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3553 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3554 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3555 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3556 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3557 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3558 extern void clear_string_char_byte_cache (void);
3559 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3560 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3561 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3562 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3563 extern void syms_of_fns (void);
3565 /* Defined in floatfns.c. */
3566 extern void syms_of_floatfns (void);
3567 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3569 /* Defined in fringe.c. */
3570 extern void syms_of_fringe (void);
3571 extern void init_fringe (void);
3572 #ifdef HAVE_WINDOW_SYSTEM
3573 extern void mark_fringe_data (void);
3574 extern void init_fringe_once (void);
3575 #endif /* HAVE_WINDOW_SYSTEM */
3577 /* Defined in image.c. */
3578 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3579 extern void reset_image_types (void);
3580 extern void syms_of_image (void);
3582 /* Defined in insdel.c. */
3583 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3584 extern _Noreturn
void buffer_overflow (void);
3585 extern void make_gap (ptrdiff_t);
3586 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3587 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3588 ptrdiff_t, bool, bool);
3589 extern int count_combining_before (const unsigned char *,
3590 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3591 extern int count_combining_after (const unsigned char *,
3592 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3593 extern void insert (const char *, ptrdiff_t);
3594 extern void insert_and_inherit (const char *, ptrdiff_t);
3595 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3597 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3598 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3599 ptrdiff_t, ptrdiff_t, bool);
3600 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3601 extern void insert_char (int);
3602 extern void insert_string (const char *);
3603 extern void insert_before_markers (const char *, ptrdiff_t);
3604 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3605 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3606 ptrdiff_t, ptrdiff_t,
3608 extern void del_range (ptrdiff_t, ptrdiff_t);
3609 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3610 extern void del_range_byte (ptrdiff_t, ptrdiff_t);
3611 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3612 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3613 ptrdiff_t, ptrdiff_t, bool);
3614 extern void modify_text (ptrdiff_t, ptrdiff_t);
3615 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3616 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3617 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3618 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3619 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3620 ptrdiff_t, ptrdiff_t);
3621 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3622 ptrdiff_t, ptrdiff_t);
3623 extern void adjust_markers_bytepos (ptrdiff_t, ptrdiff_t,
3624 ptrdiff_t, ptrdiff_t, int);
3625 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool, bool);
3626 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3627 const char *, ptrdiff_t, ptrdiff_t, bool);
3628 extern void syms_of_insdel (void);
3630 /* Defined in dispnew.c. */
3631 #if (defined PROFILING \
3632 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3633 _Noreturn
void __executable_start (void);
3635 extern Lisp_Object Vwindow_system
;
3636 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3638 /* Defined in xdisp.c. */
3639 extern bool noninteractive_need_newline
;
3640 extern Lisp_Object echo_area_buffer
[2];
3641 extern void add_to_log (char const *, ...);
3642 extern void vadd_to_log (char const *, va_list);
3643 extern void check_message_stack (void);
3644 extern void setup_echo_area_for_printing (bool);
3645 extern bool push_message (void);
3646 extern void pop_message_unwind (void);
3647 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3648 extern void restore_message (void);
3649 extern Lisp_Object
current_message (void);
3650 extern void clear_message (bool, bool);
3651 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3652 extern void message1 (const char *);
3653 extern void message1_nolog (const char *);
3654 extern void message3 (Lisp_Object
);
3655 extern void message3_nolog (Lisp_Object
);
3656 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3657 extern void message_with_string (const char *, Lisp_Object
, bool);
3658 extern void message_log_maybe_newline (void);
3659 extern void update_echo_area (void);
3660 extern void truncate_echo_area (ptrdiff_t);
3661 extern void redisplay (void);
3663 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3664 extern void syms_of_xdisp (void);
3665 extern void init_xdisp (void);
3666 extern Lisp_Object
safe_eval (Lisp_Object
);
3667 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3668 int *, int *, int *, int *, int *);
3670 /* Defined in xsettings.c. */
3671 extern void syms_of_xsettings (void);
3673 /* Defined in vm-limit.c. */
3674 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3676 /* Defined in character.c. */
3677 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3678 ptrdiff_t *, ptrdiff_t *);
3680 /* Defined in alloc.c. */
3681 extern void *my_heap_start (void);
3682 extern void check_pure_size (void);
3683 extern void free_misc (Lisp_Object
);
3684 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3685 extern void malloc_warning (const char *);
3686 extern _Noreturn
void memory_full (size_t);
3687 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3688 extern bool survives_gc_p (Lisp_Object
);
3689 extern void mark_object (Lisp_Object
);
3690 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3691 extern void refill_memory_reserve (void);
3693 extern void alloc_unexec_pre (void);
3694 extern void alloc_unexec_post (void);
3695 extern void mark_stack (char *, char *);
3696 extern void flush_stack_call_func (void (*func
) (void *arg
), void *arg
);
3697 extern const char *pending_malloc_warning
;
3698 extern Lisp_Object zero_vector
;
3699 extern EMACS_INT consing_since_gc
;
3700 extern EMACS_INT gc_relative_threshold
;
3701 extern EMACS_INT memory_full_cons_threshold
;
3702 extern Lisp_Object
list1 (Lisp_Object
);
3703 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3704 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3705 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3706 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3708 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3709 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3711 /* Build a frequently used 2/3/4-integer lists. */
3714 list2i (EMACS_INT x
, EMACS_INT y
)
3716 return list2 (make_number (x
), make_number (y
));
3720 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3722 return list3 (make_number (x
), make_number (y
), make_number (w
));
3726 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3728 return list4 (make_number (x
), make_number (y
),
3729 make_number (w
), make_number (h
));
3732 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3733 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3734 extern _Noreturn
void string_overflow (void);
3735 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3736 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3737 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3738 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3740 /* Make unibyte string from C string when the length isn't known. */
3743 build_unibyte_string (const char *str
)
3745 return make_unibyte_string (str
, strlen (str
));
3748 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3749 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3750 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3751 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3752 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3753 extern Lisp_Object
make_specified_string (const char *,
3754 ptrdiff_t, ptrdiff_t, bool);
3755 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3756 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3758 /* Make a string allocated in pure space, use STR as string data. */
3761 build_pure_c_string (const char *str
)
3763 return make_pure_c_string (str
, strlen (str
));
3766 /* Make a string from the data at STR, treating it as multibyte if the
3770 build_string (const char *str
)
3772 return make_string (str
, strlen (str
));
3775 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3776 extern void make_byte_code (struct Lisp_Vector
*);
3777 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3779 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3780 be sure that GC cannot happen until the vector is completely
3781 initialized. E.g. the following code is likely to crash:
3783 v = make_uninit_vector (3);
3785 ASET (v, 1, Ffunction_can_gc ());
3786 ASET (v, 2, obj1); */
3789 make_uninit_vector (ptrdiff_t size
)
3792 struct Lisp_Vector
*p
;
3794 p
= allocate_vector (size
);
3799 /* Like above, but special for sub char-tables. */
3802 make_uninit_sub_char_table (int depth
, int min_char
)
3804 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3805 Lisp_Object v
= make_uninit_vector (slots
);
3807 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3808 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3809 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3813 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3816 /* Allocate partially initialized pseudovector where all Lisp_Object
3817 slots are set to Qnil but the rest (if any) is left uninitialized. */
3819 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3820 ((type *) allocate_pseudovector (VECSIZE (type), \
3821 PSEUDOVECSIZE (type, field), \
3822 PSEUDOVECSIZE (type, field), tag))
3824 /* Allocate fully initialized pseudovector where all Lisp_Object
3825 slots are set to Qnil and the rest (if any) is zeroed. */
3827 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3828 ((type *) allocate_pseudovector (VECSIZE (type), \
3829 PSEUDOVECSIZE (type, field), \
3830 VECSIZE (type), tag))
3832 extern bool gc_in_progress
;
3833 extern Lisp_Object
make_float (double);
3834 extern void display_malloc_warning (void);
3835 extern ptrdiff_t inhibit_garbage_collection (void);
3836 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3837 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3838 Lisp_Object
, Lisp_Object
);
3839 extern Lisp_Object
make_save_ptr (void *);
3840 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3841 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3842 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3844 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3845 extern void free_save_value (Lisp_Object
);
3846 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3847 extern void free_marker (Lisp_Object
);
3848 extern void free_cons (struct Lisp_Cons
*);
3849 extern void init_alloc_once (void);
3850 extern void init_alloc (void);
3851 extern void syms_of_alloc (void);
3852 extern struct buffer
* allocate_buffer (void);
3853 extern int valid_lisp_object_p (Lisp_Object
);
3854 #ifdef GC_CHECK_CONS_LIST
3855 extern void check_cons_list (void);
3857 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3860 /* Defined in gmalloc.c. */
3861 #if !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC && !defined SYSTEM_MALLOC
3862 extern size_t __malloc_extra_blocks
;
3864 #if !HAVE_DECL_ALIGNED_ALLOC
3865 extern void *aligned_alloc (size_t, size_t) ATTRIBUTE_MALLOC_SIZE ((2));
3867 extern void malloc_enable_thread (void);
3870 /* Defined in ralloc.c. */
3871 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3872 extern void r_alloc_free (void **);
3873 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3874 extern void r_alloc_reset_variable (void **, void **);
3875 extern void r_alloc_inhibit_buffer_relocation (int);
3878 /* Defined in chartab.c. */
3879 extern Lisp_Object
copy_char_table (Lisp_Object
);
3880 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3882 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3883 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3885 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3886 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3887 Lisp_Object
, Lisp_Object
,
3888 Lisp_Object
, struct charset
*,
3889 unsigned, unsigned);
3890 extern Lisp_Object
uniprop_table (Lisp_Object
);
3891 extern void syms_of_chartab (void);
3893 /* Defined in print.c. */
3894 extern Lisp_Object Vprin1_to_string_buffer
;
3895 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3896 extern void temp_output_buffer_setup (const char *);
3897 extern int print_level
;
3898 extern void write_string (const char *);
3899 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3901 extern Lisp_Object internal_with_output_to_temp_buffer
3902 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3903 #define FLOAT_TO_STRING_BUFSIZE 350
3904 extern int float_to_string (char *, double);
3905 extern void init_print_once (void);
3906 extern void syms_of_print (void);
3908 /* Defined in doprnt.c. */
3909 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3911 extern ptrdiff_t esprintf (char *, char const *, ...)
3912 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3913 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3915 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3916 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3917 char const *, va_list)
3918 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3920 /* Defined in lread.c. */
3921 extern Lisp_Object
check_obarray (Lisp_Object
);
3922 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3923 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3924 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3925 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3926 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3928 LOADHIST_ATTACH (Lisp_Object x
)
3931 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3933 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3934 Lisp_Object
*, Lisp_Object
, bool);
3935 extern Lisp_Object
string_to_number (char const *, int, bool);
3936 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3938 extern void dir_warning (const char *, Lisp_Object
);
3939 extern void init_obarray (void);
3940 extern void init_lread (void);
3941 extern void syms_of_lread (void);
3944 intern (const char *str
)
3946 return intern_1 (str
, strlen (str
));
3950 intern_c_string (const char *str
)
3952 return intern_c_string_1 (str
, strlen (str
));
3955 /* Defined in eval.c. */
3956 extern Lisp_Object Vautoload_queue
;
3957 extern Lisp_Object Vrun_hooks
;
3958 extern Lisp_Object Vsignaling_function
;
3959 extern Lisp_Object inhibit_lisp_code
;
3961 /* To run a normal hook, use the appropriate function from the list below.
3962 The calling convention:
3964 if (!NILP (Vrun_hooks))
3965 call1 (Vrun_hooks, Qmy_funny_hook);
3967 should no longer be used. */
3968 extern void run_hook (Lisp_Object
);
3969 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3970 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3971 Lisp_Object (*funcall
)
3972 (ptrdiff_t nargs
, Lisp_Object
*args
));
3973 extern Lisp_Object
quit (void);
3974 INLINE _Noreturn
void
3975 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
3977 Fsignal (error_symbol
, data
);
3979 extern _Noreturn
void xsignal0 (Lisp_Object
);
3980 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3981 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3982 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3984 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3985 extern bool FUNCTIONP (Lisp_Object
);
3986 extern Lisp_Object
funcall_subr (struct Lisp_Subr
*subr
, ptrdiff_t numargs
, Lisp_Object
*arg_vector
);
3987 extern Lisp_Object
eval_sub (Lisp_Object form
);
3988 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3989 extern Lisp_Object
call0 (Lisp_Object
);
3990 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3991 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3992 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3993 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3994 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3995 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3996 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3997 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3998 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3999 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
4000 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
4001 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
4002 extern Lisp_Object internal_condition_case_n
4003 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
4004 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
4005 extern struct handler
*push_handler (Lisp_Object
, enum handlertype
);
4006 extern struct handler
*push_handler_nosignal (Lisp_Object
, enum handlertype
);
4007 extern void specbind (Lisp_Object
, Lisp_Object
);
4008 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
4009 extern void record_unwind_protect_ptr (void (*) (void *), void *);
4010 extern void record_unwind_protect_int (void (*) (int), int);
4011 extern void record_unwind_protect_void (void (*) (void));
4012 extern void record_unwind_protect_nothing (void);
4013 extern void clear_unwind_protect (ptrdiff_t);
4014 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
4015 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
4016 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
4017 extern void rebind_for_thread_switch (void);
4018 extern void unbind_for_thread_switch (struct thread_state
*);
4019 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
4020 extern _Noreturn
void verror (const char *, va_list)
4021 ATTRIBUTE_FORMAT_PRINTF (1, 0);
4022 extern Lisp_Object
vformat_string (const char *, va_list)
4023 ATTRIBUTE_FORMAT_PRINTF (1, 0);
4024 extern void un_autoload (Lisp_Object
);
4025 extern Lisp_Object
call_debugger (Lisp_Object arg
);
4026 extern void *near_C_stack_top (void);
4027 extern void init_eval_once (void);
4028 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
4029 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
4030 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4031 extern void init_eval (void);
4032 extern void syms_of_eval (void);
4033 extern void unwind_body (Lisp_Object
);
4034 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
4035 extern void mark_specpdl (union specbinding
*first
, union specbinding
*ptr
);
4036 extern void get_backtrace (Lisp_Object array
);
4037 Lisp_Object
backtrace_top_function (void);
4038 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
4039 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
4042 /* Defined in alloc.c. */
4043 extern Lisp_Object
make_user_ptr (void (*finalizer
) (void *), void *p
);
4045 /* Defined in emacs-module.c. */
4046 extern void module_init (void);
4047 extern void syms_of_module (void);
4050 /* Defined in thread.c. */
4051 extern void mark_threads (void);
4053 /* Defined in editfns.c. */
4054 extern void insert1 (Lisp_Object
);
4055 extern Lisp_Object
save_excursion_save (void);
4056 extern Lisp_Object
save_restriction_save (void);
4057 extern void save_excursion_restore (Lisp_Object
);
4058 extern void save_restriction_restore (Lisp_Object
);
4059 extern _Noreturn
void time_overflow (void);
4060 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
4061 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
4063 extern void init_editfns (bool);
4064 extern void syms_of_editfns (void);
4066 /* Defined in buffer.c. */
4067 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
4068 extern _Noreturn
void nsberror (Lisp_Object
);
4069 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
4070 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
4071 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
4072 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
4073 Lisp_Object
, Lisp_Object
, Lisp_Object
);
4074 extern bool overlay_touches_p (ptrdiff_t);
4075 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
4076 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
4077 extern void init_buffer_once (void);
4078 extern void init_buffer (int);
4079 extern void syms_of_buffer (void);
4080 extern void keys_of_buffer (void);
4082 /* Defined in marker.c. */
4084 extern ptrdiff_t marker_position (Lisp_Object
);
4085 extern ptrdiff_t marker_byte_position (Lisp_Object
);
4086 extern void clear_charpos_cache (struct buffer
*);
4087 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
4088 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
4089 extern void unchain_marker (struct Lisp_Marker
*marker
);
4090 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4091 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
4092 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
4093 ptrdiff_t, ptrdiff_t);
4094 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
4095 extern void syms_of_marker (void);
4097 /* Defined in fileio.c. */
4099 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
4100 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4101 Lisp_Object
, Lisp_Object
, Lisp_Object
,
4103 extern void close_file_unwind (int);
4104 extern void fclose_unwind (void *);
4105 extern void restore_point_unwind (Lisp_Object
);
4106 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
4107 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
4108 extern _Noreturn
void report_file_notify_error (const char *, Lisp_Object
);
4109 extern bool internal_delete_file (Lisp_Object
);
4110 extern Lisp_Object
emacs_readlinkat (int, const char *);
4111 extern bool file_directory_p (const char *);
4112 extern bool file_accessible_directory_p (Lisp_Object
);
4113 extern void init_fileio (void);
4114 extern void syms_of_fileio (void);
4115 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
4117 /* Defined in search.c. */
4118 extern void shrink_regexp_cache (void);
4119 extern void restore_search_regs (void);
4120 extern void update_search_regs (ptrdiff_t oldstart
,
4121 ptrdiff_t oldend
, ptrdiff_t newend
);
4122 extern void record_unwind_save_match_data (void);
4123 struct re_registers
;
4124 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4125 struct re_registers
*,
4126 Lisp_Object
, bool, bool);
4127 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
4131 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
4133 return fast_string_match_internal (regexp
, string
, Qnil
);
4137 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
4139 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
4142 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4144 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4145 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4146 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4147 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4148 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4150 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
4151 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4152 ptrdiff_t, ptrdiff_t *);
4153 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4154 ptrdiff_t, ptrdiff_t *);
4155 extern void syms_of_search (void);
4156 extern void clear_regexp_cache (void);
4158 /* Defined in minibuf.c. */
4160 extern Lisp_Object Vminibuffer_list
;
4161 extern Lisp_Object last_minibuf_string
;
4162 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4163 extern void init_minibuf_once (void);
4164 extern void syms_of_minibuf (void);
4166 /* Defined in callint.c. */
4168 extern void syms_of_callint (void);
4170 /* Defined in casefiddle.c. */
4172 extern void syms_of_casefiddle (void);
4173 extern void keys_of_casefiddle (void);
4175 /* Defined in casetab.c. */
4177 extern void init_casetab_once (void);
4178 extern void syms_of_casetab (void);
4180 /* Defined in keyboard.c. */
4182 extern Lisp_Object echo_message_buffer
;
4183 extern struct kboard
*echo_kboard
;
4184 extern void cancel_echoing (void);
4185 extern bool input_pending
;
4186 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4187 extern sigjmp_buf return_to_command_loop
;
4189 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4190 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4191 extern void discard_mouse_events (void);
4193 void handle_input_available_signal (int);
4195 extern Lisp_Object pending_funcalls
;
4196 extern bool detect_input_pending (void);
4197 extern bool detect_input_pending_ignore_squeezables (void);
4198 extern bool detect_input_pending_run_timers (bool);
4199 extern void safe_run_hooks (Lisp_Object
);
4200 extern void cmd_error_internal (Lisp_Object
, const char *);
4201 extern Lisp_Object
command_loop_1 (void);
4202 extern Lisp_Object
read_menu_command (void);
4203 extern Lisp_Object
recursive_edit_1 (void);
4204 extern void record_auto_save (void);
4205 extern void force_auto_save_soon (void);
4206 extern void init_keyboard (void);
4207 extern void syms_of_keyboard (void);
4208 extern void keys_of_keyboard (void);
4210 /* Defined in indent.c. */
4211 extern ptrdiff_t current_column (void);
4212 extern void invalidate_current_column (void);
4213 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4214 extern void syms_of_indent (void);
4216 /* Defined in frame.c. */
4217 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4218 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4219 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4220 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4221 extern void frames_discard_buffer (Lisp_Object
);
4222 extern void syms_of_frame (void);
4224 /* Defined in emacs.c. */
4225 extern char **initial_argv
;
4226 extern int initial_argc
;
4227 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4228 extern bool display_arg
;
4230 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4231 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4232 extern _Noreturn
void terminate_due_to_signal (int, int);
4234 extern Lisp_Object Vlibrary_cache
;
4237 void fixup_locale (void);
4238 void synchronize_system_messages_locale (void);
4239 void synchronize_system_time_locale (void);
4241 INLINE
void fixup_locale (void) {}
4242 INLINE
void synchronize_system_messages_locale (void) {}
4243 INLINE
void synchronize_system_time_locale (void) {}
4245 extern char *emacs_strerror (int);
4246 extern void shut_down_emacs (int, Lisp_Object
);
4248 /* True means don't do interactive redisplay and don't change tty modes. */
4249 extern bool noninteractive
;
4251 /* True means remove site-lisp directories from load-path. */
4252 extern bool no_site_lisp
;
4254 /* True means put details like time stamps into builds. */
4255 extern bool build_details
;
4258 /* 0 not a daemon, 1 new-style (foreground), 2 old-style (background). */
4259 extern int daemon_type
;
4260 #define IS_DAEMON (daemon_type != 0)
4261 #define DAEMON_RUNNING (daemon_type >= 0)
4262 #else /* WINDOWSNT */
4263 extern void *w32_daemon_event
;
4264 #define IS_DAEMON (w32_daemon_event != NULL)
4265 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4268 /* True if handling a fatal error already. */
4269 extern bool fatal_error_in_progress
;
4271 /* True means don't do use window-system-specific display code. */
4272 extern bool inhibit_window_system
;
4273 /* True means that a filter or a sentinel is running. */
4274 extern bool running_asynch_code
;
4276 /* Defined in process.c. */
4277 extern void kill_buffer_processes (Lisp_Object
);
4278 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4279 struct Lisp_Process
*, int);
4280 /* Max value for the first argument of wait_reading_process_output. */
4281 #if GNUC_PREREQ (3, 0, 0) && ! GNUC_PREREQ (4, 6, 0)
4282 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.0.
4283 The bug merely causes a bogus warning, but the warning is annoying. */
4284 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4286 # define WAIT_READING_MAX INTMAX_MAX
4289 extern void add_timer_wait_descriptor (int);
4291 extern void add_keyboard_wait_descriptor (int);
4292 extern void delete_keyboard_wait_descriptor (int);
4294 extern void add_gpm_wait_descriptor (int);
4295 extern void delete_gpm_wait_descriptor (int);
4297 extern void init_process_emacs (int);
4298 extern void syms_of_process (void);
4299 extern void setup_process_coding_systems (Lisp_Object
);
4301 /* Defined in callproc.c. */
4303 # define CHILD_SETUP_TYPE _Noreturn void
4305 # define CHILD_SETUP_TYPE int
4307 extern CHILD_SETUP_TYPE
child_setup (int, int, int, char **, bool, Lisp_Object
);
4308 extern void init_callproc_1 (void);
4309 extern void init_callproc (void);
4310 extern void set_initial_environment (void);
4311 extern void syms_of_callproc (void);
4313 /* Defined in doc.c. */
4314 enum text_quoting_style
4316 /* Use curved single quotes ‘like this’. */
4317 CURVE_QUOTING_STYLE
,
4319 /* Use grave accent and apostrophe `like this'. */
4320 GRAVE_QUOTING_STYLE
,
4322 /* Use apostrophes 'like this'. */
4323 STRAIGHT_QUOTING_STYLE
4325 extern enum text_quoting_style
text_quoting_style (void);
4326 extern Lisp_Object
read_doc_string (Lisp_Object
);
4327 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4328 extern void syms_of_doc (void);
4329 extern int read_bytecode_char (bool);
4331 /* Defined in bytecode.c. */
4332 extern void syms_of_bytecode (void);
4333 extern void relocate_byte_stack (struct byte_stack
*);
4334 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4335 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4336 extern Lisp_Object
get_byte_code_arity (Lisp_Object
);
4338 /* Defined in macros.c. */
4339 extern void init_macros (void);
4340 extern void syms_of_macros (void);
4342 /* Defined in undo.c. */
4343 extern void truncate_undo_list (struct buffer
*);
4344 extern void record_insert (ptrdiff_t, ptrdiff_t);
4345 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4346 extern void record_first_change (void);
4347 extern void record_change (ptrdiff_t, ptrdiff_t);
4348 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4349 Lisp_Object
, Lisp_Object
,
4351 extern void syms_of_undo (void);
4353 /* Defined in textprop.c. */
4354 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4356 /* Defined in menu.c. */
4357 extern void syms_of_menu (void);
4359 /* Defined in xmenu.c. */
4360 extern void syms_of_xmenu (void);
4362 /* Defined in termchar.h. */
4363 struct tty_display_info
;
4365 /* Defined in sysdep.c. */
4366 #ifdef HAVE_PERSONALITY_ADDR_NO_RANDOMIZE
4367 extern bool disable_address_randomization (void);
4369 INLINE
bool disable_address_randomization (void) { return false; }
4371 extern int emacs_exec_file (char const *, char *const *, char *const *);
4372 extern void init_standard_fds (void);
4373 extern char *emacs_get_current_dir_name (void);
4374 extern void stuff_char (char c
);
4375 extern void init_foreground_group (void);
4376 extern void sys_subshell (void);
4377 extern void sys_suspend (void);
4378 extern void discard_tty_input (void);
4379 extern void init_sys_modes (struct tty_display_info
*);
4380 extern void reset_sys_modes (struct tty_display_info
*);
4381 extern void init_all_sys_modes (void);
4382 extern void reset_all_sys_modes (void);
4383 extern void child_setup_tty (int);
4384 extern void setup_pty (int);
4385 extern int set_window_size (int, int, int);
4386 extern EMACS_INT
get_random (void);
4387 extern void seed_random (void *, ptrdiff_t);
4388 extern void init_random (void);
4389 extern void emacs_backtrace (int);
4390 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4391 extern int emacs_open (const char *, int, int);
4392 extern int emacs_pipe (int[2]);
4393 extern int emacs_close (int);
4394 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4395 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4396 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4397 extern void emacs_perror (char const *);
4399 extern void unlock_all_files (void);
4400 extern void lock_file (Lisp_Object
);
4401 extern void unlock_file (Lisp_Object
);
4402 extern void unlock_buffer (struct buffer
*);
4403 extern void syms_of_filelock (void);
4404 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4406 /* Defined in sound.c. */
4407 extern void syms_of_sound (void);
4409 /* Defined in category.c. */
4410 extern void init_category_once (void);
4411 extern Lisp_Object
char_category_set (int);
4412 extern void syms_of_category (void);
4414 /* Defined in ccl.c. */
4415 extern void syms_of_ccl (void);
4417 /* Defined in dired.c. */
4418 extern void syms_of_dired (void);
4419 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4420 Lisp_Object
, Lisp_Object
,
4423 /* Defined in term.c. */
4424 extern int *char_ins_del_vector
;
4425 extern void syms_of_term (void);
4426 extern _Noreturn
void fatal (const char *msgid
, ...)
4427 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4429 /* Defined in terminal.c. */
4430 extern void syms_of_terminal (void);
4432 /* Defined in font.c. */
4433 extern void syms_of_font (void);
4434 extern void init_font (void);
4436 #ifdef HAVE_WINDOW_SYSTEM
4437 /* Defined in fontset.c. */
4438 extern void syms_of_fontset (void);
4441 /* Defined in inotify.c */
4443 extern void syms_of_inotify (void);
4446 /* Defined in kqueue.c */
4448 extern void globals_of_kqueue (void);
4449 extern void syms_of_kqueue (void);
4452 /* Defined in gfilenotify.c */
4453 #ifdef HAVE_GFILENOTIFY
4454 extern void globals_of_gfilenotify (void);
4455 extern void syms_of_gfilenotify (void);
4458 #ifdef HAVE_W32NOTIFY
4459 /* Defined on w32notify.c. */
4460 extern void syms_of_w32notify (void);
4463 /* Defined in xfaces.c. */
4464 extern Lisp_Object Vface_alternative_font_family_alist
;
4465 extern Lisp_Object Vface_alternative_font_registry_alist
;
4466 extern void syms_of_xfaces (void);
4468 #ifdef HAVE_X_WINDOWS
4469 /* Defined in xfns.c. */
4470 extern void syms_of_xfns (void);
4472 /* Defined in xsmfns.c. */
4473 extern void syms_of_xsmfns (void);
4475 /* Defined in xselect.c. */
4476 extern void syms_of_xselect (void);
4478 /* Defined in xterm.c. */
4479 extern void init_xterm (void);
4480 extern void syms_of_xterm (void);
4481 #endif /* HAVE_X_WINDOWS */
4483 #ifdef HAVE_WINDOW_SYSTEM
4484 /* Defined in xterm.c, nsterm.m, w32term.c. */
4485 extern char *x_get_keysym_name (int);
4486 #endif /* HAVE_WINDOW_SYSTEM */
4489 /* Defined in xml.c. */
4490 extern void syms_of_xml (void);
4491 extern void xml_cleanup_parser (void);
4495 /* Defined in decompress.c. */
4496 extern void syms_of_decompress (void);
4500 /* Defined in dbusbind.c. */
4501 void init_dbusbind (void);
4502 void syms_of_dbusbind (void);
4506 /* Defined in profiler.c. */
4507 extern bool profiler_memory_running
;
4508 extern void malloc_probe (size_t);
4509 extern void syms_of_profiler (void);
4513 /* Defined in msdos.c, w32.c. */
4514 extern char *emacs_root_dir (void);
4517 /* Defined in lastfile.c. */
4518 extern char my_edata
[];
4519 extern char my_endbss
[];
4520 extern char *my_endbss_static
;
4522 /* True means ^G can quit instantly. */
4523 extern bool immediate_quit
;
4525 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4526 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4527 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4528 extern void xfree (void *);
4529 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4530 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4531 ATTRIBUTE_ALLOC_SIZE ((2,3));
4532 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4534 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4535 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4536 extern void dupstring (char **, char const *);
4538 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4539 null byte. This is like stpcpy, except the source is a Lisp string. */
4542 lispstpcpy (char *dest
, Lisp_Object string
)
4544 ptrdiff_t len
= SBYTES (string
);
4545 memcpy (dest
, SDATA (string
), len
+ 1);
4549 extern void xputenv (const char *);
4551 extern char *egetenv_internal (const char *, ptrdiff_t);
4554 egetenv (const char *var
)
4556 /* When VAR is a string literal, strlen can be optimized away. */
4557 return egetenv_internal (var
, strlen (var
));
4560 /* Set up the name of the machine we're running on. */
4561 extern void init_system_name (void);
4563 /* Return the absolute value of X. X should be a signed integer
4564 expression without side effects, and X's absolute value should not
4565 exceed the maximum for its promoted type. This is called 'eabs'
4566 because 'abs' is reserved by the C standard. */
4567 #define eabs(x) ((x) < 0 ? -(x) : (x))
4569 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4572 #define make_fixnum_or_float(val) \
4573 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4575 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4576 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4578 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4580 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4582 #define USE_SAFE_ALLOCA \
4583 ptrdiff_t sa_avail = MAX_ALLOCA; \
4584 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4586 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4588 /* SAFE_ALLOCA allocates a simple buffer. */
4590 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4591 ? AVAIL_ALLOCA (size) \
4592 : (sa_must_free = true, record_xmalloc (size)))
4594 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4595 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4596 positive. The code is tuned for MULTIPLIER being a constant. */
4598 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4600 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4601 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4604 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4605 sa_must_free = true; \
4606 record_unwind_protect_ptr (xfree, buf); \
4610 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4612 #define SAFE_ALLOCA_STRING(ptr, string) \
4614 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4615 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4618 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4620 #define SAFE_FREE() \
4622 if (sa_must_free) { \
4623 sa_must_free = false; \
4624 unbind_to (sa_count, Qnil); \
4628 /* Set BUF to point to an allocated array of NELT Lisp_Objects,
4629 immediately followed by EXTRA spare bytes. */
4631 #define SAFE_ALLOCA_LISP_EXTRA(buf, nelt, extra) \
4633 ptrdiff_t alloca_nbytes; \
4634 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4635 || INT_ADD_WRAPV (alloca_nbytes, extra, &alloca_nbytes) \
4636 || SIZE_MAX < alloca_nbytes) \
4637 memory_full (SIZE_MAX); \
4638 else if (alloca_nbytes <= sa_avail) \
4639 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4643 (buf) = xmalloc (alloca_nbytes); \
4644 arg_ = make_save_memory (buf, nelt); \
4645 sa_must_free = true; \
4646 record_unwind_protect (free_save_value, arg_); \
4650 /* Set BUF to point to an allocated array of NELT Lisp_Objects. */
4652 #define SAFE_ALLOCA_LISP(buf, nelt) SAFE_ALLOCA_LISP_EXTRA (buf, nelt, 0)
4655 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4656 block-scoped conses and strings. These objects are not
4657 managed by the garbage collector, so they are dangerous: passing them
4658 out of their scope (e.g., to user code) results in undefined behavior.
4659 Conversely, they have better performance because GC is not involved.
4661 This feature is experimental and requires careful debugging.
4662 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4664 #if (!defined USE_STACK_LISP_OBJECTS \
4665 && defined __GNUC__ && !defined __clang__ && ! GNUC_PREREQ (4, 3, 2))
4666 /* Work around GCC bugs 36584 and 35271, which were fixed in GCC 4.3.2. */
4667 # define USE_STACK_LISP_OBJECTS false
4669 #ifndef USE_STACK_LISP_OBJECTS
4670 # define USE_STACK_LISP_OBJECTS true
4673 #ifdef GC_CHECK_STRING_BYTES
4674 enum { defined_GC_CHECK_STRING_BYTES
= true };
4676 enum { defined_GC_CHECK_STRING_BYTES
= false };
4679 /* Struct inside unions that are typically no larger and aligned enough. */
4684 double d
; intmax_t i
; void *p
;
4687 union Aligned_String
4689 struct Lisp_String s
;
4690 double d
; intmax_t i
; void *p
;
4693 /* True for stack-based cons and string implementations, respectively.
4694 Use stack-based strings only if stack-based cons also works.
4695 Otherwise, STACK_CONS would create heap-based cons cells that
4696 could point to stack-based strings, which is a no-no. */
4700 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4701 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4702 USE_STACK_STRING
= (USE_STACK_CONS
4703 && !defined_GC_CHECK_STRING_BYTES
4704 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4707 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4708 use these only in macros like AUTO_CONS that declare a local
4709 variable whose lifetime will be clear to the programmer. */
4710 #define STACK_CONS(a, b) \
4711 make_lisp_ptr (&(union Aligned_Cons) { { a, { b } } }.s, Lisp_Cons)
4712 #define AUTO_CONS_EXPR(a, b) \
4713 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4715 /* Declare NAME as an auto Lisp cons or short list if possible, a
4716 GC-based one otherwise. This is in the sense of the C keyword
4717 'auto'; i.e., the object has the lifetime of the containing block.
4718 The resulting object should not be made visible to user Lisp code. */
4720 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4721 #define AUTO_LIST1(name, a) \
4722 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4723 #define AUTO_LIST2(name, a, b) \
4724 Lisp_Object name = (USE_STACK_CONS \
4725 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4727 #define AUTO_LIST3(name, a, b, c) \
4728 Lisp_Object name = (USE_STACK_CONS \
4729 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4731 #define AUTO_LIST4(name, a, b, c, d) \
4734 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4735 STACK_CONS (d, Qnil)))) \
4736 : list4 (a, b, c, d))
4738 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4739 Take its unibyte value from the null-terminated string STR,
4740 an expression that should not have side effects.
4741 STR's value is not necessarily copied. The resulting Lisp string
4742 should not be modified or made visible to user code. */
4744 #define AUTO_STRING(name, str) \
4745 AUTO_STRING_WITH_LEN (name, str, strlen (str))
4747 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4748 Take its unibyte value from the null-terminated string STR with length LEN.
4749 STR may have side effects and may contain null bytes.
4750 STR's value is not necessarily copied. The resulting Lisp string
4751 should not be modified or made visible to user code. */
4753 #define AUTO_STRING_WITH_LEN(name, str, len) \
4754 Lisp_Object name = \
4757 ((&(union Aligned_String) \
4758 {{len, -1, 0, (unsigned char *) (str)}}.s), \
4760 : make_unibyte_string (str, len))
4762 /* Loop over all tails of a list, checking for cycles.
4763 FIXME: Make tortoise and n internal declarations.
4764 FIXME: Unroll the loop body so we don't need `n'. */
4765 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4766 for ((tortoise) = (hare) = (list), (n) = true; \
4768 (hare = XCDR (hare), (n) = !(n), \
4770 ? (EQ (hare, tortoise) \
4771 ? xsignal1 (Qcircular_list, list) \
4773 /* Move tortoise before the next iteration, in case */ \
4774 /* the next iteration does an Fsetcdr. */ \
4775 : (void) ((tortoise) = XCDR (tortoise)))))
4777 /* Do a `for' loop over alist values. */
4779 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4780 for ((list_var) = (head_var); \
4781 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4782 (list_var) = XCDR (list_var))
4784 /* Check whether it's time for GC, and run it if so. */
4789 if ((consing_since_gc
> gc_cons_threshold
4790 && consing_since_gc
> gc_relative_threshold
)
4791 || (!NILP (Vmemory_full
)
4792 && consing_since_gc
> memory_full_cons_threshold
))
4793 Fgarbage_collect ();
4798 #endif /* EMACS_LISP_H */