1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
34 # define LISP_INLINE INLINE
37 /* The ubiquitous max and min macros. */
40 #define max(a, b) ((a) > (b) ? (a) : (b))
41 #define min(a, b) ((a) < (b) ? (a) : (b))
43 /* EMACS_INT - signed integer wide enough to hold an Emacs value
44 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
45 pI - printf length modifier for EMACS_INT
46 EMACS_UINT - unsigned variant of EMACS_INT */
48 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
49 typedef long long int EMACS_INT
;
50 typedef unsigned long long int EMACS_UINT
;
51 # define EMACS_INT_MAX LLONG_MAX
53 # elif INT_MAX < LONG_MAX
54 typedef long int EMACS_INT
;
55 typedef unsigned long int EMACS_UINT
;
56 # define EMACS_INT_MAX LONG_MAX
59 typedef int EMACS_INT
;
60 typedef unsigned int EMACS_UINT
;
61 # define EMACS_INT_MAX INT_MAX
66 /* Number of bits in some machine integer types. */
69 BITS_PER_CHAR
= CHAR_BIT
,
70 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
71 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
72 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
73 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
76 /* printmax_t and uprintmax_t are types for printing large integers.
77 These are the widest integers that are supported for printing.
78 pMd etc. are conversions for printing them.
79 On C99 hosts, there's no problem, as even the widest integers work.
80 Fall back on EMACS_INT on pre-C99 hosts. */
82 typedef intmax_t printmax_t
;
83 typedef uintmax_t uprintmax_t
;
87 typedef EMACS_INT printmax_t
;
88 typedef EMACS_UINT uprintmax_t
;
93 /* Use pD to format ptrdiff_t values, which suffice for indexes into
94 buffers and strings. Emacs never allocates objects larger than
95 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
96 In C99, pD can always be "t"; configure it here for the sake of
97 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
98 #if PTRDIFF_MAX == INT_MAX
100 #elif PTRDIFF_MAX == LONG_MAX
102 #elif PTRDIFF_MAX == LLONG_MAX
108 /* Extra internal type checking? */
110 /* Define an Emacs version of 'assert (COND)', since some
111 system-defined 'assert's are flaky. COND should be free of side
112 effects; it may or may not be evaluated. */
113 #ifndef ENABLE_CHECKING
114 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
115 #else /* ENABLE_CHECKING */
117 extern _Noreturn
void die (const char *, const char *, int);
119 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
120 it to 1 using a debugger to temporarily disable aborting on
121 detected internal inconsistencies or error conditions.
123 In some cases, a good compiler may be able to optimize away the
124 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
125 STRINGP (x), but a particular use of XSTRING is invoked only after
126 testing that STRINGP (x) is true, making the test redundant. */
127 extern bool suppress_checking EXTERNALLY_VISIBLE
;
129 # define eassert(cond) \
130 ((cond) || suppress_checking \
132 : die ("assertion failed: " # cond, __FILE__, __LINE__))
133 #endif /* ENABLE_CHECKING */
135 /* Use the configure flag --enable-check-lisp-object-type to make
136 Lisp_Object use a struct type instead of the default int. The flag
137 causes CHECK_LISP_OBJECT_TYPE to be defined. */
139 /***** Select the tagging scheme. *****/
140 /* The following option controls the tagging scheme:
141 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
142 always 0, and we can thus use them to hold tag bits, without
143 restricting our addressing space.
145 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
146 restricting our possible address range.
148 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
149 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
150 on the few static Lisp_Objects used: all the defsubr as well
151 as the two special buffers buffer_defaults and buffer_local_symbols. */
155 /* Number of bits in a Lisp_Object tag. This can be used in #if,
156 and for GDB's sake also as a regular symbol. */
161 /* 2**GCTYPEBITS. This must also be a macro that expands to a
162 literal integer constant, for MSVC. */
164 #define GCALIGNMENT 8
167 /* Number of bits in a Lisp_Object value, not counting the tag. */
168 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
170 /* Number of bits in a Lisp fixnum tag. */
171 INTTYPEBITS
= GCTYPEBITS
- 1,
173 /* Number of bits in a Lisp fixnum value, not counting the tag. */
174 FIXNUM_BITS
= VALBITS
+ 1
177 #if GCALIGNMENT != 1 << GCTYPEBITS
178 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
181 /* The maximum value that can be stored in a EMACS_INT, assuming all
182 bits other than the type bits contribute to a nonnegative signed value.
183 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
184 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
186 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
188 /* 1. We know malloc returns a multiple of 8. */
189 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
190 || defined DARWIN_OS || defined __sun)
191 /* 2. We can specify multiple-of-8 alignment on static variables. */
193 /* 3. Pointers-as-ints exceed VAL_MAX.
194 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
195 a. unnecessary, because the top bits of an EMACS_INT are unused, and
196 b. slower, because it typically requires extra masking.
197 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
198 # if VAL_MAX < UINTPTR_MAX
199 # define USE_LSB_TAG 1
206 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
207 # define USE_LSB_TAG 1
209 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
210 # define USE_LSB_TAG 0
214 # define alignas(alignment) /* empty */
216 # error "USE_LSB_TAG requires alignas"
221 /* Define the fundamental Lisp data structures. */
223 /* This is the set of Lisp data types. */
225 /* Lisp integers use 2 tags, to give them one extra bit, thus
226 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
227 static EMACS_INT
const INTMASK
= EMACS_INT_MAX
>> (INTTYPEBITS
- 1);
228 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
229 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
231 /* Stolen from GDB. The only known compiler that doesn't support
232 enums in bitfields is MSVC. */
234 #define ENUM_BF(TYPE) unsigned int
236 #define ENUM_BF(TYPE) enum TYPE
242 /* Integer. XINT (obj) is the integer value. */
244 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
246 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
249 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
250 whose first member indicates the subtype. */
253 /* String. XSTRING (object) points to a struct Lisp_String.
254 The length of the string, and its contents, are stored therein. */
255 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
257 /* Vector of Lisp objects, or something resembling it.
258 XVECTOR (object) points to a struct Lisp_Vector, which contains
259 the size and contents. The size field also contains the type
260 information, if it's not a real vector object. */
263 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
269 /* This is the set of data types that share a common structure.
270 The first member of the structure is a type code from this set.
271 The enum values are arbitrary, but we'll use large numbers to make it
272 more likely that we'll spot the error if a random word in memory is
273 mistakenly interpreted as a Lisp_Misc. */
276 Lisp_Misc_Free
= 0x5eab,
279 Lisp_Misc_Save_Value
,
280 /* Currently floats are not a misc type,
281 but let's define this in case we want to change that. */
283 /* This is not a type code. It is for range checking. */
287 /* These are the types of forwarding objects used in the value slot
288 of symbols for special built-in variables whose value is stored in
292 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
293 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
294 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
295 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
296 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
299 #ifdef CHECK_LISP_OBJECT_TYPE
301 typedef struct { EMACS_INT i
; } Lisp_Object
;
304 LISP_INLINE Lisp_Object
307 Lisp_Object o
= { i
};
311 LISP_INLINE Lisp_Object
312 LISP_MAKE_RVALUE (Lisp_Object o
)
317 #define LISP_INITIALLY_ZERO {0}
319 #undef CHECK_LISP_OBJECT_TYPE
320 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
321 #else /* CHECK_LISP_OBJECT_TYPE */
323 /* If a struct type is not wanted, define Lisp_Object as just a number. */
325 typedef EMACS_INT Lisp_Object
;
328 #define LISP_MAKE_RVALUE(o) (0+(o))
329 #define LISP_INITIALLY_ZERO 0
330 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
331 #endif /* CHECK_LISP_OBJECT_TYPE */
333 /* In the size word of a vector, this bit means the vector has been marked. */
335 static ptrdiff_t const ARRAY_MARK_FLAG
336 #define ARRAY_MARK_FLAG PTRDIFF_MIN
339 /* In the size word of a struct Lisp_Vector, this bit means it's really
340 some other vector-like object. */
341 static ptrdiff_t const PSEUDOVECTOR_FLAG
342 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
345 /* In a pseudovector, the size field actually contains a word with one
346 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
347 indicate the actual type.
348 We use a bitset, even tho only one of the bits can be set at any
349 particular time just so as to be able to use micro-optimizations such as
350 testing membership of a particular subset of pseudovectors in Fequal.
351 It is not crucial, but there are plenty of bits here, so why not do it? */
354 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
363 PVEC_WINDOW_CONFIGURATION
,
366 /* These last 4 are special because we OR them in fns.c:internal_equal,
367 so they have to use a disjoint bit pattern:
368 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
369 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
370 PVEC_COMPILED
= 0x10,
371 PVEC_CHAR_TABLE
= 0x20,
372 PVEC_SUB_CHAR_TABLE
= 0x30,
376 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
377 which were stored in a Lisp_Object. */
378 #ifndef DATA_SEG_BITS
379 # define DATA_SEG_BITS 0
381 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
386 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
388 /* For convenience, we also store the number of elements in these bits.
389 Note that this size is not necessarily the memory-footprint size, but
390 only the number of Lisp_Object fields (that need to be traced by GC).
391 The distinction is used, e.g., by Lisp_Process, which places extra
392 non-Lisp_Object fields at the end of the structure. */
393 PSEUDOVECTOR_SIZE_BITS
= 16,
394 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
395 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
397 /* Number of bits to put in each character in the internal representation
398 of bool vectors. This should not vary across implementations. */
399 BOOL_VECTOR_BITS_PER_CHAR
= 8
402 /* These macros extract various sorts of values from a Lisp_Object.
403 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
404 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
406 /* Return a perfect hash of the Lisp_Object representation. */
407 #define XHASH(a) XLI (a)
413 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
416 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
417 #define XINT(a) (XLI (a) >> INTTYPEBITS)
418 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
419 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
420 #define XSET(var, type, ptr) \
421 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
422 (var) = XIL ((type) | (intptr_t) (ptr)))
424 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
425 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
427 #else /* not USE_LSB_TAG */
429 static EMACS_INT
const VALMASK
430 #define VALMASK VAL_MAX
433 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
435 /* For integers known to be positive, XFASTINT provides fast retrieval
436 and XSETFASTINT provides fast storage. This takes advantage of the
437 fact that Lisp integers have zero-bits in their tags. */
438 #define XFASTINT(a) (XLI (a) + 0)
439 #define XSETFASTINT(a, b) ((a) = XIL (b))
441 /* Extract the value of a Lisp_Object as a (un)signed integer. */
443 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
444 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
445 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
447 #define XSET(var, type, ptr) \
448 ((var) = XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
449 + ((intptr_t) (ptr) & VALMASK)))
452 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
453 which were stored in a Lisp_Object */
454 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
456 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
459 #endif /* not USE_LSB_TAG */
461 /* For integers known to be positive, XFASTINT sometimes provides
462 faster retrieval and XSETFASTINT provides faster storage.
463 If not, fallback on the non-accelerated path. */
465 # define XFASTINT(a) (XINT (a))
466 # define XSETFASTINT(a, b) (XSETINT (a, b))
469 /* Extract the pointer value of the Lisp object A, under the
470 assumption that A's type is TYPE. This is a fallback
471 implementation if nothing faster is available. */
473 # define XUNTAG(a, type) XPNTR (a)
476 #define EQ(x, y) (XHASH (x) == XHASH (y))
478 /* Largest and smallest representable fixnum values. These are the C
479 values. They are macros for use in static initializers, and
480 constants for visibility to GDB. */
481 static EMACS_INT
const MOST_POSITIVE_FIXNUM
=
482 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
483 MOST_POSITIVE_FIXNUM
;
484 static EMACS_INT
const MOST_NEGATIVE_FIXNUM
=
485 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
486 MOST_NEGATIVE_FIXNUM
;
488 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
489 written this way so that it also works if I is of unsigned
490 type or if I is a NaN. */
492 #define FIXNUM_OVERFLOW_P(i) \
493 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
495 LISP_INLINE
ptrdiff_t
496 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
498 return num
< lower
? lower
: num
<= upper
? num
: upper
;
501 /* Extract a value or address from a Lisp_Object. */
503 #define XCONS(a) (eassert (CONSP (a)), \
504 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
505 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
506 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
507 #define XSTRING(a) (eassert (STRINGP (a)), \
508 (struct Lisp_String *) XUNTAG (a, Lisp_String))
509 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
510 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
511 #define XFLOAT(a) (eassert (FLOATP (a)), \
512 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
516 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
517 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
518 #define XMISCTYPE(a) (XMISCANY (a)->type)
519 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
520 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
521 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
523 /* Forwarding object types. */
525 #define XFWDTYPE(a) (a->u_intfwd.type)
526 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
527 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
528 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
529 #define XBUFFER_OBJFWD(a) \
530 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
531 #define XKBOARD_OBJFWD(a) \
532 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
534 /* Pseudovector types. */
536 #define XPROCESS(a) (eassert (PROCESSP (a)), \
537 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
538 #define XWINDOW(a) (eassert (WINDOWP (a)), \
539 (struct window *) XUNTAG (a, Lisp_Vectorlike))
540 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
541 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
542 #define XSUBR(a) (eassert (SUBRP (a)), \
543 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
544 #define XBUFFER(a) (eassert (BUFFERP (a)), \
545 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
546 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
547 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
548 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
549 ((struct Lisp_Sub_Char_Table *) \
550 XUNTAG (a, Lisp_Vectorlike)))
551 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
552 ((struct Lisp_Bool_Vector *) \
553 XUNTAG (a, Lisp_Vectorlike)))
555 /* Construct a Lisp_Object from a value or address. */
557 #define XSETINT(a, b) (a) = make_number (b)
558 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
559 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
560 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
561 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
562 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
566 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
567 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
569 /* Pseudovector types. */
571 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
572 #define XSETTYPED_PVECTYPE(v, size_member, code) \
573 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
574 #define XSETPVECTYPESIZE(v, code, sizeval) \
575 ((v)->header.size = (PSEUDOVECTOR_FLAG \
576 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
579 /* The cast to struct vectorlike_header * avoids aliasing issues. */
580 #define XSETPSEUDOVECTOR(a, b, code) \
581 XSETTYPED_PSEUDOVECTOR (a, b, \
582 (((struct vectorlike_header *) \
583 XUNTAG (a, Lisp_Vectorlike)) \
586 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
587 (XSETVECTOR (a, b), \
588 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
589 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
591 #define XSETWINDOW_CONFIGURATION(a, b) \
592 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
593 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
594 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
595 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
596 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
597 #define XSETSUBR(a, b) \
598 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
599 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
600 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
601 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
602 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
603 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
605 /* Convenience macros for dealing with Lisp arrays. */
607 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
608 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
609 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
610 #define ASET(ARRAY, IDX, VAL) \
611 (eassert ((IDX) == (IDX)), \
612 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
613 XVECTOR (ARRAY)->contents[IDX] = (VAL))
615 /* Convenience macros for dealing with Lisp strings. */
617 #define SDATA(string) (XSTRING (string)->data + 0)
618 #define SREF(string, index) (SDATA (string)[index] + 0)
619 #define SSET(string, index, new) (SDATA (string)[index] = (new))
620 #define SCHARS(string) (XSTRING (string)->size + 0)
621 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
623 /* Avoid "differ in sign" warnings. */
624 #define SSDATA(x) ((char *) SDATA (x))
626 #define STRING_SET_CHARS(string, newsize) \
627 (XSTRING (string)->size = (newsize))
629 #define STRING_COPYIN(string, index, new, count) \
630 memcpy (SDATA (string) + index, new, count)
634 #define CHECK_TYPE(ok, Qxxxp, x) \
635 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
637 /* Deprecated and will be removed soon. */
639 #define INTERNAL_FIELD(field) field ## _
641 /* See the macros in intervals.h. */
643 typedef struct interval
*INTERVAL
;
645 /* Complain if object is not string or buffer type. */
646 #define CHECK_STRING_OR_BUFFER(x) \
647 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
651 /* Car of this cons cell. */
656 /* Cdr of this cons cell. */
659 /* Used to chain conses on a free list. */
660 struct Lisp_Cons
*chain
;
664 /* Take the car or cdr of something known to be a cons cell. */
665 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
666 of code that has to know what a cons cell looks like. Other code not
667 part of the basic lisp implementation should assume that the car and cdr
668 fields are not accessible as lvalues. (What if we want to switch to
669 a copying collector someday? Cached cons cell field addresses may be
670 invalidated at arbitrary points.) */
671 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
672 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
674 /* Use these from normal code. */
675 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
676 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
678 /* Use these to set the fields of a cons cell.
680 Note that both arguments may refer to the same object, so 'n'
681 should not be read after 'c' is first modified. Also, neither
682 argument should be evaluated more than once; side effects are
683 especially common in the second argument. */
684 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
685 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
687 /* Take the car or cdr of something whose type is not known. */
689 (CONSP ((c)) ? XCAR ((c)) \
690 : NILP ((c)) ? Qnil \
691 : wrong_type_argument (Qlistp, (c)))
694 (CONSP ((c)) ? XCDR ((c)) \
695 : NILP ((c)) ? Qnil \
696 : wrong_type_argument (Qlistp, (c)))
698 /* Take the car or cdr of something whose type is not known. */
699 #define CAR_SAFE(c) \
700 (CONSP ((c)) ? XCAR ((c)) : Qnil)
702 #define CDR_SAFE(c) \
703 (CONSP ((c)) ? XCDR ((c)) : Qnil)
705 /* True if STR is a multibyte string. */
706 #define STRING_MULTIBYTE(STR) \
707 (XSTRING (STR)->size_byte >= 0)
709 /* Return the length in bytes of STR. */
711 #ifdef GC_CHECK_STRING_BYTES
714 extern ptrdiff_t string_bytes (struct Lisp_String
*);
715 #define STRING_BYTES(S) string_bytes ((S))
717 #else /* not GC_CHECK_STRING_BYTES */
719 #define STRING_BYTES(STR) \
720 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
722 #endif /* not GC_CHECK_STRING_BYTES */
724 /* An upper bound on the number of bytes in a Lisp string, not
725 counting the terminating null. This a tight enough bound to
726 prevent integer overflow errors that would otherwise occur during
727 string size calculations. A string cannot contain more bytes than
728 a fixnum can represent, nor can it be so long that C pointer
729 arithmetic stops working on the string plus its terminating null.
730 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
731 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
732 would expose alloc.c internal details that we'd rather keep
735 This is a macro for use in static initializers, and a constant for
736 visibility to GDB. The cast to ptrdiff_t ensures that
737 the macro is signed. */
738 static ptrdiff_t const STRING_BYTES_BOUND
=
739 #define STRING_BYTES_BOUND \
740 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
743 /* Mark STR as a unibyte string. */
744 #define STRING_SET_UNIBYTE(STR) \
745 do { if (EQ (STR, empty_multibyte_string)) \
746 (STR) = empty_unibyte_string; \
747 else XSTRING (STR)->size_byte = -1; } while (0)
749 /* Mark STR as a multibyte string. Assure that STR contains only
750 ASCII characters in advance. */
751 #define STRING_SET_MULTIBYTE(STR) \
752 do { if (EQ (STR, empty_unibyte_string)) \
753 (STR) = empty_multibyte_string; \
754 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
756 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
762 INTERVAL intervals
; /* Text properties in this string. */
766 /* Header of vector-like objects. This documents the layout constraints on
767 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
768 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
769 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
770 because when two such pointers potentially alias, a compiler won't
771 incorrectly reorder loads and stores to their size fields. See
772 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
773 struct vectorlike_header
775 /* This field contains various pieces of information:
776 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
777 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
778 vector (0) or a pseudovector (1).
779 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
780 of slots) of the vector.
781 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
782 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
783 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
784 Lisp_Object slots at the beginning of the object that need to be
785 traced by the GC, tho some types use it slightly differently.
786 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
787 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
791 /* When the vector is allocated from a vector block, NBYTES is used
792 if the vector is not on a free list, and VECTOR is used otherwise.
793 For large vector-like objects, BUFFER or VECTOR is used as a pointer
794 to the next vector-like object. It is generally a buffer or a
795 Lisp_Vector alias, so for convenience it is a union instead of a
796 pointer: this way, one can write P->next.vector instead of ((struct
797 Lisp_Vector *) P->next). */
799 /* This is only needed for small vectors that are not free because the
800 `size' field only gives us the number of Lisp_Object slots, whereas we
801 need to know the total size, including non-Lisp_Object data.
802 FIXME: figure out a way to store this info elsewhere so we can
803 finally get rid of this extra word of overhead. */
805 struct buffer
*buffer
;
806 /* FIXME: This can be removed: For large vectors, this field could be
807 placed *before* the vector itself. And for small vectors on a free
808 list, this field could be stored in the vector's bytes, since the
809 empty vector is handled specially anyway. */
810 struct Lisp_Vector
*vector
;
814 /* Regular vector is just a header plus array of Lisp_Objects. */
818 struct vectorlike_header header
;
819 Lisp_Object contents
[1];
822 /* A boolvector is a kind of vectorlike, with contents are like a string. */
824 struct Lisp_Bool_Vector
826 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
827 just the subtype information. */
828 struct vectorlike_header header
;
829 /* This is the size in bits. */
831 /* This contains the actual bits, packed into bytes. */
832 unsigned char data
[1];
835 /* Some handy constants for calculating sizes
836 and offsets, mostly of vectorlike objects. */
840 header_size
= offsetof (struct Lisp_Vector
, contents
),
841 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
842 word_size
= sizeof (Lisp_Object
)
845 /* If a struct is made to look like a vector, this macro returns the length
846 of the shortest vector that would hold that struct. */
848 #define VECSIZE(type) \
849 ((sizeof (type) - header_size + word_size - 1) / word_size)
851 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
852 at the end and we need to compute the number of Lisp_Object fields (the
853 ones that the GC needs to trace). */
855 #define PSEUDOVECSIZE(type, nonlispfield) \
856 ((offsetof (type, nonlispfield) - header_size) / word_size)
858 /* A char-table is a kind of vectorlike, with contents are like a
859 vector but with a few other slots. For some purposes, it makes
860 sense to handle a char-table with type struct Lisp_Vector. An
861 element of a char table can be any Lisp objects, but if it is a sub
862 char-table, we treat it a table that contains information of a
863 specific range of characters. A sub char-table has the same
864 structure as a vector. A sub char table appears only in an element
865 of a char-table, and there's no way to access it directly from
866 Emacs Lisp program. */
870 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
871 ({struct Lisp_Char_Table *_tbl = NULL; \
874 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
875 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
876 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
878 _val = _tbl->defalt; \
879 } while (NILP (_val) && ! NILP (_tbl->parent)); \
882 #else /* not __GNUC__ */
884 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
885 (! NILP (XCHAR_TABLE (CT)->ascii) \
886 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
887 ? XCHAR_TABLE (CT)->ascii \
888 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
889 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
890 : char_table_ref ((CT), (IDX))) \
891 : char_table_ref ((CT), (IDX)))
893 #endif /* not __GNUC__ */
895 /* Compute A OP B, using the unsigned comparison operator OP. A and B
896 should be integer expressions. This is not the same as
897 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
898 returns 1. For efficiency, prefer plain unsigned comparison if A
899 and B's sizes both fit (after integer promotion). */
900 #define UNSIGNED_CMP(a, op, b) \
901 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
902 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
903 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
905 /* Nonzero iff C is an ASCII character. */
906 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
908 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
909 characters. Do not check validity of CT. */
910 #define CHAR_TABLE_REF(CT, IDX) \
911 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
912 : char_table_ref ((CT), (IDX)))
914 /* Almost equivalent to Faref (CT, IDX). However, if the result is
915 not a character, return IDX.
917 For these characters, do not check validity of CT
918 and do not follow parent. */
919 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
920 char_table_translate (CT, IDX)
922 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
923 8-bit European characters. Do not check validity of CT. */
924 #define CHAR_TABLE_SET(CT, IDX, VAL) \
925 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
926 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
927 : char_table_set (CT, IDX, VAL))
929 enum CHARTAB_SIZE_BITS
931 CHARTAB_SIZE_BITS_0
= 6,
932 CHARTAB_SIZE_BITS_1
= 4,
933 CHARTAB_SIZE_BITS_2
= 5,
934 CHARTAB_SIZE_BITS_3
= 7
937 extern const int chartab_size
[4];
939 struct Lisp_Char_Table
941 /* HEADER.SIZE is the vector's size field, which also holds the
942 pseudovector type information. It holds the size, too.
943 The size counts the defalt, parent, purpose, ascii,
944 contents, and extras slots. */
945 struct vectorlike_header header
;
947 /* This holds a default value,
948 which is used whenever the value for a specific character is nil. */
951 /* This points to another char table, which we inherit from when the
952 value for a specific character is nil. The `defalt' slot takes
953 precedence over this. */
956 /* This is a symbol which says what kind of use this char-table is
960 /* The bottom sub char-table for characters of the range 0..127. It
961 is nil if none of ASCII character has a specific value. */
964 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
966 /* These hold additional data. It is a vector. */
967 Lisp_Object extras
[1];
970 struct Lisp_Sub_Char_Table
972 /* HEADER.SIZE is the vector's size field, which also holds the
973 pseudovector type information. It holds the size, too. */
974 struct vectorlike_header header
;
976 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
977 char-table of depth 1 contains 16 elements, and each element
978 covers 4096 (128*32) characters. A sub char-table of depth 2
979 contains 32 elements, and each element covers 128 characters. A
980 sub char-table of depth 3 contains 128 elements, and each element
981 is for one character. */
984 /* Minimum character covered by the sub char-table. */
985 Lisp_Object min_char
;
987 /* Use set_sub_char_table_contents to set this. */
988 Lisp_Object contents
[1];
991 /* This structure describes a built-in function.
992 It is generated by the DEFUN macro only.
993 defsubr makes it into a Lisp object.
995 This type is treated in most respects as a pseudovector,
996 but since we never dynamically allocate or free them,
997 we don't need a struct vectorlike_header and its 'next' field. */
1003 Lisp_Object (*a0
) (void);
1004 Lisp_Object (*a1
) (Lisp_Object
);
1005 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1006 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1007 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1008 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1009 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1010 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1011 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1012 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1013 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1015 short min_args
, max_args
;
1016 const char *symbol_name
;
1017 const char *intspec
;
1021 /* This is the number of slots that every char table must have. This
1022 counts the ordinary slots and the top, defalt, parent, and purpose
1024 enum CHAR_TABLE_STANDARD_SLOTS
1026 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1029 /* Return the number of "extra" slots in the char table CT. */
1031 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1032 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1035 /***********************************************************************
1037 ***********************************************************************/
1039 /* Interned state of a symbol. */
1041 enum symbol_interned
1043 SYMBOL_UNINTERNED
= 0,
1044 SYMBOL_INTERNED
= 1,
1045 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1048 enum symbol_redirect
1050 SYMBOL_PLAINVAL
= 4,
1051 SYMBOL_VARALIAS
= 1,
1052 SYMBOL_LOCALIZED
= 2,
1053 SYMBOL_FORWARDED
= 3
1058 unsigned gcmarkbit
: 1;
1060 /* Indicates where the value can be found:
1061 0 : it's a plain var, the value is in the `value' field.
1062 1 : it's a varalias, the value is really in the `alias' symbol.
1063 2 : it's a localized var, the value is in the `blv' object.
1064 3 : it's a forwarding variable, the value is in `forward'. */
1065 ENUM_BF (symbol_redirect
) redirect
: 3;
1067 /* Non-zero means symbol is constant, i.e. changing its value
1068 should signal an error. If the value is 3, then the var
1069 can be changed, but only by `defconst'. */
1070 unsigned constant
: 2;
1072 /* Interned state of the symbol. This is an enumerator from
1073 enum symbol_interned. */
1074 unsigned interned
: 2;
1076 /* Non-zero means that this variable has been explicitly declared
1077 special (with `defvar' etc), and shouldn't be lexically bound. */
1078 unsigned declared_special
: 1;
1080 /* The symbol's name, as a Lisp string. */
1083 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1084 union is used depends on the `redirect' field above. */
1087 struct Lisp_Symbol
*alias
;
1088 struct Lisp_Buffer_Local_Value
*blv
;
1089 union Lisp_Fwd
*fwd
;
1092 /* Function value of the symbol or Qunbound if not fboundp. */
1093 Lisp_Object function
;
1095 /* The symbol's property list. */
1098 /* Next symbol in obarray bucket, if the symbol is interned. */
1099 struct Lisp_Symbol
*next
;
1102 /* Value is name of symbol. */
1104 #define SYMBOL_VAL(sym) \
1105 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1106 #define SYMBOL_ALIAS(sym) \
1107 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1108 #define SYMBOL_BLV(sym) \
1109 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1110 #define SYMBOL_FWD(sym) \
1111 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1112 #define SET_SYMBOL_VAL(sym, v) \
1113 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1114 #define SET_SYMBOL_ALIAS(sym, v) \
1115 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1116 #define SET_SYMBOL_BLV(sym, v) \
1117 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1118 #define SET_SYMBOL_FWD(sym, v) \
1119 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1121 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1123 /* Value is non-zero if SYM is an interned symbol. */
1125 #define SYMBOL_INTERNED_P(sym) \
1126 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1128 /* Value is non-zero if SYM is interned in initial_obarray. */
1130 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1131 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1133 /* Value is non-zero if symbol is considered a constant, i.e. its
1134 value cannot be changed (there is an exception for keyword symbols,
1135 whose value can be set to the keyword symbol itself). */
1137 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1139 #define DEFSYM(sym, name) \
1140 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1143 /***********************************************************************
1145 ***********************************************************************/
1147 /* The structure of a Lisp hash table. */
1149 struct Lisp_Hash_Table
1151 /* This is for Lisp; the hash table code does not refer to it. */
1152 struct vectorlike_header header
;
1154 /* Function used to compare keys. */
1157 /* Nil if table is non-weak. Otherwise a symbol describing the
1158 weakness of the table. */
1161 /* When the table is resized, and this is an integer, compute the
1162 new size by adding this to the old size. If a float, compute the
1163 new size by multiplying the old size with this factor. */
1164 Lisp_Object rehash_size
;
1166 /* Resize hash table when number of entries/ table size is >= this
1168 Lisp_Object rehash_threshold
;
1170 /* Vector of hash codes.. If hash[I] is nil, this means that that
1171 entry I is unused. */
1174 /* Vector used to chain entries. If entry I is free, next[I] is the
1175 entry number of the next free item. If entry I is non-free,
1176 next[I] is the index of the next entry in the collision chain. */
1179 /* Index of first free entry in free list. */
1180 Lisp_Object next_free
;
1182 /* Bucket vector. A non-nil entry is the index of the first item in
1183 a collision chain. This vector's size can be larger than the
1184 hash table size to reduce collisions. */
1187 /* User-supplied hash function, or nil. */
1188 Lisp_Object user_hash_function
;
1190 /* User-supplied key comparison function, or nil. */
1191 Lisp_Object user_cmp_function
;
1193 /* Only the fields above are traced normally by the GC. The ones below
1194 `count' are special and are either ignored by the GC or traced in
1195 a special way (e.g. because of weakness). */
1197 /* Number of key/value entries in the table. */
1200 /* Vector of keys and values. The key of item I is found at index
1201 2 * I, the value is found at index 2 * I + 1.
1202 This is gc_marked specially if the table is weak. */
1203 Lisp_Object key_and_value
;
1205 /* Next weak hash table if this is a weak hash table. The head
1206 of the list is in weak_hash_tables. */
1207 struct Lisp_Hash_Table
*next_weak
;
1209 /* C function to compare two keys. */
1210 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1211 Lisp_Object
, EMACS_UINT
,
1212 Lisp_Object
, EMACS_UINT
);
1214 /* C function to compute hash code. */
1215 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1219 #define XHASH_TABLE(OBJ) \
1220 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1222 #define XSET_HASH_TABLE(VAR, PTR) \
1223 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1225 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1227 #define CHECK_HASH_TABLE(x) \
1228 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1230 /* Value is the key part of entry IDX in hash table H. */
1232 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1234 /* Value is the value part of entry IDX in hash table H. */
1236 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1238 /* Value is the index of the next entry following the one at IDX
1241 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1243 /* Value is the hash code computed for entry IDX in hash table H. */
1245 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1247 /* Value is the index of the element in hash table H that is the
1248 start of the collision list at index IDX in the index vector of H. */
1250 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1252 /* Value is the size of hash table H. */
1254 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1256 /* Default size for hash tables if not specified. */
1258 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1260 /* Default threshold specifying when to resize a hash table. The
1261 value gives the ratio of current entries in the hash table and the
1262 size of the hash table. */
1264 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1266 /* Default factor by which to increase the size of a hash table. */
1268 static double const DEFAULT_REHASH_SIZE
= 1.5;
1270 /* These structures are used for various misc types. */
1272 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1274 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1275 unsigned gcmarkbit
: 1;
1281 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1282 unsigned gcmarkbit
: 1;
1284 /* This flag is temporarily used in the functions
1285 decode/encode_coding_object to record that the marker position
1286 must be adjusted after the conversion. */
1287 unsigned int need_adjustment
: 1;
1288 /* 1 means normal insertion at the marker's position
1289 leaves the marker after the inserted text. */
1290 unsigned int insertion_type
: 1;
1291 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1292 Note: a chain of markers can contain markers pointing into different
1293 buffers (the chain is per buffer_text rather than per buffer, so it's
1294 shared between indirect buffers). */
1295 /* This is used for (other than NULL-checking):
1297 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1298 - unchain_marker: to find the list from which to unchain.
1299 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1301 struct buffer
*buffer
;
1303 /* The remaining fields are meaningless in a marker that
1304 does not point anywhere. */
1306 /* For markers that point somewhere,
1307 this is used to chain of all the markers in a given buffer. */
1308 /* We could remove it and use an array in buffer_text instead.
1309 That would also allow to preserve it ordered. */
1310 struct Lisp_Marker
*next
;
1311 /* This is the char position where the marker points. */
1313 /* This is the byte position.
1314 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1315 used to implement the functionality of markers, but rather to (ab)use
1316 markers as a cache for char<->byte mappings). */
1320 /* START and END are markers in the overlay's buffer, and
1321 PLIST is the overlay's property list. */
1323 /* An overlay's real data content is:
1325 - buffer (really there are two buffer pointers, one per marker,
1326 and both points to the same buffer)
1327 - insertion type of both ends (per-marker fields)
1328 - start & start byte (of start marker)
1329 - end & end byte (of end marker)
1330 - next (singly linked list of overlays)
1331 - next fields of start and end markers (singly linked list of markers).
1332 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1335 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1336 unsigned gcmarkbit
: 1;
1338 struct Lisp_Overlay
*next
;
1344 /* Hold a C pointer for later use.
1345 This type of object is used in the arg to record_unwind_protect. */
1346 struct Lisp_Save_Value
1348 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1349 unsigned gcmarkbit
: 1;
1351 /* If DOGC is set, POINTER is the address of a memory
1352 area containing INTEGER potential Lisp_Objects. */
1353 unsigned int dogc
: 1;
1359 /* A miscellaneous object, when it's on the free list. */
1362 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1363 unsigned gcmarkbit
: 1;
1365 union Lisp_Misc
*chain
;
1368 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1369 It uses one of these struct subtypes to get the type field. */
1373 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1374 struct Lisp_Free u_free
;
1375 struct Lisp_Marker u_marker
;
1376 struct Lisp_Overlay u_overlay
;
1377 struct Lisp_Save_Value u_save_value
;
1380 /* Forwarding pointer to an int variable.
1381 This is allowed only in the value cell of a symbol,
1382 and it means that the symbol's value really lives in the
1383 specified int variable. */
1386 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1390 /* Boolean forwarding pointer to an int variable.
1391 This is like Lisp_Intfwd except that the ostensible
1392 "value" of the symbol is t if the int variable is nonzero,
1393 nil if it is zero. */
1396 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1400 /* Forwarding pointer to a Lisp_Object variable.
1401 This is allowed only in the value cell of a symbol,
1402 and it means that the symbol's value really lives in the
1403 specified variable. */
1406 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1407 Lisp_Object
*objvar
;
1410 /* Like Lisp_Objfwd except that value lives in a slot in the
1411 current buffer. Value is byte index of slot within buffer. */
1412 struct Lisp_Buffer_Objfwd
1414 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1416 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1419 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1420 the symbol has buffer-local or frame-local bindings. (Exception:
1421 some buffer-local variables are built-in, with their values stored
1422 in the buffer structure itself. They are handled differently,
1423 using struct Lisp_Buffer_Objfwd.)
1425 The `realvalue' slot holds the variable's current value, or a
1426 forwarding pointer to where that value is kept. This value is the
1427 one that corresponds to the loaded binding. To read or set the
1428 variable, you must first make sure the right binding is loaded;
1429 then you can access the value in (or through) `realvalue'.
1431 `buffer' and `frame' are the buffer and frame for which the loaded
1432 binding was found. If those have changed, to make sure the right
1433 binding is loaded it is necessary to find which binding goes with
1434 the current buffer and selected frame, then load it. To load it,
1435 first unload the previous binding, then copy the value of the new
1436 binding into `realvalue' (or through it). Also update
1437 LOADED-BINDING to point to the newly loaded binding.
1439 `local_if_set' indicates that merely setting the variable creates a
1440 local binding for the current buffer. Otherwise the latter, setting
1441 the variable does not do that; only make-local-variable does that. */
1443 struct Lisp_Buffer_Local_Value
1445 /* 1 means that merely setting the variable creates a local
1446 binding for the current buffer. */
1447 unsigned int local_if_set
: 1;
1448 /* 1 means this variable can have frame-local bindings, otherwise, it is
1449 can have buffer-local bindings. The two cannot be combined. */
1450 unsigned int frame_local
: 1;
1451 /* 1 means that the binding now loaded was found.
1452 Presumably equivalent to (defcell!=valcell). */
1453 unsigned int found
: 1;
1454 /* If non-NULL, a forwarding to the C var where it should also be set. */
1455 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1456 /* The buffer or frame for which the loaded binding was found. */
1458 /* A cons cell that holds the default value. It has the form
1459 (SYMBOL . DEFAULT-VALUE). */
1460 Lisp_Object defcell
;
1461 /* The cons cell from `where's parameter alist.
1462 It always has the form (SYMBOL . VALUE)
1463 Note that if `forward' is non-nil, VALUE may be out of date.
1464 Also if the currently loaded binding is the default binding, then
1465 this is `eq'ual to defcell. */
1466 Lisp_Object valcell
;
1469 /* Like Lisp_Objfwd except that value lives in a slot in the
1471 struct Lisp_Kboard_Objfwd
1473 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1479 struct Lisp_Intfwd u_intfwd
;
1480 struct Lisp_Boolfwd u_boolfwd
;
1481 struct Lisp_Objfwd u_objfwd
;
1482 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1483 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1486 /* Lisp floating point type. */
1492 struct Lisp_Float
*chain
;
1496 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1497 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1499 /* A character, declared with the following typedef, is a member
1500 of some character set associated with the current buffer. */
1501 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1503 typedef unsigned char UCHAR
;
1506 /* Meanings of slots in a Lisp_Compiled: */
1510 COMPILED_ARGLIST
= 0,
1511 COMPILED_BYTECODE
= 1,
1512 COMPILED_CONSTANTS
= 2,
1513 COMPILED_STACK_DEPTH
= 3,
1514 COMPILED_DOC_STRING
= 4,
1515 COMPILED_INTERACTIVE
= 5
1518 /* Flag bits in a character. These also get used in termhooks.h.
1519 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1520 (MUlti-Lingual Emacs) might need 22 bits for the character value
1521 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1524 CHAR_ALT
= 0x0400000,
1525 CHAR_SUPER
= 0x0800000,
1526 CHAR_HYPER
= 0x1000000,
1527 CHAR_SHIFT
= 0x2000000,
1528 CHAR_CTL
= 0x4000000,
1529 CHAR_META
= 0x8000000,
1531 CHAR_MODIFIER_MASK
=
1532 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1534 /* Actually, the current Emacs uses 22 bits for the character value
1542 /* The glyph datatype, used to represent characters on the display.
1543 It consists of a char code and a face id. */
1550 /* Return a glyph's character code. */
1551 #define GLYPH_CHAR(glyph) ((glyph).ch)
1553 /* Return a glyph's face ID. */
1554 #define GLYPH_FACE(glyph) ((glyph).face_id)
1556 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1557 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1558 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1560 /* Return 1 if GLYPH contains valid character code. */
1561 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1564 /* Glyph Code from a display vector may either be an integer which
1565 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1566 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1568 #define GLYPH_CODE_P(gc) \
1570 ? (CHARACTERP (XCAR (gc)) \
1571 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1572 : (RANGED_INTEGERP \
1574 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1575 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1576 : TYPE_MAXIMUM (EMACS_INT)))))
1578 /* The following are valid only if GLYPH_CODE_P (gc). */
1580 #define GLYPH_CODE_CHAR(gc) \
1581 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1583 #define GLYPH_CODE_FACE(gc) \
1584 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1586 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1590 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1592 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1593 (XINT (gc) >> CHARACTERBITS)); \
1597 /* Structure to hold mouse highlight data. This is here because other
1598 header files need it for defining struct x_output etc. */
1600 /* These variables describe the range of text currently shown in its
1601 mouse-face, together with the window they apply to. As long as
1602 the mouse stays within this range, we need not redraw anything on
1603 its account. Rows and columns are glyph matrix positions in
1604 MOUSE_FACE_WINDOW. */
1605 int mouse_face_beg_row
, mouse_face_beg_col
;
1606 int mouse_face_beg_x
, mouse_face_beg_y
;
1607 int mouse_face_end_row
, mouse_face_end_col
;
1608 int mouse_face_end_x
, mouse_face_end_y
;
1609 int mouse_face_past_end
;
1610 Lisp_Object mouse_face_window
;
1611 int mouse_face_face_id
;
1612 Lisp_Object mouse_face_overlay
;
1614 /* 1 if a mouse motion event came and we didn't handle it right away because
1615 gc was in progress. */
1616 int mouse_face_deferred_gc
;
1618 /* FRAME and X, Y position of mouse when last checked for
1619 highlighting. X and Y can be negative or out of range for the frame. */
1620 struct frame
*mouse_face_mouse_frame
;
1621 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1623 /* Nonzero means defer mouse-motion highlighting. */
1624 int mouse_face_defer
;
1626 /* Nonzero means that the mouse highlight should not be shown. */
1627 int mouse_face_hidden
;
1629 int mouse_face_image_state
;
1632 /* Data type checking */
1634 #define NILP(x) EQ (x, Qnil)
1636 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1637 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1639 #define RANGED_INTEGERP(lo, x, hi) \
1640 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1641 #define TYPE_RANGED_INTEGERP(type, x) \
1642 (TYPE_SIGNED (type) \
1643 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1644 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1646 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1647 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1648 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1649 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1650 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1651 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1653 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1654 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1655 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1656 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1657 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1659 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1660 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1661 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1662 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1663 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1665 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1666 vectorlike_header * avoids aliasing issues. */
1667 #define PSEUDOVECTORP(x, code) \
1668 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1670 #define PSEUDOVECTOR_TYPEP(v, code) \
1671 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1672 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1674 /* True if object X, with internal type struct T *, is a pseudovector whose
1676 #define TYPED_PSEUDOVECTORP(x, t, code) \
1678 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1680 /* Test for specific pseudovector types. */
1681 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1682 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1683 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1684 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1685 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1686 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1687 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1688 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1689 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1690 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1691 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1692 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1694 /* Test for image (image . spec) */
1695 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1700 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1702 #define CHECK_LIST(x) \
1703 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1705 #define CHECK_LIST_CONS(x, y) \
1706 CHECK_TYPE (CONSP (x), Qlistp, y)
1708 #define CHECK_LIST_END(x, y) \
1709 CHECK_TYPE (NILP (x), Qlistp, y)
1711 #define CHECK_STRING(x) \
1712 CHECK_TYPE (STRINGP (x), Qstringp, x)
1714 #define CHECK_STRING_CAR(x) \
1715 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1717 #define CHECK_CONS(x) \
1718 CHECK_TYPE (CONSP (x), Qconsp, x)
1720 #define CHECK_SYMBOL(x) \
1721 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1723 #define CHECK_CHAR_TABLE(x) \
1724 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1726 #define CHECK_VECTOR(x) \
1727 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1729 #define CHECK_VECTOR_OR_STRING(x) \
1730 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1732 #define CHECK_ARRAY(x, Qxxxp) \
1733 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1735 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1736 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1738 #define CHECK_BUFFER(x) \
1739 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1741 #define CHECK_WINDOW(x) \
1742 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1744 #define CHECK_WINDOW_CONFIGURATION(x) \
1745 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1747 /* A window of any sort, leaf or interior, is "valid" if one of its
1748 buffer, vchild, or hchild members is non-nil. */
1749 #define CHECK_VALID_WINDOW(x) \
1750 CHECK_TYPE (WINDOWP (x) \
1751 && (!NILP (XWINDOW (x)->buffer) \
1752 || !NILP (XWINDOW (x)->vchild) \
1753 || !NILP (XWINDOW (x)->hchild)), \
1756 /* A window is "live" if and only if it shows a buffer. */
1757 #define CHECK_LIVE_WINDOW(x) \
1758 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), \
1761 #define CHECK_PROCESS(x) \
1762 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1764 #define CHECK_SUBR(x) \
1765 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1767 #define CHECK_NUMBER(x) \
1768 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1770 #define CHECK_NATNUM(x) \
1771 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1773 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1776 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1777 args_out_of_range_3 \
1779 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1780 ? MOST_NEGATIVE_FIXNUM \
1782 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1784 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1786 if (TYPE_SIGNED (type)) \
1787 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1789 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1792 #define CHECK_MARKER(x) \
1793 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1795 #define CHECK_NUMBER_COERCE_MARKER(x) \
1796 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1797 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1799 #define XFLOATINT(n) extract_float((n))
1801 #define CHECK_FLOAT(x) \
1802 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1804 #define CHECK_NUMBER_OR_FLOAT(x) \
1805 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1807 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1808 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1809 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1811 #define CHECK_OVERLAY(x) \
1812 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1814 /* Since we can't assign directly to the CAR or CDR fields of a cons
1815 cell, use these when checking that those fields contain numbers. */
1816 #define CHECK_NUMBER_CAR(x) \
1818 Lisp_Object tmp = XCAR (x); \
1819 CHECK_NUMBER (tmp); \
1820 XSETCAR ((x), tmp); \
1823 #define CHECK_NUMBER_CDR(x) \
1825 Lisp_Object tmp = XCDR (x); \
1826 CHECK_NUMBER (tmp); \
1827 XSETCDR ((x), tmp); \
1830 #define CHECK_NATNUM_CAR(x) \
1832 Lisp_Object tmp = XCAR (x); \
1833 CHECK_NATNUM (tmp); \
1834 XSETCAR ((x), tmp); \
1837 #define CHECK_NATNUM_CDR(x) \
1839 Lisp_Object tmp = XCDR (x); \
1840 CHECK_NATNUM (tmp); \
1841 XSETCDR ((x), tmp); \
1844 /* Define a built-in function for calling from Lisp.
1845 `lname' should be the name to give the function in Lisp,
1846 as a null-terminated C string.
1847 `fnname' should be the name of the function in C.
1848 By convention, it starts with F.
1849 `sname' should be the name for the C constant structure
1850 that records information on this function for internal use.
1851 By convention, it should be the same as `fnname' but with S instead of F.
1852 It's too bad that C macros can't compute this from `fnname'.
1853 `minargs' should be a number, the minimum number of arguments allowed.
1854 `maxargs' should be a number, the maximum number of arguments allowed,
1855 or else MANY or UNEVALLED.
1856 MANY means pass a vector of evaluated arguments,
1857 in the form of an integer number-of-arguments
1858 followed by the address of a vector of Lisp_Objects
1859 which contains the argument values.
1860 UNEVALLED means pass the list of unevaluated arguments
1861 `intspec' says how interactive arguments are to be fetched.
1862 If the string starts with a `(', `intspec' is evaluated and the resulting
1863 list is the list of arguments.
1864 If it's a string that doesn't start with `(', the value should follow
1865 the one of the doc string for `interactive'.
1866 A null string means call interactively with no arguments.
1867 `doc' is documentation for the user. */
1869 /* This version of DEFUN declares a function prototype with the right
1870 arguments, so we can catch errors with maxargs at compile-time. */
1872 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1873 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1874 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1875 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1876 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1877 { (Lisp_Object (__cdecl *)(void))fnname }, \
1878 minargs, maxargs, lname, intspec, 0}; \
1880 #else /* not _MSC_VER */
1881 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1882 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1883 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1884 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1885 { .a ## maxargs = fnname }, \
1886 minargs, maxargs, lname, intspec, 0}; \
1890 /* Note that the weird token-substitution semantics of ANSI C makes
1891 this work for MANY and UNEVALLED. */
1892 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1893 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1894 #define DEFUN_ARGS_0 (void)
1895 #define DEFUN_ARGS_1 (Lisp_Object)
1896 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1897 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1898 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1899 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1901 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1902 Lisp_Object, Lisp_Object)
1903 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1904 Lisp_Object, Lisp_Object, Lisp_Object)
1905 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1906 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1908 /* Non-zero if OBJ is a Lisp function. */
1909 #define FUNCTIONP(OBJ) \
1910 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1911 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1912 || COMPILEDP (OBJ) \
1916 is how we define the symbol for function `name' at start-up time. */
1917 extern void defsubr (struct Lisp_Subr
*);
1925 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1926 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1927 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1928 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1929 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1931 /* Macros we use to define forwarded Lisp variables.
1932 These are used in the syms_of_FILENAME functions.
1934 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1935 lisp variable is actually a field in `struct emacs_globals'. The
1936 field's name begins with "f_", which is a convention enforced by
1937 these macros. Each such global has a corresponding #define in
1938 globals.h; the plain name should be used in the code.
1940 E.g., the global "cons_cells_consed" is declared as "int
1941 f_cons_cells_consed" in globals.h, but there is a define:
1943 #define cons_cells_consed globals.f_cons_cells_consed
1945 All C code uses the `cons_cells_consed' name. This is all done
1946 this way to support indirection for multi-threaded Emacs. */
1948 #define DEFVAR_LISP(lname, vname, doc) \
1950 static struct Lisp_Objfwd o_fwd; \
1951 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1953 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1955 static struct Lisp_Objfwd o_fwd; \
1956 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1958 #define DEFVAR_BOOL(lname, vname, doc) \
1960 static struct Lisp_Boolfwd b_fwd; \
1961 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1963 #define DEFVAR_INT(lname, vname, doc) \
1965 static struct Lisp_Intfwd i_fwd; \
1966 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1969 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1971 static struct Lisp_Objfwd o_fwd; \
1972 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1975 #define DEFVAR_KBOARD(lname, vname, doc) \
1977 static struct Lisp_Kboard_Objfwd ko_fwd; \
1978 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1983 /* Structure for recording Lisp call stack for backtrace purposes. */
1985 /* The special binding stack holds the outer values of variables while
1986 they are bound by a function application or a let form, stores the
1987 code to be executed for Lisp unwind-protect forms, and stores the C
1988 functions to be called for record_unwind_protect.
1990 If func is non-zero, undoing this binding applies func to old_value;
1991 This implements record_unwind_protect.
1993 Otherwise, the element is a variable binding.
1995 If the symbol field is a symbol, it is an ordinary variable binding.
1997 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
1998 which means having bound a local value while CURRENT-BUFFER was active.
1999 If WHERE is nil this means we saw the default value when binding SYMBOL.
2000 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2001 value. Other values of WHERE mean an internal error. */
2003 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2007 Lisp_Object symbol
, old_value
;
2008 specbinding_func func
;
2009 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
2012 extern struct specbinding
*specpdl
;
2013 extern struct specbinding
*specpdl_ptr
;
2014 extern ptrdiff_t specpdl_size
;
2016 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2020 struct backtrace
*next
;
2021 Lisp_Object
*function
;
2022 Lisp_Object
*args
; /* Points to vector of args. */
2023 ptrdiff_t nargs
; /* Length of vector. */
2024 /* Nonzero means call value of debugger when done with this operation. */
2025 unsigned int debug_on_exit
: 1;
2028 extern struct backtrace
*backtrace_list
;
2030 /* Everything needed to describe an active condition case. */
2033 /* The handler clauses and variable from the condition-case form. */
2034 /* For a handler set up in Lisp code, this is always a list.
2035 For an internal handler set up by internal_condition_case*,
2036 this can instead be the symbol t or `error'.
2037 t: handle all conditions.
2038 error: handle all conditions, and errors can run the debugger
2039 or display a backtrace. */
2040 Lisp_Object handler
;
2042 /* Fsignal stores here the condition-case clause that applies,
2043 and Fcondition_case thus knows which clause to run. */
2044 Lisp_Object chosen_clause
;
2046 /* Used to effect the longjump out to the handler. */
2047 struct catchtag
*tag
;
2049 /* The next enclosing handler. */
2050 struct handler
*next
;
2053 /* This structure helps implement the `catch' and `throw' control
2054 structure. A struct catchtag contains all the information needed
2055 to restore the state of the interpreter after a non-local jump.
2057 Handlers for error conditions (represented by `struct handler'
2058 structures) just point to a catch tag to do the cleanup required
2061 catchtag structures are chained together in the C calling stack;
2062 the `next' member points to the next outer catchtag.
2064 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2065 member is TAG, and then unbinds to it. The `val' member is used to
2066 hold VAL while the stack is unwound; `val' is returned as the value
2069 All the other members are concerned with restoring the interpreter
2076 struct catchtag
*next
;
2077 struct gcpro
*gcpro
;
2079 struct backtrace
*backlist
;
2080 struct handler
*handlerlist
;
2081 EMACS_INT lisp_eval_depth
;
2083 int poll_suppress_count
;
2084 int interrupt_input_blocked
;
2085 struct byte_stack
*byte_stack
;
2088 extern Lisp_Object memory_signal_data
;
2090 /* An address near the bottom of the stack.
2091 Tells GC how to save a copy of the stack. */
2092 extern char *stack_bottom
;
2094 /* Check quit-flag and quit if it is non-nil.
2095 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2096 So the program needs to do QUIT at times when it is safe to quit.
2097 Every loop that might run for a long time or might not exit
2098 ought to do QUIT at least once, at a safe place.
2099 Unless that is impossible, of course.
2100 But it is very desirable to avoid creating loops where QUIT is impossible.
2102 Exception: if you set immediate_quit to nonzero,
2103 then the handler that responds to the C-g does the quit itself.
2104 This is a good thing to do around a loop that has no side effects
2105 and (in particular) cannot call arbitrary Lisp code.
2107 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2108 a request to exit Emacs when it is safe to do. */
2111 extern void process_pending_signals (void);
2112 extern int pending_signals
;
2113 #define ELSE_PENDING_SIGNALS \
2114 else if (pending_signals) \
2115 process_pending_signals ();
2116 #else /* not SYNC_INPUT */
2117 #define ELSE_PENDING_SIGNALS
2118 #endif /* not SYNC_INPUT */
2120 extern void process_quit_flag (void);
2123 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2124 process_quit_flag (); \
2125 ELSE_PENDING_SIGNALS \
2129 /* Nonzero if ought to quit now. */
2131 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2133 extern Lisp_Object Vascii_downcase_table
;
2134 extern Lisp_Object Vascii_canon_table
;
2136 /* Structure for recording stack slots that need marking. */
2138 /* This is a chain of structures, each of which points at a Lisp_Object
2139 variable whose value should be marked in garbage collection.
2140 Normally every link of the chain is an automatic variable of a function,
2141 and its `val' points to some argument or local variable of the function.
2142 On exit to the function, the chain is set back to the value it had on entry.
2143 This way, no link remains in the chain when the stack frame containing the
2146 Every function that can call Feval must protect in this fashion all
2147 Lisp_Object variables whose contents will be used again. */
2149 extern struct gcpro
*gcprolist
;
2155 /* Address of first protected variable. */
2156 volatile Lisp_Object
*var
;
2158 /* Number of consecutive protected variables. */
2166 /* Values of GC_MARK_STACK during compilation:
2168 0 Use GCPRO as before
2169 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2170 2 Mark the stack, and check that everything GCPRO'd is
2172 3 Mark using GCPRO's, mark stack last, and count how many
2173 dead objects are kept alive. */
2176 #define GC_USE_GCPROS_AS_BEFORE 0
2177 #define GC_MAKE_GCPROS_NOOPS 1
2178 #define GC_MARK_STACK_CHECK_GCPROS 2
2179 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2181 #ifndef GC_MARK_STACK
2182 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2185 /* Whether we do the stack marking manually. */
2186 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2187 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2190 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2192 /* Do something silly with gcproN vars just so gcc shuts up. */
2193 /* You get warnings from MIPSPro... */
2195 #define GCPRO1(varname) ((void) gcpro1)
2196 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2197 #define GCPRO3(varname1, varname2, varname3) \
2198 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2199 #define GCPRO4(varname1, varname2, varname3, varname4) \
2200 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2201 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2202 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2203 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2204 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2206 #define UNGCPRO ((void) 0)
2208 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2212 #define GCPRO1(varname) \
2213 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2214 gcprolist = &gcpro1; }
2216 #define GCPRO2(varname1, varname2) \
2217 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2218 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2219 gcprolist = &gcpro2; }
2221 #define GCPRO3(varname1, varname2, varname3) \
2222 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2223 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2224 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2225 gcprolist = &gcpro3; }
2227 #define GCPRO4(varname1, varname2, varname3, varname4) \
2228 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2229 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2230 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2231 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2232 gcprolist = &gcpro4; }
2234 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2235 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2236 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2237 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2238 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2239 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2240 gcprolist = &gcpro5; }
2242 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2243 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2244 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2245 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2246 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2247 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2248 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2249 gcprolist = &gcpro6; }
2251 #define UNGCPRO (gcprolist = gcpro1.next)
2255 extern int gcpro_level
;
2257 #define GCPRO1(varname) \
2258 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2259 gcpro1.level = gcpro_level++; \
2260 gcprolist = &gcpro1; }
2262 #define GCPRO2(varname1, varname2) \
2263 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2264 gcpro1.level = gcpro_level; \
2265 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2266 gcpro2.level = gcpro_level++; \
2267 gcprolist = &gcpro2; }
2269 #define GCPRO3(varname1, varname2, varname3) \
2270 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2271 gcpro1.level = gcpro_level; \
2272 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2273 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2274 gcpro3.level = gcpro_level++; \
2275 gcprolist = &gcpro3; }
2277 #define GCPRO4(varname1, varname2, varname3, varname4) \
2278 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2279 gcpro1.level = gcpro_level; \
2280 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2281 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2282 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2283 gcpro4.level = gcpro_level++; \
2284 gcprolist = &gcpro4; }
2286 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2287 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2288 gcpro1.level = gcpro_level; \
2289 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2290 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2291 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2292 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2293 gcpro5.level = gcpro_level++; \
2294 gcprolist = &gcpro5; }
2296 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2297 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2298 gcpro1.level = gcpro_level; \
2299 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2300 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2301 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2302 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2303 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2304 gcpro6.level = gcpro_level++; \
2305 gcprolist = &gcpro6; }
2308 ((--gcpro_level != gcpro1.level) \
2310 : ((gcprolist = gcpro1.next), 0))
2312 #endif /* DEBUG_GCPRO */
2313 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2316 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2317 #define RETURN_UNGCPRO(expr) \
2320 Lisp_Object ret_ungc_val; \
2321 ret_ungc_val = (expr); \
2323 return ret_ungc_val; \
2327 /* Call staticpro (&var) to protect static variable `var'. */
2329 void staticpro (Lisp_Object
*);
2331 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2332 meaning as in the DEFUN macro, and is used to construct a prototype. */
2333 /* We can use the same trick as in the DEFUN macro to generate the
2334 appropriate prototype. */
2335 #define EXFUN(fnname, maxargs) \
2336 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2338 /* Forward declarations for prototypes. */
2342 /* Simple access functions. */
2344 LISP_INLINE Lisp_Object
*
2345 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2347 return & XVECTOR (array
)->contents
[idx
];
2351 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2353 /* Like ASET, but also can be used in the garbage collector:
2354 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2355 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2356 XVECTOR (array
)->contents
[idx
] = val
;
2359 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2362 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2364 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2365 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2368 /* Functions to modify hash tables. */
2371 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2373 h
->key_and_value
= key_and_value
;
2377 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2379 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2383 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2385 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2389 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2395 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2397 gc_aset (h
->next
, idx
, val
);
2401 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2407 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2409 gc_aset (h
->hash
, idx
, val
);
2413 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2419 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2421 gc_aset (h
->index
, idx
, val
);
2424 /* Use these functions to set Lisp_Object
2425 or pointer slots of struct Lisp_Symbol. */
2428 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2430 XSYMBOL (sym
)->name
= name
;
2434 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2436 XSYMBOL (sym
)->function
= function
;
2440 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2442 XSYMBOL (sym
)->plist
= plist
;
2446 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2448 XSYMBOL (sym
)->next
= next
;
2451 /* Buffer-local (also frame-local) variable access functions. */
2454 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2456 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2461 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2463 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2467 LISP_INLINE Lisp_Object
2468 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2470 return XCDR (blv
->valcell
);
2474 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2476 XSETCDR (blv
->valcell
, val
);
2480 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2486 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2492 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2497 /* Set overlay's property list. */
2500 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2502 XOVERLAY (overlay
)->plist
= plist
;
2505 /* Get text properties of S. */
2507 LISP_INLINE INTERVAL
2508 string_intervals (Lisp_Object s
)
2510 return XSTRING (s
)->intervals
;
2513 /* Set text properties of S to I. */
2516 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2518 XSTRING (s
)->intervals
= i
;
2521 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2522 of setting slots directly. */
2525 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2527 XCHAR_TABLE (table
)->ascii
= val
;
2530 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2532 XCHAR_TABLE (table
)->defalt
= val
;
2535 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2537 XCHAR_TABLE (table
)->parent
= val
;
2540 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2542 XCHAR_TABLE (table
)->purpose
= val
;
2545 /* Set different slots in (sub)character tables. */
2548 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2550 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2551 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2555 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2557 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2558 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2562 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2564 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2567 /* Defined in data.c. */
2568 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2569 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2570 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2571 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2572 extern Lisp_Object Qinvalid_read_syntax
;
2573 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2574 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2575 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2576 extern Lisp_Object Qtext_read_only
;
2577 extern Lisp_Object Qinteractive_form
;
2578 extern Lisp_Object Qcircular_list
;
2579 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2580 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2581 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2582 extern Lisp_Object Qbuffer_or_string_p
;
2583 extern Lisp_Object Qfboundp
;
2584 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2586 extern Lisp_Object Qcdr
;
2588 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2589 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2591 extern Lisp_Object Qfloatp
;
2592 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2594 extern Lisp_Object Qinteger
, Qinterval
, Qsymbol
, Qstring
;
2595 extern Lisp_Object Qmisc
, Qvector
, Qfloat
, Qcons
, Qbuffer
;
2597 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2599 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2601 /* Defined in frame.c */
2602 extern Lisp_Object Qframep
;
2604 /* Defined in data.c */
2605 extern Lisp_Object
indirect_function (Lisp_Object
);
2606 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2608 /* Convert the integer I to an Emacs representation, either the integer
2609 itself, or a cons of two or three integers, or if all else fails a float.
2610 I should not have side effects. */
2611 #define INTEGER_TO_CONS(i) \
2612 (! FIXNUM_OVERFLOW_P (i) \
2614 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2615 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2616 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2617 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2618 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2619 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2620 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2621 ? Fcons (make_number ((i) >> 16 >> 24), \
2622 Fcons (make_number ((i) >> 16 & 0xffffff), \
2623 make_number ((i) & 0xffff))) \
2626 /* Convert the Emacs representation CONS back to an integer of type
2627 TYPE, storing the result the variable VAR. Signal an error if CONS
2628 is not a valid representation or is out of range for TYPE. */
2629 #define CONS_TO_INTEGER(cons, type, var) \
2630 (TYPE_SIGNED (type) \
2631 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2632 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2633 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2634 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2636 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2637 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2638 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2640 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2641 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2642 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2643 extern void syms_of_data (void);
2644 extern void init_data (void);
2645 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2647 /* Defined in cmds.c */
2648 extern void syms_of_cmds (void);
2649 extern void keys_of_cmds (void);
2651 /* Defined in coding.c */
2652 extern Lisp_Object Qcharset
;
2653 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2654 ptrdiff_t, int, int, Lisp_Object
);
2655 extern void init_coding (void);
2656 extern void init_coding_once (void);
2657 extern void syms_of_coding (void);
2659 /* Defined in character.c */
2660 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2661 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2662 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2663 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2664 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2665 extern void syms_of_character (void);
2667 /* Defined in charset.c */
2668 extern void init_charset (void);
2669 extern void init_charset_once (void);
2670 extern void syms_of_charset (void);
2671 /* Structure forward declarations. */
2674 /* Defined in composite.c */
2675 extern void syms_of_composite (void);
2677 /* Defined in syntax.c */
2678 extern void init_syntax_once (void);
2679 extern void syms_of_syntax (void);
2681 /* Defined in fns.c */
2682 /* Combine two integers X and Y for hashing. The result might not fit
2683 into a Lisp integer. */
2684 #define SXHASH_COMBINE(X, Y) \
2685 ((((EMACS_UINT) (X) << 4) + ((EMACS_UINT) (X) >> (BITS_PER_EMACS_INT - 4))) \
2687 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2688 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2689 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2690 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2691 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2692 extern void sweep_weak_hash_tables (void);
2693 extern Lisp_Object Qcursor_in_echo_area
;
2694 extern Lisp_Object Qstring_lessp
;
2695 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2696 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2697 EMACS_UINT
sxhash (Lisp_Object
, int);
2698 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2699 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2701 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2702 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2705 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2706 ptrdiff_t, ptrdiff_t);
2707 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2708 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2709 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2710 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2711 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2712 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2713 extern void clear_string_char_byte_cache (void);
2714 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2715 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2716 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2717 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2718 extern void syms_of_fns (void);
2720 /* Defined in floatfns.c */
2721 extern double extract_float (Lisp_Object
);
2722 extern void init_floatfns (void);
2723 extern void syms_of_floatfns (void);
2724 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2726 /* Defined in fringe.c */
2727 extern void syms_of_fringe (void);
2728 extern void init_fringe (void);
2729 #ifdef HAVE_WINDOW_SYSTEM
2730 extern void mark_fringe_data (void);
2731 extern void init_fringe_once (void);
2732 #endif /* HAVE_WINDOW_SYSTEM */
2734 /* Defined in image.c */
2735 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2736 extern Lisp_Object QCconversion
;
2737 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2738 extern void syms_of_image (void);
2740 /* Defined in insdel.c */
2741 extern Lisp_Object Qinhibit_modification_hooks
;
2742 extern void move_gap (ptrdiff_t);
2743 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2744 extern _Noreturn
void buffer_overflow (void);
2745 extern void make_gap (ptrdiff_t);
2746 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2747 ptrdiff_t, int, int);
2748 extern int count_combining_before (const unsigned char *,
2749 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2750 extern int count_combining_after (const unsigned char *,
2751 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2752 extern void insert (const char *, ptrdiff_t);
2753 extern void insert_and_inherit (const char *, ptrdiff_t);
2754 extern void insert_1 (const char *, ptrdiff_t, int, int, int);
2755 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2757 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2758 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2759 ptrdiff_t, ptrdiff_t, int);
2760 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2761 extern void insert_char (int);
2762 extern void insert_string (const char *);
2763 extern void insert_before_markers (const char *, ptrdiff_t);
2764 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2765 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2766 ptrdiff_t, ptrdiff_t,
2768 extern void del_range (ptrdiff_t, ptrdiff_t);
2769 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, int, int);
2770 extern void del_range_byte (ptrdiff_t, ptrdiff_t, int);
2771 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int);
2772 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2773 ptrdiff_t, ptrdiff_t, int);
2774 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2775 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2776 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2777 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2778 ptrdiff_t, ptrdiff_t);
2779 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2780 ptrdiff_t, ptrdiff_t);
2781 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, int, int, int);
2782 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2783 const char *, ptrdiff_t, ptrdiff_t, int);
2784 extern void syms_of_insdel (void);
2786 /* Defined in dispnew.c */
2787 #if (defined PROFILING \
2788 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2789 _Noreturn
void __executable_start (void);
2791 extern Lisp_Object selected_frame
;
2792 extern Lisp_Object Vwindow_system
;
2793 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2794 extern void init_display (void);
2795 extern void syms_of_display (void);
2797 /* Defined in xdisp.c */
2798 extern Lisp_Object Qinhibit_point_motion_hooks
;
2799 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2800 extern Lisp_Object Qmenu_bar_update_hook
;
2801 extern Lisp_Object Qwindow_scroll_functions
;
2802 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2803 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2804 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2805 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2806 extern Lisp_Object Qleft_margin
, Qright_margin
;
2807 extern Lisp_Object Qglyphless_char
;
2808 extern Lisp_Object QCdata
, QCfile
;
2809 extern Lisp_Object QCmap
;
2810 extern Lisp_Object Qrisky_local_variable
;
2811 extern struct frame
*last_glyphless_glyph_frame
;
2812 extern int last_glyphless_glyph_face_id
;
2813 extern int last_glyphless_glyph_merged_face_id
;
2814 extern int noninteractive_need_newline
;
2815 extern Lisp_Object echo_area_buffer
[2];
2816 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2817 extern void check_message_stack (void);
2818 extern void setup_echo_area_for_printing (int);
2819 extern bool push_message (void);
2820 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2821 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2822 extern void restore_message (void);
2823 extern Lisp_Object
current_message (void);
2824 extern void clear_message (int, int);
2825 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2826 extern void message1 (const char *);
2827 extern void message1_nolog (const char *);
2828 extern void message2 (const char *, ptrdiff_t, int);
2829 extern void message2_nolog (const char *, ptrdiff_t, int);
2830 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2831 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2832 extern void message_dolog (const char *, ptrdiff_t, int, int);
2833 extern void message_with_string (const char *, Lisp_Object
, int);
2834 extern void message_log_maybe_newline (void);
2835 extern void update_echo_area (void);
2836 extern void truncate_echo_area (ptrdiff_t);
2837 extern void redisplay (void);
2838 extern void redisplay_preserve_echo_area (int);
2839 extern void prepare_menu_bars (void);
2841 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2842 extern void syms_of_xdisp (void);
2843 extern void init_xdisp (void);
2844 extern Lisp_Object
safe_eval (Lisp_Object
);
2845 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2846 int *, int *, int *, int *, int *);
2848 /* Defined in xsettings.c */
2849 extern void syms_of_xsettings (void);
2851 /* Defined in vm-limit.c. */
2852 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2854 /* Defined in alloc.c */
2855 extern void check_pure_size (void);
2856 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2857 extern void reset_malloc_hooks (void);
2858 extern void uninterrupt_malloc (void);
2859 extern void malloc_warning (const char *);
2860 extern _Noreturn
void memory_full (size_t);
2861 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2862 extern bool survives_gc_p (Lisp_Object
);
2863 extern void mark_object (Lisp_Object
);
2864 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2865 extern void refill_memory_reserve (void);
2867 extern const char *pending_malloc_warning
;
2868 extern Lisp_Object zero_vector
;
2869 extern Lisp_Object
*stack_base
;
2870 extern EMACS_INT consing_since_gc
;
2871 extern EMACS_INT gc_relative_threshold
;
2872 extern EMACS_INT memory_full_cons_threshold
;
2873 extern Lisp_Object
list1 (Lisp_Object
);
2874 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2875 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2876 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2877 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2879 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2880 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2881 extern _Noreturn
void string_overflow (void);
2882 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2883 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2884 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2885 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2887 /* Make unibyte string from C string when the length isn't known. */
2889 LISP_INLINE Lisp_Object
2890 build_unibyte_string (const char *str
)
2892 return make_unibyte_string (str
, strlen (str
));
2895 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2896 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2897 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2898 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2899 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2900 extern Lisp_Object
make_specified_string (const char *,
2901 ptrdiff_t, ptrdiff_t, bool);
2902 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2903 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2905 /* Make a string allocated in pure space, use STR as string data. */
2907 LISP_INLINE Lisp_Object
2908 build_pure_c_string (const char *str
)
2910 return make_pure_c_string (str
, strlen (str
));
2913 /* Make a string from the data at STR, treating it as multibyte if the
2916 LISP_INLINE Lisp_Object
2917 build_string (const char *str
)
2919 return make_string (str
, strlen (str
));
2922 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2923 extern void make_byte_code (struct Lisp_Vector
*);
2924 extern Lisp_Object Qchar_table_extra_slots
;
2925 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2926 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2927 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2929 allocate_pseudovector \
2930 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2931 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2932 extern struct window
*allocate_window (void);
2933 extern struct frame
*allocate_frame (void);
2934 extern struct Lisp_Process
*allocate_process (void);
2935 extern struct terminal
*allocate_terminal (void);
2936 extern bool gc_in_progress
;
2937 extern bool abort_on_gc
;
2938 extern Lisp_Object
make_float (double);
2939 extern void display_malloc_warning (void);
2940 extern ptrdiff_t inhibit_garbage_collection (void);
2941 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2942 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2943 extern void free_marker (Lisp_Object
);
2944 extern void free_cons (struct Lisp_Cons
*);
2945 extern void init_alloc_once (void);
2946 extern void init_alloc (void);
2947 extern void syms_of_alloc (void);
2948 extern struct buffer
* allocate_buffer (void);
2949 extern int valid_lisp_object_p (Lisp_Object
);
2950 #ifdef GC_CHECK_CONS_LIST
2951 extern void check_cons_list (void);
2953 #define check_cons_list() ((void) 0)
2957 /* Defined in ralloc.c */
2958 extern void *r_alloc (void **, size_t);
2959 extern void r_alloc_free (void **);
2960 extern void *r_re_alloc (void **, size_t);
2961 extern void r_alloc_reset_variable (void **, void **);
2962 extern void r_alloc_inhibit_buffer_relocation (int);
2965 /* Defined in chartab.c */
2966 extern Lisp_Object
copy_char_table (Lisp_Object
);
2967 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2968 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2970 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
2971 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
2972 extern int char_table_translate (Lisp_Object
, int);
2973 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2975 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2976 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2977 Lisp_Object
, Lisp_Object
,
2978 Lisp_Object
, struct charset
*,
2979 unsigned, unsigned);
2980 extern Lisp_Object
uniprop_table (Lisp_Object
);
2981 extern void syms_of_chartab (void);
2983 /* Defined in print.c */
2984 extern Lisp_Object Vprin1_to_string_buffer
;
2985 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2986 extern Lisp_Object Qstandard_output
;
2987 extern Lisp_Object Qexternal_debugging_output
;
2988 extern void temp_output_buffer_setup (const char *);
2989 extern int print_level
;
2990 extern Lisp_Object Qprint_escape_newlines
;
2991 extern void write_string (const char *, int);
2992 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2994 extern Lisp_Object internal_with_output_to_temp_buffer
2995 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2996 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
2997 extern int float_to_string (char *, double);
2998 extern void syms_of_print (void);
3000 /* Defined in doprnt.c */
3001 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3003 extern ptrdiff_t esprintf (char *, char const *, ...)
3004 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3005 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3007 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3008 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3009 char const *, va_list)
3010 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3012 /* Defined in lread.c. */
3013 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3014 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3015 extern Lisp_Object
check_obarray (Lisp_Object
);
3016 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3017 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3018 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3019 #define LOADHIST_ATTACH(x) \
3021 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3023 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3024 Lisp_Object
*, Lisp_Object
);
3025 Lisp_Object
string_to_number (char const *, int, int);
3026 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3028 extern void dir_warning (const char *, Lisp_Object
);
3029 extern void close_load_descs (void);
3030 extern void init_obarray (void);
3031 extern void init_lread (void);
3032 extern void syms_of_lread (void);
3034 LISP_INLINE Lisp_Object
3035 intern (const char *str
)
3037 return intern_1 (str
, strlen (str
));
3040 LISP_INLINE Lisp_Object
3041 intern_c_string (const char *str
)
3043 return intern_c_string_1 (str
, strlen (str
));
3046 /* Defined in eval.c. */
3047 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3048 extern Lisp_Object Qinhibit_quit
, Qclosure
;
3049 extern Lisp_Object Qand_rest
;
3050 extern Lisp_Object Vautoload_queue
;
3051 extern Lisp_Object Vsignaling_function
;
3052 extern Lisp_Object inhibit_lisp_code
;
3053 extern int handling_signal
;
3055 extern struct catchtag
*catchlist
;
3056 extern struct handler
*handlerlist
;
3058 /* To run a normal hook, use the appropriate function from the list below.
3059 The calling convention:
3061 if (!NILP (Vrun_hooks))
3062 call1 (Vrun_hooks, Qmy_funny_hook);
3064 should no longer be used. */
3065 extern Lisp_Object Vrun_hooks
;
3066 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3067 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3068 Lisp_Object (*funcall
)
3069 (ptrdiff_t nargs
, Lisp_Object
*args
));
3070 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3071 extern _Noreturn
void xsignal0 (Lisp_Object
);
3072 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3073 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3074 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3076 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3077 extern Lisp_Object
eval_sub (Lisp_Object form
);
3078 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3079 extern Lisp_Object
call0 (Lisp_Object
);
3080 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3081 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3082 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3083 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3084 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3085 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3086 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3087 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3088 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3089 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3090 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3091 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3092 extern Lisp_Object internal_condition_case_n
3093 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3094 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3095 extern void specbind (Lisp_Object
, Lisp_Object
);
3096 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3097 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3098 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3099 extern _Noreturn
void verror (const char *, va_list)
3100 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3101 extern Lisp_Object
un_autoload (Lisp_Object
);
3102 extern void init_eval_once (void);
3103 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3104 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3105 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3106 extern void init_eval (void);
3108 extern void mark_backtrace (void);
3110 extern void syms_of_eval (void);
3112 /* Defined in editfns.c. */
3113 extern Lisp_Object Qfield
;
3114 extern void insert1 (Lisp_Object
);
3115 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3116 extern Lisp_Object
save_excursion_save (void);
3117 extern Lisp_Object
save_restriction_save (void);
3118 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3119 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3120 extern _Noreturn
void time_overflow (void);
3121 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, int);
3122 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3124 extern void init_editfns (void);
3125 const char *get_system_name (void);
3126 extern void syms_of_editfns (void);
3127 extern void set_time_zone_rule (const char *);
3129 /* Defined in buffer.c. */
3130 extern int mouse_face_overlay_overlaps (Lisp_Object
);
3131 extern _Noreturn
void nsberror (Lisp_Object
);
3132 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3133 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3134 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3135 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
3136 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3137 extern int overlay_touches_p (ptrdiff_t);
3138 extern Lisp_Object Vbuffer_alist
;
3139 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3140 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3141 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3142 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3143 extern void init_buffer_once (void);
3144 extern void init_buffer (void);
3145 extern void syms_of_buffer (void);
3146 extern void keys_of_buffer (void);
3148 /* Defined in marker.c. */
3150 extern ptrdiff_t marker_position (Lisp_Object
);
3151 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3152 extern void clear_charpos_cache (struct buffer
*);
3153 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3154 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3155 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3156 extern void unchain_marker (struct Lisp_Marker
*marker
);
3157 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3158 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3159 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3160 ptrdiff_t, ptrdiff_t);
3161 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3162 extern void syms_of_marker (void);
3164 /* Defined in fileio.c */
3166 extern Lisp_Object Qfile_error
;
3167 extern Lisp_Object Qfile_exists_p
;
3168 extern Lisp_Object Qfile_directory_p
;
3169 extern Lisp_Object Qinsert_file_contents
;
3170 extern Lisp_Object Qfile_name_history
;
3171 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3172 EXFUN (Fread_file_name
, 6); /* not a normal DEFUN */
3173 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3174 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3175 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3176 extern int internal_delete_file (Lisp_Object
);
3177 extern void syms_of_fileio (void);
3178 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
3179 extern Lisp_Object Qdelete_file
;
3181 /* Defined in search.c */
3182 extern void shrink_regexp_cache (void);
3183 extern void restore_search_regs (void);
3184 extern void record_unwind_save_match_data (void);
3185 struct re_registers
;
3186 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3187 struct re_registers
*,
3188 Lisp_Object
, int, int);
3189 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3190 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3192 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3193 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3194 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3195 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3197 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3199 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3200 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3201 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3202 extern void syms_of_search (void);
3203 extern void clear_regexp_cache (void);
3205 /* Defined in minibuf.c. */
3207 extern Lisp_Object Qcompletion_ignore_case
;
3208 extern Lisp_Object Vminibuffer_list
;
3209 extern Lisp_Object last_minibuf_string
;
3210 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3211 extern void init_minibuf_once (void);
3212 extern void syms_of_minibuf (void);
3214 /* Defined in callint.c. */
3216 extern Lisp_Object Qminus
, Qplus
;
3217 extern Lisp_Object Qwhen
;
3218 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3219 extern void syms_of_callint (void);
3221 /* Defined in casefiddle.c. */
3223 extern Lisp_Object Qidentity
;
3224 extern void syms_of_casefiddle (void);
3225 extern void keys_of_casefiddle (void);
3227 /* Defined in casetab.c. */
3229 extern void init_casetab_once (void);
3230 extern void syms_of_casetab (void);
3232 /* Defined in keyboard.c. */
3234 extern Lisp_Object echo_message_buffer
;
3235 extern struct kboard
*echo_kboard
;
3236 extern void cancel_echoing (void);
3237 extern Lisp_Object Qdisabled
, QCfilter
;
3238 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3239 extern Lisp_Object Qtop
;
3240 extern Lisp_Object last_undo_boundary
;
3241 extern int input_pending
;
3242 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3243 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3244 extern void discard_mouse_events (void);
3245 extern Lisp_Object pending_funcalls
;
3246 extern int detect_input_pending (void);
3247 extern int detect_input_pending_ignore_squeezables (void);
3248 extern int detect_input_pending_run_timers (int);
3249 extern void safe_run_hooks (Lisp_Object
);
3250 extern void cmd_error_internal (Lisp_Object
, const char *);
3251 extern Lisp_Object
command_loop_1 (void);
3252 extern Lisp_Object
recursive_edit_1 (void);
3253 extern void record_auto_save (void);
3255 extern void force_auto_save_soon (void);
3257 extern void init_keyboard (void);
3258 extern void syms_of_keyboard (void);
3259 extern void keys_of_keyboard (void);
3261 /* Defined in indent.c. */
3262 extern ptrdiff_t current_column (void);
3263 extern void invalidate_current_column (void);
3264 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3265 extern void syms_of_indent (void);
3267 /* Defined in frame.c. */
3268 extern Lisp_Object Qonly
, Qnone
;
3269 extern Lisp_Object Qvisible
;
3270 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3271 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3272 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3274 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3276 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3277 extern void frames_discard_buffer (Lisp_Object
);
3278 extern void syms_of_frame (void);
3280 /* Defined in emacs.c. */
3281 extern char **initial_argv
;
3282 extern int initial_argc
;
3283 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3284 extern int display_arg
;
3286 extern Lisp_Object
decode_env_path (const char *, const char *);
3287 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3288 extern Lisp_Object Qfile_name_handler_alist
;
3289 #ifdef FLOAT_CATCH_SIGILL
3290 extern void fatal_error_signal (int);
3292 extern Lisp_Object Qkill_emacs
;
3294 void fixup_locale (void);
3295 void synchronize_system_messages_locale (void);
3296 void synchronize_system_time_locale (void);
3298 #define setlocale(category, locale)
3299 #define fixup_locale()
3300 #define synchronize_system_messages_locale()
3301 #define synchronize_system_time_locale()
3303 void shut_down_emacs (int, int, Lisp_Object
);
3304 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3305 extern int noninteractive
;
3307 /* Nonzero means remove site-lisp directories from load-path. */
3308 extern int no_site_lisp
;
3310 /* Pipe used to send exit notification to the daemon parent at
3312 extern int daemon_pipe
[2];
3313 #define IS_DAEMON (daemon_pipe[1] != 0)
3315 /* Nonzero means don't do use window-system-specific display code. */
3316 extern int inhibit_window_system
;
3317 /* Nonzero means that a filter or a sentinel is running. */
3318 extern int running_asynch_code
;
3320 /* Defined in process.c. */
3321 extern Lisp_Object QCtype
, Qlocal
;
3322 extern Lisp_Object Qprocessp
;
3323 extern void kill_buffer_processes (Lisp_Object
);
3324 extern int wait_reading_process_output (intmax_t, int, int, int,
3326 struct Lisp_Process
*,
3328 /* Max value for the first argument of wait_reading_process_output. */
3329 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3330 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3331 The bug merely causes a bogus warning, but the warning is annoying. */
3332 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3334 # define WAIT_READING_MAX INTMAX_MAX
3336 extern void add_keyboard_wait_descriptor (int);
3337 extern void delete_keyboard_wait_descriptor (int);
3339 extern void add_gpm_wait_descriptor (int);
3340 extern void delete_gpm_wait_descriptor (int);
3342 extern void close_process_descs (void);
3343 extern void init_process_emacs (void);
3344 extern void syms_of_process (void);
3345 extern void setup_process_coding_systems (Lisp_Object
);
3350 extern int child_setup (int, int, int, char **, int, Lisp_Object
);
3351 extern void init_callproc_1 (void);
3352 extern void init_callproc (void);
3353 extern void set_initial_environment (void);
3354 extern void syms_of_callproc (void);
3356 /* Defined in doc.c */
3357 extern Lisp_Object Qfunction_documentation
;
3358 extern Lisp_Object
read_doc_string (Lisp_Object
);
3359 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3360 extern void syms_of_doc (void);
3361 extern int read_bytecode_char (int);
3363 /* Defined in bytecode.c */
3364 extern Lisp_Object Qbytecode
;
3365 extern void syms_of_bytecode (void);
3366 extern struct byte_stack
*byte_stack_list
;
3368 extern void mark_byte_stack (void);
3370 extern void unmark_byte_stack (void);
3371 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3372 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3374 /* Defined in macros.c */
3375 extern Lisp_Object Qexecute_kbd_macro
;
3376 extern void init_macros (void);
3377 extern void syms_of_macros (void);
3379 /* Defined in undo.c */
3380 extern Lisp_Object Qapply
;
3381 extern Lisp_Object Qinhibit_read_only
;
3382 extern void truncate_undo_list (struct buffer
*);
3383 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3384 extern void record_insert (ptrdiff_t, ptrdiff_t);
3385 extern void record_delete (ptrdiff_t, Lisp_Object
);
3386 extern void record_first_change (void);
3387 extern void record_change (ptrdiff_t, ptrdiff_t);
3388 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3389 Lisp_Object
, Lisp_Object
,
3391 extern void syms_of_undo (void);
3392 /* Defined in textprop.c */
3393 extern Lisp_Object Qfont
, Qmouse_face
;
3394 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3395 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3396 extern Lisp_Object Qminibuffer_prompt
;
3398 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3400 /* Defined in menu.c */
3401 extern void syms_of_menu (void);
3403 /* Defined in xmenu.c */
3404 extern void syms_of_xmenu (void);
3406 /* Defined in termchar.h */
3407 struct tty_display_info
;
3409 /* Defined in termhooks.h */
3412 /* Defined in sysdep.c */
3413 #ifndef HAVE_GET_CURRENT_DIR_NAME
3414 extern char *get_current_dir_name (void);
3416 extern void stuff_char (char c
);
3417 extern void init_sigio (int);
3418 extern void sys_subshell (void);
3419 extern void sys_suspend (void);
3420 extern void discard_tty_input (void);
3421 extern void init_sys_modes (struct tty_display_info
*);
3422 extern void reset_sys_modes (struct tty_display_info
*);
3423 extern void init_all_sys_modes (void);
3424 extern void reset_all_sys_modes (void);
3425 extern void wait_for_termination (pid_t
);
3426 extern void interruptible_wait_for_termination (pid_t
);
3427 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3428 extern void child_setup_tty (int);
3429 extern void setup_pty (int);
3430 extern int set_window_size (int, int, int);
3431 extern EMACS_INT
get_random (void);
3432 extern void seed_random (long);
3433 extern int emacs_open (const char *, int, int);
3434 extern int emacs_close (int);
3435 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3436 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3437 enum { READLINK_BUFSIZE
= 1024 };
3438 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3440 extern void unlock_all_files (void);
3441 extern void lock_file (Lisp_Object
);
3442 extern void unlock_file (Lisp_Object
);
3443 extern void unlock_buffer (struct buffer
*);
3444 extern void syms_of_filelock (void);
3446 /* Defined in sound.c */
3447 extern void syms_of_sound (void);
3449 /* Defined in category.c */
3450 extern void init_category_once (void);
3451 extern Lisp_Object
char_category_set (int);
3452 extern void syms_of_category (void);
3454 /* Defined in ccl.c */
3455 extern void syms_of_ccl (void);
3457 /* Defined in dired.c */
3458 extern void syms_of_dired (void);
3459 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3460 Lisp_Object
, Lisp_Object
,
3463 /* Defined in term.c */
3464 extern int *char_ins_del_vector
;
3465 extern void mark_ttys (void);
3466 extern void syms_of_term (void);
3467 extern _Noreturn
void fatal (const char *msgid
, ...)
3468 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3470 /* Defined in terminal.c */
3471 extern void syms_of_terminal (void);
3473 /* Defined in font.c */
3474 extern void syms_of_font (void);
3475 extern void init_font (void);
3477 #ifdef HAVE_WINDOW_SYSTEM
3478 /* Defined in fontset.c */
3479 extern void syms_of_fontset (void);
3481 /* Defined in xfns.c, w32fns.c, or macfns.c */
3482 extern Lisp_Object Qfont_param
;
3485 /* Defined in xfaces.c */
3486 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3487 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3488 extern Lisp_Object Qmode_line_inactive
;
3489 extern Lisp_Object Qface
;
3490 extern Lisp_Object Qnormal
;
3491 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3492 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3493 extern Lisp_Object Vface_alternative_font_family_alist
;
3494 extern Lisp_Object Vface_alternative_font_registry_alist
;
3495 extern void syms_of_xfaces (void);
3497 #ifdef HAVE_X_WINDOWS
3498 /* Defined in xfns.c */
3499 extern void syms_of_xfns (void);
3501 /* Defined in xsmfns.c */
3502 extern void syms_of_xsmfns (void);
3504 /* Defined in xselect.c */
3505 extern void syms_of_xselect (void);
3507 /* Defined in xterm.c */
3508 extern void syms_of_xterm (void);
3509 #endif /* HAVE_X_WINDOWS */
3511 #ifdef HAVE_WINDOW_SYSTEM
3512 /* Defined in xterm.c, nsterm.m, w32term.c */
3513 extern char *x_get_keysym_name (int);
3514 #endif /* HAVE_WINDOW_SYSTEM */
3517 /* Defined in xml.c */
3518 extern void syms_of_xml (void);
3519 extern void xml_cleanup_parser (void);
3523 /* Defined in (x|w32)fns.c, nsfns.m... */
3524 extern int have_menus_p (void);
3528 /* Defined in dbusbind.c */
3529 void syms_of_dbusbind (void);
3532 /* Defined in profiler.c */
3533 extern bool sample_profiler_running
;
3534 extern bool memory_profiler_running
;
3535 extern bool is_in_trace
;
3536 extern Lisp_Object Qgc
;
3537 extern void malloc_probe (size_t);
3538 extern void gc_probe (size_t, size_t);
3539 #define ENTER_TRACE (is_in_trace = 1)
3540 #define LEAVE_TRACE (is_in_trace = 0)
3541 #define MALLOC_PROBE(size) \
3543 if (memory_profiler_running) \
3544 malloc_probe (size); \
3547 extern void mark_profiler (void);
3548 extern void syms_of_profiler (void);
3551 /* Defined in msdos.c, w32.c */
3552 extern char *emacs_root_dir (void);
3555 /* Nonzero means Emacs has already been initialized.
3556 Used during startup to detect startup of dumped Emacs. */
3557 extern int initialized
;
3559 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3561 extern void *xmalloc (size_t);
3562 extern void *xzalloc (size_t);
3563 extern void *xrealloc (void *, size_t);
3564 extern void xfree (void *);
3565 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3566 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3567 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3569 extern char *xstrdup (const char *);
3571 extern char *egetenv (const char *);
3573 /* Set up the name of the machine we're running on. */
3574 extern void init_system_name (void);
3576 /* We used to use `abs', but that clashes with system headers on some
3577 platforms, and using a name reserved by Standard C is a bad idea
3580 #define eabs(x) ((x) < 0 ? -(x) : (x))
3583 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3586 #define make_fixnum_or_float(val) \
3587 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3590 /* Checks the `cycle check' variable CHECK to see if it indicates that
3591 EL is part of a cycle; CHECK must be either Qnil or a value returned
3592 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3593 elements after which a cycle might be suspected; after that many
3594 elements, this macro begins consing in order to keep more precise
3597 Returns nil if a cycle was detected, otherwise a new value for CHECK
3600 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3601 the caller should make sure that's ok. */
3603 #define CYCLE_CHECK(check, el, suspicious) \
3606 : (INTEGERP (check) \
3607 ? (XFASTINT (check) < (suspicious) \
3608 ? make_number (XFASTINT (check) + 1) \
3609 : Fcons (el, Qnil)) \
3610 : (!NILP (Fmemq ((el), (check))) \
3612 : Fcons ((el), (check)))))
3615 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3616 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3618 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16*1024 };
3620 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3621 extern void *record_xmalloc (size_t);
3623 #define USE_SAFE_ALLOCA \
3624 ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0
3626 /* SAFE_ALLOCA allocates a simple buffer. */
3628 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3630 : (sa_must_free = 1, record_xmalloc (size)))
3632 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3633 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3634 positive. The code is tuned for MULTIPLIER being a constant. */
3636 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3638 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3639 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3642 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3644 record_unwind_protect (safe_alloca_unwind, \
3645 make_save_value (buf, 0)); \
3649 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3651 #define SAFE_FREE() \
3653 if (sa_must_free) { \
3655 unbind_to (sa_count, Qnil); \
3660 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3662 #define SAFE_ALLOCA_LISP(buf, nelt) \
3664 if ((nelt) < MAX_ALLOCA / word_size) \
3665 buf = alloca ((nelt) * word_size); \
3666 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3669 buf = xmalloc ((nelt) * word_size); \
3670 arg_ = make_save_value (buf, nelt); \
3671 XSAVE_VALUE (arg_)->dogc = 1; \
3673 record_unwind_protect (safe_alloca_unwind, arg_); \
3676 memory_full (SIZE_MAX); \
3680 #include "globals.h"
3682 /* Check whether it's time for GC, and run it if so. */
3687 if ((consing_since_gc
> gc_cons_threshold
3688 && consing_since_gc
> gc_relative_threshold
)
3689 || (!NILP (Vmemory_full
)
3690 && consing_since_gc
> memory_full_cons_threshold
))
3691 Fgarbage_collect ();
3696 #endif /* EMACS_LISP_H */