1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1987, 1993-1995, 1997-2011
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/>. */
29 /* Use the configure flag --enable-checking[=LIST] to enable various
30 types of run time checks for Lisp objects. */
32 #ifdef GC_CHECK_CONS_LIST
33 extern void check_cons_list (void);
34 #define CHECK_CONS_LIST() check_cons_list ()
36 #define CHECK_CONS_LIST() ((void) 0)
39 /* Temporarily disable wider-than-pointer integers until they're tested more.
40 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
41 /* #undef WIDE_EMACS_INT */
43 /* These are default choices for the types to use. */
45 # if BITS_PER_LONG < BITS_PER_LONG_LONG && defined WIDE_EMACS_INT
46 # define EMACS_INT long long
47 # define BITS_PER_EMACS_INT BITS_PER_LONG_LONG
49 # elif BITS_PER_INT < BITS_PER_LONG
50 # define EMACS_INT long
51 # define BITS_PER_EMACS_INT BITS_PER_LONG
54 # define EMACS_INT int
55 # define BITS_PER_EMACS_INT BITS_PER_INT
60 # define EMACS_UINT unsigned EMACS_INT
63 /* Use pD to format ptrdiff_t values, which suffice for indexes into
64 buffers and strings. Emacs never allocates objects larger than
65 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
66 In C99, pD can always be "t"; configure it here for the sake of
67 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
68 #if PTRDIFF_MAX == INT_MAX
70 #elif PTRDIFF_MAX == LONG_MAX
72 #elif PTRDIFF_MAX == LLONG_MAX
78 /* Extra internal type checking? */
80 #ifdef ENABLE_CHECKING
82 extern void die (const char *, const char *, int) NO_RETURN
;
84 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
85 it to 1 using a debugger to temporarily disable aborting on
86 detected internal inconsistencies or error conditions.
88 Testing suppress_checking after the supplied condition ensures that
89 the side effects produced by CHECK will be consistent, independent
90 of whether ENABLE_CHECKING is defined, or whether the checks are
91 suppressed at run time.
93 In some cases, a good compiler may be able to optimize away the
94 CHECK macro altogether, e.g., if XSTRING (x) uses CHECK to test
95 STRINGP (x), but a particular use of XSTRING is invoked only after
96 testing that STRINGP (x) is true, making the test redundant. */
98 extern int suppress_checking EXTERNALLY_VISIBLE
;
100 #define CHECK(check,msg) (((check) || suppress_checking \
102 : die ((msg), __FILE__, __LINE__)), \
106 /* Produce same side effects and result, but don't complain. */
107 #define CHECK(check,msg) ((check),0)
111 /* Define an Emacs version of "assert", since some system ones are
113 #ifndef ENABLE_CHECKING
114 #define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
115 #else /* ENABLE_CHECKING */
116 #if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
117 #define eassert(cond) CHECK(cond,"assertion failed: " #cond)
119 #define eassert(cond) CHECK(cond,"assertion failed")
121 #endif /* ENABLE_CHECKING */
123 /* Use the configure flag --enable-use-lisp-union-type to make
124 Lisp_Object use a union type instead of the default int. The flag
125 causes USE_LISP_UNION_TYPE to be defined. */
127 /***** Select the tagging scheme. *****/
128 /* There are basically two options that control the tagging scheme:
129 - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
131 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
132 always 0, and we can thus use them to hold tag bits, without
133 restricting our addressing space.
135 If USE_LSB_TAG is not set, then we use the top 3 bits for tagging, thus
136 restricting our possible address range. Currently USE_LSB_TAG is not
137 allowed together with a union. This is not due to any fundamental
138 technical (or political ;-) problem: nobody wrote the code to do it yet.
140 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
141 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
142 on the few static Lisp_Objects used: all the defsubr as well
143 as the two special buffers buffer_defaults and buffer_local_symbols. */
145 /* First, try and define DECL_ALIGN(type,var) which declares a static
146 variable VAR of type TYPE with the added requirement that it be
148 #ifndef NO_DECL_ALIGN
150 # if HAVE_ATTRIBUTE_ALIGNED
151 # define DECL_ALIGN(type, var) \
152 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
154 /* What directives do other compilers use? */
159 /* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8. */
160 #if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
161 || defined DARWIN_OS || defined __sun)
162 /* We also need to be able to specify mult-of-8 alignment on static vars. */
163 # if defined DECL_ALIGN
168 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
171 # error "USE_LSB_TAG used without defining DECL_ALIGN"
173 # define DECL_ALIGN(type, var) type var
177 /* Define the fundamental Lisp data structures. */
179 /* If USE_2_TAGBITS_FOR_INTS is defined, then Lisp integers use
180 2 tags, to give them one extra bit, thus extending their range from
181 e.g -2^28..2^28-1 to -2^29..2^29-1. */
182 #define USE_2_TAGS_FOR_INTS
184 /* Making it work for the union case is too much trouble. */
185 #ifdef USE_LISP_UNION_TYPE
186 # undef USE_2_TAGS_FOR_INTS
189 /* This is the set of Lisp data types. */
191 #if !defined USE_2_TAGS_FOR_INTS
192 # define LISP_INT_TAG Lisp_Int
193 # define case_Lisp_Int case Lisp_Int
194 # define LISP_STRING_TAG 4
195 # define LISP_INT_TAG_P(x) ((x) == Lisp_Int)
197 # define LISP_INT_TAG Lisp_Int0
198 # define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
200 # define LISP_INT1_TAG 4
201 # define LISP_STRING_TAG 1
202 # define LISP_INT_TAG_P(x) (((x) & 3) == 0)
204 # define LISP_INT1_TAG 1
205 # define LISP_STRING_TAG 4
206 # define LISP_INT_TAG_P(x) (((x) & 6) == 0)
212 /* Integer. XINT (obj) is the integer value. */
213 #ifdef USE_2_TAGS_FOR_INTS
215 Lisp_Int1
= LISP_INT1_TAG
,
220 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
223 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
224 whose first member indicates the subtype. */
227 /* String. XSTRING (object) points to a struct Lisp_String.
228 The length of the string, and its contents, are stored therein. */
229 Lisp_String
= LISP_STRING_TAG
,
231 /* Vector of Lisp objects, or something resembling it.
232 XVECTOR (object) points to a struct Lisp_Vector, which contains
233 the size and contents. The size field also contains the type
234 information, if it's not a real vector object. */
237 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
243 /* This is the set of data types that share a common structure.
244 The first member of the structure is a type code from this set.
245 The enum values are arbitrary, but we'll use large numbers to make it
246 more likely that we'll spot the error if a random word in memory is
247 mistakenly interpreted as a Lisp_Misc. */
250 Lisp_Misc_Free
= 0x5eab,
253 Lisp_Misc_Save_Value
,
254 /* Currently floats are not a misc type,
255 but let's define this in case we want to change that. */
257 /* This is not a type code. It is for range checking. */
261 /* These are the types of forwarding objects used in the value slot
262 of symbols for special built-in variables whose value is stored in
266 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
267 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
268 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
269 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
270 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
277 /* These values are overridden by the m- file on some machines. */
279 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
282 #ifdef USE_LISP_UNION_TYPE
284 #ifndef WORDS_BIGENDIAN
286 /* Definition of Lisp_Object for little-endian machines. */
291 /* Used for comparing two Lisp_Objects;
292 also, positive integers can be accessed fast this way. */
297 /* Use explict signed, the signedness of a bit-field of type
298 int is implementation defined. */
299 signed EMACS_INT val
: VALBITS
;
300 enum Lisp_Type type
: GCTYPEBITS
;
304 EMACS_UINT val
: VALBITS
;
305 enum Lisp_Type type
: GCTYPEBITS
;
310 #else /* If WORDS_BIGENDIAN */
315 /* Used for comparing two Lisp_Objects;
316 also, positive integers can be accessed fast this way. */
321 enum Lisp_Type type
: GCTYPEBITS
;
322 /* Use explict signed, the signedness of a bit-field of type
323 int is implementation defined. */
324 signed EMACS_INT val
: VALBITS
;
328 enum Lisp_Type type
: GCTYPEBITS
;
329 EMACS_UINT val
: VALBITS
;
334 #endif /* WORDS_BIGENDIAN */
337 static inline Lisp_Object
338 LISP_MAKE_RVALUE (Lisp_Object o
)
343 /* This is more portable to pre-C99 non-GCC compilers, but for
344 backwards compatibility GCC still accepts an old GNU extension
345 which caused this to only generate a warning. */
346 #define LISP_MAKE_RVALUE(o) (0 ? (o) : (o))
349 #else /* USE_LISP_UNION_TYPE */
351 /* If union type is not wanted, define Lisp_Object as just a number. */
353 typedef EMACS_INT Lisp_Object
;
354 #define LISP_MAKE_RVALUE(o) (0+(o))
355 #endif /* USE_LISP_UNION_TYPE */
357 /* In the size word of a vector, this bit means the vector has been marked.
358 (Shift -1 left, not 1, to avoid provoking overflow diagnostics.) */
360 #define ARRAY_MARK_FLAG ((EMACS_INT) -1 << (BITS_PER_EMACS_INT - 1))
362 /* In the size word of a struct Lisp_Vector, this bit means it's really
363 some other vector-like object. */
364 #define PSEUDOVECTOR_FLAG ((EMACS_INT) 1 << (BITS_PER_EMACS_INT - 2))
366 /* In a pseudovector, the size field actually contains a word with one
367 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
368 indicate the actual type.
369 We use a bitset, even tho only one of the bits can be set at any
370 particular time just so as to be able to use micro-optimizations such as
371 testing membership of a particular subset of pseudovectors in Fequal.
372 It is not crucial, but there are plenty of bits here, so why not do it? */
375 PVEC_NORMAL_VECTOR
= 0,
376 PVEC_PROCESS
= 0x200,
378 PVEC_COMPILED
= 0x800,
379 PVEC_WINDOW
= 0x1000,
380 PVEC_WINDOW_CONFIGURATION
= 0x2000,
382 PVEC_CHAR_TABLE
= 0x8000,
383 PVEC_BOOL_VECTOR
= 0x10000,
384 PVEC_BUFFER
= 0x20000,
385 PVEC_HASH_TABLE
= 0x40000,
386 PVEC_TERMINAL
= 0x80000,
387 PVEC_SUB_CHAR_TABLE
= 0x100000,
388 PVEC_FONT
= 0x200000,
389 PVEC_OTHER
= 0x400000,
390 PVEC_TYPE_MASK
= 0x7ffe00
392 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
393 GDB. It doesn't work on OS Alpha. Moved to a variable in
395 PVEC_FLAG
= PSEUDOVECTOR_FLAG
399 /* For convenience, we also store the number of elements in these bits.
400 Note that this size is not necessarily the memory-footprint size, but
401 only the number of Lisp_Object fields (that need to be traced by the GC).
402 The distinction is used e.g. by Lisp_Process which places extra
403 non-Lisp_Object fields at the end of the structure. */
404 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
406 /* Number of bits to put in each character in the internal representation
407 of bool vectors. This should not vary across implementations. */
408 #define BOOL_VECTOR_BITS_PER_CHAR 8
410 /* These macros extract various sorts of values from a Lisp_Object.
411 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
412 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
414 #ifndef USE_LISP_UNION_TYPE
416 /* Return a perfect hash of the Lisp_Object representation. */
421 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
422 #define XTYPE(a) ((enum Lisp_Type) ((a) & TYPEMASK))
423 #ifdef USE_2_TAGS_FOR_INTS
424 # define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
425 # define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
426 # define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
428 # define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
429 # define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
430 # define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
432 #define XSET(var, type, ptr) \
433 (eassert (XTYPE ((intptr_t) (ptr)) == 0), /* Check alignment. */ \
434 (var) = (type) | (intptr_t) (ptr))
436 #define XPNTR(a) ((intptr_t) ((a) & ~TYPEMASK))
438 #else /* not USE_LSB_TAG */
440 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
442 /* One need to override this if there must be high bits set in data space
443 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
444 on all machines, but would penalize machines which don't need it)
446 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
448 /* For integers known to be positive, XFASTINT provides fast retrieval
449 and XSETFASTINT provides fast storage. This takes advantage of the
450 fact that Lisp_Int is 0. */
451 #define XFASTINT(a) ((a) + 0)
452 #define XSETFASTINT(a, b) ((a) = (b))
454 /* Extract the value of a Lisp_Object as a (un)signed integer. */
456 #ifdef USE_2_TAGS_FOR_INTS
457 # define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
458 # define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
459 # define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
461 # define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
462 >> (BITS_PER_EMACS_INT - VALBITS))
463 # define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
464 # define make_number(N) \
465 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
468 #define XSET(var, type, ptr) \
469 ((var) = ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
470 + ((intptr_t) (ptr) & VALMASK)))
473 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
474 which were stored in a Lisp_Object */
475 #define XPNTR(a) ((uintptr_t) (((a) & VALMASK)) | DATA_SEG_BITS))
477 #define XPNTR(a) ((uintptr_t) ((a) & VALMASK))
480 #endif /* not USE_LSB_TAG */
482 #else /* USE_LISP_UNION_TYPE */
484 #ifdef USE_2_TAGS_FOR_INTS
485 # error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
488 #define XHASH(a) ((a).i)
489 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
490 #define XINT(a) ((EMACS_INT) (a).s.val)
491 #define XUINT(a) ((EMACS_UINT) (a).u.val)
495 # define XSET(var, vartype, ptr) \
496 (eassert ((((EMACS_UINT) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0), \
497 (var).u.val = ((EMACS_UINT) (ptr)) >> GCTYPEBITS, \
498 (var).u.type = ((char) (vartype)))
500 /* Some versions of gcc seem to consider the bitfield width when issuing
501 the "cast to pointer from integer of different size" warning, so the
502 cast is here to widen the value back to its natural size. */
503 # define XPNTR(v) ((intptr_t) (v).s.val << GCTYPEBITS)
505 #else /* !USE_LSB_TAG */
507 /* For integers known to be positive, XFASTINT provides fast retrieval
508 and XSETFASTINT provides fast storage. This takes advantage of the
509 fact that Lisp_Int is 0. */
510 # define XFASTINT(a) ((a).i + 0)
511 # define XSETFASTINT(a, b) ((a).i = (b))
513 # define XSET(var, vartype, ptr) \
514 (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
517 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
518 which were stored in a Lisp_Object */
519 #define XPNTR(a) ((intptr_t) (XUINT (a) | DATA_SEG_BITS))
521 #define XPNTR(a) ((intptr_t) XUINT (a))
524 #endif /* !USE_LSB_TAG */
526 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
527 #define make_number(N) \
528 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
530 extern Lisp_Object
make_number (EMACS_INT
);
533 #endif /* USE_LISP_UNION_TYPE */
535 /* For integers known to be positive, XFASTINT sometimes provides
536 faster retrieval and XSETFASTINT provides faster storage.
537 If not, fallback on the non-accelerated path. */
539 # define XFASTINT(a) (XINT (a))
540 # define XSETFASTINT(a, b) (XSETINT (a, b))
543 #define EQ(x, y) (XHASH (x) == XHASH (y))
545 /* Number of bits in a fixnum, including the sign bit. */
546 #ifdef USE_2_TAGS_FOR_INTS
547 # define FIXNUM_BITS (VALBITS + 1)
549 # define FIXNUM_BITS VALBITS
552 /* Mask indicating the significant bits of a fixnum. */
553 #define INTMASK (((EMACS_INT) 1 << FIXNUM_BITS) - 1)
555 /* Largest and smallest representable fixnum values. These are the C
557 #define MOST_POSITIVE_FIXNUM (INTMASK / 2)
558 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
560 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
561 written this way so that it also works if I is of unsigned
562 type or if I is a NaN. */
564 #define FIXNUM_OVERFLOW_P(i) \
565 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
567 /* Extract a value or address from a Lisp_Object. */
569 #define XCONS(a) (eassert (CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
570 #define XVECTOR(a) (eassert (VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
571 #define XSTRING(a) (eassert (STRINGP(a)),(struct Lisp_String *) XPNTR(a))
572 #define XSYMBOL(a) (eassert (SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
573 #define XFLOAT(a) (eassert (FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
577 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
578 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC(a)->u_any))
579 #define XMISCTYPE(a) (XMISCANY (a)->type)
580 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC(a)->u_marker))
581 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
582 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
584 /* Forwarding object types. */
586 #define XFWDTYPE(a) (a->u_intfwd.type)
587 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
588 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
589 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
590 #define XBUFFER_OBJFWD(a) \
591 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
592 #define XKBOARD_OBJFWD(a) \
593 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
595 /* Pseudovector types. */
597 #define XPROCESS(a) (eassert (PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
598 #define XWINDOW(a) (eassert (WINDOWP(a)),(struct window *) XPNTR(a))
599 #define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
600 #define XSUBR(a) (eassert (SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
601 #define XBUFFER(a) (eassert (BUFFERP(a)),(struct buffer *) XPNTR(a))
602 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
603 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR(a))
604 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
606 /* Construct a Lisp_Object from a value or address. */
608 #define XSETINT(a, b) (a) = make_number (b)
609 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
610 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
611 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
612 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
613 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
617 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
618 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
620 /* Pseudovector types. */
622 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE(v, header.size, code)
623 #define XSETTYPED_PVECTYPE(v, size_member, code) \
624 ((v)->size_member |= PSEUDOVECTOR_FLAG | (code))
625 #define XSETPVECTYPESIZE(v, code, sizeval) \
626 ((v)->header.size = PSEUDOVECTOR_FLAG | (code) | (sizeval))
628 /* The cast to struct vectorlike_header * avoids aliasing issues. */
629 #define XSETPSEUDOVECTOR(a, b, code) \
630 XSETTYPED_PSEUDOVECTOR(a, b, \
631 ((struct vectorlike_header *) XPNTR (a))->size, \
633 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
634 (XSETVECTOR (a, b), \
635 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
636 == (PSEUDOVECTOR_FLAG | (code))))
638 #define XSETWINDOW_CONFIGURATION(a, b) \
639 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
640 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
641 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
642 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
643 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
644 #define XSETSUBR(a, b) \
645 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
646 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
647 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
648 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
649 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
650 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
652 /* Convenience macros for dealing with Lisp arrays. */
654 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
655 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
656 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
657 #define ASET(ARRAY, IDX, VAL) \
658 (eassert ((IDX) == (IDX)), \
659 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
660 AREF ((ARRAY), (IDX)) = (VAL))
662 /* Convenience macros for dealing with Lisp strings. */
664 #define SDATA(string) (XSTRING (string)->data + 0)
665 #define SREF(string, index) (SDATA (string)[index] + 0)
666 #define SSET(string, index, new) (SDATA (string)[index] = (new))
667 #define SCHARS(string) (XSTRING (string)->size + 0)
668 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
670 /* Avoid "differ in sign" warnings. */
671 #define SSDATA(x) ((char *) SDATA (x))
673 #define STRING_SET_CHARS(string, newsize) \
674 (XSTRING (string)->size = (newsize))
676 #define STRING_COPYIN(string, index, new, count) \
677 memcpy (SDATA (string) + index, new, count)
681 #define CHECK_TYPE(ok, Qxxxp, x) \
682 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
686 /* See the macros in intervals.h. */
688 typedef struct interval
*INTERVAL
;
690 /* Complain if object is not string or buffer type */
691 #define CHECK_STRING_OR_BUFFER(x) \
692 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
695 /* In a cons, the markbit of the car is the gc mark bit */
699 /* Please do not use the names of these elements in code other
700 than the core lisp implementation. Use XCAR and XCDR below. */
701 #ifdef HIDE_LISP_IMPLEMENTATION
706 struct Lisp_Cons
*chain
;
713 struct Lisp_Cons
*chain
;
718 /* Take the car or cdr of something known to be a cons cell. */
719 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
720 of code that has to know what a cons cell looks like. Other code not
721 part of the basic lisp implementation should assume that the car and cdr
722 fields are not accessible as lvalues. (What if we want to switch to
723 a copying collector someday? Cached cons cell field addresses may be
724 invalidated at arbitrary points.) */
725 #ifdef HIDE_LISP_IMPLEMENTATION
726 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
727 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
729 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
730 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
733 /* Use these from normal code. */
734 #define XCAR(c) LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
735 #define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))
737 /* Use these to set the fields of a cons cell.
739 Note that both arguments may refer to the same object, so 'n'
740 should not be read after 'c' is first modified. Also, neither
741 argument should be evaluated more than once; side effects are
742 especially common in the second argument. */
743 #define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
744 #define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))
746 /* Take the car or cdr of something whose type is not known. */
748 (CONSP ((c)) ? XCAR ((c)) \
749 : NILP ((c)) ? Qnil \
750 : wrong_type_argument (Qlistp, (c)))
753 (CONSP ((c)) ? XCDR ((c)) \
754 : NILP ((c)) ? Qnil \
755 : wrong_type_argument (Qlistp, (c)))
757 /* Take the car or cdr of something whose type is not known. */
758 #define CAR_SAFE(c) \
759 (CONSP ((c)) ? XCAR ((c)) : Qnil)
761 #define CDR_SAFE(c) \
762 (CONSP ((c)) ? XCDR ((c)) : Qnil)
764 /* Nonzero if STR is a multibyte string. */
765 #define STRING_MULTIBYTE(STR) \
766 (XSTRING (STR)->size_byte >= 0)
768 /* Return the length in bytes of STR. */
770 #ifdef GC_CHECK_STRING_BYTES
773 extern EMACS_INT
string_bytes (struct Lisp_String
*);
774 #define STRING_BYTES(S) string_bytes ((S))
776 #else /* not GC_CHECK_STRING_BYTES */
778 #define STRING_BYTES(STR) \
779 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
781 #endif /* not GC_CHECK_STRING_BYTES */
783 /* An upper bound on the number of bytes in a Lisp string, not
784 counting the terminating null. This a tight enough bound to
785 prevent integer overflow errors that would otherwise occur during
786 string size calculations. A string cannot contain more bytes than
787 a fixnum can represent, nor can it be so long that C pointer
788 arithmetic stops working on the string plus its terminating null.
789 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
790 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
791 would expose alloc.c internal details that we'd rather keep
792 private. The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is
794 #define STRING_BYTES_BOUND \
795 min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1)
797 /* Mark STR as a unibyte string. */
798 #define STRING_SET_UNIBYTE(STR) \
799 do { if (EQ (STR, empty_multibyte_string)) \
800 (STR) = empty_unibyte_string; \
801 else XSTRING (STR)->size_byte = -1; } while (0)
803 /* Mark STR as a multibyte string. Assure that STR contains only
804 ASCII characters in advance. */
805 #define STRING_SET_MULTIBYTE(STR) \
806 do { if (EQ (STR, empty_unibyte_string)) \
807 (STR) = empty_multibyte_string; \
808 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
810 /* Get text properties. */
811 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
813 /* Set text properties. */
814 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
816 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
822 INTERVAL intervals
; /* text properties in this string */
826 /* Header of vector-like objects. This documents the layout constraints on
827 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
828 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
829 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
830 because when two such pointers potentially alias, a compiler won't
831 incorrectly reorder loads and stores to their size fields. See
832 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
833 struct vectorlike_header
837 /* Pointer to the next vector-like object. It is generally a buffer or a
838 Lisp_Vector alias, so for convenience it is a union instead of a
839 pointer: this way, one can write P->next.vector instead of ((struct
840 Lisp_Vector *) P->next). */
842 struct buffer
*buffer
;
843 struct Lisp_Vector
*vector
;
849 struct vectorlike_header header
;
850 Lisp_Object contents
[1];
853 /* If a struct is made to look like a vector, this macro returns the length
854 of the shortest vector that would hold that struct. */
855 #define VECSIZE(type) ((sizeof (type) \
856 - offsetof (struct Lisp_Vector, contents[0]) \
857 + sizeof(Lisp_Object) - 1) /* round up */ \
858 / sizeof (Lisp_Object))
860 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
861 at the end and we need to compute the number of Lisp_Object fields (the
862 ones that the GC needs to trace). */
863 #define PSEUDOVECSIZE(type, nonlispfield) \
864 ((offsetof(type, nonlispfield) - offsetof(struct Lisp_Vector, contents[0])) \
865 / sizeof (Lisp_Object))
867 /* A char-table is a kind of vectorlike, with contents are like a
868 vector but with a few other slots. For some purposes, it makes
869 sense to handle a char-table with type struct Lisp_Vector. An
870 element of a char table can be any Lisp objects, but if it is a sub
871 char-table, we treat it a table that contains information of a
872 specific range of characters. A sub char-table has the same
873 structure as a vector. A sub char table appears only in an element
874 of a char-table, and there's no way to access it directly from
875 Emacs Lisp program. */
877 /* This is the number of slots that every char table must have. This
878 counts the ordinary slots and the top, defalt, parent, and purpose
880 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
882 /* Return the number of "extra" slots in the char table CT. */
884 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
885 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
889 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
890 ({struct Lisp_Char_Table *_tbl = NULL; \
893 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
894 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
895 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
897 _val = _tbl->defalt; \
898 } while (NILP (_val) && ! NILP (_tbl->parent)); \
901 #else /* not __GNUC__ */
903 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
904 (! NILP (XCHAR_TABLE (CT)->ascii) \
905 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
906 ? XCHAR_TABLE (CT)->ascii \
907 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
908 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
909 : char_table_ref ((CT), (IDX))) \
910 : char_table_ref ((CT), (IDX)))
912 #endif /* not __GNUC__ */
914 /* Compute A OP B, using the unsigned comparison operator OP. A and B
915 should be integer expressions. This is not the same as
916 mathemeatical comparison; for example, UNSIGNED_CMP (0, <, -1)
917 returns 1. For efficiency, prefer plain unsigned comparison if A
918 and B's sizes both fit (after integer promotion). */
919 #define UNSIGNED_CMP(a, op, b) \
920 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
921 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
922 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
924 /* Nonzero iff C is an ASCII character. */
925 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
927 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
928 characters. Do not check validity of CT. */
929 #define CHAR_TABLE_REF(CT, IDX) \
930 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
931 : char_table_ref ((CT), (IDX)))
933 /* Almost equivalent to Faref (CT, IDX). However, if the result is
934 not a character, return IDX.
936 For these characters, do not check validity of CT
937 and do not follow parent. */
938 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
939 char_table_translate (CT, IDX)
941 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
942 8-bit European characters. Do not check validity of CT. */
943 #define CHAR_TABLE_SET(CT, IDX, VAL) \
944 (((IDX) >= 0 && ASCII_CHAR_P (IDX) \
945 && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)) \
946 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
947 : char_table_set (CT, IDX, VAL))
949 #define CHARTAB_SIZE_BITS_0 6
950 #define CHARTAB_SIZE_BITS_1 4
951 #define CHARTAB_SIZE_BITS_2 5
952 #define CHARTAB_SIZE_BITS_3 7
954 extern const int chartab_size
[4];
956 struct Lisp_Sub_Char_Table
;
958 struct Lisp_Char_Table
960 /* HEADER.SIZE is the vector's size field, which also holds the
961 pseudovector type information. It holds the size, too.
962 The size counts the defalt, parent, purpose, ascii,
963 contents, and extras slots. */
964 struct vectorlike_header header
;
966 /* This holds a default value,
967 which is used whenever the value for a specific character is nil. */
970 /* This points to another char table, which we inherit from when the
971 value for a specific character is nil. The `defalt' slot takes
972 precedence over this. */
975 /* This is a symbol which says what kind of use this char-table is
979 /* The bottom sub char-table for characters of the range 0..127. It
980 is nil if none of ASCII character has a specific value. */
983 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
985 /* These hold additional data. It is a vector. */
986 Lisp_Object extras
[1];
989 struct Lisp_Sub_Char_Table
991 /* HEADER.SIZE is the vector's size field, which also holds the
992 pseudovector type information. It holds the size, too. */
993 struct vectorlike_header header
;
995 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
996 char-table of depth 1 contains 16 elements, and each element
997 covers 4096 (128*32) characters. A sub char-table of depth 2
998 contains 32 elements, and each element covers 128 characters. A
999 sub char-table of depth 3 contains 128 elements, and each element
1000 is for one character. */
1003 /* Minimum character covered by the sub char-table. */
1004 Lisp_Object min_char
;
1006 Lisp_Object contents
[1];
1009 /* A boolvector is a kind of vectorlike, with contents are like a string. */
1010 struct Lisp_Bool_Vector
1012 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1013 just the subtype information. */
1014 struct vectorlike_header header
;
1015 /* This is the size in bits. */
1017 /* This contains the actual bits, packed into bytes. */
1018 unsigned char data
[1];
1021 /* This structure describes a built-in function.
1022 It is generated by the DEFUN macro only.
1023 defsubr makes it into a Lisp object.
1025 This type is treated in most respects as a pseudovector,
1026 but since we never dynamically allocate or free them,
1027 we don't need a struct vectorlike_header and its 'next' field. */
1033 Lisp_Object (*a0
) (void);
1034 Lisp_Object (*a1
) (Lisp_Object
);
1035 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1036 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1037 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1038 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1039 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1040 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1041 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1042 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1043 Lisp_Object (*aMANY
) (size_t, Lisp_Object
*);
1045 short min_args
, max_args
;
1046 const char *symbol_name
;
1047 const char *intspec
;
1052 /***********************************************************************
1054 ***********************************************************************/
1056 /* Interned state of a symbol. */
1058 enum symbol_interned
1060 SYMBOL_UNINTERNED
= 0,
1061 SYMBOL_INTERNED
= 1,
1062 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1065 enum symbol_redirect
1067 SYMBOL_PLAINVAL
= 4,
1068 SYMBOL_VARALIAS
= 1,
1069 SYMBOL_LOCALIZED
= 2,
1070 SYMBOL_FORWARDED
= 3
1073 /* In a symbol, the markbit of the plist is used as the gc mark bit */
1077 unsigned gcmarkbit
: 1;
1079 /* Indicates where the value can be found:
1080 0 : it's a plain var, the value is in the `value' field.
1081 1 : it's a varalias, the value is really in the `alias' symbol.
1082 2 : it's a localized var, the value is in the `blv' object.
1083 3 : it's a forwarding variable, the value is in `forward'.
1085 enum symbol_redirect redirect
: 3;
1087 /* Non-zero means symbol is constant, i.e. changing its value
1088 should signal an error. If the value is 3, then the var
1089 can be changed, but only by `defconst'. */
1090 unsigned constant
: 2;
1092 /* Interned state of the symbol. This is an enumerator from
1093 enum symbol_interned. */
1094 unsigned interned
: 2;
1096 /* Non-zero means that this variable has been explicitly declared
1097 special (with `defvar' etc), and shouldn't be lexically bound. */
1098 unsigned declared_special
: 1;
1100 /* The symbol's name, as a Lisp string.
1102 The name "xname" is used to intentionally break code referring to
1103 the old field "name" of type pointer to struct Lisp_String. */
1106 /* Value of the symbol or Qunbound if unbound. If this symbol is a
1107 defvaralias, `alias' contains the symbol for which it is an
1108 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
1109 and set a symbol's value, to take defvaralias into account. */
1112 struct Lisp_Symbol
*alias
;
1113 struct Lisp_Buffer_Local_Value
*blv
;
1114 union Lisp_Fwd
*fwd
;
1117 /* Function value of the symbol or Qunbound if not fboundp. */
1118 Lisp_Object function
;
1120 /* The symbol's property list. */
1123 /* Next symbol in obarray bucket, if the symbol is interned. */
1124 struct Lisp_Symbol
*next
;
1127 /* Value is name of symbol. */
1129 #define SYMBOL_VAL(sym) \
1130 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1131 #define SYMBOL_ALIAS(sym) \
1132 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1133 #define SYMBOL_BLV(sym) \
1134 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1135 #define SYMBOL_FWD(sym) \
1136 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1137 #define SET_SYMBOL_VAL(sym, v) \
1138 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1139 #define SET_SYMBOL_ALIAS(sym, v) \
1140 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1141 #define SET_SYMBOL_BLV(sym, v) \
1142 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1143 #define SET_SYMBOL_FWD(sym, v) \
1144 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1146 #define SYMBOL_NAME(sym) \
1147 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1149 /* Value is non-zero if SYM is an interned symbol. */
1151 #define SYMBOL_INTERNED_P(sym) \
1152 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1154 /* Value is non-zero if SYM is interned in initial_obarray. */
1156 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1157 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1159 /* Value is non-zero if symbol is considered a constant, i.e. its
1160 value cannot be changed (there is an exception for keyword symbols,
1161 whose value can be set to the keyword symbol itself). */
1163 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1166 /***********************************************************************
1168 ***********************************************************************/
1170 /* The structure of a Lisp hash table. */
1172 struct Lisp_Hash_Table
1174 /* This is for Lisp; the hash table code does not refer to it. */
1175 struct vectorlike_header header
;
1177 /* Function used to compare keys. */
1180 /* Nil if table is non-weak. Otherwise a symbol describing the
1181 weakness of the table. */
1184 /* When the table is resized, and this is an integer, compute the
1185 new size by adding this to the old size. If a float, compute the
1186 new size by multiplying the old size with this factor. */
1187 Lisp_Object rehash_size
;
1189 /* Resize hash table when number of entries/ table size is >= this
1191 Lisp_Object rehash_threshold
;
1193 /* Vector of hash codes.. If hash[I] is nil, this means that that
1194 entry I is unused. */
1197 /* Vector used to chain entries. If entry I is free, next[I] is the
1198 entry number of the next free item. If entry I is non-free,
1199 next[I] is the index of the next entry in the collision chain. */
1202 /* Index of first free entry in free list. */
1203 Lisp_Object next_free
;
1205 /* Bucket vector. A non-nil entry is the index of the first item in
1206 a collision chain. This vector's size can be larger than the
1207 hash table size to reduce collisions. */
1210 /* User-supplied hash function, or nil. */
1211 Lisp_Object user_hash_function
;
1213 /* User-supplied key comparison function, or nil. */
1214 Lisp_Object user_cmp_function
;
1216 /* Only the fields above are traced normally by the GC. The ones below
1217 `count' are special and are either ignored by the GC or traced in
1218 a special way (e.g. because of weakness). */
1220 /* Number of key/value entries in the table. */
1223 /* Vector of keys and values. The key of item I is found at index
1224 2 * I, the value is found at index 2 * I + 1.
1225 This is gc_marked specially if the table is weak. */
1226 Lisp_Object key_and_value
;
1228 /* Next weak hash table if this is a weak hash table. The head
1229 of the list is in weak_hash_tables. */
1230 struct Lisp_Hash_Table
*next_weak
;
1232 /* C function to compare two keys. */
1233 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1234 Lisp_Object
, EMACS_UINT
,
1235 Lisp_Object
, EMACS_UINT
);
1237 /* C function to compute hash code. */
1238 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1242 #define XHASH_TABLE(OBJ) \
1243 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1245 #define XSET_HASH_TABLE(VAR, PTR) \
1246 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1248 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1250 #define CHECK_HASH_TABLE(x) \
1251 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1253 /* Value is the key part of entry IDX in hash table H. */
1255 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1257 /* Value is the value part of entry IDX in hash table H. */
1259 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1261 /* Value is the index of the next entry following the one at IDX
1264 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1266 /* Value is the hash code computed for entry IDX in hash table H. */
1268 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1270 /* Value is the index of the element in hash table H that is the
1271 start of the collision list at index IDX in the index vector of H. */
1273 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1275 /* Value is the size of hash table H. */
1277 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1279 /* Default size for hash tables if not specified. */
1281 #define DEFAULT_HASH_SIZE 65
1283 /* Default threshold specifying when to resize a hash table. The
1284 value gives the ratio of current entries in the hash table and the
1285 size of the hash table. */
1287 #define DEFAULT_REHASH_THRESHOLD 0.8
1289 /* Default factor by which to increase the size of a hash table. */
1291 #define DEFAULT_REHASH_SIZE 1.5
1294 /* These structures are used for various misc types. */
1296 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1298 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_??? */
1299 unsigned gcmarkbit
: 1;
1301 /* Make it as long as "Lisp_Free without padding". */
1307 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Marker */
1308 unsigned gcmarkbit
: 1;
1310 /* This flag is temporarily used in the functions
1311 decode/encode_coding_object to record that the marker position
1312 must be adjusted after the conversion. */
1313 unsigned int need_adjustment
: 1;
1314 /* 1 means normal insertion at the marker's position
1315 leaves the marker after the inserted text. */
1316 unsigned int insertion_type
: 1;
1317 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1318 Note: a chain of markers can contain markers pointing into different
1319 buffers (the chain is per buffer_text rather than per buffer, so it's
1320 shared between indirect buffers). */
1321 /* This is used for (other than NULL-checking):
1323 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1324 - unchain_marker: to find the list from which to unchain.
1325 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1327 struct buffer
*buffer
;
1329 /* The remaining fields are meaningless in a marker that
1330 does not point anywhere. */
1332 /* For markers that point somewhere,
1333 this is used to chain of all the markers in a given buffer. */
1334 /* We could remove it and use an array in buffer_text instead.
1335 That would also allow to preserve it ordered. */
1336 struct Lisp_Marker
*next
;
1337 /* This is the char position where the marker points. */
1339 /* This is the byte position.
1340 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1341 used to implement the functionality of markers, but rather to (ab)use
1342 markers as a cache for char<->byte mappings). */
1346 /* Forwarding pointer to an int variable.
1347 This is allowed only in the value cell of a symbol,
1348 and it means that the symbol's value really lives in the
1349 specified int variable. */
1352 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1356 /* Boolean forwarding pointer to an int variable.
1357 This is like Lisp_Intfwd except that the ostensible
1358 "value" of the symbol is t if the int variable is nonzero,
1359 nil if it is zero. */
1362 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1366 /* Forwarding pointer to a Lisp_Object variable.
1367 This is allowed only in the value cell of a symbol,
1368 and it means that the symbol's value really lives in the
1369 specified variable. */
1372 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1373 Lisp_Object
*objvar
;
1376 /* Like Lisp_Objfwd except that value lives in a slot in the
1377 current buffer. Value is byte index of slot within buffer. */
1378 struct Lisp_Buffer_Objfwd
1380 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1382 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1385 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1386 the symbol has buffer-local or frame-local bindings. (Exception:
1387 some buffer-local variables are built-in, with their values stored
1388 in the buffer structure itself. They are handled differently,
1389 using struct Lisp_Buffer_Objfwd.)
1391 The `realvalue' slot holds the variable's current value, or a
1392 forwarding pointer to where that value is kept. This value is the
1393 one that corresponds to the loaded binding. To read or set the
1394 variable, you must first make sure the right binding is loaded;
1395 then you can access the value in (or through) `realvalue'.
1397 `buffer' and `frame' are the buffer and frame for which the loaded
1398 binding was found. If those have changed, to make sure the right
1399 binding is loaded it is necessary to find which binding goes with
1400 the current buffer and selected frame, then load it. To load it,
1401 first unload the previous binding, then copy the value of the new
1402 binding into `realvalue' (or through it). Also update
1403 LOADED-BINDING to point to the newly loaded binding.
1405 `local_if_set' indicates that merely setting the variable creates a
1406 local binding for the current buffer. Otherwise the latter, setting
1407 the variable does not do that; only make-local-variable does that. */
1409 struct Lisp_Buffer_Local_Value
1411 /* 1 means that merely setting the variable creates a local
1412 binding for the current buffer */
1413 unsigned int local_if_set
: 1;
1414 /* 1 means this variable can have frame-local bindings, otherwise, it is
1415 can have buffer-local bindings. The two cannot be combined. */
1416 unsigned int frame_local
: 1;
1417 /* 1 means that the binding now loaded was found.
1418 Presumably equivalent to (defcell!=valcell) */
1419 unsigned int found
: 1;
1420 /* If non-NULL, a forwarding to the C var where it should also be set. */
1421 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1422 /* The buffer or frame for which the loaded binding was found. */
1424 /* A cons cell that holds the default value. It has the form
1425 (SYMBOL . DEFAULT-VALUE). */
1426 Lisp_Object defcell
;
1427 /* The cons cell from `where's parameter alist.
1428 It always has the form (SYMBOL . VALUE)
1429 Note that if `forward' is non-nil, VALUE may be out of date.
1430 Also if the currently loaded binding is the default binding, then
1431 this is `eq'ual to defcell. */
1432 Lisp_Object valcell
;
1435 #define BLV_FOUND(blv) \
1436 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1437 #define SET_BLV_FOUND(blv, v) \
1438 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1440 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1441 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1443 /* START and END are markers in the overlay's buffer, and
1444 PLIST is the overlay's property list. */
1446 /* An overlay's real data content is:
1449 - insertion type of both ends
1450 - start & start_byte
1452 - next (singly linked list of overlays).
1453 - start_next and end_next (singly linked list of markers).
1454 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1457 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Overlay */
1458 unsigned gcmarkbit
: 1;
1460 struct Lisp_Overlay
*next
;
1461 Lisp_Object start
, end
, plist
;
1464 /* Like Lisp_Objfwd except that value lives in a slot in the
1466 struct Lisp_Kboard_Objfwd
1468 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1472 /* Hold a C pointer for later use.
1473 This type of object is used in the arg to record_unwind_protect. */
1474 struct Lisp_Save_Value
1476 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Save_Value */
1477 unsigned gcmarkbit
: 1;
1479 /* If DOGC is set, POINTER is the address of a memory
1480 area containing INTEGER potential Lisp_Objects. */
1481 unsigned int dogc
: 1;
1487 /* A miscellaneous object, when it's on the free list. */
1490 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Free */
1491 unsigned gcmarkbit
: 1;
1493 union Lisp_Misc
*chain
;
1495 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1496 This assumes that Lisp_Marker is the largest of the alternatives and
1497 that Lisp_Misc_Any has the same size as "Lisp_Free w/o padding". */
1498 char padding
[((((sizeof (struct Lisp_Marker
) - 1) >> GCTYPEBITS
) + 1)
1499 << GCTYPEBITS
) - sizeof (struct Lisp_Misc_Any
)];
1503 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1504 It uses one of these struct subtypes to get the type field. */
1508 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1509 struct Lisp_Free u_free
; /* Includes padding to force alignment. */
1510 struct Lisp_Marker u_marker
; /* 5 */
1511 struct Lisp_Overlay u_overlay
; /* 5 */
1512 struct Lisp_Save_Value u_save_value
; /* 3 */
1517 struct Lisp_Intfwd u_intfwd
; /* 2 */
1518 struct Lisp_Boolfwd u_boolfwd
; /* 2 */
1519 struct Lisp_Objfwd u_objfwd
; /* 2 */
1520 struct Lisp_Buffer_Objfwd u_buffer_objfwd
; /* 2 */
1521 struct Lisp_Kboard_Objfwd u_kboard_objfwd
; /* 2 */
1524 /* Lisp floating point type */
1529 #ifdef HIDE_LISP_IMPLEMENTATION
1534 struct Lisp_Float
*chain
;
1538 #ifdef HIDE_LISP_IMPLEMENTATION
1539 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1541 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1542 /* This should be used only in alloc.c, which always disables
1543 HIDE_LISP_IMPLEMENTATION. */
1544 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1547 /* A character, declared with the following typedef, is a member
1548 of some character set associated with the current buffer. */
1549 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1551 typedef unsigned char UCHAR
;
1554 /* Meanings of slots in a Lisp_Compiled: */
1556 #define COMPILED_ARGLIST 0
1557 #define COMPILED_BYTECODE 1
1558 #define COMPILED_CONSTANTS 2
1559 #define COMPILED_STACK_DEPTH 3
1560 #define COMPILED_DOC_STRING 4
1561 #define COMPILED_INTERACTIVE 5
1563 /* Flag bits in a character. These also get used in termhooks.h.
1564 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1565 (MUlti-Lingual Emacs) might need 22 bits for the character value
1566 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1567 #define CHAR_ALT (0x0400000)
1568 #define CHAR_SUPER (0x0800000)
1569 #define CHAR_HYPER (0x1000000)
1570 #define CHAR_SHIFT (0x2000000)
1571 #define CHAR_CTL (0x4000000)
1572 #define CHAR_META (0x8000000)
1574 #define CHAR_MODIFIER_MASK \
1575 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1578 /* Actually, the current Emacs uses 22 bits for the character value
1580 #define CHARACTERBITS 22
1582 /* The maximum byte size consumed by push_key_description.
1583 All callers should assure that at least this size of memory is
1584 allocated at the place pointed by the second argument.
1586 There are 6 modifiers, each consumes 2 chars.
1587 The octal form of a character code consumes
1588 (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
1589 We need one more byte for string terminator `\0'. */
1590 #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)
1593 /* The glyph datatype, used to represent characters on the display.
1594 It consists of a char code and a face id. */
1601 /* Return a glyph's character code. */
1602 #define GLYPH_CHAR(glyph) ((glyph).ch)
1604 /* Return a glyph's face ID. */
1605 #define GLYPH_FACE(glyph) ((glyph).face_id)
1607 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1608 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1609 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1611 /* Return 1 if GLYPH contains valid character code. */
1612 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph), 1)
1615 /* Glyph Code from a display vector may either be an integer which
1616 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1617 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1619 #define GLYPH_CODE_CHAR(gc) \
1620 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1622 #define GLYPH_CODE_FACE(gc) \
1623 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1625 /* Return 1 if glyph code from display vector contains valid character code. */
1626 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc), 1)
1628 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1630 /* Only called when GLYPH_CODE_P (gc) is true. */
1631 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1635 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1637 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1638 (XINT (gc) >> CHARACTERBITS)); \
1642 /* The ID of the mode line highlighting face. */
1643 #define GLYPH_MODE_LINE_FACE 1
1645 /* Structure to hold mouse highlight data. This is here because other
1646 header files need it for defining struct x_output etc. */
1648 /* These variables describe the range of text currently shown in its
1649 mouse-face, together with the window they apply to. As long as
1650 the mouse stays within this range, we need not redraw anything on
1651 its account. Rows and columns are glyph matrix positions in
1652 MOUSE_FACE_WINDOW. */
1653 int mouse_face_beg_row
, mouse_face_beg_col
;
1654 int mouse_face_beg_x
, mouse_face_beg_y
;
1655 int mouse_face_end_row
, mouse_face_end_col
;
1656 int mouse_face_end_x
, mouse_face_end_y
;
1657 int mouse_face_past_end
;
1658 Lisp_Object mouse_face_window
;
1659 int mouse_face_face_id
;
1660 Lisp_Object mouse_face_overlay
;
1662 /* 1 if a mouse motion event came and we didn't handle it right away because
1663 gc was in progress. */
1664 int mouse_face_deferred_gc
;
1666 /* FRAME and X, Y position of mouse when last checked for
1667 highlighting. X and Y can be negative or out of range for the frame. */
1668 struct frame
*mouse_face_mouse_frame
;
1669 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1671 /* Nonzero means defer mouse-motion highlighting. */
1672 int mouse_face_defer
;
1674 /* Nonzero means that the mouse highlight should not be shown. */
1675 int mouse_face_hidden
;
1677 int mouse_face_image_state
;
1680 /* Data type checking */
1682 #define NILP(x) EQ (x, Qnil)
1684 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1685 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1687 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1688 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1689 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1690 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1691 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1692 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1694 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1695 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1696 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1697 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1698 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1700 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1701 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1702 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1703 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1704 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1706 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1707 vectorlike_header * avoids aliasing issues. */
1708 #define PSEUDOVECTORP(x, code) \
1709 TYPED_PSEUDOVECTORP(x, vectorlike_header, code)
1711 /* True if object X, with internal type struct T *, is a pseudovector whose
1713 #define TYPED_PSEUDOVECTORP(x, t, code) \
1715 && (((((struct t *) XPNTR (x))->size \
1716 & (PSEUDOVECTOR_FLAG | (code)))) \
1717 == (PSEUDOVECTOR_FLAG | (code))))
1719 /* Test for specific pseudovector types. */
1720 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1721 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1722 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1723 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1724 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1725 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1726 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1727 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1728 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1729 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1730 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1731 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1733 /* Test for image (image . spec) */
1734 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1739 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1741 #define CHECK_LIST(x) \
1742 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1744 #define CHECK_LIST_CONS(x, y) \
1745 CHECK_TYPE (CONSP (x), Qlistp, y)
1747 #define CHECK_LIST_END(x, y) \
1748 CHECK_TYPE (NILP (x), Qlistp, y)
1750 #define CHECK_STRING(x) \
1751 CHECK_TYPE (STRINGP (x), Qstringp, x)
1753 #define CHECK_STRING_CAR(x) \
1754 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1756 #define CHECK_CONS(x) \
1757 CHECK_TYPE (CONSP (x), Qconsp, x)
1759 #define CHECK_SYMBOL(x) \
1760 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1762 #define CHECK_CHAR_TABLE(x) \
1763 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1765 #define CHECK_VECTOR(x) \
1766 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1768 #define CHECK_VECTOR_OR_STRING(x) \
1769 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1771 #define CHECK_ARRAY(x, Qxxxp) \
1772 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1774 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1775 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1777 #define CHECK_BUFFER(x) \
1778 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1780 #define CHECK_WINDOW(x) \
1781 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1783 #define CHECK_WINDOW_CONFIGURATION(x) \
1784 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1786 /* This macro rejects windows on the interior of the window tree as
1787 "dead", which is what we want; this is an argument-checking macro, and
1788 the user should never get access to interior windows.
1790 A window of any sort, leaf or interior, is dead if the buffer,
1791 vchild, and hchild members are all nil. */
1793 #define CHECK_LIVE_WINDOW(x) \
1794 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1796 #define CHECK_PROCESS(x) \
1797 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1799 #define CHECK_SUBR(x) \
1800 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1802 #define CHECK_NUMBER(x) \
1803 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1805 #define CHECK_NATNUM(x) \
1806 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1808 #define CHECK_MARKER(x) \
1809 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1811 #define CHECK_NUMBER_COERCE_MARKER(x) \
1812 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1813 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1815 #define XFLOATINT(n) extract_float((n))
1817 #define CHECK_FLOAT(x) \
1818 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1820 #define CHECK_NUMBER_OR_FLOAT(x) \
1821 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1823 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1824 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1825 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1827 #define CHECK_OVERLAY(x) \
1828 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1830 /* Since we can't assign directly to the CAR or CDR fields of a cons
1831 cell, use these when checking that those fields contain numbers. */
1832 #define CHECK_NUMBER_CAR(x) \
1834 Lisp_Object tmp = XCAR (x); \
1835 CHECK_NUMBER (tmp); \
1836 XSETCAR ((x), tmp); \
1839 #define CHECK_NUMBER_CDR(x) \
1841 Lisp_Object tmp = XCDR (x); \
1842 CHECK_NUMBER (tmp); \
1843 XSETCDR ((x), tmp); \
1846 #define CHECK_NATNUM_CAR(x) \
1848 Lisp_Object tmp = XCAR (x); \
1849 CHECK_NATNUM (tmp); \
1850 XSETCAR ((x), tmp); \
1853 #define CHECK_NATNUM_CDR(x) \
1855 Lisp_Object tmp = XCDR (x); \
1856 CHECK_NATNUM (tmp); \
1857 XSETCDR ((x), tmp); \
1860 /* Cast pointers to this type to compare them. */
1861 #define PNTR_COMPARISON_TYPE uintptr_t
1863 /* Define a built-in function for calling from Lisp.
1864 `lname' should be the name to give the function in Lisp,
1865 as a null-terminated C string.
1866 `fnname' should be the name of the function in C.
1867 By convention, it starts with F.
1868 `sname' should be the name for the C constant structure
1869 that records information on this function for internal use.
1870 By convention, it should be the same as `fnname' but with S instead of F.
1871 It's too bad that C macros can't compute this from `fnname'.
1872 `minargs' should be a number, the minimum number of arguments allowed.
1873 `maxargs' should be a number, the maximum number of arguments allowed,
1874 or else MANY or UNEVALLED.
1875 MANY means pass a vector of evaluated arguments,
1876 in the form of an integer number-of-arguments
1877 followed by the address of a vector of Lisp_Objects
1878 which contains the argument values.
1879 UNEVALLED means pass the list of unevaluated arguments
1880 `intspec' says how interactive arguments are to be fetched.
1881 If the string starts with a `(', `intspec' is evaluated and the resulting
1882 list is the list of arguments.
1883 If it's a string that doesn't start with `(', the value should follow
1884 the one of the doc string for `interactive'.
1885 A null string means call interactively with no arguments.
1886 `doc' is documentation for the user. */
1888 /* This version of DEFUN declares a function prototype with the right
1889 arguments, so we can catch errors with maxargs at compile-time. */
1890 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1891 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1892 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1893 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1894 { .a ## maxargs = fnname }, \
1895 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 (size_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, \
1985 (int)((char *)(¤t_kboard->vname ## _) \
1986 - (char *)current_kboard)); \
1991 /* Structure for recording Lisp call stack for backtrace purposes. */
1993 /* The special binding stack holds the outer values of variables while
1994 they are bound by a function application or a let form, stores the
1995 code to be executed for Lisp unwind-protect forms, and stores the C
1996 functions to be called for record_unwind_protect.
1998 If func is non-zero, undoing this binding applies func to old_value;
1999 This implements record_unwind_protect.
2001 Otherwise, the element is a variable binding.
2003 If the symbol field is a symbol, it is an ordinary variable binding.
2005 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2006 which means having bound a local value while CURRENT-BUFFER was active.
2007 If WHERE is nil this means we saw the default value when binding SYMBOL.
2008 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2009 value. Other values of WHERE mean an internal error. */
2011 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2015 Lisp_Object symbol
, old_value
;
2016 specbinding_func func
;
2017 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
2020 extern struct specbinding
*specpdl
;
2021 extern struct specbinding
*specpdl_ptr
;
2022 extern EMACS_INT specpdl_size
;
2024 #define SPECPDL_INDEX() ((int) (specpdl_ptr - specpdl))
2026 /* Everything needed to describe an active condition case. */
2029 /* The handler clauses and variable from the condition-case form. */
2030 /* For a handler set up in Lisp code, this is always a list.
2031 For an internal handler set up by internal_condition_case*,
2032 this can instead be the symbol t or `error'.
2033 t: handle all conditions.
2034 error: handle all conditions, and errors can run the debugger
2035 or display a backtrace. */
2036 Lisp_Object handler
;
2038 /* Fsignal stores here the condition-case clause that applies,
2039 and Fcondition_case thus knows which clause to run. */
2040 Lisp_Object chosen_clause
;
2042 /* Used to effect the longjump out to the handler. */
2043 struct catchtag
*tag
;
2045 /* The next enclosing handler. */
2046 struct handler
*next
;
2049 /* This structure helps implement the `catch' and `throw' control
2050 structure. A struct catchtag contains all the information needed
2051 to restore the state of the interpreter after a non-local jump.
2053 Handlers for error conditions (represented by `struct handler'
2054 structures) just point to a catch tag to do the cleanup required
2057 catchtag structures are chained together in the C calling stack;
2058 the `next' member points to the next outer catchtag.
2060 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2061 member is TAG, and then unbinds to it. The `val' member is used to
2062 hold VAL while the stack is unwound; `val' is returned as the value
2065 All the other members are concerned with restoring the interpreter
2072 struct catchtag
*next
;
2073 struct gcpro
*gcpro
;
2075 struct backtrace
*backlist
;
2076 struct handler
*handlerlist
;
2077 int lisp_eval_depth
;
2079 int poll_suppress_count
;
2080 int interrupt_input_blocked
;
2081 struct byte_stack
*byte_stack
;
2084 extern Lisp_Object memory_signal_data
;
2086 /* An address near the bottom of the stack.
2087 Tells GC how to save a copy of the stack. */
2088 extern char *stack_bottom
;
2090 /* Check quit-flag and quit if it is non-nil.
2091 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2092 So the program needs to do QUIT at times when it is safe to quit.
2093 Every loop that might run for a long time or might not exit
2094 ought to do QUIT at least once, at a safe place.
2095 Unless that is impossible, of course.
2096 But it is very desirable to avoid creating loops where QUIT is impossible.
2098 Exception: if you set immediate_quit to nonzero,
2099 then the handler that responds to the C-g does the quit itself.
2100 This is a good thing to do around a loop that has no side effects
2101 and (in particular) cannot call arbitrary Lisp code. */
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 */
2115 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2117 Lisp_Object flag = Vquit_flag; \
2118 Vquit_flag = Qnil; \
2119 if (EQ (Vthrow_on_input, flag)) \
2120 Fthrow (Vthrow_on_input, Qt); \
2121 Fsignal (Qquit, Qnil); \
2123 ELSE_PENDING_SIGNALS \
2127 /* Nonzero if ought to quit now. */
2129 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2131 extern Lisp_Object Vascii_downcase_table
;
2132 extern Lisp_Object Vascii_canon_table
;
2134 /* Number of bytes of structure consed since last GC. */
2136 extern EMACS_INT consing_since_gc
;
2138 extern EMACS_INT gc_relative_threshold
;
2140 extern EMACS_INT memory_full_cons_threshold
;
2142 /* Structure for recording stack slots that need marking. */
2144 /* This is a chain of structures, each of which points at a Lisp_Object
2145 variable whose value should be marked in garbage collection.
2146 Normally every link of the chain is an automatic variable of a function,
2147 and its `val' points to some argument or local variable of the function.
2148 On exit to the function, the chain is set back to the value it had on entry.
2149 This way, no link remains in the chain when the stack frame containing the
2152 Every function that can call Feval must protect in this fashion all
2153 Lisp_Object variables whose contents will be used again. */
2155 extern struct gcpro
*gcprolist
;
2161 /* Address of first protected variable. */
2162 volatile Lisp_Object
*var
;
2164 /* Number of consecutive protected variables. */
2172 /* Values of GC_MARK_STACK during compilation:
2174 0 Use GCPRO as before
2175 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2176 2 Mark the stack, and check that everything GCPRO'd is
2178 3 Mark using GCPRO's, mark stack last, and count how many
2179 dead objects are kept alive. */
2182 #define GC_USE_GCPROS_AS_BEFORE 0
2183 #define GC_MAKE_GCPROS_NOOPS 1
2184 #define GC_MARK_STACK_CHECK_GCPROS 2
2185 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2187 #ifndef GC_MARK_STACK
2188 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2191 /* Whether we do the stack marking manually. */
2192 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2193 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2196 #define GCPRO1(var) \
2197 GCPRO1_VAR (var, gcpro)
2198 #define GCPRO2(var1, var2) \
2199 GCPRO2_VAR (var1, var2, gcpro)
2200 #define GCPRO3(var1, var2, var3) \
2201 GCPRO3_VAR (var1, var2, var3, gcpro)
2202 #define GCPRO4(var1, var2, var3, var4) \
2203 GCPRO4_VAR (var1, var2, var3, var4, gcpro)
2204 #define GCPRO5(var1, var2, var3, var4, var5) \
2205 GCPRO5_VAR (var1, var2, var3, var4, var5, gcpro)
2206 #define GCPRO6(var1, var2, var3, var4, var5, var6) \
2207 GCPRO6_VAR (var1, var2, var3, var4, var5, var6, gcpro)
2208 #define UNGCPRO UNGCPRO_VAR (gcpro)
2210 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2212 /* Do something silly with gcproN vars just so gcc shuts up. */
2213 /* You get warnings from MIPSPro... */
2215 #define GCPRO1_VAR(var, gcpro) ((void) gcpro##1)
2216 #define GCPRO2_VAR(var1, var2, gcpro) \
2217 ((void) gcpro##2, (void) gcpro##1)
2218 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2219 ((void) gcpro##3, (void) gcpro##2, (void) gcpro##1)
2220 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2221 ((void) gcpro##4, (void) gcpro##3, (void) gcpro##2, (void) gcpro##1)
2222 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2223 ((void) gcpro##5, (void) gcpro##4, (void) gcpro##3, (void) gcpro##2, \
2225 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2226 ((void) gcpro##6, (void) gcpro##5, (void) gcpro##4, (void) gcpro##3, \
2227 (void) gcpro##2, (void) gcpro##1)
2228 #define UNGCPRO_VAR(gcpro) ((void) 0)
2230 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2234 #define GCPRO1_VAR(var, gcpro) \
2235 {gcpro##1.next = gcprolist; gcpro##1.var = &var; gcpro##1.nvars = 1; \
2236 gcprolist = &gcpro##1; }
2238 #define GCPRO2_VAR(var1, var2, gcpro) \
2239 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2240 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2241 gcprolist = &gcpro##2; }
2243 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2244 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2245 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2246 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2247 gcprolist = &gcpro##3; }
2249 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2250 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2251 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2252 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2253 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2254 gcprolist = &gcpro##4; }
2256 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2257 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2258 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2259 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2260 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2261 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2262 gcprolist = &gcpro##5; }
2264 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2265 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2266 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2267 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2268 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2269 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2270 gcpro##6.next = &gcpro##5; gcpro##6.var = &var6; gcpro##6.nvars = 1; \
2271 gcprolist = &gcpro##6; }
2273 #define UNGCPRO_VAR(gcpro) (gcprolist = gcpro##1.next)
2277 extern int gcpro_level
;
2279 #define GCPRO1_VAR(var, gcpro) \
2280 {gcpro##1.next = gcprolist; gcpro##1.var = &var; gcpro##1.nvars = 1; \
2281 gcpro##1.level = gcpro_level++; \
2282 gcprolist = &gcpro##1; }
2284 #define GCPRO2_VAR(var1, var2, gcpro) \
2285 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2286 gcpro##1.level = gcpro_level; \
2287 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2288 gcpro##2.level = gcpro_level++; \
2289 gcprolist = &gcpro##2; }
2291 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2292 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2293 gcpro##1.level = gcpro_level; \
2294 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2295 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2296 gcpro##3.level = gcpro_level++; \
2297 gcprolist = &gcpro##3; }
2299 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2300 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2301 gcpro##1.level = gcpro_level; \
2302 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2303 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2304 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2305 gcpro##4.level = gcpro_level++; \
2306 gcprolist = &gcpro##4; }
2308 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2309 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2310 gcpro##1.level = gcpro_level; \
2311 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2312 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2313 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2314 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2315 gcpro##5.level = gcpro_level++; \
2316 gcprolist = &gcpro##5; }
2318 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2319 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2320 gcpro##1.level = gcpro_level; \
2321 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2322 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2323 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2324 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2325 gcpro##6.next = &gcpro##5; gcpro##6.var = &var6; gcpro##6.nvars = 1; \
2326 gcpro##6.level = gcpro_level++; \
2327 gcprolist = &gcpro##6; }
2329 #define UNGCPRO_VAR(gcpro) \
2330 ((--gcpro_level != gcpro##1.level) \
2332 : ((gcprolist = gcpro##1.next), 0))
2334 #endif /* DEBUG_GCPRO */
2335 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2338 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2339 #define RETURN_UNGCPRO(expr) \
2342 Lisp_Object ret_ungc_val; \
2343 ret_ungc_val = (expr); \
2345 return ret_ungc_val; \
2349 /* Call staticpro (&var) to protect static variable `var'. */
2351 void staticpro (Lisp_Object
*);
2353 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2354 meaning as in the DEFUN macro, and is used to construct a prototype. */
2355 /* We can use the same trick as in the DEFUN macro to generate the
2356 appropriate prototype. */
2357 #define EXFUN(fnname, maxargs) \
2358 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2360 /* Forward declarations for prototypes. */
2364 /* Defined in data.c. */
2365 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2366 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2367 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2368 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2369 extern Lisp_Object Qinvalid_read_syntax
;
2370 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2371 extern Lisp_Object Qend_of_file
, Qarith_error
, Qmark_inactive
;
2372 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2373 extern Lisp_Object Qtext_read_only
;
2374 extern Lisp_Object Qinteractive_form
;
2375 extern Lisp_Object Qcircular_list
;
2376 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2377 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2378 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2379 extern Lisp_Object Qbuffer_or_string_p
;
2380 extern Lisp_Object Qfboundp
;
2381 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2383 extern Lisp_Object Qcdr
;
2385 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2386 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2388 extern Lisp_Object Qfloatp
;
2389 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2391 extern Lisp_Object Qinteger
;
2393 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2395 EXFUN (Finteractive_form
, 1);
2396 EXFUN (Fbyteorder
, 0);
2398 /* Defined in frame.c */
2399 extern Lisp_Object Qframep
;
2401 /* Defined in data.c */
2403 EXFUN (Fcar_safe
, 1);
2405 EXFUN (Fcdr_safe
, 1);
2409 EXFUN (Ffboundp
, 1);
2410 EXFUN (Fsymbol_function
, 1);
2411 EXFUN (Fsymbol_name
, 1);
2412 extern Lisp_Object
indirect_function (Lisp_Object
);
2413 EXFUN (Findirect_function
, 2);
2415 EXFUN (Fsymbol_value
, 1);
2416 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2418 EXFUN (Fdefault_value
, 1);
2419 EXFUN (Fset_default
, 2);
2420 EXFUN (Fdefault_boundp
, 1);
2421 EXFUN (Fmake_local_variable
, 1);
2422 EXFUN (Flocal_variable_p
, 2);
2427 EXFUN (Fstring_to_number
, 2);
2428 EXFUN (Fnumber_to_string
, 1);
2434 EXFUN (Fplus
, MANY
);
2435 EXFUN (Fminus
, MANY
);
2436 EXFUN (Ftimes
, MANY
);
2444 EXFUN (Fmake_variable_buffer_local
, 1);
2446 /* Convert the integer I to an Emacs representation, either the integer
2447 itself, or a cons of two or three integers, or if all else fails a float.
2448 I should not have side effects. */
2449 #define INTEGER_TO_CONS(i) \
2450 (! FIXNUM_OVERFLOW_P (i) \
2452 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2453 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2454 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2455 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2456 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2457 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2458 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2459 ? Fcons (make_number ((i) >> 16 >> 24), \
2460 Fcons (make_number ((i) >> 16 & 0xffffff), \
2461 make_number ((i) & 0xffff))) \
2464 /* Convert the Emacs representation CONS back to an integer of type
2465 TYPE, storing the result the variable VAR. Signal an error if CONS
2466 is not a valid representation or is out of range for TYPE. */
2467 #define CONS_TO_INTEGER(cons, type, var) \
2468 (TYPE_SIGNED (type) \
2469 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2470 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2471 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2472 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2474 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2475 extern void args_out_of_range (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2476 extern void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2477 Lisp_Object
) NO_RETURN
;
2478 extern Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2479 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2480 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2481 extern void syms_of_data (void);
2482 extern void init_data (void);
2483 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2485 /* Defined in cmds.c */
2486 EXFUN (Fend_of_line
, 1);
2487 EXFUN (Fforward_char
, 1);
2488 EXFUN (Fforward_line
, 1);
2489 extern void syms_of_cmds (void);
2490 extern void keys_of_cmds (void);
2492 /* Defined in coding.c */
2493 extern Lisp_Object Qcharset
;
2494 EXFUN (Fcoding_system_p
, 1);
2495 EXFUN (Fcoding_system_base
, 1);
2496 EXFUN (Fcoding_system_eol_type
, 1);
2497 EXFUN (Fcheck_coding_system
, 1);
2498 EXFUN (Fread_coding_system
, 2);
2499 EXFUN (Fread_non_nil_coding_system
, 1);
2500 EXFUN (Ffind_operation_coding_system
, MANY
);
2501 EXFUN (Fdecode_coding_string
, 4);
2502 extern Lisp_Object
detect_coding_system (const unsigned char *, EMACS_INT
,
2503 EMACS_INT
, int, int, Lisp_Object
);
2504 extern void init_coding (void);
2505 extern void init_coding_once (void);
2506 extern void syms_of_coding (void);
2508 /* Defined in character.c */
2509 EXFUN (Fchar_width
, 1);
2510 EXFUN (Fstring
, MANY
);
2511 extern EMACS_INT
chars_in_text (const unsigned char *, EMACS_INT
);
2512 extern EMACS_INT
multibyte_chars_in_text (const unsigned char *, EMACS_INT
);
2513 extern int multibyte_char_to_unibyte (int);
2514 extern int multibyte_char_to_unibyte_safe (int);
2515 extern void init_character_once (void);
2516 extern void syms_of_character (void);
2518 /* Defined in charset.c */
2519 extern void init_charset (void);
2520 extern void init_charset_once (void);
2521 extern void syms_of_charset (void);
2522 /* Structure forward declarations. */
2525 /* Defined in composite.c */
2526 extern void syms_of_composite (void);
2528 /* Defined in syntax.c */
2529 EXFUN (Fforward_word
, 1);
2530 EXFUN (Fskip_chars_forward
, 2);
2531 EXFUN (Fskip_chars_backward
, 2);
2532 extern void init_syntax_once (void);
2533 extern void syms_of_syntax (void);
2535 /* Defined in fns.c */
2536 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2537 extern EMACS_INT
next_almost_prime (EMACS_INT
);
2538 extern Lisp_Object
larger_vector (Lisp_Object
, EMACS_INT
, Lisp_Object
);
2539 extern void sweep_weak_hash_tables (void);
2540 extern Lisp_Object Qcursor_in_echo_area
;
2541 extern Lisp_Object Qstring_lessp
;
2542 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2543 EMACS_UINT
sxhash (Lisp_Object
, int);
2544 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2545 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2547 EMACS_INT
hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2548 EMACS_INT
hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2550 void init_weak_hash_tables (void);
2551 extern void init_fns (void);
2552 EXFUN (Fmake_hash_table
, MANY
);
2553 EXFUN (Fgethash
, 3);
2554 EXFUN (Fputhash
, 3);
2555 EXFUN (Fremhash
, 2);
2557 EXFUN (Fidentity
, 1);
2559 EXFUN (Fappend
, MANY
);
2560 EXFUN (Fconcat
, MANY
);
2561 EXFUN (Fvconcat
, MANY
);
2562 EXFUN (Fcopy_sequence
, 1);
2563 EXFUN (Fstring_make_multibyte
, 1);
2564 EXFUN (Fstring_make_unibyte
, 1);
2565 EXFUN (Fstring_as_multibyte
, 1);
2566 EXFUN (Fstring_as_unibyte
, 1);
2567 EXFUN (Fstring_to_multibyte
, 1);
2568 EXFUN (Fsubstring
, 3);
2569 extern Lisp_Object
substring_both (Lisp_Object
, EMACS_INT
, EMACS_INT
,
2570 EMACS_INT
, EMACS_INT
);
2582 EXFUN (Freverse
, 1);
2583 EXFUN (Fnreverse
, 1);
2587 EXFUN (Fnconc
, MANY
);
2589 EXFUN (Fmapconcat
, 3);
2590 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2591 EXFUN (Fprovide
, 2);
2592 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2593 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2594 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2595 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2596 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2597 extern void clear_string_char_byte_cache (void);
2598 extern EMACS_INT
string_char_to_byte (Lisp_Object
, EMACS_INT
);
2599 extern EMACS_INT
string_byte_to_char (Lisp_Object
, EMACS_INT
);
2600 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2601 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2602 EXFUN (Fcopy_alist
, 1);
2603 EXFUN (Fplist_get
, 2);
2604 EXFUN (Fplist_put
, 3);
2605 EXFUN (Fplist_member
, 2);
2607 EXFUN (Fstring_equal
, 2);
2608 EXFUN (Fcompare_strings
, 7);
2609 EXFUN (Fstring_lessp
, 2);
2610 extern void syms_of_fns (void);
2612 /* Defined in floatfns.c */
2613 extern double extract_float (Lisp_Object
);
2615 EXFUN (Ftruncate
, 2);
2616 extern void init_floatfns (void);
2617 extern void syms_of_floatfns (void);
2618 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2620 /* Defined in fringe.c */
2621 extern void syms_of_fringe (void);
2622 extern void init_fringe (void);
2623 #ifdef HAVE_WINDOW_SYSTEM
2624 extern void mark_fringe_data (void);
2625 extern void init_fringe_once (void);
2626 #endif /* HAVE_WINDOW_SYSTEM */
2628 /* Defined in image.c */
2629 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2630 extern Lisp_Object QCconversion
;
2631 extern int x_bitmap_mask (struct frame
*, int);
2632 extern void syms_of_image (void);
2633 extern void init_image (void);
2635 /* Defined in insdel.c */
2636 extern Lisp_Object Qinhibit_modification_hooks
;
2637 extern void move_gap (EMACS_INT
);
2638 extern void move_gap_both (EMACS_INT
, EMACS_INT
);
2639 extern void make_gap (EMACS_INT
);
2640 extern EMACS_INT
copy_text (const unsigned char *, unsigned char *,
2641 EMACS_INT
, int, int);
2642 extern int count_combining_before (const unsigned char *,
2643 EMACS_INT
, EMACS_INT
, EMACS_INT
);
2644 extern int count_combining_after (const unsigned char *,
2645 EMACS_INT
, EMACS_INT
, EMACS_INT
);
2646 extern void insert (const char *, EMACS_INT
);
2647 extern void insert_and_inherit (const char *, EMACS_INT
);
2648 extern void insert_1 (const char *, EMACS_INT
, int, int, int);
2649 extern void insert_1_both (const char *, EMACS_INT
, EMACS_INT
,
2651 extern void insert_from_gap (EMACS_INT
, EMACS_INT
);
2652 extern void insert_from_string (Lisp_Object
, EMACS_INT
, EMACS_INT
,
2653 EMACS_INT
, EMACS_INT
, int);
2654 extern void insert_from_buffer (struct buffer
*, EMACS_INT
, EMACS_INT
, int);
2655 extern void insert_char (int);
2656 extern void insert_string (const char *);
2657 extern void insert_before_markers (const char *, EMACS_INT
);
2658 extern void insert_before_markers_and_inherit (const char *, EMACS_INT
);
2659 extern void insert_from_string_before_markers (Lisp_Object
, EMACS_INT
,
2660 EMACS_INT
, EMACS_INT
,
2662 extern void del_range (EMACS_INT
, EMACS_INT
);
2663 extern Lisp_Object
del_range_1 (EMACS_INT
, EMACS_INT
, int, int);
2664 extern void del_range_byte (EMACS_INT
, EMACS_INT
, int);
2665 extern void del_range_both (EMACS_INT
, EMACS_INT
, EMACS_INT
, EMACS_INT
, int);
2666 extern Lisp_Object
del_range_2 (EMACS_INT
, EMACS_INT
,
2667 EMACS_INT
, EMACS_INT
, int);
2668 extern void modify_region (struct buffer
*, EMACS_INT
, EMACS_INT
, int);
2669 extern void prepare_to_modify_buffer (EMACS_INT
, EMACS_INT
, EMACS_INT
*);
2670 extern void signal_after_change (EMACS_INT
, EMACS_INT
, EMACS_INT
);
2671 extern void adjust_after_insert (EMACS_INT
, EMACS_INT
, EMACS_INT
,
2672 EMACS_INT
, EMACS_INT
);
2673 extern void adjust_markers_for_delete (EMACS_INT
, EMACS_INT
,
2674 EMACS_INT
, EMACS_INT
);
2675 extern void replace_range (EMACS_INT
, EMACS_INT
, Lisp_Object
, int, int, int);
2676 extern void replace_range_2 (EMACS_INT
, EMACS_INT
, EMACS_INT
, EMACS_INT
,
2677 const char *, EMACS_INT
, EMACS_INT
, int);
2678 extern void syms_of_insdel (void);
2680 /* Defined in dispnew.c */
2681 extern Lisp_Object selected_frame
;
2682 extern Lisp_Object Vwindow_system
;
2684 EXFUN (Fredraw_frame
, 1);
2685 EXFUN (Fsleep_for
, 2);
2686 EXFUN (Fredisplay
, 1);
2687 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2688 extern void init_display (void);
2689 extern void syms_of_display (void);
2691 /* Defined in xdisp.c */
2692 extern Lisp_Object Qinhibit_point_motion_hooks
;
2693 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2694 extern Lisp_Object Qmenu_bar_update_hook
;
2695 extern Lisp_Object Qwindow_scroll_functions
;
2696 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2697 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2698 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2699 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2700 extern Lisp_Object Qleft_margin
, Qright_margin
;
2701 extern Lisp_Object Qglyphless_char
;
2702 extern Lisp_Object QCdata
, QCfile
;
2703 extern Lisp_Object QCmap
;
2704 extern Lisp_Object Qrisky_local_variable
;
2705 extern struct frame
*last_glyphless_glyph_frame
;
2706 extern unsigned last_glyphless_glyph_face_id
;
2707 extern int last_glyphless_glyph_merged_face_id
;
2708 extern int noninteractive_need_newline
;
2709 extern Lisp_Object echo_area_buffer
[2];
2710 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2711 extern void check_message_stack (void);
2712 extern void setup_echo_area_for_printing (int);
2713 extern int push_message (void);
2714 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2715 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2716 extern void restore_message (void);
2717 extern Lisp_Object
current_message (void);
2718 extern void clear_message (int, int);
2719 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2720 extern void message1 (const char *);
2721 extern void message1_nolog (const char *);
2722 extern void message2 (const char *, EMACS_INT
, int);
2723 extern void message2_nolog (const char *, EMACS_INT
, int);
2724 extern void message3 (Lisp_Object
, EMACS_INT
, int);
2725 extern void message3_nolog (Lisp_Object
, EMACS_INT
, int);
2726 extern void message_dolog (const char *, EMACS_INT
, int, int);
2727 extern void message_with_string (const char *, Lisp_Object
, int);
2728 extern void message_log_maybe_newline (void);
2729 extern void update_echo_area (void);
2730 extern void truncate_echo_area (EMACS_INT
);
2731 extern void redisplay (void);
2732 extern void redisplay_preserve_echo_area (int);
2733 extern void prepare_menu_bars (void);
2735 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2736 extern void syms_of_xdisp (void);
2737 extern void init_xdisp (void);
2738 extern Lisp_Object
safe_eval (Lisp_Object
);
2739 extern int pos_visible_p (struct window
*, EMACS_INT
, int *,
2740 int *, int *, int *, int *, int *);
2742 /* Defined in xsettings.c */
2743 extern void syms_of_xsettings (void);
2745 /* Defined in vm-limit.c. */
2746 extern void memory_warnings (POINTER_TYPE
*, void (*warnfun
) (const char *));
2748 /* Defined in alloc.c */
2749 extern void check_pure_size (void);
2750 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2751 extern void reset_malloc_hooks (void);
2752 extern void uninterrupt_malloc (void);
2753 extern void malloc_warning (const char *);
2754 extern void memory_full (size_t) NO_RETURN
;
2755 extern void buffer_memory_full (EMACS_INT
) NO_RETURN
;
2756 extern int survives_gc_p (Lisp_Object
);
2757 extern void mark_object (Lisp_Object
);
2758 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2759 extern void refill_memory_reserve (void);
2761 extern const char *pending_malloc_warning
;
2762 extern Lisp_Object
*stack_base
;
2764 extern Lisp_Object
list1 (Lisp_Object
);
2765 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2766 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2767 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2768 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2770 EXFUN (Flist
, MANY
);
2771 EXFUN (Fmake_list
, 2);
2772 extern Lisp_Object
allocate_misc (void);
2773 EXFUN (Fmake_vector
, 2);
2774 EXFUN (Fvector
, MANY
);
2775 EXFUN (Fmake_symbol
, 1);
2776 EXFUN (Fmake_marker
, 0);
2777 extern void string_overflow (void) NO_RETURN
;
2778 EXFUN (Fmake_string
, 2);
2779 extern Lisp_Object
build_string (const char *);
2780 extern Lisp_Object
make_string (const char *, EMACS_INT
);
2781 extern Lisp_Object
make_unibyte_string (const char *, EMACS_INT
);
2782 extern Lisp_Object
make_multibyte_string (const char *, EMACS_INT
, EMACS_INT
);
2783 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2784 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2785 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2786 extern Lisp_Object
make_string_from_bytes (const char *, EMACS_INT
, EMACS_INT
);
2787 extern Lisp_Object
make_specified_string (const char *,
2788 EMACS_INT
, EMACS_INT
, int);
2789 EXFUN (Fpurecopy
, 1);
2790 extern Lisp_Object
make_pure_string (const char *, EMACS_INT
, EMACS_INT
, int);
2791 extern Lisp_Object
make_pure_c_string (const char *data
);
2792 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2793 extern Lisp_Object
make_pure_vector (EMACS_INT
);
2794 EXFUN (Fgarbage_collect
, 0);
2795 EXFUN (Fmake_byte_code
, MANY
);
2796 EXFUN (Fmake_bool_vector
, 2);
2797 extern Lisp_Object Qchar_table_extra_slots
;
2798 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2799 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, EMACS_INT tag
);
2800 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2802 allocate_pseudovector \
2803 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2804 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2805 extern struct window
*allocate_window (void);
2806 extern struct frame
*allocate_frame (void);
2807 extern struct Lisp_Process
*allocate_process (void);
2808 extern struct terminal
*allocate_terminal (void);
2809 extern int gc_in_progress
;
2810 extern int abort_on_gc
;
2811 extern Lisp_Object
make_float (double);
2812 extern void display_malloc_warning (void);
2813 extern int inhibit_garbage_collection (void);
2814 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2815 extern void free_marker (Lisp_Object
);
2816 extern void free_cons (struct Lisp_Cons
*);
2817 extern void init_alloc_once (void);
2818 extern void init_alloc (void);
2819 extern void syms_of_alloc (void);
2820 extern struct buffer
* allocate_buffer (void);
2821 extern int valid_lisp_object_p (Lisp_Object
);
2823 /* Defined in chartab.c */
2824 EXFUN (Fmake_char_table
, 2);
2825 EXFUN (Fset_char_table_parent
, 2);
2826 EXFUN (Fchar_table_extra_slot
, 2);
2827 EXFUN (Fset_char_table_extra_slot
, 3);
2828 EXFUN (Fset_char_table_range
, 3);
2829 EXFUN (Foptimize_char_table
, 2);
2830 extern Lisp_Object
copy_char_table (Lisp_Object
);
2831 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2832 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2834 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2835 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2837 extern int char_table_translate (Lisp_Object
, int);
2838 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2840 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2841 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2842 Lisp_Object
, Lisp_Object
,
2843 Lisp_Object
, struct charset
*,
2844 unsigned, unsigned);
2845 extern void syms_of_chartab (void);
2847 /* Defined in print.c */
2848 extern Lisp_Object Vprin1_to_string_buffer
;
2849 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2851 EXFUN (Fprin1_to_string
, 2);
2854 EXFUN (Ferror_message_string
, 1);
2855 extern Lisp_Object Qstandard_output
;
2856 extern Lisp_Object Qexternal_debugging_output
;
2857 extern void temp_output_buffer_setup (const char *);
2858 extern int print_level
;
2859 extern Lisp_Object Qprint_escape_newlines
;
2860 extern void write_string (const char *, int);
2861 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2863 extern Lisp_Object internal_with_output_to_temp_buffer
2864 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2865 #define FLOAT_TO_STRING_BUFSIZE 350
2866 extern void float_to_string (char *, double);
2867 extern void syms_of_print (void);
2869 /* Defined in doprnt.c */
2870 extern size_t doprnt (char *, size_t, const char *, const char *, va_list);
2872 /* Defined in lread.c. */
2873 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2874 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2876 EXFUN (Fread_from_string
, 3);
2878 EXFUN (Fintern_soft
, 2);
2879 EXFUN (Funintern
, 2);
2881 EXFUN (Fget_load_suffixes
, 0);
2882 EXFUN (Fread_char
, 3);
2883 EXFUN (Fread_event
, 3);
2884 extern Lisp_Object
check_obarray (Lisp_Object
);
2885 extern Lisp_Object
intern (const char *);
2886 extern Lisp_Object
intern_c_string (const char *);
2887 extern Lisp_Object
oblookup (Lisp_Object
, const char *, EMACS_INT
, EMACS_INT
);
2888 #define LOADHIST_ATTACH(x) \
2890 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2892 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2893 Lisp_Object
*, Lisp_Object
);
2894 Lisp_Object
string_to_number (char const *, int, int);
2895 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2897 extern void dir_warning (const char *, Lisp_Object
);
2898 extern void close_load_descs (void);
2899 extern void init_obarray (void);
2900 extern void init_lread (void);
2901 extern void syms_of_lread (void);
2903 /* Defined in eval.c. */
2904 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
, Qmacro
;
2905 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2906 extern Lisp_Object Qand_rest
;
2907 extern Lisp_Object Vautoload_queue
;
2908 extern Lisp_Object Vsignaling_function
;
2909 extern int handling_signal
;
2911 extern struct catchtag
*catchlist
;
2912 extern struct handler
*handlerlist
;
2914 /* To run a normal hook, use the appropriate function from the list below.
2915 The calling convention:
2917 if (!NILP (Vrun_hooks))
2918 call1 (Vrun_hooks, Qmy_funny_hook);
2920 should no longer be used. */
2921 extern Lisp_Object Vrun_hooks
;
2922 EXFUN (Frun_hooks
, MANY
);
2923 EXFUN (Frun_hook_with_args
, MANY
);
2924 EXFUN (Frun_hook_with_args_until_failure
, MANY
);
2925 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2926 extern Lisp_Object
run_hook_with_args (size_t nargs
, Lisp_Object
*args
,
2927 Lisp_Object (*funcall
)
2928 (size_t nargs
, Lisp_Object
*args
));
2929 EXFUN (Fprogn
, UNEVALLED
);
2930 EXFUN (Finteractive_p
, 0);
2931 EXFUN (Fthrow
, 2) NO_RETURN
;
2933 extern void xsignal (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2934 extern void xsignal0 (Lisp_Object
) NO_RETURN
;
2935 extern void xsignal1 (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2936 extern void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2937 extern void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2938 extern void signal_error (const char *, Lisp_Object
) NO_RETURN
;
2939 EXFUN (Fcommandp
, 2);
2940 EXFUN (Ffunctionp
, 1);
2942 extern Lisp_Object
eval_sub (Lisp_Object form
);
2943 EXFUN (Fapply
, MANY
);
2944 EXFUN (Ffuncall
, MANY
);
2945 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2946 extern Lisp_Object
call0 (Lisp_Object
);
2947 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2948 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2949 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2950 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2951 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2952 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2953 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2954 EXFUN (Fdo_auto_save
, 2);
2955 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2956 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2957 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2958 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2959 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2960 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (size_t, Lisp_Object
*), size_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2961 extern void specbind (Lisp_Object
, Lisp_Object
);
2962 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2963 extern Lisp_Object
unbind_to (int, Lisp_Object
);
2964 extern void error (const char *, ...) NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
2965 extern void verror (const char *, va_list)
2966 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 0);
2967 extern void do_autoload (Lisp_Object
, Lisp_Object
);
2968 extern Lisp_Object
un_autoload (Lisp_Object
);
2969 extern void init_eval_once (void);
2970 extern Lisp_Object
safe_call (size_t, Lisp_Object
*);
2971 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
2972 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2973 extern void init_eval (void);
2975 extern void mark_backtrace (void);
2977 extern void syms_of_eval (void);
2979 /* Defined in editfns.c */
2980 extern Lisp_Object Qfield
;
2981 EXFUN (Fcurrent_message
, 0);
2982 EXFUN (Fgoto_char
, 1);
2983 EXFUN (Fpoint_max_marker
, 0);
2985 EXFUN (Fpoint_marker
, 0);
2986 EXFUN (Fline_beginning_position
, 1);
2987 EXFUN (Fline_end_position
, 1);
2988 EXFUN (Ffollowing_char
, 0);
2989 EXFUN (Fprevious_char
, 0);
2990 EXFUN (Fchar_after
, 1);
2991 EXFUN (Finsert
, MANY
);
2992 EXFUN (Finsert_char
, 3);
2993 extern void insert1 (Lisp_Object
);
2998 EXFUN (Fformat
, MANY
);
2999 EXFUN (Fmessage
, MANY
);
3000 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3001 EXFUN (Fbuffer_substring
, 2);
3002 EXFUN (Fbuffer_string
, 0);
3003 extern Lisp_Object
save_excursion_save (void);
3004 extern Lisp_Object
save_restriction_save (void);
3005 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3006 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3007 EXFUN (Fchar_to_string
, 1);
3008 EXFUN (Fdelete_region
, 2);
3009 EXFUN (Fnarrow_to_region
, 2);
3011 EXFUN (Fuser_login_name
, 1);
3012 EXFUN (Fsystem_name
, 0);
3013 EXFUN (Fcurrent_time
, 0);
3014 EXFUN (Fget_internal_run_time
, 0);
3015 extern EMACS_INT
clip_to_bounds (EMACS_INT
, EMACS_INT
, EMACS_INT
);
3016 extern Lisp_Object
make_buffer_string (EMACS_INT
, EMACS_INT
, int);
3017 extern Lisp_Object
make_buffer_string_both (EMACS_INT
, EMACS_INT
, EMACS_INT
,
3019 extern void init_editfns (void);
3020 const char *get_system_name (void);
3021 extern void syms_of_editfns (void);
3022 EXFUN (Fconstrain_to_field
, 5);
3023 EXFUN (Ffield_end
, 3);
3024 extern void set_time_zone_rule (const char *);
3026 /* Defined in buffer.c */
3027 extern int mouse_face_overlay_overlaps (Lisp_Object
);
3028 extern void nsberror (Lisp_Object
) NO_RETURN
;
3029 EXFUN (Fset_buffer_multibyte
, 1);
3030 EXFUN (Foverlay_start
, 1);
3031 EXFUN (Foverlay_end
, 1);
3032 extern void adjust_overlays_for_insert (EMACS_INT
, EMACS_INT
);
3033 extern void adjust_overlays_for_delete (EMACS_INT
, EMACS_INT
);
3034 extern void fix_start_end_in_overlays (EMACS_INT
, EMACS_INT
);
3035 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
3036 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3037 extern int overlay_touches_p (EMACS_INT
);
3038 extern Lisp_Object Vbuffer_alist
;
3039 EXFUN (Fget_buffer
, 1);
3040 EXFUN (Fget_buffer_create
, 1);
3041 EXFUN (Fgenerate_new_buffer_name
, 2);
3042 EXFUN (Fset_buffer
, 1);
3043 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3044 EXFUN (Fbarf_if_buffer_read_only
, 0);
3045 EXFUN (Fcurrent_buffer
, 0);
3046 EXFUN (Fother_buffer
, 3);
3047 EXFUN (Foverlay_get
, 2);
3048 EXFUN (Fbuffer_modified_p
, 1);
3049 EXFUN (Fset_buffer_modified_p
, 1);
3050 EXFUN (Fkill_buffer
, 1);
3051 EXFUN (Fkill_all_local_variables
, 0);
3052 EXFUN (Fbuffer_enable_undo
, 1);
3053 EXFUN (Ferase_buffer
, 0);
3054 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3055 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3056 extern struct buffer
*all_buffers
;
3057 EXFUN (Fprevious_overlay_change
, 1);
3058 EXFUN (Fbuffer_file_name
, 1);
3059 extern void init_buffer_once (void);
3060 extern void init_buffer (void);
3061 extern void syms_of_buffer (void);
3062 extern void keys_of_buffer (void);
3064 /* Defined in marker.c */
3066 EXFUN (Fmarker_position
, 1);
3067 EXFUN (Fmarker_buffer
, 1);
3068 EXFUN (Fcopy_marker
, 2);
3069 EXFUN (Fset_marker
, 3);
3070 extern EMACS_INT
marker_position (Lisp_Object
);
3071 extern EMACS_INT
marker_byte_position (Lisp_Object
);
3072 extern void clear_charpos_cache (struct buffer
*);
3073 extern EMACS_INT
charpos_to_bytepos (EMACS_INT
);
3074 extern EMACS_INT
buf_charpos_to_bytepos (struct buffer
*, EMACS_INT
);
3075 extern EMACS_INT
buf_bytepos_to_charpos (struct buffer
*, EMACS_INT
);
3076 extern void unchain_marker (struct Lisp_Marker
*marker
);
3077 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3078 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
3079 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3080 EMACS_INT
, EMACS_INT
);
3081 extern void syms_of_marker (void);
3083 /* Defined in fileio.c */
3085 extern Lisp_Object Qfile_error
;
3086 extern Lisp_Object Qfile_exists_p
;
3087 extern Lisp_Object Qfile_directory_p
;
3088 extern Lisp_Object Qinsert_file_contents
;
3089 extern Lisp_Object Qfile_name_history
;
3090 EXFUN (Ffind_file_name_handler
, 2);
3091 EXFUN (Ffile_name_as_directory
, 1);
3092 EXFUN (Fexpand_file_name
, 2);
3093 EXFUN (Ffile_name_nondirectory
, 1);
3094 EXFUN (Fsubstitute_in_file_name
, 1);
3095 EXFUN (Ffile_symlink_p
, 1);
3096 EXFUN (Fverify_visited_file_modtime
, 1);
3097 EXFUN (Ffile_exists_p
, 1);
3098 EXFUN (Ffile_name_absolute_p
, 1);
3099 EXFUN (Fdirectory_file_name
, 1);
3100 EXFUN (Ffile_name_directory
, 1);
3101 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3102 EXFUN (Ffile_accessible_directory_p
, 1);
3103 EXFUN (Funhandled_file_name_directory
, 1);
3104 EXFUN (Ffile_directory_p
, 1);
3105 EXFUN (Fwrite_region
, 7);
3106 EXFUN (Ffile_readable_p
, 1);
3107 EXFUN (Fread_file_name
, 6);
3108 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3109 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3110 extern void report_file_error (const char *, Lisp_Object
) NO_RETURN
;
3111 extern int internal_delete_file (Lisp_Object
);
3112 extern void syms_of_fileio (void);
3113 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
3114 extern Lisp_Object Qdelete_file
;
3116 /* Defined in abbrev.c */
3118 extern void syms_of_abbrev (void);
3120 /* Defined in search.c */
3121 extern void shrink_regexp_cache (void);
3122 EXFUN (Fstring_match
, 3);
3123 extern void restore_search_regs (void);
3124 EXFUN (Fmatch_data
, 3);
3125 EXFUN (Fset_match_data
, 2);
3126 EXFUN (Fmatch_beginning
, 1);
3127 EXFUN (Fmatch_end
, 1);
3128 extern void record_unwind_save_match_data (void);
3129 struct re_registers
;
3130 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3131 struct re_registers
*,
3132 Lisp_Object
, int, int);
3133 extern EMACS_INT
fast_string_match (Lisp_Object
, Lisp_Object
);
3134 extern EMACS_INT
fast_c_string_match_ignore_case (Lisp_Object
, const char *);
3135 extern EMACS_INT
fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3136 extern EMACS_INT
fast_looking_at (Lisp_Object
, EMACS_INT
, EMACS_INT
,
3137 EMACS_INT
, EMACS_INT
, Lisp_Object
);
3138 extern EMACS_INT
scan_buffer (int, EMACS_INT
, EMACS_INT
, EMACS_INT
,
3140 extern EMACS_INT
scan_newline (EMACS_INT
, EMACS_INT
, EMACS_INT
, EMACS_INT
,
3142 extern EMACS_INT
find_next_newline (EMACS_INT
, int);
3143 extern EMACS_INT
find_next_newline_no_quit (EMACS_INT
, EMACS_INT
);
3144 extern EMACS_INT
find_before_next_newline (EMACS_INT
, EMACS_INT
, EMACS_INT
);
3145 extern void syms_of_search (void);
3146 extern void clear_regexp_cache (void);
3148 /* Defined in minibuf.c */
3150 extern Lisp_Object Qcompletion_ignore_case
;
3151 extern Lisp_Object Vminibuffer_list
;
3152 extern Lisp_Object last_minibuf_string
;
3153 EXFUN (Fcompleting_read
, 8);
3154 EXFUN (Fread_from_minibuffer
, 7);
3155 EXFUN (Fread_variable
, 2);
3156 EXFUN (Fread_buffer
, 3);
3157 EXFUN (Fread_minibuffer
, 2);
3158 EXFUN (Feval_minibuffer
, 2);
3159 EXFUN (Fread_string
, 5);
3160 EXFUN (Fassoc_string
, 3);
3161 extern Lisp_Object
get_minibuffer (int);
3162 extern void init_minibuf_once (void);
3163 extern void syms_of_minibuf (void);
3165 /* Defined in callint.c */
3167 extern Lisp_Object Qminus
, Qplus
;
3168 extern Lisp_Object Qwhen
;
3169 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3170 EXFUN (Fprefix_numeric_value
, 1);
3171 extern void syms_of_callint (void);
3173 /* Defined in casefiddle.c */
3175 extern Lisp_Object Qidentity
;
3176 EXFUN (Fdowncase
, 1);
3178 EXFUN (Fupcase_region
, 2);
3179 EXFUN (Fupcase_initials
, 1);
3180 EXFUN (Fupcase_initials_region
, 2);
3181 extern void syms_of_casefiddle (void);
3182 extern void keys_of_casefiddle (void);
3184 /* Defined in casetab.c */
3186 EXFUN (Fset_case_table
, 1);
3187 EXFUN (Fset_standard_case_table
, 1);
3188 extern void init_casetab_once (void);
3189 extern void syms_of_casetab (void);
3191 /* Defined in keyboard.c */
3193 extern Lisp_Object echo_message_buffer
;
3194 extern struct kboard
*echo_kboard
;
3195 extern void cancel_echoing (void);
3196 extern Lisp_Object Qdisabled
, QCfilter
;
3197 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3198 extern Lisp_Object Qtop
;
3199 extern int input_pending
;
3200 EXFUN (Fdiscard_input
, 0);
3201 EXFUN (Frecursive_edit
, 0);
3202 EXFUN (Ftop_level
, 0) NO_RETURN
;
3203 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3204 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3205 extern void discard_mouse_events (void);
3206 EXFUN (Fevent_convert_list
, 1);
3207 EXFUN (Fread_key_sequence
, 5);
3208 EXFUN (Fset_input_interrupt_mode
, 1);
3209 EXFUN (Fset_input_mode
, 4);
3210 extern Lisp_Object pending_funcalls
;
3211 extern int detect_input_pending (void);
3212 extern int detect_input_pending_ignore_squeezables (void);
3213 extern int detect_input_pending_run_timers (int);
3214 extern void safe_run_hooks (Lisp_Object
);
3215 extern void cmd_error_internal (Lisp_Object
, const char *);
3216 extern Lisp_Object
command_loop_1 (void);
3217 extern Lisp_Object
recursive_edit_1 (void);
3218 extern void record_auto_save (void);
3220 extern void force_auto_save_soon (void);
3222 extern void init_keyboard (void);
3223 extern void syms_of_keyboard (void);
3224 extern void keys_of_keyboard (void);
3225 extern char *push_key_description (unsigned int, char *, int);
3228 /* Defined in indent.c */
3229 EXFUN (Fvertical_motion
, 2);
3230 EXFUN (Findent_to
, 2);
3231 EXFUN (Fmove_to_column
, 2);
3232 extern EMACS_INT
current_column (void);
3233 extern void invalidate_current_column (void);
3234 extern int indented_beyond_p (EMACS_INT
, EMACS_INT
, EMACS_INT
);
3235 extern void syms_of_indent (void);
3237 /* Defined in frame.c */
3238 #ifdef HAVE_WINDOW_SYSTEM
3239 #endif /* HAVE_WINDOW_SYSTEM */
3240 extern Lisp_Object Qonly
;
3241 extern Lisp_Object Qvisible
;
3242 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3243 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3244 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3246 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3248 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3249 EXFUN (Fselect_frame
, 2);
3250 EXFUN (Fselected_frame
, 0);
3251 EXFUN (Fmake_frame_visible
, 1);
3252 EXFUN (Ficonify_frame
, 1);
3253 EXFUN (Fframe_parameter
, 2);
3254 EXFUN (Fmodify_frame_parameters
, 2);
3255 EXFUN (Fraise_frame
, 1);
3256 EXFUN (Fredirect_frame_focus
, 2);
3257 extern Lisp_Object
frame_buffer_list (Lisp_Object
);
3258 extern void frames_discard_buffer (Lisp_Object
);
3259 extern void set_frame_buffer_list (Lisp_Object
, Lisp_Object
);
3260 extern void syms_of_frame (void);
3262 /* Defined in emacs.c */
3263 extern char **initial_argv
;
3264 extern int initial_argc
;
3265 #if defined(HAVE_X_WINDOWS) || defined(HAVE_NS)
3266 extern int display_arg
;
3268 extern Lisp_Object
decode_env_path (const char *, const char *);
3269 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3270 extern Lisp_Object Qfile_name_handler_alist
;
3271 #ifdef FLOAT_CATCH_SIGILL
3272 extern void fatal_error_signal (int);
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);
3316 extern void add_gpm_wait_descriptor (int);
3317 extern void delete_gpm_wait_descriptor (int);
3318 extern void close_process_descs (void);
3319 extern void init_process (void);
3320 extern void syms_of_process (void);
3321 extern void setup_process_coding_systems (Lisp_Object
);
3323 EXFUN (Fcall_process
, MANY
);
3324 extern int child_setup (int, int, int, char **, int, Lisp_Object
)
3329 extern void init_callproc_1 (void);
3330 extern void init_callproc (void);
3331 extern void set_initial_environment (void);
3332 extern void syms_of_callproc (void);
3334 /* Defined in doc.c */
3335 extern Lisp_Object Qfunction_documentation
;
3336 EXFUN (Fsubstitute_command_keys
, 1);
3337 extern Lisp_Object
read_doc_string (Lisp_Object
);
3338 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3339 extern void syms_of_doc (void);
3340 extern int read_bytecode_char (int);
3342 /* Defined in bytecode.c */
3343 extern Lisp_Object Qbytecode
;
3344 extern void syms_of_bytecode (void);
3345 extern struct byte_stack
*byte_stack_list
;
3347 extern void mark_byte_stack (void);
3349 extern void unmark_byte_stack (void);
3350 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3351 Lisp_Object
, int, Lisp_Object
*);
3353 /* Defined in macros.c */
3354 extern Lisp_Object Qexecute_kbd_macro
;
3355 EXFUN (Fexecute_kbd_macro
, 3);
3356 EXFUN (Fcancel_kbd_macro_events
, 0);
3357 extern void init_macros (void);
3358 extern void syms_of_macros (void);
3360 /* Defined in undo.c */
3361 extern Lisp_Object Qapply
;
3362 extern Lisp_Object Qinhibit_read_only
;
3363 EXFUN (Fundo_boundary
, 0);
3364 extern void truncate_undo_list (struct buffer
*);
3365 extern void record_marker_adjustment (Lisp_Object
, EMACS_INT
);
3366 extern void record_insert (EMACS_INT
, EMACS_INT
);
3367 extern void record_delete (EMACS_INT
, Lisp_Object
);
3368 extern void record_first_change (void);
3369 extern void record_change (EMACS_INT
, EMACS_INT
);
3370 extern void record_property_change (EMACS_INT
, EMACS_INT
,
3371 Lisp_Object
, Lisp_Object
,
3373 extern void syms_of_undo (void);
3374 /* Defined in textprop.c */
3375 extern Lisp_Object Qfont
, Qmouse_face
;
3376 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3377 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3378 extern Lisp_Object Qminibuffer_prompt
;
3380 EXFUN (Fnext_single_property_change
, 4);
3381 EXFUN (Fnext_single_char_property_change
, 4);
3382 EXFUN (Fprevious_single_property_change
, 4);
3383 EXFUN (Fget_text_property
, 3);
3384 EXFUN (Fput_text_property
, 5);
3385 EXFUN (Fprevious_char_property_change
, 2);
3386 EXFUN (Fnext_char_property_change
, 2);
3387 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3389 /* Defined in menu.c */
3390 extern void syms_of_menu (void);
3392 /* Defined in xmenu.c */
3393 EXFUN (Fx_popup_menu
, 2);
3394 EXFUN (Fx_popup_dialog
, 3);
3395 extern void syms_of_xmenu (void);
3397 /* Defined in termchar.h */
3398 struct tty_display_info
;
3400 /* Defined in termhooks.h */
3403 /* Defined in sysdep.c */
3404 #ifndef HAVE_GET_CURRENT_DIR_NAME
3405 extern char *get_current_dir_name (void);
3407 extern void stuff_char (char c
);
3408 extern void init_sigio (int);
3409 extern void sys_subshell (void);
3410 extern void sys_suspend (void);
3411 extern void discard_tty_input (void);
3412 extern void init_sys_modes (struct tty_display_info
*);
3413 extern void reset_sys_modes (struct tty_display_info
*);
3414 extern void init_all_sys_modes (void);
3415 extern void reset_all_sys_modes (void);
3416 extern void wait_for_termination (int);
3417 extern void interruptible_wait_for_termination (int);
3418 extern void flush_pending_output (int);
3419 extern void child_setup_tty (int);
3420 extern void setup_pty (int);
3421 extern int set_window_size (int, int, int);
3422 extern EMACS_INT
get_random (void);
3423 extern void seed_random (long);
3424 extern int emacs_open (const char *, int, int);
3425 extern int emacs_close (int);
3426 extern EMACS_INT
emacs_read (int, char *, EMACS_INT
);
3427 extern EMACS_INT
emacs_write (int, const char *, EMACS_INT
);
3428 enum { READLINK_BUFSIZE
= 1024 };
3429 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3431 extern void *memset (void *, int, size_t);
3434 extern void *memcpy (void *, void *, size_t);
3436 #ifndef HAVE_MEMMOVE
3437 extern void *memmove (void *, void *, size_t);
3440 extern int memcmp (void *, void *, size_t);
3443 EXFUN (Funlock_buffer
, 0);
3444 extern void unlock_all_files (void);
3445 extern void lock_file (Lisp_Object
);
3446 extern void unlock_file (Lisp_Object
);
3447 extern void unlock_buffer (struct buffer
*);
3448 extern void syms_of_filelock (void);
3449 extern void init_filelock (void);
3451 /* Defined in sound.c */
3452 extern void syms_of_sound (void);
3453 extern void init_sound (void);
3455 /* Defined in category.c */
3456 extern void init_category_once (void);
3457 extern Lisp_Object
char_category_set (int);
3458 extern void syms_of_category (void);
3460 /* Defined in ccl.c */
3461 extern void syms_of_ccl (void);
3463 /* Defined in dired.c */
3464 extern void syms_of_dired (void);
3465 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3466 Lisp_Object
, Lisp_Object
,
3469 /* Defined in term.c */
3470 extern int *char_ins_del_vector
;
3471 extern void mark_ttys (void);
3472 extern void syms_of_term (void);
3473 extern void fatal (const char *msgid
, ...)
3474 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
3476 /* Defined in terminal.c */
3477 EXFUN (Fframe_terminal
, 1);
3478 EXFUN (Fdelete_terminal
, 2);
3479 extern void syms_of_terminal (void);
3481 /* Defined in font.c */
3482 extern void syms_of_font (void);
3483 extern void init_font (void);
3485 #ifdef HAVE_WINDOW_SYSTEM
3486 /* Defined in fontset.c */
3487 extern void syms_of_fontset (void);
3489 /* Defined in xfns.c, w32fns.c, or macfns.c */
3490 extern Lisp_Object Qfont_param
;
3491 EXFUN (Fxw_display_color_p
, 1);
3492 EXFUN (Fx_focus_frame
, 1);
3495 /* Defined in xfaces.c */
3496 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3497 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3498 extern Lisp_Object Qmode_line_inactive
;
3499 extern Lisp_Object Qface
;
3500 extern Lisp_Object Qnormal
;
3501 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3502 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3503 extern Lisp_Object Vface_alternative_font_family_alist
;
3504 extern Lisp_Object Vface_alternative_font_registry_alist
;
3505 EXFUN (Fclear_face_cache
, 1);
3506 EXFUN (Fx_load_color_file
, 1);
3507 extern void syms_of_xfaces (void);
3509 #ifdef HAVE_X_WINDOWS
3510 /* Defined in xfns.c */
3511 extern void syms_of_xfns (void);
3513 /* Defined in xsmfns.c */
3514 extern void syms_of_xsmfns (void);
3516 /* Defined in xselect.c */
3517 extern void syms_of_xselect (void);
3519 /* Defined in xterm.c */
3520 extern void syms_of_xterm (void);
3521 #endif /* HAVE_X_WINDOWS */
3523 #ifdef HAVE_WINDOW_SYSTEM
3524 /* Defined in xterm.c, nsterm.m, w32term.c */
3525 extern char *x_get_keysym_name (int);
3526 #endif /* HAVE_WINDOW_SYSTEM */
3529 /* Defined in msdos.c */
3530 EXFUN (Fmsdos_downcase_filename
, 1);
3534 /* Defined in xml.c */
3535 extern void syms_of_xml (void);
3539 /* Defined in (x|w32)fns.c, nsfns.m... */
3540 extern int have_menus_p (void);
3544 /* Defined in dbusbind.c */
3545 void syms_of_dbusbind (void);
3549 /* Defined in msdos.c, w32.c */
3550 extern char *emacs_root_dir (void);
3553 /* Nonzero means Emacs has already been initialized.
3554 Used during startup to detect startup of dumped Emacs. */
3555 extern int initialized
;
3557 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3559 extern POINTER_TYPE
*xmalloc (size_t);
3560 extern POINTER_TYPE
*xrealloc (POINTER_TYPE
*, size_t);
3561 extern void xfree (POINTER_TYPE
*);
3563 extern char *xstrdup (const char *);
3565 extern char *egetenv (const char *);
3567 /* Set up the name of the machine we're running on. */
3568 extern void init_system_name (void);
3570 /* Some systems (e.g., NT) use a different path separator than Unix,
3571 in addition to a device separator. Set the path separator
3572 to '/', and don't test for a device separator in IS_ANY_SEP. */
3574 #define DIRECTORY_SEP '/'
3575 #ifndef IS_DIRECTORY_SEP
3576 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3578 #ifndef IS_DEVICE_SEP
3580 #define IS_DEVICE_SEP(_c_) 0
3582 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3586 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3589 #define SWITCH_ENUM_CAST(x) (x)
3591 /* Loop over Lisp list LIST. Signal an error if LIST is not a proper
3592 list, or if it contains circles.
3594 HARE and TORTOISE should be the names of Lisp_Object variables, and
3595 N should be the name of an EMACS_INT variable declared in the
3596 function where the macro is used. Each nested loop should use
3599 In the loop body, HARE is set to each cons of LIST, and N is the
3600 length of the list processed so far. */
3602 #define LIST_END_P(list, obj) \
3607 : (wrong_type_argument (Qlistp, (list))), 1))
3609 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
3611 # define IF_LINT(Code) Code
3613 # define IF_LINT(Code) /* empty */
3616 /* The ubiquitous min and max macros. */
3622 #define min(a, b) ((a) < (b) ? (a) : (b))
3623 #define max(a, b) ((a) > (b) ? (a) : (b))
3625 /* We used to use `abs', but that clashes with system headers on some
3626 platforms, and using a name reserved by Standard C is a bad idea
3629 #define eabs(x) ((x) < 0 ? -(x) : (x))
3632 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3635 #define make_fixnum_or_float(val) \
3636 (FIXNUM_OVERFLOW_P (val) \
3637 ? make_float (val) \
3638 : make_number ((EMACS_INT)(val)))
3641 /* Checks the `cycle check' variable CHECK to see if it indicates that
3642 EL is part of a cycle; CHECK must be either Qnil or a value returned
3643 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3644 elements after which a cycle might be suspected; after that many
3645 elements, this macro begins consing in order to keep more precise
3648 Returns nil if a cycle was detected, otherwise a new value for CHECK
3651 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3652 the caller should make sure that's ok. */
3654 #define CYCLE_CHECK(check, el, suspicious) \
3657 : (INTEGERP (check) \
3658 ? (XFASTINT (check) < (suspicious) \
3659 ? make_number (XFASTINT (check) + 1) \
3660 : Fcons (el, Qnil)) \
3661 : (!NILP (Fmemq ((el), (check))) \
3663 : Fcons ((el), (check)))))
3666 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3667 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3669 #define MAX_ALLOCA 16*1024
3671 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3673 #define USE_SAFE_ALLOCA \
3674 int sa_count = (int) SPECPDL_INDEX (), sa_must_free = 0
3676 /* SAFE_ALLOCA allocates a simple buffer. */
3678 #define SAFE_ALLOCA(buf, type, size) \
3680 if ((size) < MAX_ALLOCA) \
3681 buf = (type) alloca (size); \
3684 buf = (type) xmalloc (size); \
3686 record_unwind_protect (safe_alloca_unwind, \
3687 make_save_value (buf, 0)); \
3691 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3693 #define SAFE_FREE() \
3695 if (sa_must_free) { \
3697 unbind_to (sa_count, Qnil); \
3702 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3704 #define SAFE_ALLOCA_LISP(buf, nelt) \
3706 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3707 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3708 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3711 buf = (Lisp_Object *) xmalloc ((nelt) * sizeof (Lisp_Object)); \
3712 arg_ = make_save_value (buf, nelt); \
3713 XSAVE_VALUE (arg_)->dogc = 1; \
3715 record_unwind_protect (safe_alloca_unwind, arg_); \
3718 memory_full (SIZE_MAX); \
3722 #include "globals.h"
3724 #endif /* EMACS_LISP_H */