(custom-guess-name-alist): -alist variables should use the `alist' type.
[emacs.git] / src / lisp.h
blob762d34abb9c81562aaddd3afafd5772462aa3bac
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/>. */
20 #ifndef EMACS_LISP_H
21 #define EMACS_LISP_H
23 #include <stdarg.h>
24 #include <stddef.h>
25 #include <inttypes.h>
26 #include <limits.h>
28 #include <intprops.h>
30 /* Use the configure flag --enable-checking[=LIST] to enable various
31 types of run time checks for Lisp objects. */
33 #ifdef GC_CHECK_CONS_LIST
34 extern void check_cons_list (void);
35 #define CHECK_CONS_LIST() check_cons_list ()
36 #else
37 #define CHECK_CONS_LIST() ((void) 0)
38 #endif
40 /* Temporarily disable wider-than-pointer integers until they're tested more.
41 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
42 /* #undef WIDE_EMACS_INT */
44 /* These are default choices for the types to use. */
45 #ifndef EMACS_INT
46 # if BITS_PER_LONG < BITS_PER_LONG_LONG && defined WIDE_EMACS_INT
47 # define EMACS_INT long long
48 # define BITS_PER_EMACS_INT BITS_PER_LONG_LONG
49 # define pI "ll"
50 # elif BITS_PER_INT < BITS_PER_LONG
51 # define EMACS_INT long
52 # define BITS_PER_EMACS_INT BITS_PER_LONG
53 # define pI "l"
54 # else
55 # define EMACS_INT int
56 # define BITS_PER_EMACS_INT BITS_PER_INT
57 # define pI ""
58 # endif
59 #endif
60 #ifndef EMACS_UINT
61 # define EMACS_UINT unsigned EMACS_INT
62 #endif
64 /* Use pD to format ptrdiff_t values, which suffice for indexes into
65 buffers and strings. Emacs never allocates objects larger than
66 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
67 In C99, pD can always be "t"; configure it here for the sake of
68 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
69 #if PTRDIFF_MAX == INT_MAX
70 # define pD ""
71 #elif PTRDIFF_MAX == LONG_MAX
72 # define pD "l"
73 #elif PTRDIFF_MAX == LLONG_MAX
74 # define pD "ll"
75 #else
76 # define pD "t"
77 #endif
79 /* Extra internal type checking? */
81 #ifdef ENABLE_CHECKING
83 extern void die (const char *, const char *, int) NO_RETURN;
85 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
86 it to 1 using a debugger to temporarily disable aborting on
87 detected internal inconsistencies or error conditions.
89 Testing suppress_checking after the supplied condition ensures that
90 the side effects produced by CHECK will be consistent, independent
91 of whether ENABLE_CHECKING is defined, or whether the checks are
92 suppressed at run time.
94 In some cases, a good compiler may be able to optimize away the
95 CHECK macro altogether, e.g., if XSTRING (x) uses CHECK to test
96 STRINGP (x), but a particular use of XSTRING is invoked only after
97 testing that STRINGP (x) is true, making the test redundant. */
99 extern int suppress_checking EXTERNALLY_VISIBLE;
101 #define CHECK(check,msg) (((check) || suppress_checking \
102 ? (void) 0 \
103 : die ((msg), __FILE__, __LINE__)), \
105 #else
107 /* Produce same side effects and result, but don't complain. */
108 #define CHECK(check,msg) ((check),0)
110 #endif
112 /* Define an Emacs version of "assert", since some system ones are
113 flaky. */
114 #ifndef ENABLE_CHECKING
115 #define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
116 #else /* ENABLE_CHECKING */
117 #if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
118 #define eassert(cond) CHECK(cond,"assertion failed: " #cond)
119 #else
120 #define eassert(cond) CHECK(cond,"assertion failed")
121 #endif
122 #endif /* ENABLE_CHECKING */
124 /* Use the configure flag --enable-use-lisp-union-type to make
125 Lisp_Object use a union type instead of the default int. The flag
126 causes USE_LISP_UNION_TYPE to be defined. */
128 /***** Select the tagging scheme. *****/
129 /* There are basically two options that control the tagging scheme:
130 - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
131 of an integer.
132 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
133 always 0, and we can thus use them to hold tag bits, without
134 restricting our addressing space.
136 If USE_LSB_TAG is not set, then we use the top 3 bits for tagging, thus
137 restricting our possible address range. Currently USE_LSB_TAG is not
138 allowed together with a union. This is not due to any fundamental
139 technical (or political ;-) problem: nobody wrote the code to do it yet.
141 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
142 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
143 on the few static Lisp_Objects used: all the defsubr as well
144 as the two special buffers buffer_defaults and buffer_local_symbols. */
146 /* First, try and define DECL_ALIGN(type,var) which declares a static
147 variable VAR of type TYPE with the added requirement that it be
148 TYPEBITS-aligned. */
149 #ifndef NO_DECL_ALIGN
150 # ifndef DECL_ALIGN
151 # if HAVE_ATTRIBUTE_ALIGNED
152 # define DECL_ALIGN(type, var) \
153 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
154 # else
155 /* What directives do other compilers use? */
156 # endif
157 # endif
158 #endif
160 /* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8. */
161 #if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
162 || defined DARWIN_OS || defined __sun)
163 /* We also need to be able to specify mult-of-8 alignment on static vars. */
164 # if defined DECL_ALIGN
165 # define USE_LSB_TAG
166 # endif
167 #endif
169 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
170 #ifndef DECL_ALIGN
171 # ifdef USE_LSB_TAG
172 # error "USE_LSB_TAG used without defining DECL_ALIGN"
173 # endif
174 # define DECL_ALIGN(type, var) type var
175 #endif
178 /* Define the fundamental Lisp data structures. */
180 /* If USE_2_TAGBITS_FOR_INTS is defined, then Lisp integers use
181 2 tags, to give them one extra bit, thus extending their range from
182 e.g -2^28..2^28-1 to -2^29..2^29-1. */
183 #define USE_2_TAGS_FOR_INTS
185 /* Making it work for the union case is too much trouble. */
186 #ifdef USE_LISP_UNION_TYPE
187 # undef USE_2_TAGS_FOR_INTS
188 #endif
190 /* This is the set of Lisp data types. */
192 #if !defined USE_2_TAGS_FOR_INTS
193 # define LISP_INT_TAG Lisp_Int
194 # define case_Lisp_Int case Lisp_Int
195 # define LISP_STRING_TAG 4
196 # define LISP_INT_TAG_P(x) ((x) == Lisp_Int)
197 #else
198 # define LISP_INT_TAG Lisp_Int0
199 # define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
200 # ifdef USE_LSB_TAG
201 # define LISP_INT1_TAG 4
202 # define LISP_STRING_TAG 1
203 # define LISP_INT_TAG_P(x) (((x) & 3) == 0)
204 # else
205 # define LISP_INT1_TAG 1
206 # define LISP_STRING_TAG 4
207 # define LISP_INT_TAG_P(x) (((x) & 6) == 0)
208 # endif
209 #endif
211 enum Lisp_Type
213 /* Integer. XINT (obj) is the integer value. */
214 #ifdef USE_2_TAGS_FOR_INTS
215 Lisp_Int0 = 0,
216 Lisp_Int1 = LISP_INT1_TAG,
217 #else
218 Lisp_Int = 0,
219 #endif
221 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
222 Lisp_Symbol = 2,
224 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
225 whose first member indicates the subtype. */
226 Lisp_Misc = 3,
228 /* String. XSTRING (object) points to a struct Lisp_String.
229 The length of the string, and its contents, are stored therein. */
230 Lisp_String = LISP_STRING_TAG,
232 /* Vector of Lisp objects, or something resembling it.
233 XVECTOR (object) points to a struct Lisp_Vector, which contains
234 the size and contents. The size field also contains the type
235 information, if it's not a real vector object. */
236 Lisp_Vectorlike = 5,
238 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
239 Lisp_Cons = 6,
241 Lisp_Float = 7,
244 /* This is the set of data types that share a common structure.
245 The first member of the structure is a type code from this set.
246 The enum values are arbitrary, but we'll use large numbers to make it
247 more likely that we'll spot the error if a random word in memory is
248 mistakenly interpreted as a Lisp_Misc. */
249 enum Lisp_Misc_Type
251 Lisp_Misc_Free = 0x5eab,
252 Lisp_Misc_Marker,
253 Lisp_Misc_Overlay,
254 Lisp_Misc_Save_Value,
255 /* Currently floats are not a misc type,
256 but let's define this in case we want to change that. */
257 Lisp_Misc_Float,
258 /* This is not a type code. It is for range checking. */
259 Lisp_Misc_Limit
262 /* These are the types of forwarding objects used in the value slot
263 of symbols for special built-in variables whose value is stored in
264 C variables. */
265 enum Lisp_Fwd_Type
267 Lisp_Fwd_Int, /* Fwd to a C `int' variable. */
268 Lisp_Fwd_Bool, /* Fwd to a C boolean var. */
269 Lisp_Fwd_Obj, /* Fwd to a C Lisp_Object variable. */
270 Lisp_Fwd_Buffer_Obj, /* Fwd to a Lisp_Object field of buffers. */
271 Lisp_Fwd_Kboard_Obj, /* Fwd to a Lisp_Object field of kboards. */
274 #ifndef GCTYPEBITS
275 #define GCTYPEBITS 3
276 #endif
278 /* These values are overridden by the m- file on some machines. */
279 #ifndef VALBITS
280 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
281 #endif
283 #ifdef USE_LISP_UNION_TYPE
285 #ifndef WORDS_BIGENDIAN
287 /* Definition of Lisp_Object for little-endian machines. */
289 typedef
290 union Lisp_Object
292 /* Used for comparing two Lisp_Objects;
293 also, positive integers can be accessed fast this way. */
294 EMACS_INT i;
296 struct
298 /* Use explict signed, the signedness of a bit-field of type
299 int is implementation defined. */
300 signed EMACS_INT val : VALBITS;
301 enum Lisp_Type type : GCTYPEBITS;
302 } s;
303 struct
305 EMACS_UINT val : VALBITS;
306 enum Lisp_Type type : GCTYPEBITS;
307 } u;
309 Lisp_Object;
311 #else /* If WORDS_BIGENDIAN */
313 typedef
314 union Lisp_Object
316 /* Used for comparing two Lisp_Objects;
317 also, positive integers can be accessed fast this way. */
318 EMACS_INT i;
320 struct
322 enum Lisp_Type type : GCTYPEBITS;
323 /* Use explict signed, the signedness of a bit-field of type
324 int is implementation defined. */
325 signed EMACS_INT val : VALBITS;
326 } s;
327 struct
329 enum Lisp_Type type : GCTYPEBITS;
330 EMACS_UINT val : VALBITS;
331 } u;
333 Lisp_Object;
335 #endif /* WORDS_BIGENDIAN */
337 #ifdef __GNUC__
338 static inline Lisp_Object
339 LISP_MAKE_RVALUE (Lisp_Object o)
341 return o;
343 #else
344 /* This is more portable to pre-C99 non-GCC compilers, but for
345 backwards compatibility GCC still accepts an old GNU extension
346 which caused this to only generate a warning. */
347 #define LISP_MAKE_RVALUE(o) (0 ? (o) : (o))
348 #endif
350 #else /* USE_LISP_UNION_TYPE */
352 /* If union type is not wanted, define Lisp_Object as just a number. */
354 typedef EMACS_INT Lisp_Object;
355 #define LISP_MAKE_RVALUE(o) (0+(o))
356 #endif /* USE_LISP_UNION_TYPE */
358 /* In the size word of a vector, this bit means the vector has been marked.
359 (Shift -1 left, not 1, to avoid provoking overflow diagnostics.) */
361 #define ARRAY_MARK_FLAG ((EMACS_INT) -1 << (BITS_PER_EMACS_INT - 1))
363 /* In the size word of a struct Lisp_Vector, this bit means it's really
364 some other vector-like object. */
365 #define PSEUDOVECTOR_FLAG ((EMACS_INT) 1 << (BITS_PER_EMACS_INT - 2))
367 /* In a pseudovector, the size field actually contains a word with one
368 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
369 indicate the actual type.
370 We use a bitset, even tho only one of the bits can be set at any
371 particular time just so as to be able to use micro-optimizations such as
372 testing membership of a particular subset of pseudovectors in Fequal.
373 It is not crucial, but there are plenty of bits here, so why not do it? */
374 enum pvec_type
376 PVEC_NORMAL_VECTOR = 0,
377 PVEC_PROCESS = 0x200,
378 PVEC_FRAME = 0x400,
379 PVEC_COMPILED = 0x800,
380 PVEC_WINDOW = 0x1000,
381 PVEC_WINDOW_CONFIGURATION = 0x2000,
382 PVEC_SUBR = 0x4000,
383 PVEC_CHAR_TABLE = 0x8000,
384 PVEC_BOOL_VECTOR = 0x10000,
385 PVEC_BUFFER = 0x20000,
386 PVEC_HASH_TABLE = 0x40000,
387 PVEC_TERMINAL = 0x80000,
388 PVEC_SUB_CHAR_TABLE = 0x100000,
389 PVEC_FONT = 0x200000,
390 PVEC_OTHER = 0x400000,
391 PVEC_TYPE_MASK = 0x7ffe00
393 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
394 GDB. It doesn't work on OS Alpha. Moved to a variable in
395 emacs.c. */
396 PVEC_FLAG = PSEUDOVECTOR_FLAG
397 #endif
400 /* For convenience, we also store the number of elements in these bits.
401 Note that this size is not necessarily the memory-footprint size, but
402 only the number of Lisp_Object fields (that need to be traced by the GC).
403 The distinction is used e.g. by Lisp_Process which places extra
404 non-Lisp_Object fields at the end of the structure. */
405 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
407 /* Number of bits to put in each character in the internal representation
408 of bool vectors. This should not vary across implementations. */
409 #define BOOL_VECTOR_BITS_PER_CHAR 8
411 /* These macros extract various sorts of values from a Lisp_Object.
412 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
413 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
415 #ifndef USE_LISP_UNION_TYPE
417 /* Return a perfect hash of the Lisp_Object representation. */
418 #define XHASH(a) (a)
420 #ifdef USE_LSB_TAG
422 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
423 #define XTYPE(a) ((enum Lisp_Type) ((a) & TYPEMASK))
424 #ifdef USE_2_TAGS_FOR_INTS
425 # define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
426 # define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
427 # define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
428 #else
429 # define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
430 # define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
431 # define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
432 #endif
433 #define XSET(var, type, ptr) \
434 (eassert (XTYPE ((intptr_t) (ptr)) == 0), /* Check alignment. */ \
435 (var) = (type) | (intptr_t) (ptr))
437 #define XPNTR(a) ((intptr_t) ((a) & ~TYPEMASK))
439 #else /* not USE_LSB_TAG */
441 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
443 /* One need to override this if there must be high bits set in data space
444 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
445 on all machines, but would penalize machines which don't need it)
447 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
449 /* For integers known to be positive, XFASTINT provides fast retrieval
450 and XSETFASTINT provides fast storage. This takes advantage of the
451 fact that Lisp_Int is 0. */
452 #define XFASTINT(a) ((a) + 0)
453 #define XSETFASTINT(a, b) ((a) = (b))
455 /* Extract the value of a Lisp_Object as a (un)signed integer. */
457 #ifdef USE_2_TAGS_FOR_INTS
458 # define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
459 # define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
460 # define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
461 #else
462 # define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
463 >> (BITS_PER_EMACS_INT - VALBITS))
464 # define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
465 # define make_number(N) \
466 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
467 #endif
469 #define XSET(var, type, ptr) \
470 ((var) = ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
471 + ((intptr_t) (ptr) & VALMASK)))
473 #ifdef DATA_SEG_BITS
474 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
475 which were stored in a Lisp_Object */
476 #define XPNTR(a) ((uintptr_t) (((a) & VALMASK)) | DATA_SEG_BITS))
477 #else
478 #define XPNTR(a) ((uintptr_t) ((a) & VALMASK))
479 #endif
481 #endif /* not USE_LSB_TAG */
483 #else /* USE_LISP_UNION_TYPE */
485 #ifdef USE_2_TAGS_FOR_INTS
486 # error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
487 #endif
489 #define XHASH(a) ((a).i)
490 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
491 #define XINT(a) ((EMACS_INT) (a).s.val)
492 #define XUINT(a) ((EMACS_UINT) (a).u.val)
494 #ifdef USE_LSB_TAG
496 # define XSET(var, vartype, ptr) \
497 (eassert ((((uintptr_t) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0), \
498 (var).u.val = ((uintptr_t) (ptr)) >> GCTYPEBITS, \
499 (var).u.type = ((char) (vartype)))
501 /* Some versions of gcc seem to consider the bitfield width when issuing
502 the "cast to pointer from integer of different size" warning, so the
503 cast is here to widen the value back to its natural size. */
504 # define XPNTR(v) ((intptr_t) (v).s.val << GCTYPEBITS)
506 #else /* !USE_LSB_TAG */
508 /* For integers known to be positive, XFASTINT provides fast retrieval
509 and XSETFASTINT provides fast storage. This takes advantage of the
510 fact that Lisp_Int is 0. */
511 # define XFASTINT(a) ((a).i + 0)
512 # define XSETFASTINT(a, b) ((a).i = (b))
514 # define XSET(var, vartype, ptr) \
515 (((var).s.val = ((intptr_t) (ptr))), ((var).s.type = ((char) (vartype))))
517 #ifdef DATA_SEG_BITS
518 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
519 which were stored in a Lisp_Object */
520 #define XPNTR(a) ((intptr_t) (XUINT (a) | DATA_SEG_BITS))
521 #else
522 #define XPNTR(a) ((intptr_t) XUINT (a))
523 #endif
525 #endif /* !USE_LSB_TAG */
527 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
528 #define make_number(N) \
529 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
530 #else
531 extern Lisp_Object make_number (EMACS_INT);
532 #endif
534 #endif /* USE_LISP_UNION_TYPE */
536 /* For integers known to be positive, XFASTINT sometimes provides
537 faster retrieval and XSETFASTINT provides faster storage.
538 If not, fallback on the non-accelerated path. */
539 #ifndef XFASTINT
540 # define XFASTINT(a) (XINT (a))
541 # define XSETFASTINT(a, b) (XSETINT (a, b))
542 #endif
544 #define EQ(x, y) (XHASH (x) == XHASH (y))
546 /* Number of bits in a fixnum, including the sign bit. */
547 #ifdef USE_2_TAGS_FOR_INTS
548 # define FIXNUM_BITS (VALBITS + 1)
549 #else
550 # define FIXNUM_BITS VALBITS
551 #endif
553 /* Mask indicating the significant bits of a fixnum. */
554 #define INTMASK (((EMACS_INT) 1 << FIXNUM_BITS) - 1)
556 /* Largest and smallest representable fixnum values. These are the C
557 values. */
558 #define MOST_POSITIVE_FIXNUM (INTMASK / 2)
559 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
561 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
562 written this way so that it also works if I is of unsigned
563 type or if I is a NaN. */
565 #define FIXNUM_OVERFLOW_P(i) \
566 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
568 /* Extract a value or address from a Lisp_Object. */
570 #define XCONS(a) (eassert (CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
571 #define XVECTOR(a) (eassert (VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
572 #define XSTRING(a) (eassert (STRINGP(a)),(struct Lisp_String *) XPNTR(a))
573 #define XSYMBOL(a) (eassert (SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
574 #define XFLOAT(a) (eassert (FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
576 /* Misc types. */
578 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
579 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC(a)->u_any))
580 #define XMISCTYPE(a) (XMISCANY (a)->type)
581 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC(a)->u_marker))
582 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
583 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
585 /* Forwarding object types. */
587 #define XFWDTYPE(a) (a->u_intfwd.type)
588 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
589 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
590 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
591 #define XBUFFER_OBJFWD(a) \
592 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
593 #define XKBOARD_OBJFWD(a) \
594 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
596 /* Pseudovector types. */
598 #define XPROCESS(a) (eassert (PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
599 #define XWINDOW(a) (eassert (WINDOWP(a)),(struct window *) XPNTR(a))
600 #define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
601 #define XSUBR(a) (eassert (SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
602 #define XBUFFER(a) (eassert (BUFFERP(a)),(struct buffer *) XPNTR(a))
603 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
604 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR(a))
605 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
607 /* Construct a Lisp_Object from a value or address. */
609 #define XSETINT(a, b) (a) = make_number (b)
610 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
611 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
612 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
613 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
614 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
616 /* Misc types. */
618 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
619 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
621 /* Pseudovector types. */
623 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE(v, header.size, code)
624 #define XSETTYPED_PVECTYPE(v, size_member, code) \
625 ((v)->size_member |= PSEUDOVECTOR_FLAG | (code))
626 #define XSETPVECTYPESIZE(v, code, sizeval) \
627 ((v)->header.size = PSEUDOVECTOR_FLAG | (code) | (sizeval))
629 /* The cast to struct vectorlike_header * avoids aliasing issues. */
630 #define XSETPSEUDOVECTOR(a, b, code) \
631 XSETTYPED_PSEUDOVECTOR(a, b, \
632 ((struct vectorlike_header *) XPNTR (a))->size, \
633 code)
634 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
635 (XSETVECTOR (a, b), \
636 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
637 == (PSEUDOVECTOR_FLAG | (code))))
639 #define XSETWINDOW_CONFIGURATION(a, b) \
640 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
641 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
642 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
643 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
644 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
645 #define XSETSUBR(a, b) \
646 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
647 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
648 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
649 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
650 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
651 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
653 /* Convenience macros for dealing with Lisp arrays. */
655 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
656 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
657 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
658 #define ASET(ARRAY, IDX, VAL) \
659 (eassert ((IDX) == (IDX)), \
660 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
661 AREF ((ARRAY), (IDX)) = (VAL))
663 /* Convenience macros for dealing with Lisp strings. */
665 #define SDATA(string) (XSTRING (string)->data + 0)
666 #define SREF(string, index) (SDATA (string)[index] + 0)
667 #define SSET(string, index, new) (SDATA (string)[index] = (new))
668 #define SCHARS(string) (XSTRING (string)->size + 0)
669 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
671 /* Avoid "differ in sign" warnings. */
672 #define SSDATA(x) ((char *) SDATA (x))
674 #define STRING_SET_CHARS(string, newsize) \
675 (XSTRING (string)->size = (newsize))
677 #define STRING_COPYIN(string, index, new, count) \
678 memcpy (SDATA (string) + index, new, count)
680 /* Type checking. */
682 #define CHECK_TYPE(ok, Qxxxp, x) \
683 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
687 /* See the macros in intervals.h. */
689 typedef struct interval *INTERVAL;
691 /* Complain if object is not string or buffer type */
692 #define CHECK_STRING_OR_BUFFER(x) \
693 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
696 /* In a cons, the markbit of the car is the gc mark bit */
698 struct Lisp_Cons
700 /* Please do not use the names of these elements in code other
701 than the core lisp implementation. Use XCAR and XCDR below. */
702 #ifdef HIDE_LISP_IMPLEMENTATION
703 Lisp_Object car_;
704 union
706 Lisp_Object cdr_;
707 struct Lisp_Cons *chain;
708 } u;
709 #else
710 Lisp_Object car;
711 union
713 Lisp_Object cdr;
714 struct Lisp_Cons *chain;
715 } u;
716 #endif
719 /* Take the car or cdr of something known to be a cons cell. */
720 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
721 of code that has to know what a cons cell looks like. Other code not
722 part of the basic lisp implementation should assume that the car and cdr
723 fields are not accessible as lvalues. (What if we want to switch to
724 a copying collector someday? Cached cons cell field addresses may be
725 invalidated at arbitrary points.) */
726 #ifdef HIDE_LISP_IMPLEMENTATION
727 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
728 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
729 #else
730 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
731 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
732 #endif
734 /* Use these from normal code. */
735 #define XCAR(c) LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
736 #define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))
738 /* Use these to set the fields of a cons cell.
740 Note that both arguments may refer to the same object, so 'n'
741 should not be read after 'c' is first modified. Also, neither
742 argument should be evaluated more than once; side effects are
743 especially common in the second argument. */
744 #define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
745 #define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))
747 /* Take the car or cdr of something whose type is not known. */
748 #define CAR(c) \
749 (CONSP ((c)) ? XCAR ((c)) \
750 : NILP ((c)) ? Qnil \
751 : wrong_type_argument (Qlistp, (c)))
753 #define CDR(c) \
754 (CONSP ((c)) ? XCDR ((c)) \
755 : NILP ((c)) ? Qnil \
756 : wrong_type_argument (Qlistp, (c)))
758 /* Take the car or cdr of something whose type is not known. */
759 #define CAR_SAFE(c) \
760 (CONSP ((c)) ? XCAR ((c)) : Qnil)
762 #define CDR_SAFE(c) \
763 (CONSP ((c)) ? XCDR ((c)) : Qnil)
765 /* Nonzero if STR is a multibyte string. */
766 #define STRING_MULTIBYTE(STR) \
767 (XSTRING (STR)->size_byte >= 0)
769 /* Return the length in bytes of STR. */
771 #ifdef GC_CHECK_STRING_BYTES
773 struct Lisp_String;
774 extern EMACS_INT string_bytes (struct Lisp_String *);
775 #define STRING_BYTES(S) string_bytes ((S))
777 #else /* not GC_CHECK_STRING_BYTES */
779 #define STRING_BYTES(STR) \
780 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
782 #endif /* not GC_CHECK_STRING_BYTES */
784 /* An upper bound on the number of bytes in a Lisp string, not
785 counting the terminating null. This a tight enough bound to
786 prevent integer overflow errors that would otherwise occur during
787 string size calculations. A string cannot contain more bytes than
788 a fixnum can represent, nor can it be so long that C pointer
789 arithmetic stops working on the string plus its terminating null.
790 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
791 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
792 would expose alloc.c internal details that we'd rather keep
793 private. The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is
794 signed. */
795 #define STRING_BYTES_BOUND \
796 min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1)
798 /* Mark STR as a unibyte string. */
799 #define STRING_SET_UNIBYTE(STR) \
800 do { if (EQ (STR, empty_multibyte_string)) \
801 (STR) = empty_unibyte_string; \
802 else XSTRING (STR)->size_byte = -1; } while (0)
804 /* Mark STR as a multibyte string. Assure that STR contains only
805 ASCII characters in advance. */
806 #define STRING_SET_MULTIBYTE(STR) \
807 do { if (EQ (STR, empty_unibyte_string)) \
808 (STR) = empty_multibyte_string; \
809 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
811 /* Get text properties. */
812 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
814 /* Set text properties. */
815 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
817 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
819 struct Lisp_String
821 EMACS_INT size;
822 EMACS_INT size_byte;
823 INTERVAL intervals; /* text properties in this string */
824 unsigned char *data;
827 /* Header of vector-like objects. This documents the layout constraints on
828 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
829 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
830 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
831 because when two such pointers potentially alias, a compiler won't
832 incorrectly reorder loads and stores to their size fields. See
833 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
834 struct vectorlike_header
836 EMACS_UINT size;
838 /* Pointer to the next vector-like object. It is generally a buffer or a
839 Lisp_Vector alias, so for convenience it is a union instead of a
840 pointer: this way, one can write P->next.vector instead of ((struct
841 Lisp_Vector *) P->next). */
842 union {
843 struct buffer *buffer;
844 struct Lisp_Vector *vector;
845 } next;
848 struct Lisp_Vector
850 struct vectorlike_header header;
851 Lisp_Object contents[1];
854 /* If a struct is made to look like a vector, this macro returns the length
855 of the shortest vector that would hold that struct. */
856 #define VECSIZE(type) ((sizeof (type) \
857 - offsetof (struct Lisp_Vector, contents[0]) \
858 + sizeof(Lisp_Object) - 1) /* round up */ \
859 / sizeof (Lisp_Object))
861 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
862 at the end and we need to compute the number of Lisp_Object fields (the
863 ones that the GC needs to trace). */
864 #define PSEUDOVECSIZE(type, nonlispfield) \
865 ((offsetof(type, nonlispfield) - offsetof(struct Lisp_Vector, contents[0])) \
866 / sizeof (Lisp_Object))
868 /* A char-table is a kind of vectorlike, with contents are like a
869 vector but with a few other slots. For some purposes, it makes
870 sense to handle a char-table with type struct Lisp_Vector. An
871 element of a char table can be any Lisp objects, but if it is a sub
872 char-table, we treat it a table that contains information of a
873 specific range of characters. A sub char-table has the same
874 structure as a vector. A sub char table appears only in an element
875 of a char-table, and there's no way to access it directly from
876 Emacs Lisp program. */
878 /* This is the number of slots that every char table must have. This
879 counts the ordinary slots and the top, defalt, parent, and purpose
880 slots. */
881 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
883 /* Return the number of "extra" slots in the char table CT. */
885 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
886 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
888 #ifdef __GNUC__
890 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
891 ({struct Lisp_Char_Table *_tbl = NULL; \
892 Lisp_Object _val; \
893 do { \
894 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
895 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
896 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
897 if (NILP (_val)) \
898 _val = _tbl->defalt; \
899 } while (NILP (_val) && ! NILP (_tbl->parent)); \
900 _val; })
902 #else /* not __GNUC__ */
904 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
905 (! NILP (XCHAR_TABLE (CT)->ascii) \
906 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
907 ? XCHAR_TABLE (CT)->ascii \
908 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
909 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
910 : char_table_ref ((CT), (IDX))) \
911 : char_table_ref ((CT), (IDX)))
913 #endif /* not __GNUC__ */
915 /* Compute A OP B, using the unsigned comparison operator OP. A and B
916 should be integer expressions. This is not the same as
917 mathemeatical comparison; for example, UNSIGNED_CMP (0, <, -1)
918 returns 1. For efficiency, prefer plain unsigned comparison if A
919 and B's sizes both fit (after integer promotion). */
920 #define UNSIGNED_CMP(a, op, b) \
921 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
922 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
923 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
925 /* Nonzero iff C is an ASCII character. */
926 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
928 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
929 characters. Do not check validity of CT. */
930 #define CHAR_TABLE_REF(CT, IDX) \
931 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
932 : char_table_ref ((CT), (IDX)))
934 /* Almost equivalent to Faref (CT, IDX). However, if the result is
935 not a character, return IDX.
937 For these characters, do not check validity of CT
938 and do not follow parent. */
939 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
940 char_table_translate (CT, IDX)
942 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
943 8-bit European characters. Do not check validity of CT. */
944 #define CHAR_TABLE_SET(CT, IDX, VAL) \
945 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
946 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
947 : char_table_set (CT, IDX, VAL))
949 #define CHARTAB_SIZE_BITS_0 6
950 #define CHARTAB_SIZE_BITS_1 4
951 #define CHARTAB_SIZE_BITS_2 5
952 #define CHARTAB_SIZE_BITS_3 7
954 extern const int chartab_size[4];
956 struct Lisp_Sub_Char_Table;
958 struct Lisp_Char_Table
960 /* HEADER.SIZE is the vector's size field, which also holds the
961 pseudovector type information. It holds the size, too.
962 The size counts the defalt, parent, purpose, ascii,
963 contents, and extras slots. */
964 struct vectorlike_header header;
966 /* This holds a default value,
967 which is used whenever the value for a specific character is nil. */
968 Lisp_Object defalt;
970 /* This points to another char table, which we inherit from when the
971 value for a specific character is nil. The `defalt' slot takes
972 precedence over this. */
973 Lisp_Object parent;
975 /* This is a symbol which says what kind of use this char-table is
976 meant for. */
977 Lisp_Object purpose;
979 /* The bottom sub char-table for characters of the range 0..127. It
980 is nil if none of ASCII character has a specific value. */
981 Lisp_Object ascii;
983 Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)];
985 /* These hold additional data. It is a vector. */
986 Lisp_Object extras[1];
989 struct Lisp_Sub_Char_Table
991 /* HEADER.SIZE is the vector's size field, which also holds the
992 pseudovector type information. It holds the size, too. */
993 struct vectorlike_header header;
995 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
996 char-table of depth 1 contains 16 elements, and each element
997 covers 4096 (128*32) characters. A sub char-table of depth 2
998 contains 32 elements, and each element covers 128 characters. A
999 sub char-table of depth 3 contains 128 elements, and each element
1000 is for one character. */
1001 Lisp_Object depth;
1003 /* Minimum character covered by the sub char-table. */
1004 Lisp_Object min_char;
1006 Lisp_Object contents[1];
1009 /* A boolvector is a kind of vectorlike, with contents are like a string. */
1010 struct Lisp_Bool_Vector
1012 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1013 just the subtype information. */
1014 struct vectorlike_header header;
1015 /* This is the size in bits. */
1016 EMACS_INT size;
1017 /* This contains the actual bits, packed into bytes. */
1018 unsigned char data[1];
1021 /* This structure describes a built-in function.
1022 It is generated by the DEFUN macro only.
1023 defsubr makes it into a Lisp object.
1025 This type is treated in most respects as a pseudovector,
1026 but since we never dynamically allocate or free them,
1027 we don't need a struct vectorlike_header and its 'next' field. */
1029 struct Lisp_Subr
1031 EMACS_UINT size;
1032 union {
1033 Lisp_Object (*a0) (void);
1034 Lisp_Object (*a1) (Lisp_Object);
1035 Lisp_Object (*a2) (Lisp_Object, Lisp_Object);
1036 Lisp_Object (*a3) (Lisp_Object, Lisp_Object, Lisp_Object);
1037 Lisp_Object (*a4) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1038 Lisp_Object (*a5) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1039 Lisp_Object (*a6) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1040 Lisp_Object (*a7) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1041 Lisp_Object (*a8) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1042 Lisp_Object (*aUNEVALLED) (Lisp_Object args);
1043 Lisp_Object (*aMANY) (ptrdiff_t, Lisp_Object *);
1044 } function;
1045 short min_args, max_args;
1046 const char *symbol_name;
1047 const char *intspec;
1048 const char *doc;
1052 /***********************************************************************
1053 Symbols
1054 ***********************************************************************/
1056 /* Interned state of a symbol. */
1058 enum symbol_interned
1060 SYMBOL_UNINTERNED = 0,
1061 SYMBOL_INTERNED = 1,
1062 SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
1065 enum symbol_redirect
1067 SYMBOL_PLAINVAL = 4,
1068 SYMBOL_VARALIAS = 1,
1069 SYMBOL_LOCALIZED = 2,
1070 SYMBOL_FORWARDED = 3
1073 /* In a symbol, the markbit of the plist is used as the gc mark bit */
1075 struct Lisp_Symbol
1077 unsigned gcmarkbit : 1;
1079 /* Indicates where the value can be found:
1080 0 : it's a plain var, the value is in the `value' field.
1081 1 : it's a varalias, the value is really in the `alias' symbol.
1082 2 : it's a localized var, the value is in the `blv' object.
1083 3 : it's a forwarding variable, the value is in `forward'.
1085 enum symbol_redirect redirect : 3;
1087 /* Non-zero means symbol is constant, i.e. changing its value
1088 should signal an error. If the value is 3, then the var
1089 can be changed, but only by `defconst'. */
1090 unsigned constant : 2;
1092 /* Interned state of the symbol. This is an enumerator from
1093 enum symbol_interned. */
1094 unsigned interned : 2;
1096 /* Non-zero means that this variable has been explicitly declared
1097 special (with `defvar' etc), and shouldn't be lexically bound. */
1098 unsigned declared_special : 1;
1100 /* The symbol's name, as a Lisp string.
1102 The name "xname" is used to intentionally break code referring to
1103 the old field "name" of type pointer to struct Lisp_String. */
1104 Lisp_Object xname;
1106 /* Value of the symbol or Qunbound if unbound. If this symbol is a
1107 defvaralias, `alias' contains the symbol for which it is an
1108 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
1109 and set a symbol's value, to take defvaralias into account. */
1110 union {
1111 Lisp_Object value;
1112 struct Lisp_Symbol *alias;
1113 struct Lisp_Buffer_Local_Value *blv;
1114 union Lisp_Fwd *fwd;
1115 } val;
1117 /* Function value of the symbol or Qunbound if not fboundp. */
1118 Lisp_Object function;
1120 /* The symbol's property list. */
1121 Lisp_Object plist;
1123 /* Next symbol in obarray bucket, if the symbol is interned. */
1124 struct Lisp_Symbol *next;
1127 /* Value is name of symbol. */
1129 #define SYMBOL_VAL(sym) \
1130 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1131 #define SYMBOL_ALIAS(sym) \
1132 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1133 #define SYMBOL_BLV(sym) \
1134 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1135 #define SYMBOL_FWD(sym) \
1136 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1137 #define SET_SYMBOL_VAL(sym, v) \
1138 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1139 #define SET_SYMBOL_ALIAS(sym, v) \
1140 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1141 #define SET_SYMBOL_BLV(sym, v) \
1142 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1143 #define SET_SYMBOL_FWD(sym, v) \
1144 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1146 #define SYMBOL_NAME(sym) \
1147 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1149 /* Value is non-zero if SYM is an interned symbol. */
1151 #define SYMBOL_INTERNED_P(sym) \
1152 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1154 /* Value is non-zero if SYM is interned in initial_obarray. */
1156 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1157 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1159 /* Value is non-zero if symbol is considered a constant, i.e. its
1160 value cannot be changed (there is an exception for keyword symbols,
1161 whose value can be set to the keyword symbol itself). */
1163 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1165 #define DEFSYM(sym, name) \
1166 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1169 /***********************************************************************
1170 Hash Tables
1171 ***********************************************************************/
1173 /* The structure of a Lisp hash table. */
1175 struct Lisp_Hash_Table
1177 /* This is for Lisp; the hash table code does not refer to it. */
1178 struct vectorlike_header header;
1180 /* Function used to compare keys. */
1181 Lisp_Object test;
1183 /* Nil if table is non-weak. Otherwise a symbol describing the
1184 weakness of the table. */
1185 Lisp_Object weak;
1187 /* When the table is resized, and this is an integer, compute the
1188 new size by adding this to the old size. If a float, compute the
1189 new size by multiplying the old size with this factor. */
1190 Lisp_Object rehash_size;
1192 /* Resize hash table when number of entries/ table size is >= this
1193 ratio, a float. */
1194 Lisp_Object rehash_threshold;
1196 /* Vector of hash codes.. If hash[I] is nil, this means that that
1197 entry I is unused. */
1198 Lisp_Object hash;
1200 /* Vector used to chain entries. If entry I is free, next[I] is the
1201 entry number of the next free item. If entry I is non-free,
1202 next[I] is the index of the next entry in the collision chain. */
1203 Lisp_Object next;
1205 /* Index of first free entry in free list. */
1206 Lisp_Object next_free;
1208 /* Bucket vector. A non-nil entry is the index of the first item in
1209 a collision chain. This vector's size can be larger than the
1210 hash table size to reduce collisions. */
1211 Lisp_Object index;
1213 /* User-supplied hash function, or nil. */
1214 Lisp_Object user_hash_function;
1216 /* User-supplied key comparison function, or nil. */
1217 Lisp_Object user_cmp_function;
1219 /* Only the fields above are traced normally by the GC. The ones below
1220 `count' are special and are either ignored by the GC or traced in
1221 a special way (e.g. because of weakness). */
1223 /* Number of key/value entries in the table. */
1224 EMACS_INT count;
1226 /* Vector of keys and values. The key of item I is found at index
1227 2 * I, the value is found at index 2 * I + 1.
1228 This is gc_marked specially if the table is weak. */
1229 Lisp_Object key_and_value;
1231 /* Next weak hash table if this is a weak hash table. The head
1232 of the list is in weak_hash_tables. */
1233 struct Lisp_Hash_Table *next_weak;
1235 /* C function to compare two keys. */
1236 int (*cmpfn) (struct Lisp_Hash_Table *,
1237 Lisp_Object, EMACS_UINT,
1238 Lisp_Object, EMACS_UINT);
1240 /* C function to compute hash code. */
1241 EMACS_UINT (*hashfn) (struct Lisp_Hash_Table *, Lisp_Object);
1245 #define XHASH_TABLE(OBJ) \
1246 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1248 #define XSET_HASH_TABLE(VAR, PTR) \
1249 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1251 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1253 #define CHECK_HASH_TABLE(x) \
1254 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1256 /* Value is the key part of entry IDX in hash table H. */
1258 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1260 /* Value is the value part of entry IDX in hash table H. */
1262 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1264 /* Value is the index of the next entry following the one at IDX
1265 in hash table H. */
1267 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1269 /* Value is the hash code computed for entry IDX in hash table H. */
1271 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1273 /* Value is the index of the element in hash table H that is the
1274 start of the collision list at index IDX in the index vector of H. */
1276 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1278 /* Value is the size of hash table H. */
1280 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1282 /* Default size for hash tables if not specified. */
1284 #define DEFAULT_HASH_SIZE 65
1286 /* Default threshold specifying when to resize a hash table. The
1287 value gives the ratio of current entries in the hash table and the
1288 size of the hash table. */
1290 #define DEFAULT_REHASH_THRESHOLD 0.8
1292 /* Default factor by which to increase the size of a hash table. */
1294 #define DEFAULT_REHASH_SIZE 1.5
1297 /* These structures are used for various misc types. */
1299 struct Lisp_Misc_Any /* Supertype of all Misc types. */
1301 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_??? */
1302 unsigned gcmarkbit : 1;
1303 int spacer : 15;
1304 /* Make it as long as "Lisp_Free without padding". */
1305 void *fill;
1308 struct Lisp_Marker
1310 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Marker */
1311 unsigned gcmarkbit : 1;
1312 int spacer : 13;
1313 /* This flag is temporarily used in the functions
1314 decode/encode_coding_object to record that the marker position
1315 must be adjusted after the conversion. */
1316 unsigned int need_adjustment : 1;
1317 /* 1 means normal insertion at the marker's position
1318 leaves the marker after the inserted text. */
1319 unsigned int insertion_type : 1;
1320 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1321 Note: a chain of markers can contain markers pointing into different
1322 buffers (the chain is per buffer_text rather than per buffer, so it's
1323 shared between indirect buffers). */
1324 /* This is used for (other than NULL-checking):
1325 - Fmarker_buffer
1326 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1327 - unchain_marker: to find the list from which to unchain.
1328 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1330 struct buffer *buffer;
1332 /* The remaining fields are meaningless in a marker that
1333 does not point anywhere. */
1335 /* For markers that point somewhere,
1336 this is used to chain of all the markers in a given buffer. */
1337 /* We could remove it and use an array in buffer_text instead.
1338 That would also allow to preserve it ordered. */
1339 struct Lisp_Marker *next;
1340 /* This is the char position where the marker points. */
1341 EMACS_INT charpos;
1342 /* This is the byte position.
1343 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1344 used to implement the functionality of markers, but rather to (ab)use
1345 markers as a cache for char<->byte mappings). */
1346 EMACS_INT bytepos;
1349 /* Forwarding pointer to an int variable.
1350 This is allowed only in the value cell of a symbol,
1351 and it means that the symbol's value really lives in the
1352 specified int variable. */
1353 struct Lisp_Intfwd
1355 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Int */
1356 EMACS_INT *intvar;
1359 /* Boolean forwarding pointer to an int variable.
1360 This is like Lisp_Intfwd except that the ostensible
1361 "value" of the symbol is t if the int variable is nonzero,
1362 nil if it is zero. */
1363 struct Lisp_Boolfwd
1365 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Bool */
1366 int *boolvar;
1369 /* Forwarding pointer to a Lisp_Object variable.
1370 This is allowed only in the value cell of a symbol,
1371 and it means that the symbol's value really lives in the
1372 specified variable. */
1373 struct Lisp_Objfwd
1375 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Obj */
1376 Lisp_Object *objvar;
1379 /* Like Lisp_Objfwd except that value lives in a slot in the
1380 current buffer. Value is byte index of slot within buffer. */
1381 struct Lisp_Buffer_Objfwd
1383 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Buffer_Obj */
1384 int offset;
1385 Lisp_Object slottype; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1388 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1389 the symbol has buffer-local or frame-local bindings. (Exception:
1390 some buffer-local variables are built-in, with their values stored
1391 in the buffer structure itself. They are handled differently,
1392 using struct Lisp_Buffer_Objfwd.)
1394 The `realvalue' slot holds the variable's current value, or a
1395 forwarding pointer to where that value is kept. This value is the
1396 one that corresponds to the loaded binding. To read or set the
1397 variable, you must first make sure the right binding is loaded;
1398 then you can access the value in (or through) `realvalue'.
1400 `buffer' and `frame' are the buffer and frame for which the loaded
1401 binding was found. If those have changed, to make sure the right
1402 binding is loaded it is necessary to find which binding goes with
1403 the current buffer and selected frame, then load it. To load it,
1404 first unload the previous binding, then copy the value of the new
1405 binding into `realvalue' (or through it). Also update
1406 LOADED-BINDING to point to the newly loaded binding.
1408 `local_if_set' indicates that merely setting the variable creates a
1409 local binding for the current buffer. Otherwise the latter, setting
1410 the variable does not do that; only make-local-variable does that. */
1412 struct Lisp_Buffer_Local_Value
1414 /* 1 means that merely setting the variable creates a local
1415 binding for the current buffer */
1416 unsigned int local_if_set : 1;
1417 /* 1 means this variable can have frame-local bindings, otherwise, it is
1418 can have buffer-local bindings. The two cannot be combined. */
1419 unsigned int frame_local : 1;
1420 /* 1 means that the binding now loaded was found.
1421 Presumably equivalent to (defcell!=valcell) */
1422 unsigned int found : 1;
1423 /* If non-NULL, a forwarding to the C var where it should also be set. */
1424 union Lisp_Fwd *fwd; /* Should never be (Buffer|Kboard)_Objfwd. */
1425 /* The buffer or frame for which the loaded binding was found. */
1426 Lisp_Object where;
1427 /* A cons cell that holds the default value. It has the form
1428 (SYMBOL . DEFAULT-VALUE). */
1429 Lisp_Object defcell;
1430 /* The cons cell from `where's parameter alist.
1431 It always has the form (SYMBOL . VALUE)
1432 Note that if `forward' is non-nil, VALUE may be out of date.
1433 Also if the currently loaded binding is the default binding, then
1434 this is `eq'ual to defcell. */
1435 Lisp_Object valcell;
1438 #define BLV_FOUND(blv) \
1439 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1440 #define SET_BLV_FOUND(blv, v) \
1441 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1443 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1444 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1446 /* START and END are markers in the overlay's buffer, and
1447 PLIST is the overlay's property list. */
1448 struct Lisp_Overlay
1449 /* An overlay's real data content is:
1450 - plist
1451 - buffer
1452 - insertion type of both ends
1453 - start & start_byte
1454 - end & end_byte
1455 - next (singly linked list of overlays).
1456 - start_next and end_next (singly linked list of markers).
1457 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1460 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Overlay */
1461 unsigned gcmarkbit : 1;
1462 int spacer : 15;
1463 struct Lisp_Overlay *next;
1464 Lisp_Object start, end, plist;
1467 /* Like Lisp_Objfwd except that value lives in a slot in the
1468 current kboard. */
1469 struct Lisp_Kboard_Objfwd
1471 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Kboard_Obj */
1472 int offset;
1475 /* Hold a C pointer for later use.
1476 This type of object is used in the arg to record_unwind_protect. */
1477 struct Lisp_Save_Value
1479 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Save_Value */
1480 unsigned gcmarkbit : 1;
1481 int spacer : 14;
1482 /* If DOGC is set, POINTER is the address of a memory
1483 area containing INTEGER potential Lisp_Objects. */
1484 unsigned int dogc : 1;
1485 void *pointer;
1486 ptrdiff_t integer;
1490 /* A miscellaneous object, when it's on the free list. */
1491 struct Lisp_Free
1493 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Free */
1494 unsigned gcmarkbit : 1;
1495 int spacer : 15;
1496 union Lisp_Misc *chain;
1497 #ifdef USE_LSB_TAG
1498 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1499 This assumes that Lisp_Marker is the largest of the alternatives and
1500 that Lisp_Misc_Any has the same size as "Lisp_Free w/o padding". */
1501 char padding[((((sizeof (struct Lisp_Marker) - 1) >> GCTYPEBITS) + 1)
1502 << GCTYPEBITS) - sizeof (struct Lisp_Misc_Any)];
1503 #endif
1506 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1507 It uses one of these struct subtypes to get the type field. */
1509 union Lisp_Misc
1511 struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */
1512 struct Lisp_Free u_free; /* Includes padding to force alignment. */
1513 struct Lisp_Marker u_marker; /* 5 */
1514 struct Lisp_Overlay u_overlay; /* 5 */
1515 struct Lisp_Save_Value u_save_value; /* 3 */
1518 union Lisp_Fwd
1520 struct Lisp_Intfwd u_intfwd; /* 2 */
1521 struct Lisp_Boolfwd u_boolfwd; /* 2 */
1522 struct Lisp_Objfwd u_objfwd; /* 2 */
1523 struct Lisp_Buffer_Objfwd u_buffer_objfwd; /* 2 */
1524 struct Lisp_Kboard_Objfwd u_kboard_objfwd; /* 2 */
1527 /* Lisp floating point type */
1528 struct Lisp_Float
1530 union
1532 #ifdef HIDE_LISP_IMPLEMENTATION
1533 double data_;
1534 #else
1535 double data;
1536 #endif
1537 struct Lisp_Float *chain;
1538 } u;
1541 #ifdef HIDE_LISP_IMPLEMENTATION
1542 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1543 #else
1544 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1545 /* This should be used only in alloc.c, which always disables
1546 HIDE_LISP_IMPLEMENTATION. */
1547 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1548 #endif
1550 /* A character, declared with the following typedef, is a member
1551 of some character set associated with the current buffer. */
1552 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1553 #define _UCHAR_T
1554 typedef unsigned char UCHAR;
1555 #endif
1557 /* Meanings of slots in a Lisp_Compiled: */
1559 #define COMPILED_ARGLIST 0
1560 #define COMPILED_BYTECODE 1
1561 #define COMPILED_CONSTANTS 2
1562 #define COMPILED_STACK_DEPTH 3
1563 #define COMPILED_DOC_STRING 4
1564 #define COMPILED_INTERACTIVE 5
1566 /* Flag bits in a character. These also get used in termhooks.h.
1567 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1568 (MUlti-Lingual Emacs) might need 22 bits for the character value
1569 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1570 #define CHAR_ALT (0x0400000)
1571 #define CHAR_SUPER (0x0800000)
1572 #define CHAR_HYPER (0x1000000)
1573 #define CHAR_SHIFT (0x2000000)
1574 #define CHAR_CTL (0x4000000)
1575 #define CHAR_META (0x8000000)
1577 #define CHAR_MODIFIER_MASK \
1578 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1581 /* Actually, the current Emacs uses 22 bits for the character value
1582 itself. */
1583 #define CHARACTERBITS 22
1585 /* The maximum byte size consumed by push_key_description.
1586 All callers should assure that at least this size of memory is
1587 allocated at the place pointed by the second argument.
1589 There are 6 modifiers, each consumes 2 chars.
1590 The octal form of a character code consumes
1591 (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
1592 We need one more byte for string terminator `\0'. */
1593 #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)
1596 /* The glyph datatype, used to represent characters on the display.
1597 It consists of a char code and a face id. */
1599 typedef struct {
1600 int ch;
1601 int face_id;
1602 } GLYPH;
1604 /* Return a glyph's character code. */
1605 #define GLYPH_CHAR(glyph) ((glyph).ch)
1607 /* Return a glyph's face ID. */
1608 #define GLYPH_FACE(glyph) ((glyph).face_id)
1610 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1611 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1612 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1614 /* Return 1 if GLYPH contains valid character code. */
1615 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1618 /* Glyph Code from a display vector may either be an integer which
1619 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1620 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1622 #define GLYPH_CODE_CHAR(gc) \
1623 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1625 #define GLYPH_CODE_FACE(gc) \
1626 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1628 /* Return 1 if glyph code from display vector contains valid character code. */
1629 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc))
1631 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1633 /* Only called when GLYPH_CODE_P (gc) is true. */
1634 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1635 do \
1637 if (CONSP (gc)) \
1638 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1639 else \
1640 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1641 (XINT (gc) >> CHARACTERBITS)); \
1643 while (0)
1645 /* The ID of the mode line highlighting face. */
1646 #define GLYPH_MODE_LINE_FACE 1
1648 /* Structure to hold mouse highlight data. This is here because other
1649 header files need it for defining struct x_output etc. */
1650 typedef struct {
1651 /* These variables describe the range of text currently shown in its
1652 mouse-face, together with the window they apply to. As long as
1653 the mouse stays within this range, we need not redraw anything on
1654 its account. Rows and columns are glyph matrix positions in
1655 MOUSE_FACE_WINDOW. */
1656 int mouse_face_beg_row, mouse_face_beg_col;
1657 int mouse_face_beg_x, mouse_face_beg_y;
1658 int mouse_face_end_row, mouse_face_end_col;
1659 int mouse_face_end_x, mouse_face_end_y;
1660 int mouse_face_past_end;
1661 Lisp_Object mouse_face_window;
1662 int mouse_face_face_id;
1663 Lisp_Object mouse_face_overlay;
1665 /* 1 if a mouse motion event came and we didn't handle it right away because
1666 gc was in progress. */
1667 int mouse_face_deferred_gc;
1669 /* FRAME and X, Y position of mouse when last checked for
1670 highlighting. X and Y can be negative or out of range for the frame. */
1671 struct frame *mouse_face_mouse_frame;
1672 int mouse_face_mouse_x, mouse_face_mouse_y;
1674 /* Nonzero means defer mouse-motion highlighting. */
1675 int mouse_face_defer;
1677 /* Nonzero means that the mouse highlight should not be shown. */
1678 int mouse_face_hidden;
1680 int mouse_face_image_state;
1681 } Mouse_HLInfo;
1683 /* Data type checking */
1685 #define NILP(x) EQ (x, Qnil)
1687 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1688 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1690 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1691 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1692 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1693 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1694 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1695 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1697 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1698 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1699 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1700 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1701 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1703 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1704 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1705 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1706 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1707 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1709 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1710 vectorlike_header * avoids aliasing issues. */
1711 #define PSEUDOVECTORP(x, code) \
1712 TYPED_PSEUDOVECTORP(x, vectorlike_header, code)
1714 /* True if object X, with internal type struct T *, is a pseudovector whose
1715 code is CODE. */
1716 #define TYPED_PSEUDOVECTORP(x, t, code) \
1717 (VECTORLIKEP (x) \
1718 && (((((struct t *) XPNTR (x))->size \
1719 & (PSEUDOVECTOR_FLAG | (code)))) \
1720 == (PSEUDOVECTOR_FLAG | (code))))
1722 /* Test for specific pseudovector types. */
1723 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1724 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1725 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1726 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1727 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1728 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1729 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1730 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1731 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1732 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1733 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1734 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1736 /* Test for image (image . spec) */
1737 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1739 /* Array types. */
1741 #define ARRAYP(x) \
1742 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1744 #define CHECK_LIST(x) \
1745 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1747 #define CHECK_LIST_CONS(x, y) \
1748 CHECK_TYPE (CONSP (x), Qlistp, y)
1750 #define CHECK_LIST_END(x, y) \
1751 CHECK_TYPE (NILP (x), Qlistp, y)
1753 #define CHECK_STRING(x) \
1754 CHECK_TYPE (STRINGP (x), Qstringp, x)
1756 #define CHECK_STRING_CAR(x) \
1757 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1759 #define CHECK_CONS(x) \
1760 CHECK_TYPE (CONSP (x), Qconsp, x)
1762 #define CHECK_SYMBOL(x) \
1763 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1765 #define CHECK_CHAR_TABLE(x) \
1766 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1768 #define CHECK_VECTOR(x) \
1769 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1771 #define CHECK_VECTOR_OR_STRING(x) \
1772 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1774 #define CHECK_ARRAY(x, Qxxxp) \
1775 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1777 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1778 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1780 #define CHECK_BUFFER(x) \
1781 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1783 #define CHECK_WINDOW(x) \
1784 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1786 #define CHECK_WINDOW_CONFIGURATION(x) \
1787 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1789 /* This macro rejects windows on the interior of the window tree as
1790 "dead", which is what we want; this is an argument-checking macro, and
1791 the user should never get access to interior windows.
1793 A window of any sort, leaf or interior, is dead if the buffer,
1794 vchild, and hchild members are all nil. */
1796 #define CHECK_LIVE_WINDOW(x) \
1797 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1799 #define CHECK_PROCESS(x) \
1800 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1802 #define CHECK_SUBR(x) \
1803 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1805 #define CHECK_NUMBER(x) \
1806 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1808 #define CHECK_NATNUM(x) \
1809 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1811 #define CHECK_MARKER(x) \
1812 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1814 #define CHECK_NUMBER_COERCE_MARKER(x) \
1815 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1816 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1818 #define XFLOATINT(n) extract_float((n))
1820 #define CHECK_FLOAT(x) \
1821 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1823 #define CHECK_NUMBER_OR_FLOAT(x) \
1824 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1826 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1827 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1828 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1830 #define CHECK_OVERLAY(x) \
1831 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1833 /* Since we can't assign directly to the CAR or CDR fields of a cons
1834 cell, use these when checking that those fields contain numbers. */
1835 #define CHECK_NUMBER_CAR(x) \
1836 do { \
1837 Lisp_Object tmp = XCAR (x); \
1838 CHECK_NUMBER (tmp); \
1839 XSETCAR ((x), tmp); \
1840 } while (0)
1842 #define CHECK_NUMBER_CDR(x) \
1843 do { \
1844 Lisp_Object tmp = XCDR (x); \
1845 CHECK_NUMBER (tmp); \
1846 XSETCDR ((x), tmp); \
1847 } while (0)
1849 #define CHECK_NATNUM_CAR(x) \
1850 do { \
1851 Lisp_Object tmp = XCAR (x); \
1852 CHECK_NATNUM (tmp); \
1853 XSETCAR ((x), tmp); \
1854 } while (0)
1856 #define CHECK_NATNUM_CDR(x) \
1857 do { \
1858 Lisp_Object tmp = XCDR (x); \
1859 CHECK_NATNUM (tmp); \
1860 XSETCDR ((x), tmp); \
1861 } while (0)
1863 /* Cast pointers to this type to compare them. */
1864 #define PNTR_COMPARISON_TYPE uintptr_t
1866 /* Define a built-in function for calling from Lisp.
1867 `lname' should be the name to give the function in Lisp,
1868 as a null-terminated C string.
1869 `fnname' should be the name of the function in C.
1870 By convention, it starts with F.
1871 `sname' should be the name for the C constant structure
1872 that records information on this function for internal use.
1873 By convention, it should be the same as `fnname' but with S instead of F.
1874 It's too bad that C macros can't compute this from `fnname'.
1875 `minargs' should be a number, the minimum number of arguments allowed.
1876 `maxargs' should be a number, the maximum number of arguments allowed,
1877 or else MANY or UNEVALLED.
1878 MANY means pass a vector of evaluated arguments,
1879 in the form of an integer number-of-arguments
1880 followed by the address of a vector of Lisp_Objects
1881 which contains the argument values.
1882 UNEVALLED means pass the list of unevaluated arguments
1883 `intspec' says how interactive arguments are to be fetched.
1884 If the string starts with a `(', `intspec' is evaluated and the resulting
1885 list is the list of arguments.
1886 If it's a string that doesn't start with `(', the value should follow
1887 the one of the doc string for `interactive'.
1888 A null string means call interactively with no arguments.
1889 `doc' is documentation for the user. */
1891 /* This version of DEFUN declares a function prototype with the right
1892 arguments, so we can catch errors with maxargs at compile-time. */
1893 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1894 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1895 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1896 { PVEC_SUBR, \
1897 { .a ## maxargs = fnname }, \
1898 minargs, maxargs, lname, intspec, 0}; \
1899 Lisp_Object fnname
1901 /* Note that the weird token-substitution semantics of ANSI C makes
1902 this work for MANY and UNEVALLED. */
1903 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1904 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1905 #define DEFUN_ARGS_0 (void)
1906 #define DEFUN_ARGS_1 (Lisp_Object)
1907 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1908 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1909 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1910 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1911 Lisp_Object)
1912 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1913 Lisp_Object, Lisp_Object)
1914 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1915 Lisp_Object, Lisp_Object, Lisp_Object)
1916 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1917 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1919 /* Non-zero if OBJ is a Lisp function. */
1920 #define FUNCTIONP(OBJ) \
1921 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1922 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1923 || COMPILEDP (OBJ) \
1924 || SUBRP (OBJ))
1926 /* defsubr (Sname);
1927 is how we define the symbol for function `name' at start-up time. */
1928 extern void defsubr (struct Lisp_Subr *);
1930 #define MANY -2
1931 #define UNEVALLED -1
1933 extern void defvar_lisp (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1934 extern void defvar_lisp_nopro (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1935 extern void defvar_bool (struct Lisp_Boolfwd *, const char *, int *);
1936 extern void defvar_int (struct Lisp_Intfwd *, const char *, EMACS_INT *);
1937 extern void defvar_kboard (struct Lisp_Kboard_Objfwd *, const char *, int);
1939 /* Macros we use to define forwarded Lisp variables.
1940 These are used in the syms_of_FILENAME functions.
1942 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1943 lisp variable is actually a field in `struct emacs_globals'. The
1944 field's name begins with "f_", which is a convention enforced by
1945 these macros. Each such global has a corresponding #define in
1946 globals.h; the plain name should be used in the code.
1948 E.g., the global "cons_cells_consed" is declared as "int
1949 f_cons_cells_consed" in globals.h, but there is a define:
1951 #define cons_cells_consed globals.f_cons_cells_consed
1953 All C code uses the `cons_cells_consed' name. This is all done
1954 this way to support indirection for multi-threaded Emacs. */
1956 #define DEFVAR_LISP(lname, vname, doc) \
1957 do { \
1958 static struct Lisp_Objfwd o_fwd; \
1959 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1960 } while (0)
1961 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1962 do { \
1963 static struct Lisp_Objfwd o_fwd; \
1964 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1965 } while (0)
1966 #define DEFVAR_BOOL(lname, vname, doc) \
1967 do { \
1968 static struct Lisp_Boolfwd b_fwd; \
1969 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1970 } while (0)
1971 #define DEFVAR_INT(lname, vname, doc) \
1972 do { \
1973 static struct Lisp_Intfwd i_fwd; \
1974 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1975 } while (0)
1977 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1978 do { \
1979 static struct Lisp_Objfwd o_fwd; \
1980 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1981 } while (0)
1983 #define DEFVAR_KBOARD(lname, vname, doc) \
1984 do { \
1985 static struct Lisp_Kboard_Objfwd ko_fwd; \
1986 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1987 } while (0)
1991 /* Structure for recording Lisp call stack for backtrace purposes. */
1993 /* The special binding stack holds the outer values of variables while
1994 they are bound by a function application or a let form, stores the
1995 code to be executed for Lisp unwind-protect forms, and stores the C
1996 functions to be called for record_unwind_protect.
1998 If func is non-zero, undoing this binding applies func to old_value;
1999 This implements record_unwind_protect.
2001 Otherwise, the element is a variable binding.
2003 If the symbol field is a symbol, it is an ordinary variable binding.
2005 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2006 which means having bound a local value while CURRENT-BUFFER was active.
2007 If WHERE is nil this means we saw the default value when binding SYMBOL.
2008 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2009 value. Other values of WHERE mean an internal error. */
2011 typedef Lisp_Object (*specbinding_func) (Lisp_Object);
2013 struct specbinding
2015 Lisp_Object symbol, old_value;
2016 specbinding_func func;
2017 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
2020 extern struct specbinding *specpdl;
2021 extern struct specbinding *specpdl_ptr;
2022 extern EMACS_INT specpdl_size;
2024 #define SPECPDL_INDEX() ((int) (specpdl_ptr - specpdl))
2026 /* Everything needed to describe an active condition case. */
2027 struct handler
2029 /* The handler clauses and variable from the condition-case form. */
2030 /* For a handler set up in Lisp code, this is always a list.
2031 For an internal handler set up by internal_condition_case*,
2032 this can instead be the symbol t or `error'.
2033 t: handle all conditions.
2034 error: handle all conditions, and errors can run the debugger
2035 or display a backtrace. */
2036 Lisp_Object handler;
2037 Lisp_Object var;
2038 /* Fsignal stores here the condition-case clause that applies,
2039 and Fcondition_case thus knows which clause to run. */
2040 Lisp_Object chosen_clause;
2042 /* Used to effect the longjump out to the handler. */
2043 struct catchtag *tag;
2045 /* The next enclosing handler. */
2046 struct handler *next;
2049 /* This structure helps implement the `catch' and `throw' control
2050 structure. A struct catchtag contains all the information needed
2051 to restore the state of the interpreter after a non-local jump.
2053 Handlers for error conditions (represented by `struct handler'
2054 structures) just point to a catch tag to do the cleanup required
2055 for their jumps.
2057 catchtag structures are chained together in the C calling stack;
2058 the `next' member points to the next outer catchtag.
2060 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2061 member is TAG, and then unbinds to it. The `val' member is used to
2062 hold VAL while the stack is unwound; `val' is returned as the value
2063 of the catch form.
2065 All the other members are concerned with restoring the interpreter
2066 state. */
2068 struct catchtag
2070 Lisp_Object tag;
2071 Lisp_Object val;
2072 struct catchtag *next;
2073 struct gcpro *gcpro;
2074 jmp_buf jmp;
2075 struct backtrace *backlist;
2076 struct handler *handlerlist;
2077 int lisp_eval_depth;
2078 int pdlcount;
2079 int poll_suppress_count;
2080 int interrupt_input_blocked;
2081 struct byte_stack *byte_stack;
2084 extern Lisp_Object memory_signal_data;
2086 /* An address near the bottom of the stack.
2087 Tells GC how to save a copy of the stack. */
2088 extern char *stack_bottom;
2090 /* Check quit-flag and quit if it is non-nil.
2091 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2092 So the program needs to do QUIT at times when it is safe to quit.
2093 Every loop that might run for a long time or might not exit
2094 ought to do QUIT at least once, at a safe place.
2095 Unless that is impossible, of course.
2096 But it is very desirable to avoid creating loops where QUIT is impossible.
2098 Exception: if you set immediate_quit to nonzero,
2099 then the handler that responds to the C-g does the quit itself.
2100 This is a good thing to do around a loop that has no side effects
2101 and (in particular) cannot call arbitrary Lisp code. */
2103 #ifdef SYNC_INPUT
2104 extern void process_pending_signals (void);
2105 extern int pending_signals;
2106 #define ELSE_PENDING_SIGNALS \
2107 else if (pending_signals) \
2108 process_pending_signals ();
2109 #else /* not SYNC_INPUT */
2110 #define ELSE_PENDING_SIGNALS
2111 #endif /* not SYNC_INPUT */
2113 #define QUIT \
2114 do { \
2115 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2117 Lisp_Object flag = Vquit_flag; \
2118 Vquit_flag = Qnil; \
2119 if (EQ (Vthrow_on_input, flag)) \
2120 Fthrow (Vthrow_on_input, Qt); \
2121 Fsignal (Qquit, Qnil); \
2123 ELSE_PENDING_SIGNALS \
2124 } while (0)
2127 /* Nonzero if ought to quit now. */
2129 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2131 extern Lisp_Object Vascii_downcase_table;
2132 extern Lisp_Object Vascii_canon_table;
2134 /* Number of bytes of structure consed since last GC. */
2136 extern EMACS_INT consing_since_gc;
2138 extern EMACS_INT gc_relative_threshold;
2140 extern EMACS_INT memory_full_cons_threshold;
2142 /* Structure for recording stack slots that need marking. */
2144 /* This is a chain of structures, each of which points at a Lisp_Object
2145 variable whose value should be marked in garbage collection.
2146 Normally every link of the chain is an automatic variable of a function,
2147 and its `val' points to some argument or local variable of the function.
2148 On exit to the function, the chain is set back to the value it had on entry.
2149 This way, no link remains in the chain when the stack frame containing the
2150 link disappears.
2152 Every function that can call Feval must protect in this fashion all
2153 Lisp_Object variables whose contents will be used again. */
2155 extern struct gcpro *gcprolist;
2157 struct gcpro
2159 struct gcpro *next;
2161 /* Address of first protected variable. */
2162 volatile Lisp_Object *var;
2164 /* Number of consecutive protected variables. */
2165 ptrdiff_t nvars;
2167 #ifdef DEBUG_GCPRO
2168 int level;
2169 #endif
2172 /* Values of GC_MARK_STACK during compilation:
2174 0 Use GCPRO as before
2175 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2176 2 Mark the stack, and check that everything GCPRO'd is
2177 marked.
2178 3 Mark using GCPRO's, mark stack last, and count how many
2179 dead objects are kept alive. */
2182 #define GC_USE_GCPROS_AS_BEFORE 0
2183 #define GC_MAKE_GCPROS_NOOPS 1
2184 #define GC_MARK_STACK_CHECK_GCPROS 2
2185 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2187 #ifndef GC_MARK_STACK
2188 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2189 #endif
2191 /* Whether we do the stack marking manually. */
2192 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2193 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2196 #define GCPRO1(var) \
2197 GCPRO1_VAR (var, gcpro)
2198 #define GCPRO2(var1, var2) \
2199 GCPRO2_VAR (var1, var2, gcpro)
2200 #define GCPRO3(var1, var2, var3) \
2201 GCPRO3_VAR (var1, var2, var3, gcpro)
2202 #define GCPRO4(var1, var2, var3, var4) \
2203 GCPRO4_VAR (var1, var2, var3, var4, gcpro)
2204 #define GCPRO5(var1, var2, var3, var4, var5) \
2205 GCPRO5_VAR (var1, var2, var3, var4, var5, gcpro)
2206 #define GCPRO6(var1, var2, var3, var4, var5, var6) \
2207 GCPRO6_VAR (var1, var2, var3, var4, var5, var6, gcpro)
2208 #define UNGCPRO UNGCPRO_VAR (gcpro)
2210 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2212 /* Do something silly with gcproN vars just so gcc shuts up. */
2213 /* You get warnings from MIPSPro... */
2215 #define GCPRO1_VAR(var, gcpro) ((void) gcpro##1)
2216 #define GCPRO2_VAR(var1, var2, gcpro) \
2217 ((void) gcpro##2, (void) gcpro##1)
2218 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2219 ((void) gcpro##3, (void) gcpro##2, (void) gcpro##1)
2220 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2221 ((void) gcpro##4, (void) gcpro##3, (void) gcpro##2, (void) gcpro##1)
2222 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2223 ((void) gcpro##5, (void) gcpro##4, (void) gcpro##3, (void) gcpro##2, \
2224 (void) gcpro##1)
2225 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2226 ((void) gcpro##6, (void) gcpro##5, (void) gcpro##4, (void) gcpro##3, \
2227 (void) gcpro##2, (void) gcpro##1)
2228 #define UNGCPRO_VAR(gcpro) ((void) 0)
2230 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2232 #ifndef DEBUG_GCPRO
2234 #define GCPRO1_VAR(var, gcpro) \
2235 {gcpro##1.next = gcprolist; gcpro##1.var = &var; gcpro##1.nvars = 1; \
2236 gcprolist = &gcpro##1; }
2238 #define GCPRO2_VAR(var1, var2, gcpro) \
2239 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2240 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2241 gcprolist = &gcpro##2; }
2243 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2244 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2245 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2246 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2247 gcprolist = &gcpro##3; }
2249 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2250 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2251 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2252 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2253 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2254 gcprolist = &gcpro##4; }
2256 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2257 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2258 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2259 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2260 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2261 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2262 gcprolist = &gcpro##5; }
2264 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2265 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2266 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2267 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2268 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2269 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2270 gcpro##6.next = &gcpro##5; gcpro##6.var = &var6; gcpro##6.nvars = 1; \
2271 gcprolist = &gcpro##6; }
2273 #define UNGCPRO_VAR(gcpro) (gcprolist = gcpro##1.next)
2275 #else
2277 extern int gcpro_level;
2279 #define GCPRO1_VAR(var, gcpro) \
2280 {gcpro##1.next = gcprolist; gcpro##1.var = &var; gcpro##1.nvars = 1; \
2281 gcpro##1.level = gcpro_level++; \
2282 gcprolist = &gcpro##1; }
2284 #define GCPRO2_VAR(var1, var2, gcpro) \
2285 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2286 gcpro##1.level = gcpro_level; \
2287 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2288 gcpro##2.level = gcpro_level++; \
2289 gcprolist = &gcpro##2; }
2291 #define GCPRO3_VAR(var1, var2, var3, gcpro) \
2292 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2293 gcpro##1.level = gcpro_level; \
2294 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2295 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2296 gcpro##3.level = gcpro_level++; \
2297 gcprolist = &gcpro##3; }
2299 #define GCPRO4_VAR(var1, var2, var3, var4, gcpro) \
2300 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2301 gcpro##1.level = gcpro_level; \
2302 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2303 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2304 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2305 gcpro##4.level = gcpro_level++; \
2306 gcprolist = &gcpro##4; }
2308 #define GCPRO5_VAR(var1, var2, var3, var4, var5, gcpro) \
2309 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2310 gcpro##1.level = gcpro_level; \
2311 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2312 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2313 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2314 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2315 gcpro##5.level = gcpro_level++; \
2316 gcprolist = &gcpro##5; }
2318 #define GCPRO6_VAR(var1, var2, var3, var4, var5, var6, gcpro) \
2319 {gcpro##1.next = gcprolist; gcpro##1.var = &var1; gcpro##1.nvars = 1; \
2320 gcpro##1.level = gcpro_level; \
2321 gcpro##2.next = &gcpro##1; gcpro##2.var = &var2; gcpro##2.nvars = 1; \
2322 gcpro##3.next = &gcpro##2; gcpro##3.var = &var3; gcpro##3.nvars = 1; \
2323 gcpro##4.next = &gcpro##3; gcpro##4.var = &var4; gcpro##4.nvars = 1; \
2324 gcpro##5.next = &gcpro##4; gcpro##5.var = &var5; gcpro##5.nvars = 1; \
2325 gcpro##6.next = &gcpro##5; gcpro##6.var = &var6; gcpro##6.nvars = 1; \
2326 gcpro##6.level = gcpro_level++; \
2327 gcprolist = &gcpro##6; }
2329 #define UNGCPRO_VAR(gcpro) \
2330 ((--gcpro_level != gcpro##1.level) \
2331 ? (abort (), 0) \
2332 : ((gcprolist = gcpro##1.next), 0))
2334 #endif /* DEBUG_GCPRO */
2335 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2338 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2339 #define RETURN_UNGCPRO(expr) \
2340 do \
2342 Lisp_Object ret_ungc_val; \
2343 ret_ungc_val = (expr); \
2344 UNGCPRO; \
2345 return ret_ungc_val; \
2347 while (0)
2349 /* Call staticpro (&var) to protect static variable `var'. */
2351 void staticpro (Lisp_Object *);
2353 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2354 meaning as in the DEFUN macro, and is used to construct a prototype. */
2355 /* We can use the same trick as in the DEFUN macro to generate the
2356 appropriate prototype. */
2357 #define EXFUN(fnname, maxargs) \
2358 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2360 /* Forward declarations for prototypes. */
2361 struct window;
2362 struct frame;
2364 /* Defined in data.c. */
2365 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qunbound;
2366 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
2367 extern Lisp_Object Qerror, Qquit, Qargs_out_of_range;
2368 extern Lisp_Object Qvoid_variable, Qvoid_function;
2369 extern Lisp_Object Qinvalid_read_syntax;
2370 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
2371 extern Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
2372 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
2373 extern Lisp_Object Qtext_read_only;
2374 extern Lisp_Object Qinteractive_form;
2375 extern Lisp_Object Qcircular_list;
2376 extern Lisp_Object Qintegerp, Qwholenump, Qsymbolp, Qlistp, Qconsp;
2377 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
2378 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
2379 extern Lisp_Object Qbuffer_or_string_p;
2380 extern Lisp_Object Qfboundp;
2381 extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
2383 extern Lisp_Object Qcdr;
2385 extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
2386 extern Lisp_Object Qoverflow_error, Qunderflow_error;
2388 extern Lisp_Object Qfloatp;
2389 extern Lisp_Object Qnumberp, Qnumber_or_marker_p;
2391 extern Lisp_Object Qinteger;
2393 extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
2395 EXFUN (Finteractive_form, 1);
2396 EXFUN (Fbyteorder, 0);
2398 /* Defined in frame.c */
2399 extern Lisp_Object Qframep;
2401 /* Defined in data.c */
2402 EXFUN (Fcar, 1);
2403 EXFUN (Fcar_safe, 1);
2404 EXFUN (Fcdr, 1);
2405 EXFUN (Fcdr_safe, 1);
2406 EXFUN (Fsetcar, 2);
2407 EXFUN (Fsetcdr, 2);
2408 EXFUN (Fboundp, 1);
2409 EXFUN (Ffboundp, 1);
2410 EXFUN (Fsymbol_function, 1);
2411 EXFUN (Fsymbol_name, 1);
2412 extern Lisp_Object indirect_function (Lisp_Object);
2413 EXFUN (Findirect_function, 2);
2414 EXFUN (Ffset, 2);
2415 EXFUN (Fsymbol_value, 1);
2416 extern Lisp_Object find_symbol_value (Lisp_Object);
2417 EXFUN (Fset, 2);
2418 EXFUN (Fdefault_value, 1);
2419 EXFUN (Fset_default, 2);
2420 EXFUN (Fdefault_boundp, 1);
2421 EXFUN (Fmake_local_variable, 1);
2422 EXFUN (Flocal_variable_p, 2);
2424 EXFUN (Faref, 2);
2425 EXFUN (Faset, 3);
2427 EXFUN (Fstring_to_number, 2);
2428 EXFUN (Fnumber_to_string, 1);
2429 EXFUN (Fgtr, 2);
2430 EXFUN (Flss, 2);
2431 EXFUN (Fgeq, 2);
2432 EXFUN (Fleq, 2);
2433 EXFUN (Fzerop, 1);
2434 EXFUN (Fplus, MANY);
2435 EXFUN (Fminus, MANY);
2436 EXFUN (Ftimes, MANY);
2437 EXFUN (Fquo, MANY);
2438 EXFUN (Frem, 2);
2439 EXFUN (Fmax, MANY);
2440 EXFUN (Fmin, MANY);
2442 EXFUN (Fadd1, 1);
2443 EXFUN (Fsub1, 1);
2444 EXFUN (Fmake_variable_buffer_local, 1);
2446 /* Convert the integer I to an Emacs representation, either the integer
2447 itself, or a cons of two or three integers, or if all else fails a float.
2448 I should not have side effects. */
2449 #define INTEGER_TO_CONS(i) \
2450 (! FIXNUM_OVERFLOW_P (i) \
2451 ? make_number (i) \
2452 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2453 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2454 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2455 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2456 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2457 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2458 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2459 ? Fcons (make_number ((i) >> 16 >> 24), \
2460 Fcons (make_number ((i) >> 16 & 0xffffff), \
2461 make_number ((i) & 0xffff))) \
2462 : make_float (i))
2464 /* Convert the Emacs representation CONS back to an integer of type
2465 TYPE, storing the result the variable VAR. Signal an error if CONS
2466 is not a valid representation or is out of range for TYPE. */
2467 #define CONS_TO_INTEGER(cons, type, var) \
2468 (TYPE_SIGNED (type) \
2469 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2470 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2471 extern intmax_t cons_to_signed (Lisp_Object, intmax_t, intmax_t);
2472 extern uintmax_t cons_to_unsigned (Lisp_Object, uintmax_t);
2474 extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *);
2475 extern void args_out_of_range (Lisp_Object, Lisp_Object) NO_RETURN;
2476 extern void args_out_of_range_3 (Lisp_Object, Lisp_Object,
2477 Lisp_Object) NO_RETURN;
2478 extern Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object) NO_RETURN;
2479 extern Lisp_Object do_symval_forwarding (union Lisp_Fwd *);
2480 extern void set_internal (Lisp_Object, Lisp_Object, Lisp_Object, int);
2481 extern void syms_of_data (void);
2482 extern void init_data (void);
2483 extern void swap_in_global_binding (struct Lisp_Symbol *);
2485 /* Defined in cmds.c */
2486 EXFUN (Fend_of_line, 1);
2487 EXFUN (Fforward_char, 1);
2488 EXFUN (Fforward_line, 1);
2489 extern void syms_of_cmds (void);
2490 extern void keys_of_cmds (void);
2492 /* Defined in coding.c */
2493 extern Lisp_Object Qcharset;
2494 EXFUN (Fcoding_system_p, 1);
2495 EXFUN (Fcoding_system_base, 1);
2496 EXFUN (Fcoding_system_eol_type, 1);
2497 EXFUN (Fcheck_coding_system, 1);
2498 EXFUN (Fread_coding_system, 2);
2499 EXFUN (Fread_non_nil_coding_system, 1);
2500 EXFUN (Ffind_operation_coding_system, MANY);
2501 EXFUN (Fdecode_coding_string, 4);
2502 extern Lisp_Object detect_coding_system (const unsigned char *, EMACS_INT,
2503 EMACS_INT, int, int, Lisp_Object);
2504 extern void init_coding (void);
2505 extern void init_coding_once (void);
2506 extern void syms_of_coding (void);
2508 /* Defined in character.c */
2509 EXFUN (Fchar_width, 1);
2510 EXFUN (Fstring, MANY);
2511 extern EMACS_INT chars_in_text (const unsigned char *, EMACS_INT);
2512 extern EMACS_INT multibyte_chars_in_text (const unsigned char *, EMACS_INT);
2513 extern int multibyte_char_to_unibyte (int);
2514 extern int multibyte_char_to_unibyte_safe (int);
2515 extern void init_character_once (void);
2516 extern void syms_of_character (void);
2518 /* Defined in charset.c */
2519 extern void init_charset (void);
2520 extern void init_charset_once (void);
2521 extern void syms_of_charset (void);
2522 /* Structure forward declarations. */
2523 struct charset;
2525 /* Defined in composite.c */
2526 extern void syms_of_composite (void);
2528 /* Defined in syntax.c */
2529 EXFUN (Fforward_word, 1);
2530 EXFUN (Fskip_chars_forward, 2);
2531 EXFUN (Fskip_chars_backward, 2);
2532 extern void init_syntax_once (void);
2533 extern void syms_of_syntax (void);
2535 /* Defined in fns.c */
2536 extern Lisp_Object QCrehash_size, QCrehash_threshold;
2537 extern EMACS_INT next_almost_prime (EMACS_INT);
2538 extern Lisp_Object larger_vector (Lisp_Object, EMACS_INT, Lisp_Object);
2539 extern void sweep_weak_hash_tables (void);
2540 extern Lisp_Object Qcursor_in_echo_area;
2541 extern Lisp_Object Qstring_lessp;
2542 extern Lisp_Object QCsize, QCtest, QCweakness, Qequal, Qeq, Qeql;
2543 EMACS_UINT sxhash (Lisp_Object, int);
2544 Lisp_Object make_hash_table (Lisp_Object, Lisp_Object, Lisp_Object,
2545 Lisp_Object, Lisp_Object, Lisp_Object,
2546 Lisp_Object);
2547 EMACS_INT hash_lookup (struct Lisp_Hash_Table *, Lisp_Object, EMACS_UINT *);
2548 EMACS_INT hash_put (struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
2549 EMACS_UINT);
2550 void init_weak_hash_tables (void);
2551 extern void init_fns (void);
2552 EXFUN (Fmake_hash_table, MANY);
2553 EXFUN (Fgethash, 3);
2554 EXFUN (Fputhash, 3);
2555 EXFUN (Fremhash, 2);
2557 EXFUN (Fidentity, 1);
2558 EXFUN (Flength, 1);
2559 EXFUN (Fappend, MANY);
2560 EXFUN (Fconcat, MANY);
2561 EXFUN (Fvconcat, MANY);
2562 EXFUN (Fcopy_sequence, 1);
2563 EXFUN (Fstring_make_multibyte, 1);
2564 EXFUN (Fstring_make_unibyte, 1);
2565 EXFUN (Fstring_as_multibyte, 1);
2566 EXFUN (Fstring_as_unibyte, 1);
2567 EXFUN (Fstring_to_multibyte, 1);
2568 EXFUN (Fsubstring, 3);
2569 extern Lisp_Object substring_both (Lisp_Object, EMACS_INT, EMACS_INT,
2570 EMACS_INT, EMACS_INT);
2571 EXFUN (Fnth, 2);
2572 EXFUN (Fnthcdr, 2);
2573 EXFUN (Fmemq, 2);
2574 EXFUN (Fassq, 2);
2575 EXFUN (Fassoc, 2);
2576 EXFUN (Felt, 2);
2577 EXFUN (Fmember, 2);
2578 EXFUN (Frassq, 2);
2579 EXFUN (Fdelq, 2);
2580 EXFUN (Fdelete, 2);
2581 EXFUN (Fsort, 2);
2582 EXFUN (Freverse, 1);
2583 EXFUN (Fnreverse, 1);
2584 EXFUN (Fget, 2);
2585 EXFUN (Fput, 3);
2586 EXFUN (Fequal, 2);
2587 EXFUN (Fnconc, MANY);
2588 EXFUN (Fmapcar, 2);
2589 EXFUN (Fmapconcat, 3);
2590 extern Lisp_Object do_yes_or_no_p (Lisp_Object);
2591 EXFUN (Fprovide, 2);
2592 extern Lisp_Object concat2 (Lisp_Object, Lisp_Object);
2593 extern Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2594 extern Lisp_Object nconc2 (Lisp_Object, Lisp_Object);
2595 extern Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object);
2596 extern Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object);
2597 extern void clear_string_char_byte_cache (void);
2598 extern EMACS_INT string_char_to_byte (Lisp_Object, EMACS_INT);
2599 extern EMACS_INT string_byte_to_char (Lisp_Object, EMACS_INT);
2600 extern Lisp_Object string_to_multibyte (Lisp_Object);
2601 extern Lisp_Object string_make_unibyte (Lisp_Object);
2602 EXFUN (Fcopy_alist, 1);
2603 EXFUN (Fplist_get, 2);
2604 EXFUN (Fplist_put, 3);
2605 EXFUN (Fplist_member, 2);
2606 EXFUN (Frassoc, 2);
2607 EXFUN (Fstring_equal, 2);
2608 EXFUN (Fcompare_strings, 7);
2609 EXFUN (Fstring_lessp, 2);
2610 extern void syms_of_fns (void);
2612 /* Defined in floatfns.c */
2613 extern double extract_float (Lisp_Object);
2614 EXFUN (Ffloat, 1);
2615 EXFUN (Ftruncate, 2);
2616 extern void init_floatfns (void);
2617 extern void syms_of_floatfns (void);
2618 extern Lisp_Object fmod_float (Lisp_Object x, Lisp_Object y);
2620 /* Defined in fringe.c */
2621 extern void syms_of_fringe (void);
2622 extern void init_fringe (void);
2623 #ifdef HAVE_WINDOW_SYSTEM
2624 extern void mark_fringe_data (void);
2625 extern void init_fringe_once (void);
2626 #endif /* HAVE_WINDOW_SYSTEM */
2628 /* Defined in image.c */
2629 extern Lisp_Object QCascent, QCmargin, QCrelief;
2630 extern Lisp_Object QCconversion;
2631 extern int x_bitmap_mask (struct frame *, ptrdiff_t);
2632 extern void syms_of_image (void);
2633 extern void init_image (void);
2635 /* Defined in insdel.c */
2636 extern Lisp_Object Qinhibit_modification_hooks;
2637 extern void move_gap (EMACS_INT);
2638 extern void move_gap_both (EMACS_INT, EMACS_INT);
2639 extern void buffer_overflow (void) NO_RETURN;
2640 extern void make_gap (EMACS_INT);
2641 extern EMACS_INT copy_text (const unsigned char *, unsigned char *,
2642 EMACS_INT, int, int);
2643 extern int count_combining_before (const unsigned char *,
2644 EMACS_INT, EMACS_INT, EMACS_INT);
2645 extern int count_combining_after (const unsigned char *,
2646 EMACS_INT, EMACS_INT, EMACS_INT);
2647 extern void insert (const char *, EMACS_INT);
2648 extern void insert_and_inherit (const char *, EMACS_INT);
2649 extern void insert_1 (const char *, EMACS_INT, int, int, int);
2650 extern void insert_1_both (const char *, EMACS_INT, EMACS_INT,
2651 int, int, int);
2652 extern void insert_from_gap (EMACS_INT, EMACS_INT);
2653 extern void insert_from_string (Lisp_Object, EMACS_INT, EMACS_INT,
2654 EMACS_INT, EMACS_INT, int);
2655 extern void insert_from_buffer (struct buffer *, EMACS_INT, EMACS_INT, int);
2656 extern void insert_char (int);
2657 extern void insert_string (const char *);
2658 extern void insert_before_markers (const char *, EMACS_INT);
2659 extern void insert_before_markers_and_inherit (const char *, EMACS_INT);
2660 extern void insert_from_string_before_markers (Lisp_Object, EMACS_INT,
2661 EMACS_INT, EMACS_INT,
2662 EMACS_INT, int);
2663 extern void del_range (EMACS_INT, EMACS_INT);
2664 extern Lisp_Object del_range_1 (EMACS_INT, EMACS_INT, int, int);
2665 extern void del_range_byte (EMACS_INT, EMACS_INT, int);
2666 extern void del_range_both (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT, int);
2667 extern Lisp_Object del_range_2 (EMACS_INT, EMACS_INT,
2668 EMACS_INT, EMACS_INT, int);
2669 extern void modify_region (struct buffer *, EMACS_INT, EMACS_INT, int);
2670 extern void prepare_to_modify_buffer (EMACS_INT, EMACS_INT, EMACS_INT *);
2671 extern void signal_after_change (EMACS_INT, EMACS_INT, EMACS_INT);
2672 extern void adjust_after_insert (EMACS_INT, EMACS_INT, EMACS_INT,
2673 EMACS_INT, EMACS_INT);
2674 extern void adjust_markers_for_delete (EMACS_INT, EMACS_INT,
2675 EMACS_INT, EMACS_INT);
2676 extern void replace_range (EMACS_INT, EMACS_INT, Lisp_Object, int, int, int);
2677 extern void replace_range_2 (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
2678 const char *, EMACS_INT, EMACS_INT, int);
2679 extern void syms_of_insdel (void);
2681 /* Defined in dispnew.c */
2682 extern Lisp_Object selected_frame;
2683 extern Lisp_Object Vwindow_system;
2684 EXFUN (Fding, 1);
2685 EXFUN (Fredraw_frame, 1);
2686 EXFUN (Fsleep_for, 2);
2687 EXFUN (Fredisplay, 1);
2688 extern Lisp_Object sit_for (Lisp_Object, int, int);
2689 extern void init_display (void);
2690 extern void syms_of_display (void);
2692 /* Defined in xdisp.c */
2693 extern Lisp_Object Qinhibit_point_motion_hooks;
2694 extern Lisp_Object Qinhibit_redisplay, Qdisplay;
2695 extern Lisp_Object Qmenu_bar_update_hook;
2696 extern Lisp_Object Qwindow_scroll_functions;
2697 extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
2698 extern Lisp_Object Qimage, Qtext, Qboth, Qboth_horiz, Qtext_image_horiz;
2699 extern Lisp_Object Qspace, Qcenter, QCalign_to;
2700 extern Lisp_Object Qbar, Qhbar, Qbox, Qhollow;
2701 extern Lisp_Object Qleft_margin, Qright_margin;
2702 extern Lisp_Object Qglyphless_char;
2703 extern Lisp_Object QCdata, QCfile;
2704 extern Lisp_Object QCmap;
2705 extern Lisp_Object Qrisky_local_variable;
2706 extern struct frame *last_glyphless_glyph_frame;
2707 extern unsigned last_glyphless_glyph_face_id;
2708 extern int last_glyphless_glyph_merged_face_id;
2709 extern int noninteractive_need_newline;
2710 extern Lisp_Object echo_area_buffer[2];
2711 extern void add_to_log (const char *, Lisp_Object, Lisp_Object);
2712 extern void check_message_stack (void);
2713 extern void setup_echo_area_for_printing (int);
2714 extern int push_message (void);
2715 extern Lisp_Object pop_message_unwind (Lisp_Object);
2716 extern Lisp_Object restore_message_unwind (Lisp_Object);
2717 extern void restore_message (void);
2718 extern Lisp_Object current_message (void);
2719 extern void clear_message (int, int);
2720 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2721 extern void message1 (const char *);
2722 extern void message1_nolog (const char *);
2723 extern void message2 (const char *, EMACS_INT, int);
2724 extern void message2_nolog (const char *, EMACS_INT, int);
2725 extern void message3 (Lisp_Object, EMACS_INT, int);
2726 extern void message3_nolog (Lisp_Object, EMACS_INT, int);
2727 extern void message_dolog (const char *, EMACS_INT, int, int);
2728 extern void message_with_string (const char *, Lisp_Object, int);
2729 extern void message_log_maybe_newline (void);
2730 extern void update_echo_area (void);
2731 extern void truncate_echo_area (EMACS_INT);
2732 extern void redisplay (void);
2733 extern void redisplay_preserve_echo_area (int);
2734 extern void prepare_menu_bars (void);
2736 void set_frame_cursor_types (struct frame *, Lisp_Object);
2737 extern void syms_of_xdisp (void);
2738 extern void init_xdisp (void);
2739 extern Lisp_Object safe_eval (Lisp_Object);
2740 extern int pos_visible_p (struct window *, EMACS_INT, int *,
2741 int *, int *, int *, int *, int *);
2743 /* Defined in xsettings.c */
2744 extern void syms_of_xsettings (void);
2746 /* Defined in vm-limit.c. */
2747 extern void memory_warnings (POINTER_TYPE *, void (*warnfun) (const char *));
2749 /* Defined in alloc.c */
2750 extern void check_pure_size (void);
2751 extern void allocate_string_data (struct Lisp_String *, EMACS_INT, EMACS_INT);
2752 extern void reset_malloc_hooks (void);
2753 extern void uninterrupt_malloc (void);
2754 extern void malloc_warning (const char *);
2755 extern void memory_full (size_t) NO_RETURN;
2756 extern void buffer_memory_full (EMACS_INT) NO_RETURN;
2757 extern int survives_gc_p (Lisp_Object);
2758 extern void mark_object (Lisp_Object);
2759 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2760 extern void refill_memory_reserve (void);
2761 #endif
2762 extern const char *pending_malloc_warning;
2763 extern Lisp_Object *stack_base;
2764 EXFUN (Fcons, 2);
2765 extern Lisp_Object list1 (Lisp_Object);
2766 extern Lisp_Object list2 (Lisp_Object, Lisp_Object);
2767 extern Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object);
2768 extern Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2769 extern Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2770 Lisp_Object);
2771 EXFUN (Flist, MANY);
2772 EXFUN (Fmake_list, 2);
2773 extern Lisp_Object allocate_misc (void);
2774 EXFUN (Fmake_vector, 2);
2775 EXFUN (Fvector, MANY);
2776 EXFUN (Fmake_symbol, 1);
2777 EXFUN (Fmake_marker, 0);
2778 extern void string_overflow (void) NO_RETURN;
2779 EXFUN (Fmake_string, 2);
2780 extern Lisp_Object build_string (const char *);
2781 extern Lisp_Object make_string (const char *, EMACS_INT);
2782 extern Lisp_Object make_unibyte_string (const char *, EMACS_INT);
2783 extern Lisp_Object make_multibyte_string (const char *, EMACS_INT, EMACS_INT);
2784 extern Lisp_Object make_event_array (int, Lisp_Object *);
2785 extern Lisp_Object make_uninit_string (EMACS_INT);
2786 extern Lisp_Object make_uninit_multibyte_string (EMACS_INT, EMACS_INT);
2787 extern Lisp_Object make_string_from_bytes (const char *, EMACS_INT, EMACS_INT);
2788 extern Lisp_Object make_specified_string (const char *,
2789 EMACS_INT, EMACS_INT, int);
2790 EXFUN (Fpurecopy, 1);
2791 extern Lisp_Object make_pure_string (const char *, EMACS_INT, EMACS_INT, int);
2792 extern Lisp_Object make_pure_c_string (const char *data);
2793 extern Lisp_Object pure_cons (Lisp_Object, Lisp_Object);
2794 extern Lisp_Object make_pure_vector (EMACS_INT);
2795 EXFUN (Fgarbage_collect, 0);
2796 EXFUN (Fmake_byte_code, MANY);
2797 EXFUN (Fmake_bool_vector, 2);
2798 extern Lisp_Object Qchar_table_extra_slots;
2799 extern struct Lisp_Vector *allocate_vector (EMACS_INT);
2800 extern struct Lisp_Vector *allocate_pseudovector (int memlen, int lisplen, EMACS_INT tag);
2801 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2802 ((typ*) \
2803 allocate_pseudovector \
2804 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2805 extern struct Lisp_Hash_Table *allocate_hash_table (void);
2806 extern struct window *allocate_window (void);
2807 extern struct frame *allocate_frame (void);
2808 extern struct Lisp_Process *allocate_process (void);
2809 extern struct terminal *allocate_terminal (void);
2810 extern int gc_in_progress;
2811 extern int abort_on_gc;
2812 extern Lisp_Object make_float (double);
2813 extern void display_malloc_warning (void);
2814 extern int inhibit_garbage_collection (void);
2815 extern Lisp_Object make_save_value (void *, ptrdiff_t);
2816 extern void free_marker (Lisp_Object);
2817 extern void free_cons (struct Lisp_Cons *);
2818 extern void init_alloc_once (void);
2819 extern void init_alloc (void);
2820 extern void syms_of_alloc (void);
2821 extern struct buffer * allocate_buffer (void);
2822 extern int valid_lisp_object_p (Lisp_Object);
2824 /* Defined in chartab.c */
2825 EXFUN (Fmake_char_table, 2);
2826 EXFUN (Fset_char_table_parent, 2);
2827 EXFUN (Fchar_table_extra_slot, 2);
2828 EXFUN (Fset_char_table_extra_slot, 3);
2829 EXFUN (Fset_char_table_range, 3);
2830 EXFUN (Foptimize_char_table, 2);
2831 extern Lisp_Object copy_char_table (Lisp_Object);
2832 extern Lisp_Object char_table_ref (Lisp_Object, int);
2833 extern Lisp_Object char_table_ref_and_range (Lisp_Object, int,
2834 int *, int *);
2835 extern Lisp_Object char_table_set (Lisp_Object, int, Lisp_Object);
2836 extern Lisp_Object char_table_set_range (Lisp_Object, int, int,
2837 Lisp_Object);
2838 extern int char_table_translate (Lisp_Object, int);
2839 extern void map_char_table (void (*) (Lisp_Object, Lisp_Object,
2840 Lisp_Object),
2841 Lisp_Object, Lisp_Object, Lisp_Object);
2842 extern void map_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object),
2843 Lisp_Object, Lisp_Object,
2844 Lisp_Object, struct charset *,
2845 unsigned, unsigned);
2846 extern void syms_of_chartab (void);
2848 /* Defined in print.c */
2849 extern Lisp_Object Vprin1_to_string_buffer;
2850 extern void debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
2851 EXFUN (Fprin1, 2);
2852 EXFUN (Fprin1_to_string, 2);
2853 EXFUN (Fterpri, 1);
2854 EXFUN (Fprint, 2);
2855 EXFUN (Ferror_message_string, 1);
2856 extern Lisp_Object Qstandard_output;
2857 extern Lisp_Object Qexternal_debugging_output;
2858 extern void temp_output_buffer_setup (const char *);
2859 extern int print_level;
2860 extern Lisp_Object Qprint_escape_newlines;
2861 extern void write_string (const char *, int);
2862 extern void print_error_message (Lisp_Object, Lisp_Object, const char *,
2863 Lisp_Object);
2864 extern Lisp_Object internal_with_output_to_temp_buffer
2865 (const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object);
2866 #define FLOAT_TO_STRING_BUFSIZE 350
2867 extern void float_to_string (char *, double);
2868 extern void syms_of_print (void);
2870 /* Defined in doprnt.c */
2871 extern size_t doprnt (char *, size_t, const char *, const char *, va_list);
2873 /* Defined in lread.c. */
2874 extern Lisp_Object Qvariable_documentation, Qstandard_input;
2875 extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
2876 EXFUN (Fread, 1);
2877 EXFUN (Fread_from_string, 3);
2878 EXFUN (Fintern, 2);
2879 EXFUN (Fintern_soft, 2);
2880 EXFUN (Funintern, 2);
2881 EXFUN (Fload, 5);
2882 EXFUN (Fget_load_suffixes, 0);
2883 EXFUN (Fread_char, 3);
2884 EXFUN (Fread_event, 3);
2885 extern Lisp_Object check_obarray (Lisp_Object);
2886 extern Lisp_Object intern (const char *);
2887 extern Lisp_Object intern_c_string (const char *);
2888 extern Lisp_Object oblookup (Lisp_Object, const char *, EMACS_INT, EMACS_INT);
2889 #define LOADHIST_ATTACH(x) \
2890 do { \
2891 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2892 } while (0)
2893 extern int openp (Lisp_Object, Lisp_Object, Lisp_Object,
2894 Lisp_Object *, Lisp_Object);
2895 Lisp_Object string_to_number (char const *, int, int);
2896 extern void map_obarray (Lisp_Object, void (*) (Lisp_Object, Lisp_Object),
2897 Lisp_Object);
2898 extern void dir_warning (const char *, Lisp_Object);
2899 extern void close_load_descs (void);
2900 extern void init_obarray (void);
2901 extern void init_lread (void);
2902 extern void syms_of_lread (void);
2904 /* Defined in eval.c. */
2905 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
2906 extern Lisp_Object Qinhibit_quit, Qclosure;
2907 extern Lisp_Object Qand_rest;
2908 extern Lisp_Object Vautoload_queue;
2909 extern Lisp_Object Vsignaling_function;
2910 extern int handling_signal;
2911 #if BYTE_MARK_STACK
2912 extern struct catchtag *catchlist;
2913 extern struct handler *handlerlist;
2914 #endif
2915 /* To run a normal hook, use the appropriate function from the list below.
2916 The calling convention:
2918 if (!NILP (Vrun_hooks))
2919 call1 (Vrun_hooks, Qmy_funny_hook);
2921 should no longer be used. */
2922 extern Lisp_Object Vrun_hooks;
2923 EXFUN (Frun_hooks, MANY);
2924 EXFUN (Frun_hook_with_args, MANY);
2925 EXFUN (Frun_hook_with_args_until_failure, MANY);
2926 extern void run_hook_with_args_2 (Lisp_Object, Lisp_Object, Lisp_Object);
2927 extern Lisp_Object run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args,
2928 Lisp_Object (*funcall)
2929 (ptrdiff_t nargs, Lisp_Object *args));
2930 EXFUN (Fprogn, UNEVALLED);
2931 EXFUN (Finteractive_p, 0);
2932 EXFUN (Fthrow, 2) NO_RETURN;
2933 EXFUN (Fsignal, 2);
2934 extern void xsignal (Lisp_Object, Lisp_Object) NO_RETURN;
2935 extern void xsignal0 (Lisp_Object) NO_RETURN;
2936 extern void xsignal1 (Lisp_Object, Lisp_Object) NO_RETURN;
2937 extern void xsignal2 (Lisp_Object, Lisp_Object, Lisp_Object) NO_RETURN;
2938 extern void xsignal3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object) NO_RETURN;
2939 extern void signal_error (const char *, Lisp_Object) NO_RETURN;
2940 EXFUN (Fcommandp, 2);
2941 EXFUN (Ffunctionp, 1);
2942 EXFUN (Feval, 2);
2943 extern Lisp_Object eval_sub (Lisp_Object form);
2944 EXFUN (Fapply, MANY);
2945 EXFUN (Ffuncall, MANY);
2946 extern Lisp_Object apply1 (Lisp_Object, Lisp_Object);
2947 extern Lisp_Object call0 (Lisp_Object);
2948 extern Lisp_Object call1 (Lisp_Object, Lisp_Object);
2949 extern Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2950 extern Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2951 extern Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2952 extern Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2953 extern Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2954 extern Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2955 EXFUN (Fdo_auto_save, 2);
2956 extern Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object);
2957 extern Lisp_Object internal_lisp_condition_case (Lisp_Object, Lisp_Object, Lisp_Object);
2958 extern Lisp_Object internal_condition_case (Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object));
2959 extern Lisp_Object internal_condition_case_1 (Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
2960 extern Lisp_Object internal_condition_case_2 (Lisp_Object (*) (Lisp_Object, Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
2961 extern Lisp_Object internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object *), ptrdiff_t, Lisp_Object *, Lisp_Object, Lisp_Object (*) (Lisp_Object));
2962 extern void specbind (Lisp_Object, Lisp_Object);
2963 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object), Lisp_Object);
2964 extern Lisp_Object unbind_to (int, Lisp_Object);
2965 extern void error (const char *, ...) NO_RETURN ATTRIBUTE_FORMAT_PRINTF (1, 2);
2966 extern void verror (const char *, va_list)
2967 NO_RETURN ATTRIBUTE_FORMAT_PRINTF (1, 0);
2968 extern void do_autoload (Lisp_Object, Lisp_Object);
2969 extern Lisp_Object un_autoload (Lisp_Object);
2970 extern void init_eval_once (void);
2971 extern Lisp_Object safe_call (ptrdiff_t, Lisp_Object *);
2972 extern Lisp_Object safe_call1 (Lisp_Object, Lisp_Object);
2973 extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2974 extern void init_eval (void);
2975 #if BYTE_MARK_STACK
2976 extern void mark_backtrace (void);
2977 #endif
2978 extern void syms_of_eval (void);
2980 /* Defined in editfns.c */
2981 extern Lisp_Object Qfield;
2982 EXFUN (Fcurrent_message, 0);
2983 EXFUN (Fgoto_char, 1);
2984 EXFUN (Fpoint_max_marker, 0);
2985 EXFUN (Fpoint, 0);
2986 EXFUN (Fpoint_marker, 0);
2987 EXFUN (Fline_beginning_position, 1);
2988 EXFUN (Fline_end_position, 1);
2989 EXFUN (Ffollowing_char, 0);
2990 EXFUN (Fprevious_char, 0);
2991 EXFUN (Fchar_after, 1);
2992 EXFUN (Finsert, MANY);
2993 EXFUN (Finsert_char, 3);
2994 extern void insert1 (Lisp_Object);
2995 EXFUN (Feolp, 0);
2996 EXFUN (Feobp, 0);
2997 EXFUN (Fbolp, 0);
2998 EXFUN (Fbobp, 0);
2999 EXFUN (Fformat, MANY);
3000 EXFUN (Fmessage, MANY);
3001 extern Lisp_Object format2 (const char *, Lisp_Object, Lisp_Object);
3002 EXFUN (Fbuffer_substring, 2);
3003 EXFUN (Fbuffer_string, 0);
3004 extern Lisp_Object save_excursion_save (void);
3005 extern Lisp_Object save_restriction_save (void);
3006 extern Lisp_Object save_excursion_restore (Lisp_Object);
3007 extern Lisp_Object save_restriction_restore (Lisp_Object);
3008 EXFUN (Fchar_to_string, 1);
3009 EXFUN (Fdelete_region, 2);
3010 EXFUN (Fnarrow_to_region, 2);
3011 EXFUN (Fwiden, 0);
3012 EXFUN (Fuser_login_name, 1);
3013 EXFUN (Fsystem_name, 0);
3014 EXFUN (Fcurrent_time, 0);
3015 EXFUN (Fget_internal_run_time, 0);
3016 extern EMACS_INT clip_to_bounds (EMACS_INT, EMACS_INT, EMACS_INT);
3017 extern Lisp_Object make_buffer_string (EMACS_INT, EMACS_INT, int);
3018 extern Lisp_Object make_buffer_string_both (EMACS_INT, EMACS_INT, EMACS_INT,
3019 EMACS_INT, int);
3020 extern void init_editfns (void);
3021 const char *get_system_name (void);
3022 extern void syms_of_editfns (void);
3023 EXFUN (Fconstrain_to_field, 5);
3024 EXFUN (Ffield_end, 3);
3025 extern void set_time_zone_rule (const char *);
3027 /* Defined in buffer.c */
3028 extern int mouse_face_overlay_overlaps (Lisp_Object);
3029 extern void nsberror (Lisp_Object) NO_RETURN;
3030 EXFUN (Fset_buffer_multibyte, 1);
3031 EXFUN (Foverlay_start, 1);
3032 EXFUN (Foverlay_end, 1);
3033 extern void adjust_overlays_for_insert (EMACS_INT, EMACS_INT);
3034 extern void adjust_overlays_for_delete (EMACS_INT, EMACS_INT);
3035 extern void fix_start_end_in_overlays (EMACS_INT, EMACS_INT);
3036 extern void report_overlay_modification (Lisp_Object, Lisp_Object, int,
3037 Lisp_Object, Lisp_Object, Lisp_Object);
3038 extern int overlay_touches_p (EMACS_INT);
3039 extern Lisp_Object Vbuffer_alist;
3040 EXFUN (Fget_buffer, 1);
3041 EXFUN (Fget_buffer_create, 1);
3042 EXFUN (Fgenerate_new_buffer_name, 2);
3043 EXFUN (Fset_buffer, 1);
3044 extern Lisp_Object set_buffer_if_live (Lisp_Object);
3045 EXFUN (Fbarf_if_buffer_read_only, 0);
3046 EXFUN (Fcurrent_buffer, 0);
3047 EXFUN (Fother_buffer, 3);
3048 extern Lisp_Object other_buffer_safely (Lisp_Object);
3049 EXFUN (Foverlay_get, 2);
3050 EXFUN (Fbuffer_modified_p, 1);
3051 EXFUN (Fset_buffer_modified_p, 1);
3052 EXFUN (Fkill_buffer, 1);
3053 EXFUN (Fkill_all_local_variables, 0);
3054 EXFUN (Fbuffer_enable_undo, 1);
3055 EXFUN (Ferase_buffer, 0);
3056 extern Lisp_Object Qpriority, Qwindow, Qbefore_string, Qafter_string;
3057 extern Lisp_Object get_truename_buffer (Lisp_Object);
3058 extern struct buffer *all_buffers;
3059 EXFUN (Fprevious_overlay_change, 1);
3060 EXFUN (Fbuffer_file_name, 1);
3061 extern void init_buffer_once (void);
3062 extern void init_buffer (void);
3063 extern void syms_of_buffer (void);
3064 extern void keys_of_buffer (void);
3066 /* Defined in marker.c */
3068 EXFUN (Fmarker_position, 1);
3069 EXFUN (Fmarker_buffer, 1);
3070 EXFUN (Fcopy_marker, 2);
3071 EXFUN (Fset_marker, 3);
3072 extern EMACS_INT marker_position (Lisp_Object);
3073 extern EMACS_INT marker_byte_position (Lisp_Object);
3074 extern void clear_charpos_cache (struct buffer *);
3075 extern EMACS_INT charpos_to_bytepos (EMACS_INT);
3076 extern EMACS_INT buf_charpos_to_bytepos (struct buffer *, EMACS_INT);
3077 extern EMACS_INT buf_bytepos_to_charpos (struct buffer *, EMACS_INT);
3078 extern void unchain_marker (struct Lisp_Marker *marker);
3079 extern Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object);
3080 extern Lisp_Object set_marker_both (Lisp_Object, Lisp_Object, EMACS_INT, EMACS_INT);
3081 extern Lisp_Object set_marker_restricted_both (Lisp_Object, Lisp_Object,
3082 EMACS_INT, EMACS_INT);
3083 extern void syms_of_marker (void);
3085 /* Defined in fileio.c */
3087 extern Lisp_Object Qfile_error;
3088 extern Lisp_Object Qfile_exists_p;
3089 extern Lisp_Object Qfile_directory_p;
3090 extern Lisp_Object Qinsert_file_contents;
3091 extern Lisp_Object Qfile_name_history;
3092 EXFUN (Ffind_file_name_handler, 2);
3093 EXFUN (Ffile_name_as_directory, 1);
3094 EXFUN (Fexpand_file_name, 2);
3095 EXFUN (Ffile_name_nondirectory, 1);
3096 EXFUN (Fsubstitute_in_file_name, 1);
3097 EXFUN (Ffile_symlink_p, 1);
3098 EXFUN (Fverify_visited_file_modtime, 1);
3099 EXFUN (Ffile_exists_p, 1);
3100 EXFUN (Ffile_name_absolute_p, 1);
3101 EXFUN (Fdirectory_file_name, 1);
3102 EXFUN (Ffile_name_directory, 1);
3103 extern Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object);
3104 EXFUN (Ffile_accessible_directory_p, 1);
3105 EXFUN (Funhandled_file_name_directory, 1);
3106 EXFUN (Ffile_directory_p, 1);
3107 EXFUN (Fwrite_region, 7);
3108 EXFUN (Ffile_readable_p, 1);
3109 EXFUN (Fread_file_name, 6);
3110 extern Lisp_Object close_file_unwind (Lisp_Object);
3111 extern Lisp_Object restore_point_unwind (Lisp_Object);
3112 extern void report_file_error (const char *, Lisp_Object) NO_RETURN;
3113 extern int internal_delete_file (Lisp_Object);
3114 extern void syms_of_fileio (void);
3115 extern Lisp_Object make_temp_name (Lisp_Object, int);
3116 extern Lisp_Object Qdelete_file;
3118 /* Defined in abbrev.c */
3120 extern void syms_of_abbrev (void);
3122 /* Defined in search.c */
3123 extern void shrink_regexp_cache (void);
3124 EXFUN (Fstring_match, 3);
3125 extern void restore_search_regs (void);
3126 EXFUN (Fmatch_data, 3);
3127 EXFUN (Fset_match_data, 2);
3128 EXFUN (Fmatch_beginning, 1);
3129 EXFUN (Fmatch_end, 1);
3130 extern void record_unwind_save_match_data (void);
3131 struct re_registers;
3132 extern struct re_pattern_buffer *compile_pattern (Lisp_Object,
3133 struct re_registers *,
3134 Lisp_Object, int, int);
3135 extern EMACS_INT fast_string_match (Lisp_Object, Lisp_Object);
3136 extern EMACS_INT fast_c_string_match_ignore_case (Lisp_Object, const char *);
3137 extern EMACS_INT fast_string_match_ignore_case (Lisp_Object, Lisp_Object);
3138 extern EMACS_INT fast_looking_at (Lisp_Object, EMACS_INT, EMACS_INT,
3139 EMACS_INT, EMACS_INT, Lisp_Object);
3140 extern EMACS_INT scan_buffer (int, EMACS_INT, EMACS_INT, EMACS_INT,
3141 EMACS_INT *, int);
3142 extern EMACS_INT scan_newline (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
3143 EMACS_INT, int);
3144 extern EMACS_INT find_next_newline (EMACS_INT, int);
3145 extern EMACS_INT find_next_newline_no_quit (EMACS_INT, EMACS_INT);
3146 extern EMACS_INT find_before_next_newline (EMACS_INT, EMACS_INT, EMACS_INT);
3147 extern void syms_of_search (void);
3148 extern void clear_regexp_cache (void);
3150 /* Defined in minibuf.c */
3152 extern Lisp_Object Qcompletion_ignore_case;
3153 extern Lisp_Object Vminibuffer_list;
3154 extern Lisp_Object last_minibuf_string;
3155 EXFUN (Fcompleting_read, 8);
3156 EXFUN (Fread_from_minibuffer, 7);
3157 EXFUN (Fread_variable, 2);
3158 EXFUN (Fread_buffer, 3);
3159 EXFUN (Fread_minibuffer, 2);
3160 EXFUN (Feval_minibuffer, 2);
3161 EXFUN (Fread_string, 5);
3162 EXFUN (Fassoc_string, 3);
3163 extern Lisp_Object get_minibuffer (int);
3164 extern void init_minibuf_once (void);
3165 extern void syms_of_minibuf (void);
3167 /* Defined in callint.c */
3169 extern Lisp_Object Qminus, Qplus;
3170 extern Lisp_Object Qwhen;
3171 extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
3172 EXFUN (Fprefix_numeric_value, 1);
3173 extern void syms_of_callint (void);
3175 /* Defined in casefiddle.c */
3177 extern Lisp_Object Qidentity;
3178 EXFUN (Fdowncase, 1);
3179 EXFUN (Fupcase, 1);
3180 EXFUN (Fupcase_region, 2);
3181 EXFUN (Fupcase_initials, 1);
3182 EXFUN (Fupcase_initials_region, 2);
3183 extern void syms_of_casefiddle (void);
3184 extern void keys_of_casefiddle (void);
3186 /* Defined in casetab.c */
3188 EXFUN (Fset_case_table, 1);
3189 EXFUN (Fset_standard_case_table, 1);
3190 extern void init_casetab_once (void);
3191 extern void syms_of_casetab (void);
3193 /* Defined in keyboard.c */
3195 extern Lisp_Object echo_message_buffer;
3196 extern struct kboard *echo_kboard;
3197 extern void cancel_echoing (void);
3198 extern Lisp_Object Qdisabled, QCfilter;
3199 extern Lisp_Object Qup, Qdown, Qbottom;
3200 extern Lisp_Object Qtop;
3201 extern int input_pending;
3202 EXFUN (Fdiscard_input, 0);
3203 EXFUN (Frecursive_edit, 0);
3204 EXFUN (Ftop_level, 0) NO_RETURN;
3205 extern Lisp_Object menu_bar_items (Lisp_Object);
3206 extern Lisp_Object tool_bar_items (Lisp_Object, int *);
3207 extern void discard_mouse_events (void);
3208 EXFUN (Fevent_convert_list, 1);
3209 EXFUN (Fread_key_sequence, 5);
3210 EXFUN (Fset_input_interrupt_mode, 1);
3211 EXFUN (Fset_input_mode, 4);
3212 extern Lisp_Object pending_funcalls;
3213 extern int detect_input_pending (void);
3214 extern int detect_input_pending_ignore_squeezables (void);
3215 extern int detect_input_pending_run_timers (int);
3216 extern void safe_run_hooks (Lisp_Object);
3217 extern void cmd_error_internal (Lisp_Object, const char *);
3218 extern Lisp_Object command_loop_1 (void);
3219 extern Lisp_Object recursive_edit_1 (void);
3220 extern void record_auto_save (void);
3221 #ifdef SIGDANGER
3222 extern void force_auto_save_soon (void);
3223 #endif
3224 extern void init_keyboard (void);
3225 extern void syms_of_keyboard (void);
3226 extern void keys_of_keyboard (void);
3227 extern char *push_key_description (unsigned int, char *, int);
3230 /* Defined in indent.c */
3231 EXFUN (Fvertical_motion, 2);
3232 EXFUN (Findent_to, 2);
3233 EXFUN (Fmove_to_column, 2);
3234 extern EMACS_INT current_column (void);
3235 extern void invalidate_current_column (void);
3236 extern int indented_beyond_p (EMACS_INT, EMACS_INT, EMACS_INT);
3237 extern void syms_of_indent (void);
3239 /* Defined in frame.c */
3240 #ifdef HAVE_WINDOW_SYSTEM
3241 #endif /* HAVE_WINDOW_SYSTEM */
3242 extern Lisp_Object Qonly;
3243 extern Lisp_Object Qvisible;
3244 extern void store_frame_param (struct frame *, Lisp_Object, Lisp_Object);
3245 extern void store_in_alist (Lisp_Object *, Lisp_Object, Lisp_Object);
3246 extern Lisp_Object do_switch_frame (Lisp_Object, int, int, Lisp_Object);
3247 #if HAVE_NS
3248 extern Lisp_Object get_frame_param (struct frame *, Lisp_Object);
3249 #endif
3250 extern Lisp_Object frame_buffer_predicate (Lisp_Object);
3251 EXFUN (Fselect_frame, 2);
3252 EXFUN (Fselected_frame, 0);
3253 EXFUN (Fmake_frame_visible, 1);
3254 EXFUN (Ficonify_frame, 1);
3255 EXFUN (Fframe_parameter, 2);
3256 EXFUN (Fmodify_frame_parameters, 2);
3257 EXFUN (Fraise_frame, 1);
3258 EXFUN (Fredirect_frame_focus, 2);
3259 extern void frames_discard_buffer (Lisp_Object);
3260 extern void syms_of_frame (void);
3262 /* Defined in emacs.c */
3263 extern char **initial_argv;
3264 extern int initial_argc;
3265 #if defined(HAVE_X_WINDOWS) || defined(HAVE_NS)
3266 extern int display_arg;
3267 #endif
3268 extern Lisp_Object decode_env_path (const char *, const char *);
3269 extern Lisp_Object empty_unibyte_string, empty_multibyte_string;
3270 extern Lisp_Object Qfile_name_handler_alist;
3271 #ifdef FLOAT_CATCH_SIGILL
3272 extern void fatal_error_signal (int);
3273 #endif
3274 EXFUN (Fkill_emacs, 1) NO_RETURN;
3275 #if HAVE_SETLOCALE
3276 void fixup_locale (void);
3277 void synchronize_system_messages_locale (void);
3278 void synchronize_system_time_locale (void);
3279 #else
3280 #define setlocale(category, locale)
3281 #define fixup_locale()
3282 #define synchronize_system_messages_locale()
3283 #define synchronize_system_time_locale()
3284 #endif
3285 void shut_down_emacs (int, int, Lisp_Object);
3286 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3287 extern int noninteractive;
3289 /* Nonzero means remove site-lisp directories from load-path. */
3290 extern int no_site_lisp;
3292 /* Pipe used to send exit notification to the daemon parent at
3293 startup. */
3294 extern int daemon_pipe[2];
3295 #define IS_DAEMON (daemon_pipe[1] != 0)
3297 /* Nonzero means don't do use window-system-specific display code. */
3298 extern int inhibit_window_system;
3299 /* Nonzero means that a filter or a sentinel is running. */
3300 extern int running_asynch_code;
3302 /* Defined in process.c. */
3303 extern Lisp_Object QCtype, Qlocal;
3304 EXFUN (Fget_buffer_process, 1);
3305 EXFUN (Fprocess_status, 1);
3306 EXFUN (Fkill_process, 2);
3307 EXFUN (Fwaiting_for_user_input_p, 0);
3308 extern Lisp_Object Qprocessp;
3309 extern void kill_buffer_processes (Lisp_Object);
3310 extern int wait_reading_process_output (int, int, int, int,
3311 Lisp_Object,
3312 struct Lisp_Process *,
3313 int);
3314 extern void add_keyboard_wait_descriptor (int);
3315 extern void delete_keyboard_wait_descriptor (int);
3316 #ifdef HAVE_GPM
3317 extern void add_gpm_wait_descriptor (int);
3318 extern void delete_gpm_wait_descriptor (int);
3319 #endif
3320 extern void close_process_descs (void);
3321 extern void init_process (void);
3322 extern void syms_of_process (void);
3323 extern void setup_process_coding_systems (Lisp_Object);
3325 EXFUN (Fcall_process, MANY);
3326 extern int child_setup (int, int, int, char **, int, Lisp_Object)
3327 #ifndef DOS_NT
3328 NO_RETURN
3329 #endif
3331 extern void init_callproc_1 (void);
3332 extern void init_callproc (void);
3333 extern void set_initial_environment (void);
3334 extern void syms_of_callproc (void);
3336 /* Defined in doc.c */
3337 extern Lisp_Object Qfunction_documentation;
3338 EXFUN (Fsubstitute_command_keys, 1);
3339 extern Lisp_Object read_doc_string (Lisp_Object);
3340 extern Lisp_Object get_doc_string (Lisp_Object, int, int);
3341 extern void syms_of_doc (void);
3342 extern int read_bytecode_char (int);
3344 /* Defined in bytecode.c */
3345 extern Lisp_Object Qbytecode;
3346 extern void syms_of_bytecode (void);
3347 extern struct byte_stack *byte_stack_list;
3348 #if BYTE_MARK_STACK
3349 extern void mark_byte_stack (void);
3350 #endif
3351 extern void unmark_byte_stack (void);
3352 extern Lisp_Object exec_byte_code (Lisp_Object, Lisp_Object, Lisp_Object,
3353 Lisp_Object, ptrdiff_t, Lisp_Object *);
3355 /* Defined in macros.c */
3356 extern Lisp_Object Qexecute_kbd_macro;
3357 EXFUN (Fexecute_kbd_macro, 3);
3358 EXFUN (Fcancel_kbd_macro_events, 0);
3359 extern void init_macros (void);
3360 extern void syms_of_macros (void);
3362 /* Defined in undo.c */
3363 extern Lisp_Object Qapply;
3364 extern Lisp_Object Qinhibit_read_only;
3365 EXFUN (Fundo_boundary, 0);
3366 extern void truncate_undo_list (struct buffer *);
3367 extern void record_marker_adjustment (Lisp_Object, EMACS_INT);
3368 extern void record_insert (EMACS_INT, EMACS_INT);
3369 extern void record_delete (EMACS_INT, Lisp_Object);
3370 extern void record_first_change (void);
3371 extern void record_change (EMACS_INT, EMACS_INT);
3372 extern void record_property_change (EMACS_INT, EMACS_INT,
3373 Lisp_Object, Lisp_Object,
3374 Lisp_Object);
3375 extern void syms_of_undo (void);
3376 /* Defined in textprop.c */
3377 extern Lisp_Object Qfont, Qmouse_face;
3378 extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
3379 extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
3380 extern Lisp_Object Qminibuffer_prompt;
3382 EXFUN (Fnext_single_property_change, 4);
3383 EXFUN (Fnext_single_char_property_change, 4);
3384 EXFUN (Fprevious_single_property_change, 4);
3385 EXFUN (Fget_text_property, 3);
3386 EXFUN (Fput_text_property, 5);
3387 EXFUN (Fprevious_char_property_change, 2);
3388 EXFUN (Fnext_char_property_change, 2);
3389 extern void report_interval_modification (Lisp_Object, Lisp_Object);
3391 /* Defined in menu.c */
3392 extern void syms_of_menu (void);
3394 /* Defined in xmenu.c */
3395 EXFUN (Fx_popup_menu, 2);
3396 EXFUN (Fx_popup_dialog, 3);
3397 extern void syms_of_xmenu (void);
3399 /* Defined in termchar.h */
3400 struct tty_display_info;
3402 /* Defined in termhooks.h */
3403 struct terminal;
3405 /* Defined in sysdep.c */
3406 #ifndef HAVE_GET_CURRENT_DIR_NAME
3407 extern char *get_current_dir_name (void);
3408 #endif
3409 extern void stuff_char (char c);
3410 extern void init_sigio (int);
3411 extern void sys_subshell (void);
3412 extern void sys_suspend (void);
3413 extern void discard_tty_input (void);
3414 extern void init_sys_modes (struct tty_display_info *);
3415 extern void reset_sys_modes (struct tty_display_info *);
3416 extern void init_all_sys_modes (void);
3417 extern void reset_all_sys_modes (void);
3418 extern void wait_for_termination (int);
3419 extern void interruptible_wait_for_termination (int);
3420 extern void flush_pending_output (int);
3421 extern void child_setup_tty (int);
3422 extern void setup_pty (int);
3423 extern int set_window_size (int, int, int);
3424 extern EMACS_INT get_random (void);
3425 extern void seed_random (long);
3426 extern int emacs_open (const char *, int, int);
3427 extern int emacs_close (int);
3428 extern EMACS_INT emacs_read (int, char *, EMACS_INT);
3429 extern EMACS_INT emacs_write (int, const char *, EMACS_INT);
3430 enum { READLINK_BUFSIZE = 1024 };
3431 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE]);
3432 #ifndef HAVE_MEMSET
3433 extern void *memset (void *, int, size_t);
3434 #endif
3435 #ifndef HAVE_MEMCPY
3436 extern void *memcpy (void *, void *, size_t);
3437 #endif
3438 #ifndef HAVE_MEMMOVE
3439 extern void *memmove (void *, void *, size_t);
3440 #endif
3441 #ifndef HAVE_MEMCMP
3442 extern int memcmp (void *, void *, size_t);
3443 #endif
3445 EXFUN (Funlock_buffer, 0);
3446 extern void unlock_all_files (void);
3447 extern void lock_file (Lisp_Object);
3448 extern void unlock_file (Lisp_Object);
3449 extern void unlock_buffer (struct buffer *);
3450 extern void syms_of_filelock (void);
3451 extern void init_filelock (void);
3453 /* Defined in sound.c */
3454 extern void syms_of_sound (void);
3455 extern void init_sound (void);
3457 /* Defined in category.c */
3458 extern void init_category_once (void);
3459 extern Lisp_Object char_category_set (int);
3460 extern void syms_of_category (void);
3462 /* Defined in ccl.c */
3463 extern void syms_of_ccl (void);
3465 /* Defined in dired.c */
3466 extern void syms_of_dired (void);
3467 extern Lisp_Object directory_files_internal (Lisp_Object, Lisp_Object,
3468 Lisp_Object, Lisp_Object,
3469 int, Lisp_Object);
3471 /* Defined in term.c */
3472 extern int *char_ins_del_vector;
3473 extern void mark_ttys (void);
3474 extern void syms_of_term (void);
3475 extern void fatal (const char *msgid, ...)
3476 NO_RETURN ATTRIBUTE_FORMAT_PRINTF (1, 2);
3478 /* Defined in terminal.c */
3479 EXFUN (Fframe_terminal, 1);
3480 EXFUN (Fdelete_terminal, 2);
3481 extern void syms_of_terminal (void);
3483 /* Defined in font.c */
3484 extern void syms_of_font (void);
3485 extern void init_font (void);
3487 #ifdef HAVE_WINDOW_SYSTEM
3488 /* Defined in fontset.c */
3489 extern void syms_of_fontset (void);
3491 /* Defined in xfns.c, w32fns.c, or macfns.c */
3492 extern Lisp_Object Qfont_param;
3493 EXFUN (Fxw_display_color_p, 1);
3494 EXFUN (Fx_focus_frame, 1);
3495 #endif
3497 /* Defined in xfaces.c */
3498 extern Lisp_Object Qdefault, Qtool_bar, Qfringe;
3499 extern Lisp_Object Qheader_line, Qscroll_bar, Qcursor;
3500 extern Lisp_Object Qmode_line_inactive;
3501 extern Lisp_Object Qface;
3502 extern Lisp_Object Qnormal;
3503 extern Lisp_Object QCfamily, QCweight, QCslant;
3504 extern Lisp_Object QCheight, QCname, QCwidth, QCforeground, QCbackground;
3505 extern Lisp_Object Vface_alternative_font_family_alist;
3506 extern Lisp_Object Vface_alternative_font_registry_alist;
3507 EXFUN (Fclear_face_cache, 1);
3508 EXFUN (Fx_load_color_file, 1);
3509 extern void syms_of_xfaces (void);
3511 #ifdef HAVE_X_WINDOWS
3512 /* Defined in xfns.c */
3513 extern void syms_of_xfns (void);
3515 /* Defined in xsmfns.c */
3516 extern void syms_of_xsmfns (void);
3518 /* Defined in xselect.c */
3519 extern void syms_of_xselect (void);
3521 /* Defined in xterm.c */
3522 extern void syms_of_xterm (void);
3523 #endif /* HAVE_X_WINDOWS */
3525 #ifdef HAVE_WINDOW_SYSTEM
3526 /* Defined in xterm.c, nsterm.m, w32term.c */
3527 extern char *x_get_keysym_name (int);
3528 #endif /* HAVE_WINDOW_SYSTEM */
3530 #ifdef MSDOS
3531 /* Defined in msdos.c */
3532 EXFUN (Fmsdos_downcase_filename, 1);
3533 #endif
3535 #ifdef HAVE_LIBXML2
3536 /* Defined in xml.c */
3537 extern void syms_of_xml (void);
3538 #endif
3540 #ifdef HAVE_MENUS
3541 /* Defined in (x|w32)fns.c, nsfns.m... */
3542 extern int have_menus_p (void);
3543 #endif
3545 #ifdef HAVE_DBUS
3546 /* Defined in dbusbind.c */
3547 void syms_of_dbusbind (void);
3548 #endif
3550 #ifdef DOS_NT
3551 /* Defined in msdos.c, w32.c */
3552 extern char *emacs_root_dir (void);
3553 #endif /* DOS_NT */
3555 /* Nonzero means Emacs has already been initialized.
3556 Used during startup to detect startup of dumped Emacs. */
3557 extern int initialized;
3559 extern int immediate_quit; /* Nonzero means ^G can quit instantly */
3561 extern POINTER_TYPE *xmalloc (size_t);
3562 extern POINTER_TYPE *xrealloc (POINTER_TYPE *, size_t);
3563 extern void xfree (POINTER_TYPE *);
3565 extern char *xstrdup (const char *);
3567 extern char *egetenv (const char *);
3569 /* Set up the name of the machine we're running on. */
3570 extern void init_system_name (void);
3572 /* Some systems (e.g., NT) use a different path separator than Unix,
3573 in addition to a device separator. Set the path separator
3574 to '/', and don't test for a device separator in IS_ANY_SEP. */
3576 #define DIRECTORY_SEP '/'
3577 #ifndef IS_DIRECTORY_SEP
3578 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3579 #endif
3580 #ifndef IS_DEVICE_SEP
3581 #ifndef DEVICE_SEP
3582 #define IS_DEVICE_SEP(_c_) 0
3583 #else
3584 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3585 #endif
3586 #endif
3587 #ifndef IS_ANY_SEP
3588 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3589 #endif
3591 #define SWITCH_ENUM_CAST(x) (x)
3593 /* Use this to suppress gcc's warnings. */
3594 #ifdef lint
3596 /* Use CODE only if lint checking is in effect. */
3597 # define IF_LINT(Code) Code
3599 /* Assume that the expression COND is true. This differs in intent
3600 from 'assert', as it is a message from the programmer to the compiler. */
3601 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3603 #else
3604 # define IF_LINT(Code) /* empty */
3605 # define lint_assume(cond) ((void) (0 && (cond)))
3606 #endif
3608 /* The ubiquitous min and max macros. */
3610 #ifdef max
3611 #undef max
3612 #undef min
3613 #endif
3614 #define min(a, b) ((a) < (b) ? (a) : (b))
3615 #define max(a, b) ((a) > (b) ? (a) : (b))
3617 /* We used to use `abs', but that clashes with system headers on some
3618 platforms, and using a name reserved by Standard C is a bad idea
3619 anyway. */
3620 #if !defined(eabs)
3621 #define eabs(x) ((x) < 0 ? -(x) : (x))
3622 #endif
3624 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3625 fixnum. */
3627 #define make_fixnum_or_float(val) \
3628 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3631 /* Checks the `cycle check' variable CHECK to see if it indicates that
3632 EL is part of a cycle; CHECK must be either Qnil or a value returned
3633 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3634 elements after which a cycle might be suspected; after that many
3635 elements, this macro begins consing in order to keep more precise
3636 track of elements.
3638 Returns nil if a cycle was detected, otherwise a new value for CHECK
3639 that includes EL.
3641 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3642 the caller should make sure that's ok. */
3644 #define CYCLE_CHECK(check, el, suspicious) \
3645 (NILP (check) \
3646 ? make_number (0) \
3647 : (INTEGERP (check) \
3648 ? (XFASTINT (check) < (suspicious) \
3649 ? make_number (XFASTINT (check) + 1) \
3650 : Fcons (el, Qnil)) \
3651 : (!NILP (Fmemq ((el), (check))) \
3652 ? Qnil \
3653 : Fcons ((el), (check)))))
3656 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3657 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3659 #define MAX_ALLOCA 16*1024
3661 extern Lisp_Object safe_alloca_unwind (Lisp_Object);
3663 #define USE_SAFE_ALLOCA \
3664 int sa_count = (int) SPECPDL_INDEX (), sa_must_free = 0
3666 /* SAFE_ALLOCA allocates a simple buffer. */
3668 #define SAFE_ALLOCA(buf, type, size) \
3669 do { \
3670 if ((size) < MAX_ALLOCA) \
3671 buf = (type) alloca (size); \
3672 else \
3674 buf = (type) xmalloc (size); \
3675 sa_must_free = 1; \
3676 record_unwind_protect (safe_alloca_unwind, \
3677 make_save_value (buf, 0)); \
3679 } while (0)
3681 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3683 #define SAFE_FREE() \
3684 do { \
3685 if (sa_must_free) { \
3686 sa_must_free = 0; \
3687 unbind_to (sa_count, Qnil); \
3689 } while (0)
3692 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3694 #define SAFE_ALLOCA_LISP(buf, nelt) \
3695 do { \
3696 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3697 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3698 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3700 Lisp_Object arg_; \
3701 buf = (Lisp_Object *) xmalloc ((nelt) * sizeof (Lisp_Object)); \
3702 arg_ = make_save_value (buf, nelt); \
3703 XSAVE_VALUE (arg_)->dogc = 1; \
3704 sa_must_free = 1; \
3705 record_unwind_protect (safe_alloca_unwind, arg_); \
3707 else \
3708 memory_full (SIZE_MAX); \
3709 } while (0)
3712 #include "globals.h"
3714 #endif /* EMACS_LISP_H */