1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2014 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
39 #define ID_val (some integer preprocessor expression)
41 DEFINE_GDB_SYMBOL_ENUM (ID)
43 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
45 DEFINE_GDB_SYMBOL_END (ID)
48 This hack is for the benefit of compilers that do not make macro
49 definitions visible to the debugger. It's used for symbols that
50 .gdbinit needs, symbols whose values may not fit in 'int' (where an
53 Some GCC versions before GCC 4.2 omit enums in debugging output;
54 see GCC bug 23336. So don't use enums with older GCC. */
56 #if !defined __GNUC__ || 4 < __GNUC__ + (2 <= __GNUC_MINOR__)
57 # define ENUMABLE(val) (INT_MIN <= (val) && (val) <= INT_MAX)
59 # define ENUMABLE(val) 0
62 #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val };
63 #if defined MAIN_PROGRAM
64 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
65 # define DEFINE_GDB_SYMBOL_END(id) = id;
67 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
68 # define DEFINE_GDB_SYMBOL_END(val)
71 /* The ubiquitous max and min macros. */
74 #define max(a, b) ((a) > (b) ? (a) : (b))
75 #define min(a, b) ((a) < (b) ? (a) : (b))
77 /* Number of elements in an array. */
78 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
80 /* Number of bits in a Lisp_Object tag. */
81 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
83 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
85 /* The number of bits needed in an EMACS_INT over and above the number
86 of bits in a pointer. This is 0 on systems where:
87 1. We can specify multiple-of-8 alignment on static variables.
88 2. We know malloc returns a multiple of 8. */
89 #if (defined alignas \
90 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
91 || defined DARWIN_OS || defined __sun || defined __MINGW32__))
92 # define NONPOINTER_BITS 0
94 # define NONPOINTER_BITS GCTYPEBITS
97 /* EMACS_INT - signed integer wide enough to hold an Emacs value
98 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
99 pI - printf length modifier for EMACS_INT
100 EMACS_UINT - unsigned variant of EMACS_INT */
101 #ifndef EMACS_INT_MAX
103 # error "INTPTR_MAX misconfigured"
104 # elif INTPTR_MAX <= INT_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
105 typedef int EMACS_INT
;
106 typedef unsigned int EMACS_UINT
;
107 # define EMACS_INT_MAX INT_MAX
109 # elif INTPTR_MAX <= LONG_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
110 typedef long int EMACS_INT
;
111 typedef unsigned long EMACS_UINT
;
112 # define EMACS_INT_MAX LONG_MAX
114 /* Check versus LLONG_MAX, not LLONG_MAX >> NONPOINTER_BITS.
115 In theory this is not safe, but in practice it seems to be OK. */
116 # elif INTPTR_MAX <= LLONG_MAX
117 typedef long long int EMACS_INT
;
118 typedef unsigned long long int EMACS_UINT
;
119 # define EMACS_INT_MAX LLONG_MAX
122 # error "INTPTR_MAX too large"
126 /* Number of bits to put in each character in the internal representation
127 of bool vectors. This should not vary across implementations. */
128 enum { BOOL_VECTOR_BITS_PER_CHAR
=
129 #define BOOL_VECTOR_BITS_PER_CHAR 8
130 BOOL_VECTOR_BITS_PER_CHAR
133 /* An unsigned integer type representing a fixed-length bit sequence,
134 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
135 for speed, but it is unsigned char on weird platforms. */
136 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
137 typedef size_t bits_word
;
138 # define BITS_WORD_MAX SIZE_MAX
139 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
141 typedef unsigned char bits_word
;
142 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
143 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
145 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
147 /* Number of bits in some machine integer types. */
150 BITS_PER_CHAR
= CHAR_BIT
,
151 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
152 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
153 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
156 /* printmax_t and uprintmax_t are types for printing large integers.
157 These are the widest integers that are supported for printing.
158 pMd etc. are conversions for printing them.
159 On C99 hosts, there's no problem, as even the widest integers work.
160 Fall back on EMACS_INT on pre-C99 hosts. */
162 typedef intmax_t printmax_t
;
163 typedef uintmax_t uprintmax_t
;
167 typedef EMACS_INT printmax_t
;
168 typedef EMACS_UINT uprintmax_t
;
173 /* Use pD to format ptrdiff_t values, which suffice for indexes into
174 buffers and strings. Emacs never allocates objects larger than
175 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
176 In C99, pD can always be "t"; configure it here for the sake of
177 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
178 #if PTRDIFF_MAX == INT_MAX
180 #elif PTRDIFF_MAX == LONG_MAX
182 #elif PTRDIFF_MAX == LLONG_MAX
188 /* Extra internal type checking? */
190 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
191 'assume (COND)'. COND should be free of side effects, as it may or
192 may not be evaluated.
194 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
195 defined and suppress_checking is false, and does nothing otherwise.
196 Emacs dies if COND is checked and is false. The suppress_checking
197 variable is initialized to 0 in alloc.c. Set it to 1 using a
198 debugger to temporarily disable aborting on detected internal
199 inconsistencies or error conditions.
201 In some cases, a good compiler may be able to optimize away the
202 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
203 uses eassert to test STRINGP (x), but a particular use of XSTRING
204 is invoked only after testing that STRINGP (x) is true, making the
207 eassume is like eassert except that it also causes the compiler to
208 assume that COND is true afterwards, regardless of whether runtime
209 checking is enabled. This can improve performance in some cases,
210 though it can degrade performance in others. It's often suboptimal
211 for COND to call external functions or access volatile storage. */
213 #ifndef ENABLE_CHECKING
214 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
215 # define eassume(cond) assume (cond)
216 #else /* ENABLE_CHECKING */
218 extern _Noreturn
void die (const char *, const char *, int);
220 extern bool suppress_checking EXTERNALLY_VISIBLE
;
222 # define eassert(cond) \
223 (suppress_checking || (cond) \
225 : die (# cond, __FILE__, __LINE__))
226 # define eassume(cond) \
231 : die (# cond, __FILE__, __LINE__))
232 #endif /* ENABLE_CHECKING */
235 /* Use the configure flag --enable-check-lisp-object-type to make
236 Lisp_Object use a struct type instead of the default int. The flag
237 causes CHECK_LISP_OBJECT_TYPE to be defined. */
239 /***** Select the tagging scheme. *****/
240 /* The following option controls the tagging scheme:
241 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
242 always 0, and we can thus use them to hold tag bits, without
243 restricting our addressing space.
245 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
246 restricting our possible address range.
248 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
249 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
250 on the few static Lisp_Objects used: all the defsubr as well
251 as the two special buffers buffer_defaults and buffer_local_symbols. */
255 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
256 integer constant, for MSVC. */
257 #define GCALIGNMENT 8
259 /* Number of bits in a Lisp_Object value, not counting the tag. */
260 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
262 /* Number of bits in a Lisp fixnum tag. */
263 INTTYPEBITS
= GCTYPEBITS
- 1,
265 /* Number of bits in a Lisp fixnum value, not counting the tag. */
266 FIXNUM_BITS
= VALBITS
+ 1
269 #if GCALIGNMENT != 1 << GCTYPEBITS
270 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
273 /* The maximum value that can be stored in a EMACS_INT, assuming all
274 bits other than the type bits contribute to a nonnegative signed value.
275 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
276 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
278 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
279 #define USE_LSB_TAG 1
280 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
283 # define alignas(alignment) /* empty */
285 # error "USE_LSB_TAG requires alignas"
289 /* Some operations are so commonly executed that they are implemented
290 as macros, not functions, because otherwise runtime performance would
291 suffer too much when compiling with GCC without optimization.
292 There's no need to inline everything, just the operations that
293 would otherwise cause a serious performance problem.
295 For each such operation OP, define a macro lisp_h_OP that contains
296 the operation's implementation. That way, OP can be implemented
297 via a macro definition like this:
299 #define OP(x) lisp_h_OP (x)
301 and/or via a function definition like this:
303 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
305 which macro-expands to this:
307 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
309 without worrying about the implementations diverging, since
310 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
311 are intended to be private to this include file, and should not be
314 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
315 functions, once most developers have access to GCC 4.8 or later and
316 can use "gcc -Og" to debug. Maybe in the year 2016. See
319 Commentary for these macros can be found near their corresponding
322 #if CHECK_LISP_OBJECT_TYPE
323 # define lisp_h_XLI(o) ((o).i)
324 # define lisp_h_XIL(i) ((Lisp_Object) { i })
326 # define lisp_h_XLI(o) (o)
327 # define lisp_h_XIL(i) (i)
329 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
330 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
331 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
332 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
333 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
334 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
335 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
336 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
337 #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0)
338 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
339 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
340 #define lisp_h_NILP(x) EQ (x, Qnil)
341 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
342 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
343 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
344 #define lisp_h_SYMBOL_VAL(sym) \
345 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
346 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
347 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
348 #define lisp_h_XCAR(c) XCONS (c)->car
349 #define lisp_h_XCDR(c) XCONS (c)->cdr
350 #define lisp_h_XCONS(a) \
351 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
352 #define lisp_h_XHASH(a) XUINT (a)
353 #define lisp_h_XPNTR(a) ((void *) (intptr_t) (XLI (a) & VALMASK))
354 #define lisp_h_XSYMBOL(a) \
355 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
357 # define lisp_h_make_number(n) \
358 XIL ((EMACS_INT) ((EMACS_UINT) (n) << INTTYPEBITS))
359 # define lisp_h_XFASTINT(a) XINT (a)
360 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
361 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
362 # define lisp_h_XUNTAG(a, type) ((void *) (XLI (a) - (type)))
365 /* When compiling via gcc -O0, define the key operations as macros, as
366 Emacs is too slow otherwise. To disable this optimization, compile
367 with -DINLINING=false. */
369 #if (defined __NO_INLINE__ \
370 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
371 && ! (defined INLINING && ! INLINING))
372 # define XLI(o) lisp_h_XLI (o)
373 # define XIL(i) lisp_h_XIL (i)
374 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
375 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
376 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
377 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
378 # define CONSP(x) lisp_h_CONSP (x)
379 # define EQ(x, y) lisp_h_EQ (x, y)
380 # define FLOATP(x) lisp_h_FLOATP (x)
381 # define INTEGERP(x) lisp_h_INTEGERP (x)
382 # define MARKERP(x) lisp_h_MARKERP (x)
383 # define MISCP(x) lisp_h_MISCP (x)
384 # define NILP(x) lisp_h_NILP (x)
385 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
386 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
387 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
388 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
389 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
390 # define XCAR(c) lisp_h_XCAR (c)
391 # define XCDR(c) lisp_h_XCDR (c)
392 # define XCONS(a) lisp_h_XCONS (a)
393 # define XHASH(a) lisp_h_XHASH (a)
394 # define XPNTR(a) lisp_h_XPNTR (a)
395 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
397 # define make_number(n) lisp_h_make_number (n)
398 # define XFASTINT(a) lisp_h_XFASTINT (a)
399 # define XINT(a) lisp_h_XINT (a)
400 # define XTYPE(a) lisp_h_XTYPE (a)
401 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
406 /* Define NAME as a lisp.h inline function that returns TYPE and has
407 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
408 ARGS should be parenthesized. Implement the function by calling
410 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
411 INLINE type (name) argdecls { return lisp_h_##name args; }
413 /* like LISP_MACRO_DEFUN, except NAME returns void. */
414 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
415 INLINE void (name) argdecls { lisp_h_##name args; }
418 /* Define the fundamental Lisp data structures. */
420 /* This is the set of Lisp data types. If you want to define a new
421 data type, read the comments after Lisp_Fwd_Type definition
424 /* Lisp integers use 2 tags, to give them one extra bit, thus
425 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
426 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
427 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
429 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
430 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
431 vociferously about them. */
432 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
433 || (defined __SUNPRO_C && __STDC__))
434 #define ENUM_BF(TYPE) unsigned int
436 #define ENUM_BF(TYPE) enum TYPE
442 /* Integer. XINT (obj) is the integer value. */
444 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
446 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
449 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
450 whose first member indicates the subtype. */
453 /* String. XSTRING (object) points to a struct Lisp_String.
454 The length of the string, and its contents, are stored therein. */
455 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
457 /* Vector of Lisp objects, or something resembling it.
458 XVECTOR (object) points to a struct Lisp_Vector, which contains
459 the size and contents. The size field also contains the type
460 information, if it's not a real vector object. */
463 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
469 /* This is the set of data types that share a common structure.
470 The first member of the structure is a type code from this set.
471 The enum values are arbitrary, but we'll use large numbers to make it
472 more likely that we'll spot the error if a random word in memory is
473 mistakenly interpreted as a Lisp_Misc. */
476 Lisp_Misc_Free
= 0x5eab,
479 Lisp_Misc_Save_Value
,
480 /* Currently floats are not a misc type,
481 but let's define this in case we want to change that. */
483 /* This is not a type code. It is for range checking. */
487 /* These are the types of forwarding objects used in the value slot
488 of symbols for special built-in variables whose value is stored in
492 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
493 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
494 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
495 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
496 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
499 /* If you want to define a new Lisp data type, here are some
500 instructions. See the thread at
501 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
504 First, there are already a couple of Lisp types that can be used if
505 your new type does not need to be exposed to Lisp programs nor
506 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
507 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
508 is suitable for temporarily stashing away pointers and integers in
509 a Lisp object. The latter is useful for vector-like Lisp objects
510 that need to be used as part of other objects, but which are never
511 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
514 These two types don't look pretty when printed, so they are
515 unsuitable for Lisp objects that can be exposed to users.
517 To define a new data type, add one more Lisp_Misc subtype or one
518 more pseudovector subtype. Pseudovectors are more suitable for
519 objects with several slots that need to support fast random access,
520 while Lisp_Misc types are for everything else. A pseudovector object
521 provides one or more slots for Lisp objects, followed by struct
522 members that are accessible only from C. A Lisp_Misc object is a
523 wrapper for a C struct that can contain anything you like.
525 Explicit freeing is discouraged for Lisp objects in general. But if
526 you really need to exploit this, use Lisp_Misc (check free_misc in
527 alloc.c to see why). There is no way to free a vectorlike object.
529 To add a new pseudovector type, extend the pvec_type enumeration;
530 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
532 For a Lisp_Misc, you will also need to add your entry to union
533 Lisp_Misc (but make sure the first word has the same structure as
534 the others, starting with a 16-bit member of the Lisp_Misc_Type
535 enumeration and a 1-bit GC markbit) and make sure the overall size
536 of the union is not increased by your addition.
538 For a new pseudovector, it's highly desirable to limit the size
539 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
540 Otherwise you will need to change sweep_vectors (also in alloc.c).
542 Then you will need to add switch branches in print.c (in
543 print_object, to print your object, and possibly also in
544 print_preprocess) and to alloc.c, to mark your object (in
545 mark_object) and to free it (in gc_sweep). The latter is also the
546 right place to call any code specific to your data type that needs
547 to run when the object is recycled -- e.g., free any additional
548 resources allocated for it that are not Lisp objects. You can even
549 make a pointer to the function that frees the resources a slot in
550 your object -- this way, the same object could be used to represent
551 several disparate C structures. */
553 #ifdef CHECK_LISP_OBJECT_TYPE
555 typedef struct { EMACS_INT i
; } Lisp_Object
;
557 #define LISP_INITIALLY_ZERO {0}
559 #undef CHECK_LISP_OBJECT_TYPE
560 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
561 #else /* CHECK_LISP_OBJECT_TYPE */
563 /* If a struct type is not wanted, define Lisp_Object as just a number. */
565 typedef EMACS_INT Lisp_Object
;
566 #define LISP_INITIALLY_ZERO 0
567 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
568 #endif /* CHECK_LISP_OBJECT_TYPE */
570 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
571 At the machine level, these operations are no-ops. */
572 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
573 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
575 /* In the size word of a struct Lisp_Vector, this bit means it's really
576 some other vector-like object. */
577 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
578 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
579 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
581 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
582 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
583 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
586 /* In a pseudovector, the size field actually contains a word with one
587 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
588 with PVEC_TYPE_MASK to indicate the actual type. */
600 PVEC_WINDOW_CONFIGURATION
,
603 /* These should be last, check internal_equal to see why. */
607 PVEC_FONT
/* Should be last because it's used for range checking. */
612 /* For convenience, we also store the number of elements in these bits.
613 Note that this size is not necessarily the memory-footprint size, but
614 only the number of Lisp_Object fields (that need to be traced by GC).
615 The distinction is used, e.g., by Lisp_Process, which places extra
616 non-Lisp_Object fields at the end of the structure. */
617 PSEUDOVECTOR_SIZE_BITS
= 12,
618 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
620 /* To calculate the memory footprint of the pseudovector, it's useful
621 to store the size of non-Lisp area in word_size units here. */
622 PSEUDOVECTOR_REST_BITS
= 12,
623 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
624 << PSEUDOVECTOR_SIZE_BITS
),
626 /* Used to extract pseudovector subtype information. */
627 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
628 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
631 /* These functions extract various sorts of values from a Lisp_Object.
632 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
633 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
636 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
637 #define VALMASK_val (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
638 #if ENUMABLE (VALMASK_val)
639 DEFINE_GDB_SYMBOL_ENUM (VALMASK
)
641 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
642 # define VALMASK VALMASK_val
643 DEFINE_GDB_SYMBOL_END (VALMASK
)
646 /* Largest and smallest representable fixnum values. These are the C
647 values. They are macros for use in static initializers. */
648 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
649 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
651 /* Extract the pointer hidden within A. */
652 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
656 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
657 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
658 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
659 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
660 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
662 #else /* ! USE_LSB_TAG */
664 /* Although compiled only if ! USE_LSB_TAG, the following functions
665 also work when USE_LSB_TAG; this is to aid future maintenance when
666 the lisp_h_* macros are eventually removed. */
668 /* Make a Lisp integer representing the value of the low order
671 make_number (EMACS_INT n
)
676 n
= u
<< INTTYPEBITS
;
683 /* Extract A's value as a signed integer. */
687 EMACS_INT i
= XLI (a
);
691 i
= u
<< INTTYPEBITS
;
693 return i
>> INTTYPEBITS
;
696 /* Like XINT (A), but may be faster. A must be nonnegative.
697 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
698 integers have zero-bits in their tags. */
700 XFASTINT (Lisp_Object a
)
702 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
707 /* Extract A's type. */
708 INLINE
enum Lisp_Type
709 XTYPE (Lisp_Object a
)
711 EMACS_UINT i
= XLI (a
);
712 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
715 /* Extract A's pointer value, assuming A's type is TYPE. */
717 XUNTAG (Lisp_Object a
, int type
)
721 intptr_t i
= XLI (a
) - type
;
727 #endif /* ! USE_LSB_TAG */
729 /* Extract A's value as an unsigned integer. */
731 XUINT (Lisp_Object a
)
733 EMACS_UINT i
= XLI (a
);
734 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
737 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
738 right now, but XUINT should only be applied to objects we know are
740 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
742 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
744 make_natnum (EMACS_INT n
)
746 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
747 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
750 /* Return true if X and Y are the same object. */
751 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
753 /* Value is true if I doesn't fit into a Lisp fixnum. It is
754 written this way so that it also works if I is of unsigned
755 type or if I is a NaN. */
757 #define FIXNUM_OVERFLOW_P(i) \
758 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
761 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
763 return num
< lower
? lower
: num
<= upper
? num
: upper
;
766 /* Forward declarations. */
768 /* Defined in this file. */
770 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
771 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
772 INLINE
bool BUFFERP (Lisp_Object
);
773 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
774 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
775 INLINE
bool (CONSP
) (Lisp_Object
);
776 INLINE
bool (FLOATP
) (Lisp_Object
);
777 INLINE
bool functionp (Lisp_Object
);
778 INLINE
bool (INTEGERP
) (Lisp_Object
);
779 INLINE
bool (MARKERP
) (Lisp_Object
);
780 INLINE
bool (MISCP
) (Lisp_Object
);
781 INLINE
bool (NILP
) (Lisp_Object
);
782 INLINE
bool OVERLAYP (Lisp_Object
);
783 INLINE
bool PROCESSP (Lisp_Object
);
784 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
785 INLINE
bool SAVE_VALUEP (Lisp_Object
);
786 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
788 INLINE
bool STRINGP (Lisp_Object
);
789 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
790 INLINE
bool SUBRP (Lisp_Object
);
791 INLINE
bool (SYMBOLP
) (Lisp_Object
);
792 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
793 INLINE
bool WINDOWP (Lisp_Object
);
794 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
796 /* Defined in chartab.c. */
797 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
798 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
799 extern int char_table_translate (Lisp_Object
, int);
801 /* Defined in data.c. */
802 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
803 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
804 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
805 extern Lisp_Object Qbool_vector_p
;
806 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
807 extern Lisp_Object Qwindow
;
808 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
810 /* Defined in emacs.c. */
811 extern bool might_dump
;
812 /* True means Emacs has already been initialized.
813 Used during startup to detect startup of dumped Emacs. */
814 extern bool initialized
;
816 /* Defined in eval.c. */
817 extern Lisp_Object Qautoload
;
819 /* Defined in floatfns.c. */
820 extern double extract_float (Lisp_Object
);
822 /* Defined in process.c. */
823 extern Lisp_Object Qprocessp
;
825 /* Defined in window.c. */
826 extern Lisp_Object Qwindowp
;
828 /* Defined in xdisp.c. */
829 extern Lisp_Object Qimage
;
832 /* Extract a value or address from a Lisp_Object. */
834 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
836 INLINE
struct Lisp_Vector
*
837 XVECTOR (Lisp_Object a
)
839 eassert (VECTORLIKEP (a
));
840 return XUNTAG (a
, Lisp_Vectorlike
);
843 INLINE
struct Lisp_String
*
844 XSTRING (Lisp_Object a
)
846 eassert (STRINGP (a
));
847 return XUNTAG (a
, Lisp_String
);
850 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
852 INLINE
struct Lisp_Float
*
853 XFLOAT (Lisp_Object a
)
855 eassert (FLOATP (a
));
856 return XUNTAG (a
, Lisp_Float
);
859 /* Pseudovector types. */
861 INLINE
struct Lisp_Process
*
862 XPROCESS (Lisp_Object a
)
864 eassert (PROCESSP (a
));
865 return XUNTAG (a
, Lisp_Vectorlike
);
868 INLINE
struct window
*
869 XWINDOW (Lisp_Object a
)
871 eassert (WINDOWP (a
));
872 return XUNTAG (a
, Lisp_Vectorlike
);
875 INLINE
struct terminal
*
876 XTERMINAL (Lisp_Object a
)
878 return XUNTAG (a
, Lisp_Vectorlike
);
881 INLINE
struct Lisp_Subr
*
882 XSUBR (Lisp_Object a
)
885 return XUNTAG (a
, Lisp_Vectorlike
);
888 INLINE
struct buffer
*
889 XBUFFER (Lisp_Object a
)
891 eassert (BUFFERP (a
));
892 return XUNTAG (a
, Lisp_Vectorlike
);
895 INLINE
struct Lisp_Char_Table
*
896 XCHAR_TABLE (Lisp_Object a
)
898 eassert (CHAR_TABLE_P (a
));
899 return XUNTAG (a
, Lisp_Vectorlike
);
902 INLINE
struct Lisp_Sub_Char_Table
*
903 XSUB_CHAR_TABLE (Lisp_Object a
)
905 eassert (SUB_CHAR_TABLE_P (a
));
906 return XUNTAG (a
, Lisp_Vectorlike
);
909 INLINE
struct Lisp_Bool_Vector
*
910 XBOOL_VECTOR (Lisp_Object a
)
912 eassert (BOOL_VECTOR_P (a
));
913 return XUNTAG (a
, Lisp_Vectorlike
);
916 /* Construct a Lisp_Object from a value or address. */
919 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
921 EMACS_UINT utype
= type
;
922 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
923 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
924 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
929 make_lisp_proc (struct Lisp_Process
*p
)
931 return make_lisp_ptr (p
, Lisp_Vectorlike
);
934 #define XSETINT(a, b) ((a) = make_number (b))
935 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
936 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
937 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
938 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
939 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
940 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
941 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
943 /* Pseudovector types. */
945 #define XSETPVECTYPE(v, code) \
946 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
947 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
948 ((v)->header.size = (PSEUDOVECTOR_FLAG \
949 | ((code) << PSEUDOVECTOR_AREA_BITS) \
950 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
953 /* The cast to struct vectorlike_header * avoids aliasing issues. */
954 #define XSETPSEUDOVECTOR(a, b, code) \
955 XSETTYPED_PSEUDOVECTOR (a, b, \
956 (((struct vectorlike_header *) \
957 XUNTAG (a, Lisp_Vectorlike)) \
960 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
961 (XSETVECTOR (a, b), \
962 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
963 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
965 #define XSETWINDOW_CONFIGURATION(a, b) \
966 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
967 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
968 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
969 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
970 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
971 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
972 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
973 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
974 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
975 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
979 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
980 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
983 /* Deprecated and will be removed soon. */
985 #define INTERNAL_FIELD(field) field ## _
987 /* See the macros in intervals.h. */
989 typedef struct interval
*INTERVAL
;
993 /* Car of this cons cell. */
996 /* Cdr of this cons cell. */
1000 /* Take the car or cdr of something known to be a cons cell. */
1001 /* The _addr functions shouldn't be used outside of the minimal set
1002 of code that has to know what a cons cell looks like. Other code not
1003 part of the basic lisp implementation should assume that the car and cdr
1004 fields are not accessible. (What if we want to switch to
1005 a copying collector someday? Cached cons cell field addresses may be
1006 invalidated at arbitrary points.) */
1007 INLINE Lisp_Object
*
1008 xcar_addr (Lisp_Object c
)
1010 return &XCONS (c
)->car
;
1012 INLINE Lisp_Object
*
1013 xcdr_addr (Lisp_Object c
)
1015 return &XCONS (c
)->cdr
;
1018 /* Use these from normal code. */
1019 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
1020 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
1022 /* Use these to set the fields of a cons cell.
1024 Note that both arguments may refer to the same object, so 'n'
1025 should not be read after 'c' is first modified. */
1027 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1032 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1037 /* Take the car or cdr of something whose type is not known. */
1041 return (CONSP (c
) ? XCAR (c
)
1043 : wrong_type_argument (Qlistp
, c
));
1048 return (CONSP (c
) ? XCDR (c
)
1050 : wrong_type_argument (Qlistp
, c
));
1053 /* Take the car or cdr of something whose type is not known. */
1055 CAR_SAFE (Lisp_Object c
)
1057 return CONSP (c
) ? XCAR (c
) : Qnil
;
1060 CDR_SAFE (Lisp_Object c
)
1062 return CONSP (c
) ? XCDR (c
) : Qnil
;
1065 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1070 ptrdiff_t size_byte
;
1071 INTERVAL intervals
; /* Text properties in this string. */
1072 unsigned char *data
;
1075 /* True if STR is a multibyte string. */
1077 STRING_MULTIBYTE (Lisp_Object str
)
1079 return 0 <= XSTRING (str
)->size_byte
;
1082 /* An upper bound on the number of bytes in a Lisp string, not
1083 counting the terminating null. This a tight enough bound to
1084 prevent integer overflow errors that would otherwise occur during
1085 string size calculations. A string cannot contain more bytes than
1086 a fixnum can represent, nor can it be so long that C pointer
1087 arithmetic stops working on the string plus its terminating null.
1088 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1089 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1090 would expose alloc.c internal details that we'd rather keep
1093 This is a macro for use in static initializers. The cast to
1094 ptrdiff_t ensures that the macro is signed. */
1095 #define STRING_BYTES_BOUND \
1096 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1098 /* Mark STR as a unibyte string. */
1099 #define STRING_SET_UNIBYTE(STR) \
1101 if (EQ (STR, empty_multibyte_string)) \
1102 (STR) = empty_unibyte_string; \
1104 XSTRING (STR)->size_byte = -1; \
1107 /* Mark STR as a multibyte string. Assure that STR contains only
1108 ASCII characters in advance. */
1109 #define STRING_SET_MULTIBYTE(STR) \
1111 if (EQ (STR, empty_unibyte_string)) \
1112 (STR) = empty_multibyte_string; \
1114 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1117 /* Convenience functions for dealing with Lisp strings. */
1119 INLINE
unsigned char *
1120 SDATA (Lisp_Object string
)
1122 return XSTRING (string
)->data
;
1125 SSDATA (Lisp_Object string
)
1127 /* Avoid "differ in sign" warnings. */
1128 return (char *) SDATA (string
);
1130 INLINE
unsigned char
1131 SREF (Lisp_Object string
, ptrdiff_t index
)
1133 return SDATA (string
)[index
];
1136 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1138 SDATA (string
)[index
] = new;
1141 SCHARS (Lisp_Object string
)
1143 return XSTRING (string
)->size
;
1147 STRING_BYTES (struct Lisp_String
*s
)
1149 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1153 SBYTES (Lisp_Object string
)
1155 return STRING_BYTES (XSTRING (string
));
1158 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1160 XSTRING (string
)->size
= newsize
;
1163 /* Header of vector-like objects. This documents the layout constraints on
1164 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1165 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1166 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1167 because when two such pointers potentially alias, a compiler won't
1168 incorrectly reorder loads and stores to their size fields. See
1170 struct vectorlike_header
1172 /* The only field contains various pieces of information:
1173 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1174 vector (0) or a pseudovector (1).
1175 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1176 of slots) of the vector.
1177 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1178 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1179 - b) number of Lisp_Objects slots at the beginning of the object
1180 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1182 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1183 measured in word_size units. Rest fields may also include
1184 Lisp_Objects, but these objects usually needs some special treatment
1186 There are some exceptions. For PVEC_FREE, b) is always zero. For
1187 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1188 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1189 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1193 /* A regular vector is just a header plus an array of Lisp_Objects. */
1197 struct vectorlike_header header
;
1198 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1201 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1204 ALIGNOF_STRUCT_LISP_VECTOR
1205 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1208 /* A boolvector is a kind of vectorlike, with contents like a string. */
1210 struct Lisp_Bool_Vector
1212 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1213 just the subtype information. */
1214 struct vectorlike_header header
;
1215 /* This is the size in bits. */
1217 /* The actual bits, packed into bytes.
1218 Zeros fill out the last word if needed.
1219 The bits are in little-endian order in the bytes, and
1220 the bytes are in little-endian order in the words. */
1221 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1225 bool_vector_size (Lisp_Object a
)
1227 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1228 eassume (0 <= size
);
1233 bool_vector_data (Lisp_Object a
)
1235 return XBOOL_VECTOR (a
)->data
;
1238 INLINE
unsigned char *
1239 bool_vector_uchar_data (Lisp_Object a
)
1241 return (unsigned char *) bool_vector_data (a
);
1244 /* The number of data words and bytes in a bool vector with SIZE bits. */
1247 bool_vector_words (EMACS_INT size
)
1249 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1250 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1254 bool_vector_bytes (EMACS_INT size
)
1256 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1257 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1260 /* True if A's Ith bit is set. */
1263 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1265 eassume (0 <= i
&& i
< bool_vector_size (a
));
1266 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1267 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1271 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1273 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1276 /* Set A's Ith bit to B. */
1279 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1281 unsigned char *addr
;
1283 eassume (0 <= i
&& i
< bool_vector_size (a
));
1284 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1287 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1289 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1292 /* Some handy constants for calculating sizes
1293 and offsets, mostly of vectorlike objects. */
1297 header_size
= offsetof (struct Lisp_Vector
, contents
),
1298 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1299 word_size
= sizeof (Lisp_Object
)
1302 /* Conveniences for dealing with Lisp arrays. */
1305 AREF (Lisp_Object array
, ptrdiff_t idx
)
1307 return XVECTOR (array
)->contents
[idx
];
1310 INLINE Lisp_Object
*
1311 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1313 return & XVECTOR (array
)->contents
[idx
];
1317 ASIZE (Lisp_Object array
)
1319 return XVECTOR (array
)->header
.size
;
1323 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1325 eassert (0 <= idx
&& idx
< ASIZE (array
));
1326 XVECTOR (array
)->contents
[idx
] = val
;
1330 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1332 /* Like ASET, but also can be used in the garbage collector:
1333 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1334 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1335 XVECTOR (array
)->contents
[idx
] = val
;
1338 /* If a struct is made to look like a vector, this macro returns the length
1339 of the shortest vector that would hold that struct. */
1341 #define VECSIZE(type) \
1342 ((sizeof (type) - header_size + word_size - 1) / word_size)
1344 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1345 at the end and we need to compute the number of Lisp_Object fields (the
1346 ones that the GC needs to trace). */
1348 #define PSEUDOVECSIZE(type, nonlispfield) \
1349 ((offsetof (type, nonlispfield) - header_size) / word_size)
1351 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1352 should be integer expressions. This is not the same as
1353 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1354 returns true. For efficiency, prefer plain unsigned comparison if A
1355 and B's sizes both fit (after integer promotion). */
1356 #define UNSIGNED_CMP(a, op, b) \
1357 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1358 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1359 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1361 /* True iff C is an ASCII character. */
1362 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1364 /* A char-table is a kind of vectorlike, with contents are like a
1365 vector but with a few other slots. For some purposes, it makes
1366 sense to handle a char-table with type struct Lisp_Vector. An
1367 element of a char table can be any Lisp objects, but if it is a sub
1368 char-table, we treat it a table that contains information of a
1369 specific range of characters. A sub char-table has the same
1370 structure as a vector. A sub char table appears only in an element
1371 of a char-table, and there's no way to access it directly from
1372 Emacs Lisp program. */
1374 enum CHARTAB_SIZE_BITS
1376 CHARTAB_SIZE_BITS_0
= 6,
1377 CHARTAB_SIZE_BITS_1
= 4,
1378 CHARTAB_SIZE_BITS_2
= 5,
1379 CHARTAB_SIZE_BITS_3
= 7
1382 extern const int chartab_size
[4];
1384 struct Lisp_Char_Table
1386 /* HEADER.SIZE is the vector's size field, which also holds the
1387 pseudovector type information. It holds the size, too.
1388 The size counts the defalt, parent, purpose, ascii,
1389 contents, and extras slots. */
1390 struct vectorlike_header header
;
1392 /* This holds a default value,
1393 which is used whenever the value for a specific character is nil. */
1396 /* This points to another char table, which we inherit from when the
1397 value for a specific character is nil. The `defalt' slot takes
1398 precedence over this. */
1401 /* This is a symbol which says what kind of use this char-table is
1403 Lisp_Object purpose
;
1405 /* The bottom sub char-table for characters of the range 0..127. It
1406 is nil if none of ASCII character has a specific value. */
1409 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1411 /* These hold additional data. It is a vector. */
1412 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1415 struct Lisp_Sub_Char_Table
1417 /* HEADER.SIZE is the vector's size field, which also holds the
1418 pseudovector type information. It holds the size, too. */
1419 struct vectorlike_header header
;
1421 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1422 char-table of depth 1 contains 16 elements, and each element
1423 covers 4096 (128*32) characters. A sub char-table of depth 2
1424 contains 32 elements, and each element covers 128 characters. A
1425 sub char-table of depth 3 contains 128 elements, and each element
1426 is for one character. */
1429 /* Minimum character covered by the sub char-table. */
1430 Lisp_Object min_char
;
1432 /* Use set_sub_char_table_contents to set this. */
1433 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1437 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1439 struct Lisp_Char_Table
*tbl
= NULL
;
1443 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1444 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1445 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1449 while (NILP (val
) && ! NILP (tbl
->parent
));
1454 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1455 characters. Do not check validity of CT. */
1457 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1459 return (ASCII_CHAR_P (idx
)
1460 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1461 : char_table_ref (ct
, idx
));
1464 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1465 8-bit European characters. Do not check validity of CT. */
1467 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1469 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1470 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1472 char_table_set (ct
, idx
, val
);
1475 /* This structure describes a built-in function.
1476 It is generated by the DEFUN macro only.
1477 defsubr makes it into a Lisp object. */
1481 struct vectorlike_header header
;
1483 Lisp_Object (*a0
) (void);
1484 Lisp_Object (*a1
) (Lisp_Object
);
1485 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1486 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1487 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1488 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1489 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1490 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1491 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1492 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1493 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1495 short min_args
, max_args
;
1496 const char *symbol_name
;
1497 const char *intspec
;
1501 /* This is the number of slots that every char table must have. This
1502 counts the ordinary slots and the top, defalt, parent, and purpose
1504 enum CHAR_TABLE_STANDARD_SLOTS
1506 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1509 /* Return the number of "extra" slots in the char table CT. */
1512 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1514 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1515 - CHAR_TABLE_STANDARD_SLOTS
);
1519 /***********************************************************************
1521 ***********************************************************************/
1523 /* Interned state of a symbol. */
1525 enum symbol_interned
1527 SYMBOL_UNINTERNED
= 0,
1528 SYMBOL_INTERNED
= 1,
1529 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1532 enum symbol_redirect
1534 SYMBOL_PLAINVAL
= 4,
1535 SYMBOL_VARALIAS
= 1,
1536 SYMBOL_LOCALIZED
= 2,
1537 SYMBOL_FORWARDED
= 3
1542 /* Indicates where the value can be found:
1543 0 : it's a plain var, the value is in the `value' field.
1544 1 : it's a varalias, the value is really in the `alias' symbol.
1545 2 : it's a localized var, the value is in the `blv' object.
1546 3 : it's a forwarding variable, the value is in `forward'. */
1547 ENUM_BF (symbol_redirect
) redirect
: 3;
1549 /* Non-zero means symbol is constant, i.e. changing its value
1550 should signal an error. If the value is 3, then the var
1551 can be changed, but only by `defconst'. */
1552 unsigned constant
: 2;
1554 /* Interned state of the symbol. This is an enumerator from
1555 enum symbol_interned. */
1556 unsigned interned
: 2;
1558 /* True means that this variable has been explicitly declared
1559 special (with `defvar' etc), and shouldn't be lexically bound. */
1560 bool_bf declared_special
: 1;
1562 /* True if pointed to from purespace and hence can't be GC'd. */
1565 /* The symbol's name, as a Lisp string. */
1568 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1569 union is used depends on the `redirect' field above. */
1572 struct Lisp_Symbol
*alias
;
1573 struct Lisp_Buffer_Local_Value
*blv
;
1574 union Lisp_Fwd
*fwd
;
1577 /* Function value of the symbol or Qnil if not fboundp. */
1578 Lisp_Object function
;
1580 /* The symbol's property list. */
1583 /* Next symbol in obarray bucket, if the symbol is interned. */
1584 struct Lisp_Symbol
*next
;
1587 /* Value is name of symbol. */
1589 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1591 INLINE
struct Lisp_Symbol
*
1592 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1594 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1595 return sym
->val
.alias
;
1597 INLINE
struct Lisp_Buffer_Local_Value
*
1598 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1600 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1601 return sym
->val
.blv
;
1603 INLINE
union Lisp_Fwd
*
1604 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1606 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1607 return sym
->val
.fwd
;
1610 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1611 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1614 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1616 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1620 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1622 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1626 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1628 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1633 SYMBOL_NAME (Lisp_Object sym
)
1635 return XSYMBOL (sym
)->name
;
1638 /* Value is true if SYM is an interned symbol. */
1641 SYMBOL_INTERNED_P (Lisp_Object sym
)
1643 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1646 /* Value is true if SYM is interned in initial_obarray. */
1649 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1651 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1654 /* Value is non-zero if symbol is considered a constant, i.e. its
1655 value cannot be changed (there is an exception for keyword symbols,
1656 whose value can be set to the keyword symbol itself). */
1658 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1660 #define DEFSYM(sym, name) \
1661 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1664 /***********************************************************************
1666 ***********************************************************************/
1668 /* The structure of a Lisp hash table. */
1670 struct hash_table_test
1672 /* Name of the function used to compare keys. */
1675 /* User-supplied hash function, or nil. */
1676 Lisp_Object user_hash_function
;
1678 /* User-supplied key comparison function, or nil. */
1679 Lisp_Object user_cmp_function
;
1681 /* C function to compare two keys. */
1682 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1684 /* C function to compute hash code. */
1685 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1688 struct Lisp_Hash_Table
1690 /* This is for Lisp; the hash table code does not refer to it. */
1691 struct vectorlike_header header
;
1693 /* Nil if table is non-weak. Otherwise a symbol describing the
1694 weakness of the table. */
1697 /* When the table is resized, and this is an integer, compute the
1698 new size by adding this to the old size. If a float, compute the
1699 new size by multiplying the old size with this factor. */
1700 Lisp_Object rehash_size
;
1702 /* Resize hash table when number of entries/ table size is >= this
1704 Lisp_Object rehash_threshold
;
1706 /* Vector of hash codes. If hash[I] is nil, this means that the
1707 I-th entry is unused. */
1710 /* Vector used to chain entries. If entry I is free, next[I] is the
1711 entry number of the next free item. If entry I is non-free,
1712 next[I] is the index of the next entry in the collision chain. */
1715 /* Index of first free entry in free list. */
1716 Lisp_Object next_free
;
1718 /* Bucket vector. A non-nil entry is the index of the first item in
1719 a collision chain. This vector's size can be larger than the
1720 hash table size to reduce collisions. */
1723 /* Only the fields above are traced normally by the GC. The ones below
1724 `count' are special and are either ignored by the GC or traced in
1725 a special way (e.g. because of weakness). */
1727 /* Number of key/value entries in the table. */
1730 /* Vector of keys and values. The key of item I is found at index
1731 2 * I, the value is found at index 2 * I + 1.
1732 This is gc_marked specially if the table is weak. */
1733 Lisp_Object key_and_value
;
1735 /* The comparison and hash functions. */
1736 struct hash_table_test test
;
1738 /* Next weak hash table if this is a weak hash table. The head
1739 of the list is in weak_hash_tables. */
1740 struct Lisp_Hash_Table
*next_weak
;
1744 INLINE
struct Lisp_Hash_Table
*
1745 XHASH_TABLE (Lisp_Object a
)
1747 return XUNTAG (a
, Lisp_Vectorlike
);
1750 #define XSET_HASH_TABLE(VAR, PTR) \
1751 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1754 HASH_TABLE_P (Lisp_Object a
)
1756 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1759 /* Value is the key part of entry IDX in hash table H. */
1761 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1763 return AREF (h
->key_and_value
, 2 * idx
);
1766 /* Value is the value part of entry IDX in hash table H. */
1768 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1770 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1773 /* Value is the index of the next entry following the one at IDX
1776 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1778 return AREF (h
->next
, idx
);
1781 /* Value is the hash code computed for entry IDX in hash table H. */
1783 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1785 return AREF (h
->hash
, idx
);
1788 /* Value is the index of the element in hash table H that is the
1789 start of the collision list at index IDX in the index vector of H. */
1791 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1793 return AREF (h
->index
, idx
);
1796 /* Value is the size of hash table H. */
1798 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1800 return ASIZE (h
->next
);
1803 /* Default size for hash tables if not specified. */
1805 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1807 /* Default threshold specifying when to resize a hash table. The
1808 value gives the ratio of current entries in the hash table and the
1809 size of the hash table. */
1811 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1813 /* Default factor by which to increase the size of a hash table. */
1815 static double const DEFAULT_REHASH_SIZE
= 1.5;
1817 /* Combine two integers X and Y for hashing. The result might not fit
1818 into a Lisp integer. */
1821 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1823 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1826 /* Hash X, returning a value that fits into a fixnum. */
1829 SXHASH_REDUCE (EMACS_UINT x
)
1831 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1834 /* These structures are used for various misc types. */
1836 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1838 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1843 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1844 /* This flag is temporarily used in the functions
1845 decode/encode_coding_object to record that the marker position
1846 must be adjusted after the conversion. */
1847 bool_bf need_adjustment
: 1;
1848 /* True means normal insertion at the marker's position
1849 leaves the marker after the inserted text. */
1850 bool_bf insertion_type
: 1;
1851 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1852 Note: a chain of markers can contain markers pointing into different
1853 buffers (the chain is per buffer_text rather than per buffer, so it's
1854 shared between indirect buffers). */
1855 /* This is used for (other than NULL-checking):
1857 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1858 - unchain_marker: to find the list from which to unchain.
1859 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1861 struct buffer
*buffer
;
1863 /* The remaining fields are meaningless in a marker that
1864 does not point anywhere. */
1866 /* For markers that point somewhere,
1867 this is used to chain of all the markers in a given buffer. */
1868 /* We could remove it and use an array in buffer_text instead.
1869 That would also allow to preserve it ordered. */
1870 struct Lisp_Marker
*next
;
1871 /* This is the char position where the marker points. */
1873 /* This is the byte position.
1874 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1875 used to implement the functionality of markers, but rather to (ab)use
1876 markers as a cache for char<->byte mappings). */
1880 /* START and END are markers in the overlay's buffer, and
1881 PLIST is the overlay's property list. */
1883 /* An overlay's real data content is:
1885 - buffer (really there are two buffer pointers, one per marker,
1886 and both points to the same buffer)
1887 - insertion type of both ends (per-marker fields)
1888 - start & start byte (of start marker)
1889 - end & end byte (of end marker)
1890 - next (singly linked list of overlays)
1891 - next fields of start and end markers (singly linked list of markers).
1892 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1895 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1896 struct Lisp_Overlay
*next
;
1902 /* Types of data which may be saved in a Lisp_Save_Value. */
1913 /* Number of bits needed to store one of the above values. */
1914 enum { SAVE_SLOT_BITS
= 3 };
1916 /* Number of slots in a save value where save_type is nonzero. */
1917 enum { SAVE_VALUE_SLOTS
= 4 };
1919 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1921 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1925 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1926 SAVE_TYPE_INT_INT_INT
1927 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1928 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1929 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1930 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1931 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1932 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1933 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1934 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1935 SAVE_TYPE_FUNCPTR_PTR_OBJ
1936 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1938 /* This has an extra bit indicating it's raw memory. */
1939 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1942 /* Special object used to hold a different values for later use.
1944 This is mostly used to package C integers and pointers to call
1945 record_unwind_protect when two or more values need to be saved.
1949 struct my_data *md = get_my_data ();
1950 ptrdiff_t mi = get_my_integer ();
1951 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1954 Lisp_Object my_unwind (Lisp_Object arg)
1956 struct my_data *md = XSAVE_POINTER (arg, 0);
1957 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1961 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1962 saved objects and raise eassert if type of the saved object doesn't match
1963 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1964 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1965 slot 0 is a pointer. */
1967 typedef void (*voidfuncptr
) (void);
1969 struct Lisp_Save_Value
1971 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1972 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1974 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1975 V's data entries are determined by V->save_type. E.g., if
1976 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1977 V->data[1] is an integer, and V's other data entries are unused.
1979 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1980 a memory area containing V->data[1].integer potential Lisp_Objects. */
1981 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1984 voidfuncptr funcpointer
;
1987 } data
[SAVE_VALUE_SLOTS
];
1990 /* Return the type of V's Nth saved value. */
1992 save_type (struct Lisp_Save_Value
*v
, int n
)
1994 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1995 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1998 /* Get and set the Nth saved pointer. */
2001 XSAVE_POINTER (Lisp_Object obj
, int n
)
2003 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2004 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2007 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2009 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2010 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2013 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2015 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2016 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2019 /* Likewise for the saved integer. */
2022 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2024 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2025 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2028 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2030 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2031 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2034 /* Extract Nth saved object. */
2037 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2039 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2040 return XSAVE_VALUE (obj
)->data
[n
].object
;
2043 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2044 It uses one of these struct subtypes to get the type field. */
2048 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2049 struct Lisp_Marker u_marker
;
2050 struct Lisp_Overlay u_overlay
;
2051 struct Lisp_Save_Value u_save_value
;
2054 INLINE
union Lisp_Misc
*
2055 XMISC (Lisp_Object a
)
2057 return XUNTAG (a
, Lisp_Misc
);
2060 INLINE
struct Lisp_Misc_Any
*
2061 XMISCANY (Lisp_Object a
)
2063 eassert (MISCP (a
));
2064 return & XMISC (a
)->u_any
;
2067 INLINE
enum Lisp_Misc_Type
2068 XMISCTYPE (Lisp_Object a
)
2070 return XMISCANY (a
)->type
;
2073 INLINE
struct Lisp_Marker
*
2074 XMARKER (Lisp_Object a
)
2076 eassert (MARKERP (a
));
2077 return & XMISC (a
)->u_marker
;
2080 INLINE
struct Lisp_Overlay
*
2081 XOVERLAY (Lisp_Object a
)
2083 eassert (OVERLAYP (a
));
2084 return & XMISC (a
)->u_overlay
;
2087 INLINE
struct Lisp_Save_Value
*
2088 XSAVE_VALUE (Lisp_Object a
)
2090 eassert (SAVE_VALUEP (a
));
2091 return & XMISC (a
)->u_save_value
;
2094 /* Forwarding pointer to an int variable.
2095 This is allowed only in the value cell of a symbol,
2096 and it means that the symbol's value really lives in the
2097 specified int variable. */
2100 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2104 /* Boolean forwarding pointer to an int variable.
2105 This is like Lisp_Intfwd except that the ostensible
2106 "value" of the symbol is t if the bool variable is true,
2107 nil if it is false. */
2110 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2114 /* Forwarding pointer to a Lisp_Object variable.
2115 This is allowed only in the value cell of a symbol,
2116 and it means that the symbol's value really lives in the
2117 specified variable. */
2120 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2121 Lisp_Object
*objvar
;
2124 /* Like Lisp_Objfwd except that value lives in a slot in the
2125 current buffer. Value is byte index of slot within buffer. */
2126 struct Lisp_Buffer_Objfwd
2128 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2130 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2131 Lisp_Object predicate
;
2134 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2135 the symbol has buffer-local or frame-local bindings. (Exception:
2136 some buffer-local variables are built-in, with their values stored
2137 in the buffer structure itself. They are handled differently,
2138 using struct Lisp_Buffer_Objfwd.)
2140 The `realvalue' slot holds the variable's current value, or a
2141 forwarding pointer to where that value is kept. This value is the
2142 one that corresponds to the loaded binding. To read or set the
2143 variable, you must first make sure the right binding is loaded;
2144 then you can access the value in (or through) `realvalue'.
2146 `buffer' and `frame' are the buffer and frame for which the loaded
2147 binding was found. If those have changed, to make sure the right
2148 binding is loaded it is necessary to find which binding goes with
2149 the current buffer and selected frame, then load it. To load it,
2150 first unload the previous binding, then copy the value of the new
2151 binding into `realvalue' (or through it). Also update
2152 LOADED-BINDING to point to the newly loaded binding.
2154 `local_if_set' indicates that merely setting the variable creates a
2155 local binding for the current buffer. Otherwise the latter, setting
2156 the variable does not do that; only make-local-variable does that. */
2158 struct Lisp_Buffer_Local_Value
2160 /* True means that merely setting the variable creates a local
2161 binding for the current buffer. */
2162 bool_bf local_if_set
: 1;
2163 /* True means this variable can have frame-local bindings, otherwise, it is
2164 can have buffer-local bindings. The two cannot be combined. */
2165 bool_bf frame_local
: 1;
2166 /* True means that the binding now loaded was found.
2167 Presumably equivalent to (defcell!=valcell). */
2169 /* If non-NULL, a forwarding to the C var where it should also be set. */
2170 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2171 /* The buffer or frame for which the loaded binding was found. */
2173 /* A cons cell that holds the default value. It has the form
2174 (SYMBOL . DEFAULT-VALUE). */
2175 Lisp_Object defcell
;
2176 /* The cons cell from `where's parameter alist.
2177 It always has the form (SYMBOL . VALUE)
2178 Note that if `forward' is non-nil, VALUE may be out of date.
2179 Also if the currently loaded binding is the default binding, then
2180 this is `eq'ual to defcell. */
2181 Lisp_Object valcell
;
2184 /* Like Lisp_Objfwd except that value lives in a slot in the
2186 struct Lisp_Kboard_Objfwd
2188 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2194 struct Lisp_Intfwd u_intfwd
;
2195 struct Lisp_Boolfwd u_boolfwd
;
2196 struct Lisp_Objfwd u_objfwd
;
2197 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2198 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2201 INLINE
enum Lisp_Fwd_Type
2202 XFWDTYPE (union Lisp_Fwd
*a
)
2204 return a
->u_intfwd
.type
;
2207 INLINE
struct Lisp_Buffer_Objfwd
*
2208 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2210 eassert (BUFFER_OBJFWDP (a
));
2211 return &a
->u_buffer_objfwd
;
2214 /* Lisp floating point type. */
2221 XFLOAT_DATA (Lisp_Object f
)
2223 return XFLOAT (f
)->data
;
2226 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2227 representations, have infinities and NaNs, and do not trap on
2228 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2229 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2230 wanted here, but is not quite right because Emacs does not require
2231 all the features of C11 Annex F (and does not require C11 at all,
2232 for that matter). */
2236 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2237 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2240 /* A character, declared with the following typedef, is a member
2241 of some character set associated with the current buffer. */
2242 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2244 typedef unsigned char UCHAR
;
2247 /* Meanings of slots in a Lisp_Compiled: */
2251 COMPILED_ARGLIST
= 0,
2252 COMPILED_BYTECODE
= 1,
2253 COMPILED_CONSTANTS
= 2,
2254 COMPILED_STACK_DEPTH
= 3,
2255 COMPILED_DOC_STRING
= 4,
2256 COMPILED_INTERACTIVE
= 5
2259 /* Flag bits in a character. These also get used in termhooks.h.
2260 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2261 (MUlti-Lingual Emacs) might need 22 bits for the character value
2262 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2265 CHAR_ALT
= 0x0400000,
2266 CHAR_SUPER
= 0x0800000,
2267 CHAR_HYPER
= 0x1000000,
2268 CHAR_SHIFT
= 0x2000000,
2269 CHAR_CTL
= 0x4000000,
2270 CHAR_META
= 0x8000000,
2272 CHAR_MODIFIER_MASK
=
2273 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2275 /* Actually, the current Emacs uses 22 bits for the character value
2280 /* Data type checking. */
2282 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2285 NUMBERP (Lisp_Object x
)
2287 return INTEGERP (x
) || FLOATP (x
);
2290 NATNUMP (Lisp_Object x
)
2292 return INTEGERP (x
) && 0 <= XINT (x
);
2296 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2298 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2301 #define TYPE_RANGED_INTEGERP(type, x) \
2303 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2304 && XINT (x) <= TYPE_MAXIMUM (type))
2306 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2307 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2308 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2309 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2310 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2311 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2312 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2315 STRINGP (Lisp_Object x
)
2317 return XTYPE (x
) == Lisp_String
;
2320 VECTORP (Lisp_Object x
)
2322 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2325 OVERLAYP (Lisp_Object x
)
2327 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2330 SAVE_VALUEP (Lisp_Object x
)
2332 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2336 AUTOLOADP (Lisp_Object x
)
2338 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2342 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2344 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2348 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2350 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2351 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2354 /* True if A is a pseudovector whose code is CODE. */
2356 PSEUDOVECTORP (Lisp_Object a
, int code
)
2358 if (! VECTORLIKEP (a
))
2362 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2363 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2364 return PSEUDOVECTOR_TYPEP (h
, code
);
2369 /* Test for specific pseudovector types. */
2372 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2374 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2378 PROCESSP (Lisp_Object a
)
2380 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2384 WINDOWP (Lisp_Object a
)
2386 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2390 TERMINALP (Lisp_Object a
)
2392 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2396 SUBRP (Lisp_Object a
)
2398 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2402 COMPILEDP (Lisp_Object a
)
2404 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2408 BUFFERP (Lisp_Object a
)
2410 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2414 CHAR_TABLE_P (Lisp_Object a
)
2416 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2420 SUB_CHAR_TABLE_P (Lisp_Object a
)
2422 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2426 BOOL_VECTOR_P (Lisp_Object a
)
2428 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2432 FRAMEP (Lisp_Object a
)
2434 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2437 /* Test for image (image . spec) */
2439 IMAGEP (Lisp_Object x
)
2441 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2446 ARRAYP (Lisp_Object x
)
2448 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2452 CHECK_LIST (Lisp_Object x
)
2454 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2457 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2458 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2459 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2462 CHECK_STRING (Lisp_Object x
)
2464 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2467 CHECK_STRING_CAR (Lisp_Object x
)
2469 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2472 CHECK_CONS (Lisp_Object x
)
2474 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2477 CHECK_VECTOR (Lisp_Object x
)
2479 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2482 CHECK_BOOL_VECTOR (Lisp_Object x
)
2484 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2487 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2489 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2492 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2494 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2497 CHECK_BUFFER (Lisp_Object x
)
2499 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2502 CHECK_WINDOW (Lisp_Object x
)
2504 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2508 CHECK_PROCESS (Lisp_Object x
)
2510 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2514 CHECK_NATNUM (Lisp_Object x
)
2516 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2519 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2522 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2523 args_out_of_range_3 \
2525 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2526 ? MOST_NEGATIVE_FIXNUM \
2528 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2530 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2532 if (TYPE_SIGNED (type)) \
2533 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2535 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2538 #define CHECK_NUMBER_COERCE_MARKER(x) \
2540 if (MARKERP ((x))) \
2541 XSETFASTINT (x, marker_position (x)); \
2543 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2547 XFLOATINT (Lisp_Object n
)
2549 return extract_float (n
);
2553 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2555 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2558 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2561 XSETFASTINT (x, marker_position (x)); \
2563 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2566 /* Since we can't assign directly to the CAR or CDR fields of a cons
2567 cell, use these when checking that those fields contain numbers. */
2569 CHECK_NUMBER_CAR (Lisp_Object x
)
2571 Lisp_Object tmp
= XCAR (x
);
2577 CHECK_NUMBER_CDR (Lisp_Object x
)
2579 Lisp_Object tmp
= XCDR (x
);
2584 /* Define a built-in function for calling from Lisp.
2585 `lname' should be the name to give the function in Lisp,
2586 as a null-terminated C string.
2587 `fnname' should be the name of the function in C.
2588 By convention, it starts with F.
2589 `sname' should be the name for the C constant structure
2590 that records information on this function for internal use.
2591 By convention, it should be the same as `fnname' but with S instead of F.
2592 It's too bad that C macros can't compute this from `fnname'.
2593 `minargs' should be a number, the minimum number of arguments allowed.
2594 `maxargs' should be a number, the maximum number of arguments allowed,
2595 or else MANY or UNEVALLED.
2596 MANY means pass a vector of evaluated arguments,
2597 in the form of an integer number-of-arguments
2598 followed by the address of a vector of Lisp_Objects
2599 which contains the argument values.
2600 UNEVALLED means pass the list of unevaluated arguments
2601 `intspec' says how interactive arguments are to be fetched.
2602 If the string starts with a `(', `intspec' is evaluated and the resulting
2603 list is the list of arguments.
2604 If it's a string that doesn't start with `(', the value should follow
2605 the one of the doc string for `interactive'.
2606 A null string means call interactively with no arguments.
2607 `doc' is documentation for the user. */
2609 /* This version of DEFUN declares a function prototype with the right
2610 arguments, so we can catch errors with maxargs at compile-time. */
2612 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2613 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2614 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2615 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2616 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2617 { (Lisp_Object (__cdecl *)(void))fnname }, \
2618 minargs, maxargs, lname, intspec, 0}; \
2620 #else /* not _MSC_VER */
2621 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2622 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2623 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2624 { .a ## maxargs = fnname }, \
2625 minargs, maxargs, lname, intspec, 0}; \
2629 /* Note that the weird token-substitution semantics of ANSI C makes
2630 this work for MANY and UNEVALLED. */
2631 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2632 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2633 #define DEFUN_ARGS_0 (void)
2634 #define DEFUN_ARGS_1 (Lisp_Object)
2635 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2636 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2637 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2638 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2640 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2641 Lisp_Object, Lisp_Object)
2642 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2643 Lisp_Object, Lisp_Object, Lisp_Object)
2644 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2645 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2647 /* True if OBJ is a Lisp function. */
2649 FUNCTIONP (Lisp_Object obj
)
2651 return functionp (obj
);
2655 is how we define the symbol for function `name' at start-up time. */
2656 extern void defsubr (struct Lisp_Subr
*);
2664 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2665 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2666 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2667 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2668 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2670 /* Macros we use to define forwarded Lisp variables.
2671 These are used in the syms_of_FILENAME functions.
2673 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2674 lisp variable is actually a field in `struct emacs_globals'. The
2675 field's name begins with "f_", which is a convention enforced by
2676 these macros. Each such global has a corresponding #define in
2677 globals.h; the plain name should be used in the code.
2679 E.g., the global "cons_cells_consed" is declared as "int
2680 f_cons_cells_consed" in globals.h, but there is a define:
2682 #define cons_cells_consed globals.f_cons_cells_consed
2684 All C code uses the `cons_cells_consed' name. This is all done
2685 this way to support indirection for multi-threaded Emacs. */
2687 #define DEFVAR_LISP(lname, vname, doc) \
2689 static struct Lisp_Objfwd o_fwd; \
2690 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2692 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2694 static struct Lisp_Objfwd o_fwd; \
2695 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2697 #define DEFVAR_BOOL(lname, vname, doc) \
2699 static struct Lisp_Boolfwd b_fwd; \
2700 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2702 #define DEFVAR_INT(lname, vname, doc) \
2704 static struct Lisp_Intfwd i_fwd; \
2705 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2708 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2710 static struct Lisp_Objfwd o_fwd; \
2711 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2714 #define DEFVAR_KBOARD(lname, vname, doc) \
2716 static struct Lisp_Kboard_Objfwd ko_fwd; \
2717 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2720 /* Save and restore the instruction and environment pointers,
2721 without affecting the signal mask. */
2724 typedef jmp_buf sys_jmp_buf
;
2725 # define sys_setjmp(j) _setjmp (j)
2726 # define sys_longjmp(j, v) _longjmp (j, v)
2727 #elif defined HAVE_SIGSETJMP
2728 typedef sigjmp_buf sys_jmp_buf
;
2729 # define sys_setjmp(j) sigsetjmp (j, 0)
2730 # define sys_longjmp(j, v) siglongjmp (j, v)
2732 /* A platform that uses neither _longjmp nor siglongjmp; assume
2733 longjmp does not affect the sigmask. */
2734 typedef jmp_buf sys_jmp_buf
;
2735 # define sys_setjmp(j) setjmp (j)
2736 # define sys_longjmp(j, v) longjmp (j, v)
2740 /* Elisp uses several stacks:
2742 - the bytecode stack: used internally by the bytecode interpreter.
2743 Allocated from the C stack.
2744 - The specpdl stack: keeps track of active unwind-protect and
2745 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2747 - The handler stack: keeps track of active catch tags and condition-case
2748 handlers. Allocated in a manually managed stack implemented by a
2749 doubly-linked list allocated via xmalloc and never freed. */
2751 /* Structure for recording Lisp call stack for backtrace purposes. */
2753 /* The special binding stack holds the outer values of variables while
2754 they are bound by a function application or a let form, stores the
2755 code to be executed for unwind-protect forms.
2757 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2758 used all over the place, needs to be fast, and needs to know the size of
2759 union specbinding. But only eval.c should access it. */
2762 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2763 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2764 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2765 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2766 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2767 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2768 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2769 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2770 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2775 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2777 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2778 void (*func
) (Lisp_Object
);
2782 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2783 void (*func
) (void *);
2787 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2792 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2793 void (*func
) (void);
2796 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2797 /* `where' is not used in the case of SPECPDL_LET. */
2798 Lisp_Object symbol
, old_value
, where
;
2801 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2802 bool_bf debug_on_exit
: 1;
2803 Lisp_Object function
;
2809 extern union specbinding
*specpdl
;
2810 extern union specbinding
*specpdl_ptr
;
2811 extern ptrdiff_t specpdl_size
;
2814 SPECPDL_INDEX (void)
2816 return specpdl_ptr
- specpdl
;
2819 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2820 control structures. A struct handler contains all the information needed to
2821 restore the state of the interpreter after a non-local jump.
2823 handler structures are chained together in a doubly linked list; the `next'
2824 member points to the next outer catchtag and the `nextfree' member points in
2825 the other direction to the next inner element (which is typically the next
2826 free element since we mostly use it on the deepest handler).
2828 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2829 member is TAG, and then unbinds to it. The `val' member is used to
2830 hold VAL while the stack is unwound; `val' is returned as the value
2833 All the other members are concerned with restoring the interpreter
2836 Members are volatile if their values need to survive _longjmp when
2837 a 'struct handler' is a local variable. */
2839 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2843 enum handlertype type
;
2844 Lisp_Object tag_or_ch
;
2846 struct handler
*next
;
2847 struct handler
*nextfree
;
2849 /* The bytecode interpreter can have several handlers active at the same
2850 time, so when we longjmp to one of them, it needs to know which handler
2851 this was and what was the corresponding internal state. This is stored
2852 here, and when we longjmp we make sure that handlerlist points to the
2854 Lisp_Object
*bytecode_top
;
2857 /* Most global vars are reset to their value via the specpdl mechanism,
2858 but a few others are handled by storing their value here. */
2859 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
2860 struct gcpro
*gcpro
;
2863 EMACS_INT lisp_eval_depth
;
2865 int poll_suppress_count
;
2866 int interrupt_input_blocked
;
2869 /* Fill in the components of c, and put it on the list. */
2870 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2871 if (handlerlist->nextfree) \
2872 (c) = handlerlist->nextfree; \
2875 (c) = xmalloc (sizeof (struct handler)); \
2876 (c)->nextfree = NULL; \
2877 handlerlist->nextfree = (c); \
2879 (c)->type = (handlertype); \
2880 (c)->tag_or_ch = (tag_ch_val); \
2882 (c)->next = handlerlist; \
2883 (c)->lisp_eval_depth = lisp_eval_depth; \
2884 (c)->pdlcount = SPECPDL_INDEX (); \
2885 (c)->poll_suppress_count = poll_suppress_count; \
2886 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2887 (c)->gcpro = gcprolist; \
2891 extern Lisp_Object memory_signal_data
;
2893 /* Check quit-flag and quit if it is non-nil.
2894 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2895 So the program needs to do QUIT at times when it is safe to quit.
2896 Every loop that might run for a long time or might not exit
2897 ought to do QUIT at least once, at a safe place.
2898 Unless that is impossible, of course.
2899 But it is very desirable to avoid creating loops where QUIT is impossible.
2901 Exception: if you set immediate_quit to true,
2902 then the handler that responds to the C-g does the quit itself.
2903 This is a good thing to do around a loop that has no side effects
2904 and (in particular) cannot call arbitrary Lisp code.
2906 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2907 a request to exit Emacs when it is safe to do. */
2909 extern void process_pending_signals (void);
2910 extern bool volatile pending_signals
;
2912 extern void process_quit_flag (void);
2915 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2916 process_quit_flag (); \
2917 else if (pending_signals) \
2918 process_pending_signals (); \
2922 /* True if ought to quit now. */
2924 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2926 extern Lisp_Object Vascii_downcase_table
;
2927 extern Lisp_Object Vascii_canon_table
;
2929 /* Structure for recording stack slots that need marking. */
2931 /* This is a chain of structures, each of which points at a Lisp_Object
2932 variable whose value should be marked in garbage collection.
2933 Normally every link of the chain is an automatic variable of a function,
2934 and its `val' points to some argument or local variable of the function.
2935 On exit to the function, the chain is set back to the value it had on entry.
2936 This way, no link remains in the chain when the stack frame containing the
2939 Every function that can call Feval must protect in this fashion all
2940 Lisp_Object variables whose contents will be used again. */
2942 extern struct gcpro
*gcprolist
;
2948 /* Address of first protected variable. */
2949 volatile Lisp_Object
*var
;
2951 /* Number of consecutive protected variables. */
2959 /* Do something silly with gcproN vars just so gcc shuts up. */
2960 /* You get warnings from MIPSPro... */
2962 #define GCPRO1(varname) ((void) gcpro1)
2963 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2964 #define GCPRO3(varname1, varname2, varname3) \
2965 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2966 #define GCPRO4(varname1, varname2, varname3, varname4) \
2967 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2968 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2969 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2970 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2971 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2973 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
2974 #define UNGCPRO ((void) 0)
2976 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2977 #define RETURN_UNGCPRO(expr) \
2980 Lisp_Object ret_ungc_val; \
2981 ret_ungc_val = (expr); \
2983 return ret_ungc_val; \
2987 /* Call staticpro (&var) to protect static variable `var'. */
2989 void staticpro (Lisp_Object
*);
2991 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2992 meaning as in the DEFUN macro, and is used to construct a prototype. */
2993 /* We can use the same trick as in the DEFUN macro to generate the
2994 appropriate prototype. */
2995 #define EXFUN(fnname, maxargs) \
2996 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2998 #include "globals.h"
3000 /* Forward declarations for prototypes. */
3004 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3007 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3009 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3010 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3013 /* Functions to modify hash tables. */
3016 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3018 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3022 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3024 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3027 /* Use these functions to set Lisp_Object
3028 or pointer slots of struct Lisp_Symbol. */
3031 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3033 XSYMBOL (sym
)->function
= function
;
3037 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3039 XSYMBOL (sym
)->plist
= plist
;
3043 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3045 XSYMBOL (sym
)->next
= next
;
3048 /* Buffer-local (also frame-local) variable access functions. */
3051 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3053 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3057 /* Set overlay's property list. */
3060 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3062 XOVERLAY (overlay
)->plist
= plist
;
3065 /* Get text properties of S. */
3068 string_intervals (Lisp_Object s
)
3070 return XSTRING (s
)->intervals
;
3073 /* Set text properties of S to I. */
3076 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3078 XSTRING (s
)->intervals
= i
;
3081 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3082 of setting slots directly. */
3085 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3087 XCHAR_TABLE (table
)->defalt
= val
;
3090 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3092 XCHAR_TABLE (table
)->purpose
= val
;
3095 /* Set different slots in (sub)character tables. */
3098 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3100 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3101 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3105 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3107 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3108 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3112 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3114 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3117 /* Defined in data.c. */
3118 extern Lisp_Object Qquote
, Qunbound
;
3119 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3120 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3121 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3122 extern Lisp_Object Qinvalid_read_syntax
;
3123 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3124 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3125 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3126 extern Lisp_Object Qtext_read_only
;
3127 extern Lisp_Object Qinteractive_form
;
3128 extern Lisp_Object Qcircular_list
;
3129 extern Lisp_Object Qsequencep
;
3130 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
3131 extern Lisp_Object Qfboundp
;
3133 extern Lisp_Object Qcdr
;
3135 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3137 extern Lisp_Object Qnumber_or_marker_p
;
3139 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3141 /* Defined in data.c. */
3142 extern Lisp_Object
indirect_function (Lisp_Object
);
3143 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3144 enum Arith_Comparison
{
3149 ARITH_LESS_OR_EQUAL
,
3152 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3153 enum Arith_Comparison comparison
);
3155 /* Convert the integer I to an Emacs representation, either the integer
3156 itself, or a cons of two or three integers, or if all else fails a float.
3157 I should not have side effects. */
3158 #define INTEGER_TO_CONS(i) \
3159 (! FIXNUM_OVERFLOW_P (i) \
3161 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3162 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3163 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3164 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3165 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3166 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3167 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3168 ? Fcons (make_number ((i) >> 16 >> 24), \
3169 Fcons (make_number ((i) >> 16 & 0xffffff), \
3170 make_number ((i) & 0xffff))) \
3173 /* Convert the Emacs representation CONS back to an integer of type
3174 TYPE, storing the result the variable VAR. Signal an error if CONS
3175 is not a valid representation or is out of range for TYPE. */
3176 #define CONS_TO_INTEGER(cons, type, var) \
3177 (TYPE_SIGNED (type) \
3178 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3179 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3180 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3181 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3183 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3184 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3185 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3187 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3188 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3189 extern void syms_of_data (void);
3190 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3192 /* Defined in cmds.c */
3193 extern void syms_of_cmds (void);
3194 extern void keys_of_cmds (void);
3196 /* Defined in coding.c. */
3197 extern Lisp_Object Qcharset
;
3198 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3199 ptrdiff_t, bool, bool, Lisp_Object
);
3200 extern void init_coding (void);
3201 extern void init_coding_once (void);
3202 extern void syms_of_coding (void);
3204 /* Defined in character.c. */
3205 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3206 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3207 extern void syms_of_character (void);
3209 /* Defined in charset.c. */
3210 extern void init_charset (void);
3211 extern void init_charset_once (void);
3212 extern void syms_of_charset (void);
3213 /* Structure forward declarations. */
3216 /* Defined in syntax.c. */
3217 extern void init_syntax_once (void);
3218 extern void syms_of_syntax (void);
3220 /* Defined in fns.c. */
3221 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3222 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3223 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3224 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3225 extern void sweep_weak_hash_tables (void);
3226 extern Lisp_Object Qcursor_in_echo_area
;
3227 extern Lisp_Object Qstring_lessp
;
3228 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3229 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3230 EMACS_UINT
sxhash (Lisp_Object
, int);
3231 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3232 Lisp_Object
, Lisp_Object
);
3233 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3234 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3236 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3237 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3238 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3239 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3240 ptrdiff_t, ptrdiff_t);
3241 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3242 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3243 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3244 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3245 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3246 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3247 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3248 extern void clear_string_char_byte_cache (void);
3249 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3250 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3251 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3252 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3253 extern void syms_of_fns (void);
3255 /* Defined in floatfns.c. */
3256 extern void syms_of_floatfns (void);
3257 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3259 /* Defined in fringe.c. */
3260 extern void syms_of_fringe (void);
3261 extern void init_fringe (void);
3262 #ifdef HAVE_WINDOW_SYSTEM
3263 extern void mark_fringe_data (void);
3264 extern void init_fringe_once (void);
3265 #endif /* HAVE_WINDOW_SYSTEM */
3267 /* Defined in image.c. */
3268 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3269 extern Lisp_Object QCconversion
;
3270 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3271 extern void reset_image_types (void);
3272 extern void syms_of_image (void);
3274 /* Defined in insdel.c. */
3275 extern Lisp_Object Qinhibit_modification_hooks
;
3276 extern Lisp_Object Qregion_extract_function
;
3277 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3278 extern _Noreturn
void buffer_overflow (void);
3279 extern void make_gap (ptrdiff_t);
3280 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3281 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3282 ptrdiff_t, bool, bool);
3283 extern int count_combining_before (const unsigned char *,
3284 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3285 extern int count_combining_after (const unsigned char *,
3286 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3287 extern void insert (const char *, ptrdiff_t);
3288 extern void insert_and_inherit (const char *, ptrdiff_t);
3289 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3291 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3292 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3293 ptrdiff_t, ptrdiff_t, bool);
3294 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3295 extern void insert_char (int);
3296 extern void insert_string (const char *);
3297 extern void insert_before_markers (const char *, ptrdiff_t);
3298 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3299 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3300 ptrdiff_t, ptrdiff_t,
3302 extern void del_range (ptrdiff_t, ptrdiff_t);
3303 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3304 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3305 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3306 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3307 ptrdiff_t, ptrdiff_t, bool);
3308 extern void modify_text (ptrdiff_t, ptrdiff_t);
3309 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3310 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3311 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3312 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3313 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3314 ptrdiff_t, ptrdiff_t);
3315 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3316 ptrdiff_t, ptrdiff_t);
3317 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3318 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3319 const char *, ptrdiff_t, ptrdiff_t, bool);
3320 extern void syms_of_insdel (void);
3322 /* Defined in dispnew.c. */
3323 #if (defined PROFILING \
3324 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3325 _Noreturn
void __executable_start (void);
3327 extern Lisp_Object Vwindow_system
;
3328 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3330 /* Defined in xdisp.c. */
3331 extern Lisp_Object Qinhibit_point_motion_hooks
;
3332 extern Lisp_Object Qinhibit_redisplay
;
3333 extern Lisp_Object Qmenu_bar_update_hook
;
3334 extern Lisp_Object Qwindow_scroll_functions
;
3335 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3336 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3337 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3338 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3339 extern Lisp_Object Qleft_margin
, Qright_margin
;
3340 extern Lisp_Object QCdata
, QCfile
;
3341 extern Lisp_Object QCmap
;
3342 extern Lisp_Object Qrisky_local_variable
;
3343 extern bool noninteractive_need_newline
;
3344 extern Lisp_Object echo_area_buffer
[2];
3345 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3346 extern void check_message_stack (void);
3347 extern void setup_echo_area_for_printing (int);
3348 extern bool push_message (void);
3349 extern void pop_message_unwind (void);
3350 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3351 extern void restore_message (void);
3352 extern Lisp_Object
current_message (void);
3353 extern void clear_message (bool, bool);
3354 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3355 extern void message1 (const char *);
3356 extern void message1_nolog (const char *);
3357 extern void message3 (Lisp_Object
);
3358 extern void message3_nolog (Lisp_Object
);
3359 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3360 extern void message_with_string (const char *, Lisp_Object
, int);
3361 extern void message_log_maybe_newline (void);
3362 extern void update_echo_area (void);
3363 extern void truncate_echo_area (ptrdiff_t);
3364 extern void redisplay (void);
3366 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3367 extern void syms_of_xdisp (void);
3368 extern void init_xdisp (void);
3369 extern Lisp_Object
safe_eval (Lisp_Object
);
3370 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3371 int *, int *, int *, int *, int *);
3373 /* Defined in xsettings.c. */
3374 extern void syms_of_xsettings (void);
3376 /* Defined in vm-limit.c. */
3377 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3379 /* Defined in alloc.c. */
3380 extern void check_pure_size (void);
3381 extern void free_misc (Lisp_Object
);
3382 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3383 extern void malloc_warning (const char *);
3384 extern _Noreturn
void memory_full (size_t);
3385 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3386 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3387 extern void refill_memory_reserve (void);
3389 extern const char *pending_malloc_warning
;
3390 extern Lisp_Object zero_vector
;
3391 extern Lisp_Object
list1 (Lisp_Object
);
3392 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3393 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3394 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3395 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3397 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3398 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3400 /* Build a frequently used 2/3/4-integer lists. */
3403 list2i (EMACS_INT x
, EMACS_INT y
)
3405 return list2 (make_number (x
), make_number (y
));
3409 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3411 return list3 (make_number (x
), make_number (y
), make_number (w
));
3415 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3417 return list4 (make_number (x
), make_number (y
),
3418 make_number (w
), make_number (h
));
3421 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3422 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3423 extern _Noreturn
void string_overflow (void);
3424 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3425 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3426 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3427 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3429 /* Make unibyte string from C string when the length isn't known. */
3432 build_unibyte_string (const char *str
)
3434 return make_unibyte_string (str
, strlen (str
));
3437 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3438 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3439 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3440 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3441 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3442 extern Lisp_Object
make_specified_string (const char *,
3443 ptrdiff_t, ptrdiff_t, bool);
3444 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3445 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3447 /* Make a string allocated in pure space, use STR as string data. */
3450 build_pure_c_string (const char *str
)
3452 return make_pure_c_string (str
, strlen (str
));
3455 /* Make a string from the data at STR, treating it as multibyte if the
3459 build_string (const char *str
)
3461 return make_string (str
, strlen (str
));
3464 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3465 extern void make_byte_code (struct Lisp_Vector
*);
3466 extern Lisp_Object Qchar_table_extra_slots
;
3467 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3469 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3470 be sure that GC cannot happen until the vector is completely
3471 initialized. E.g. the following code is likely to crash:
3473 v = make_uninit_vector (3);
3475 ASET (v, 1, Ffunction_can_gc ());
3476 ASET (v, 2, obj1); */
3479 make_uninit_vector (ptrdiff_t size
)
3482 struct Lisp_Vector
*p
;
3484 p
= allocate_vector (size
);
3489 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3490 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3492 allocate_pseudovector \
3493 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3494 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3495 extern struct window
*allocate_window (void);
3496 extern struct frame
*allocate_frame (void);
3497 extern struct Lisp_Process
*allocate_process (void);
3498 extern struct terminal
*allocate_terminal (void);
3499 extern Lisp_Object
make_float (double);
3500 extern void display_malloc_warning (void);
3501 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3502 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3503 Lisp_Object
, Lisp_Object
);
3504 extern Lisp_Object
make_save_ptr (void *);
3505 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3506 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3507 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3509 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3510 extern void free_save_value (Lisp_Object
);
3511 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3512 extern void init_alloc_once (void);
3513 extern void init_alloc (void);
3514 extern void syms_of_alloc (void);
3515 extern struct buffer
* allocate_buffer (void);
3516 extern int valid_lisp_object_p (Lisp_Object
);
3517 extern int relocatable_string_data_p (const char *);
3520 /* Defined in ralloc.c. */
3521 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3522 extern void r_alloc_free (void **);
3523 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3524 extern void r_alloc_reset_variable (void **, void **);
3525 extern void r_alloc_inhibit_buffer_relocation (int);
3528 /* Defined in chartab.c. */
3529 extern Lisp_Object
copy_char_table (Lisp_Object
);
3530 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3532 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3533 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3535 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3536 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3537 Lisp_Object
, Lisp_Object
,
3538 Lisp_Object
, struct charset
*,
3539 unsigned, unsigned);
3540 extern Lisp_Object
uniprop_table (Lisp_Object
);
3541 extern void syms_of_chartab (void);
3543 /* Defined in print.c. */
3544 extern Lisp_Object Vprin1_to_string_buffer
;
3545 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3546 extern Lisp_Object Qstandard_output
;
3547 extern Lisp_Object Qexternal_debugging_output
;
3548 extern void temp_output_buffer_setup (const char *);
3549 extern int print_level
;
3550 extern Lisp_Object Qprint_escape_newlines
;
3551 extern void write_string (const char *, int);
3552 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3554 extern Lisp_Object internal_with_output_to_temp_buffer
3555 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3556 #define FLOAT_TO_STRING_BUFSIZE 350
3557 extern int float_to_string (char *, double);
3558 extern void init_print_once (void);
3559 extern void syms_of_print (void);
3561 /* Defined in doprnt.c. */
3562 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3564 extern ptrdiff_t esprintf (char *, char const *, ...)
3565 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3566 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3568 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3569 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3570 char const *, va_list)
3571 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3573 /* Defined in lread.c. */
3574 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3575 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3576 extern Lisp_Object Qlexical_binding
;
3577 extern Lisp_Object
check_obarray (Lisp_Object
);
3578 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3579 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3580 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3582 LOADHIST_ATTACH (Lisp_Object x
)
3585 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3587 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3588 Lisp_Object
*, Lisp_Object
, bool);
3589 extern Lisp_Object
string_to_number (char const *, int, bool);
3590 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3592 extern void dir_warning (const char *, Lisp_Object
);
3593 extern void init_obarray (void);
3594 extern void init_lread (void);
3595 extern void syms_of_lread (void);
3598 intern (const char *str
)
3600 return intern_1 (str
, strlen (str
));
3604 intern_c_string (const char *str
)
3606 return intern_c_string_1 (str
, strlen (str
));
3609 /* Defined in eval.c. */
3610 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3611 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3612 extern Lisp_Object Qand_rest
;
3613 extern Lisp_Object Vautoload_queue
;
3614 extern Lisp_Object Vsignaling_function
;
3615 extern Lisp_Object inhibit_lisp_code
;
3616 extern struct handler
*handlerlist
;
3618 /* To run a normal hook, use the appropriate function from the list below.
3619 The calling convention:
3621 if (!NILP (Vrun_hooks))
3622 call1 (Vrun_hooks, Qmy_funny_hook);
3624 should no longer be used. */
3625 extern Lisp_Object Vrun_hooks
;
3626 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3627 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3628 Lisp_Object (*funcall
)
3629 (ptrdiff_t nargs
, Lisp_Object
*args
));
3630 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3631 extern _Noreturn
void xsignal0 (Lisp_Object
);
3632 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3633 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3634 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3636 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3637 extern Lisp_Object
eval_sub (Lisp_Object form
);
3638 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3639 extern Lisp_Object
call0 (Lisp_Object
);
3640 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3641 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3642 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3643 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3644 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3645 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3646 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3647 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3648 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3649 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3650 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3651 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3652 extern Lisp_Object internal_condition_case_n
3653 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3654 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3655 extern void specbind (Lisp_Object
, Lisp_Object
);
3656 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3657 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3658 extern void record_unwind_protect_int (void (*) (int), int);
3659 extern void record_unwind_protect_void (void (*) (void));
3660 extern void record_unwind_protect_nothing (void);
3661 extern void clear_unwind_protect (ptrdiff_t);
3662 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3663 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3664 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3665 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3666 extern _Noreturn
void verror (const char *, va_list)
3667 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3668 extern void un_autoload (Lisp_Object
);
3669 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3670 extern void init_eval_once (void);
3671 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3672 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3673 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3674 extern void init_eval (void);
3675 extern void syms_of_eval (void);
3676 extern void unwind_body (Lisp_Object
);
3677 extern void record_in_backtrace (Lisp_Object function
,
3678 Lisp_Object
*args
, ptrdiff_t nargs
);
3679 extern void mark_specpdl (void);
3680 extern void get_backtrace (Lisp_Object array
);
3681 Lisp_Object
backtrace_top_function (void);
3682 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3683 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3686 /* Defined in editfns.c. */
3687 extern Lisp_Object Qfield
;
3688 extern void insert1 (Lisp_Object
);
3689 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3690 extern Lisp_Object
save_excursion_save (void);
3691 extern Lisp_Object
save_restriction_save (void);
3692 extern void save_excursion_restore (Lisp_Object
);
3693 extern void save_restriction_restore (Lisp_Object
);
3694 extern _Noreturn
void time_overflow (void);
3695 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3696 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3698 extern void init_editfns (void);
3699 extern void syms_of_editfns (void);
3700 extern void set_time_zone_rule (const char *);
3702 /* Defined in buffer.c. */
3703 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3704 extern _Noreturn
void nsberror (Lisp_Object
);
3705 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3706 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3707 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3708 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3709 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3710 extern bool overlay_touches_p (ptrdiff_t);
3711 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3712 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3713 extern void init_buffer_once (void);
3714 extern void init_buffer (int);
3715 extern void syms_of_buffer (void);
3716 extern void keys_of_buffer (void);
3718 /* Defined in marker.c. */
3720 extern ptrdiff_t marker_position (Lisp_Object
);
3721 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3722 extern void clear_charpos_cache (struct buffer
*);
3723 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3724 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3725 extern void unchain_marker (struct Lisp_Marker
*marker
);
3726 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3727 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3728 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3729 ptrdiff_t, ptrdiff_t);
3730 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3731 extern void syms_of_marker (void);
3733 /* Defined in fileio.c. */
3735 extern Lisp_Object Qfile_error
;
3736 extern Lisp_Object Qfile_notify_error
;
3737 extern Lisp_Object Qfile_exists_p
;
3738 extern Lisp_Object Qfile_directory_p
;
3739 extern Lisp_Object Qinsert_file_contents
;
3740 extern Lisp_Object Qfile_name_history
;
3741 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3742 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3743 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3745 extern void close_file_unwind (int);
3746 extern void fclose_unwind (void *);
3747 extern void restore_point_unwind (Lisp_Object
);
3748 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3749 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3750 extern bool internal_delete_file (Lisp_Object
);
3751 extern Lisp_Object
emacs_readlinkat (int, const char *);
3752 extern bool file_directory_p (const char *);
3753 extern bool file_accessible_directory_p (const char *);
3754 extern void init_fileio (void);
3755 extern void syms_of_fileio (void);
3756 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3757 extern Lisp_Object Qdelete_file
;
3759 /* Defined in search.c. */
3760 extern void shrink_regexp_cache (void);
3761 extern void restore_search_regs (void);
3762 extern void record_unwind_save_match_data (void);
3763 struct re_registers
;
3764 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3765 struct re_registers
*,
3766 Lisp_Object
, bool, bool);
3767 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3768 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3770 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3771 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3772 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3773 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3774 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3775 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3777 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3778 ptrdiff_t, ptrdiff_t *);
3779 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3780 ptrdiff_t, ptrdiff_t *);
3781 extern void syms_of_search (void);
3782 extern void clear_regexp_cache (void);
3784 /* Defined in minibuf.c. */
3786 extern Lisp_Object Qcompletion_ignore_case
;
3787 extern Lisp_Object Vminibuffer_list
;
3788 extern Lisp_Object last_minibuf_string
;
3789 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3790 extern void init_minibuf_once (void);
3791 extern void syms_of_minibuf (void);
3793 /* Defined in callint.c. */
3795 extern Lisp_Object Qminus
, Qplus
;
3796 extern Lisp_Object Qprogn
;
3797 extern Lisp_Object Qwhen
;
3798 extern Lisp_Object Qmouse_leave_buffer_hook
;
3799 extern void syms_of_callint (void);
3801 /* Defined in casefiddle.c. */
3803 extern Lisp_Object Qidentity
;
3804 extern void syms_of_casefiddle (void);
3805 extern void keys_of_casefiddle (void);
3807 /* Defined in casetab.c. */
3809 extern void init_casetab_once (void);
3810 extern void syms_of_casetab (void);
3812 /* Defined in keyboard.c. */
3814 extern Lisp_Object echo_message_buffer
;
3815 extern struct kboard
*echo_kboard
;
3816 extern void cancel_echoing (void);
3817 extern Lisp_Object Qdisabled
, QCfilter
;
3818 extern Lisp_Object Qup
, Qdown
;
3819 extern Lisp_Object last_undo_boundary
;
3820 extern bool input_pending
;
3821 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3822 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3823 extern void discard_mouse_events (void);
3825 void handle_input_available_signal (int);
3827 extern Lisp_Object pending_funcalls
;
3828 extern bool detect_input_pending (void);
3829 extern bool detect_input_pending_ignore_squeezables (void);
3830 extern bool detect_input_pending_run_timers (bool);
3831 extern void safe_run_hooks (Lisp_Object
);
3832 extern void cmd_error_internal (Lisp_Object
, const char *);
3833 extern Lisp_Object
command_loop_1 (void);
3834 extern Lisp_Object
read_menu_command (void);
3835 extern Lisp_Object
recursive_edit_1 (void);
3836 extern void record_auto_save (void);
3837 extern void force_auto_save_soon (void);
3838 extern void init_keyboard (void);
3839 extern void syms_of_keyboard (void);
3840 extern void keys_of_keyboard (void);
3842 /* Defined in indent.c. */
3843 extern ptrdiff_t current_column (void);
3844 extern void invalidate_current_column (void);
3845 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3846 extern void syms_of_indent (void);
3848 /* Defined in frame.c. */
3849 extern Lisp_Object Qonly
, Qnone
;
3850 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3851 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3852 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3853 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3854 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3855 extern void frames_discard_buffer (Lisp_Object
);
3856 extern void syms_of_frame (void);
3858 /* Defined in emacs.c. */
3859 extern char **initial_argv
;
3860 extern int initial_argc
;
3861 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3862 extern bool display_arg
;
3864 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3865 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3866 extern Lisp_Object Qfile_name_handler_alist
;
3867 extern _Noreturn
void terminate_due_to_signal (int, int);
3868 extern Lisp_Object Qkill_emacs
;
3870 extern Lisp_Object Vlibrary_cache
;
3873 void fixup_locale (void);
3874 void synchronize_system_messages_locale (void);
3875 void synchronize_system_time_locale (void);
3877 INLINE
void fixup_locale (void) {}
3878 INLINE
void synchronize_system_messages_locale (void) {}
3879 INLINE
void synchronize_system_time_locale (void) {}
3881 extern void shut_down_emacs (int, Lisp_Object
);
3883 /* True means don't do interactive redisplay and don't change tty modes. */
3884 extern bool noninteractive
;
3886 /* True means remove site-lisp directories from load-path. */
3887 extern bool no_site_lisp
;
3889 /* Pipe used to send exit notification to the daemon parent at
3891 extern int daemon_pipe
[2];
3892 #define IS_DAEMON (daemon_pipe[1] != 0)
3894 /* True if handling a fatal error already. */
3895 extern bool fatal_error_in_progress
;
3897 /* True means don't do use window-system-specific display code. */
3898 extern bool inhibit_window_system
;
3899 /* True means that a filter or a sentinel is running. */
3900 extern bool running_asynch_code
;
3902 /* Defined in process.c. */
3903 extern Lisp_Object QCtype
, Qlocal
;
3904 extern void kill_buffer_processes (Lisp_Object
);
3905 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3906 struct Lisp_Process
*, int);
3907 /* Max value for the first argument of wait_reading_process_output. */
3908 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3909 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3910 The bug merely causes a bogus warning, but the warning is annoying. */
3911 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3913 # define WAIT_READING_MAX INTMAX_MAX
3915 extern void add_keyboard_wait_descriptor (int);
3916 extern void delete_keyboard_wait_descriptor (int);
3918 extern void add_gpm_wait_descriptor (int);
3919 extern void delete_gpm_wait_descriptor (int);
3921 extern void init_process_emacs (void);
3922 extern void syms_of_process (void);
3923 extern void setup_process_coding_systems (Lisp_Object
);
3925 /* Defined in callproc.c. */
3929 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3930 extern void init_callproc_1 (void);
3931 extern void init_callproc (void);
3932 extern void set_initial_environment (void);
3933 extern void syms_of_callproc (void);
3935 /* Defined in doc.c. */
3936 extern Lisp_Object Qfunction_documentation
;
3937 extern Lisp_Object
read_doc_string (Lisp_Object
);
3938 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3939 extern void syms_of_doc (void);
3940 extern int read_bytecode_char (bool);
3942 /* Defined in bytecode.c. */
3943 extern void syms_of_bytecode (void);
3944 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3945 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3947 /* Defined in macros.c. */
3948 extern void init_macros (void);
3949 extern void syms_of_macros (void);
3951 /* Defined in undo.c. */
3952 extern Lisp_Object Qapply
;
3953 extern Lisp_Object Qinhibit_read_only
;
3954 extern void truncate_undo_list (struct buffer
*);
3955 extern void record_insert (ptrdiff_t, ptrdiff_t);
3956 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3957 extern void record_first_change (void);
3958 extern void record_change (ptrdiff_t, ptrdiff_t);
3959 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3960 Lisp_Object
, Lisp_Object
,
3962 extern void syms_of_undo (void);
3963 /* Defined in textprop.c. */
3964 extern Lisp_Object Qmouse_face
;
3965 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3966 extern Lisp_Object Qminibuffer_prompt
;
3968 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3970 /* Defined in menu.c. */
3971 extern void syms_of_menu (void);
3973 /* Defined in xmenu.c. */
3974 extern void syms_of_xmenu (void);
3976 /* Defined in termchar.h. */
3977 struct tty_display_info
;
3979 /* Defined in termhooks.h. */
3982 /* Defined in sysdep.c. */
3983 #ifndef HAVE_GET_CURRENT_DIR_NAME
3984 extern char *get_current_dir_name (void);
3986 extern void stuff_char (char c
);
3987 extern void init_foreground_group (void);
3988 extern void sys_subshell (void);
3989 extern void sys_suspend (void);
3990 extern void discard_tty_input (void);
3991 extern void init_sys_modes (struct tty_display_info
*);
3992 extern void reset_sys_modes (struct tty_display_info
*);
3993 extern void init_all_sys_modes (void);
3994 extern void reset_all_sys_modes (void);
3995 extern void child_setup_tty (int);
3996 extern void setup_pty (int);
3997 extern int set_window_size (int, int, int);
3998 extern EMACS_INT
get_random (void);
3999 extern void seed_random (void *, ptrdiff_t);
4000 extern void init_random (void);
4001 extern void emacs_backtrace (int);
4002 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4003 extern int emacs_open (const char *, int, int);
4004 extern int emacs_pipe (int[2]);
4005 extern int emacs_close (int);
4006 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4007 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4008 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4009 extern void emacs_perror (char const *);
4011 extern void unlock_all_files (void);
4012 extern void lock_file (Lisp_Object
);
4013 extern void unlock_file (Lisp_Object
);
4014 extern void unlock_buffer (struct buffer
*);
4015 extern void syms_of_filelock (void);
4017 /* Defined in sound.c. */
4018 extern void syms_of_sound (void);
4020 /* Defined in category.c. */
4021 extern void init_category_once (void);
4022 extern Lisp_Object
char_category_set (int);
4023 extern void syms_of_category (void);
4025 /* Defined in ccl.c. */
4026 extern void syms_of_ccl (void);
4028 /* Defined in dired.c. */
4029 extern void syms_of_dired (void);
4030 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4031 Lisp_Object
, Lisp_Object
,
4034 /* Defined in term.c. */
4035 extern int *char_ins_del_vector
;
4036 extern void syms_of_term (void);
4037 extern _Noreturn
void fatal (const char *msgid
, ...)
4038 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4040 /* Defined in terminal.c. */
4041 extern void syms_of_terminal (void);
4043 /* Defined in font.c. */
4044 extern void syms_of_font (void);
4045 extern void init_font (void);
4047 #ifdef HAVE_WINDOW_SYSTEM
4048 /* Defined in fontset.c. */
4049 extern void syms_of_fontset (void);
4051 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4052 extern Lisp_Object Qfont_param
;
4055 /* Defined in gfilenotify.c */
4056 #ifdef HAVE_GFILENOTIFY
4057 extern void globals_of_gfilenotify (void);
4058 extern void syms_of_gfilenotify (void);
4061 /* Defined in inotify.c */
4063 extern void syms_of_inotify (void);
4066 #ifdef HAVE_W32NOTIFY
4067 /* Defined on w32notify.c. */
4068 extern void syms_of_w32notify (void);
4071 /* Defined in xfaces.c. */
4072 extern Lisp_Object Qdefault
, Qfringe
;
4073 extern Lisp_Object Qscroll_bar
, Qcursor
;
4074 extern Lisp_Object Qmode_line_inactive
;
4075 extern Lisp_Object Qface
;
4076 extern Lisp_Object Qnormal
;
4077 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4078 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4079 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4080 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4081 extern Lisp_Object Qoblique
, Qitalic
;
4082 extern Lisp_Object Vface_alternative_font_family_alist
;
4083 extern Lisp_Object Vface_alternative_font_registry_alist
;
4084 extern void syms_of_xfaces (void);
4086 #ifdef HAVE_X_WINDOWS
4087 /* Defined in xfns.c. */
4088 extern void syms_of_xfns (void);
4090 /* Defined in xsmfns.c. */
4091 extern void syms_of_xsmfns (void);
4093 /* Defined in xselect.c. */
4094 extern void syms_of_xselect (void);
4096 /* Defined in xterm.c. */
4097 extern void syms_of_xterm (void);
4098 #endif /* HAVE_X_WINDOWS */
4100 #ifdef HAVE_WINDOW_SYSTEM
4101 /* Defined in xterm.c, nsterm.m, w32term.c. */
4102 extern char *x_get_keysym_name (int);
4103 #endif /* HAVE_WINDOW_SYSTEM */
4106 /* Defined in xml.c. */
4107 extern void syms_of_xml (void);
4108 extern void xml_cleanup_parser (void);
4112 /* Defined in decompress.c. */
4113 extern void syms_of_decompress (void);
4117 /* Defined in dbusbind.c. */
4118 void syms_of_dbusbind (void);
4122 /* Defined in profiler.c. */
4123 extern bool profiler_memory_running
;
4124 extern void malloc_probe (size_t);
4125 extern void syms_of_profiler (void);
4129 /* Defined in msdos.c, w32.c. */
4130 extern char *emacs_root_dir (void);
4133 /* True means ^G can quit instantly. */
4134 extern bool immediate_quit
;
4136 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4137 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4138 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4139 extern void xfree (void *);
4140 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4141 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4142 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4143 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4144 ATTRIBUTE_ALLOC_SIZE ((2,3));
4145 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4146 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4147 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4148 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4149 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4151 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4152 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4153 extern void dupstring (char **, char const *);
4154 extern void xputenv (const char *);
4156 extern char *egetenv (const char *);
4158 /* Copy Lisp string to temporary (allocated on stack) C string. */
4160 #define xlispstrdupa(string) \
4161 memcpy (alloca (SBYTES (string) + 1), \
4162 SSDATA (string), SBYTES (string) + 1)
4164 /* Set up the name of the machine we're running on. */
4165 extern void init_system_name (void);
4167 /* Return the absolute value of X. X should be a signed integer
4168 expression without side effects, and X's absolute value should not
4169 exceed the maximum for its promoted type. This is called 'eabs'
4170 because 'abs' is reserved by the C standard. */
4171 #define eabs(x) ((x) < 0 ? -(x) : (x))
4173 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4176 #define make_fixnum_or_float(val) \
4177 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4179 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4180 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4182 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4184 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4186 #define USE_SAFE_ALLOCA \
4187 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4189 /* SAFE_ALLOCA allocates a simple buffer. */
4191 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4193 : (sa_must_free = true, record_xmalloc (size)))
4195 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4196 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4197 positive. The code is tuned for MULTIPLIER being a constant. */
4199 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4201 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4202 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4205 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4206 sa_must_free = true; \
4207 record_unwind_protect_ptr (xfree, buf); \
4211 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4213 #define SAFE_FREE() \
4215 if (sa_must_free) { \
4216 sa_must_free = false; \
4217 unbind_to (sa_count, Qnil); \
4222 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4224 #define SAFE_ALLOCA_LISP(buf, nelt) \
4226 if ((nelt) < MAX_ALLOCA / word_size) \
4227 (buf) = alloca ((nelt) * word_size); \
4228 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4231 (buf) = xmalloc ((nelt) * word_size); \
4232 arg_ = make_save_memory (buf, nelt); \
4233 sa_must_free = true; \
4234 record_unwind_protect (free_save_value, arg_); \
4237 memory_full (SIZE_MAX); \
4240 /* Loop over all tails of a list, checking for cycles.
4241 FIXME: Make tortoise and n internal declarations.
4242 FIXME: Unroll the loop body so we don't need `n'. */
4243 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4244 for ((tortoise) = (hare) = (list), (n) = true; \
4246 (hare = XCDR (hare), (n) = !(n), \
4248 ? (EQ (hare, tortoise) \
4249 ? xsignal1 (Qcircular_list, list) \
4251 /* Move tortoise before the next iteration, in case */ \
4252 /* the next iteration does an Fsetcdr. */ \
4253 : (void) ((tortoise) = XCDR (tortoise)))))
4255 /* Do a `for' loop over alist values. */
4257 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4258 for ((list_var) = (head_var); \
4259 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4260 (list_var) = XCDR (list_var))
4262 /* Check whether it's time for GC, and run it if so. */
4271 functionp (Lisp_Object object
)
4273 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4275 object
= Findirect_function (object
, Qt
);
4277 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4279 /* Autoloaded symbols are functions, except if they load
4280 macros or keymaps. */
4282 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4283 object
= XCDR (object
);
4285 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4290 return XSUBR (object
)->max_args
!= UNEVALLED
;
4291 else if (COMPILEDP (object
))
4293 else if (CONSP (object
))
4295 Lisp_Object car
= XCAR (object
);
4296 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4304 #endif /* EMACS_LISP_H */