1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2013 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/>. */
38 /* Define a TYPE constant ID as an externally visible name. Use like this:
40 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
42 DEFINE_GDB_SYMBOL_END (ID)
44 This hack is for the benefit of compilers that do not make macro
45 definitions visible to the debugger. It's used for symbols that
46 .gdbinit needs, symbols whose values may not fit in 'int' (where an
47 enum would suffice). */
48 #if defined MAIN_PROGRAM
49 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
50 # define DEFINE_GDB_SYMBOL_END(id) = id;
52 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
53 # define DEFINE_GDB_SYMBOL_END(val)
56 /* The ubiquitous max and min macros. */
59 #define max(a, b) ((a) > (b) ? (a) : (b))
60 #define min(a, b) ((a) < (b) ? (a) : (b))
62 /* EMACS_INT - signed integer wide enough to hold an Emacs value
63 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
64 pI - printf length modifier for EMACS_INT
65 EMACS_UINT - unsigned variant of EMACS_INT */
67 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
68 typedef long long int EMACS_INT
;
69 typedef unsigned long long int EMACS_UINT
;
70 # define EMACS_INT_MAX LLONG_MAX
72 # elif INT_MAX < LONG_MAX
73 typedef long int EMACS_INT
;
74 typedef unsigned long EMACS_UINT
;
75 # define EMACS_INT_MAX LONG_MAX
78 typedef int EMACS_INT
;
79 typedef unsigned int EMACS_UINT
;
80 # define EMACS_INT_MAX INT_MAX
85 /* Number of bits to put in each character in the internal representation
86 of bool vectors. This should not vary across implementations. */
87 enum { BOOL_VECTOR_BITS_PER_CHAR
=
88 #define BOOL_VECTOR_BITS_PER_CHAR 8
89 BOOL_VECTOR_BITS_PER_CHAR
92 /* An unsigned integer type representing a fixed-length bit sequence,
93 suitable for words in a Lisp bool vector. Normally it is size_t
94 for speed, but it is unsigned char on weird platforms. */
95 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
96 typedef size_t bits_word
;
97 # define BITS_WORD_MAX SIZE_MAX
98 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
100 typedef unsigned char bits_word
;
101 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
102 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
104 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
106 /* Number of bits in some machine integer types. */
109 BITS_PER_CHAR
= CHAR_BIT
,
110 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
111 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
112 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
113 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
116 /* printmax_t and uprintmax_t are types for printing large integers.
117 These are the widest integers that are supported for printing.
118 pMd etc. are conversions for printing them.
119 On C99 hosts, there's no problem, as even the widest integers work.
120 Fall back on EMACS_INT on pre-C99 hosts. */
122 typedef intmax_t printmax_t
;
123 typedef uintmax_t uprintmax_t
;
127 typedef EMACS_INT printmax_t
;
128 typedef EMACS_UINT uprintmax_t
;
133 /* Use pD to format ptrdiff_t values, which suffice for indexes into
134 buffers and strings. Emacs never allocates objects larger than
135 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
136 In C99, pD can always be "t"; configure it here for the sake of
137 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
138 #if PTRDIFF_MAX == INT_MAX
140 #elif PTRDIFF_MAX == LONG_MAX
142 #elif PTRDIFF_MAX == LLONG_MAX
148 /* Extra internal type checking? */
150 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
151 'assume (COND)'. COND should be free of side effects, as it may or
152 may not be evaluated.
154 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
155 defined and suppress_checking is false, and does nothing otherwise.
156 Emacs dies if COND is checked and is false. The suppress_checking
157 variable is initialized to 0 in alloc.c. Set it to 1 using a
158 debugger to temporarily disable aborting on detected internal
159 inconsistencies or error conditions.
161 In some cases, a good compiler may be able to optimize away the
162 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
163 uses eassert to test STRINGP (x), but a particular use of XSTRING
164 is invoked only after testing that STRINGP (x) is true, making the
167 eassume is like eassert except that it also causes the compiler to
168 assume that COND is true afterwards, regardless of whether runtime
169 checking is enabled. This can improve performance in some cases,
170 though it can degrade performance in others. It's often suboptimal
171 for COND to call external functions or access volatile storage. */
173 #ifndef ENABLE_CHECKING
174 # define eassert(cond) ((void) (0 && (cond))) /* Check that COND compiles. */
175 # define eassume(cond) assume (cond)
176 #else /* ENABLE_CHECKING */
178 extern _Noreturn
void die (const char *, const char *, int);
180 extern bool suppress_checking EXTERNALLY_VISIBLE
;
182 # define eassert(cond) \
183 (suppress_checking || (cond) \
185 : die (# cond, __FILE__, __LINE__))
186 # define eassume(cond) \
191 : die (# cond, __FILE__, __LINE__))
192 #endif /* ENABLE_CHECKING */
195 /* Use the configure flag --enable-check-lisp-object-type to make
196 Lisp_Object use a struct type instead of the default int. The flag
197 causes CHECK_LISP_OBJECT_TYPE to be defined. */
199 /***** Select the tagging scheme. *****/
200 /* The following option controls the tagging scheme:
201 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
202 always 0, and we can thus use them to hold tag bits, without
203 restricting our addressing space.
205 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
206 restricting our possible address range.
208 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
209 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
210 on the few static Lisp_Objects used: all the defsubr as well
211 as the two special buffers buffer_defaults and buffer_local_symbols. */
215 /* Number of bits in a Lisp_Object tag. This can be used in #if,
216 and for GDB's sake also as a regular symbol. */
221 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
222 integer constant, for MSVC. */
223 #define GCALIGNMENT 8
225 /* Number of bits in a Lisp_Object value, not counting the tag. */
226 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
228 /* Number of bits in a Lisp fixnum tag. */
229 INTTYPEBITS
= GCTYPEBITS
- 1,
231 /* Number of bits in a Lisp fixnum value, not counting the tag. */
232 FIXNUM_BITS
= VALBITS
+ 1
235 #if GCALIGNMENT != 1 << GCTYPEBITS
236 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
239 /* The maximum value that can be stored in a EMACS_INT, assuming all
240 bits other than the type bits contribute to a nonnegative signed value.
241 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
242 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
244 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
246 /* 1. We know malloc returns a multiple of 8. */
247 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
248 || defined DARWIN_OS || defined __sun)
249 /* 2. We can specify multiple-of-8 alignment on static variables. */
251 /* 3. Pointers-as-ints exceed VAL_MAX.
252 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
253 a. unnecessary, because the top bits of an EMACS_INT are unused, and
254 b. slower, because it typically requires extra masking.
255 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
256 # if VAL_MAX < UINTPTR_MAX
257 # define USE_LSB_TAG 1
264 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
265 # define USE_LSB_TAG 1
267 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
268 # define USE_LSB_TAG 0
272 # define alignas(alignment) /* empty */
274 # error "USE_LSB_TAG requires alignas"
279 /* Some operations are so commonly executed that they are implemented
280 as macros, not functions, because otherwise runtime performance would
281 suffer too much when compiling with GCC without optimization.
282 There's no need to inline everything, just the operations that
283 would otherwise cause a serious performance problem.
285 For each such operation OP, define a macro lisp_h_OP that contains
286 the operation's implementation. That way, OP can be implemented
287 via a macro definition like this:
289 #define OP(x) lisp_h_OP (x)
291 and/or via a function definition like this:
293 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
295 which macro-expands to this:
297 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
299 without worrying about the implementations diverging, since
300 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
301 are intended to be private to this include file, and should not be
304 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
305 functions, once most developers have access to GCC 4.8 or later and
306 can use "gcc -Og" to debug. Maybe in the year 2016. See
309 Commentary for these macros can be found near their corresponding
312 #if CHECK_LISP_OBJECT_TYPE
313 # define lisp_h_XLI(o) ((o).i)
314 # define lisp_h_XIL(i) ((Lisp_Object) { i })
316 # define lisp_h_XLI(o) (o)
317 # define lisp_h_XIL(i) (i)
319 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
320 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
321 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
322 #define lisp_h_CHECK_TYPE(ok, Qxxxp, x) \
323 ((ok) ? (void) 0 : (void) wrong_type_argument (Qxxxp, x))
324 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
325 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
326 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
327 #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0)
328 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
329 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
330 #define lisp_h_NILP(x) EQ (x, Qnil)
331 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
332 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
333 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
334 #define lisp_h_SYMBOL_VAL(sym) \
335 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
336 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
337 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
338 #define lisp_h_XCAR(c) XCONS (c)->car
339 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
340 #define lisp_h_XCONS(a) \
341 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
342 #define lisp_h_XHASH(a) XUINT (a)
343 #define lisp_h_XPNTR(a) \
344 ((void *) (intptr_t) ((XLI (a) & VALMASK) | DATA_SEG_BITS))
345 #define lisp_h_XSYMBOL(a) \
346 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
347 #ifndef GC_CHECK_CONS_LIST
348 # define lisp_h_check_cons_list() ((void) 0)
351 # define lisp_h_make_number(n) XIL ((EMACS_INT) (n) << INTTYPEBITS)
352 # define lisp_h_XFASTINT(a) XINT (a)
353 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
354 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
355 # define lisp_h_XUNTAG(a, type) ((void *) (XLI (a) - (type)))
358 /* When compiling via gcc -O0, define the key operations as macros, as
359 Emacs is too slow otherwise. To disable this optimization, compile
360 with -DINLINING=0. */
361 #if (defined __NO_INLINE__ \
362 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
363 && ! (defined INLINING && ! INLINING))
364 # define XLI(o) lisp_h_XLI (o)
365 # define XIL(i) lisp_h_XIL (i)
366 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
367 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
368 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
369 # define CHECK_TYPE(ok, Qxxxp, x) lisp_h_CHECK_TYPE (ok, Qxxxp, x)
370 # define CONSP(x) lisp_h_CONSP (x)
371 # define EQ(x, y) lisp_h_EQ (x, y)
372 # define FLOATP(x) lisp_h_FLOATP (x)
373 # define INTEGERP(x) lisp_h_INTEGERP (x)
374 # define MARKERP(x) lisp_h_MARKERP (x)
375 # define MISCP(x) lisp_h_MISCP (x)
376 # define NILP(x) lisp_h_NILP (x)
377 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
378 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
379 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
380 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
381 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
382 # define XCAR(c) lisp_h_XCAR (c)
383 # define XCDR(c) lisp_h_XCDR (c)
384 # define XCONS(a) lisp_h_XCONS (a)
385 # define XHASH(a) lisp_h_XHASH (a)
386 # define XPNTR(a) lisp_h_XPNTR (a)
387 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
388 # ifndef GC_CHECK_CONS_LIST
389 # define check_cons_list() lisp_h_check_cons_list ()
392 # define make_number(n) lisp_h_make_number (n)
393 # define XFASTINT(a) lisp_h_XFASTINT (a)
394 # define XINT(a) lisp_h_XINT (a)
395 # define XTYPE(a) lisp_h_XTYPE (a)
396 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
400 /* Define NAME as a lisp.h inline function that returns TYPE and has
401 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
402 ARGS should be parenthesized. Implement the function by calling
404 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
405 INLINE type (name) argdecls { return lisp_h_##name args; }
407 /* like LISP_MACRO_DEFUN, except NAME returns void. */
408 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
409 INLINE void (name) argdecls { lisp_h_##name args; }
412 /* Define the fundamental Lisp data structures. */
414 /* This is the set of Lisp data types. If you want to define a new
415 data type, read the comments after Lisp_Fwd_Type definition
418 /* Lisp integers use 2 tags, to give them one extra bit, thus
419 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
420 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
421 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
423 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
424 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
425 vociferously about them. */
426 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
427 || (defined __SUNPRO_C && __STDC__))
428 #define ENUM_BF(TYPE) unsigned int
430 #define ENUM_BF(TYPE) enum TYPE
436 /* Integer. XINT (obj) is the integer value. */
438 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
440 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
443 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
444 whose first member indicates the subtype. */
447 /* String. XSTRING (object) points to a struct Lisp_String.
448 The length of the string, and its contents, are stored therein. */
449 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
451 /* Vector of Lisp objects, or something resembling it.
452 XVECTOR (object) points to a struct Lisp_Vector, which contains
453 the size and contents. The size field also contains the type
454 information, if it's not a real vector object. */
457 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
463 /* This is the set of data types that share a common structure.
464 The first member of the structure is a type code from this set.
465 The enum values are arbitrary, but we'll use large numbers to make it
466 more likely that we'll spot the error if a random word in memory is
467 mistakenly interpreted as a Lisp_Misc. */
470 Lisp_Misc_Free
= 0x5eab,
473 Lisp_Misc_Save_Value
,
474 /* Currently floats are not a misc type,
475 but let's define this in case we want to change that. */
477 /* This is not a type code. It is for range checking. */
481 /* These are the types of forwarding objects used in the value slot
482 of symbols for special built-in variables whose value is stored in
486 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
487 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
488 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
489 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
490 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
493 /* If you want to define a new Lisp data type, here are some
494 instructions. See the thread at
495 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
498 First, there are already a couple of Lisp types that can be used if
499 your new type does not need to be exposed to Lisp programs nor
500 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
501 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
502 is suitable for temporarily stashing away pointers and integers in
503 a Lisp object. The latter is useful for vector-like Lisp objects
504 that need to be used as part of other objects, but which are never
505 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
508 These two types don't look pretty when printed, so they are
509 unsuitable for Lisp objects that can be exposed to users.
511 To define a new data type, add one more Lisp_Misc subtype or one
512 more pseudovector subtype. Pseudovectors are more suitable for
513 objects with several slots that need to support fast random access,
514 while Lisp_Misc types are for everything else. A pseudovector object
515 provides one or more slots for Lisp objects, followed by struct
516 members that are accessible only from C. A Lisp_Misc object is a
517 wrapper for a C struct that can contain anything you like.
519 Explicit freeing is discouraged for Lisp objects in general. But if
520 you really need to exploit this, use Lisp_Misc (check free_misc in
521 alloc.c to see why). There is no way to free a vectorlike object.
523 To add a new pseudovector type, extend the pvec_type enumeration;
524 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
526 For a Lisp_Misc, you will also need to add your entry to union
527 Lisp_Misc (but make sure the first word has the same structure as
528 the others, starting with a 16-bit member of the Lisp_Misc_Type
529 enumeration and a 1-bit GC markbit) and make sure the overall size
530 of the union is not increased by your addition.
532 For a new pseudovector, it's highly desirable to limit the size
533 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
534 Otherwise you will need to change sweep_vectors (also in alloc.c).
536 Then you will need to add switch branches in print.c (in
537 print_object, to print your object, and possibly also in
538 print_preprocess) and to alloc.c, to mark your object (in
539 mark_object) and to free it (in gc_sweep). The latter is also the
540 right place to call any code specific to your data type that needs
541 to run when the object is recycled -- e.g., free any additional
542 resources allocated for it that are not Lisp objects. You can even
543 make a pointer to the function that frees the resources a slot in
544 your object -- this way, the same object could be used to represent
545 several disparate C structures. */
547 #ifdef CHECK_LISP_OBJECT_TYPE
549 typedef struct { EMACS_INT i
; } Lisp_Object
;
551 #define LISP_INITIALLY_ZERO {0}
553 #undef CHECK_LISP_OBJECT_TYPE
554 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
555 #else /* CHECK_LISP_OBJECT_TYPE */
557 /* If a struct type is not wanted, define Lisp_Object as just a number. */
559 typedef EMACS_INT Lisp_Object
;
560 #define LISP_INITIALLY_ZERO 0
561 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
562 #endif /* CHECK_LISP_OBJECT_TYPE */
564 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
565 At the machine level, these operations are no-ops. */
566 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
567 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
569 /* In the size word of a vector, this bit means the vector has been marked. */
571 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
572 #define ARRAY_MARK_FLAG PTRDIFF_MIN
573 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
575 /* In the size word of a struct Lisp_Vector, this bit means it's really
576 some other vector-like object. */
577 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
578 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
579 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
581 /* In a pseudovector, the size field actually contains a word with one
582 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
583 with PVEC_TYPE_MASK to indicate the actual type. */
595 PVEC_WINDOW_CONFIGURATION
,
598 /* These should be last, check internal_equal to see why. */
602 PVEC_FONT
/* Should be last because it's used for range checking. */
605 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
606 which were stored in a Lisp_Object. */
607 #ifndef DATA_SEG_BITS
608 # define DATA_SEG_BITS 0
610 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
615 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
617 /* For convenience, we also store the number of elements in these bits.
618 Note that this size is not necessarily the memory-footprint size, but
619 only the number of Lisp_Object fields (that need to be traced by GC).
620 The distinction is used, e.g., by Lisp_Process, which places extra
621 non-Lisp_Object fields at the end of the structure. */
622 PSEUDOVECTOR_SIZE_BITS
= 12,
623 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
625 /* To calculate the memory footprint of the pseudovector, it's useful
626 to store the size of non-Lisp area in word_size units here. */
627 PSEUDOVECTOR_REST_BITS
= 12,
628 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
629 << PSEUDOVECTOR_SIZE_BITS
),
631 /* Used to extract pseudovector subtype information. */
632 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
633 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
,
636 /* These functions extract various sorts of values from a Lisp_Object.
637 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
638 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
641 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
642 #define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
643 DEFINE_GDB_SYMBOL_END (VALMASK
)
645 /* Largest and smallest representable fixnum values. These are the C
646 values. They are macros for use in static initializers. */
647 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
648 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
650 /* Extract the pointer hidden within A. */
651 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
655 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
656 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
657 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
658 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
659 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
661 #else /* ! USE_LSB_TAG */
663 /* Although compiled only if ! USE_LSB_TAG, the following functions
664 also work when USE_LSB_TAG; this is to aid future maintenance when
665 the lisp_h_* macros are eventually removed. */
667 /* Make a Lisp integer representing the value of the low order
670 make_number (EMACS_INT n
)
672 return XIL (USE_LSB_TAG
? n
<< INTTYPEBITS
: n
& INTMASK
);
675 /* Extract A's value as a signed integer. */
679 EMACS_INT i
= XLI (a
);
680 return (USE_LSB_TAG
? i
: i
<< INTTYPEBITS
) >> INTTYPEBITS
;
683 /* Like XINT (A), but may be faster. A must be nonnegative.
684 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
685 integers have zero-bits in their tags. */
687 XFASTINT (Lisp_Object a
)
689 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
694 /* Extract A's type. */
695 INLINE
enum Lisp_Type
696 XTYPE (Lisp_Object a
)
698 EMACS_UINT i
= XLI (a
);
699 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
702 /* Extract A's pointer value, assuming A's type is TYPE. */
704 XUNTAG (Lisp_Object a
, int type
)
708 intptr_t i
= XLI (a
) - type
;
714 #endif /* ! USE_LSB_TAG */
716 /* Extract A's value as an unsigned integer. */
718 XUINT (Lisp_Object a
)
720 EMACS_UINT i
= XLI (a
);
721 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
724 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
725 right now, but XUINT should only be applied to objects we know are
727 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
729 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
731 make_natnum (EMACS_INT n
)
733 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
734 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
737 /* Return true if X and Y are the same object. */
738 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
740 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
741 written this way so that it also works if I is of unsigned
742 type or if I is a NaN. */
744 #define FIXNUM_OVERFLOW_P(i) \
745 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
748 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
750 return num
< lower
? lower
: num
<= upper
? num
: upper
;
753 /* Forward declarations. */
755 /* Defined in this file. */
757 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
758 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
759 INLINE
bool BUFFERP (Lisp_Object
);
760 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
761 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
762 INLINE
bool (CONSP
) (Lisp_Object
);
763 INLINE
bool (FLOATP
) (Lisp_Object
);
764 INLINE
bool functionp (Lisp_Object
);
765 INLINE
bool (INTEGERP
) (Lisp_Object
);
766 INLINE
bool (MARKERP
) (Lisp_Object
);
767 INLINE
bool (MISCP
) (Lisp_Object
);
768 INLINE
bool (NILP
) (Lisp_Object
);
769 INLINE
bool OVERLAYP (Lisp_Object
);
770 INLINE
bool PROCESSP (Lisp_Object
);
771 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
772 INLINE
bool SAVE_VALUEP (Lisp_Object
);
773 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
775 INLINE
bool STRINGP (Lisp_Object
);
776 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
777 INLINE
bool SUBRP (Lisp_Object
);
778 INLINE
bool (SYMBOLP
) (Lisp_Object
);
779 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
780 INLINE
bool WINDOWP (Lisp_Object
);
781 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
783 /* Defined in chartab.c. */
784 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
785 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
786 extern int char_table_translate (Lisp_Object
, int);
788 /* Defined in data.c. */
789 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
790 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
791 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
792 extern Lisp_Object Qbool_vector_p
;
793 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
794 extern Lisp_Object Qwindow
;
795 extern Lisp_Object
Ffboundp (Lisp_Object
);
796 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
798 /* Defined in emacs.c. */
799 extern bool initialized
;
801 /* Defined in eval.c. */
802 extern Lisp_Object Qautoload
;
804 /* Defined in floatfns.c. */
805 extern double extract_float (Lisp_Object
);
807 /* Defined in process.c. */
808 extern Lisp_Object Qprocessp
;
810 /* Defined in window.c. */
811 extern Lisp_Object Qwindowp
;
813 /* Defined in xdisp.c. */
814 extern Lisp_Object Qimage
;
817 /* Extract a value or address from a Lisp_Object. */
819 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
821 INLINE
struct Lisp_Vector
*
822 XVECTOR (Lisp_Object a
)
824 eassert (VECTORLIKEP (a
));
825 return XUNTAG (a
, Lisp_Vectorlike
);
828 INLINE
struct Lisp_String
*
829 XSTRING (Lisp_Object a
)
831 eassert (STRINGP (a
));
832 return XUNTAG (a
, Lisp_String
);
835 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
837 INLINE
struct Lisp_Float
*
838 XFLOAT (Lisp_Object a
)
840 eassert (FLOATP (a
));
841 return XUNTAG (a
, Lisp_Float
);
844 /* Pseudovector types. */
846 INLINE
struct Lisp_Process
*
847 XPROCESS (Lisp_Object a
)
849 eassert (PROCESSP (a
));
850 return XUNTAG (a
, Lisp_Vectorlike
);
853 INLINE
struct window
*
854 XWINDOW (Lisp_Object a
)
856 eassert (WINDOWP (a
));
857 return XUNTAG (a
, Lisp_Vectorlike
);
860 INLINE
struct terminal
*
861 XTERMINAL (Lisp_Object a
)
863 return XUNTAG (a
, Lisp_Vectorlike
);
866 INLINE
struct Lisp_Subr
*
867 XSUBR (Lisp_Object a
)
870 return XUNTAG (a
, Lisp_Vectorlike
);
873 INLINE
struct buffer
*
874 XBUFFER (Lisp_Object a
)
876 eassert (BUFFERP (a
));
877 return XUNTAG (a
, Lisp_Vectorlike
);
880 INLINE
struct Lisp_Char_Table
*
881 XCHAR_TABLE (Lisp_Object a
)
883 eassert (CHAR_TABLE_P (a
));
884 return XUNTAG (a
, Lisp_Vectorlike
);
887 INLINE
struct Lisp_Sub_Char_Table
*
888 XSUB_CHAR_TABLE (Lisp_Object a
)
890 eassert (SUB_CHAR_TABLE_P (a
));
891 return XUNTAG (a
, Lisp_Vectorlike
);
894 INLINE
struct Lisp_Bool_Vector
*
895 XBOOL_VECTOR (Lisp_Object a
)
897 eassert (BOOL_VECTOR_P (a
));
898 return XUNTAG (a
, Lisp_Vectorlike
);
901 /* Construct a Lisp_Object from a value or address. */
904 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
906 EMACS_UINT utype
= type
;
907 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
908 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
909 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
914 make_lisp_proc (struct Lisp_Process
*p
)
916 return make_lisp_ptr (p
, Lisp_Vectorlike
);
919 #define XSETINT(a, b) ((a) = make_number (b))
920 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
921 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
922 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
923 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
924 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
925 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
926 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
928 /* Pseudovector types. */
930 #define XSETPVECTYPE(v, code) \
931 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
932 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
933 ((v)->header.size = (PSEUDOVECTOR_FLAG \
934 | ((code) << PSEUDOVECTOR_AREA_BITS) \
935 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
938 /* The cast to struct vectorlike_header * avoids aliasing issues. */
939 #define XSETPSEUDOVECTOR(a, b, code) \
940 XSETTYPED_PSEUDOVECTOR (a, b, \
941 (((struct vectorlike_header *) \
942 XUNTAG (a, Lisp_Vectorlike)) \
945 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
946 (XSETVECTOR (a, b), \
947 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
948 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
950 #define XSETWINDOW_CONFIGURATION(a, b) \
951 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
952 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
953 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
954 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
955 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
956 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
957 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
958 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
959 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
960 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
964 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
, (int ok
, Lisp_Object Qxxxp
, Lisp_Object x
),
967 /* Deprecated and will be removed soon. */
969 #define INTERNAL_FIELD(field) field ## _
971 /* See the macros in intervals.h. */
973 typedef struct interval
*INTERVAL
;
977 /* Car of this cons cell. */
982 /* Cdr of this cons cell. */
985 /* Used to chain conses on a free list. */
986 struct Lisp_Cons
*chain
;
990 /* Take the car or cdr of something known to be a cons cell. */
991 /* The _addr functions shouldn't be used outside of the minimal set
992 of code that has to know what a cons cell looks like. Other code not
993 part of the basic lisp implementation should assume that the car and cdr
994 fields are not accessible. (What if we want to switch to
995 a copying collector someday? Cached cons cell field addresses may be
996 invalidated at arbitrary points.) */
998 xcar_addr (Lisp_Object c
)
1000 return &XCONS (c
)->car
;
1002 INLINE Lisp_Object
*
1003 xcdr_addr (Lisp_Object c
)
1005 return &XCONS (c
)->u
.cdr
;
1008 /* Use these from normal code. */
1009 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
1010 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
1012 /* Use these to set the fields of a cons cell.
1014 Note that both arguments may refer to the same object, so 'n'
1015 should not be read after 'c' is first modified. */
1017 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1022 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1027 /* Take the car or cdr of something whose type is not known. */
1031 return (CONSP (c
) ? XCAR (c
)
1033 : wrong_type_argument (Qlistp
, c
));
1038 return (CONSP (c
) ? XCDR (c
)
1040 : wrong_type_argument (Qlistp
, c
));
1043 /* Take the car or cdr of something whose type is not known. */
1045 CAR_SAFE (Lisp_Object c
)
1047 return CONSP (c
) ? XCAR (c
) : Qnil
;
1050 CDR_SAFE (Lisp_Object c
)
1052 return CONSP (c
) ? XCDR (c
) : Qnil
;
1055 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1060 ptrdiff_t size_byte
;
1061 INTERVAL intervals
; /* Text properties in this string. */
1062 unsigned char *data
;
1065 /* True if STR is a multibyte string. */
1067 STRING_MULTIBYTE (Lisp_Object str
)
1069 return 0 <= XSTRING (str
)->size_byte
;
1072 /* An upper bound on the number of bytes in a Lisp string, not
1073 counting the terminating null. This a tight enough bound to
1074 prevent integer overflow errors that would otherwise occur during
1075 string size calculations. A string cannot contain more bytes than
1076 a fixnum can represent, nor can it be so long that C pointer
1077 arithmetic stops working on the string plus its terminating null.
1078 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1079 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1080 would expose alloc.c internal details that we'd rather keep
1083 This is a macro for use in static initializers. The cast to
1084 ptrdiff_t ensures that the macro is signed. */
1085 #define STRING_BYTES_BOUND \
1086 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1088 /* Mark STR as a unibyte string. */
1089 #define STRING_SET_UNIBYTE(STR) \
1090 do { if (EQ (STR, empty_multibyte_string)) \
1091 (STR) = empty_unibyte_string; \
1092 else XSTRING (STR)->size_byte = -1; } while (0)
1094 /* Mark STR as a multibyte string. Assure that STR contains only
1095 ASCII characters in advance. */
1096 #define STRING_SET_MULTIBYTE(STR) \
1097 do { if (EQ (STR, empty_unibyte_string)) \
1098 (STR) = empty_multibyte_string; \
1099 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
1101 /* Convenience functions for dealing with Lisp strings. */
1103 INLINE
unsigned char *
1104 SDATA (Lisp_Object string
)
1106 return XSTRING (string
)->data
;
1109 SSDATA (Lisp_Object string
)
1111 /* Avoid "differ in sign" warnings. */
1112 return (char *) SDATA (string
);
1114 INLINE
unsigned char
1115 SREF (Lisp_Object string
, ptrdiff_t index
)
1117 return SDATA (string
)[index
];
1120 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1122 SDATA (string
)[index
] = new;
1125 SCHARS (Lisp_Object string
)
1127 return XSTRING (string
)->size
;
1130 #ifdef GC_CHECK_STRING_BYTES
1131 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1134 STRING_BYTES (struct Lisp_String
*s
)
1136 #ifdef GC_CHECK_STRING_BYTES
1137 return string_bytes (s
);
1139 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1144 SBYTES (Lisp_Object string
)
1146 return STRING_BYTES (XSTRING (string
));
1149 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1151 XSTRING (string
)->size
= newsize
;
1154 STRING_COPYIN (Lisp_Object string
, ptrdiff_t index
, char const *new,
1157 memcpy (SDATA (string
) + index
, new, count
);
1160 /* Header of vector-like objects. This documents the layout constraints on
1161 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1162 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1163 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1164 because when two such pointers potentially alias, a compiler won't
1165 incorrectly reorder loads and stores to their size fields. See
1167 struct vectorlike_header
1169 /* The only field contains various pieces of information:
1170 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1171 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1172 vector (0) or a pseudovector (1).
1173 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1174 of slots) of the vector.
1175 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1176 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1177 - b) number of Lisp_Objects slots at the beginning of the object
1178 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1180 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1181 measured in word_size units. Rest fields may also include
1182 Lisp_Objects, but these objects usually needs some special treatment
1184 There are some exceptions. For PVEC_FREE, b) is always zero. For
1185 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1186 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1187 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1191 /* A regular vector is just a header plus an array of Lisp_Objects. */
1195 struct vectorlike_header header
;
1196 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1199 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1202 ALIGNOF_STRUCT_LISP_VECTOR
1203 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1206 /* A boolvector is a kind of vectorlike, with contents like a string. */
1208 struct Lisp_Bool_Vector
1210 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1211 just the subtype information. */
1212 struct vectorlike_header header
;
1213 /* This is the size in bits. */
1215 /* The actual bits, packed into bytes.
1216 The bits are in little-endian order in the bytes, and
1217 the bytes are in little-endian order in the words. */
1218 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1222 bool_vector_size (Lisp_Object a
)
1224 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1225 eassume (0 <= size
);
1230 bool_vector_data (Lisp_Object a
)
1232 return XBOOL_VECTOR (a
)->data
;
1235 INLINE
unsigned char *
1236 bool_vector_uchar_data (Lisp_Object a
)
1238 return (unsigned char *) bool_vector_data (a
);
1241 /* The number of data words and bytes in a bool vector with SIZE bits. */
1244 bool_vector_words (EMACS_INT size
)
1246 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1247 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1251 bool_vector_bytes (EMACS_INT size
)
1253 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1254 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1257 /* True if A's Ith bit is set. */
1260 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1262 eassume (0 <= i
&& i
< bool_vector_size (a
));
1263 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1264 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1268 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1270 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1273 /* Set A's Ith bit to B. */
1276 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1278 unsigned char *addr
;
1280 eassume (0 <= i
&& i
< bool_vector_size (a
));
1281 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1284 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1286 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1289 /* Some handy constants for calculating sizes
1290 and offsets, mostly of vectorlike objects. */
1294 header_size
= offsetof (struct Lisp_Vector
, contents
),
1295 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1296 word_size
= sizeof (Lisp_Object
)
1299 /* Conveniences for dealing with Lisp arrays. */
1302 AREF (Lisp_Object array
, ptrdiff_t idx
)
1304 return XVECTOR (array
)->contents
[idx
];
1307 INLINE Lisp_Object
*
1308 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1310 return & XVECTOR (array
)->contents
[idx
];
1314 ASIZE (Lisp_Object array
)
1316 return XVECTOR (array
)->header
.size
;
1320 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1322 eassert (0 <= idx
&& idx
< ASIZE (array
));
1323 XVECTOR (array
)->contents
[idx
] = val
;
1327 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1329 /* Like ASET, but also can be used in the garbage collector:
1330 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1331 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
1332 XVECTOR (array
)->contents
[idx
] = val
;
1335 /* If a struct is made to look like a vector, this macro returns the length
1336 of the shortest vector that would hold that struct. */
1338 #define VECSIZE(type) \
1339 ((sizeof (type) - header_size + word_size - 1) / word_size)
1341 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1342 at the end and we need to compute the number of Lisp_Object fields (the
1343 ones that the GC needs to trace). */
1345 #define PSEUDOVECSIZE(type, nonlispfield) \
1346 ((offsetof (type, nonlispfield) - header_size) / word_size)
1348 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1349 should be integer expressions. This is not the same as
1350 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1351 returns 1. For efficiency, prefer plain unsigned comparison if A
1352 and B's sizes both fit (after integer promotion). */
1353 #define UNSIGNED_CMP(a, op, b) \
1354 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1355 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1356 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1358 /* Nonzero iff C is an ASCII character. */
1359 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1361 /* A char-table is a kind of vectorlike, with contents are like a
1362 vector but with a few other slots. For some purposes, it makes
1363 sense to handle a char-table with type struct Lisp_Vector. An
1364 element of a char table can be any Lisp objects, but if it is a sub
1365 char-table, we treat it a table that contains information of a
1366 specific range of characters. A sub char-table has the same
1367 structure as a vector. A sub char table appears only in an element
1368 of a char-table, and there's no way to access it directly from
1369 Emacs Lisp program. */
1371 enum CHARTAB_SIZE_BITS
1373 CHARTAB_SIZE_BITS_0
= 6,
1374 CHARTAB_SIZE_BITS_1
= 4,
1375 CHARTAB_SIZE_BITS_2
= 5,
1376 CHARTAB_SIZE_BITS_3
= 7
1379 extern const int chartab_size
[4];
1381 struct Lisp_Char_Table
1383 /* HEADER.SIZE is the vector's size field, which also holds the
1384 pseudovector type information. It holds the size, too.
1385 The size counts the defalt, parent, purpose, ascii,
1386 contents, and extras slots. */
1387 struct vectorlike_header header
;
1389 /* This holds a default value,
1390 which is used whenever the value for a specific character is nil. */
1393 /* This points to another char table, which we inherit from when the
1394 value for a specific character is nil. The `defalt' slot takes
1395 precedence over this. */
1398 /* This is a symbol which says what kind of use this char-table is
1400 Lisp_Object purpose
;
1402 /* The bottom sub char-table for characters of the range 0..127. It
1403 is nil if none of ASCII character has a specific value. */
1406 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1408 /* These hold additional data. It is a vector. */
1409 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1412 struct Lisp_Sub_Char_Table
1414 /* HEADER.SIZE is the vector's size field, which also holds the
1415 pseudovector type information. It holds the size, too. */
1416 struct vectorlike_header header
;
1418 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1419 char-table of depth 1 contains 16 elements, and each element
1420 covers 4096 (128*32) characters. A sub char-table of depth 2
1421 contains 32 elements, and each element covers 128 characters. A
1422 sub char-table of depth 3 contains 128 elements, and each element
1423 is for one character. */
1426 /* Minimum character covered by the sub char-table. */
1427 Lisp_Object min_char
;
1429 /* Use set_sub_char_table_contents to set this. */
1430 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1434 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1436 struct Lisp_Char_Table
*tbl
= NULL
;
1440 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1441 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1442 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1446 while (NILP (val
) && ! NILP (tbl
->parent
));
1451 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1452 characters. Do not check validity of CT. */
1454 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1456 return (ASCII_CHAR_P (idx
)
1457 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1458 : char_table_ref (ct
, idx
));
1461 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1462 8-bit European characters. Do not check validity of CT. */
1464 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1466 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1467 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1469 char_table_set (ct
, idx
, val
);
1472 /* This structure describes a built-in function.
1473 It is generated by the DEFUN macro only.
1474 defsubr makes it into a Lisp object. */
1478 struct vectorlike_header header
;
1480 Lisp_Object (*a0
) (void);
1481 Lisp_Object (*a1
) (Lisp_Object
);
1482 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1483 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1484 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1485 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1486 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1487 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1488 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1489 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1490 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1492 short min_args
, max_args
;
1493 const char *symbol_name
;
1494 const char *intspec
;
1498 /* This is the number of slots that every char table must have. This
1499 counts the ordinary slots and the top, defalt, parent, and purpose
1501 enum CHAR_TABLE_STANDARD_SLOTS
1503 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1506 /* Return the number of "extra" slots in the char table CT. */
1509 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1511 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1512 - CHAR_TABLE_STANDARD_SLOTS
);
1516 /***********************************************************************
1518 ***********************************************************************/
1520 /* Interned state of a symbol. */
1522 enum symbol_interned
1524 SYMBOL_UNINTERNED
= 0,
1525 SYMBOL_INTERNED
= 1,
1526 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1529 enum symbol_redirect
1531 SYMBOL_PLAINVAL
= 4,
1532 SYMBOL_VARALIAS
= 1,
1533 SYMBOL_LOCALIZED
= 2,
1534 SYMBOL_FORWARDED
= 3
1539 unsigned gcmarkbit
: 1;
1541 /* Indicates where the value can be found:
1542 0 : it's a plain var, the value is in the `value' field.
1543 1 : it's a varalias, the value is really in the `alias' symbol.
1544 2 : it's a localized var, the value is in the `blv' object.
1545 3 : it's a forwarding variable, the value is in `forward'. */
1546 ENUM_BF (symbol_redirect
) redirect
: 3;
1548 /* Non-zero means symbol is constant, i.e. changing its value
1549 should signal an error. If the value is 3, then the var
1550 can be changed, but only by `defconst'. */
1551 unsigned constant
: 2;
1553 /* Interned state of the symbol. This is an enumerator from
1554 enum symbol_interned. */
1555 unsigned interned
: 2;
1557 /* Non-zero means that this variable has been explicitly declared
1558 special (with `defvar' etc), and shouldn't be lexically bound. */
1559 unsigned declared_special
: 1;
1561 /* The symbol's name, as a Lisp string. */
1564 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1565 union is used depends on the `redirect' field above. */
1568 struct Lisp_Symbol
*alias
;
1569 struct Lisp_Buffer_Local_Value
*blv
;
1570 union Lisp_Fwd
*fwd
;
1573 /* Function value of the symbol or Qnil if not fboundp. */
1574 Lisp_Object function
;
1576 /* The symbol's property list. */
1579 /* Next symbol in obarray bucket, if the symbol is interned. */
1580 struct Lisp_Symbol
*next
;
1583 /* Value is name of symbol. */
1585 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1587 INLINE
struct Lisp_Symbol
*
1588 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1590 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1591 return sym
->val
.alias
;
1593 INLINE
struct Lisp_Buffer_Local_Value
*
1594 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1596 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1597 return sym
->val
.blv
;
1599 INLINE
union Lisp_Fwd
*
1600 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1602 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1603 return sym
->val
.fwd
;
1606 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1607 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1610 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1612 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1616 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1618 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1622 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1624 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1629 SYMBOL_NAME (Lisp_Object sym
)
1631 return XSYMBOL (sym
)->name
;
1634 /* Value is true if SYM is an interned symbol. */
1637 SYMBOL_INTERNED_P (Lisp_Object sym
)
1639 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1642 /* Value is true if SYM is interned in initial_obarray. */
1645 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1647 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1650 /* Value is non-zero if symbol is considered a constant, i.e. its
1651 value cannot be changed (there is an exception for keyword symbols,
1652 whose value can be set to the keyword symbol itself). */
1654 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1656 #define DEFSYM(sym, name) \
1657 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1660 /***********************************************************************
1662 ***********************************************************************/
1664 /* The structure of a Lisp hash table. */
1666 struct hash_table_test
1668 /* Name of the function used to compare keys. */
1671 /* User-supplied hash function, or nil. */
1672 Lisp_Object user_hash_function
;
1674 /* User-supplied key comparison function, or nil. */
1675 Lisp_Object user_cmp_function
;
1677 /* C function to compare two keys. */
1678 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1680 /* C function to compute hash code. */
1681 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1684 struct Lisp_Hash_Table
1686 /* This is for Lisp; the hash table code does not refer to it. */
1687 struct vectorlike_header header
;
1689 /* Nil if table is non-weak. Otherwise a symbol describing the
1690 weakness of the table. */
1693 /* When the table is resized, and this is an integer, compute the
1694 new size by adding this to the old size. If a float, compute the
1695 new size by multiplying the old size with this factor. */
1696 Lisp_Object rehash_size
;
1698 /* Resize hash table when number of entries/ table size is >= this
1700 Lisp_Object rehash_threshold
;
1702 /* Vector of hash codes.. If hash[I] is nil, this means that that
1703 entry I is unused. */
1706 /* Vector used to chain entries. If entry I is free, next[I] is the
1707 entry number of the next free item. If entry I is non-free,
1708 next[I] is the index of the next entry in the collision chain. */
1711 /* Index of first free entry in free list. */
1712 Lisp_Object next_free
;
1714 /* Bucket vector. A non-nil entry is the index of the first item in
1715 a collision chain. This vector's size can be larger than the
1716 hash table size to reduce collisions. */
1719 /* Only the fields above are traced normally by the GC. The ones below
1720 `count' are special and are either ignored by the GC or traced in
1721 a special way (e.g. because of weakness). */
1723 /* Number of key/value entries in the table. */
1726 /* Vector of keys and values. The key of item I is found at index
1727 2 * I, the value is found at index 2 * I + 1.
1728 This is gc_marked specially if the table is weak. */
1729 Lisp_Object key_and_value
;
1731 /* The comparison and hash functions. */
1732 struct hash_table_test test
;
1734 /* Next weak hash table if this is a weak hash table. The head
1735 of the list is in weak_hash_tables. */
1736 struct Lisp_Hash_Table
*next_weak
;
1740 INLINE
struct Lisp_Hash_Table
*
1741 XHASH_TABLE (Lisp_Object a
)
1743 return XUNTAG (a
, Lisp_Vectorlike
);
1746 #define XSET_HASH_TABLE(VAR, PTR) \
1747 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1750 HASH_TABLE_P (Lisp_Object a
)
1752 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1755 /* Value is the key part of entry IDX in hash table H. */
1757 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1759 return AREF (h
->key_and_value
, 2 * idx
);
1762 /* Value is the value part of entry IDX in hash table H. */
1764 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1766 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1769 /* Value is the index of the next entry following the one at IDX
1772 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1774 return AREF (h
->next
, idx
);
1777 /* Value is the hash code computed for entry IDX in hash table H. */
1779 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1781 return AREF (h
->hash
, idx
);
1784 /* Value is the index of the element in hash table H that is the
1785 start of the collision list at index IDX in the index vector of H. */
1787 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1789 return AREF (h
->index
, idx
);
1792 /* Value is the size of hash table H. */
1794 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1796 return ASIZE (h
->next
);
1799 /* Default size for hash tables if not specified. */
1801 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1803 /* Default threshold specifying when to resize a hash table. The
1804 value gives the ratio of current entries in the hash table and the
1805 size of the hash table. */
1807 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1809 /* Default factor by which to increase the size of a hash table. */
1811 static double const DEFAULT_REHASH_SIZE
= 1.5;
1813 /* Combine two integers X and Y for hashing. The result might not fit
1814 into a Lisp integer. */
1817 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1819 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1822 /* Hash X, returning a value that fits into a fixnum. */
1825 SXHASH_REDUCE (EMACS_UINT x
)
1827 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1830 /* These structures are used for various misc types. */
1832 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1834 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1835 unsigned gcmarkbit
: 1;
1836 unsigned spacer
: 15;
1841 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1842 unsigned gcmarkbit
: 1;
1843 unsigned spacer
: 13;
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 unsigned int need_adjustment
: 1;
1848 /* 1 means normal insertion at the marker's position
1849 leaves the marker after the inserted text. */
1850 unsigned int 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 unsigned gcmarkbit
: 1;
1897 unsigned spacer
: 15;
1898 struct Lisp_Overlay
*next
;
1904 /* Types of data which may be saved in a Lisp_Save_Value. */
1915 /* Number of bits needed to store one of the above values. */
1916 enum { SAVE_SLOT_BITS
= 3 };
1918 /* Number of slots in a save value where save_type is nonzero. */
1919 enum { SAVE_VALUE_SLOTS
= 4 };
1921 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1923 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1927 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1928 SAVE_TYPE_INT_INT_INT
1929 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1930 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1931 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1932 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1933 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1934 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1935 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1936 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1937 SAVE_TYPE_FUNCPTR_PTR_OBJ
1938 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1940 /* This has an extra bit indicating it's raw memory. */
1941 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1944 /* Special object used to hold a different values for later use.
1946 This is mostly used to package C integers and pointers to call
1947 record_unwind_protect when two or more values need to be saved.
1951 struct my_data *md = get_my_data ();
1952 ptrdiff_t mi = get_my_integer ();
1953 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1956 Lisp_Object my_unwind (Lisp_Object arg)
1958 struct my_data *md = XSAVE_POINTER (arg, 0);
1959 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1963 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1964 saved objects and raise eassert if type of the saved object doesn't match
1965 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1966 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1967 slot 0 is a pointer. */
1969 typedef void (*voidfuncptr
) (void);
1971 struct Lisp_Save_Value
1973 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1974 unsigned gcmarkbit
: 1;
1975 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
1977 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1978 V's data entries are determined by V->save_type. E.g., if
1979 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1980 V->data[1] is an integer, and V's other data entries are unused.
1982 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1983 a memory area containing V->data[1].integer potential Lisp_Objects. */
1984 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1987 voidfuncptr funcpointer
;
1990 } data
[SAVE_VALUE_SLOTS
];
1993 /* Return the type of V's Nth saved value. */
1995 save_type (struct Lisp_Save_Value
*v
, int n
)
1997 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1998 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2001 /* Get and set the Nth saved pointer. */
2004 XSAVE_POINTER (Lisp_Object obj
, int n
)
2006 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2007 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2010 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2012 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2013 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2016 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2018 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2019 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2022 /* Likewise for the saved integer. */
2025 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2027 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2028 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2031 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2033 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2034 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2037 /* Extract Nth saved object. */
2040 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2042 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2043 return XSAVE_VALUE (obj
)->data
[n
].object
;
2046 /* A miscellaneous object, when it's on the free list. */
2049 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2050 unsigned gcmarkbit
: 1;
2051 unsigned spacer
: 15;
2052 union Lisp_Misc
*chain
;
2055 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2056 It uses one of these struct subtypes to get the type field. */
2060 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2061 struct Lisp_Free u_free
;
2062 struct Lisp_Marker u_marker
;
2063 struct Lisp_Overlay u_overlay
;
2064 struct Lisp_Save_Value u_save_value
;
2067 INLINE
union Lisp_Misc
*
2068 XMISC (Lisp_Object a
)
2070 return XUNTAG (a
, Lisp_Misc
);
2073 INLINE
struct Lisp_Misc_Any
*
2074 XMISCANY (Lisp_Object a
)
2076 eassert (MISCP (a
));
2077 return & XMISC (a
)->u_any
;
2080 INLINE
enum Lisp_Misc_Type
2081 XMISCTYPE (Lisp_Object a
)
2083 return XMISCANY (a
)->type
;
2086 INLINE
struct Lisp_Marker
*
2087 XMARKER (Lisp_Object a
)
2089 eassert (MARKERP (a
));
2090 return & XMISC (a
)->u_marker
;
2093 INLINE
struct Lisp_Overlay
*
2094 XOVERLAY (Lisp_Object a
)
2096 eassert (OVERLAYP (a
));
2097 return & XMISC (a
)->u_overlay
;
2100 INLINE
struct Lisp_Save_Value
*
2101 XSAVE_VALUE (Lisp_Object a
)
2103 eassert (SAVE_VALUEP (a
));
2104 return & XMISC (a
)->u_save_value
;
2107 /* Forwarding pointer to an int variable.
2108 This is allowed only in the value cell of a symbol,
2109 and it means that the symbol's value really lives in the
2110 specified int variable. */
2113 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2117 /* Boolean forwarding pointer to an int variable.
2118 This is like Lisp_Intfwd except that the ostensible
2119 "value" of the symbol is t if the int variable is nonzero,
2120 nil if it is zero. */
2123 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2127 /* Forwarding pointer to a Lisp_Object variable.
2128 This is allowed only in the value cell of a symbol,
2129 and it means that the symbol's value really lives in the
2130 specified variable. */
2133 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2134 Lisp_Object
*objvar
;
2137 /* Like Lisp_Objfwd except that value lives in a slot in the
2138 current buffer. Value is byte index of slot within buffer. */
2139 struct Lisp_Buffer_Objfwd
2141 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2143 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2144 Lisp_Object predicate
;
2147 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2148 the symbol has buffer-local or frame-local bindings. (Exception:
2149 some buffer-local variables are built-in, with their values stored
2150 in the buffer structure itself. They are handled differently,
2151 using struct Lisp_Buffer_Objfwd.)
2153 The `realvalue' slot holds the variable's current value, or a
2154 forwarding pointer to where that value is kept. This value is the
2155 one that corresponds to the loaded binding. To read or set the
2156 variable, you must first make sure the right binding is loaded;
2157 then you can access the value in (or through) `realvalue'.
2159 `buffer' and `frame' are the buffer and frame for which the loaded
2160 binding was found. If those have changed, to make sure the right
2161 binding is loaded it is necessary to find which binding goes with
2162 the current buffer and selected frame, then load it. To load it,
2163 first unload the previous binding, then copy the value of the new
2164 binding into `realvalue' (or through it). Also update
2165 LOADED-BINDING to point to the newly loaded binding.
2167 `local_if_set' indicates that merely setting the variable creates a
2168 local binding for the current buffer. Otherwise the latter, setting
2169 the variable does not do that; only make-local-variable does that. */
2171 struct Lisp_Buffer_Local_Value
2173 /* 1 means that merely setting the variable creates a local
2174 binding for the current buffer. */
2175 unsigned int local_if_set
: 1;
2176 /* 1 means this variable can have frame-local bindings, otherwise, it is
2177 can have buffer-local bindings. The two cannot be combined. */
2178 unsigned int frame_local
: 1;
2179 /* 1 means that the binding now loaded was found.
2180 Presumably equivalent to (defcell!=valcell). */
2181 unsigned int found
: 1;
2182 /* If non-NULL, a forwarding to the C var where it should also be set. */
2183 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2184 /* The buffer or frame for which the loaded binding was found. */
2186 /* A cons cell that holds the default value. It has the form
2187 (SYMBOL . DEFAULT-VALUE). */
2188 Lisp_Object defcell
;
2189 /* The cons cell from `where's parameter alist.
2190 It always has the form (SYMBOL . VALUE)
2191 Note that if `forward' is non-nil, VALUE may be out of date.
2192 Also if the currently loaded binding is the default binding, then
2193 this is `eq'ual to defcell. */
2194 Lisp_Object valcell
;
2197 /* Like Lisp_Objfwd except that value lives in a slot in the
2199 struct Lisp_Kboard_Objfwd
2201 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2207 struct Lisp_Intfwd u_intfwd
;
2208 struct Lisp_Boolfwd u_boolfwd
;
2209 struct Lisp_Objfwd u_objfwd
;
2210 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2211 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2214 INLINE
enum Lisp_Fwd_Type
2215 XFWDTYPE (union Lisp_Fwd
*a
)
2217 return a
->u_intfwd
.type
;
2220 INLINE
struct Lisp_Buffer_Objfwd
*
2221 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2223 eassert (BUFFER_OBJFWDP (a
));
2224 return &a
->u_buffer_objfwd
;
2227 /* Lisp floating point type. */
2233 struct Lisp_Float
*chain
;
2238 XFLOAT_DATA (Lisp_Object f
)
2240 return XFLOAT (f
)->u
.data
;
2243 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2244 representations, have infinities and NaNs, and do not trap on
2245 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2246 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2247 wanted here, but is not quite right because Emacs does not require
2248 all the features of C11 Annex F (and does not require C11 at all,
2249 for that matter). */
2253 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2254 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2257 /* A character, declared with the following typedef, is a member
2258 of some character set associated with the current buffer. */
2259 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2261 typedef unsigned char UCHAR
;
2264 /* Meanings of slots in a Lisp_Compiled: */
2268 COMPILED_ARGLIST
= 0,
2269 COMPILED_BYTECODE
= 1,
2270 COMPILED_CONSTANTS
= 2,
2271 COMPILED_STACK_DEPTH
= 3,
2272 COMPILED_DOC_STRING
= 4,
2273 COMPILED_INTERACTIVE
= 5
2276 /* Flag bits in a character. These also get used in termhooks.h.
2277 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2278 (MUlti-Lingual Emacs) might need 22 bits for the character value
2279 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2282 CHAR_ALT
= 0x0400000,
2283 CHAR_SUPER
= 0x0800000,
2284 CHAR_HYPER
= 0x1000000,
2285 CHAR_SHIFT
= 0x2000000,
2286 CHAR_CTL
= 0x4000000,
2287 CHAR_META
= 0x8000000,
2289 CHAR_MODIFIER_MASK
=
2290 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2292 /* Actually, the current Emacs uses 22 bits for the character value
2297 /* Data type checking. */
2299 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2302 NUMBERP (Lisp_Object x
)
2304 return INTEGERP (x
) || FLOATP (x
);
2307 NATNUMP (Lisp_Object x
)
2309 return INTEGERP (x
) && 0 <= XINT (x
);
2313 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2315 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2318 #define TYPE_RANGED_INTEGERP(type, x) \
2320 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2321 && XINT (x) <= TYPE_MAXIMUM (type))
2323 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2324 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2325 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2326 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2327 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2328 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2329 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2332 STRINGP (Lisp_Object x
)
2334 return XTYPE (x
) == Lisp_String
;
2337 VECTORP (Lisp_Object x
)
2339 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2342 OVERLAYP (Lisp_Object x
)
2344 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2347 SAVE_VALUEP (Lisp_Object x
)
2349 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2353 AUTOLOADP (Lisp_Object x
)
2355 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2359 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2361 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2365 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2367 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2368 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2371 /* True if A is a pseudovector whose code is CODE. */
2373 PSEUDOVECTORP (Lisp_Object a
, int code
)
2375 if (! VECTORLIKEP (a
))
2379 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2380 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2381 return PSEUDOVECTOR_TYPEP (h
, code
);
2386 /* Test for specific pseudovector types. */
2389 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2391 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2395 PROCESSP (Lisp_Object a
)
2397 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2401 WINDOWP (Lisp_Object a
)
2403 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2407 TERMINALP (Lisp_Object a
)
2409 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2413 SUBRP (Lisp_Object a
)
2415 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2419 COMPILEDP (Lisp_Object a
)
2421 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2425 BUFFERP (Lisp_Object a
)
2427 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2431 CHAR_TABLE_P (Lisp_Object a
)
2433 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2437 SUB_CHAR_TABLE_P (Lisp_Object a
)
2439 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2443 BOOL_VECTOR_P (Lisp_Object a
)
2445 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2449 FRAMEP (Lisp_Object a
)
2451 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2454 /* Test for image (image . spec) */
2456 IMAGEP (Lisp_Object x
)
2458 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2463 ARRAYP (Lisp_Object x
)
2465 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2469 CHECK_LIST (Lisp_Object x
)
2471 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2474 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2475 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2476 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2479 CHECK_STRING (Lisp_Object x
)
2481 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2484 CHECK_STRING_CAR (Lisp_Object x
)
2486 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2489 CHECK_CONS (Lisp_Object x
)
2491 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2494 CHECK_VECTOR (Lisp_Object x
)
2496 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2499 CHECK_BOOL_VECTOR (Lisp_Object x
)
2501 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2504 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2506 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2509 CHECK_ARRAY (Lisp_Object x
, Lisp_Object Qxxxp
)
2511 CHECK_TYPE (ARRAYP (x
), Qxxxp
, x
);
2514 CHECK_BUFFER (Lisp_Object x
)
2516 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2519 CHECK_WINDOW (Lisp_Object x
)
2521 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2524 CHECK_PROCESS (Lisp_Object x
)
2526 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2529 CHECK_NATNUM (Lisp_Object x
)
2531 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2534 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2537 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2538 args_out_of_range_3 \
2540 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2541 ? MOST_NEGATIVE_FIXNUM \
2543 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2545 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2547 if (TYPE_SIGNED (type)) \
2548 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2550 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2553 #define CHECK_NUMBER_COERCE_MARKER(x) \
2554 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
2555 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
2558 XFLOATINT (Lisp_Object n
)
2560 return extract_float (n
);
2564 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2566 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2569 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2570 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
2571 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
2573 /* Since we can't assign directly to the CAR or CDR fields of a cons
2574 cell, use these when checking that those fields contain numbers. */
2576 CHECK_NUMBER_CAR (Lisp_Object x
)
2578 Lisp_Object tmp
= XCAR (x
);
2584 CHECK_NUMBER_CDR (Lisp_Object x
)
2586 Lisp_Object tmp
= XCDR (x
);
2591 /* Define a built-in function for calling from Lisp.
2592 `lname' should be the name to give the function in Lisp,
2593 as a null-terminated C string.
2594 `fnname' should be the name of the function in C.
2595 By convention, it starts with F.
2596 `sname' should be the name for the C constant structure
2597 that records information on this function for internal use.
2598 By convention, it should be the same as `fnname' but with S instead of F.
2599 It's too bad that C macros can't compute this from `fnname'.
2600 `minargs' should be a number, the minimum number of arguments allowed.
2601 `maxargs' should be a number, the maximum number of arguments allowed,
2602 or else MANY or UNEVALLED.
2603 MANY means pass a vector of evaluated arguments,
2604 in the form of an integer number-of-arguments
2605 followed by the address of a vector of Lisp_Objects
2606 which contains the argument values.
2607 UNEVALLED means pass the list of unevaluated arguments
2608 `intspec' says how interactive arguments are to be fetched.
2609 If the string starts with a `(', `intspec' is evaluated and the resulting
2610 list is the list of arguments.
2611 If it's a string that doesn't start with `(', the value should follow
2612 the one of the doc string for `interactive'.
2613 A null string means call interactively with no arguments.
2614 `doc' is documentation for the user. */
2616 /* This version of DEFUN declares a function prototype with the right
2617 arguments, so we can catch errors with maxargs at compile-time. */
2619 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2620 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2621 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2622 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2623 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2624 { (Lisp_Object (__cdecl *)(void))fnname }, \
2625 minargs, maxargs, lname, intspec, 0}; \
2627 #else /* not _MSC_VER */
2628 # if __STDC_VERSION__ < 199901
2629 # define DEFUN_FUNCTION_INIT(fnname, maxargs) (Lisp_Object (*) (void)) fnname
2631 # define DEFUN_FUNCTION_INIT(fnname, maxargs) .a ## maxargs = fnname
2633 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2634 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2635 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2636 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2637 { DEFUN_FUNCTION_INIT (fnname, maxargs) }, \
2638 minargs, maxargs, lname, intspec, 0}; \
2642 /* Note that the weird token-substitution semantics of ANSI C makes
2643 this work for MANY and UNEVALLED. */
2644 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2645 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2646 #define DEFUN_ARGS_0 (void)
2647 #define DEFUN_ARGS_1 (Lisp_Object)
2648 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2649 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2650 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2651 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2653 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2654 Lisp_Object, Lisp_Object)
2655 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2656 Lisp_Object, Lisp_Object, Lisp_Object)
2657 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2658 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2660 /* True if OBJ is a Lisp function. */
2662 FUNCTIONP (Lisp_Object obj
)
2664 return functionp (obj
);
2668 is how we define the symbol for function `name' at start-up time. */
2669 extern void defsubr (struct Lisp_Subr
*);
2677 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2678 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2679 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2680 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2681 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2683 /* Macros we use to define forwarded Lisp variables.
2684 These are used in the syms_of_FILENAME functions.
2686 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2687 lisp variable is actually a field in `struct emacs_globals'. The
2688 field's name begins with "f_", which is a convention enforced by
2689 these macros. Each such global has a corresponding #define in
2690 globals.h; the plain name should be used in the code.
2692 E.g., the global "cons_cells_consed" is declared as "int
2693 f_cons_cells_consed" in globals.h, but there is a define:
2695 #define cons_cells_consed globals.f_cons_cells_consed
2697 All C code uses the `cons_cells_consed' name. This is all done
2698 this way to support indirection for multi-threaded Emacs. */
2700 #define DEFVAR_LISP(lname, vname, doc) \
2702 static struct Lisp_Objfwd o_fwd; \
2703 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2705 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2707 static struct Lisp_Objfwd o_fwd; \
2708 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2710 #define DEFVAR_BOOL(lname, vname, doc) \
2712 static struct Lisp_Boolfwd b_fwd; \
2713 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2715 #define DEFVAR_INT(lname, vname, doc) \
2717 static struct Lisp_Intfwd i_fwd; \
2718 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2721 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2723 static struct Lisp_Objfwd o_fwd; \
2724 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2727 #define DEFVAR_KBOARD(lname, vname, doc) \
2729 static struct Lisp_Kboard_Objfwd ko_fwd; \
2730 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2733 /* Save and restore the instruction and environment pointers,
2734 without affecting the signal mask. */
2737 typedef jmp_buf sys_jmp_buf
;
2738 # define sys_setjmp(j) _setjmp (j)
2739 # define sys_longjmp(j, v) _longjmp (j, v)
2740 #elif defined HAVE_SIGSETJMP
2741 typedef sigjmp_buf sys_jmp_buf
;
2742 # define sys_setjmp(j) sigsetjmp (j, 0)
2743 # define sys_longjmp(j, v) siglongjmp (j, v)
2745 /* A platform that uses neither _longjmp nor siglongjmp; assume
2746 longjmp does not affect the sigmask. */
2747 typedef jmp_buf sys_jmp_buf
;
2748 # define sys_setjmp(j) setjmp (j)
2749 # define sys_longjmp(j, v) longjmp (j, v)
2753 /* Elisp uses several stacks:
2755 - the bytecode stack: used internally by the bytecode interpreter.
2756 Allocated from the C stack.
2757 - The specpdl stack: keeps track of active unwind-protect and
2758 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2760 - The handler stack: keeps track of active catch tags and condition-case
2761 handlers. Allocated in a manually managed stack implemented by a
2762 doubly-linked list allocated via xmalloc and never freed. */
2764 /* Structure for recording Lisp call stack for backtrace purposes. */
2766 /* The special binding stack holds the outer values of variables while
2767 they are bound by a function application or a let form, stores the
2768 code to be executed for unwind-protect forms.
2770 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2771 used all over the place, needs to be fast, and needs to know the size of
2772 union specbinding. But only eval.c should access it. */
2775 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2776 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2777 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2778 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2779 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2780 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2781 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2782 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2783 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2788 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2790 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2791 void (*func
) (Lisp_Object
);
2795 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2796 void (*func
) (void *);
2800 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2805 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2806 void (*func
) (void);
2809 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2810 /* `where' is not used in the case of SPECPDL_LET. */
2811 Lisp_Object symbol
, old_value
, where
;
2814 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2815 unsigned debug_on_exit
: 1;
2816 Lisp_Object function
;
2822 extern union specbinding
*specpdl
;
2823 extern union specbinding
*specpdl_ptr
;
2824 extern ptrdiff_t specpdl_size
;
2827 SPECPDL_INDEX (void)
2829 return specpdl_ptr
- specpdl
;
2832 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2833 control structures. A struct handler contains all the information needed to
2834 restore the state of the interpreter after a non-local jump.
2836 handler structures are chained together in a doubly linked list; the `next'
2837 member points to the next outer catchtag and the `nextfree' member points in
2838 the other direction to the next inner element (which is typically the next
2839 free element since we mostly use it on the deepest handler).
2841 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2842 member is TAG, and then unbinds to it. The `val' member is used to
2843 hold VAL while the stack is unwound; `val' is returned as the value
2846 All the other members are concerned with restoring the interpreter
2849 Members are volatile if their values need to survive _longjmp when
2850 a 'struct handler' is a local variable. */
2852 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2856 enum handlertype type
;
2857 Lisp_Object tag_or_ch
;
2859 struct handler
*next
;
2860 struct handler
*nextfree
;
2862 /* The bytecode interpreter can have several handlers active at the same
2863 time, so when we longjmp to one of them, it needs to know which handler
2864 this was and what was the corresponding internal state. This is stored
2865 here, and when we longjmp we make sure that handlerlist points to the
2867 Lisp_Object
*bytecode_top
;
2870 /* Most global vars are reset to their value via the specpdl mechanism,
2871 but a few others are handled by storing their value here. */
2872 #if 1 /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but they're defined later. */
2873 struct gcpro
*gcpro
;
2876 EMACS_INT lisp_eval_depth
;
2878 int poll_suppress_count
;
2879 int interrupt_input_blocked
;
2880 struct byte_stack
*byte_stack
;
2883 /* Fill in the components of c, and put it on the list. */
2884 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2885 if (handlerlist->nextfree) \
2886 (c) = handlerlist->nextfree; \
2889 (c) = xmalloc (sizeof (struct handler)); \
2890 (c)->nextfree = NULL; \
2891 handlerlist->nextfree = (c); \
2893 (c)->type = (handlertype); \
2894 (c)->tag_or_ch = (tag_ch_val); \
2896 (c)->next = handlerlist; \
2897 (c)->lisp_eval_depth = lisp_eval_depth; \
2898 (c)->pdlcount = SPECPDL_INDEX (); \
2899 (c)->poll_suppress_count = poll_suppress_count; \
2900 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2901 (c)->gcpro = gcprolist; \
2902 (c)->byte_stack = byte_stack_list; \
2906 extern Lisp_Object memory_signal_data
;
2908 /* An address near the bottom of the stack.
2909 Tells GC how to save a copy of the stack. */
2910 extern char *stack_bottom
;
2912 /* Check quit-flag and quit if it is non-nil.
2913 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2914 So the program needs to do QUIT at times when it is safe to quit.
2915 Every loop that might run for a long time or might not exit
2916 ought to do QUIT at least once, at a safe place.
2917 Unless that is impossible, of course.
2918 But it is very desirable to avoid creating loops where QUIT is impossible.
2920 Exception: if you set immediate_quit to nonzero,
2921 then the handler that responds to the C-g does the quit itself.
2922 This is a good thing to do around a loop that has no side effects
2923 and (in particular) cannot call arbitrary Lisp code.
2925 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2926 a request to exit Emacs when it is safe to do. */
2928 extern void process_pending_signals (void);
2929 extern bool volatile pending_signals
;
2931 extern void process_quit_flag (void);
2934 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2935 process_quit_flag (); \
2936 else if (pending_signals) \
2937 process_pending_signals (); \
2941 /* Nonzero if ought to quit now. */
2943 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2945 extern Lisp_Object Vascii_downcase_table
;
2946 extern Lisp_Object Vascii_canon_table
;
2948 /* Structure for recording stack slots that need marking. */
2950 /* This is a chain of structures, each of which points at a Lisp_Object
2951 variable whose value should be marked in garbage collection.
2952 Normally every link of the chain is an automatic variable of a function,
2953 and its `val' points to some argument or local variable of the function.
2954 On exit to the function, the chain is set back to the value it had on entry.
2955 This way, no link remains in the chain when the stack frame containing the
2958 Every function that can call Feval must protect in this fashion all
2959 Lisp_Object variables whose contents will be used again. */
2961 extern struct gcpro
*gcprolist
;
2967 /* Address of first protected variable. */
2968 volatile Lisp_Object
*var
;
2970 /* Number of consecutive protected variables. */
2978 /* Values of GC_MARK_STACK during compilation:
2980 0 Use GCPRO as before
2981 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2982 2 Mark the stack, and check that everything GCPRO'd is
2984 3 Mark using GCPRO's, mark stack last, and count how many
2985 dead objects are kept alive.
2987 Formerly, method 0 was used. Currently, method 1 is used unless
2988 otherwise specified by hand when building, e.g.,
2989 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
2990 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
2992 #define GC_USE_GCPROS_AS_BEFORE 0
2993 #define GC_MAKE_GCPROS_NOOPS 1
2994 #define GC_MARK_STACK_CHECK_GCPROS 2
2995 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2997 #ifndef GC_MARK_STACK
2998 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
3001 /* Whether we do the stack marking manually. */
3002 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
3003 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
3006 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
3008 /* Do something silly with gcproN vars just so gcc shuts up. */
3009 /* You get warnings from MIPSPro... */
3011 #define GCPRO1(varname) ((void) gcpro1)
3012 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
3013 #define GCPRO3(varname1, varname2, varname3) \
3014 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
3015 #define GCPRO4(varname1, varname2, varname3, varname4) \
3016 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3017 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3018 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
3019 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3020 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
3022 #define UNGCPRO ((void) 0)
3024 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3028 #define GCPRO1(varname) \
3029 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3030 gcprolist = &gcpro1; }
3032 #define GCPRO2(varname1, varname2) \
3033 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3034 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3035 gcprolist = &gcpro2; }
3037 #define GCPRO3(varname1, varname2, varname3) \
3038 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3039 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3040 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3041 gcprolist = &gcpro3; }
3043 #define GCPRO4(varname1, varname2, varname3, varname4) \
3044 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3045 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3046 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3047 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3048 gcprolist = &gcpro4; }
3050 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3051 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3052 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3053 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3054 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3055 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3056 gcprolist = &gcpro5; }
3058 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3059 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3060 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3061 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3062 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3063 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3064 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3065 gcprolist = &gcpro6; }
3067 #define UNGCPRO (gcprolist = gcpro1.next)
3071 extern int gcpro_level
;
3073 #define GCPRO1(varname) \
3074 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
3075 gcpro1.level = gcpro_level++; \
3076 gcprolist = &gcpro1; }
3078 #define GCPRO2(varname1, varname2) \
3079 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3080 gcpro1.level = gcpro_level; \
3081 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3082 gcpro2.level = gcpro_level++; \
3083 gcprolist = &gcpro2; }
3085 #define GCPRO3(varname1, varname2, varname3) \
3086 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3087 gcpro1.level = gcpro_level; \
3088 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3089 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3090 gcpro3.level = gcpro_level++; \
3091 gcprolist = &gcpro3; }
3093 #define GCPRO4(varname1, varname2, varname3, varname4) \
3094 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3095 gcpro1.level = gcpro_level; \
3096 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3097 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3098 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3099 gcpro4.level = gcpro_level++; \
3100 gcprolist = &gcpro4; }
3102 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3103 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3104 gcpro1.level = gcpro_level; \
3105 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3106 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3107 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3108 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3109 gcpro5.level = gcpro_level++; \
3110 gcprolist = &gcpro5; }
3112 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3113 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3114 gcpro1.level = gcpro_level; \
3115 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3116 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3117 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3118 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3119 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3120 gcpro6.level = gcpro_level++; \
3121 gcprolist = &gcpro6; }
3124 ((--gcpro_level != gcpro1.level) \
3125 ? (emacs_abort (), 0) \
3126 : ((gcprolist = gcpro1.next), 0))
3128 #endif /* DEBUG_GCPRO */
3129 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3132 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
3133 #define RETURN_UNGCPRO(expr) \
3136 Lisp_Object ret_ungc_val; \
3137 ret_ungc_val = (expr); \
3139 return ret_ungc_val; \
3143 /* Call staticpro (&var) to protect static variable `var'. */
3145 void staticpro (Lisp_Object
*);
3147 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
3148 meaning as in the DEFUN macro, and is used to construct a prototype. */
3149 /* We can use the same trick as in the DEFUN macro to generate the
3150 appropriate prototype. */
3151 #define EXFUN(fnname, maxargs) \
3152 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
3154 #include "globals.h"
3156 /* Forward declarations for prototypes. */
3160 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3163 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3165 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3166 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3169 /* Functions to modify hash tables. */
3172 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3174 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3178 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3180 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3183 /* Use these functions to set Lisp_Object
3184 or pointer slots of struct Lisp_Symbol. */
3187 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3189 XSYMBOL (sym
)->function
= function
;
3193 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3195 XSYMBOL (sym
)->plist
= plist
;
3199 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3201 XSYMBOL (sym
)->next
= next
;
3204 /* Buffer-local (also frame-local) variable access functions. */
3207 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3209 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3213 /* Set overlay's property list. */
3216 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3218 XOVERLAY (overlay
)->plist
= plist
;
3221 /* Get text properties of S. */
3224 string_intervals (Lisp_Object s
)
3226 return XSTRING (s
)->intervals
;
3229 /* Set text properties of S to I. */
3232 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3234 XSTRING (s
)->intervals
= i
;
3237 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3238 of setting slots directly. */
3241 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3243 XCHAR_TABLE (table
)->defalt
= val
;
3246 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3248 XCHAR_TABLE (table
)->purpose
= val
;
3251 /* Set different slots in (sub)character tables. */
3254 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3256 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3257 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3261 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3263 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3264 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3268 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3270 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3273 /* Defined in data.c. */
3274 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
3275 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3276 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3277 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3278 extern Lisp_Object Qinvalid_read_syntax
;
3279 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3280 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3281 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3282 extern Lisp_Object Qtext_read_only
;
3283 extern Lisp_Object Qinteractive_form
;
3284 extern Lisp_Object Qcircular_list
;
3285 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
3286 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
3287 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
3288 extern Lisp_Object Qbuffer_or_string_p
;
3289 extern Lisp_Object Qfboundp
;
3290 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
3292 extern Lisp_Object Qcdr
;
3294 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3296 extern Lisp_Object Qfloatp
;
3297 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
3299 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3301 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
3303 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
3305 /* Defined in data.c. */
3306 extern Lisp_Object
indirect_function (Lisp_Object
);
3307 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3308 enum Arith_Comparison
{
3313 ARITH_LESS_OR_EQUAL
,
3316 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3317 enum Arith_Comparison comparison
);
3319 /* Convert the integer I to an Emacs representation, either the integer
3320 itself, or a cons of two or three integers, or if all else fails a float.
3321 I should not have side effects. */
3322 #define INTEGER_TO_CONS(i) \
3323 (! FIXNUM_OVERFLOW_P (i) \
3325 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3326 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3327 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3328 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3329 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3330 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3331 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3332 ? Fcons (make_number ((i) >> 16 >> 24), \
3333 Fcons (make_number ((i) >> 16 & 0xffffff), \
3334 make_number ((i) & 0xffff))) \
3337 /* Convert the Emacs representation CONS back to an integer of type
3338 TYPE, storing the result the variable VAR. Signal an error if CONS
3339 is not a valid representation or is out of range for TYPE. */
3340 #define CONS_TO_INTEGER(cons, type, var) \
3341 (TYPE_SIGNED (type) \
3342 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3343 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3344 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3345 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3347 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3348 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3349 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3351 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
3352 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3353 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3354 extern void syms_of_data (void);
3355 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3357 /* Defined in cmds.c */
3358 extern void syms_of_cmds (void);
3359 extern void keys_of_cmds (void);
3361 /* Defined in coding.c. */
3362 extern Lisp_Object Qcharset
;
3363 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3364 ptrdiff_t, bool, bool, Lisp_Object
);
3365 extern void init_coding (void);
3366 extern void init_coding_once (void);
3367 extern void syms_of_coding (void);
3369 /* Defined in character.c. */
3370 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
3371 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3372 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3373 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
3374 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
3375 extern void syms_of_character (void);
3377 /* Defined in charset.c. */
3378 extern void init_charset (void);
3379 extern void init_charset_once (void);
3380 extern void syms_of_charset (void);
3381 /* Structure forward declarations. */
3384 /* Defined in composite.c. */
3385 extern void syms_of_composite (void);
3387 /* Defined in syntax.c. */
3388 extern void init_syntax_once (void);
3389 extern void syms_of_syntax (void);
3391 /* Defined in fns.c. */
3392 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3393 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3394 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
3395 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3396 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3397 extern void sweep_weak_hash_tables (void);
3398 extern Lisp_Object Qcursor_in_echo_area
;
3399 extern Lisp_Object Qstring_lessp
;
3400 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3401 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3402 EMACS_UINT
sxhash (Lisp_Object
, int);
3403 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3404 Lisp_Object
, Lisp_Object
);
3405 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3406 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3408 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3410 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3411 ptrdiff_t, ptrdiff_t);
3412 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3413 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3414 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3415 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3416 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3417 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3418 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3419 extern void clear_string_char_byte_cache (void);
3420 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3421 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3422 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3423 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3424 extern void syms_of_fns (void);
3426 /* Defined in floatfns.c. */
3427 extern double extract_float (Lisp_Object
);
3428 extern void syms_of_floatfns (void);
3429 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3431 /* Defined in fringe.c. */
3432 extern void syms_of_fringe (void);
3433 extern void init_fringe (void);
3434 #ifdef HAVE_WINDOW_SYSTEM
3435 extern void mark_fringe_data (void);
3436 extern void init_fringe_once (void);
3437 #endif /* HAVE_WINDOW_SYSTEM */
3439 /* Defined in image.c. */
3440 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3441 extern Lisp_Object QCconversion
;
3442 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3443 extern void reset_image_types (void);
3444 extern void syms_of_image (void);
3446 /* Defined in insdel.c. */
3447 extern Lisp_Object Qinhibit_modification_hooks
;
3448 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3449 extern _Noreturn
void buffer_overflow (void);
3450 extern void make_gap (ptrdiff_t);
3451 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3452 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3453 ptrdiff_t, bool, bool);
3454 extern int count_combining_before (const unsigned char *,
3455 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3456 extern int count_combining_after (const unsigned char *,
3457 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3458 extern void insert (const char *, ptrdiff_t);
3459 extern void insert_and_inherit (const char *, ptrdiff_t);
3460 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3462 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3463 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3464 ptrdiff_t, ptrdiff_t, bool);
3465 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3466 extern void insert_char (int);
3467 extern void insert_string (const char *);
3468 extern void insert_before_markers (const char *, ptrdiff_t);
3469 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3470 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3471 ptrdiff_t, ptrdiff_t,
3473 extern void del_range (ptrdiff_t, ptrdiff_t);
3474 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3475 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3476 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3477 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3478 ptrdiff_t, ptrdiff_t, bool);
3479 extern void modify_text (ptrdiff_t, ptrdiff_t);
3480 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3481 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3482 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3483 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3484 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3485 ptrdiff_t, ptrdiff_t);
3486 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3487 ptrdiff_t, ptrdiff_t);
3488 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3489 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3490 const char *, ptrdiff_t, ptrdiff_t, bool);
3491 extern void syms_of_insdel (void);
3493 /* Defined in dispnew.c. */
3494 #if (defined PROFILING \
3495 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3496 _Noreturn
void __executable_start (void);
3498 extern Lisp_Object Vwindow_system
;
3499 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3500 extern void init_display (void);
3501 extern void syms_of_display (void);
3503 /* Defined in xdisp.c. */
3504 extern Lisp_Object Qinhibit_point_motion_hooks
;
3505 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
3506 extern Lisp_Object Qmenu_bar_update_hook
;
3507 extern Lisp_Object Qwindow_scroll_functions
;
3508 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3509 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3510 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3511 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
3512 extern Lisp_Object Qleft_margin
, Qright_margin
;
3513 extern Lisp_Object QCdata
, QCfile
;
3514 extern Lisp_Object QCmap
;
3515 extern Lisp_Object Qrisky_local_variable
;
3516 extern bool noninteractive_need_newline
;
3517 extern Lisp_Object echo_area_buffer
[2];
3518 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3519 extern void check_message_stack (void);
3520 extern void setup_echo_area_for_printing (int);
3521 extern bool push_message (void);
3522 extern void pop_message_unwind (void);
3523 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3524 extern void restore_message (void);
3525 extern Lisp_Object
current_message (void);
3526 extern void clear_message (int, int);
3527 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3528 extern void message1 (const char *);
3529 extern void message1_nolog (const char *);
3530 extern void message3 (Lisp_Object
);
3531 extern void message3_nolog (Lisp_Object
);
3532 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3533 extern void message_with_string (const char *, Lisp_Object
, int);
3534 extern void message_log_maybe_newline (void);
3535 extern void update_echo_area (void);
3536 extern void truncate_echo_area (ptrdiff_t);
3537 extern void redisplay (void);
3538 extern void redisplay_preserve_echo_area (int);
3540 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3541 extern void syms_of_xdisp (void);
3542 extern void init_xdisp (void);
3543 extern Lisp_Object
safe_eval (Lisp_Object
);
3544 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3545 int *, int *, int *, int *, int *);
3547 /* Defined in xsettings.c. */
3548 extern void syms_of_xsettings (void);
3550 /* Defined in vm-limit.c. */
3551 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3553 /* Defined in alloc.c. */
3554 extern void check_pure_size (void);
3555 extern void free_misc (Lisp_Object
);
3556 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3557 extern void malloc_warning (const char *);
3558 extern _Noreturn
void memory_full (size_t);
3559 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3560 extern bool survives_gc_p (Lisp_Object
);
3561 extern void mark_object (Lisp_Object
);
3562 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3563 extern void refill_memory_reserve (void);
3565 extern const char *pending_malloc_warning
;
3566 extern Lisp_Object zero_vector
;
3567 extern Lisp_Object
*stack_base
;
3568 extern EMACS_INT consing_since_gc
;
3569 extern EMACS_INT gc_relative_threshold
;
3570 extern EMACS_INT memory_full_cons_threshold
;
3571 extern Lisp_Object
list1 (Lisp_Object
);
3572 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3573 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3574 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3575 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3577 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3578 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3580 /* Build a frequently used 2/3/4-integer lists. */
3583 list2i (EMACS_INT x
, EMACS_INT y
)
3585 return list2 (make_number (x
), make_number (y
));
3589 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3591 return list3 (make_number (x
), make_number (y
), make_number (w
));
3595 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3597 return list4 (make_number (x
), make_number (y
),
3598 make_number (w
), make_number (h
));
3601 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3602 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3603 extern _Noreturn
void string_overflow (void);
3604 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3605 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3606 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3607 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3609 /* Make unibyte string from C string when the length isn't known. */
3612 build_unibyte_string (const char *str
)
3614 return make_unibyte_string (str
, strlen (str
));
3617 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3618 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3619 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3620 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3621 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3622 extern Lisp_Object
make_specified_string (const char *,
3623 ptrdiff_t, ptrdiff_t, bool);
3624 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3625 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3627 /* Make a string allocated in pure space, use STR as string data. */
3630 build_pure_c_string (const char *str
)
3632 return make_pure_c_string (str
, strlen (str
));
3635 /* Make a string from the data at STR, treating it as multibyte if the
3639 build_string (const char *str
)
3641 return make_string (str
, strlen (str
));
3644 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3645 extern void make_byte_code (struct Lisp_Vector
*);
3646 extern Lisp_Object Qautomatic_gc
;
3647 extern Lisp_Object Qchar_table_extra_slots
;
3648 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3650 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3651 be sure that GC cannot happen until the vector is completely
3652 initialized. E.g. the following code is likely to crash:
3654 v = make_uninit_vector (3);
3656 ASET (v, 1, Ffunction_can_gc ());
3657 ASET (v, 2, obj1); */
3660 make_uninit_vector (ptrdiff_t size
)
3663 struct Lisp_Vector
*p
;
3665 p
= allocate_vector (size
);
3670 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3671 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3673 allocate_pseudovector \
3674 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3675 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3676 extern struct window
*allocate_window (void);
3677 extern struct frame
*allocate_frame (void);
3678 extern struct Lisp_Process
*allocate_process (void);
3679 extern struct terminal
*allocate_terminal (void);
3680 extern bool gc_in_progress
;
3681 extern bool abort_on_gc
;
3682 extern Lisp_Object
make_float (double);
3683 extern void display_malloc_warning (void);
3684 extern ptrdiff_t inhibit_garbage_collection (void);
3685 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3686 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3687 Lisp_Object
, Lisp_Object
);
3688 extern Lisp_Object
make_save_ptr (void *);
3689 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3690 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3691 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3693 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3694 extern void free_save_value (Lisp_Object
);
3695 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3696 extern void free_marker (Lisp_Object
);
3697 extern void free_cons (struct Lisp_Cons
*);
3698 extern void init_alloc_once (void);
3699 extern void init_alloc (void);
3700 extern void syms_of_alloc (void);
3701 extern struct buffer
* allocate_buffer (void);
3702 extern int valid_lisp_object_p (Lisp_Object
);
3703 #ifdef GC_CHECK_CONS_LIST
3704 extern void check_cons_list (void);
3706 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3710 /* Defined in ralloc.c. */
3711 extern void *r_alloc (void **, size_t);
3712 extern void r_alloc_free (void **);
3713 extern void *r_re_alloc (void **, size_t);
3714 extern void r_alloc_reset_variable (void **, void **);
3715 extern void r_alloc_inhibit_buffer_relocation (int);
3718 /* Defined in chartab.c. */
3719 extern Lisp_Object
copy_char_table (Lisp_Object
);
3720 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
3721 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3723 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3724 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3725 extern int char_table_translate (Lisp_Object
, int);
3726 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3728 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3729 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3730 Lisp_Object
, Lisp_Object
,
3731 Lisp_Object
, struct charset
*,
3732 unsigned, unsigned);
3733 extern Lisp_Object
uniprop_table (Lisp_Object
);
3734 extern void syms_of_chartab (void);
3736 /* Defined in print.c. */
3737 extern Lisp_Object Vprin1_to_string_buffer
;
3738 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3739 extern Lisp_Object Qstandard_output
;
3740 extern Lisp_Object Qexternal_debugging_output
;
3741 extern void temp_output_buffer_setup (const char *);
3742 extern int print_level
;
3743 extern Lisp_Object Qprint_escape_newlines
;
3744 extern void write_string (const char *, int);
3745 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3747 extern Lisp_Object internal_with_output_to_temp_buffer
3748 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3749 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3750 extern int float_to_string (char *, double);
3751 extern void init_print_once (void);
3752 extern void syms_of_print (void);
3754 /* Defined in doprnt.c. */
3755 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3757 extern ptrdiff_t esprintf (char *, char const *, ...)
3758 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3759 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3761 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3762 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3763 char const *, va_list)
3764 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3766 /* Defined in lread.c. */
3767 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3768 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3769 extern Lisp_Object Qlexical_binding
;
3770 extern Lisp_Object
check_obarray (Lisp_Object
);
3771 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3772 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3773 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3775 LOADHIST_ATTACH (Lisp_Object x
)
3778 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3780 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3781 Lisp_Object
*, Lisp_Object
);
3782 extern Lisp_Object
string_to_number (char const *, int, bool);
3783 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3785 extern void dir_warning (const char *, Lisp_Object
);
3786 extern void init_obarray (void);
3787 extern void init_lread (void);
3788 extern void syms_of_lread (void);
3791 intern (const char *str
)
3793 return intern_1 (str
, strlen (str
));
3797 intern_c_string (const char *str
)
3799 return intern_c_string_1 (str
, strlen (str
));
3802 /* Defined in eval.c. */
3803 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3804 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3805 extern Lisp_Object Qand_rest
;
3806 extern Lisp_Object Vautoload_queue
;
3807 extern Lisp_Object Vsignaling_function
;
3808 extern Lisp_Object inhibit_lisp_code
;
3809 extern struct handler
*handlerlist
;
3811 /* To run a normal hook, use the appropriate function from the list below.
3812 The calling convention:
3814 if (!NILP (Vrun_hooks))
3815 call1 (Vrun_hooks, Qmy_funny_hook);
3817 should no longer be used. */
3818 extern Lisp_Object Vrun_hooks
;
3819 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3820 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3821 Lisp_Object (*funcall
)
3822 (ptrdiff_t nargs
, Lisp_Object
*args
));
3823 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3824 extern _Noreturn
void xsignal0 (Lisp_Object
);
3825 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3826 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3827 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3829 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3830 extern Lisp_Object
eval_sub (Lisp_Object form
);
3831 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3832 extern Lisp_Object
call0 (Lisp_Object
);
3833 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3834 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3835 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3836 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3837 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3838 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3839 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3840 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3841 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3842 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3843 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3844 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3845 extern Lisp_Object internal_condition_case_n
3846 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3847 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3848 extern void specbind (Lisp_Object
, Lisp_Object
);
3849 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3850 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3851 extern void record_unwind_protect_int (void (*) (int), int);
3852 extern void record_unwind_protect_void (void (*) (void));
3853 extern void record_unwind_protect_nothing (void);
3854 extern void clear_unwind_protect (ptrdiff_t);
3855 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3856 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3857 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3858 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3859 extern _Noreturn
void verror (const char *, va_list)
3860 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3861 extern void un_autoload (Lisp_Object
);
3862 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3863 extern void init_eval_once (void);
3864 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3865 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3866 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3867 extern void init_eval (void);
3868 extern void syms_of_eval (void);
3869 extern void unwind_body (Lisp_Object
);
3870 extern void record_in_backtrace (Lisp_Object function
,
3871 Lisp_Object
*args
, ptrdiff_t nargs
);
3872 extern void mark_specpdl (void);
3873 extern void get_backtrace (Lisp_Object array
);
3874 Lisp_Object
backtrace_top_function (void);
3875 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3876 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3879 /* Defined in editfns.c. */
3880 extern Lisp_Object Qfield
;
3881 extern void insert1 (Lisp_Object
);
3882 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3883 extern Lisp_Object
save_excursion_save (void);
3884 extern Lisp_Object
save_restriction_save (void);
3885 extern void save_excursion_restore (Lisp_Object
);
3886 extern void save_restriction_restore (Lisp_Object
);
3887 extern _Noreturn
void time_overflow (void);
3888 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3889 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3891 extern void init_editfns (void);
3892 extern void syms_of_editfns (void);
3893 extern void set_time_zone_rule (const char *);
3895 /* Defined in buffer.c. */
3896 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3897 extern _Noreturn
void nsberror (Lisp_Object
);
3898 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3899 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3900 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3901 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3902 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3903 extern bool overlay_touches_p (ptrdiff_t);
3904 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3905 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3906 extern void init_buffer_once (void);
3907 extern void init_buffer (void);
3908 extern void syms_of_buffer (void);
3909 extern void keys_of_buffer (void);
3911 /* Defined in marker.c. */
3913 extern ptrdiff_t marker_position (Lisp_Object
);
3914 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3915 extern void clear_charpos_cache (struct buffer
*);
3916 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3917 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3918 extern void unchain_marker (struct Lisp_Marker
*marker
);
3919 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3920 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3921 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3922 ptrdiff_t, ptrdiff_t);
3923 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3924 extern void syms_of_marker (void);
3926 /* Defined in fileio.c. */
3928 extern Lisp_Object Qfile_error
;
3929 extern Lisp_Object Qfile_notify_error
;
3930 extern Lisp_Object Qfile_exists_p
;
3931 extern Lisp_Object Qfile_directory_p
;
3932 extern Lisp_Object Qinsert_file_contents
;
3933 extern Lisp_Object Qfile_name_history
;
3934 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3935 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3936 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3938 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3939 extern void close_file_unwind (int);
3940 extern void fclose_unwind (void *);
3941 extern void restore_point_unwind (Lisp_Object
);
3942 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3943 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3944 extern bool internal_delete_file (Lisp_Object
);
3945 extern Lisp_Object
emacs_readlinkat (int, const char *);
3946 extern bool file_directory_p (const char *);
3947 extern bool file_accessible_directory_p (const char *);
3948 extern void init_fileio (void);
3949 extern void syms_of_fileio (void);
3950 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3951 extern Lisp_Object Qdelete_file
;
3953 /* Defined in search.c. */
3954 extern void shrink_regexp_cache (void);
3955 extern void restore_search_regs (void);
3956 extern void record_unwind_save_match_data (void);
3957 struct re_registers
;
3958 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3959 struct re_registers
*,
3960 Lisp_Object
, bool, bool);
3961 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3962 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3964 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3965 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3966 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3967 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3968 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3969 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3971 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3972 ptrdiff_t, ptrdiff_t *);
3973 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3974 ptrdiff_t, ptrdiff_t *);
3975 extern void syms_of_search (void);
3976 extern void clear_regexp_cache (void);
3978 /* Defined in minibuf.c. */
3980 extern Lisp_Object Qcompletion_ignore_case
;
3981 extern Lisp_Object Vminibuffer_list
;
3982 extern Lisp_Object last_minibuf_string
;
3983 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3984 extern void init_minibuf_once (void);
3985 extern void syms_of_minibuf (void);
3987 /* Defined in callint.c. */
3989 extern Lisp_Object Qminus
, Qplus
;
3990 extern Lisp_Object Qwhen
;
3991 extern Lisp_Object Qmouse_leave_buffer_hook
;
3992 extern void syms_of_callint (void);
3994 /* Defined in casefiddle.c. */
3996 extern Lisp_Object Qidentity
;
3997 extern void syms_of_casefiddle (void);
3998 extern void keys_of_casefiddle (void);
4000 /* Defined in casetab.c. */
4002 extern void init_casetab_once (void);
4003 extern void syms_of_casetab (void);
4005 /* Defined in keyboard.c. */
4007 extern Lisp_Object echo_message_buffer
;
4008 extern struct kboard
*echo_kboard
;
4009 extern void cancel_echoing (void);
4010 extern Lisp_Object Qdisabled
, QCfilter
;
4011 extern Lisp_Object Qup
, Qdown
, Qbottom
;
4012 extern Lisp_Object Qtop
;
4013 extern Lisp_Object last_undo_boundary
;
4014 extern bool input_pending
;
4015 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4016 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4017 extern void discard_mouse_events (void);
4019 void handle_input_available_signal (int);
4021 extern Lisp_Object pending_funcalls
;
4022 extern bool detect_input_pending (void);
4023 extern bool detect_input_pending_ignore_squeezables (void);
4024 extern bool detect_input_pending_run_timers (bool);
4025 extern void safe_run_hooks (Lisp_Object
);
4026 extern void cmd_error_internal (Lisp_Object
, const char *);
4027 extern Lisp_Object
command_loop_1 (void);
4028 extern Lisp_Object
read_menu_command (void);
4029 extern Lisp_Object
recursive_edit_1 (void);
4030 extern void record_auto_save (void);
4031 extern void force_auto_save_soon (void);
4032 extern void init_keyboard (void);
4033 extern void syms_of_keyboard (void);
4034 extern void keys_of_keyboard (void);
4036 /* Defined in indent.c. */
4037 extern ptrdiff_t current_column (void);
4038 extern void invalidate_current_column (void);
4039 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4040 extern void syms_of_indent (void);
4042 /* Defined in frame.c. */
4043 extern Lisp_Object Qonly
, Qnone
;
4044 extern Lisp_Object Qvisible
;
4045 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4046 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4047 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4048 #if HAVE_NS || defined WINDOWSNT
4049 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4051 extern void frames_discard_buffer (Lisp_Object
);
4052 extern void syms_of_frame (void);
4054 /* Defined in emacs.c. */
4055 extern char **initial_argv
;
4056 extern int initial_argc
;
4057 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4058 extern bool display_arg
;
4060 extern Lisp_Object
decode_env_path (const char *, const char *);
4061 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4062 extern Lisp_Object Qfile_name_handler_alist
;
4063 extern _Noreturn
void terminate_due_to_signal (int, int);
4064 extern Lisp_Object Qkill_emacs
;
4066 extern Lisp_Object Vlibrary_cache
;
4069 void fixup_locale (void);
4070 void synchronize_system_messages_locale (void);
4071 void synchronize_system_time_locale (void);
4073 INLINE
void fixup_locale (void) {}
4074 INLINE
void synchronize_system_messages_locale (void) {}
4075 INLINE
void synchronize_system_time_locale (void) {}
4077 extern void shut_down_emacs (int, Lisp_Object
);
4079 /* True means don't do interactive redisplay and don't change tty modes. */
4080 extern bool noninteractive
;
4082 /* True means remove site-lisp directories from load-path. */
4083 extern bool no_site_lisp
;
4085 /* Pipe used to send exit notification to the daemon parent at
4087 extern int daemon_pipe
[2];
4088 #define IS_DAEMON (daemon_pipe[1] != 0)
4090 /* True if handling a fatal error already. */
4091 extern bool fatal_error_in_progress
;
4093 /* True means don't do use window-system-specific display code. */
4094 extern bool inhibit_window_system
;
4095 /* True means that a filter or a sentinel is running. */
4096 extern bool running_asynch_code
;
4098 /* Defined in process.c. */
4099 extern Lisp_Object QCtype
, Qlocal
;
4100 extern Lisp_Object Qprocessp
;
4101 extern void kill_buffer_processes (Lisp_Object
);
4102 extern bool wait_reading_process_output (intmax_t, int, int, bool,
4104 struct Lisp_Process
*,
4106 /* Max value for the first argument of wait_reading_process_output. */
4107 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4108 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4109 The bug merely causes a bogus warning, but the warning is annoying. */
4110 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4112 # define WAIT_READING_MAX INTMAX_MAX
4114 extern void add_keyboard_wait_descriptor (int);
4115 extern void delete_keyboard_wait_descriptor (int);
4117 extern void add_gpm_wait_descriptor (int);
4118 extern void delete_gpm_wait_descriptor (int);
4120 extern void init_process_emacs (void);
4121 extern void syms_of_process (void);
4122 extern void setup_process_coding_systems (Lisp_Object
);
4124 /* Defined in callproc.c. */
4128 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4129 extern void init_callproc_1 (void);
4130 extern void init_callproc (void);
4131 extern void set_initial_environment (void);
4132 extern void syms_of_callproc (void);
4134 /* Defined in doc.c. */
4135 extern Lisp_Object Qfunction_documentation
;
4136 extern Lisp_Object
read_doc_string (Lisp_Object
);
4137 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4138 extern void syms_of_doc (void);
4139 extern int read_bytecode_char (bool);
4141 /* Defined in bytecode.c. */
4142 extern void syms_of_bytecode (void);
4143 extern struct byte_stack
*byte_stack_list
;
4145 extern void mark_byte_stack (void);
4147 extern void unmark_byte_stack (void);
4148 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4149 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4151 /* Defined in macros.c. */
4152 extern void init_macros (void);
4153 extern void syms_of_macros (void);
4155 /* Defined in undo.c. */
4156 extern Lisp_Object Qapply
;
4157 extern Lisp_Object Qinhibit_read_only
;
4158 extern void truncate_undo_list (struct buffer
*);
4159 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
4160 extern void record_insert (ptrdiff_t, ptrdiff_t);
4161 extern void record_delete (ptrdiff_t, Lisp_Object
);
4162 extern void record_first_change (void);
4163 extern void record_change (ptrdiff_t, ptrdiff_t);
4164 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4165 Lisp_Object
, Lisp_Object
,
4167 extern void syms_of_undo (void);
4168 /* Defined in textprop.c. */
4169 extern Lisp_Object Qfont
, Qmouse_face
;
4170 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
4171 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
4172 extern Lisp_Object Qminibuffer_prompt
;
4174 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4176 /* Defined in menu.c. */
4177 extern void syms_of_menu (void);
4179 /* Defined in xmenu.c. */
4180 extern void syms_of_xmenu (void);
4182 /* Defined in termchar.h. */
4183 struct tty_display_info
;
4185 /* Defined in termhooks.h. */
4188 /* Defined in sysdep.c. */
4189 #ifndef HAVE_GET_CURRENT_DIR_NAME
4190 extern char *get_current_dir_name (void);
4192 extern void stuff_char (char c
);
4193 extern void init_foreground_group (void);
4194 extern void init_sigio (int);
4195 extern void sys_subshell (void);
4196 extern void sys_suspend (void);
4197 extern void discard_tty_input (void);
4198 extern void block_tty_out_signal (void);
4199 extern void unblock_tty_out_signal (void);
4200 extern void init_sys_modes (struct tty_display_info
*);
4201 extern void reset_sys_modes (struct tty_display_info
*);
4202 extern void init_all_sys_modes (void);
4203 extern void reset_all_sys_modes (void);
4204 extern void child_setup_tty (int);
4205 extern void setup_pty (int);
4206 extern int set_window_size (int, int, int);
4207 extern EMACS_INT
get_random (void);
4208 extern void seed_random (void *, ptrdiff_t);
4209 extern void init_random (void);
4210 extern void emacs_backtrace (int);
4211 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4212 extern int emacs_open (const char *, int, int);
4213 extern int emacs_pipe (int[2]);
4214 extern int emacs_close (int);
4215 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4216 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4217 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4218 extern void emacs_perror (char const *);
4220 extern void unlock_all_files (void);
4221 extern void lock_file (Lisp_Object
);
4222 extern void unlock_file (Lisp_Object
);
4223 extern void unlock_buffer (struct buffer
*);
4224 extern void syms_of_filelock (void);
4226 /* Defined in sound.c. */
4227 extern void syms_of_sound (void);
4229 /* Defined in category.c. */
4230 extern void init_category_once (void);
4231 extern Lisp_Object
char_category_set (int);
4232 extern void syms_of_category (void);
4234 /* Defined in ccl.c. */
4235 extern void syms_of_ccl (void);
4237 /* Defined in dired.c. */
4238 extern void syms_of_dired (void);
4239 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4240 Lisp_Object
, Lisp_Object
,
4243 /* Defined in term.c. */
4244 extern int *char_ins_del_vector
;
4245 extern void syms_of_term (void);
4246 extern _Noreturn
void fatal (const char *msgid
, ...)
4247 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4249 /* Defined in terminal.c. */
4250 extern void syms_of_terminal (void);
4252 /* Defined in font.c. */
4253 extern void syms_of_font (void);
4254 extern void init_font (void);
4256 #ifdef HAVE_WINDOW_SYSTEM
4257 /* Defined in fontset.c. */
4258 extern void syms_of_fontset (void);
4260 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4261 extern Lisp_Object Qfont_param
;
4264 /* Defined in gfilenotify.c */
4265 #ifdef HAVE_GFILENOTIFY
4266 extern void globals_of_gfilenotify (void);
4267 extern void syms_of_gfilenotify (void);
4270 /* Defined in inotify.c */
4272 extern void syms_of_inotify (void);
4275 #ifdef HAVE_W32NOTIFY
4276 /* Defined on w32notify.c. */
4277 extern void syms_of_w32notify (void);
4280 /* Defined in xfaces.c. */
4281 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
4282 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
4283 extern Lisp_Object Qmode_line_inactive
;
4284 extern Lisp_Object Qface
;
4285 extern Lisp_Object Qnormal
;
4286 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4287 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4288 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4289 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4290 extern Lisp_Object Qoblique
, Qitalic
;
4291 extern Lisp_Object Vface_alternative_font_family_alist
;
4292 extern Lisp_Object Vface_alternative_font_registry_alist
;
4293 extern void syms_of_xfaces (void);
4295 #ifdef HAVE_X_WINDOWS
4296 /* Defined in xfns.c. */
4297 extern void syms_of_xfns (void);
4299 /* Defined in xsmfns.c. */
4300 extern void syms_of_xsmfns (void);
4302 /* Defined in xselect.c. */
4303 extern void syms_of_xselect (void);
4305 /* Defined in xterm.c. */
4306 extern void syms_of_xterm (void);
4307 #endif /* HAVE_X_WINDOWS */
4309 #ifdef HAVE_WINDOW_SYSTEM
4310 /* Defined in xterm.c, nsterm.m, w32term.c. */
4311 extern char *x_get_keysym_name (int);
4312 #endif /* HAVE_WINDOW_SYSTEM */
4315 /* Defined in xml.c. */
4316 extern void syms_of_xml (void);
4317 extern void xml_cleanup_parser (void);
4321 /* Defined in decompress.c. */
4322 extern void syms_of_decompress (void);
4326 /* Defined in dbusbind.c. */
4327 void syms_of_dbusbind (void);
4331 /* Defined in profiler.c. */
4332 extern bool profiler_memory_running
;
4333 extern void malloc_probe (size_t);
4334 extern void syms_of_profiler (void);
4338 /* Defined in msdos.c, w32.c. */
4339 extern char *emacs_root_dir (void);
4342 /* True means Emacs has already been initialized.
4343 Used during startup to detect startup of dumped Emacs. */
4344 extern bool initialized
;
4346 /* True means ^G can quit instantly. */
4347 extern bool immediate_quit
;
4349 extern void *xmalloc (size_t);
4350 extern void *xzalloc (size_t);
4351 extern void *xrealloc (void *, size_t);
4352 extern void xfree (void *);
4353 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
4354 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
4355 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4357 extern char *xstrdup (const char *);
4358 extern char *xlispstrdup (Lisp_Object
);
4359 extern void xputenv (const char *);
4361 extern char *egetenv (const char *);
4363 /* Copy Lisp string to temporary (allocated on stack) C string. */
4365 #define xlispstrdupa(string) \
4366 memcpy (alloca (SBYTES (string) + 1), \
4367 SSDATA (string), SBYTES (string) + 1)
4369 /* Set up the name of the machine we're running on. */
4370 extern void init_system_name (void);
4372 /* Return the absolute value of X. X should be a signed integer
4373 expression without side effects, and X's absolute value should not
4374 exceed the maximum for its promoted type. This is called 'eabs'
4375 because 'abs' is reserved by the C standard. */
4376 #define eabs(x) ((x) < 0 ? -(x) : (x))
4378 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4381 #define make_fixnum_or_float(val) \
4382 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4384 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4385 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4387 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4389 extern void *record_xmalloc (size_t);
4391 #define USE_SAFE_ALLOCA \
4392 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
4394 /* SAFE_ALLOCA allocates a simple buffer. */
4396 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4398 : (sa_must_free = 1, record_xmalloc (size)))
4400 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4401 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4402 positive. The code is tuned for MULTIPLIER being a constant. */
4404 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4406 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4407 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4410 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4412 record_unwind_protect_ptr (xfree, buf); \
4416 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4418 #define SAFE_FREE() \
4420 if (sa_must_free) { \
4422 unbind_to (sa_count, Qnil); \
4427 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4429 #define SAFE_ALLOCA_LISP(buf, nelt) \
4431 if ((nelt) < MAX_ALLOCA / word_size) \
4432 buf = alloca ((nelt) * word_size); \
4433 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4436 buf = xmalloc ((nelt) * word_size); \
4437 arg_ = make_save_memory (buf, nelt); \
4439 record_unwind_protect (free_save_value, arg_); \
4442 memory_full (SIZE_MAX); \
4445 /* Do a `for' loop over alist values. */
4447 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4448 for (list_var = head_var; \
4449 (CONSP (list_var) && (value_var = XCDR (XCAR (list_var)), 1)); \
4450 list_var = XCDR (list_var))
4452 /* Check whether it's time for GC, and run it if so. */
4457 if ((consing_since_gc
> gc_cons_threshold
4458 && consing_since_gc
> gc_relative_threshold
)
4459 || (!NILP (Vmemory_full
)
4460 && consing_since_gc
> memory_full_cons_threshold
))
4461 Fgarbage_collect ();
4465 functionp (Lisp_Object object
)
4467 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4469 object
= Findirect_function (object
, Qt
);
4471 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4473 /* Autoloaded symbols are functions, except if they load
4474 macros or keymaps. */
4476 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4477 object
= XCDR (object
);
4479 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4484 return XSUBR (object
)->max_args
!= UNEVALLED
;
4485 else if (COMPILEDP (object
))
4487 else if (CONSP (object
))
4489 Lisp_Object car
= XCAR (object
);
4490 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4498 #endif /* EMACS_LISP_H */