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/>. */
33 # define LISP_INLINE INLINE
36 /* The ubiquitous max and min macros. */
39 #define max(a, b) ((a) > (b) ? (a) : (b))
40 #define min(a, b) ((a) < (b) ? (a) : (b))
42 /* EMACS_INT - signed integer wide enough to hold an Emacs value
43 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
44 pI - printf length modifier for EMACS_INT
45 EMACS_UINT - unsigned variant of EMACS_INT */
47 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
48 typedef long long int EMACS_INT
;
49 typedef unsigned long long int EMACS_UINT
;
50 # define EMACS_INT_MAX LLONG_MAX
52 # elif INT_MAX < LONG_MAX
53 typedef long int EMACS_INT
;
54 typedef unsigned long int EMACS_UINT
;
55 # define EMACS_INT_MAX LONG_MAX
58 typedef int EMACS_INT
;
59 typedef unsigned int EMACS_UINT
;
60 # define EMACS_INT_MAX INT_MAX
65 /* Number of bits in some machine integer types. */
68 BITS_PER_CHAR
= CHAR_BIT
,
69 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
70 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
71 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
72 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
75 /* printmax_t and uprintmax_t are types for printing large integers.
76 These are the widest integers that are supported for printing.
77 pMd etc. are conversions for printing them.
78 On C99 hosts, there's no problem, as even the widest integers work.
79 Fall back on EMACS_INT on pre-C99 hosts. */
81 typedef intmax_t printmax_t
;
82 typedef uintmax_t uprintmax_t
;
86 typedef EMACS_INT printmax_t
;
87 typedef EMACS_UINT uprintmax_t
;
92 /* Use pD to format ptrdiff_t values, which suffice for indexes into
93 buffers and strings. Emacs never allocates objects larger than
94 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
95 In C99, pD can always be "t"; configure it here for the sake of
96 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
97 #if PTRDIFF_MAX == INT_MAX
99 #elif PTRDIFF_MAX == LONG_MAX
101 #elif PTRDIFF_MAX == LLONG_MAX
107 /* Extra internal type checking? */
109 /* Define an Emacs version of 'assert (COND)', since some
110 system-defined 'assert's are flaky. COND should be free of side
111 effects; it may or may not be evaluated. */
112 #ifndef ENABLE_CHECKING
113 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
114 #else /* ENABLE_CHECKING */
116 extern _Noreturn
void die (const char *, const char *, int);
118 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
119 it to 1 using a debugger to temporarily disable aborting on
120 detected internal inconsistencies or error conditions.
122 In some cases, a good compiler may be able to optimize away the
123 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
124 STRINGP (x), but a particular use of XSTRING is invoked only after
125 testing that STRINGP (x) is true, making the test redundant. */
126 extern int suppress_checking EXTERNALLY_VISIBLE
;
128 # define eassert(cond) \
129 ((cond) || suppress_checking \
131 : die ("assertion failed: " # cond, __FILE__, __LINE__))
132 #endif /* ENABLE_CHECKING */
134 /* Use the configure flag --enable-check-lisp-object-type to make
135 Lisp_Object use a struct type instead of the default int. The flag
136 causes CHECK_LISP_OBJECT_TYPE to be defined. */
138 /***** Select the tagging scheme. *****/
139 /* The following option controls the tagging scheme:
140 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
141 always 0, and we can thus use them to hold tag bits, without
142 restricting our addressing space.
144 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
145 restricting our possible address range.
147 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
148 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
149 on the few static Lisp_Objects used: all the defsubr as well
150 as the two special buffers buffer_defaults and buffer_local_symbols. */
154 /* Number of bits in a Lisp_Object tag. This can be used in #if,
155 and for GDB's sake also as a regular symbol. */
160 /* 2**GCTYPEBITS. This must also be a macro that expands to a
161 literal integer constant, for MSVC. */
163 #define GCALIGNMENT 8
166 /* Number of bits in a Lisp_Object value, not counting the tag. */
167 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
169 /* Number of bits in a Lisp fixnum tag. */
170 INTTYPEBITS
= GCTYPEBITS
- 1,
172 /* Number of bits in a Lisp fixnum value, not counting the tag. */
173 FIXNUM_BITS
= VALBITS
+ 1
176 #if GCALIGNMENT != 1 << GCTYPEBITS
177 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
180 /* The maximum value that can be stored in a EMACS_INT, assuming all
181 bits other than the type bits contribute to a nonnegative signed value.
182 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
183 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
185 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
187 /* 1. We know malloc returns a multiple of 8. */
188 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
189 || defined DARWIN_OS || defined __sun)
190 /* 2. We can specify multiple-of-8 alignment on static variables. */
192 /* 3. Pointers-as-ints exceed VAL_MAX.
193 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
194 a. unnecessary, because the top bits of an EMACS_INT are unused, and
195 b. slower, because it typically requires extra masking.
196 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
197 # if VAL_MAX < UINTPTR_MAX
198 # define USE_LSB_TAG 1
205 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
206 # define USE_LSB_TAG 1
208 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
209 # define USE_LSB_TAG 0
213 # define alignas(alignment) /* empty */
215 # error "USE_LSB_TAG requires alignas"
220 /* Define the fundamental Lisp data structures. */
222 /* This is the set of Lisp data types. */
224 /* Lisp integers use 2 tags, to give them one extra bit, thus
225 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
226 static EMACS_INT
const INTMASK
= EMACS_INT_MAX
>> (INTTYPEBITS
- 1);
227 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
228 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
230 /* Stolen from GDB. The only known compiler that doesn't support
231 enums in bitfields is MSVC. */
233 #define ENUM_BF(TYPE) unsigned int
235 #define ENUM_BF(TYPE) enum TYPE
241 /* Integer. XINT (obj) is the integer value. */
243 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
245 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
248 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
249 whose first member indicates the subtype. */
252 /* String. XSTRING (object) points to a struct Lisp_String.
253 The length of the string, and its contents, are stored therein. */
254 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
256 /* Vector of Lisp objects, or something resembling it.
257 XVECTOR (object) points to a struct Lisp_Vector, which contains
258 the size and contents. The size field also contains the type
259 information, if it's not a real vector object. */
262 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
268 /* This is the set of data types that share a common structure.
269 The first member of the structure is a type code from this set.
270 The enum values are arbitrary, but we'll use large numbers to make it
271 more likely that we'll spot the error if a random word in memory is
272 mistakenly interpreted as a Lisp_Misc. */
275 Lisp_Misc_Free
= 0x5eab,
278 Lisp_Misc_Save_Value
,
279 /* Currently floats are not a misc type,
280 but let's define this in case we want to change that. */
282 /* This is not a type code. It is for range checking. */
286 /* These are the types of forwarding objects used in the value slot
287 of symbols for special built-in variables whose value is stored in
291 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
292 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
293 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
294 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
295 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
298 #ifdef CHECK_LISP_OBJECT_TYPE
300 typedef struct { EMACS_INT i
; } Lisp_Object
;
303 LISP_INLINE Lisp_Object
306 Lisp_Object o
= { i
};
310 LISP_INLINE Lisp_Object
311 LISP_MAKE_RVALUE (Lisp_Object o
)
316 #define LISP_INITIALLY_ZERO {0}
318 #undef CHECK_LISP_OBJECT_TYPE
319 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
320 #else /* CHECK_LISP_OBJECT_TYPE */
322 /* If a struct type is not wanted, define Lisp_Object as just a number. */
324 typedef EMACS_INT Lisp_Object
;
327 #define LISP_MAKE_RVALUE(o) (0+(o))
328 #define LISP_INITIALLY_ZERO 0
329 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
330 #endif /* CHECK_LISP_OBJECT_TYPE */
332 /* In the size word of a vector, this bit means the vector has been marked. */
334 static ptrdiff_t const ARRAY_MARK_FLAG
= PTRDIFF_MIN
;
336 /* In the size word of a struct Lisp_Vector, this bit means it's really
337 some other vector-like object. */
338 static ptrdiff_t const PSEUDOVECTOR_FLAG
339 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
342 /* In a pseudovector, the size field actually contains a word with one
343 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
344 indicate the actual type.
345 We use a bitset, even tho only one of the bits can be set at any
346 particular time just so as to be able to use micro-optimizations such as
347 testing membership of a particular subset of pseudovectors in Fequal.
348 It is not crucial, but there are plenty of bits here, so why not do it? */
351 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
360 PVEC_WINDOW_CONFIGURATION
,
363 /* These last 4 are special because we OR them in fns.c:internal_equal,
364 so they have to use a disjoint bit pattern:
365 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
366 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
367 PVEC_COMPILED
= 0x10,
368 PVEC_CHAR_TABLE
= 0x20,
369 PVEC_SUB_CHAR_TABLE
= 0x30,
373 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
374 which were stored in a Lisp_Object. */
375 #ifndef DATA_SEG_BITS
376 # define DATA_SEG_BITS 0
378 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
383 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
385 /* For convenience, we also store the number of elements in these bits.
386 Note that this size is not necessarily the memory-footprint size, but
387 only the number of Lisp_Object fields (that need to be traced by GC).
388 The distinction is used, e.g., by Lisp_Process, which places extra
389 non-Lisp_Object fields at the end of the structure. */
390 PSEUDOVECTOR_SIZE_BITS
= 16,
391 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
392 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
394 /* Number of bits to put in each character in the internal representation
395 of bool vectors. This should not vary across implementations. */
396 BOOL_VECTOR_BITS_PER_CHAR
= 8
399 /* These macros extract various sorts of values from a Lisp_Object.
400 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
401 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
403 /* Return a perfect hash of the Lisp_Object representation. */
404 #define XHASH(a) XLI (a)
410 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
413 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
414 #define XINT(a) (XLI (a) >> INTTYPEBITS)
415 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
416 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
417 #define XSET(var, type, ptr) \
418 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
419 (var) = XIL ((type) | (intptr_t) (ptr)))
421 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
422 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
424 #else /* not USE_LSB_TAG */
426 static EMACS_INT
const VALMASK
= VAL_MAX
;
428 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
430 /* For integers known to be positive, XFASTINT provides fast retrieval
431 and XSETFASTINT provides fast storage. This takes advantage of the
432 fact that Lisp integers have zero-bits in their tags. */
433 #define XFASTINT(a) (XLI (a) + 0)
434 #define XSETFASTINT(a, b) ((a) = XIL (b))
436 /* Extract the value of a Lisp_Object as a (un)signed integer. */
438 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
439 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
440 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
442 #define XSET(var, type, ptr) \
443 ((var) = XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
444 + ((intptr_t) (ptr) & VALMASK)))
447 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
448 which were stored in a Lisp_Object */
449 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
451 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
454 #endif /* not USE_LSB_TAG */
456 /* For integers known to be positive, XFASTINT sometimes provides
457 faster retrieval and XSETFASTINT provides faster storage.
458 If not, fallback on the non-accelerated path. */
460 # define XFASTINT(a) (XINT (a))
461 # define XSETFASTINT(a, b) (XSETINT (a, b))
464 /* Extract the pointer value of the Lisp object A, under the
465 assumption that A's type is TYPE. This is a fallback
466 implementation if nothing faster is available. */
468 # define XUNTAG(a, type) XPNTR (a)
471 #define EQ(x, y) (XHASH (x) == XHASH (y))
473 /* Largest and smallest representable fixnum values. These are the C
474 values. They are macros for use in static initializers, and
475 constants for visibility to GDB. */
476 static EMACS_INT
const MOST_POSITIVE_FIXNUM
=
477 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
478 MOST_POSITIVE_FIXNUM
;
479 static EMACS_INT
const MOST_NEGATIVE_FIXNUM
=
480 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
481 MOST_NEGATIVE_FIXNUM
;
483 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
484 written this way so that it also works if I is of unsigned
485 type or if I is a NaN. */
487 #define FIXNUM_OVERFLOW_P(i) \
488 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
490 LISP_INLINE
ptrdiff_t
491 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
493 return num
< lower
? lower
: num
<= upper
? num
: upper
;
496 /* Extract a value or address from a Lisp_Object. */
498 #define XCONS(a) (eassert (CONSP (a)), \
499 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
500 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
501 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
502 #define XSTRING(a) (eassert (STRINGP (a)), \
503 (struct Lisp_String *) XUNTAG (a, Lisp_String))
504 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
505 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
506 #define XFLOAT(a) (eassert (FLOATP (a)), \
507 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
511 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
512 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
513 #define XMISCTYPE(a) (XMISCANY (a)->type)
514 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
515 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
516 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
518 /* Forwarding object types. */
520 #define XFWDTYPE(a) (a->u_intfwd.type)
521 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
522 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
523 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
524 #define XBUFFER_OBJFWD(a) \
525 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
526 #define XKBOARD_OBJFWD(a) \
527 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
529 /* Pseudovector types. */
531 #define XPROCESS(a) (eassert (PROCESSP (a)), \
532 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
533 #define XWINDOW(a) (eassert (WINDOWP (a)), \
534 (struct window *) XUNTAG (a, Lisp_Vectorlike))
535 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
536 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
537 #define XSUBR(a) (eassert (SUBRP (a)), \
538 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
539 #define XBUFFER(a) (eassert (BUFFERP (a)), \
540 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
541 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
542 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
543 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
544 ((struct Lisp_Sub_Char_Table *) \
545 XUNTAG (a, Lisp_Vectorlike)))
546 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
547 ((struct Lisp_Bool_Vector *) \
548 XUNTAG (a, Lisp_Vectorlike)))
550 /* Construct a Lisp_Object from a value or address. */
552 #define XSETINT(a, b) (a) = make_number (b)
553 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
554 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
555 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
556 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
557 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
561 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
562 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
564 /* Pseudovector types. */
566 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
567 #define XSETTYPED_PVECTYPE(v, size_member, code) \
568 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
569 #define XSETPVECTYPESIZE(v, code, sizeval) \
570 ((v)->header.size = (PSEUDOVECTOR_FLAG \
571 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
574 /* The cast to struct vectorlike_header * avoids aliasing issues. */
575 #define XSETPSEUDOVECTOR(a, b, code) \
576 XSETTYPED_PSEUDOVECTOR (a, b, \
577 (((struct vectorlike_header *) \
578 XUNTAG (a, Lisp_Vectorlike)) \
581 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
582 (XSETVECTOR (a, b), \
583 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
584 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
586 #define XSETWINDOW_CONFIGURATION(a, b) \
587 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
588 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
589 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
590 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
591 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
592 #define XSETSUBR(a, b) \
593 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
594 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
595 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
596 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
597 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
598 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
600 /* Convenience macros for dealing with Lisp arrays. */
602 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
603 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
604 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
605 #define ASET(ARRAY, IDX, VAL) \
606 (eassert ((IDX) == (IDX)), \
607 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
608 XVECTOR (ARRAY)->contents[IDX] = (VAL))
610 /* Convenience macros for dealing with Lisp strings. */
612 #define SDATA(string) (XSTRING (string)->data + 0)
613 #define SREF(string, index) (SDATA (string)[index] + 0)
614 #define SSET(string, index, new) (SDATA (string)[index] = (new))
615 #define SCHARS(string) (XSTRING (string)->size + 0)
616 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
618 /* Avoid "differ in sign" warnings. */
619 #define SSDATA(x) ((char *) SDATA (x))
621 #define STRING_SET_CHARS(string, newsize) \
622 (XSTRING (string)->size = (newsize))
624 #define STRING_COPYIN(string, index, new, count) \
625 memcpy (SDATA (string) + index, new, count)
629 #define CHECK_TYPE(ok, Qxxxp, x) \
630 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
632 /* Lisp fields are usually hidden from most code and accessed
633 via special macros. Only select pieces of code, like the GC,
634 are allowed to use INTERNAL_FIELD directly. Objects which
635 aren't using this convention should be fixed. */
637 #define INTERNAL_FIELD(field) field ## _
639 /* See the macros in intervals.h. */
641 typedef struct interval
*INTERVAL
;
643 /* Complain if object is not string or buffer type */
644 #define CHECK_STRING_OR_BUFFER(x) \
645 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
647 /* Most code should use this macro to
648 access Lisp fields in struct Lisp_Cons. */
650 #define CVAR(cons, field) ((cons)->INTERNAL_FIELD (field))
654 /* Car of this cons cell. */
655 Lisp_Object
INTERNAL_FIELD (car
);
659 /* Cdr of this cons cell. */
660 Lisp_Object
INTERNAL_FIELD (cdr
);
662 /* Used to chain conses on a free list. */
663 struct Lisp_Cons
*chain
;
667 /* Take the car or cdr of something known to be a cons cell. */
668 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
669 of code that has to know what a cons cell looks like. Other code not
670 part of the basic lisp implementation should assume that the car and cdr
671 fields are not accessible as lvalues. (What if we want to switch to
672 a copying collector someday? Cached cons cell field addresses may be
673 invalidated at arbitrary points.) */
674 #define XCAR_AS_LVALUE(c) (CVAR (XCONS (c), car))
675 #define XCDR_AS_LVALUE(c) (CVAR (XCONS (c), u.cdr))
677 /* Use these from normal code. */
678 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
679 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
681 /* Use these to set the fields of a cons cell.
683 Note that both arguments may refer to the same object, so 'n'
684 should not be read after 'c' is first modified. Also, neither
685 argument should be evaluated more than once; side effects are
686 especially common in the second argument. */
687 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
688 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
690 /* Take the car or cdr of something whose type is not known. */
692 (CONSP ((c)) ? XCAR ((c)) \
693 : NILP ((c)) ? Qnil \
694 : wrong_type_argument (Qlistp, (c)))
697 (CONSP ((c)) ? XCDR ((c)) \
698 : NILP ((c)) ? Qnil \
699 : wrong_type_argument (Qlistp, (c)))
701 /* Take the car or cdr of something whose type is not known. */
702 #define CAR_SAFE(c) \
703 (CONSP ((c)) ? XCAR ((c)) : Qnil)
705 #define CDR_SAFE(c) \
706 (CONSP ((c)) ? XCDR ((c)) : Qnil)
708 /* Nonzero if STR is a multibyte string. */
709 #define STRING_MULTIBYTE(STR) \
710 (XSTRING (STR)->size_byte >= 0)
712 /* Return the length in bytes of STR. */
714 #ifdef GC_CHECK_STRING_BYTES
717 extern ptrdiff_t string_bytes (struct Lisp_String
*);
718 #define STRING_BYTES(S) string_bytes ((S))
720 #else /* not GC_CHECK_STRING_BYTES */
722 #define STRING_BYTES(STR) \
723 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
725 #endif /* not GC_CHECK_STRING_BYTES */
727 /* An upper bound on the number of bytes in a Lisp string, not
728 counting the terminating null. This a tight enough bound to
729 prevent integer overflow errors that would otherwise occur during
730 string size calculations. A string cannot contain more bytes than
731 a fixnum can represent, nor can it be so long that C pointer
732 arithmetic stops working on the string plus its terminating null.
733 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
734 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
735 would expose alloc.c internal details that we'd rather keep
738 This is a macro for use in static initializers, and a constant for
739 visibility to GDB. The cast to ptrdiff_t ensures that
740 the macro is signed. */
741 static ptrdiff_t const STRING_BYTES_BOUND
=
742 #define STRING_BYTES_BOUND \
743 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
746 /* Mark STR as a unibyte string. */
747 #define STRING_SET_UNIBYTE(STR) \
748 do { if (EQ (STR, empty_multibyte_string)) \
749 (STR) = empty_unibyte_string; \
750 else XSTRING (STR)->size_byte = -1; } while (0)
752 /* Mark STR as a multibyte string. Assure that STR contains only
753 ASCII characters in advance. */
754 #define STRING_SET_MULTIBYTE(STR) \
755 do { if (EQ (STR, empty_unibyte_string)) \
756 (STR) = empty_multibyte_string; \
757 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
759 /* Get text properties. */
760 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
762 /* Set text properties. */
763 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
765 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
771 INTERVAL intervals
; /* Text properties in this string. */
775 /* Header of vector-like objects. This documents the layout constraints on
776 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
777 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
778 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
779 because when two such pointers potentially alias, a compiler won't
780 incorrectly reorder loads and stores to their size fields. See
781 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
782 struct vectorlike_header
784 /* This field contains various pieces of information:
785 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
786 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
787 vector (0) or a pseudovector (1).
788 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
789 of slots) of the vector.
790 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
791 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
792 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
793 Lisp_Object slots at the beginning of the object that need to be
794 traced by the GC, tho some types use it slightly differently.
795 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
796 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
800 /* When the vector is allocated from a vector block, NBYTES is used
801 if the vector is not on a free list, and VECTOR is used otherwise.
802 For large vector-like objects, BUFFER or VECTOR is used as a pointer
803 to the next vector-like object. It is generally a buffer or a
804 Lisp_Vector alias, so for convenience it is a union instead of a
805 pointer: this way, one can write P->next.vector instead of ((struct
806 Lisp_Vector *) P->next). */
808 /* This is only needed for small vectors that are not free because the
809 `size' field only gives us the number of Lisp_Object slots, whereas we
810 need to know the total size, including non-Lisp_Object data.
811 FIXME: figure out a way to store this info elsewhere so we can
812 finally get rid of this extra word of overhead. */
814 struct buffer
*buffer
;
815 /* FIXME: This can be removed: For large vectors, this field could be
816 placed *before* the vector itself. And for small vectors on a free
817 list, this field could be stored in the vector's bytes, since the
818 empty vector is handled specially anyway. */
819 struct Lisp_Vector
*vector
;
825 struct vectorlike_header header
;
826 Lisp_Object contents
[1];
829 /* If a struct is made to look like a vector, this macro returns the length
830 of the shortest vector that would hold that struct. */
831 #define VECSIZE(type) ((sizeof (type) \
832 - offsetof (struct Lisp_Vector, contents[0]) \
833 + sizeof (Lisp_Object) - 1) /* Round up. */ \
834 / sizeof (Lisp_Object))
836 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
837 at the end and we need to compute the number of Lisp_Object fields (the
838 ones that the GC needs to trace). */
839 #define PSEUDOVECSIZE(type, nonlispfield) \
840 ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \
841 / sizeof (Lisp_Object))
843 /* A char-table is a kind of vectorlike, with contents are like a
844 vector but with a few other slots. For some purposes, it makes
845 sense to handle a char-table with type struct Lisp_Vector. An
846 element of a char table can be any Lisp objects, but if it is a sub
847 char-table, we treat it a table that contains information of a
848 specific range of characters. A sub char-table has the same
849 structure as a vector. A sub char table appears only in an element
850 of a char-table, and there's no way to access it directly from
851 Emacs Lisp program. */
855 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
856 ({struct Lisp_Char_Table *_tbl = NULL; \
859 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
860 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
861 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
863 _val = _tbl->defalt; \
864 } while (NILP (_val) && ! NILP (_tbl->parent)); \
867 #else /* not __GNUC__ */
869 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
870 (! NILP (XCHAR_TABLE (CT)->ascii) \
871 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
872 ? XCHAR_TABLE (CT)->ascii \
873 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
874 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
875 : char_table_ref ((CT), (IDX))) \
876 : char_table_ref ((CT), (IDX)))
878 #endif /* not __GNUC__ */
880 /* Compute A OP B, using the unsigned comparison operator OP. A and B
881 should be integer expressions. This is not the same as
882 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
883 returns 1. For efficiency, prefer plain unsigned comparison if A
884 and B's sizes both fit (after integer promotion). */
885 #define UNSIGNED_CMP(a, op, b) \
886 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
887 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
888 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
890 /* Nonzero iff C is an ASCII character. */
891 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
893 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
894 characters. Do not check validity of CT. */
895 #define CHAR_TABLE_REF(CT, IDX) \
896 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
897 : char_table_ref ((CT), (IDX)))
899 /* Almost equivalent to Faref (CT, IDX). However, if the result is
900 not a character, return IDX.
902 For these characters, do not check validity of CT
903 and do not follow parent. */
904 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
905 char_table_translate (CT, IDX)
907 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
908 8-bit European characters. Do not check validity of CT. */
909 #define CHAR_TABLE_SET(CT, IDX, VAL) \
910 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
911 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
912 : char_table_set (CT, IDX, VAL))
914 enum CHARTAB_SIZE_BITS
916 CHARTAB_SIZE_BITS_0
= 6,
917 CHARTAB_SIZE_BITS_1
= 4,
918 CHARTAB_SIZE_BITS_2
= 5,
919 CHARTAB_SIZE_BITS_3
= 7
922 extern const int chartab_size
[4];
924 struct Lisp_Sub_Char_Table
;
926 struct Lisp_Char_Table
928 /* HEADER.SIZE is the vector's size field, which also holds the
929 pseudovector type information. It holds the size, too.
930 The size counts the defalt, parent, purpose, ascii,
931 contents, and extras slots. */
932 struct vectorlike_header header
;
934 /* This holds a default value,
935 which is used whenever the value for a specific character is nil. */
938 /* This points to another char table, which we inherit from when the
939 value for a specific character is nil. The `defalt' slot takes
940 precedence over this. */
943 /* This is a symbol which says what kind of use this char-table is
947 /* The bottom sub char-table for characters of the range 0..127. It
948 is nil if none of ASCII character has a specific value. */
951 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
953 /* These hold additional data. It is a vector. */
954 Lisp_Object extras
[1];
957 struct Lisp_Sub_Char_Table
959 /* HEADER.SIZE is the vector's size field, which also holds the
960 pseudovector type information. It holds the size, too. */
961 struct vectorlike_header header
;
963 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
964 char-table of depth 1 contains 16 elements, and each element
965 covers 4096 (128*32) characters. A sub char-table of depth 2
966 contains 32 elements, and each element covers 128 characters. A
967 sub char-table of depth 3 contains 128 elements, and each element
968 is for one character. */
971 /* Minimum character covered by the sub char-table. */
972 Lisp_Object min_char
;
974 Lisp_Object contents
[1];
977 /* A boolvector is a kind of vectorlike, with contents are like a string. */
978 struct Lisp_Bool_Vector
980 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
981 just the subtype information. */
982 struct vectorlike_header header
;
983 /* This is the size in bits. */
985 /* This contains the actual bits, packed into bytes. */
986 unsigned char data
[1];
989 /* This structure describes a built-in function.
990 It is generated by the DEFUN macro only.
991 defsubr makes it into a Lisp object.
993 This type is treated in most respects as a pseudovector,
994 but since we never dynamically allocate or free them,
995 we don't need a struct vectorlike_header and its 'next' field. */
1001 Lisp_Object (*a0
) (void);
1002 Lisp_Object (*a1
) (Lisp_Object
);
1003 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1004 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1005 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1006 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1007 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1008 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1009 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1010 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1011 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1013 short min_args
, max_args
;
1014 const char *symbol_name
;
1015 const char *intspec
;
1019 /* This is the number of slots that every char table must have. This
1020 counts the ordinary slots and the top, defalt, parent, and purpose
1022 enum CHAR_TABLE_STANDARD_SLOTS
1024 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1027 /* Return the number of "extra" slots in the char table CT. */
1029 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1030 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1033 /***********************************************************************
1035 ***********************************************************************/
1037 /* Interned state of a symbol. */
1039 enum symbol_interned
1041 SYMBOL_UNINTERNED
= 0,
1042 SYMBOL_INTERNED
= 1,
1043 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1046 enum symbol_redirect
1048 SYMBOL_PLAINVAL
= 4,
1049 SYMBOL_VARALIAS
= 1,
1050 SYMBOL_LOCALIZED
= 2,
1051 SYMBOL_FORWARDED
= 3
1054 /* Most code should use this macro to access
1055 Lisp fields in struct Lisp_Symbol. */
1057 #define SVAR(sym, field) ((sym)->INTERNAL_FIELD (field))
1061 unsigned gcmarkbit
: 1;
1063 /* Indicates where the value can be found:
1064 0 : it's a plain var, the value is in the `value' field.
1065 1 : it's a varalias, the value is really in the `alias' symbol.
1066 2 : it's a localized var, the value is in the `blv' object.
1067 3 : it's a forwarding variable, the value is in `forward'. */
1068 ENUM_BF (symbol_redirect
) redirect
: 3;
1070 /* Non-zero means symbol is constant, i.e. changing its value
1071 should signal an error. If the value is 3, then the var
1072 can be changed, but only by `defconst'. */
1073 unsigned constant
: 2;
1075 /* Interned state of the symbol. This is an enumerator from
1076 enum symbol_interned. */
1077 unsigned interned
: 2;
1079 /* Non-zero means that this variable has been explicitly declared
1080 special (with `defvar' etc), and shouldn't be lexically bound. */
1081 unsigned declared_special
: 1;
1083 /* The symbol's name, as a Lisp string.
1084 The name "xname" is used to intentionally break code referring to
1085 the old field "name" of type pointer to struct Lisp_String. */
1086 Lisp_Object
INTERNAL_FIELD (xname
);
1088 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1089 union is used depends on the `redirect' field above. */
1091 Lisp_Object
INTERNAL_FIELD (value
);
1092 struct Lisp_Symbol
*alias
;
1093 struct Lisp_Buffer_Local_Value
*blv
;
1094 union Lisp_Fwd
*fwd
;
1097 /* Function value of the symbol or Qunbound if not fboundp. */
1098 Lisp_Object
INTERNAL_FIELD (function
);
1100 /* The symbol's property list. */
1101 Lisp_Object
INTERNAL_FIELD (plist
);
1103 /* Next symbol in obarray bucket, if the symbol is interned. */
1104 struct Lisp_Symbol
*next
;
1107 /* Value is name of symbol. */
1109 #define SYMBOL_VAL(sym) \
1110 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), SVAR (sym, val.value))
1111 #define SYMBOL_ALIAS(sym) \
1112 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1113 #define SYMBOL_BLV(sym) \
1114 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1115 #define SYMBOL_FWD(sym) \
1116 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1117 #define SET_SYMBOL_VAL(sym, v) \
1118 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), SVAR (sym, val.value) = (v))
1119 #define SET_SYMBOL_ALIAS(sym, v) \
1120 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1121 #define SET_SYMBOL_BLV(sym, v) \
1122 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1123 #define SET_SYMBOL_FWD(sym, v) \
1124 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1126 #define SYMBOL_NAME(sym) \
1127 LISP_MAKE_RVALUE (SVAR (XSYMBOL (sym), xname))
1129 /* Value is non-zero if SYM is an interned symbol. */
1131 #define SYMBOL_INTERNED_P(sym) \
1132 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1134 /* Value is non-zero if SYM is interned in initial_obarray. */
1136 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1137 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1139 /* Value is non-zero if symbol is considered a constant, i.e. its
1140 value cannot be changed (there is an exception for keyword symbols,
1141 whose value can be set to the keyword symbol itself). */
1143 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1145 #define DEFSYM(sym, name) \
1146 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1149 /***********************************************************************
1151 ***********************************************************************/
1153 /* The structure of a Lisp hash table. */
1155 struct Lisp_Hash_Table
1157 /* This is for Lisp; the hash table code does not refer to it. */
1158 struct vectorlike_header header
;
1160 /* Function used to compare keys. */
1163 /* Nil if table is non-weak. Otherwise a symbol describing the
1164 weakness of the table. */
1167 /* When the table is resized, and this is an integer, compute the
1168 new size by adding this to the old size. If a float, compute the
1169 new size by multiplying the old size with this factor. */
1170 Lisp_Object rehash_size
;
1172 /* Resize hash table when number of entries/ table size is >= this
1174 Lisp_Object rehash_threshold
;
1176 /* Vector of hash codes.. If hash[I] is nil, this means that that
1177 entry I is unused. */
1180 /* Vector used to chain entries. If entry I is free, next[I] is the
1181 entry number of the next free item. If entry I is non-free,
1182 next[I] is the index of the next entry in the collision chain. */
1185 /* Index of first free entry in free list. */
1186 Lisp_Object next_free
;
1188 /* Bucket vector. A non-nil entry is the index of the first item in
1189 a collision chain. This vector's size can be larger than the
1190 hash table size to reduce collisions. */
1193 /* User-supplied hash function, or nil. */
1194 Lisp_Object user_hash_function
;
1196 /* User-supplied key comparison function, or nil. */
1197 Lisp_Object user_cmp_function
;
1199 /* Only the fields above are traced normally by the GC. The ones below
1200 `count' are special and are either ignored by the GC or traced in
1201 a special way (e.g. because of weakness). */
1203 /* Number of key/value entries in the table. */
1206 /* Vector of keys and values. The key of item I is found at index
1207 2 * I, the value is found at index 2 * I + 1.
1208 This is gc_marked specially if the table is weak. */
1209 Lisp_Object key_and_value
;
1211 /* Next weak hash table if this is a weak hash table. The head
1212 of the list is in weak_hash_tables. */
1213 struct Lisp_Hash_Table
*next_weak
;
1215 /* C function to compare two keys. */
1216 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1217 Lisp_Object
, EMACS_UINT
,
1218 Lisp_Object
, EMACS_UINT
);
1220 /* C function to compute hash code. */
1221 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1225 #define XHASH_TABLE(OBJ) \
1226 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1228 #define XSET_HASH_TABLE(VAR, PTR) \
1229 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1231 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1233 #define CHECK_HASH_TABLE(x) \
1234 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1236 /* Value is the key part of entry IDX in hash table H. */
1238 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1240 /* Value is the value part of entry IDX in hash table H. */
1242 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1244 /* Value is the index of the next entry following the one at IDX
1247 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1249 /* Value is the hash code computed for entry IDX in hash table H. */
1251 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1253 /* Value is the index of the element in hash table H that is the
1254 start of the collision list at index IDX in the index vector of H. */
1256 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1258 /* Value is the size of hash table H. */
1260 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1262 /* Default size for hash tables if not specified. */
1264 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1266 /* Default threshold specifying when to resize a hash table. The
1267 value gives the ratio of current entries in the hash table and the
1268 size of the hash table. */
1270 #define DEFAULT_REHASH_THRESHOLD 0.8
1272 /* Default factor by which to increase the size of a hash table. */
1274 #define DEFAULT_REHASH_SIZE 1.5
1276 /* Most code should use this macro to access
1277 Lisp fields in a different misc objects. */
1279 #define MVAR(misc, field) ((misc)->INTERNAL_FIELD (field))
1281 /* These structures are used for various misc types. */
1283 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1285 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1286 unsigned gcmarkbit
: 1;
1292 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1293 unsigned gcmarkbit
: 1;
1295 /* This flag is temporarily used in the functions
1296 decode/encode_coding_object to record that the marker position
1297 must be adjusted after the conversion. */
1298 unsigned int need_adjustment
: 1;
1299 /* 1 means normal insertion at the marker's position
1300 leaves the marker after the inserted text. */
1301 unsigned int insertion_type
: 1;
1302 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1303 Note: a chain of markers can contain markers pointing into different
1304 buffers (the chain is per buffer_text rather than per buffer, so it's
1305 shared between indirect buffers). */
1306 /* This is used for (other than NULL-checking):
1308 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1309 - unchain_marker: to find the list from which to unchain.
1310 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1312 struct buffer
*buffer
;
1314 /* The remaining fields are meaningless in a marker that
1315 does not point anywhere. */
1317 /* For markers that point somewhere,
1318 this is used to chain of all the markers in a given buffer. */
1319 /* We could remove it and use an array in buffer_text instead.
1320 That would also allow to preserve it ordered. */
1321 struct Lisp_Marker
*next
;
1322 /* This is the char position where the marker points. */
1324 /* This is the byte position.
1325 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1326 used to implement the functionality of markers, but rather to (ab)use
1327 markers as a cache for char<->byte mappings). */
1331 /* START and END are markers in the overlay's buffer, and
1332 PLIST is the overlay's property list. */
1334 /* An overlay's real data content is:
1336 - buffer (really there are two buffer pointers, one per marker,
1337 and both points to the same buffer)
1338 - insertion type of both ends (per-marker fields)
1339 - start & start byte (of start marker)
1340 - end & end byte (of end marker)
1341 - next (singly linked list of overlays)
1342 - next fields of start and end markers (singly linked list of markers).
1343 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1346 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1347 unsigned gcmarkbit
: 1;
1349 struct Lisp_Overlay
*next
;
1350 Lisp_Object
INTERNAL_FIELD (start
);
1351 Lisp_Object
INTERNAL_FIELD (end
);
1352 Lisp_Object
INTERNAL_FIELD (plist
);
1355 /* Hold a C pointer for later use.
1356 This type of object is used in the arg to record_unwind_protect. */
1357 struct Lisp_Save_Value
1359 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1360 unsigned gcmarkbit
: 1;
1362 /* If DOGC is set, POINTER is the address of a memory
1363 area containing INTEGER potential Lisp_Objects. */
1364 unsigned int dogc
: 1;
1370 /* A miscellaneous object, when it's on the free list. */
1373 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1374 unsigned gcmarkbit
: 1;
1376 union Lisp_Misc
*chain
;
1379 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1380 It uses one of these struct subtypes to get the type field. */
1384 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1385 struct Lisp_Free u_free
;
1386 struct Lisp_Marker u_marker
;
1387 struct Lisp_Overlay u_overlay
;
1388 struct Lisp_Save_Value u_save_value
;
1391 /* Forwarding pointer to an int variable.
1392 This is allowed only in the value cell of a symbol,
1393 and it means that the symbol's value really lives in the
1394 specified int variable. */
1397 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1401 /* Boolean forwarding pointer to an int variable.
1402 This is like Lisp_Intfwd except that the ostensible
1403 "value" of the symbol is t if the int variable is nonzero,
1404 nil if it is zero. */
1407 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1411 /* Forwarding pointer to a Lisp_Object variable.
1412 This is allowed only in the value cell of a symbol,
1413 and it means that the symbol's value really lives in the
1414 specified variable. */
1417 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1418 Lisp_Object
*objvar
;
1421 /* Like Lisp_Objfwd except that value lives in a slot in the
1422 current buffer. Value is byte index of slot within buffer. */
1423 struct Lisp_Buffer_Objfwd
1425 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1427 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1430 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1431 the symbol has buffer-local or frame-local bindings. (Exception:
1432 some buffer-local variables are built-in, with their values stored
1433 in the buffer structure itself. They are handled differently,
1434 using struct Lisp_Buffer_Objfwd.)
1436 The `realvalue' slot holds the variable's current value, or a
1437 forwarding pointer to where that value is kept. This value is the
1438 one that corresponds to the loaded binding. To read or set the
1439 variable, you must first make sure the right binding is loaded;
1440 then you can access the value in (or through) `realvalue'.
1442 `buffer' and `frame' are the buffer and frame for which the loaded
1443 binding was found. If those have changed, to make sure the right
1444 binding is loaded it is necessary to find which binding goes with
1445 the current buffer and selected frame, then load it. To load it,
1446 first unload the previous binding, then copy the value of the new
1447 binding into `realvalue' (or through it). Also update
1448 LOADED-BINDING to point to the newly loaded binding.
1450 `local_if_set' indicates that merely setting the variable creates a
1451 local binding for the current buffer. Otherwise the latter, setting
1452 the variable does not do that; only make-local-variable does that. */
1454 struct Lisp_Buffer_Local_Value
1456 /* 1 means that merely setting the variable creates a local
1457 binding for the current buffer. */
1458 unsigned int local_if_set
: 1;
1459 /* 1 means this variable can have frame-local bindings, otherwise, it is
1460 can have buffer-local bindings. The two cannot be combined. */
1461 unsigned int frame_local
: 1;
1462 /* 1 means that the binding now loaded was found.
1463 Presumably equivalent to (defcell!=valcell). */
1464 unsigned int found
: 1;
1465 /* If non-NULL, a forwarding to the C var where it should also be set. */
1466 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1467 /* The buffer or frame for which the loaded binding was found. */
1469 /* A cons cell that holds the default value. It has the form
1470 (SYMBOL . DEFAULT-VALUE). */
1471 Lisp_Object defcell
;
1472 /* The cons cell from `where's parameter alist.
1473 It always has the form (SYMBOL . VALUE)
1474 Note that if `forward' is non-nil, VALUE may be out of date.
1475 Also if the currently loaded binding is the default binding, then
1476 this is `eq'ual to defcell. */
1477 Lisp_Object valcell
;
1480 #define BLV_FOUND(blv) \
1481 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1482 #define SET_BLV_FOUND(blv, v) \
1483 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1485 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1486 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1488 /* Like Lisp_Objfwd except that value lives in a slot in the
1490 struct Lisp_Kboard_Objfwd
1492 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1498 struct Lisp_Intfwd u_intfwd
;
1499 struct Lisp_Boolfwd u_boolfwd
;
1500 struct Lisp_Objfwd u_objfwd
;
1501 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1502 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1505 /* Lisp floating point type. */
1511 struct Lisp_Float
*chain
;
1515 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1516 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1518 /* A character, declared with the following typedef, is a member
1519 of some character set associated with the current buffer. */
1520 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1522 typedef unsigned char UCHAR
;
1525 /* Meanings of slots in a Lisp_Compiled: */
1529 COMPILED_ARGLIST
= 0,
1530 COMPILED_BYTECODE
= 1,
1531 COMPILED_CONSTANTS
= 2,
1532 COMPILED_STACK_DEPTH
= 3,
1533 COMPILED_DOC_STRING
= 4,
1534 COMPILED_INTERACTIVE
= 5
1537 /* Flag bits in a character. These also get used in termhooks.h.
1538 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1539 (MUlti-Lingual Emacs) might need 22 bits for the character value
1540 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1543 CHAR_ALT
= 0x0400000,
1544 CHAR_SUPER
= 0x0800000,
1545 CHAR_HYPER
= 0x1000000,
1546 CHAR_SHIFT
= 0x2000000,
1547 CHAR_CTL
= 0x4000000,
1548 CHAR_META
= 0x8000000,
1550 CHAR_MODIFIER_MASK
=
1551 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1553 /* Actually, the current Emacs uses 22 bits for the character value
1561 /* The glyph datatype, used to represent characters on the display.
1562 It consists of a char code and a face id. */
1569 /* Return a glyph's character code. */
1570 #define GLYPH_CHAR(glyph) ((glyph).ch)
1572 /* Return a glyph's face ID. */
1573 #define GLYPH_FACE(glyph) ((glyph).face_id)
1575 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1576 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1577 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1579 /* Return 1 if GLYPH contains valid character code. */
1580 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1583 /* Glyph Code from a display vector may either be an integer which
1584 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1585 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1587 #define GLYPH_CODE_P(gc) \
1589 ? (CHARACTERP (XCAR (gc)) \
1590 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1591 : (RANGED_INTEGERP \
1593 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1594 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1595 : TYPE_MAXIMUM (EMACS_INT)))))
1597 /* The following are valid only if GLYPH_CODE_P (gc). */
1599 #define GLYPH_CODE_CHAR(gc) \
1600 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1602 #define GLYPH_CODE_FACE(gc) \
1603 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1605 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1609 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1611 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1612 (XINT (gc) >> CHARACTERBITS)); \
1616 /* Structure to hold mouse highlight data. This is here because other
1617 header files need it for defining struct x_output etc. */
1619 /* These variables describe the range of text currently shown in its
1620 mouse-face, together with the window they apply to. As long as
1621 the mouse stays within this range, we need not redraw anything on
1622 its account. Rows and columns are glyph matrix positions in
1623 MOUSE_FACE_WINDOW. */
1624 int mouse_face_beg_row
, mouse_face_beg_col
;
1625 int mouse_face_beg_x
, mouse_face_beg_y
;
1626 int mouse_face_end_row
, mouse_face_end_col
;
1627 int mouse_face_end_x
, mouse_face_end_y
;
1628 int mouse_face_past_end
;
1629 Lisp_Object mouse_face_window
;
1630 int mouse_face_face_id
;
1631 Lisp_Object mouse_face_overlay
;
1633 /* 1 if a mouse motion event came and we didn't handle it right away because
1634 gc was in progress. */
1635 int mouse_face_deferred_gc
;
1637 /* FRAME and X, Y position of mouse when last checked for
1638 highlighting. X and Y can be negative or out of range for the frame. */
1639 struct frame
*mouse_face_mouse_frame
;
1640 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1642 /* Nonzero means defer mouse-motion highlighting. */
1643 int mouse_face_defer
;
1645 /* Nonzero means that the mouse highlight should not be shown. */
1646 int mouse_face_hidden
;
1648 int mouse_face_image_state
;
1651 /* Data type checking */
1653 #define NILP(x) EQ (x, Qnil)
1655 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1656 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1658 #define RANGED_INTEGERP(lo, x, hi) \
1659 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1660 #define TYPE_RANGED_INTEGERP(type, x) \
1661 (TYPE_SIGNED (type) \
1662 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1663 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1665 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1666 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1667 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1668 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1669 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1670 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1672 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1673 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1674 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1675 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1676 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1678 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1679 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1680 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1681 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1682 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1684 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1685 vectorlike_header * avoids aliasing issues. */
1686 #define PSEUDOVECTORP(x, code) \
1687 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1689 #define PSEUDOVECTOR_TYPEP(v, code) \
1690 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1691 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1693 /* True if object X, with internal type struct T *, is a pseudovector whose
1695 #define TYPED_PSEUDOVECTORP(x, t, code) \
1697 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1699 /* Test for specific pseudovector types. */
1700 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1701 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1702 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1703 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1704 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1705 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1706 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1707 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1708 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1709 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1710 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1711 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1713 /* Test for image (image . spec) */
1714 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1719 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1721 #define CHECK_LIST(x) \
1722 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1724 #define CHECK_LIST_CONS(x, y) \
1725 CHECK_TYPE (CONSP (x), Qlistp, y)
1727 #define CHECK_LIST_END(x, y) \
1728 CHECK_TYPE (NILP (x), Qlistp, y)
1730 #define CHECK_STRING(x) \
1731 CHECK_TYPE (STRINGP (x), Qstringp, x)
1733 #define CHECK_STRING_CAR(x) \
1734 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1736 #define CHECK_CONS(x) \
1737 CHECK_TYPE (CONSP (x), Qconsp, x)
1739 #define CHECK_SYMBOL(x) \
1740 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1742 #define CHECK_CHAR_TABLE(x) \
1743 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1745 #define CHECK_VECTOR(x) \
1746 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1748 #define CHECK_VECTOR_OR_STRING(x) \
1749 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1751 #define CHECK_ARRAY(x, Qxxxp) \
1752 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1754 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1755 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1757 #define CHECK_BUFFER(x) \
1758 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1760 #define CHECK_WINDOW(x) \
1761 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1763 #define CHECK_WINDOW_CONFIGURATION(x) \
1764 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1766 /* This macro rejects windows on the interior of the window tree as
1767 "dead", which is what we want; this is an argument-checking macro, and
1768 the user should never get access to interior windows.
1770 A window of any sort, leaf or interior, is dead if the buffer,
1771 vchild, and hchild members are all nil. */
1773 #define CHECK_LIVE_WINDOW(x) \
1774 CHECK_TYPE (WINDOWP (x) && !NILP (WVAR (XWINDOW (x), buffer)), \
1777 #define CHECK_PROCESS(x) \
1778 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1780 #define CHECK_SUBR(x) \
1781 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1783 #define CHECK_NUMBER(x) \
1784 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1786 #define CHECK_NATNUM(x) \
1787 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1789 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1792 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1793 args_out_of_range_3 \
1795 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1796 ? MOST_NEGATIVE_FIXNUM \
1798 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1800 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1802 if (TYPE_SIGNED (type)) \
1803 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1805 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1808 #define CHECK_MARKER(x) \
1809 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1811 #define CHECK_NUMBER_COERCE_MARKER(x) \
1812 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1813 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1815 #define XFLOATINT(n) extract_float((n))
1817 #define CHECK_FLOAT(x) \
1818 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1820 #define CHECK_NUMBER_OR_FLOAT(x) \
1821 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1823 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1824 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1825 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1827 #define CHECK_OVERLAY(x) \
1828 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1830 /* Since we can't assign directly to the CAR or CDR fields of a cons
1831 cell, use these when checking that those fields contain numbers. */
1832 #define CHECK_NUMBER_CAR(x) \
1834 Lisp_Object tmp = XCAR (x); \
1835 CHECK_NUMBER (tmp); \
1836 XSETCAR ((x), tmp); \
1839 #define CHECK_NUMBER_CDR(x) \
1841 Lisp_Object tmp = XCDR (x); \
1842 CHECK_NUMBER (tmp); \
1843 XSETCDR ((x), tmp); \
1846 #define CHECK_NATNUM_CAR(x) \
1848 Lisp_Object tmp = XCAR (x); \
1849 CHECK_NATNUM (tmp); \
1850 XSETCAR ((x), tmp); \
1853 #define CHECK_NATNUM_CDR(x) \
1855 Lisp_Object tmp = XCDR (x); \
1856 CHECK_NATNUM (tmp); \
1857 XSETCDR ((x), tmp); \
1860 /* Define a built-in function for calling from Lisp.
1861 `lname' should be the name to give the function in Lisp,
1862 as a null-terminated C string.
1863 `fnname' should be the name of the function in C.
1864 By convention, it starts with F.
1865 `sname' should be the name for the C constant structure
1866 that records information on this function for internal use.
1867 By convention, it should be the same as `fnname' but with S instead of F.
1868 It's too bad that C macros can't compute this from `fnname'.
1869 `minargs' should be a number, the minimum number of arguments allowed.
1870 `maxargs' should be a number, the maximum number of arguments allowed,
1871 or else MANY or UNEVALLED.
1872 MANY means pass a vector of evaluated arguments,
1873 in the form of an integer number-of-arguments
1874 followed by the address of a vector of Lisp_Objects
1875 which contains the argument values.
1876 UNEVALLED means pass the list of unevaluated arguments
1877 `intspec' says how interactive arguments are to be fetched.
1878 If the string starts with a `(', `intspec' is evaluated and the resulting
1879 list is the list of arguments.
1880 If it's a string that doesn't start with `(', the value should follow
1881 the one of the doc string for `interactive'.
1882 A null string means call interactively with no arguments.
1883 `doc' is documentation for the user. */
1885 /* This version of DEFUN declares a function prototype with the right
1886 arguments, so we can catch errors with maxargs at compile-time. */
1888 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1889 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1890 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1891 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1892 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1893 { (Lisp_Object (__cdecl *)(void))fnname }, \
1894 minargs, maxargs, lname, intspec, 0}; \
1896 #else /* not _MSC_VER */
1897 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1898 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1899 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1900 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1901 { .a ## maxargs = fnname }, \
1902 minargs, maxargs, lname, intspec, 0}; \
1906 /* Note that the weird token-substitution semantics of ANSI C makes
1907 this work for MANY and UNEVALLED. */
1908 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1909 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1910 #define DEFUN_ARGS_0 (void)
1911 #define DEFUN_ARGS_1 (Lisp_Object)
1912 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1913 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1914 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1915 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1917 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1918 Lisp_Object, Lisp_Object)
1919 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1920 Lisp_Object, Lisp_Object, Lisp_Object)
1921 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1922 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1924 /* Non-zero if OBJ is a Lisp function. */
1925 #define FUNCTIONP(OBJ) \
1926 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1927 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1928 || COMPILEDP (OBJ) \
1932 is how we define the symbol for function `name' at start-up time. */
1933 extern void defsubr (struct Lisp_Subr
*);
1941 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1942 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1943 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1944 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1945 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1947 /* Macros we use to define forwarded Lisp variables.
1948 These are used in the syms_of_FILENAME functions.
1950 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1951 lisp variable is actually a field in `struct emacs_globals'. The
1952 field's name begins with "f_", which is a convention enforced by
1953 these macros. Each such global has a corresponding #define in
1954 globals.h; the plain name should be used in the code.
1956 E.g., the global "cons_cells_consed" is declared as "int
1957 f_cons_cells_consed" in globals.h, but there is a define:
1959 #define cons_cells_consed globals.f_cons_cells_consed
1961 All C code uses the `cons_cells_consed' name. This is all done
1962 this way to support indirection for multi-threaded Emacs. */
1964 #define DEFVAR_LISP(lname, vname, doc) \
1966 static struct Lisp_Objfwd o_fwd; \
1967 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1969 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1971 static struct Lisp_Objfwd o_fwd; \
1972 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1974 #define DEFVAR_BOOL(lname, vname, doc) \
1976 static struct Lisp_Boolfwd b_fwd; \
1977 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1979 #define DEFVAR_INT(lname, vname, doc) \
1981 static struct Lisp_Intfwd i_fwd; \
1982 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1985 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1987 static struct Lisp_Objfwd o_fwd; \
1988 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1991 #define DEFVAR_KBOARD(lname, vname, doc) \
1993 static struct Lisp_Kboard_Objfwd ko_fwd; \
1994 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1999 /* Structure for recording Lisp call stack for backtrace purposes. */
2001 /* The special binding stack holds the outer values of variables while
2002 they are bound by a function application or a let form, stores the
2003 code to be executed for Lisp unwind-protect forms, and stores the C
2004 functions to be called for record_unwind_protect.
2006 If func is non-zero, undoing this binding applies func to old_value;
2007 This implements record_unwind_protect.
2009 Otherwise, the element is a variable binding.
2011 If the symbol field is a symbol, it is an ordinary variable binding.
2013 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2014 which means having bound a local value while CURRENT-BUFFER was active.
2015 If WHERE is nil this means we saw the default value when binding SYMBOL.
2016 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2017 value. Other values of WHERE mean an internal error. */
2019 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2023 Lisp_Object symbol
, old_value
;
2024 specbinding_func func
;
2025 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
2028 extern struct specbinding
*specpdl
;
2029 extern struct specbinding
*specpdl_ptr
;
2030 extern ptrdiff_t specpdl_size
;
2032 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2034 /* Everything needed to describe an active condition case. */
2037 /* The handler clauses and variable from the condition-case form. */
2038 /* For a handler set up in Lisp code, this is always a list.
2039 For an internal handler set up by internal_condition_case*,
2040 this can instead be the symbol t or `error'.
2041 t: handle all conditions.
2042 error: handle all conditions, and errors can run the debugger
2043 or display a backtrace. */
2044 Lisp_Object handler
;
2046 /* Fsignal stores here the condition-case clause that applies,
2047 and Fcondition_case thus knows which clause to run. */
2048 Lisp_Object chosen_clause
;
2050 /* Used to effect the longjump out to the handler. */
2051 struct catchtag
*tag
;
2053 /* The next enclosing handler. */
2054 struct handler
*next
;
2057 /* This structure helps implement the `catch' and `throw' control
2058 structure. A struct catchtag contains all the information needed
2059 to restore the state of the interpreter after a non-local jump.
2061 Handlers for error conditions (represented by `struct handler'
2062 structures) just point to a catch tag to do the cleanup required
2065 catchtag structures are chained together in the C calling stack;
2066 the `next' member points to the next outer catchtag.
2068 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2069 member is TAG, and then unbinds to it. The `val' member is used to
2070 hold VAL while the stack is unwound; `val' is returned as the value
2073 All the other members are concerned with restoring the interpreter
2080 struct catchtag
*next
;
2081 struct gcpro
*gcpro
;
2083 struct backtrace
*backlist
;
2084 struct handler
*handlerlist
;
2085 EMACS_INT lisp_eval_depth
;
2087 int poll_suppress_count
;
2088 int interrupt_input_blocked
;
2089 struct byte_stack
*byte_stack
;
2092 extern Lisp_Object memory_signal_data
;
2094 /* An address near the bottom of the stack.
2095 Tells GC how to save a copy of the stack. */
2096 extern char *stack_bottom
;
2098 /* Check quit-flag and quit if it is non-nil.
2099 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2100 So the program needs to do QUIT at times when it is safe to quit.
2101 Every loop that might run for a long time or might not exit
2102 ought to do QUIT at least once, at a safe place.
2103 Unless that is impossible, of course.
2104 But it is very desirable to avoid creating loops where QUIT is impossible.
2106 Exception: if you set immediate_quit to nonzero,
2107 then the handler that responds to the C-g does the quit itself.
2108 This is a good thing to do around a loop that has no side effects
2109 and (in particular) cannot call arbitrary Lisp code.
2111 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2112 a request to exit Emacs when it is safe to do. */
2115 extern void process_pending_signals (void);
2116 extern int pending_signals
;
2117 #define ELSE_PENDING_SIGNALS \
2118 else if (pending_signals) \
2119 process_pending_signals ();
2120 #else /* not SYNC_INPUT */
2121 #define ELSE_PENDING_SIGNALS
2122 #endif /* not SYNC_INPUT */
2124 extern void process_quit_flag (void);
2127 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2128 process_quit_flag (); \
2129 ELSE_PENDING_SIGNALS \
2133 /* Nonzero if ought to quit now. */
2135 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2137 extern Lisp_Object Vascii_downcase_table
;
2138 extern Lisp_Object Vascii_canon_table
;
2140 /* Structure for recording stack slots that need marking. */
2142 /* This is a chain of structures, each of which points at a Lisp_Object
2143 variable whose value should be marked in garbage collection.
2144 Normally every link of the chain is an automatic variable of a function,
2145 and its `val' points to some argument or local variable of the function.
2146 On exit to the function, the chain is set back to the value it had on entry.
2147 This way, no link remains in the chain when the stack frame containing the
2150 Every function that can call Feval must protect in this fashion all
2151 Lisp_Object variables whose contents will be used again. */
2153 extern struct gcpro
*gcprolist
;
2159 /* Address of first protected variable. */
2160 volatile Lisp_Object
*var
;
2162 /* Number of consecutive protected variables. */
2170 /* Values of GC_MARK_STACK during compilation:
2172 0 Use GCPRO as before
2173 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2174 2 Mark the stack, and check that everything GCPRO'd is
2176 3 Mark using GCPRO's, mark stack last, and count how many
2177 dead objects are kept alive. */
2180 #define GC_USE_GCPROS_AS_BEFORE 0
2181 #define GC_MAKE_GCPROS_NOOPS 1
2182 #define GC_MARK_STACK_CHECK_GCPROS 2
2183 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2185 #ifndef GC_MARK_STACK
2186 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2189 /* Whether we do the stack marking manually. */
2190 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2191 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2194 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2196 /* Do something silly with gcproN vars just so gcc shuts up. */
2197 /* You get warnings from MIPSPro... */
2199 #define GCPRO1(varname) ((void) gcpro1)
2200 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2201 #define GCPRO3(varname1, varname2, varname3) \
2202 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2203 #define GCPRO4(varname1, varname2, varname3, varname4) \
2204 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2205 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2206 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2207 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2208 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2210 #define UNGCPRO ((void) 0)
2212 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2216 #define GCPRO1(varname) \
2217 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2218 gcprolist = &gcpro1; }
2220 #define GCPRO2(varname1, varname2) \
2221 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2222 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2223 gcprolist = &gcpro2; }
2225 #define GCPRO3(varname1, varname2, varname3) \
2226 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2227 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2228 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2229 gcprolist = &gcpro3; }
2231 #define GCPRO4(varname1, varname2, varname3, varname4) \
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 gcprolist = &gcpro4; }
2238 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2239 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2240 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2241 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2242 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2243 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2244 gcprolist = &gcpro5; }
2246 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2247 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2248 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2249 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2250 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2251 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2252 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2253 gcprolist = &gcpro6; }
2255 #define UNGCPRO (gcprolist = gcpro1.next)
2259 extern int gcpro_level
;
2261 #define GCPRO1(varname) \
2262 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2263 gcpro1.level = gcpro_level++; \
2264 gcprolist = &gcpro1; }
2266 #define GCPRO2(varname1, varname2) \
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 gcpro2.level = gcpro_level++; \
2271 gcprolist = &gcpro2; }
2273 #define GCPRO3(varname1, varname2, varname3) \
2274 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2275 gcpro1.level = gcpro_level; \
2276 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2277 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2278 gcpro3.level = gcpro_level++; \
2279 gcprolist = &gcpro3; }
2281 #define GCPRO4(varname1, varname2, varname3, varname4) \
2282 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2283 gcpro1.level = gcpro_level; \
2284 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2285 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2286 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2287 gcpro4.level = gcpro_level++; \
2288 gcprolist = &gcpro4; }
2290 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2291 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2292 gcpro1.level = gcpro_level; \
2293 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2294 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2295 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2296 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2297 gcpro5.level = gcpro_level++; \
2298 gcprolist = &gcpro5; }
2300 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2301 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2302 gcpro1.level = gcpro_level; \
2303 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2304 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2305 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2306 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2307 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2308 gcpro6.level = gcpro_level++; \
2309 gcprolist = &gcpro6; }
2312 ((--gcpro_level != gcpro1.level) \
2314 : ((gcprolist = gcpro1.next), 0))
2316 #endif /* DEBUG_GCPRO */
2317 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2320 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2321 #define RETURN_UNGCPRO(expr) \
2324 Lisp_Object ret_ungc_val; \
2325 ret_ungc_val = (expr); \
2327 return ret_ungc_val; \
2331 /* Call staticpro (&var) to protect static variable `var'. */
2333 void staticpro (Lisp_Object
*);
2335 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2336 meaning as in the DEFUN macro, and is used to construct a prototype. */
2337 /* We can use the same trick as in the DEFUN macro to generate the
2338 appropriate prototype. */
2339 #define EXFUN(fnname, maxargs) \
2340 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2342 /* Forward declarations for prototypes. */
2346 /* Simple access functions. */
2348 LISP_INLINE Lisp_Object
*
2349 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2351 return & XVECTOR (array
)->contents
[idx
];
2355 set_hash_key (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2357 ASET (h
->key_and_value
, 2 * idx
, val
);
2361 set_hash_value (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2363 ASET (h
->key_and_value
, 2 * idx
+ 1, val
);
2367 set_hash_next (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2369 ASET (h
->next
, idx
, val
);
2373 set_hash_hash (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2375 ASET (h
->hash
, idx
, val
);
2379 set_hash_index (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2381 ASET (h
->index
, idx
, val
);
2384 /* Defined in data.c. */
2385 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2386 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2387 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2388 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2389 extern Lisp_Object Qinvalid_read_syntax
;
2390 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2391 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2392 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2393 extern Lisp_Object Qtext_read_only
;
2394 extern Lisp_Object Qinteractive_form
;
2395 extern Lisp_Object Qcircular_list
;
2396 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2397 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2398 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2399 extern Lisp_Object Qbuffer_or_string_p
;
2400 extern Lisp_Object Qfboundp
;
2401 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2403 extern Lisp_Object Qcdr
;
2405 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2406 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2408 extern Lisp_Object Qfloatp
;
2409 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2411 extern Lisp_Object Qinteger
, Qinterval
, Qsymbol
, Qstring
;
2412 extern Lisp_Object Qmisc
, Qvector
, Qfloat
, Qcons
, Qbuffer
;
2414 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2416 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2418 /* Defined in frame.c */
2419 extern Lisp_Object Qframep
;
2421 /* Defined in data.c */
2422 extern Lisp_Object
indirect_function (Lisp_Object
);
2423 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2425 /* Convert the integer I to an Emacs representation, either the integer
2426 itself, or a cons of two or three integers, or if all else fails a float.
2427 I should not have side effects. */
2428 #define INTEGER_TO_CONS(i) \
2429 (! FIXNUM_OVERFLOW_P (i) \
2431 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2432 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2433 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2434 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2435 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2436 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2437 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2438 ? Fcons (make_number ((i) >> 16 >> 24), \
2439 Fcons (make_number ((i) >> 16 & 0xffffff), \
2440 make_number ((i) & 0xffff))) \
2443 /* Convert the Emacs representation CONS back to an integer of type
2444 TYPE, storing the result the variable VAR. Signal an error if CONS
2445 is not a valid representation or is out of range for TYPE. */
2446 #define CONS_TO_INTEGER(cons, type, var) \
2447 (TYPE_SIGNED (type) \
2448 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2449 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2450 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2451 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2453 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2454 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2455 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2457 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2458 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2459 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2460 extern void syms_of_data (void);
2461 extern void init_data (void);
2462 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2464 /* Defined in cmds.c */
2465 extern void syms_of_cmds (void);
2466 extern void keys_of_cmds (void);
2468 /* Defined in coding.c */
2469 extern Lisp_Object Qcharset
;
2470 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2471 ptrdiff_t, int, int, Lisp_Object
);
2472 extern void init_coding (void);
2473 extern void init_coding_once (void);
2474 extern void syms_of_coding (void);
2476 /* Defined in character.c */
2477 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2478 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2479 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2480 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2481 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2482 extern void syms_of_character (void);
2484 /* Defined in charset.c */
2485 extern void init_charset (void);
2486 extern void init_charset_once (void);
2487 extern void syms_of_charset (void);
2488 /* Structure forward declarations. */
2491 /* Defined in composite.c */
2492 extern void syms_of_composite (void);
2494 /* Defined in syntax.c */
2495 extern void init_syntax_once (void);
2496 extern void syms_of_syntax (void);
2498 /* Defined in fns.c */
2499 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2500 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2501 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2502 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2503 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2504 extern void sweep_weak_hash_tables (void);
2505 extern Lisp_Object Qcursor_in_echo_area
;
2506 extern Lisp_Object Qstring_lessp
;
2507 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2508 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2509 EMACS_UINT
sxhash (Lisp_Object
, int);
2510 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2511 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2513 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2514 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2517 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2518 ptrdiff_t, ptrdiff_t);
2519 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2520 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2521 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2522 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2523 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2524 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2525 extern void clear_string_char_byte_cache (void);
2526 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2527 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2528 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2529 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2530 extern void syms_of_fns (void);
2532 /* Defined in floatfns.c */
2533 extern double extract_float (Lisp_Object
);
2534 extern void init_floatfns (void);
2535 extern void syms_of_floatfns (void);
2536 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2538 /* Defined in fringe.c */
2539 extern void syms_of_fringe (void);
2540 extern void init_fringe (void);
2541 #ifdef HAVE_WINDOW_SYSTEM
2542 extern void mark_fringe_data (void);
2543 extern void init_fringe_once (void);
2544 #endif /* HAVE_WINDOW_SYSTEM */
2546 /* Defined in image.c */
2547 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2548 extern Lisp_Object QCconversion
;
2549 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2550 extern void syms_of_image (void);
2552 /* Defined in insdel.c */
2553 extern Lisp_Object Qinhibit_modification_hooks
;
2554 extern void move_gap (ptrdiff_t);
2555 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2556 extern _Noreturn
void buffer_overflow (void);
2557 extern void make_gap (ptrdiff_t);
2558 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2559 ptrdiff_t, int, int);
2560 extern int count_combining_before (const unsigned char *,
2561 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2562 extern int count_combining_after (const unsigned char *,
2563 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2564 extern void insert (const char *, ptrdiff_t);
2565 extern void insert_and_inherit (const char *, ptrdiff_t);
2566 extern void insert_1 (const char *, ptrdiff_t, int, int, int);
2567 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2569 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2570 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2571 ptrdiff_t, ptrdiff_t, int);
2572 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2573 extern void insert_char (int);
2574 extern void insert_string (const char *);
2575 extern void insert_before_markers (const char *, ptrdiff_t);
2576 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2577 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2578 ptrdiff_t, ptrdiff_t,
2580 extern void del_range (ptrdiff_t, ptrdiff_t);
2581 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, int, int);
2582 extern void del_range_byte (ptrdiff_t, ptrdiff_t, int);
2583 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int);
2584 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2585 ptrdiff_t, ptrdiff_t, int);
2586 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2587 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2588 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2589 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2590 ptrdiff_t, ptrdiff_t);
2591 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2592 ptrdiff_t, ptrdiff_t);
2593 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, int, int, int);
2594 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2595 const char *, ptrdiff_t, ptrdiff_t, int);
2596 extern void syms_of_insdel (void);
2598 /* Defined in dispnew.c */
2599 #if (defined PROFILING \
2600 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2601 _Noreturn
void __executable_start (void);
2603 extern Lisp_Object selected_frame
;
2604 extern Lisp_Object Vwindow_system
;
2605 void duration_to_sec_usec (double, int *, int *);
2606 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2607 extern void init_display (void);
2608 extern void syms_of_display (void);
2610 /* Defined in xdisp.c */
2611 extern Lisp_Object Qinhibit_point_motion_hooks
;
2612 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2613 extern Lisp_Object Qmenu_bar_update_hook
;
2614 extern Lisp_Object Qwindow_scroll_functions
;
2615 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2616 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2617 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2618 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2619 extern Lisp_Object Qleft_margin
, Qright_margin
;
2620 extern Lisp_Object Qglyphless_char
;
2621 extern Lisp_Object QCdata
, QCfile
;
2622 extern Lisp_Object QCmap
;
2623 extern Lisp_Object Qrisky_local_variable
;
2624 extern struct frame
*last_glyphless_glyph_frame
;
2625 extern int last_glyphless_glyph_face_id
;
2626 extern int last_glyphless_glyph_merged_face_id
;
2627 extern int noninteractive_need_newline
;
2628 extern Lisp_Object echo_area_buffer
[2];
2629 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2630 extern void check_message_stack (void);
2631 extern void setup_echo_area_for_printing (int);
2632 extern int push_message (void);
2633 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2634 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2635 extern void restore_message (void);
2636 extern Lisp_Object
current_message (void);
2637 extern void clear_message (int, int);
2638 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2639 extern void message1 (const char *);
2640 extern void message1_nolog (const char *);
2641 extern void message2 (const char *, ptrdiff_t, int);
2642 extern void message2_nolog (const char *, ptrdiff_t, int);
2643 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2644 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2645 extern void message_dolog (const char *, ptrdiff_t, int, int);
2646 extern void message_with_string (const char *, Lisp_Object
, int);
2647 extern void message_log_maybe_newline (void);
2648 extern void update_echo_area (void);
2649 extern void truncate_echo_area (ptrdiff_t);
2650 extern void redisplay (void);
2651 extern void redisplay_preserve_echo_area (int);
2652 extern void prepare_menu_bars (void);
2654 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2655 extern void syms_of_xdisp (void);
2656 extern void init_xdisp (void);
2657 extern Lisp_Object
safe_eval (Lisp_Object
);
2658 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2659 int *, int *, int *, int *, int *);
2661 /* Defined in xsettings.c */
2662 extern void syms_of_xsettings (void);
2664 /* Defined in vm-limit.c. */
2665 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2667 /* Defined in alloc.c */
2668 extern void check_pure_size (void);
2669 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2670 extern void reset_malloc_hooks (void);
2671 extern void uninterrupt_malloc (void);
2672 extern void malloc_warning (const char *);
2673 extern _Noreturn
void memory_full (size_t);
2674 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2675 extern int survives_gc_p (Lisp_Object
);
2676 extern void mark_object (Lisp_Object
);
2677 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2678 extern void refill_memory_reserve (void);
2680 extern const char *pending_malloc_warning
;
2681 extern Lisp_Object zero_vector
;
2682 extern Lisp_Object
*stack_base
;
2683 extern EMACS_INT consing_since_gc
;
2684 extern EMACS_INT gc_relative_threshold
;
2685 extern EMACS_INT memory_full_cons_threshold
;
2686 extern Lisp_Object
list1 (Lisp_Object
);
2687 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2688 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2689 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2690 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2692 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2693 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2694 extern _Noreturn
void string_overflow (void);
2695 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2696 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2697 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2698 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2700 /* Make unibyte string from C string when the length isn't known. */
2702 LISP_INLINE Lisp_Object
2703 build_unibyte_string (const char *str
)
2705 return make_unibyte_string (str
, strlen (str
));
2708 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2709 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2710 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2711 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2712 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2713 extern Lisp_Object
make_specified_string (const char *,
2714 ptrdiff_t, ptrdiff_t, int);
2715 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, int);
2716 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2718 /* Make a string allocated in pure space, use STR as string data. */
2720 LISP_INLINE Lisp_Object
2721 build_pure_c_string (const char *str
)
2723 return make_pure_c_string (str
, strlen (str
));
2726 /* Make a string from the data at STR, treating it as multibyte if the
2729 LISP_INLINE Lisp_Object
2730 build_string (const char *str
)
2732 return make_string (str
, strlen (str
));
2735 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2736 extern void make_byte_code (struct Lisp_Vector
*);
2737 extern Lisp_Object Qchar_table_extra_slots
;
2738 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2739 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2740 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2742 allocate_pseudovector \
2743 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2744 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2745 extern struct window
*allocate_window (void);
2746 extern struct frame
*allocate_frame (void);
2747 extern struct Lisp_Process
*allocate_process (void);
2748 extern struct terminal
*allocate_terminal (void);
2749 extern int gc_in_progress
;
2750 extern int abort_on_gc
;
2751 extern Lisp_Object
make_float (double);
2752 extern void display_malloc_warning (void);
2753 extern ptrdiff_t inhibit_garbage_collection (void);
2754 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2755 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2756 extern void free_marker (Lisp_Object
);
2757 extern void free_cons (struct Lisp_Cons
*);
2758 extern void init_alloc_once (void);
2759 extern void init_alloc (void);
2760 extern void syms_of_alloc (void);
2761 extern struct buffer
* allocate_buffer (void);
2762 extern int valid_lisp_object_p (Lisp_Object
);
2763 #ifdef GC_CHECK_CONS_LIST
2764 extern void check_cons_list (void);
2766 #define check_cons_list() ((void) 0)
2770 /* Defined in ralloc.c */
2771 extern void *r_alloc (void **, size_t);
2772 extern void r_alloc_free (void **);
2773 extern void *r_re_alloc (void **, size_t);
2774 extern void r_alloc_reset_variable (void **, void **);
2775 extern void r_alloc_inhibit_buffer_relocation (int);
2778 /* Defined in chartab.c */
2779 extern Lisp_Object
copy_char_table (Lisp_Object
);
2780 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2781 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2783 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2784 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2786 extern int char_table_translate (Lisp_Object
, int);
2787 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2789 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2790 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2791 Lisp_Object
, Lisp_Object
,
2792 Lisp_Object
, struct charset
*,
2793 unsigned, unsigned);
2794 extern Lisp_Object
uniprop_table (Lisp_Object
);
2795 extern void syms_of_chartab (void);
2797 /* Defined in print.c */
2798 extern Lisp_Object Vprin1_to_string_buffer
;
2799 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2800 extern Lisp_Object Qstandard_output
;
2801 extern Lisp_Object Qexternal_debugging_output
;
2802 extern void temp_output_buffer_setup (const char *);
2803 extern int print_level
;
2804 extern Lisp_Object Qprint_escape_newlines
;
2805 extern void write_string (const char *, int);
2806 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2808 extern Lisp_Object internal_with_output_to_temp_buffer
2809 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2810 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
2811 extern int float_to_string (char *, double);
2812 extern void syms_of_print (void);
2814 /* Defined in doprnt.c */
2815 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2817 extern ptrdiff_t esprintf (char *, char const *, ...)
2818 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2819 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2821 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2822 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2823 char const *, va_list)
2824 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2826 /* Defined in lread.c. */
2827 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2828 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2829 extern Lisp_Object
check_obarray (Lisp_Object
);
2830 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
2831 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
2832 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
2833 #define LOADHIST_ATTACH(x) \
2835 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2837 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2838 Lisp_Object
*, Lisp_Object
);
2839 Lisp_Object
string_to_number (char const *, int, int);
2840 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2842 extern void dir_warning (const char *, Lisp_Object
);
2843 extern void close_load_descs (void);
2844 extern void init_obarray (void);
2845 extern void init_lread (void);
2846 extern void syms_of_lread (void);
2848 LISP_INLINE Lisp_Object
2849 intern (const char *str
)
2851 return intern_1 (str
, strlen (str
));
2854 LISP_INLINE Lisp_Object
2855 intern_c_string (const char *str
)
2857 return intern_c_string_1 (str
, strlen (str
));
2860 /* Defined in eval.c. */
2861 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
2862 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2863 extern Lisp_Object Qand_rest
;
2864 extern Lisp_Object Vautoload_queue
;
2865 extern Lisp_Object Vsignaling_function
;
2866 extern Lisp_Object inhibit_lisp_code
;
2867 extern int handling_signal
;
2869 extern struct catchtag
*catchlist
;
2870 extern struct handler
*handlerlist
;
2872 /* To run a normal hook, use the appropriate function from the list below.
2873 The calling convention:
2875 if (!NILP (Vrun_hooks))
2876 call1 (Vrun_hooks, Qmy_funny_hook);
2878 should no longer be used. */
2879 extern Lisp_Object Vrun_hooks
;
2880 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2881 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2882 Lisp_Object (*funcall
)
2883 (ptrdiff_t nargs
, Lisp_Object
*args
));
2884 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
2885 extern _Noreturn
void xsignal0 (Lisp_Object
);
2886 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
2887 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2888 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2890 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
2891 extern Lisp_Object
eval_sub (Lisp_Object form
);
2892 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2893 extern Lisp_Object
call0 (Lisp_Object
);
2894 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2895 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2896 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2897 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2898 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2899 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2900 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2901 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2902 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2903 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2904 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2905 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2906 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2907 extern void specbind (Lisp_Object
, Lisp_Object
);
2908 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2909 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
2910 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2911 extern _Noreturn
void verror (const char *, va_list)
2912 ATTRIBUTE_FORMAT_PRINTF (1, 0);
2913 extern Lisp_Object
un_autoload (Lisp_Object
);
2914 extern void init_eval_once (void);
2915 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
2916 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
2917 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2918 extern void init_eval (void);
2920 extern void mark_backtrace (void);
2922 extern void syms_of_eval (void);
2924 /* Defined in editfns.c. */
2925 extern Lisp_Object Qfield
;
2926 extern void insert1 (Lisp_Object
);
2927 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
2928 extern Lisp_Object
save_excursion_save (void);
2929 extern Lisp_Object
save_restriction_save (void);
2930 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
2931 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
2932 extern _Noreturn
void time_overflow (void);
2933 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, int);
2934 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2936 extern void init_editfns (void);
2937 const char *get_system_name (void);
2938 extern void syms_of_editfns (void);
2939 extern void set_time_zone_rule (const char *);
2941 /* Defined in buffer.c. */
2942 extern int mouse_face_overlay_overlaps (Lisp_Object
);
2943 extern _Noreturn
void nsberror (Lisp_Object
);
2944 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
2945 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
2946 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
2947 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
2948 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2949 extern int overlay_touches_p (ptrdiff_t);
2950 extern Lisp_Object Vbuffer_alist
;
2951 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
2952 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
2953 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
2954 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
2955 extern void init_buffer_once (void);
2956 extern void init_buffer (void);
2957 extern void syms_of_buffer (void);
2958 extern void keys_of_buffer (void);
2960 /* Defined in marker.c. */
2962 extern ptrdiff_t marker_position (Lisp_Object
);
2963 extern ptrdiff_t marker_byte_position (Lisp_Object
);
2964 extern void clear_charpos_cache (struct buffer
*);
2965 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
2966 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
2967 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
2968 extern void unchain_marker (struct Lisp_Marker
*marker
);
2969 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2970 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
2971 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
2972 ptrdiff_t, ptrdiff_t);
2973 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
2974 extern void syms_of_marker (void);
2976 /* Defined in fileio.c */
2978 extern Lisp_Object Qfile_error
;
2979 extern Lisp_Object Qfile_exists_p
;
2980 extern Lisp_Object Qfile_directory_p
;
2981 extern Lisp_Object Qinsert_file_contents
;
2982 extern Lisp_Object Qfile_name_history
;
2983 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
2984 EXFUN (Fread_file_name
, 6); /* not a normal DEFUN */
2985 extern Lisp_Object
close_file_unwind (Lisp_Object
);
2986 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
2987 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
2988 extern int internal_delete_file (Lisp_Object
);
2989 extern void syms_of_fileio (void);
2990 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
2991 extern Lisp_Object Qdelete_file
;
2993 /* Defined in search.c */
2994 extern void shrink_regexp_cache (void);
2995 extern void restore_search_regs (void);
2996 extern void record_unwind_save_match_data (void);
2997 struct re_registers
;
2998 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
2999 struct re_registers
*,
3000 Lisp_Object
, int, int);
3001 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3002 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3004 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3005 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3006 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3007 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3009 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3011 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3012 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3013 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3014 extern void syms_of_search (void);
3015 extern void clear_regexp_cache (void);
3017 /* Defined in minibuf.c. */
3019 extern Lisp_Object Qcompletion_ignore_case
;
3020 extern Lisp_Object Vminibuffer_list
;
3021 extern Lisp_Object last_minibuf_string
;
3022 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3023 extern void init_minibuf_once (void);
3024 extern void syms_of_minibuf (void);
3026 /* Defined in callint.c. */
3028 extern Lisp_Object Qminus
, Qplus
;
3029 extern Lisp_Object Qwhen
;
3030 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3031 extern void syms_of_callint (void);
3033 /* Defined in casefiddle.c. */
3035 extern Lisp_Object Qidentity
;
3036 extern void syms_of_casefiddle (void);
3037 extern void keys_of_casefiddle (void);
3039 /* Defined in casetab.c. */
3041 extern void init_casetab_once (void);
3042 extern void syms_of_casetab (void);
3044 /* Defined in keyboard.c. */
3046 extern Lisp_Object echo_message_buffer
;
3047 extern struct kboard
*echo_kboard
;
3048 extern void cancel_echoing (void);
3049 extern Lisp_Object Qdisabled
, QCfilter
;
3050 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3051 extern Lisp_Object Qtop
;
3052 extern Lisp_Object last_undo_boundary
;
3053 extern int input_pending
;
3054 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3055 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3056 extern void discard_mouse_events (void);
3057 extern Lisp_Object pending_funcalls
;
3058 extern int detect_input_pending (void);
3059 extern int detect_input_pending_ignore_squeezables (void);
3060 extern int detect_input_pending_run_timers (int);
3061 extern void safe_run_hooks (Lisp_Object
);
3062 extern void cmd_error_internal (Lisp_Object
, const char *);
3063 extern Lisp_Object
command_loop_1 (void);
3064 extern Lisp_Object
recursive_edit_1 (void);
3065 extern void record_auto_save (void);
3067 extern void force_auto_save_soon (void);
3069 extern void init_keyboard (void);
3070 extern void syms_of_keyboard (void);
3071 extern void keys_of_keyboard (void);
3073 /* Defined in indent.c. */
3074 extern ptrdiff_t current_column (void);
3075 extern void invalidate_current_column (void);
3076 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3077 extern void syms_of_indent (void);
3079 /* Defined in frame.c. */
3080 extern Lisp_Object Qonly
;
3081 extern Lisp_Object Qvisible
;
3082 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3083 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3084 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3086 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3088 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3089 extern void frames_discard_buffer (Lisp_Object
);
3090 extern void syms_of_frame (void);
3092 /* Defined in emacs.c. */
3093 extern char **initial_argv
;
3094 extern int initial_argc
;
3095 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3096 extern int display_arg
;
3098 extern Lisp_Object
decode_env_path (const char *, const char *);
3099 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3100 extern Lisp_Object Qfile_name_handler_alist
;
3101 #ifdef FLOAT_CATCH_SIGILL
3102 extern void fatal_error_signal (int);
3104 extern Lisp_Object Qkill_emacs
;
3106 void fixup_locale (void);
3107 void synchronize_system_messages_locale (void);
3108 void synchronize_system_time_locale (void);
3110 #define setlocale(category, locale)
3111 #define fixup_locale()
3112 #define synchronize_system_messages_locale()
3113 #define synchronize_system_time_locale()
3115 void shut_down_emacs (int, int, Lisp_Object
);
3116 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3117 extern int noninteractive
;
3119 /* Nonzero means remove site-lisp directories from load-path. */
3120 extern int no_site_lisp
;
3122 /* Pipe used to send exit notification to the daemon parent at
3124 extern int daemon_pipe
[2];
3125 #define IS_DAEMON (daemon_pipe[1] != 0)
3127 /* Nonzero means don't do use window-system-specific display code. */
3128 extern int inhibit_window_system
;
3129 /* Nonzero means that a filter or a sentinel is running. */
3130 extern int running_asynch_code
;
3132 /* Defined in process.c. */
3133 extern Lisp_Object QCtype
, Qlocal
;
3134 extern Lisp_Object Qprocessp
;
3135 extern void kill_buffer_processes (Lisp_Object
);
3136 extern int wait_reading_process_output (intmax_t, int, int, int,
3138 struct Lisp_Process
*,
3140 /* Max value for the first argument of wait_reading_process_output. */
3141 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3142 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3143 The bug merely causes a bogus warning, but the warning is annoying. */
3144 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3146 # define WAIT_READING_MAX INTMAX_MAX
3148 extern void add_keyboard_wait_descriptor (int);
3149 extern void delete_keyboard_wait_descriptor (int);
3151 extern void add_gpm_wait_descriptor (int);
3152 extern void delete_gpm_wait_descriptor (int);
3154 extern void close_process_descs (void);
3155 extern void init_process_emacs (void);
3156 extern void syms_of_process (void);
3157 extern void setup_process_coding_systems (Lisp_Object
);
3162 extern int child_setup (int, int, int, char **, int, Lisp_Object
);
3163 extern void init_callproc_1 (void);
3164 extern void init_callproc (void);
3165 extern void set_initial_environment (void);
3166 extern void syms_of_callproc (void);
3168 /* Defined in doc.c */
3169 extern Lisp_Object Qfunction_documentation
;
3170 extern Lisp_Object
read_doc_string (Lisp_Object
);
3171 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3172 extern void syms_of_doc (void);
3173 extern int read_bytecode_char (int);
3175 /* Defined in bytecode.c */
3176 extern Lisp_Object Qbytecode
;
3177 extern void syms_of_bytecode (void);
3178 extern struct byte_stack
*byte_stack_list
;
3180 extern void mark_byte_stack (void);
3182 extern void unmark_byte_stack (void);
3183 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3184 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3186 /* Defined in macros.c */
3187 extern Lisp_Object Qexecute_kbd_macro
;
3188 extern void init_macros (void);
3189 extern void syms_of_macros (void);
3191 /* Defined in undo.c */
3192 extern Lisp_Object Qapply
;
3193 extern Lisp_Object Qinhibit_read_only
;
3194 extern void truncate_undo_list (struct buffer
*);
3195 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3196 extern void record_insert (ptrdiff_t, ptrdiff_t);
3197 extern void record_delete (ptrdiff_t, Lisp_Object
);
3198 extern void record_first_change (void);
3199 extern void record_change (ptrdiff_t, ptrdiff_t);
3200 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3201 Lisp_Object
, Lisp_Object
,
3203 extern void syms_of_undo (void);
3204 /* Defined in textprop.c */
3205 extern Lisp_Object Qfont
, Qmouse_face
;
3206 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3207 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3208 extern Lisp_Object Qminibuffer_prompt
;
3210 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3212 /* Defined in menu.c */
3213 extern void syms_of_menu (void);
3215 /* Defined in xmenu.c */
3216 extern void syms_of_xmenu (void);
3218 /* Defined in termchar.h */
3219 struct tty_display_info
;
3221 /* Defined in termhooks.h */
3224 /* Defined in sysdep.c */
3225 #ifndef HAVE_GET_CURRENT_DIR_NAME
3226 extern char *get_current_dir_name (void);
3228 extern void stuff_char (char c
);
3229 extern void init_sigio (int);
3230 extern void sys_subshell (void);
3231 extern void sys_suspend (void);
3232 extern void discard_tty_input (void);
3233 extern void init_sys_modes (struct tty_display_info
*);
3234 extern void reset_sys_modes (struct tty_display_info
*);
3235 extern void init_all_sys_modes (void);
3236 extern void reset_all_sys_modes (void);
3237 extern void wait_for_termination (pid_t
);
3238 extern void interruptible_wait_for_termination (pid_t
);
3239 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3240 extern void child_setup_tty (int);
3241 extern void setup_pty (int);
3242 extern int set_window_size (int, int, int);
3243 extern EMACS_INT
get_random (void);
3244 extern void seed_random (long);
3245 extern int emacs_open (const char *, int, int);
3246 extern int emacs_close (int);
3247 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3248 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3249 enum { READLINK_BUFSIZE
= 1024 };
3250 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3252 extern void unlock_all_files (void);
3253 extern void lock_file (Lisp_Object
);
3254 extern void unlock_file (Lisp_Object
);
3255 extern void unlock_buffer (struct buffer
*);
3256 extern void syms_of_filelock (void);
3258 /* Defined in sound.c */
3259 extern void syms_of_sound (void);
3261 /* Defined in category.c */
3262 extern void init_category_once (void);
3263 extern Lisp_Object
char_category_set (int);
3264 extern void syms_of_category (void);
3266 /* Defined in ccl.c */
3267 extern void syms_of_ccl (void);
3269 /* Defined in dired.c */
3270 extern void syms_of_dired (void);
3271 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3272 Lisp_Object
, Lisp_Object
,
3275 /* Defined in term.c */
3276 extern int *char_ins_del_vector
;
3277 extern void mark_ttys (void);
3278 extern void syms_of_term (void);
3279 extern _Noreturn
void fatal (const char *msgid
, ...)
3280 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3282 /* Defined in terminal.c */
3283 extern void syms_of_terminal (void);
3285 /* Defined in font.c */
3286 extern void syms_of_font (void);
3287 extern void init_font (void);
3289 #ifdef HAVE_WINDOW_SYSTEM
3290 /* Defined in fontset.c */
3291 extern void syms_of_fontset (void);
3293 /* Defined in xfns.c, w32fns.c, or macfns.c */
3294 extern Lisp_Object Qfont_param
;
3297 /* Defined in xfaces.c */
3298 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3299 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3300 extern Lisp_Object Qmode_line_inactive
;
3301 extern Lisp_Object Qface
;
3302 extern Lisp_Object Qnormal
;
3303 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3304 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3305 extern Lisp_Object Vface_alternative_font_family_alist
;
3306 extern Lisp_Object Vface_alternative_font_registry_alist
;
3307 extern void syms_of_xfaces (void);
3309 #ifdef HAVE_X_WINDOWS
3310 /* Defined in xfns.c */
3311 extern void syms_of_xfns (void);
3313 /* Defined in xsmfns.c */
3314 extern void syms_of_xsmfns (void);
3316 /* Defined in xselect.c */
3317 extern void syms_of_xselect (void);
3319 /* Defined in xterm.c */
3320 extern void syms_of_xterm (void);
3321 #endif /* HAVE_X_WINDOWS */
3323 #ifdef HAVE_WINDOW_SYSTEM
3324 /* Defined in xterm.c, nsterm.m, w32term.c */
3325 extern char *x_get_keysym_name (int);
3326 #endif /* HAVE_WINDOW_SYSTEM */
3329 /* Defined in xml.c */
3330 extern void syms_of_xml (void);
3331 extern void xml_cleanup_parser (void);
3335 /* Defined in (x|w32)fns.c, nsfns.m... */
3336 extern int have_menus_p (void);
3340 /* Defined in dbusbind.c */
3341 void syms_of_dbusbind (void);
3345 /* Defined in msdos.c, w32.c */
3346 extern char *emacs_root_dir (void);
3349 /* Nonzero means Emacs has already been initialized.
3350 Used during startup to detect startup of dumped Emacs. */
3351 extern int initialized
;
3353 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3355 extern void *xmalloc (size_t);
3356 extern void *xzalloc (size_t);
3357 extern void *xrealloc (void *, size_t);
3358 extern void xfree (void *);
3359 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3360 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3361 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3363 extern char *xstrdup (const char *);
3365 extern char *egetenv (const char *);
3367 /* Set up the name of the machine we're running on. */
3368 extern void init_system_name (void);
3370 static char const DIRECTORY_SEP
= '/';
3372 /* Use this to suppress gcc's warnings. */
3375 /* Use CODE only if lint checking is in effect. */
3376 # define IF_LINT(Code) Code
3378 /* Assume that the expression COND is true. This differs in intent
3379 from 'assert', as it is a message from the programmer to the compiler. */
3380 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3383 # define IF_LINT(Code) /* empty */
3384 # define lint_assume(cond) ((void) (0 && (cond)))
3387 /* We used to use `abs', but that clashes with system headers on some
3388 platforms, and using a name reserved by Standard C is a bad idea
3391 #define eabs(x) ((x) < 0 ? -(x) : (x))
3394 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3397 #define make_fixnum_or_float(val) \
3398 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3401 /* Checks the `cycle check' variable CHECK to see if it indicates that
3402 EL is part of a cycle; CHECK must be either Qnil or a value returned
3403 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3404 elements after which a cycle might be suspected; after that many
3405 elements, this macro begins consing in order to keep more precise
3408 Returns nil if a cycle was detected, otherwise a new value for CHECK
3411 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3412 the caller should make sure that's ok. */
3414 #define CYCLE_CHECK(check, el, suspicious) \
3417 : (INTEGERP (check) \
3418 ? (XFASTINT (check) < (suspicious) \
3419 ? make_number (XFASTINT (check) + 1) \
3420 : Fcons (el, Qnil)) \
3421 : (!NILP (Fmemq ((el), (check))) \
3423 : Fcons ((el), (check)))))
3426 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3427 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3429 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16*1024 };
3431 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3433 #define USE_SAFE_ALLOCA \
3434 ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0
3436 /* SAFE_ALLOCA allocates a simple buffer. */
3438 #define SAFE_ALLOCA(buf, type, size) \
3440 if ((size) < MAX_ALLOCA) \
3441 buf = (type) alloca (size); \
3444 buf = xmalloc (size); \
3446 record_unwind_protect (safe_alloca_unwind, \
3447 make_save_value (buf, 0)); \
3451 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3452 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3453 positive. The code is tuned for MULTIPLIER being a constant. */
3455 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3457 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3458 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3461 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3463 record_unwind_protect (safe_alloca_unwind, \
3464 make_save_value (buf, 0)); \
3468 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3470 #define SAFE_FREE() \
3472 if (sa_must_free) { \
3474 unbind_to (sa_count, Qnil); \
3479 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3481 #define SAFE_ALLOCA_LISP(buf, nelt) \
3483 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3484 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3485 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3488 buf = xmalloc ((nelt) * sizeof (Lisp_Object)); \
3489 arg_ = make_save_value (buf, nelt); \
3490 XSAVE_VALUE (arg_)->dogc = 1; \
3492 record_unwind_protect (safe_alloca_unwind, arg_); \
3495 memory_full (SIZE_MAX); \
3499 #include "globals.h"
3501 /* Check whether it's time for GC, and run it if so. */
3506 if ((consing_since_gc
> gc_cons_threshold
3507 && consing_since_gc
> gc_relative_threshold
)
3508 || (!NILP (Vmemory_full
)
3509 && consing_since_gc
> memory_full_cons_threshold
))
3510 Fgarbage_collect ();
3515 #endif /* EMACS_LISP_H */