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
335 #define ARRAY_MARK_FLAG PTRDIFF_MIN
338 /* In the size word of a struct Lisp_Vector, this bit means it's really
339 some other vector-like object. */
340 static ptrdiff_t const PSEUDOVECTOR_FLAG
341 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
344 /* In a pseudovector, the size field actually contains a word with one
345 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
346 indicate the actual type.
347 We use a bitset, even tho only one of the bits can be set at any
348 particular time just so as to be able to use micro-optimizations such as
349 testing membership of a particular subset of pseudovectors in Fequal.
350 It is not crucial, but there are plenty of bits here, so why not do it? */
353 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
362 PVEC_WINDOW_CONFIGURATION
,
365 /* These last 4 are special because we OR them in fns.c:internal_equal,
366 so they have to use a disjoint bit pattern:
367 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
368 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
369 PVEC_COMPILED
= 0x10,
370 PVEC_CHAR_TABLE
= 0x20,
371 PVEC_SUB_CHAR_TABLE
= 0x30,
375 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
376 which were stored in a Lisp_Object. */
377 #ifndef DATA_SEG_BITS
378 # define DATA_SEG_BITS 0
380 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
385 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
387 /* For convenience, we also store the number of elements in these bits.
388 Note that this size is not necessarily the memory-footprint size, but
389 only the number of Lisp_Object fields (that need to be traced by GC).
390 The distinction is used, e.g., by Lisp_Process, which places extra
391 non-Lisp_Object fields at the end of the structure. */
392 PSEUDOVECTOR_SIZE_BITS
= 16,
393 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
394 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
396 /* Number of bits to put in each character in the internal representation
397 of bool vectors. This should not vary across implementations. */
398 BOOL_VECTOR_BITS_PER_CHAR
= 8
401 /* These macros extract various sorts of values from a Lisp_Object.
402 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
403 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
405 /* Return a perfect hash of the Lisp_Object representation. */
406 #define XHASH(a) XLI (a)
412 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
415 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
416 #define XINT(a) (XLI (a) >> INTTYPEBITS)
417 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
418 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
419 #define XSET(var, type, ptr) \
420 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
421 (var) = XIL ((type) | (intptr_t) (ptr)))
423 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
424 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
426 #else /* not USE_LSB_TAG */
428 static EMACS_INT
const VALMASK
429 #define VALMASK VAL_MAX
432 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
434 /* For integers known to be positive, XFASTINT provides fast retrieval
435 and XSETFASTINT provides fast storage. This takes advantage of the
436 fact that Lisp integers have zero-bits in their tags. */
437 #define XFASTINT(a) (XLI (a) + 0)
438 #define XSETFASTINT(a, b) ((a) = XIL (b))
440 /* Extract the value of a Lisp_Object as a (un)signed integer. */
442 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
443 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
444 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
446 #define XSET(var, type, ptr) \
447 ((var) = XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
448 + ((intptr_t) (ptr) & VALMASK)))
451 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
452 which were stored in a Lisp_Object */
453 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
455 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
458 #endif /* not USE_LSB_TAG */
460 /* For integers known to be positive, XFASTINT sometimes provides
461 faster retrieval and XSETFASTINT provides faster storage.
462 If not, fallback on the non-accelerated path. */
464 # define XFASTINT(a) (XINT (a))
465 # define XSETFASTINT(a, b) (XSETINT (a, b))
468 /* Extract the pointer value of the Lisp object A, under the
469 assumption that A's type is TYPE. This is a fallback
470 implementation if nothing faster is available. */
472 # define XUNTAG(a, type) XPNTR (a)
475 #define EQ(x, y) (XHASH (x) == XHASH (y))
477 /* Largest and smallest representable fixnum values. These are the C
478 values. They are macros for use in static initializers, and
479 constants for visibility to GDB. */
480 static EMACS_INT
const MOST_POSITIVE_FIXNUM
=
481 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
482 MOST_POSITIVE_FIXNUM
;
483 static EMACS_INT
const MOST_NEGATIVE_FIXNUM
=
484 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
485 MOST_NEGATIVE_FIXNUM
;
487 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
488 written this way so that it also works if I is of unsigned
489 type or if I is a NaN. */
491 #define FIXNUM_OVERFLOW_P(i) \
492 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
494 LISP_INLINE
ptrdiff_t
495 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
497 return num
< lower
? lower
: num
<= upper
? num
: upper
;
500 /* Extract a value or address from a Lisp_Object. */
502 #define XCONS(a) (eassert (CONSP (a)), \
503 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
504 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
505 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
506 #define XSTRING(a) (eassert (STRINGP (a)), \
507 (struct Lisp_String *) XUNTAG (a, Lisp_String))
508 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
509 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
510 #define XFLOAT(a) (eassert (FLOATP (a)), \
511 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
515 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
516 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
517 #define XMISCTYPE(a) (XMISCANY (a)->type)
518 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
519 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
520 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
522 /* Forwarding object types. */
524 #define XFWDTYPE(a) (a->u_intfwd.type)
525 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
526 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
527 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
528 #define XBUFFER_OBJFWD(a) \
529 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
530 #define XKBOARD_OBJFWD(a) \
531 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
533 /* Pseudovector types. */
535 #define XPROCESS(a) (eassert (PROCESSP (a)), \
536 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
537 #define XWINDOW(a) (eassert (WINDOWP (a)), \
538 (struct window *) XUNTAG (a, Lisp_Vectorlike))
539 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
540 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
541 #define XSUBR(a) (eassert (SUBRP (a)), \
542 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
543 #define XBUFFER(a) (eassert (BUFFERP (a)), \
544 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
545 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
546 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
547 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
548 ((struct Lisp_Sub_Char_Table *) \
549 XUNTAG (a, Lisp_Vectorlike)))
550 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
551 ((struct Lisp_Bool_Vector *) \
552 XUNTAG (a, Lisp_Vectorlike)))
554 /* Construct a Lisp_Object from a value or address. */
556 #define XSETINT(a, b) (a) = make_number (b)
557 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
558 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
559 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
560 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
561 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
565 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
566 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
568 /* Pseudovector types. */
570 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
571 #define XSETTYPED_PVECTYPE(v, size_member, code) \
572 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
573 #define XSETPVECTYPESIZE(v, code, sizeval) \
574 ((v)->header.size = (PSEUDOVECTOR_FLAG \
575 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
578 /* The cast to struct vectorlike_header * avoids aliasing issues. */
579 #define XSETPSEUDOVECTOR(a, b, code) \
580 XSETTYPED_PSEUDOVECTOR (a, b, \
581 (((struct vectorlike_header *) \
582 XUNTAG (a, Lisp_Vectorlike)) \
585 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
586 (XSETVECTOR (a, b), \
587 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
588 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
590 #define XSETWINDOW_CONFIGURATION(a, b) \
591 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
592 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
593 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
594 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
595 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
596 #define XSETSUBR(a, b) \
597 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
598 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
599 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
600 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
601 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
602 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
604 /* Convenience macros for dealing with Lisp arrays. */
606 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
607 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
608 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
609 #define ASET(ARRAY, IDX, VAL) \
610 (eassert ((IDX) == (IDX)), \
611 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
612 XVECTOR (ARRAY)->contents[IDX] = (VAL))
614 /* Convenience macros for dealing with Lisp strings. */
616 #define SDATA(string) (XSTRING (string)->data + 0)
617 #define SREF(string, index) (SDATA (string)[index] + 0)
618 #define SSET(string, index, new) (SDATA (string)[index] = (new))
619 #define SCHARS(string) (XSTRING (string)->size + 0)
620 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
622 /* Avoid "differ in sign" warnings. */
623 #define SSDATA(x) ((char *) SDATA (x))
625 #define STRING_SET_CHARS(string, newsize) \
626 (XSTRING (string)->size = (newsize))
628 #define STRING_COPYIN(string, index, new, count) \
629 memcpy (SDATA (string) + index, new, count)
633 #define CHECK_TYPE(ok, Qxxxp, x) \
634 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
636 /* Lisp fields are usually hidden from most code and accessed
637 via special macros. Only select pieces of code, like the GC,
638 are allowed to use INTERNAL_FIELD directly. Objects which
639 aren't using this convention should be fixed. */
641 #define INTERNAL_FIELD(field) field ## _
643 /* See the macros in intervals.h. */
645 typedef struct interval
*INTERVAL
;
647 /* Complain if object is not string or buffer type */
648 #define CHECK_STRING_OR_BUFFER(x) \
649 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
651 /* Most code should use this macro to
652 access Lisp fields in struct Lisp_Cons. */
654 #define CVAR(cons, field) ((cons)->INTERNAL_FIELD (field))
658 /* Car of this cons cell. */
659 Lisp_Object
INTERNAL_FIELD (car
);
663 /* Cdr of this cons cell. */
664 Lisp_Object
INTERNAL_FIELD (cdr
);
666 /* Used to chain conses on a free list. */
667 struct Lisp_Cons
*chain
;
671 /* Take the car or cdr of something known to be a cons cell. */
672 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
673 of code that has to know what a cons cell looks like. Other code not
674 part of the basic lisp implementation should assume that the car and cdr
675 fields are not accessible as lvalues. (What if we want to switch to
676 a copying collector someday? Cached cons cell field addresses may be
677 invalidated at arbitrary points.) */
678 #define XCAR_AS_LVALUE(c) (CVAR (XCONS (c), car))
679 #define XCDR_AS_LVALUE(c) (CVAR (XCONS (c), u.cdr))
681 /* Use these from normal code. */
682 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
683 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
685 /* Use these to set the fields of a cons cell.
687 Note that both arguments may refer to the same object, so 'n'
688 should not be read after 'c' is first modified. Also, neither
689 argument should be evaluated more than once; side effects are
690 especially common in the second argument. */
691 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
692 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
694 /* Take the car or cdr of something whose type is not known. */
696 (CONSP ((c)) ? XCAR ((c)) \
697 : NILP ((c)) ? Qnil \
698 : wrong_type_argument (Qlistp, (c)))
701 (CONSP ((c)) ? XCDR ((c)) \
702 : NILP ((c)) ? Qnil \
703 : wrong_type_argument (Qlistp, (c)))
705 /* Take the car or cdr of something whose type is not known. */
706 #define CAR_SAFE(c) \
707 (CONSP ((c)) ? XCAR ((c)) : Qnil)
709 #define CDR_SAFE(c) \
710 (CONSP ((c)) ? XCDR ((c)) : Qnil)
712 /* Nonzero if STR is a multibyte string. */
713 #define STRING_MULTIBYTE(STR) \
714 (XSTRING (STR)->size_byte >= 0)
716 /* Return the length in bytes of STR. */
718 #ifdef GC_CHECK_STRING_BYTES
721 extern ptrdiff_t string_bytes (struct Lisp_String
*);
722 #define STRING_BYTES(S) string_bytes ((S))
724 #else /* not GC_CHECK_STRING_BYTES */
726 #define STRING_BYTES(STR) \
727 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
729 #endif /* not GC_CHECK_STRING_BYTES */
731 /* An upper bound on the number of bytes in a Lisp string, not
732 counting the terminating null. This a tight enough bound to
733 prevent integer overflow errors that would otherwise occur during
734 string size calculations. A string cannot contain more bytes than
735 a fixnum can represent, nor can it be so long that C pointer
736 arithmetic stops working on the string plus its terminating null.
737 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
738 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
739 would expose alloc.c internal details that we'd rather keep
742 This is a macro for use in static initializers, and a constant for
743 visibility to GDB. The cast to ptrdiff_t ensures that
744 the macro is signed. */
745 static ptrdiff_t const STRING_BYTES_BOUND
=
746 #define STRING_BYTES_BOUND \
747 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
750 /* Mark STR as a unibyte string. */
751 #define STRING_SET_UNIBYTE(STR) \
752 do { if (EQ (STR, empty_multibyte_string)) \
753 (STR) = empty_unibyte_string; \
754 else XSTRING (STR)->size_byte = -1; } while (0)
756 /* Mark STR as a multibyte string. Assure that STR contains only
757 ASCII characters in advance. */
758 #define STRING_SET_MULTIBYTE(STR) \
759 do { if (EQ (STR, empty_unibyte_string)) \
760 (STR) = empty_multibyte_string; \
761 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
763 /* Get text properties. */
764 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
766 /* Set text properties. */
767 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
769 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
775 INTERVAL intervals
; /* Text properties in this string. */
779 /* Header of vector-like objects. This documents the layout constraints on
780 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
781 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
782 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
783 because when two such pointers potentially alias, a compiler won't
784 incorrectly reorder loads and stores to their size fields. See
785 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
786 struct vectorlike_header
788 /* This field contains various pieces of information:
789 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
790 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
791 vector (0) or a pseudovector (1).
792 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
793 of slots) of the vector.
794 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
795 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
796 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
797 Lisp_Object slots at the beginning of the object that need to be
798 traced by the GC, tho some types use it slightly differently.
799 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
800 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
804 /* When the vector is allocated from a vector block, NBYTES is used
805 if the vector is not on a free list, and VECTOR is used otherwise.
806 For large vector-like objects, BUFFER or VECTOR is used as a pointer
807 to the next vector-like object. It is generally a buffer or a
808 Lisp_Vector alias, so for convenience it is a union instead of a
809 pointer: this way, one can write P->next.vector instead of ((struct
810 Lisp_Vector *) P->next). */
812 /* This is only needed for small vectors that are not free because the
813 `size' field only gives us the number of Lisp_Object slots, whereas we
814 need to know the total size, including non-Lisp_Object data.
815 FIXME: figure out a way to store this info elsewhere so we can
816 finally get rid of this extra word of overhead. */
818 struct buffer
*buffer
;
819 /* FIXME: This can be removed: For large vectors, this field could be
820 placed *before* the vector itself. And for small vectors on a free
821 list, this field could be stored in the vector's bytes, since the
822 empty vector is handled specially anyway. */
823 struct Lisp_Vector
*vector
;
827 /* Regular vector is just a header plus array of Lisp_Objects. */
831 struct vectorlike_header header
;
832 Lisp_Object contents
[1];
835 /* A boolvector is a kind of vectorlike, with contents are like a string. */
837 struct Lisp_Bool_Vector
839 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
840 just the subtype information. */
841 struct vectorlike_header header
;
842 /* This is the size in bits. */
844 /* This contains the actual bits, packed into bytes. */
845 unsigned char data
[1];
848 /* Some handy constants for calculating sizes
849 and offsets, mostly of vectorlike objects. */
853 header_size
= offsetof (struct Lisp_Vector
, contents
),
854 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
855 word_size
= sizeof (Lisp_Object
)
858 /* If a struct is made to look like a vector, this macro returns the length
859 of the shortest vector that would hold that struct. */
861 #define VECSIZE(type) \
862 ((sizeof (type) - header_size + word_size - 1) / word_size)
864 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
865 at the end and we need to compute the number of Lisp_Object fields (the
866 ones that the GC needs to trace). */
868 #define PSEUDOVECSIZE(type, nonlispfield) \
869 ((offsetof (type, nonlispfield) - header_size) / word_size)
871 /* A char-table is a kind of vectorlike, with contents are like a
872 vector but with a few other slots. For some purposes, it makes
873 sense to handle a char-table with type struct Lisp_Vector. An
874 element of a char table can be any Lisp objects, but if it is a sub
875 char-table, we treat it a table that contains information of a
876 specific range of characters. A sub char-table has the same
877 structure as a vector. A sub char table appears only in an element
878 of a char-table, and there's no way to access it directly from
879 Emacs Lisp program. */
883 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
884 ({struct Lisp_Char_Table *_tbl = NULL; \
887 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
888 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
889 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
891 _val = _tbl->defalt; \
892 } while (NILP (_val) && ! NILP (_tbl->parent)); \
895 #else /* not __GNUC__ */
897 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
898 (! NILP (XCHAR_TABLE (CT)->ascii) \
899 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
900 ? XCHAR_TABLE (CT)->ascii \
901 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
902 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
903 : char_table_ref ((CT), (IDX))) \
904 : char_table_ref ((CT), (IDX)))
906 #endif /* not __GNUC__ */
908 /* Compute A OP B, using the unsigned comparison operator OP. A and B
909 should be integer expressions. This is not the same as
910 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
911 returns 1. For efficiency, prefer plain unsigned comparison if A
912 and B's sizes both fit (after integer promotion). */
913 #define UNSIGNED_CMP(a, op, b) \
914 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
915 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
916 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
918 /* Nonzero iff C is an ASCII character. */
919 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
921 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
922 characters. Do not check validity of CT. */
923 #define CHAR_TABLE_REF(CT, IDX) \
924 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
925 : char_table_ref ((CT), (IDX)))
927 /* Almost equivalent to Faref (CT, IDX). However, if the result is
928 not a character, return IDX.
930 For these characters, do not check validity of CT
931 and do not follow parent. */
932 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
933 char_table_translate (CT, IDX)
935 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
936 8-bit European characters. Do not check validity of CT. */
937 #define CHAR_TABLE_SET(CT, IDX, VAL) \
938 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
939 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
940 : char_table_set (CT, IDX, VAL))
942 enum CHARTAB_SIZE_BITS
944 CHARTAB_SIZE_BITS_0
= 6,
945 CHARTAB_SIZE_BITS_1
= 4,
946 CHARTAB_SIZE_BITS_2
= 5,
947 CHARTAB_SIZE_BITS_3
= 7
950 extern const int chartab_size
[4];
952 struct Lisp_Sub_Char_Table
;
954 struct Lisp_Char_Table
956 /* HEADER.SIZE is the vector's size field, which also holds the
957 pseudovector type information. It holds the size, too.
958 The size counts the defalt, parent, purpose, ascii,
959 contents, and extras slots. */
960 struct vectorlike_header header
;
962 /* This holds a default value,
963 which is used whenever the value for a specific character is nil. */
966 /* This points to another char table, which we inherit from when the
967 value for a specific character is nil. The `defalt' slot takes
968 precedence over this. */
971 /* This is a symbol which says what kind of use this char-table is
975 /* The bottom sub char-table for characters of the range 0..127. It
976 is nil if none of ASCII character has a specific value. */
979 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
981 /* These hold additional data. It is a vector. */
982 Lisp_Object extras
[1];
985 struct Lisp_Sub_Char_Table
987 /* HEADER.SIZE is the vector's size field, which also holds the
988 pseudovector type information. It holds the size, too. */
989 struct vectorlike_header header
;
991 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
992 char-table of depth 1 contains 16 elements, and each element
993 covers 4096 (128*32) characters. A sub char-table of depth 2
994 contains 32 elements, and each element covers 128 characters. A
995 sub char-table of depth 3 contains 128 elements, and each element
996 is for one character. */
999 /* Minimum character covered by the sub char-table. */
1000 Lisp_Object min_char
;
1002 Lisp_Object contents
[1];
1005 /* This structure describes a built-in function.
1006 It is generated by the DEFUN macro only.
1007 defsubr makes it into a Lisp object.
1009 This type is treated in most respects as a pseudovector,
1010 but since we never dynamically allocate or free them,
1011 we don't need a struct vectorlike_header and its 'next' field. */
1017 Lisp_Object (*a0
) (void);
1018 Lisp_Object (*a1
) (Lisp_Object
);
1019 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1020 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1021 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1022 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1023 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1024 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1025 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1026 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1027 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1029 short min_args
, max_args
;
1030 const char *symbol_name
;
1031 const char *intspec
;
1035 /* This is the number of slots that every char table must have. This
1036 counts the ordinary slots and the top, defalt, parent, and purpose
1038 enum CHAR_TABLE_STANDARD_SLOTS
1040 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1043 /* Return the number of "extra" slots in the char table CT. */
1045 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1046 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1049 /***********************************************************************
1051 ***********************************************************************/
1053 /* Interned state of a symbol. */
1055 enum symbol_interned
1057 SYMBOL_UNINTERNED
= 0,
1058 SYMBOL_INTERNED
= 1,
1059 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1062 enum symbol_redirect
1064 SYMBOL_PLAINVAL
= 4,
1065 SYMBOL_VARALIAS
= 1,
1066 SYMBOL_LOCALIZED
= 2,
1067 SYMBOL_FORWARDED
= 3
1070 /* Most code should use this macro to access
1071 Lisp fields in struct Lisp_Symbol. */
1073 #define SVAR(sym, field) ((sym)->INTERNAL_FIELD (field))
1077 unsigned gcmarkbit
: 1;
1079 /* Indicates where the value can be found:
1080 0 : it's a plain var, the value is in the `value' field.
1081 1 : it's a varalias, the value is really in the `alias' symbol.
1082 2 : it's a localized var, the value is in the `blv' object.
1083 3 : it's a forwarding variable, the value is in `forward'. */
1084 ENUM_BF (symbol_redirect
) redirect
: 3;
1086 /* Non-zero means symbol is constant, i.e. changing its value
1087 should signal an error. If the value is 3, then the var
1088 can be changed, but only by `defconst'. */
1089 unsigned constant
: 2;
1091 /* Interned state of the symbol. This is an enumerator from
1092 enum symbol_interned. */
1093 unsigned interned
: 2;
1095 /* Non-zero means that this variable has been explicitly declared
1096 special (with `defvar' etc), and shouldn't be lexically bound. */
1097 unsigned declared_special
: 1;
1099 /* The symbol's name, as a Lisp string.
1100 The name "xname" is used to intentionally break code referring to
1101 the old field "name" of type pointer to struct Lisp_String. */
1102 Lisp_Object
INTERNAL_FIELD (xname
);
1104 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1105 union is used depends on the `redirect' field above. */
1107 Lisp_Object
INTERNAL_FIELD (value
);
1108 struct Lisp_Symbol
*alias
;
1109 struct Lisp_Buffer_Local_Value
*blv
;
1110 union Lisp_Fwd
*fwd
;
1113 /* Function value of the symbol or Qunbound if not fboundp. */
1114 Lisp_Object
INTERNAL_FIELD (function
);
1116 /* The symbol's property list. */
1117 Lisp_Object
INTERNAL_FIELD (plist
);
1119 /* Next symbol in obarray bucket, if the symbol is interned. */
1120 struct Lisp_Symbol
*next
;
1123 /* Value is name of symbol. */
1125 #define SYMBOL_VAL(sym) \
1126 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), SVAR (sym, val.value))
1127 #define SYMBOL_ALIAS(sym) \
1128 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1129 #define SYMBOL_BLV(sym) \
1130 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1131 #define SYMBOL_FWD(sym) \
1132 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1133 #define SET_SYMBOL_VAL(sym, v) \
1134 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), SVAR (sym, val.value) = (v))
1135 #define SET_SYMBOL_ALIAS(sym, v) \
1136 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1137 #define SET_SYMBOL_BLV(sym, v) \
1138 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1139 #define SET_SYMBOL_FWD(sym, v) \
1140 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1142 #define SYMBOL_NAME(sym) \
1143 LISP_MAKE_RVALUE (SVAR (XSYMBOL (sym), xname))
1145 /* Value is non-zero if SYM is an interned symbol. */
1147 #define SYMBOL_INTERNED_P(sym) \
1148 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1150 /* Value is non-zero if SYM is interned in initial_obarray. */
1152 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1153 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1155 /* Value is non-zero if symbol is considered a constant, i.e. its
1156 value cannot be changed (there is an exception for keyword symbols,
1157 whose value can be set to the keyword symbol itself). */
1159 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1161 #define DEFSYM(sym, name) \
1162 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1165 /***********************************************************************
1167 ***********************************************************************/
1169 /* The structure of a Lisp hash table. */
1171 struct Lisp_Hash_Table
1173 /* This is for Lisp; the hash table code does not refer to it. */
1174 struct vectorlike_header header
;
1176 /* Function used to compare keys. */
1179 /* Nil if table is non-weak. Otherwise a symbol describing the
1180 weakness of the table. */
1183 /* When the table is resized, and this is an integer, compute the
1184 new size by adding this to the old size. If a float, compute the
1185 new size by multiplying the old size with this factor. */
1186 Lisp_Object rehash_size
;
1188 /* Resize hash table when number of entries/ table size is >= this
1190 Lisp_Object rehash_threshold
;
1192 /* Vector of hash codes.. If hash[I] is nil, this means that that
1193 entry I is unused. */
1196 /* Vector used to chain entries. If entry I is free, next[I] is the
1197 entry number of the next free item. If entry I is non-free,
1198 next[I] is the index of the next entry in the collision chain. */
1201 /* Index of first free entry in free list. */
1202 Lisp_Object next_free
;
1204 /* Bucket vector. A non-nil entry is the index of the first item in
1205 a collision chain. This vector's size can be larger than the
1206 hash table size to reduce collisions. */
1209 /* User-supplied hash function, or nil. */
1210 Lisp_Object user_hash_function
;
1212 /* User-supplied key comparison function, or nil. */
1213 Lisp_Object user_cmp_function
;
1215 /* Only the fields above are traced normally by the GC. The ones below
1216 `count' are special and are either ignored by the GC or traced in
1217 a special way (e.g. because of weakness). */
1219 /* Number of key/value entries in the table. */
1222 /* Vector of keys and values. The key of item I is found at index
1223 2 * I, the value is found at index 2 * I + 1.
1224 This is gc_marked specially if the table is weak. */
1225 Lisp_Object key_and_value
;
1227 /* Next weak hash table if this is a weak hash table. The head
1228 of the list is in weak_hash_tables. */
1229 struct Lisp_Hash_Table
*next_weak
;
1231 /* C function to compare two keys. */
1232 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1233 Lisp_Object
, EMACS_UINT
,
1234 Lisp_Object
, EMACS_UINT
);
1236 /* C function to compute hash code. */
1237 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1241 #define XHASH_TABLE(OBJ) \
1242 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1244 #define XSET_HASH_TABLE(VAR, PTR) \
1245 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1247 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1249 #define CHECK_HASH_TABLE(x) \
1250 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1252 /* Value is the key part of entry IDX in hash table H. */
1254 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1256 /* Value is the value part of entry IDX in hash table H. */
1258 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1260 /* Value is the index of the next entry following the one at IDX
1263 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1265 /* Value is the hash code computed for entry IDX in hash table H. */
1267 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1269 /* Value is the index of the element in hash table H that is the
1270 start of the collision list at index IDX in the index vector of H. */
1272 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1274 /* Value is the size of hash table H. */
1276 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1278 /* Default size for hash tables if not specified. */
1280 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1282 /* Default threshold specifying when to resize a hash table. The
1283 value gives the ratio of current entries in the hash table and the
1284 size of the hash table. */
1286 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1288 /* Default factor by which to increase the size of a hash table. */
1290 static double const DEFAULT_REHASH_SIZE
= 1.5;
1292 /* Most code should use this macro to access
1293 Lisp fields in a different misc objects. */
1295 #define MVAR(misc, field) ((misc)->INTERNAL_FIELD (field))
1297 /* These structures are used for various misc types. */
1299 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1301 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1302 unsigned gcmarkbit
: 1;
1308 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1309 unsigned gcmarkbit
: 1;
1311 /* This flag is temporarily used in the functions
1312 decode/encode_coding_object to record that the marker position
1313 must be adjusted after the conversion. */
1314 unsigned int need_adjustment
: 1;
1315 /* 1 means normal insertion at the marker's position
1316 leaves the marker after the inserted text. */
1317 unsigned int insertion_type
: 1;
1318 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1319 Note: a chain of markers can contain markers pointing into different
1320 buffers (the chain is per buffer_text rather than per buffer, so it's
1321 shared between indirect buffers). */
1322 /* This is used for (other than NULL-checking):
1324 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1325 - unchain_marker: to find the list from which to unchain.
1326 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1328 struct buffer
*buffer
;
1330 /* The remaining fields are meaningless in a marker that
1331 does not point anywhere. */
1333 /* For markers that point somewhere,
1334 this is used to chain of all the markers in a given buffer. */
1335 /* We could remove it and use an array in buffer_text instead.
1336 That would also allow to preserve it ordered. */
1337 struct Lisp_Marker
*next
;
1338 /* This is the char position where the marker points. */
1340 /* This is the byte position.
1341 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1342 used to implement the functionality of markers, but rather to (ab)use
1343 markers as a cache for char<->byte mappings). */
1347 /* START and END are markers in the overlay's buffer, and
1348 PLIST is the overlay's property list. */
1350 /* An overlay's real data content is:
1352 - buffer (really there are two buffer pointers, one per marker,
1353 and both points to the same buffer)
1354 - insertion type of both ends (per-marker fields)
1355 - start & start byte (of start marker)
1356 - end & end byte (of end marker)
1357 - next (singly linked list of overlays)
1358 - next fields of start and end markers (singly linked list of markers).
1359 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1362 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1363 unsigned gcmarkbit
: 1;
1365 struct Lisp_Overlay
*next
;
1366 Lisp_Object
INTERNAL_FIELD (start
);
1367 Lisp_Object
INTERNAL_FIELD (end
);
1368 Lisp_Object
INTERNAL_FIELD (plist
);
1371 /* Hold a C pointer for later use.
1372 This type of object is used in the arg to record_unwind_protect. */
1373 struct Lisp_Save_Value
1375 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1376 unsigned gcmarkbit
: 1;
1378 /* If DOGC is set, POINTER is the address of a memory
1379 area containing INTEGER potential Lisp_Objects. */
1380 unsigned int dogc
: 1;
1386 /* A miscellaneous object, when it's on the free list. */
1389 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1390 unsigned gcmarkbit
: 1;
1392 union Lisp_Misc
*chain
;
1395 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1396 It uses one of these struct subtypes to get the type field. */
1400 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1401 struct Lisp_Free u_free
;
1402 struct Lisp_Marker u_marker
;
1403 struct Lisp_Overlay u_overlay
;
1404 struct Lisp_Save_Value u_save_value
;
1407 /* Forwarding pointer to an int variable.
1408 This is allowed only in the value cell of a symbol,
1409 and it means that the symbol's value really lives in the
1410 specified int variable. */
1413 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1417 /* Boolean forwarding pointer to an int variable.
1418 This is like Lisp_Intfwd except that the ostensible
1419 "value" of the symbol is t if the int variable is nonzero,
1420 nil if it is zero. */
1423 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1427 /* Forwarding pointer to a Lisp_Object variable.
1428 This is allowed only in the value cell of a symbol,
1429 and it means that the symbol's value really lives in the
1430 specified variable. */
1433 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1434 Lisp_Object
*objvar
;
1437 /* Like Lisp_Objfwd except that value lives in a slot in the
1438 current buffer. Value is byte index of slot within buffer. */
1439 struct Lisp_Buffer_Objfwd
1441 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1443 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1446 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1447 the symbol has buffer-local or frame-local bindings. (Exception:
1448 some buffer-local variables are built-in, with their values stored
1449 in the buffer structure itself. They are handled differently,
1450 using struct Lisp_Buffer_Objfwd.)
1452 The `realvalue' slot holds the variable's current value, or a
1453 forwarding pointer to where that value is kept. This value is the
1454 one that corresponds to the loaded binding. To read or set the
1455 variable, you must first make sure the right binding is loaded;
1456 then you can access the value in (or through) `realvalue'.
1458 `buffer' and `frame' are the buffer and frame for which the loaded
1459 binding was found. If those have changed, to make sure the right
1460 binding is loaded it is necessary to find which binding goes with
1461 the current buffer and selected frame, then load it. To load it,
1462 first unload the previous binding, then copy the value of the new
1463 binding into `realvalue' (or through it). Also update
1464 LOADED-BINDING to point to the newly loaded binding.
1466 `local_if_set' indicates that merely setting the variable creates a
1467 local binding for the current buffer. Otherwise the latter, setting
1468 the variable does not do that; only make-local-variable does that. */
1470 struct Lisp_Buffer_Local_Value
1472 /* 1 means that merely setting the variable creates a local
1473 binding for the current buffer. */
1474 unsigned int local_if_set
: 1;
1475 /* 1 means this variable can have frame-local bindings, otherwise, it is
1476 can have buffer-local bindings. The two cannot be combined. */
1477 unsigned int frame_local
: 1;
1478 /* 1 means that the binding now loaded was found.
1479 Presumably equivalent to (defcell!=valcell). */
1480 unsigned int found
: 1;
1481 /* If non-NULL, a forwarding to the C var where it should also be set. */
1482 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1483 /* The buffer or frame for which the loaded binding was found. */
1485 /* A cons cell that holds the default value. It has the form
1486 (SYMBOL . DEFAULT-VALUE). */
1487 Lisp_Object defcell
;
1488 /* The cons cell from `where's parameter alist.
1489 It always has the form (SYMBOL . VALUE)
1490 Note that if `forward' is non-nil, VALUE may be out of date.
1491 Also if the currently loaded binding is the default binding, then
1492 this is `eq'ual to defcell. */
1493 Lisp_Object valcell
;
1496 #define BLV_FOUND(blv) \
1497 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1498 #define SET_BLV_FOUND(blv, v) \
1499 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1501 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1502 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1504 /* Like Lisp_Objfwd except that value lives in a slot in the
1506 struct Lisp_Kboard_Objfwd
1508 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1514 struct Lisp_Intfwd u_intfwd
;
1515 struct Lisp_Boolfwd u_boolfwd
;
1516 struct Lisp_Objfwd u_objfwd
;
1517 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1518 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1521 /* Lisp floating point type. */
1527 struct Lisp_Float
*chain
;
1531 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1532 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1534 /* A character, declared with the following typedef, is a member
1535 of some character set associated with the current buffer. */
1536 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1538 typedef unsigned char UCHAR
;
1541 /* Meanings of slots in a Lisp_Compiled: */
1545 COMPILED_ARGLIST
= 0,
1546 COMPILED_BYTECODE
= 1,
1547 COMPILED_CONSTANTS
= 2,
1548 COMPILED_STACK_DEPTH
= 3,
1549 COMPILED_DOC_STRING
= 4,
1550 COMPILED_INTERACTIVE
= 5
1553 /* Flag bits in a character. These also get used in termhooks.h.
1554 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1555 (MUlti-Lingual Emacs) might need 22 bits for the character value
1556 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1559 CHAR_ALT
= 0x0400000,
1560 CHAR_SUPER
= 0x0800000,
1561 CHAR_HYPER
= 0x1000000,
1562 CHAR_SHIFT
= 0x2000000,
1563 CHAR_CTL
= 0x4000000,
1564 CHAR_META
= 0x8000000,
1566 CHAR_MODIFIER_MASK
=
1567 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1569 /* Actually, the current Emacs uses 22 bits for the character value
1577 /* The glyph datatype, used to represent characters on the display.
1578 It consists of a char code and a face id. */
1585 /* Return a glyph's character code. */
1586 #define GLYPH_CHAR(glyph) ((glyph).ch)
1588 /* Return a glyph's face ID. */
1589 #define GLYPH_FACE(glyph) ((glyph).face_id)
1591 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1592 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1593 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1595 /* Return 1 if GLYPH contains valid character code. */
1596 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1599 /* Glyph Code from a display vector may either be an integer which
1600 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1601 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1603 #define GLYPH_CODE_P(gc) \
1605 ? (CHARACTERP (XCAR (gc)) \
1606 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1607 : (RANGED_INTEGERP \
1609 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1610 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1611 : TYPE_MAXIMUM (EMACS_INT)))))
1613 /* The following are valid only if GLYPH_CODE_P (gc). */
1615 #define GLYPH_CODE_CHAR(gc) \
1616 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1618 #define GLYPH_CODE_FACE(gc) \
1619 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1621 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1625 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1627 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1628 (XINT (gc) >> CHARACTERBITS)); \
1632 /* Structure to hold mouse highlight data. This is here because other
1633 header files need it for defining struct x_output etc. */
1635 /* These variables describe the range of text currently shown in its
1636 mouse-face, together with the window they apply to. As long as
1637 the mouse stays within this range, we need not redraw anything on
1638 its account. Rows and columns are glyph matrix positions in
1639 MOUSE_FACE_WINDOW. */
1640 int mouse_face_beg_row
, mouse_face_beg_col
;
1641 int mouse_face_beg_x
, mouse_face_beg_y
;
1642 int mouse_face_end_row
, mouse_face_end_col
;
1643 int mouse_face_end_x
, mouse_face_end_y
;
1644 int mouse_face_past_end
;
1645 Lisp_Object mouse_face_window
;
1646 int mouse_face_face_id
;
1647 Lisp_Object mouse_face_overlay
;
1649 /* 1 if a mouse motion event came and we didn't handle it right away because
1650 gc was in progress. */
1651 int mouse_face_deferred_gc
;
1653 /* FRAME and X, Y position of mouse when last checked for
1654 highlighting. X and Y can be negative or out of range for the frame. */
1655 struct frame
*mouse_face_mouse_frame
;
1656 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1658 /* Nonzero means defer mouse-motion highlighting. */
1659 int mouse_face_defer
;
1661 /* Nonzero means that the mouse highlight should not be shown. */
1662 int mouse_face_hidden
;
1664 int mouse_face_image_state
;
1667 /* Data type checking */
1669 #define NILP(x) EQ (x, Qnil)
1671 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1672 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1674 #define RANGED_INTEGERP(lo, x, hi) \
1675 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1676 #define TYPE_RANGED_INTEGERP(type, x) \
1677 (TYPE_SIGNED (type) \
1678 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1679 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1681 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1682 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1683 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1684 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1685 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1686 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1688 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1689 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1690 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1691 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1692 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1694 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1695 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1696 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1697 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1698 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1700 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1701 vectorlike_header * avoids aliasing issues. */
1702 #define PSEUDOVECTORP(x, code) \
1703 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1705 #define PSEUDOVECTOR_TYPEP(v, code) \
1706 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1707 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1709 /* True if object X, with internal type struct T *, is a pseudovector whose
1711 #define TYPED_PSEUDOVECTORP(x, t, code) \
1713 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1715 /* Test for specific pseudovector types. */
1716 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1717 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1718 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1719 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1720 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1721 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1722 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1723 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1724 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1725 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1726 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1727 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1729 /* Test for image (image . spec) */
1730 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1735 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1737 #define CHECK_LIST(x) \
1738 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1740 #define CHECK_LIST_CONS(x, y) \
1741 CHECK_TYPE (CONSP (x), Qlistp, y)
1743 #define CHECK_LIST_END(x, y) \
1744 CHECK_TYPE (NILP (x), Qlistp, y)
1746 #define CHECK_STRING(x) \
1747 CHECK_TYPE (STRINGP (x), Qstringp, x)
1749 #define CHECK_STRING_CAR(x) \
1750 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1752 #define CHECK_CONS(x) \
1753 CHECK_TYPE (CONSP (x), Qconsp, x)
1755 #define CHECK_SYMBOL(x) \
1756 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1758 #define CHECK_CHAR_TABLE(x) \
1759 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1761 #define CHECK_VECTOR(x) \
1762 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1764 #define CHECK_VECTOR_OR_STRING(x) \
1765 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1767 #define CHECK_ARRAY(x, Qxxxp) \
1768 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1770 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1771 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1773 #define CHECK_BUFFER(x) \
1774 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1776 #define CHECK_WINDOW(x) \
1777 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1779 #define CHECK_WINDOW_CONFIGURATION(x) \
1780 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1782 /* This macro rejects windows on the interior of the window tree as
1783 "dead", which is what we want; this is an argument-checking macro, and
1784 the user should never get access to interior windows.
1786 A window of any sort, leaf or interior, is dead if the buffer,
1787 vchild, and hchild members are all nil. */
1789 #define CHECK_LIVE_WINDOW(x) \
1790 CHECK_TYPE (WINDOWP (x) && !NILP (WGET (XWINDOW (x), buffer)), \
1793 #define CHECK_PROCESS(x) \
1794 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1796 #define CHECK_SUBR(x) \
1797 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1799 #define CHECK_NUMBER(x) \
1800 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1802 #define CHECK_NATNUM(x) \
1803 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1805 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1808 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1809 args_out_of_range_3 \
1811 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1812 ? MOST_NEGATIVE_FIXNUM \
1814 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1816 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1818 if (TYPE_SIGNED (type)) \
1819 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1821 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1824 #define CHECK_MARKER(x) \
1825 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1827 #define CHECK_NUMBER_COERCE_MARKER(x) \
1828 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1829 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1831 #define XFLOATINT(n) extract_float((n))
1833 #define CHECK_FLOAT(x) \
1834 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1836 #define CHECK_NUMBER_OR_FLOAT(x) \
1837 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1839 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1840 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1841 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1843 #define CHECK_OVERLAY(x) \
1844 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1846 /* Since we can't assign directly to the CAR or CDR fields of a cons
1847 cell, use these when checking that those fields contain numbers. */
1848 #define CHECK_NUMBER_CAR(x) \
1850 Lisp_Object tmp = XCAR (x); \
1851 CHECK_NUMBER (tmp); \
1852 XSETCAR ((x), tmp); \
1855 #define CHECK_NUMBER_CDR(x) \
1857 Lisp_Object tmp = XCDR (x); \
1858 CHECK_NUMBER (tmp); \
1859 XSETCDR ((x), tmp); \
1862 #define CHECK_NATNUM_CAR(x) \
1864 Lisp_Object tmp = XCAR (x); \
1865 CHECK_NATNUM (tmp); \
1866 XSETCAR ((x), tmp); \
1869 #define CHECK_NATNUM_CDR(x) \
1871 Lisp_Object tmp = XCDR (x); \
1872 CHECK_NATNUM (tmp); \
1873 XSETCDR ((x), tmp); \
1876 /* Define a built-in function for calling from Lisp.
1877 `lname' should be the name to give the function in Lisp,
1878 as a null-terminated C string.
1879 `fnname' should be the name of the function in C.
1880 By convention, it starts with F.
1881 `sname' should be the name for the C constant structure
1882 that records information on this function for internal use.
1883 By convention, it should be the same as `fnname' but with S instead of F.
1884 It's too bad that C macros can't compute this from `fnname'.
1885 `minargs' should be a number, the minimum number of arguments allowed.
1886 `maxargs' should be a number, the maximum number of arguments allowed,
1887 or else MANY or UNEVALLED.
1888 MANY means pass a vector of evaluated arguments,
1889 in the form of an integer number-of-arguments
1890 followed by the address of a vector of Lisp_Objects
1891 which contains the argument values.
1892 UNEVALLED means pass the list of unevaluated arguments
1893 `intspec' says how interactive arguments are to be fetched.
1894 If the string starts with a `(', `intspec' is evaluated and the resulting
1895 list is the list of arguments.
1896 If it's a string that doesn't start with `(', the value should follow
1897 the one of the doc string for `interactive'.
1898 A null string means call interactively with no arguments.
1899 `doc' is documentation for the user. */
1901 /* This version of DEFUN declares a function prototype with the right
1902 arguments, so we can catch errors with maxargs at compile-time. */
1904 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1905 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1906 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1907 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1908 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1909 { (Lisp_Object (__cdecl *)(void))fnname }, \
1910 minargs, maxargs, lname, intspec, 0}; \
1912 #else /* not _MSC_VER */
1913 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1914 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1915 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1916 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1917 { .a ## maxargs = fnname }, \
1918 minargs, maxargs, lname, intspec, 0}; \
1922 /* Note that the weird token-substitution semantics of ANSI C makes
1923 this work for MANY and UNEVALLED. */
1924 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1925 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1926 #define DEFUN_ARGS_0 (void)
1927 #define DEFUN_ARGS_1 (Lisp_Object)
1928 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1929 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1930 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1931 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1933 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1934 Lisp_Object, Lisp_Object)
1935 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1936 Lisp_Object, Lisp_Object, Lisp_Object)
1937 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1938 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1940 /* Non-zero if OBJ is a Lisp function. */
1941 #define FUNCTIONP(OBJ) \
1942 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1943 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1944 || COMPILEDP (OBJ) \
1948 is how we define the symbol for function `name' at start-up time. */
1949 extern void defsubr (struct Lisp_Subr
*);
1957 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1958 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1959 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1960 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1961 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1963 /* Macros we use to define forwarded Lisp variables.
1964 These are used in the syms_of_FILENAME functions.
1966 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1967 lisp variable is actually a field in `struct emacs_globals'. The
1968 field's name begins with "f_", which is a convention enforced by
1969 these macros. Each such global has a corresponding #define in
1970 globals.h; the plain name should be used in the code.
1972 E.g., the global "cons_cells_consed" is declared as "int
1973 f_cons_cells_consed" in globals.h, but there is a define:
1975 #define cons_cells_consed globals.f_cons_cells_consed
1977 All C code uses the `cons_cells_consed' name. This is all done
1978 this way to support indirection for multi-threaded Emacs. */
1980 #define DEFVAR_LISP(lname, vname, doc) \
1982 static struct Lisp_Objfwd o_fwd; \
1983 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1985 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1987 static struct Lisp_Objfwd o_fwd; \
1988 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1990 #define DEFVAR_BOOL(lname, vname, doc) \
1992 static struct Lisp_Boolfwd b_fwd; \
1993 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1995 #define DEFVAR_INT(lname, vname, doc) \
1997 static struct Lisp_Intfwd i_fwd; \
1998 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2001 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2003 static struct Lisp_Objfwd o_fwd; \
2004 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2007 #define DEFVAR_KBOARD(lname, vname, doc) \
2009 static struct Lisp_Kboard_Objfwd ko_fwd; \
2010 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2015 /* Structure for recording Lisp call stack for backtrace purposes. */
2017 /* The special binding stack holds the outer values of variables while
2018 they are bound by a function application or a let form, stores the
2019 code to be executed for Lisp unwind-protect forms, and stores the C
2020 functions to be called for record_unwind_protect.
2022 If func is non-zero, undoing this binding applies func to old_value;
2023 This implements record_unwind_protect.
2025 Otherwise, the element is a variable binding.
2027 If the symbol field is a symbol, it is an ordinary variable binding.
2029 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2030 which means having bound a local value while CURRENT-BUFFER was active.
2031 If WHERE is nil this means we saw the default value when binding SYMBOL.
2032 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2033 value. Other values of WHERE mean an internal error. */
2035 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2039 Lisp_Object symbol
, old_value
;
2040 specbinding_func func
;
2041 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
2044 extern struct specbinding
*specpdl
;
2045 extern struct specbinding
*specpdl_ptr
;
2046 extern ptrdiff_t specpdl_size
;
2048 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2050 /* Everything needed to describe an active condition case. */
2053 /* The handler clauses and variable from the condition-case form. */
2054 /* For a handler set up in Lisp code, this is always a list.
2055 For an internal handler set up by internal_condition_case*,
2056 this can instead be the symbol t or `error'.
2057 t: handle all conditions.
2058 error: handle all conditions, and errors can run the debugger
2059 or display a backtrace. */
2060 Lisp_Object handler
;
2062 /* Fsignal stores here the condition-case clause that applies,
2063 and Fcondition_case thus knows which clause to run. */
2064 Lisp_Object chosen_clause
;
2066 /* Used to effect the longjump out to the handler. */
2067 struct catchtag
*tag
;
2069 /* The next enclosing handler. */
2070 struct handler
*next
;
2073 /* This structure helps implement the `catch' and `throw' control
2074 structure. A struct catchtag contains all the information needed
2075 to restore the state of the interpreter after a non-local jump.
2077 Handlers for error conditions (represented by `struct handler'
2078 structures) just point to a catch tag to do the cleanup required
2081 catchtag structures are chained together in the C calling stack;
2082 the `next' member points to the next outer catchtag.
2084 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2085 member is TAG, and then unbinds to it. The `val' member is used to
2086 hold VAL while the stack is unwound; `val' is returned as the value
2089 All the other members are concerned with restoring the interpreter
2096 struct catchtag
*next
;
2097 struct gcpro
*gcpro
;
2099 struct backtrace
*backlist
;
2100 struct handler
*handlerlist
;
2101 EMACS_INT lisp_eval_depth
;
2103 int poll_suppress_count
;
2104 int interrupt_input_blocked
;
2105 struct byte_stack
*byte_stack
;
2108 extern Lisp_Object memory_signal_data
;
2110 /* An address near the bottom of the stack.
2111 Tells GC how to save a copy of the stack. */
2112 extern char *stack_bottom
;
2114 /* Check quit-flag and quit if it is non-nil.
2115 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2116 So the program needs to do QUIT at times when it is safe to quit.
2117 Every loop that might run for a long time or might not exit
2118 ought to do QUIT at least once, at a safe place.
2119 Unless that is impossible, of course.
2120 But it is very desirable to avoid creating loops where QUIT is impossible.
2122 Exception: if you set immediate_quit to nonzero,
2123 then the handler that responds to the C-g does the quit itself.
2124 This is a good thing to do around a loop that has no side effects
2125 and (in particular) cannot call arbitrary Lisp code.
2127 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2128 a request to exit Emacs when it is safe to do. */
2131 extern void process_pending_signals (void);
2132 extern int pending_signals
;
2133 #define ELSE_PENDING_SIGNALS \
2134 else if (pending_signals) \
2135 process_pending_signals ();
2136 #else /* not SYNC_INPUT */
2137 #define ELSE_PENDING_SIGNALS
2138 #endif /* not SYNC_INPUT */
2140 extern void process_quit_flag (void);
2143 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2144 process_quit_flag (); \
2145 ELSE_PENDING_SIGNALS \
2149 /* Nonzero if ought to quit now. */
2151 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2153 extern Lisp_Object Vascii_downcase_table
;
2154 extern Lisp_Object Vascii_canon_table
;
2156 /* Structure for recording stack slots that need marking. */
2158 /* This is a chain of structures, each of which points at a Lisp_Object
2159 variable whose value should be marked in garbage collection.
2160 Normally every link of the chain is an automatic variable of a function,
2161 and its `val' points to some argument or local variable of the function.
2162 On exit to the function, the chain is set back to the value it had on entry.
2163 This way, no link remains in the chain when the stack frame containing the
2166 Every function that can call Feval must protect in this fashion all
2167 Lisp_Object variables whose contents will be used again. */
2169 extern struct gcpro
*gcprolist
;
2175 /* Address of first protected variable. */
2176 volatile Lisp_Object
*var
;
2178 /* Number of consecutive protected variables. */
2186 /* Values of GC_MARK_STACK during compilation:
2188 0 Use GCPRO as before
2189 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2190 2 Mark the stack, and check that everything GCPRO'd is
2192 3 Mark using GCPRO's, mark stack last, and count how many
2193 dead objects are kept alive. */
2196 #define GC_USE_GCPROS_AS_BEFORE 0
2197 #define GC_MAKE_GCPROS_NOOPS 1
2198 #define GC_MARK_STACK_CHECK_GCPROS 2
2199 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2201 #ifndef GC_MARK_STACK
2202 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2205 /* Whether we do the stack marking manually. */
2206 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2207 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2210 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2212 /* Do something silly with gcproN vars just so gcc shuts up. */
2213 /* You get warnings from MIPSPro... */
2215 #define GCPRO1(varname) ((void) gcpro1)
2216 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2217 #define GCPRO3(varname1, varname2, varname3) \
2218 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2219 #define GCPRO4(varname1, varname2, varname3, varname4) \
2220 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2221 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2222 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2223 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2224 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2226 #define UNGCPRO ((void) 0)
2228 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2232 #define GCPRO1(varname) \
2233 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2234 gcprolist = &gcpro1; }
2236 #define GCPRO2(varname1, varname2) \
2237 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2238 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2239 gcprolist = &gcpro2; }
2241 #define GCPRO3(varname1, varname2, varname3) \
2242 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2243 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2244 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2245 gcprolist = &gcpro3; }
2247 #define GCPRO4(varname1, varname2, varname3, varname4) \
2248 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2249 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2250 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2251 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2252 gcprolist = &gcpro4; }
2254 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2255 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2256 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2257 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2258 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2259 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2260 gcprolist = &gcpro5; }
2262 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2263 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2264 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2265 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2266 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2267 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2268 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2269 gcprolist = &gcpro6; }
2271 #define UNGCPRO (gcprolist = gcpro1.next)
2275 extern int gcpro_level
;
2277 #define GCPRO1(varname) \
2278 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2279 gcpro1.level = gcpro_level++; \
2280 gcprolist = &gcpro1; }
2282 #define GCPRO2(varname1, varname2) \
2283 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2284 gcpro1.level = gcpro_level; \
2285 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2286 gcpro2.level = gcpro_level++; \
2287 gcprolist = &gcpro2; }
2289 #define GCPRO3(varname1, varname2, varname3) \
2290 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2291 gcpro1.level = gcpro_level; \
2292 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2293 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2294 gcpro3.level = gcpro_level++; \
2295 gcprolist = &gcpro3; }
2297 #define GCPRO4(varname1, varname2, varname3, varname4) \
2298 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2299 gcpro1.level = gcpro_level; \
2300 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2301 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2302 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2303 gcpro4.level = gcpro_level++; \
2304 gcprolist = &gcpro4; }
2306 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2307 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2308 gcpro1.level = gcpro_level; \
2309 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2310 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2311 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2312 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2313 gcpro5.level = gcpro_level++; \
2314 gcprolist = &gcpro5; }
2316 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2317 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2318 gcpro1.level = gcpro_level; \
2319 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2320 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2321 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2322 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2323 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2324 gcpro6.level = gcpro_level++; \
2325 gcprolist = &gcpro6; }
2328 ((--gcpro_level != gcpro1.level) \
2330 : ((gcprolist = gcpro1.next), 0))
2332 #endif /* DEBUG_GCPRO */
2333 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2336 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2337 #define RETURN_UNGCPRO(expr) \
2340 Lisp_Object ret_ungc_val; \
2341 ret_ungc_val = (expr); \
2343 return ret_ungc_val; \
2347 /* Call staticpro (&var) to protect static variable `var'. */
2349 void staticpro (Lisp_Object
*);
2351 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2352 meaning as in the DEFUN macro, and is used to construct a prototype. */
2353 /* We can use the same trick as in the DEFUN macro to generate the
2354 appropriate prototype. */
2355 #define EXFUN(fnname, maxargs) \
2356 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2358 /* Forward declarations for prototypes. */
2362 /* Simple access functions. */
2364 LISP_INLINE Lisp_Object
*
2365 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2367 return & XVECTOR (array
)->contents
[idx
];
2371 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2373 /* Like ASET, but also can be used in the garbage collector:
2374 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2375 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2376 XVECTOR (array
)->contents
[idx
] = val
;
2380 set_hash_key (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2382 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2386 set_hash_value (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2388 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2392 set_hash_next (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2394 gc_aset (h
->next
, idx
, val
);
2398 set_hash_hash (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2400 gc_aset (h
->hash
, idx
, val
);
2404 set_hash_index (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2406 gc_aset (h
->index
, idx
, val
);
2409 /* Defined in data.c. */
2410 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2411 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2412 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2413 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2414 extern Lisp_Object Qinvalid_read_syntax
;
2415 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2416 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2417 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2418 extern Lisp_Object Qtext_read_only
;
2419 extern Lisp_Object Qinteractive_form
;
2420 extern Lisp_Object Qcircular_list
;
2421 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2422 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2423 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2424 extern Lisp_Object Qbuffer_or_string_p
;
2425 extern Lisp_Object Qfboundp
;
2426 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2428 extern Lisp_Object Qcdr
;
2430 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2431 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2433 extern Lisp_Object Qfloatp
;
2434 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2436 extern Lisp_Object Qinteger
, Qinterval
, Qsymbol
, Qstring
;
2437 extern Lisp_Object Qmisc
, Qvector
, Qfloat
, Qcons
, Qbuffer
;
2439 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2441 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2443 /* Defined in frame.c */
2444 extern Lisp_Object Qframep
;
2446 /* Defined in data.c */
2447 extern Lisp_Object
indirect_function (Lisp_Object
);
2448 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2450 /* Convert the integer I to an Emacs representation, either the integer
2451 itself, or a cons of two or three integers, or if all else fails a float.
2452 I should not have side effects. */
2453 #define INTEGER_TO_CONS(i) \
2454 (! FIXNUM_OVERFLOW_P (i) \
2456 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2457 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2458 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2459 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2460 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2461 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2462 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2463 ? Fcons (make_number ((i) >> 16 >> 24), \
2464 Fcons (make_number ((i) >> 16 & 0xffffff), \
2465 make_number ((i) & 0xffff))) \
2468 /* Convert the Emacs representation CONS back to an integer of type
2469 TYPE, storing the result the variable VAR. Signal an error if CONS
2470 is not a valid representation or is out of range for TYPE. */
2471 #define CONS_TO_INTEGER(cons, type, var) \
2472 (TYPE_SIGNED (type) \
2473 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2474 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2475 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2476 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2478 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2479 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2480 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2482 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2483 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2484 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2485 extern void syms_of_data (void);
2486 extern void init_data (void);
2487 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2489 /* Defined in cmds.c */
2490 extern void syms_of_cmds (void);
2491 extern void keys_of_cmds (void);
2493 /* Defined in coding.c */
2494 extern Lisp_Object Qcharset
;
2495 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2496 ptrdiff_t, int, int, Lisp_Object
);
2497 extern void init_coding (void);
2498 extern void init_coding_once (void);
2499 extern void syms_of_coding (void);
2501 /* Defined in character.c */
2502 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2503 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2504 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2505 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2506 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2507 extern void syms_of_character (void);
2509 /* Defined in charset.c */
2510 extern void init_charset (void);
2511 extern void init_charset_once (void);
2512 extern void syms_of_charset (void);
2513 /* Structure forward declarations. */
2516 /* Defined in composite.c */
2517 extern void syms_of_composite (void);
2519 /* Defined in syntax.c */
2520 extern void init_syntax_once (void);
2521 extern void syms_of_syntax (void);
2523 /* Defined in fns.c */
2524 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2525 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2526 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2527 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2528 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2529 extern void sweep_weak_hash_tables (void);
2530 extern Lisp_Object Qcursor_in_echo_area
;
2531 extern Lisp_Object Qstring_lessp
;
2532 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2533 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2534 EMACS_UINT
sxhash (Lisp_Object
, int);
2535 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2536 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2538 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2539 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2542 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2543 ptrdiff_t, ptrdiff_t);
2544 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2545 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2546 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2547 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2548 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2549 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2550 extern void clear_string_char_byte_cache (void);
2551 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2552 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2553 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2554 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2555 extern void syms_of_fns (void);
2557 /* Defined in floatfns.c */
2558 extern double extract_float (Lisp_Object
);
2559 extern void init_floatfns (void);
2560 extern void syms_of_floatfns (void);
2561 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2563 /* Defined in fringe.c */
2564 extern void syms_of_fringe (void);
2565 extern void init_fringe (void);
2566 #ifdef HAVE_WINDOW_SYSTEM
2567 extern void mark_fringe_data (void);
2568 extern void init_fringe_once (void);
2569 #endif /* HAVE_WINDOW_SYSTEM */
2571 /* Defined in image.c */
2572 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2573 extern Lisp_Object QCconversion
;
2574 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2575 extern void syms_of_image (void);
2577 /* Defined in insdel.c */
2578 extern Lisp_Object Qinhibit_modification_hooks
;
2579 extern void move_gap (ptrdiff_t);
2580 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2581 extern _Noreturn
void buffer_overflow (void);
2582 extern void make_gap (ptrdiff_t);
2583 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2584 ptrdiff_t, int, int);
2585 extern int count_combining_before (const unsigned char *,
2586 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2587 extern int count_combining_after (const unsigned char *,
2588 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2589 extern void insert (const char *, ptrdiff_t);
2590 extern void insert_and_inherit (const char *, ptrdiff_t);
2591 extern void insert_1 (const char *, ptrdiff_t, int, int, int);
2592 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2594 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2595 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2596 ptrdiff_t, ptrdiff_t, int);
2597 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2598 extern void insert_char (int);
2599 extern void insert_string (const char *);
2600 extern void insert_before_markers (const char *, ptrdiff_t);
2601 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2602 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2603 ptrdiff_t, ptrdiff_t,
2605 extern void del_range (ptrdiff_t, ptrdiff_t);
2606 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, int, int);
2607 extern void del_range_byte (ptrdiff_t, ptrdiff_t, int);
2608 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int);
2609 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2610 ptrdiff_t, ptrdiff_t, int);
2611 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2612 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2613 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2614 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2615 ptrdiff_t, ptrdiff_t);
2616 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2617 ptrdiff_t, ptrdiff_t);
2618 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, int, int, int);
2619 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2620 const char *, ptrdiff_t, ptrdiff_t, int);
2621 extern void syms_of_insdel (void);
2623 /* Defined in dispnew.c */
2624 #if (defined PROFILING \
2625 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2626 _Noreturn
void __executable_start (void);
2628 extern Lisp_Object selected_frame
;
2629 extern Lisp_Object Vwindow_system
;
2630 void duration_to_sec_usec (double, int *, int *);
2631 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2632 extern void init_display (void);
2633 extern void syms_of_display (void);
2635 /* Defined in xdisp.c */
2636 extern Lisp_Object Qinhibit_point_motion_hooks
;
2637 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2638 extern Lisp_Object Qmenu_bar_update_hook
;
2639 extern Lisp_Object Qwindow_scroll_functions
;
2640 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2641 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2642 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2643 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2644 extern Lisp_Object Qleft_margin
, Qright_margin
;
2645 extern Lisp_Object Qglyphless_char
;
2646 extern Lisp_Object QCdata
, QCfile
;
2647 extern Lisp_Object QCmap
;
2648 extern Lisp_Object Qrisky_local_variable
;
2649 extern struct frame
*last_glyphless_glyph_frame
;
2650 extern int last_glyphless_glyph_face_id
;
2651 extern int last_glyphless_glyph_merged_face_id
;
2652 extern int noninteractive_need_newline
;
2653 extern Lisp_Object echo_area_buffer
[2];
2654 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2655 extern void check_message_stack (void);
2656 extern void setup_echo_area_for_printing (int);
2657 extern int push_message (void);
2658 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2659 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2660 extern void restore_message (void);
2661 extern Lisp_Object
current_message (void);
2662 extern void clear_message (int, int);
2663 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2664 extern void message1 (const char *);
2665 extern void message1_nolog (const char *);
2666 extern void message2 (const char *, ptrdiff_t, int);
2667 extern void message2_nolog (const char *, ptrdiff_t, int);
2668 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2669 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2670 extern void message_dolog (const char *, ptrdiff_t, int, int);
2671 extern void message_with_string (const char *, Lisp_Object
, int);
2672 extern void message_log_maybe_newline (void);
2673 extern void update_echo_area (void);
2674 extern void truncate_echo_area (ptrdiff_t);
2675 extern void redisplay (void);
2676 extern void redisplay_preserve_echo_area (int);
2677 extern void prepare_menu_bars (void);
2679 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2680 extern void syms_of_xdisp (void);
2681 extern void init_xdisp (void);
2682 extern Lisp_Object
safe_eval (Lisp_Object
);
2683 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2684 int *, int *, int *, int *, int *);
2686 /* Defined in xsettings.c */
2687 extern void syms_of_xsettings (void);
2689 /* Defined in vm-limit.c. */
2690 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2692 /* Defined in alloc.c */
2693 extern void check_pure_size (void);
2694 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2695 extern void reset_malloc_hooks (void);
2696 extern void uninterrupt_malloc (void);
2697 extern void malloc_warning (const char *);
2698 extern _Noreturn
void memory_full (size_t);
2699 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2700 extern int survives_gc_p (Lisp_Object
);
2701 extern void mark_object (Lisp_Object
);
2702 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2703 extern void refill_memory_reserve (void);
2705 extern const char *pending_malloc_warning
;
2706 extern Lisp_Object zero_vector
;
2707 extern Lisp_Object
*stack_base
;
2708 extern EMACS_INT consing_since_gc
;
2709 extern EMACS_INT gc_relative_threshold
;
2710 extern EMACS_INT memory_full_cons_threshold
;
2711 extern Lisp_Object
list1 (Lisp_Object
);
2712 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2713 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2714 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2715 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2717 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2718 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2719 extern _Noreturn
void string_overflow (void);
2720 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2721 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2722 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2723 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2725 /* Make unibyte string from C string when the length isn't known. */
2727 LISP_INLINE Lisp_Object
2728 build_unibyte_string (const char *str
)
2730 return make_unibyte_string (str
, strlen (str
));
2733 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2734 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2735 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2736 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2737 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2738 extern Lisp_Object
make_specified_string (const char *,
2739 ptrdiff_t, ptrdiff_t, int);
2740 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, int);
2741 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2743 /* Make a string allocated in pure space, use STR as string data. */
2745 LISP_INLINE Lisp_Object
2746 build_pure_c_string (const char *str
)
2748 return make_pure_c_string (str
, strlen (str
));
2751 /* Make a string from the data at STR, treating it as multibyte if the
2754 LISP_INLINE Lisp_Object
2755 build_string (const char *str
)
2757 return make_string (str
, strlen (str
));
2760 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2761 extern void make_byte_code (struct Lisp_Vector
*);
2762 extern Lisp_Object Qchar_table_extra_slots
;
2763 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2764 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2765 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2767 allocate_pseudovector \
2768 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2769 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2770 extern struct window
*allocate_window (void);
2771 extern struct frame
*allocate_frame (void);
2772 extern struct Lisp_Process
*allocate_process (void);
2773 extern struct terminal
*allocate_terminal (void);
2774 extern int gc_in_progress
;
2775 extern int abort_on_gc
;
2776 extern Lisp_Object
make_float (double);
2777 extern void display_malloc_warning (void);
2778 extern ptrdiff_t inhibit_garbage_collection (void);
2779 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2780 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2781 extern void free_marker (Lisp_Object
);
2782 extern void free_cons (struct Lisp_Cons
*);
2783 extern void init_alloc_once (void);
2784 extern void init_alloc (void);
2785 extern void syms_of_alloc (void);
2786 extern struct buffer
* allocate_buffer (void);
2787 extern int valid_lisp_object_p (Lisp_Object
);
2788 #ifdef GC_CHECK_CONS_LIST
2789 extern void check_cons_list (void);
2791 #define check_cons_list() ((void) 0)
2795 /* Defined in ralloc.c */
2796 extern void *r_alloc (void **, size_t);
2797 extern void r_alloc_free (void **);
2798 extern void *r_re_alloc (void **, size_t);
2799 extern void r_alloc_reset_variable (void **, void **);
2800 extern void r_alloc_inhibit_buffer_relocation (int);
2803 /* Defined in chartab.c */
2804 extern Lisp_Object
copy_char_table (Lisp_Object
);
2805 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2806 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2808 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2809 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2811 extern int char_table_translate (Lisp_Object
, int);
2812 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2814 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2815 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2816 Lisp_Object
, Lisp_Object
,
2817 Lisp_Object
, struct charset
*,
2818 unsigned, unsigned);
2819 extern Lisp_Object
uniprop_table (Lisp_Object
);
2820 extern void syms_of_chartab (void);
2822 /* Defined in print.c */
2823 extern Lisp_Object Vprin1_to_string_buffer
;
2824 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2825 extern Lisp_Object Qstandard_output
;
2826 extern Lisp_Object Qexternal_debugging_output
;
2827 extern void temp_output_buffer_setup (const char *);
2828 extern int print_level
;
2829 extern Lisp_Object Qprint_escape_newlines
;
2830 extern void write_string (const char *, int);
2831 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2833 extern Lisp_Object internal_with_output_to_temp_buffer
2834 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2835 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
2836 extern int float_to_string (char *, double);
2837 extern void syms_of_print (void);
2839 /* Defined in doprnt.c */
2840 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2842 extern ptrdiff_t esprintf (char *, char const *, ...)
2843 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2844 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2846 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2847 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2848 char const *, va_list)
2849 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2851 /* Defined in lread.c. */
2852 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2853 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2854 extern Lisp_Object
check_obarray (Lisp_Object
);
2855 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
2856 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
2857 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
2858 #define LOADHIST_ATTACH(x) \
2860 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2862 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2863 Lisp_Object
*, Lisp_Object
);
2864 Lisp_Object
string_to_number (char const *, int, int);
2865 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2867 extern void dir_warning (const char *, Lisp_Object
);
2868 extern void close_load_descs (void);
2869 extern void init_obarray (void);
2870 extern void init_lread (void);
2871 extern void syms_of_lread (void);
2873 LISP_INLINE Lisp_Object
2874 intern (const char *str
)
2876 return intern_1 (str
, strlen (str
));
2879 LISP_INLINE Lisp_Object
2880 intern_c_string (const char *str
)
2882 return intern_c_string_1 (str
, strlen (str
));
2885 /* Defined in eval.c. */
2886 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
2887 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2888 extern Lisp_Object Qand_rest
;
2889 extern Lisp_Object Vautoload_queue
;
2890 extern Lisp_Object Vsignaling_function
;
2891 extern Lisp_Object inhibit_lisp_code
;
2892 extern int handling_signal
;
2894 extern struct catchtag
*catchlist
;
2895 extern struct handler
*handlerlist
;
2897 /* To run a normal hook, use the appropriate function from the list below.
2898 The calling convention:
2900 if (!NILP (Vrun_hooks))
2901 call1 (Vrun_hooks, Qmy_funny_hook);
2903 should no longer be used. */
2904 extern Lisp_Object Vrun_hooks
;
2905 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2906 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2907 Lisp_Object (*funcall
)
2908 (ptrdiff_t nargs
, Lisp_Object
*args
));
2909 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
2910 extern _Noreturn
void xsignal0 (Lisp_Object
);
2911 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
2912 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2913 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2915 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
2916 extern Lisp_Object
eval_sub (Lisp_Object form
);
2917 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2918 extern Lisp_Object
call0 (Lisp_Object
);
2919 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2920 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2921 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2922 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2923 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2924 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2925 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2926 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2927 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2928 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2929 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2930 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2931 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2932 extern void specbind (Lisp_Object
, Lisp_Object
);
2933 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2934 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
2935 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2936 extern _Noreturn
void verror (const char *, va_list)
2937 ATTRIBUTE_FORMAT_PRINTF (1, 0);
2938 extern Lisp_Object
un_autoload (Lisp_Object
);
2939 extern void init_eval_once (void);
2940 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
2941 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
2942 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2943 extern void init_eval (void);
2945 extern void mark_backtrace (void);
2947 extern void syms_of_eval (void);
2949 /* Defined in editfns.c. */
2950 extern Lisp_Object Qfield
;
2951 extern void insert1 (Lisp_Object
);
2952 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
2953 extern Lisp_Object
save_excursion_save (void);
2954 extern Lisp_Object
save_restriction_save (void);
2955 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
2956 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
2957 extern _Noreturn
void time_overflow (void);
2958 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, int);
2959 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2961 extern void init_editfns (void);
2962 const char *get_system_name (void);
2963 extern void syms_of_editfns (void);
2964 extern void set_time_zone_rule (const char *);
2966 /* Defined in buffer.c. */
2967 extern int mouse_face_overlay_overlaps (Lisp_Object
);
2968 extern _Noreturn
void nsberror (Lisp_Object
);
2969 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
2970 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
2971 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
2972 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
2973 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2974 extern int overlay_touches_p (ptrdiff_t);
2975 extern Lisp_Object Vbuffer_alist
;
2976 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
2977 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
2978 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
2979 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
2980 extern void init_buffer_once (void);
2981 extern void init_buffer (void);
2982 extern void syms_of_buffer (void);
2983 extern void keys_of_buffer (void);
2985 /* Defined in marker.c. */
2987 extern ptrdiff_t marker_position (Lisp_Object
);
2988 extern ptrdiff_t marker_byte_position (Lisp_Object
);
2989 extern void clear_charpos_cache (struct buffer
*);
2990 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
2991 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
2992 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
2993 extern void unchain_marker (struct Lisp_Marker
*marker
);
2994 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2995 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
2996 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
2997 ptrdiff_t, ptrdiff_t);
2998 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
2999 extern void syms_of_marker (void);
3001 /* Defined in fileio.c */
3003 extern Lisp_Object Qfile_error
;
3004 extern Lisp_Object Qfile_exists_p
;
3005 extern Lisp_Object Qfile_directory_p
;
3006 extern Lisp_Object Qinsert_file_contents
;
3007 extern Lisp_Object Qfile_name_history
;
3008 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3009 EXFUN (Fread_file_name
, 6); /* not a normal DEFUN */
3010 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3011 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3012 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3013 extern int internal_delete_file (Lisp_Object
);
3014 extern void syms_of_fileio (void);
3015 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
3016 extern Lisp_Object Qdelete_file
;
3018 /* Defined in search.c */
3019 extern void shrink_regexp_cache (void);
3020 extern void restore_search_regs (void);
3021 extern void record_unwind_save_match_data (void);
3022 struct re_registers
;
3023 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3024 struct re_registers
*,
3025 Lisp_Object
, int, int);
3026 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3027 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3029 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3030 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3031 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3032 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3034 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3036 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3037 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3038 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3039 extern void syms_of_search (void);
3040 extern void clear_regexp_cache (void);
3042 /* Defined in minibuf.c. */
3044 extern Lisp_Object Qcompletion_ignore_case
;
3045 extern Lisp_Object Vminibuffer_list
;
3046 extern Lisp_Object last_minibuf_string
;
3047 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3048 extern void init_minibuf_once (void);
3049 extern void syms_of_minibuf (void);
3051 /* Defined in callint.c. */
3053 extern Lisp_Object Qminus
, Qplus
;
3054 extern Lisp_Object Qwhen
;
3055 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3056 extern void syms_of_callint (void);
3058 /* Defined in casefiddle.c. */
3060 extern Lisp_Object Qidentity
;
3061 extern void syms_of_casefiddle (void);
3062 extern void keys_of_casefiddle (void);
3064 /* Defined in casetab.c. */
3066 extern void init_casetab_once (void);
3067 extern void syms_of_casetab (void);
3069 /* Defined in keyboard.c. */
3071 extern Lisp_Object echo_message_buffer
;
3072 extern struct kboard
*echo_kboard
;
3073 extern void cancel_echoing (void);
3074 extern Lisp_Object Qdisabled
, QCfilter
;
3075 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3076 extern Lisp_Object Qtop
;
3077 extern Lisp_Object last_undo_boundary
;
3078 extern int input_pending
;
3079 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3080 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3081 extern void discard_mouse_events (void);
3082 extern Lisp_Object pending_funcalls
;
3083 extern int detect_input_pending (void);
3084 extern int detect_input_pending_ignore_squeezables (void);
3085 extern int detect_input_pending_run_timers (int);
3086 extern void safe_run_hooks (Lisp_Object
);
3087 extern void cmd_error_internal (Lisp_Object
, const char *);
3088 extern Lisp_Object
command_loop_1 (void);
3089 extern Lisp_Object
recursive_edit_1 (void);
3090 extern void record_auto_save (void);
3092 extern void force_auto_save_soon (void);
3094 extern void init_keyboard (void);
3095 extern void syms_of_keyboard (void);
3096 extern void keys_of_keyboard (void);
3098 /* Defined in indent.c. */
3099 extern ptrdiff_t current_column (void);
3100 extern void invalidate_current_column (void);
3101 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3102 extern void syms_of_indent (void);
3104 /* Defined in frame.c. */
3105 extern Lisp_Object Qonly
;
3106 extern Lisp_Object Qvisible
;
3107 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3108 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3109 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3111 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3113 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3114 extern void frames_discard_buffer (Lisp_Object
);
3115 extern void syms_of_frame (void);
3117 /* Defined in emacs.c. */
3118 extern char **initial_argv
;
3119 extern int initial_argc
;
3120 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3121 extern int display_arg
;
3123 extern Lisp_Object
decode_env_path (const char *, const char *);
3124 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3125 extern Lisp_Object Qfile_name_handler_alist
;
3126 #ifdef FLOAT_CATCH_SIGILL
3127 extern void fatal_error_signal (int);
3129 extern Lisp_Object Qkill_emacs
;
3131 void fixup_locale (void);
3132 void synchronize_system_messages_locale (void);
3133 void synchronize_system_time_locale (void);
3135 #define setlocale(category, locale)
3136 #define fixup_locale()
3137 #define synchronize_system_messages_locale()
3138 #define synchronize_system_time_locale()
3140 void shut_down_emacs (int, int, Lisp_Object
);
3141 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3142 extern int noninteractive
;
3144 /* Nonzero means remove site-lisp directories from load-path. */
3145 extern int no_site_lisp
;
3147 /* Pipe used to send exit notification to the daemon parent at
3149 extern int daemon_pipe
[2];
3150 #define IS_DAEMON (daemon_pipe[1] != 0)
3152 /* Nonzero means don't do use window-system-specific display code. */
3153 extern int inhibit_window_system
;
3154 /* Nonzero means that a filter or a sentinel is running. */
3155 extern int running_asynch_code
;
3157 /* Defined in process.c. */
3158 extern Lisp_Object QCtype
, Qlocal
;
3159 extern Lisp_Object Qprocessp
;
3160 extern void kill_buffer_processes (Lisp_Object
);
3161 extern int wait_reading_process_output (intmax_t, int, int, int,
3163 struct Lisp_Process
*,
3165 /* Max value for the first argument of wait_reading_process_output. */
3166 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3167 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3168 The bug merely causes a bogus warning, but the warning is annoying. */
3169 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3171 # define WAIT_READING_MAX INTMAX_MAX
3173 extern void add_keyboard_wait_descriptor (int);
3174 extern void delete_keyboard_wait_descriptor (int);
3176 extern void add_gpm_wait_descriptor (int);
3177 extern void delete_gpm_wait_descriptor (int);
3179 extern void close_process_descs (void);
3180 extern void init_process_emacs (void);
3181 extern void syms_of_process (void);
3182 extern void setup_process_coding_systems (Lisp_Object
);
3187 extern int child_setup (int, int, int, char **, int, Lisp_Object
);
3188 extern void init_callproc_1 (void);
3189 extern void init_callproc (void);
3190 extern void set_initial_environment (void);
3191 extern void syms_of_callproc (void);
3193 /* Defined in doc.c */
3194 extern Lisp_Object Qfunction_documentation
;
3195 extern Lisp_Object
read_doc_string (Lisp_Object
);
3196 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3197 extern void syms_of_doc (void);
3198 extern int read_bytecode_char (int);
3200 /* Defined in bytecode.c */
3201 extern Lisp_Object Qbytecode
;
3202 extern void syms_of_bytecode (void);
3203 extern struct byte_stack
*byte_stack_list
;
3205 extern void mark_byte_stack (void);
3207 extern void unmark_byte_stack (void);
3208 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3209 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3211 /* Defined in macros.c */
3212 extern Lisp_Object Qexecute_kbd_macro
;
3213 extern void init_macros (void);
3214 extern void syms_of_macros (void);
3216 /* Defined in undo.c */
3217 extern Lisp_Object Qapply
;
3218 extern Lisp_Object Qinhibit_read_only
;
3219 extern void truncate_undo_list (struct buffer
*);
3220 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3221 extern void record_insert (ptrdiff_t, ptrdiff_t);
3222 extern void record_delete (ptrdiff_t, Lisp_Object
);
3223 extern void record_first_change (void);
3224 extern void record_change (ptrdiff_t, ptrdiff_t);
3225 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3226 Lisp_Object
, Lisp_Object
,
3228 extern void syms_of_undo (void);
3229 /* Defined in textprop.c */
3230 extern Lisp_Object Qfont
, Qmouse_face
;
3231 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3232 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3233 extern Lisp_Object Qminibuffer_prompt
;
3235 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3237 /* Defined in menu.c */
3238 extern void syms_of_menu (void);
3240 /* Defined in xmenu.c */
3241 extern void syms_of_xmenu (void);
3243 /* Defined in termchar.h */
3244 struct tty_display_info
;
3246 /* Defined in termhooks.h */
3249 /* Defined in sysdep.c */
3250 #ifndef HAVE_GET_CURRENT_DIR_NAME
3251 extern char *get_current_dir_name (void);
3253 extern void stuff_char (char c
);
3254 extern void init_sigio (int);
3255 extern void sys_subshell (void);
3256 extern void sys_suspend (void);
3257 extern void discard_tty_input (void);
3258 extern void init_sys_modes (struct tty_display_info
*);
3259 extern void reset_sys_modes (struct tty_display_info
*);
3260 extern void init_all_sys_modes (void);
3261 extern void reset_all_sys_modes (void);
3262 extern void wait_for_termination (pid_t
);
3263 extern void interruptible_wait_for_termination (pid_t
);
3264 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3265 extern void child_setup_tty (int);
3266 extern void setup_pty (int);
3267 extern int set_window_size (int, int, int);
3268 extern EMACS_INT
get_random (void);
3269 extern void seed_random (long);
3270 extern int emacs_open (const char *, int, int);
3271 extern int emacs_close (int);
3272 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3273 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3274 enum { READLINK_BUFSIZE
= 1024 };
3275 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3277 extern void unlock_all_files (void);
3278 extern void lock_file (Lisp_Object
);
3279 extern void unlock_file (Lisp_Object
);
3280 extern void unlock_buffer (struct buffer
*);
3281 extern void syms_of_filelock (void);
3283 /* Defined in sound.c */
3284 extern void syms_of_sound (void);
3286 /* Defined in category.c */
3287 extern void init_category_once (void);
3288 extern Lisp_Object
char_category_set (int);
3289 extern void syms_of_category (void);
3291 /* Defined in ccl.c */
3292 extern void syms_of_ccl (void);
3294 /* Defined in dired.c */
3295 extern void syms_of_dired (void);
3296 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3297 Lisp_Object
, Lisp_Object
,
3300 /* Defined in term.c */
3301 extern int *char_ins_del_vector
;
3302 extern void mark_ttys (void);
3303 extern void syms_of_term (void);
3304 extern _Noreturn
void fatal (const char *msgid
, ...)
3305 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3307 /* Defined in terminal.c */
3308 extern void syms_of_terminal (void);
3310 /* Defined in font.c */
3311 extern void syms_of_font (void);
3312 extern void init_font (void);
3314 #ifdef HAVE_WINDOW_SYSTEM
3315 /* Defined in fontset.c */
3316 extern void syms_of_fontset (void);
3318 /* Defined in xfns.c, w32fns.c, or macfns.c */
3319 extern Lisp_Object Qfont_param
;
3322 /* Defined in xfaces.c */
3323 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3324 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3325 extern Lisp_Object Qmode_line_inactive
;
3326 extern Lisp_Object Qface
;
3327 extern Lisp_Object Qnormal
;
3328 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3329 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3330 extern Lisp_Object Vface_alternative_font_family_alist
;
3331 extern Lisp_Object Vface_alternative_font_registry_alist
;
3332 extern void syms_of_xfaces (void);
3334 #ifdef HAVE_X_WINDOWS
3335 /* Defined in xfns.c */
3336 extern void syms_of_xfns (void);
3338 /* Defined in xsmfns.c */
3339 extern void syms_of_xsmfns (void);
3341 /* Defined in xselect.c */
3342 extern void syms_of_xselect (void);
3344 /* Defined in xterm.c */
3345 extern void syms_of_xterm (void);
3346 #endif /* HAVE_X_WINDOWS */
3348 #ifdef HAVE_WINDOW_SYSTEM
3349 /* Defined in xterm.c, nsterm.m, w32term.c */
3350 extern char *x_get_keysym_name (int);
3351 #endif /* HAVE_WINDOW_SYSTEM */
3354 /* Defined in xml.c */
3355 extern void syms_of_xml (void);
3356 extern void xml_cleanup_parser (void);
3360 /* Defined in (x|w32)fns.c, nsfns.m... */
3361 extern int have_menus_p (void);
3365 /* Defined in dbusbind.c */
3366 void syms_of_dbusbind (void);
3370 /* Defined in msdos.c, w32.c */
3371 extern char *emacs_root_dir (void);
3374 /* Nonzero means Emacs has already been initialized.
3375 Used during startup to detect startup of dumped Emacs. */
3376 extern int initialized
;
3378 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3380 extern void *xmalloc (size_t);
3381 extern void *xzalloc (size_t);
3382 extern void *xrealloc (void *, size_t);
3383 extern void xfree (void *);
3384 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3385 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3386 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3388 extern char *xstrdup (const char *);
3390 extern char *egetenv (const char *);
3392 /* Set up the name of the machine we're running on. */
3393 extern void init_system_name (void);
3395 static char const DIRECTORY_SEP
= '/';
3397 /* Use this to suppress gcc's warnings. */
3400 /* Use CODE only if lint checking is in effect. */
3401 # define IF_LINT(Code) Code
3403 /* Assume that the expression COND is true. This differs in intent
3404 from 'assert', as it is a message from the programmer to the compiler. */
3405 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3408 # define IF_LINT(Code) /* empty */
3409 # define lint_assume(cond) ((void) (0 && (cond)))
3412 /* We used to use `abs', but that clashes with system headers on some
3413 platforms, and using a name reserved by Standard C is a bad idea
3416 #define eabs(x) ((x) < 0 ? -(x) : (x))
3419 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3422 #define make_fixnum_or_float(val) \
3423 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3426 /* Checks the `cycle check' variable CHECK to see if it indicates that
3427 EL is part of a cycle; CHECK must be either Qnil or a value returned
3428 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3429 elements after which a cycle might be suspected; after that many
3430 elements, this macro begins consing in order to keep more precise
3433 Returns nil if a cycle was detected, otherwise a new value for CHECK
3436 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3437 the caller should make sure that's ok. */
3439 #define CYCLE_CHECK(check, el, suspicious) \
3442 : (INTEGERP (check) \
3443 ? (XFASTINT (check) < (suspicious) \
3444 ? make_number (XFASTINT (check) + 1) \
3445 : Fcons (el, Qnil)) \
3446 : (!NILP (Fmemq ((el), (check))) \
3448 : Fcons ((el), (check)))))
3451 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3452 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3454 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16*1024 };
3456 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3457 extern void *record_xmalloc (size_t);
3459 #define USE_SAFE_ALLOCA \
3460 ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0
3462 /* SAFE_ALLOCA allocates a simple buffer. */
3464 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3466 : (sa_must_free = 1, record_xmalloc (size)))
3468 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3469 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3470 positive. The code is tuned for MULTIPLIER being a constant. */
3472 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3474 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3475 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3478 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3480 record_unwind_protect (safe_alloca_unwind, \
3481 make_save_value (buf, 0)); \
3485 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3487 #define SAFE_FREE() \
3489 if (sa_must_free) { \
3491 unbind_to (sa_count, Qnil); \
3496 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3498 #define SAFE_ALLOCA_LISP(buf, nelt) \
3500 if ((nelt) < MAX_ALLOCA / word_size) \
3501 buf = alloca ((nelt) * word_size); \
3502 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3505 buf = xmalloc ((nelt) * word_size); \
3506 arg_ = make_save_value (buf, nelt); \
3507 XSAVE_VALUE (arg_)->dogc = 1; \
3509 record_unwind_protect (safe_alloca_unwind, arg_); \
3512 memory_full (SIZE_MAX); \
3516 #include "globals.h"
3518 /* Check whether it's time for GC, and run it if so. */
3523 if ((consing_since_gc
> gc_cons_threshold
3524 && consing_since_gc
> gc_relative_threshold
)
3525 || (!NILP (Vmemory_full
)
3526 && consing_since_gc
> memory_full_cons_threshold
))
3527 Fgarbage_collect ();
3532 #endif /* EMACS_LISP_H */