1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1987, 1993-1995, 1997-2012
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
30 /* Use the configure flag --enable-checking[=LIST] to enable various
31 types of run time checks for Lisp objects. */
33 #ifdef GC_CHECK_CONS_LIST
34 extern void check_cons_list (void);
35 #define CHECK_CONS_LIST() check_cons_list ()
37 #define CHECK_CONS_LIST() ((void) 0)
40 /* Temporarily disable wider-than-pointer integers until they're tested more.
41 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
42 /* #undef WIDE_EMACS_INT */
44 /* These are default choices for the types to use. */
46 # if BITS_PER_LONG < BITS_PER_LONG_LONG && defined WIDE_EMACS_INT
47 # define EMACS_INT long long
48 # define BITS_PER_EMACS_INT BITS_PER_LONG_LONG
50 # elif BITS_PER_INT < BITS_PER_LONG
51 # define EMACS_INT long
52 # define BITS_PER_EMACS_INT BITS_PER_LONG
55 # define EMACS_INT int
56 # define BITS_PER_EMACS_INT BITS_PER_INT
61 # define EMACS_UINT unsigned EMACS_INT
64 /* printmax_t and uprintmax_t are types for printing large integers.
65 These are the widest integers that are supported for printing.
66 pMd etc. are conversions for printing them.
67 On C99 hosts, there's no problem, as even the widest integers work.
68 Fall back on EMACS_INT on pre-C99 hosts. */
70 typedef intmax_t printmax_t
;
71 typedef uintmax_t uprintmax_t
;
75 typedef EMACS_INT printmax_t
;
76 typedef EMACS_UINT uprintmax_t
;
81 /* Use pD to format ptrdiff_t values, which suffice for indexes into
82 buffers and strings. Emacs never allocates objects larger than
83 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
84 In C99, pD can always be "t"; configure it here for the sake of
85 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
86 #if PTRDIFF_MAX == INT_MAX
88 #elif PTRDIFF_MAX == LONG_MAX
90 #elif PTRDIFF_MAX == LLONG_MAX
96 /* Extra internal type checking? */
98 #ifdef ENABLE_CHECKING
100 extern void die (const char *, const char *, int) NO_RETURN
;
102 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
103 it to 1 using a debugger to temporarily disable aborting on
104 detected internal inconsistencies or error conditions.
106 Testing suppress_checking after the supplied condition ensures that
107 the side effects produced by CHECK will be consistent, independent
108 of whether ENABLE_CHECKING is defined, or whether the checks are
109 suppressed at run time.
111 In some cases, a good compiler may be able to optimize away the
112 CHECK macro altogether, e.g., if XSTRING (x) uses CHECK to test
113 STRINGP (x), but a particular use of XSTRING is invoked only after
114 testing that STRINGP (x) is true, making the test redundant. */
116 extern int suppress_checking EXTERNALLY_VISIBLE
;
118 #define CHECK(check,msg) (((check) || suppress_checking \
120 : die ((msg), __FILE__, __LINE__)), \
124 /* Produce same side effects and result, but don't complain. */
125 #define CHECK(check,msg) ((check),0)
129 /* Define an Emacs version of "assert", since some system ones are
131 #ifndef ENABLE_CHECKING
132 #define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
133 #else /* ENABLE_CHECKING */
134 #if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
135 #define eassert(cond) CHECK (cond, "assertion failed: " #cond)
137 #define eassert(cond) CHECK (cond, "assertion failed")
139 #endif /* ENABLE_CHECKING */
141 /* Use the configure flag --enable-use-lisp-union-type to make
142 Lisp_Object use a union type instead of the default int. The flag
143 causes USE_LISP_UNION_TYPE to be defined. */
145 /***** Select the tagging scheme. *****/
146 /* There are basically two options that control the tagging scheme:
147 - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
149 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
150 always 0, and we can thus use them to hold tag bits, without
151 restricting our addressing space.
153 If USE_LSB_TAG is not set, then we use the top 3 bits for tagging, thus
154 restricting our possible address range. Currently USE_LSB_TAG is not
155 allowed together with a union. This is not due to any fundamental
156 technical (or political ;-) problem: nobody wrote the code to do it yet.
158 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
159 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
160 on the few static Lisp_Objects used: all the defsubr as well
161 as the two special buffers buffer_defaults and buffer_local_symbols. */
163 /* First, try and define DECL_ALIGN(type,var) which declares a static
164 variable VAR of type TYPE with the added requirement that it be
172 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
175 #ifndef NO_DECL_ALIGN
177 # if HAVE_ATTRIBUTE_ALIGNED
178 # define DECL_ALIGN(type, var) \
179 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
180 # elif defined(_MSC_VER)
181 # define ALIGN_GCTYPEBITS 8
182 # if (1 << GCTYPEBITS) != ALIGN_GCTYPEBITS
183 # error ALIGN_GCTYPEBITS is wrong!
185 # define DECL_ALIGN(type, var) \
186 type __declspec(align(ALIGN_GCTYPEBITS)) var
188 /* What directives do other compilers use? */
193 /* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8. */
194 #if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
195 || defined DARWIN_OS || defined __sun)
196 /* We also need to be able to specify mult-of-8 alignment on static vars. */
197 # if defined DECL_ALIGN
198 /* mark_maybe_object assumes that EMACS_INT values are contiguous,
199 but this is not true on some hosts where EMACS_INT is wider than a pointer,
200 as they may allocate the halves of an EMACS_INT separately.
201 On these hosts USE_LSB_TAG is not needed because the top bits of an
202 EMACS_INT are unused, so define USE_LSB_TAG only on hosts where it
204 # if UINTPTR_MAX >> VALBITS != 0
210 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
213 # error "USE_LSB_TAG used without defining DECL_ALIGN"
215 # define DECL_ALIGN(type, var) type var
219 /* Define the fundamental Lisp data structures. */
221 /* If USE_2_TAGBITS_FOR_INTS is defined, then Lisp integers use
222 2 tags, to give them one extra bit, thus extending their range from
223 e.g -2^28..2^28-1 to -2^29..2^29-1. */
224 #define USE_2_TAGS_FOR_INTS
226 /* Making it work for the union case is too much trouble. */
227 #ifdef USE_LISP_UNION_TYPE
228 # undef USE_2_TAGS_FOR_INTS
231 /* This is the set of Lisp data types. */
233 #if !defined USE_2_TAGS_FOR_INTS
234 # define LISP_INT_TAG Lisp_Int
235 # define case_Lisp_Int case Lisp_Int
236 # define LISP_STRING_TAG 4
237 # define LISP_INT_TAG_P(x) ((x) == Lisp_Int)
239 # define LISP_INT_TAG Lisp_Int0
240 # define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
242 # define LISP_INT1_TAG 4
243 # define LISP_STRING_TAG 1
244 # define LISP_INT_TAG_P(x) (((x) & 3) == 0)
246 # define LISP_INT1_TAG 1
247 # define LISP_STRING_TAG 4
248 # define LISP_INT_TAG_P(x) (((x) & 6) == 0)
252 /* Stolen from GDB. The only known compiler that doesn't support
253 enums in bitfields is MSVC. */
255 #define ENUM_BF(TYPE) unsigned int
257 #define ENUM_BF(TYPE) enum TYPE
263 /* Integer. XINT (obj) is the integer value. */
264 #ifdef USE_2_TAGS_FOR_INTS
266 Lisp_Int1
= LISP_INT1_TAG
,
271 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
274 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
275 whose first member indicates the subtype. */
278 /* String. XSTRING (object) points to a struct Lisp_String.
279 The length of the string, and its contents, are stored therein. */
280 Lisp_String
= LISP_STRING_TAG
,
282 /* Vector of Lisp objects, or something resembling it.
283 XVECTOR (object) points to a struct Lisp_Vector, which contains
284 the size and contents. The size field also contains the type
285 information, if it's not a real vector object. */
288 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
294 /* This is the set of data types that share a common structure.
295 The first member of the structure is a type code from this set.
296 The enum values are arbitrary, but we'll use large numbers to make it
297 more likely that we'll spot the error if a random word in memory is
298 mistakenly interpreted as a Lisp_Misc. */
301 Lisp_Misc_Free
= 0x5eab,
304 Lisp_Misc_Save_Value
,
305 /* Currently floats are not a misc type,
306 but let's define this in case we want to change that. */
308 /* This is not a type code. It is for range checking. */
312 /* These are the types of forwarding objects used in the value slot
313 of symbols for special built-in variables whose value is stored in
317 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
318 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
319 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
320 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
321 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
324 #ifdef USE_LISP_UNION_TYPE
326 #ifndef WORDS_BIGENDIAN
328 /* Definition of Lisp_Object for little-endian machines. */
333 /* Used for comparing two Lisp_Objects;
334 also, positive integers can be accessed fast this way. */
339 /* Use explicit signed, the signedness of a bit-field of type
340 int is implementation defined. */
341 signed EMACS_INT val
: VALBITS
;
342 ENUM_BF (Lisp_Type
) type
: GCTYPEBITS
;
346 EMACS_UINT val
: VALBITS
;
347 ENUM_BF (Lisp_Type
) type
: GCTYPEBITS
;
352 #else /* If WORDS_BIGENDIAN */
357 /* Used for comparing two Lisp_Objects;
358 also, positive integers can be accessed fast this way. */
363 ENUM_BF (Lisp_Type
) type
: GCTYPEBITS
;
364 /* Use explicit signed, the signedness of a bit-field of type
365 int is implementation defined. */
366 signed EMACS_INT val
: VALBITS
;
370 ENUM_BF (Lisp_Type
) type
: GCTYPEBITS
;
371 EMACS_UINT val
: VALBITS
;
376 #endif /* WORDS_BIGENDIAN */
379 static inline Lisp_Object
380 LISP_MAKE_RVALUE (Lisp_Object o
)
385 /* This is more portable to pre-C99 non-GCC compilers, but for
386 backwards compatibility GCC still accepts an old GNU extension
387 which caused this to only generate a warning. */
388 #define LISP_MAKE_RVALUE(o) (0 ? (o) : (o))
391 #else /* USE_LISP_UNION_TYPE */
393 /* If union type is not wanted, define Lisp_Object as just a number. */
395 typedef EMACS_INT Lisp_Object
;
396 #define LISP_MAKE_RVALUE(o) (0+(o))
397 #endif /* USE_LISP_UNION_TYPE */
399 /* In the size word of a vector, this bit means the vector has been marked.
400 (Shift -1 left, not 1, to avoid provoking overflow diagnostics.) */
402 #define ARRAY_MARK_FLAG ((EMACS_INT) -1 << (BITS_PER_EMACS_INT - 1))
404 /* In the size word of a struct Lisp_Vector, this bit means it's really
405 some other vector-like object. */
406 #define PSEUDOVECTOR_FLAG ((EMACS_INT) 1 << (BITS_PER_EMACS_INT - 2))
408 /* In a pseudovector, the size field actually contains a word with one
409 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
410 indicate the actual type.
411 We use a bitset, even tho only one of the bits can be set at any
412 particular time just so as to be able to use micro-optimizations such as
413 testing membership of a particular subset of pseudovectors in Fequal.
414 It is not crucial, but there are plenty of bits here, so why not do it? */
417 PVEC_NORMAL_VECTOR
= 0,
418 PVEC_PROCESS
= 0x200,
420 PVEC_COMPILED
= 0x800,
421 PVEC_WINDOW
= 0x1000,
422 PVEC_WINDOW_CONFIGURATION
= 0x2000,
424 PVEC_CHAR_TABLE
= 0x8000,
425 PVEC_BOOL_VECTOR
= 0x10000,
426 PVEC_BUFFER
= 0x20000,
427 PVEC_HASH_TABLE
= 0x40000,
428 PVEC_TERMINAL
= 0x80000,
429 PVEC_SUB_CHAR_TABLE
= 0x100000,
430 PVEC_FONT
= 0x200000,
431 PVEC_OTHER
= 0x400000,
433 PVEC_XWIDGET
= 0x800000,
434 PVEC_XWIDGET_VIEW
= 0x1000000,
436 PVEC_TYPE_MASK
= 0x3fffe00
438 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
439 GDB. It doesn't work on OS Alpha. Moved to a variable in
441 PVEC_FLAG
= PSEUDOVECTOR_FLAG
445 /* For convenience, we also store the number of elements in these bits.
446 Note that this size is not necessarily the memory-footprint size, but
447 only the number of Lisp_Object fields (that need to be traced by the GC).
448 The distinction is used e.g. by Lisp_Process which places extra
449 non-Lisp_Object fields at the end of the structure. */
450 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
452 /* Number of bits to put in each character in the internal representation
453 of bool vectors. This should not vary across implementations. */
454 #define BOOL_VECTOR_BITS_PER_CHAR 8
456 /* These macros extract various sorts of values from a Lisp_Object.
457 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
458 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
460 #ifndef USE_LISP_UNION_TYPE
462 /* Return a perfect hash of the Lisp_Object representation. */
467 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
468 #define XTYPE(a) ((enum Lisp_Type) ((a) & TYPEMASK))
469 #ifdef USE_2_TAGS_FOR_INTS
470 # define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
471 # define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
472 # define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
474 # define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
475 # define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
476 # define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
478 #define XSET(var, type, ptr) \
479 (eassert (XTYPE ((intptr_t) (ptr)) == 0), /* Check alignment. */ \
480 (var) = (type) | (intptr_t) (ptr))
482 #define XPNTR(a) ((intptr_t) ((a) & ~TYPEMASK))
484 #else /* not USE_LSB_TAG */
486 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
488 /* One need to override this if there must be high bits set in data space
489 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
490 on all machines, but would penalize machines which don't need it)
492 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
494 /* For integers known to be positive, XFASTINT provides fast retrieval
495 and XSETFASTINT provides fast storage. This takes advantage of the
496 fact that Lisp_Int is 0. */
497 #define XFASTINT(a) ((a) + 0)
498 #define XSETFASTINT(a, b) ((a) = (b))
500 /* Extract the value of a Lisp_Object as a (un)signed integer. */
502 #ifdef USE_2_TAGS_FOR_INTS
503 # define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
504 # define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
505 # define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
507 # define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
508 >> (BITS_PER_EMACS_INT - VALBITS))
509 # define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
510 # define make_number(N) \
511 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
514 #define XSET(var, type, ptr) \
515 ((var) = ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
516 + ((intptr_t) (ptr) & VALMASK)))
519 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
520 which were stored in a Lisp_Object */
521 #define XPNTR(a) ((uintptr_t) (((a) & VALMASK)) | DATA_SEG_BITS))
523 #define XPNTR(a) ((uintptr_t) ((a) & VALMASK))
526 #endif /* not USE_LSB_TAG */
528 #else /* USE_LISP_UNION_TYPE */
530 #ifdef USE_2_TAGS_FOR_INTS
531 # error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
534 #define XHASH(a) ((a).i)
535 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
536 #define XINT(a) ((EMACS_INT) (a).s.val)
537 #define XUINT(a) ((EMACS_UINT) (a).u.val)
541 # define XSET(var, vartype, ptr) \
542 (eassert ((((uintptr_t) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0), \
543 (var).u.val = ((uintptr_t) (ptr)) >> GCTYPEBITS, \
544 (var).u.type = ((char) (vartype)))
546 /* Some versions of gcc seem to consider the bitfield width when issuing
547 the "cast to pointer from integer of different size" warning, so the
548 cast is here to widen the value back to its natural size. */
549 # define XPNTR(v) ((intptr_t) (v).s.val << GCTYPEBITS)
551 #else /* !USE_LSB_TAG */
553 /* For integers known to be positive, XFASTINT provides fast retrieval
554 and XSETFASTINT provides fast storage. This takes advantage of the
555 fact that Lisp_Int is 0. */
556 # define XFASTINT(a) ((a).i + 0)
557 # define XSETFASTINT(a, b) ((a).i = (b))
559 # define XSET(var, vartype, ptr) \
560 (((var).s.val = ((intptr_t) (ptr))), ((var).s.type = ((char) (vartype))))
563 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
564 which were stored in a Lisp_Object */
565 #define XPNTR(a) ((intptr_t) (XUINT (a) | DATA_SEG_BITS))
567 #define XPNTR(a) ((intptr_t) XUINT (a))
570 #endif /* !USE_LSB_TAG */
572 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
573 #define make_number(N) \
574 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
576 extern Lisp_Object
make_number (EMACS_INT
);
579 #endif /* USE_LISP_UNION_TYPE */
581 /* For integers known to be positive, XFASTINT sometimes provides
582 faster retrieval and XSETFASTINT provides faster storage.
583 If not, fallback on the non-accelerated path. */
585 # define XFASTINT(a) (XINT (a))
586 # define XSETFASTINT(a, b) (XSETINT (a, b))
589 #define EQ(x, y) (XHASH (x) == XHASH (y))
591 /* Number of bits in a fixnum, including the sign bit. */
592 #ifdef USE_2_TAGS_FOR_INTS
593 # define FIXNUM_BITS (VALBITS + 1)
595 # define FIXNUM_BITS VALBITS
598 /* Mask indicating the significant bits of a fixnum. */
599 #define INTMASK (((EMACS_INT) 1 << FIXNUM_BITS) - 1)
601 /* Largest and smallest representable fixnum values. These are the C
603 #define MOST_POSITIVE_FIXNUM (INTMASK / 2)
604 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
606 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
607 written this way so that it also works if I is of unsigned
608 type or if I is a NaN. */
610 #define FIXNUM_OVERFLOW_P(i) \
611 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
613 /* Extract a value or address from a Lisp_Object. */
615 #define XCONS(a) (eassert (CONSP (a)), (struct Lisp_Cons *) XPNTR (a))
616 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), (struct Lisp_Vector *) XPNTR (a))
617 #define XSTRING(a) (eassert (STRINGP (a)), (struct Lisp_String *) XPNTR (a))
618 #define XSYMBOL(a) (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XPNTR (a))
619 #define XFLOAT(a) (eassert (FLOATP (a)), (struct Lisp_Float *) XPNTR (a))
623 #define XMISC(a) ((union Lisp_Misc *) XPNTR (a))
624 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
625 #define XMISCTYPE(a) (XMISCANY (a)->type)
626 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
627 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
628 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
630 /* Forwarding object types. */
632 #define XFWDTYPE(a) (a->u_intfwd.type)
633 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
634 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
635 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
636 #define XBUFFER_OBJFWD(a) \
637 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
638 #define XKBOARD_OBJFWD(a) \
639 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
641 /* Pseudovector types. */
643 #define XPROCESS(a) (eassert (PROCESSP (a)), (struct Lisp_Process *) XPNTR (a))
644 #define XWINDOW(a) (eassert (WINDOWP (a)), (struct window *) XPNTR (a))
645 #define XTERMINAL(a) (eassert (TERMINALP (a)), (struct terminal *) XPNTR (a))
646 #define XSUBR(a) (eassert (SUBRP (a)), (struct Lisp_Subr *) XPNTR (a))
647 #define XBUFFER(a) (eassert (BUFFERP (a)), (struct buffer *) XPNTR (a))
648 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR (a))
649 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR (a))
650 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR (a))
652 /* Construct a Lisp_Object from a value or address. */
654 #define XSETINT(a, b) (a) = make_number (b)
655 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
656 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
657 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
658 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
659 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
663 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
664 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
666 /* Pseudovector types. */
668 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
669 #define XSETTYPED_PVECTYPE(v, size_member, code) \
670 ((v)->size_member |= PSEUDOVECTOR_FLAG | (code))
671 #define XSETPVECTYPESIZE(v, code, sizeval) \
672 ((v)->header.size = PSEUDOVECTOR_FLAG | (code) | (sizeval))
674 /* The cast to struct vectorlike_header * avoids aliasing issues. */
675 #define XSETPSEUDOVECTOR(a, b, code) \
676 XSETTYPED_PSEUDOVECTOR(a, b, \
677 ((struct vectorlike_header *) XPNTR (a))->size, \
679 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
680 (XSETVECTOR (a, b), \
681 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
682 == (PSEUDOVECTOR_FLAG | (code))))
684 #define XSETWINDOW_CONFIGURATION(a, b) \
685 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
686 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
687 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
688 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
689 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
690 #define XSETSUBR(a, b) \
691 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
692 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
693 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
694 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
695 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
696 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
698 /* Convenience macros for dealing with Lisp arrays. */
700 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
701 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
702 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
703 #define ASET(ARRAY, IDX, VAL) \
704 (eassert ((IDX) == (IDX)), \
705 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
706 AREF ((ARRAY), (IDX)) = (VAL))
708 /* Convenience macros for dealing with Lisp strings. */
710 #define SDATA(string) (XSTRING (string)->data + 0)
711 #define SREF(string, index) (SDATA (string)[index] + 0)
712 #define SSET(string, index, new) (SDATA (string)[index] = (new))
713 #define SCHARS(string) (XSTRING (string)->size + 0)
714 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
716 /* Avoid "differ in sign" warnings. */
717 #define SSDATA(x) ((char *) SDATA (x))
719 #define STRING_SET_CHARS(string, newsize) \
720 (XSTRING (string)->size = (newsize))
722 #define STRING_COPYIN(string, index, new, count) \
723 memcpy (SDATA (string) + index, new, count)
727 #define CHECK_TYPE(ok, Qxxxp, x) \
728 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
732 /* See the macros in intervals.h. */
734 typedef struct interval
*INTERVAL
;
736 /* Complain if object is not string or buffer type */
737 #define CHECK_STRING_OR_BUFFER(x) \
738 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
741 /* In a cons, the markbit of the car is the gc mark bit */
745 /* Please do not use the names of these elements in code other
746 than the core lisp implementation. Use XCAR and XCDR below. */
747 #ifdef HIDE_LISP_IMPLEMENTATION
752 struct Lisp_Cons
*chain
;
759 struct Lisp_Cons
*chain
;
764 /* Take the car or cdr of something known to be a cons cell. */
765 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
766 of code that has to know what a cons cell looks like. Other code not
767 part of the basic lisp implementation should assume that the car and cdr
768 fields are not accessible as lvalues. (What if we want to switch to
769 a copying collector someday? Cached cons cell field addresses may be
770 invalidated at arbitrary points.) */
771 #ifdef HIDE_LISP_IMPLEMENTATION
772 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
773 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
775 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
776 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
779 /* Use these from normal code. */
780 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
781 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
783 /* Use these to set the fields of a cons cell.
785 Note that both arguments may refer to the same object, so 'n'
786 should not be read after 'c' is first modified. Also, neither
787 argument should be evaluated more than once; side effects are
788 especially common in the second argument. */
789 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
790 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
792 /* Take the car or cdr of something whose type is not known. */
794 (CONSP ((c)) ? XCAR ((c)) \
795 : NILP ((c)) ? Qnil \
796 : wrong_type_argument (Qlistp, (c)))
799 (CONSP ((c)) ? XCDR ((c)) \
800 : NILP ((c)) ? Qnil \
801 : wrong_type_argument (Qlistp, (c)))
803 /* Take the car or cdr of something whose type is not known. */
804 #define CAR_SAFE(c) \
805 (CONSP ((c)) ? XCAR ((c)) : Qnil)
807 #define CDR_SAFE(c) \
808 (CONSP ((c)) ? XCDR ((c)) : Qnil)
810 /* Nonzero if STR is a multibyte string. */
811 #define STRING_MULTIBYTE(STR) \
812 (XSTRING (STR)->size_byte >= 0)
814 /* Return the length in bytes of STR. */
816 #ifdef GC_CHECK_STRING_BYTES
819 extern EMACS_INT
string_bytes (struct Lisp_String
*);
820 #define STRING_BYTES(S) string_bytes ((S))
822 #else /* not GC_CHECK_STRING_BYTES */
824 #define STRING_BYTES(STR) \
825 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
827 #endif /* not GC_CHECK_STRING_BYTES */
829 /* An upper bound on the number of bytes in a Lisp string, not
830 counting the terminating null. This a tight enough bound to
831 prevent integer overflow errors that would otherwise occur during
832 string size calculations. A string cannot contain more bytes than
833 a fixnum can represent, nor can it be so long that C pointer
834 arithmetic stops working on the string plus its terminating null.
835 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
836 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
837 would expose alloc.c internal details that we'd rather keep
838 private. The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is
840 #define STRING_BYTES_BOUND \
841 min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1)
843 /* Mark STR as a unibyte string. */
844 #define STRING_SET_UNIBYTE(STR) \
845 do { if (EQ (STR, empty_multibyte_string)) \
846 (STR) = empty_unibyte_string; \
847 else XSTRING (STR)->size_byte = -1; } while (0)
849 /* Mark STR as a multibyte string. Assure that STR contains only
850 ASCII characters in advance. */
851 #define STRING_SET_MULTIBYTE(STR) \
852 do { if (EQ (STR, empty_unibyte_string)) \
853 (STR) = empty_multibyte_string; \
854 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
856 /* Get text properties. */
857 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
859 /* Set text properties. */
860 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
862 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
868 INTERVAL intervals
; /* text properties in this string */
872 /* Header of vector-like objects. This documents the layout constraints on
873 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
874 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
875 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
876 because when two such pointers potentially alias, a compiler won't
877 incorrectly reorder loads and stores to their size fields. See
878 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
879 struct vectorlike_header
883 /* Pointer to the next vector-like object. It is generally a buffer or a
884 Lisp_Vector alias, so for convenience it is a union instead of a
885 pointer: this way, one can write P->next.vector instead of ((struct
886 Lisp_Vector *) P->next). */
888 struct buffer
*buffer
;
889 struct Lisp_Vector
*vector
;
895 struct vectorlike_header header
;
896 Lisp_Object contents
[1];
899 /* If a struct is made to look like a vector, this macro returns the length
900 of the shortest vector that would hold that struct. */
901 #define VECSIZE(type) ((sizeof (type) \
902 - offsetof (struct Lisp_Vector, contents[0]) \
903 + sizeof (Lisp_Object) - 1) /* round up */ \
904 / sizeof (Lisp_Object))
906 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
907 at the end and we need to compute the number of Lisp_Object fields (the
908 ones that the GC needs to trace). */
909 #define PSEUDOVECSIZE(type, nonlispfield) \
910 ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \
911 / sizeof (Lisp_Object))
913 /* A char-table is a kind of vectorlike, with contents are like a
914 vector but with a few other slots. For some purposes, it makes
915 sense to handle a char-table with type struct Lisp_Vector. An
916 element of a char table can be any Lisp objects, but if it is a sub
917 char-table, we treat it a table that contains information of a
918 specific range of characters. A sub char-table has the same
919 structure as a vector. A sub char table appears only in an element
920 of a char-table, and there's no way to access it directly from
921 Emacs Lisp program. */
923 /* This is the number of slots that every char table must have. This
924 counts the ordinary slots and the top, defalt, parent, and purpose
926 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
928 /* Return the number of "extra" slots in the char table CT. */
930 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
931 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
935 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
936 ({struct Lisp_Char_Table *_tbl = NULL; \
939 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
940 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
941 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
943 _val = _tbl->defalt; \
944 } while (NILP (_val) && ! NILP (_tbl->parent)); \
947 #else /* not __GNUC__ */
949 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
950 (! NILP (XCHAR_TABLE (CT)->ascii) \
951 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
952 ? XCHAR_TABLE (CT)->ascii \
953 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
954 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
955 : char_table_ref ((CT), (IDX))) \
956 : char_table_ref ((CT), (IDX)))
958 #endif /* not __GNUC__ */
960 /* Compute A OP B, using the unsigned comparison operator OP. A and B
961 should be integer expressions. This is not the same as
962 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
963 returns 1. For efficiency, prefer plain unsigned comparison if A
964 and B's sizes both fit (after integer promotion). */
965 #define UNSIGNED_CMP(a, op, b) \
966 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
967 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
968 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
970 /* Nonzero iff C is an ASCII character. */
971 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
973 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
974 characters. Do not check validity of CT. */
975 #define CHAR_TABLE_REF(CT, IDX) \
976 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
977 : char_table_ref ((CT), (IDX)))
979 /* Almost equivalent to Faref (CT, IDX). However, if the result is
980 not a character, return IDX.
982 For these characters, do not check validity of CT
983 and do not follow parent. */
984 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
985 char_table_translate (CT, IDX)
987 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
988 8-bit European characters. Do not check validity of CT. */
989 #define CHAR_TABLE_SET(CT, IDX, VAL) \
990 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
991 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
992 : char_table_set (CT, IDX, VAL))
994 #define CHARTAB_SIZE_BITS_0 6
995 #define CHARTAB_SIZE_BITS_1 4
996 #define CHARTAB_SIZE_BITS_2 5
997 #define CHARTAB_SIZE_BITS_3 7
999 extern const int chartab_size
[4];
1001 struct Lisp_Sub_Char_Table
;
1003 struct Lisp_Char_Table
1005 /* HEADER.SIZE is the vector's size field, which also holds the
1006 pseudovector type information. It holds the size, too.
1007 The size counts the defalt, parent, purpose, ascii,
1008 contents, and extras slots. */
1009 struct vectorlike_header header
;
1011 /* This holds a default value,
1012 which is used whenever the value for a specific character is nil. */
1015 /* This points to another char table, which we inherit from when the
1016 value for a specific character is nil. The `defalt' slot takes
1017 precedence over this. */
1020 /* This is a symbol which says what kind of use this char-table is
1022 Lisp_Object purpose
;
1024 /* The bottom sub char-table for characters of the range 0..127. It
1025 is nil if none of ASCII character has a specific value. */
1028 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1030 /* These hold additional data. It is a vector. */
1031 Lisp_Object extras
[1];
1034 struct Lisp_Sub_Char_Table
1036 /* HEADER.SIZE is the vector's size field, which also holds the
1037 pseudovector type information. It holds the size, too. */
1038 struct vectorlike_header header
;
1040 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1041 char-table of depth 1 contains 16 elements, and each element
1042 covers 4096 (128*32) characters. A sub char-table of depth 2
1043 contains 32 elements, and each element covers 128 characters. A
1044 sub char-table of depth 3 contains 128 elements, and each element
1045 is for one character. */
1048 /* Minimum character covered by the sub char-table. */
1049 Lisp_Object min_char
;
1051 Lisp_Object contents
[1];
1054 /* A boolvector is a kind of vectorlike, with contents are like a string. */
1055 struct Lisp_Bool_Vector
1057 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1058 just the subtype information. */
1059 struct vectorlike_header header
;
1060 /* This is the size in bits. */
1062 /* This contains the actual bits, packed into bytes. */
1063 unsigned char data
[1];
1066 /* This structure describes a built-in function.
1067 It is generated by the DEFUN macro only.
1068 defsubr makes it into a Lisp object.
1070 This type is treated in most respects as a pseudovector,
1071 but since we never dynamically allocate or free them,
1072 we don't need a struct vectorlike_header and its 'next' field. */
1078 Lisp_Object (*a0
) (void);
1079 Lisp_Object (*a1
) (Lisp_Object
);
1080 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1081 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1082 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1083 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1084 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1085 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1086 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1087 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1088 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1090 short min_args
, max_args
;
1091 const char *symbol_name
;
1092 const char *intspec
;
1097 /***********************************************************************
1099 ***********************************************************************/
1101 /* Interned state of a symbol. */
1103 enum symbol_interned
1105 SYMBOL_UNINTERNED
= 0,
1106 SYMBOL_INTERNED
= 1,
1107 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1110 enum symbol_redirect
1112 SYMBOL_PLAINVAL
= 4,
1113 SYMBOL_VARALIAS
= 1,
1114 SYMBOL_LOCALIZED
= 2,
1115 SYMBOL_FORWARDED
= 3
1120 unsigned gcmarkbit
: 1;
1122 /* Indicates where the value can be found:
1123 0 : it's a plain var, the value is in the `value' field.
1124 1 : it's a varalias, the value is really in the `alias' symbol.
1125 2 : it's a localized var, the value is in the `blv' object.
1126 3 : it's a forwarding variable, the value is in `forward'. */
1127 ENUM_BF (symbol_redirect
) redirect
: 3;
1129 /* Non-zero means symbol is constant, i.e. changing its value
1130 should signal an error. If the value is 3, then the var
1131 can be changed, but only by `defconst'. */
1132 unsigned constant
: 2;
1134 /* Interned state of the symbol. This is an enumerator from
1135 enum symbol_interned. */
1136 unsigned interned
: 2;
1138 /* Non-zero means that this variable has been explicitly declared
1139 special (with `defvar' etc), and shouldn't be lexically bound. */
1140 unsigned declared_special
: 1;
1142 /* The symbol's name, as a Lisp string.
1143 The name "xname" is used to intentionally break code referring to
1144 the old field "name" of type pointer to struct Lisp_String. */
1147 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1148 union is used depends on the `redirect' field above. */
1151 struct Lisp_Symbol
*alias
;
1152 struct Lisp_Buffer_Local_Value
*blv
;
1153 union Lisp_Fwd
*fwd
;
1156 /* Function value of the symbol or Qunbound if not fboundp. */
1157 Lisp_Object function
;
1159 /* The symbol's property list. */
1162 /* Next symbol in obarray bucket, if the symbol is interned. */
1163 struct Lisp_Symbol
*next
;
1166 /* Value is name of symbol. */
1168 #define SYMBOL_VAL(sym) \
1169 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1170 #define SYMBOL_ALIAS(sym) \
1171 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1172 #define SYMBOL_BLV(sym) \
1173 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1174 #define SYMBOL_FWD(sym) \
1175 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1176 #define SET_SYMBOL_VAL(sym, v) \
1177 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1178 #define SET_SYMBOL_ALIAS(sym, v) \
1179 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1180 #define SET_SYMBOL_BLV(sym, v) \
1181 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1182 #define SET_SYMBOL_FWD(sym, v) \
1183 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1185 #define SYMBOL_NAME(sym) \
1186 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1188 /* Value is non-zero if SYM is an interned symbol. */
1190 #define SYMBOL_INTERNED_P(sym) \
1191 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1193 /* Value is non-zero if SYM is interned in initial_obarray. */
1195 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1196 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1198 /* Value is non-zero if symbol is considered a constant, i.e. its
1199 value cannot be changed (there is an exception for keyword symbols,
1200 whose value can be set to the keyword symbol itself). */
1202 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1204 #define DEFSYM(sym, name) \
1205 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1208 /***********************************************************************
1210 ***********************************************************************/
1212 /* The structure of a Lisp hash table. */
1214 struct Lisp_Hash_Table
1216 /* This is for Lisp; the hash table code does not refer to it. */
1217 struct vectorlike_header header
;
1219 /* Function used to compare keys. */
1222 /* Nil if table is non-weak. Otherwise a symbol describing the
1223 weakness of the table. */
1226 /* When the table is resized, and this is an integer, compute the
1227 new size by adding this to the old size. If a float, compute the
1228 new size by multiplying the old size with this factor. */
1229 Lisp_Object rehash_size
;
1231 /* Resize hash table when number of entries/ table size is >= this
1233 Lisp_Object rehash_threshold
;
1235 /* Vector of hash codes.. If hash[I] is nil, this means that that
1236 entry I is unused. */
1239 /* Vector used to chain entries. If entry I is free, next[I] is the
1240 entry number of the next free item. If entry I is non-free,
1241 next[I] is the index of the next entry in the collision chain. */
1244 /* Index of first free entry in free list. */
1245 Lisp_Object next_free
;
1247 /* Bucket vector. A non-nil entry is the index of the first item in
1248 a collision chain. This vector's size can be larger than the
1249 hash table size to reduce collisions. */
1252 /* User-supplied hash function, or nil. */
1253 Lisp_Object user_hash_function
;
1255 /* User-supplied key comparison function, or nil. */
1256 Lisp_Object user_cmp_function
;
1258 /* Only the fields above are traced normally by the GC. The ones below
1259 `count' are special and are either ignored by the GC or traced in
1260 a special way (e.g. because of weakness). */
1262 /* Number of key/value entries in the table. */
1265 /* Vector of keys and values. The key of item I is found at index
1266 2 * I, the value is found at index 2 * I + 1.
1267 This is gc_marked specially if the table is weak. */
1268 Lisp_Object key_and_value
;
1270 /* Next weak hash table if this is a weak hash table. The head
1271 of the list is in weak_hash_tables. */
1272 struct Lisp_Hash_Table
*next_weak
;
1274 /* C function to compare two keys. */
1275 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1276 Lisp_Object
, EMACS_UINT
,
1277 Lisp_Object
, EMACS_UINT
);
1279 /* C function to compute hash code. */
1280 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1284 #define XHASH_TABLE(OBJ) \
1285 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1287 #define XSET_HASH_TABLE(VAR, PTR) \
1288 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1290 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1292 #define CHECK_HASH_TABLE(x) \
1293 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1295 /* Value is the key part of entry IDX in hash table H. */
1297 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1299 /* Value is the value part of entry IDX in hash table H. */
1301 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1303 /* Value is the index of the next entry following the one at IDX
1306 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1308 /* Value is the hash code computed for entry IDX in hash table H. */
1310 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1312 /* Value is the index of the element in hash table H that is the
1313 start of the collision list at index IDX in the index vector of H. */
1315 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1317 /* Value is the size of hash table H. */
1319 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1321 /* Default size for hash tables if not specified. */
1323 #define DEFAULT_HASH_SIZE 65
1325 /* Default threshold specifying when to resize a hash table. The
1326 value gives the ratio of current entries in the hash table and the
1327 size of the hash table. */
1329 #define DEFAULT_REHASH_THRESHOLD 0.8
1331 /* Default factor by which to increase the size of a hash table. */
1333 #define DEFAULT_REHASH_SIZE 1.5
1336 /* These structures are used for various misc types. */
1338 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1340 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1341 unsigned gcmarkbit
: 1;
1343 /* Make it as long as "Lisp_Free without padding". */
1349 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1350 unsigned gcmarkbit
: 1;
1352 /* This flag is temporarily used in the functions
1353 decode/encode_coding_object to record that the marker position
1354 must be adjusted after the conversion. */
1355 unsigned int need_adjustment
: 1;
1356 /* 1 means normal insertion at the marker's position
1357 leaves the marker after the inserted text. */
1358 unsigned int insertion_type
: 1;
1359 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1360 Note: a chain of markers can contain markers pointing into different
1361 buffers (the chain is per buffer_text rather than per buffer, so it's
1362 shared between indirect buffers). */
1363 /* This is used for (other than NULL-checking):
1365 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1366 - unchain_marker: to find the list from which to unchain.
1367 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1369 struct buffer
*buffer
;
1371 /* The remaining fields are meaningless in a marker that
1372 does not point anywhere. */
1374 /* For markers that point somewhere,
1375 this is used to chain of all the markers in a given buffer. */
1376 /* We could remove it and use an array in buffer_text instead.
1377 That would also allow to preserve it ordered. */
1378 struct Lisp_Marker
*next
;
1379 /* This is the char position where the marker points. */
1381 /* This is the byte position.
1382 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1383 used to implement the functionality of markers, but rather to (ab)use
1384 markers as a cache for char<->byte mappings). */
1388 /* Forwarding pointer to an int variable.
1389 This is allowed only in the value cell of a symbol,
1390 and it means that the symbol's value really lives in the
1391 specified int variable. */
1394 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1398 /* Boolean forwarding pointer to an int variable.
1399 This is like Lisp_Intfwd except that the ostensible
1400 "value" of the symbol is t if the int variable is nonzero,
1401 nil if it is zero. */
1404 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1408 /* Forwarding pointer to a Lisp_Object variable.
1409 This is allowed only in the value cell of a symbol,
1410 and it means that the symbol's value really lives in the
1411 specified variable. */
1414 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1415 Lisp_Object
*objvar
;
1418 /* Like Lisp_Objfwd except that value lives in a slot in the
1419 current buffer. Value is byte index of slot within buffer. */
1420 struct Lisp_Buffer_Objfwd
1422 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1424 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1427 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1428 the symbol has buffer-local or frame-local bindings. (Exception:
1429 some buffer-local variables are built-in, with their values stored
1430 in the buffer structure itself. They are handled differently,
1431 using struct Lisp_Buffer_Objfwd.)
1433 The `realvalue' slot holds the variable's current value, or a
1434 forwarding pointer to where that value is kept. This value is the
1435 one that corresponds to the loaded binding. To read or set the
1436 variable, you must first make sure the right binding is loaded;
1437 then you can access the value in (or through) `realvalue'.
1439 `buffer' and `frame' are the buffer and frame for which the loaded
1440 binding was found. If those have changed, to make sure the right
1441 binding is loaded it is necessary to find which binding goes with
1442 the current buffer and selected frame, then load it. To load it,
1443 first unload the previous binding, then copy the value of the new
1444 binding into `realvalue' (or through it). Also update
1445 LOADED-BINDING to point to the newly loaded binding.
1447 `local_if_set' indicates that merely setting the variable creates a
1448 local binding for the current buffer. Otherwise the latter, setting
1449 the variable does not do that; only make-local-variable does that. */
1451 struct Lisp_Buffer_Local_Value
1453 /* 1 means that merely setting the variable creates a local
1454 binding for the current buffer */
1455 unsigned int local_if_set
: 1;
1456 /* 1 means this variable can have frame-local bindings, otherwise, it is
1457 can have buffer-local bindings. The two cannot be combined. */
1458 unsigned int frame_local
: 1;
1459 /* 1 means that the binding now loaded was found.
1460 Presumably equivalent to (defcell!=valcell) */
1461 unsigned int found
: 1;
1462 /* If non-NULL, a forwarding to the C var where it should also be set. */
1463 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1464 /* The buffer or frame for which the loaded binding was found. */
1466 /* A cons cell that holds the default value. It has the form
1467 (SYMBOL . DEFAULT-VALUE). */
1468 Lisp_Object defcell
;
1469 /* The cons cell from `where's parameter alist.
1470 It always has the form (SYMBOL . VALUE)
1471 Note that if `forward' is non-nil, VALUE may be out of date.
1472 Also if the currently loaded binding is the default binding, then
1473 this is `eq'ual to defcell. */
1474 Lisp_Object valcell
;
1477 #define BLV_FOUND(blv) \
1478 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1479 #define SET_BLV_FOUND(blv, v) \
1480 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1482 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1483 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1485 /* START and END are markers in the overlay's buffer, and
1486 PLIST is the overlay's property list. */
1488 /* An overlay's real data content is:
1491 - insertion type of both ends
1492 - start & start_byte
1494 - next (singly linked list of overlays).
1495 - start_next and end_next (singly linked list of markers).
1496 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1499 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1500 unsigned gcmarkbit
: 1;
1502 struct Lisp_Overlay
*next
;
1503 Lisp_Object start
, end
, plist
;
1506 /* Like Lisp_Objfwd except that value lives in a slot in the
1508 struct Lisp_Kboard_Objfwd
1510 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1514 /* Hold a C pointer for later use.
1515 This type of object is used in the arg to record_unwind_protect. */
1516 struct Lisp_Save_Value
1518 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1519 unsigned gcmarkbit
: 1;
1521 /* If DOGC is set, POINTER is the address of a memory
1522 area containing INTEGER potential Lisp_Objects. */
1523 unsigned int dogc
: 1;
1529 /* A miscellaneous object, when it's on the free list. */
1532 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1533 unsigned gcmarkbit
: 1;
1535 union Lisp_Misc
*chain
;
1537 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1538 This assumes that Lisp_Marker is the largest of the alternatives and
1539 that Lisp_Misc_Any has the same size as "Lisp_Free w/o padding". */
1540 char padding
[((((sizeof (struct Lisp_Marker
) - 1) >> GCTYPEBITS
) + 1)
1541 << GCTYPEBITS
) - sizeof (struct Lisp_Misc_Any
)];
1545 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1546 It uses one of these struct subtypes to get the type field. */
1550 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1551 struct Lisp_Free u_free
; /* Includes padding to force alignment. */
1552 struct Lisp_Marker u_marker
; /* 5 */
1553 struct Lisp_Overlay u_overlay
; /* 5 */
1554 struct Lisp_Save_Value u_save_value
; /* 3 */
1559 struct Lisp_Intfwd u_intfwd
; /* 2 */
1560 struct Lisp_Boolfwd u_boolfwd
; /* 2 */
1561 struct Lisp_Objfwd u_objfwd
; /* 2 */
1562 struct Lisp_Buffer_Objfwd u_buffer_objfwd
; /* 2 */
1563 struct Lisp_Kboard_Objfwd u_kboard_objfwd
; /* 2 */
1566 /* Lisp floating point type */
1571 #ifdef HIDE_LISP_IMPLEMENTATION
1576 struct Lisp_Float
*chain
;
1580 #ifdef HIDE_LISP_IMPLEMENTATION
1581 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1583 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1584 /* This should be used only in alloc.c, which always disables
1585 HIDE_LISP_IMPLEMENTATION. */
1586 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1589 /* A character, declared with the following typedef, is a member
1590 of some character set associated with the current buffer. */
1591 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1593 typedef unsigned char UCHAR
;
1596 /* Meanings of slots in a Lisp_Compiled: */
1598 #define COMPILED_ARGLIST 0
1599 #define COMPILED_BYTECODE 1
1600 #define COMPILED_CONSTANTS 2
1601 #define COMPILED_STACK_DEPTH 3
1602 #define COMPILED_DOC_STRING 4
1603 #define COMPILED_INTERACTIVE 5
1605 /* Flag bits in a character. These also get used in termhooks.h.
1606 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1607 (MUlti-Lingual Emacs) might need 22 bits for the character value
1608 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1609 #define CHAR_ALT (0x0400000)
1610 #define CHAR_SUPER (0x0800000)
1611 #define CHAR_HYPER (0x1000000)
1612 #define CHAR_SHIFT (0x2000000)
1613 #define CHAR_CTL (0x4000000)
1614 #define CHAR_META (0x8000000)
1616 #define CHAR_MODIFIER_MASK \
1617 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1620 /* Actually, the current Emacs uses 22 bits for the character value
1622 #define CHARACTERBITS 22
1625 /* The glyph datatype, used to represent characters on the display.
1626 It consists of a char code and a face id. */
1633 /* Return a glyph's character code. */
1634 #define GLYPH_CHAR(glyph) ((glyph).ch)
1636 /* Return a glyph's face ID. */
1637 #define GLYPH_FACE(glyph) ((glyph).face_id)
1639 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1640 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1641 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1643 /* Return 1 if GLYPH contains valid character code. */
1644 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1647 /* Glyph Code from a display vector may either be an integer which
1648 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1649 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1651 #define GLYPH_CODE_CHAR(gc) \
1652 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1654 #define GLYPH_CODE_FACE(gc) \
1655 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1657 /* Return 1 if glyph code from display vector contains valid character code. */
1658 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc))
1660 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1662 /* Only called when GLYPH_CODE_P (gc) is true. */
1663 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1667 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1669 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1670 (XINT (gc) >> CHARACTERBITS)); \
1674 /* The ID of the mode line highlighting face. */
1675 #define GLYPH_MODE_LINE_FACE 1
1677 /* Structure to hold mouse highlight data. This is here because other
1678 header files need it for defining struct x_output etc. */
1680 /* These variables describe the range of text currently shown in its
1681 mouse-face, together with the window they apply to. As long as
1682 the mouse stays within this range, we need not redraw anything on
1683 its account. Rows and columns are glyph matrix positions in
1684 MOUSE_FACE_WINDOW. */
1685 int mouse_face_beg_row
, mouse_face_beg_col
;
1686 int mouse_face_beg_x
, mouse_face_beg_y
;
1687 int mouse_face_end_row
, mouse_face_end_col
;
1688 int mouse_face_end_x
, mouse_face_end_y
;
1689 int mouse_face_past_end
;
1690 Lisp_Object mouse_face_window
;
1691 int mouse_face_face_id
;
1692 Lisp_Object mouse_face_overlay
;
1694 /* 1 if a mouse motion event came and we didn't handle it right away because
1695 gc was in progress. */
1696 int mouse_face_deferred_gc
;
1698 /* FRAME and X, Y position of mouse when last checked for
1699 highlighting. X and Y can be negative or out of range for the frame. */
1700 struct frame
*mouse_face_mouse_frame
;
1701 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1703 /* Nonzero means defer mouse-motion highlighting. */
1704 int mouse_face_defer
;
1706 /* Nonzero means that the mouse highlight should not be shown. */
1707 int mouse_face_hidden
;
1709 int mouse_face_image_state
;
1712 /* Data type checking */
1714 #define NILP(x) EQ (x, Qnil)
1716 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1717 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1719 #define RANGED_INTEGERP(lo, x, hi) \
1720 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1721 #define TYPE_RANGED_INTEGERP(type, x) \
1722 RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type))
1724 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1725 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1726 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1727 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1728 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1729 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1731 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1732 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1733 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1734 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1735 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1737 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1738 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1739 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1740 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1741 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1743 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1744 vectorlike_header * avoids aliasing issues. */
1745 #define PSEUDOVECTORP(x, code) \
1746 TYPED_PSEUDOVECTORP(x, vectorlike_header, code)
1748 /* True if object X, with internal type struct T *, is a pseudovector whose
1750 #define TYPED_PSEUDOVECTORP(x, t, code) \
1752 && (((((struct t *) XPNTR (x))->size \
1753 & (PSEUDOVECTOR_FLAG | (code)))) \
1754 == (PSEUDOVECTOR_FLAG | (code))))
1756 /* Test for specific pseudovector types. */
1757 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1758 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1759 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1760 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1761 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1762 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1763 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1764 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1765 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1766 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1767 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1768 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1770 /* Test for image (image . spec) */
1771 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1776 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1778 #define CHECK_LIST(x) \
1779 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1781 #define CHECK_LIST_CONS(x, y) \
1782 CHECK_TYPE (CONSP (x), Qlistp, y)
1784 #define CHECK_LIST_END(x, y) \
1785 CHECK_TYPE (NILP (x), Qlistp, y)
1787 #define CHECK_STRING(x) \
1788 CHECK_TYPE (STRINGP (x), Qstringp, x)
1790 #define CHECK_STRING_CAR(x) \
1791 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1793 #define CHECK_CONS(x) \
1794 CHECK_TYPE (CONSP (x), Qconsp, x)
1796 #define CHECK_SYMBOL(x) \
1797 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1799 #define CHECK_CHAR_TABLE(x) \
1800 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1802 #define CHECK_VECTOR(x) \
1803 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1805 #define CHECK_VECTOR_OR_STRING(x) \
1806 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1808 #define CHECK_ARRAY(x, Qxxxp) \
1809 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1811 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1812 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1814 #define CHECK_BUFFER(x) \
1815 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1817 #define CHECK_WINDOW(x) \
1818 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1820 #define CHECK_WINDOW_CONFIGURATION(x) \
1821 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1823 /* This macro rejects windows on the interior of the window tree as
1824 "dead", which is what we want; this is an argument-checking macro, and
1825 the user should never get access to interior windows.
1827 A window of any sort, leaf or interior, is dead if the buffer,
1828 vchild, and hchild members are all nil. */
1830 #define CHECK_LIVE_WINDOW(x) \
1831 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1833 #define CHECK_PROCESS(x) \
1834 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1836 #define CHECK_SUBR(x) \
1837 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1839 #define CHECK_NUMBER(x) \
1840 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1842 #define CHECK_NATNUM(x) \
1843 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1845 #define CHECK_MARKER(x) \
1846 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1848 #define CHECK_NUMBER_COERCE_MARKER(x) \
1849 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1850 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1852 #define XFLOATINT(n) extract_float((n))
1854 #define CHECK_FLOAT(x) \
1855 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1857 #define CHECK_NUMBER_OR_FLOAT(x) \
1858 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1860 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1861 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1862 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1864 #define CHECK_OVERLAY(x) \
1865 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1867 /* Since we can't assign directly to the CAR or CDR fields of a cons
1868 cell, use these when checking that those fields contain numbers. */
1869 #define CHECK_NUMBER_CAR(x) \
1871 Lisp_Object tmp = XCAR (x); \
1872 CHECK_NUMBER (tmp); \
1873 XSETCAR ((x), tmp); \
1876 #define CHECK_NUMBER_CDR(x) \
1878 Lisp_Object tmp = XCDR (x); \
1879 CHECK_NUMBER (tmp); \
1880 XSETCDR ((x), tmp); \
1883 #define CHECK_NATNUM_CAR(x) \
1885 Lisp_Object tmp = XCAR (x); \
1886 CHECK_NATNUM (tmp); \
1887 XSETCAR ((x), tmp); \
1890 #define CHECK_NATNUM_CDR(x) \
1892 Lisp_Object tmp = XCDR (x); \
1893 CHECK_NATNUM (tmp); \
1894 XSETCDR ((x), tmp); \
1897 /* Define a built-in function for calling from Lisp.
1898 `lname' should be the name to give the function in Lisp,
1899 as a null-terminated C string.
1900 `fnname' should be the name of the function in C.
1901 By convention, it starts with F.
1902 `sname' should be the name for the C constant structure
1903 that records information on this function for internal use.
1904 By convention, it should be the same as `fnname' but with S instead of F.
1905 It's too bad that C macros can't compute this from `fnname'.
1906 `minargs' should be a number, the minimum number of arguments allowed.
1907 `maxargs' should be a number, the maximum number of arguments allowed,
1908 or else MANY or UNEVALLED.
1909 MANY means pass a vector of evaluated arguments,
1910 in the form of an integer number-of-arguments
1911 followed by the address of a vector of Lisp_Objects
1912 which contains the argument values.
1913 UNEVALLED means pass the list of unevaluated arguments
1914 `intspec' says how interactive arguments are to be fetched.
1915 If the string starts with a `(', `intspec' is evaluated and the resulting
1916 list is the list of arguments.
1917 If it's a string that doesn't start with `(', the value should follow
1918 the one of the doc string for `interactive'.
1919 A null string means call interactively with no arguments.
1920 `doc' is documentation for the user. */
1922 /* This version of DEFUN declares a function prototype with the right
1923 arguments, so we can catch errors with maxargs at compile-time. */
1925 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1926 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1927 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1928 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1929 { (Lisp_Object (__cdecl *)(void))fnname }, \
1930 minargs, maxargs, lname, intspec, 0}; \
1932 #else /* not _MSC_VER */
1933 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1934 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1935 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1937 { .a ## maxargs = fnname }, \
1938 minargs, maxargs, lname, intspec, 0}; \
1942 /* Note that the weird token-substitution semantics of ANSI C makes
1943 this work for MANY and UNEVALLED. */
1944 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1945 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1946 #define DEFUN_ARGS_0 (void)
1947 #define DEFUN_ARGS_1 (Lisp_Object)
1948 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1949 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1950 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1951 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1953 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1954 Lisp_Object, Lisp_Object)
1955 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1956 Lisp_Object, Lisp_Object, Lisp_Object)
1957 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1958 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1960 /* Non-zero if OBJ is a Lisp function. */
1961 #define FUNCTIONP(OBJ) \
1962 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1963 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1964 || COMPILEDP (OBJ) \
1968 is how we define the symbol for function `name' at start-up time. */
1969 extern void defsubr (struct Lisp_Subr
*);
1972 #define UNEVALLED -1
1974 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1975 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1976 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1977 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1978 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1980 /* Macros we use to define forwarded Lisp variables.
1981 These are used in the syms_of_FILENAME functions.
1983 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1984 lisp variable is actually a field in `struct emacs_globals'. The
1985 field's name begins with "f_", which is a convention enforced by
1986 these macros. Each such global has a corresponding #define in
1987 globals.h; the plain name should be used in the code.
1989 E.g., the global "cons_cells_consed" is declared as "int
1990 f_cons_cells_consed" in globals.h, but there is a define:
1992 #define cons_cells_consed globals.f_cons_cells_consed
1994 All C code uses the `cons_cells_consed' name. This is all done
1995 this way to support indirection for multi-threaded Emacs. */
1997 #define DEFVAR_LISP(lname, vname, doc) \
1999 static struct Lisp_Objfwd o_fwd; \
2000 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2002 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2004 static struct Lisp_Objfwd o_fwd; \
2005 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2007 #define DEFVAR_BOOL(lname, vname, doc) \
2009 static struct Lisp_Boolfwd b_fwd; \
2010 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2012 #define DEFVAR_INT(lname, vname, doc) \
2014 static struct Lisp_Intfwd i_fwd; \
2015 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2018 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2020 static struct Lisp_Objfwd o_fwd; \
2021 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2024 #define DEFVAR_KBOARD(lname, vname, doc) \
2026 static struct Lisp_Kboard_Objfwd ko_fwd; \
2027 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2032 /* Structure for recording Lisp call stack for backtrace purposes. */
2034 /* The special binding stack holds the outer values of variables while
2035 they are bound by a function application or a let form, stores the
2036 code to be executed for Lisp unwind-protect forms, and stores the C
2037 functions to be called for record_unwind_protect.
2039 If func is non-zero, undoing this binding applies func to old_value;
2040 This implements record_unwind_protect.
2042 Otherwise, the element is a variable binding.
2044 If the symbol field is a symbol, it is an ordinary variable binding.
2046 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2047 which means having bound a local value while CURRENT-BUFFER was active.
2048 If WHERE is nil this means we saw the default value when binding SYMBOL.
2049 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2050 value. Other values of WHERE mean an internal error. */
2052 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2056 Lisp_Object symbol
, old_value
;
2057 specbinding_func func
;
2058 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
2061 extern struct specbinding
*specpdl
;
2062 extern struct specbinding
*specpdl_ptr
;
2063 extern EMACS_INT specpdl_size
;
2065 #define SPECPDL_INDEX() ((int) (specpdl_ptr - specpdl))
2067 /* Everything needed to describe an active condition case. */
2070 /* The handler clauses and variable from the condition-case form. */
2071 /* For a handler set up in Lisp code, this is always a list.
2072 For an internal handler set up by internal_condition_case*,
2073 this can instead be the symbol t or `error'.
2074 t: handle all conditions.
2075 error: handle all conditions, and errors can run the debugger
2076 or display a backtrace. */
2077 Lisp_Object handler
;
2079 /* Fsignal stores here the condition-case clause that applies,
2080 and Fcondition_case thus knows which clause to run. */
2081 Lisp_Object chosen_clause
;
2083 /* Used to effect the longjump out to the handler. */
2084 struct catchtag
*tag
;
2086 /* The next enclosing handler. */
2087 struct handler
*next
;
2090 /* This structure helps implement the `catch' and `throw' control
2091 structure. A struct catchtag contains all the information needed
2092 to restore the state of the interpreter after a non-local jump.
2094 Handlers for error conditions (represented by `struct handler'
2095 structures) just point to a catch tag to do the cleanup required
2098 catchtag structures are chained together in the C calling stack;
2099 the `next' member points to the next outer catchtag.
2101 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2102 member is TAG, and then unbinds to it. The `val' member is used to
2103 hold VAL while the stack is unwound; `val' is returned as the value
2106 All the other members are concerned with restoring the interpreter
2113 struct catchtag
*next
;
2114 struct gcpro
*gcpro
;
2116 struct backtrace
*backlist
;
2117 struct handler
*handlerlist
;
2118 int lisp_eval_depth
;
2120 int poll_suppress_count
;
2121 int interrupt_input_blocked
;
2122 struct byte_stack
*byte_stack
;
2125 extern Lisp_Object memory_signal_data
;
2127 /* An address near the bottom of the stack.
2128 Tells GC how to save a copy of the stack. */
2129 extern char *stack_bottom
;
2131 /* Check quit-flag and quit if it is non-nil.
2132 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2133 So the program needs to do QUIT at times when it is safe to quit.
2134 Every loop that might run for a long time or might not exit
2135 ought to do QUIT at least once, at a safe place.
2136 Unless that is impossible, of course.
2137 But it is very desirable to avoid creating loops where QUIT is impossible.
2139 Exception: if you set immediate_quit to nonzero,
2140 then the handler that responds to the C-g does the quit itself.
2141 This is a good thing to do around a loop that has no side effects
2142 and (in particular) cannot call arbitrary Lisp code.
2144 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2145 a request to exit Emacs when it is safe to do. */
2148 extern void process_pending_signals (void);
2149 extern int pending_signals
;
2150 #define ELSE_PENDING_SIGNALS \
2151 else if (pending_signals) \
2152 process_pending_signals ();
2153 #else /* not SYNC_INPUT */
2154 #define ELSE_PENDING_SIGNALS
2155 #endif /* not SYNC_INPUT */
2157 extern void process_quit_flag (void);
2160 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2161 process_quit_flag (); \
2162 ELSE_PENDING_SIGNALS \
2166 /* Nonzero if ought to quit now. */
2168 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2170 extern Lisp_Object Vascii_downcase_table
;
2171 extern Lisp_Object Vascii_canon_table
;
2173 /* Number of bytes of structure consed since last GC. */
2175 extern EMACS_INT consing_since_gc
;
2177 extern EMACS_INT gc_relative_threshold
;
2179 extern EMACS_INT memory_full_cons_threshold
;
2181 /* Structure for recording stack slots that need marking. */
2183 /* This is a chain of structures, each of which points at a Lisp_Object
2184 variable whose value should be marked in garbage collection.
2185 Normally every link of the chain is an automatic variable of a function,
2186 and its `val' points to some argument or local variable of the function.
2187 On exit to the function, the chain is set back to the value it had on entry.
2188 This way, no link remains in the chain when the stack frame containing the
2191 Every function that can call Feval must protect in this fashion all
2192 Lisp_Object variables whose contents will be used again. */
2194 extern struct gcpro
*gcprolist
;
2200 /* Address of first protected variable. */
2201 volatile Lisp_Object
*var
;
2203 /* Number of consecutive protected variables. */
2211 /* Values of GC_MARK_STACK during compilation:
2213 0 Use GCPRO as before
2214 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2215 2 Mark the stack, and check that everything GCPRO'd is
2217 3 Mark using GCPRO's, mark stack last, and count how many
2218 dead objects are kept alive. */
2221 #define GC_USE_GCPROS_AS_BEFORE 0
2222 #define GC_MAKE_GCPROS_NOOPS 1
2223 #define GC_MARK_STACK_CHECK_GCPROS 2
2224 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2226 #ifndef GC_MARK_STACK
2227 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2230 /* Whether we do the stack marking manually. */
2231 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2232 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2235 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2237 /* Do something silly with gcproN vars just so gcc shuts up. */
2238 /* You get warnings from MIPSPro... */
2240 #define GCPRO1(varname) ((void) gcpro1)
2241 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2242 #define GCPRO3(varname1, varname2, varname3) \
2243 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2244 #define GCPRO4(varname1, varname2, varname3, varname4) \
2245 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2246 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2247 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2248 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2249 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2251 #define UNGCPRO ((void) 0)
2253 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2257 #define GCPRO1(varname) \
2258 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2259 gcprolist = &gcpro1; }
2261 #define GCPRO2(varname1, varname2) \
2262 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2263 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2264 gcprolist = &gcpro2; }
2266 #define GCPRO3(varname1, varname2, varname3) \
2267 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2268 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2269 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2270 gcprolist = &gcpro3; }
2272 #define GCPRO4(varname1, varname2, varname3, varname4) \
2273 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2274 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2275 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2276 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2277 gcprolist = &gcpro4; }
2279 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2280 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2281 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2282 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2283 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2284 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2285 gcprolist = &gcpro5; }
2287 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2288 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2289 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2290 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2291 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2292 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2293 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2294 gcprolist = &gcpro6; }
2296 #define UNGCPRO (gcprolist = gcpro1.next)
2300 extern int gcpro_level
;
2302 #define GCPRO1(varname) \
2303 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2304 gcpro1.level = gcpro_level++; \
2305 gcprolist = &gcpro1; }
2307 #define GCPRO2(varname1, varname2) \
2308 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2309 gcpro1.level = gcpro_level; \
2310 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2311 gcpro2.level = gcpro_level++; \
2312 gcprolist = &gcpro2; }
2314 #define GCPRO3(varname1, varname2, varname3) \
2315 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2316 gcpro1.level = gcpro_level; \
2317 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2318 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2319 gcpro3.level = gcpro_level++; \
2320 gcprolist = &gcpro3; }
2322 #define GCPRO4(varname1, varname2, varname3, varname4) \
2323 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2324 gcpro1.level = gcpro_level; \
2325 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2326 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2327 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2328 gcpro4.level = gcpro_level++; \
2329 gcprolist = &gcpro4; }
2331 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2332 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2333 gcpro1.level = gcpro_level; \
2334 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2335 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2336 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2337 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2338 gcpro5.level = gcpro_level++; \
2339 gcprolist = &gcpro5; }
2341 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2342 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2343 gcpro1.level = gcpro_level; \
2344 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2345 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2346 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2347 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2348 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2349 gcpro6.level = gcpro_level++; \
2350 gcprolist = &gcpro6; }
2353 ((--gcpro_level != gcpro1.level) \
2355 : ((gcprolist = gcpro1.next), 0))
2357 #endif /* DEBUG_GCPRO */
2358 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2361 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2362 #define RETURN_UNGCPRO(expr) \
2365 Lisp_Object ret_ungc_val; \
2366 ret_ungc_val = (expr); \
2368 return ret_ungc_val; \
2372 /* Call staticpro (&var) to protect static variable `var'. */
2374 void staticpro (Lisp_Object
*);
2376 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2377 meaning as in the DEFUN macro, and is used to construct a prototype. */
2378 /* We can use the same trick as in the DEFUN macro to generate the
2379 appropriate prototype. */
2380 #define EXFUN(fnname, maxargs) \
2381 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2383 /* Forward declarations for prototypes. */
2387 /* Defined in data.c. */
2388 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2389 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2390 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2391 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2392 extern Lisp_Object Qinvalid_read_syntax
;
2393 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2394 extern Lisp_Object Qend_of_file
, Qarith_error
, Qmark_inactive
;
2395 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2396 extern Lisp_Object Qtext_read_only
;
2397 extern Lisp_Object Qinteractive_form
;
2398 extern Lisp_Object Qcircular_list
;
2399 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2400 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2401 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2402 extern Lisp_Object Qbuffer_or_string_p
;
2403 extern Lisp_Object Qfboundp
;
2404 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2406 extern Lisp_Object Qcdr
;
2408 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2409 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2411 extern Lisp_Object Qfloatp
;
2412 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2414 extern Lisp_Object Qinteger
;
2416 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2418 EXFUN (Finteractive_form
, 1);
2419 EXFUN (Fbyteorder
, 0);
2421 /* Defined in frame.c */
2422 extern Lisp_Object Qframep
;
2424 /* Defined in data.c */
2426 EXFUN (Fcar_safe
, 1);
2428 EXFUN (Fcdr_safe
, 1);
2432 EXFUN (Ffboundp
, 1);
2433 EXFUN (Fsymbol_function
, 1);
2434 EXFUN (Fsymbol_name
, 1);
2435 extern Lisp_Object
indirect_function (Lisp_Object
);
2436 EXFUN (Findirect_function
, 2);
2438 EXFUN (Fsymbol_value
, 1);
2439 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2441 EXFUN (Fdefault_value
, 1);
2442 EXFUN (Fset_default
, 2);
2443 EXFUN (Fdefault_boundp
, 1);
2444 EXFUN (Fmake_local_variable
, 1);
2445 EXFUN (Flocal_variable_p
, 2);
2450 EXFUN (Fstring_to_number
, 2);
2451 EXFUN (Fnumber_to_string
, 1);
2457 EXFUN (Fplus
, MANY
);
2458 EXFUN (Fminus
, MANY
);
2459 EXFUN (Ftimes
, MANY
);
2467 EXFUN (Fmake_variable_buffer_local
, 1);
2469 /* Convert the integer I to an Emacs representation, either the integer
2470 itself, or a cons of two or three integers, or if all else fails a float.
2471 I should not have side effects. */
2472 #define INTEGER_TO_CONS(i) \
2473 (! FIXNUM_OVERFLOW_P (i) \
2475 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2476 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2477 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2478 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2479 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2480 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2481 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2482 ? Fcons (make_number ((i) >> 16 >> 24), \
2483 Fcons (make_number ((i) >> 16 & 0xffffff), \
2484 make_number ((i) & 0xffff))) \
2487 /* Convert the Emacs representation CONS back to an integer of type
2488 TYPE, storing the result the variable VAR. Signal an error if CONS
2489 is not a valid representation or is out of range for TYPE. */
2490 #define CONS_TO_INTEGER(cons, type, var) \
2491 (TYPE_SIGNED (type) \
2492 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2493 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2494 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2495 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2497 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2498 extern void args_out_of_range (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2499 extern void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2500 Lisp_Object
) NO_RETURN
;
2501 extern Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2502 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2503 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2504 extern void syms_of_data (void);
2505 extern void init_data (void);
2506 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2508 /* Defined in cmds.c */
2509 EXFUN (Fend_of_line
, 1);
2510 EXFUN (Fforward_char
, 1);
2511 EXFUN (Fforward_line
, 1);
2512 extern void syms_of_cmds (void);
2513 extern void keys_of_cmds (void);
2515 /* Defined in coding.c */
2516 extern Lisp_Object Qcharset
;
2517 EXFUN (Fcoding_system_p
, 1);
2518 EXFUN (Fcoding_system_base
, 1);
2519 EXFUN (Fcoding_system_eol_type
, 1);
2520 EXFUN (Fcheck_coding_system
, 1);
2521 EXFUN (Fread_coding_system
, 2);
2522 EXFUN (Fread_non_nil_coding_system
, 1);
2523 EXFUN (Ffind_operation_coding_system
, MANY
);
2524 EXFUN (Fdecode_coding_string
, 4);
2525 extern Lisp_Object
detect_coding_system (const unsigned char *, EMACS_INT
,
2526 EMACS_INT
, int, int, Lisp_Object
);
2527 extern void init_coding (void);
2528 extern void init_coding_once (void);
2529 extern void syms_of_coding (void);
2531 /* Defined in character.c */
2532 EXFUN (Fchar_width
, 1);
2533 EXFUN (Fstring
, MANY
);
2534 extern EMACS_INT
chars_in_text (const unsigned char *, EMACS_INT
);
2535 extern EMACS_INT
multibyte_chars_in_text (const unsigned char *, EMACS_INT
);
2536 extern int multibyte_char_to_unibyte (int);
2537 extern int multibyte_char_to_unibyte_safe (int);
2538 extern void init_character_once (void);
2539 extern void syms_of_character (void);
2541 /* Defined in charset.c */
2542 extern void init_charset (void);
2543 extern void init_charset_once (void);
2544 extern void syms_of_charset (void);
2545 /* Structure forward declarations. */
2548 /* Defined in composite.c */
2549 extern void syms_of_composite (void);
2551 /* Defined in syntax.c */
2552 EXFUN (Fforward_word
, 1);
2553 EXFUN (Fskip_chars_forward
, 2);
2554 EXFUN (Fskip_chars_backward
, 2);
2555 extern void init_syntax_once (void);
2556 extern void syms_of_syntax (void);
2558 /* Defined in fns.c */
2559 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2560 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2561 extern EMACS_INT
next_almost_prime (EMACS_INT
);
2562 extern Lisp_Object
larger_vector (Lisp_Object
, EMACS_INT
, Lisp_Object
);
2563 extern void sweep_weak_hash_tables (void);
2564 extern Lisp_Object Qcursor_in_echo_area
;
2565 extern Lisp_Object Qstring_lessp
;
2566 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2567 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2568 EMACS_UINT
sxhash (Lisp_Object
, int);
2569 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2570 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2572 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2573 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2575 void init_weak_hash_tables (void);
2576 extern void init_fns (void);
2577 EXFUN (Fmake_hash_table
, MANY
);
2578 EXFUN (Fgethash
, 3);
2579 EXFUN (Fputhash
, 3);
2580 EXFUN (Fremhash
, 2);
2582 EXFUN (Fidentity
, 1);
2584 EXFUN (Fappend
, MANY
);
2585 EXFUN (Fconcat
, MANY
);
2586 EXFUN (Fvconcat
, MANY
);
2587 EXFUN (Fcopy_sequence
, 1);
2588 EXFUN (Fstring_make_multibyte
, 1);
2589 EXFUN (Fstring_make_unibyte
, 1);
2590 EXFUN (Fstring_as_multibyte
, 1);
2591 EXFUN (Fstring_as_unibyte
, 1);
2592 EXFUN (Fstring_to_multibyte
, 1);
2593 EXFUN (Fsubstring
, 3);
2594 extern Lisp_Object
substring_both (Lisp_Object
, EMACS_INT
, EMACS_INT
,
2595 EMACS_INT
, EMACS_INT
);
2607 EXFUN (Freverse
, 1);
2608 EXFUN (Fnreverse
, 1);
2612 EXFUN (Fnconc
, MANY
);
2614 EXFUN (Fmapconcat
, 3);
2615 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2616 EXFUN (Fprovide
, 2);
2617 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2618 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2619 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2620 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2621 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2622 extern void clear_string_char_byte_cache (void);
2623 extern EMACS_INT
string_char_to_byte (Lisp_Object
, EMACS_INT
);
2624 extern EMACS_INT
string_byte_to_char (Lisp_Object
, EMACS_INT
);
2625 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2626 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2627 EXFUN (Fcopy_alist
, 1);
2628 EXFUN (Fplist_get
, 2);
2629 EXFUN (Fplist_put
, 3);
2630 EXFUN (Fplist_member
, 2);
2632 EXFUN (Fstring_equal
, 2);
2633 EXFUN (Fcompare_strings
, 7);
2634 EXFUN (Fstring_lessp
, 2);
2635 extern void syms_of_fns (void);
2637 /* Defined in floatfns.c */
2638 extern double extract_float (Lisp_Object
);
2640 EXFUN (Ftruncate
, 2);
2641 extern void init_floatfns (void);
2642 extern void syms_of_floatfns (void);
2643 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2645 /* Defined in fringe.c */
2646 extern void syms_of_fringe (void);
2647 extern void init_fringe (void);
2648 #ifdef HAVE_WINDOW_SYSTEM
2649 extern void mark_fringe_data (void);
2650 extern void init_fringe_once (void);
2651 #endif /* HAVE_WINDOW_SYSTEM */
2653 /* Defined in image.c */
2654 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2655 extern Lisp_Object QCconversion
;
2656 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2657 extern void syms_of_image (void);
2658 extern void init_image (void);
2660 /* Defined in insdel.c */
2661 extern Lisp_Object Qinhibit_modification_hooks
;
2662 extern void move_gap (EMACS_INT
);
2663 extern void move_gap_both (EMACS_INT
, EMACS_INT
);
2664 extern void buffer_overflow (void) NO_RETURN
;
2665 extern void make_gap (EMACS_INT
);
2666 extern EMACS_INT
copy_text (const unsigned char *, unsigned char *,
2667 EMACS_INT
, int, int);
2668 extern int count_combining_before (const unsigned char *,
2669 EMACS_INT
, EMACS_INT
, EMACS_INT
);
2670 extern int count_combining_after (const unsigned char *,
2671 EMACS_INT
, EMACS_INT
, EMACS_INT
);
2672 extern void insert (const char *, EMACS_INT
);
2673 extern void insert_and_inherit (const char *, EMACS_INT
);
2674 extern void insert_1 (const char *, EMACS_INT
, int, int, int);
2675 extern void insert_1_both (const char *, EMACS_INT
, EMACS_INT
,
2677 extern void insert_from_gap (EMACS_INT
, EMACS_INT
);
2678 extern void insert_from_string (Lisp_Object
, EMACS_INT
, EMACS_INT
,
2679 EMACS_INT
, EMACS_INT
, int);
2680 extern void insert_from_buffer (struct buffer
*, EMACS_INT
, EMACS_INT
, int);
2681 extern void insert_char (int);
2682 extern void insert_string (const char *);
2683 extern void insert_before_markers (const char *, EMACS_INT
);
2684 extern void insert_before_markers_and_inherit (const char *, EMACS_INT
);
2685 extern void insert_from_string_before_markers (Lisp_Object
, EMACS_INT
,
2686 EMACS_INT
, EMACS_INT
,
2688 extern void del_range (EMACS_INT
, EMACS_INT
);
2689 extern Lisp_Object
del_range_1 (EMACS_INT
, EMACS_INT
, int, int);
2690 extern void del_range_byte (EMACS_INT
, EMACS_INT
, int);
2691 extern void del_range_both (EMACS_INT
, EMACS_INT
, EMACS_INT
, EMACS_INT
, int);
2692 extern Lisp_Object
del_range_2 (EMACS_INT
, EMACS_INT
,
2693 EMACS_INT
, EMACS_INT
, int);
2694 extern void modify_region (struct buffer
*, EMACS_INT
, EMACS_INT
, int);
2695 extern void prepare_to_modify_buffer (EMACS_INT
, EMACS_INT
, EMACS_INT
*);
2696 extern void signal_after_change (EMACS_INT
, EMACS_INT
, EMACS_INT
);
2697 extern void adjust_after_insert (EMACS_INT
, EMACS_INT
, EMACS_INT
,
2698 EMACS_INT
, EMACS_INT
);
2699 extern void adjust_markers_for_delete (EMACS_INT
, EMACS_INT
,
2700 EMACS_INT
, EMACS_INT
);
2701 extern void replace_range (EMACS_INT
, EMACS_INT
, Lisp_Object
, int, int, int);
2702 extern void replace_range_2 (EMACS_INT
, EMACS_INT
, EMACS_INT
, EMACS_INT
,
2703 const char *, EMACS_INT
, EMACS_INT
, int);
2704 extern void syms_of_insdel (void);
2706 /* Defined in dispnew.c */
2707 extern Lisp_Object selected_frame
;
2708 extern Lisp_Object Vwindow_system
;
2710 EXFUN (Fredraw_frame
, 1);
2711 EXFUN (Fsleep_for
, 2);
2712 EXFUN (Fredisplay
, 1);
2713 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2714 extern void init_display (void);
2715 extern void syms_of_display (void);
2717 /* Defined in xdisp.c */
2718 extern Lisp_Object Qinhibit_point_motion_hooks
;
2719 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2720 extern Lisp_Object Qmenu_bar_update_hook
;
2721 extern Lisp_Object Qwindow_scroll_functions
;
2722 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2723 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2724 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2725 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2726 extern Lisp_Object Qleft_margin
, Qright_margin
;
2727 extern Lisp_Object Qglyphless_char
;
2728 extern Lisp_Object QCdata
, QCfile
;
2729 extern Lisp_Object QCmap
;
2730 extern Lisp_Object Qrisky_local_variable
;
2731 extern struct frame
*last_glyphless_glyph_frame
;
2732 extern unsigned last_glyphless_glyph_face_id
;
2733 extern int last_glyphless_glyph_merged_face_id
;
2734 extern int noninteractive_need_newline
;
2735 extern Lisp_Object echo_area_buffer
[2];
2736 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2737 extern void check_message_stack (void);
2738 extern void setup_echo_area_for_printing (int);
2739 extern int push_message (void);
2740 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2741 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2742 extern void restore_message (void);
2743 extern Lisp_Object
current_message (void);
2744 extern void clear_message (int, int);
2745 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2746 extern void message1 (const char *);
2747 extern void message1_nolog (const char *);
2748 extern void message2 (const char *, EMACS_INT
, int);
2749 extern void message2_nolog (const char *, EMACS_INT
, int);
2750 extern void message3 (Lisp_Object
, EMACS_INT
, int);
2751 extern void message3_nolog (Lisp_Object
, EMACS_INT
, int);
2752 extern void message_dolog (const char *, EMACS_INT
, int, int);
2753 extern void message_with_string (const char *, Lisp_Object
, int);
2754 extern void message_log_maybe_newline (void);
2755 extern void update_echo_area (void);
2756 extern void truncate_echo_area (EMACS_INT
);
2757 extern void redisplay (void);
2758 extern void redisplay_preserve_echo_area (int);
2759 extern void prepare_menu_bars (void);
2761 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2762 extern void syms_of_xdisp (void);
2763 extern void init_xdisp (void);
2764 extern Lisp_Object
safe_eval (Lisp_Object
);
2765 extern int pos_visible_p (struct window
*, EMACS_INT
, int *,
2766 int *, int *, int *, int *, int *);
2768 /* Defined in xsettings.c */
2769 extern void syms_of_xsettings (void);
2771 /* Defined in vm-limit.c. */
2772 extern void memory_warnings (POINTER_TYPE
*, void (*warnfun
) (const char *));
2774 /* Defined in alloc.c */
2775 extern void check_pure_size (void);
2776 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2777 extern void reset_malloc_hooks (void);
2778 extern void uninterrupt_malloc (void);
2779 extern void malloc_warning (const char *);
2780 extern void memory_full (size_t) NO_RETURN
;
2781 extern void buffer_memory_full (EMACS_INT
) NO_RETURN
;
2782 extern int survives_gc_p (Lisp_Object
);
2783 extern void mark_object (Lisp_Object
);
2784 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2785 extern void refill_memory_reserve (void);
2787 extern const char *pending_malloc_warning
;
2788 extern Lisp_Object
*stack_base
;
2790 extern Lisp_Object
list1 (Lisp_Object
);
2791 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2792 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2793 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2794 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2796 EXFUN (Flist
, MANY
);
2797 EXFUN (Fmake_list
, 2);
2798 extern Lisp_Object
allocate_misc (void);
2799 EXFUN (Fmake_vector
, 2);
2800 EXFUN (Fvector
, MANY
);
2801 EXFUN (Fmake_symbol
, 1);
2802 EXFUN (Fmake_marker
, 0);
2803 extern void string_overflow (void) NO_RETURN
;
2804 EXFUN (Fmake_string
, 2);
2805 extern Lisp_Object
build_string (const char *);
2806 extern Lisp_Object
make_string (const char *, EMACS_INT
);
2807 extern Lisp_Object
make_unibyte_string (const char *, EMACS_INT
);
2808 extern Lisp_Object
make_multibyte_string (const char *, EMACS_INT
, EMACS_INT
);
2809 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2810 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2811 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2812 extern Lisp_Object
make_string_from_bytes (const char *, EMACS_INT
, EMACS_INT
);
2813 extern Lisp_Object
make_specified_string (const char *,
2814 EMACS_INT
, EMACS_INT
, int);
2815 EXFUN (Fpurecopy
, 1);
2816 extern Lisp_Object
make_pure_string (const char *, EMACS_INT
, EMACS_INT
, int);
2817 extern Lisp_Object
make_pure_c_string (const char *data
);
2818 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2819 extern Lisp_Object
make_pure_vector (EMACS_INT
);
2820 EXFUN (Fgarbage_collect
, 0);
2821 EXFUN (Fmake_byte_code
, MANY
);
2822 EXFUN (Fmake_bool_vector
, 2);
2823 extern Lisp_Object Qchar_table_extra_slots
;
2824 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2825 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, EMACS_INT tag
);
2826 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2828 allocate_pseudovector \
2829 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2830 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2831 extern struct window
*allocate_window (void);
2832 extern struct frame
*allocate_frame (void);
2833 extern struct Lisp_Process
*allocate_process (void);
2834 extern struct terminal
*allocate_terminal (void);
2835 extern int gc_in_progress
;
2836 extern int abort_on_gc
;
2837 extern Lisp_Object
make_float (double);
2838 extern void display_malloc_warning (void);
2839 extern int inhibit_garbage_collection (void);
2840 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2841 extern void free_marker (Lisp_Object
);
2842 extern void free_cons (struct Lisp_Cons
*);
2843 extern void init_alloc_once (void);
2844 extern void init_alloc (void);
2845 extern void syms_of_alloc (void);
2846 extern struct buffer
* allocate_buffer (void);
2847 extern int valid_lisp_object_p (Lisp_Object
);
2849 /* Defined in chartab.c */
2850 EXFUN (Fmake_char_table
, 2);
2851 EXFUN (Fset_char_table_parent
, 2);
2852 EXFUN (Fchar_table_extra_slot
, 2);
2853 EXFUN (Fset_char_table_extra_slot
, 3);
2854 EXFUN (Fset_char_table_range
, 3);
2855 EXFUN (Foptimize_char_table
, 2);
2856 extern Lisp_Object
copy_char_table (Lisp_Object
);
2857 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2858 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2860 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2861 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2863 extern int char_table_translate (Lisp_Object
, int);
2864 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2866 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2867 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2868 Lisp_Object
, Lisp_Object
,
2869 Lisp_Object
, struct charset
*,
2870 unsigned, unsigned);
2871 extern Lisp_Object
uniprop_table (Lisp_Object
);
2872 extern void syms_of_chartab (void);
2874 /* Defined in print.c */
2875 extern Lisp_Object Vprin1_to_string_buffer
;
2876 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2878 EXFUN (Fprin1_to_string
, 2);
2881 EXFUN (Ferror_message_string
, 1);
2882 extern Lisp_Object Qstandard_output
;
2883 extern Lisp_Object Qexternal_debugging_output
;
2884 extern void temp_output_buffer_setup (const char *);
2885 extern int print_level
;
2886 extern Lisp_Object Qprint_escape_newlines
;
2887 extern void write_string (const char *, int);
2888 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2890 extern Lisp_Object internal_with_output_to_temp_buffer
2891 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2892 #define FLOAT_TO_STRING_BUFSIZE 350
2893 extern void float_to_string (char *, double);
2894 extern void syms_of_print (void);
2896 /* Defined in doprnt.c */
2897 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2899 extern ptrdiff_t esprintf (char *, char const *, ...)
2900 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2901 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2903 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2904 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2905 char const *, va_list)
2906 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2908 /* Defined in lread.c. */
2909 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2910 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2912 EXFUN (Fread_from_string
, 3);
2914 EXFUN (Fintern_soft
, 2);
2915 EXFUN (Funintern
, 2);
2917 EXFUN (Fget_load_suffixes
, 0);
2918 EXFUN (Fread_char
, 3);
2919 EXFUN (Fread_event
, 3);
2920 extern Lisp_Object
check_obarray (Lisp_Object
);
2921 extern Lisp_Object
intern (const char *);
2922 extern Lisp_Object
intern_c_string (const char *);
2923 extern Lisp_Object
oblookup (Lisp_Object
, const char *, EMACS_INT
, EMACS_INT
);
2924 #define LOADHIST_ATTACH(x) \
2926 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2928 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2929 Lisp_Object
*, Lisp_Object
);
2930 Lisp_Object
string_to_number (char const *, int, int);
2931 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2933 extern void dir_warning (const char *, Lisp_Object
);
2934 extern void close_load_descs (void);
2935 extern void init_obarray (void);
2936 extern void init_lread (void);
2937 extern void syms_of_lread (void);
2939 /* Defined in eval.c. */
2940 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
, Qmacro
;
2941 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2942 extern Lisp_Object Qand_rest
;
2943 extern Lisp_Object Vautoload_queue
;
2944 extern Lisp_Object Vsignaling_function
;
2945 extern int handling_signal
;
2947 extern struct catchtag
*catchlist
;
2948 extern struct handler
*handlerlist
;
2950 /* To run a normal hook, use the appropriate function from the list below.
2951 The calling convention:
2953 if (!NILP (Vrun_hooks))
2954 call1 (Vrun_hooks, Qmy_funny_hook);
2956 should no longer be used. */
2957 extern Lisp_Object Vrun_hooks
;
2958 EXFUN (Frun_hooks
, MANY
);
2959 EXFUN (Frun_hook_with_args
, MANY
);
2960 EXFUN (Frun_hook_with_args_until_failure
, MANY
);
2961 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2962 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2963 Lisp_Object (*funcall
)
2964 (ptrdiff_t nargs
, Lisp_Object
*args
));
2965 EXFUN (Fprogn
, UNEVALLED
);
2966 EXFUN (Finteractive_p
, 0);
2967 EXFUN (Fthrow
, 2) NO_RETURN
;
2969 extern void xsignal (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2970 extern void xsignal0 (Lisp_Object
) NO_RETURN
;
2971 extern void xsignal1 (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2972 extern void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2973 extern void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2974 extern void signal_error (const char *, Lisp_Object
) NO_RETURN
;
2975 EXFUN (Fcommandp
, 2);
2976 EXFUN (Ffunctionp
, 1);
2978 extern Lisp_Object
eval_sub (Lisp_Object form
);
2979 EXFUN (Fapply
, MANY
);
2980 EXFUN (Ffuncall
, MANY
);
2981 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2982 extern Lisp_Object
call0 (Lisp_Object
);
2983 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2984 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2985 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2986 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2987 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2988 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2989 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2990 EXFUN (Fdo_auto_save
, 2);
2991 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2992 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2993 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2994 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2995 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2996 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2997 extern void specbind (Lisp_Object
, Lisp_Object
);
2998 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2999 extern Lisp_Object
unbind_to (int, Lisp_Object
);
3000 extern void error (const char *, ...) NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
3001 extern void verror (const char *, va_list)
3002 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 0);
3003 extern void do_autoload (Lisp_Object
, Lisp_Object
);
3004 extern Lisp_Object
un_autoload (Lisp_Object
);
3005 extern void init_eval_once (void);
3006 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
*);
3007 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3008 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3009 extern void init_eval (void);
3011 extern void mark_backtrace (void);
3013 extern void syms_of_eval (void);
3015 /* Defined in editfns.c */
3016 extern Lisp_Object Qfield
;
3017 EXFUN (Fcurrent_message
, 0);
3018 EXFUN (Fgoto_char
, 1);
3019 EXFUN (Fpoint_max_marker
, 0);
3021 EXFUN (Fpoint_marker
, 0);
3022 EXFUN (Fline_beginning_position
, 1);
3023 EXFUN (Fline_end_position
, 1);
3024 EXFUN (Ffollowing_char
, 0);
3025 EXFUN (Fprevious_char
, 0);
3026 EXFUN (Fchar_after
, 1);
3027 EXFUN (Finsert
, MANY
);
3028 EXFUN (Finsert_char
, 3);
3029 extern void insert1 (Lisp_Object
);
3034 EXFUN (Fformat
, MANY
);
3035 EXFUN (Fmessage
, MANY
);
3036 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3037 EXFUN (Fbuffer_substring
, 2);
3038 EXFUN (Fbuffer_string
, 0);
3039 extern Lisp_Object
save_excursion_save (void);
3040 extern Lisp_Object
save_restriction_save (void);
3041 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3042 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3043 EXFUN (Fchar_to_string
, 1);
3044 EXFUN (Fdelete_region
, 2);
3045 EXFUN (Fnarrow_to_region
, 2);
3047 EXFUN (Fuser_login_name
, 1);
3048 EXFUN (Fsystem_name
, 0);
3049 EXFUN (Fcurrent_time
, 0);
3050 EXFUN (Fget_internal_run_time
, 0);
3051 extern EMACS_INT
clip_to_bounds (EMACS_INT
, EMACS_INT
, EMACS_INT
);
3052 extern Lisp_Object
make_buffer_string (EMACS_INT
, EMACS_INT
, int);
3053 extern Lisp_Object
make_buffer_string_both (EMACS_INT
, EMACS_INT
, EMACS_INT
,
3055 extern void init_editfns (void);
3056 const char *get_system_name (void);
3057 extern void syms_of_editfns (void);
3058 EXFUN (Fconstrain_to_field
, 5);
3059 EXFUN (Ffield_end
, 3);
3060 extern void set_time_zone_rule (const char *);
3062 /* Defined in buffer.c */
3063 extern int mouse_face_overlay_overlaps (Lisp_Object
);
3064 extern void nsberror (Lisp_Object
) NO_RETURN
;
3065 EXFUN (Fset_buffer_multibyte
, 1);
3066 EXFUN (Foverlay_start
, 1);
3067 EXFUN (Foverlay_end
, 1);
3068 extern void adjust_overlays_for_insert (EMACS_INT
, EMACS_INT
);
3069 extern void adjust_overlays_for_delete (EMACS_INT
, EMACS_INT
);
3070 extern void fix_start_end_in_overlays (EMACS_INT
, EMACS_INT
);
3071 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
3072 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3073 extern int overlay_touches_p (EMACS_INT
);
3074 extern Lisp_Object Vbuffer_alist
;
3075 EXFUN (Fget_buffer
, 1);
3076 EXFUN (Fget_buffer_create
, 1);
3077 EXFUN (Fgenerate_new_buffer_name
, 2);
3078 EXFUN (Fset_buffer
, 1);
3079 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3080 EXFUN (Fbarf_if_buffer_read_only
, 0);
3081 EXFUN (Fcurrent_buffer
, 0);
3082 EXFUN (Fother_buffer
, 3);
3083 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3084 EXFUN (Foverlay_get
, 2);
3085 EXFUN (Fbuffer_modified_p
, 1);
3086 EXFUN (Fset_buffer_modified_p
, 1);
3087 EXFUN (Fkill_buffer
, 1);
3088 EXFUN (Fkill_all_local_variables
, 0);
3089 EXFUN (Fbuffer_enable_undo
, 1);
3090 EXFUN (Ferase_buffer
, 0);
3091 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3092 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3093 extern struct buffer
*all_buffers
;
3094 EXFUN (Fprevious_overlay_change
, 1);
3095 EXFUN (Fbuffer_file_name
, 1);
3096 extern void init_buffer_once (void);
3097 extern void init_buffer (void);
3098 extern void syms_of_buffer (void);
3099 extern void keys_of_buffer (void);
3101 /* Defined in marker.c */
3103 EXFUN (Fmarker_position
, 1);
3104 EXFUN (Fmarker_buffer
, 1);
3105 EXFUN (Fcopy_marker
, 2);
3106 EXFUN (Fset_marker
, 3);
3107 extern EMACS_INT
marker_position (Lisp_Object
);
3108 extern EMACS_INT
marker_byte_position (Lisp_Object
);
3109 extern void clear_charpos_cache (struct buffer
*);
3110 extern EMACS_INT
charpos_to_bytepos (EMACS_INT
);
3111 extern EMACS_INT
buf_charpos_to_bytepos (struct buffer
*, EMACS_INT
);
3112 extern EMACS_INT
buf_bytepos_to_charpos (struct buffer
*, EMACS_INT
);
3113 extern void unchain_marker (struct Lisp_Marker
*marker
);
3114 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3115 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
3116 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3117 EMACS_INT
, EMACS_INT
);
3118 extern void syms_of_marker (void);
3120 /* Defined in fileio.c */
3122 extern Lisp_Object Qfile_error
;
3123 extern Lisp_Object Qfile_exists_p
;
3124 extern Lisp_Object Qfile_directory_p
;
3125 extern Lisp_Object Qinsert_file_contents
;
3126 extern Lisp_Object Qfile_name_history
;
3127 EXFUN (Ffind_file_name_handler
, 2);
3128 EXFUN (Ffile_name_as_directory
, 1);
3129 EXFUN (Fexpand_file_name
, 2);
3130 EXFUN (Ffile_name_nondirectory
, 1);
3131 EXFUN (Fsubstitute_in_file_name
, 1);
3132 EXFUN (Ffile_symlink_p
, 1);
3133 EXFUN (Fverify_visited_file_modtime
, 1);
3134 EXFUN (Ffile_exists_p
, 1);
3135 EXFUN (Ffile_name_absolute_p
, 1);
3136 EXFUN (Fdirectory_file_name
, 1);
3137 EXFUN (Ffile_name_directory
, 1);
3138 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3139 EXFUN (Ffile_accessible_directory_p
, 1);
3140 EXFUN (Funhandled_file_name_directory
, 1);
3141 EXFUN (Ffile_directory_p
, 1);
3142 EXFUN (Fwrite_region
, 7);
3143 EXFUN (Ffile_readable_p
, 1);
3144 EXFUN (Fread_file_name
, 6);
3145 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3146 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3147 extern void report_file_error (const char *, Lisp_Object
) NO_RETURN
;
3148 extern int internal_delete_file (Lisp_Object
);
3149 extern void syms_of_fileio (void);
3150 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
3151 extern Lisp_Object Qdelete_file
;
3153 /* Defined in search.c */
3154 extern void shrink_regexp_cache (void);
3155 EXFUN (Fstring_match
, 3);
3156 extern void restore_search_regs (void);
3157 EXFUN (Fmatch_data
, 3);
3158 EXFUN (Fset_match_data
, 2);
3159 EXFUN (Fmatch_beginning
, 1);
3160 EXFUN (Fmatch_end
, 1);
3161 extern void record_unwind_save_match_data (void);
3162 struct re_registers
;
3163 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3164 struct re_registers
*,
3165 Lisp_Object
, int, int);
3166 extern EMACS_INT
fast_string_match (Lisp_Object
, Lisp_Object
);
3167 extern EMACS_INT
fast_c_string_match_ignore_case (Lisp_Object
, const char *);
3168 extern EMACS_INT
fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3169 extern EMACS_INT
fast_looking_at (Lisp_Object
, EMACS_INT
, EMACS_INT
,
3170 EMACS_INT
, EMACS_INT
, Lisp_Object
);
3171 extern EMACS_INT
scan_buffer (int, EMACS_INT
, EMACS_INT
, EMACS_INT
,
3173 extern EMACS_INT
scan_newline (EMACS_INT
, EMACS_INT
, EMACS_INT
, EMACS_INT
,
3175 extern EMACS_INT
find_next_newline (EMACS_INT
, int);
3176 extern EMACS_INT
find_next_newline_no_quit (EMACS_INT
, EMACS_INT
);
3177 extern EMACS_INT
find_before_next_newline (EMACS_INT
, EMACS_INT
, EMACS_INT
);
3178 extern void syms_of_search (void);
3179 extern void clear_regexp_cache (void);
3181 /* Defined in minibuf.c */
3183 extern Lisp_Object Qcompletion_ignore_case
;
3184 extern Lisp_Object Vminibuffer_list
;
3185 extern Lisp_Object last_minibuf_string
;
3186 EXFUN (Fcompleting_read
, 8);
3187 EXFUN (Fread_from_minibuffer
, 7);
3188 EXFUN (Fread_variable
, 2);
3189 EXFUN (Fread_buffer
, 3);
3190 EXFUN (Fread_minibuffer
, 2);
3191 EXFUN (Feval_minibuffer
, 2);
3192 EXFUN (Fread_string
, 5);
3193 EXFUN (Fassoc_string
, 3);
3194 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3195 extern void init_minibuf_once (void);
3196 extern void syms_of_minibuf (void);
3198 /* Defined in callint.c */
3200 extern Lisp_Object Qminus
, Qplus
;
3201 extern Lisp_Object Qwhen
;
3202 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3203 EXFUN (Fprefix_numeric_value
, 1);
3204 extern void syms_of_callint (void);
3206 /* Defined in casefiddle.c */
3208 extern Lisp_Object Qidentity
;
3209 EXFUN (Fdowncase
, 1);
3211 EXFUN (Fupcase_region
, 2);
3212 EXFUN (Fupcase_initials
, 1);
3213 EXFUN (Fupcase_initials_region
, 2);
3214 extern void syms_of_casefiddle (void);
3215 extern void keys_of_casefiddle (void);
3217 /* Defined in casetab.c */
3219 EXFUN (Fset_case_table
, 1);
3220 EXFUN (Fset_standard_case_table
, 1);
3221 extern void init_casetab_once (void);
3222 extern void syms_of_casetab (void);
3224 /* Defined in keyboard.c */
3226 extern Lisp_Object echo_message_buffer
;
3227 extern struct kboard
*echo_kboard
;
3228 extern void cancel_echoing (void);
3229 extern Lisp_Object Qdisabled
, QCfilter
;
3230 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3231 extern Lisp_Object Qtop
;
3232 extern int input_pending
;
3233 EXFUN (Fdiscard_input
, 0);
3234 EXFUN (Frecursive_edit
, 0);
3235 EXFUN (Ftop_level
, 0) NO_RETURN
;
3236 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3237 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3238 extern void discard_mouse_events (void);
3239 EXFUN (Fevent_convert_list
, 1);
3240 EXFUN (Fread_key_sequence
, 5);
3241 EXFUN (Fset_input_interrupt_mode
, 1);
3242 EXFUN (Fset_input_mode
, 4);
3243 extern Lisp_Object pending_funcalls
;
3244 extern int detect_input_pending (void);
3245 extern int detect_input_pending_ignore_squeezables (void);
3246 extern int detect_input_pending_run_timers (int);
3247 extern void safe_run_hooks (Lisp_Object
);
3248 extern void cmd_error_internal (Lisp_Object
, const char *);
3249 extern Lisp_Object
command_loop_1 (void);
3250 extern Lisp_Object
recursive_edit_1 (void);
3251 extern void record_auto_save (void);
3253 extern void force_auto_save_soon (void);
3255 extern void init_keyboard (void);
3256 extern void syms_of_keyboard (void);
3257 extern void keys_of_keyboard (void);
3259 /* Defined in indent.c */
3260 EXFUN (Fvertical_motion
, 2);
3261 EXFUN (Findent_to
, 2);
3262 EXFUN (Fmove_to_column
, 2);
3263 extern EMACS_INT
current_column (void);
3264 extern void invalidate_current_column (void);
3265 extern int indented_beyond_p (EMACS_INT
, EMACS_INT
, EMACS_INT
);
3266 extern void syms_of_indent (void);
3268 /* Defined in frame.c */
3269 #ifdef HAVE_WINDOW_SYSTEM
3270 #endif /* HAVE_WINDOW_SYSTEM */
3271 extern Lisp_Object Qonly
;
3272 extern Lisp_Object Qvisible
;
3273 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3274 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3275 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3277 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3279 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3280 EXFUN (Fselect_frame
, 2);
3281 EXFUN (Fselected_frame
, 0);
3282 EXFUN (Fmake_frame_visible
, 1);
3283 EXFUN (Ficonify_frame
, 1);
3284 EXFUN (Fframe_parameter
, 2);
3285 EXFUN (Fmodify_frame_parameters
, 2);
3286 EXFUN (Fraise_frame
, 1);
3287 EXFUN (Fredirect_frame_focus
, 2);
3288 extern void frames_discard_buffer (Lisp_Object
);
3289 extern void syms_of_frame (void);
3291 /* Defined in emacs.c */
3292 extern char **initial_argv
;
3293 extern int initial_argc
;
3294 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3295 extern int display_arg
;
3297 extern Lisp_Object
decode_env_path (const char *, const char *);
3298 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3299 extern Lisp_Object Qfile_name_handler_alist
;
3300 #ifdef FLOAT_CATCH_SIGILL
3301 extern void fatal_error_signal (int);
3303 extern Lisp_Object Qkill_emacs
;
3304 EXFUN (Fkill_emacs
, 1) NO_RETURN
;
3306 void fixup_locale (void);
3307 void synchronize_system_messages_locale (void);
3308 void synchronize_system_time_locale (void);
3310 #define setlocale(category, locale)
3311 #define fixup_locale()
3312 #define synchronize_system_messages_locale()
3313 #define synchronize_system_time_locale()
3315 void shut_down_emacs (int, int, Lisp_Object
);
3316 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3317 extern int noninteractive
;
3319 /* Nonzero means remove site-lisp directories from load-path. */
3320 extern int no_site_lisp
;
3322 /* Pipe used to send exit notification to the daemon parent at
3324 extern int daemon_pipe
[2];
3325 #define IS_DAEMON (daemon_pipe[1] != 0)
3327 /* Nonzero means don't do use window-system-specific display code. */
3328 extern int inhibit_window_system
;
3329 /* Nonzero means that a filter or a sentinel is running. */
3330 extern int running_asynch_code
;
3332 /* Defined in process.c. */
3333 extern Lisp_Object QCtype
, Qlocal
;
3334 EXFUN (Fget_buffer_process
, 1);
3335 EXFUN (Fprocess_status
, 1);
3336 EXFUN (Fkill_process
, 2);
3337 EXFUN (Fwaiting_for_user_input_p
, 0);
3338 extern Lisp_Object Qprocessp
;
3339 extern void kill_buffer_processes (Lisp_Object
);
3340 extern int wait_reading_process_output (int, int, int, int,
3342 struct Lisp_Process
*,
3344 extern void add_keyboard_wait_descriptor (int);
3345 extern void delete_keyboard_wait_descriptor (int);
3347 extern void add_gpm_wait_descriptor (int);
3348 extern void delete_gpm_wait_descriptor (int);
3350 extern void close_process_descs (void);
3351 extern void init_process (void);
3352 extern void syms_of_process (void);
3353 extern void setup_process_coding_systems (Lisp_Object
);
3355 EXFUN (Fcall_process
, MANY
);
3356 extern int child_setup (int, int, int, char **, int, Lisp_Object
)
3361 extern void init_callproc_1 (void);
3362 extern void init_callproc (void);
3363 extern void set_initial_environment (void);
3364 extern void syms_of_callproc (void);
3366 /* Defined in doc.c */
3367 extern Lisp_Object Qfunction_documentation
;
3368 EXFUN (Fsubstitute_command_keys
, 1);
3369 extern Lisp_Object
read_doc_string (Lisp_Object
);
3370 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3371 extern void syms_of_doc (void);
3372 extern int read_bytecode_char (int);
3374 /* Defined in bytecode.c */
3375 extern Lisp_Object Qbytecode
;
3376 extern void syms_of_bytecode (void);
3377 extern struct byte_stack
*byte_stack_list
;
3379 extern void mark_byte_stack (void);
3381 extern void unmark_byte_stack (void);
3382 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3383 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3385 /* Defined in macros.c */
3386 extern Lisp_Object Qexecute_kbd_macro
;
3387 EXFUN (Fexecute_kbd_macro
, 3);
3388 EXFUN (Fcancel_kbd_macro_events
, 0);
3389 extern void init_macros (void);
3390 extern void syms_of_macros (void);
3392 /* Defined in undo.c */
3393 extern Lisp_Object Qapply
;
3394 extern Lisp_Object Qinhibit_read_only
;
3395 EXFUN (Fundo_boundary
, 0);
3396 extern void truncate_undo_list (struct buffer
*);
3397 extern void record_marker_adjustment (Lisp_Object
, EMACS_INT
);
3398 extern void record_insert (EMACS_INT
, EMACS_INT
);
3399 extern void record_delete (EMACS_INT
, Lisp_Object
);
3400 extern void record_first_change (void);
3401 extern void record_change (EMACS_INT
, EMACS_INT
);
3402 extern void record_property_change (EMACS_INT
, EMACS_INT
,
3403 Lisp_Object
, Lisp_Object
,
3405 extern void syms_of_undo (void);
3406 /* Defined in textprop.c */
3407 extern Lisp_Object Qfont
, Qmouse_face
;
3408 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3409 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3410 extern Lisp_Object Qminibuffer_prompt
;
3412 EXFUN (Fnext_single_property_change
, 4);
3413 EXFUN (Fnext_single_char_property_change
, 4);
3414 EXFUN (Fprevious_single_property_change
, 4);
3415 EXFUN (Fget_text_property
, 3);
3416 EXFUN (Fput_text_property
, 5);
3417 EXFUN (Fprevious_char_property_change
, 2);
3418 EXFUN (Fnext_char_property_change
, 2);
3419 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3421 /* Defined in menu.c */
3422 extern void syms_of_menu (void);
3424 /* Defined in xmenu.c */
3425 EXFUN (Fx_popup_menu
, 2);
3426 EXFUN (Fx_popup_dialog
, 3);
3427 extern void syms_of_xmenu (void);
3429 /* Defined in termchar.h */
3430 struct tty_display_info
;
3432 /* Defined in termhooks.h */
3435 /* Defined in sysdep.c */
3436 #ifndef HAVE_GET_CURRENT_DIR_NAME
3437 extern char *get_current_dir_name (void);
3439 extern void stuff_char (char c
);
3440 extern void init_sigio (int);
3441 extern void sys_subshell (void);
3442 extern void sys_suspend (void);
3443 extern void discard_tty_input (void);
3444 extern void init_sys_modes (struct tty_display_info
*);
3445 extern void reset_sys_modes (struct tty_display_info
*);
3446 extern void init_all_sys_modes (void);
3447 extern void reset_all_sys_modes (void);
3448 extern void wait_for_termination (int);
3449 extern void interruptible_wait_for_termination (int);
3450 extern void flush_pending_output (int);
3451 extern void child_setup_tty (int);
3452 extern void setup_pty (int);
3453 extern int set_window_size (int, int, int);
3454 extern EMACS_INT
get_random (void);
3455 extern void seed_random (long);
3456 extern int emacs_open (const char *, int, int);
3457 extern int emacs_close (int);
3458 extern EMACS_INT
emacs_read (int, char *, EMACS_INT
);
3459 extern EMACS_INT
emacs_write (int, const char *, EMACS_INT
);
3460 enum { READLINK_BUFSIZE
= 1024 };
3461 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3463 EXFUN (Funlock_buffer
, 0);
3464 extern void unlock_all_files (void);
3465 extern void lock_file (Lisp_Object
);
3466 extern void unlock_file (Lisp_Object
);
3467 extern void unlock_buffer (struct buffer
*);
3468 extern void syms_of_filelock (void);
3469 extern void init_filelock (void);
3471 /* Defined in sound.c */
3472 extern void syms_of_sound (void);
3473 extern void init_sound (void);
3475 /* Defined in category.c */
3476 extern void init_category_once (void);
3477 extern Lisp_Object
char_category_set (int);
3478 extern void syms_of_category (void);
3480 /* Defined in ccl.c */
3481 extern void syms_of_ccl (void);
3483 /* Defined in dired.c */
3484 extern void syms_of_dired (void);
3485 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3486 Lisp_Object
, Lisp_Object
,
3489 /* Defined in term.c */
3490 extern int *char_ins_del_vector
;
3491 extern void mark_ttys (void);
3492 extern void syms_of_term (void);
3493 extern void fatal (const char *msgid
, ...)
3494 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
3496 /* Defined in terminal.c */
3497 EXFUN (Fframe_terminal
, 1);
3498 EXFUN (Fdelete_terminal
, 2);
3499 extern void syms_of_terminal (void);
3501 /* Defined in font.c */
3502 extern void syms_of_font (void);
3503 extern void init_font (void);
3505 #ifdef HAVE_WINDOW_SYSTEM
3506 /* Defined in fontset.c */
3507 extern void syms_of_fontset (void);
3509 /* Defined in xfns.c, w32fns.c, or macfns.c */
3510 extern Lisp_Object Qfont_param
;
3511 EXFUN (Fxw_display_color_p
, 1);
3512 EXFUN (Fx_focus_frame
, 1);
3515 /* Defined in xfaces.c */
3516 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3517 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3518 extern Lisp_Object Qmode_line_inactive
;
3519 extern Lisp_Object Qface
;
3520 extern Lisp_Object Qnormal
;
3521 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3522 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3523 extern Lisp_Object Vface_alternative_font_family_alist
;
3524 extern Lisp_Object Vface_alternative_font_registry_alist
;
3525 EXFUN (Fclear_face_cache
, 1);
3526 EXFUN (Fx_load_color_file
, 1);
3527 extern void syms_of_xfaces (void);
3529 #ifdef HAVE_X_WINDOWS
3530 /* Defined in xfns.c */
3531 extern void syms_of_xfns (void);
3533 /* Defined in xsmfns.c */
3534 extern void syms_of_xsmfns (void);
3536 /* Defined in xselect.c */
3537 extern void syms_of_xselect (void);
3539 /* Defined in xterm.c */
3540 extern void syms_of_xterm (void);
3541 #endif /* HAVE_X_WINDOWS */
3543 #ifdef HAVE_WINDOW_SYSTEM
3544 /* Defined in xterm.c, nsterm.m, w32term.c */
3545 extern char *x_get_keysym_name (int);
3546 #endif /* HAVE_WINDOW_SYSTEM */
3549 /* Defined in msdos.c */
3550 EXFUN (Fmsdos_downcase_filename
, 1);
3554 /* Defined in xml.c */
3555 extern void syms_of_xml (void);
3559 /* Defined in (x|w32)fns.c, nsfns.m... */
3560 extern int have_menus_p (void);
3564 /* Defined in dbusbind.c */
3565 void syms_of_dbusbind (void);
3569 /* Defined in msdos.c, w32.c */
3570 extern char *emacs_root_dir (void);
3573 /* Nonzero means Emacs has already been initialized.
3574 Used during startup to detect startup of dumped Emacs. */
3575 extern int initialized
;
3577 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3579 extern POINTER_TYPE
*xmalloc (size_t);
3580 extern POINTER_TYPE
*xrealloc (POINTER_TYPE
*, size_t);
3581 extern void xfree (POINTER_TYPE
*);
3582 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3583 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3584 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3586 extern char *xstrdup (const char *);
3588 extern char *egetenv (const char *);
3590 /* Set up the name of the machine we're running on. */
3591 extern void init_system_name (void);
3593 /* Some systems (e.g., NT) use a different path separator than Unix,
3594 in addition to a device separator. Set the path separator
3595 to '/', and don't test for a device separator in IS_ANY_SEP. */
3597 #define DIRECTORY_SEP '/'
3598 #ifndef IS_DIRECTORY_SEP
3599 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3601 #ifndef IS_DEVICE_SEP
3603 #define IS_DEVICE_SEP(_c_) 0
3605 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3609 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3612 #define SWITCH_ENUM_CAST(x) (x)
3614 /* Use this to suppress gcc's warnings. */
3617 /* Use CODE only if lint checking is in effect. */
3618 # define IF_LINT(Code) Code
3620 /* Assume that the expression COND is true. This differs in intent
3621 from 'assert', as it is a message from the programmer to the compiler. */
3622 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3625 # define IF_LINT(Code) /* empty */
3626 # define lint_assume(cond) ((void) (0 && (cond)))
3629 /* The ubiquitous min and max macros. */
3635 #define min(a, b) ((a) < (b) ? (a) : (b))
3636 #define max(a, b) ((a) > (b) ? (a) : (b))
3638 /* We used to use `abs', but that clashes with system headers on some
3639 platforms, and using a name reserved by Standard C is a bad idea
3642 #define eabs(x) ((x) < 0 ? -(x) : (x))
3645 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3648 #define make_fixnum_or_float(val) \
3649 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3652 /* Checks the `cycle check' variable CHECK to see if it indicates that
3653 EL is part of a cycle; CHECK must be either Qnil or a value returned
3654 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3655 elements after which a cycle might be suspected; after that many
3656 elements, this macro begins consing in order to keep more precise
3659 Returns nil if a cycle was detected, otherwise a new value for CHECK
3662 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3663 the caller should make sure that's ok. */
3665 #define CYCLE_CHECK(check, el, suspicious) \
3668 : (INTEGERP (check) \
3669 ? (XFASTINT (check) < (suspicious) \
3670 ? make_number (XFASTINT (check) + 1) \
3671 : Fcons (el, Qnil)) \
3672 : (!NILP (Fmemq ((el), (check))) \
3674 : Fcons ((el), (check)))))
3677 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3678 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3680 #define MAX_ALLOCA 16*1024
3682 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3684 #define USE_SAFE_ALLOCA \
3685 int sa_count = (int) SPECPDL_INDEX (), sa_must_free = 0
3687 /* SAFE_ALLOCA allocates a simple buffer. */
3689 #define SAFE_ALLOCA(buf, type, size) \
3691 if ((size) < MAX_ALLOCA) \
3692 buf = (type) alloca (size); \
3695 buf = (type) xmalloc (size); \
3697 record_unwind_protect (safe_alloca_unwind, \
3698 make_save_value (buf, 0)); \
3702 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3703 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3704 positive. The code is tuned for MULTIPLIER being a constant. */
3706 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3708 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3709 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3712 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3714 record_unwind_protect (safe_alloca_unwind, \
3715 make_save_value (buf, 0)); \
3719 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3721 #define SAFE_FREE() \
3723 if (sa_must_free) { \
3725 unbind_to (sa_count, Qnil); \
3730 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3732 #define SAFE_ALLOCA_LISP(buf, nelt) \
3734 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3735 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3736 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3739 buf = (Lisp_Object *) xmalloc ((nelt) * sizeof (Lisp_Object)); \
3740 arg_ = make_save_value (buf, nelt); \
3741 XSAVE_VALUE (arg_)->dogc = 1; \
3743 record_unwind_protect (safe_alloca_unwind, arg_); \
3746 memory_full (SIZE_MAX); \
3750 #include "globals.h"
3752 #endif /* EMACS_LISP_H */