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