1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1987, 1993-1995, 1997-2012
3 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/>. */
30 /* Use the configure flag --enable-checking[=LIST] to enable various
31 types of run time checks for Lisp objects. */
33 #ifdef GC_CHECK_CONS_LIST
34 extern void check_cons_list (void);
35 #define CHECK_CONS_LIST() check_cons_list ()
37 #define CHECK_CONS_LIST() ((void) 0)
40 /* Temporarily disable wider-than-pointer integers until they're tested more.
41 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
42 /* #undef WIDE_EMACS_INT */
44 /* EMACS_INT - signed integer wide enough to hold an Emacs value
45 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
46 pI - printf length modifier for EMACS_INT
47 EMACS_UINT - unsigned variant of EMACS_INT */
49 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
50 # define EMACS_INT long long
51 # define EMACS_INT_MAX LLONG_MAX
53 # elif INT_MAX < LONG_MAX
54 # define EMACS_INT long
55 # define EMACS_INT_MAX LONG_MAX
58 # define EMACS_INT int
59 # define EMACS_INT_MAX INT_MAX
63 #define EMACS_UINT unsigned EMACS_INT
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 #ifdef ENABLE_CHECKING
111 extern void die (const char *, const char *, int) NO_RETURN
;
113 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
114 it to 1 using a debugger to temporarily disable aborting on
115 detected internal inconsistencies or error conditions.
117 Testing suppress_checking after the supplied condition ensures that
118 the side effects produced by CHECK will be consistent, independent
119 of whether ENABLE_CHECKING is defined, or whether the checks are
120 suppressed at run time.
122 In some cases, a good compiler may be able to optimize away the
123 CHECK macro altogether, e.g., if XSTRING (x) uses CHECK 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. */
127 extern int suppress_checking EXTERNALLY_VISIBLE
;
129 #define CHECK(check,msg) (((check) || suppress_checking \
131 : die ((msg), __FILE__, __LINE__)), \
135 /* Produce same side effects and result, but don't complain. */
136 #define CHECK(check,msg) ((check),0)
140 /* Define an Emacs version of "assert", since some system ones are
142 #ifndef ENABLE_CHECKING
143 #define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
144 #else /* ENABLE_CHECKING */
145 #if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
146 #define eassert(cond) CHECK (cond, "assertion failed: " #cond)
148 #define eassert(cond) CHECK (cond, "assertion failed")
150 #endif /* ENABLE_CHECKING */
152 /* Use the configure flag --enable-check-lisp-object-type to make
153 Lisp_Object use a struct type instead of the default int. The flag
154 causes CHECK_LISP_OBJECT_TYPE to be defined. */
156 /***** Select the tagging scheme. *****/
157 /* The following option controls the tagging scheme:
158 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
159 always 0, and we can thus use them to hold tag bits, without
160 restricting our addressing space.
162 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
163 restricting our possible address range.
165 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
166 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
167 on the few static Lisp_Objects used: all the defsubr as well
168 as the two special buffers buffer_defaults and buffer_local_symbols. */
170 /* First, try and define DECL_ALIGN(type,var) which declares a static
171 variable VAR of type TYPE with the added requirement that it be
175 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
177 /* The maximum value that can be stored in a EMACS_INT, assuming all
178 bits other than the type bits contribute to a nonnegative signed value.
179 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
180 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
182 #ifndef NO_DECL_ALIGN
184 # if HAVE_ATTRIBUTE_ALIGNED
185 # define DECL_ALIGN(type, var) \
186 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
187 # elif defined(_MSC_VER)
188 # define ALIGN_GCTYPEBITS 8
189 # if (1 << GCTYPEBITS) != ALIGN_GCTYPEBITS
190 # error ALIGN_GCTYPEBITS is wrong!
192 # define DECL_ALIGN(type, var) \
193 type __declspec(align(ALIGN_GCTYPEBITS)) var
195 /* What directives do other compilers use? */
200 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
202 /* 1. We know malloc returns a multiple of 8. */
203 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
204 || defined DARWIN_OS || defined __sun)
205 /* 2. We can specify multiple-of-8 alignment on static variables. */
207 /* 3. Pointers-as-ints exceed VAL_MAX.
208 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
209 a. unnecessary, because the top bits of an EMACS_INT are unused, and
210 b. slower, because it typically requires extra masking.
211 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
212 # if VAL_MAX < UINTPTR_MAX
213 # define USE_LSB_TAG 1
219 # define USE_LSB_TAG 0
222 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
225 # error "USE_LSB_TAG used without defining DECL_ALIGN"
227 # define DECL_ALIGN(type, var) type var
231 /* Define the fundamental Lisp data structures. */
233 /* If USE_2_TAGBITS_FOR_INTS is defined, then Lisp integers use
234 2 tags, to give them one extra bit, thus extending their range from
235 e.g -2^28..2^28-1 to -2^29..2^29-1. */
236 #define USE_2_TAGS_FOR_INTS
238 /* This is the set of Lisp data types. */
240 #if !defined USE_2_TAGS_FOR_INTS
241 # define LISP_INT_TAG Lisp_Int
242 # define case_Lisp_Int case Lisp_Int
243 # define LISP_STRING_TAG 4
244 # define LISP_INT_TAG_P(x) ((x) == Lisp_Int)
246 # define LISP_INT_TAG Lisp_Int0
247 # define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
249 # define LISP_INT1_TAG 4
250 # define LISP_STRING_TAG 1
251 # define LISP_INT_TAG_P(x) (((x) & 3) == 0)
253 # define LISP_INT1_TAG 1
254 # define LISP_STRING_TAG 4
255 # define LISP_INT_TAG_P(x) (((x) & 6) == 0)
259 /* Stolen from GDB. The only known compiler that doesn't support
260 enums in bitfields is MSVC. */
262 #define ENUM_BF(TYPE) unsigned int
264 #define ENUM_BF(TYPE) enum TYPE
270 /* Integer. XINT (obj) is the integer value. */
271 #ifdef USE_2_TAGS_FOR_INTS
273 Lisp_Int1
= LISP_INT1_TAG
,
278 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
281 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
282 whose first member indicates the subtype. */
285 /* String. XSTRING (object) points to a struct Lisp_String.
286 The length of the string, and its contents, are stored therein. */
287 Lisp_String
= LISP_STRING_TAG
,
289 /* Vector of Lisp objects, or something resembling it.
290 XVECTOR (object) points to a struct Lisp_Vector, which contains
291 the size and contents. The size field also contains the type
292 information, if it's not a real vector object. */
295 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
301 /* This is the set of data types that share a common structure.
302 The first member of the structure is a type code from this set.
303 The enum values are arbitrary, but we'll use large numbers to make it
304 more likely that we'll spot the error if a random word in memory is
305 mistakenly interpreted as a Lisp_Misc. */
308 Lisp_Misc_Free
= 0x5eab,
311 Lisp_Misc_Save_Value
,
312 /* Currently floats are not a misc type,
313 but let's define this in case we want to change that. */
315 /* This is not a type code. It is for range checking. */
319 /* These are the types of forwarding objects used in the value slot
320 of symbols for special built-in variables whose value is stored in
324 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
325 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
326 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
327 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
328 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
331 #ifdef CHECK_LISP_OBJECT_TYPE
333 typedef struct { EMACS_INT i
; } Lisp_Object
;
336 static inline Lisp_Object
339 Lisp_Object o
= { i
};
343 static inline Lisp_Object
344 LISP_MAKE_RVALUE (Lisp_Object o
)
349 #define LISP_INITIALLY_ZERO {0}
351 #else /* CHECK_LISP_OBJECT_TYPE */
353 /* If a struct type is not wanted, define Lisp_Object as just a number. */
355 typedef EMACS_INT Lisp_Object
;
358 #define LISP_MAKE_RVALUE(o) (0+(o))
359 #define LISP_INITIALLY_ZERO 0
360 #endif /* CHECK_LISP_OBJECT_TYPE */
362 /* In the size word of a vector, this bit means the vector has been marked. */
364 #define ARRAY_MARK_FLAG PTRDIFF_MIN
366 /* In the size word of a struct Lisp_Vector, this bit means it's really
367 some other vector-like object. */
368 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
370 /* In a pseudovector, the size field actually contains a word with one
371 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
372 indicate the actual type.
373 We use a bitset, even tho only one of the bits can be set at any
374 particular time just so as to be able to use micro-optimizations such as
375 testing membership of a particular subset of pseudovectors in Fequal.
376 It is not crucial, but there are plenty of bits here, so why not do it? */
379 PVEC_NORMAL_VECTOR
= 0,
380 PVEC_PROCESS
= 0x200,
382 PVEC_COMPILED
= 0x800,
383 PVEC_WINDOW
= 0x1000,
384 PVEC_WINDOW_CONFIGURATION
= 0x2000,
386 PVEC_CHAR_TABLE
= 0x8000,
387 PVEC_BOOL_VECTOR
= 0x10000,
388 PVEC_BUFFER
= 0x20000,
389 PVEC_HASH_TABLE
= 0x40000,
390 PVEC_TERMINAL
= 0x80000,
391 PVEC_SUB_CHAR_TABLE
= 0x100000,
392 PVEC_FONT
= 0x200000,
393 PVEC_OTHER
= 0x400000,
394 PVEC_TYPE_MASK
= 0x7ffe00
396 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
397 GDB. It doesn't work on OS Alpha. Moved to a variable in
399 PVEC_FLAG
= PSEUDOVECTOR_FLAG
403 /* For convenience, we also store the number of elements in these bits.
404 Note that this size is not necessarily the memory-footprint size, but
405 only the number of Lisp_Object fields (that need to be traced by the GC).
406 The distinction is used e.g. by Lisp_Process which places extra
407 non-Lisp_Object fields at the end of the structure. */
408 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
410 /* Number of bits to put in each character in the internal representation
411 of bool vectors. This should not vary across implementations. */
412 #define BOOL_VECTOR_BITS_PER_CHAR 8
414 /* These macros extract various sorts of values from a Lisp_Object.
415 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
416 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
418 /* Return a perfect hash of the Lisp_Object representation. */
419 #define XHASH(a) XLI(a)
423 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
424 #define XTYPE(a) ((enum Lisp_Type) (XLI(a) & TYPEMASK))
425 #ifdef USE_2_TAGS_FOR_INTS
426 # define XINT(a) (((EMACS_INT) XLI(a)) >> (GCTYPEBITS - 1))
427 # define XUINT(a) (((EMACS_UINT) XLI(a)) >> (GCTYPEBITS - 1))
428 # define make_number(N) XIL(((EMACS_INT) (N)) << (GCTYPEBITS - 1))
430 # define XINT(a) (((EMACS_INT) XLI(a)) >> GCTYPEBITS)
431 # define XUINT(a) (((EMACS_UINT) XLI(a)) >> GCTYPEBITS)
432 # define make_number(N) XIL(((EMACS_INT) (N)) << GCTYPEBITS)
434 #define XSET(var, type, ptr) \
435 (eassert (XTYPE (XIL((intptr_t) (ptr))) == 0), /* Check alignment. */ \
436 (var) = XIL((type) | (intptr_t) (ptr)))
438 #define XPNTR(a) ((intptr_t) (XLI(a) & ~TYPEMASK))
439 #define XUNTAG(a, type) ((intptr_t) (XLI(a) - (type)))
441 #else /* not USE_LSB_TAG */
443 #define VALMASK VAL_MAX
445 /* One need to override this if there must be high bits set in data space
446 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
447 on all machines, but would penalize machines which don't need it)
449 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) XLI(a)) >> VALBITS))
451 /* For integers known to be positive, XFASTINT provides fast retrieval
452 and XSETFASTINT provides fast storage. This takes advantage of the
453 fact that Lisp_Int is 0. */
454 #define XFASTINT(a) (XLI(a) + 0)
455 #define XSETFASTINT(a, b) ((a) = XIL(b))
457 /* Extract the value of a Lisp_Object as a (un)signed integer. */
459 #ifdef USE_2_TAGS_FOR_INTS
460 # define XINT(a) ((((EMACS_INT) XLI(a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
461 # define XUINT(a) ((EMACS_UINT) (XLI(a) & (1 + (VALMASK << 1))))
462 # define make_number(N) XIL((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
464 # define XINT(a) ((((EMACS_INT) XLI(a)) << (BITS_PER_EMACS_INT - VALBITS)) \
465 >> (BITS_PER_EMACS_INT - VALBITS))
466 # define XUINT(a) ((EMACS_UINT) (XLI(a) & VALMASK))
467 # define make_number(N) \
468 XIL((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
471 #define XSET(var, type, ptr) \
472 ((var) = XIL((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
473 + ((intptr_t) (ptr) & VALMASK)))
476 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
477 which were stored in a Lisp_Object */
478 #define XPNTR(a) ((uintptr_t) ((XLI(a) & VALMASK)) | DATA_SEG_BITS))
480 #define XPNTR(a) ((uintptr_t) (XLI(a) & VALMASK))
483 #endif /* not USE_LSB_TAG */
485 /* For integers known to be positive, XFASTINT sometimes provides
486 faster retrieval and XSETFASTINT provides faster storage.
487 If not, fallback on the non-accelerated path. */
489 # define XFASTINT(a) (XINT (a))
490 # define XSETFASTINT(a, b) (XSETINT (a, b))
493 /* Extract the pointer value of the Lisp object A, under the
494 assumption that A's type is TYPE. This is a fallback
495 implementation if nothing faster is available. */
497 # define XUNTAG(a, type) XPNTR (a)
500 #define EQ(x, y) (XHASH (x) == XHASH (y))
502 /* Number of bits in a fixnum, including the sign bit. */
503 #ifdef USE_2_TAGS_FOR_INTS
504 # define FIXNUM_BITS (VALBITS + 1)
506 # define FIXNUM_BITS VALBITS
509 /* Mask indicating the significant bits of a fixnum. */
510 #define INTMASK (((EMACS_INT) 1 << FIXNUM_BITS) - 1)
512 /* Largest and smallest representable fixnum values. These are the C
514 #define MOST_POSITIVE_FIXNUM (INTMASK / 2)
515 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
517 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
518 written this way so that it also works if I is of unsigned
519 type or if I is a NaN. */
521 #define FIXNUM_OVERFLOW_P(i) \
522 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
524 static inline ptrdiff_t
525 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
527 return num
< lower
? lower
: num
<= upper
? num
: upper
;
530 /* Extract a value or address from a Lisp_Object. */
532 #define XCONS(a) (eassert (CONSP (a)), \
533 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
534 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
535 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
536 #define XSTRING(a) (eassert (STRINGP (a)), \
537 (struct Lisp_String *) XUNTAG (a, Lisp_String))
538 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
539 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
540 #define XFLOAT(a) (eassert (FLOATP (a)), \
541 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
545 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
546 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
547 #define XMISCTYPE(a) (XMISCANY (a)->type)
548 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
549 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
550 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
552 /* Forwarding object types. */
554 #define XFWDTYPE(a) (a->u_intfwd.type)
555 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
556 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
557 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
558 #define XBUFFER_OBJFWD(a) \
559 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
560 #define XKBOARD_OBJFWD(a) \
561 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
563 /* Pseudovector types. */
565 #define XPROCESS(a) (eassert (PROCESSP (a)), \
566 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
567 #define XWINDOW(a) (eassert (WINDOWP (a)), \
568 (struct window *) XUNTAG (a, Lisp_Vectorlike))
569 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
570 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
571 #define XSUBR(a) (eassert (SUBRP (a)), \
572 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
573 #define XBUFFER(a) (eassert (BUFFERP (a)), \
574 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
575 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
576 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
577 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
578 ((struct Lisp_Sub_Char_Table *) \
579 XUNTAG (a, Lisp_Vectorlike)))
580 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
581 ((struct Lisp_Bool_Vector *) \
582 XUNTAG (a, Lisp_Vectorlike)))
584 /* Construct a Lisp_Object from a value or address. */
586 #define XSETINT(a, b) (a) = make_number (b)
587 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
588 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
589 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
590 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
591 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
595 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
596 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
598 /* Pseudovector types. */
600 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
601 #define XSETTYPED_PVECTYPE(v, size_member, code) \
602 ((v)->size_member |= PSEUDOVECTOR_FLAG | (code))
603 #define XSETPVECTYPESIZE(v, code, sizeval) \
604 ((v)->header.size = PSEUDOVECTOR_FLAG | (code) | (sizeval))
606 /* The cast to struct vectorlike_header * avoids aliasing issues. */
607 #define XSETPSEUDOVECTOR(a, b, code) \
608 XSETTYPED_PSEUDOVECTOR(a, b, \
609 (((struct vectorlike_header *) \
610 XUNTAG (a, Lisp_Vectorlike)) \
613 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
614 (XSETVECTOR (a, b), \
615 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
616 == (PSEUDOVECTOR_FLAG | (code))))
618 #define XSETWINDOW_CONFIGURATION(a, b) \
619 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
620 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
621 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
622 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
623 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
624 #define XSETSUBR(a, b) \
625 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
626 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
627 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
628 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
629 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
630 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
632 /* Convenience macros for dealing with Lisp arrays. */
634 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
635 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
636 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
637 #define ASET(ARRAY, IDX, VAL) \
638 (eassert ((IDX) == (IDX)), \
639 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
640 AREF ((ARRAY), (IDX)) = (VAL))
642 /* Convenience macros for dealing with Lisp strings. */
644 #define SDATA(string) (XSTRING (string)->data + 0)
645 #define SREF(string, index) (SDATA (string)[index] + 0)
646 #define SSET(string, index, new) (SDATA (string)[index] = (new))
647 #define SCHARS(string) (XSTRING (string)->size + 0)
648 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
650 /* Avoid "differ in sign" warnings. */
651 #define SSDATA(x) ((char *) SDATA (x))
653 #define STRING_SET_CHARS(string, newsize) \
654 (XSTRING (string)->size = (newsize))
656 #define STRING_COPYIN(string, index, new, count) \
657 memcpy (SDATA (string) + index, new, count)
661 #define CHECK_TYPE(ok, Qxxxp, x) \
662 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
666 /* See the macros in intervals.h. */
668 typedef struct interval
*INTERVAL
;
670 /* Complain if object is not string or buffer type */
671 #define CHECK_STRING_OR_BUFFER(x) \
672 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
675 /* In a cons, the markbit of the car is the gc mark bit */
679 /* Please do not use the names of these elements in code other
680 than the core lisp implementation. Use XCAR and XCDR below. */
681 #ifdef HIDE_LISP_IMPLEMENTATION
686 struct Lisp_Cons
*chain
;
693 struct Lisp_Cons
*chain
;
698 /* Take the car or cdr of something known to be a cons cell. */
699 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
700 of code that has to know what a cons cell looks like. Other code not
701 part of the basic lisp implementation should assume that the car and cdr
702 fields are not accessible as lvalues. (What if we want to switch to
703 a copying collector someday? Cached cons cell field addresses may be
704 invalidated at arbitrary points.) */
705 #ifdef HIDE_LISP_IMPLEMENTATION
706 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
707 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
709 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
710 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
713 /* Use these from normal code. */
714 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
715 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
717 /* Use these to set the fields of a cons cell.
719 Note that both arguments may refer to the same object, so 'n'
720 should not be read after 'c' is first modified. Also, neither
721 argument should be evaluated more than once; side effects are
722 especially common in the second argument. */
723 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
724 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
726 /* Take the car or cdr of something whose type is not known. */
728 (CONSP ((c)) ? XCAR ((c)) \
729 : NILP ((c)) ? Qnil \
730 : wrong_type_argument (Qlistp, (c)))
733 (CONSP ((c)) ? XCDR ((c)) \
734 : NILP ((c)) ? Qnil \
735 : wrong_type_argument (Qlistp, (c)))
737 /* Take the car or cdr of something whose type is not known. */
738 #define CAR_SAFE(c) \
739 (CONSP ((c)) ? XCAR ((c)) : Qnil)
741 #define CDR_SAFE(c) \
742 (CONSP ((c)) ? XCDR ((c)) : Qnil)
744 /* Nonzero if STR is a multibyte string. */
745 #define STRING_MULTIBYTE(STR) \
746 (XSTRING (STR)->size_byte >= 0)
748 /* Return the length in bytes of STR. */
750 #ifdef GC_CHECK_STRING_BYTES
753 extern ptrdiff_t string_bytes (struct Lisp_String
*);
754 #define STRING_BYTES(S) string_bytes ((S))
756 #else /* not GC_CHECK_STRING_BYTES */
758 #define STRING_BYTES(STR) \
759 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
761 #endif /* not GC_CHECK_STRING_BYTES */
763 /* An upper bound on the number of bytes in a Lisp string, not
764 counting the terminating null. This a tight enough bound to
765 prevent integer overflow errors that would otherwise occur during
766 string size calculations. A string cannot contain more bytes than
767 a fixnum can represent, nor can it be so long that C pointer
768 arithmetic stops working on the string plus its terminating null.
769 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
770 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
771 would expose alloc.c internal details that we'd rather keep
772 private. The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is
774 #define STRING_BYTES_BOUND \
775 min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1)
777 /* Mark STR as a unibyte string. */
778 #define STRING_SET_UNIBYTE(STR) \
779 do { if (EQ (STR, empty_multibyte_string)) \
780 (STR) = empty_unibyte_string; \
781 else XSTRING (STR)->size_byte = -1; } while (0)
783 /* Mark STR as a multibyte string. Assure that STR contains only
784 ASCII characters in advance. */
785 #define STRING_SET_MULTIBYTE(STR) \
786 do { if (EQ (STR, empty_unibyte_string)) \
787 (STR) = empty_multibyte_string; \
788 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
790 /* Get text properties. */
791 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
793 /* Set text properties. */
794 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
796 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
802 INTERVAL intervals
; /* text properties in this string */
806 /* Header of vector-like objects. This documents the layout constraints on
807 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
808 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
809 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
810 because when two such pointers potentially alias, a compiler won't
811 incorrectly reorder loads and stores to their size fields. See
812 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
813 struct vectorlike_header
817 /* When the vector is allocated from a vector block, NBYTES is used
818 if the vector is not on a free list, and VECTOR is used otherwise.
819 For large vector-like objects, BUFFER or VECTOR is used as a pointer
820 to the next vector-like object. It is generally a buffer or a
821 Lisp_Vector alias, so for convenience it is a union instead of a
822 pointer: this way, one can write P->next.vector instead of ((struct
823 Lisp_Vector *) P->next). */
826 struct buffer
*buffer
;
827 struct Lisp_Vector
*vector
;
833 struct vectorlike_header header
;
834 Lisp_Object contents
[1];
837 /* If a struct is made to look like a vector, this macro returns the length
838 of the shortest vector that would hold that struct. */
839 #define VECSIZE(type) ((sizeof (type) \
840 - offsetof (struct Lisp_Vector, contents[0]) \
841 + sizeof (Lisp_Object) - 1) /* round up */ \
842 / sizeof (Lisp_Object))
844 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
845 at the end and we need to compute the number of Lisp_Object fields (the
846 ones that the GC needs to trace). */
847 #define PSEUDOVECSIZE(type, nonlispfield) \
848 ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \
849 / sizeof (Lisp_Object))
851 /* A char-table is a kind of vectorlike, with contents are like a
852 vector but with a few other slots. For some purposes, it makes
853 sense to handle a char-table with type struct Lisp_Vector. An
854 element of a char table can be any Lisp objects, but if it is a sub
855 char-table, we treat it a table that contains information of a
856 specific range of characters. A sub char-table has the same
857 structure as a vector. A sub char table appears only in an element
858 of a char-table, and there's no way to access it directly from
859 Emacs Lisp program. */
861 /* This is the number of slots that every char table must have. This
862 counts the ordinary slots and the top, defalt, parent, and purpose
864 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
866 /* Return the number of "extra" slots in the char table CT. */
868 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
869 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
873 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
874 ({struct Lisp_Char_Table *_tbl = NULL; \
877 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
878 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
879 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
881 _val = _tbl->defalt; \
882 } while (NILP (_val) && ! NILP (_tbl->parent)); \
885 #else /* not __GNUC__ */
887 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
888 (! NILP (XCHAR_TABLE (CT)->ascii) \
889 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
890 ? XCHAR_TABLE (CT)->ascii \
891 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
892 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
893 : char_table_ref ((CT), (IDX))) \
894 : char_table_ref ((CT), (IDX)))
896 #endif /* not __GNUC__ */
898 /* Compute A OP B, using the unsigned comparison operator OP. A and B
899 should be integer expressions. This is not the same as
900 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
901 returns 1. For efficiency, prefer plain unsigned comparison if A
902 and B's sizes both fit (after integer promotion). */
903 #define UNSIGNED_CMP(a, op, b) \
904 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
905 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
906 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
908 /* Nonzero iff C is an ASCII character. */
909 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
911 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
912 characters. Do not check validity of CT. */
913 #define CHAR_TABLE_REF(CT, IDX) \
914 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
915 : char_table_ref ((CT), (IDX)))
917 /* Almost equivalent to Faref (CT, IDX). However, if the result is
918 not a character, return IDX.
920 For these characters, do not check validity of CT
921 and do not follow parent. */
922 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
923 char_table_translate (CT, IDX)
925 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
926 8-bit European characters. Do not check validity of CT. */
927 #define CHAR_TABLE_SET(CT, IDX, VAL) \
928 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
929 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
930 : char_table_set (CT, IDX, VAL))
932 #define CHARTAB_SIZE_BITS_0 6
933 #define CHARTAB_SIZE_BITS_1 4
934 #define CHARTAB_SIZE_BITS_2 5
935 #define CHARTAB_SIZE_BITS_3 7
937 extern const int chartab_size
[4];
939 struct Lisp_Sub_Char_Table
;
941 struct Lisp_Char_Table
943 /* HEADER.SIZE is the vector's size field, which also holds the
944 pseudovector type information. It holds the size, too.
945 The size counts the defalt, parent, purpose, ascii,
946 contents, and extras slots. */
947 struct vectorlike_header header
;
949 /* This holds a default value,
950 which is used whenever the value for a specific character is nil. */
953 /* This points to another char table, which we inherit from when the
954 value for a specific character is nil. The `defalt' slot takes
955 precedence over this. */
958 /* This is a symbol which says what kind of use this char-table is
962 /* The bottom sub char-table for characters of the range 0..127. It
963 is nil if none of ASCII character has a specific value. */
966 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
968 /* These hold additional data. It is a vector. */
969 Lisp_Object extras
[1];
972 struct Lisp_Sub_Char_Table
974 /* HEADER.SIZE is the vector's size field, which also holds the
975 pseudovector type information. It holds the size, too. */
976 struct vectorlike_header header
;
978 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
979 char-table of depth 1 contains 16 elements, and each element
980 covers 4096 (128*32) characters. A sub char-table of depth 2
981 contains 32 elements, and each element covers 128 characters. A
982 sub char-table of depth 3 contains 128 elements, and each element
983 is for one character. */
986 /* Minimum character covered by the sub char-table. */
987 Lisp_Object min_char
;
989 Lisp_Object contents
[1];
992 /* A boolvector is a kind of vectorlike, with contents are like a string. */
993 struct Lisp_Bool_Vector
995 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
996 just the subtype information. */
997 struct vectorlike_header header
;
998 /* This is the size in bits. */
1000 /* This contains the actual bits, packed into bytes. */
1001 unsigned char data
[1];
1004 /* This structure describes a built-in function.
1005 It is generated by the DEFUN macro only.
1006 defsubr makes it into a Lisp object.
1008 This type is treated in most respects as a pseudovector,
1009 but since we never dynamically allocate or free them,
1010 we don't need a struct vectorlike_header and its 'next' field. */
1016 Lisp_Object (*a0
) (void);
1017 Lisp_Object (*a1
) (Lisp_Object
);
1018 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1019 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1020 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1021 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1022 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1023 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1024 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1025 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1026 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1028 short min_args
, max_args
;
1029 const char *symbol_name
;
1030 const char *intspec
;
1035 /***********************************************************************
1037 ***********************************************************************/
1039 /* Interned state of a symbol. */
1041 enum symbol_interned
1043 SYMBOL_UNINTERNED
= 0,
1044 SYMBOL_INTERNED
= 1,
1045 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1048 enum symbol_redirect
1050 SYMBOL_PLAINVAL
= 4,
1051 SYMBOL_VARALIAS
= 1,
1052 SYMBOL_LOCALIZED
= 2,
1053 SYMBOL_FORWARDED
= 3
1058 unsigned gcmarkbit
: 1;
1060 /* Indicates where the value can be found:
1061 0 : it's a plain var, the value is in the `value' field.
1062 1 : it's a varalias, the value is really in the `alias' symbol.
1063 2 : it's a localized var, the value is in the `blv' object.
1064 3 : it's a forwarding variable, the value is in `forward'. */
1065 ENUM_BF (symbol_redirect
) redirect
: 3;
1067 /* Non-zero means symbol is constant, i.e. changing its value
1068 should signal an error. If the value is 3, then the var
1069 can be changed, but only by `defconst'. */
1070 unsigned constant
: 2;
1072 /* Interned state of the symbol. This is an enumerator from
1073 enum symbol_interned. */
1074 unsigned interned
: 2;
1076 /* Non-zero means that this variable has been explicitly declared
1077 special (with `defvar' etc), and shouldn't be lexically bound. */
1078 unsigned declared_special
: 1;
1080 /* The symbol's name, as a Lisp string.
1081 The name "xname" is used to intentionally break code referring to
1082 the old field "name" of type pointer to struct Lisp_String. */
1085 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1086 union is used depends on the `redirect' field above. */
1089 struct Lisp_Symbol
*alias
;
1090 struct Lisp_Buffer_Local_Value
*blv
;
1091 union Lisp_Fwd
*fwd
;
1094 /* Function value of the symbol or Qunbound if not fboundp. */
1095 Lisp_Object function
;
1097 /* The symbol's property list. */
1100 /* Next symbol in obarray bucket, if the symbol is interned. */
1101 struct Lisp_Symbol
*next
;
1104 /* Value is name of symbol. */
1106 #define SYMBOL_VAL(sym) \
1107 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1108 #define SYMBOL_ALIAS(sym) \
1109 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1110 #define SYMBOL_BLV(sym) \
1111 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1112 #define SYMBOL_FWD(sym) \
1113 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1114 #define SET_SYMBOL_VAL(sym, v) \
1115 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1116 #define SET_SYMBOL_ALIAS(sym, v) \
1117 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1118 #define SET_SYMBOL_BLV(sym, v) \
1119 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1120 #define SET_SYMBOL_FWD(sym, v) \
1121 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1123 #define SYMBOL_NAME(sym) \
1124 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1126 /* Value is non-zero if SYM is an interned symbol. */
1128 #define SYMBOL_INTERNED_P(sym) \
1129 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1131 /* Value is non-zero if SYM is interned in initial_obarray. */
1133 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1134 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1136 /* Value is non-zero if symbol is considered a constant, i.e. its
1137 value cannot be changed (there is an exception for keyword symbols,
1138 whose value can be set to the keyword symbol itself). */
1140 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1142 #define DEFSYM(sym, name) \
1143 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1146 /***********************************************************************
1148 ***********************************************************************/
1150 /* The structure of a Lisp hash table. */
1152 struct Lisp_Hash_Table
1154 /* This is for Lisp; the hash table code does not refer to it. */
1155 struct vectorlike_header header
;
1157 /* Function used to compare keys. */
1160 /* Nil if table is non-weak. Otherwise a symbol describing the
1161 weakness of the table. */
1164 /* When the table is resized, and this is an integer, compute the
1165 new size by adding this to the old size. If a float, compute the
1166 new size by multiplying the old size with this factor. */
1167 Lisp_Object rehash_size
;
1169 /* Resize hash table when number of entries/ table size is >= this
1171 Lisp_Object rehash_threshold
;
1173 /* Vector of hash codes.. If hash[I] is nil, this means that that
1174 entry I is unused. */
1177 /* Vector used to chain entries. If entry I is free, next[I] is the
1178 entry number of the next free item. If entry I is non-free,
1179 next[I] is the index of the next entry in the collision chain. */
1182 /* Index of first free entry in free list. */
1183 Lisp_Object next_free
;
1185 /* Bucket vector. A non-nil entry is the index of the first item in
1186 a collision chain. This vector's size can be larger than the
1187 hash table size to reduce collisions. */
1190 /* User-supplied hash function, or nil. */
1191 Lisp_Object user_hash_function
;
1193 /* User-supplied key comparison function, or nil. */
1194 Lisp_Object user_cmp_function
;
1196 /* Only the fields above are traced normally by the GC. The ones below
1197 `count' are special and are either ignored by the GC or traced in
1198 a special way (e.g. because of weakness). */
1200 /* Number of key/value entries in the table. */
1203 /* Vector of keys and values. The key of item I is found at index
1204 2 * I, the value is found at index 2 * I + 1.
1205 This is gc_marked specially if the table is weak. */
1206 Lisp_Object key_and_value
;
1208 /* Next weak hash table if this is a weak hash table. The head
1209 of the list is in weak_hash_tables. */
1210 struct Lisp_Hash_Table
*next_weak
;
1212 /* C function to compare two keys. */
1213 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1214 Lisp_Object
, EMACS_UINT
,
1215 Lisp_Object
, EMACS_UINT
);
1217 /* C function to compute hash code. */
1218 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1222 #define XHASH_TABLE(OBJ) \
1223 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1225 #define XSET_HASH_TABLE(VAR, PTR) \
1226 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1228 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1230 #define CHECK_HASH_TABLE(x) \
1231 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1233 /* Value is the key part of entry IDX in hash table H. */
1235 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1237 /* Value is the value part of entry IDX in hash table H. */
1239 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1241 /* Value is the index of the next entry following the one at IDX
1244 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1246 /* Value is the hash code computed for entry IDX in hash table H. */
1248 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1250 /* Value is the index of the element in hash table H that is the
1251 start of the collision list at index IDX in the index vector of H. */
1253 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1255 /* Value is the size of hash table H. */
1257 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1259 /* Default size for hash tables if not specified. */
1261 #define DEFAULT_HASH_SIZE 65
1263 /* Default threshold specifying when to resize a hash table. The
1264 value gives the ratio of current entries in the hash table and the
1265 size of the hash table. */
1267 #define DEFAULT_REHASH_THRESHOLD 0.8
1269 /* Default factor by which to increase the size of a hash table. */
1271 #define DEFAULT_REHASH_SIZE 1.5
1274 /* These structures are used for various misc types. */
1276 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1278 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1279 unsigned gcmarkbit
: 1;
1285 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1286 unsigned gcmarkbit
: 1;
1288 /* This flag is temporarily used in the functions
1289 decode/encode_coding_object to record that the marker position
1290 must be adjusted after the conversion. */
1291 unsigned int need_adjustment
: 1;
1292 /* 1 means normal insertion at the marker's position
1293 leaves the marker after the inserted text. */
1294 unsigned int insertion_type
: 1;
1295 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1296 Note: a chain of markers can contain markers pointing into different
1297 buffers (the chain is per buffer_text rather than per buffer, so it's
1298 shared between indirect buffers). */
1299 /* This is used for (other than NULL-checking):
1301 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1302 - unchain_marker: to find the list from which to unchain.
1303 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1305 struct buffer
*buffer
;
1307 /* The remaining fields are meaningless in a marker that
1308 does not point anywhere. */
1310 /* For markers that point somewhere,
1311 this is used to chain of all the markers in a given buffer. */
1312 /* We could remove it and use an array in buffer_text instead.
1313 That would also allow to preserve it ordered. */
1314 struct Lisp_Marker
*next
;
1315 /* This is the char position where the marker points. */
1317 /* This is the byte position.
1318 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1319 used to implement the functionality of markers, but rather to (ab)use
1320 markers as a cache for char<->byte mappings). */
1324 /* Forwarding pointer to an int variable.
1325 This is allowed only in the value cell of a symbol,
1326 and it means that the symbol's value really lives in the
1327 specified int variable. */
1330 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1334 /* Boolean forwarding pointer to an int variable.
1335 This is like Lisp_Intfwd except that the ostensible
1336 "value" of the symbol is t if the int variable is nonzero,
1337 nil if it is zero. */
1340 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1344 /* Forwarding pointer to a Lisp_Object variable.
1345 This is allowed only in the value cell of a symbol,
1346 and it means that the symbol's value really lives in the
1347 specified variable. */
1350 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1351 Lisp_Object
*objvar
;
1354 /* Like Lisp_Objfwd except that value lives in a slot in the
1355 current buffer. Value is byte index of slot within buffer. */
1356 struct Lisp_Buffer_Objfwd
1358 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1360 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1363 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1364 the symbol has buffer-local or frame-local bindings. (Exception:
1365 some buffer-local variables are built-in, with their values stored
1366 in the buffer structure itself. They are handled differently,
1367 using struct Lisp_Buffer_Objfwd.)
1369 The `realvalue' slot holds the variable's current value, or a
1370 forwarding pointer to where that value is kept. This value is the
1371 one that corresponds to the loaded binding. To read or set the
1372 variable, you must first make sure the right binding is loaded;
1373 then you can access the value in (or through) `realvalue'.
1375 `buffer' and `frame' are the buffer and frame for which the loaded
1376 binding was found. If those have changed, to make sure the right
1377 binding is loaded it is necessary to find which binding goes with
1378 the current buffer and selected frame, then load it. To load it,
1379 first unload the previous binding, then copy the value of the new
1380 binding into `realvalue' (or through it). Also update
1381 LOADED-BINDING to point to the newly loaded binding.
1383 `local_if_set' indicates that merely setting the variable creates a
1384 local binding for the current buffer. Otherwise the latter, setting
1385 the variable does not do that; only make-local-variable does that. */
1387 struct Lisp_Buffer_Local_Value
1389 /* 1 means that merely setting the variable creates a local
1390 binding for the current buffer */
1391 unsigned int local_if_set
: 1;
1392 /* 1 means this variable can have frame-local bindings, otherwise, it is
1393 can have buffer-local bindings. The two cannot be combined. */
1394 unsigned int frame_local
: 1;
1395 /* 1 means that the binding now loaded was found.
1396 Presumably equivalent to (defcell!=valcell) */
1397 unsigned int found
: 1;
1398 /* If non-NULL, a forwarding to the C var where it should also be set. */
1399 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1400 /* The buffer or frame for which the loaded binding was found. */
1402 /* A cons cell that holds the default value. It has the form
1403 (SYMBOL . DEFAULT-VALUE). */
1404 Lisp_Object defcell
;
1405 /* The cons cell from `where's parameter alist.
1406 It always has the form (SYMBOL . VALUE)
1407 Note that if `forward' is non-nil, VALUE may be out of date.
1408 Also if the currently loaded binding is the default binding, then
1409 this is `eq'ual to defcell. */
1410 Lisp_Object valcell
;
1413 #define BLV_FOUND(blv) \
1414 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1415 #define SET_BLV_FOUND(blv, v) \
1416 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1418 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1419 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1421 /* START and END are markers in the overlay's buffer, and
1422 PLIST is the overlay's property list. */
1424 /* An overlay's real data content is:
1427 - insertion type of both ends
1428 - start & start_byte
1430 - next (singly linked list of overlays).
1431 - start_next and end_next (singly linked list of markers).
1432 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1435 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1436 unsigned gcmarkbit
: 1;
1438 struct Lisp_Overlay
*next
;
1439 Lisp_Object start
, end
, plist
;
1442 /* Like Lisp_Objfwd except that value lives in a slot in the
1444 struct Lisp_Kboard_Objfwd
1446 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1450 /* Hold a C pointer for later use.
1451 This type of object is used in the arg to record_unwind_protect. */
1452 struct Lisp_Save_Value
1454 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1455 unsigned gcmarkbit
: 1;
1457 /* If DOGC is set, POINTER is the address of a memory
1458 area containing INTEGER potential Lisp_Objects. */
1459 unsigned int dogc
: 1;
1465 /* A miscellaneous object, when it's on the free list. */
1468 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1469 unsigned gcmarkbit
: 1;
1471 union Lisp_Misc
*chain
;
1474 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1475 It uses one of these struct subtypes to get the type field. */
1479 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1480 struct Lisp_Free u_free
;
1481 struct Lisp_Marker u_marker
;
1482 struct Lisp_Overlay u_overlay
;
1483 struct Lisp_Save_Value u_save_value
;
1488 struct Lisp_Intfwd u_intfwd
;
1489 struct Lisp_Boolfwd u_boolfwd
;
1490 struct Lisp_Objfwd u_objfwd
;
1491 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1492 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1495 /* Lisp floating point type */
1500 #ifdef HIDE_LISP_IMPLEMENTATION
1505 struct Lisp_Float
*chain
;
1509 #ifdef HIDE_LISP_IMPLEMENTATION
1510 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1512 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1513 /* This should be used only in alloc.c, which always disables
1514 HIDE_LISP_IMPLEMENTATION. */
1515 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1518 /* A character, declared with the following typedef, is a member
1519 of some character set associated with the current buffer. */
1520 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1522 typedef unsigned char UCHAR
;
1525 /* Meanings of slots in a Lisp_Compiled: */
1527 #define COMPILED_ARGLIST 0
1528 #define COMPILED_BYTECODE 1
1529 #define COMPILED_CONSTANTS 2
1530 #define COMPILED_STACK_DEPTH 3
1531 #define COMPILED_DOC_STRING 4
1532 #define COMPILED_INTERACTIVE 5
1534 /* Flag bits in a character. These also get used in termhooks.h.
1535 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1536 (MUlti-Lingual Emacs) might need 22 bits for the character value
1537 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1538 #define CHAR_ALT (0x0400000)
1539 #define CHAR_SUPER (0x0800000)
1540 #define CHAR_HYPER (0x1000000)
1541 #define CHAR_SHIFT (0x2000000)
1542 #define CHAR_CTL (0x4000000)
1543 #define CHAR_META (0x8000000)
1545 #define CHAR_MODIFIER_MASK \
1546 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1549 /* Actually, the current Emacs uses 22 bits for the character value
1551 #define CHARACTERBITS 22
1554 /* The glyph datatype, used to represent characters on the display.
1555 It consists of a char code and a face id. */
1562 /* Return a glyph's character code. */
1563 #define GLYPH_CHAR(glyph) ((glyph).ch)
1565 /* Return a glyph's face ID. */
1566 #define GLYPH_FACE(glyph) ((glyph).face_id)
1568 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1569 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1570 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1572 /* Return 1 if GLYPH contains valid character code. */
1573 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1576 /* Glyph Code from a display vector may either be an integer which
1577 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1578 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1580 #define GLYPH_CODE_P(gc) \
1582 ? (CHARACTERP (XCAR (gc)) \
1583 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1584 : (RANGED_INTEGERP \
1586 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1587 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1588 : TYPE_MAXIMUM (EMACS_INT)))))
1590 /* The following are valid only if GLYPH_CODE_P (gc). */
1592 #define GLYPH_CODE_CHAR(gc) \
1593 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1595 #define GLYPH_CODE_FACE(gc) \
1596 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1598 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1602 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1604 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1605 (XINT (gc) >> CHARACTERBITS)); \
1609 /* The ID of the mode line highlighting face. */
1610 #define GLYPH_MODE_LINE_FACE 1
1612 /* Structure to hold mouse highlight data. This is here because other
1613 header files need it for defining struct x_output etc. */
1615 /* These variables describe the range of text currently shown in its
1616 mouse-face, together with the window they apply to. As long as
1617 the mouse stays within this range, we need not redraw anything on
1618 its account. Rows and columns are glyph matrix positions in
1619 MOUSE_FACE_WINDOW. */
1620 int mouse_face_beg_row
, mouse_face_beg_col
;
1621 int mouse_face_beg_x
, mouse_face_beg_y
;
1622 int mouse_face_end_row
, mouse_face_end_col
;
1623 int mouse_face_end_x
, mouse_face_end_y
;
1624 int mouse_face_past_end
;
1625 Lisp_Object mouse_face_window
;
1626 int mouse_face_face_id
;
1627 Lisp_Object mouse_face_overlay
;
1629 /* 1 if a mouse motion event came and we didn't handle it right away because
1630 gc was in progress. */
1631 int mouse_face_deferred_gc
;
1633 /* FRAME and X, Y position of mouse when last checked for
1634 highlighting. X and Y can be negative or out of range for the frame. */
1635 struct frame
*mouse_face_mouse_frame
;
1636 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1638 /* Nonzero means defer mouse-motion highlighting. */
1639 int mouse_face_defer
;
1641 /* Nonzero means that the mouse highlight should not be shown. */
1642 int mouse_face_hidden
;
1644 int mouse_face_image_state
;
1647 /* Data type checking */
1649 #define NILP(x) EQ (x, Qnil)
1651 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1652 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1654 #define RANGED_INTEGERP(lo, x, hi) \
1655 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1656 #define TYPE_RANGED_INTEGERP(type, x) \
1657 (TYPE_SIGNED (type) \
1658 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1659 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1661 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1662 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1663 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1664 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1665 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1666 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1668 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1669 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1670 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1671 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1672 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1674 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1675 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1676 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1677 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1678 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1680 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1681 vectorlike_header * avoids aliasing issues. */
1682 #define PSEUDOVECTORP(x, code) \
1683 TYPED_PSEUDOVECTORP(x, vectorlike_header, code)
1685 /* True if object X, with internal type struct T *, is a pseudovector whose
1687 #define TYPED_PSEUDOVECTORP(x, t, code) \
1689 && (((((struct t *) XUNTAG (x, Lisp_Vectorlike))->size \
1690 & (PSEUDOVECTOR_FLAG | (code)))) \
1691 == (PSEUDOVECTOR_FLAG | (code))))
1693 /* Test for specific pseudovector types. */
1694 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1695 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1696 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1697 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1698 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1699 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1700 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1701 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1702 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1703 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1704 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1705 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1707 /* Test for image (image . spec) */
1708 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1713 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1715 #define CHECK_LIST(x) \
1716 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1718 #define CHECK_LIST_CONS(x, y) \
1719 CHECK_TYPE (CONSP (x), Qlistp, y)
1721 #define CHECK_LIST_END(x, y) \
1722 CHECK_TYPE (NILP (x), Qlistp, y)
1724 #define CHECK_STRING(x) \
1725 CHECK_TYPE (STRINGP (x), Qstringp, x)
1727 #define CHECK_STRING_CAR(x) \
1728 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1730 #define CHECK_CONS(x) \
1731 CHECK_TYPE (CONSP (x), Qconsp, x)
1733 #define CHECK_SYMBOL(x) \
1734 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1736 #define CHECK_CHAR_TABLE(x) \
1737 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1739 #define CHECK_VECTOR(x) \
1740 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1742 #define CHECK_VECTOR_OR_STRING(x) \
1743 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1745 #define CHECK_ARRAY(x, Qxxxp) \
1746 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1748 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1749 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1751 #define CHECK_BUFFER(x) \
1752 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1754 #define CHECK_WINDOW(x) \
1755 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1757 #define CHECK_WINDOW_CONFIGURATION(x) \
1758 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1760 /* This macro rejects windows on the interior of the window tree as
1761 "dead", which is what we want; this is an argument-checking macro, and
1762 the user should never get access to interior windows.
1764 A window of any sort, leaf or interior, is dead if the buffer,
1765 vchild, and hchild members are all nil. */
1767 #define CHECK_LIVE_WINDOW(x) \
1768 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1770 #define CHECK_PROCESS(x) \
1771 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1773 #define CHECK_SUBR(x) \
1774 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1776 #define CHECK_NUMBER(x) \
1777 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1779 #define CHECK_NATNUM(x) \
1780 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1782 #define CHECK_RANGED_INTEGER(lo, x, hi) \
1785 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1786 args_out_of_range_3 \
1788 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1789 ? MOST_NEGATIVE_FIXNUM \
1791 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1793 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1795 if (TYPE_SIGNED (type)) \
1796 CHECK_RANGED_INTEGER (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)); \
1798 CHECK_RANGED_INTEGER (0, x, TYPE_MAXIMUM (type)); \
1801 #define CHECK_MARKER(x) \
1802 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1804 #define CHECK_NUMBER_COERCE_MARKER(x) \
1805 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1806 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1808 #define XFLOATINT(n) extract_float((n))
1810 #define CHECK_FLOAT(x) \
1811 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1813 #define CHECK_NUMBER_OR_FLOAT(x) \
1814 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1816 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1817 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1818 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1820 #define CHECK_OVERLAY(x) \
1821 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1823 /* Since we can't assign directly to the CAR or CDR fields of a cons
1824 cell, use these when checking that those fields contain numbers. */
1825 #define CHECK_NUMBER_CAR(x) \
1827 Lisp_Object tmp = XCAR (x); \
1828 CHECK_NUMBER (tmp); \
1829 XSETCAR ((x), tmp); \
1832 #define CHECK_NUMBER_CDR(x) \
1834 Lisp_Object tmp = XCDR (x); \
1835 CHECK_NUMBER (tmp); \
1836 XSETCDR ((x), tmp); \
1839 #define CHECK_NATNUM_CAR(x) \
1841 Lisp_Object tmp = XCAR (x); \
1842 CHECK_NATNUM (tmp); \
1843 XSETCAR ((x), tmp); \
1846 #define CHECK_NATNUM_CDR(x) \
1848 Lisp_Object tmp = XCDR (x); \
1849 CHECK_NATNUM (tmp); \
1850 XSETCDR ((x), tmp); \
1853 /* Define a built-in function for calling from Lisp.
1854 `lname' should be the name to give the function in Lisp,
1855 as a null-terminated C string.
1856 `fnname' should be the name of the function in C.
1857 By convention, it starts with F.
1858 `sname' should be the name for the C constant structure
1859 that records information on this function for internal use.
1860 By convention, it should be the same as `fnname' but with S instead of F.
1861 It's too bad that C macros can't compute this from `fnname'.
1862 `minargs' should be a number, the minimum number of arguments allowed.
1863 `maxargs' should be a number, the maximum number of arguments allowed,
1864 or else MANY or UNEVALLED.
1865 MANY means pass a vector of evaluated arguments,
1866 in the form of an integer number-of-arguments
1867 followed by the address of a vector of Lisp_Objects
1868 which contains the argument values.
1869 UNEVALLED means pass the list of unevaluated arguments
1870 `intspec' says how interactive arguments are to be fetched.
1871 If the string starts with a `(', `intspec' is evaluated and the resulting
1872 list is the list of arguments.
1873 If it's a string that doesn't start with `(', the value should follow
1874 the one of the doc string for `interactive'.
1875 A null string means call interactively with no arguments.
1876 `doc' is documentation for the user. */
1878 /* This version of DEFUN declares a function prototype with the right
1879 arguments, so we can catch errors with maxargs at compile-time. */
1881 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1882 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1883 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1884 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1885 { (Lisp_Object (__cdecl *)(void))fnname }, \
1886 minargs, maxargs, lname, intspec, 0}; \
1888 #else /* not _MSC_VER */
1889 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1890 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1891 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1893 { .a ## maxargs = fnname }, \
1894 minargs, maxargs, lname, intspec, 0}; \
1898 /* Note that the weird token-substitution semantics of ANSI C makes
1899 this work for MANY and UNEVALLED. */
1900 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1901 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1902 #define DEFUN_ARGS_0 (void)
1903 #define DEFUN_ARGS_1 (Lisp_Object)
1904 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1905 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1906 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1907 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1909 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1910 Lisp_Object, Lisp_Object)
1911 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1912 Lisp_Object, Lisp_Object, Lisp_Object)
1913 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1914 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1916 /* Non-zero if OBJ is a Lisp function. */
1917 #define FUNCTIONP(OBJ) \
1918 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1919 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1920 || COMPILEDP (OBJ) \
1924 is how we define the symbol for function `name' at start-up time. */
1925 extern void defsubr (struct Lisp_Subr
*);
1928 #define UNEVALLED -1
1930 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1931 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1932 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1933 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1934 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1936 /* Macros we use to define forwarded Lisp variables.
1937 These are used in the syms_of_FILENAME functions.
1939 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1940 lisp variable is actually a field in `struct emacs_globals'. The
1941 field's name begins with "f_", which is a convention enforced by
1942 these macros. Each such global has a corresponding #define in
1943 globals.h; the plain name should be used in the code.
1945 E.g., the global "cons_cells_consed" is declared as "int
1946 f_cons_cells_consed" in globals.h, but there is a define:
1948 #define cons_cells_consed globals.f_cons_cells_consed
1950 All C code uses the `cons_cells_consed' name. This is all done
1951 this way to support indirection for multi-threaded Emacs. */
1953 #define DEFVAR_LISP(lname, vname, doc) \
1955 static struct Lisp_Objfwd o_fwd; \
1956 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1958 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1960 static struct Lisp_Objfwd o_fwd; \
1961 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1963 #define DEFVAR_BOOL(lname, vname, doc) \
1965 static struct Lisp_Boolfwd b_fwd; \
1966 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1968 #define DEFVAR_INT(lname, vname, doc) \
1970 static struct Lisp_Intfwd i_fwd; \
1971 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1974 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1976 static struct Lisp_Objfwd o_fwd; \
1977 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1980 #define DEFVAR_KBOARD(lname, vname, doc) \
1982 static struct Lisp_Kboard_Objfwd ko_fwd; \
1983 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1988 /* Structure for recording Lisp call stack for backtrace purposes. */
1990 /* The special binding stack holds the outer values of variables while
1991 they are bound by a function application or a let form, stores the
1992 code to be executed for Lisp unwind-protect forms, and stores the C
1993 functions to be called for record_unwind_protect.
1995 If func is non-zero, undoing this binding applies func to old_value;
1996 This implements record_unwind_protect.
1998 Otherwise, the element is a variable binding.
2000 If the symbol field is a symbol, it is an ordinary variable binding.
2002 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2003 which means having bound a local value while CURRENT-BUFFER was active.
2004 If WHERE is nil this means we saw the default value when binding SYMBOL.
2005 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2006 value. Other values of WHERE mean an internal error. */
2008 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2012 Lisp_Object symbol
, old_value
;
2013 specbinding_func func
;
2014 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
2017 extern struct specbinding
*specpdl
;
2018 extern struct specbinding
*specpdl_ptr
;
2019 extern ptrdiff_t specpdl_size
;
2021 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2023 /* Everything needed to describe an active condition case. */
2026 /* The handler clauses and variable from the condition-case form. */
2027 /* For a handler set up in Lisp code, this is always a list.
2028 For an internal handler set up by internal_condition_case*,
2029 this can instead be the symbol t or `error'.
2030 t: handle all conditions.
2031 error: handle all conditions, and errors can run the debugger
2032 or display a backtrace. */
2033 Lisp_Object handler
;
2035 /* Fsignal stores here the condition-case clause that applies,
2036 and Fcondition_case thus knows which clause to run. */
2037 Lisp_Object chosen_clause
;
2039 /* Used to effect the longjump out to the handler. */
2040 struct catchtag
*tag
;
2042 /* The next enclosing handler. */
2043 struct handler
*next
;
2046 /* This structure helps implement the `catch' and `throw' control
2047 structure. A struct catchtag contains all the information needed
2048 to restore the state of the interpreter after a non-local jump.
2050 Handlers for error conditions (represented by `struct handler'
2051 structures) just point to a catch tag to do the cleanup required
2054 catchtag structures are chained together in the C calling stack;
2055 the `next' member points to the next outer catchtag.
2057 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2058 member is TAG, and then unbinds to it. The `val' member is used to
2059 hold VAL while the stack is unwound; `val' is returned as the value
2062 All the other members are concerned with restoring the interpreter
2069 struct catchtag
*next
;
2070 struct gcpro
*gcpro
;
2072 struct backtrace
*backlist
;
2073 struct handler
*handlerlist
;
2074 EMACS_INT lisp_eval_depth
;
2076 int poll_suppress_count
;
2077 int interrupt_input_blocked
;
2078 struct byte_stack
*byte_stack
;
2081 extern Lisp_Object memory_signal_data
;
2083 /* An address near the bottom of the stack.
2084 Tells GC how to save a copy of the stack. */
2085 extern char *stack_bottom
;
2087 /* Check quit-flag and quit if it is non-nil.
2088 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2089 So the program needs to do QUIT at times when it is safe to quit.
2090 Every loop that might run for a long time or might not exit
2091 ought to do QUIT at least once, at a safe place.
2092 Unless that is impossible, of course.
2093 But it is very desirable to avoid creating loops where QUIT is impossible.
2095 Exception: if you set immediate_quit to nonzero,
2096 then the handler that responds to the C-g does the quit itself.
2097 This is a good thing to do around a loop that has no side effects
2098 and (in particular) cannot call arbitrary Lisp code.
2100 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2101 a request to exit Emacs when it is safe to do. */
2104 extern void process_pending_signals (void);
2105 extern int pending_signals
;
2106 #define ELSE_PENDING_SIGNALS \
2107 else if (pending_signals) \
2108 process_pending_signals ();
2109 #else /* not SYNC_INPUT */
2110 #define ELSE_PENDING_SIGNALS
2111 #endif /* not SYNC_INPUT */
2113 extern void process_quit_flag (void);
2116 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2117 process_quit_flag (); \
2118 ELSE_PENDING_SIGNALS \
2122 /* Nonzero if ought to quit now. */
2124 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2126 extern Lisp_Object Vascii_downcase_table
;
2127 extern Lisp_Object Vascii_canon_table
;
2129 /* Number of bytes of structure consed since last GC. */
2131 extern EMACS_INT consing_since_gc
;
2133 extern EMACS_INT gc_relative_threshold
;
2135 extern EMACS_INT memory_full_cons_threshold
;
2137 /* Structure for recording stack slots that need marking. */
2139 /* This is a chain of structures, each of which points at a Lisp_Object
2140 variable whose value should be marked in garbage collection.
2141 Normally every link of the chain is an automatic variable of a function,
2142 and its `val' points to some argument or local variable of the function.
2143 On exit to the function, the chain is set back to the value it had on entry.
2144 This way, no link remains in the chain when the stack frame containing the
2147 Every function that can call Feval must protect in this fashion all
2148 Lisp_Object variables whose contents will be used again. */
2150 extern struct gcpro
*gcprolist
;
2156 /* Address of first protected variable. */
2157 volatile Lisp_Object
*var
;
2159 /* Number of consecutive protected variables. */
2167 /* Values of GC_MARK_STACK during compilation:
2169 0 Use GCPRO as before
2170 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2171 2 Mark the stack, and check that everything GCPRO'd is
2173 3 Mark using GCPRO's, mark stack last, and count how many
2174 dead objects are kept alive. */
2177 #define GC_USE_GCPROS_AS_BEFORE 0
2178 #define GC_MAKE_GCPROS_NOOPS 1
2179 #define GC_MARK_STACK_CHECK_GCPROS 2
2180 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2182 #ifndef GC_MARK_STACK
2183 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2186 /* Whether we do the stack marking manually. */
2187 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2188 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2191 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2193 /* Do something silly with gcproN vars just so gcc shuts up. */
2194 /* You get warnings from MIPSPro... */
2196 #define GCPRO1(varname) ((void) gcpro1)
2197 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2198 #define GCPRO3(varname1, varname2, varname3) \
2199 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2200 #define GCPRO4(varname1, varname2, varname3, varname4) \
2201 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2202 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2203 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2204 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2205 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2207 #define UNGCPRO ((void) 0)
2209 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2213 #define GCPRO1(varname) \
2214 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2215 gcprolist = &gcpro1; }
2217 #define GCPRO2(varname1, varname2) \
2218 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2219 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2220 gcprolist = &gcpro2; }
2222 #define GCPRO3(varname1, varname2, varname3) \
2223 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2224 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2225 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2226 gcprolist = &gcpro3; }
2228 #define GCPRO4(varname1, varname2, varname3, varname4) \
2229 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2230 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2231 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2232 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2233 gcprolist = &gcpro4; }
2235 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2236 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2237 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2238 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2239 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2240 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2241 gcprolist = &gcpro5; }
2243 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2244 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2245 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2246 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2247 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2248 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2249 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2250 gcprolist = &gcpro6; }
2252 #define UNGCPRO (gcprolist = gcpro1.next)
2256 extern int gcpro_level
;
2258 #define GCPRO1(varname) \
2259 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2260 gcpro1.level = gcpro_level++; \
2261 gcprolist = &gcpro1; }
2263 #define GCPRO2(varname1, varname2) \
2264 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2265 gcpro1.level = gcpro_level; \
2266 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2267 gcpro2.level = gcpro_level++; \
2268 gcprolist = &gcpro2; }
2270 #define GCPRO3(varname1, varname2, varname3) \
2271 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2272 gcpro1.level = gcpro_level; \
2273 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2274 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2275 gcpro3.level = gcpro_level++; \
2276 gcprolist = &gcpro3; }
2278 #define GCPRO4(varname1, varname2, varname3, varname4) \
2279 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2280 gcpro1.level = gcpro_level; \
2281 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2282 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2283 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2284 gcpro4.level = gcpro_level++; \
2285 gcprolist = &gcpro4; }
2287 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2288 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2289 gcpro1.level = gcpro_level; \
2290 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2291 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2292 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2293 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2294 gcpro5.level = gcpro_level++; \
2295 gcprolist = &gcpro5; }
2297 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
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 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2304 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2305 gcpro6.level = gcpro_level++; \
2306 gcprolist = &gcpro6; }
2309 ((--gcpro_level != gcpro1.level) \
2311 : ((gcprolist = gcpro1.next), 0))
2313 #endif /* DEBUG_GCPRO */
2314 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2317 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2318 #define RETURN_UNGCPRO(expr) \
2321 Lisp_Object ret_ungc_val; \
2322 ret_ungc_val = (expr); \
2324 return ret_ungc_val; \
2328 /* Call staticpro (&var) to protect static variable `var'. */
2330 void staticpro (Lisp_Object
*);
2332 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2333 meaning as in the DEFUN macro, and is used to construct a prototype. */
2334 /* We can use the same trick as in the DEFUN macro to generate the
2335 appropriate prototype. */
2336 #define EXFUN(fnname, maxargs) \
2337 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2339 /* Forward declarations for prototypes. */
2343 /* Defined in data.c. */
2344 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2345 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2346 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2347 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2348 extern Lisp_Object Qinvalid_read_syntax
;
2349 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2350 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2351 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2352 extern Lisp_Object Qtext_read_only
;
2353 extern Lisp_Object Qinteractive_form
;
2354 extern Lisp_Object Qcircular_list
;
2355 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2356 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2357 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2358 extern Lisp_Object Qbuffer_or_string_p
;
2359 extern Lisp_Object Qfboundp
;
2360 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2362 extern Lisp_Object Qcdr
;
2364 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2365 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2367 extern Lisp_Object Qfloatp
;
2368 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2370 extern Lisp_Object Qinteger
;
2372 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2374 EXFUN (Finteractive_form
, 1);
2375 EXFUN (Fbyteorder
, 0);
2377 /* Defined in frame.c */
2378 extern Lisp_Object Qframep
;
2380 /* Defined in data.c */
2382 EXFUN (Fcar_safe
, 1);
2384 EXFUN (Fcdr_safe
, 1);
2388 EXFUN (Ffboundp
, 1);
2389 EXFUN (Fsymbol_function
, 1);
2390 EXFUN (Fsymbol_name
, 1);
2391 extern Lisp_Object
indirect_function (Lisp_Object
);
2392 EXFUN (Findirect_function
, 2);
2394 EXFUN (Fsymbol_value
, 1);
2395 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2397 EXFUN (Fdefault_value
, 1);
2398 EXFUN (Fset_default
, 2);
2399 EXFUN (Fdefault_boundp
, 1);
2400 EXFUN (Fmake_local_variable
, 1);
2401 EXFUN (Flocal_variable_p
, 2);
2406 EXFUN (Fstring_to_number
, 2);
2407 EXFUN (Fnumber_to_string
, 1);
2413 EXFUN (Fplus
, MANY
);
2414 EXFUN (Fminus
, MANY
);
2415 EXFUN (Ftimes
, MANY
);
2423 EXFUN (Fmake_variable_buffer_local
, 1);
2425 /* Convert the integer I to an Emacs representation, either the integer
2426 itself, or a cons of two or three integers, or if all else fails a float.
2427 I should not have side effects. */
2428 #define INTEGER_TO_CONS(i) \
2429 (! FIXNUM_OVERFLOW_P (i) \
2431 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2432 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2433 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2434 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2435 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2436 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2437 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2438 ? Fcons (make_number ((i) >> 16 >> 24), \
2439 Fcons (make_number ((i) >> 16 & 0xffffff), \
2440 make_number ((i) & 0xffff))) \
2443 /* Convert the Emacs representation CONS back to an integer of type
2444 TYPE, storing the result the variable VAR. Signal an error if CONS
2445 is not a valid representation or is out of range for TYPE. */
2446 #define CONS_TO_INTEGER(cons, type, var) \
2447 (TYPE_SIGNED (type) \
2448 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2449 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2450 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2451 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2453 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2454 extern void args_out_of_range (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2455 extern void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2456 Lisp_Object
) NO_RETURN
;
2457 extern Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2458 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2459 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2460 extern void syms_of_data (void);
2461 extern void init_data (void);
2462 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2464 /* Defined in cmds.c */
2465 EXFUN (Fend_of_line
, 1);
2466 EXFUN (Fforward_char
, 1);
2467 EXFUN (Fforward_line
, 1);
2468 extern void syms_of_cmds (void);
2469 extern void keys_of_cmds (void);
2471 /* Defined in coding.c */
2472 extern Lisp_Object Qcharset
;
2473 EXFUN (Fcoding_system_p
, 1);
2474 EXFUN (Fcoding_system_base
, 1);
2475 EXFUN (Fcoding_system_eol_type
, 1);
2476 EXFUN (Fcheck_coding_system
, 1);
2477 EXFUN (Fread_coding_system
, 2);
2478 EXFUN (Fread_non_nil_coding_system
, 1);
2479 EXFUN (Ffind_operation_coding_system
, MANY
);
2480 EXFUN (Fdecode_coding_string
, 4);
2481 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2482 ptrdiff_t, int, int, Lisp_Object
);
2483 extern void init_coding (void);
2484 extern void init_coding_once (void);
2485 extern void syms_of_coding (void);
2487 /* Defined in character.c */
2488 EXFUN (Fchar_width
, 1);
2489 EXFUN (Fstring
, MANY
);
2490 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2491 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2492 extern int multibyte_char_to_unibyte (int);
2493 extern int multibyte_char_to_unibyte_safe (int);
2494 extern void init_character_once (void);
2495 extern void syms_of_character (void);
2497 /* Defined in charset.c */
2498 extern void init_charset (void);
2499 extern void init_charset_once (void);
2500 extern void syms_of_charset (void);
2501 /* Structure forward declarations. */
2504 /* Defined in composite.c */
2505 extern void syms_of_composite (void);
2507 /* Defined in syntax.c */
2508 EXFUN (Fforward_word
, 1);
2509 EXFUN (Fskip_chars_forward
, 2);
2510 EXFUN (Fskip_chars_backward
, 2);
2511 extern void init_syntax_once (void);
2512 extern void syms_of_syntax (void);
2514 /* Defined in fns.c */
2515 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2516 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2517 extern EMACS_INT
next_almost_prime (EMACS_INT
);
2518 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2519 extern void sweep_weak_hash_tables (void);
2520 extern Lisp_Object Qcursor_in_echo_area
;
2521 extern Lisp_Object Qstring_lessp
;
2522 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2523 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2524 EMACS_UINT
sxhash (Lisp_Object
, int);
2525 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2526 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2528 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2529 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2531 void init_weak_hash_tables (void);
2532 extern void init_fns (void);
2533 EXFUN (Fmake_hash_table
, MANY
);
2534 EXFUN (Fgethash
, 3);
2535 EXFUN (Fputhash
, 3);
2536 EXFUN (Fremhash
, 2);
2538 EXFUN (Fidentity
, 1);
2540 EXFUN (Fappend
, MANY
);
2541 EXFUN (Fconcat
, MANY
);
2542 EXFUN (Fvconcat
, MANY
);
2543 EXFUN (Fcopy_sequence
, 1);
2544 EXFUN (Fstring_make_multibyte
, 1);
2545 EXFUN (Fstring_make_unibyte
, 1);
2546 EXFUN (Fstring_as_multibyte
, 1);
2547 EXFUN (Fstring_as_unibyte
, 1);
2548 EXFUN (Fstring_to_multibyte
, 1);
2549 EXFUN (Fsubstring
, 3);
2550 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2551 ptrdiff_t, ptrdiff_t);
2563 EXFUN (Freverse
, 1);
2564 EXFUN (Fnreverse
, 1);
2568 EXFUN (Fnconc
, MANY
);
2570 EXFUN (Fmapconcat
, 3);
2571 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2572 EXFUN (Fprovide
, 2);
2573 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2574 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2575 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2576 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2577 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2578 extern void clear_string_char_byte_cache (void);
2579 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2580 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2581 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2582 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2583 EXFUN (Fcopy_alist
, 1);
2584 EXFUN (Fplist_get
, 2);
2585 EXFUN (Fplist_put
, 3);
2586 EXFUN (Fplist_member
, 2);
2588 EXFUN (Fstring_equal
, 2);
2589 EXFUN (Fcompare_strings
, 7);
2590 EXFUN (Fstring_lessp
, 2);
2591 extern void syms_of_fns (void);
2593 /* Defined in floatfns.c */
2594 extern double extract_float (Lisp_Object
);
2596 EXFUN (Ftruncate
, 2);
2597 extern void init_floatfns (void);
2598 extern void syms_of_floatfns (void);
2599 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2601 /* Defined in fringe.c */
2602 extern void syms_of_fringe (void);
2603 extern void init_fringe (void);
2604 #ifdef HAVE_WINDOW_SYSTEM
2605 extern void mark_fringe_data (void);
2606 extern void init_fringe_once (void);
2607 #endif /* HAVE_WINDOW_SYSTEM */
2609 /* Defined in image.c */
2610 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2611 extern Lisp_Object QCconversion
;
2612 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2613 extern void syms_of_image (void);
2614 extern void init_image (void);
2616 /* Defined in insdel.c */
2617 extern Lisp_Object Qinhibit_modification_hooks
;
2618 extern void move_gap (ptrdiff_t);
2619 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2620 extern void buffer_overflow (void) NO_RETURN
;
2621 extern void make_gap (ptrdiff_t);
2622 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2623 ptrdiff_t, int, int);
2624 extern int count_combining_before (const unsigned char *,
2625 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2626 extern int count_combining_after (const unsigned char *,
2627 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2628 extern void insert (const char *, ptrdiff_t);
2629 extern void insert_and_inherit (const char *, ptrdiff_t);
2630 extern void insert_1 (const char *, ptrdiff_t, int, int, int);
2631 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2633 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2634 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2635 ptrdiff_t, ptrdiff_t, int);
2636 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2637 extern void insert_char (int);
2638 extern void insert_string (const char *);
2639 extern void insert_before_markers (const char *, ptrdiff_t);
2640 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2641 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2642 ptrdiff_t, ptrdiff_t,
2644 extern void del_range (ptrdiff_t, ptrdiff_t);
2645 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, int, int);
2646 extern void del_range_byte (ptrdiff_t, ptrdiff_t, int);
2647 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int);
2648 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2649 ptrdiff_t, ptrdiff_t, int);
2650 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2651 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2652 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2653 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2654 ptrdiff_t, ptrdiff_t);
2655 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2656 ptrdiff_t, ptrdiff_t);
2657 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, int, int, int);
2658 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2659 const char *, ptrdiff_t, ptrdiff_t, int);
2660 extern void syms_of_insdel (void);
2662 /* Defined in dispnew.c */
2663 #if (defined PROFILING \
2664 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2665 void __executable_start (void) NO_RETURN
;
2667 extern Lisp_Object selected_frame
;
2668 extern Lisp_Object Vwindow_system
;
2670 EXFUN (Fredraw_frame
, 1);
2671 void duration_to_sec_usec (double, int *, int *);
2672 EXFUN (Fsleep_for
, 2);
2673 EXFUN (Fredisplay
, 1);
2674 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2675 extern void init_display (void);
2676 extern void syms_of_display (void);
2678 /* Defined in xdisp.c */
2679 extern Lisp_Object Qinhibit_point_motion_hooks
;
2680 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2681 extern Lisp_Object Qmenu_bar_update_hook
;
2682 extern Lisp_Object Qwindow_scroll_functions
;
2683 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2684 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2685 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2686 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2687 extern Lisp_Object Qleft_margin
, Qright_margin
;
2688 extern Lisp_Object Qglyphless_char
;
2689 extern Lisp_Object QCdata
, QCfile
;
2690 extern Lisp_Object QCmap
;
2691 extern Lisp_Object Qrisky_local_variable
;
2692 extern struct frame
*last_glyphless_glyph_frame
;
2693 extern int last_glyphless_glyph_face_id
;
2694 extern int last_glyphless_glyph_merged_face_id
;
2695 extern int noninteractive_need_newline
;
2696 extern Lisp_Object echo_area_buffer
[2];
2697 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2698 extern void check_message_stack (void);
2699 extern void setup_echo_area_for_printing (int);
2700 extern int push_message (void);
2701 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2702 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2703 extern void restore_message (void);
2704 extern Lisp_Object
current_message (void);
2705 extern void clear_message (int, int);
2706 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2707 extern void message1 (const char *);
2708 extern void message1_nolog (const char *);
2709 extern void message2 (const char *, ptrdiff_t, int);
2710 extern void message2_nolog (const char *, ptrdiff_t, int);
2711 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2712 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2713 extern void message_dolog (const char *, ptrdiff_t, int, int);
2714 extern void message_with_string (const char *, Lisp_Object
, int);
2715 extern void message_log_maybe_newline (void);
2716 extern void update_echo_area (void);
2717 extern void truncate_echo_area (ptrdiff_t);
2718 extern void redisplay (void);
2719 extern void redisplay_preserve_echo_area (int);
2720 extern void prepare_menu_bars (void);
2722 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2723 extern void syms_of_xdisp (void);
2724 extern void init_xdisp (void);
2725 extern Lisp_Object
safe_eval (Lisp_Object
);
2726 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2727 int *, int *, int *, int *, int *);
2729 /* Defined in xsettings.c */
2730 extern void syms_of_xsettings (void);
2732 /* Defined in vm-limit.c. */
2733 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2735 /* Defined in alloc.c */
2736 extern void check_pure_size (void);
2737 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2738 extern void reset_malloc_hooks (void);
2739 extern void uninterrupt_malloc (void);
2740 extern void malloc_warning (const char *);
2741 extern void memory_full (size_t) NO_RETURN
;
2742 extern void buffer_memory_full (ptrdiff_t) NO_RETURN
;
2743 extern int survives_gc_p (Lisp_Object
);
2744 extern void mark_object (Lisp_Object
);
2745 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2746 extern void refill_memory_reserve (void);
2748 extern const char *pending_malloc_warning
;
2749 extern Lisp_Object
*stack_base
;
2751 extern Lisp_Object
list1 (Lisp_Object
);
2752 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2753 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2754 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2755 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2757 EXFUN (Flist
, MANY
);
2758 EXFUN (Fmake_list
, 2);
2759 extern Lisp_Object
allocate_misc (void);
2760 EXFUN (Fmake_vector
, 2);
2761 EXFUN (Fvector
, MANY
);
2762 EXFUN (Fmake_symbol
, 1);
2763 EXFUN (Fmake_marker
, 0);
2764 extern void string_overflow (void) NO_RETURN
;
2765 EXFUN (Fmake_string
, 2);
2766 extern Lisp_Object
build_string (const char *);
2767 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2768 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2769 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2770 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2771 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2772 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2773 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2774 extern Lisp_Object
make_specified_string (const char *,
2775 ptrdiff_t, ptrdiff_t, int);
2776 EXFUN (Fpurecopy
, 1);
2777 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, int);
2778 extern Lisp_Object
make_pure_c_string (const char *data
);
2779 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2780 EXFUN (Fgarbage_collect
, 0);
2781 extern void make_byte_code (struct Lisp_Vector
*);
2782 EXFUN (Fmake_byte_code
, MANY
);
2783 EXFUN (Fmake_bool_vector
, 2);
2784 extern Lisp_Object Qchar_table_extra_slots
;
2785 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2786 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2787 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2789 allocate_pseudovector \
2790 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2791 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2792 extern struct window
*allocate_window (void);
2793 extern struct frame
*allocate_frame (void);
2794 extern struct Lisp_Process
*allocate_process (void);
2795 extern struct terminal
*allocate_terminal (void);
2796 extern int gc_in_progress
;
2797 extern int abort_on_gc
;
2798 extern Lisp_Object
make_float (double);
2799 extern void display_malloc_warning (void);
2800 extern ptrdiff_t inhibit_garbage_collection (void);
2801 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2802 extern void free_marker (Lisp_Object
);
2803 extern void free_cons (struct Lisp_Cons
*);
2804 extern void init_alloc_once (void);
2805 extern void init_alloc (void);
2806 extern void syms_of_alloc (void);
2807 extern struct buffer
* allocate_buffer (void);
2808 extern int valid_lisp_object_p (Lisp_Object
);
2811 /* Defined in ralloc.c */
2812 extern void *r_alloc (void **, size_t);
2813 extern void r_alloc_free (void **);
2814 extern void *r_re_alloc (void **, size_t);
2815 extern void r_alloc_reset_variable (void **, void **);
2816 extern void r_alloc_inhibit_buffer_relocation (int);
2819 /* Defined in chartab.c */
2820 EXFUN (Fmake_char_table
, 2);
2821 EXFUN (Fset_char_table_parent
, 2);
2822 EXFUN (Fchar_table_extra_slot
, 2);
2823 EXFUN (Fset_char_table_extra_slot
, 3);
2824 EXFUN (Fset_char_table_range
, 3);
2825 EXFUN (Foptimize_char_table
, 2);
2826 extern Lisp_Object
copy_char_table (Lisp_Object
);
2827 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2828 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2830 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2831 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2833 extern int char_table_translate (Lisp_Object
, int);
2834 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2836 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2837 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2838 Lisp_Object
, Lisp_Object
,
2839 Lisp_Object
, struct charset
*,
2840 unsigned, unsigned);
2841 extern Lisp_Object
uniprop_table (Lisp_Object
);
2842 extern void syms_of_chartab (void);
2844 /* Defined in print.c */
2845 extern Lisp_Object Vprin1_to_string_buffer
;
2846 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2848 EXFUN (Fprin1_to_string
, 2);
2851 EXFUN (Ferror_message_string
, 1);
2852 extern Lisp_Object Qstandard_output
;
2853 extern Lisp_Object Qexternal_debugging_output
;
2854 extern void temp_output_buffer_setup (const char *);
2855 extern int print_level
;
2856 extern Lisp_Object Qprint_escape_newlines
;
2857 extern void write_string (const char *, int);
2858 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2860 extern Lisp_Object internal_with_output_to_temp_buffer
2861 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2862 #define FLOAT_TO_STRING_BUFSIZE 350
2863 extern void float_to_string (char *, double);
2864 extern void syms_of_print (void);
2866 /* Defined in doprnt.c */
2867 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2869 extern ptrdiff_t esprintf (char *, char const *, ...)
2870 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2871 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2873 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2874 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2875 char const *, va_list)
2876 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2878 /* Defined in lread.c. */
2879 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2880 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2882 EXFUN (Fread_from_string
, 3);
2884 EXFUN (Fintern_soft
, 2);
2885 EXFUN (Funintern
, 2);
2887 EXFUN (Fget_load_suffixes
, 0);
2888 EXFUN (Fread_char
, 3);
2889 EXFUN (Fread_event
, 3);
2890 extern Lisp_Object
check_obarray (Lisp_Object
);
2891 extern Lisp_Object
intern (const char *);
2892 extern Lisp_Object
intern_c_string (const char *);
2893 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
2894 #define LOADHIST_ATTACH(x) \
2896 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2898 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2899 Lisp_Object
*, Lisp_Object
);
2900 Lisp_Object
string_to_number (char const *, int, int);
2901 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2903 extern void dir_warning (const char *, Lisp_Object
);
2904 extern void close_load_descs (void);
2905 extern void init_obarray (void);
2906 extern void init_lread (void);
2907 extern void syms_of_lread (void);
2909 /* Defined in eval.c. */
2910 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
2911 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2912 extern Lisp_Object Qand_rest
;
2913 extern Lisp_Object Vautoload_queue
;
2914 extern Lisp_Object Vsignaling_function
;
2915 extern Lisp_Object inhibit_lisp_code
;
2916 extern int handling_signal
;
2918 extern struct catchtag
*catchlist
;
2919 extern struct handler
*handlerlist
;
2921 /* To run a normal hook, use the appropriate function from the list below.
2922 The calling convention:
2924 if (!NILP (Vrun_hooks))
2925 call1 (Vrun_hooks, Qmy_funny_hook);
2927 should no longer be used. */
2928 extern Lisp_Object Vrun_hooks
;
2929 EXFUN (Frun_hooks
, MANY
);
2930 EXFUN (Frun_hook_with_args
, MANY
);
2931 EXFUN (Frun_hook_with_args_until_failure
, MANY
);
2932 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2933 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2934 Lisp_Object (*funcall
)
2935 (ptrdiff_t nargs
, Lisp_Object
*args
));
2936 EXFUN (Fprogn
, UNEVALLED
);
2937 EXFUN (Finteractive_p
, 0);
2938 EXFUN (Fthrow
, 2) NO_RETURN
;
2940 extern void xsignal (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2941 extern void xsignal0 (Lisp_Object
) NO_RETURN
;
2942 extern void xsignal1 (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2943 extern void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2944 extern void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2945 extern void signal_error (const char *, Lisp_Object
) NO_RETURN
;
2946 EXFUN (Fcommandp
, 2);
2947 EXFUN (Ffunctionp
, 1);
2949 extern Lisp_Object
eval_sub (Lisp_Object form
);
2950 EXFUN (Fapply
, MANY
);
2951 EXFUN (Ffuncall
, MANY
);
2952 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2953 extern Lisp_Object
call0 (Lisp_Object
);
2954 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2955 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2956 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2957 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2958 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2959 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2960 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2961 EXFUN (Fdo_auto_save
, 2);
2962 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2963 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2964 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2965 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2966 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2967 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2968 extern void specbind (Lisp_Object
, Lisp_Object
);
2969 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2970 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
2971 extern void error (const char *, ...) NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
2972 extern void verror (const char *, va_list)
2973 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 0);
2974 extern void do_autoload (Lisp_Object
, Lisp_Object
);
2975 extern Lisp_Object
un_autoload (Lisp_Object
);
2976 extern void init_eval_once (void);
2977 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
*);
2978 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
2979 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2980 extern void init_eval (void);
2982 extern void mark_backtrace (void);
2984 extern void syms_of_eval (void);
2986 /* Defined in editfns.c */
2987 extern Lisp_Object Qfield
;
2988 EXFUN (Fcurrent_message
, 0);
2989 EXFUN (Fgoto_char
, 1);
2990 EXFUN (Fpoint_max_marker
, 0);
2992 EXFUN (Fpoint_marker
, 0);
2993 EXFUN (Fline_beginning_position
, 1);
2994 EXFUN (Fline_end_position
, 1);
2995 EXFUN (Ffollowing_char
, 0);
2996 EXFUN (Fprevious_char
, 0);
2997 EXFUN (Fchar_after
, 1);
2998 EXFUN (Finsert
, MANY
);
2999 EXFUN (Finsert_char
, 3);
3000 extern void insert1 (Lisp_Object
);
3005 EXFUN (Fformat
, MANY
);
3006 EXFUN (Fmessage
, MANY
);
3007 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3008 EXFUN (Fbuffer_substring
, 2);
3009 EXFUN (Fbuffer_string
, 0);
3010 extern Lisp_Object
save_excursion_save (void);
3011 extern Lisp_Object
save_restriction_save (void);
3012 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3013 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3014 EXFUN (Fchar_to_string
, 1);
3015 EXFUN (Fdelete_region
, 2);
3016 EXFUN (Fnarrow_to_region
, 2);
3018 EXFUN (Fuser_login_name
, 1);
3019 EXFUN (Fsystem_name
, 0);
3020 EXFUN (Fcurrent_time
, 0);
3021 EXFUN (Fget_internal_run_time
, 0);
3022 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, int);
3023 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3025 extern void init_editfns (void);
3026 const char *get_system_name (void);
3027 extern void syms_of_editfns (void);
3028 EXFUN (Fconstrain_to_field
, 5);
3029 EXFUN (Ffield_end
, 3);
3030 extern void set_time_zone_rule (const char *);
3032 /* Defined in buffer.c */
3033 extern int mouse_face_overlay_overlaps (Lisp_Object
);
3034 extern void nsberror (Lisp_Object
) NO_RETURN
;
3035 EXFUN (Fset_buffer_multibyte
, 1);
3036 EXFUN (Foverlay_start
, 1);
3037 EXFUN (Foverlay_end
, 1);
3038 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3039 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3040 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3041 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
3042 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3043 extern int overlay_touches_p (ptrdiff_t);
3044 extern Lisp_Object Vbuffer_alist
;
3045 EXFUN (Fget_buffer
, 1);
3046 EXFUN (Fget_buffer_create
, 1);
3047 EXFUN (Fgenerate_new_buffer_name
, 2);
3048 EXFUN (Fset_buffer
, 1);
3049 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3050 EXFUN (Fbarf_if_buffer_read_only
, 0);
3051 EXFUN (Fcurrent_buffer
, 0);
3052 EXFUN (Fother_buffer
, 3);
3053 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3054 EXFUN (Foverlay_get
, 2);
3055 EXFUN (Fbuffer_modified_p
, 1);
3056 EXFUN (Fset_buffer_modified_p
, 1);
3057 EXFUN (Fkill_buffer
, 1);
3058 EXFUN (Fkill_all_local_variables
, 0);
3059 EXFUN (Fbuffer_enable_undo
, 1);
3060 EXFUN (Ferase_buffer
, 0);
3061 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3062 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3063 extern struct buffer
*all_buffers
;
3064 EXFUN (Fprevious_overlay_change
, 1);
3065 EXFUN (Fbuffer_file_name
, 1);
3066 extern void init_buffer_once (void);
3067 extern void init_buffer (void);
3068 extern void syms_of_buffer (void);
3069 extern void keys_of_buffer (void);
3071 /* Defined in marker.c */
3073 EXFUN (Fmarker_position
, 1);
3074 EXFUN (Fmarker_buffer
, 1);
3075 EXFUN (Fcopy_marker
, 2);
3076 EXFUN (Fset_marker
, 3);
3077 extern ptrdiff_t marker_position (Lisp_Object
);
3078 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3079 extern void clear_charpos_cache (struct buffer
*);
3080 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3081 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3082 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3083 extern void unchain_marker (struct Lisp_Marker
*marker
);
3084 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3085 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3086 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3087 ptrdiff_t, ptrdiff_t);
3088 extern void syms_of_marker (void);
3090 /* Defined in fileio.c */
3092 extern Lisp_Object Qfile_error
;
3093 extern Lisp_Object Qfile_exists_p
;
3094 extern Lisp_Object Qfile_directory_p
;
3095 extern Lisp_Object Qinsert_file_contents
;
3096 extern Lisp_Object Qfile_name_history
;
3097 EXFUN (Ffind_file_name_handler
, 2);
3098 EXFUN (Ffile_name_as_directory
, 1);
3099 EXFUN (Fexpand_file_name
, 2);
3100 EXFUN (Ffile_name_nondirectory
, 1);
3101 EXFUN (Fsubstitute_in_file_name
, 1);
3102 EXFUN (Ffile_symlink_p
, 1);
3103 EXFUN (Fverify_visited_file_modtime
, 1);
3104 EXFUN (Ffile_exists_p
, 1);
3105 EXFUN (Ffile_name_absolute_p
, 1);
3106 EXFUN (Fdirectory_file_name
, 1);
3107 EXFUN (Ffile_name_directory
, 1);
3108 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3109 EXFUN (Ffile_accessible_directory_p
, 1);
3110 EXFUN (Funhandled_file_name_directory
, 1);
3111 EXFUN (Ffile_directory_p
, 1);
3112 EXFUN (Fwrite_region
, 7);
3113 EXFUN (Ffile_readable_p
, 1);
3114 EXFUN (Fread_file_name
, 6);
3115 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3116 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3117 extern void report_file_error (const char *, Lisp_Object
) NO_RETURN
;
3118 extern int internal_delete_file (Lisp_Object
);
3119 extern void syms_of_fileio (void);
3120 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
3121 extern Lisp_Object Qdelete_file
;
3123 /* Defined in search.c */
3124 extern void shrink_regexp_cache (void);
3125 EXFUN (Fstring_match
, 3);
3126 extern void restore_search_regs (void);
3127 EXFUN (Fmatch_data
, 3);
3128 EXFUN (Fset_match_data
, 2);
3129 EXFUN (Fmatch_beginning
, 1);
3130 EXFUN (Fmatch_end
, 1);
3131 extern void record_unwind_save_match_data (void);
3132 struct re_registers
;
3133 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3134 struct re_registers
*,
3135 Lisp_Object
, int, int);
3136 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3137 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *);
3138 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3139 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3140 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3141 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3143 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3145 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3146 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3147 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3148 extern void syms_of_search (void);
3149 extern void clear_regexp_cache (void);
3151 /* Defined in minibuf.c */
3153 extern Lisp_Object Qcompletion_ignore_case
;
3154 extern Lisp_Object Vminibuffer_list
;
3155 extern Lisp_Object last_minibuf_string
;
3156 EXFUN (Fcompleting_read
, 8);
3157 EXFUN (Fread_from_minibuffer
, 7);
3158 EXFUN (Fread_variable
, 2);
3159 EXFUN (Fread_buffer
, 3);
3160 EXFUN (Fread_minibuffer
, 2);
3161 EXFUN (Feval_minibuffer
, 2);
3162 EXFUN (Fread_string
, 5);
3163 EXFUN (Fassoc_string
, 3);
3164 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3165 extern void init_minibuf_once (void);
3166 extern void syms_of_minibuf (void);
3168 /* Defined in callint.c */
3170 extern Lisp_Object Qminus
, Qplus
;
3171 extern Lisp_Object Qwhen
;
3172 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3173 EXFUN (Fprefix_numeric_value
, 1);
3174 extern void syms_of_callint (void);
3176 /* Defined in casefiddle.c */
3178 extern Lisp_Object Qidentity
;
3179 EXFUN (Fdowncase
, 1);
3181 EXFUN (Fupcase_region
, 2);
3182 EXFUN (Fupcase_initials
, 1);
3183 EXFUN (Fupcase_initials_region
, 2);
3184 extern void syms_of_casefiddle (void);
3185 extern void keys_of_casefiddle (void);
3187 /* Defined in casetab.c */
3189 EXFUN (Fset_case_table
, 1);
3190 EXFUN (Fset_standard_case_table
, 1);
3191 extern void init_casetab_once (void);
3192 extern void syms_of_casetab (void);
3194 /* Defined in keyboard.c */
3196 extern Lisp_Object echo_message_buffer
;
3197 extern struct kboard
*echo_kboard
;
3198 extern void cancel_echoing (void);
3199 extern Lisp_Object Qdisabled
, QCfilter
;
3200 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3201 extern Lisp_Object Qtop
;
3202 extern int input_pending
;
3203 EXFUN (Fdiscard_input
, 0);
3204 EXFUN (Frecursive_edit
, 0);
3205 EXFUN (Ftop_level
, 0) NO_RETURN
;
3206 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3207 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3208 extern void discard_mouse_events (void);
3209 EXFUN (Fevent_convert_list
, 1);
3210 EXFUN (Fread_key_sequence
, 5);
3211 EXFUN (Fset_input_interrupt_mode
, 1);
3212 EXFUN (Fset_input_mode
, 4);
3213 extern Lisp_Object pending_funcalls
;
3214 extern int detect_input_pending (void);
3215 extern int detect_input_pending_ignore_squeezables (void);
3216 extern int detect_input_pending_run_timers (int);
3217 extern void safe_run_hooks (Lisp_Object
);
3218 extern void cmd_error_internal (Lisp_Object
, const char *);
3219 extern Lisp_Object
command_loop_1 (void);
3220 extern Lisp_Object
recursive_edit_1 (void);
3221 extern void record_auto_save (void);
3223 extern void force_auto_save_soon (void);
3225 extern void init_keyboard (void);
3226 extern void syms_of_keyboard (void);
3227 extern void keys_of_keyboard (void);
3229 /* Defined in indent.c */
3230 EXFUN (Fvertical_motion
, 2);
3231 EXFUN (Findent_to
, 2);
3232 EXFUN (Fmove_to_column
, 2);
3233 extern ptrdiff_t current_column (void);
3234 extern void invalidate_current_column (void);
3235 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3236 extern void syms_of_indent (void);
3238 /* Defined in frame.c */
3239 #ifdef HAVE_WINDOW_SYSTEM
3240 #endif /* HAVE_WINDOW_SYSTEM */
3241 extern Lisp_Object Qonly
;
3242 extern Lisp_Object Qvisible
;
3243 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3244 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3245 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3247 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3249 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3250 EXFUN (Fselect_frame
, 2);
3251 EXFUN (Fselected_frame
, 0);
3252 EXFUN (Fmake_frame_visible
, 1);
3253 EXFUN (Ficonify_frame
, 1);
3254 EXFUN (Fframe_parameter
, 2);
3255 EXFUN (Fmodify_frame_parameters
, 2);
3256 EXFUN (Fraise_frame
, 1);
3257 EXFUN (Fredirect_frame_focus
, 2);
3258 extern void frames_discard_buffer (Lisp_Object
);
3259 extern void syms_of_frame (void);
3261 /* Defined in emacs.c */
3262 extern char **initial_argv
;
3263 extern int initial_argc
;
3264 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3265 extern int display_arg
;
3267 extern Lisp_Object
decode_env_path (const char *, const char *);
3268 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3269 extern Lisp_Object Qfile_name_handler_alist
;
3270 #ifdef FLOAT_CATCH_SIGILL
3271 extern void fatal_error_signal (int);
3273 extern Lisp_Object Qkill_emacs
;
3274 EXFUN (Fkill_emacs
, 1) NO_RETURN
;
3276 void fixup_locale (void);
3277 void synchronize_system_messages_locale (void);
3278 void synchronize_system_time_locale (void);
3280 #define setlocale(category, locale)
3281 #define fixup_locale()
3282 #define synchronize_system_messages_locale()
3283 #define synchronize_system_time_locale()
3285 void shut_down_emacs (int, int, Lisp_Object
);
3286 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3287 extern int noninteractive
;
3289 /* Nonzero means remove site-lisp directories from load-path. */
3290 extern int no_site_lisp
;
3292 /* Pipe used to send exit notification to the daemon parent at
3294 extern int daemon_pipe
[2];
3295 #define IS_DAEMON (daemon_pipe[1] != 0)
3297 /* Nonzero means don't do use window-system-specific display code. */
3298 extern int inhibit_window_system
;
3299 /* Nonzero means that a filter or a sentinel is running. */
3300 extern int running_asynch_code
;
3302 /* Defined in process.c. */
3303 extern Lisp_Object QCtype
, Qlocal
;
3304 EXFUN (Fget_buffer_process
, 1);
3305 EXFUN (Fprocess_status
, 1);
3306 EXFUN (Fkill_process
, 2);
3307 EXFUN (Fwaiting_for_user_input_p
, 0);
3308 extern Lisp_Object Qprocessp
;
3309 extern void kill_buffer_processes (Lisp_Object
);
3310 extern int wait_reading_process_output (int, int, int, int,
3312 struct Lisp_Process
*,
3314 extern void add_keyboard_wait_descriptor (int);
3315 extern void delete_keyboard_wait_descriptor (int);
3317 extern void add_gpm_wait_descriptor (int);
3318 extern void delete_gpm_wait_descriptor (int);
3320 extern void close_process_descs (void);
3321 extern void init_process (void);
3322 extern void syms_of_process (void);
3323 extern void setup_process_coding_systems (Lisp_Object
);
3325 EXFUN (Fcall_process
, MANY
);
3326 extern int child_setup (int, int, int, char **, int, Lisp_Object
)
3331 extern void init_callproc_1 (void);
3332 extern void init_callproc (void);
3333 extern void set_initial_environment (void);
3334 extern void syms_of_callproc (void);
3336 /* Defined in doc.c */
3337 extern Lisp_Object Qfunction_documentation
;
3338 EXFUN (Fsubstitute_command_keys
, 1);
3339 extern Lisp_Object
read_doc_string (Lisp_Object
);
3340 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3341 extern void syms_of_doc (void);
3342 extern int read_bytecode_char (int);
3344 /* Defined in bytecode.c */
3345 extern Lisp_Object Qbytecode
;
3346 extern void syms_of_bytecode (void);
3347 extern struct byte_stack
*byte_stack_list
;
3349 extern void mark_byte_stack (void);
3351 extern void unmark_byte_stack (void);
3352 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3353 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3355 /* Defined in macros.c */
3356 extern Lisp_Object Qexecute_kbd_macro
;
3357 EXFUN (Fexecute_kbd_macro
, 3);
3358 EXFUN (Fcancel_kbd_macro_events
, 0);
3359 extern void init_macros (void);
3360 extern void syms_of_macros (void);
3362 /* Defined in undo.c */
3363 extern Lisp_Object Qapply
;
3364 extern Lisp_Object Qinhibit_read_only
;
3365 EXFUN (Fundo_boundary
, 0);
3366 extern void truncate_undo_list (struct buffer
*);
3367 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3368 extern void record_insert (ptrdiff_t, ptrdiff_t);
3369 extern void record_delete (ptrdiff_t, Lisp_Object
);
3370 extern void record_first_change (void);
3371 extern void record_change (ptrdiff_t, ptrdiff_t);
3372 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3373 Lisp_Object
, Lisp_Object
,
3375 extern void syms_of_undo (void);
3376 /* Defined in textprop.c */
3377 extern Lisp_Object Qfont
, Qmouse_face
;
3378 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3379 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3380 extern Lisp_Object Qminibuffer_prompt
;
3382 EXFUN (Fnext_single_property_change
, 4);
3383 EXFUN (Fnext_single_char_property_change
, 4);
3384 EXFUN (Fprevious_single_property_change
, 4);
3385 EXFUN (Fget_text_property
, 3);
3386 EXFUN (Fput_text_property
, 5);
3387 EXFUN (Fprevious_char_property_change
, 2);
3388 EXFUN (Fnext_char_property_change
, 2);
3389 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3391 /* Defined in menu.c */
3392 extern void syms_of_menu (void);
3394 /* Defined in xmenu.c */
3395 EXFUN (Fx_popup_menu
, 2);
3396 EXFUN (Fx_popup_dialog
, 3);
3397 extern void syms_of_xmenu (void);
3399 /* Defined in termchar.h */
3400 struct tty_display_info
;
3402 /* Defined in termhooks.h */
3405 /* Defined in sysdep.c */
3406 #ifndef HAVE_GET_CURRENT_DIR_NAME
3407 extern char *get_current_dir_name (void);
3409 extern void stuff_char (char c
);
3410 extern void init_sigio (int);
3411 extern void sys_subshell (void);
3412 extern void sys_suspend (void);
3413 extern void discard_tty_input (void);
3414 extern void init_sys_modes (struct tty_display_info
*);
3415 extern void reset_sys_modes (struct tty_display_info
*);
3416 extern void init_all_sys_modes (void);
3417 extern void reset_all_sys_modes (void);
3418 extern void wait_for_termination (pid_t
);
3419 extern void interruptible_wait_for_termination (pid_t
);
3420 extern void flush_pending_output (int);
3421 extern void child_setup_tty (int);
3422 extern void setup_pty (int);
3423 extern int set_window_size (int, int, int);
3424 extern EMACS_INT
get_random (void);
3425 extern void seed_random (long);
3426 extern int emacs_open (const char *, int, int);
3427 extern int emacs_close (int);
3428 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3429 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3430 enum { READLINK_BUFSIZE
= 1024 };
3431 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3433 EXFUN (Funlock_buffer
, 0);
3434 extern void unlock_all_files (void);
3435 extern void lock_file (Lisp_Object
);
3436 extern void unlock_file (Lisp_Object
);
3437 extern void unlock_buffer (struct buffer
*);
3438 extern void syms_of_filelock (void);
3439 extern void init_filelock (void);
3441 /* Defined in sound.c */
3442 extern void syms_of_sound (void);
3443 extern void init_sound (void);
3445 /* Defined in category.c */
3446 extern void init_category_once (void);
3447 extern Lisp_Object
char_category_set (int);
3448 extern void syms_of_category (void);
3450 /* Defined in ccl.c */
3451 extern void syms_of_ccl (void);
3453 /* Defined in dired.c */
3454 extern void syms_of_dired (void);
3455 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3456 Lisp_Object
, Lisp_Object
,
3459 /* Defined in term.c */
3460 extern int *char_ins_del_vector
;
3461 extern void mark_ttys (void);
3462 extern void syms_of_term (void);
3463 extern void fatal (const char *msgid
, ...)
3464 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
3466 /* Defined in terminal.c */
3467 EXFUN (Fframe_terminal
, 1);
3468 EXFUN (Fdelete_terminal
, 2);
3469 extern void syms_of_terminal (void);
3471 /* Defined in font.c */
3472 extern void syms_of_font (void);
3473 extern void init_font (void);
3475 #ifdef HAVE_WINDOW_SYSTEM
3476 /* Defined in fontset.c */
3477 extern void syms_of_fontset (void);
3479 /* Defined in xfns.c, w32fns.c, or macfns.c */
3480 extern Lisp_Object Qfont_param
;
3481 EXFUN (Fxw_display_color_p
, 1);
3482 EXFUN (Fx_focus_frame
, 1);
3485 /* Defined in xfaces.c */
3486 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3487 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3488 extern Lisp_Object Qmode_line_inactive
;
3489 extern Lisp_Object Qface
;
3490 extern Lisp_Object Qnormal
;
3491 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3492 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3493 extern Lisp_Object Vface_alternative_font_family_alist
;
3494 extern Lisp_Object Vface_alternative_font_registry_alist
;
3495 EXFUN (Fclear_face_cache
, 1);
3496 EXFUN (Fx_load_color_file
, 1);
3497 extern void syms_of_xfaces (void);
3499 #ifdef HAVE_X_WINDOWS
3500 /* Defined in xfns.c */
3501 extern void syms_of_xfns (void);
3503 /* Defined in xsmfns.c */
3504 extern void syms_of_xsmfns (void);
3506 /* Defined in xselect.c */
3507 extern void syms_of_xselect (void);
3509 /* Defined in xterm.c */
3510 extern void syms_of_xterm (void);
3511 #endif /* HAVE_X_WINDOWS */
3513 #ifdef HAVE_WINDOW_SYSTEM
3514 /* Defined in xterm.c, nsterm.m, w32term.c */
3515 extern char *x_get_keysym_name (int);
3516 #endif /* HAVE_WINDOW_SYSTEM */
3519 /* Defined in msdos.c */
3520 EXFUN (Fmsdos_downcase_filename
, 1);
3524 /* Defined in xml.c */
3525 extern void syms_of_xml (void);
3526 extern void xml_cleanup_parser (void);
3530 /* Defined in (x|w32)fns.c, nsfns.m... */
3531 extern int have_menus_p (void);
3535 /* Defined in dbusbind.c */
3536 void syms_of_dbusbind (void);
3540 /* Defined in msdos.c, w32.c */
3541 extern char *emacs_root_dir (void);
3544 /* Nonzero means Emacs has already been initialized.
3545 Used during startup to detect startup of dumped Emacs. */
3546 extern int initialized
;
3548 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3550 extern void *xmalloc (size_t);
3551 extern void *xrealloc (void *, size_t);
3552 extern void xfree (void *);
3553 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3554 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3555 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3557 extern char *xstrdup (const char *);
3559 extern char *egetenv (const char *);
3561 /* Set up the name of the machine we're running on. */
3562 extern void init_system_name (void);
3564 /* Some systems (e.g., NT) use a different path separator than Unix,
3565 in addition to a device separator. Set the path separator
3566 to '/', and don't test for a device separator in IS_ANY_SEP. */
3568 #define DIRECTORY_SEP '/'
3569 #ifndef IS_DIRECTORY_SEP
3570 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3572 #ifndef IS_DEVICE_SEP
3574 #define IS_DEVICE_SEP(_c_) 0
3576 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3580 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3583 #define SWITCH_ENUM_CAST(x) (x)
3585 /* Use this to suppress gcc's warnings. */
3588 /* Use CODE only if lint checking is in effect. */
3589 # define IF_LINT(Code) Code
3591 /* Assume that the expression COND is true. This differs in intent
3592 from 'assert', as it is a message from the programmer to the compiler. */
3593 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3596 # define IF_LINT(Code) /* empty */
3597 # define lint_assume(cond) ((void) (0 && (cond)))
3600 /* The ubiquitous min and max macros. */
3606 #define min(a, b) ((a) < (b) ? (a) : (b))
3607 #define max(a, b) ((a) > (b) ? (a) : (b))
3609 /* We used to use `abs', but that clashes with system headers on some
3610 platforms, and using a name reserved by Standard C is a bad idea
3613 #define eabs(x) ((x) < 0 ? -(x) : (x))
3616 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3619 #define make_fixnum_or_float(val) \
3620 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3623 /* Checks the `cycle check' variable CHECK to see if it indicates that
3624 EL is part of a cycle; CHECK must be either Qnil or a value returned
3625 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3626 elements after which a cycle might be suspected; after that many
3627 elements, this macro begins consing in order to keep more precise
3630 Returns nil if a cycle was detected, otherwise a new value for CHECK
3633 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3634 the caller should make sure that's ok. */
3636 #define CYCLE_CHECK(check, el, suspicious) \
3639 : (INTEGERP (check) \
3640 ? (XFASTINT (check) < (suspicious) \
3641 ? make_number (XFASTINT (check) + 1) \
3642 : Fcons (el, Qnil)) \
3643 : (!NILP (Fmemq ((el), (check))) \
3645 : Fcons ((el), (check)))))
3648 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3649 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3651 #define MAX_ALLOCA 16*1024
3653 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3655 #define USE_SAFE_ALLOCA \
3656 ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0
3658 /* SAFE_ALLOCA allocates a simple buffer. */
3660 #define SAFE_ALLOCA(buf, type, size) \
3662 if ((size) < MAX_ALLOCA) \
3663 buf = (type) alloca (size); \
3666 buf = (type) xmalloc (size); \
3668 record_unwind_protect (safe_alloca_unwind, \
3669 make_save_value (buf, 0)); \
3673 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3674 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3675 positive. The code is tuned for MULTIPLIER being a constant. */
3677 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3679 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3680 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3683 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3685 record_unwind_protect (safe_alloca_unwind, \
3686 make_save_value (buf, 0)); \
3690 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3692 #define SAFE_FREE() \
3694 if (sa_must_free) { \
3696 unbind_to (sa_count, Qnil); \
3701 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3703 #define SAFE_ALLOCA_LISP(buf, nelt) \
3705 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3706 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3707 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3710 buf = (Lisp_Object *) xmalloc ((nelt) * sizeof (Lisp_Object)); \
3711 arg_ = make_save_value (buf, nelt); \
3712 XSAVE_VALUE (arg_)->dogc = 1; \
3714 record_unwind_protect (safe_alloca_unwind, arg_); \
3717 memory_full (SIZE_MAX); \
3721 #include "globals.h"
3723 #endif /* EMACS_LISP_H */