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/>. */
27 /* Use the configure flag --enable-checking[=LIST] to enable various
28 types of run time checks for Lisp objects. */
30 #ifdef GC_CHECK_CONS_LIST
31 extern void check_cons_list (void);
32 #define CHECK_CONS_LIST() check_cons_list ()
34 #define CHECK_CONS_LIST() ((void) 0)
37 /* Temporarily disable wider-than-pointer integers until they're tested more.
38 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
39 /* #undef WIDE_EMACS_INT */
41 /* These are default choices for the types to use. */
43 # if BITS_PER_LONG < BITS_PER_LONG_LONG && defined WIDE_EMACS_INT
44 # define EMACS_INT long long
45 # define BITS_PER_EMACS_INT BITS_PER_LONG_LONG
47 # elif BITS_PER_INT < BITS_PER_LONG
48 # define EMACS_INT long
49 # define BITS_PER_EMACS_INT BITS_PER_LONG
52 # define EMACS_INT int
53 # define BITS_PER_EMACS_INT BITS_PER_INT
58 # define EMACS_UINT unsigned EMACS_INT
61 /* Extra internal type checking? */
63 #ifdef ENABLE_CHECKING
65 extern void die (const char *, const char *, int) NO_RETURN
;
67 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
68 it to 1 using a debugger to temporarily disable aborting on
69 detected internal inconsistencies or error conditions.
71 Testing suppress_checking after the supplied condition ensures that
72 the side effects produced by CHECK will be consistent, independent
73 of whether ENABLE_CHECKING is defined, or whether the checks are
74 suppressed at run time.
76 In some cases, a good compiler may be able to optimize away the
77 CHECK macro altogether, e.g., if XSTRING (x) uses CHECK to test
78 STRINGP (x), but a particular use of XSTRING is invoked only after
79 testing that STRINGP (x) is true, making the test redundant. */
81 extern int suppress_checking EXTERNALLY_VISIBLE
;
83 #define CHECK(check,msg) (((check) || suppress_checking \
85 : die ((msg), __FILE__, __LINE__)), \
89 /* Produce same side effects and result, but don't complain. */
90 #define CHECK(check,msg) ((check),0)
94 /* Define an Emacs version of "assert", since some system ones are
96 #ifndef ENABLE_CHECKING
97 #define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
98 #else /* ENABLE_CHECKING */
99 #if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
100 #define eassert(cond) CHECK(cond,"assertion failed: " #cond)
102 #define eassert(cond) CHECK(cond,"assertion failed")
104 #endif /* ENABLE_CHECKING */
106 /* Use the configure flag --enable-use-lisp-union-type to make
107 Lisp_Object use a union type instead of the default int. The flag
108 causes USE_LISP_UNION_TYPE to be defined. */
110 /***** Select the tagging scheme. *****/
111 /* There are basically two options that control the tagging scheme:
112 - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
114 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
115 always 0, and we can thus use them to hold tag bits, without
116 restricting our addressing space.
118 If USE_LSB_TAG is not set, then we use the top 3 bits for tagging, thus
119 restricting our possible address range. Currently USE_LSB_TAG is not
120 allowed together with a union. This is not due to any fundamental
121 technical (or political ;-) problem: nobody wrote the code to do it yet.
123 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
124 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
125 on the few static Lisp_Objects used: all the defsubr as well
126 as the two special buffers buffer_defaults and buffer_local_symbols. */
128 /* First, try and define DECL_ALIGN(type,var) which declares a static
129 variable VAR of type TYPE with the added requirement that it be
131 #ifndef NO_DECL_ALIGN
133 # if HAVE_ATTRIBUTE_ALIGNED
134 # define DECL_ALIGN(type, var) \
135 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
137 /* What directives do other compilers use? */
142 /* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8. */
143 #if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
144 || defined DARWIN_OS || defined __sun)
145 /* We also need to be able to specify mult-of-8 alignment on static vars. */
146 # if defined DECL_ALIGN
151 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
154 # error "USE_LSB_TAG used without defining DECL_ALIGN"
156 # define DECL_ALIGN(type, var) type var
160 /* Define the fundamental Lisp data structures. */
162 /* If USE_2_TAGBITS_FOR_INTS is defined, then Lisp integers use
163 2 tags, to give them one extra bit, thus extending their range from
164 e.g -2^28..2^28-1 to -2^29..2^29-1. */
165 #define USE_2_TAGS_FOR_INTS
167 /* Making it work for the union case is too much trouble. */
168 #ifdef USE_LISP_UNION_TYPE
169 # undef USE_2_TAGS_FOR_INTS
172 /* This is the set of Lisp data types. */
174 #if !defined USE_2_TAGS_FOR_INTS
175 # define LISP_INT_TAG Lisp_Int
176 # define case_Lisp_Int case Lisp_Int
177 # define LISP_STRING_TAG 4
178 # define LISP_INT_TAG_P(x) ((x) == Lisp_Int)
180 # define LISP_INT_TAG Lisp_Int0
181 # define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
183 # define LISP_INT1_TAG 4
184 # define LISP_STRING_TAG 1
185 # define LISP_INT_TAG_P(x) (((x) & 3) == 0)
187 # define LISP_INT1_TAG 1
188 # define LISP_STRING_TAG 4
189 # define LISP_INT_TAG_P(x) (((x) & 6) == 0)
195 /* Integer. XINT (obj) is the integer value. */
196 #ifdef USE_2_TAGS_FOR_INTS
198 Lisp_Int1
= LISP_INT1_TAG
,
203 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
206 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
207 whose first member indicates the subtype. */
210 /* String. XSTRING (object) points to a struct Lisp_String.
211 The length of the string, and its contents, are stored therein. */
212 Lisp_String
= LISP_STRING_TAG
,
214 /* Vector of Lisp objects, or something resembling it.
215 XVECTOR (object) points to a struct Lisp_Vector, which contains
216 the size and contents. The size field also contains the type
217 information, if it's not a real vector object. */
220 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
226 /* This is the set of data types that share a common structure.
227 The first member of the structure is a type code from this set.
228 The enum values are arbitrary, but we'll use large numbers to make it
229 more likely that we'll spot the error if a random word in memory is
230 mistakenly interpreted as a Lisp_Misc. */
233 Lisp_Misc_Free
= 0x5eab,
236 Lisp_Misc_Save_Value
,
237 /* Currently floats are not a misc type,
238 but let's define this in case we want to change that. */
240 /* This is not a type code. It is for range checking. */
244 /* These are the types of forwarding objects used in the value slot
245 of symbols for special built-in variables whose value is stored in
249 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
250 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
251 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
252 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
253 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
260 /* These values are overridden by the m- file on some machines. */
262 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
265 #ifdef USE_LISP_UNION_TYPE
267 #ifndef WORDS_BIGENDIAN
269 /* Definition of Lisp_Object for little-endian machines. */
274 /* Used for comparing two Lisp_Objects;
275 also, positive integers can be accessed fast this way. */
280 /* Use explict signed, the signedness of a bit-field of type
281 int is implementation defined. */
282 signed EMACS_INT val
: VALBITS
;
283 enum Lisp_Type type
: GCTYPEBITS
;
287 EMACS_UINT val
: VALBITS
;
288 enum Lisp_Type type
: GCTYPEBITS
;
293 #else /* If WORDS_BIGENDIAN */
298 /* Used for comparing two Lisp_Objects;
299 also, positive integers can be accessed fast this way. */
304 enum Lisp_Type type
: GCTYPEBITS
;
305 /* Use explict signed, the signedness of a bit-field of type
306 int is implementation defined. */
307 signed EMACS_INT val
: VALBITS
;
311 enum Lisp_Type type
: GCTYPEBITS
;
312 EMACS_UINT val
: VALBITS
;
317 #endif /* WORDS_BIGENDIAN */
320 static inline Lisp_Object
321 LISP_MAKE_RVALUE (Lisp_Object o
)
326 /* This is more portable to pre-C99 non-GCC compilers, but for
327 backwards compatibility GCC still accepts an old GNU extension
328 which caused this to only generate a warning. */
329 #define LISP_MAKE_RVALUE(o) (0 ? (o) : (o))
332 #else /* USE_LISP_UNION_TYPE */
334 /* If union type is not wanted, define Lisp_Object as just a number. */
336 typedef EMACS_INT Lisp_Object
;
337 #define LISP_MAKE_RVALUE(o) (0+(o))
338 #endif /* USE_LISP_UNION_TYPE */
340 /* In the size word of a vector, this bit means the vector has been marked.
341 (Shift -1 left, not 1, to avoid provoking overflow diagnostics.) */
343 #define ARRAY_MARK_FLAG ((EMACS_INT) -1 << (BITS_PER_EMACS_INT - 1))
345 /* In the size word of a struct Lisp_Vector, this bit means it's really
346 some other vector-like object. */
347 #define PSEUDOVECTOR_FLAG ((EMACS_INT) 1 << (BITS_PER_EMACS_INT - 2))
349 /* In a pseudovector, the size field actually contains a word with one
350 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
351 indicate the actual type.
352 We use a bitset, even tho only one of the bits can be set at any
353 particular time just so as to be able to use micro-optimizations such as
354 testing membership of a particular subset of pseudovectors in Fequal.
355 It is not crucial, but there are plenty of bits here, so why not do it? */
358 PVEC_NORMAL_VECTOR
= 0,
359 PVEC_PROCESS
= 0x200,
361 PVEC_COMPILED
= 0x800,
362 PVEC_WINDOW
= 0x1000,
363 PVEC_WINDOW_CONFIGURATION
= 0x2000,
365 PVEC_CHAR_TABLE
= 0x8000,
366 PVEC_BOOL_VECTOR
= 0x10000,
367 PVEC_BUFFER
= 0x20000,
368 PVEC_HASH_TABLE
= 0x40000,
369 PVEC_TERMINAL
= 0x80000,
370 PVEC_SUB_CHAR_TABLE
= 0x100000,
371 PVEC_FONT
= 0x200000,
372 PVEC_OTHER
= 0x400000,
373 PVEC_TYPE_MASK
= 0x7ffe00
375 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
376 GDB. It doesn't work on OS Alpha. Moved to a variable in
378 PVEC_FLAG
= PSEUDOVECTOR_FLAG
382 /* For convenience, we also store the number of elements in these bits.
383 Note that this size is not necessarily the memory-footprint size, but
384 only the number of Lisp_Object fields (that need to be traced by the GC).
385 The distinction is used e.g. by Lisp_Process which places extra
386 non-Lisp_Object fields at the end of the structure. */
387 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
389 /* Number of bits to put in each character in the internal representation
390 of bool vectors. This should not vary across implementations. */
391 #define BOOL_VECTOR_BITS_PER_CHAR 8
393 /* These macros extract various sorts of values from a Lisp_Object.
394 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
395 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
397 #ifndef USE_LISP_UNION_TYPE
399 /* Return a perfect hash of the Lisp_Object representation. */
404 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
405 #define XTYPE(a) ((enum Lisp_Type) ((a) & TYPEMASK))
406 #ifdef USE_2_TAGS_FOR_INTS
407 # define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
408 # define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
409 # define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
411 # define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
412 # define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
413 # define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
415 #define XSET(var, type, ptr) \
416 (eassert (XTYPE ((intptr_t) (ptr)) == 0), /* Check alignment. */ \
417 (var) = (type) | (intptr_t) (ptr))
419 #define XPNTR(a) ((intptr_t) ((a) & ~TYPEMASK))
421 #else /* not USE_LSB_TAG */
423 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
425 /* One need to override this if there must be high bits set in data space
426 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
427 on all machines, but would penalize machines which don't need it)
429 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
431 /* For integers known to be positive, XFASTINT provides fast retrieval
432 and XSETFASTINT provides fast storage. This takes advantage of the
433 fact that Lisp_Int is 0. */
434 #define XFASTINT(a) ((a) + 0)
435 #define XSETFASTINT(a, b) ((a) = (b))
437 /* Extract the value of a Lisp_Object as a (un)signed integer. */
439 #ifdef USE_2_TAGS_FOR_INTS
440 # define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
441 # define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
442 # define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
444 # define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
445 >> (BITS_PER_EMACS_INT - VALBITS))
446 # define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
447 # define make_number(N) \
448 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
451 #define XSET(var, type, ptr) \
452 ((var) = ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
453 + ((intptr_t) (ptr) & VALMASK)))
456 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
457 which were stored in a Lisp_Object */
458 #define XPNTR(a) ((uintptr_t) (((a) & VALMASK)) | DATA_SEG_BITS))
460 #define XPNTR(a) ((uintptr_t) ((a) & VALMASK))
463 #endif /* not USE_LSB_TAG */
465 #else /* USE_LISP_UNION_TYPE */
467 #ifdef USE_2_TAGS_FOR_INTS
468 # error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
471 #define XHASH(a) ((a).i)
472 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
473 #define XINT(a) ((EMACS_INT) (a).s.val)
474 #define XUINT(a) ((EMACS_UINT) (a).u.val)
478 # define XSET(var, vartype, ptr) \
479 (eassert ((((EMACS_UINT) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0), \
480 (var).u.val = ((EMACS_UINT) (ptr)) >> GCTYPEBITS, \
481 (var).u.type = ((char) (vartype)))
483 /* Some versions of gcc seem to consider the bitfield width when issuing
484 the "cast to pointer from integer of different size" warning, so the
485 cast is here to widen the value back to its natural size. */
486 # define XPNTR(v) ((intptr_t) (v).s.val << GCTYPEBITS)
488 #else /* !USE_LSB_TAG */
490 /* For integers known to be positive, XFASTINT provides fast retrieval
491 and XSETFASTINT provides fast storage. This takes advantage of the
492 fact that Lisp_Int is 0. */
493 # define XFASTINT(a) ((a).i + 0)
494 # define XSETFASTINT(a, b) ((a).i = (b))
496 # define XSET(var, vartype, ptr) \
497 (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
500 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
501 which were stored in a Lisp_Object */
502 #define XPNTR(a) ((intptr_t) (XUINT (a) | DATA_SEG_BITS))
504 #define XPNTR(a) ((intptr_t) XUINT (a))
507 #endif /* !USE_LSB_TAG */
509 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
510 #define make_number(N) \
511 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
513 extern Lisp_Object
make_number (EMACS_INT
);
516 #endif /* USE_LISP_UNION_TYPE */
518 /* For integers known to be positive, XFASTINT sometimes provides
519 faster retrieval and XSETFASTINT provides faster storage.
520 If not, fallback on the non-accelerated path. */
522 # define XFASTINT(a) (XINT (a))
523 # define XSETFASTINT(a, b) (XSETINT (a, b))
526 #define EQ(x, y) (XHASH (x) == XHASH (y))
528 /* Number of bits in a fixnum, including the sign bit. */
529 #ifdef USE_2_TAGS_FOR_INTS
530 # define FIXNUM_BITS (VALBITS + 1)
532 # define FIXNUM_BITS VALBITS
535 /* Mask indicating the significant bits of a fixnum. */
536 #define INTMASK (((EMACS_INT) 1 << FIXNUM_BITS) - 1)
538 /* Largest and smallest representable fixnum values. These are the C
540 #define MOST_POSITIVE_FIXNUM (INTMASK / 2)
541 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
543 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
544 written this way so that it also works if I is of unsigned
545 type or if I is a NaN. */
547 #define FIXNUM_OVERFLOW_P(i) \
548 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
550 /* Extract a value or address from a Lisp_Object. */
552 #define XCONS(a) (eassert (CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
553 #define XVECTOR(a) (eassert (VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
554 #define XSTRING(a) (eassert (STRINGP(a)),(struct Lisp_String *) XPNTR(a))
555 #define XSYMBOL(a) (eassert (SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
556 #define XFLOAT(a) (eassert (FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
560 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
561 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC(a)->u_any))
562 #define XMISCTYPE(a) (XMISCANY (a)->type)
563 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC(a)->u_marker))
564 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
565 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
567 /* Forwarding object types. */
569 #define XFWDTYPE(a) (a->u_intfwd.type)
570 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
571 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
572 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
573 #define XBUFFER_OBJFWD(a) \
574 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
575 #define XKBOARD_OBJFWD(a) \
576 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
578 /* Pseudovector types. */
580 #define XPROCESS(a) (eassert (PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
581 #define XWINDOW(a) (eassert (WINDOWP(a)),(struct window *) XPNTR(a))
582 #define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
583 #define XSUBR(a) (eassert (SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
584 #define XBUFFER(a) (eassert (BUFFERP(a)),(struct buffer *) XPNTR(a))
585 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
586 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR(a))
587 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
589 /* Construct a Lisp_Object from a value or address. */
591 #define XSETINT(a, b) (a) = make_number (b)
592 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
593 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
594 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
595 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
596 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
600 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
601 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
603 /* Pseudovector types. */
605 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE(v, header.size, code)
606 #define XSETTYPED_PVECTYPE(v, size_member, code) \
607 ((v)->size_member |= PSEUDOVECTOR_FLAG | (code))
608 #define XSETPVECTYPESIZE(v, code, sizeval) \
609 ((v)->header.size = PSEUDOVECTOR_FLAG | (code) | (sizeval))
611 /* The cast to struct vectorlike_header * avoids aliasing issues. */
612 #define XSETPSEUDOVECTOR(a, b, code) \
613 XSETTYPED_PSEUDOVECTOR(a, b, \
614 ((struct vectorlike_header *) XPNTR (a))->size, \
616 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
617 (XSETVECTOR (a, b), \
618 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
619 == (PSEUDOVECTOR_FLAG | (code))))
621 #define XSETWINDOW_CONFIGURATION(a, b) \
622 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
623 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
624 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
625 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
626 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
627 #define XSETSUBR(a, b) \
628 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
629 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
630 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
631 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
632 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
633 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
635 /* Convenience macros for dealing with Lisp arrays. */
637 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
638 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
639 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
640 #define ASET(ARRAY, IDX, VAL) \
641 (eassert ((IDX) == (IDX)), \
642 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
643 AREF ((ARRAY), (IDX)) = (VAL))
645 /* Convenience macros for dealing with Lisp strings. */
647 #define SDATA(string) (XSTRING (string)->data + 0)
648 #define SREF(string, index) (SDATA (string)[index] + 0)
649 #define SSET(string, index, new) (SDATA (string)[index] = (new))
650 #define SCHARS(string) (XSTRING (string)->size + 0)
651 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
653 /* Avoid "differ in sign" warnings. */
654 #define SSDATA(x) ((char *) SDATA (x))
656 #define STRING_SET_CHARS(string, newsize) \
657 (XSTRING (string)->size = (newsize))
659 #define STRING_COPYIN(string, index, new, count) \
660 memcpy (SDATA (string) + index, new, count)
664 #define CHECK_TYPE(ok, Qxxxp, x) \
665 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
669 /* See the macros in intervals.h. */
671 typedef struct interval
*INTERVAL
;
673 /* Complain if object is not string or buffer type */
674 #define CHECK_STRING_OR_BUFFER(x) \
675 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
678 /* In a cons, the markbit of the car is the gc mark bit */
682 /* Please do not use the names of these elements in code other
683 than the core lisp implementation. Use XCAR and XCDR below. */
684 #ifdef HIDE_LISP_IMPLEMENTATION
689 struct Lisp_Cons
*chain
;
696 struct Lisp_Cons
*chain
;
701 /* Take the car or cdr of something known to be a cons cell. */
702 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
703 of code that has to know what a cons cell looks like. Other code not
704 part of the basic lisp implementation should assume that the car and cdr
705 fields are not accessible as lvalues. (What if we want to switch to
706 a copying collector someday? Cached cons cell field addresses may be
707 invalidated at arbitrary points.) */
708 #ifdef HIDE_LISP_IMPLEMENTATION
709 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
710 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
712 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
713 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
716 /* Use these from normal code. */
717 #define XCAR(c) LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
718 #define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))
720 /* Use these to set the fields of a cons cell.
722 Note that both arguments may refer to the same object, so 'n'
723 should not be read after 'c' is first modified. Also, neither
724 argument should be evaluated more than once; side effects are
725 especially common in the second argument. */
726 #define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
727 #define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))
729 /* Take the car or cdr of something whose type is not known. */
731 (CONSP ((c)) ? XCAR ((c)) \
732 : NILP ((c)) ? Qnil \
733 : wrong_type_argument (Qlistp, (c)))
736 (CONSP ((c)) ? XCDR ((c)) \
737 : NILP ((c)) ? Qnil \
738 : wrong_type_argument (Qlistp, (c)))
740 /* Take the car or cdr of something whose type is not known. */
741 #define CAR_SAFE(c) \
742 (CONSP ((c)) ? XCAR ((c)) : Qnil)
744 #define CDR_SAFE(c) \
745 (CONSP ((c)) ? XCDR ((c)) : Qnil)
747 /* Nonzero if STR is a multibyte string. */
748 #define STRING_MULTIBYTE(STR) \
749 (XSTRING (STR)->size_byte >= 0)
751 /* Return the length in bytes of STR. */
753 #ifdef GC_CHECK_STRING_BYTES
756 extern EMACS_INT
string_bytes (struct Lisp_String
*);
757 #define STRING_BYTES(S) string_bytes ((S))
759 #else /* not GC_CHECK_STRING_BYTES */
761 #define STRING_BYTES(STR) \
762 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
764 #endif /* not GC_CHECK_STRING_BYTES */
766 /* Mark STR as a unibyte string. */
767 #define STRING_SET_UNIBYTE(STR) \
768 do { if (EQ (STR, empty_multibyte_string)) \
769 (STR) = empty_unibyte_string; \
770 else XSTRING (STR)->size_byte = -1; } while (0)
772 /* Mark STR as a multibyte string. Assure that STR contains only
773 ASCII characters in advance. */
774 #define STRING_SET_MULTIBYTE(STR) \
775 do { if (EQ (STR, empty_unibyte_string)) \
776 (STR) = empty_multibyte_string; \
777 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
779 /* Get text properties. */
780 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
782 /* Set text properties. */
783 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
785 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
791 INTERVAL intervals
; /* text properties in this string */
795 /* Header of vector-like objects. This documents the layout constraints on
796 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
797 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
798 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
799 because when two such pointers potentially alias, a compiler won't
800 incorrectly reorder loads and stores to their size fields. See
801 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
802 struct vectorlike_header
806 /* Pointer to the next vector-like object. It is generally a buffer or a
807 Lisp_Vector alias, so for convenience it is a union instead of a
808 pointer: this way, one can write P->next.vector instead of ((struct
809 Lisp_Vector *) P->next). */
811 struct buffer
*buffer
;
812 struct Lisp_Vector
*vector
;
818 struct vectorlike_header header
;
819 Lisp_Object contents
[1];
822 /* If a struct is made to look like a vector, this macro returns the length
823 of the shortest vector that would hold that struct. */
824 #define VECSIZE(type) ((sizeof (type) \
825 - offsetof (struct Lisp_Vector, contents[0]) \
826 + sizeof(Lisp_Object) - 1) /* round up */ \
827 / sizeof (Lisp_Object))
829 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
830 at the end and we need to compute the number of Lisp_Object fields (the
831 ones that the GC needs to trace). */
832 #define PSEUDOVECSIZE(type, nonlispfield) \
833 ((offsetof(type, nonlispfield) - offsetof(struct Lisp_Vector, contents[0])) \
834 / sizeof (Lisp_Object))
836 /* A char-table is a kind of vectorlike, with contents are like a
837 vector but with a few other slots. For some purposes, it makes
838 sense to handle a char-table with type struct Lisp_Vector. An
839 element of a char table can be any Lisp objects, but if it is a sub
840 char-table, we treat it a table that contains information of a
841 specific range of characters. A sub char-table has the same
842 structure as a vector. A sub char table appears only in an element
843 of a char-table, and there's no way to access it directly from
844 Emacs Lisp program. */
846 /* This is the number of slots that every char table must have. This
847 counts the ordinary slots and the top, defalt, parent, and purpose
849 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
851 /* Return the number of "extra" slots in the char table CT. */
853 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
854 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
858 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
859 ({struct Lisp_Char_Table *_tbl = NULL; \
862 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
863 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
864 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
866 _val = _tbl->defalt; \
867 } while (NILP (_val) && ! NILP (_tbl->parent)); \
870 #else /* not __GNUC__ */
872 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
873 (! NILP (XCHAR_TABLE (CT)->ascii) \
874 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
875 ? XCHAR_TABLE (CT)->ascii \
876 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
877 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
878 : char_table_ref ((CT), (IDX))) \
879 : char_table_ref ((CT), (IDX)))
881 #endif /* not __GNUC__ */
883 /* Nonzero iff C is an ASCII character. */
884 #define ASCII_CHAR_P(c) ((unsigned) (c) < 0x80)
886 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
887 characters. Do not check validity of CT. */
888 #define CHAR_TABLE_REF(CT, IDX) \
889 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
890 : char_table_ref ((CT), (IDX)))
892 /* Almost equivalent to Faref (CT, IDX). However, if the result is
893 not a character, return IDX.
895 For these characters, do not check validity of CT
896 and do not follow parent. */
897 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
898 char_table_translate (CT, IDX)
900 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
901 8-bit European characters. Do not check validity of CT. */
902 #define CHAR_TABLE_SET(CT, IDX, VAL) \
903 (((IDX) >= 0 && ASCII_CHAR_P (IDX) \
904 && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)) \
905 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
906 : char_table_set (CT, IDX, VAL))
908 #define CHARTAB_SIZE_BITS_0 6
909 #define CHARTAB_SIZE_BITS_1 4
910 #define CHARTAB_SIZE_BITS_2 5
911 #define CHARTAB_SIZE_BITS_3 7
913 extern const int chartab_size
[4];
915 struct Lisp_Sub_Char_Table
;
917 struct Lisp_Char_Table
919 /* HEADER.SIZE is the vector's size field, which also holds the
920 pseudovector type information. It holds the size, too.
921 The size counts the defalt, parent, purpose, ascii,
922 contents, and extras slots. */
923 struct vectorlike_header header
;
925 /* This holds a default value,
926 which is used whenever the value for a specific character is nil. */
929 /* This points to another char table, which we inherit from when the
930 value for a specific character is nil. The `defalt' slot takes
931 precedence over this. */
934 /* This is a symbol which says what kind of use this char-table is
938 /* The bottom sub char-table for characters of the range 0..127. It
939 is nil if none of ASCII character has a specific value. */
942 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
944 /* These hold additional data. It is a vector. */
945 Lisp_Object extras
[1];
948 struct Lisp_Sub_Char_Table
950 /* HEADER.SIZE is the vector's size field, which also holds the
951 pseudovector type information. It holds the size, too. */
952 struct vectorlike_header header
;
954 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
955 char-table of depth 1 contains 16 elements, and each element
956 covers 4096 (128*32) characters. A sub char-table of depth 2
957 contains 32 elements, and each element covers 128 characters. A
958 sub char-table of depth 3 contains 128 elements, and each element
959 is for one character. */
962 /* Minimum character covered by the sub char-table. */
963 Lisp_Object min_char
;
965 Lisp_Object contents
[1];
968 /* A boolvector is a kind of vectorlike, with contents are like a string. */
969 struct Lisp_Bool_Vector
971 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
972 just the subtype information. */
973 struct vectorlike_header header
;
974 /* This is the size in bits. */
976 /* This contains the actual bits, packed into bytes. */
977 unsigned char data
[1];
980 /* This structure describes a built-in function.
981 It is generated by the DEFUN macro only.
982 defsubr makes it into a Lisp object.
984 This type is treated in most respects as a pseudovector,
985 but since we never dynamically allocate or free them,
986 we don't need a struct vectorlike_header and its 'next' field. */
992 Lisp_Object (*a0
) (void);
993 Lisp_Object (*a1
) (Lisp_Object
);
994 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
995 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
996 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
997 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
998 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
999 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1000 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1001 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1002 Lisp_Object (*aMANY
) (size_t, Lisp_Object
*);
1004 short min_args
, max_args
;
1005 const char *symbol_name
;
1006 const char *intspec
;
1011 /***********************************************************************
1013 ***********************************************************************/
1015 /* Interned state of a symbol. */
1017 enum symbol_interned
1019 SYMBOL_UNINTERNED
= 0,
1020 SYMBOL_INTERNED
= 1,
1021 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1024 enum symbol_redirect
1026 SYMBOL_PLAINVAL
= 4,
1027 SYMBOL_VARALIAS
= 1,
1028 SYMBOL_LOCALIZED
= 2,
1029 SYMBOL_FORWARDED
= 3
1032 /* In a symbol, the markbit of the plist is used as the gc mark bit */
1036 unsigned gcmarkbit
: 1;
1038 /* Indicates where the value can be found:
1039 0 : it's a plain var, the value is in the `value' field.
1040 1 : it's a varalias, the value is really in the `alias' symbol.
1041 2 : it's a localized var, the value is in the `blv' object.
1042 3 : it's a forwarding variable, the value is in `forward'.
1044 enum symbol_redirect redirect
: 3;
1046 /* Non-zero means symbol is constant, i.e. changing its value
1047 should signal an error. If the value is 3, then the var
1048 can be changed, but only by `defconst'. */
1049 unsigned constant
: 2;
1051 /* Interned state of the symbol. This is an enumerator from
1052 enum symbol_interned. */
1053 unsigned interned
: 2;
1055 /* Non-zero means that this variable has been explicitly declared
1056 special (with `defvar' etc), and shouldn't be lexically bound. */
1057 unsigned declared_special
: 1;
1059 /* The symbol's name, as a Lisp string.
1061 The name "xname" is used to intentionally break code referring to
1062 the old field "name" of type pointer to struct Lisp_String. */
1065 /* Value of the symbol or Qunbound if unbound. If this symbol is a
1066 defvaralias, `alias' contains the symbol for which it is an
1067 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
1068 and set a symbol's value, to take defvaralias into account. */
1071 struct Lisp_Symbol
*alias
;
1072 struct Lisp_Buffer_Local_Value
*blv
;
1073 union Lisp_Fwd
*fwd
;
1076 /* Function value of the symbol or Qunbound if not fboundp. */
1077 Lisp_Object function
;
1079 /* The symbol's property list. */
1082 /* Next symbol in obarray bucket, if the symbol is interned. */
1083 struct Lisp_Symbol
*next
;
1086 /* Value is name of symbol. */
1088 #define SYMBOL_VAL(sym) \
1089 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1090 #define SYMBOL_ALIAS(sym) \
1091 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1092 #define SYMBOL_BLV(sym) \
1093 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1094 #define SYMBOL_FWD(sym) \
1095 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1096 #define SET_SYMBOL_VAL(sym, v) \
1097 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1098 #define SET_SYMBOL_ALIAS(sym, v) \
1099 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1100 #define SET_SYMBOL_BLV(sym, v) \
1101 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1102 #define SET_SYMBOL_FWD(sym, v) \
1103 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1105 #define SYMBOL_NAME(sym) \
1106 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1108 /* Value is non-zero if SYM is an interned symbol. */
1110 #define SYMBOL_INTERNED_P(sym) \
1111 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1113 /* Value is non-zero if SYM is interned in initial_obarray. */
1115 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1116 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1118 /* Value is non-zero if symbol is considered a constant, i.e. its
1119 value cannot be changed (there is an exception for keyword symbols,
1120 whose value can be set to the keyword symbol itself). */
1122 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1125 /***********************************************************************
1127 ***********************************************************************/
1129 /* The structure of a Lisp hash table. */
1131 struct Lisp_Hash_Table
1133 /* This is for Lisp; the hash table code does not refer to it. */
1134 struct vectorlike_header header
;
1136 /* Function used to compare keys. */
1139 /* Nil if table is non-weak. Otherwise a symbol describing the
1140 weakness of the table. */
1143 /* When the table is resized, and this is an integer, compute the
1144 new size by adding this to the old size. If a float, compute the
1145 new size by multiplying the old size with this factor. */
1146 Lisp_Object rehash_size
;
1148 /* Resize hash table when number of entries/ table size is >= this
1150 Lisp_Object rehash_threshold
;
1152 /* Vector of hash codes.. If hash[I] is nil, this means that that
1153 entry I is unused. */
1156 /* Vector used to chain entries. If entry I is free, next[I] is the
1157 entry number of the next free item. If entry I is non-free,
1158 next[I] is the index of the next entry in the collision chain. */
1161 /* Index of first free entry in free list. */
1162 Lisp_Object next_free
;
1164 /* Bucket vector. A non-nil entry is the index of the first item in
1165 a collision chain. This vector's size can be larger than the
1166 hash table size to reduce collisions. */
1169 /* User-supplied hash function, or nil. */
1170 Lisp_Object user_hash_function
;
1172 /* User-supplied key comparison function, or nil. */
1173 Lisp_Object user_cmp_function
;
1175 /* Only the fields above are traced normally by the GC. The ones below
1176 `count' are special and are either ignored by the GC or traced in
1177 a special way (e.g. because of weakness). */
1179 /* Number of key/value entries in the table. */
1182 /* Vector of keys and values. The key of item I is found at index
1183 2 * I, the value is found at index 2 * I + 1.
1184 This is gc_marked specially if the table is weak. */
1185 Lisp_Object key_and_value
;
1187 /* Next weak hash table if this is a weak hash table. The head
1188 of the list is in weak_hash_tables. */
1189 struct Lisp_Hash_Table
*next_weak
;
1191 /* C function to compare two keys. */
1192 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1193 Lisp_Object
, EMACS_UINT
,
1194 Lisp_Object
, EMACS_UINT
);
1196 /* C function to compute hash code. */
1197 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1201 #define XHASH_TABLE(OBJ) \
1202 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1204 #define XSET_HASH_TABLE(VAR, PTR) \
1205 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1207 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1209 #define CHECK_HASH_TABLE(x) \
1210 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1212 /* Value is the key part of entry IDX in hash table H. */
1214 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1216 /* Value is the value part of entry IDX in hash table H. */
1218 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1220 /* Value is the index of the next entry following the one at IDX
1223 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1225 /* Value is the hash code computed for entry IDX in hash table H. */
1227 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1229 /* Value is the index of the element in hash table H that is the
1230 start of the collision list at index IDX in the index vector of H. */
1232 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1234 /* Value is the size of hash table H. */
1236 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1238 /* Default size for hash tables if not specified. */
1240 #define DEFAULT_HASH_SIZE 65
1242 /* Default threshold specifying when to resize a hash table. The
1243 value gives the ratio of current entries in the hash table and the
1244 size of the hash table. */
1246 #define DEFAULT_REHASH_THRESHOLD 0.8
1248 /* Default factor by which to increase the size of a hash table. */
1250 #define DEFAULT_REHASH_SIZE 1.5
1253 /* These structures are used for various misc types. */
1255 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1257 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_??? */
1258 unsigned gcmarkbit
: 1;
1260 /* Make it as long as "Lisp_Free without padding". */
1266 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Marker */
1267 unsigned gcmarkbit
: 1;
1269 /* This flag is temporarily used in the functions
1270 decode/encode_coding_object to record that the marker position
1271 must be adjusted after the conversion. */
1272 unsigned int need_adjustment
: 1;
1273 /* 1 means normal insertion at the marker's position
1274 leaves the marker after the inserted text. */
1275 unsigned int insertion_type
: 1;
1276 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1277 Note: a chain of markers can contain markers pointing into different
1278 buffers (the chain is per buffer_text rather than per buffer, so it's
1279 shared between indirect buffers). */
1280 /* This is used for (other than NULL-checking):
1282 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1283 - unchain_marker: to find the list from which to unchain.
1284 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1286 struct buffer
*buffer
;
1288 /* The remaining fields are meaningless in a marker that
1289 does not point anywhere. */
1291 /* For markers that point somewhere,
1292 this is used to chain of all the markers in a given buffer. */
1293 /* We could remove it and use an array in buffer_text instead.
1294 That would also allow to preserve it ordered. */
1295 struct Lisp_Marker
*next
;
1296 /* This is the char position where the marker points. */
1298 /* This is the byte position.
1299 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1300 used to implement the functionality of markers, but rather to (ab)use
1301 markers as a cache for char<->byte mappings). */
1305 /* Forwarding pointer to an int variable.
1306 This is allowed only in the value cell of a symbol,
1307 and it means that the symbol's value really lives in the
1308 specified int variable. */
1311 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1315 /* Boolean forwarding pointer to an int variable.
1316 This is like Lisp_Intfwd except that the ostensible
1317 "value" of the symbol is t if the int variable is nonzero,
1318 nil if it is zero. */
1321 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1325 /* Forwarding pointer to a Lisp_Object variable.
1326 This is allowed only in the value cell of a symbol,
1327 and it means that the symbol's value really lives in the
1328 specified variable. */
1331 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1332 Lisp_Object
*objvar
;
1335 /* Like Lisp_Objfwd except that value lives in a slot in the
1336 current buffer. Value is byte index of slot within buffer. */
1337 struct Lisp_Buffer_Objfwd
1339 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1341 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1344 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1345 the symbol has buffer-local or frame-local bindings. (Exception:
1346 some buffer-local variables are built-in, with their values stored
1347 in the buffer structure itself. They are handled differently,
1348 using struct Lisp_Buffer_Objfwd.)
1350 The `realvalue' slot holds the variable's current value, or a
1351 forwarding pointer to where that value is kept. This value is the
1352 one that corresponds to the loaded binding. To read or set the
1353 variable, you must first make sure the right binding is loaded;
1354 then you can access the value in (or through) `realvalue'.
1356 `buffer' and `frame' are the buffer and frame for which the loaded
1357 binding was found. If those have changed, to make sure the right
1358 binding is loaded it is necessary to find which binding goes with
1359 the current buffer and selected frame, then load it. To load it,
1360 first unload the previous binding, then copy the value of the new
1361 binding into `realvalue' (or through it). Also update
1362 LOADED-BINDING to point to the newly loaded binding.
1364 `local_if_set' indicates that merely setting the variable creates a
1365 local binding for the current buffer. Otherwise the latter, setting
1366 the variable does not do that; only make-local-variable does that. */
1368 struct Lisp_Buffer_Local_Value
1370 /* 1 means that merely setting the variable creates a local
1371 binding for the current buffer */
1372 unsigned int local_if_set
: 1;
1373 /* 1 means this variable can have frame-local bindings, otherwise, it is
1374 can have buffer-local bindings. The two cannot be combined. */
1375 unsigned int frame_local
: 1;
1376 /* 1 means that the binding now loaded was found.
1377 Presumably equivalent to (defcell!=valcell) */
1378 unsigned int found
: 1;
1379 /* If non-NULL, a forwarding to the C var where it should also be set. */
1380 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1381 /* The buffer or frame for which the loaded binding was found. */
1383 /* A cons cell that holds the default value. It has the form
1384 (SYMBOL . DEFAULT-VALUE). */
1385 Lisp_Object defcell
;
1386 /* The cons cell from `where's parameter alist.
1387 It always has the form (SYMBOL . VALUE)
1388 Note that if `forward' is non-nil, VALUE may be out of date.
1389 Also if the currently loaded binding is the default binding, then
1390 this is `eq'ual to defcell. */
1391 Lisp_Object valcell
;
1394 #define BLV_FOUND(blv) \
1395 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1396 #define SET_BLV_FOUND(blv, v) \
1397 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1399 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1400 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1402 /* START and END are markers in the overlay's buffer, and
1403 PLIST is the overlay's property list. */
1405 /* An overlay's real data content is:
1408 - insertion type of both ends
1409 - start & start_byte
1411 - next (singly linked list of overlays).
1412 - start_next and end_next (singly linked list of markers).
1413 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1416 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Overlay */
1417 unsigned gcmarkbit
: 1;
1419 struct Lisp_Overlay
*next
;
1420 Lisp_Object start
, end
, plist
;
1423 /* Like Lisp_Objfwd except that value lives in a slot in the
1425 struct Lisp_Kboard_Objfwd
1427 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1431 /* Hold a C pointer for later use.
1432 This type of object is used in the arg to record_unwind_protect. */
1433 struct Lisp_Save_Value
1435 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Save_Value */
1436 unsigned gcmarkbit
: 1;
1438 /* If DOGC is set, POINTER is the address of a memory
1439 area containing INTEGER potential Lisp_Objects. */
1440 unsigned int dogc
: 1;
1446 /* A miscellaneous object, when it's on the free list. */
1449 enum Lisp_Misc_Type type
: 16; /* = Lisp_Misc_Free */
1450 unsigned gcmarkbit
: 1;
1452 union Lisp_Misc
*chain
;
1454 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1455 This assumes that Lisp_Marker is the largest of the alternatives and
1456 that Lisp_Misc_Any has the same size as "Lisp_Free w/o padding". */
1457 char padding
[((((sizeof (struct Lisp_Marker
) - 1) >> GCTYPEBITS
) + 1)
1458 << GCTYPEBITS
) - sizeof (struct Lisp_Misc_Any
)];
1462 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1463 It uses one of these struct subtypes to get the type field. */
1467 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1468 struct Lisp_Free u_free
; /* Includes padding to force alignment. */
1469 struct Lisp_Marker u_marker
; /* 5 */
1470 struct Lisp_Overlay u_overlay
; /* 5 */
1471 struct Lisp_Save_Value u_save_value
; /* 3 */
1476 struct Lisp_Intfwd u_intfwd
; /* 2 */
1477 struct Lisp_Boolfwd u_boolfwd
; /* 2 */
1478 struct Lisp_Objfwd u_objfwd
; /* 2 */
1479 struct Lisp_Buffer_Objfwd u_buffer_objfwd
; /* 2 */
1480 struct Lisp_Kboard_Objfwd u_kboard_objfwd
; /* 2 */
1483 /* Lisp floating point type */
1488 #ifdef HIDE_LISP_IMPLEMENTATION
1493 struct Lisp_Float
*chain
;
1497 #ifdef HIDE_LISP_IMPLEMENTATION
1498 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1500 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1501 /* This should be used only in alloc.c, which always disables
1502 HIDE_LISP_IMPLEMENTATION. */
1503 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1506 /* A character, declared with the following typedef, is a member
1507 of some character set associated with the current buffer. */
1508 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1510 typedef unsigned char UCHAR
;
1513 /* Meanings of slots in a Lisp_Compiled: */
1515 #define COMPILED_ARGLIST 0
1516 #define COMPILED_BYTECODE 1
1517 #define COMPILED_CONSTANTS 2
1518 #define COMPILED_STACK_DEPTH 3
1519 #define COMPILED_DOC_STRING 4
1520 #define COMPILED_INTERACTIVE 5
1522 /* Flag bits in a character. These also get used in termhooks.h.
1523 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1524 (MUlti-Lingual Emacs) might need 22 bits for the character value
1525 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1526 #define CHAR_ALT (0x0400000)
1527 #define CHAR_SUPER (0x0800000)
1528 #define CHAR_HYPER (0x1000000)
1529 #define CHAR_SHIFT (0x2000000)
1530 #define CHAR_CTL (0x4000000)
1531 #define CHAR_META (0x8000000)
1533 #define CHAR_MODIFIER_MASK \
1534 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1537 /* Actually, the current Emacs uses 22 bits for the character value
1539 #define CHARACTERBITS 22
1541 /* The maximum byte size consumed by push_key_description.
1542 All callers should assure that at least this size of memory is
1543 allocated at the place pointed by the second argument.
1545 There are 6 modifiers, each consumes 2 chars.
1546 The octal form of a character code consumes
1547 (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
1548 We need one more byte for string terminator `\0'. */
1549 #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)
1552 /* The glyph datatype, used to represent characters on the display.
1553 It consists of a char code and a face id. */
1560 /* Return a glyph's character code. */
1561 #define GLYPH_CHAR(glyph) ((glyph).ch)
1563 /* Return a glyph's face ID. */
1564 #define GLYPH_FACE(glyph) ((glyph).face_id)
1566 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1567 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1568 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1570 /* Return 1 if GLYPH contains valid character code. */
1571 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph), 1)
1574 /* Glyph Code from a display vector may either be an integer which
1575 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1576 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1578 #define GLYPH_CODE_CHAR(gc) \
1579 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1581 #define GLYPH_CODE_FACE(gc) \
1582 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1584 /* Return 1 if glyph code from display vector contains valid character code. */
1585 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc), 1)
1587 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1589 /* Only called when GLYPH_CODE_P (gc) is true. */
1590 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1594 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1596 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1597 (XINT (gc) >> CHARACTERBITS)); \
1601 /* The ID of the mode line highlighting face. */
1602 #define GLYPH_MODE_LINE_FACE 1
1604 /* Structure to hold mouse highlight data. This is here because other
1605 header files need it for defining struct x_output etc. */
1607 /* These variables describe the range of text currently shown in its
1608 mouse-face, together with the window they apply to. As long as
1609 the mouse stays within this range, we need not redraw anything on
1610 its account. Rows and columns are glyph matrix positions in
1611 MOUSE_FACE_WINDOW. */
1612 int mouse_face_beg_row
, mouse_face_beg_col
;
1613 int mouse_face_beg_x
, mouse_face_beg_y
;
1614 int mouse_face_end_row
, mouse_face_end_col
;
1615 int mouse_face_end_x
, mouse_face_end_y
;
1616 int mouse_face_past_end
;
1617 Lisp_Object mouse_face_window
;
1618 int mouse_face_face_id
;
1619 Lisp_Object mouse_face_overlay
;
1621 /* 1 if a mouse motion event came and we didn't handle it right away because
1622 gc was in progress. */
1623 int mouse_face_deferred_gc
;
1625 /* FRAME and X, Y position of mouse when last checked for
1626 highlighting. X and Y can be negative or out of range for the frame. */
1627 struct frame
*mouse_face_mouse_frame
;
1628 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1630 /* Nonzero means defer mouse-motion highlighting. */
1631 int mouse_face_defer
;
1633 /* Nonzero means that the mouse highlight should not be shown. */
1634 int mouse_face_hidden
;
1636 int mouse_face_image_state
;
1639 /* Data type checking */
1641 #define NILP(x) EQ (x, Qnil)
1643 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1644 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1646 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1647 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1648 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1649 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1650 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1651 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1653 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1654 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1655 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1656 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1657 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1659 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1660 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1661 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1662 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1663 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1665 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1666 vectorlike_header * avoids aliasing issues. */
1667 #define PSEUDOVECTORP(x, code) \
1668 TYPED_PSEUDOVECTORP(x, vectorlike_header, code)
1670 /* True if object X, with internal type struct T *, is a pseudovector whose
1672 #define TYPED_PSEUDOVECTORP(x, t, code) \
1674 && (((((struct t *) XPNTR (x))->size \
1675 & (PSEUDOVECTOR_FLAG | (code)))) \
1676 == (PSEUDOVECTOR_FLAG | (code))))
1678 /* Test for specific pseudovector types. */
1679 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1680 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1681 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1682 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1683 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1684 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1685 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1686 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1687 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1688 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1689 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1690 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1692 /* Test for image (image . spec) */
1693 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1698 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1700 #define CHECK_LIST(x) \
1701 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1703 #define CHECK_LIST_CONS(x, y) \
1704 CHECK_TYPE (CONSP (x), Qlistp, y)
1706 #define CHECK_LIST_END(x, y) \
1707 CHECK_TYPE (NILP (x), Qlistp, y)
1709 #define CHECK_STRING(x) \
1710 CHECK_TYPE (STRINGP (x), Qstringp, x)
1712 #define CHECK_STRING_CAR(x) \
1713 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1715 #define CHECK_CONS(x) \
1716 CHECK_TYPE (CONSP (x), Qconsp, x)
1718 #define CHECK_SYMBOL(x) \
1719 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1721 #define CHECK_CHAR_TABLE(x) \
1722 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1724 #define CHECK_VECTOR(x) \
1725 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1727 #define CHECK_VECTOR_OR_STRING(x) \
1728 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1730 #define CHECK_ARRAY(x, Qxxxp) \
1731 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1733 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1734 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1736 #define CHECK_BUFFER(x) \
1737 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1739 #define CHECK_WINDOW(x) \
1740 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1742 #define CHECK_WINDOW_CONFIGURATION(x) \
1743 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1745 /* This macro rejects windows on the interior of the window tree as
1746 "dead", which is what we want; this is an argument-checking macro, and
1747 the user should never get access to interior windows.
1749 A window of any sort, leaf or interior, is dead if the buffer,
1750 vchild, and hchild members are all nil. */
1752 #define CHECK_LIVE_WINDOW(x) \
1753 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1755 #define CHECK_PROCESS(x) \
1756 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1758 #define CHECK_SUBR(x) \
1759 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1761 #define CHECK_NUMBER(x) \
1762 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1764 #define CHECK_NATNUM(x) \
1765 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1767 #define CHECK_MARKER(x) \
1768 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1770 #define CHECK_NUMBER_COERCE_MARKER(x) \
1771 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1772 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1774 #define XFLOATINT(n) extract_float((n))
1776 #define CHECK_FLOAT(x) \
1777 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1779 #define CHECK_NUMBER_OR_FLOAT(x) \
1780 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1782 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1783 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1784 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1786 #define CHECK_OVERLAY(x) \
1787 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1789 /* Since we can't assign directly to the CAR or CDR fields of a cons
1790 cell, use these when checking that those fields contain numbers. */
1791 #define CHECK_NUMBER_CAR(x) \
1793 Lisp_Object tmp = XCAR (x); \
1794 CHECK_NUMBER (tmp); \
1795 XSETCAR ((x), tmp); \
1798 #define CHECK_NUMBER_CDR(x) \
1800 Lisp_Object tmp = XCDR (x); \
1801 CHECK_NUMBER (tmp); \
1802 XSETCDR ((x), tmp); \
1805 #define CHECK_NATNUM_CAR(x) \
1807 Lisp_Object tmp = XCAR (x); \
1808 CHECK_NATNUM (tmp); \
1809 XSETCAR ((x), tmp); \
1812 #define CHECK_NATNUM_CDR(x) \
1814 Lisp_Object tmp = XCDR (x); \
1815 CHECK_NATNUM (tmp); \
1816 XSETCDR ((x), tmp); \
1819 /* Cast pointers to this type to compare them. */
1820 #define PNTR_COMPARISON_TYPE uintptr_t
1822 /* Define a built-in function for calling from Lisp.
1823 `lname' should be the name to give the function in Lisp,
1824 as a null-terminated C string.
1825 `fnname' should be the name of the function in C.
1826 By convention, it starts with F.
1827 `sname' should be the name for the C constant structure
1828 that records information on this function for internal use.
1829 By convention, it should be the same as `fnname' but with S instead of F.
1830 It's too bad that C macros can't compute this from `fnname'.
1831 `minargs' should be a number, the minimum number of arguments allowed.
1832 `maxargs' should be a number, the maximum number of arguments allowed,
1833 or else MANY or UNEVALLED.
1834 MANY means pass a vector of evaluated arguments,
1835 in the form of an integer number-of-arguments
1836 followed by the address of a vector of Lisp_Objects
1837 which contains the argument values.
1838 UNEVALLED means pass the list of unevaluated arguments
1839 `intspec' says how interactive arguments are to be fetched.
1840 If the string starts with a `(', `intspec' is evaluated and the resulting
1841 list is the list of arguments.
1842 If it's a string that doesn't start with `(', the value should follow
1843 the one of the doc string for `interactive'.
1844 A null string means call interactively with no arguments.
1845 `doc' is documentation for the user. */
1847 /* This version of DEFUN declares a function prototype with the right
1848 arguments, so we can catch errors with maxargs at compile-time. */
1849 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1850 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1851 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1852 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1853 { .a ## maxargs = fnname }, \
1854 minargs, maxargs, lname, intspec, 0}; \
1857 /* Note that the weird token-substitution semantics of ANSI C makes
1858 this work for MANY and UNEVALLED. */
1859 #define DEFUN_ARGS_MANY (size_t, Lisp_Object *)
1860 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1861 #define DEFUN_ARGS_0 (void)
1862 #define DEFUN_ARGS_1 (Lisp_Object)
1863 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1864 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1865 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1866 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1868 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1869 Lisp_Object, Lisp_Object)
1870 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1871 Lisp_Object, Lisp_Object, Lisp_Object)
1872 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1873 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1875 /* Non-zero if OBJ is a Lisp function. */
1876 #define FUNCTIONP(OBJ) \
1877 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1878 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1879 || COMPILEDP (OBJ) \
1883 is how we define the symbol for function `name' at start-up time. */
1884 extern void defsubr (struct Lisp_Subr
*);
1887 #define UNEVALLED -1
1889 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1890 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1891 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1892 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1893 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1895 /* Macros we use to define forwarded Lisp variables.
1896 These are used in the syms_of_FILENAME functions.
1898 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1899 lisp variable is actually a field in `struct emacs_globals'. The
1900 field's name begins with "f_", which is a convention enforced by
1901 these macros. Each such global has a corresponding #define in
1902 globals.h; the plain name should be used in the code.
1904 E.g., the global "cons_cells_consed" is declared as "int
1905 f_cons_cells_consed" in globals.h, but there is a define:
1907 #define cons_cells_consed globals.f_cons_cells_consed
1909 All C code uses the `cons_cells_consed' name. This is all done
1910 this way to support indirection for multi-threaded Emacs. */
1912 #define DEFVAR_LISP(lname, vname, doc) \
1914 static struct Lisp_Objfwd o_fwd; \
1915 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1917 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1919 static struct Lisp_Objfwd o_fwd; \
1920 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1922 #define DEFVAR_BOOL(lname, vname, doc) \
1924 static struct Lisp_Boolfwd b_fwd; \
1925 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1927 #define DEFVAR_INT(lname, vname, doc) \
1929 static struct Lisp_Intfwd i_fwd; \
1930 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1933 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1935 static struct Lisp_Objfwd o_fwd; \
1936 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1939 #define DEFVAR_KBOARD(lname, vname, doc) \
1941 static struct Lisp_Kboard_Objfwd ko_fwd; \
1942 defvar_kboard (&ko_fwd, \
1944 (int)((char *)(¤t_kboard->vname ## _) \
1945 - (char *)current_kboard)); \
1950 /* Structure for recording Lisp call stack for backtrace purposes. */
1952 /* The special binding stack holds the outer values of variables while
1953 they are bound by a function application or a let form, stores the
1954 code to be executed for Lisp unwind-protect forms, and stores the C
1955 functions to be called for record_unwind_protect.
1957 If func is non-zero, undoing this binding applies func to old_value;
1958 This implements record_unwind_protect.
1960 Otherwise, the element is a variable binding.
1962 If the symbol field is a symbol, it is an ordinary variable binding.
1964 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
1965 which means having bound a local value while CURRENT-BUFFER was active.
1966 If WHERE is nil this means we saw the default value when binding SYMBOL.
1967 WHERE being a buffer or frame means we saw a buffer-local or frame-local
1968 value. Other values of WHERE mean an internal error. */
1970 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
1974 Lisp_Object symbol
, old_value
;
1975 specbinding_func func
;
1976 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
1979 extern struct specbinding
*specpdl
;
1980 extern struct specbinding
*specpdl_ptr
;
1981 extern EMACS_INT specpdl_size
;
1983 #define SPECPDL_INDEX() ((int) (specpdl_ptr - specpdl))
1985 /* Everything needed to describe an active condition case. */
1988 /* The handler clauses and variable from the condition-case form. */
1989 /* For a handler set up in Lisp code, this is always a list.
1990 For an internal handler set up by internal_condition_case*,
1991 this can instead be the symbol t or `error'.
1992 t: handle all conditions.
1993 error: handle all conditions, and errors can run the debugger
1994 or display a backtrace. */
1995 Lisp_Object handler
;
1997 /* Fsignal stores here the condition-case clause that applies,
1998 and Fcondition_case thus knows which clause to run. */
1999 Lisp_Object chosen_clause
;
2001 /* Used to effect the longjump out to the handler. */
2002 struct catchtag
*tag
;
2004 /* The next enclosing handler. */
2005 struct handler
*next
;
2008 /* This structure helps implement the `catch' and `throw' control
2009 structure. A struct catchtag contains all the information needed
2010 to restore the state of the interpreter after a non-local jump.
2012 Handlers for error conditions (represented by `struct handler'
2013 structures) just point to a catch tag to do the cleanup required
2016 catchtag structures are chained together in the C calling stack;
2017 the `next' member points to the next outer catchtag.
2019 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2020 member is TAG, and then unbinds to it. The `val' member is used to
2021 hold VAL while the stack is unwound; `val' is returned as the value
2024 All the other members are concerned with restoring the interpreter
2031 struct catchtag
*next
;
2032 struct gcpro
*gcpro
;
2034 struct backtrace
*backlist
;
2035 struct handler
*handlerlist
;
2036 int lisp_eval_depth
;
2038 int poll_suppress_count
;
2039 int interrupt_input_blocked
;
2040 struct byte_stack
*byte_stack
;
2043 extern Lisp_Object memory_signal_data
;
2045 /* An address near the bottom of the stack.
2046 Tells GC how to save a copy of the stack. */
2047 extern char *stack_bottom
;
2049 /* Check quit-flag and quit if it is non-nil.
2050 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2051 So the program needs to do QUIT at times when it is safe to quit.
2052 Every loop that might run for a long time or might not exit
2053 ought to do QUIT at least once, at a safe place.
2054 Unless that is impossible, of course.
2055 But it is very desirable to avoid creating loops where QUIT is impossible.
2057 Exception: if you set immediate_quit to nonzero,
2058 then the handler that responds to the C-g does the quit itself.
2059 This is a good thing to do around a loop that has no side effects
2060 and (in particular) cannot call arbitrary Lisp code. */
2063 extern void process_pending_signals (void);
2064 extern int pending_signals
;
2065 #define ELSE_PENDING_SIGNALS \
2066 else if (pending_signals) \
2067 process_pending_signals ();
2068 #else /* not SYNC_INPUT */
2069 #define ELSE_PENDING_SIGNALS
2070 #endif /* not SYNC_INPUT */
2074 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2076 Lisp_Object flag = Vquit_flag; \
2077 Vquit_flag = Qnil; \
2078 if (EQ (Vthrow_on_input, flag)) \
2079 Fthrow (Vthrow_on_input, Qt); \
2080 Fsignal (Qquit, Qnil); \
2082 ELSE_PENDING_SIGNALS \
2086 /* Nonzero if ought to quit now. */
2088 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2090 extern Lisp_Object Vascii_downcase_table
;
2091 extern Lisp_Object Vascii_canon_table
;
2093 /* Number of bytes of structure consed since last GC. */
2095 extern EMACS_INT consing_since_gc
;
2097 extern EMACS_INT gc_relative_threshold
;
2099 extern EMACS_INT memory_full_cons_threshold
;
2101 /* Structure for recording stack slots that need marking. */
2103 /* This is a chain of structures, each of which points at a Lisp_Object
2104 variable whose value should be marked in garbage collection.
2105 Normally every link of the chain is an automatic variable of a function,
2106 and its `val' points to some argument or local variable of the function.
2107 On exit to the function, the chain is set back to the value it had on entry.
2108 This way, no link remains in the chain when the stack frame containing the
2111 Every function that can call Feval must protect in this fashion all
2112 Lisp_Object variables whose contents will be used again. */
2114 extern struct gcpro
*gcprolist
;
2120 /* Address of first protected variable. */
2121 volatile Lisp_Object
*var
;
2123 /* Number of consecutive protected variables. */
2131 /* Values of GC_MARK_STACK during compilation:
2133 0 Use GCPRO as before
2134 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2135 2 Mark the stack, and check that everything GCPRO'd is
2137 3 Mark using GCPRO's, mark stack last, and count how many
2138 dead objects are kept alive. */
2141 #define GC_USE_GCPROS_AS_BEFORE 0
2142 #define GC_MAKE_GCPROS_NOOPS 1
2143 #define GC_MARK_STACK_CHECK_GCPROS 2
2144 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2146 #ifndef GC_MARK_STACK
2147 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2150 /* Whether we do the stack marking manually. */
2151 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2152 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2155 #define GCPRO1(var) \
2156 GCPRO1_VAR (var, gcpro)
2157 #define GCPRO2(var1, var2) \
2158 GCPRO2_VAR (var1, var2, gcpro)
2159 #define GCPRO3(var1, var2, var3) \
2160 GCPRO3_VAR (var1, var2, var3, gcpro)
2161 #define GCPRO4(var1, var2, var3, var4) \
2162 GCPRO4_VAR (var1, var2, var3, var4, gcpro)
2163 #define GCPRO5(var1, var2, var3, var4, var5) \
2164 GCPRO5_VAR (var1, var2, var3, var4, var5, gcpro)
2165 #define GCPRO6(var1, var2, var3, var4, var5, var6) \
2166 GCPRO6_VAR (var1, var2, var3, var4, var5, var6, gcpro)
2167 #define UNGCPRO UNGCPRO_VAR (gcpro)
2169 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2171 /* Do something silly with gcproN vars just so gcc shuts up. */
2172 /* You get warnings from MIPSPro... */
2174 #define GCPRO1_VAR(var, gcpro) ((void) gcpro##1)
2175 #define GCPRO2_VAR(var1, var2, gcpro) \
2176 ((void) gcpro##2, (void) gcpro##1)
2177 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2178 ((void) gcpro##3, (void) gcpro##2, (void) gcpro##1)
2179 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2180 ((void) gcpro##4, (void) gcpro##3, (void) gcpro##2, (void) gcpro##1)
2181 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2182 ((void) gcpro##5, (void) gcpro##4, (void) gcpro##3, (void) gcpro##2, \
2184 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2185 ((void) gcpro##6, (void) gcpro##5, (void) gcpro##4, (void) gcpro##3, \
2186 (void) gcpro##2, (void) gcpro##1)
2187 #define UNGCPRO_VAR(gcpro) ((void) 0)
2189 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2193 #define GCPRO1_VAR(var, gcpro) \
2194 {gcpro##1.next = gcprolist; gcpro##1.var = &var; gcpro##1.nvars = 1; \
2195 gcprolist = &gcpro##1; }
2197 #define GCPRO2_VAR(var1, var2, gcpro) \
2198 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2199 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2200 gcprolist = &gcpro##2; }
2202 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2203 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2204 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2205 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2206 gcprolist = &gcpro##3; }
2208 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2209 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2210 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2211 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2212 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2213 gcprolist = &gcpro##4; }
2215 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2216 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2217 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2218 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2219 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2220 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2221 gcprolist = &gcpro##5; }
2223 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2224 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2225 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2226 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2227 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2228 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2229 gcpro##6.next = &gcpro##5; gcpro##6.var = &var6; gcpro##6.nvars = 1; \
2230 gcprolist = &gcpro##6; }
2232 #define UNGCPRO_VAR(gcpro) (gcprolist = gcpro##1.next)
2236 extern int gcpro_level
;
2238 #define GCPRO1_VAR(var, gcpro) \
2239 {gcpro##1.next = gcprolist; gcpro##1.var = &var; gcpro##1.nvars = 1; \
2240 gcpro##1.level = gcpro_level++; \
2241 gcprolist = &gcpro##1; }
2243 #define GCPRO2_VAR(var1, var2, gcpro) \
2244 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2245 gcpro##1.level = gcpro_level; \
2246 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2247 gcpro##2.level = gcpro_level++; \
2248 gcprolist = &gcpro##2; }
2250 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2251 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2252 gcpro##1.level = gcpro_level; \
2253 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2254 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2255 gcpro##3.level = gcpro_level++; \
2256 gcprolist = &gcpro##3; }
2258 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2259 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2260 gcpro##1.level = gcpro_level; \
2261 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2262 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2263 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2264 gcpro##4.level = gcpro_level++; \
2265 gcprolist = &gcpro##4; }
2267 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2268 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2269 gcpro##1.level = gcpro_level; \
2270 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2271 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2272 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2273 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2274 gcpro##5.level = gcpro_level++; \
2275 gcprolist = &gcpro##5; }
2277 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2278 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2279 gcpro##1.level = gcpro_level; \
2280 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2281 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2282 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2283 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2284 gcpro##6.next = &gcpro##5; gcpro##6.var = &var6; gcpro##6.nvars = 1; \
2285 gcpro##6.level = gcpro_level++; \
2286 gcprolist = &gcpro##6; }
2288 #define UNGCPRO_VAR(gcpro) \
2289 ((--gcpro_level != gcpro##1.level) \
2291 : ((gcprolist = gcpro##1.next), 0))
2293 #endif /* DEBUG_GCPRO */
2294 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2297 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2298 #define RETURN_UNGCPRO(expr) \
2301 Lisp_Object ret_ungc_val; \
2302 ret_ungc_val = (expr); \
2304 return ret_ungc_val; \
2308 /* Call staticpro (&var) to protect static variable `var'. */
2310 void staticpro (Lisp_Object
*);
2312 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2313 meaning as in the DEFUN macro, and is used to construct a prototype. */
2314 /* We can use the same trick as in the DEFUN macro to generate the
2315 appropriate prototype. */
2316 #define EXFUN(fnname, maxargs) \
2317 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2319 /* Forward declarations for prototypes. */
2323 /* Defined in data.c. */
2324 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2325 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2326 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2327 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2328 extern Lisp_Object Qinvalid_read_syntax
;
2329 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2330 extern Lisp_Object Qend_of_file
, Qarith_error
, Qmark_inactive
;
2331 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2332 extern Lisp_Object Qtext_read_only
;
2333 extern Lisp_Object Qinteractive_form
;
2334 extern Lisp_Object Qcircular_list
;
2335 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2336 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2337 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2338 extern Lisp_Object Qbuffer_or_string_p
;
2339 extern Lisp_Object Qfboundp
;
2340 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2342 extern Lisp_Object Qcdr
;
2344 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2345 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2347 extern Lisp_Object Qfloatp
;
2348 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2350 extern Lisp_Object Qinteger
;
2352 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2354 EXFUN (Finteractive_form
, 1);
2355 EXFUN (Fbyteorder
, 0);
2357 /* Defined in frame.c */
2358 extern Lisp_Object Qframep
;
2360 /* Defined in data.c */
2362 EXFUN (Fcar_safe
, 1);
2364 EXFUN (Fcdr_safe
, 1);
2368 EXFUN (Ffboundp
, 1);
2369 EXFUN (Fsymbol_function
, 1);
2370 EXFUN (Fsymbol_name
, 1);
2371 extern Lisp_Object
indirect_function (Lisp_Object
);
2372 EXFUN (Findirect_function
, 2);
2374 EXFUN (Fsymbol_value
, 1);
2375 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2377 EXFUN (Fdefault_value
, 1);
2378 EXFUN (Fset_default
, 2);
2379 EXFUN (Fdefault_boundp
, 1);
2380 EXFUN (Fmake_local_variable
, 1);
2381 EXFUN (Flocal_variable_p
, 2);
2386 EXFUN (Fstring_to_number
, 2);
2387 EXFUN (Fnumber_to_string
, 1);
2393 EXFUN (Fplus
, MANY
);
2394 EXFUN (Fminus
, MANY
);
2395 EXFUN (Ftimes
, MANY
);
2403 EXFUN (Fmake_variable_buffer_local
, 1);
2405 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2406 extern Lisp_Object
long_to_cons (unsigned long);
2407 extern unsigned long cons_to_long (Lisp_Object
);
2408 extern void args_out_of_range (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2409 extern void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2410 Lisp_Object
) NO_RETURN
;
2411 extern Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2412 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2413 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2414 extern void syms_of_data (void);
2415 extern void init_data (void);
2416 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2418 /* Defined in cmds.c */
2419 EXFUN (Fend_of_line
, 1);
2420 EXFUN (Fforward_char
, 1);
2421 EXFUN (Fforward_line
, 1);
2422 extern void syms_of_cmds (void);
2423 extern void keys_of_cmds (void);
2425 /* Defined in coding.c */
2426 extern Lisp_Object Qcharset
;
2427 EXFUN (Fcoding_system_p
, 1);
2428 EXFUN (Fcoding_system_base
, 1);
2429 EXFUN (Fcoding_system_eol_type
, 1);
2430 EXFUN (Fcheck_coding_system
, 1);
2431 EXFUN (Fread_coding_system
, 2);
2432 EXFUN (Fread_non_nil_coding_system
, 1);
2433 EXFUN (Ffind_operation_coding_system
, MANY
);
2434 EXFUN (Fdecode_coding_string
, 4);
2435 extern Lisp_Object
detect_coding_system (const unsigned char *, EMACS_INT
,
2436 EMACS_INT
, int, int, Lisp_Object
);
2437 extern void init_coding (void);
2438 extern void init_coding_once (void);
2439 extern void syms_of_coding (void);
2441 /* Defined in character.c */
2442 EXFUN (Fchar_width
, 1);
2443 EXFUN (Fstring
, MANY
);
2444 extern EMACS_INT
chars_in_text (const unsigned char *, EMACS_INT
);
2445 extern EMACS_INT
multibyte_chars_in_text (const unsigned char *, EMACS_INT
);
2446 extern int multibyte_char_to_unibyte (int);
2447 extern int multibyte_char_to_unibyte_safe (int);
2448 extern void init_character_once (void);
2449 extern void syms_of_character (void);
2451 /* Defined in charset.c */
2452 extern void init_charset (void);
2453 extern void init_charset_once (void);
2454 extern void syms_of_charset (void);
2455 /* Structure forward declarations. */
2458 /* Defined in composite.c */
2459 extern void syms_of_composite (void);
2461 /* Defined in syntax.c */
2462 EXFUN (Fforward_word
, 1);
2463 EXFUN (Fskip_chars_forward
, 2);
2464 EXFUN (Fskip_chars_backward
, 2);
2465 extern void init_syntax_once (void);
2466 extern void syms_of_syntax (void);
2468 /* Defined in fns.c */
2469 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2470 extern EMACS_INT
next_almost_prime (EMACS_INT
);
2471 extern Lisp_Object
larger_vector (Lisp_Object
, EMACS_INT
, Lisp_Object
);
2472 extern void sweep_weak_hash_tables (void);
2473 extern Lisp_Object Qcursor_in_echo_area
;
2474 extern Lisp_Object Qstring_lessp
;
2475 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2476 EMACS_UINT
sxhash (Lisp_Object
, int);
2477 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2478 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2480 EMACS_INT
hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2481 EMACS_INT
hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2483 void init_weak_hash_tables (void);
2484 extern void init_fns (void);
2485 EXFUN (Fmake_hash_table
, MANY
);
2486 EXFUN (Fgethash
, 3);
2487 EXFUN (Fputhash
, 3);
2488 EXFUN (Fremhash
, 2);
2490 EXFUN (Fidentity
, 1);
2492 EXFUN (Fappend
, MANY
);
2493 EXFUN (Fconcat
, MANY
);
2494 EXFUN (Fvconcat
, MANY
);
2495 EXFUN (Fcopy_sequence
, 1);
2496 EXFUN (Fstring_make_multibyte
, 1);
2497 EXFUN (Fstring_make_unibyte
, 1);
2498 EXFUN (Fstring_as_multibyte
, 1);
2499 EXFUN (Fstring_as_unibyte
, 1);
2500 EXFUN (Fstring_to_multibyte
, 1);
2501 EXFUN (Fsubstring
, 3);
2502 extern Lisp_Object
substring_both (Lisp_Object
, EMACS_INT
, EMACS_INT
,
2503 EMACS_INT
, EMACS_INT
);
2515 EXFUN (Freverse
, 1);
2516 EXFUN (Fnreverse
, 1);
2520 EXFUN (Fnconc
, MANY
);
2522 EXFUN (Fmapconcat
, 3);
2523 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2524 EXFUN (Fprovide
, 2);
2525 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2526 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2527 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2528 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2529 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2530 extern void clear_string_char_byte_cache (void);
2531 extern EMACS_INT
string_char_to_byte (Lisp_Object
, EMACS_INT
);
2532 extern EMACS_INT
string_byte_to_char (Lisp_Object
, EMACS_INT
);
2533 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2534 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2535 EXFUN (Fcopy_alist
, 1);
2536 EXFUN (Fplist_get
, 2);
2537 EXFUN (Fplist_put
, 3);
2538 EXFUN (Fplist_member
, 2);
2540 EXFUN (Fstring_equal
, 2);
2541 EXFUN (Fcompare_strings
, 7);
2542 EXFUN (Fstring_lessp
, 2);
2543 extern void syms_of_fns (void);
2545 /* Defined in floatfns.c */
2546 extern double extract_float (Lisp_Object
);
2548 EXFUN (Ftruncate
, 2);
2549 extern void init_floatfns (void);
2550 extern void syms_of_floatfns (void);
2551 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2553 /* Defined in fringe.c */
2554 extern void syms_of_fringe (void);
2555 extern void init_fringe (void);
2556 #ifdef HAVE_WINDOW_SYSTEM
2557 extern void mark_fringe_data (void);
2558 extern void init_fringe_once (void);
2559 #endif /* HAVE_WINDOW_SYSTEM */
2561 /* Defined in image.c */
2562 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2563 extern Lisp_Object QCconversion
;
2564 extern int x_bitmap_mask (struct frame
*, int);
2565 extern void syms_of_image (void);
2566 extern void init_image (void);
2568 /* Defined in insdel.c */
2569 extern Lisp_Object Qinhibit_modification_hooks
;
2570 extern void move_gap (EMACS_INT
);
2571 extern void move_gap_both (EMACS_INT
, EMACS_INT
);
2572 extern void make_gap (EMACS_INT
);
2573 extern EMACS_INT
copy_text (const unsigned char *, unsigned char *,
2574 EMACS_INT
, int, int);
2575 extern int count_combining_before (const unsigned char *,
2576 EMACS_INT
, EMACS_INT
, EMACS_INT
);
2577 extern int count_combining_after (const unsigned char *,
2578 EMACS_INT
, EMACS_INT
, EMACS_INT
);
2579 extern void insert (const char *, EMACS_INT
);
2580 extern void insert_and_inherit (const char *, EMACS_INT
);
2581 extern void insert_1 (const char *, EMACS_INT
, int, int, int);
2582 extern void insert_1_both (const char *, EMACS_INT
, EMACS_INT
,
2584 extern void insert_from_gap (EMACS_INT
, EMACS_INT
);
2585 extern void insert_from_string (Lisp_Object
, EMACS_INT
, EMACS_INT
,
2586 EMACS_INT
, EMACS_INT
, int);
2587 extern void insert_from_buffer (struct buffer
*, EMACS_INT
, EMACS_INT
, int);
2588 extern void insert_char (int);
2589 extern void insert_string (const char *);
2590 extern void insert_before_markers (const char *, EMACS_INT
);
2591 extern void insert_before_markers_and_inherit (const char *, EMACS_INT
);
2592 extern void insert_from_string_before_markers (Lisp_Object
, EMACS_INT
,
2593 EMACS_INT
, EMACS_INT
,
2595 extern void del_range (EMACS_INT
, EMACS_INT
);
2596 extern Lisp_Object
del_range_1 (EMACS_INT
, EMACS_INT
, int, int);
2597 extern void del_range_byte (EMACS_INT
, EMACS_INT
, int);
2598 extern void del_range_both (EMACS_INT
, EMACS_INT
, EMACS_INT
, EMACS_INT
, int);
2599 extern Lisp_Object
del_range_2 (EMACS_INT
, EMACS_INT
,
2600 EMACS_INT
, EMACS_INT
, int);
2601 extern void modify_region (struct buffer
*, EMACS_INT
, EMACS_INT
, int);
2602 extern void prepare_to_modify_buffer (EMACS_INT
, EMACS_INT
, EMACS_INT
*);
2603 extern void signal_after_change (EMACS_INT
, EMACS_INT
, EMACS_INT
);
2604 extern void adjust_after_insert (EMACS_INT
, EMACS_INT
, EMACS_INT
,
2605 EMACS_INT
, EMACS_INT
);
2606 extern void adjust_markers_for_delete (EMACS_INT
, EMACS_INT
,
2607 EMACS_INT
, EMACS_INT
);
2608 extern void replace_range (EMACS_INT
, EMACS_INT
, Lisp_Object
, int, int, int);
2609 extern void replace_range_2 (EMACS_INT
, EMACS_INT
, EMACS_INT
, EMACS_INT
,
2610 const char *, EMACS_INT
, EMACS_INT
, int);
2611 extern void syms_of_insdel (void);
2613 /* Defined in dispnew.c */
2614 extern Lisp_Object selected_frame
;
2615 extern Lisp_Object Vwindow_system
;
2617 EXFUN (Fredraw_frame
, 1);
2618 EXFUN (Fsleep_for
, 2);
2619 EXFUN (Fredisplay
, 1);
2620 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2621 extern void init_display (void);
2622 extern void syms_of_display (void);
2624 /* Defined in xdisp.c */
2625 extern Lisp_Object Qinhibit_point_motion_hooks
;
2626 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2627 extern Lisp_Object Qmenu_bar_update_hook
;
2628 extern Lisp_Object Qwindow_scroll_functions
;
2629 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2630 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2631 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2632 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2633 extern Lisp_Object Qleft_margin
, Qright_margin
;
2634 extern Lisp_Object Qglyphless_char
;
2635 extern Lisp_Object QCdata
, QCfile
;
2636 extern Lisp_Object QCmap
;
2637 extern Lisp_Object Qrisky_local_variable
;
2638 extern struct frame
*last_glyphless_glyph_frame
;
2639 extern unsigned last_glyphless_glyph_face_id
;
2640 extern int last_glyphless_glyph_merged_face_id
;
2641 extern int noninteractive_need_newline
;
2642 extern Lisp_Object echo_area_buffer
[2];
2643 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2644 extern void check_message_stack (void);
2645 extern void setup_echo_area_for_printing (int);
2646 extern int push_message (void);
2647 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2648 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2649 extern void restore_message (void);
2650 extern Lisp_Object
current_message (void);
2651 extern void clear_message (int, int);
2652 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2653 extern void message1 (const char *);
2654 extern void message1_nolog (const char *);
2655 extern void message2 (const char *, EMACS_INT
, int);
2656 extern void message2_nolog (const char *, EMACS_INT
, int);
2657 extern void message3 (Lisp_Object
, EMACS_INT
, int);
2658 extern void message3_nolog (Lisp_Object
, EMACS_INT
, int);
2659 extern void message_dolog (const char *, EMACS_INT
, int, int);
2660 extern void message_with_string (const char *, Lisp_Object
, int);
2661 extern void message_log_maybe_newline (void);
2662 extern void update_echo_area (void);
2663 extern void truncate_echo_area (EMACS_INT
);
2664 extern void redisplay (void);
2665 extern void redisplay_preserve_echo_area (int);
2666 extern void prepare_menu_bars (void);
2668 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2669 extern void syms_of_xdisp (void);
2670 extern void init_xdisp (void);
2671 extern Lisp_Object
safe_eval (Lisp_Object
);
2672 extern int pos_visible_p (struct window
*, EMACS_INT
, int *,
2673 int *, int *, int *, int *, int *);
2675 /* Defined in xsettings.c */
2676 extern void syms_of_xsettings (void);
2678 /* Defined in vm-limit.c. */
2679 extern void memory_warnings (POINTER_TYPE
*, void (*warnfun
) (const char *));
2681 /* Defined in alloc.c */
2682 extern void check_pure_size (void);
2683 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2684 extern void reset_malloc_hooks (void);
2685 extern void uninterrupt_malloc (void);
2686 extern void malloc_warning (const char *);
2687 extern void memory_full (void) NO_RETURN
;
2688 extern void buffer_memory_full (void) NO_RETURN
;
2689 extern int survives_gc_p (Lisp_Object
);
2690 extern void mark_object (Lisp_Object
);
2691 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2692 extern void refill_memory_reserve (void);
2694 extern const char *pending_malloc_warning
;
2695 extern Lisp_Object
*stack_base
;
2697 extern Lisp_Object
list1 (Lisp_Object
);
2698 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2699 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2700 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2701 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2703 EXFUN (Flist
, MANY
);
2704 EXFUN (Fmake_list
, 2);
2705 extern Lisp_Object
allocate_misc (void);
2706 EXFUN (Fmake_vector
, 2);
2707 EXFUN (Fvector
, MANY
);
2708 EXFUN (Fmake_symbol
, 1);
2709 EXFUN (Fmake_marker
, 0);
2710 extern void string_overflow (void) NO_RETURN
;
2711 EXFUN (Fmake_string
, 2);
2712 extern Lisp_Object
build_string (const char *);
2713 extern Lisp_Object
make_string (const char *, EMACS_INT
);
2714 extern Lisp_Object
make_unibyte_string (const char *, EMACS_INT
);
2715 extern Lisp_Object
make_multibyte_string (const char *, EMACS_INT
, EMACS_INT
);
2716 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2717 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2718 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2719 extern Lisp_Object
make_string_from_bytes (const char *, EMACS_INT
, EMACS_INT
);
2720 extern Lisp_Object
make_specified_string (const char *,
2721 EMACS_INT
, EMACS_INT
, int);
2722 EXFUN (Fpurecopy
, 1);
2723 extern Lisp_Object
make_pure_string (const char *, EMACS_INT
, EMACS_INT
, int);
2724 extern Lisp_Object
make_pure_c_string (const char *data
);
2725 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2726 extern Lisp_Object
make_pure_vector (EMACS_INT
);
2727 EXFUN (Fgarbage_collect
, 0);
2728 EXFUN (Fmake_byte_code
, MANY
);
2729 EXFUN (Fmake_bool_vector
, 2);
2730 extern Lisp_Object Qchar_table_extra_slots
;
2731 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2732 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, EMACS_INT tag
);
2733 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2735 allocate_pseudovector \
2736 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2737 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2738 extern struct window
*allocate_window (void);
2739 extern struct frame
*allocate_frame (void);
2740 extern struct Lisp_Process
*allocate_process (void);
2741 extern struct terminal
*allocate_terminal (void);
2742 extern int gc_in_progress
;
2743 extern int abort_on_gc
;
2744 extern Lisp_Object
make_float (double);
2745 extern void display_malloc_warning (void);
2746 extern int inhibit_garbage_collection (void);
2747 extern Lisp_Object
make_save_value (void *, int);
2748 extern void free_marker (Lisp_Object
);
2749 extern void free_cons (struct Lisp_Cons
*);
2750 extern void init_alloc_once (void);
2751 extern void init_alloc (void);
2752 extern void syms_of_alloc (void);
2753 extern struct buffer
* allocate_buffer (void);
2754 extern int valid_lisp_object_p (Lisp_Object
);
2756 /* Defined in chartab.c */
2757 EXFUN (Fmake_char_table
, 2);
2758 EXFUN (Fset_char_table_parent
, 2);
2759 EXFUN (Fchar_table_extra_slot
, 2);
2760 EXFUN (Fset_char_table_extra_slot
, 3);
2761 EXFUN (Fset_char_table_range
, 3);
2762 EXFUN (Foptimize_char_table
, 2);
2763 extern Lisp_Object
copy_char_table (Lisp_Object
);
2764 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2765 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2767 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2768 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2770 extern int char_table_translate (Lisp_Object
, int);
2771 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2773 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2774 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2775 Lisp_Object
, Lisp_Object
,
2776 Lisp_Object
, struct charset
*,
2777 unsigned, unsigned);
2778 extern void syms_of_chartab (void);
2780 /* Defined in print.c */
2781 extern Lisp_Object Vprin1_to_string_buffer
;
2782 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2784 EXFUN (Fprin1_to_string
, 2);
2787 EXFUN (Ferror_message_string
, 1);
2788 extern Lisp_Object Qstandard_output
;
2789 extern Lisp_Object Qexternal_debugging_output
;
2790 extern void temp_output_buffer_setup (const char *);
2791 extern int print_level
;
2792 extern Lisp_Object Qprint_escape_newlines
;
2793 extern void write_string (const char *, int);
2794 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2796 extern Lisp_Object internal_with_output_to_temp_buffer
2797 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2798 #define FLOAT_TO_STRING_BUFSIZE 350
2799 extern void float_to_string (char *, double);
2800 extern void syms_of_print (void);
2802 /* Defined in doprnt.c */
2803 extern size_t doprnt (char *, size_t, const char *, const char *, va_list);
2805 /* Defined in lread.c. */
2806 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2807 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2809 EXFUN (Fread_from_string
, 3);
2811 EXFUN (Fintern_soft
, 2);
2812 EXFUN (Funintern
, 2);
2814 EXFUN (Fget_load_suffixes
, 0);
2815 EXFUN (Fread_char
, 3);
2816 EXFUN (Fread_event
, 3);
2817 extern Lisp_Object
check_obarray (Lisp_Object
);
2818 extern Lisp_Object
intern (const char *);
2819 extern Lisp_Object
intern_c_string (const char *);
2820 extern Lisp_Object
oblookup (Lisp_Object
, const char *, EMACS_INT
, EMACS_INT
);
2821 #define LOADHIST_ATTACH(x) \
2823 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2825 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2826 Lisp_Object
*, Lisp_Object
);
2827 Lisp_Object
string_to_number (char const *, int, int);
2828 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2830 extern void dir_warning (const char *, Lisp_Object
);
2831 extern void close_load_descs (void);
2832 extern void init_obarray (void);
2833 extern void init_lread (void);
2834 extern void syms_of_lread (void);
2836 /* Defined in eval.c. */
2837 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
, Qmacro
;
2838 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2839 extern Lisp_Object Qand_rest
;
2840 extern Lisp_Object Vautoload_queue
;
2841 extern Lisp_Object Vsignaling_function
;
2842 extern int handling_signal
;
2844 extern struct catchtag
*catchlist
;
2845 extern struct handler
*handlerlist
;
2847 /* To run a normal hook, use the appropriate function from the list below.
2848 The calling convention:
2850 if (!NILP (Vrun_hooks))
2851 call1 (Vrun_hooks, Qmy_funny_hook);
2853 should no longer be used. */
2854 extern Lisp_Object Vrun_hooks
;
2855 EXFUN (Frun_hooks
, MANY
);
2856 EXFUN (Frun_hook_with_args
, MANY
);
2857 EXFUN (Frun_hook_with_args_until_failure
, MANY
);
2858 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2859 extern Lisp_Object
run_hook_with_args (size_t nargs
, Lisp_Object
*args
,
2860 Lisp_Object (*funcall
)
2861 (size_t nargs
, Lisp_Object
*args
));
2862 EXFUN (Fprogn
, UNEVALLED
);
2863 EXFUN (Finteractive_p
, 0);
2864 EXFUN (Fthrow
, 2) NO_RETURN
;
2866 extern void xsignal (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2867 extern void xsignal0 (Lisp_Object
) NO_RETURN
;
2868 extern void xsignal1 (Lisp_Object
, Lisp_Object
) NO_RETURN
;
2869 extern void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2870 extern void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
) NO_RETURN
;
2871 extern void signal_error (const char *, Lisp_Object
) NO_RETURN
;
2872 EXFUN (Fcommandp
, 2);
2873 EXFUN (Ffunctionp
, 1);
2875 extern Lisp_Object
eval_sub (Lisp_Object form
);
2876 EXFUN (Fapply
, MANY
);
2877 EXFUN (Ffuncall
, MANY
);
2878 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2879 extern Lisp_Object
call0 (Lisp_Object
);
2880 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2881 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2882 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2883 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2884 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2885 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2886 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2887 EXFUN (Fdo_auto_save
, 2);
2888 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2889 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2890 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2891 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2892 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2893 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (size_t, Lisp_Object
*), size_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2894 extern void specbind (Lisp_Object
, Lisp_Object
);
2895 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2896 extern Lisp_Object
unbind_to (int, Lisp_Object
);
2897 extern void error (const char *, ...) NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
2898 extern void verror (const char *, va_list)
2899 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 0);
2900 extern void do_autoload (Lisp_Object
, Lisp_Object
);
2901 extern Lisp_Object
un_autoload (Lisp_Object
);
2902 extern void init_eval_once (void);
2903 extern Lisp_Object
safe_call (size_t, Lisp_Object
*);
2904 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
2905 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2906 extern void init_eval (void);
2908 extern void mark_backtrace (void);
2910 extern void syms_of_eval (void);
2912 /* Defined in editfns.c */
2913 extern Lisp_Object Qfield
;
2914 EXFUN (Fcurrent_message
, 0);
2915 EXFUN (Fgoto_char
, 1);
2916 EXFUN (Fpoint_max_marker
, 0);
2918 EXFUN (Fpoint_marker
, 0);
2919 EXFUN (Fline_beginning_position
, 1);
2920 EXFUN (Fline_end_position
, 1);
2921 EXFUN (Ffollowing_char
, 0);
2922 EXFUN (Fprevious_char
, 0);
2923 EXFUN (Fchar_after
, 1);
2924 EXFUN (Finsert
, MANY
);
2925 EXFUN (Finsert_char
, 3);
2926 extern void insert1 (Lisp_Object
);
2931 EXFUN (Fformat
, MANY
);
2932 EXFUN (Fmessage
, MANY
);
2933 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
2934 EXFUN (Fbuffer_substring
, 2);
2935 EXFUN (Fbuffer_string
, 0);
2936 extern Lisp_Object
save_excursion_save (void);
2937 extern Lisp_Object
save_restriction_save (void);
2938 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
2939 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
2940 EXFUN (Fchar_to_string
, 1);
2941 EXFUN (Fdelete_region
, 2);
2942 EXFUN (Fnarrow_to_region
, 2);
2944 EXFUN (Fuser_login_name
, 1);
2945 EXFUN (Fsystem_name
, 0);
2946 EXFUN (Fcurrent_time
, 0);
2947 EXFUN (Fget_internal_run_time
, 0);
2948 extern EMACS_INT
clip_to_bounds (EMACS_INT
, EMACS_INT
, EMACS_INT
);
2949 extern Lisp_Object
make_buffer_string (EMACS_INT
, EMACS_INT
, int);
2950 extern Lisp_Object
make_buffer_string_both (EMACS_INT
, EMACS_INT
, EMACS_INT
,
2952 extern void init_editfns (void);
2953 const char *get_system_name (void);
2954 extern void syms_of_editfns (void);
2955 EXFUN (Fconstrain_to_field
, 5);
2956 EXFUN (Ffield_end
, 3);
2957 extern void set_time_zone_rule (const char *);
2959 /* Defined in buffer.c */
2960 extern int mouse_face_overlay_overlaps (Lisp_Object
);
2961 extern void nsberror (Lisp_Object
) NO_RETURN
;
2962 EXFUN (Fset_buffer_multibyte
, 1);
2963 EXFUN (Foverlay_start
, 1);
2964 EXFUN (Foverlay_end
, 1);
2965 extern void adjust_overlays_for_insert (EMACS_INT
, EMACS_INT
);
2966 extern void adjust_overlays_for_delete (EMACS_INT
, EMACS_INT
);
2967 extern void fix_start_end_in_overlays (EMACS_INT
, EMACS_INT
);
2968 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
2969 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2970 extern int overlay_touches_p (EMACS_INT
);
2971 extern Lisp_Object Vbuffer_alist
;
2972 EXFUN (Fget_buffer
, 1);
2973 EXFUN (Fget_buffer_create
, 1);
2974 EXFUN (Fgenerate_new_buffer_name
, 2);
2975 EXFUN (Fset_buffer
, 1);
2976 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
2977 EXFUN (Fbarf_if_buffer_read_only
, 0);
2978 EXFUN (Fcurrent_buffer
, 0);
2979 EXFUN (Fother_buffer
, 3);
2980 EXFUN (Foverlay_get
, 2);
2981 EXFUN (Fbuffer_modified_p
, 1);
2982 EXFUN (Fset_buffer_modified_p
, 1);
2983 EXFUN (Fkill_buffer
, 1);
2984 EXFUN (Fkill_all_local_variables
, 0);
2985 EXFUN (Fbuffer_enable_undo
, 1);
2986 EXFUN (Ferase_buffer
, 0);
2987 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
2988 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
2989 extern struct buffer
*all_buffers
;
2990 EXFUN (Fprevious_overlay_change
, 1);
2991 EXFUN (Fbuffer_file_name
, 1);
2992 extern void init_buffer_once (void);
2993 extern void init_buffer (void);
2994 extern void syms_of_buffer (void);
2995 extern void keys_of_buffer (void);
2997 /* Defined in marker.c */
2999 EXFUN (Fmarker_position
, 1);
3000 EXFUN (Fmarker_buffer
, 1);
3001 EXFUN (Fcopy_marker
, 2);
3002 EXFUN (Fset_marker
, 3);
3003 extern EMACS_INT
marker_position (Lisp_Object
);
3004 extern EMACS_INT
marker_byte_position (Lisp_Object
);
3005 extern void clear_charpos_cache (struct buffer
*);
3006 extern EMACS_INT
charpos_to_bytepos (EMACS_INT
);
3007 extern EMACS_INT
buf_charpos_to_bytepos (struct buffer
*, EMACS_INT
);
3008 extern EMACS_INT
buf_bytepos_to_charpos (struct buffer
*, EMACS_INT
);
3009 extern void unchain_marker (struct Lisp_Marker
*marker
);
3010 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3011 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
3012 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3013 EMACS_INT
, EMACS_INT
);
3014 extern void syms_of_marker (void);
3016 /* Defined in fileio.c */
3018 extern Lisp_Object Qfile_error
;
3019 extern Lisp_Object Qfile_exists_p
;
3020 extern Lisp_Object Qfile_directory_p
;
3021 extern Lisp_Object Qinsert_file_contents
;
3022 extern Lisp_Object Qfile_name_history
;
3023 EXFUN (Ffind_file_name_handler
, 2);
3024 EXFUN (Ffile_name_as_directory
, 1);
3025 EXFUN (Fexpand_file_name
, 2);
3026 EXFUN (Ffile_name_nondirectory
, 1);
3027 EXFUN (Fsubstitute_in_file_name
, 1);
3028 EXFUN (Ffile_symlink_p
, 1);
3029 EXFUN (Fverify_visited_file_modtime
, 1);
3030 EXFUN (Ffile_exists_p
, 1);
3031 EXFUN (Ffile_name_absolute_p
, 1);
3032 EXFUN (Fdirectory_file_name
, 1);
3033 EXFUN (Ffile_name_directory
, 1);
3034 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3035 EXFUN (Ffile_accessible_directory_p
, 1);
3036 EXFUN (Funhandled_file_name_directory
, 1);
3037 EXFUN (Ffile_directory_p
, 1);
3038 EXFUN (Fwrite_region
, 7);
3039 EXFUN (Ffile_readable_p
, 1);
3040 EXFUN (Fread_file_name
, 6);
3041 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3042 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3043 extern void report_file_error (const char *, Lisp_Object
) NO_RETURN
;
3044 extern int internal_delete_file (Lisp_Object
);
3045 extern void syms_of_fileio (void);
3046 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
3047 extern Lisp_Object Qdelete_file
;
3049 /* Defined in abbrev.c */
3051 extern void syms_of_abbrev (void);
3053 /* Defined in search.c */
3054 extern void shrink_regexp_cache (void);
3055 EXFUN (Fstring_match
, 3);
3056 extern void restore_search_regs (void);
3057 EXFUN (Fmatch_data
, 3);
3058 EXFUN (Fset_match_data
, 2);
3059 EXFUN (Fmatch_beginning
, 1);
3060 EXFUN (Fmatch_end
, 1);
3061 extern void record_unwind_save_match_data (void);
3062 struct re_registers
;
3063 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3064 struct re_registers
*,
3065 Lisp_Object
, int, int);
3066 extern EMACS_INT
fast_string_match (Lisp_Object
, Lisp_Object
);
3067 extern EMACS_INT
fast_c_string_match_ignore_case (Lisp_Object
, const char *);
3068 extern EMACS_INT
fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3069 extern EMACS_INT
fast_looking_at (Lisp_Object
, EMACS_INT
, EMACS_INT
,
3070 EMACS_INT
, EMACS_INT
, Lisp_Object
);
3071 extern EMACS_INT
scan_buffer (int, EMACS_INT
, EMACS_INT
, EMACS_INT
,
3073 extern EMACS_INT
scan_newline (EMACS_INT
, EMACS_INT
, EMACS_INT
, EMACS_INT
,
3075 extern EMACS_INT
find_next_newline (EMACS_INT
, int);
3076 extern EMACS_INT
find_next_newline_no_quit (EMACS_INT
, EMACS_INT
);
3077 extern EMACS_INT
find_before_next_newline (EMACS_INT
, EMACS_INT
, EMACS_INT
);
3078 extern void syms_of_search (void);
3079 extern void clear_regexp_cache (void);
3081 /* Defined in minibuf.c */
3083 extern Lisp_Object Qcompletion_ignore_case
;
3084 extern Lisp_Object Vminibuffer_list
;
3085 extern Lisp_Object last_minibuf_string
;
3086 EXFUN (Fcompleting_read
, 8);
3087 EXFUN (Fread_from_minibuffer
, 7);
3088 EXFUN (Fread_variable
, 2);
3089 EXFUN (Fread_buffer
, 3);
3090 EXFUN (Fread_minibuffer
, 2);
3091 EXFUN (Feval_minibuffer
, 2);
3092 EXFUN (Fread_string
, 5);
3093 EXFUN (Fassoc_string
, 3);
3094 extern Lisp_Object
get_minibuffer (int);
3095 extern void init_minibuf_once (void);
3096 extern void syms_of_minibuf (void);
3098 /* Defined in callint.c */
3100 extern Lisp_Object Qminus
, Qplus
;
3101 extern Lisp_Object Qwhen
;
3102 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3103 EXFUN (Fprefix_numeric_value
, 1);
3104 extern void syms_of_callint (void);
3106 /* Defined in casefiddle.c */
3108 extern Lisp_Object Qidentity
;
3109 EXFUN (Fdowncase
, 1);
3111 EXFUN (Fupcase_region
, 2);
3112 EXFUN (Fupcase_initials
, 1);
3113 EXFUN (Fupcase_initials_region
, 2);
3114 extern void syms_of_casefiddle (void);
3115 extern void keys_of_casefiddle (void);
3117 /* Defined in casetab.c */
3119 EXFUN (Fset_case_table
, 1);
3120 EXFUN (Fset_standard_case_table
, 1);
3121 extern void init_casetab_once (void);
3122 extern void syms_of_casetab (void);
3124 /* Defined in keyboard.c */
3126 extern Lisp_Object echo_message_buffer
;
3127 extern struct kboard
*echo_kboard
;
3128 extern void cancel_echoing (void);
3129 extern Lisp_Object Qdisabled
, QCfilter
;
3130 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3131 extern Lisp_Object Qtop
;
3132 extern int input_pending
;
3133 EXFUN (Fdiscard_input
, 0);
3134 EXFUN (Frecursive_edit
, 0);
3135 EXFUN (Ftop_level
, 0) NO_RETURN
;
3136 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3137 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3138 extern void discard_mouse_events (void);
3139 EXFUN (Fevent_convert_list
, 1);
3140 EXFUN (Fread_key_sequence
, 5);
3141 EXFUN (Fset_input_interrupt_mode
, 1);
3142 EXFUN (Fset_input_mode
, 4);
3143 extern Lisp_Object pending_funcalls
;
3144 extern int detect_input_pending (void);
3145 extern int detect_input_pending_ignore_squeezables (void);
3146 extern int detect_input_pending_run_timers (int);
3147 extern void safe_run_hooks (Lisp_Object
);
3148 extern void cmd_error_internal (Lisp_Object
, const char *);
3149 extern Lisp_Object
command_loop_1 (void);
3150 extern Lisp_Object
recursive_edit_1 (void);
3151 extern void record_auto_save (void);
3153 extern void force_auto_save_soon (void);
3155 extern void init_keyboard (void);
3156 extern void syms_of_keyboard (void);
3157 extern void keys_of_keyboard (void);
3158 extern char *push_key_description (unsigned int, char *, int);
3161 /* Defined in indent.c */
3162 EXFUN (Fvertical_motion
, 2);
3163 EXFUN (Findent_to
, 2);
3164 EXFUN (Fmove_to_column
, 2);
3165 extern EMACS_INT
current_column (void);
3166 extern void invalidate_current_column (void);
3167 extern int indented_beyond_p (EMACS_INT
, EMACS_INT
, EMACS_INT
);
3168 extern void syms_of_indent (void);
3170 /* Defined in frame.c */
3171 #ifdef HAVE_WINDOW_SYSTEM
3172 #endif /* HAVE_WINDOW_SYSTEM */
3173 extern Lisp_Object Qonly
;
3174 extern Lisp_Object Qvisible
;
3175 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3176 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3177 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3179 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3181 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3182 EXFUN (Fselect_frame
, 2);
3183 EXFUN (Fselected_frame
, 0);
3184 EXFUN (Fwindow_frame
, 1);
3185 EXFUN (Fframe_root_window
, 1);
3186 EXFUN (Fframe_first_window
, 1);
3187 EXFUN (Fmake_frame_visible
, 1);
3188 EXFUN (Ficonify_frame
, 1);
3189 EXFUN (Fframe_parameter
, 2);
3190 EXFUN (Fmodify_frame_parameters
, 2);
3191 EXFUN (Fraise_frame
, 1);
3192 EXFUN (Fredirect_frame_focus
, 2);
3193 EXFUN (Fset_frame_selected_window
, 3);
3194 extern Lisp_Object
frame_buffer_list (Lisp_Object
);
3195 extern void frames_discard_buffer (Lisp_Object
);
3196 extern void set_frame_buffer_list (Lisp_Object
, Lisp_Object
);
3197 extern void syms_of_frame (void);
3199 /* Defined in emacs.c */
3200 extern char **initial_argv
;
3201 extern int initial_argc
;
3202 #if defined(HAVE_X_WINDOWS) || defined(HAVE_NS)
3203 extern int display_arg
;
3205 extern Lisp_Object
decode_env_path (const char *, const char *);
3206 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3207 extern Lisp_Object Qfile_name_handler_alist
;
3208 #ifdef FLOAT_CATCH_SIGILL
3209 extern void fatal_error_signal (int);
3211 EXFUN (Fkill_emacs
, 1) NO_RETURN
;
3213 void fixup_locale (void);
3214 void synchronize_system_messages_locale (void);
3215 void synchronize_system_time_locale (void);
3217 #define setlocale(category, locale)
3218 #define fixup_locale()
3219 #define synchronize_system_messages_locale()
3220 #define synchronize_system_time_locale()
3222 void shut_down_emacs (int, int, Lisp_Object
);
3223 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3224 extern int noninteractive
;
3226 /* Nonzero means remove site-lisp directories from load-path. */
3227 extern int no_site_lisp
;
3229 /* Pipe used to send exit notification to the daemon parent at
3231 extern int daemon_pipe
[2];
3232 #define IS_DAEMON (daemon_pipe[1] != 0)
3234 /* Nonzero means don't do use window-system-specific display code. */
3235 extern int inhibit_window_system
;
3236 /* Nonzero means that a filter or a sentinel is running. */
3237 extern int running_asynch_code
;
3239 /* Defined in process.c. */
3240 extern Lisp_Object QCtype
, Qlocal
;
3241 EXFUN (Fget_buffer_process
, 1);
3242 EXFUN (Fprocess_status
, 1);
3243 EXFUN (Fkill_process
, 2);
3244 EXFUN (Fwaiting_for_user_input_p
, 0);
3245 extern Lisp_Object Qprocessp
;
3246 extern void kill_buffer_processes (Lisp_Object
);
3247 extern int wait_reading_process_output (int, int, int, int,
3249 struct Lisp_Process
*,
3251 extern void add_keyboard_wait_descriptor (int);
3252 extern void delete_keyboard_wait_descriptor (int);
3253 extern void add_gpm_wait_descriptor (int);
3254 extern void delete_gpm_wait_descriptor (int);
3255 extern void close_process_descs (void);
3256 extern void init_process (void);
3257 extern void syms_of_process (void);
3258 extern void setup_process_coding_systems (Lisp_Object
);
3260 EXFUN (Fcall_process
, MANY
);
3261 extern int child_setup (int, int, int, char **, int, Lisp_Object
)
3266 extern void init_callproc_1 (void);
3267 extern void init_callproc (void);
3268 extern void set_initial_environment (void);
3269 extern void syms_of_callproc (void);
3271 /* Defined in doc.c */
3272 extern Lisp_Object Qfunction_documentation
;
3273 EXFUN (Fsubstitute_command_keys
, 1);
3274 extern Lisp_Object
read_doc_string (Lisp_Object
);
3275 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3276 extern void syms_of_doc (void);
3277 extern int read_bytecode_char (int);
3279 /* Defined in bytecode.c */
3280 extern Lisp_Object Qbytecode
;
3281 extern void syms_of_bytecode (void);
3282 extern struct byte_stack
*byte_stack_list
;
3284 extern void mark_byte_stack (void);
3286 extern void unmark_byte_stack (void);
3287 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3288 Lisp_Object
, int, Lisp_Object
*);
3290 /* Defined in macros.c */
3291 extern Lisp_Object Qexecute_kbd_macro
;
3292 EXFUN (Fexecute_kbd_macro
, 3);
3293 EXFUN (Fcancel_kbd_macro_events
, 0);
3294 extern void init_macros (void);
3295 extern void syms_of_macros (void);
3297 /* Defined in undo.c */
3298 extern Lisp_Object Qapply
;
3299 extern Lisp_Object Qinhibit_read_only
;
3300 EXFUN (Fundo_boundary
, 0);
3301 extern void truncate_undo_list (struct buffer
*);
3302 extern void record_marker_adjustment (Lisp_Object
, EMACS_INT
);
3303 extern void record_insert (EMACS_INT
, EMACS_INT
);
3304 extern void record_delete (EMACS_INT
, Lisp_Object
);
3305 extern void record_first_change (void);
3306 extern void record_change (EMACS_INT
, EMACS_INT
);
3307 extern void record_property_change (EMACS_INT
, EMACS_INT
,
3308 Lisp_Object
, Lisp_Object
,
3310 extern void syms_of_undo (void);
3311 /* Defined in textprop.c */
3312 extern Lisp_Object Qfont
, Qmouse_face
;
3313 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3314 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3315 extern Lisp_Object Qminibuffer_prompt
;
3317 EXFUN (Fnext_single_property_change
, 4);
3318 EXFUN (Fnext_single_char_property_change
, 4);
3319 EXFUN (Fprevious_single_property_change
, 4);
3320 EXFUN (Fget_text_property
, 3);
3321 EXFUN (Fput_text_property
, 5);
3322 EXFUN (Fprevious_char_property_change
, 2);
3323 EXFUN (Fnext_char_property_change
, 2);
3324 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3326 /* Defined in menu.c */
3327 extern void syms_of_menu (void);
3329 /* Defined in xmenu.c */
3330 EXFUN (Fx_popup_menu
, 2);
3331 EXFUN (Fx_popup_dialog
, 3);
3332 extern void syms_of_xmenu (void);
3334 /* Defined in termchar.h */
3335 struct tty_display_info
;
3337 /* Defined in termhooks.h */
3340 /* Defined in sysdep.c */
3341 #ifndef HAVE_GET_CURRENT_DIR_NAME
3342 extern char *get_current_dir_name (void);
3344 extern void stuff_char (char c
);
3345 extern void init_sigio (int);
3346 extern void sys_subshell (void);
3347 extern void sys_suspend (void);
3348 extern void discard_tty_input (void);
3349 extern void init_sys_modes (struct tty_display_info
*);
3350 extern void reset_sys_modes (struct tty_display_info
*);
3351 extern void init_all_sys_modes (void);
3352 extern void reset_all_sys_modes (void);
3353 extern void wait_for_termination (int);
3354 extern void interruptible_wait_for_termination (int);
3355 extern void flush_pending_output (int);
3356 extern void child_setup_tty (int);
3357 extern void setup_pty (int);
3358 extern int set_window_size (int, int, int);
3359 extern EMACS_INT
get_random (void);
3360 extern void seed_random (long);
3361 extern int emacs_open (const char *, int, int);
3362 extern int emacs_close (int);
3363 extern EMACS_INT
emacs_read (int, char *, EMACS_INT
);
3364 extern EMACS_INT
emacs_write (int, const char *, EMACS_INT
);
3365 enum { READLINK_BUFSIZE
= 1024 };
3366 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3368 extern void *memset (void *, int, size_t);
3371 extern void *memcpy (void *, void *, size_t);
3373 #ifndef HAVE_MEMMOVE
3374 extern void *memmove (void *, void *, size_t);
3377 extern int memcmp (void *, void *, size_t);
3380 EXFUN (Funlock_buffer
, 0);
3381 extern void unlock_all_files (void);
3382 extern void lock_file (Lisp_Object
);
3383 extern void unlock_file (Lisp_Object
);
3384 extern void unlock_buffer (struct buffer
*);
3385 extern void syms_of_filelock (void);
3386 extern void init_filelock (void);
3388 /* Defined in sound.c */
3389 extern void syms_of_sound (void);
3390 extern void init_sound (void);
3392 /* Defined in category.c */
3393 extern void init_category_once (void);
3394 extern Lisp_Object
char_category_set (int);
3395 extern void syms_of_category (void);
3397 /* Defined in ccl.c */
3398 extern void syms_of_ccl (void);
3400 /* Defined in dired.c */
3401 extern void syms_of_dired (void);
3402 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3403 Lisp_Object
, Lisp_Object
,
3406 /* Defined in term.c */
3407 extern int *char_ins_del_vector
;
3408 extern void mark_ttys (void);
3409 extern void syms_of_term (void);
3410 extern void fatal (const char *msgid
, ...)
3411 NO_RETURN
ATTRIBUTE_FORMAT_PRINTF (1, 2);
3413 /* Defined in terminal.c */
3414 EXFUN (Fframe_terminal
, 1);
3415 EXFUN (Fdelete_terminal
, 2);
3416 extern void syms_of_terminal (void);
3418 /* Defined in font.c */
3419 extern void syms_of_font (void);
3420 extern void init_font (void);
3422 #ifdef HAVE_WINDOW_SYSTEM
3423 /* Defined in fontset.c */
3424 extern void syms_of_fontset (void);
3426 /* Defined in xfns.c, w32fns.c, or macfns.c */
3427 extern Lisp_Object Qfont_param
;
3428 EXFUN (Fxw_display_color_p
, 1);
3429 EXFUN (Fx_focus_frame
, 1);
3432 /* Defined in xfaces.c */
3433 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3434 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3435 extern Lisp_Object Qmode_line_inactive
;
3436 extern Lisp_Object Qface
;
3437 extern Lisp_Object Qnormal
;
3438 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3439 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3440 extern Lisp_Object Vface_alternative_font_family_alist
;
3441 extern Lisp_Object Vface_alternative_font_registry_alist
;
3442 EXFUN (Fclear_face_cache
, 1);
3443 EXFUN (Fx_load_color_file
, 1);
3444 extern void syms_of_xfaces (void);
3446 #ifdef HAVE_X_WINDOWS
3447 /* Defined in xfns.c */
3448 extern void syms_of_xfns (void);
3450 /* Defined in xsmfns.c */
3451 extern void syms_of_xsmfns (void);
3453 /* Defined in xselect.c */
3454 extern void syms_of_xselect (void);
3456 /* Defined in xterm.c */
3457 extern void syms_of_xterm (void);
3458 #endif /* HAVE_X_WINDOWS */
3460 #ifdef HAVE_WINDOW_SYSTEM
3461 /* Defined in xterm.c, nsterm.m, w32term.c */
3462 extern char *x_get_keysym_name (int);
3463 #endif /* HAVE_WINDOW_SYSTEM */
3466 /* Defined in msdos.c */
3467 EXFUN (Fmsdos_downcase_filename
, 1);
3471 /* Defined in xml.c */
3472 extern void syms_of_xml (void);
3476 /* Defined in (x|w32)fns.c, nsfns.m... */
3477 extern int have_menus_p (void);
3481 /* Defined in dbusbind.c */
3482 void syms_of_dbusbind (void);
3486 /* Defined in msdos.c, w32.c */
3487 extern char *emacs_root_dir (void);
3490 /* Nonzero means Emacs has already been initialized.
3491 Used during startup to detect startup of dumped Emacs. */
3492 extern int initialized
;
3494 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3496 extern POINTER_TYPE
*xmalloc (size_t);
3497 extern POINTER_TYPE
*xrealloc (POINTER_TYPE
*, size_t);
3498 extern void xfree (POINTER_TYPE
*);
3500 extern char *xstrdup (const char *);
3502 extern char *egetenv (const char *);
3504 /* Set up the name of the machine we're running on. */
3505 extern void init_system_name (void);
3507 /* Some systems (e.g., NT) use a different path separator than Unix,
3508 in addition to a device separator. Set the path separator
3509 to '/', and don't test for a device separator in IS_ANY_SEP. */
3511 #define DIRECTORY_SEP '/'
3512 #ifndef IS_DIRECTORY_SEP
3513 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3515 #ifndef IS_DEVICE_SEP
3517 #define IS_DEVICE_SEP(_c_) 0
3519 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3523 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3526 #define SWITCH_ENUM_CAST(x) (x)
3528 /* Loop over Lisp list LIST. Signal an error if LIST is not a proper
3529 list, or if it contains circles.
3531 HARE and TORTOISE should be the names of Lisp_Object variables, and
3532 N should be the name of an EMACS_INT variable declared in the
3533 function where the macro is used. Each nested loop should use
3536 In the loop body, HARE is set to each cons of LIST, and N is the
3537 length of the list processed so far. */
3539 #define LIST_END_P(list, obj) \
3544 : (wrong_type_argument (Qlistp, (list))), 1))
3546 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
3548 # define IF_LINT(Code) Code
3550 # define IF_LINT(Code) /* empty */
3553 /* The ubiquitous min and max macros. */
3559 #define min(a, b) ((a) < (b) ? (a) : (b))
3560 #define max(a, b) ((a) > (b) ? (a) : (b))
3562 /* We used to use `abs', but that clashes with system headers on some
3563 platforms, and using a name reserved by Standard C is a bad idea
3566 #define eabs(x) ((x) < 0 ? -(x) : (x))
3569 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3572 #define make_fixnum_or_float(val) \
3573 (FIXNUM_OVERFLOW_P (val) \
3574 ? make_float (val) \
3575 : make_number ((EMACS_INT)(val)))
3578 /* Checks the `cycle check' variable CHECK to see if it indicates that
3579 EL is part of a cycle; CHECK must be either Qnil or a value returned
3580 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3581 elements after which a cycle might be suspected; after that many
3582 elements, this macro begins consing in order to keep more precise
3585 Returns nil if a cycle was detected, otherwise a new value for CHECK
3588 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3589 the caller should make sure that's ok. */
3591 #define CYCLE_CHECK(check, el, suspicious) \
3594 : (INTEGERP (check) \
3595 ? (XFASTINT (check) < (suspicious) \
3596 ? make_number (XFASTINT (check) + 1) \
3597 : Fcons (el, Qnil)) \
3598 : (!NILP (Fmemq ((el), (check))) \
3600 : Fcons ((el), (check)))))
3603 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3604 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3606 #define MAX_ALLOCA 16*1024
3608 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3610 #define USE_SAFE_ALLOCA \
3611 int sa_count = (int) SPECPDL_INDEX (), sa_must_free = 0
3613 /* SAFE_ALLOCA allocates a simple buffer. */
3615 #define SAFE_ALLOCA(buf, type, size) \
3617 if ((size) < MAX_ALLOCA) \
3618 buf = (type) alloca (size); \
3621 buf = (type) xmalloc (size); \
3623 record_unwind_protect (safe_alloca_unwind, \
3624 make_save_value (buf, 0)); \
3628 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3630 #define SAFE_FREE() \
3632 if (sa_must_free) { \
3634 unbind_to (sa_count, Qnil); \
3639 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3641 #define SAFE_ALLOCA_LISP(buf, nelt) \
3643 int size_ = (nelt) * sizeof (Lisp_Object); \
3644 if (size_ < MAX_ALLOCA) \
3645 buf = (Lisp_Object *) alloca (size_); \
3649 buf = (Lisp_Object *) xmalloc (size_); \
3650 arg_ = make_save_value (buf, nelt); \
3651 XSAVE_VALUE (arg_)->dogc = 1; \
3653 record_unwind_protect (safe_alloca_unwind, arg_); \
3658 #include "globals.h"
3660 #endif /* EMACS_LISP_H */