1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1987, 1993-1995, 1997-2011
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
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
166 #ifndef NO_DECL_ALIGN
168 # if HAVE_ATTRIBUTE_ALIGNED
169 # define DECL_ALIGN(type, var) \
170 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
172 /* What directives do other compilers use? */
177 /* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8. */
178 #if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
179 || defined DARWIN_OS || defined __sun)
180 /* We also need to be able to specify mult-of-8 alignment on static vars. */
181 # if defined DECL_ALIGN
186 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
189 # error "USE_LSB_TAG used without defining DECL_ALIGN"
191 # define DECL_ALIGN(type, var) type var
195 /* Define the fundamental Lisp data structures. */
197 /* If USE_2_TAGBITS_FOR_INTS is defined, then Lisp integers use
198 2 tags, to give them one extra bit, thus extending their range from
199 e.g -2^28..2^28-1 to -2^29..2^29-1. */
200 #define USE_2_TAGS_FOR_INTS
202 /* Making it work for the union case is too much trouble. */
203 #ifdef USE_LISP_UNION_TYPE
204 # undef USE_2_TAGS_FOR_INTS
207 /* This is the set of Lisp data types. */
209 #if !defined USE_2_TAGS_FOR_INTS
210 # define LISP_INT_TAG Lisp_Int
211 # define case_Lisp_Int case Lisp_Int
212 # define LISP_STRING_TAG 4
213 # define LISP_INT_TAG_P(x) ((x) == Lisp_Int)
215 # define LISP_INT_TAG Lisp_Int0
216 # define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
218 # define LISP_INT1_TAG 4
219 # define LISP_STRING_TAG 1
220 # define LISP_INT_TAG_P(x) (((x) & 3) == 0)
222 # define LISP_INT1_TAG 1
223 # define LISP_STRING_TAG 4
224 # define LISP_INT_TAG_P(x) (((x) & 6) == 0)
230 /* Integer. XINT (obj) is the integer value. */
231 #ifdef USE_2_TAGS_FOR_INTS
233 Lisp_Int1
= LISP_INT1_TAG
,
238 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
241 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
242 whose first member indicates the subtype. */
245 /* String. XSTRING (object) points to a struct Lisp_String.
246 The length of the string, and its contents, are stored therein. */
247 Lisp_String
= LISP_STRING_TAG
,
249 /* Vector of Lisp objects, or something resembling it.
250 XVECTOR (object) points to a struct Lisp_Vector, which contains
251 the size and contents. The size field also contains the type
252 information, if it's not a real vector object. */
255 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
261 /* This is the set of data types that share a common structure.
262 The first member of the structure is a type code from this set.
263 The enum values are arbitrary, but we'll use large numbers to make it
264 more likely that we'll spot the error if a random word in memory is
265 mistakenly interpreted as a Lisp_Misc. */
268 Lisp_Misc_Free
= 0x5eab,
271 Lisp_Misc_Save_Value
,
272 /* Currently floats are not a misc type,
273 but let's define this in case we want to change that. */
275 /* This is not a type code. It is for range checking. */
279 /* These are the types of forwarding objects used in the value slot
280 of symbols for special built-in variables whose value is stored in
284 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
285 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
286 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
287 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
288 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
295 /* These values are overridden by the m- file on some machines. */
297 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
300 #ifdef USE_LISP_UNION_TYPE
302 #ifndef WORDS_BIGENDIAN
304 /* Definition of Lisp_Object for little-endian machines. */
309 /* Used for comparing two Lisp_Objects;
310 also, positive integers can be accessed fast this way. */
315 /* Use explict signed, the signedness of a bit-field of type
316 int is implementation defined. */
317 signed EMACS_INT val
: VALBITS
;
318 enum Lisp_Type type
: GCTYPEBITS
;
322 EMACS_UINT val
: VALBITS
;
323 enum Lisp_Type type
: GCTYPEBITS
;
328 #else /* If WORDS_BIGENDIAN */
333 /* Used for comparing two Lisp_Objects;
334 also, positive integers can be accessed fast this way. */
339 enum Lisp_Type type
: GCTYPEBITS
;
340 /* Use explict signed, the signedness of a bit-field of type
341 int is implementation defined. */
342 signed EMACS_INT val
: VALBITS
;
346 enum Lisp_Type type
: GCTYPEBITS
;
347 EMACS_UINT val
: VALBITS
;
352 #endif /* WORDS_BIGENDIAN */
355 static inline Lisp_Object
356 LISP_MAKE_RVALUE (Lisp_Object o
)
361 /* This is more portable to pre-C99 non-GCC compilers, but for
362 backwards compatibility GCC still accepts an old GNU extension
363 which caused this to only generate a warning. */
364 #define LISP_MAKE_RVALUE(o) (0 ? (o) : (o))
367 #else /* USE_LISP_UNION_TYPE */
369 /* If union type is not wanted, define Lisp_Object as just a number. */
371 typedef EMACS_INT Lisp_Object
;
372 #define LISP_MAKE_RVALUE(o) (0+(o))
373 #endif /* USE_LISP_UNION_TYPE */
375 /* In the size word of a vector, this bit means the vector has been marked. */
377 #define ARRAY_MARK_FLAG PTRDIFF_MIN
379 /* In the size word of a struct Lisp_Vector, this bit means it's really
380 some other vector-like object. */
381 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
383 /* In a pseudovector, the size field actually contains a word with one
384 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
385 indicate the actual type.
386 We use a bitset, even tho only one of the bits can be set at any
387 particular time just so as to be able to use micro-optimizations such as
388 testing membership of a particular subset of pseudovectors in Fequal.
389 It is not crucial, but there are plenty of bits here, so why not do it? */
392 PVEC_NORMAL_VECTOR
= 0,
393 PVEC_PROCESS
= 0x200,
395 PVEC_COMPILED
= 0x800,
396 PVEC_WINDOW
= 0x1000,
397 PVEC_WINDOW_CONFIGURATION
= 0x2000,
399 PVEC_CHAR_TABLE
= 0x8000,
400 PVEC_BOOL_VECTOR
= 0x10000,
401 PVEC_BUFFER
= 0x20000,
402 PVEC_HASH_TABLE
= 0x40000,
403 PVEC_TERMINAL
= 0x80000,
404 PVEC_SUB_CHAR_TABLE
= 0x100000,
405 PVEC_FONT
= 0x200000,
406 PVEC_OTHER
= 0x400000,
407 PVEC_TYPE_MASK
= 0x7ffe00
409 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
410 GDB. It doesn't work on OS Alpha. Moved to a variable in
412 PVEC_FLAG
= PSEUDOVECTOR_FLAG
416 /* For convenience, we also store the number of elements in these bits.
417 Note that this size is not necessarily the memory-footprint size, but
418 only the number of Lisp_Object fields (that need to be traced by the GC).
419 The distinction is used e.g. by Lisp_Process which places extra
420 non-Lisp_Object fields at the end of the structure. */
421 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
423 /* Number of bits to put in each character in the internal representation
424 of bool vectors. This should not vary across implementations. */
425 #define BOOL_VECTOR_BITS_PER_CHAR 8
427 /* These macros extract various sorts of values from a Lisp_Object.
428 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
429 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
431 #ifndef USE_LISP_UNION_TYPE
433 /* Return a perfect hash of the Lisp_Object representation. */
438 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
439 #define XTYPE(a) ((enum Lisp_Type) ((a) & TYPEMASK))
440 #ifdef USE_2_TAGS_FOR_INTS
441 # define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
442 # define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
443 # define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
445 # define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
446 # define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
447 # define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
449 #define XSET(var, type, ptr) \
450 (eassert (XTYPE ((intptr_t) (ptr)) == 0), /* Check alignment. */ \
451 (var) = (type) | (intptr_t) (ptr))
453 #define XPNTR(a) ((intptr_t) ((a) & ~TYPEMASK))
455 #else /* not USE_LSB_TAG */
457 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
459 /* One need to override this if there must be high bits set in data space
460 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
461 on all machines, but would penalize machines which don't need it)
463 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
465 /* For integers known to be positive, XFASTINT provides fast retrieval
466 and XSETFASTINT provides fast storage. This takes advantage of the
467 fact that Lisp_Int is 0. */
468 #define XFASTINT(a) ((a) + 0)
469 #define XSETFASTINT(a, b) ((a) = (b))
471 /* Extract the value of a Lisp_Object as a (un)signed integer. */
473 #ifdef USE_2_TAGS_FOR_INTS
474 # define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
475 # define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
476 # define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
478 # define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
479 >> (BITS_PER_EMACS_INT - VALBITS))
480 # define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
481 # define make_number(N) \
482 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
485 #define XSET(var, type, ptr) \
486 ((var) = ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
487 + ((intptr_t) (ptr) & VALMASK)))
490 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
491 which were stored in a Lisp_Object */
492 #define XPNTR(a) ((uintptr_t) (((a) & VALMASK)) | DATA_SEG_BITS))
494 #define XPNTR(a) ((uintptr_t) ((a) & VALMASK))
497 #endif /* not USE_LSB_TAG */
499 #else /* USE_LISP_UNION_TYPE */
501 #ifdef USE_2_TAGS_FOR_INTS
502 # error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
505 #define XHASH(a) ((a).i)
506 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
507 #define XINT(a) ((EMACS_INT) (a).s.val)
508 #define XUINT(a) ((EMACS_UINT) (a).u.val)
512 # define XSET(var, vartype, ptr) \
513 (eassert ((((uintptr_t) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0), \
514 (var).u.val = ((uintptr_t) (ptr)) >> GCTYPEBITS, \
515 (var).u.type = ((char) (vartype)))
517 /* Some versions of gcc seem to consider the bitfield width when issuing
518 the "cast to pointer from integer of different size" warning, so the
519 cast is here to widen the value back to its natural size. */
520 # define XPNTR(v) ((intptr_t) (v).s.val << GCTYPEBITS)
522 #else /* !USE_LSB_TAG */
524 /* For integers known to be positive, XFASTINT provides fast retrieval
525 and XSETFASTINT provides fast storage. This takes advantage of the
526 fact that Lisp_Int is 0. */
527 # define XFASTINT(a) ((a).i + 0)
528 # define XSETFASTINT(a, b) ((a).i = (b))
530 # define XSET(var, vartype, ptr) \
531 (((var).s.val = ((intptr_t) (ptr))), ((var).s.type = ((char) (vartype))))
534 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
535 which were stored in a Lisp_Object */
536 #define XPNTR(a) ((intptr_t) (XUINT (a) | DATA_SEG_BITS))
538 #define XPNTR(a) ((intptr_t) XUINT (a))
541 #endif /* !USE_LSB_TAG */
543 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
544 #define make_number(N) \
545 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
547 extern Lisp_Object
make_number (EMACS_INT
);
550 #endif /* USE_LISP_UNION_TYPE */
552 /* For integers known to be positive, XFASTINT sometimes provides
553 faster retrieval and XSETFASTINT provides faster storage.
554 If not, fallback on the non-accelerated path. */
556 # define XFASTINT(a) (XINT (a))
557 # define XSETFASTINT(a, b) (XSETINT (a, b))
560 #define EQ(x, y) (XHASH (x) == XHASH (y))
562 /* Number of bits in a fixnum, including the sign bit. */
563 #ifdef USE_2_TAGS_FOR_INTS
564 # define FIXNUM_BITS (VALBITS + 1)
566 # define FIXNUM_BITS VALBITS
569 /* Mask indicating the significant bits of a fixnum. */
570 #define INTMASK (((EMACS_INT) 1 << FIXNUM_BITS) - 1)
572 /* Largest and smallest representable fixnum values. These are the C
574 #define MOST_POSITIVE_FIXNUM (INTMASK / 2)
575 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
577 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
578 written this way so that it also works if I is of unsigned
579 type or if I is a NaN. */
581 #define FIXNUM_OVERFLOW_P(i) \
582 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
584 static inline ptrdiff_t
585 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
587 return num
< lower
? lower
: num
<= upper
? num
: upper
;
590 /* Extract a value or address from a Lisp_Object. */
592 #define XCONS(a) (eassert (CONSP (a)), (struct Lisp_Cons *) XPNTR (a))
593 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), (struct Lisp_Vector *) XPNTR (a))
594 #define XSTRING(a) (eassert (STRINGP (a)), (struct Lisp_String *) XPNTR (a))
595 #define XSYMBOL(a) (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XPNTR (a))
596 #define XFLOAT(a) (eassert (FLOATP (a)), (struct Lisp_Float *) XPNTR (a))
600 #define XMISC(a) ((union Lisp_Misc *) XPNTR (a))
601 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
602 #define XMISCTYPE(a) (XMISCANY (a)->type)
603 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
604 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
605 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
607 /* Forwarding object types. */
609 #define XFWDTYPE(a) (a->u_intfwd.type)
610 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
611 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
612 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
613 #define XBUFFER_OBJFWD(a) \
614 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
615 #define XKBOARD_OBJFWD(a) \
616 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
618 /* Pseudovector types. */
620 #define XPROCESS(a) (eassert (PROCESSP (a)), (struct Lisp_Process *) XPNTR (a))
621 #define XWINDOW(a) (eassert (WINDOWP (a)), (struct window *) XPNTR (a))
622 #define XTERMINAL(a) (eassert (TERMINALP (a)), (struct terminal *) XPNTR (a))
623 #define XSUBR(a) (eassert (SUBRP (a)), (struct Lisp_Subr *) XPNTR (a))
624 #define XBUFFER(a) (eassert (BUFFERP (a)), (struct buffer *) XPNTR (a))
625 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR (a))
626 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR (a))
627 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR (a))
629 /* Construct a Lisp_Object from a value or address. */
631 #define XSETINT(a, b) (a) = make_number (b)
632 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
633 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
634 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
635 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
636 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
640 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
641 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
643 /* Pseudovector types. */
645 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
646 #define XSETTYPED_PVECTYPE(v, size_member, code) \
647 ((v)->size_member |= PSEUDOVECTOR_FLAG | (code))
648 #define XSETPVECTYPESIZE(v, code, sizeval) \
649 ((v)->header.size = PSEUDOVECTOR_FLAG | (code) | (sizeval))
651 /* The cast to struct vectorlike_header * avoids aliasing issues. */
652 #define XSETPSEUDOVECTOR(a, b, code) \
653 XSETTYPED_PSEUDOVECTOR(a, b, \
654 ((struct vectorlike_header *) XPNTR (a))->size, \
656 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
657 (XSETVECTOR (a, b), \
658 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
659 == (PSEUDOVECTOR_FLAG | (code))))
661 #define XSETWINDOW_CONFIGURATION(a, b) \
662 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
663 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
664 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
665 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
666 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
667 #define XSETSUBR(a, b) \
668 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
669 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
670 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
671 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
672 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
673 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
675 /* Convenience macros for dealing with Lisp arrays. */
677 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
678 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
679 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
680 #define ASET(ARRAY, IDX, VAL) \
681 (eassert ((IDX) == (IDX)), \
682 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
683 AREF ((ARRAY), (IDX)) = (VAL))
685 /* Convenience macros for dealing with Lisp strings. */
687 #define SDATA(string) (XSTRING (string)->data + 0)
688 #define SREF(string, index) (SDATA (string)[index] + 0)
689 #define SSET(string, index, new) (SDATA (string)[index] = (new))
690 #define SCHARS(string) (XSTRING (string)->size + 0)
691 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
693 /* Avoid "differ in sign" warnings. */
694 #define SSDATA(x) ((char *) SDATA (x))
696 #define STRING_SET_CHARS(string, newsize) \
697 (XSTRING (string)->size = (newsize))
699 #define STRING_COPYIN(string, index, new, count) \
700 memcpy (SDATA (string) + index, new, count)
704 #define CHECK_TYPE(ok, Qxxxp, x) \
705 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
709 /* See the macros in intervals.h. */
711 typedef struct interval
*INTERVAL
;
713 /* Complain if object is not string or buffer type */
714 #define CHECK_STRING_OR_BUFFER(x) \
715 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
718 /* In a cons, the markbit of the car is the gc mark bit */
722 /* Please do not use the names of these elements in code other
723 than the core lisp implementation. Use XCAR and XCDR below. */
724 #ifdef HIDE_LISP_IMPLEMENTATION
729 struct Lisp_Cons
*chain
;
736 struct Lisp_Cons
*chain
;
741 /* Take the car or cdr of something known to be a cons cell. */
742 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
743 of code that has to know what a cons cell looks like. Other code not
744 part of the basic lisp implementation should assume that the car and cdr
745 fields are not accessible as lvalues. (What if we want to switch to
746 a copying collector someday? Cached cons cell field addresses may be
747 invalidated at arbitrary points.) */
748 #ifdef HIDE_LISP_IMPLEMENTATION
749 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
750 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
752 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
753 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
756 /* Use these from normal code. */
757 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
758 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
760 /* Use these to set the fields of a cons cell.
762 Note that both arguments may refer to the same object, so 'n'
763 should not be read after 'c' is first modified. Also, neither
764 argument should be evaluated more than once; side effects are
765 especially common in the second argument. */
766 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
767 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
769 /* Take the car or cdr of something whose type is not known. */
771 (CONSP ((c)) ? XCAR ((c)) \
772 : NILP ((c)) ? Qnil \
773 : wrong_type_argument (Qlistp, (c)))
776 (CONSP ((c)) ? XCDR ((c)) \
777 : NILP ((c)) ? Qnil \
778 : wrong_type_argument (Qlistp, (c)))
780 /* Take the car or cdr of something whose type is not known. */
781 #define CAR_SAFE(c) \
782 (CONSP ((c)) ? XCAR ((c)) : Qnil)
784 #define CDR_SAFE(c) \
785 (CONSP ((c)) ? XCDR ((c)) : Qnil)
787 /* Nonzero if STR is a multibyte string. */
788 #define STRING_MULTIBYTE(STR) \
789 (XSTRING (STR)->size_byte >= 0)
791 /* Return the length in bytes of STR. */
793 #ifdef GC_CHECK_STRING_BYTES
796 extern ptrdiff_t string_bytes (struct Lisp_String
*);
797 #define STRING_BYTES(S) string_bytes ((S))
799 #else /* not GC_CHECK_STRING_BYTES */
801 #define STRING_BYTES(STR) \
802 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
804 #endif /* not GC_CHECK_STRING_BYTES */
806 /* An upper bound on the number of bytes in a Lisp string, not
807 counting the terminating null. This a tight enough bound to
808 prevent integer overflow errors that would otherwise occur during
809 string size calculations. A string cannot contain more bytes than
810 a fixnum can represent, nor can it be so long that C pointer
811 arithmetic stops working on the string plus its terminating null.
812 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
813 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
814 would expose alloc.c internal details that we'd rather keep
815 private. The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is
817 #define STRING_BYTES_BOUND \
818 min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1)
820 /* Mark STR as a unibyte string. */
821 #define STRING_SET_UNIBYTE(STR) \
822 do { if (EQ (STR, empty_multibyte_string)) \
823 (STR) = empty_unibyte_string; \
824 else XSTRING (STR)->size_byte = -1; } while (0)
826 /* Mark STR as a multibyte string. Assure that STR contains only
827 ASCII characters in advance. */
828 #define STRING_SET_MULTIBYTE(STR) \
829 do { if (EQ (STR, empty_unibyte_string)) \
830 (STR) = empty_multibyte_string; \
831 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
833 /* Get text properties. */
834 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
836 /* Set text properties. */
837 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
839 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
845 INTERVAL intervals
; /* text properties in this string */
849 /* Header of vector-like objects. This documents the layout constraints on
850 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
851 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
852 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
853 because when two such pointers potentially alias, a compiler won't
854 incorrectly reorder loads and stores to their size fields. See
855 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
856 struct vectorlike_header
860 /* Pointer to the next vector-like object. It is generally a buffer or a
861 Lisp_Vector alias, so for convenience it is a union instead of a
862 pointer: this way, one can write P->next.vector instead of ((struct
863 Lisp_Vector *) P->next). */
865 struct buffer
*buffer
;
866 struct Lisp_Vector
*vector
;
872 struct vectorlike_header header
;
873 Lisp_Object contents
[1];
876 /* If a struct is made to look like a vector, this macro returns the length
877 of the shortest vector that would hold that struct. */
878 #define VECSIZE(type) ((sizeof (type) \
879 - offsetof (struct Lisp_Vector, contents[0]) \
880 + sizeof (Lisp_Object) - 1) /* round up */ \
881 / sizeof (Lisp_Object))
883 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
884 at the end and we need to compute the number of Lisp_Object fields (the
885 ones that the GC needs to trace). */
886 #define PSEUDOVECSIZE(type, nonlispfield) \
887 ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \
888 / sizeof (Lisp_Object))
890 /* A char-table is a kind of vectorlike, with contents are like a
891 vector but with a few other slots. For some purposes, it makes
892 sense to handle a char-table with type struct Lisp_Vector. An
893 element of a char table can be any Lisp objects, but if it is a sub
894 char-table, we treat it a table that contains information of a
895 specific range of characters. A sub char-table has the same
896 structure as a vector. A sub char table appears only in an element
897 of a char-table, and there's no way to access it directly from
898 Emacs Lisp program. */
900 /* This is the number of slots that every char table must have. This
901 counts the ordinary slots and the top, defalt, parent, and purpose
903 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
905 /* Return the number of "extra" slots in the char table CT. */
907 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
908 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
912 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
913 ({struct Lisp_Char_Table *_tbl = NULL; \
916 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
917 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
918 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
920 _val = _tbl->defalt; \
921 } while (NILP (_val) && ! NILP (_tbl->parent)); \
924 #else /* not __GNUC__ */
926 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
927 (! NILP (XCHAR_TABLE (CT)->ascii) \
928 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
929 ? XCHAR_TABLE (CT)->ascii \
930 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
931 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
932 : char_table_ref ((CT), (IDX))) \
933 : char_table_ref ((CT), (IDX)))
935 #endif /* not __GNUC__ */
937 /* Compute A OP B, using the unsigned comparison operator OP. A and B
938 should be integer expressions. This is not the same as
939 mathemeatical comparison; for example, UNSIGNED_CMP (0, <, -1)
940 returns 1. For efficiency, prefer plain unsigned comparison if A
941 and B's sizes both fit (after integer promotion). */
942 #define UNSIGNED_CMP(a, op, b) \
943 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
944 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
945 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
947 /* Nonzero iff C is an ASCII character. */
948 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
950 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
951 characters. Do not check validity of CT. */
952 #define CHAR_TABLE_REF(CT, IDX) \
953 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
954 : char_table_ref ((CT), (IDX)))
956 /* Almost equivalent to Faref (CT, IDX). However, if the result is
957 not a character, return IDX.
959 For these characters, do not check validity of CT
960 and do not follow parent. */
961 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
962 char_table_translate (CT, IDX)
964 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
965 8-bit European characters. Do not check validity of CT. */
966 #define CHAR_TABLE_SET(CT, IDX, VAL) \
967 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
968 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
969 : char_table_set (CT, IDX, VAL))
971 #define CHARTAB_SIZE_BITS_0 6
972 #define CHARTAB_SIZE_BITS_1 4
973 #define CHARTAB_SIZE_BITS_2 5
974 #define CHARTAB_SIZE_BITS_3 7
976 extern const int chartab_size
[4];
978 struct Lisp_Sub_Char_Table
;
980 struct Lisp_Char_Table
982 /* HEADER.SIZE is the vector's size field, which also holds the
983 pseudovector type information. It holds the size, too.
984 The size counts the defalt, parent, purpose, ascii,
985 contents, and extras slots. */
986 struct vectorlike_header header
;
988 /* This holds a default value,
989 which is used whenever the value for a specific character is nil. */
992 /* This points to another char table, which we inherit from when the
993 value for a specific character is nil. The `defalt' slot takes
994 precedence over this. */
997 /* This is a symbol which says what kind of use this char-table is
1001 /* The bottom sub char-table for characters of the range 0..127. It
1002 is nil if none of ASCII character has a specific value. */
1005 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1007 /* These hold additional data. It is a vector. */
1008 Lisp_Object extras
[1];
1011 struct Lisp_Sub_Char_Table
1013 /* HEADER.SIZE is the vector's size field, which also holds the
1014 pseudovector type information. It holds the size, too. */
1015 struct vectorlike_header header
;
1017 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1018 char-table of depth 1 contains 16 elements, and each element
1019 covers 4096 (128*32) characters. A sub char-table of depth 2
1020 contains 32 elements, and each element covers 128 characters. A
1021 sub char-table of depth 3 contains 128 elements, and each element
1022 is for one character. */
1025 /* Minimum character covered by the sub char-table. */
1026 Lisp_Object min_char
;
1028 Lisp_Object contents
[1];
1031 /* A boolvector is a kind of vectorlike, with contents are like a string. */
1032 struct Lisp_Bool_Vector
1034 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1035 just the subtype information. */
1036 struct vectorlike_header header
;
1037 /* This is the size in bits. */
1039 /* This contains the actual bits, packed into bytes. */
1040 unsigned char data
[1];
1043 /* This structure describes a built-in function.
1044 It is generated by the DEFUN macro only.
1045 defsubr makes it into a Lisp object.
1047 This type is treated in most respects as a pseudovector,
1048 but since we never dynamically allocate or free them,
1049 we don't need a struct vectorlike_header and its 'next' field. */
1055 Lisp_Object (*a0
) (void);
1056 Lisp_Object (*a1
) (Lisp_Object
);
1057 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1058 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1059 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1060 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1061 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1062 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1063 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1064 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1065 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1067 short min_args
, max_args
;
1068 const char *symbol_name
;
1069 const char *intspec
;
1074 /***********************************************************************
1076 ***********************************************************************/
1078 /* Interned state of a symbol. */
1080 enum symbol_interned
1082 SYMBOL_UNINTERNED
= 0,
1083 SYMBOL_INTERNED
= 1,
1084 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1087 enum symbol_redirect
1089 SYMBOL_PLAINVAL
= 4,
1090 SYMBOL_VARALIAS
= 1,
1091 SYMBOL_LOCALIZED
= 2,
1092 SYMBOL_FORWARDED
= 3
1095 /* In a symbol, the markbit of the plist is used as the gc mark bit */
1099 unsigned gcmarkbit
: 1;
1101 /* Indicates where the value can be found:
1102 0 : it's a plain var, the value is in the `value' field.
1103 1 : it's a varalias, the value is really in the `alias' symbol.
1104 2 : it's a localized var, the value is in the `blv' object.
1105 3 : it's a forwarding variable, the value is in `forward'.
1107 enum symbol_redirect redirect
: 3;
1109 /* Non-zero means symbol is constant, i.e. changing its value
1110 should signal an error. If the value is 3, then the var
1111 can be changed, but only by `defconst'. */
1112 unsigned constant
: 2;
1114 /* Interned state of the symbol. This is an enumerator from
1115 enum symbol_interned. */
1116 unsigned interned
: 2;
1118 /* Non-zero means that this variable has been explicitly declared
1119 special (with `defvar' etc), and shouldn't be lexically bound. */
1120 unsigned declared_special
: 1;
1122 /* The symbol's name, as a Lisp string.
1124 The name "xname" is used to intentionally break code referring to
1125 the old field "name" of type pointer to struct Lisp_String. */
1128 /* Value of the symbol or Qunbound if unbound. If this symbol is a
1129 defvaralias, `alias' contains the symbol for which it is an
1130 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
1131 and set a symbol's value, to take defvaralias into account. */
1134 struct Lisp_Symbol
*alias
;
1135 struct Lisp_Buffer_Local_Value
*blv
;
1136 union Lisp_Fwd
*fwd
;
1139 /* Function value of the symbol or Qunbound if not fboundp. */
1140 Lisp_Object function
;
1142 /* The symbol's property list. */
1145 /* Next symbol in obarray bucket, if the symbol is interned. */
1146 struct Lisp_Symbol
*next
;
1149 /* Value is name of symbol. */
1151 #define SYMBOL_VAL(sym) \
1152 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1153 #define SYMBOL_ALIAS(sym) \
1154 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1155 #define SYMBOL_BLV(sym) \
1156 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1157 #define SYMBOL_FWD(sym) \
1158 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1159 #define SET_SYMBOL_VAL(sym, v) \
1160 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1161 #define SET_SYMBOL_ALIAS(sym, v) \
1162 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1163 #define SET_SYMBOL_BLV(sym, v) \
1164 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1165 #define SET_SYMBOL_FWD(sym, v) \
1166 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1168 #define SYMBOL_NAME(sym) \
1169 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1171 /* Value is non-zero if SYM is an interned symbol. */
1173 #define SYMBOL_INTERNED_P(sym) \
1174 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1176 /* Value is non-zero if SYM is interned in initial_obarray. */
1178 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1179 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1181 /* Value is non-zero if symbol is considered a constant, i.e. its
1182 value cannot be changed (there is an exception for keyword symbols,
1183 whose value can be set to the keyword symbol itself). */
1185 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1187 #define DEFSYM(sym, name) \
1188 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1191 /***********************************************************************
1193 ***********************************************************************/
1195 /* The structure of a Lisp hash table. */
1197 struct Lisp_Hash_Table
1199 /* This is for Lisp; the hash table code does not refer to it. */
1200 struct vectorlike_header header
;
1202 /* Function used to compare keys. */
1205 /* Nil if table is non-weak. Otherwise a symbol describing the
1206 weakness of the table. */
1209 /* When the table is resized, and this is an integer, compute the
1210 new size by adding this to the old size. If a float, compute the
1211 new size by multiplying the old size with this factor. */
1212 Lisp_Object rehash_size
;
1214 /* Resize hash table when number of entries/ table size is >= this
1216 Lisp_Object rehash_threshold
;
1218 /* Vector of hash codes.. If hash[I] is nil, this means that that
1219 entry I is unused. */
1222 /* Vector used to chain entries. If entry I is free, next[I] is the
1223 entry number of the next free item. If entry I is non-free,
1224 next[I] is the index of the next entry in the collision chain. */
1227 /* Index of first free entry in free list. */
1228 Lisp_Object next_free
;
1230 /* Bucket vector. A non-nil entry is the index of the first item in
1231 a collision chain. This vector's size can be larger than the
1232 hash table size to reduce collisions. */
1235 /* User-supplied hash function, or nil. */
1236 Lisp_Object user_hash_function
;
1238 /* User-supplied key comparison function, or nil. */
1239 Lisp_Object user_cmp_function
;
1241 /* Only the fields above are traced normally by the GC. The ones below
1242 `count' are special and are either ignored by the GC or traced in
1243 a special way (e.g. because of weakness). */
1245 /* Number of key/value entries in the table. */
1248 /* Vector of keys and values. The key of item I is found at index
1249 2 * I, the value is found at index 2 * I + 1.
1250 This is gc_marked specially if the table is weak. */
1251 Lisp_Object key_and_value
;
1253 /* Next weak hash table if this is a weak hash table. The head
1254 of the list is in weak_hash_tables. */
1255 struct Lisp_Hash_Table
*next_weak
;
1257 /* C function to compare two keys. */
1258 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1259 Lisp_Object
, EMACS_UINT
,
1260 Lisp_Object
, EMACS_UINT
);
1262 /* C function to compute hash code. */
1263 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1267 #define XHASH_TABLE(OBJ) \
1268 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1270 #define XSET_HASH_TABLE(VAR, PTR) \
1271 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1273 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1275 #define CHECK_HASH_TABLE(x) \
1276 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1278 /* Value is the key part of entry IDX in hash table H. */
1280 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1282 /* Value is the value part of entry IDX in hash table H. */
1284 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1286 /* Value is the index of the next entry following the one at IDX
1289 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1291 /* Value is the hash code computed for entry IDX in hash table H. */
1293 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1295 /* Value is the index of the element in hash table H that is the
1296 start of the collision list at index IDX in the index vector of H. */
1298 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1300 /* Value is the size of hash table H. */
1302 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1304 /* Default size for hash tables if not specified. */
1306 #define DEFAULT_HASH_SIZE 65
1308 /* Default threshold specifying when to resize a hash table. The
1309 value gives the ratio of current entries in the hash table and the
1310 size of the hash table. */
1312 #define DEFAULT_REHASH_THRESHOLD 0.8
1314 /* Default factor by which to increase the size of a hash table. */
1316 #define DEFAULT_REHASH_SIZE 1.5
1319 /* These structures are used for various misc types. */
1321 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1323 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_??? */
1324 unsigned gcmarkbit
: 1;
1326 /* Make it as long as "Lisp_Free without padding". */
1332 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Marker */
1333 unsigned gcmarkbit
: 1;
1335 /* This flag is temporarily used in the functions
1336 decode/encode_coding_object to record that the marker position
1337 must be adjusted after the conversion. */
1338 unsigned int need_adjustment
: 1;
1339 /* 1 means normal insertion at the marker's position
1340 leaves the marker after the inserted text. */
1341 unsigned int insertion_type
: 1;
1342 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1343 Note: a chain of markers can contain markers pointing into different
1344 buffers (the chain is per buffer_text rather than per buffer, so it's
1345 shared between indirect buffers). */
1346 /* This is used for (other than NULL-checking):
1348 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1349 - unchain_marker: to find the list from which to unchain.
1350 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1352 struct buffer
*buffer
;
1354 /* The remaining fields are meaningless in a marker that
1355 does not point anywhere. */
1357 /* For markers that point somewhere,
1358 this is used to chain of all the markers in a given buffer. */
1359 /* We could remove it and use an array in buffer_text instead.
1360 That would also allow to preserve it ordered. */
1361 struct Lisp_Marker
*next
;
1362 /* This is the char position where the marker points. */
1364 /* This is the byte position.
1365 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1366 used to implement the functionality of markers, but rather to (ab)use
1367 markers as a cache for char<->byte mappings). */
1371 /* Forwarding pointer to an int variable.
1372 This is allowed only in the value cell of a symbol,
1373 and it means that the symbol's value really lives in the
1374 specified int variable. */
1377 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1381 /* Boolean forwarding pointer to an int variable.
1382 This is like Lisp_Intfwd except that the ostensible
1383 "value" of the symbol is t if the int variable is nonzero,
1384 nil if it is zero. */
1387 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1391 /* Forwarding pointer to a Lisp_Object variable.
1392 This is allowed only in the value cell of a symbol,
1393 and it means that the symbol's value really lives in the
1394 specified variable. */
1397 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1398 Lisp_Object
*objvar
;
1401 /* Like Lisp_Objfwd except that value lives in a slot in the
1402 current buffer. Value is byte index of slot within buffer. */
1403 struct Lisp_Buffer_Objfwd
1405 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1407 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1410 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1411 the symbol has buffer-local or frame-local bindings. (Exception:
1412 some buffer-local variables are built-in, with their values stored
1413 in the buffer structure itself. They are handled differently,
1414 using struct Lisp_Buffer_Objfwd.)
1416 The `realvalue' slot holds the variable's current value, or a
1417 forwarding pointer to where that value is kept. This value is the
1418 one that corresponds to the loaded binding. To read or set the
1419 variable, you must first make sure the right binding is loaded;
1420 then you can access the value in (or through) `realvalue'.
1422 `buffer' and `frame' are the buffer and frame for which the loaded
1423 binding was found. If those have changed, to make sure the right
1424 binding is loaded it is necessary to find which binding goes with
1425 the current buffer and selected frame, then load it. To load it,
1426 first unload the previous binding, then copy the value of the new
1427 binding into `realvalue' (or through it). Also update
1428 LOADED-BINDING to point to the newly loaded binding.
1430 `local_if_set' indicates that merely setting the variable creates a
1431 local binding for the current buffer. Otherwise the latter, setting
1432 the variable does not do that; only make-local-variable does that. */
1434 struct Lisp_Buffer_Local_Value
1436 /* 1 means that merely setting the variable creates a local
1437 binding for the current buffer */
1438 unsigned int local_if_set
: 1;
1439 /* 1 means this variable can have frame-local bindings, otherwise, it is
1440 can have buffer-local bindings. The two cannot be combined. */
1441 unsigned int frame_local
: 1;
1442 /* 1 means that the binding now loaded was found.
1443 Presumably equivalent to (defcell!=valcell) */
1444 unsigned int found
: 1;
1445 /* If non-NULL, a forwarding to the C var where it should also be set. */
1446 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1447 /* The buffer or frame for which the loaded binding was found. */
1449 /* A cons cell that holds the default value. It has the form
1450 (SYMBOL . DEFAULT-VALUE). */
1451 Lisp_Object defcell
;
1452 /* The cons cell from `where's parameter alist.
1453 It always has the form (SYMBOL . VALUE)
1454 Note that if `forward' is non-nil, VALUE may be out of date.
1455 Also if the currently loaded binding is the default binding, then
1456 this is `eq'ual to defcell. */
1457 Lisp_Object valcell
;
1460 #define BLV_FOUND(blv) \
1461 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1462 #define SET_BLV_FOUND(blv, v) \
1463 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1465 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1466 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1468 /* START and END are markers in the overlay's buffer, and
1469 PLIST is the overlay's property list. */
1471 /* An overlay's real data content is:
1474 - insertion type of both ends
1475 - start & start_byte
1477 - next (singly linked list of overlays).
1478 - start_next and end_next (singly linked list of markers).
1479 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1482 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Overlay */
1483 unsigned gcmarkbit
: 1;
1485 struct Lisp_Overlay
*next
;
1486 Lisp_Object start
, end
, plist
;
1489 /* Like Lisp_Objfwd except that value lives in a slot in the
1491 struct Lisp_Kboard_Objfwd
1493 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1497 /* Hold a C pointer for later use.
1498 This type of object is used in the arg to record_unwind_protect. */
1499 struct Lisp_Save_Value
1501 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Save_Value */
1502 unsigned gcmarkbit
: 1;
1504 /* If DOGC is set, POINTER is the address of a memory
1505 area containing INTEGER potential Lisp_Objects. */
1506 unsigned int dogc
: 1;
1512 /* A miscellaneous object, when it's on the free list. */
1515 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Free */
1516 unsigned gcmarkbit
: 1;
1518 union Lisp_Misc
*chain
;
1520 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1521 This assumes that Lisp_Marker is the largest of the alternatives and
1522 that Lisp_Misc_Any has the same size as "Lisp_Free w/o padding". */
1523 char padding
[((((sizeof (struct Lisp_Marker
) - 1) >> GCTYPEBITS
) + 1)
1524 << GCTYPEBITS
) - sizeof (struct Lisp_Misc_Any
)];
1528 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1529 It uses one of these struct subtypes to get the type field. */
1533 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1534 struct Lisp_Free u_free
; /* Includes padding to force alignment. */
1535 struct Lisp_Marker u_marker
; /* 5 */
1536 struct Lisp_Overlay u_overlay
; /* 5 */
1537 struct Lisp_Save_Value u_save_value
; /* 3 */
1542 struct Lisp_Intfwd u_intfwd
; /* 2 */
1543 struct Lisp_Boolfwd u_boolfwd
; /* 2 */
1544 struct Lisp_Objfwd u_objfwd
; /* 2 */
1545 struct Lisp_Buffer_Objfwd u_buffer_objfwd
; /* 2 */
1546 struct Lisp_Kboard_Objfwd u_kboard_objfwd
; /* 2 */
1549 /* Lisp floating point type */
1554 #ifdef HIDE_LISP_IMPLEMENTATION
1559 struct Lisp_Float
*chain
;
1563 #ifdef HIDE_LISP_IMPLEMENTATION
1564 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1566 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1567 /* This should be used only in alloc.c, which always disables
1568 HIDE_LISP_IMPLEMENTATION. */
1569 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1572 /* A character, declared with the following typedef, is a member
1573 of some character set associated with the current buffer. */
1574 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1576 typedef unsigned char UCHAR
;
1579 /* Meanings of slots in a Lisp_Compiled: */
1581 #define COMPILED_ARGLIST 0
1582 #define COMPILED_BYTECODE 1
1583 #define COMPILED_CONSTANTS 2
1584 #define COMPILED_STACK_DEPTH 3
1585 #define COMPILED_DOC_STRING 4
1586 #define COMPILED_INTERACTIVE 5
1588 /* Flag bits in a character. These also get used in termhooks.h.
1589 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1590 (MUlti-Lingual Emacs) might need 22 bits for the character value
1591 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1592 #define CHAR_ALT (0x0400000)
1593 #define CHAR_SUPER (0x0800000)
1594 #define CHAR_HYPER (0x1000000)
1595 #define CHAR_SHIFT (0x2000000)
1596 #define CHAR_CTL (0x4000000)
1597 #define CHAR_META (0x8000000)
1599 #define CHAR_MODIFIER_MASK \
1600 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1603 /* Actually, the current Emacs uses 22 bits for the character value
1605 #define CHARACTERBITS 22
1608 /* The glyph datatype, used to represent characters on the display.
1609 It consists of a char code and a face id. */
1616 /* Return a glyph's character code. */
1617 #define GLYPH_CHAR(glyph) ((glyph).ch)
1619 /* Return a glyph's face ID. */
1620 #define GLYPH_FACE(glyph) ((glyph).face_id)
1622 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1623 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1624 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1626 /* Return 1 if GLYPH contains valid character code. */
1627 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1630 /* Glyph Code from a display vector may either be an integer which
1631 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1632 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1634 #define GLYPH_CODE_P(gc) \
1636 ? (CHARACTERP (XCAR (gc)) \
1637 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1638 : (RANGED_INTEGERP \
1640 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1641 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1642 : TYPE_MAXIMUM (EMACS_INT)))))
1644 /* The following are valid only if GLYPH_CODE_P (gc). */
1646 #define GLYPH_CODE_CHAR(gc) \
1647 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1649 #define GLYPH_CODE_FACE(gc) \
1650 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1652 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1656 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1658 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1659 (XINT (gc) >> CHARACTERBITS)); \
1663 /* The ID of the mode line highlighting face. */
1664 #define GLYPH_MODE_LINE_FACE 1
1666 /* Structure to hold mouse highlight data. This is here because other
1667 header files need it for defining struct x_output etc. */
1669 /* These variables describe the range of text currently shown in its
1670 mouse-face, together with the window they apply to. As long as
1671 the mouse stays within this range, we need not redraw anything on
1672 its account. Rows and columns are glyph matrix positions in
1673 MOUSE_FACE_WINDOW. */
1674 int mouse_face_beg_row
, mouse_face_beg_col
;
1675 int mouse_face_beg_x
, mouse_face_beg_y
;
1676 int mouse_face_end_row
, mouse_face_end_col
;
1677 int mouse_face_end_x
, mouse_face_end_y
;
1678 int mouse_face_past_end
;
1679 Lisp_Object mouse_face_window
;
1680 int mouse_face_face_id
;
1681 Lisp_Object mouse_face_overlay
;
1683 /* 1 if a mouse motion event came and we didn't handle it right away because
1684 gc was in progress. */
1685 int mouse_face_deferred_gc
;
1687 /* FRAME and X, Y position of mouse when last checked for
1688 highlighting. X and Y can be negative or out of range for the frame. */
1689 struct frame
*mouse_face_mouse_frame
;
1690 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1692 /* Nonzero means defer mouse-motion highlighting. */
1693 int mouse_face_defer
;
1695 /* Nonzero means that the mouse highlight should not be shown. */
1696 int mouse_face_hidden
;
1698 int mouse_face_image_state
;
1701 /* Data type checking */
1703 #define NILP(x) EQ (x, Qnil)
1705 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1706 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1708 #define RANGED_INTEGERP(lo, x, hi) \
1709 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1710 #define TYPE_RANGED_INTEGERP(type, x) \
1711 (TYPE_SIGNED (type) \
1712 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1713 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1715 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1716 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1717 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1718 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1719 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1720 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1722 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1723 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1724 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1725 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1726 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1728 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1729 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1730 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1731 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1732 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1734 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1735 vectorlike_header * avoids aliasing issues. */
1736 #define PSEUDOVECTORP(x, code) \
1737 TYPED_PSEUDOVECTORP(x, vectorlike_header, code)
1739 /* True if object X, with internal type struct T *, is a pseudovector whose
1741 #define TYPED_PSEUDOVECTORP(x, t, code) \
1743 && (((((struct t *) XPNTR (x))->size \
1744 & (PSEUDOVECTOR_FLAG | (code)))) \
1745 == (PSEUDOVECTOR_FLAG | (code))))
1747 /* Test for specific pseudovector types. */
1748 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1749 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1750 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1751 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1752 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1753 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1754 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1755 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1756 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1757 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1758 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1759 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1761 /* Test for image (image . spec) */
1762 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1767 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1769 #define CHECK_LIST(x) \
1770 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1772 #define CHECK_LIST_CONS(x, y) \
1773 CHECK_TYPE (CONSP (x), Qlistp, y)
1775 #define CHECK_LIST_END(x, y) \
1776 CHECK_TYPE (NILP (x), Qlistp, y)
1778 #define CHECK_STRING(x) \
1779 CHECK_TYPE (STRINGP (x), Qstringp, x)
1781 #define CHECK_STRING_CAR(x) \
1782 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1784 #define CHECK_CONS(x) \
1785 CHECK_TYPE (CONSP (x), Qconsp, x)
1787 #define CHECK_SYMBOL(x) \
1788 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1790 #define CHECK_CHAR_TABLE(x) \
1791 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1793 #define CHECK_VECTOR(x) \
1794 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1796 #define CHECK_VECTOR_OR_STRING(x) \
1797 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1799 #define CHECK_ARRAY(x, Qxxxp) \
1800 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1802 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1803 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1805 #define CHECK_BUFFER(x) \
1806 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1808 #define CHECK_WINDOW(x) \
1809 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1811 #define CHECK_WINDOW_CONFIGURATION(x) \
1812 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1814 /* This macro rejects windows on the interior of the window tree as
1815 "dead", which is what we want; this is an argument-checking macro, and
1816 the user should never get access to interior windows.
1818 A window of any sort, leaf or interior, is dead if the buffer,
1819 vchild, and hchild members are all nil. */
1821 #define CHECK_LIVE_WINDOW(x) \
1822 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1824 #define CHECK_PROCESS(x) \
1825 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1827 #define CHECK_SUBR(x) \
1828 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1830 #define CHECK_NUMBER(x) \
1831 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1833 #define CHECK_NATNUM(x) \
1834 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1836 #define CHECK_RANGED_INTEGER(lo, x, hi) \
1839 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1840 args_out_of_range_3 \
1842 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1843 ? MOST_NEGATIVE_FIXNUM \
1845 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1847 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1849 if (TYPE_SIGNED (type)) \
1850 CHECK_RANGED_INTEGER (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)); \
1852 CHECK_RANGED_INTEGER (0, x, TYPE_MAXIMUM (type)); \
1855 #define CHECK_MARKER(x) \
1856 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1858 #define CHECK_NUMBER_COERCE_MARKER(x) \
1859 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1860 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1862 #define XFLOATINT(n) extract_float((n))
1864 #define CHECK_FLOAT(x) \
1865 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1867 #define CHECK_NUMBER_OR_FLOAT(x) \
1868 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1870 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1871 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1872 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1874 #define CHECK_OVERLAY(x) \
1875 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1877 /* Since we can't assign directly to the CAR or CDR fields of a cons
1878 cell, use these when checking that those fields contain numbers. */
1879 #define CHECK_NUMBER_CAR(x) \
1881 Lisp_Object tmp = XCAR (x); \
1882 CHECK_NUMBER (tmp); \
1883 XSETCAR ((x), tmp); \
1886 #define CHECK_NUMBER_CDR(x) \
1888 Lisp_Object tmp = XCDR (x); \
1889 CHECK_NUMBER (tmp); \
1890 XSETCDR ((x), tmp); \
1893 #define CHECK_NATNUM_CAR(x) \
1895 Lisp_Object tmp = XCAR (x); \
1896 CHECK_NATNUM (tmp); \
1897 XSETCAR ((x), tmp); \
1900 #define CHECK_NATNUM_CDR(x) \
1902 Lisp_Object tmp = XCDR (x); \
1903 CHECK_NATNUM (tmp); \
1904 XSETCDR ((x), tmp); \
1907 /* Cast pointers to this type to compare them. */
1908 #define PNTR_COMPARISON_TYPE uintptr_t
1910 /* Define a built-in function for calling from Lisp.
1911 `lname' should be the name to give the function in Lisp,
1912 as a null-terminated C string.
1913 `fnname' should be the name of the function in C.
1914 By convention, it starts with F.
1915 `sname' should be the name for the C constant structure
1916 that records information on this function for internal use.
1917 By convention, it should be the same as `fnname' but with S instead of F.
1918 It's too bad that C macros can't compute this from `fnname'.
1919 `minargs' should be a number, the minimum number of arguments allowed.
1920 `maxargs' should be a number, the maximum number of arguments allowed,
1921 or else MANY or UNEVALLED.
1922 MANY means pass a vector of evaluated arguments,
1923 in the form of an integer number-of-arguments
1924 followed by the address of a vector of Lisp_Objects
1925 which contains the argument values.
1926 UNEVALLED means pass the list of unevaluated arguments
1927 `intspec' says how interactive arguments are to be fetched.
1928 If the string starts with a `(', `intspec' is evaluated and the resulting
1929 list is the list of arguments.
1930 If it's a string that doesn't start with `(', the value should follow
1931 the one of the doc string for `interactive'.
1932 A null string means call interactively with no arguments.
1933 `doc' is documentation for the user. */
1935 /* This version of DEFUN declares a function prototype with the right
1936 arguments, so we can catch errors with maxargs at compile-time. */
1937 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1938 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1939 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1941 { .a ## maxargs = fnname }, \
1942 minargs, maxargs, lname, intspec, 0}; \
1945 /* Note that the weird token-substitution semantics of ANSI C makes
1946 this work for MANY and UNEVALLED. */
1947 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1948 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1949 #define DEFUN_ARGS_0 (void)
1950 #define DEFUN_ARGS_1 (Lisp_Object)
1951 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1952 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1953 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1954 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1956 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1957 Lisp_Object, Lisp_Object)
1958 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1959 Lisp_Object, Lisp_Object, Lisp_Object)
1960 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1961 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1963 /* Non-zero if OBJ is a Lisp function. */
1964 #define FUNCTIONP(OBJ) \
1965 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1966 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1967 || COMPILEDP (OBJ) \
1971 is how we define the symbol for function `name' at start-up time. */
1972 extern void defsubr (struct Lisp_Subr
*);
1975 #define UNEVALLED -1
1977 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1978 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1979 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1980 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1981 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1983 /* Macros we use to define forwarded Lisp variables.
1984 These are used in the syms_of_FILENAME functions.
1986 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1987 lisp variable is actually a field in `struct emacs_globals'. The
1988 field's name begins with "f_", which is a convention enforced by
1989 these macros. Each such global has a corresponding #define in
1990 globals.h; the plain name should be used in the code.
1992 E.g., the global "cons_cells_consed" is declared as "int
1993 f_cons_cells_consed" in globals.h, but there is a define:
1995 #define cons_cells_consed globals.f_cons_cells_consed
1997 All C code uses the `cons_cells_consed' name. This is all done
1998 this way to support indirection for multi-threaded Emacs. */
2000 #define DEFVAR_LISP(lname, vname, doc) \
2002 static struct Lisp_Objfwd o_fwd; \
2003 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2005 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2007 static struct Lisp_Objfwd o_fwd; \
2008 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2010 #define DEFVAR_BOOL(lname, vname, doc) \
2012 static struct Lisp_Boolfwd b_fwd; \
2013 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2015 #define DEFVAR_INT(lname, vname, doc) \
2017 static struct Lisp_Intfwd i_fwd; \
2018 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2021 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2023 static struct Lisp_Objfwd o_fwd; \
2024 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2027 #define DEFVAR_KBOARD(lname, vname, doc) \
2029 static struct Lisp_Kboard_Objfwd ko_fwd; \
2030 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2035 /* Structure for recording Lisp call stack for backtrace purposes. */
2037 /* The special binding stack holds the outer values of variables while
2038 they are bound by a function application or a let form, stores the
2039 code to be executed for Lisp unwind-protect forms, and stores the C
2040 functions to be called for record_unwind_protect.
2042 If func is non-zero, undoing this binding applies func to old_value;
2043 This implements record_unwind_protect.
2045 Otherwise, the element is a variable binding.
2047 If the symbol field is a symbol, it is an ordinary variable binding.
2049 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2050 which means having bound a local value while CURRENT-BUFFER was active.
2051 If WHERE is nil this means we saw the default value when binding SYMBOL.
2052 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2053 value. Other values of WHERE mean an internal error. */
2055 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2059 Lisp_Object symbol
, old_value
;
2060 specbinding_func func
;
2061 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
2064 extern struct specbinding
*specpdl
;
2065 extern struct specbinding
*specpdl_ptr
;
2066 extern ptrdiff_t specpdl_size
;
2068 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2070 /* Everything needed to describe an active condition case. */
2073 /* The handler clauses and variable from the condition-case form. */
2074 /* For a handler set up in Lisp code, this is always a list.
2075 For an internal handler set up by internal_condition_case*,
2076 this can instead be the symbol t or `error'.
2077 t: handle all conditions.
2078 error: handle all conditions, and errors can run the debugger
2079 or display a backtrace. */
2080 Lisp_Object handler
;
2082 /* Fsignal stores here the condition-case clause that applies,
2083 and Fcondition_case thus knows which clause to run. */
2084 Lisp_Object chosen_clause
;
2086 /* Used to effect the longjump out to the handler. */
2087 struct catchtag
*tag
;
2089 /* The next enclosing handler. */
2090 struct handler
*next
;
2093 /* This structure helps implement the `catch' and `throw' control
2094 structure. A struct catchtag contains all the information needed
2095 to restore the state of the interpreter after a non-local jump.
2097 Handlers for error conditions (represented by `struct handler'
2098 structures) just point to a catch tag to do the cleanup required
2101 catchtag structures are chained together in the C calling stack;
2102 the `next' member points to the next outer catchtag.
2104 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2105 member is TAG, and then unbinds to it. The `val' member is used to
2106 hold VAL while the stack is unwound; `val' is returned as the value
2109 All the other members are concerned with restoring the interpreter
2116 struct catchtag
*next
;
2117 struct gcpro
*gcpro
;
2119 struct backtrace
*backlist
;
2120 struct handler
*handlerlist
;
2121 EMACS_INT lisp_eval_depth
;
2123 int poll_suppress_count
;
2124 int interrupt_input_blocked
;
2125 struct byte_stack
*byte_stack
;
2128 extern Lisp_Object memory_signal_data
;
2130 /* An address near the bottom of the stack.
2131 Tells GC how to save a copy of the stack. */
2132 extern char *stack_bottom
;
2134 /* Check quit-flag and quit if it is non-nil.
2135 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2136 So the program needs to do QUIT at times when it is safe to quit.
2137 Every loop that might run for a long time or might not exit
2138 ought to do QUIT at least once, at a safe place.
2139 Unless that is impossible, of course.
2140 But it is very desirable to avoid creating loops where QUIT is impossible.
2142 Exception: if you set immediate_quit to nonzero,
2143 then the handler that responds to the C-g does the quit itself.
2144 This is a good thing to do around a loop that has no side effects
2145 and (in particular) cannot call arbitrary Lisp code. */
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 */
2159 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2161 Lisp_Object flag = Vquit_flag; \
2162 Vquit_flag = Qnil; \
2163 if (EQ (Vthrow_on_input, flag)) \
2164 Fthrow (Vthrow_on_input, Qt); \
2165 Fsignal (Qquit, Qnil); \
2167 ELSE_PENDING_SIGNALS \
2171 /* Nonzero if ought to quit now. */
2173 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2175 extern Lisp_Object Vascii_downcase_table
;
2176 extern Lisp_Object Vascii_canon_table
;
2178 /* Number of bytes of structure consed since last GC. */
2180 extern EMACS_INT consing_since_gc
;
2182 extern EMACS_INT gc_relative_threshold
;
2184 extern EMACS_INT memory_full_cons_threshold
;
2186 /* Structure for recording stack slots that need marking. */
2188 /* This is a chain of structures, each of which points at a Lisp_Object
2189 variable whose value should be marked in garbage collection.
2190 Normally every link of the chain is an automatic variable of a function,
2191 and its `val' points to some argument or local variable of the function.
2192 On exit to the function, the chain is set back to the value it had on entry.
2193 This way, no link remains in the chain when the stack frame containing the
2196 Every function that can call Feval must protect in this fashion all
2197 Lisp_Object variables whose contents will be used again. */
2199 extern struct gcpro
*gcprolist
;
2205 /* Address of first protected variable. */
2206 volatile Lisp_Object
*var
;
2208 /* Number of consecutive protected variables. */
2216 /* Values of GC_MARK_STACK during compilation:
2218 0 Use GCPRO as before
2219 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2220 2 Mark the stack, and check that everything GCPRO'd is
2222 3 Mark using GCPRO's, mark stack last, and count how many
2223 dead objects are kept alive. */
2226 #define GC_USE_GCPROS_AS_BEFORE 0
2227 #define GC_MAKE_GCPROS_NOOPS 1
2228 #define GC_MARK_STACK_CHECK_GCPROS 2
2229 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2231 #ifndef GC_MARK_STACK
2232 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2235 /* Whether we do the stack marking manually. */
2236 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2237 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2240 #define GCPRO1(var) \
2241 GCPRO1_VAR (var, gcpro)
2242 #define GCPRO2(var1, var2) \
2243 GCPRO2_VAR (var1, var2, gcpro)
2244 #define GCPRO3(var1, var2, var3) \
2245 GCPRO3_VAR (var1, var2, var3, gcpro)
2246 #define GCPRO4(var1, var2, var3, var4) \
2247 GCPRO4_VAR (var1, var2, var3, var4, gcpro)
2248 #define GCPRO5(var1, var2, var3, var4, var5) \
2249 GCPRO5_VAR (var1, var2, var3, var4, var5, gcpro)
2250 #define GCPRO6(var1, var2, var3, var4, var5, var6) \
2251 GCPRO6_VAR (var1, var2, var3, var4, var5, var6, gcpro)
2252 #define UNGCPRO UNGCPRO_VAR (gcpro)
2254 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2256 /* Do something silly with gcproN vars just so gcc shuts up. */
2257 /* You get warnings from MIPSPro... */
2259 #define GCPRO1_VAR(var, gcpro) ((void) gcpro##1)
2260 #define GCPRO2_VAR(var1, var2, gcpro) \
2261 ((void) gcpro##2, (void) gcpro##1)
2262 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2263 ((void) gcpro##3, (void) gcpro##2, (void) gcpro##1)
2264 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2265 ((void) gcpro##4, (void) gcpro##3, (void) gcpro##2, (void) gcpro##1)
2266 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2267 ((void) gcpro##5, (void) gcpro##4, (void) gcpro##3, (void) gcpro##2, \
2269 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2270 ((void) gcpro##6, (void) gcpro##5, (void) gcpro##4, (void) gcpro##3, \
2271 (void) gcpro##2, (void) gcpro##1)
2272 #define UNGCPRO_VAR(gcpro) ((void) 0)
2274 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2278 #define GCPRO1_VAR(var1, gcpro) \
2279 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2280 gcprolist = &gcpro##1; }
2282 #define GCPRO2_VAR(var1, var2, gcpro) \
2283 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2284 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2285 gcprolist = &gcpro##2; }
2287 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2288 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2289 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2290 gcpro##3 .next = &gcpro##2; gcpro##3 .var = &var3; gcpro##3 .nvars = 1; \
2291 gcprolist = &gcpro##3; }
2293 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2294 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2295 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2296 gcpro##3 .next = &gcpro##2; gcpro##3 .var = &var3; gcpro##3 .nvars = 1; \
2297 gcpro##4 .next = &gcpro##3; gcpro##4 .var = &var4; gcpro##4 .nvars = 1; \
2298 gcprolist = &gcpro##4; }
2300 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2301 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2302 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2303 gcpro##3 .next = &gcpro##2; gcpro##3 .var = &var3; gcpro##3 .nvars = 1; \
2304 gcpro##4 .next = &gcpro##3; gcpro##4 .var = &var4; gcpro##4 .nvars = 1; \
2305 gcpro##5 .next = &gcpro##4; gcpro##5 .var = &var5; gcpro##5 .nvars = 1; \
2306 gcprolist = &gcpro##5; }
2308 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2309 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2310 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2311 gcpro##3 .next = &gcpro##2; gcpro##3 .var = &var3; gcpro##3 .nvars = 1; \
2312 gcpro##4 .next = &gcpro##3; gcpro##4 .var = &var4; gcpro##4 .nvars = 1; \
2313 gcpro##5 .next = &gcpro##4; gcpro##5 .var = &var5; gcpro##5 .nvars = 1; \
2314 gcpro##6 .next = &gcpro##5; gcpro##6 .var = &var6; gcpro##6 .nvars = 1; \
2315 gcprolist = &gcpro##6; }
2317 #define UNGCPRO_VAR(gcpro) (gcprolist = gcpro##1 .next)
2321 extern int gcpro_level
;
2323 #define GCPRO1_VAR(var1, gcpro) \
2324 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2325 gcpro##1 .level = gcpro_level++; \
2326 gcprolist = &gcpro##1; }
2328 #define GCPRO2_VAR(var1, var2, gcpro) \
2329 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2330 gcpro##1 .level = gcpro_level; \
2331 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2332 gcpro##2 .level = gcpro_level++; \
2333 gcprolist = &gcpro##2; }
2335 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2336 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2337 gcpro##1 .level = gcpro_level; \
2338 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2339 gcpro##3 .next = &gcpro##2; gcpro##3 .var = &var3; gcpro##3 .nvars = 1; \
2340 gcpro##3 .level = gcpro_level++; \
2341 gcprolist = &gcpro##3; }
2343 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2344 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2345 gcpro##1 .level = gcpro_level; \
2346 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2347 gcpro##3 .next = &gcpro##2; gcpro##3 .var = &var3; gcpro##3 .nvars = 1; \
2348 gcpro##4 .next = &gcpro##3; gcpro##4 .var = &var4; gcpro##4 .nvars = 1; \
2349 gcpro##4 .level = gcpro_level++; \
2350 gcprolist = &gcpro##4; }
2352 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2353 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2354 gcpro##1 .level = gcpro_level; \
2355 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2356 gcpro##3 .next = &gcpro##2; gcpro##3 .var = &var3; gcpro##3 .nvars = 1; \
2357 gcpro##4 .next = &gcpro##3; gcpro##4 .var = &var4; gcpro##4 .nvars = 1; \
2358 gcpro##5 .next = &gcpro##4; gcpro##5 .var = &var5; gcpro##5 .nvars = 1; \
2359 gcpro##5 .level = gcpro_level++; \
2360 gcprolist = &gcpro##5; }
2362 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2363 {gcpro##1 .next = gcprolist; gcpro##1 .var = &var1; gcpro##1 .nvars = 1; \
2364 gcpro##1 .level = gcpro_level; \
2365 gcpro##2 .next = &gcpro##1; gcpro##2 .var = &var2; gcpro##2 .nvars = 1; \
2366 gcpro##3 .next = &gcpro##2; gcpro##3 .var = &var3; gcpro##3 .nvars = 1; \
2367 gcpro##4 .next = &gcpro##3; gcpro##4 .var = &var4; gcpro##4 .nvars = 1; \
2368 gcpro##5 .next = &gcpro##4; gcpro##5 .var = &var5; gcpro##5 .nvars = 1; \
2369 gcpro##6 .next = &gcpro##5; gcpro##6 .var = &var6; gcpro##6 .nvars = 1; \
2370 gcpro##6 .level = gcpro_level++; \
2371 gcprolist = &gcpro##6; }
2373 #define UNGCPRO_VAR(gcpro) \
2374 ((--gcpro_level != gcpro##1 .level) \
2376 : ((gcprolist = gcpro##1 .next), 0))
2378 #endif /* DEBUG_GCPRO */
2379 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2382 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2383 #define RETURN_UNGCPRO(expr) \
2386 Lisp_Object ret_ungc_val; \
2387 ret_ungc_val = (expr); \
2389 return ret_ungc_val; \
2393 /* Call staticpro (&var) to protect static variable `var'. */
2395 void staticpro (Lisp_Object
*);
2397 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2398 meaning as in the DEFUN macro, and is used to construct a prototype. */
2399 /* We can use the same trick as in the DEFUN macro to generate the
2400 appropriate prototype. */
2401 #define EXFUN(fnname, maxargs) \
2402 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2404 /* Forward declarations for prototypes. */
2408 /* Defined in data.c. */
2409 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2410 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2411 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2412 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2413 extern Lisp_Object Qinvalid_read_syntax
;
2414 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2415 extern Lisp_Object Qend_of_file
, Qarith_error
, Qmark_inactive
;
2416 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2417 extern Lisp_Object Qtext_read_only
;
2418 extern Lisp_Object Qinteractive_form
;
2419 extern Lisp_Object Qcircular_list
;
2420 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2421 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2422 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2423 extern Lisp_Object Qbuffer_or_string_p
;
2424 extern Lisp_Object Qfboundp
;
2425 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2427 extern Lisp_Object Qcdr
;
2429 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2430 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2432 extern Lisp_Object Qfloatp
;
2433 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2435 extern Lisp_Object Qinteger
;
2437 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2439 EXFUN (Finteractive_form
, 1);
2440 EXFUN (Fbyteorder
, 0);
2442 /* Defined in frame.c */
2443 extern Lisp_Object Qframep
;
2445 /* Defined in data.c */
2447 EXFUN (Fcar_safe
, 1);
2449 EXFUN (Fcdr_safe
, 1);
2453 EXFUN (Ffboundp
, 1);
2454 EXFUN (Fsymbol_function
, 1);
2455 EXFUN (Fsymbol_name
, 1);
2456 extern Lisp_Object
indirect_function (Lisp_Object
);
2457 EXFUN (Findirect_function
, 2);
2459 EXFUN (Fsymbol_value
, 1);
2460 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2462 EXFUN (Fdefault_value
, 1);
2463 EXFUN (Fset_default
, 2);
2464 EXFUN (Fdefault_boundp
, 1);
2465 EXFUN (Fmake_local_variable
, 1);
2466 EXFUN (Flocal_variable_p
, 2);
2471 EXFUN (Fstring_to_number
, 2);
2472 EXFUN (Fnumber_to_string
, 1);
2478 EXFUN (Fplus
, MANY
);
2479 EXFUN (Fminus
, MANY
);
2480 EXFUN (Ftimes
, MANY
);
2488 EXFUN (Fmake_variable_buffer_local
, 1);
2490 /* Convert the integer I to an Emacs representation, either the integer
2491 itself, or a cons of two or three integers, or if all else fails a float.
2492 I should not have side effects. */
2493 #define INTEGER_TO_CONS(i) \
2494 (! FIXNUM_OVERFLOW_P (i) \
2496 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2497 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2498 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2499 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2500 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2501 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2502 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2503 ? Fcons (make_number ((i) >> 16 >> 24), \
2504 Fcons (make_number ((i) >> 16 & 0xffffff), \
2505 make_number ((i) & 0xffff))) \
2508 /* Convert the Emacs representation CONS back to an integer of type
2509 TYPE, storing the result the variable VAR. Signal an error if CONS
2510 is not a valid representation or is out of range for TYPE. */
2511 #define CONS_TO_INTEGER(cons, type, var) \
2512 (TYPE_SIGNED (type) \
2513 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2514 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2515 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2516 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2518 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2519 extern void args_out_of_range (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2520 extern void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2521 Lisp_Object
) NO_RETURN
;
2522 extern Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2523 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2524 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2525 extern void syms_of_data (void);
2526 extern void init_data (void);
2527 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2529 /* Defined in cmds.c */
2530 EXFUN (Fend_of_line
, 1);
2531 EXFUN (Fforward_char
, 1);
2532 EXFUN (Fforward_line
, 1);
2533 extern void syms_of_cmds (void);
2534 extern void keys_of_cmds (void);
2536 /* Defined in coding.c */
2537 extern Lisp_Object Qcharset
;
2538 EXFUN (Fcoding_system_p
, 1);
2539 EXFUN (Fcoding_system_base
, 1);
2540 EXFUN (Fcoding_system_eol_type
, 1);
2541 EXFUN (Fcheck_coding_system
, 1);
2542 EXFUN (Fread_coding_system
, 2);
2543 EXFUN (Fread_non_nil_coding_system
, 1);
2544 EXFUN (Ffind_operation_coding_system
, MANY
);
2545 EXFUN (Fdecode_coding_string
, 4);
2546 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2547 ptrdiff_t, int, int, Lisp_Object
);
2548 extern void init_coding (void);
2549 extern void init_coding_once (void);
2550 extern void syms_of_coding (void);
2552 /* Defined in character.c */
2553 EXFUN (Fchar_width
, 1);
2554 EXFUN (Fstring
, MANY
);
2555 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2556 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2557 extern int multibyte_char_to_unibyte (int);
2558 extern int multibyte_char_to_unibyte_safe (int);
2559 extern void init_character_once (void);
2560 extern void syms_of_character (void);
2562 /* Defined in charset.c */
2563 extern void init_charset (void);
2564 extern void init_charset_once (void);
2565 extern void syms_of_charset (void);
2566 /* Structure forward declarations. */
2569 /* Defined in composite.c */
2570 extern void syms_of_composite (void);
2572 /* Defined in syntax.c */
2573 EXFUN (Fforward_word
, 1);
2574 EXFUN (Fskip_chars_forward
, 2);
2575 EXFUN (Fskip_chars_backward
, 2);
2576 extern void init_syntax_once (void);
2577 extern void syms_of_syntax (void);
2579 /* Defined in fns.c */
2580 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2581 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2582 extern EMACS_INT
next_almost_prime (EMACS_INT
);
2583 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2584 extern void sweep_weak_hash_tables (void);
2585 extern Lisp_Object Qcursor_in_echo_area
;
2586 extern Lisp_Object Qstring_lessp
;
2587 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2588 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2589 EMACS_UINT
sxhash (Lisp_Object
, int);
2590 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2591 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2593 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2594 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2596 void init_weak_hash_tables (void);
2597 extern void init_fns (void);
2598 EXFUN (Fmake_hash_table
, MANY
);
2599 EXFUN (Fgethash
, 3);
2600 EXFUN (Fputhash
, 3);
2601 EXFUN (Fremhash
, 2);
2603 EXFUN (Fidentity
, 1);
2605 EXFUN (Fappend
, MANY
);
2606 EXFUN (Fconcat
, MANY
);
2607 EXFUN (Fvconcat
, MANY
);
2608 EXFUN (Fcopy_sequence
, 1);
2609 EXFUN (Fstring_make_multibyte
, 1);
2610 EXFUN (Fstring_make_unibyte
, 1);
2611 EXFUN (Fstring_as_multibyte
, 1);
2612 EXFUN (Fstring_as_unibyte
, 1);
2613 EXFUN (Fstring_to_multibyte
, 1);
2614 EXFUN (Fsubstring
, 3);
2615 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2616 ptrdiff_t, ptrdiff_t);
2628 EXFUN (Freverse
, 1);
2629 EXFUN (Fnreverse
, 1);
2633 EXFUN (Fnconc
, MANY
);
2635 EXFUN (Fmapconcat
, 3);
2636 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2637 EXFUN (Fprovide
, 2);
2638 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2639 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2640 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2641 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2642 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2643 extern void clear_string_char_byte_cache (void);
2644 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2645 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2646 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2647 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2648 EXFUN (Fcopy_alist
, 1);
2649 EXFUN (Fplist_get
, 2);
2650 EXFUN (Fplist_put
, 3);
2651 EXFUN (Fplist_member
, 2);
2653 EXFUN (Fstring_equal
, 2);
2654 EXFUN (Fcompare_strings
, 7);
2655 EXFUN (Fstring_lessp
, 2);
2656 extern void syms_of_fns (void);
2658 /* Defined in floatfns.c */
2659 extern double extract_float (Lisp_Object
);
2661 EXFUN (Ftruncate
, 2);
2662 extern void init_floatfns (void);
2663 extern void syms_of_floatfns (void);
2664 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2666 /* Defined in fringe.c */
2667 extern void syms_of_fringe (void);
2668 extern void init_fringe (void);
2669 #ifdef HAVE_WINDOW_SYSTEM
2670 extern void mark_fringe_data (void);
2671 extern void init_fringe_once (void);
2672 #endif /* HAVE_WINDOW_SYSTEM */
2674 /* Defined in image.c */
2675 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2676 extern Lisp_Object QCconversion
;
2677 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2678 extern void syms_of_image (void);
2679 extern void init_image (void);
2681 /* Defined in insdel.c */
2682 extern Lisp_Object Qinhibit_modification_hooks
;
2683 extern void move_gap (ptrdiff_t);
2684 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2685 extern void buffer_overflow (void) NO_RETURN
;
2686 extern void make_gap (ptrdiff_t);
2687 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2688 ptrdiff_t, int, int);
2689 extern int count_combining_before (const unsigned char *,
2690 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2691 extern int count_combining_after (const unsigned char *,
2692 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2693 extern void insert (const char *, ptrdiff_t);
2694 extern void insert_and_inherit (const char *, ptrdiff_t);
2695 extern void insert_1 (const char *, ptrdiff_t, int, int, int);
2696 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2698 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2699 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2700 ptrdiff_t, ptrdiff_t, int);
2701 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2702 extern void insert_char (int);
2703 extern void insert_string (const char *);
2704 extern void insert_before_markers (const char *, ptrdiff_t);
2705 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2706 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2707 ptrdiff_t, ptrdiff_t,
2709 extern void del_range (ptrdiff_t, ptrdiff_t);
2710 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, int, int);
2711 extern void del_range_byte (ptrdiff_t, ptrdiff_t, int);
2712 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int);
2713 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2714 ptrdiff_t, ptrdiff_t, int);
2715 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2716 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2717 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2718 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2719 ptrdiff_t, ptrdiff_t);
2720 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2721 ptrdiff_t, ptrdiff_t);
2722 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, int, int, int);
2723 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2724 const char *, ptrdiff_t, ptrdiff_t, int);
2725 extern void syms_of_insdel (void);
2727 /* Defined in dispnew.c */
2728 extern Lisp_Object selected_frame
;
2729 extern Lisp_Object Vwindow_system
;
2731 EXFUN (Fredraw_frame
, 1);
2732 void duration_to_sec_usec (double, int *, int *);
2733 EXFUN (Fsleep_for
, 2);
2734 EXFUN (Fredisplay
, 1);
2735 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2736 extern void init_display (void);
2737 extern void syms_of_display (void);
2739 /* Defined in xdisp.c */
2740 extern Lisp_Object Qinhibit_point_motion_hooks
;
2741 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2742 extern Lisp_Object Qmenu_bar_update_hook
;
2743 extern Lisp_Object Qwindow_scroll_functions
;
2744 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2745 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2746 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2747 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2748 extern Lisp_Object Qleft_margin
, Qright_margin
;
2749 extern Lisp_Object Qglyphless_char
;
2750 extern Lisp_Object QCdata
, QCfile
;
2751 extern Lisp_Object QCmap
;
2752 extern Lisp_Object Qrisky_local_variable
;
2753 extern struct frame
*last_glyphless_glyph_frame
;
2754 extern int last_glyphless_glyph_face_id
;
2755 extern int last_glyphless_glyph_merged_face_id
;
2756 extern int noninteractive_need_newline
;
2757 extern Lisp_Object echo_area_buffer
[2];
2758 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2759 extern void check_message_stack (void);
2760 extern void setup_echo_area_for_printing (int);
2761 extern int push_message (void);
2762 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2763 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2764 extern void restore_message (void);
2765 extern Lisp_Object
current_message (void);
2766 extern void clear_message (int, int);
2767 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2768 extern void message1 (const char *);
2769 extern void message1_nolog (const char *);
2770 extern void message2 (const char *, ptrdiff_t, int);
2771 extern void message2_nolog (const char *, ptrdiff_t, int);
2772 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2773 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2774 extern void message_dolog (const char *, ptrdiff_t, int, int);
2775 extern void message_with_string (const char *, Lisp_Object
, int);
2776 extern void message_log_maybe_newline (void);
2777 extern void update_echo_area (void);
2778 extern void truncate_echo_area (ptrdiff_t);
2779 extern void redisplay (void);
2780 extern void redisplay_preserve_echo_area (int);
2781 extern void prepare_menu_bars (void);
2783 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2784 extern void syms_of_xdisp (void);
2785 extern void init_xdisp (void);
2786 extern Lisp_Object
safe_eval (Lisp_Object
);
2787 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2788 int *, int *, int *, int *, int *);
2790 /* Defined in xsettings.c */
2791 extern void syms_of_xsettings (void);
2793 /* Defined in vm-limit.c. */
2794 extern void memory_warnings (POINTER_TYPE
*, void (*warnfun
) (const char *));
2796 /* Defined in alloc.c */
2797 extern void check_pure_size (void);
2798 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2799 extern void reset_malloc_hooks (void);
2800 extern void uninterrupt_malloc (void);
2801 extern void malloc_warning (const char *);
2802 extern void memory_full (size_t) NO_RETURN
;
2803 extern void buffer_memory_full (ptrdiff_t) NO_RETURN
;
2804 extern int survives_gc_p (Lisp_Object
);
2805 extern void mark_object (Lisp_Object
);
2806 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2807 extern void refill_memory_reserve (void);
2809 extern const char *pending_malloc_warning
;
2810 extern Lisp_Object
*stack_base
;
2812 extern Lisp_Object
list1 (Lisp_Object
);
2813 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2814 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2815 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2816 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2818 EXFUN (Flist
, MANY
);
2819 EXFUN (Fmake_list
, 2);
2820 extern Lisp_Object
allocate_misc (void);
2821 EXFUN (Fmake_vector
, 2);
2822 EXFUN (Fvector
, MANY
);
2823 EXFUN (Fmake_symbol
, 1);
2824 EXFUN (Fmake_marker
, 0);
2825 extern void string_overflow (void) NO_RETURN
;
2826 EXFUN (Fmake_string
, 2);
2827 extern Lisp_Object
build_string (const char *);
2828 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2829 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2830 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2831 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2832 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2833 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2834 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2835 extern Lisp_Object
make_specified_string (const char *,
2836 ptrdiff_t, ptrdiff_t, int);
2837 EXFUN (Fpurecopy
, 1);
2838 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, int);
2839 extern Lisp_Object
make_pure_c_string (const char *data
);
2840 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2841 extern Lisp_Object
make_pure_vector (ptrdiff_t);
2842 EXFUN (Fgarbage_collect
, 0);
2843 EXFUN (Fmake_byte_code
, MANY
);
2844 EXFUN (Fmake_bool_vector
, 2);
2845 extern Lisp_Object Qchar_table_extra_slots
;
2846 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2847 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2848 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2850 allocate_pseudovector \
2851 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2852 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2853 extern struct window
*allocate_window (void);
2854 extern struct frame
*allocate_frame (void);
2855 extern struct Lisp_Process
*allocate_process (void);
2856 extern struct terminal
*allocate_terminal (void);
2857 extern int gc_in_progress
;
2858 extern int abort_on_gc
;
2859 extern Lisp_Object
make_float (double);
2860 extern void display_malloc_warning (void);
2861 extern ptrdiff_t inhibit_garbage_collection (void);
2862 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2863 extern void free_marker (Lisp_Object
);
2864 extern void free_cons (struct Lisp_Cons
*);
2865 extern void init_alloc_once (void);
2866 extern void init_alloc (void);
2867 extern void syms_of_alloc (void);
2868 extern struct buffer
* allocate_buffer (void);
2869 extern int valid_lisp_object_p (Lisp_Object
);
2871 /* Defined in chartab.c */
2872 EXFUN (Fmake_char_table
, 2);
2873 EXFUN (Fset_char_table_parent
, 2);
2874 EXFUN (Fchar_table_extra_slot
, 2);
2875 EXFUN (Fset_char_table_extra_slot
, 3);
2876 EXFUN (Fset_char_table_range
, 3);
2877 EXFUN (Foptimize_char_table
, 2);
2878 extern Lisp_Object
copy_char_table (Lisp_Object
);
2879 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2880 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2882 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2883 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2885 extern int char_table_translate (Lisp_Object
, int);
2886 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2888 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2889 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2890 Lisp_Object
, Lisp_Object
,
2891 Lisp_Object
, struct charset
*,
2892 unsigned, unsigned);
2893 extern Lisp_Object
uniprop_table (Lisp_Object
);
2894 extern void syms_of_chartab (void);
2896 /* Defined in print.c */
2897 extern Lisp_Object Vprin1_to_string_buffer
;
2898 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2900 EXFUN (Fprin1_to_string
, 2);
2903 EXFUN (Ferror_message_string
, 1);
2904 extern Lisp_Object Qstandard_output
;
2905 extern Lisp_Object Qexternal_debugging_output
;
2906 extern void temp_output_buffer_setup (const char *);
2907 extern int print_level
;
2908 extern Lisp_Object Qprint_escape_newlines
;
2909 extern void write_string (const char *, int);
2910 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2912 extern Lisp_Object internal_with_output_to_temp_buffer
2913 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2914 #define FLOAT_TO_STRING_BUFSIZE 350
2915 extern void float_to_string (char *, double);
2916 extern void syms_of_print (void);
2918 /* Defined in doprnt.c */
2919 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2921 extern ptrdiff_t esprintf (char *, char const *, ...)
2922 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2923 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2925 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2926 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2927 char const *, va_list)
2928 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2930 /* Defined in lread.c. */
2931 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2932 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2934 EXFUN (Fread_from_string
, 3);
2936 EXFUN (Fintern_soft
, 2);
2937 EXFUN (Funintern
, 2);
2939 EXFUN (Fget_load_suffixes
, 0);
2940 EXFUN (Fread_char
, 3);
2941 EXFUN (Fread_event
, 3);
2942 extern Lisp_Object
check_obarray (Lisp_Object
);
2943 extern Lisp_Object
intern (const char *);
2944 extern Lisp_Object
intern_c_string (const char *);
2945 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
2946 #define LOADHIST_ATTACH(x) \
2948 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2950 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2951 Lisp_Object
*, Lisp_Object
);
2952 Lisp_Object
string_to_number (char const *, int, int);
2953 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2955 extern void dir_warning (const char *, Lisp_Object
);
2956 extern void close_load_descs (void);
2957 extern void init_obarray (void);
2958 extern void init_lread (void);
2959 extern void syms_of_lread (void);
2961 /* Defined in eval.c. */
2962 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
, Qmacro
;
2963 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2964 extern Lisp_Object Qand_rest
;
2965 extern Lisp_Object Vautoload_queue
;
2966 extern Lisp_Object Vsignaling_function
;
2967 extern int handling_signal
;
2969 extern struct catchtag
*catchlist
;
2970 extern struct handler
*handlerlist
;
2972 /* To run a normal hook, use the appropriate function from the list below.
2973 The calling convention:
2975 if (!NILP (Vrun_hooks))
2976 call1 (Vrun_hooks, Qmy_funny_hook);
2978 should no longer be used. */
2979 extern Lisp_Object Vrun_hooks
;
2980 EXFUN (Frun_hooks
, MANY
);
2981 EXFUN (Frun_hook_with_args
, MANY
);
2982 EXFUN (Frun_hook_with_args_until_failure
, MANY
);
2983 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2984 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2985 Lisp_Object (*funcall
)
2986 (ptrdiff_t nargs
, Lisp_Object
*args
));
2987 EXFUN (Fprogn
, UNEVALLED
);
2988 EXFUN (Finteractive_p
, 0);
2989 EXFUN (Fthrow
, 2) NO_RETURN
;
2991 extern void xsignal (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2992 extern void xsignal0 (Lisp_Object
) NO_RETURN
;
2993 extern void xsignal1 (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2994 extern void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2995 extern void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2996 extern void signal_error (const char *, Lisp_Object
) NO_RETURN
;
2997 EXFUN (Fcommandp
, 2);
2998 EXFUN (Ffunctionp
, 1);
3000 extern Lisp_Object
eval_sub (Lisp_Object form
);
3001 EXFUN (Fapply
, MANY
);
3002 EXFUN (Ffuncall
, MANY
);
3003 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3004 extern Lisp_Object
call0 (Lisp_Object
);
3005 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3006 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3007 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3008 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3009 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3010 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3011 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3012 EXFUN (Fdo_auto_save
, 2);
3013 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3014 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3015 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3016 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3017 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3018 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3019 extern void specbind (Lisp_Object
, Lisp_Object
);
3020 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3021 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3022 extern void error (const char *, ...) NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
3023 extern void verror (const char *, va_list)
3024 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 0);
3025 extern void do_autoload (Lisp_Object
, Lisp_Object
);
3026 extern Lisp_Object
un_autoload (Lisp_Object
);
3027 extern void init_eval_once (void);
3028 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
*);
3029 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3030 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3031 extern void init_eval (void);
3033 extern void mark_backtrace (void);
3035 extern void syms_of_eval (void);
3037 /* Defined in editfns.c */
3038 extern Lisp_Object Qfield
;
3039 EXFUN (Fcurrent_message
, 0);
3040 EXFUN (Fgoto_char
, 1);
3041 EXFUN (Fpoint_max_marker
, 0);
3043 EXFUN (Fpoint_marker
, 0);
3044 EXFUN (Fline_beginning_position
, 1);
3045 EXFUN (Fline_end_position
, 1);
3046 EXFUN (Ffollowing_char
, 0);
3047 EXFUN (Fprevious_char
, 0);
3048 EXFUN (Fchar_after
, 1);
3049 EXFUN (Finsert
, MANY
);
3050 EXFUN (Finsert_char
, 3);
3051 extern void insert1 (Lisp_Object
);
3056 EXFUN (Fformat
, MANY
);
3057 EXFUN (Fmessage
, MANY
);
3058 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3059 EXFUN (Fbuffer_substring
, 2);
3060 EXFUN (Fbuffer_string
, 0);
3061 extern Lisp_Object
save_excursion_save (void);
3062 extern Lisp_Object
save_restriction_save (void);
3063 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3064 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3065 EXFUN (Fchar_to_string
, 1);
3066 EXFUN (Fdelete_region
, 2);
3067 EXFUN (Fnarrow_to_region
, 2);
3069 EXFUN (Fuser_login_name
, 1);
3070 EXFUN (Fsystem_name
, 0);
3071 EXFUN (Fcurrent_time
, 0);
3072 EXFUN (Fget_internal_run_time
, 0);
3073 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, int);
3074 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3076 extern void init_editfns (void);
3077 const char *get_system_name (void);
3078 extern void syms_of_editfns (void);
3079 EXFUN (Fconstrain_to_field
, 5);
3080 EXFUN (Ffield_end
, 3);
3081 extern void set_time_zone_rule (const char *);
3083 /* Defined in buffer.c */
3084 extern int mouse_face_overlay_overlaps (Lisp_Object
);
3085 extern void nsberror (Lisp_Object
) NO_RETURN
;
3086 EXFUN (Fset_buffer_multibyte
, 1);
3087 EXFUN (Foverlay_start
, 1);
3088 EXFUN (Foverlay_end
, 1);
3089 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3090 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3091 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3092 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
3093 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3094 extern int overlay_touches_p (ptrdiff_t);
3095 extern Lisp_Object Vbuffer_alist
;
3096 EXFUN (Fget_buffer
, 1);
3097 EXFUN (Fget_buffer_create
, 1);
3098 EXFUN (Fgenerate_new_buffer_name
, 2);
3099 EXFUN (Fset_buffer
, 1);
3100 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3101 EXFUN (Fbarf_if_buffer_read_only
, 0);
3102 EXFUN (Fcurrent_buffer
, 0);
3103 EXFUN (Fother_buffer
, 3);
3104 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3105 EXFUN (Foverlay_get
, 2);
3106 EXFUN (Fbuffer_modified_p
, 1);
3107 EXFUN (Fset_buffer_modified_p
, 1);
3108 EXFUN (Fkill_buffer
, 1);
3109 EXFUN (Fkill_all_local_variables
, 0);
3110 EXFUN (Fbuffer_enable_undo
, 1);
3111 EXFUN (Ferase_buffer
, 0);
3112 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3113 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3114 extern struct buffer
*all_buffers
;
3115 EXFUN (Fprevious_overlay_change
, 1);
3116 EXFUN (Fbuffer_file_name
, 1);
3117 extern void init_buffer_once (void);
3118 extern void init_buffer (void);
3119 extern void syms_of_buffer (void);
3120 extern void keys_of_buffer (void);
3122 /* Defined in marker.c */
3124 EXFUN (Fmarker_position
, 1);
3125 EXFUN (Fmarker_buffer
, 1);
3126 EXFUN (Fcopy_marker
, 2);
3127 EXFUN (Fset_marker
, 3);
3128 extern ptrdiff_t marker_position (Lisp_Object
);
3129 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3130 extern void clear_charpos_cache (struct buffer
*);
3131 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3132 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3133 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3134 extern void unchain_marker (struct Lisp_Marker
*marker
);
3135 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3136 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3137 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3138 ptrdiff_t, ptrdiff_t);
3139 extern void syms_of_marker (void);
3141 /* Defined in fileio.c */
3143 extern Lisp_Object Qfile_error
;
3144 extern Lisp_Object Qfile_exists_p
;
3145 extern Lisp_Object Qfile_directory_p
;
3146 extern Lisp_Object Qinsert_file_contents
;
3147 extern Lisp_Object Qfile_name_history
;
3148 EXFUN (Ffind_file_name_handler
, 2);
3149 EXFUN (Ffile_name_as_directory
, 1);
3150 EXFUN (Fexpand_file_name
, 2);
3151 EXFUN (Ffile_name_nondirectory
, 1);
3152 EXFUN (Fsubstitute_in_file_name
, 1);
3153 EXFUN (Ffile_symlink_p
, 1);
3154 EXFUN (Fverify_visited_file_modtime
, 1);
3155 EXFUN (Ffile_exists_p
, 1);
3156 EXFUN (Ffile_name_absolute_p
, 1);
3157 EXFUN (Fdirectory_file_name
, 1);
3158 EXFUN (Ffile_name_directory
, 1);
3159 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3160 EXFUN (Ffile_accessible_directory_p
, 1);
3161 EXFUN (Funhandled_file_name_directory
, 1);
3162 EXFUN (Ffile_directory_p
, 1);
3163 EXFUN (Fwrite_region
, 7);
3164 EXFUN (Ffile_readable_p
, 1);
3165 EXFUN (Fread_file_name
, 6);
3166 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3167 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3168 extern void report_file_error (const char *, Lisp_Object
) NO_RETURN
;
3169 extern int internal_delete_file (Lisp_Object
);
3170 extern void syms_of_fileio (void);
3171 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
3172 extern Lisp_Object Qdelete_file
;
3174 /* Defined in abbrev.c */
3176 extern void syms_of_abbrev (void);
3178 /* Defined in search.c */
3179 extern void shrink_regexp_cache (void);
3180 EXFUN (Fstring_match
, 3);
3181 extern void restore_search_regs (void);
3182 EXFUN (Fmatch_data
, 3);
3183 EXFUN (Fset_match_data
, 2);
3184 EXFUN (Fmatch_beginning
, 1);
3185 EXFUN (Fmatch_end
, 1);
3186 extern void record_unwind_save_match_data (void);
3187 struct re_registers
;
3188 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3189 struct re_registers
*,
3190 Lisp_Object
, int, int);
3191 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3192 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *);
3193 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3194 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3195 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3196 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3198 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3200 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3201 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3202 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3203 extern void syms_of_search (void);
3204 extern void clear_regexp_cache (void);
3206 /* Defined in minibuf.c */
3208 extern Lisp_Object Qcompletion_ignore_case
;
3209 extern Lisp_Object Vminibuffer_list
;
3210 extern Lisp_Object last_minibuf_string
;
3211 EXFUN (Fcompleting_read
, 8);
3212 EXFUN (Fread_from_minibuffer
, 7);
3213 EXFUN (Fread_variable
, 2);
3214 EXFUN (Fread_buffer
, 3);
3215 EXFUN (Fread_minibuffer
, 2);
3216 EXFUN (Feval_minibuffer
, 2);
3217 EXFUN (Fread_string
, 5);
3218 EXFUN (Fassoc_string
, 3);
3219 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3220 extern void init_minibuf_once (void);
3221 extern void syms_of_minibuf (void);
3223 /* Defined in callint.c */
3225 extern Lisp_Object Qminus
, Qplus
;
3226 extern Lisp_Object Qwhen
;
3227 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3228 EXFUN (Fprefix_numeric_value
, 1);
3229 extern void syms_of_callint (void);
3231 /* Defined in casefiddle.c */
3233 extern Lisp_Object Qidentity
;
3234 EXFUN (Fdowncase
, 1);
3236 EXFUN (Fupcase_region
, 2);
3237 EXFUN (Fupcase_initials
, 1);
3238 EXFUN (Fupcase_initials_region
, 2);
3239 extern void syms_of_casefiddle (void);
3240 extern void keys_of_casefiddle (void);
3242 /* Defined in casetab.c */
3244 EXFUN (Fset_case_table
, 1);
3245 EXFUN (Fset_standard_case_table
, 1);
3246 extern void init_casetab_once (void);
3247 extern void syms_of_casetab (void);
3249 /* Defined in keyboard.c */
3251 extern Lisp_Object echo_message_buffer
;
3252 extern struct kboard
*echo_kboard
;
3253 extern void cancel_echoing (void);
3254 extern Lisp_Object Qdisabled
, QCfilter
;
3255 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3256 extern Lisp_Object Qtop
;
3257 extern int input_pending
;
3258 EXFUN (Fdiscard_input
, 0);
3259 EXFUN (Frecursive_edit
, 0);
3260 EXFUN (Ftop_level
, 0) NO_RETURN
;
3261 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3262 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3263 extern void discard_mouse_events (void);
3264 EXFUN (Fevent_convert_list
, 1);
3265 EXFUN (Fread_key_sequence
, 5);
3266 EXFUN (Fset_input_interrupt_mode
, 1);
3267 EXFUN (Fset_input_mode
, 4);
3268 extern Lisp_Object pending_funcalls
;
3269 extern int detect_input_pending (void);
3270 extern int detect_input_pending_ignore_squeezables (void);
3271 extern int detect_input_pending_run_timers (int);
3272 extern void safe_run_hooks (Lisp_Object
);
3273 extern void cmd_error_internal (Lisp_Object
, const char *);
3274 extern Lisp_Object
command_loop_1 (void);
3275 extern Lisp_Object
recursive_edit_1 (void);
3276 extern void record_auto_save (void);
3278 extern void force_auto_save_soon (void);
3280 extern void init_keyboard (void);
3281 extern void syms_of_keyboard (void);
3282 extern void keys_of_keyboard (void);
3284 /* Defined in indent.c */
3285 EXFUN (Fvertical_motion
, 2);
3286 EXFUN (Findent_to
, 2);
3287 EXFUN (Fmove_to_column
, 2);
3288 extern ptrdiff_t current_column (void);
3289 extern void invalidate_current_column (void);
3290 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3291 extern void syms_of_indent (void);
3293 /* Defined in frame.c */
3294 #ifdef HAVE_WINDOW_SYSTEM
3295 #endif /* HAVE_WINDOW_SYSTEM */
3296 extern Lisp_Object Qonly
;
3297 extern Lisp_Object Qvisible
;
3298 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3299 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3300 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3302 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3304 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3305 EXFUN (Fselect_frame
, 2);
3306 EXFUN (Fselected_frame
, 0);
3307 EXFUN (Fmake_frame_visible
, 1);
3308 EXFUN (Ficonify_frame
, 1);
3309 EXFUN (Fframe_parameter
, 2);
3310 EXFUN (Fmodify_frame_parameters
, 2);
3311 EXFUN (Fraise_frame
, 1);
3312 EXFUN (Fredirect_frame_focus
, 2);
3313 extern void frames_discard_buffer (Lisp_Object
);
3314 extern void syms_of_frame (void);
3316 /* Defined in emacs.c */
3317 extern char **initial_argv
;
3318 extern int initial_argc
;
3319 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3320 extern int display_arg
;
3322 extern Lisp_Object
decode_env_path (const char *, const char *);
3323 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3324 extern Lisp_Object Qfile_name_handler_alist
;
3325 #ifdef FLOAT_CATCH_SIGILL
3326 extern void fatal_error_signal (int);
3328 EXFUN (Fkill_emacs
, 1) NO_RETURN
;
3330 void fixup_locale (void);
3331 void synchronize_system_messages_locale (void);
3332 void synchronize_system_time_locale (void);
3334 #define setlocale(category, locale)
3335 #define fixup_locale()
3336 #define synchronize_system_messages_locale()
3337 #define synchronize_system_time_locale()
3339 void shut_down_emacs (int, int, Lisp_Object
);
3340 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3341 extern int noninteractive
;
3343 /* Nonzero means remove site-lisp directories from load-path. */
3344 extern int no_site_lisp
;
3346 /* Pipe used to send exit notification to the daemon parent at
3348 extern int daemon_pipe
[2];
3349 #define IS_DAEMON (daemon_pipe[1] != 0)
3351 /* Nonzero means don't do use window-system-specific display code. */
3352 extern int inhibit_window_system
;
3353 /* Nonzero means that a filter or a sentinel is running. */
3354 extern int running_asynch_code
;
3356 /* Defined in process.c. */
3357 extern Lisp_Object QCtype
, Qlocal
;
3358 EXFUN (Fget_buffer_process
, 1);
3359 EXFUN (Fprocess_status
, 1);
3360 EXFUN (Fkill_process
, 2);
3361 EXFUN (Fwaiting_for_user_input_p
, 0);
3362 extern Lisp_Object Qprocessp
;
3363 extern void kill_buffer_processes (Lisp_Object
);
3364 extern int wait_reading_process_output (int, int, int, int,
3366 struct Lisp_Process
*,
3368 extern void add_keyboard_wait_descriptor (int);
3369 extern void delete_keyboard_wait_descriptor (int);
3371 extern void add_gpm_wait_descriptor (int);
3372 extern void delete_gpm_wait_descriptor (int);
3374 extern void close_process_descs (void);
3375 extern void init_process (void);
3376 extern void syms_of_process (void);
3377 extern void setup_process_coding_systems (Lisp_Object
);
3379 EXFUN (Fcall_process
, MANY
);
3380 extern int child_setup (int, int, int, char **, int, Lisp_Object
)
3385 extern void init_callproc_1 (void);
3386 extern void init_callproc (void);
3387 extern void set_initial_environment (void);
3388 extern void syms_of_callproc (void);
3390 /* Defined in doc.c */
3391 extern Lisp_Object Qfunction_documentation
;
3392 EXFUN (Fsubstitute_command_keys
, 1);
3393 extern Lisp_Object
read_doc_string (Lisp_Object
);
3394 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3395 extern void syms_of_doc (void);
3396 extern int read_bytecode_char (int);
3398 /* Defined in bytecode.c */
3399 extern Lisp_Object Qbytecode
;
3400 extern void syms_of_bytecode (void);
3401 extern struct byte_stack
*byte_stack_list
;
3403 extern void mark_byte_stack (void);
3405 extern void unmark_byte_stack (void);
3406 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3407 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3409 /* Defined in macros.c */
3410 extern Lisp_Object Qexecute_kbd_macro
;
3411 EXFUN (Fexecute_kbd_macro
, 3);
3412 EXFUN (Fcancel_kbd_macro_events
, 0);
3413 extern void init_macros (void);
3414 extern void syms_of_macros (void);
3416 /* Defined in undo.c */
3417 extern Lisp_Object Qapply
;
3418 extern Lisp_Object Qinhibit_read_only
;
3419 EXFUN (Fundo_boundary
, 0);
3420 extern void truncate_undo_list (struct buffer
*);
3421 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3422 extern void record_insert (ptrdiff_t, ptrdiff_t);
3423 extern void record_delete (ptrdiff_t, Lisp_Object
);
3424 extern void record_first_change (void);
3425 extern void record_change (ptrdiff_t, ptrdiff_t);
3426 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3427 Lisp_Object
, Lisp_Object
,
3429 extern void syms_of_undo (void);
3430 /* Defined in textprop.c */
3431 extern Lisp_Object Qfont
, Qmouse_face
;
3432 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3433 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3434 extern Lisp_Object Qminibuffer_prompt
;
3436 EXFUN (Fnext_single_property_change
, 4);
3437 EXFUN (Fnext_single_char_property_change
, 4);
3438 EXFUN (Fprevious_single_property_change
, 4);
3439 EXFUN (Fget_text_property
, 3);
3440 EXFUN (Fput_text_property
, 5);
3441 EXFUN (Fprevious_char_property_change
, 2);
3442 EXFUN (Fnext_char_property_change
, 2);
3443 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3445 /* Defined in menu.c */
3446 extern void syms_of_menu (void);
3448 /* Defined in xmenu.c */
3449 EXFUN (Fx_popup_menu
, 2);
3450 EXFUN (Fx_popup_dialog
, 3);
3451 extern void syms_of_xmenu (void);
3453 /* Defined in termchar.h */
3454 struct tty_display_info
;
3456 /* Defined in termhooks.h */
3459 /* Defined in sysdep.c */
3460 #ifndef HAVE_GET_CURRENT_DIR_NAME
3461 extern char *get_current_dir_name (void);
3463 extern void stuff_char (char c
);
3464 extern void init_sigio (int);
3465 extern void sys_subshell (void);
3466 extern void sys_suspend (void);
3467 extern void discard_tty_input (void);
3468 extern void init_sys_modes (struct tty_display_info
*);
3469 extern void reset_sys_modes (struct tty_display_info
*);
3470 extern void init_all_sys_modes (void);
3471 extern void reset_all_sys_modes (void);
3472 extern void wait_for_termination (pid_t
);
3473 extern void interruptible_wait_for_termination (pid_t
);
3474 extern void flush_pending_output (int);
3475 extern void child_setup_tty (int);
3476 extern void setup_pty (int);
3477 extern int set_window_size (int, int, int);
3478 extern EMACS_INT
get_random (void);
3479 extern void seed_random (long);
3480 extern int emacs_open (const char *, int, int);
3481 extern int emacs_close (int);
3482 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3483 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3484 enum { READLINK_BUFSIZE
= 1024 };
3485 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3487 EXFUN (Funlock_buffer
, 0);
3488 extern void unlock_all_files (void);
3489 extern void lock_file (Lisp_Object
);
3490 extern void unlock_file (Lisp_Object
);
3491 extern void unlock_buffer (struct buffer
*);
3492 extern void syms_of_filelock (void);
3493 extern void init_filelock (void);
3495 /* Defined in sound.c */
3496 extern void syms_of_sound (void);
3497 extern void init_sound (void);
3499 /* Defined in category.c */
3500 extern void init_category_once (void);
3501 extern Lisp_Object
char_category_set (int);
3502 extern void syms_of_category (void);
3504 /* Defined in ccl.c */
3505 extern void syms_of_ccl (void);
3507 /* Defined in dired.c */
3508 extern void syms_of_dired (void);
3509 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3510 Lisp_Object
, Lisp_Object
,
3513 /* Defined in term.c */
3514 extern int *char_ins_del_vector
;
3515 extern void mark_ttys (void);
3516 extern void syms_of_term (void);
3517 extern void fatal (const char *msgid
, ...)
3518 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
3520 /* Defined in terminal.c */
3521 EXFUN (Fframe_terminal
, 1);
3522 EXFUN (Fdelete_terminal
, 2);
3523 extern void syms_of_terminal (void);
3525 /* Defined in font.c */
3526 extern void syms_of_font (void);
3527 extern void init_font (void);
3529 #ifdef HAVE_WINDOW_SYSTEM
3530 /* Defined in fontset.c */
3531 extern void syms_of_fontset (void);
3533 /* Defined in xfns.c, w32fns.c, or macfns.c */
3534 extern Lisp_Object Qfont_param
;
3535 EXFUN (Fxw_display_color_p
, 1);
3536 EXFUN (Fx_focus_frame
, 1);
3539 /* Defined in xfaces.c */
3540 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3541 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3542 extern Lisp_Object Qmode_line_inactive
;
3543 extern Lisp_Object Qface
;
3544 extern Lisp_Object Qnormal
;
3545 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3546 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3547 extern Lisp_Object Vface_alternative_font_family_alist
;
3548 extern Lisp_Object Vface_alternative_font_registry_alist
;
3549 EXFUN (Fclear_face_cache
, 1);
3550 EXFUN (Fx_load_color_file
, 1);
3551 extern void syms_of_xfaces (void);
3553 #ifdef HAVE_X_WINDOWS
3554 /* Defined in xfns.c */
3555 extern void syms_of_xfns (void);
3557 /* Defined in xsmfns.c */
3558 extern void syms_of_xsmfns (void);
3560 /* Defined in xselect.c */
3561 extern void syms_of_xselect (void);
3563 /* Defined in xterm.c */
3564 extern void syms_of_xterm (void);
3565 #endif /* HAVE_X_WINDOWS */
3567 #ifdef HAVE_WINDOW_SYSTEM
3568 /* Defined in xterm.c, nsterm.m, w32term.c */
3569 extern char *x_get_keysym_name (int);
3570 #endif /* HAVE_WINDOW_SYSTEM */
3573 /* Defined in msdos.c */
3574 EXFUN (Fmsdos_downcase_filename
, 1);
3578 /* Defined in xml.c */
3579 extern void syms_of_xml (void);
3583 /* Defined in (x|w32)fns.c, nsfns.m... */
3584 extern int have_menus_p (void);
3588 /* Defined in dbusbind.c */
3589 void syms_of_dbusbind (void);
3593 /* Defined in msdos.c, w32.c */
3594 extern char *emacs_root_dir (void);
3597 /* Nonzero means Emacs has already been initialized.
3598 Used during startup to detect startup of dumped Emacs. */
3599 extern int initialized
;
3601 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3603 extern POINTER_TYPE
*xmalloc (size_t);
3604 extern POINTER_TYPE
*xrealloc (POINTER_TYPE
*, size_t);
3605 extern void xfree (POINTER_TYPE
*);
3606 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3607 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3608 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3610 extern char *xstrdup (const char *);
3612 extern char *egetenv (const char *);
3614 /* Set up the name of the machine we're running on. */
3615 extern void init_system_name (void);
3617 /* Some systems (e.g., NT) use a different path separator than Unix,
3618 in addition to a device separator. Set the path separator
3619 to '/', and don't test for a device separator in IS_ANY_SEP. */
3621 #define DIRECTORY_SEP '/'
3622 #ifndef IS_DIRECTORY_SEP
3623 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3625 #ifndef IS_DEVICE_SEP
3627 #define IS_DEVICE_SEP(_c_) 0
3629 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3633 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3636 #define SWITCH_ENUM_CAST(x) (x)
3638 /* Use this to suppress gcc's warnings. */
3641 /* Use CODE only if lint checking is in effect. */
3642 # define IF_LINT(Code) Code
3644 /* Assume that the expression COND is true. This differs in intent
3645 from 'assert', as it is a message from the programmer to the compiler. */
3646 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3649 # define IF_LINT(Code) /* empty */
3650 # define lint_assume(cond) ((void) (0 && (cond)))
3653 /* The ubiquitous min and max macros. */
3659 #define min(a, b) ((a) < (b) ? (a) : (b))
3660 #define max(a, b) ((a) > (b) ? (a) : (b))
3662 /* We used to use `abs', but that clashes with system headers on some
3663 platforms, and using a name reserved by Standard C is a bad idea
3666 #define eabs(x) ((x) < 0 ? -(x) : (x))
3669 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3672 #define make_fixnum_or_float(val) \
3673 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3676 /* Checks the `cycle check' variable CHECK to see if it indicates that
3677 EL is part of a cycle; CHECK must be either Qnil or a value returned
3678 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3679 elements after which a cycle might be suspected; after that many
3680 elements, this macro begins consing in order to keep more precise
3683 Returns nil if a cycle was detected, otherwise a new value for CHECK
3686 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3687 the caller should make sure that's ok. */
3689 #define CYCLE_CHECK(check, el, suspicious) \
3692 : (INTEGERP (check) \
3693 ? (XFASTINT (check) < (suspicious) \
3694 ? make_number (XFASTINT (check) + 1) \
3695 : Fcons (el, Qnil)) \
3696 : (!NILP (Fmemq ((el), (check))) \
3698 : Fcons ((el), (check)))))
3701 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3702 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3704 #define MAX_ALLOCA 16*1024
3706 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3708 #define USE_SAFE_ALLOCA \
3709 ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0
3711 /* SAFE_ALLOCA allocates a simple buffer. */
3713 #define SAFE_ALLOCA(buf, type, size) \
3715 if ((size) < MAX_ALLOCA) \
3716 buf = (type) alloca (size); \
3719 buf = (type) xmalloc (size); \
3721 record_unwind_protect (safe_alloca_unwind, \
3722 make_save_value (buf, 0)); \
3726 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3727 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3728 positive. The code is tuned for MULTIPLIER being a constant. */
3730 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3732 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3733 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3736 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3738 record_unwind_protect (safe_alloca_unwind, \
3739 make_save_value (buf, 0)); \
3743 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3745 #define SAFE_FREE() \
3747 if (sa_must_free) { \
3749 unbind_to (sa_count, Qnil); \
3754 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3756 #define SAFE_ALLOCA_LISP(buf, nelt) \
3758 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3759 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3760 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3763 buf = (Lisp_Object *) xmalloc ((nelt) * sizeof (Lisp_Object)); \
3764 arg_ = make_save_value (buf, nelt); \
3765 XSAVE_VALUE (arg_)->dogc = 1; \
3767 record_unwind_protect (safe_alloca_unwind, arg_); \
3770 memory_full (SIZE_MAX); \
3774 #include "globals.h"
3776 #endif /* EMACS_LISP_H */