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