lispref/os.texi edits
[emacs.git] / src / lisp.h
blobbd19da55b2a1492bd0cf4d2891333f85f947e6d7
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 /* The symbol's name, as a Lisp string.
1138 The name "xname" is used to intentionally break code referring to
1139 the old field "name" of type pointer to struct Lisp_String. */
1140 Lisp_Object xname;
1142 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1143 union is used depends on the `redirect' field above. */
1144 union {
1145 Lisp_Object value;
1146 struct Lisp_Symbol *alias;
1147 struct Lisp_Buffer_Local_Value *blv;
1148 union Lisp_Fwd *fwd;
1149 } val;
1151 /* Function value of the symbol or Qunbound if not fboundp. */
1152 Lisp_Object function;
1154 /* The symbol's property list. */
1155 Lisp_Object plist;
1157 /* Next symbol in obarray bucket, if the symbol is interned. */
1158 struct Lisp_Symbol *next;
1161 /* Value is name of symbol. */
1163 #define SYMBOL_VAL(sym) \
1164 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1165 #define SYMBOL_ALIAS(sym) \
1166 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1167 #define SYMBOL_BLV(sym) \
1168 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1169 #define SYMBOL_FWD(sym) \
1170 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1171 #define SET_SYMBOL_VAL(sym, v) \
1172 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1173 #define SET_SYMBOL_ALIAS(sym, v) \
1174 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1175 #define SET_SYMBOL_BLV(sym, v) \
1176 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1177 #define SET_SYMBOL_FWD(sym, v) \
1178 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1180 #define SYMBOL_NAME(sym) \
1181 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1183 /* Value is non-zero if SYM is an interned symbol. */
1185 #define SYMBOL_INTERNED_P(sym) \
1186 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1188 /* Value is non-zero if SYM is interned in initial_obarray. */
1190 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1191 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1193 /* Value is non-zero if symbol is considered a constant, i.e. its
1194 value cannot be changed (there is an exception for keyword symbols,
1195 whose value can be set to the keyword symbol itself). */
1197 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1199 #define DEFSYM(sym, name) \
1200 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1203 /***********************************************************************
1204 Hash Tables
1205 ***********************************************************************/
1207 /* The structure of a Lisp hash table. */
1209 struct Lisp_Hash_Table
1211 /* This is for Lisp; the hash table code does not refer to it. */
1212 struct vectorlike_header header;
1214 /* Function used to compare keys. */
1215 Lisp_Object test;
1217 /* Nil if table is non-weak. Otherwise a symbol describing the
1218 weakness of the table. */
1219 Lisp_Object weak;
1221 /* When the table is resized, and this is an integer, compute the
1222 new size by adding this to the old size. If a float, compute the
1223 new size by multiplying the old size with this factor. */
1224 Lisp_Object rehash_size;
1226 /* Resize hash table when number of entries/ table size is >= this
1227 ratio, a float. */
1228 Lisp_Object rehash_threshold;
1230 /* Vector of hash codes.. If hash[I] is nil, this means that that
1231 entry I is unused. */
1232 Lisp_Object hash;
1234 /* Vector used to chain entries. If entry I is free, next[I] is the
1235 entry number of the next free item. If entry I is non-free,
1236 next[I] is the index of the next entry in the collision chain. */
1237 Lisp_Object next;
1239 /* Index of first free entry in free list. */
1240 Lisp_Object next_free;
1242 /* Bucket vector. A non-nil entry is the index of the first item in
1243 a collision chain. This vector's size can be larger than the
1244 hash table size to reduce collisions. */
1245 Lisp_Object index;
1247 /* User-supplied hash function, or nil. */
1248 Lisp_Object user_hash_function;
1250 /* User-supplied key comparison function, or nil. */
1251 Lisp_Object user_cmp_function;
1253 /* Only the fields above are traced normally by the GC. The ones below
1254 `count' are special and are either ignored by the GC or traced in
1255 a special way (e.g. because of weakness). */
1257 /* Number of key/value entries in the table. */
1258 EMACS_INT count;
1260 /* Vector of keys and values. The key of item I is found at index
1261 2 * I, the value is found at index 2 * I + 1.
1262 This is gc_marked specially if the table is weak. */
1263 Lisp_Object key_and_value;
1265 /* Next weak hash table if this is a weak hash table. The head
1266 of the list is in weak_hash_tables. */
1267 struct Lisp_Hash_Table *next_weak;
1269 /* C function to compare two keys. */
1270 int (*cmpfn) (struct Lisp_Hash_Table *,
1271 Lisp_Object, EMACS_UINT,
1272 Lisp_Object, EMACS_UINT);
1274 /* C function to compute hash code. */
1275 EMACS_UINT (*hashfn) (struct Lisp_Hash_Table *, Lisp_Object);
1279 #define XHASH_TABLE(OBJ) \
1280 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1282 #define XSET_HASH_TABLE(VAR, PTR) \
1283 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1285 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1287 #define CHECK_HASH_TABLE(x) \
1288 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1290 /* Value is the key part of entry IDX in hash table H. */
1292 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1294 /* Value is the value part of entry IDX in hash table H. */
1296 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1298 /* Value is the index of the next entry following the one at IDX
1299 in hash table H. */
1301 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1303 /* Value is the hash code computed for entry IDX in hash table H. */
1305 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1307 /* Value is the index of the element in hash table H that is the
1308 start of the collision list at index IDX in the index vector of H. */
1310 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1312 /* Value is the size of hash table H. */
1314 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1316 /* Default size for hash tables if not specified. */
1318 #define DEFAULT_HASH_SIZE 65
1320 /* Default threshold specifying when to resize a hash table. The
1321 value gives the ratio of current entries in the hash table and the
1322 size of the hash table. */
1324 #define DEFAULT_REHASH_THRESHOLD 0.8
1326 /* Default factor by which to increase the size of a hash table. */
1328 #define DEFAULT_REHASH_SIZE 1.5
1331 /* These structures are used for various misc types. */
1333 struct Lisp_Misc_Any /* Supertype of all Misc types. */
1335 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_??? */
1336 unsigned gcmarkbit : 1;
1337 int spacer : 15;
1338 /* Make it as long as "Lisp_Free without padding". */
1339 void *fill;
1342 struct Lisp_Marker
1344 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Marker */
1345 unsigned gcmarkbit : 1;
1346 int spacer : 13;
1347 /* This flag is temporarily used in the functions
1348 decode/encode_coding_object to record that the marker position
1349 must be adjusted after the conversion. */
1350 unsigned int need_adjustment : 1;
1351 /* 1 means normal insertion at the marker's position
1352 leaves the marker after the inserted text. */
1353 unsigned int insertion_type : 1;
1354 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1355 Note: a chain of markers can contain markers pointing into different
1356 buffers (the chain is per buffer_text rather than per buffer, so it's
1357 shared between indirect buffers). */
1358 /* This is used for (other than NULL-checking):
1359 - Fmarker_buffer
1360 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1361 - unchain_marker: to find the list from which to unchain.
1362 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1364 struct buffer *buffer;
1366 /* The remaining fields are meaningless in a marker that
1367 does not point anywhere. */
1369 /* For markers that point somewhere,
1370 this is used to chain of all the markers in a given buffer. */
1371 /* We could remove it and use an array in buffer_text instead.
1372 That would also allow to preserve it ordered. */
1373 struct Lisp_Marker *next;
1374 /* This is the char position where the marker points. */
1375 EMACS_INT charpos;
1376 /* This is the byte position.
1377 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1378 used to implement the functionality of markers, but rather to (ab)use
1379 markers as a cache for char<->byte mappings). */
1380 EMACS_INT bytepos;
1383 /* Forwarding pointer to an int variable.
1384 This is allowed only in the value cell of a symbol,
1385 and it means that the symbol's value really lives in the
1386 specified int variable. */
1387 struct Lisp_Intfwd
1389 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Int */
1390 EMACS_INT *intvar;
1393 /* Boolean forwarding pointer to an int variable.
1394 This is like Lisp_Intfwd except that the ostensible
1395 "value" of the symbol is t if the int variable is nonzero,
1396 nil if it is zero. */
1397 struct Lisp_Boolfwd
1399 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Bool */
1400 int *boolvar;
1403 /* Forwarding pointer to a Lisp_Object variable.
1404 This is allowed only in the value cell of a symbol,
1405 and it means that the symbol's value really lives in the
1406 specified variable. */
1407 struct Lisp_Objfwd
1409 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Obj */
1410 Lisp_Object *objvar;
1413 /* Like Lisp_Objfwd except that value lives in a slot in the
1414 current buffer. Value is byte index of slot within buffer. */
1415 struct Lisp_Buffer_Objfwd
1417 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Buffer_Obj */
1418 int offset;
1419 Lisp_Object slottype; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1422 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1423 the symbol has buffer-local or frame-local bindings. (Exception:
1424 some buffer-local variables are built-in, with their values stored
1425 in the buffer structure itself. They are handled differently,
1426 using struct Lisp_Buffer_Objfwd.)
1428 The `realvalue' slot holds the variable's current value, or a
1429 forwarding pointer to where that value is kept. This value is the
1430 one that corresponds to the loaded binding. To read or set the
1431 variable, you must first make sure the right binding is loaded;
1432 then you can access the value in (or through) `realvalue'.
1434 `buffer' and `frame' are the buffer and frame for which the loaded
1435 binding was found. If those have changed, to make sure the right
1436 binding is loaded it is necessary to find which binding goes with
1437 the current buffer and selected frame, then load it. To load it,
1438 first unload the previous binding, then copy the value of the new
1439 binding into `realvalue' (or through it). Also update
1440 LOADED-BINDING to point to the newly loaded binding.
1442 `local_if_set' indicates that merely setting the variable creates a
1443 local binding for the current buffer. Otherwise the latter, setting
1444 the variable does not do that; only make-local-variable does that. */
1446 struct Lisp_Buffer_Local_Value
1448 /* 1 means that merely setting the variable creates a local
1449 binding for the current buffer */
1450 unsigned int local_if_set : 1;
1451 /* 1 means this variable can have frame-local bindings, otherwise, it is
1452 can have buffer-local bindings. The two cannot be combined. */
1453 unsigned int frame_local : 1;
1454 /* 1 means that the binding now loaded was found.
1455 Presumably equivalent to (defcell!=valcell) */
1456 unsigned int found : 1;
1457 /* If non-NULL, a forwarding to the C var where it should also be set. */
1458 union Lisp_Fwd *fwd; /* Should never be (Buffer|Kboard)_Objfwd. */
1459 /* The buffer or frame for which the loaded binding was found. */
1460 Lisp_Object where;
1461 /* A cons cell that holds the default value. It has the form
1462 (SYMBOL . DEFAULT-VALUE). */
1463 Lisp_Object defcell;
1464 /* The cons cell from `where's parameter alist.
1465 It always has the form (SYMBOL . VALUE)
1466 Note that if `forward' is non-nil, VALUE may be out of date.
1467 Also if the currently loaded binding is the default binding, then
1468 this is `eq'ual to defcell. */
1469 Lisp_Object valcell;
1472 #define BLV_FOUND(blv) \
1473 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1474 #define SET_BLV_FOUND(blv, v) \
1475 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1477 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1478 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1480 /* START and END are markers in the overlay's buffer, and
1481 PLIST is the overlay's property list. */
1482 struct Lisp_Overlay
1483 /* An overlay's real data content is:
1484 - plist
1485 - buffer
1486 - insertion type of both ends
1487 - start & start_byte
1488 - end & end_byte
1489 - next (singly linked list of overlays).
1490 - start_next and end_next (singly linked list of markers).
1491 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1494 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Overlay */
1495 unsigned gcmarkbit : 1;
1496 int spacer : 15;
1497 struct Lisp_Overlay *next;
1498 Lisp_Object start, end, plist;
1501 /* Like Lisp_Objfwd except that value lives in a slot in the
1502 current kboard. */
1503 struct Lisp_Kboard_Objfwd
1505 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Kboard_Obj */
1506 int offset;
1509 /* Hold a C pointer for later use.
1510 This type of object is used in the arg to record_unwind_protect. */
1511 struct Lisp_Save_Value
1513 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Save_Value */
1514 unsigned gcmarkbit : 1;
1515 int spacer : 14;
1516 /* If DOGC is set, POINTER is the address of a memory
1517 area containing INTEGER potential Lisp_Objects. */
1518 unsigned int dogc : 1;
1519 void *pointer;
1520 ptrdiff_t integer;
1524 /* A miscellaneous object, when it's on the free list. */
1525 struct Lisp_Free
1527 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Free */
1528 unsigned gcmarkbit : 1;
1529 int spacer : 15;
1530 union Lisp_Misc *chain;
1531 #ifdef USE_LSB_TAG
1532 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1533 This assumes that Lisp_Marker is the largest of the alternatives and
1534 that Lisp_Misc_Any has the same size as "Lisp_Free w/o padding". */
1535 char padding[((((sizeof (struct Lisp_Marker) - 1) >> GCTYPEBITS) + 1)
1536 << GCTYPEBITS) - sizeof (struct Lisp_Misc_Any)];
1537 #endif
1540 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1541 It uses one of these struct subtypes to get the type field. */
1543 union Lisp_Misc
1545 struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */
1546 struct Lisp_Free u_free; /* Includes padding to force alignment. */
1547 struct Lisp_Marker u_marker; /* 5 */
1548 struct Lisp_Overlay u_overlay; /* 5 */
1549 struct Lisp_Save_Value u_save_value; /* 3 */
1552 union Lisp_Fwd
1554 struct Lisp_Intfwd u_intfwd; /* 2 */
1555 struct Lisp_Boolfwd u_boolfwd; /* 2 */
1556 struct Lisp_Objfwd u_objfwd; /* 2 */
1557 struct Lisp_Buffer_Objfwd u_buffer_objfwd; /* 2 */
1558 struct Lisp_Kboard_Objfwd u_kboard_objfwd; /* 2 */
1561 /* Lisp floating point type */
1562 struct Lisp_Float
1564 union
1566 #ifdef HIDE_LISP_IMPLEMENTATION
1567 double data_;
1568 #else
1569 double data;
1570 #endif
1571 struct Lisp_Float *chain;
1572 } u;
1575 #ifdef HIDE_LISP_IMPLEMENTATION
1576 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1577 #else
1578 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1579 /* This should be used only in alloc.c, which always disables
1580 HIDE_LISP_IMPLEMENTATION. */
1581 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1582 #endif
1584 /* A character, declared with the following typedef, is a member
1585 of some character set associated with the current buffer. */
1586 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1587 #define _UCHAR_T
1588 typedef unsigned char UCHAR;
1589 #endif
1591 /* Meanings of slots in a Lisp_Compiled: */
1593 #define COMPILED_ARGLIST 0
1594 #define COMPILED_BYTECODE 1
1595 #define COMPILED_CONSTANTS 2
1596 #define COMPILED_STACK_DEPTH 3
1597 #define COMPILED_DOC_STRING 4
1598 #define COMPILED_INTERACTIVE 5
1600 /* Flag bits in a character. These also get used in termhooks.h.
1601 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1602 (MUlti-Lingual Emacs) might need 22 bits for the character value
1603 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1604 #define CHAR_ALT (0x0400000)
1605 #define CHAR_SUPER (0x0800000)
1606 #define CHAR_HYPER (0x1000000)
1607 #define CHAR_SHIFT (0x2000000)
1608 #define CHAR_CTL (0x4000000)
1609 #define CHAR_META (0x8000000)
1611 #define CHAR_MODIFIER_MASK \
1612 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1615 /* Actually, the current Emacs uses 22 bits for the character value
1616 itself. */
1617 #define CHARACTERBITS 22
1620 /* The glyph datatype, used to represent characters on the display.
1621 It consists of a char code and a face id. */
1623 typedef struct {
1624 int ch;
1625 int face_id;
1626 } GLYPH;
1628 /* Return a glyph's character code. */
1629 #define GLYPH_CHAR(glyph) ((glyph).ch)
1631 /* Return a glyph's face ID. */
1632 #define GLYPH_FACE(glyph) ((glyph).face_id)
1634 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1635 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1636 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1638 /* Return 1 if GLYPH contains valid character code. */
1639 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1642 /* Glyph Code from a display vector may either be an integer which
1643 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1644 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1646 #define GLYPH_CODE_CHAR(gc) \
1647 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1649 #define GLYPH_CODE_FACE(gc) \
1650 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1652 /* Return 1 if glyph code from display vector contains valid character code. */
1653 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc))
1655 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1657 /* Only called when GLYPH_CODE_P (gc) is true. */
1658 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1659 do \
1661 if (CONSP (gc)) \
1662 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1663 else \
1664 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1665 (XINT (gc) >> CHARACTERBITS)); \
1667 while (0)
1669 /* The ID of the mode line highlighting face. */
1670 #define GLYPH_MODE_LINE_FACE 1
1672 /* Structure to hold mouse highlight data. This is here because other
1673 header files need it for defining struct x_output etc. */
1674 typedef struct {
1675 /* These variables describe the range of text currently shown in its
1676 mouse-face, together with the window they apply to. As long as
1677 the mouse stays within this range, we need not redraw anything on
1678 its account. Rows and columns are glyph matrix positions in
1679 MOUSE_FACE_WINDOW. */
1680 int mouse_face_beg_row, mouse_face_beg_col;
1681 int mouse_face_beg_x, mouse_face_beg_y;
1682 int mouse_face_end_row, mouse_face_end_col;
1683 int mouse_face_end_x, mouse_face_end_y;
1684 int mouse_face_past_end;
1685 Lisp_Object mouse_face_window;
1686 int mouse_face_face_id;
1687 Lisp_Object mouse_face_overlay;
1689 /* 1 if a mouse motion event came and we didn't handle it right away because
1690 gc was in progress. */
1691 int mouse_face_deferred_gc;
1693 /* FRAME and X, Y position of mouse when last checked for
1694 highlighting. X and Y can be negative or out of range for the frame. */
1695 struct frame *mouse_face_mouse_frame;
1696 int mouse_face_mouse_x, mouse_face_mouse_y;
1698 /* Nonzero means defer mouse-motion highlighting. */
1699 int mouse_face_defer;
1701 /* Nonzero means that the mouse highlight should not be shown. */
1702 int mouse_face_hidden;
1704 int mouse_face_image_state;
1705 } Mouse_HLInfo;
1707 /* Data type checking */
1709 #define NILP(x) EQ (x, Qnil)
1711 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1712 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1714 #define RANGED_INTEGERP(lo, x, hi) \
1715 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1716 #define TYPE_RANGED_INTEGERP(type, x) \
1717 RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type))
1719 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1720 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1721 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1722 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1723 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1724 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1726 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1727 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1728 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1729 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1730 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1732 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1733 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1734 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1735 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1736 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1738 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1739 vectorlike_header * avoids aliasing issues. */
1740 #define PSEUDOVECTORP(x, code) \
1741 TYPED_PSEUDOVECTORP(x, vectorlike_header, code)
1743 /* True if object X, with internal type struct T *, is a pseudovector whose
1744 code is CODE. */
1745 #define TYPED_PSEUDOVECTORP(x, t, code) \
1746 (VECTORLIKEP (x) \
1747 && (((((struct t *) XPNTR (x))->size \
1748 & (PSEUDOVECTOR_FLAG | (code)))) \
1749 == (PSEUDOVECTOR_FLAG | (code))))
1751 /* Test for specific pseudovector types. */
1752 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1753 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1754 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1755 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1756 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1757 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1758 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1759 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1760 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1761 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1762 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1763 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1765 /* Test for image (image . spec) */
1766 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1768 /* Array types. */
1770 #define ARRAYP(x) \
1771 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1773 #define CHECK_LIST(x) \
1774 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1776 #define CHECK_LIST_CONS(x, y) \
1777 CHECK_TYPE (CONSP (x), Qlistp, y)
1779 #define CHECK_LIST_END(x, y) \
1780 CHECK_TYPE (NILP (x), Qlistp, y)
1782 #define CHECK_STRING(x) \
1783 CHECK_TYPE (STRINGP (x), Qstringp, x)
1785 #define CHECK_STRING_CAR(x) \
1786 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1788 #define CHECK_CONS(x) \
1789 CHECK_TYPE (CONSP (x), Qconsp, x)
1791 #define CHECK_SYMBOL(x) \
1792 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1794 #define CHECK_CHAR_TABLE(x) \
1795 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1797 #define CHECK_VECTOR(x) \
1798 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1800 #define CHECK_VECTOR_OR_STRING(x) \
1801 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1803 #define CHECK_ARRAY(x, Qxxxp) \
1804 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1806 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1807 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1809 #define CHECK_BUFFER(x) \
1810 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1812 #define CHECK_WINDOW(x) \
1813 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1815 #define CHECK_WINDOW_CONFIGURATION(x) \
1816 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1818 /* This macro rejects windows on the interior of the window tree as
1819 "dead", which is what we want; this is an argument-checking macro, and
1820 the user should never get access to interior windows.
1822 A window of any sort, leaf or interior, is dead if the buffer,
1823 vchild, and hchild members are all nil. */
1825 #define CHECK_LIVE_WINDOW(x) \
1826 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1828 #define CHECK_PROCESS(x) \
1829 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1831 #define CHECK_SUBR(x) \
1832 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1834 #define CHECK_NUMBER(x) \
1835 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1837 #define CHECK_NATNUM(x) \
1838 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1840 #define CHECK_MARKER(x) \
1841 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1843 #define CHECK_NUMBER_COERCE_MARKER(x) \
1844 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1845 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1847 #define XFLOATINT(n) extract_float((n))
1849 #define CHECK_FLOAT(x) \
1850 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1852 #define CHECK_NUMBER_OR_FLOAT(x) \
1853 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1855 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1856 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1857 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1859 #define CHECK_OVERLAY(x) \
1860 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1862 /* Since we can't assign directly to the CAR or CDR fields of a cons
1863 cell, use these when checking that those fields contain numbers. */
1864 #define CHECK_NUMBER_CAR(x) \
1865 do { \
1866 Lisp_Object tmp = XCAR (x); \
1867 CHECK_NUMBER (tmp); \
1868 XSETCAR ((x), tmp); \
1869 } while (0)
1871 #define CHECK_NUMBER_CDR(x) \
1872 do { \
1873 Lisp_Object tmp = XCDR (x); \
1874 CHECK_NUMBER (tmp); \
1875 XSETCDR ((x), tmp); \
1876 } while (0)
1878 #define CHECK_NATNUM_CAR(x) \
1879 do { \
1880 Lisp_Object tmp = XCAR (x); \
1881 CHECK_NATNUM (tmp); \
1882 XSETCAR ((x), tmp); \
1883 } while (0)
1885 #define CHECK_NATNUM_CDR(x) \
1886 do { \
1887 Lisp_Object tmp = XCDR (x); \
1888 CHECK_NATNUM (tmp); \
1889 XSETCDR ((x), tmp); \
1890 } while (0)
1892 /* Define a built-in function for calling from Lisp.
1893 `lname' should be the name to give the function in Lisp,
1894 as a null-terminated C string.
1895 `fnname' should be the name of the function in C.
1896 By convention, it starts with F.
1897 `sname' should be the name for the C constant structure
1898 that records information on this function for internal use.
1899 By convention, it should be the same as `fnname' but with S instead of F.
1900 It's too bad that C macros can't compute this from `fnname'.
1901 `minargs' should be a number, the minimum number of arguments allowed.
1902 `maxargs' should be a number, the maximum number of arguments allowed,
1903 or else MANY or UNEVALLED.
1904 MANY means pass a vector of evaluated arguments,
1905 in the form of an integer number-of-arguments
1906 followed by the address of a vector of Lisp_Objects
1907 which contains the argument values.
1908 UNEVALLED means pass the list of unevaluated arguments
1909 `intspec' says how interactive arguments are to be fetched.
1910 If the string starts with a `(', `intspec' is evaluated and the resulting
1911 list is the list of arguments.
1912 If it's a string that doesn't start with `(', the value should follow
1913 the one of the doc string for `interactive'.
1914 A null string means call interactively with no arguments.
1915 `doc' is documentation for the user. */
1917 /* This version of DEFUN declares a function prototype with the right
1918 arguments, so we can catch errors with maxargs at compile-time. */
1919 #ifdef _MSC_VER
1920 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1921 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1922 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1923 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1924 { (Lisp_Object (__cdecl *)(void))fnname }, \
1925 minargs, maxargs, lname, intspec, 0}; \
1926 Lisp_Object fnname
1927 #else /* not _MSC_VER */
1928 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1929 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1930 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1931 { PVEC_SUBR, \
1932 { .a ## maxargs = fnname }, \
1933 minargs, maxargs, lname, intspec, 0}; \
1934 Lisp_Object fnname
1935 #endif
1937 /* Note that the weird token-substitution semantics of ANSI C makes
1938 this work for MANY and UNEVALLED. */
1939 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1940 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1941 #define DEFUN_ARGS_0 (void)
1942 #define DEFUN_ARGS_1 (Lisp_Object)
1943 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1944 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1945 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1946 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1947 Lisp_Object)
1948 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1949 Lisp_Object, Lisp_Object)
1950 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1951 Lisp_Object, Lisp_Object, Lisp_Object)
1952 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1953 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1955 /* Non-zero if OBJ is a Lisp function. */
1956 #define FUNCTIONP(OBJ) \
1957 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1958 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1959 || COMPILEDP (OBJ) \
1960 || SUBRP (OBJ))
1962 /* defsubr (Sname);
1963 is how we define the symbol for function `name' at start-up time. */
1964 extern void defsubr (struct Lisp_Subr *);
1966 #define MANY -2
1967 #define UNEVALLED -1
1969 extern void defvar_lisp (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1970 extern void defvar_lisp_nopro (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1971 extern void defvar_bool (struct Lisp_Boolfwd *, const char *, int *);
1972 extern void defvar_int (struct Lisp_Intfwd *, const char *, EMACS_INT *);
1973 extern void defvar_kboard (struct Lisp_Kboard_Objfwd *, const char *, int);
1975 /* Macros we use to define forwarded Lisp variables.
1976 These are used in the syms_of_FILENAME functions.
1978 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1979 lisp variable is actually a field in `struct emacs_globals'. The
1980 field's name begins with "f_", which is a convention enforced by
1981 these macros. Each such global has a corresponding #define in
1982 globals.h; the plain name should be used in the code.
1984 E.g., the global "cons_cells_consed" is declared as "int
1985 f_cons_cells_consed" in globals.h, but there is a define:
1987 #define cons_cells_consed globals.f_cons_cells_consed
1989 All C code uses the `cons_cells_consed' name. This is all done
1990 this way to support indirection for multi-threaded Emacs. */
1992 #define DEFVAR_LISP(lname, vname, doc) \
1993 do { \
1994 static struct Lisp_Objfwd o_fwd; \
1995 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1996 } while (0)
1997 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1998 do { \
1999 static struct Lisp_Objfwd o_fwd; \
2000 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2001 } while (0)
2002 #define DEFVAR_BOOL(lname, vname, doc) \
2003 do { \
2004 static struct Lisp_Boolfwd b_fwd; \
2005 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2006 } while (0)
2007 #define DEFVAR_INT(lname, vname, doc) \
2008 do { \
2009 static struct Lisp_Intfwd i_fwd; \
2010 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2011 } while (0)
2013 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2014 do { \
2015 static struct Lisp_Objfwd o_fwd; \
2016 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2017 } while (0)
2019 #define DEFVAR_KBOARD(lname, vname, doc) \
2020 do { \
2021 static struct Lisp_Kboard_Objfwd ko_fwd; \
2022 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2023 } while (0)
2027 /* Structure for recording Lisp call stack for backtrace purposes. */
2029 /* The special binding stack holds the outer values of variables while
2030 they are bound by a function application or a let form, stores the
2031 code to be executed for Lisp unwind-protect forms, and stores the C
2032 functions to be called for record_unwind_protect.
2034 If func is non-zero, undoing this binding applies func to old_value;
2035 This implements record_unwind_protect.
2037 Otherwise, the element is a variable binding.
2039 If the symbol field is a symbol, it is an ordinary variable binding.
2041 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2042 which means having bound a local value while CURRENT-BUFFER was active.
2043 If WHERE is nil this means we saw the default value when binding SYMBOL.
2044 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2045 value. Other values of WHERE mean an internal error. */
2047 typedef Lisp_Object (*specbinding_func) (Lisp_Object);
2049 struct specbinding
2051 Lisp_Object symbol, old_value;
2052 specbinding_func func;
2053 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
2056 extern struct specbinding *specpdl;
2057 extern struct specbinding *specpdl_ptr;
2058 extern EMACS_INT specpdl_size;
2060 #define SPECPDL_INDEX() ((int) (specpdl_ptr - specpdl))
2062 /* Everything needed to describe an active condition case. */
2063 struct handler
2065 /* The handler clauses and variable from the condition-case form. */
2066 /* For a handler set up in Lisp code, this is always a list.
2067 For an internal handler set up by internal_condition_case*,
2068 this can instead be the symbol t or `error'.
2069 t: handle all conditions.
2070 error: handle all conditions, and errors can run the debugger
2071 or display a backtrace. */
2072 Lisp_Object handler;
2073 Lisp_Object var;
2074 /* Fsignal stores here the condition-case clause that applies,
2075 and Fcondition_case thus knows which clause to run. */
2076 Lisp_Object chosen_clause;
2078 /* Used to effect the longjump out to the handler. */
2079 struct catchtag *tag;
2081 /* The next enclosing handler. */
2082 struct handler *next;
2085 /* This structure helps implement the `catch' and `throw' control
2086 structure. A struct catchtag contains all the information needed
2087 to restore the state of the interpreter after a non-local jump.
2089 Handlers for error conditions (represented by `struct handler'
2090 structures) just point to a catch tag to do the cleanup required
2091 for their jumps.
2093 catchtag structures are chained together in the C calling stack;
2094 the `next' member points to the next outer catchtag.
2096 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2097 member is TAG, and then unbinds to it. The `val' member is used to
2098 hold VAL while the stack is unwound; `val' is returned as the value
2099 of the catch form.
2101 All the other members are concerned with restoring the interpreter
2102 state. */
2104 struct catchtag
2106 Lisp_Object tag;
2107 Lisp_Object val;
2108 struct catchtag *next;
2109 struct gcpro *gcpro;
2110 jmp_buf jmp;
2111 struct backtrace *backlist;
2112 struct handler *handlerlist;
2113 int lisp_eval_depth;
2114 int pdlcount;
2115 int poll_suppress_count;
2116 int interrupt_input_blocked;
2117 struct byte_stack *byte_stack;
2120 extern Lisp_Object memory_signal_data;
2122 /* An address near the bottom of the stack.
2123 Tells GC how to save a copy of the stack. */
2124 extern char *stack_bottom;
2126 /* Check quit-flag and quit if it is non-nil.
2127 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2128 So the program needs to do QUIT at times when it is safe to quit.
2129 Every loop that might run for a long time or might not exit
2130 ought to do QUIT at least once, at a safe place.
2131 Unless that is impossible, of course.
2132 But it is very desirable to avoid creating loops where QUIT is impossible.
2134 Exception: if you set immediate_quit to nonzero,
2135 then the handler that responds to the C-g does the quit itself.
2136 This is a good thing to do around a loop that has no side effects
2137 and (in particular) cannot call arbitrary Lisp code.
2139 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2140 a request to exit Emacs when it is safe to do. */
2142 #ifdef SYNC_INPUT
2143 extern void process_pending_signals (void);
2144 extern int pending_signals;
2145 #define ELSE_PENDING_SIGNALS \
2146 else if (pending_signals) \
2147 process_pending_signals ();
2148 #else /* not SYNC_INPUT */
2149 #define ELSE_PENDING_SIGNALS
2150 #endif /* not SYNC_INPUT */
2152 extern void process_quit_flag (void);
2153 #define QUIT \
2154 do { \
2155 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2156 process_quit_flag (); \
2157 ELSE_PENDING_SIGNALS \
2158 } while (0)
2161 /* Nonzero if ought to quit now. */
2163 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2165 extern Lisp_Object Vascii_downcase_table;
2166 extern Lisp_Object Vascii_canon_table;
2168 /* Number of bytes of structure consed since last GC. */
2170 extern EMACS_INT consing_since_gc;
2172 extern EMACS_INT gc_relative_threshold;
2174 extern EMACS_INT memory_full_cons_threshold;
2176 /* Structure for recording stack slots that need marking. */
2178 /* This is a chain of structures, each of which points at a Lisp_Object
2179 variable whose value should be marked in garbage collection.
2180 Normally every link of the chain is an automatic variable of a function,
2181 and its `val' points to some argument or local variable of the function.
2182 On exit to the function, the chain is set back to the value it had on entry.
2183 This way, no link remains in the chain when the stack frame containing the
2184 link disappears.
2186 Every function that can call Feval must protect in this fashion all
2187 Lisp_Object variables whose contents will be used again. */
2189 extern struct gcpro *gcprolist;
2191 struct gcpro
2193 struct gcpro *next;
2195 /* Address of first protected variable. */
2196 volatile Lisp_Object *var;
2198 /* Number of consecutive protected variables. */
2199 ptrdiff_t nvars;
2201 #ifdef DEBUG_GCPRO
2202 int level;
2203 #endif
2206 /* Values of GC_MARK_STACK during compilation:
2208 0 Use GCPRO as before
2209 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2210 2 Mark the stack, and check that everything GCPRO'd is
2211 marked.
2212 3 Mark using GCPRO's, mark stack last, and count how many
2213 dead objects are kept alive. */
2216 #define GC_USE_GCPROS_AS_BEFORE 0
2217 #define GC_MAKE_GCPROS_NOOPS 1
2218 #define GC_MARK_STACK_CHECK_GCPROS 2
2219 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2221 #ifndef GC_MARK_STACK
2222 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2223 #endif
2225 /* Whether we do the stack marking manually. */
2226 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2227 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2230 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2232 /* Do something silly with gcproN vars just so gcc shuts up. */
2233 /* You get warnings from MIPSPro... */
2235 #define GCPRO1(varname) ((void) gcpro1)
2236 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2237 #define GCPRO3(varname1, varname2, varname3) \
2238 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2239 #define GCPRO4(varname1, varname2, varname3, varname4) \
2240 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2241 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2242 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2243 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2244 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2245 (void) gcpro1)
2246 #define UNGCPRO ((void) 0)
2248 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2250 #ifndef DEBUG_GCPRO
2252 #define GCPRO1(varname) \
2253 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2254 gcprolist = &gcpro1; }
2256 #define GCPRO2(varname1, varname2) \
2257 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2258 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2259 gcprolist = &gcpro2; }
2261 #define GCPRO3(varname1, varname2, varname3) \
2262 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2263 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2264 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2265 gcprolist = &gcpro3; }
2267 #define GCPRO4(varname1, varname2, varname3, varname4) \
2268 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2269 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2270 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2271 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2272 gcprolist = &gcpro4; }
2274 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2275 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2276 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2277 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2278 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2279 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2280 gcprolist = &gcpro5; }
2282 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2283 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2284 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2285 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2286 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2287 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2288 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2289 gcprolist = &gcpro6; }
2291 #define UNGCPRO (gcprolist = gcpro1.next)
2293 #else
2295 extern int gcpro_level;
2297 #define GCPRO1(varname) \
2298 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2299 gcpro1.level = gcpro_level++; \
2300 gcprolist = &gcpro1; }
2302 #define GCPRO2(varname1, varname2) \
2303 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2304 gcpro1.level = gcpro_level; \
2305 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2306 gcpro2.level = gcpro_level++; \
2307 gcprolist = &gcpro2; }
2309 #define GCPRO3(varname1, varname2, varname3) \
2310 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2311 gcpro1.level = gcpro_level; \
2312 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2313 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2314 gcpro3.level = gcpro_level++; \
2315 gcprolist = &gcpro3; }
2317 #define GCPRO4(varname1, varname2, varname3, varname4) \
2318 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2319 gcpro1.level = gcpro_level; \
2320 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2321 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2322 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2323 gcpro4.level = gcpro_level++; \
2324 gcprolist = &gcpro4; }
2326 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2327 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2328 gcpro1.level = gcpro_level; \
2329 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2330 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2331 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2332 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2333 gcpro5.level = gcpro_level++; \
2334 gcprolist = &gcpro5; }
2336 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2337 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2338 gcpro1.level = gcpro_level; \
2339 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2340 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2341 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2342 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2343 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2344 gcpro6.level = gcpro_level++; \
2345 gcprolist = &gcpro6; }
2347 #define UNGCPRO \
2348 ((--gcpro_level != gcpro1.level) \
2349 ? (abort (), 0) \
2350 : ((gcprolist = gcpro1.next), 0))
2352 #endif /* DEBUG_GCPRO */
2353 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2356 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2357 #define RETURN_UNGCPRO(expr) \
2358 do \
2360 Lisp_Object ret_ungc_val; \
2361 ret_ungc_val = (expr); \
2362 UNGCPRO; \
2363 return ret_ungc_val; \
2365 while (0)
2367 /* Call staticpro (&var) to protect static variable `var'. */
2369 void staticpro (Lisp_Object *);
2371 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2372 meaning as in the DEFUN macro, and is used to construct a prototype. */
2373 /* We can use the same trick as in the DEFUN macro to generate the
2374 appropriate prototype. */
2375 #define EXFUN(fnname, maxargs) \
2376 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2378 /* Forward declarations for prototypes. */
2379 struct window;
2380 struct frame;
2382 /* Defined in data.c. */
2383 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qunbound;
2384 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
2385 extern Lisp_Object Qerror, Qquit, Qargs_out_of_range;
2386 extern Lisp_Object Qvoid_variable, Qvoid_function;
2387 extern Lisp_Object Qinvalid_read_syntax;
2388 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
2389 extern Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
2390 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
2391 extern Lisp_Object Qtext_read_only;
2392 extern Lisp_Object Qinteractive_form;
2393 extern Lisp_Object Qcircular_list;
2394 extern Lisp_Object Qintegerp, Qwholenump, Qsymbolp, Qlistp, Qconsp;
2395 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
2396 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
2397 extern Lisp_Object Qbuffer_or_string_p;
2398 extern Lisp_Object Qfboundp;
2399 extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
2401 extern Lisp_Object Qcdr;
2403 extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
2404 extern Lisp_Object Qoverflow_error, Qunderflow_error;
2406 extern Lisp_Object Qfloatp;
2407 extern Lisp_Object Qnumberp, Qnumber_or_marker_p;
2409 extern Lisp_Object Qinteger;
2411 extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
2413 EXFUN (Finteractive_form, 1);
2414 EXFUN (Fbyteorder, 0);
2416 /* Defined in frame.c */
2417 extern Lisp_Object Qframep;
2419 /* Defined in data.c */
2420 EXFUN (Fcar, 1);
2421 EXFUN (Fcar_safe, 1);
2422 EXFUN (Fcdr, 1);
2423 EXFUN (Fcdr_safe, 1);
2424 EXFUN (Fsetcar, 2);
2425 EXFUN (Fsetcdr, 2);
2426 EXFUN (Fboundp, 1);
2427 EXFUN (Ffboundp, 1);
2428 EXFUN (Fsymbol_function, 1);
2429 EXFUN (Fsymbol_name, 1);
2430 extern Lisp_Object indirect_function (Lisp_Object);
2431 EXFUN (Findirect_function, 2);
2432 EXFUN (Ffset, 2);
2433 EXFUN (Fsymbol_value, 1);
2434 extern Lisp_Object find_symbol_value (Lisp_Object);
2435 EXFUN (Fset, 2);
2436 EXFUN (Fdefault_value, 1);
2437 EXFUN (Fset_default, 2);
2438 EXFUN (Fdefault_boundp, 1);
2439 EXFUN (Fmake_local_variable, 1);
2440 EXFUN (Flocal_variable_p, 2);
2442 EXFUN (Faref, 2);
2443 EXFUN (Faset, 3);
2445 EXFUN (Fstring_to_number, 2);
2446 EXFUN (Fnumber_to_string, 1);
2447 EXFUN (Fgtr, 2);
2448 EXFUN (Flss, 2);
2449 EXFUN (Fgeq, 2);
2450 EXFUN (Fleq, 2);
2451 EXFUN (Fzerop, 1);
2452 EXFUN (Fplus, MANY);
2453 EXFUN (Fminus, MANY);
2454 EXFUN (Ftimes, MANY);
2455 EXFUN (Fquo, MANY);
2456 EXFUN (Frem, 2);
2457 EXFUN (Fmax, MANY);
2458 EXFUN (Fmin, MANY);
2460 EXFUN (Fadd1, 1);
2461 EXFUN (Fsub1, 1);
2462 EXFUN (Fmake_variable_buffer_local, 1);
2464 /* Convert the integer I to an Emacs representation, either the integer
2465 itself, or a cons of two or three integers, or if all else fails a float.
2466 I should not have side effects. */
2467 #define INTEGER_TO_CONS(i) \
2468 (! FIXNUM_OVERFLOW_P (i) \
2469 ? make_number (i) \
2470 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2471 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2472 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2473 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2474 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2475 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2476 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2477 ? Fcons (make_number ((i) >> 16 >> 24), \
2478 Fcons (make_number ((i) >> 16 & 0xffffff), \
2479 make_number ((i) & 0xffff))) \
2480 : make_float (i))
2482 /* Convert the Emacs representation CONS back to an integer of type
2483 TYPE, storing the result the variable VAR. Signal an error if CONS
2484 is not a valid representation or is out of range for TYPE. */
2485 #define CONS_TO_INTEGER(cons, type, var) \
2486 (TYPE_SIGNED (type) \
2487 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2488 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2489 extern intmax_t cons_to_signed (Lisp_Object, intmax_t, intmax_t);
2490 extern uintmax_t cons_to_unsigned (Lisp_Object, uintmax_t);
2492 extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *);
2493 extern void args_out_of_range (Lisp_Object, Lisp_Object) NO_RETURN;
2494 extern void args_out_of_range_3 (Lisp_Object, Lisp_Object,
2495 Lisp_Object) NO_RETURN;
2496 extern Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object) NO_RETURN;
2497 extern Lisp_Object do_symval_forwarding (union Lisp_Fwd *);
2498 extern void set_internal (Lisp_Object, Lisp_Object, Lisp_Object, int);
2499 extern void syms_of_data (void);
2500 extern void init_data (void);
2501 extern void swap_in_global_binding (struct Lisp_Symbol *);
2503 /* Defined in cmds.c */
2504 EXFUN (Fend_of_line, 1);
2505 EXFUN (Fforward_char, 1);
2506 EXFUN (Fforward_line, 1);
2507 extern void syms_of_cmds (void);
2508 extern void keys_of_cmds (void);
2510 /* Defined in coding.c */
2511 extern Lisp_Object Qcharset;
2512 EXFUN (Fcoding_system_p, 1);
2513 EXFUN (Fcoding_system_base, 1);
2514 EXFUN (Fcoding_system_eol_type, 1);
2515 EXFUN (Fcheck_coding_system, 1);
2516 EXFUN (Fread_coding_system, 2);
2517 EXFUN (Fread_non_nil_coding_system, 1);
2518 EXFUN (Ffind_operation_coding_system, MANY);
2519 EXFUN (Fdecode_coding_string, 4);
2520 extern Lisp_Object detect_coding_system (const unsigned char *, EMACS_INT,
2521 EMACS_INT, int, int, Lisp_Object);
2522 extern void init_coding (void);
2523 extern void init_coding_once (void);
2524 extern void syms_of_coding (void);
2526 /* Defined in character.c */
2527 EXFUN (Fchar_width, 1);
2528 EXFUN (Fstring, MANY);
2529 extern EMACS_INT chars_in_text (const unsigned char *, EMACS_INT);
2530 extern EMACS_INT multibyte_chars_in_text (const unsigned char *, EMACS_INT);
2531 extern int multibyte_char_to_unibyte (int);
2532 extern int multibyte_char_to_unibyte_safe (int);
2533 extern void init_character_once (void);
2534 extern void syms_of_character (void);
2536 /* Defined in charset.c */
2537 extern void init_charset (void);
2538 extern void init_charset_once (void);
2539 extern void syms_of_charset (void);
2540 /* Structure forward declarations. */
2541 struct charset;
2543 /* Defined in composite.c */
2544 extern void syms_of_composite (void);
2546 /* Defined in syntax.c */
2547 EXFUN (Fforward_word, 1);
2548 EXFUN (Fskip_chars_forward, 2);
2549 EXFUN (Fskip_chars_backward, 2);
2550 extern void init_syntax_once (void);
2551 extern void syms_of_syntax (void);
2553 /* Defined in fns.c */
2554 extern Lisp_Object QCrehash_size, QCrehash_threshold;
2555 enum { NEXT_ALMOST_PRIME_LIMIT = 11 };
2556 extern EMACS_INT next_almost_prime (EMACS_INT);
2557 extern Lisp_Object larger_vector (Lisp_Object, EMACS_INT, Lisp_Object);
2558 extern void sweep_weak_hash_tables (void);
2559 extern Lisp_Object Qcursor_in_echo_area;
2560 extern Lisp_Object Qstring_lessp;
2561 extern Lisp_Object QCsize, QCtest, QCweakness, Qequal, Qeq, Qeql;
2562 EMACS_UINT hash_string (char const *, ptrdiff_t);
2563 EMACS_UINT sxhash (Lisp_Object, int);
2564 Lisp_Object make_hash_table (Lisp_Object, Lisp_Object, Lisp_Object,
2565 Lisp_Object, Lisp_Object, Lisp_Object,
2566 Lisp_Object);
2567 ptrdiff_t hash_lookup (struct Lisp_Hash_Table *, Lisp_Object, EMACS_UINT *);
2568 ptrdiff_t hash_put (struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
2569 EMACS_UINT);
2570 void init_weak_hash_tables (void);
2571 extern void init_fns (void);
2572 EXFUN (Fmake_hash_table, MANY);
2573 EXFUN (Fgethash, 3);
2574 EXFUN (Fputhash, 3);
2575 EXFUN (Fremhash, 2);
2577 EXFUN (Fidentity, 1);
2578 EXFUN (Flength, 1);
2579 EXFUN (Fappend, MANY);
2580 EXFUN (Fconcat, MANY);
2581 EXFUN (Fvconcat, MANY);
2582 EXFUN (Fcopy_sequence, 1);
2583 EXFUN (Fstring_make_multibyte, 1);
2584 EXFUN (Fstring_make_unibyte, 1);
2585 EXFUN (Fstring_as_multibyte, 1);
2586 EXFUN (Fstring_as_unibyte, 1);
2587 EXFUN (Fstring_to_multibyte, 1);
2588 EXFUN (Fsubstring, 3);
2589 extern Lisp_Object substring_both (Lisp_Object, EMACS_INT, EMACS_INT,
2590 EMACS_INT, EMACS_INT);
2591 EXFUN (Fnth, 2);
2592 EXFUN (Fnthcdr, 2);
2593 EXFUN (Fmemq, 2);
2594 EXFUN (Fassq, 2);
2595 EXFUN (Fassoc, 2);
2596 EXFUN (Felt, 2);
2597 EXFUN (Fmember, 2);
2598 EXFUN (Frassq, 2);
2599 EXFUN (Fdelq, 2);
2600 EXFUN (Fdelete, 2);
2601 EXFUN (Fsort, 2);
2602 EXFUN (Freverse, 1);
2603 EXFUN (Fnreverse, 1);
2604 EXFUN (Fget, 2);
2605 EXFUN (Fput, 3);
2606 EXFUN (Fequal, 2);
2607 EXFUN (Fnconc, MANY);
2608 EXFUN (Fmapcar, 2);
2609 EXFUN (Fmapconcat, 3);
2610 extern Lisp_Object do_yes_or_no_p (Lisp_Object);
2611 EXFUN (Fprovide, 2);
2612 extern Lisp_Object concat2 (Lisp_Object, Lisp_Object);
2613 extern Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2614 extern Lisp_Object nconc2 (Lisp_Object, Lisp_Object);
2615 extern Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object);
2616 extern Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object);
2617 extern void clear_string_char_byte_cache (void);
2618 extern EMACS_INT string_char_to_byte (Lisp_Object, EMACS_INT);
2619 extern EMACS_INT string_byte_to_char (Lisp_Object, EMACS_INT);
2620 extern Lisp_Object string_to_multibyte (Lisp_Object);
2621 extern Lisp_Object string_make_unibyte (Lisp_Object);
2622 EXFUN (Fcopy_alist, 1);
2623 EXFUN (Fplist_get, 2);
2624 EXFUN (Fplist_put, 3);
2625 EXFUN (Fplist_member, 2);
2626 EXFUN (Frassoc, 2);
2627 EXFUN (Fstring_equal, 2);
2628 EXFUN (Fcompare_strings, 7);
2629 EXFUN (Fstring_lessp, 2);
2630 extern void syms_of_fns (void);
2632 /* Defined in floatfns.c */
2633 extern double extract_float (Lisp_Object);
2634 EXFUN (Ffloat, 1);
2635 EXFUN (Ftruncate, 2);
2636 extern void init_floatfns (void);
2637 extern void syms_of_floatfns (void);
2638 extern Lisp_Object fmod_float (Lisp_Object x, Lisp_Object y);
2640 /* Defined in fringe.c */
2641 extern void syms_of_fringe (void);
2642 extern void init_fringe (void);
2643 #ifdef HAVE_WINDOW_SYSTEM
2644 extern void mark_fringe_data (void);
2645 extern void init_fringe_once (void);
2646 #endif /* HAVE_WINDOW_SYSTEM */
2648 /* Defined in image.c */
2649 extern Lisp_Object QCascent, QCmargin, QCrelief;
2650 extern Lisp_Object QCconversion;
2651 extern int x_bitmap_mask (struct frame *, ptrdiff_t);
2652 extern void syms_of_image (void);
2653 extern void init_image (void);
2655 /* Defined in insdel.c */
2656 extern Lisp_Object Qinhibit_modification_hooks;
2657 extern void move_gap (EMACS_INT);
2658 extern void move_gap_both (EMACS_INT, EMACS_INT);
2659 extern void buffer_overflow (void) NO_RETURN;
2660 extern void make_gap (EMACS_INT);
2661 extern EMACS_INT copy_text (const unsigned char *, unsigned char *,
2662 EMACS_INT, int, int);
2663 extern int count_combining_before (const unsigned char *,
2664 EMACS_INT, EMACS_INT, EMACS_INT);
2665 extern int count_combining_after (const unsigned char *,
2666 EMACS_INT, EMACS_INT, EMACS_INT);
2667 extern void insert (const char *, EMACS_INT);
2668 extern void insert_and_inherit (const char *, EMACS_INT);
2669 extern void insert_1 (const char *, EMACS_INT, int, int, int);
2670 extern void insert_1_both (const char *, EMACS_INT, EMACS_INT,
2671 int, int, int);
2672 extern void insert_from_gap (EMACS_INT, EMACS_INT);
2673 extern void insert_from_string (Lisp_Object, EMACS_INT, EMACS_INT,
2674 EMACS_INT, EMACS_INT, int);
2675 extern void insert_from_buffer (struct buffer *, EMACS_INT, EMACS_INT, int);
2676 extern void insert_char (int);
2677 extern void insert_string (const char *);
2678 extern void insert_before_markers (const char *, EMACS_INT);
2679 extern void insert_before_markers_and_inherit (const char *, EMACS_INT);
2680 extern void insert_from_string_before_markers (Lisp_Object, EMACS_INT,
2681 EMACS_INT, EMACS_INT,
2682 EMACS_INT, int);
2683 extern void del_range (EMACS_INT, EMACS_INT);
2684 extern Lisp_Object del_range_1 (EMACS_INT, EMACS_INT, int, int);
2685 extern void del_range_byte (EMACS_INT, EMACS_INT, int);
2686 extern void del_range_both (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT, int);
2687 extern Lisp_Object del_range_2 (EMACS_INT, EMACS_INT,
2688 EMACS_INT, EMACS_INT, int);
2689 extern void modify_region (struct buffer *, EMACS_INT, EMACS_INT, int);
2690 extern void prepare_to_modify_buffer (EMACS_INT, EMACS_INT, EMACS_INT *);
2691 extern void signal_after_change (EMACS_INT, EMACS_INT, EMACS_INT);
2692 extern void adjust_after_insert (EMACS_INT, EMACS_INT, EMACS_INT,
2693 EMACS_INT, EMACS_INT);
2694 extern void adjust_markers_for_delete (EMACS_INT, EMACS_INT,
2695 EMACS_INT, EMACS_INT);
2696 extern void replace_range (EMACS_INT, EMACS_INT, Lisp_Object, int, int, int);
2697 extern void replace_range_2 (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
2698 const char *, EMACS_INT, EMACS_INT, int);
2699 extern void syms_of_insdel (void);
2701 /* Defined in dispnew.c */
2702 extern Lisp_Object selected_frame;
2703 extern Lisp_Object Vwindow_system;
2704 EXFUN (Fding, 1);
2705 EXFUN (Fredraw_frame, 1);
2706 EXFUN (Fsleep_for, 2);
2707 EXFUN (Fredisplay, 1);
2708 extern Lisp_Object sit_for (Lisp_Object, int, int);
2709 extern void init_display (void);
2710 extern void syms_of_display (void);
2712 /* Defined in xdisp.c */
2713 extern Lisp_Object Qinhibit_point_motion_hooks;
2714 extern Lisp_Object Qinhibit_redisplay, Qdisplay;
2715 extern Lisp_Object Qmenu_bar_update_hook;
2716 extern Lisp_Object Qwindow_scroll_functions;
2717 extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
2718 extern Lisp_Object Qimage, Qtext, Qboth, Qboth_horiz, Qtext_image_horiz;
2719 extern Lisp_Object Qspace, Qcenter, QCalign_to;
2720 extern Lisp_Object Qbar, Qhbar, Qbox, Qhollow;
2721 extern Lisp_Object Qleft_margin, Qright_margin;
2722 extern Lisp_Object Qglyphless_char;
2723 extern Lisp_Object QCdata, QCfile;
2724 extern Lisp_Object QCmap;
2725 extern Lisp_Object Qrisky_local_variable;
2726 extern struct frame *last_glyphless_glyph_frame;
2727 extern unsigned last_glyphless_glyph_face_id;
2728 extern int last_glyphless_glyph_merged_face_id;
2729 extern int noninteractive_need_newline;
2730 extern Lisp_Object echo_area_buffer[2];
2731 extern void add_to_log (const char *, Lisp_Object, Lisp_Object);
2732 extern void check_message_stack (void);
2733 extern void setup_echo_area_for_printing (int);
2734 extern int push_message (void);
2735 extern Lisp_Object pop_message_unwind (Lisp_Object);
2736 extern Lisp_Object restore_message_unwind (Lisp_Object);
2737 extern void restore_message (void);
2738 extern Lisp_Object current_message (void);
2739 extern void clear_message (int, int);
2740 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2741 extern void message1 (const char *);
2742 extern void message1_nolog (const char *);
2743 extern void message2 (const char *, EMACS_INT, int);
2744 extern void message2_nolog (const char *, EMACS_INT, int);
2745 extern void message3 (Lisp_Object, EMACS_INT, int);
2746 extern void message3_nolog (Lisp_Object, EMACS_INT, int);
2747 extern void message_dolog (const char *, EMACS_INT, int, int);
2748 extern void message_with_string (const char *, Lisp_Object, int);
2749 extern void message_log_maybe_newline (void);
2750 extern void update_echo_area (void);
2751 extern void truncate_echo_area (EMACS_INT);
2752 extern void redisplay (void);
2753 extern void redisplay_preserve_echo_area (int);
2754 extern void prepare_menu_bars (void);
2756 void set_frame_cursor_types (struct frame *, Lisp_Object);
2757 extern void syms_of_xdisp (void);
2758 extern void init_xdisp (void);
2759 extern Lisp_Object safe_eval (Lisp_Object);
2760 extern int pos_visible_p (struct window *, EMACS_INT, int *,
2761 int *, int *, int *, int *, int *);
2763 /* Defined in xsettings.c */
2764 extern void syms_of_xsettings (void);
2766 /* Defined in vm-limit.c. */
2767 extern void memory_warnings (POINTER_TYPE *, void (*warnfun) (const char *));
2769 /* Defined in alloc.c */
2770 extern void check_pure_size (void);
2771 extern void allocate_string_data (struct Lisp_String *, EMACS_INT, EMACS_INT);
2772 extern void reset_malloc_hooks (void);
2773 extern void uninterrupt_malloc (void);
2774 extern void malloc_warning (const char *);
2775 extern void memory_full (size_t) NO_RETURN;
2776 extern void buffer_memory_full (EMACS_INT) NO_RETURN;
2777 extern int survives_gc_p (Lisp_Object);
2778 extern void mark_object (Lisp_Object);
2779 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2780 extern void refill_memory_reserve (void);
2781 #endif
2782 extern const char *pending_malloc_warning;
2783 extern Lisp_Object *stack_base;
2784 EXFUN (Fcons, 2);
2785 extern Lisp_Object list1 (Lisp_Object);
2786 extern Lisp_Object list2 (Lisp_Object, Lisp_Object);
2787 extern Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object);
2788 extern Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2789 extern Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2790 Lisp_Object);
2791 EXFUN (Flist, MANY);
2792 EXFUN (Fmake_list, 2);
2793 extern Lisp_Object allocate_misc (void);
2794 EXFUN (Fmake_vector, 2);
2795 EXFUN (Fvector, MANY);
2796 EXFUN (Fmake_symbol, 1);
2797 EXFUN (Fmake_marker, 0);
2798 extern void string_overflow (void) NO_RETURN;
2799 EXFUN (Fmake_string, 2);
2800 extern Lisp_Object build_string (const char *);
2801 extern Lisp_Object make_string (const char *, EMACS_INT);
2802 extern Lisp_Object make_unibyte_string (const char *, EMACS_INT);
2803 extern Lisp_Object make_multibyte_string (const char *, EMACS_INT, EMACS_INT);
2804 extern Lisp_Object make_event_array (int, Lisp_Object *);
2805 extern Lisp_Object make_uninit_string (EMACS_INT);
2806 extern Lisp_Object make_uninit_multibyte_string (EMACS_INT, EMACS_INT);
2807 extern Lisp_Object make_string_from_bytes (const char *, EMACS_INT, EMACS_INT);
2808 extern Lisp_Object make_specified_string (const char *,
2809 EMACS_INT, EMACS_INT, int);
2810 EXFUN (Fpurecopy, 1);
2811 extern Lisp_Object make_pure_string (const char *, EMACS_INT, EMACS_INT, int);
2812 extern Lisp_Object make_pure_c_string (const char *data);
2813 extern Lisp_Object pure_cons (Lisp_Object, Lisp_Object);
2814 extern Lisp_Object make_pure_vector (EMACS_INT);
2815 EXFUN (Fgarbage_collect, 0);
2816 EXFUN (Fmake_byte_code, MANY);
2817 EXFUN (Fmake_bool_vector, 2);
2818 extern Lisp_Object Qchar_table_extra_slots;
2819 extern struct Lisp_Vector *allocate_vector (EMACS_INT);
2820 extern struct Lisp_Vector *allocate_pseudovector (int memlen, int lisplen, EMACS_INT tag);
2821 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2822 ((typ*) \
2823 allocate_pseudovector \
2824 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2825 extern struct Lisp_Hash_Table *allocate_hash_table (void);
2826 extern struct window *allocate_window (void);
2827 extern struct frame *allocate_frame (void);
2828 extern struct Lisp_Process *allocate_process (void);
2829 extern struct terminal *allocate_terminal (void);
2830 extern int gc_in_progress;
2831 extern int abort_on_gc;
2832 extern Lisp_Object make_float (double);
2833 extern void display_malloc_warning (void);
2834 extern int inhibit_garbage_collection (void);
2835 extern Lisp_Object make_save_value (void *, ptrdiff_t);
2836 extern void free_marker (Lisp_Object);
2837 extern void free_cons (struct Lisp_Cons *);
2838 extern void init_alloc_once (void);
2839 extern void init_alloc (void);
2840 extern void syms_of_alloc (void);
2841 extern struct buffer * allocate_buffer (void);
2842 extern int valid_lisp_object_p (Lisp_Object);
2844 /* Defined in chartab.c */
2845 EXFUN (Fmake_char_table, 2);
2846 EXFUN (Fset_char_table_parent, 2);
2847 EXFUN (Fchar_table_extra_slot, 2);
2848 EXFUN (Fset_char_table_extra_slot, 3);
2849 EXFUN (Fset_char_table_range, 3);
2850 EXFUN (Foptimize_char_table, 2);
2851 extern Lisp_Object copy_char_table (Lisp_Object);
2852 extern Lisp_Object char_table_ref (Lisp_Object, int);
2853 extern Lisp_Object char_table_ref_and_range (Lisp_Object, int,
2854 int *, int *);
2855 extern Lisp_Object char_table_set (Lisp_Object, int, Lisp_Object);
2856 extern Lisp_Object char_table_set_range (Lisp_Object, int, int,
2857 Lisp_Object);
2858 extern int char_table_translate (Lisp_Object, int);
2859 extern void map_char_table (void (*) (Lisp_Object, Lisp_Object,
2860 Lisp_Object),
2861 Lisp_Object, Lisp_Object, Lisp_Object);
2862 extern void map_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object),
2863 Lisp_Object, Lisp_Object,
2864 Lisp_Object, struct charset *,
2865 unsigned, unsigned);
2866 extern Lisp_Object uniprop_table (Lisp_Object);
2867 extern void syms_of_chartab (void);
2869 /* Defined in print.c */
2870 extern Lisp_Object Vprin1_to_string_buffer;
2871 extern void debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
2872 EXFUN (Fprin1, 2);
2873 EXFUN (Fprin1_to_string, 2);
2874 EXFUN (Fterpri, 1);
2875 EXFUN (Fprint, 2);
2876 EXFUN (Ferror_message_string, 1);
2877 extern Lisp_Object Qstandard_output;
2878 extern Lisp_Object Qexternal_debugging_output;
2879 extern void temp_output_buffer_setup (const char *);
2880 extern int print_level;
2881 extern Lisp_Object Qprint_escape_newlines;
2882 extern void write_string (const char *, int);
2883 extern void print_error_message (Lisp_Object, Lisp_Object, const char *,
2884 Lisp_Object);
2885 extern Lisp_Object internal_with_output_to_temp_buffer
2886 (const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object);
2887 #define FLOAT_TO_STRING_BUFSIZE 350
2888 extern void float_to_string (char *, double);
2889 extern void syms_of_print (void);
2891 /* Defined in doprnt.c */
2892 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2893 va_list);
2894 extern ptrdiff_t esprintf (char *, char const *, ...)
2895 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2896 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2897 char const *, ...)
2898 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2899 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2900 char const *, va_list)
2901 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2903 /* Defined in lread.c. */
2904 extern Lisp_Object Qvariable_documentation, Qstandard_input;
2905 extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
2906 EXFUN (Fread, 1);
2907 EXFUN (Fread_from_string, 3);
2908 EXFUN (Fintern, 2);
2909 EXFUN (Fintern_soft, 2);
2910 EXFUN (Funintern, 2);
2911 EXFUN (Fload, 5);
2912 EXFUN (Fget_load_suffixes, 0);
2913 EXFUN (Fread_char, 3);
2914 EXFUN (Fread_event, 3);
2915 extern Lisp_Object check_obarray (Lisp_Object);
2916 extern Lisp_Object intern (const char *);
2917 extern Lisp_Object intern_c_string (const char *);
2918 extern Lisp_Object oblookup (Lisp_Object, const char *, EMACS_INT, EMACS_INT);
2919 #define LOADHIST_ATTACH(x) \
2920 do { \
2921 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2922 } while (0)
2923 extern int openp (Lisp_Object, Lisp_Object, Lisp_Object,
2924 Lisp_Object *, Lisp_Object);
2925 Lisp_Object string_to_number (char const *, int, int);
2926 extern void map_obarray (Lisp_Object, void (*) (Lisp_Object, Lisp_Object),
2927 Lisp_Object);
2928 extern void dir_warning (const char *, Lisp_Object);
2929 extern void close_load_descs (void);
2930 extern void init_obarray (void);
2931 extern void init_lread (void);
2932 extern void syms_of_lread (void);
2934 /* Defined in eval.c. */
2935 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
2936 extern Lisp_Object Qinhibit_quit, Qclosure;
2937 extern Lisp_Object Qand_rest;
2938 extern Lisp_Object Vautoload_queue;
2939 extern Lisp_Object Vsignaling_function;
2940 extern Lisp_Object inhibit_lisp_code;
2941 extern int handling_signal;
2942 #if BYTE_MARK_STACK
2943 extern struct catchtag *catchlist;
2944 extern struct handler *handlerlist;
2945 #endif
2946 /* To run a normal hook, use the appropriate function from the list below.
2947 The calling convention:
2949 if (!NILP (Vrun_hooks))
2950 call1 (Vrun_hooks, Qmy_funny_hook);
2952 should no longer be used. */
2953 extern Lisp_Object Vrun_hooks;
2954 EXFUN (Frun_hooks, MANY);
2955 EXFUN (Frun_hook_with_args, MANY);
2956 EXFUN (Frun_hook_with_args_until_failure, MANY);
2957 extern void run_hook_with_args_2 (Lisp_Object, Lisp_Object, Lisp_Object);
2958 extern Lisp_Object run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args,
2959 Lisp_Object (*funcall)
2960 (ptrdiff_t nargs, Lisp_Object *args));
2961 EXFUN (Fprogn, UNEVALLED);
2962 EXFUN (Finteractive_p, 0);
2963 EXFUN (Fthrow, 2) NO_RETURN;
2964 EXFUN (Fsignal, 2);
2965 extern void xsignal (Lisp_Object, Lisp_Object) NO_RETURN;
2966 extern void xsignal0 (Lisp_Object) NO_RETURN;
2967 extern void xsignal1 (Lisp_Object, Lisp_Object) NO_RETURN;
2968 extern void xsignal2 (Lisp_Object, Lisp_Object, Lisp_Object) NO_RETURN;
2969 extern void xsignal3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object) NO_RETURN;
2970 extern void signal_error (const char *, Lisp_Object) NO_RETURN;
2971 EXFUN (Fcommandp, 2);
2972 EXFUN (Ffunctionp, 1);
2973 EXFUN (Feval, 2);
2974 extern Lisp_Object eval_sub (Lisp_Object form);
2975 EXFUN (Fapply, MANY);
2976 EXFUN (Ffuncall, MANY);
2977 extern Lisp_Object apply1 (Lisp_Object, Lisp_Object);
2978 extern Lisp_Object call0 (Lisp_Object);
2979 extern Lisp_Object call1 (Lisp_Object, Lisp_Object);
2980 extern Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2981 extern Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2982 extern Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2983 extern Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2984 extern Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2985 extern Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2986 EXFUN (Fdo_auto_save, 2);
2987 extern Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object);
2988 extern Lisp_Object internal_lisp_condition_case (Lisp_Object, Lisp_Object, Lisp_Object);
2989 extern Lisp_Object internal_condition_case (Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object));
2990 extern Lisp_Object internal_condition_case_1 (Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
2991 extern Lisp_Object internal_condition_case_2 (Lisp_Object (*) (Lisp_Object, Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
2992 extern Lisp_Object internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object *), ptrdiff_t, Lisp_Object *, Lisp_Object, Lisp_Object (*) (Lisp_Object));
2993 extern void specbind (Lisp_Object, Lisp_Object);
2994 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object), Lisp_Object);
2995 extern Lisp_Object unbind_to (int, Lisp_Object);
2996 extern void error (const char *, ...) NO_RETURN ATTRIBUTE_FORMAT_PRINTF (1, 2);
2997 extern void verror (const char *, va_list)
2998 NO_RETURN ATTRIBUTE_FORMAT_PRINTF (1, 0);
2999 extern void do_autoload (Lisp_Object, Lisp_Object);
3000 extern Lisp_Object un_autoload (Lisp_Object);
3001 extern void init_eval_once (void);
3002 extern Lisp_Object safe_call (ptrdiff_t, Lisp_Object *);
3003 extern Lisp_Object safe_call1 (Lisp_Object, Lisp_Object);
3004 extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object);
3005 extern void init_eval (void);
3006 #if BYTE_MARK_STACK
3007 extern void mark_backtrace (void);
3008 #endif
3009 extern void syms_of_eval (void);
3011 /* Defined in editfns.c */
3012 extern Lisp_Object Qfield;
3013 EXFUN (Fcurrent_message, 0);
3014 EXFUN (Fgoto_char, 1);
3015 EXFUN (Fpoint_max_marker, 0);
3016 EXFUN (Fpoint, 0);
3017 EXFUN (Fpoint_marker, 0);
3018 EXFUN (Fline_beginning_position, 1);
3019 EXFUN (Fline_end_position, 1);
3020 EXFUN (Ffollowing_char, 0);
3021 EXFUN (Fprevious_char, 0);
3022 EXFUN (Fchar_after, 1);
3023 EXFUN (Finsert, MANY);
3024 EXFUN (Finsert_char, 3);
3025 extern void insert1 (Lisp_Object);
3026 EXFUN (Feolp, 0);
3027 EXFUN (Feobp, 0);
3028 EXFUN (Fbolp, 0);
3029 EXFUN (Fbobp, 0);
3030 EXFUN (Fformat, MANY);
3031 EXFUN (Fmessage, MANY);
3032 extern Lisp_Object format2 (const char *, Lisp_Object, Lisp_Object);
3033 EXFUN (Fbuffer_substring, 2);
3034 EXFUN (Fbuffer_string, 0);
3035 extern Lisp_Object save_excursion_save (void);
3036 extern Lisp_Object save_restriction_save (void);
3037 extern Lisp_Object save_excursion_restore (Lisp_Object);
3038 extern Lisp_Object save_restriction_restore (Lisp_Object);
3039 EXFUN (Fchar_to_string, 1);
3040 EXFUN (Fdelete_region, 2);
3041 EXFUN (Fnarrow_to_region, 2);
3042 EXFUN (Fwiden, 0);
3043 EXFUN (Fuser_login_name, 1);
3044 EXFUN (Fsystem_name, 0);
3045 EXFUN (Fcurrent_time, 0);
3046 EXFUN (Fget_internal_run_time, 0);
3047 extern EMACS_INT clip_to_bounds (EMACS_INT, EMACS_INT, EMACS_INT);
3048 extern Lisp_Object make_buffer_string (EMACS_INT, EMACS_INT, int);
3049 extern Lisp_Object make_buffer_string_both (EMACS_INT, EMACS_INT, EMACS_INT,
3050 EMACS_INT, int);
3051 extern void init_editfns (void);
3052 const char *get_system_name (void);
3053 extern void syms_of_editfns (void);
3054 EXFUN (Fconstrain_to_field, 5);
3055 EXFUN (Ffield_end, 3);
3056 extern void set_time_zone_rule (const char *);
3058 /* Defined in buffer.c */
3059 extern int mouse_face_overlay_overlaps (Lisp_Object);
3060 extern void nsberror (Lisp_Object) NO_RETURN;
3061 EXFUN (Fset_buffer_multibyte, 1);
3062 EXFUN (Foverlay_start, 1);
3063 EXFUN (Foverlay_end, 1);
3064 extern void adjust_overlays_for_insert (EMACS_INT, EMACS_INT);
3065 extern void adjust_overlays_for_delete (EMACS_INT, EMACS_INT);
3066 extern void fix_start_end_in_overlays (EMACS_INT, EMACS_INT);
3067 extern void report_overlay_modification (Lisp_Object, Lisp_Object, int,
3068 Lisp_Object, Lisp_Object, Lisp_Object);
3069 extern int overlay_touches_p (EMACS_INT);
3070 extern Lisp_Object Vbuffer_alist;
3071 EXFUN (Fget_buffer, 1);
3072 EXFUN (Fget_buffer_create, 1);
3073 EXFUN (Fgenerate_new_buffer_name, 2);
3074 EXFUN (Fset_buffer, 1);
3075 extern Lisp_Object set_buffer_if_live (Lisp_Object);
3076 EXFUN (Fbarf_if_buffer_read_only, 0);
3077 EXFUN (Fcurrent_buffer, 0);
3078 EXFUN (Fother_buffer, 3);
3079 extern Lisp_Object other_buffer_safely (Lisp_Object);
3080 EXFUN (Foverlay_get, 2);
3081 EXFUN (Fbuffer_modified_p, 1);
3082 EXFUN (Fset_buffer_modified_p, 1);
3083 EXFUN (Fkill_buffer, 1);
3084 EXFUN (Fkill_all_local_variables, 0);
3085 EXFUN (Fbuffer_enable_undo, 1);
3086 EXFUN (Ferase_buffer, 0);
3087 extern Lisp_Object Qpriority, Qwindow, Qbefore_string, Qafter_string;
3088 extern Lisp_Object get_truename_buffer (Lisp_Object);
3089 extern struct buffer *all_buffers;
3090 EXFUN (Fprevious_overlay_change, 1);
3091 EXFUN (Fbuffer_file_name, 1);
3092 extern void init_buffer_once (void);
3093 extern void init_buffer (void);
3094 extern void syms_of_buffer (void);
3095 extern void keys_of_buffer (void);
3097 /* Defined in marker.c */
3099 EXFUN (Fmarker_position, 1);
3100 EXFUN (Fmarker_buffer, 1);
3101 EXFUN (Fcopy_marker, 2);
3102 EXFUN (Fset_marker, 3);
3103 extern EMACS_INT marker_position (Lisp_Object);
3104 extern EMACS_INT marker_byte_position (Lisp_Object);
3105 extern void clear_charpos_cache (struct buffer *);
3106 extern EMACS_INT charpos_to_bytepos (EMACS_INT);
3107 extern EMACS_INT buf_charpos_to_bytepos (struct buffer *, EMACS_INT);
3108 extern EMACS_INT buf_bytepos_to_charpos (struct buffer *, EMACS_INT);
3109 extern void unchain_marker (struct Lisp_Marker *marker);
3110 extern Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object);
3111 extern Lisp_Object set_marker_both (Lisp_Object, Lisp_Object, EMACS_INT, EMACS_INT);
3112 extern Lisp_Object set_marker_restricted_both (Lisp_Object, Lisp_Object,
3113 EMACS_INT, EMACS_INT);
3114 extern void syms_of_marker (void);
3116 /* Defined in fileio.c */
3118 extern Lisp_Object Qfile_error;
3119 extern Lisp_Object Qfile_exists_p;
3120 extern Lisp_Object Qfile_directory_p;
3121 extern Lisp_Object Qinsert_file_contents;
3122 extern Lisp_Object Qfile_name_history;
3123 EXFUN (Ffind_file_name_handler, 2);
3124 EXFUN (Ffile_name_as_directory, 1);
3125 EXFUN (Fexpand_file_name, 2);
3126 EXFUN (Ffile_name_nondirectory, 1);
3127 EXFUN (Fsubstitute_in_file_name, 1);
3128 EXFUN (Ffile_symlink_p, 1);
3129 EXFUN (Fverify_visited_file_modtime, 1);
3130 EXFUN (Ffile_exists_p, 1);
3131 EXFUN (Ffile_name_absolute_p, 1);
3132 EXFUN (Fdirectory_file_name, 1);
3133 EXFUN (Ffile_name_directory, 1);
3134 extern Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object);
3135 EXFUN (Ffile_accessible_directory_p, 1);
3136 EXFUN (Funhandled_file_name_directory, 1);
3137 EXFUN (Ffile_directory_p, 1);
3138 EXFUN (Fwrite_region, 7);
3139 EXFUN (Ffile_readable_p, 1);
3140 EXFUN (Fread_file_name, 6);
3141 extern Lisp_Object close_file_unwind (Lisp_Object);
3142 extern Lisp_Object restore_point_unwind (Lisp_Object);
3143 extern void report_file_error (const char *, Lisp_Object) NO_RETURN;
3144 extern int internal_delete_file (Lisp_Object);
3145 extern void syms_of_fileio (void);
3146 extern Lisp_Object make_temp_name (Lisp_Object, int);
3147 extern Lisp_Object Qdelete_file;
3149 /* Defined in search.c */
3150 extern void shrink_regexp_cache (void);
3151 EXFUN (Fstring_match, 3);
3152 extern void restore_search_regs (void);
3153 EXFUN (Fmatch_data, 3);
3154 EXFUN (Fset_match_data, 2);
3155 EXFUN (Fmatch_beginning, 1);
3156 EXFUN (Fmatch_end, 1);
3157 extern void record_unwind_save_match_data (void);
3158 struct re_registers;
3159 extern struct re_pattern_buffer *compile_pattern (Lisp_Object,
3160 struct re_registers *,
3161 Lisp_Object, int, int);
3162 extern EMACS_INT fast_string_match (Lisp_Object, Lisp_Object);
3163 extern EMACS_INT fast_c_string_match_ignore_case (Lisp_Object, const char *);
3164 extern EMACS_INT fast_string_match_ignore_case (Lisp_Object, Lisp_Object);
3165 extern EMACS_INT fast_looking_at (Lisp_Object, EMACS_INT, EMACS_INT,
3166 EMACS_INT, EMACS_INT, Lisp_Object);
3167 extern EMACS_INT scan_buffer (int, EMACS_INT, EMACS_INT, EMACS_INT,
3168 EMACS_INT *, int);
3169 extern EMACS_INT scan_newline (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
3170 EMACS_INT, int);
3171 extern EMACS_INT find_next_newline (EMACS_INT, int);
3172 extern EMACS_INT find_next_newline_no_quit (EMACS_INT, EMACS_INT);
3173 extern EMACS_INT find_before_next_newline (EMACS_INT, EMACS_INT, EMACS_INT);
3174 extern void syms_of_search (void);
3175 extern void clear_regexp_cache (void);
3177 /* Defined in minibuf.c */
3179 extern Lisp_Object Qcompletion_ignore_case;
3180 extern Lisp_Object Vminibuffer_list;
3181 extern Lisp_Object last_minibuf_string;
3182 EXFUN (Fcompleting_read, 8);
3183 EXFUN (Fread_from_minibuffer, 7);
3184 EXFUN (Fread_variable, 2);
3185 EXFUN (Fread_buffer, 3);
3186 EXFUN (Fread_minibuffer, 2);
3187 EXFUN (Feval_minibuffer, 2);
3188 EXFUN (Fread_string, 5);
3189 EXFUN (Fassoc_string, 3);
3190 extern Lisp_Object get_minibuffer (EMACS_INT);
3191 extern void init_minibuf_once (void);
3192 extern void syms_of_minibuf (void);
3194 /* Defined in callint.c */
3196 extern Lisp_Object Qminus, Qplus;
3197 extern Lisp_Object Qwhen;
3198 extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
3199 EXFUN (Fprefix_numeric_value, 1);
3200 extern void syms_of_callint (void);
3202 /* Defined in casefiddle.c */
3204 extern Lisp_Object Qidentity;
3205 EXFUN (Fdowncase, 1);
3206 EXFUN (Fupcase, 1);
3207 EXFUN (Fupcase_region, 2);
3208 EXFUN (Fupcase_initials, 1);
3209 EXFUN (Fupcase_initials_region, 2);
3210 extern void syms_of_casefiddle (void);
3211 extern void keys_of_casefiddle (void);
3213 /* Defined in casetab.c */
3215 EXFUN (Fset_case_table, 1);
3216 EXFUN (Fset_standard_case_table, 1);
3217 extern void init_casetab_once (void);
3218 extern void syms_of_casetab (void);
3220 /* Defined in keyboard.c */
3222 extern Lisp_Object echo_message_buffer;
3223 extern struct kboard *echo_kboard;
3224 extern void cancel_echoing (void);
3225 extern Lisp_Object Qdisabled, QCfilter;
3226 extern Lisp_Object Qup, Qdown, Qbottom;
3227 extern Lisp_Object Qtop;
3228 extern int input_pending;
3229 EXFUN (Fdiscard_input, 0);
3230 EXFUN (Frecursive_edit, 0);
3231 EXFUN (Ftop_level, 0) NO_RETURN;
3232 extern Lisp_Object menu_bar_items (Lisp_Object);
3233 extern Lisp_Object tool_bar_items (Lisp_Object, int *);
3234 extern void discard_mouse_events (void);
3235 EXFUN (Fevent_convert_list, 1);
3236 EXFUN (Fread_key_sequence, 5);
3237 EXFUN (Fset_input_interrupt_mode, 1);
3238 EXFUN (Fset_input_mode, 4);
3239 extern Lisp_Object pending_funcalls;
3240 extern int detect_input_pending (void);
3241 extern int detect_input_pending_ignore_squeezables (void);
3242 extern int detect_input_pending_run_timers (int);
3243 extern void safe_run_hooks (Lisp_Object);
3244 extern void cmd_error_internal (Lisp_Object, const char *);
3245 extern Lisp_Object command_loop_1 (void);
3246 extern Lisp_Object recursive_edit_1 (void);
3247 extern void record_auto_save (void);
3248 #ifdef SIGDANGER
3249 extern void force_auto_save_soon (void);
3250 #endif
3251 extern void init_keyboard (void);
3252 extern void syms_of_keyboard (void);
3253 extern void keys_of_keyboard (void);
3255 /* Defined in indent.c */
3256 EXFUN (Fvertical_motion, 2);
3257 EXFUN (Findent_to, 2);
3258 EXFUN (Fmove_to_column, 2);
3259 extern EMACS_INT current_column (void);
3260 extern void invalidate_current_column (void);
3261 extern int indented_beyond_p (EMACS_INT, EMACS_INT, EMACS_INT);
3262 extern void syms_of_indent (void);
3264 /* Defined in frame.c */
3265 #ifdef HAVE_WINDOW_SYSTEM
3266 #endif /* HAVE_WINDOW_SYSTEM */
3267 extern Lisp_Object Qonly;
3268 extern Lisp_Object Qvisible;
3269 extern void store_frame_param (struct frame *, Lisp_Object, Lisp_Object);
3270 extern void store_in_alist (Lisp_Object *, Lisp_Object, Lisp_Object);
3271 extern Lisp_Object do_switch_frame (Lisp_Object, int, int, Lisp_Object);
3272 #if HAVE_NS
3273 extern Lisp_Object get_frame_param (struct frame *, Lisp_Object);
3274 #endif
3275 extern Lisp_Object frame_buffer_predicate (Lisp_Object);
3276 EXFUN (Fselect_frame, 2);
3277 EXFUN (Fselected_frame, 0);
3278 EXFUN (Fmake_frame_visible, 1);
3279 EXFUN (Ficonify_frame, 1);
3280 EXFUN (Fframe_parameter, 2);
3281 EXFUN (Fmodify_frame_parameters, 2);
3282 EXFUN (Fraise_frame, 1);
3283 EXFUN (Fredirect_frame_focus, 2);
3284 extern void frames_discard_buffer (Lisp_Object);
3285 extern void syms_of_frame (void);
3287 /* Defined in emacs.c */
3288 extern char **initial_argv;
3289 extern int initial_argc;
3290 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3291 extern int display_arg;
3292 #endif
3293 extern Lisp_Object decode_env_path (const char *, const char *);
3294 extern Lisp_Object empty_unibyte_string, empty_multibyte_string;
3295 extern Lisp_Object Qfile_name_handler_alist;
3296 #ifdef FLOAT_CATCH_SIGILL
3297 extern void fatal_error_signal (int);
3298 #endif
3299 extern Lisp_Object Qkill_emacs;
3300 EXFUN (Fkill_emacs, 1) NO_RETURN;
3301 #if HAVE_SETLOCALE
3302 void fixup_locale (void);
3303 void synchronize_system_messages_locale (void);
3304 void synchronize_system_time_locale (void);
3305 #else
3306 #define setlocale(category, locale)
3307 #define fixup_locale()
3308 #define synchronize_system_messages_locale()
3309 #define synchronize_system_time_locale()
3310 #endif
3311 void shut_down_emacs (int, int, Lisp_Object);
3312 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3313 extern int noninteractive;
3315 /* Nonzero means remove site-lisp directories from load-path. */
3316 extern int no_site_lisp;
3318 /* Pipe used to send exit notification to the daemon parent at
3319 startup. */
3320 extern int daemon_pipe[2];
3321 #define IS_DAEMON (daemon_pipe[1] != 0)
3323 /* Nonzero means don't do use window-system-specific display code. */
3324 extern int inhibit_window_system;
3325 /* Nonzero means that a filter or a sentinel is running. */
3326 extern int running_asynch_code;
3328 /* Defined in process.c. */
3329 extern Lisp_Object QCtype, Qlocal;
3330 EXFUN (Fget_buffer_process, 1);
3331 EXFUN (Fprocess_status, 1);
3332 EXFUN (Fkill_process, 2);
3333 EXFUN (Fwaiting_for_user_input_p, 0);
3334 extern Lisp_Object Qprocessp;
3335 extern void kill_buffer_processes (Lisp_Object);
3336 extern int wait_reading_process_output (int, int, int, int,
3337 Lisp_Object,
3338 struct Lisp_Process *,
3339 int);
3340 extern void add_keyboard_wait_descriptor (int);
3341 extern void delete_keyboard_wait_descriptor (int);
3342 #ifdef HAVE_GPM
3343 extern void add_gpm_wait_descriptor (int);
3344 extern void delete_gpm_wait_descriptor (int);
3345 #endif
3346 extern void close_process_descs (void);
3347 extern void init_process (void);
3348 extern void syms_of_process (void);
3349 extern void setup_process_coding_systems (Lisp_Object);
3351 EXFUN (Fcall_process, MANY);
3352 extern int child_setup (int, int, int, char **, int, Lisp_Object)
3353 #ifndef DOS_NT
3354 NO_RETURN
3355 #endif
3357 extern void init_callproc_1 (void);
3358 extern void init_callproc (void);
3359 extern void set_initial_environment (void);
3360 extern void syms_of_callproc (void);
3362 /* Defined in doc.c */
3363 extern Lisp_Object Qfunction_documentation;
3364 EXFUN (Fsubstitute_command_keys, 1);
3365 extern Lisp_Object read_doc_string (Lisp_Object);
3366 extern Lisp_Object get_doc_string (Lisp_Object, int, int);
3367 extern void syms_of_doc (void);
3368 extern int read_bytecode_char (int);
3370 /* Defined in bytecode.c */
3371 extern Lisp_Object Qbytecode;
3372 extern void syms_of_bytecode (void);
3373 extern struct byte_stack *byte_stack_list;
3374 #if BYTE_MARK_STACK
3375 extern void mark_byte_stack (void);
3376 #endif
3377 extern void unmark_byte_stack (void);
3378 extern Lisp_Object exec_byte_code (Lisp_Object, Lisp_Object, Lisp_Object,
3379 Lisp_Object, ptrdiff_t, Lisp_Object *);
3381 /* Defined in macros.c */
3382 extern Lisp_Object Qexecute_kbd_macro;
3383 EXFUN (Fexecute_kbd_macro, 3);
3384 EXFUN (Fcancel_kbd_macro_events, 0);
3385 extern void init_macros (void);
3386 extern void syms_of_macros (void);
3388 /* Defined in undo.c */
3389 extern Lisp_Object Qapply;
3390 extern Lisp_Object Qinhibit_read_only;
3391 EXFUN (Fundo_boundary, 0);
3392 extern void truncate_undo_list (struct buffer *);
3393 extern void record_marker_adjustment (Lisp_Object, EMACS_INT);
3394 extern void record_insert (EMACS_INT, EMACS_INT);
3395 extern void record_delete (EMACS_INT, Lisp_Object);
3396 extern void record_first_change (void);
3397 extern void record_change (EMACS_INT, EMACS_INT);
3398 extern void record_property_change (EMACS_INT, EMACS_INT,
3399 Lisp_Object, Lisp_Object,
3400 Lisp_Object);
3401 extern void syms_of_undo (void);
3402 /* Defined in textprop.c */
3403 extern Lisp_Object Qfont, Qmouse_face;
3404 extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
3405 extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
3406 extern Lisp_Object Qminibuffer_prompt;
3408 EXFUN (Fnext_single_property_change, 4);
3409 EXFUN (Fnext_single_char_property_change, 4);
3410 EXFUN (Fprevious_single_property_change, 4);
3411 EXFUN (Fget_text_property, 3);
3412 EXFUN (Fput_text_property, 5);
3413 EXFUN (Fprevious_char_property_change, 2);
3414 EXFUN (Fnext_char_property_change, 2);
3415 extern void report_interval_modification (Lisp_Object, Lisp_Object);
3417 /* Defined in menu.c */
3418 extern void syms_of_menu (void);
3420 /* Defined in xmenu.c */
3421 EXFUN (Fx_popup_menu, 2);
3422 EXFUN (Fx_popup_dialog, 3);
3423 extern void syms_of_xmenu (void);
3425 /* Defined in termchar.h */
3426 struct tty_display_info;
3428 /* Defined in termhooks.h */
3429 struct terminal;
3431 /* Defined in sysdep.c */
3432 #ifndef HAVE_GET_CURRENT_DIR_NAME
3433 extern char *get_current_dir_name (void);
3434 #endif
3435 extern void stuff_char (char c);
3436 extern void init_sigio (int);
3437 extern void sys_subshell (void);
3438 extern void sys_suspend (void);
3439 extern void discard_tty_input (void);
3440 extern void init_sys_modes (struct tty_display_info *);
3441 extern void reset_sys_modes (struct tty_display_info *);
3442 extern void init_all_sys_modes (void);
3443 extern void reset_all_sys_modes (void);
3444 extern void wait_for_termination (int);
3445 extern void interruptible_wait_for_termination (int);
3446 extern void flush_pending_output (int);
3447 extern void child_setup_tty (int);
3448 extern void setup_pty (int);
3449 extern int set_window_size (int, int, int);
3450 extern EMACS_INT get_random (void);
3451 extern void seed_random (long);
3452 extern int emacs_open (const char *, int, int);
3453 extern int emacs_close (int);
3454 extern EMACS_INT emacs_read (int, char *, EMACS_INT);
3455 extern EMACS_INT emacs_write (int, const char *, EMACS_INT);
3456 enum { READLINK_BUFSIZE = 1024 };
3457 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE]);
3459 EXFUN (Funlock_buffer, 0);
3460 extern void unlock_all_files (void);
3461 extern void lock_file (Lisp_Object);
3462 extern void unlock_file (Lisp_Object);
3463 extern void unlock_buffer (struct buffer *);
3464 extern void syms_of_filelock (void);
3465 extern void init_filelock (void);
3467 /* Defined in sound.c */
3468 extern void syms_of_sound (void);
3469 extern void init_sound (void);
3471 /* Defined in category.c */
3472 extern void init_category_once (void);
3473 extern Lisp_Object char_category_set (int);
3474 extern void syms_of_category (void);
3476 /* Defined in ccl.c */
3477 extern void syms_of_ccl (void);
3479 /* Defined in dired.c */
3480 extern void syms_of_dired (void);
3481 extern Lisp_Object directory_files_internal (Lisp_Object, Lisp_Object,
3482 Lisp_Object, Lisp_Object,
3483 int, Lisp_Object);
3485 /* Defined in term.c */
3486 extern int *char_ins_del_vector;
3487 extern void mark_ttys (void);
3488 extern void syms_of_term (void);
3489 extern void fatal (const char *msgid, ...)
3490 NO_RETURN ATTRIBUTE_FORMAT_PRINTF (1, 2);
3492 /* Defined in terminal.c */
3493 EXFUN (Fframe_terminal, 1);
3494 EXFUN (Fdelete_terminal, 2);
3495 extern void syms_of_terminal (void);
3497 /* Defined in font.c */
3498 extern void syms_of_font (void);
3499 extern void init_font (void);
3501 #ifdef HAVE_WINDOW_SYSTEM
3502 /* Defined in fontset.c */
3503 extern void syms_of_fontset (void);
3505 /* Defined in xfns.c, w32fns.c, or macfns.c */
3506 extern Lisp_Object Qfont_param;
3507 EXFUN (Fxw_display_color_p, 1);
3508 EXFUN (Fx_focus_frame, 1);
3509 #endif
3511 /* Defined in xfaces.c */
3512 extern Lisp_Object Qdefault, Qtool_bar, Qfringe;
3513 extern Lisp_Object Qheader_line, Qscroll_bar, Qcursor;
3514 extern Lisp_Object Qmode_line_inactive;
3515 extern Lisp_Object Qface;
3516 extern Lisp_Object Qnormal;
3517 extern Lisp_Object QCfamily, QCweight, QCslant;
3518 extern Lisp_Object QCheight, QCname, QCwidth, QCforeground, QCbackground;
3519 extern Lisp_Object Vface_alternative_font_family_alist;
3520 extern Lisp_Object Vface_alternative_font_registry_alist;
3521 EXFUN (Fclear_face_cache, 1);
3522 EXFUN (Fx_load_color_file, 1);
3523 extern void syms_of_xfaces (void);
3525 #ifdef HAVE_X_WINDOWS
3526 /* Defined in xfns.c */
3527 extern void syms_of_xfns (void);
3529 /* Defined in xsmfns.c */
3530 extern void syms_of_xsmfns (void);
3532 /* Defined in xselect.c */
3533 extern void syms_of_xselect (void);
3535 /* Defined in xterm.c */
3536 extern void syms_of_xterm (void);
3537 #endif /* HAVE_X_WINDOWS */
3539 #ifdef HAVE_WINDOW_SYSTEM
3540 /* Defined in xterm.c, nsterm.m, w32term.c */
3541 extern char *x_get_keysym_name (int);
3542 #endif /* HAVE_WINDOW_SYSTEM */
3544 #ifdef MSDOS
3545 /* Defined in msdos.c */
3546 EXFUN (Fmsdos_downcase_filename, 1);
3547 #endif
3549 #ifdef HAVE_LIBXML2
3550 /* Defined in xml.c */
3551 extern void syms_of_xml (void);
3552 #endif
3554 #ifdef HAVE_MENUS
3555 /* Defined in (x|w32)fns.c, nsfns.m... */
3556 extern int have_menus_p (void);
3557 #endif
3559 #ifdef HAVE_DBUS
3560 /* Defined in dbusbind.c */
3561 void syms_of_dbusbind (void);
3562 #endif
3564 #ifdef DOS_NT
3565 /* Defined in msdos.c, w32.c */
3566 extern char *emacs_root_dir (void);
3567 #endif /* DOS_NT */
3569 /* Nonzero means Emacs has already been initialized.
3570 Used during startup to detect startup of dumped Emacs. */
3571 extern int initialized;
3573 extern int immediate_quit; /* Nonzero means ^G can quit instantly */
3575 extern POINTER_TYPE *xmalloc (size_t);
3576 extern POINTER_TYPE *xrealloc (POINTER_TYPE *, size_t);
3577 extern void xfree (POINTER_TYPE *);
3578 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3579 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3580 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3582 extern char *xstrdup (const char *);
3584 extern char *egetenv (const char *);
3586 /* Set up the name of the machine we're running on. */
3587 extern void init_system_name (void);
3589 /* Some systems (e.g., NT) use a different path separator than Unix,
3590 in addition to a device separator. Set the path separator
3591 to '/', and don't test for a device separator in IS_ANY_SEP. */
3593 #define DIRECTORY_SEP '/'
3594 #ifndef IS_DIRECTORY_SEP
3595 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3596 #endif
3597 #ifndef IS_DEVICE_SEP
3598 #ifndef DEVICE_SEP
3599 #define IS_DEVICE_SEP(_c_) 0
3600 #else
3601 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3602 #endif
3603 #endif
3604 #ifndef IS_ANY_SEP
3605 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3606 #endif
3608 #define SWITCH_ENUM_CAST(x) (x)
3610 /* Use this to suppress gcc's warnings. */
3611 #ifdef lint
3613 /* Use CODE only if lint checking is in effect. */
3614 # define IF_LINT(Code) Code
3616 /* Assume that the expression COND is true. This differs in intent
3617 from 'assert', as it is a message from the programmer to the compiler. */
3618 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3620 #else
3621 # define IF_LINT(Code) /* empty */
3622 # define lint_assume(cond) ((void) (0 && (cond)))
3623 #endif
3625 /* The ubiquitous min and max macros. */
3627 #ifdef max
3628 #undef max
3629 #undef min
3630 #endif
3631 #define min(a, b) ((a) < (b) ? (a) : (b))
3632 #define max(a, b) ((a) > (b) ? (a) : (b))
3634 /* We used to use `abs', but that clashes with system headers on some
3635 platforms, and using a name reserved by Standard C is a bad idea
3636 anyway. */
3637 #if !defined (eabs)
3638 #define eabs(x) ((x) < 0 ? -(x) : (x))
3639 #endif
3641 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3642 fixnum. */
3644 #define make_fixnum_or_float(val) \
3645 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3648 /* Checks the `cycle check' variable CHECK to see if it indicates that
3649 EL is part of a cycle; CHECK must be either Qnil or a value returned
3650 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3651 elements after which a cycle might be suspected; after that many
3652 elements, this macro begins consing in order to keep more precise
3653 track of elements.
3655 Returns nil if a cycle was detected, otherwise a new value for CHECK
3656 that includes EL.
3658 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3659 the caller should make sure that's ok. */
3661 #define CYCLE_CHECK(check, el, suspicious) \
3662 (NILP (check) \
3663 ? make_number (0) \
3664 : (INTEGERP (check) \
3665 ? (XFASTINT (check) < (suspicious) \
3666 ? make_number (XFASTINT (check) + 1) \
3667 : Fcons (el, Qnil)) \
3668 : (!NILP (Fmemq ((el), (check))) \
3669 ? Qnil \
3670 : Fcons ((el), (check)))))
3673 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3674 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3676 #define MAX_ALLOCA 16*1024
3678 extern Lisp_Object safe_alloca_unwind (Lisp_Object);
3680 #define USE_SAFE_ALLOCA \
3681 int sa_count = (int) SPECPDL_INDEX (), sa_must_free = 0
3683 /* SAFE_ALLOCA allocates a simple buffer. */
3685 #define SAFE_ALLOCA(buf, type, size) \
3686 do { \
3687 if ((size) < MAX_ALLOCA) \
3688 buf = (type) alloca (size); \
3689 else \
3691 buf = (type) xmalloc (size); \
3692 sa_must_free = 1; \
3693 record_unwind_protect (safe_alloca_unwind, \
3694 make_save_value (buf, 0)); \
3696 } while (0)
3698 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3699 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3700 positive. The code is tuned for MULTIPLIER being a constant. */
3702 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3703 do { \
3704 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3705 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3706 else \
3708 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3709 sa_must_free = 1; \
3710 record_unwind_protect (safe_alloca_unwind, \
3711 make_save_value (buf, 0)); \
3713 } while (0)
3715 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3717 #define SAFE_FREE() \
3718 do { \
3719 if (sa_must_free) { \
3720 sa_must_free = 0; \
3721 unbind_to (sa_count, Qnil); \
3723 } while (0)
3726 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3728 #define SAFE_ALLOCA_LISP(buf, nelt) \
3729 do { \
3730 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3731 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3732 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3734 Lisp_Object arg_; \
3735 buf = (Lisp_Object *) xmalloc ((nelt) * sizeof (Lisp_Object)); \
3736 arg_ = make_save_value (buf, nelt); \
3737 XSAVE_VALUE (arg_)->dogc = 1; \
3738 sa_must_free = 1; \
3739 record_unwind_protect (safe_alloca_unwind, arg_); \
3741 else \
3742 memory_full (SIZE_MAX); \
3743 } while (0)
3746 #include "globals.h"
3748 #endif /* EMACS_LISP_H */