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/>. */
31 /* The ubiquitous max and min macros. */
34 #define max(a, b) ((a) > (b) ? (a) : (b))
35 #define min(a, b) ((a) < (b) ? (a) : (b))
37 /* EMACS_INT - signed integer wide enough to hold an Emacs value
38 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
39 pI - printf length modifier for EMACS_INT
40 EMACS_UINT - unsigned variant of EMACS_INT */
42 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
43 typedef long long int EMACS_INT
;
44 typedef unsigned long long int EMACS_UINT
;
45 # define EMACS_INT_MAX LLONG_MAX
47 # elif INT_MAX < LONG_MAX
48 typedef long int EMACS_INT
;
49 typedef unsigned long int EMACS_UINT
;
50 # define EMACS_INT_MAX LONG_MAX
53 typedef int EMACS_INT
;
54 typedef unsigned int EMACS_UINT
;
55 # define EMACS_INT_MAX INT_MAX
60 /* Number of bits in some machine integer types. */
63 BITS_PER_CHAR
= CHAR_BIT
,
64 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
65 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
66 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
67 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
70 /* printmax_t and uprintmax_t are types for printing large integers.
71 These are the widest integers that are supported for printing.
72 pMd etc. are conversions for printing them.
73 On C99 hosts, there's no problem, as even the widest integers work.
74 Fall back on EMACS_INT on pre-C99 hosts. */
76 typedef intmax_t printmax_t
;
77 typedef uintmax_t uprintmax_t
;
81 typedef EMACS_INT printmax_t
;
82 typedef EMACS_UINT uprintmax_t
;
87 /* Use pD to format ptrdiff_t values, which suffice for indexes into
88 buffers and strings. Emacs never allocates objects larger than
89 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
90 In C99, pD can always be "t"; configure it here for the sake of
91 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
92 #if PTRDIFF_MAX == INT_MAX
94 #elif PTRDIFF_MAX == LONG_MAX
96 #elif PTRDIFF_MAX == LLONG_MAX
102 /* Extra internal type checking? */
104 /* Define an Emacs version of 'assert (COND)', since some
105 system-defined 'assert's are flaky. COND should be free of side
106 effects; it may or may not be evaluated. */
107 #ifndef ENABLE_CHECKING
108 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
109 #else /* ENABLE_CHECKING */
111 extern _Noreturn
void die (const char *, const char *, int);
113 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
114 it to 1 using a debugger to temporarily disable aborting on
115 detected internal inconsistencies or error conditions.
117 In some cases, a good compiler may be able to optimize away the
118 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
119 STRINGP (x), but a particular use of XSTRING is invoked only after
120 testing that STRINGP (x) is true, making the test redundant. */
121 extern int suppress_checking EXTERNALLY_VISIBLE
;
123 # define eassert(cond) \
124 ((cond) || suppress_checking \
126 : die ("assertion failed: " # cond, __FILE__, __LINE__))
127 #endif /* ENABLE_CHECKING */
129 /* Use the configure flag --enable-check-lisp-object-type to make
130 Lisp_Object use a struct type instead of the default int. The flag
131 causes CHECK_LISP_OBJECT_TYPE to be defined. */
133 /***** Select the tagging scheme. *****/
134 /* The following option controls the tagging scheme:
135 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
136 always 0, and we can thus use them to hold tag bits, without
137 restricting our addressing space.
139 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
140 restricting our possible address range.
142 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
143 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
144 on the few static Lisp_Objects used: all the defsubr as well
145 as the two special buffers buffer_defaults and buffer_local_symbols. */
149 /* Number of bits in a Lisp_Object tag. This can be used in #if,
150 and for GDB's sake also as a regular symbol. */
155 /* 2**GCTYPEBITS. This must also be a macro that expands to a
156 literal integer constant, for MSVC. */
158 #define GCALIGNMENT 8
161 /* Number of bits in a Lisp_Object value, not counting the tag. */
162 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
164 /* Number of bits in a Lisp fixnum tag. */
165 INTTYPEBITS
= GCTYPEBITS
- 1,
167 /* Number of bits in a Lisp fixnum value, not counting the tag. */
168 FIXNUM_BITS
= VALBITS
+ 1
171 #if GCALIGNMENT != 1 << GCTYPEBITS
172 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
175 /* The maximum value that can be stored in a EMACS_INT, assuming all
176 bits other than the type bits contribute to a nonnegative signed value.
177 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
178 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
180 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
182 /* 1. We know malloc returns a multiple of 8. */
183 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
184 || defined DARWIN_OS || defined __sun)
185 /* 2. We can specify multiple-of-8 alignment on static variables. */
187 /* 3. Pointers-as-ints exceed VAL_MAX.
188 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
189 a. unnecessary, because the top bits of an EMACS_INT are unused, and
190 b. slower, because it typically requires extra masking.
191 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
192 # if VAL_MAX < UINTPTR_MAX
193 # define USE_LSB_TAG 1
200 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
201 # define USE_LSB_TAG 1
203 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
204 # define USE_LSB_TAG 0
208 # define alignas(alignment) /* empty */
210 # error "USE_LSB_TAG requires alignas"
215 /* Define the fundamental Lisp data structures. */
217 /* This is the set of Lisp data types. */
219 /* Lisp integers use 2 tags, to give them one extra bit, thus
220 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
221 static EMACS_INT
const INTMASK
= EMACS_INT_MAX
>> (INTTYPEBITS
- 1);
222 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
223 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
225 /* Stolen from GDB. The only known compiler that doesn't support
226 enums in bitfields is MSVC. */
228 #define ENUM_BF(TYPE) unsigned int
230 #define ENUM_BF(TYPE) enum TYPE
236 /* Integer. XINT (obj) is the integer value. */
238 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
240 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
243 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
244 whose first member indicates the subtype. */
247 /* String. XSTRING (object) points to a struct Lisp_String.
248 The length of the string, and its contents, are stored therein. */
249 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
251 /* Vector of Lisp objects, or something resembling it.
252 XVECTOR (object) points to a struct Lisp_Vector, which contains
253 the size and contents. The size field also contains the type
254 information, if it's not a real vector object. */
257 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
263 /* This is the set of data types that share a common structure.
264 The first member of the structure is a type code from this set.
265 The enum values are arbitrary, but we'll use large numbers to make it
266 more likely that we'll spot the error if a random word in memory is
267 mistakenly interpreted as a Lisp_Misc. */
270 Lisp_Misc_Free
= 0x5eab,
273 Lisp_Misc_Save_Value
,
274 /* Currently floats are not a misc type,
275 but let's define this in case we want to change that. */
277 /* This is not a type code. It is for range checking. */
281 /* These are the types of forwarding objects used in the value slot
282 of symbols for special built-in variables whose value is stored in
286 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
287 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
288 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
289 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
290 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
293 #ifdef CHECK_LISP_OBJECT_TYPE
295 typedef struct { EMACS_INT i
; } Lisp_Object
;
298 static inline Lisp_Object
301 Lisp_Object o
= { i
};
305 static inline Lisp_Object
306 LISP_MAKE_RVALUE (Lisp_Object o
)
311 #define LISP_INITIALLY_ZERO {0}
313 #undef CHECK_LISP_OBJECT_TYPE
314 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
315 #else /* CHECK_LISP_OBJECT_TYPE */
317 /* If a struct type is not wanted, define Lisp_Object as just a number. */
319 typedef EMACS_INT Lisp_Object
;
322 #define LISP_MAKE_RVALUE(o) (0+(o))
323 #define LISP_INITIALLY_ZERO 0
324 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
325 #endif /* CHECK_LISP_OBJECT_TYPE */
327 /* In the size word of a vector, this bit means the vector has been marked. */
329 static ptrdiff_t const ARRAY_MARK_FLAG
= PTRDIFF_MIN
;
331 /* In the size word of a struct Lisp_Vector, this bit means it's really
332 some other vector-like object. */
333 static ptrdiff_t const PSEUDOVECTOR_FLAG
= PTRDIFF_MAX
- PTRDIFF_MAX
/ 2;
335 /* In a pseudovector, the size field actually contains a word with one
336 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
337 indicate the actual type.
338 We use a bitset, even tho only one of the bits can be set at any
339 particular time just so as to be able to use micro-optimizations such as
340 testing membership of a particular subset of pseudovectors in Fequal.
341 It is not crucial, but there are plenty of bits here, so why not do it? */
344 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
353 PVEC_WINDOW_CONFIGURATION
,
356 /* These last 4 are special because we OR them in fns.c:internal_equal,
357 so they have to use a disjoint bit pattern:
358 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
359 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
360 PVEC_COMPILED
= 0x10,
361 PVEC_CHAR_TABLE
= 0x20,
362 PVEC_SUB_CHAR_TABLE
= 0x30,
366 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
367 which were stored in a Lisp_Object. */
368 #ifndef DATA_SEG_BITS
369 # define DATA_SEG_BITS 0
371 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
376 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
378 /* For convenience, we also store the number of elements in these bits.
379 Note that this size is not necessarily the memory-footprint size, but
380 only the number of Lisp_Object fields (that need to be traced by GC).
381 The distinction is used, e.g., by Lisp_Process, which places extra
382 non-Lisp_Object fields at the end of the structure. */
383 PSEUDOVECTOR_SIZE_BITS
= 16,
384 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
385 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
387 /* Number of bits to put in each character in the internal representation
388 of bool vectors. This should not vary across implementations. */
389 BOOL_VECTOR_BITS_PER_CHAR
= 8
392 /* These macros extract various sorts of values from a Lisp_Object.
393 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
394 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
396 /* Return a perfect hash of the Lisp_Object representation. */
397 #define XHASH(a) XLI (a)
403 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
406 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
407 #define XINT(a) (XLI (a) >> INTTYPEBITS)
408 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
409 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
410 #define XSET(var, type, ptr) \
411 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
412 (var) = XIL ((type) | (intptr_t) (ptr)))
414 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
415 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
417 #else /* not USE_LSB_TAG */
419 static EMACS_INT
const VALMASK
= VAL_MAX
;
421 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
423 /* For integers known to be positive, XFASTINT provides fast retrieval
424 and XSETFASTINT provides fast storage. This takes advantage of the
425 fact that Lisp integers have zero-bits in their tags. */
426 #define XFASTINT(a) (XLI (a) + 0)
427 #define XSETFASTINT(a, b) ((a) = XIL (b))
429 /* Extract the value of a Lisp_Object as a (un)signed integer. */
431 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
432 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
433 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
435 #define XSET(var, type, ptr) \
436 ((var) = XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
437 + ((intptr_t) (ptr) & VALMASK)))
440 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
441 which were stored in a Lisp_Object */
442 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
444 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
447 #endif /* not USE_LSB_TAG */
449 /* For integers known to be positive, XFASTINT sometimes provides
450 faster retrieval and XSETFASTINT provides faster storage.
451 If not, fallback on the non-accelerated path. */
453 # define XFASTINT(a) (XINT (a))
454 # define XSETFASTINT(a, b) (XSETINT (a, b))
457 /* Extract the pointer value of the Lisp object A, under the
458 assumption that A's type is TYPE. This is a fallback
459 implementation if nothing faster is available. */
461 # define XUNTAG(a, type) XPNTR (a)
464 #define EQ(x, y) (XHASH (x) == XHASH (y))
466 /* Largest and smallest representable fixnum values. These are the C
467 values. They are macros for use in static initializers, and
468 constants for visibility to GDB. */
469 static EMACS_INT
const MOST_POSITIVE_FIXNUM
=
470 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
471 MOST_POSITIVE_FIXNUM
;
472 static EMACS_INT
const MOST_NEGATIVE_FIXNUM
=
473 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
474 MOST_NEGATIVE_FIXNUM
;
476 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
477 written this way so that it also works if I is of unsigned
478 type or if I is a NaN. */
480 #define FIXNUM_OVERFLOW_P(i) \
481 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
483 static inline ptrdiff_t
484 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
486 return num
< lower
? lower
: num
<= upper
? num
: upper
;
489 /* Extract a value or address from a Lisp_Object. */
491 #define XCONS(a) (eassert (CONSP (a)), \
492 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
493 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
494 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
495 #define XSTRING(a) (eassert (STRINGP (a)), \
496 (struct Lisp_String *) XUNTAG (a, Lisp_String))
497 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
498 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
499 #define XFLOAT(a) (eassert (FLOATP (a)), \
500 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
504 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
505 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
506 #define XMISCTYPE(a) (XMISCANY (a)->type)
507 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
508 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
509 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
511 /* Forwarding object types. */
513 #define XFWDTYPE(a) (a->u_intfwd.type)
514 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
515 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
516 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
517 #define XBUFFER_OBJFWD(a) \
518 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
519 #define XKBOARD_OBJFWD(a) \
520 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
522 /* Pseudovector types. */
524 #define XPROCESS(a) (eassert (PROCESSP (a)), \
525 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
526 #define XWINDOW(a) (eassert (WINDOWP (a)), \
527 (struct window *) XUNTAG (a, Lisp_Vectorlike))
528 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
529 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
530 #define XSUBR(a) (eassert (SUBRP (a)), \
531 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
532 #define XBUFFER(a) (eassert (BUFFERP (a)), \
533 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
534 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
535 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
536 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
537 ((struct Lisp_Sub_Char_Table *) \
538 XUNTAG (a, Lisp_Vectorlike)))
539 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
540 ((struct Lisp_Bool_Vector *) \
541 XUNTAG (a, Lisp_Vectorlike)))
543 /* Construct a Lisp_Object from a value or address. */
545 #define XSETINT(a, b) (a) = make_number (b)
546 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
547 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
548 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
549 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
550 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
554 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
555 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
557 /* Pseudovector types. */
559 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
560 #define XSETTYPED_PVECTYPE(v, size_member, code) \
561 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
562 #define XSETPVECTYPESIZE(v, code, sizeval) \
563 ((v)->header.size = (PSEUDOVECTOR_FLAG \
564 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
567 /* The cast to struct vectorlike_header * avoids aliasing issues. */
568 #define XSETPSEUDOVECTOR(a, b, code) \
569 XSETTYPED_PSEUDOVECTOR (a, b, \
570 (((struct vectorlike_header *) \
571 XUNTAG (a, Lisp_Vectorlike)) \
574 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
575 (XSETVECTOR (a, b), \
576 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
577 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
579 #define XSETWINDOW_CONFIGURATION(a, b) \
580 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
581 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
582 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
583 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
584 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
585 #define XSETSUBR(a, b) \
586 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
587 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
588 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
589 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
590 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
591 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
593 /* Convenience macros for dealing with Lisp arrays. */
595 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
596 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
597 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
598 #define ASET(ARRAY, IDX, VAL) \
599 (eassert ((IDX) == (IDX)), \
600 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
601 AREF ((ARRAY), (IDX)) = (VAL))
603 /* Convenience macros for dealing with Lisp strings. */
605 #define SDATA(string) (XSTRING (string)->data + 0)
606 #define SREF(string, index) (SDATA (string)[index] + 0)
607 #define SSET(string, index, new) (SDATA (string)[index] = (new))
608 #define SCHARS(string) (XSTRING (string)->size + 0)
609 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
611 /* Avoid "differ in sign" warnings. */
612 #define SSDATA(x) ((char *) SDATA (x))
614 #define STRING_SET_CHARS(string, newsize) \
615 (XSTRING (string)->size = (newsize))
617 #define STRING_COPYIN(string, index, new, count) \
618 memcpy (SDATA (string) + index, new, count)
622 #define CHECK_TYPE(ok, Qxxxp, x) \
623 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
625 /* Lisp fields are usually hidden from most code and accessed
626 via special macros. Only select pieces of code, like the GC,
627 are allowed to use INTERNAL_FIELD directly. Objects which
628 aren't using this convention should be fixed. */
630 #define INTERNAL_FIELD(field) field ## _
632 /* See the macros in intervals.h. */
634 typedef struct interval
*INTERVAL
;
636 /* Complain if object is not string or buffer type */
637 #define CHECK_STRING_OR_BUFFER(x) \
638 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
640 /* Most code should use this macro to
641 access Lisp fields in struct Lisp_Cons. */
643 #define CVAR(cons, field) ((cons)->INTERNAL_FIELD (field))
647 /* Car of this cons cell. */
648 Lisp_Object
INTERNAL_FIELD (car
);
652 /* Cdr of this cons cell. */
653 Lisp_Object
INTERNAL_FIELD (cdr
);
655 /* Used to chain conses on a free list. */
656 struct Lisp_Cons
*chain
;
660 /* Take the car or cdr of something known to be a cons cell. */
661 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
662 of code that has to know what a cons cell looks like. Other code not
663 part of the basic lisp implementation should assume that the car and cdr
664 fields are not accessible as lvalues. (What if we want to switch to
665 a copying collector someday? Cached cons cell field addresses may be
666 invalidated at arbitrary points.) */
667 #define XCAR_AS_LVALUE(c) (CVAR (XCONS (c), car))
668 #define XCDR_AS_LVALUE(c) (CVAR (XCONS (c), u.cdr))
670 /* Use these from normal code. */
671 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
672 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
674 /* Use these to set the fields of a cons cell.
676 Note that both arguments may refer to the same object, so 'n'
677 should not be read after 'c' is first modified. Also, neither
678 argument should be evaluated more than once; side effects are
679 especially common in the second argument. */
680 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
681 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
683 /* Take the car or cdr of something whose type is not known. */
685 (CONSP ((c)) ? XCAR ((c)) \
686 : NILP ((c)) ? Qnil \
687 : wrong_type_argument (Qlistp, (c)))
690 (CONSP ((c)) ? XCDR ((c)) \
691 : NILP ((c)) ? Qnil \
692 : wrong_type_argument (Qlistp, (c)))
694 /* Take the car or cdr of something whose type is not known. */
695 #define CAR_SAFE(c) \
696 (CONSP ((c)) ? XCAR ((c)) : Qnil)
698 #define CDR_SAFE(c) \
699 (CONSP ((c)) ? XCDR ((c)) : Qnil)
701 /* Nonzero if STR is a multibyte string. */
702 #define STRING_MULTIBYTE(STR) \
703 (XSTRING (STR)->size_byte >= 0)
705 /* Return the length in bytes of STR. */
707 #ifdef GC_CHECK_STRING_BYTES
710 extern ptrdiff_t string_bytes (struct Lisp_String
*);
711 #define STRING_BYTES(S) string_bytes ((S))
713 #else /* not GC_CHECK_STRING_BYTES */
715 #define STRING_BYTES(STR) \
716 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
718 #endif /* not GC_CHECK_STRING_BYTES */
720 /* An upper bound on the number of bytes in a Lisp string, not
721 counting the terminating null. This a tight enough bound to
722 prevent integer overflow errors that would otherwise occur during
723 string size calculations. A string cannot contain more bytes than
724 a fixnum can represent, nor can it be so long that C pointer
725 arithmetic stops working on the string plus its terminating null.
726 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
727 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
728 would expose alloc.c internal details that we'd rather keep
731 This is a macro for use in static initializers, and a constant for
732 visibility to GDB. The cast to ptrdiff_t ensures that
733 the macro is signed. */
734 static ptrdiff_t const STRING_BYTES_BOUND
=
735 #define STRING_BYTES_BOUND \
736 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
739 /* Mark STR as a unibyte string. */
740 #define STRING_SET_UNIBYTE(STR) \
741 do { if (EQ (STR, empty_multibyte_string)) \
742 (STR) = empty_unibyte_string; \
743 else XSTRING (STR)->size_byte = -1; } while (0)
745 /* Mark STR as a multibyte string. Assure that STR contains only
746 ASCII characters in advance. */
747 #define STRING_SET_MULTIBYTE(STR) \
748 do { if (EQ (STR, empty_unibyte_string)) \
749 (STR) = empty_multibyte_string; \
750 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
752 /* Get text properties. */
753 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
755 /* Set text properties. */
756 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
758 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
764 INTERVAL intervals
; /* Text properties in this string. */
768 /* Header of vector-like objects. This documents the layout constraints on
769 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
770 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
771 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
772 because when two such pointers potentially alias, a compiler won't
773 incorrectly reorder loads and stores to their size fields. See
774 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
775 struct vectorlike_header
777 /* This field contains various pieces of information:
778 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
779 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
780 vector (0) or a pseudovector (1).
781 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
782 of slots) of the vector.
783 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
784 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
785 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
786 Lisp_Object slots at the beginning of the object that need to be
787 traced by the GC, tho some types use it slightly differently.
788 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
789 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
793 /* When the vector is allocated from a vector block, NBYTES is used
794 if the vector is not on a free list, and VECTOR is used otherwise.
795 For large vector-like objects, BUFFER or VECTOR is used as a pointer
796 to the next vector-like object. It is generally a buffer or a
797 Lisp_Vector alias, so for convenience it is a union instead of a
798 pointer: this way, one can write P->next.vector instead of ((struct
799 Lisp_Vector *) P->next). */
801 /* This is only needed for small vectors that are not free because the
802 `size' field only gives us the number of Lisp_Object slots, whereas we
803 need to know the total size, including non-Lisp_Object data.
804 FIXME: figure out a way to store this info elsewhere so we can
805 finally get rid of this extra word of overhead. */
807 struct buffer
*buffer
;
808 /* FIXME: This can be removed: For large vectors, this field could be
809 placed *before* the vector itself. And for small vectors on a free
810 list, this field could be stored in the vector's bytes, since the
811 empty vector is handled specially anyway. */
812 struct Lisp_Vector
*vector
;
818 struct vectorlike_header header
;
819 Lisp_Object contents
[1];
822 /* If a struct is made to look like a vector, this macro returns the length
823 of the shortest vector that would hold that struct. */
824 #define VECSIZE(type) ((sizeof (type) \
825 - offsetof (struct Lisp_Vector, contents[0]) \
826 + sizeof (Lisp_Object) - 1) /* Round up. */ \
827 / sizeof (Lisp_Object))
829 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
830 at the end and we need to compute the number of Lisp_Object fields (the
831 ones that the GC needs to trace). */
832 #define PSEUDOVECSIZE(type, nonlispfield) \
833 ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \
834 / sizeof (Lisp_Object))
836 /* A char-table is a kind of vectorlike, with contents are like a
837 vector but with a few other slots. For some purposes, it makes
838 sense to handle a char-table with type struct Lisp_Vector. An
839 element of a char table can be any Lisp objects, but if it is a sub
840 char-table, we treat it a table that contains information of a
841 specific range of characters. A sub char-table has the same
842 structure as a vector. A sub char table appears only in an element
843 of a char-table, and there's no way to access it directly from
844 Emacs Lisp program. */
848 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
849 ({struct Lisp_Char_Table *_tbl = NULL; \
852 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
853 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
854 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
856 _val = _tbl->defalt; \
857 } while (NILP (_val) && ! NILP (_tbl->parent)); \
860 #else /* not __GNUC__ */
862 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
863 (! NILP (XCHAR_TABLE (CT)->ascii) \
864 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
865 ? XCHAR_TABLE (CT)->ascii \
866 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
867 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
868 : char_table_ref ((CT), (IDX))) \
869 : char_table_ref ((CT), (IDX)))
871 #endif /* not __GNUC__ */
873 /* Compute A OP B, using the unsigned comparison operator OP. A and B
874 should be integer expressions. This is not the same as
875 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
876 returns 1. For efficiency, prefer plain unsigned comparison if A
877 and B's sizes both fit (after integer promotion). */
878 #define UNSIGNED_CMP(a, op, b) \
879 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
880 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
881 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
883 /* Nonzero iff C is an ASCII character. */
884 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
886 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
887 characters. Do not check validity of CT. */
888 #define CHAR_TABLE_REF(CT, IDX) \
889 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
890 : char_table_ref ((CT), (IDX)))
892 /* Almost equivalent to Faref (CT, IDX). However, if the result is
893 not a character, return IDX.
895 For these characters, do not check validity of CT
896 and do not follow parent. */
897 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
898 char_table_translate (CT, IDX)
900 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
901 8-bit European characters. Do not check validity of CT. */
902 #define CHAR_TABLE_SET(CT, IDX, VAL) \
903 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
904 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
905 : char_table_set (CT, IDX, VAL))
907 enum CHARTAB_SIZE_BITS
909 CHARTAB_SIZE_BITS_0
= 6,
910 CHARTAB_SIZE_BITS_1
= 4,
911 CHARTAB_SIZE_BITS_2
= 5,
912 CHARTAB_SIZE_BITS_3
= 7
915 extern const int chartab_size
[4];
917 struct Lisp_Sub_Char_Table
;
919 struct Lisp_Char_Table
921 /* HEADER.SIZE is the vector's size field, which also holds the
922 pseudovector type information. It holds the size, too.
923 The size counts the defalt, parent, purpose, ascii,
924 contents, and extras slots. */
925 struct vectorlike_header header
;
927 /* This holds a default value,
928 which is used whenever the value for a specific character is nil. */
931 /* This points to another char table, which we inherit from when the
932 value for a specific character is nil. The `defalt' slot takes
933 precedence over this. */
936 /* This is a symbol which says what kind of use this char-table is
940 /* The bottom sub char-table for characters of the range 0..127. It
941 is nil if none of ASCII character has a specific value. */
944 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
946 /* These hold additional data. It is a vector. */
947 Lisp_Object extras
[1];
950 struct Lisp_Sub_Char_Table
952 /* HEADER.SIZE is the vector's size field, which also holds the
953 pseudovector type information. It holds the size, too. */
954 struct vectorlike_header header
;
956 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
957 char-table of depth 1 contains 16 elements, and each element
958 covers 4096 (128*32) characters. A sub char-table of depth 2
959 contains 32 elements, and each element covers 128 characters. A
960 sub char-table of depth 3 contains 128 elements, and each element
961 is for one character. */
964 /* Minimum character covered by the sub char-table. */
965 Lisp_Object min_char
;
967 Lisp_Object contents
[1];
970 /* A boolvector is a kind of vectorlike, with contents are like a string. */
971 struct Lisp_Bool_Vector
973 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
974 just the subtype information. */
975 struct vectorlike_header header
;
976 /* This is the size in bits. */
978 /* This contains the actual bits, packed into bytes. */
979 unsigned char data
[1];
982 /* This structure describes a built-in function.
983 It is generated by the DEFUN macro only.
984 defsubr makes it into a Lisp object.
986 This type is treated in most respects as a pseudovector,
987 but since we never dynamically allocate or free them,
988 we don't need a struct vectorlike_header and its 'next' field. */
994 Lisp_Object (*a0
) (void);
995 Lisp_Object (*a1
) (Lisp_Object
);
996 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
997 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
998 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
999 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1000 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1001 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1002 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1003 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1004 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1006 short min_args
, max_args
;
1007 const char *symbol_name
;
1008 const char *intspec
;
1012 /* This is the number of slots that every char table must have. This
1013 counts the ordinary slots and the top, defalt, parent, and purpose
1015 enum CHAR_TABLE_STANDARD_SLOTS
1017 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1020 /* Return the number of "extra" slots in the char table CT. */
1022 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1023 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1026 /***********************************************************************
1028 ***********************************************************************/
1030 /* Interned state of a symbol. */
1032 enum symbol_interned
1034 SYMBOL_UNINTERNED
= 0,
1035 SYMBOL_INTERNED
= 1,
1036 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1039 enum symbol_redirect
1041 SYMBOL_PLAINVAL
= 4,
1042 SYMBOL_VARALIAS
= 1,
1043 SYMBOL_LOCALIZED
= 2,
1044 SYMBOL_FORWARDED
= 3
1047 /* Most code should use this macro to access
1048 Lisp fields in struct Lisp_Symbol. */
1050 #define SVAR(sym, field) ((sym)->INTERNAL_FIELD (field))
1054 unsigned gcmarkbit
: 1;
1056 /* Indicates where the value can be found:
1057 0 : it's a plain var, the value is in the `value' field.
1058 1 : it's a varalias, the value is really in the `alias' symbol.
1059 2 : it's a localized var, the value is in the `blv' object.
1060 3 : it's a forwarding variable, the value is in `forward'. */
1061 ENUM_BF (symbol_redirect
) redirect
: 3;
1063 /* Non-zero means symbol is constant, i.e. changing its value
1064 should signal an error. If the value is 3, then the var
1065 can be changed, but only by `defconst'. */
1066 unsigned constant
: 2;
1068 /* Interned state of the symbol. This is an enumerator from
1069 enum symbol_interned. */
1070 unsigned interned
: 2;
1072 /* Non-zero means that this variable has been explicitly declared
1073 special (with `defvar' etc), and shouldn't be lexically bound. */
1074 unsigned declared_special
: 1;
1076 /* The symbol's name, as a Lisp string.
1077 The name "xname" is used to intentionally break code referring to
1078 the old field "name" of type pointer to struct Lisp_String. */
1079 Lisp_Object
INTERNAL_FIELD (xname
);
1081 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1082 union is used depends on the `redirect' field above. */
1084 Lisp_Object
INTERNAL_FIELD (value
);
1085 struct Lisp_Symbol
*alias
;
1086 struct Lisp_Buffer_Local_Value
*blv
;
1087 union Lisp_Fwd
*fwd
;
1090 /* Function value of the symbol or Qunbound if not fboundp. */
1091 Lisp_Object
INTERNAL_FIELD (function
);
1093 /* The symbol's property list. */
1094 Lisp_Object
INTERNAL_FIELD (plist
);
1096 /* Next symbol in obarray bucket, if the symbol is interned. */
1097 struct Lisp_Symbol
*next
;
1100 /* Value is name of symbol. */
1102 #define SYMBOL_VAL(sym) \
1103 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), SVAR (sym, val.value))
1104 #define SYMBOL_ALIAS(sym) \
1105 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1106 #define SYMBOL_BLV(sym) \
1107 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1108 #define SYMBOL_FWD(sym) \
1109 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1110 #define SET_SYMBOL_VAL(sym, v) \
1111 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), SVAR (sym, val.value) = (v))
1112 #define SET_SYMBOL_ALIAS(sym, v) \
1113 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1114 #define SET_SYMBOL_BLV(sym, v) \
1115 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1116 #define SET_SYMBOL_FWD(sym, v) \
1117 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1119 #define SYMBOL_NAME(sym) \
1120 LISP_MAKE_RVALUE (SVAR (XSYMBOL (sym), xname))
1122 /* Value is non-zero if SYM is an interned symbol. */
1124 #define SYMBOL_INTERNED_P(sym) \
1125 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1127 /* Value is non-zero if SYM is interned in initial_obarray. */
1129 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1130 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1132 /* Value is non-zero if symbol is considered a constant, i.e. its
1133 value cannot be changed (there is an exception for keyword symbols,
1134 whose value can be set to the keyword symbol itself). */
1136 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1138 #define DEFSYM(sym, name) \
1139 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1142 /***********************************************************************
1144 ***********************************************************************/
1146 /* The structure of a Lisp hash table. */
1148 struct Lisp_Hash_Table
1150 /* This is for Lisp; the hash table code does not refer to it. */
1151 struct vectorlike_header header
;
1153 /* Function used to compare keys. */
1156 /* Nil if table is non-weak. Otherwise a symbol describing the
1157 weakness of the table. */
1160 /* When the table is resized, and this is an integer, compute the
1161 new size by adding this to the old size. If a float, compute the
1162 new size by multiplying the old size with this factor. */
1163 Lisp_Object rehash_size
;
1165 /* Resize hash table when number of entries/ table size is >= this
1167 Lisp_Object rehash_threshold
;
1169 /* Vector of hash codes.. If hash[I] is nil, this means that that
1170 entry I is unused. */
1173 /* Vector used to chain entries. If entry I is free, next[I] is the
1174 entry number of the next free item. If entry I is non-free,
1175 next[I] is the index of the next entry in the collision chain. */
1178 /* Index of first free entry in free list. */
1179 Lisp_Object next_free
;
1181 /* Bucket vector. A non-nil entry is the index of the first item in
1182 a collision chain. This vector's size can be larger than the
1183 hash table size to reduce collisions. */
1186 /* User-supplied hash function, or nil. */
1187 Lisp_Object user_hash_function
;
1189 /* User-supplied key comparison function, or nil. */
1190 Lisp_Object user_cmp_function
;
1192 /* Only the fields above are traced normally by the GC. The ones below
1193 `count' are special and are either ignored by the GC or traced in
1194 a special way (e.g. because of weakness). */
1196 /* Number of key/value entries in the table. */
1199 /* Vector of keys and values. The key of item I is found at index
1200 2 * I, the value is found at index 2 * I + 1.
1201 This is gc_marked specially if the table is weak. */
1202 Lisp_Object key_and_value
;
1204 /* Next weak hash table if this is a weak hash table. The head
1205 of the list is in weak_hash_tables. */
1206 struct Lisp_Hash_Table
*next_weak
;
1208 /* C function to compare two keys. */
1209 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1210 Lisp_Object
, EMACS_UINT
,
1211 Lisp_Object
, EMACS_UINT
);
1213 /* C function to compute hash code. */
1214 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1218 #define XHASH_TABLE(OBJ) \
1219 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1221 #define XSET_HASH_TABLE(VAR, PTR) \
1222 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1224 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1226 #define CHECK_HASH_TABLE(x) \
1227 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1229 /* Value is the key part of entry IDX in hash table H. */
1231 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1233 /* Value is the value part of entry IDX in hash table H. */
1235 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1237 /* Value is the index of the next entry following the one at IDX
1240 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1242 /* Value is the hash code computed for entry IDX in hash table H. */
1244 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1246 /* Value is the index of the element in hash table H that is the
1247 start of the collision list at index IDX in the index vector of H. */
1249 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1251 /* Value is the size of hash table H. */
1253 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1255 /* Default size for hash tables if not specified. */
1257 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1259 /* Default threshold specifying when to resize a hash table. The
1260 value gives the ratio of current entries in the hash table and the
1261 size of the hash table. */
1263 #define DEFAULT_REHASH_THRESHOLD 0.8
1265 /* Default factor by which to increase the size of a hash table. */
1267 #define DEFAULT_REHASH_SIZE 1.5
1269 /* Most code should use this macro to access
1270 Lisp fields in a different misc objects. */
1272 #define MVAR(misc, field) ((misc)->INTERNAL_FIELD (field))
1274 /* These structures are used for various misc types. */
1276 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1278 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1279 unsigned gcmarkbit
: 1;
1285 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1286 unsigned gcmarkbit
: 1;
1288 /* This flag is temporarily used in the functions
1289 decode/encode_coding_object to record that the marker position
1290 must be adjusted after the conversion. */
1291 unsigned int need_adjustment
: 1;
1292 /* 1 means normal insertion at the marker's position
1293 leaves the marker after the inserted text. */
1294 unsigned int insertion_type
: 1;
1295 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1296 Note: a chain of markers can contain markers pointing into different
1297 buffers (the chain is per buffer_text rather than per buffer, so it's
1298 shared between indirect buffers). */
1299 /* This is used for (other than NULL-checking):
1301 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1302 - unchain_marker: to find the list from which to unchain.
1303 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1305 struct buffer
*buffer
;
1307 /* The remaining fields are meaningless in a marker that
1308 does not point anywhere. */
1310 /* For markers that point somewhere,
1311 this is used to chain of all the markers in a given buffer. */
1312 /* We could remove it and use an array in buffer_text instead.
1313 That would also allow to preserve it ordered. */
1314 struct Lisp_Marker
*next
;
1315 /* This is the char position where the marker points. */
1317 /* This is the byte position.
1318 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1319 used to implement the functionality of markers, but rather to (ab)use
1320 markers as a cache for char<->byte mappings). */
1324 /* START and END are markers in the overlay's buffer, and
1325 PLIST is the overlay's property list. */
1327 /* An overlay's real data content is:
1329 - buffer (really there are two buffer pointers, one per marker,
1330 and both points to the same buffer)
1331 - insertion type of both ends (per-marker fields)
1332 - start & start byte (of start marker)
1333 - end & end byte (of end marker)
1334 - next (singly linked list of overlays)
1335 - next fields of start and end markers (singly linked list of markers).
1336 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1339 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1340 unsigned gcmarkbit
: 1;
1342 struct Lisp_Overlay
*next
;
1343 Lisp_Object
INTERNAL_FIELD (start
);
1344 Lisp_Object
INTERNAL_FIELD (end
);
1345 Lisp_Object
INTERNAL_FIELD (plist
);
1348 /* Hold a C pointer for later use.
1349 This type of object is used in the arg to record_unwind_protect. */
1350 struct Lisp_Save_Value
1352 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1353 unsigned gcmarkbit
: 1;
1355 /* If DOGC is set, POINTER is the address of a memory
1356 area containing INTEGER potential Lisp_Objects. */
1357 unsigned int dogc
: 1;
1363 /* A miscellaneous object, when it's on the free list. */
1366 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1367 unsigned gcmarkbit
: 1;
1369 union Lisp_Misc
*chain
;
1372 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1373 It uses one of these struct subtypes to get the type field. */
1377 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1378 struct Lisp_Free u_free
;
1379 struct Lisp_Marker u_marker
;
1380 struct Lisp_Overlay u_overlay
;
1381 struct Lisp_Save_Value u_save_value
;
1384 /* Forwarding pointer to an int variable.
1385 This is allowed only in the value cell of a symbol,
1386 and it means that the symbol's value really lives in the
1387 specified int variable. */
1390 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1394 /* Boolean forwarding pointer to an int variable.
1395 This is like Lisp_Intfwd except that the ostensible
1396 "value" of the symbol is t if the int variable is nonzero,
1397 nil if it is zero. */
1400 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1404 /* Forwarding pointer to a Lisp_Object variable.
1405 This is allowed only in the value cell of a symbol,
1406 and it means that the symbol's value really lives in the
1407 specified variable. */
1410 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1411 Lisp_Object
*objvar
;
1414 /* Like Lisp_Objfwd except that value lives in a slot in the
1415 current buffer. Value is byte index of slot within buffer. */
1416 struct Lisp_Buffer_Objfwd
1418 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1420 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1423 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1424 the symbol has buffer-local or frame-local bindings. (Exception:
1425 some buffer-local variables are built-in, with their values stored
1426 in the buffer structure itself. They are handled differently,
1427 using struct Lisp_Buffer_Objfwd.)
1429 The `realvalue' slot holds the variable's current value, or a
1430 forwarding pointer to where that value is kept. This value is the
1431 one that corresponds to the loaded binding. To read or set the
1432 variable, you must first make sure the right binding is loaded;
1433 then you can access the value in (or through) `realvalue'.
1435 `buffer' and `frame' are the buffer and frame for which the loaded
1436 binding was found. If those have changed, to make sure the right
1437 binding is loaded it is necessary to find which binding goes with
1438 the current buffer and selected frame, then load it. To load it,
1439 first unload the previous binding, then copy the value of the new
1440 binding into `realvalue' (or through it). Also update
1441 LOADED-BINDING to point to the newly loaded binding.
1443 `local_if_set' indicates that merely setting the variable creates a
1444 local binding for the current buffer. Otherwise the latter, setting
1445 the variable does not do that; only make-local-variable does that. */
1447 struct Lisp_Buffer_Local_Value
1449 /* 1 means that merely setting the variable creates a local
1450 binding for the current buffer. */
1451 unsigned int local_if_set
: 1;
1452 /* 1 means this variable can have frame-local bindings, otherwise, it is
1453 can have buffer-local bindings. The two cannot be combined. */
1454 unsigned int frame_local
: 1;
1455 /* 1 means that the binding now loaded was found.
1456 Presumably equivalent to (defcell!=valcell). */
1457 unsigned int found
: 1;
1458 /* If non-NULL, a forwarding to the C var where it should also be set. */
1459 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1460 /* The buffer or frame for which the loaded binding was found. */
1462 /* A cons cell that holds the default value. It has the form
1463 (SYMBOL . DEFAULT-VALUE). */
1464 Lisp_Object defcell
;
1465 /* The cons cell from `where's parameter alist.
1466 It always has the form (SYMBOL . VALUE)
1467 Note that if `forward' is non-nil, VALUE may be out of date.
1468 Also if the currently loaded binding is the default binding, then
1469 this is `eq'ual to defcell. */
1470 Lisp_Object valcell
;
1473 #define BLV_FOUND(blv) \
1474 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1475 #define SET_BLV_FOUND(blv, v) \
1476 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1478 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1479 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1481 /* Like Lisp_Objfwd except that value lives in a slot in the
1483 struct Lisp_Kboard_Objfwd
1485 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1491 struct Lisp_Intfwd u_intfwd
;
1492 struct Lisp_Boolfwd u_boolfwd
;
1493 struct Lisp_Objfwd u_objfwd
;
1494 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1495 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1498 /* Lisp floating point type. */
1504 struct Lisp_Float
*chain
;
1508 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1509 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1511 /* A character, declared with the following typedef, is a member
1512 of some character set associated with the current buffer. */
1513 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1515 typedef unsigned char UCHAR
;
1518 /* Meanings of slots in a Lisp_Compiled: */
1522 COMPILED_ARGLIST
= 0,
1523 COMPILED_BYTECODE
= 1,
1524 COMPILED_CONSTANTS
= 2,
1525 COMPILED_STACK_DEPTH
= 3,
1526 COMPILED_DOC_STRING
= 4,
1527 COMPILED_INTERACTIVE
= 5
1530 /* Flag bits in a character. These also get used in termhooks.h.
1531 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1532 (MUlti-Lingual Emacs) might need 22 bits for the character value
1533 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1536 CHAR_ALT
= 0x0400000,
1537 CHAR_SUPER
= 0x0800000,
1538 CHAR_HYPER
= 0x1000000,
1539 CHAR_SHIFT
= 0x2000000,
1540 CHAR_CTL
= 0x4000000,
1541 CHAR_META
= 0x8000000,
1543 CHAR_MODIFIER_MASK
=
1544 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1546 /* Actually, the current Emacs uses 22 bits for the character value
1554 /* The glyph datatype, used to represent characters on the display.
1555 It consists of a char code and a face id. */
1562 /* Return a glyph's character code. */
1563 #define GLYPH_CHAR(glyph) ((glyph).ch)
1565 /* Return a glyph's face ID. */
1566 #define GLYPH_FACE(glyph) ((glyph).face_id)
1568 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1569 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1570 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1572 /* Return 1 if GLYPH contains valid character code. */
1573 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1576 /* Glyph Code from a display vector may either be an integer which
1577 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1578 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1580 #define GLYPH_CODE_P(gc) \
1582 ? (CHARACTERP (XCAR (gc)) \
1583 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1584 : (RANGED_INTEGERP \
1586 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1587 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1588 : TYPE_MAXIMUM (EMACS_INT)))))
1590 /* The following are valid only if GLYPH_CODE_P (gc). */
1592 #define GLYPH_CODE_CHAR(gc) \
1593 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1595 #define GLYPH_CODE_FACE(gc) \
1596 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1598 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1602 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1604 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1605 (XINT (gc) >> CHARACTERBITS)); \
1609 /* Structure to hold mouse highlight data. This is here because other
1610 header files need it for defining struct x_output etc. */
1612 /* These variables describe the range of text currently shown in its
1613 mouse-face, together with the window they apply to. As long as
1614 the mouse stays within this range, we need not redraw anything on
1615 its account. Rows and columns are glyph matrix positions in
1616 MOUSE_FACE_WINDOW. */
1617 int mouse_face_beg_row
, mouse_face_beg_col
;
1618 int mouse_face_beg_x
, mouse_face_beg_y
;
1619 int mouse_face_end_row
, mouse_face_end_col
;
1620 int mouse_face_end_x
, mouse_face_end_y
;
1621 int mouse_face_past_end
;
1622 Lisp_Object mouse_face_window
;
1623 int mouse_face_face_id
;
1624 Lisp_Object mouse_face_overlay
;
1626 /* 1 if a mouse motion event came and we didn't handle it right away because
1627 gc was in progress. */
1628 int mouse_face_deferred_gc
;
1630 /* FRAME and X, Y position of mouse when last checked for
1631 highlighting. X and Y can be negative or out of range for the frame. */
1632 struct frame
*mouse_face_mouse_frame
;
1633 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1635 /* Nonzero means defer mouse-motion highlighting. */
1636 int mouse_face_defer
;
1638 /* Nonzero means that the mouse highlight should not be shown. */
1639 int mouse_face_hidden
;
1641 int mouse_face_image_state
;
1644 /* Data type checking */
1646 #define NILP(x) EQ (x, Qnil)
1648 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1649 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1651 #define RANGED_INTEGERP(lo, x, hi) \
1652 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1653 #define TYPE_RANGED_INTEGERP(type, x) \
1654 (TYPE_SIGNED (type) \
1655 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1656 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1658 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1659 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1660 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1661 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1662 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1663 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1665 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1666 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1667 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1668 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1669 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1671 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1672 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1673 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1674 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1675 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1677 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1678 vectorlike_header * avoids aliasing issues. */
1679 #define PSEUDOVECTORP(x, code) \
1680 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1682 #define PSEUDOVECTOR_TYPEP(v, code) \
1683 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1684 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1686 /* True if object X, with internal type struct T *, is a pseudovector whose
1688 #define TYPED_PSEUDOVECTORP(x, t, code) \
1690 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1692 /* Test for specific pseudovector types. */
1693 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1694 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1695 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1696 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1697 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1698 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1699 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1700 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1701 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1702 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1703 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1704 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1706 /* Test for image (image . spec) */
1707 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1712 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1714 #define CHECK_LIST(x) \
1715 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1717 #define CHECK_LIST_CONS(x, y) \
1718 CHECK_TYPE (CONSP (x), Qlistp, y)
1720 #define CHECK_LIST_END(x, y) \
1721 CHECK_TYPE (NILP (x), Qlistp, y)
1723 #define CHECK_STRING(x) \
1724 CHECK_TYPE (STRINGP (x), Qstringp, x)
1726 #define CHECK_STRING_CAR(x) \
1727 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1729 #define CHECK_CONS(x) \
1730 CHECK_TYPE (CONSP (x), Qconsp, x)
1732 #define CHECK_SYMBOL(x) \
1733 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1735 #define CHECK_CHAR_TABLE(x) \
1736 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1738 #define CHECK_VECTOR(x) \
1739 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1741 #define CHECK_VECTOR_OR_STRING(x) \
1742 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1744 #define CHECK_ARRAY(x, Qxxxp) \
1745 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1747 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1748 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1750 #define CHECK_BUFFER(x) \
1751 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1753 #define CHECK_WINDOW(x) \
1754 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1756 #define CHECK_WINDOW_CONFIGURATION(x) \
1757 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1759 /* This macro rejects windows on the interior of the window tree as
1760 "dead", which is what we want; this is an argument-checking macro, and
1761 the user should never get access to interior windows.
1763 A window of any sort, leaf or interior, is dead if the buffer,
1764 vchild, and hchild members are all nil. */
1766 #define CHECK_LIVE_WINDOW(x) \
1767 CHECK_TYPE (WINDOWP (x) && !NILP (WVAR (XWINDOW (x), buffer)), \
1770 #define CHECK_PROCESS(x) \
1771 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1773 #define CHECK_SUBR(x) \
1774 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1776 #define CHECK_NUMBER(x) \
1777 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1779 #define CHECK_NATNUM(x) \
1780 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1782 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1785 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1786 args_out_of_range_3 \
1788 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1789 ? MOST_NEGATIVE_FIXNUM \
1791 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1793 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1795 if (TYPE_SIGNED (type)) \
1796 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1798 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1801 #define CHECK_MARKER(x) \
1802 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1804 #define CHECK_NUMBER_COERCE_MARKER(x) \
1805 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1806 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1808 #define XFLOATINT(n) extract_float((n))
1810 #define CHECK_FLOAT(x) \
1811 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1813 #define CHECK_NUMBER_OR_FLOAT(x) \
1814 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1816 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1817 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1818 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1820 #define CHECK_OVERLAY(x) \
1821 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1823 /* Since we can't assign directly to the CAR or CDR fields of a cons
1824 cell, use these when checking that those fields contain numbers. */
1825 #define CHECK_NUMBER_CAR(x) \
1827 Lisp_Object tmp = XCAR (x); \
1828 CHECK_NUMBER (tmp); \
1829 XSETCAR ((x), tmp); \
1832 #define CHECK_NUMBER_CDR(x) \
1834 Lisp_Object tmp = XCDR (x); \
1835 CHECK_NUMBER (tmp); \
1836 XSETCDR ((x), tmp); \
1839 #define CHECK_NATNUM_CAR(x) \
1841 Lisp_Object tmp = XCAR (x); \
1842 CHECK_NATNUM (tmp); \
1843 XSETCAR ((x), tmp); \
1846 #define CHECK_NATNUM_CDR(x) \
1848 Lisp_Object tmp = XCDR (x); \
1849 CHECK_NATNUM (tmp); \
1850 XSETCDR ((x), tmp); \
1853 /* Define a built-in function for calling from Lisp.
1854 `lname' should be the name to give the function in Lisp,
1855 as a null-terminated C string.
1856 `fnname' should be the name of the function in C.
1857 By convention, it starts with F.
1858 `sname' should be the name for the C constant structure
1859 that records information on this function for internal use.
1860 By convention, it should be the same as `fnname' but with S instead of F.
1861 It's too bad that C macros can't compute this from `fnname'.
1862 `minargs' should be a number, the minimum number of arguments allowed.
1863 `maxargs' should be a number, the maximum number of arguments allowed,
1864 or else MANY or UNEVALLED.
1865 MANY means pass a vector of evaluated arguments,
1866 in the form of an integer number-of-arguments
1867 followed by the address of a vector of Lisp_Objects
1868 which contains the argument values.
1869 UNEVALLED means pass the list of unevaluated arguments
1870 `intspec' says how interactive arguments are to be fetched.
1871 If the string starts with a `(', `intspec' is evaluated and the resulting
1872 list is the list of arguments.
1873 If it's a string that doesn't start with `(', the value should follow
1874 the one of the doc string for `interactive'.
1875 A null string means call interactively with no arguments.
1876 `doc' is documentation for the user. */
1878 /* This version of DEFUN declares a function prototype with the right
1879 arguments, so we can catch errors with maxargs at compile-time. */
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 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1886 { (Lisp_Object (__cdecl *)(void))fnname }, \
1887 minargs, maxargs, lname, intspec, 0}; \
1889 #else /* not _MSC_VER */
1890 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1891 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1892 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1893 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1894 { .a ## maxargs = fnname }, \
1895 minargs, maxargs, lname, intspec, 0}; \
1899 /* Note that the weird token-substitution semantics of ANSI C makes
1900 this work for MANY and UNEVALLED. */
1901 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1902 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1903 #define DEFUN_ARGS_0 (void)
1904 #define DEFUN_ARGS_1 (Lisp_Object)
1905 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1906 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1907 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1908 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1910 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1911 Lisp_Object, Lisp_Object)
1912 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1913 Lisp_Object, Lisp_Object, Lisp_Object)
1914 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1915 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1917 /* Non-zero if OBJ is a Lisp function. */
1918 #define FUNCTIONP(OBJ) \
1919 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1920 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1921 || COMPILEDP (OBJ) \
1925 is how we define the symbol for function `name' at start-up time. */
1926 extern void defsubr (struct Lisp_Subr
*);
1934 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1935 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1936 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1937 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1938 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1940 /* Macros we use to define forwarded Lisp variables.
1941 These are used in the syms_of_FILENAME functions.
1943 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1944 lisp variable is actually a field in `struct emacs_globals'. The
1945 field's name begins with "f_", which is a convention enforced by
1946 these macros. Each such global has a corresponding #define in
1947 globals.h; the plain name should be used in the code.
1949 E.g., the global "cons_cells_consed" is declared as "int
1950 f_cons_cells_consed" in globals.h, but there is a define:
1952 #define cons_cells_consed globals.f_cons_cells_consed
1954 All C code uses the `cons_cells_consed' name. This is all done
1955 this way to support indirection for multi-threaded Emacs. */
1957 #define DEFVAR_LISP(lname, vname, doc) \
1959 static struct Lisp_Objfwd o_fwd; \
1960 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1962 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1964 static struct Lisp_Objfwd o_fwd; \
1965 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1967 #define DEFVAR_BOOL(lname, vname, doc) \
1969 static struct Lisp_Boolfwd b_fwd; \
1970 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1972 #define DEFVAR_INT(lname, vname, doc) \
1974 static struct Lisp_Intfwd i_fwd; \
1975 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1978 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1980 static struct Lisp_Objfwd o_fwd; \
1981 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1984 #define DEFVAR_KBOARD(lname, vname, doc) \
1986 static struct Lisp_Kboard_Objfwd ko_fwd; \
1987 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1992 /* Structure for recording Lisp call stack for backtrace purposes. */
1994 /* The special binding stack holds the outer values of variables while
1995 they are bound by a function application or a let form, stores the
1996 code to be executed for Lisp unwind-protect forms, and stores the C
1997 functions to be called for record_unwind_protect.
1999 If func is non-zero, undoing this binding applies func to old_value;
2000 This implements record_unwind_protect.
2002 Otherwise, the element is a variable binding.
2004 If the symbol field is a symbol, it is an ordinary variable binding.
2006 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2007 which means having bound a local value while CURRENT-BUFFER was active.
2008 If WHERE is nil this means we saw the default value when binding SYMBOL.
2009 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2010 value. Other values of WHERE mean an internal error. */
2012 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2016 Lisp_Object symbol
, old_value
;
2017 specbinding_func func
;
2018 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
2021 extern struct specbinding
*specpdl
;
2022 extern struct specbinding
*specpdl_ptr
;
2023 extern ptrdiff_t specpdl_size
;
2025 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2027 /* Everything needed to describe an active condition case. */
2030 /* The handler clauses and variable from the condition-case form. */
2031 /* For a handler set up in Lisp code, this is always a list.
2032 For an internal handler set up by internal_condition_case*,
2033 this can instead be the symbol t or `error'.
2034 t: handle all conditions.
2035 error: handle all conditions, and errors can run the debugger
2036 or display a backtrace. */
2037 Lisp_Object handler
;
2039 /* Fsignal stores here the condition-case clause that applies,
2040 and Fcondition_case thus knows which clause to run. */
2041 Lisp_Object chosen_clause
;
2043 /* Used to effect the longjump out to the handler. */
2044 struct catchtag
*tag
;
2046 /* The next enclosing handler. */
2047 struct handler
*next
;
2050 /* This structure helps implement the `catch' and `throw' control
2051 structure. A struct catchtag contains all the information needed
2052 to restore the state of the interpreter after a non-local jump.
2054 Handlers for error conditions (represented by `struct handler'
2055 structures) just point to a catch tag to do the cleanup required
2058 catchtag structures are chained together in the C calling stack;
2059 the `next' member points to the next outer catchtag.
2061 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2062 member is TAG, and then unbinds to it. The `val' member is used to
2063 hold VAL while the stack is unwound; `val' is returned as the value
2066 All the other members are concerned with restoring the interpreter
2073 struct catchtag
*next
;
2074 struct gcpro
*gcpro
;
2076 struct backtrace
*backlist
;
2077 struct handler
*handlerlist
;
2078 EMACS_INT lisp_eval_depth
;
2080 int poll_suppress_count
;
2081 int interrupt_input_blocked
;
2082 struct byte_stack
*byte_stack
;
2085 extern Lisp_Object memory_signal_data
;
2087 /* An address near the bottom of the stack.
2088 Tells GC how to save a copy of the stack. */
2089 extern char *stack_bottom
;
2091 /* Check quit-flag and quit if it is non-nil.
2092 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2093 So the program needs to do QUIT at times when it is safe to quit.
2094 Every loop that might run for a long time or might not exit
2095 ought to do QUIT at least once, at a safe place.
2096 Unless that is impossible, of course.
2097 But it is very desirable to avoid creating loops where QUIT is impossible.
2099 Exception: if you set immediate_quit to nonzero,
2100 then the handler that responds to the C-g does the quit itself.
2101 This is a good thing to do around a loop that has no side effects
2102 and (in particular) cannot call arbitrary Lisp code.
2104 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2105 a request to exit Emacs when it is safe to do. */
2108 extern void process_pending_signals (void);
2109 extern int pending_signals
;
2110 #define ELSE_PENDING_SIGNALS \
2111 else if (pending_signals) \
2112 process_pending_signals ();
2113 #else /* not SYNC_INPUT */
2114 #define ELSE_PENDING_SIGNALS
2115 #endif /* not SYNC_INPUT */
2117 extern void process_quit_flag (void);
2120 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2121 process_quit_flag (); \
2122 ELSE_PENDING_SIGNALS \
2126 /* Nonzero if ought to quit now. */
2128 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2130 extern Lisp_Object Vascii_downcase_table
;
2131 extern Lisp_Object Vascii_canon_table
;
2133 /* Structure for recording stack slots that need marking. */
2135 /* This is a chain of structures, each of which points at a Lisp_Object
2136 variable whose value should be marked in garbage collection.
2137 Normally every link of the chain is an automatic variable of a function,
2138 and its `val' points to some argument or local variable of the function.
2139 On exit to the function, the chain is set back to the value it had on entry.
2140 This way, no link remains in the chain when the stack frame containing the
2143 Every function that can call Feval must protect in this fashion all
2144 Lisp_Object variables whose contents will be used again. */
2146 extern struct gcpro
*gcprolist
;
2152 /* Address of first protected variable. */
2153 volatile Lisp_Object
*var
;
2155 /* Number of consecutive protected variables. */
2163 /* Values of GC_MARK_STACK during compilation:
2165 0 Use GCPRO as before
2166 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2167 2 Mark the stack, and check that everything GCPRO'd is
2169 3 Mark using GCPRO's, mark stack last, and count how many
2170 dead objects are kept alive. */
2173 #define GC_USE_GCPROS_AS_BEFORE 0
2174 #define GC_MAKE_GCPROS_NOOPS 1
2175 #define GC_MARK_STACK_CHECK_GCPROS 2
2176 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2178 #ifndef GC_MARK_STACK
2179 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2182 /* Whether we do the stack marking manually. */
2183 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2184 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2187 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2189 /* Do something silly with gcproN vars just so gcc shuts up. */
2190 /* You get warnings from MIPSPro... */
2192 #define GCPRO1(varname) ((void) gcpro1)
2193 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2194 #define GCPRO3(varname1, varname2, varname3) \
2195 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2196 #define GCPRO4(varname1, varname2, varname3, varname4) \
2197 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2198 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2199 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2200 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2201 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2203 #define UNGCPRO ((void) 0)
2205 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2209 #define GCPRO1(varname) \
2210 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2211 gcprolist = &gcpro1; }
2213 #define GCPRO2(varname1, varname2) \
2214 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2215 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2216 gcprolist = &gcpro2; }
2218 #define GCPRO3(varname1, varname2, varname3) \
2219 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2220 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2221 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2222 gcprolist = &gcpro3; }
2224 #define GCPRO4(varname1, varname2, varname3, varname4) \
2225 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2226 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2227 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2228 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2229 gcprolist = &gcpro4; }
2231 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2232 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2233 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2234 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2235 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2236 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2237 gcprolist = &gcpro5; }
2239 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2240 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2241 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2242 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2243 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2244 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2245 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2246 gcprolist = &gcpro6; }
2248 #define UNGCPRO (gcprolist = gcpro1.next)
2252 extern int gcpro_level
;
2254 #define GCPRO1(varname) \
2255 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2256 gcpro1.level = gcpro_level++; \
2257 gcprolist = &gcpro1; }
2259 #define GCPRO2(varname1, varname2) \
2260 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2261 gcpro1.level = gcpro_level; \
2262 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2263 gcpro2.level = gcpro_level++; \
2264 gcprolist = &gcpro2; }
2266 #define GCPRO3(varname1, varname2, varname3) \
2267 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2268 gcpro1.level = gcpro_level; \
2269 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2270 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2271 gcpro3.level = gcpro_level++; \
2272 gcprolist = &gcpro3; }
2274 #define GCPRO4(varname1, varname2, varname3, varname4) \
2275 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2276 gcpro1.level = gcpro_level; \
2277 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2278 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2279 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2280 gcpro4.level = gcpro_level++; \
2281 gcprolist = &gcpro4; }
2283 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2284 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2285 gcpro1.level = gcpro_level; \
2286 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2287 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2288 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2289 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2290 gcpro5.level = gcpro_level++; \
2291 gcprolist = &gcpro5; }
2293 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2294 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2295 gcpro1.level = gcpro_level; \
2296 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2297 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2298 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2299 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2300 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2301 gcpro6.level = gcpro_level++; \
2302 gcprolist = &gcpro6; }
2305 ((--gcpro_level != gcpro1.level) \
2307 : ((gcprolist = gcpro1.next), 0))
2309 #endif /* DEBUG_GCPRO */
2310 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2313 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2314 #define RETURN_UNGCPRO(expr) \
2317 Lisp_Object ret_ungc_val; \
2318 ret_ungc_val = (expr); \
2320 return ret_ungc_val; \
2324 /* Call staticpro (&var) to protect static variable `var'. */
2326 void staticpro (Lisp_Object
*);
2328 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2329 meaning as in the DEFUN macro, and is used to construct a prototype. */
2330 /* We can use the same trick as in the DEFUN macro to generate the
2331 appropriate prototype. */
2332 #define EXFUN(fnname, maxargs) \
2333 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2335 /* Forward declarations for prototypes. */
2339 /* Defined in data.c. */
2340 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2341 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2342 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2343 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2344 extern Lisp_Object Qinvalid_read_syntax
;
2345 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2346 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2347 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2348 extern Lisp_Object Qtext_read_only
;
2349 extern Lisp_Object Qinteractive_form
;
2350 extern Lisp_Object Qcircular_list
;
2351 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2352 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2353 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2354 extern Lisp_Object Qbuffer_or_string_p
;
2355 extern Lisp_Object Qfboundp
;
2356 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2358 extern Lisp_Object Qcdr
;
2360 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2361 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2363 extern Lisp_Object Qfloatp
;
2364 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2366 extern Lisp_Object Qinteger
, Qinterval
, Qsymbol
, Qstring
;
2367 extern Lisp_Object Qmisc
, Qvector
, Qfloat
, Qcons
, Qbuffer
;
2369 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2371 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2373 /* Defined in frame.c */
2374 extern Lisp_Object Qframep
;
2376 /* Defined in data.c */
2377 extern Lisp_Object
indirect_function (Lisp_Object
);
2378 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2380 /* Convert the integer I to an Emacs representation, either the integer
2381 itself, or a cons of two or three integers, or if all else fails a float.
2382 I should not have side effects. */
2383 #define INTEGER_TO_CONS(i) \
2384 (! FIXNUM_OVERFLOW_P (i) \
2386 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2387 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2388 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2389 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2390 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2391 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2392 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2393 ? Fcons (make_number ((i) >> 16 >> 24), \
2394 Fcons (make_number ((i) >> 16 & 0xffffff), \
2395 make_number ((i) & 0xffff))) \
2398 /* Convert the Emacs representation CONS back to an integer of type
2399 TYPE, storing the result the variable VAR. Signal an error if CONS
2400 is not a valid representation or is out of range for TYPE. */
2401 #define CONS_TO_INTEGER(cons, type, var) \
2402 (TYPE_SIGNED (type) \
2403 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2404 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2405 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2406 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2408 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2409 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2410 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2412 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2413 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2414 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2415 extern void syms_of_data (void);
2416 extern void init_data (void);
2417 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2419 /* Defined in cmds.c */
2420 extern void syms_of_cmds (void);
2421 extern void keys_of_cmds (void);
2423 /* Defined in coding.c */
2424 extern Lisp_Object Qcharset
;
2425 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2426 ptrdiff_t, int, int, Lisp_Object
);
2427 extern void init_coding (void);
2428 extern void init_coding_once (void);
2429 extern void syms_of_coding (void);
2431 /* Defined in character.c */
2432 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2433 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2434 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2435 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2436 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2437 extern void syms_of_character (void);
2439 /* Defined in charset.c */
2440 extern void init_charset (void);
2441 extern void init_charset_once (void);
2442 extern void syms_of_charset (void);
2443 /* Structure forward declarations. */
2446 /* Defined in composite.c */
2447 extern void syms_of_composite (void);
2449 /* Defined in syntax.c */
2450 extern void init_syntax_once (void);
2451 extern void syms_of_syntax (void);
2453 /* Defined in fns.c */
2454 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2455 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2456 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2457 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2458 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2459 extern void sweep_weak_hash_tables (void);
2460 extern Lisp_Object Qcursor_in_echo_area
;
2461 extern Lisp_Object Qstring_lessp
;
2462 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2463 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2464 EMACS_UINT
sxhash (Lisp_Object
, int);
2465 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2466 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2468 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2469 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2472 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2473 ptrdiff_t, ptrdiff_t);
2474 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2475 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2476 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2477 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2478 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2479 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2480 extern void clear_string_char_byte_cache (void);
2481 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2482 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2483 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2484 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2485 extern void syms_of_fns (void);
2487 /* Defined in floatfns.c */
2488 extern double extract_float (Lisp_Object
);
2489 extern void init_floatfns (void);
2490 extern void syms_of_floatfns (void);
2491 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2493 /* Defined in fringe.c */
2494 extern void syms_of_fringe (void);
2495 extern void init_fringe (void);
2496 #ifdef HAVE_WINDOW_SYSTEM
2497 extern void mark_fringe_data (void);
2498 extern void init_fringe_once (void);
2499 #endif /* HAVE_WINDOW_SYSTEM */
2501 /* Defined in image.c */
2502 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2503 extern Lisp_Object QCconversion
;
2504 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2505 extern void syms_of_image (void);
2507 /* Defined in insdel.c */
2508 extern Lisp_Object Qinhibit_modification_hooks
;
2509 extern void move_gap (ptrdiff_t);
2510 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2511 extern _Noreturn
void buffer_overflow (void);
2512 extern void make_gap (ptrdiff_t);
2513 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2514 ptrdiff_t, int, int);
2515 extern int count_combining_before (const unsigned char *,
2516 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2517 extern int count_combining_after (const unsigned char *,
2518 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2519 extern void insert (const char *, ptrdiff_t);
2520 extern void insert_and_inherit (const char *, ptrdiff_t);
2521 extern void insert_1 (const char *, ptrdiff_t, int, int, int);
2522 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2524 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2525 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2526 ptrdiff_t, ptrdiff_t, int);
2527 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2528 extern void insert_char (int);
2529 extern void insert_string (const char *);
2530 extern void insert_before_markers (const char *, ptrdiff_t);
2531 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2532 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2533 ptrdiff_t, ptrdiff_t,
2535 extern void del_range (ptrdiff_t, ptrdiff_t);
2536 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, int, int);
2537 extern void del_range_byte (ptrdiff_t, ptrdiff_t, int);
2538 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int);
2539 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2540 ptrdiff_t, ptrdiff_t, int);
2541 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2542 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2543 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2544 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2545 ptrdiff_t, ptrdiff_t);
2546 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2547 ptrdiff_t, ptrdiff_t);
2548 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, int, int, int);
2549 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2550 const char *, ptrdiff_t, ptrdiff_t, int);
2551 extern void syms_of_insdel (void);
2553 /* Defined in dispnew.c */
2554 #if (defined PROFILING \
2555 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2556 _Noreturn
void __executable_start (void);
2558 extern Lisp_Object selected_frame
;
2559 extern Lisp_Object Vwindow_system
;
2560 void duration_to_sec_usec (double, int *, int *);
2561 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2562 extern void init_display (void);
2563 extern void syms_of_display (void);
2565 /* Defined in xdisp.c */
2566 extern Lisp_Object Qinhibit_point_motion_hooks
;
2567 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2568 extern Lisp_Object Qmenu_bar_update_hook
;
2569 extern Lisp_Object Qwindow_scroll_functions
;
2570 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2571 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2572 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2573 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2574 extern Lisp_Object Qleft_margin
, Qright_margin
;
2575 extern Lisp_Object Qglyphless_char
;
2576 extern Lisp_Object QCdata
, QCfile
;
2577 extern Lisp_Object QCmap
;
2578 extern Lisp_Object Qrisky_local_variable
;
2579 extern struct frame
*last_glyphless_glyph_frame
;
2580 extern int last_glyphless_glyph_face_id
;
2581 extern int last_glyphless_glyph_merged_face_id
;
2582 extern int noninteractive_need_newline
;
2583 extern Lisp_Object echo_area_buffer
[2];
2584 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2585 extern void check_message_stack (void);
2586 extern void setup_echo_area_for_printing (int);
2587 extern int push_message (void);
2588 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2589 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2590 extern void restore_message (void);
2591 extern Lisp_Object
current_message (void);
2592 extern void clear_message (int, int);
2593 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2594 extern void message1 (const char *);
2595 extern void message1_nolog (const char *);
2596 extern void message2 (const char *, ptrdiff_t, int);
2597 extern void message2_nolog (const char *, ptrdiff_t, int);
2598 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2599 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2600 extern void message_dolog (const char *, ptrdiff_t, int, int);
2601 extern void message_with_string (const char *, Lisp_Object
, int);
2602 extern void message_log_maybe_newline (void);
2603 extern void update_echo_area (void);
2604 extern void truncate_echo_area (ptrdiff_t);
2605 extern void redisplay (void);
2606 extern void redisplay_preserve_echo_area (int);
2607 extern void prepare_menu_bars (void);
2609 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2610 extern void syms_of_xdisp (void);
2611 extern void init_xdisp (void);
2612 extern Lisp_Object
safe_eval (Lisp_Object
);
2613 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2614 int *, int *, int *, int *, int *);
2616 /* Defined in xsettings.c */
2617 extern void syms_of_xsettings (void);
2619 /* Defined in vm-limit.c. */
2620 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2622 /* Defined in alloc.c */
2623 extern void check_pure_size (void);
2624 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2625 extern void reset_malloc_hooks (void);
2626 extern void uninterrupt_malloc (void);
2627 extern void malloc_warning (const char *);
2628 extern _Noreturn
void memory_full (size_t);
2629 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2630 extern int survives_gc_p (Lisp_Object
);
2631 extern void mark_object (Lisp_Object
);
2632 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2633 extern void refill_memory_reserve (void);
2635 extern const char *pending_malloc_warning
;
2636 extern Lisp_Object zero_vector
;
2637 extern Lisp_Object
*stack_base
;
2638 extern EMACS_INT consing_since_gc
;
2639 extern EMACS_INT gc_relative_threshold
;
2640 extern EMACS_INT memory_full_cons_threshold
;
2641 extern Lisp_Object
list1 (Lisp_Object
);
2642 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2643 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2644 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2645 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2647 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2648 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2649 extern _Noreturn
void string_overflow (void);
2650 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2651 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2652 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2653 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2655 /* Make unibyte string from C string when the length isn't known. */
2657 static inline Lisp_Object
2658 build_unibyte_string (const char *str
)
2660 return make_unibyte_string (str
, strlen (str
));
2663 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2664 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2665 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2666 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2667 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2668 extern Lisp_Object
make_specified_string (const char *,
2669 ptrdiff_t, ptrdiff_t, int);
2670 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, int);
2671 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2673 /* Make a string allocated in pure space, use STR as string data. */
2675 static inline Lisp_Object
2676 build_pure_c_string (const char *str
)
2678 return make_pure_c_string (str
, strlen (str
));
2681 /* Make a string from the data at STR, treating it as multibyte if the
2684 static inline Lisp_Object
2685 build_string (const char *str
)
2687 return make_string (str
, strlen (str
));
2690 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2691 extern void make_byte_code (struct Lisp_Vector
*);
2692 extern Lisp_Object Qchar_table_extra_slots
;
2693 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2694 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2695 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2697 allocate_pseudovector \
2698 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2699 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2700 extern struct window
*allocate_window (void);
2701 extern struct frame
*allocate_frame (void);
2702 extern struct Lisp_Process
*allocate_process (void);
2703 extern struct terminal
*allocate_terminal (void);
2704 extern int gc_in_progress
;
2705 extern int abort_on_gc
;
2706 extern Lisp_Object
make_float (double);
2707 extern void display_malloc_warning (void);
2708 extern ptrdiff_t inhibit_garbage_collection (void);
2709 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2710 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2711 extern void free_marker (Lisp_Object
);
2712 extern void free_cons (struct Lisp_Cons
*);
2713 extern void init_alloc_once (void);
2714 extern void init_alloc (void);
2715 extern void syms_of_alloc (void);
2716 extern struct buffer
* allocate_buffer (void);
2717 extern int valid_lisp_object_p (Lisp_Object
);
2718 #ifdef GC_CHECK_CONS_LIST
2719 extern void check_cons_list (void);
2721 #define check_cons_list() ((void) 0)
2725 /* Defined in ralloc.c */
2726 extern void *r_alloc (void **, size_t);
2727 extern void r_alloc_free (void **);
2728 extern void *r_re_alloc (void **, size_t);
2729 extern void r_alloc_reset_variable (void **, void **);
2730 extern void r_alloc_inhibit_buffer_relocation (int);
2733 /* Defined in chartab.c */
2734 extern Lisp_Object
copy_char_table (Lisp_Object
);
2735 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2736 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2738 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2739 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2741 extern int char_table_translate (Lisp_Object
, int);
2742 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2744 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2745 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2746 Lisp_Object
, Lisp_Object
,
2747 Lisp_Object
, struct charset
*,
2748 unsigned, unsigned);
2749 extern Lisp_Object
uniprop_table (Lisp_Object
);
2750 extern void syms_of_chartab (void);
2752 /* Defined in print.c */
2753 extern Lisp_Object Vprin1_to_string_buffer
;
2754 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2755 extern Lisp_Object Qstandard_output
;
2756 extern Lisp_Object Qexternal_debugging_output
;
2757 extern void temp_output_buffer_setup (const char *);
2758 extern int print_level
;
2759 extern Lisp_Object Qprint_escape_newlines
;
2760 extern void write_string (const char *, int);
2761 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2763 extern Lisp_Object internal_with_output_to_temp_buffer
2764 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2765 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
2766 extern int float_to_string (char *, double);
2767 extern void syms_of_print (void);
2769 /* Defined in doprnt.c */
2770 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2772 extern ptrdiff_t esprintf (char *, char const *, ...)
2773 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2774 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2776 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2777 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2778 char const *, va_list)
2779 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2781 /* Defined in lread.c. */
2782 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2783 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2784 extern Lisp_Object
check_obarray (Lisp_Object
);
2785 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
2786 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
2787 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
2788 #define LOADHIST_ATTACH(x) \
2790 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2792 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2793 Lisp_Object
*, Lisp_Object
);
2794 Lisp_Object
string_to_number (char const *, int, int);
2795 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2797 extern void dir_warning (const char *, Lisp_Object
);
2798 extern void close_load_descs (void);
2799 extern void init_obarray (void);
2800 extern void init_lread (void);
2801 extern void syms_of_lread (void);
2803 static inline Lisp_Object
2804 intern (const char *str
)
2806 return intern_1 (str
, strlen (str
));
2809 static inline Lisp_Object
2810 intern_c_string (const char *str
)
2812 return intern_c_string_1 (str
, strlen (str
));
2815 /* Defined in eval.c. */
2816 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
2817 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2818 extern Lisp_Object Qand_rest
;
2819 extern Lisp_Object Vautoload_queue
;
2820 extern Lisp_Object Vsignaling_function
;
2821 extern Lisp_Object inhibit_lisp_code
;
2822 extern int handling_signal
;
2824 extern struct catchtag
*catchlist
;
2825 extern struct handler
*handlerlist
;
2827 /* To run a normal hook, use the appropriate function from the list below.
2828 The calling convention:
2830 if (!NILP (Vrun_hooks))
2831 call1 (Vrun_hooks, Qmy_funny_hook);
2833 should no longer be used. */
2834 extern Lisp_Object Vrun_hooks
;
2835 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2836 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2837 Lisp_Object (*funcall
)
2838 (ptrdiff_t nargs
, Lisp_Object
*args
));
2839 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
2840 extern _Noreturn
void xsignal0 (Lisp_Object
);
2841 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
2842 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2843 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2845 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
2846 extern Lisp_Object
eval_sub (Lisp_Object form
);
2847 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2848 extern Lisp_Object
call0 (Lisp_Object
);
2849 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2850 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2851 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2852 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2853 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2854 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2855 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2856 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2857 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2858 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2859 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2860 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2861 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2862 extern void specbind (Lisp_Object
, Lisp_Object
);
2863 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2864 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
2865 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2866 extern _Noreturn
void verror (const char *, va_list)
2867 ATTRIBUTE_FORMAT_PRINTF (1, 0);
2868 extern Lisp_Object
un_autoload (Lisp_Object
);
2869 extern void init_eval_once (void);
2870 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
2871 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
2872 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2873 extern void init_eval (void);
2875 extern void mark_backtrace (void);
2877 extern void syms_of_eval (void);
2879 /* Defined in editfns.c. */
2880 extern Lisp_Object Qfield
;
2881 extern void insert1 (Lisp_Object
);
2882 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
2883 extern Lisp_Object
save_excursion_save (void);
2884 extern Lisp_Object
save_restriction_save (void);
2885 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
2886 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
2887 extern _Noreturn
void time_overflow (void);
2888 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, int);
2889 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2891 extern void init_editfns (void);
2892 const char *get_system_name (void);
2893 extern void syms_of_editfns (void);
2894 extern void set_time_zone_rule (const char *);
2896 /* Defined in buffer.c. */
2897 extern int mouse_face_overlay_overlaps (Lisp_Object
);
2898 extern _Noreturn
void nsberror (Lisp_Object
);
2899 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
2900 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
2901 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
2902 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
2903 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2904 extern int overlay_touches_p (ptrdiff_t);
2905 extern Lisp_Object Vbuffer_alist
;
2906 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
2907 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
2908 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
2909 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
2910 extern void init_buffer_once (void);
2911 extern void init_buffer (void);
2912 extern void syms_of_buffer (void);
2913 extern void keys_of_buffer (void);
2915 /* Defined in marker.c. */
2917 extern ptrdiff_t marker_position (Lisp_Object
);
2918 extern ptrdiff_t marker_byte_position (Lisp_Object
);
2919 extern void clear_charpos_cache (struct buffer
*);
2920 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
2921 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
2922 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
2923 extern void unchain_marker (struct Lisp_Marker
*marker
);
2924 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2925 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
2926 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
2927 ptrdiff_t, ptrdiff_t);
2928 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
2929 extern void syms_of_marker (void);
2931 /* Defined in fileio.c */
2933 extern Lisp_Object Qfile_error
;
2934 extern Lisp_Object Qfile_exists_p
;
2935 extern Lisp_Object Qfile_directory_p
;
2936 extern Lisp_Object Qinsert_file_contents
;
2937 extern Lisp_Object Qfile_name_history
;
2938 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
2939 EXFUN (Fread_file_name
, 6); /* not a normal DEFUN */
2940 extern Lisp_Object
close_file_unwind (Lisp_Object
);
2941 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
2942 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
2943 extern int internal_delete_file (Lisp_Object
);
2944 extern void syms_of_fileio (void);
2945 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
2946 extern Lisp_Object Qdelete_file
;
2948 /* Defined in search.c */
2949 extern void shrink_regexp_cache (void);
2950 extern void restore_search_regs (void);
2951 extern void record_unwind_save_match_data (void);
2952 struct re_registers
;
2953 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
2954 struct re_registers
*,
2955 Lisp_Object
, int, int);
2956 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
2957 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
2959 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
2960 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2961 ptrdiff_t, ptrdiff_t, Lisp_Object
);
2962 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2964 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2966 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
2967 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
2968 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2969 extern void syms_of_search (void);
2970 extern void clear_regexp_cache (void);
2972 /* Defined in minibuf.c. */
2974 extern Lisp_Object Qcompletion_ignore_case
;
2975 extern Lisp_Object Vminibuffer_list
;
2976 extern Lisp_Object last_minibuf_string
;
2977 extern Lisp_Object
get_minibuffer (EMACS_INT
);
2978 extern void init_minibuf_once (void);
2979 extern void syms_of_minibuf (void);
2981 /* Defined in callint.c. */
2983 extern Lisp_Object Qminus
, Qplus
;
2984 extern Lisp_Object Qwhen
;
2985 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
2986 extern void syms_of_callint (void);
2988 /* Defined in casefiddle.c. */
2990 extern Lisp_Object Qidentity
;
2991 extern void syms_of_casefiddle (void);
2992 extern void keys_of_casefiddle (void);
2994 /* Defined in casetab.c. */
2996 extern void init_casetab_once (void);
2997 extern void syms_of_casetab (void);
2999 /* Defined in keyboard.c. */
3001 extern Lisp_Object echo_message_buffer
;
3002 extern struct kboard
*echo_kboard
;
3003 extern void cancel_echoing (void);
3004 extern Lisp_Object Qdisabled
, QCfilter
;
3005 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3006 extern Lisp_Object Qtop
;
3007 extern Lisp_Object last_undo_boundary
;
3008 extern int input_pending
;
3009 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3010 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3011 extern void discard_mouse_events (void);
3012 extern Lisp_Object pending_funcalls
;
3013 extern int detect_input_pending (void);
3014 extern int detect_input_pending_ignore_squeezables (void);
3015 extern int detect_input_pending_run_timers (int);
3016 extern void safe_run_hooks (Lisp_Object
);
3017 extern void cmd_error_internal (Lisp_Object
, const char *);
3018 extern Lisp_Object
command_loop_1 (void);
3019 extern Lisp_Object
recursive_edit_1 (void);
3020 extern void record_auto_save (void);
3022 extern void force_auto_save_soon (void);
3024 extern void init_keyboard (void);
3025 extern void syms_of_keyboard (void);
3026 extern void keys_of_keyboard (void);
3028 /* Defined in indent.c. */
3029 extern ptrdiff_t current_column (void);
3030 extern void invalidate_current_column (void);
3031 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3032 extern void syms_of_indent (void);
3034 /* Defined in frame.c. */
3035 extern Lisp_Object Qonly
;
3036 extern Lisp_Object Qvisible
;
3037 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3038 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3039 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3041 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3043 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3044 extern void frames_discard_buffer (Lisp_Object
);
3045 extern void syms_of_frame (void);
3047 /* Defined in emacs.c. */
3048 extern char **initial_argv
;
3049 extern int initial_argc
;
3050 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3051 extern int display_arg
;
3053 extern Lisp_Object
decode_env_path (const char *, const char *);
3054 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3055 extern Lisp_Object Qfile_name_handler_alist
;
3056 #ifdef FLOAT_CATCH_SIGILL
3057 extern void fatal_error_signal (int);
3059 extern Lisp_Object Qkill_emacs
;
3061 void fixup_locale (void);
3062 void synchronize_system_messages_locale (void);
3063 void synchronize_system_time_locale (void);
3065 #define setlocale(category, locale)
3066 #define fixup_locale()
3067 #define synchronize_system_messages_locale()
3068 #define synchronize_system_time_locale()
3070 void shut_down_emacs (int, int, Lisp_Object
);
3071 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3072 extern int noninteractive
;
3074 /* Nonzero means remove site-lisp directories from load-path. */
3075 extern int no_site_lisp
;
3077 /* Pipe used to send exit notification to the daemon parent at
3079 extern int daemon_pipe
[2];
3080 #define IS_DAEMON (daemon_pipe[1] != 0)
3082 /* Nonzero means don't do use window-system-specific display code. */
3083 extern int inhibit_window_system
;
3084 /* Nonzero means that a filter or a sentinel is running. */
3085 extern int running_asynch_code
;
3087 /* Defined in process.c. */
3088 extern Lisp_Object QCtype
, Qlocal
;
3089 extern Lisp_Object Qprocessp
;
3090 extern void kill_buffer_processes (Lisp_Object
);
3091 extern int wait_reading_process_output (intmax_t, int, int, int,
3093 struct Lisp_Process
*,
3095 /* Max value for the first argument of wait_reading_process_output. */
3096 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3097 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3098 The bug merely causes a bogus warning, but the warning is annoying. */
3099 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3101 # define WAIT_READING_MAX INTMAX_MAX
3103 extern void add_keyboard_wait_descriptor (int);
3104 extern void delete_keyboard_wait_descriptor (int);
3106 extern void add_gpm_wait_descriptor (int);
3107 extern void delete_gpm_wait_descriptor (int);
3109 extern void close_process_descs (void);
3110 extern void init_process_emacs (void);
3111 extern void syms_of_process (void);
3112 extern void setup_process_coding_systems (Lisp_Object
);
3117 extern int child_setup (int, int, int, char **, int, Lisp_Object
);
3118 extern void init_callproc_1 (void);
3119 extern void init_callproc (void);
3120 extern void set_initial_environment (void);
3121 extern void syms_of_callproc (void);
3123 /* Defined in doc.c */
3124 extern Lisp_Object Qfunction_documentation
;
3125 extern Lisp_Object
read_doc_string (Lisp_Object
);
3126 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3127 extern void syms_of_doc (void);
3128 extern int read_bytecode_char (int);
3130 /* Defined in bytecode.c */
3131 extern Lisp_Object Qbytecode
;
3132 extern void syms_of_bytecode (void);
3133 extern struct byte_stack
*byte_stack_list
;
3135 extern void mark_byte_stack (void);
3137 extern void unmark_byte_stack (void);
3138 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3139 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3141 /* Defined in macros.c */
3142 extern Lisp_Object Qexecute_kbd_macro
;
3143 extern void init_macros (void);
3144 extern void syms_of_macros (void);
3146 /* Defined in undo.c */
3147 extern Lisp_Object Qapply
;
3148 extern Lisp_Object Qinhibit_read_only
;
3149 extern void truncate_undo_list (struct buffer
*);
3150 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3151 extern void record_insert (ptrdiff_t, ptrdiff_t);
3152 extern void record_delete (ptrdiff_t, Lisp_Object
);
3153 extern void record_first_change (void);
3154 extern void record_change (ptrdiff_t, ptrdiff_t);
3155 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3156 Lisp_Object
, Lisp_Object
,
3158 extern void syms_of_undo (void);
3159 /* Defined in textprop.c */
3160 extern Lisp_Object Qfont
, Qmouse_face
;
3161 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3162 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3163 extern Lisp_Object Qminibuffer_prompt
;
3165 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3167 /* Defined in menu.c */
3168 extern void syms_of_menu (void);
3170 /* Defined in xmenu.c */
3171 extern void syms_of_xmenu (void);
3173 /* Defined in termchar.h */
3174 struct tty_display_info
;
3176 /* Defined in termhooks.h */
3179 /* Defined in sysdep.c */
3180 #ifndef HAVE_GET_CURRENT_DIR_NAME
3181 extern char *get_current_dir_name (void);
3183 extern void stuff_char (char c
);
3184 extern void init_sigio (int);
3185 extern void sys_subshell (void);
3186 extern void sys_suspend (void);
3187 extern void discard_tty_input (void);
3188 extern void init_sys_modes (struct tty_display_info
*);
3189 extern void reset_sys_modes (struct tty_display_info
*);
3190 extern void init_all_sys_modes (void);
3191 extern void reset_all_sys_modes (void);
3192 extern void wait_for_termination (pid_t
);
3193 extern void interruptible_wait_for_termination (pid_t
);
3194 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3195 extern void child_setup_tty (int);
3196 extern void setup_pty (int);
3197 extern int set_window_size (int, int, int);
3198 extern EMACS_INT
get_random (void);
3199 extern void seed_random (long);
3200 extern int emacs_open (const char *, int, int);
3201 extern int emacs_close (int);
3202 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3203 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3204 enum { READLINK_BUFSIZE
= 1024 };
3205 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3207 extern void unlock_all_files (void);
3208 extern void lock_file (Lisp_Object
);
3209 extern void unlock_file (Lisp_Object
);
3210 extern void unlock_buffer (struct buffer
*);
3211 extern void syms_of_filelock (void);
3213 /* Defined in sound.c */
3214 extern void syms_of_sound (void);
3216 /* Defined in category.c */
3217 extern void init_category_once (void);
3218 extern Lisp_Object
char_category_set (int);
3219 extern void syms_of_category (void);
3221 /* Defined in ccl.c */
3222 extern void syms_of_ccl (void);
3224 /* Defined in dired.c */
3225 extern void syms_of_dired (void);
3226 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3227 Lisp_Object
, Lisp_Object
,
3230 /* Defined in term.c */
3231 extern int *char_ins_del_vector
;
3232 extern void mark_ttys (void);
3233 extern void syms_of_term (void);
3234 extern _Noreturn
void fatal (const char *msgid
, ...)
3235 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3237 /* Defined in terminal.c */
3238 extern void syms_of_terminal (void);
3240 /* Defined in font.c */
3241 extern void syms_of_font (void);
3242 extern void init_font (void);
3244 #ifdef HAVE_WINDOW_SYSTEM
3245 /* Defined in fontset.c */
3246 extern void syms_of_fontset (void);
3248 /* Defined in xfns.c, w32fns.c, or macfns.c */
3249 extern Lisp_Object Qfont_param
;
3252 /* Defined in xfaces.c */
3253 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3254 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3255 extern Lisp_Object Qmode_line_inactive
;
3256 extern Lisp_Object Qface
;
3257 extern Lisp_Object Qnormal
;
3258 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3259 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3260 extern Lisp_Object Vface_alternative_font_family_alist
;
3261 extern Lisp_Object Vface_alternative_font_registry_alist
;
3262 extern void syms_of_xfaces (void);
3264 #ifdef HAVE_X_WINDOWS
3265 /* Defined in xfns.c */
3266 extern void syms_of_xfns (void);
3268 /* Defined in xsmfns.c */
3269 extern void syms_of_xsmfns (void);
3271 /* Defined in xselect.c */
3272 extern void syms_of_xselect (void);
3274 /* Defined in xterm.c */
3275 extern void syms_of_xterm (void);
3276 #endif /* HAVE_X_WINDOWS */
3278 #ifdef HAVE_WINDOW_SYSTEM
3279 /* Defined in xterm.c, nsterm.m, w32term.c */
3280 extern char *x_get_keysym_name (int);
3281 #endif /* HAVE_WINDOW_SYSTEM */
3284 /* Defined in xml.c */
3285 extern void syms_of_xml (void);
3286 extern void xml_cleanup_parser (void);
3290 /* Defined in (x|w32)fns.c, nsfns.m... */
3291 extern int have_menus_p (void);
3295 /* Defined in dbusbind.c */
3296 void syms_of_dbusbind (void);
3300 /* Defined in msdos.c, w32.c */
3301 extern char *emacs_root_dir (void);
3304 /* Nonzero means Emacs has already been initialized.
3305 Used during startup to detect startup of dumped Emacs. */
3306 extern int initialized
;
3308 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3310 extern void *xmalloc (size_t);
3311 extern void *xzalloc (size_t);
3312 extern void *xrealloc (void *, size_t);
3313 extern void xfree (void *);
3314 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3315 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3316 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3318 extern char *xstrdup (const char *);
3320 extern char *egetenv (const char *);
3322 /* Set up the name of the machine we're running on. */
3323 extern void init_system_name (void);
3325 static char const DIRECTORY_SEP
= '/';
3327 /* Use this to suppress gcc's warnings. */
3330 /* Use CODE only if lint checking is in effect. */
3331 # define IF_LINT(Code) Code
3333 /* Assume that the expression COND is true. This differs in intent
3334 from 'assert', as it is a message from the programmer to the compiler. */
3335 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3338 # define IF_LINT(Code) /* empty */
3339 # define lint_assume(cond) ((void) (0 && (cond)))
3342 /* We used to use `abs', but that clashes with system headers on some
3343 platforms, and using a name reserved by Standard C is a bad idea
3346 #define eabs(x) ((x) < 0 ? -(x) : (x))
3349 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3352 #define make_fixnum_or_float(val) \
3353 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3356 /* Checks the `cycle check' variable CHECK to see if it indicates that
3357 EL is part of a cycle; CHECK must be either Qnil or a value returned
3358 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3359 elements after which a cycle might be suspected; after that many
3360 elements, this macro begins consing in order to keep more precise
3363 Returns nil if a cycle was detected, otherwise a new value for CHECK
3366 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3367 the caller should make sure that's ok. */
3369 #define CYCLE_CHECK(check, el, suspicious) \
3372 : (INTEGERP (check) \
3373 ? (XFASTINT (check) < (suspicious) \
3374 ? make_number (XFASTINT (check) + 1) \
3375 : Fcons (el, Qnil)) \
3376 : (!NILP (Fmemq ((el), (check))) \
3378 : Fcons ((el), (check)))))
3381 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3382 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3384 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16*1024 };
3386 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3388 #define USE_SAFE_ALLOCA \
3389 ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0
3391 /* SAFE_ALLOCA allocates a simple buffer. */
3393 #define SAFE_ALLOCA(buf, type, size) \
3395 if ((size) < MAX_ALLOCA) \
3396 buf = (type) alloca (size); \
3399 buf = xmalloc (size); \
3401 record_unwind_protect (safe_alloca_unwind, \
3402 make_save_value (buf, 0)); \
3406 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3407 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3408 positive. The code is tuned for MULTIPLIER being a constant. */
3410 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3412 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3413 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3416 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3418 record_unwind_protect (safe_alloca_unwind, \
3419 make_save_value (buf, 0)); \
3423 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3425 #define SAFE_FREE() \
3427 if (sa_must_free) { \
3429 unbind_to (sa_count, Qnil); \
3434 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3436 #define SAFE_ALLOCA_LISP(buf, nelt) \
3438 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3439 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3440 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3443 buf = xmalloc ((nelt) * sizeof (Lisp_Object)); \
3444 arg_ = make_save_value (buf, nelt); \
3445 XSAVE_VALUE (arg_)->dogc = 1; \
3447 record_unwind_protect (safe_alloca_unwind, arg_); \
3450 memory_full (SIZE_MAX); \
3454 #include "globals.h"
3456 /* Check whether it's time for GC, and run it if so. */
3461 if ((consing_since_gc
> gc_cons_threshold
3462 && consing_since_gc
> gc_relative_threshold
)
3463 || (!NILP (Vmemory_full
)
3464 && consing_since_gc
> memory_full_cons_threshold
))
3465 Fgarbage_collect ();
3468 #endif /* EMACS_LISP_H */