* files.el (directory-files-no-dot-files-regexp): Doc fix (bug#6298).
[emacs.git] / src / lisp.h
blobe17931ca366bb077229347e9abc55fcae7eb7856
1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #ifndef EMACS_LISP_H
22 #define EMACS_LISP_H
24 /* Declare the prototype for a general external function. */
25 #define P_(proto) proto
27 /* Use the configure flag --enable-checking[=LIST] to enable various
28 types of run time checks for Lisp objects. */
30 #ifdef GC_CHECK_CONS_LIST
31 #define CHECK_CONS_LIST() check_cons_list()
32 #else
33 #define CHECK_CONS_LIST() ((void)0)
34 #endif
36 /* These are default choices for the types to use. */
37 #ifdef _LP64
38 #ifndef EMACS_INT
39 #define EMACS_INT long
40 #define BITS_PER_EMACS_INT BITS_PER_LONG
41 #endif
42 #ifndef EMACS_UINT
43 #define EMACS_UINT unsigned long
44 #endif
45 #else /* not _LP64 */
46 #ifndef EMACS_INT
47 #define EMACS_INT int
48 #define BITS_PER_EMACS_INT BITS_PER_INT
49 #endif
50 #ifndef EMACS_UINT
51 #define EMACS_UINT unsigned int
52 #endif
53 #endif
55 /* Extra internal type checking? */
56 extern int suppress_checking;
57 extern void die P_((const char *, const char *, int)) NO_RETURN;
59 #ifdef ENABLE_CHECKING
61 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
62 it to 1 using a debugger to temporarily disable aborting on
63 detected internal inconsistencies or error conditions.
65 Testing suppress_checking after the supplied condition ensures that
66 the side effects produced by CHECK will be consistent, independent
67 of whether ENABLE_CHECKING is defined, or whether the checks are
68 suppressed at run time.
70 In some cases, a good compiler may be able to optimize away the
71 CHECK macro altogether, e.g., if XSTRING (x) uses CHECK to test
72 STRINGP (x), but a particular use of XSTRING is invoked only after
73 testing that STRINGP (x) is true, making the test redundant. */
75 #define CHECK(check,msg) (((check) || suppress_checking \
76 ? (void) 0 \
77 : die ((msg), __FILE__, __LINE__)), \
79 #else
81 /* Produce same side effects and result, but don't complain. */
82 #define CHECK(check,msg) ((check),0)
84 #endif
86 /* Define an Emacs version of "assert", since some system ones are
87 flaky. */
88 #ifndef ENABLE_CHECKING
89 #define eassert(X) (void) 0
90 #else /* ENABLE_CHECKING */
91 #if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
92 #define eassert(cond) CHECK(cond,"assertion failed: " #cond)
93 #else
94 #define eassert(cond) CHECK(cond,"assertion failed")
95 #endif
96 #endif /* ENABLE_CHECKING */
98 /* Define this to make Lisp_Object use a union type instead of the
99 default int. FIXME: It might be better to add a flag to configure
100 to do this. */
101 /* #define USE_LISP_UNION_TYPE */
103 /***** Select the tagging scheme. *****/
104 /* There are basically two options that control the tagging scheme:
105 - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
106 of an integer.
107 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
108 always 0, and we can thus use them to hold tag bits, without
109 restricting our addressing space.
111 If USE_LSB_TAG is not set, then we use the top 3 bits for tagging, thus
112 restricting our possible address range. Currently USE_LSB_TAG is not
113 allowed together with a union. This is not due to any fundamental
114 technical (or political ;-) problem: nobody wrote the code to do it yet.
116 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
117 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
118 on the few static Lisp_Objects used: all the defsubr as well
119 as the two special buffers buffer_defaults and buffer_local_symbols. */
121 /* First, try and define DECL_ALIGN(type,var) which declares a static
122 variable VAR of type TYPE with the added requirement that it be
123 TYPEBITS-aligned. */
124 #ifndef NO_DECL_ALIGN
125 # ifndef DECL_ALIGN
126 /* What compiler directive should we use for non-gcc compilers? -stef */
127 # if defined (__GNUC__)
128 # define DECL_ALIGN(type, var) \
129 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
130 # endif
131 # endif
132 #endif
134 /* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8. */
135 #if defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ || defined DARWIN_OS
136 /* We also need to be able to specify mult-of-8 alignment on static vars. */
137 # if defined DECL_ALIGN
138 # define USE_LSB_TAG
139 # endif
140 #endif
142 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
143 #ifndef DECL_ALIGN
144 # ifdef USE_LSB_TAG
145 # error "USE_LSB_TAG used without defining DECL_ALIGN"
146 # endif
147 # define DECL_ALIGN(type, var) type var
148 #endif
151 /* Define the fundamental Lisp data structures. */
153 /* If USE_2_TAGBITS_FOR_INTS is defined, then Lisp integers use
154 2 tags, to give them one extra bit, thus extending their range from
155 e.g -2^28..2^28-1 to -2^29..2^29-1. */
156 #define USE_2_TAGS_FOR_INTS
158 /* Making it work for the union case is too much trouble. */
159 #ifdef USE_LISP_UNION_TYPE
160 # undef USE_2_TAGS_FOR_INTS
161 #endif
163 /* This is the set of Lisp data types. */
165 #if !defined USE_2_TAGS_FOR_INTS
166 # define LISP_INT_TAG Lisp_Int
167 # define case_Lisp_Int case Lisp_Int
168 # define LISP_STRING_TAG 4
169 # define LISP_INT_TAG_P(x) ((x) == Lisp_Int)
170 #else
171 # define LISP_INT_TAG Lisp_Int0
172 # define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
173 # ifdef USE_LSB_TAG
174 # define LISP_INT1_TAG 4
175 # define LISP_STRING_TAG 1
176 # define LISP_INT_TAG_P(x) (((x) & 3) == 0)
177 # else
178 # define LISP_INT1_TAG 1
179 # define LISP_STRING_TAG 4
180 # define LISP_INT_TAG_P(x) (((x) & 6) == 0)
181 # endif
182 #endif
184 enum Lisp_Type
186 /* Integer. XINT (obj) is the integer value. */
187 #ifdef USE_2_TAGS_FOR_INTS
188 Lisp_Int0 = 0,
189 Lisp_Int1 = LISP_INT1_TAG,
190 #else
191 Lisp_Int = 0,
192 #endif
194 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
195 Lisp_Symbol = 2,
197 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
198 whose first member indicates the subtype. */
199 Lisp_Misc = 3,
201 /* String. XSTRING (object) points to a struct Lisp_String.
202 The length of the string, and its contents, are stored therein. */
203 Lisp_String = LISP_STRING_TAG,
205 /* Vector of Lisp objects, or something resembling it.
206 XVECTOR (object) points to a struct Lisp_Vector, which contains
207 the size and contents. The size field also contains the type
208 information, if it's not a real vector object. */
209 Lisp_Vectorlike = 5,
211 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
212 Lisp_Cons = 6,
214 Lisp_Float = 7,
217 /* This is the set of data types that share a common structure.
218 The first member of the structure is a type code from this set.
219 The enum values are arbitrary, but we'll use large numbers to make it
220 more likely that we'll spot the error if a random word in memory is
221 mistakenly interpreted as a Lisp_Misc. */
222 enum Lisp_Misc_Type
224 Lisp_Misc_Free = 0x5eab,
225 Lisp_Misc_Marker,
226 Lisp_Misc_Overlay,
227 Lisp_Misc_Save_Value,
228 /* Currently floats are not a misc type,
229 but let's define this in case we want to change that. */
230 Lisp_Misc_Float,
231 /* This is not a type code. It is for range checking. */
232 Lisp_Misc_Limit
235 /* These are the types of forwarding objects used in the value slot
236 of symbols for special built-in variables whose value is stored in
237 C variables. */
238 enum Lisp_Fwd_Type
240 Lisp_Fwd_Int, /* Fwd to a C `int' variable. */
241 Lisp_Fwd_Bool, /* Fwd to a C boolean var. */
242 Lisp_Fwd_Obj, /* Fwd to a C Lisp_Object variable. */
243 Lisp_Fwd_Buffer_Obj, /* Fwd to a Lisp_Object field of buffers. */
244 Lisp_Fwd_Kboard_Obj, /* Fwd to a Lisp_Object field of kboards. */
247 #ifndef GCTYPEBITS
248 #define GCTYPEBITS 3
249 #endif
251 /* These values are overridden by the m- file on some machines. */
252 #ifndef VALBITS
253 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
254 #endif
256 #ifdef USE_LISP_UNION_TYPE
258 #ifndef WORDS_BIG_ENDIAN
260 /* Definition of Lisp_Object for little-endian machines. */
262 typedef
263 union Lisp_Object
265 /* Used for comparing two Lisp_Objects;
266 also, positive integers can be accessed fast this way. */
267 EMACS_UINT i;
269 struct
271 EMACS_INT val : VALBITS;
272 enum Lisp_Type type : GCTYPEBITS;
273 } s;
274 struct
276 EMACS_UINT val : VALBITS;
277 enum Lisp_Type type : GCTYPEBITS;
278 } u;
280 Lisp_Object;
282 #else /* If WORDS_BIG_ENDIAN */
284 typedef
285 union Lisp_Object
287 /* Used for comparing two Lisp_Objects;
288 also, positive integers can be accessed fast this way. */
289 EMACS_UINT i;
291 struct
293 enum Lisp_Type type : GCTYPEBITS;
294 EMACS_INT val : VALBITS;
295 } s;
296 struct
298 enum Lisp_Type type : GCTYPEBITS;
299 EMACS_UINT val : VALBITS;
300 } u;
302 Lisp_Object;
304 #endif /* WORDS_BIG_ENDIAN */
306 #ifdef __GNUC__
307 static __inline__ Lisp_Object
308 LISP_MAKE_RVALUE (Lisp_Object o)
310 return o;
312 #else
313 /* This is more portable to pre-C99 non-GCC compilers, but for
314 backwards compatibility GCC still accepts an old GNU extension
315 which caused this to only generate a warning. */
316 #define LISP_MAKE_RVALUE(o) (0 ? (o) : (o))
317 #endif
319 #else /* USE_LISP_UNION_TYPE */
321 /* If union type is not wanted, define Lisp_Object as just a number. */
323 typedef EMACS_INT Lisp_Object;
324 #define LISP_MAKE_RVALUE(o) (0+(o))
325 #endif /* USE_LISP_UNION_TYPE */
327 /* In the size word of a vector, this bit means the vector has been marked. */
329 #define ARRAY_MARK_FLAG ((EMACS_UINT) 1 << (BITS_PER_EMACS_INT - 1))
331 /* In the size word of a struct Lisp_Vector, this bit means it's really
332 some other vector-like object. */
333 #define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1))
335 /* In a pseudovector, the size field actually contains a word with one
336 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
337 indicate the actual type.
338 We use a bitset, even tho only one of the bits can be set at any
339 particular time just so as to be able to use micro-optimizations such as
340 testing membership of a particular subset of pseudovectors in Fequal.
341 It is not crucial, but there are plenty of bits here, so why not do it? */
342 enum pvec_type
344 PVEC_NORMAL_VECTOR = 0,
345 PVEC_PROCESS = 0x200,
346 PVEC_FRAME = 0x400,
347 PVEC_COMPILED = 0x800,
348 PVEC_WINDOW = 0x1000,
349 PVEC_WINDOW_CONFIGURATION = 0x2000,
350 PVEC_SUBR = 0x4000,
351 PVEC_CHAR_TABLE = 0x8000,
352 PVEC_BOOL_VECTOR = 0x10000,
353 PVEC_BUFFER = 0x20000,
354 PVEC_HASH_TABLE = 0x40000,
355 PVEC_TERMINAL = 0x80000,
356 PVEC_SUB_CHAR_TABLE = 0x100000,
357 PVEC_FONT = 0x200000,
358 PVEC_OTHER = 0x400000,
359 PVEC_TYPE_MASK = 0x7ffe00
361 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
362 GDB. It doesn't work on OS Alpha. Moved to a variable in
363 emacs.c. */
364 PVEC_FLAG = PSEUDOVECTOR_FLAG
365 #endif
368 /* For convenience, we also store the number of elements in these bits.
369 Note that this size is not necessarily the memory-footprint size, but
370 only the number of Lisp_Object fields (that need to be traced by the GC).
371 The distinction is used e.g. by Lisp_Process which places extra
372 non-Lisp_Object fields at the end of the structure. */
373 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
375 /* Number of bits to put in each character in the internal representation
376 of bool vectors. This should not vary across implementations. */
377 #define BOOL_VECTOR_BITS_PER_CHAR 8
379 /* These macros extract various sorts of values from a Lisp_Object.
380 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
381 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
383 #ifndef USE_LISP_UNION_TYPE
385 /* Return a perfect hash of the Lisp_Object representation. */
386 #define XHASH(a) (a)
388 #ifdef USE_LSB_TAG
390 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
391 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) & TYPEMASK))
392 #ifdef USE_2_TAGS_FOR_INTS
393 # define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
394 # define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
395 # define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
396 #else
397 # define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
398 # define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
399 # define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
400 #endif
401 #define XSET(var, type, ptr) \
402 (eassert (XTYPE (ptr) == 0), /* Check alignment. */ \
403 (var) = ((EMACS_INT) (type)) | ((EMACS_INT) (ptr)))
405 #define XPNTR(a) ((EMACS_INT) ((a) & ~TYPEMASK))
407 #else /* not USE_LSB_TAG */
409 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
411 /* One need to override this if there must be high bits set in data space
412 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
413 on all machines, but would penalize machines which don't need it)
415 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
417 /* For integers known to be positive, XFASTINT provides fast retrieval
418 and XSETFASTINT provides fast storage. This takes advantage of the
419 fact that Lisp_Int is 0. */
420 #define XFASTINT(a) ((a) + 0)
421 #define XSETFASTINT(a, b) ((a) = (b))
423 /* Extract the value of a Lisp_Object as a (un)signed integer. */
425 #ifdef USE_2_TAGS_FOR_INTS
426 # define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
427 # define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
428 # define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
429 #else
430 # define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
431 >> (BITS_PER_EMACS_INT - VALBITS))
432 # define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
433 # define make_number(N) \
434 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
435 #endif
437 #define XSET(var, type, ptr) \
438 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
440 #define XPNTR(a) ((EMACS_UINT) ((a) & VALMASK))
442 #endif /* not USE_LSB_TAG */
444 #else /* USE_LISP_UNION_TYPE */
446 #ifdef USE_2_TAGS_FOR_INTS
447 # error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
448 #endif
450 #define XHASH(a) ((a).i)
452 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
454 #ifdef EXPLICIT_SIGN_EXTEND
455 /* Make sure we sign-extend; compilers have been known to fail to do so.
456 We additionally cast to EMACS_INT since it seems that some compilers
457 have been known to fail to do so, even though the bitfield is declared
458 as EMACS_INT already. */
459 #define XINT(a) ((((EMACS_INT) (a).s.val) << (BITS_PER_EMACS_INT - VALBITS)) \
460 >> (BITS_PER_EMACS_INT - VALBITS))
461 #else
462 #define XINT(a) ((a).s.val)
463 #endif /* EXPLICIT_SIGN_EXTEND */
465 #define XUINT(a) ((a).u.val)
467 #ifdef USE_LSB_TAG
469 # define XSET(var, vartype, ptr) \
470 (eassert ((((EMACS_UINT) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0), \
471 (var).u.val = ((EMACS_UINT) (ptr)) >> GCTYPEBITS, \
472 (var).u.type = ((char) (vartype)))
474 /* Some versions of gcc seem to consider the bitfield width when issuing
475 the "cast to pointer from integer of different size" warning, so the
476 cast is here to widen the value back to its natural size. */
477 # define XPNTR(v) ((EMACS_INT)((v).s.val) << GCTYPEBITS)
479 #else /* !USE_LSB_TAG */
481 /* For integers known to be positive, XFASTINT provides fast retrieval
482 and XSETFASTINT provides fast storage. This takes advantage of the
483 fact that Lisp_Int is 0. */
484 # define XFASTINT(a) ((a).i + 0)
485 # define XSETFASTINT(a, b) ((a).i = (b))
487 # define XSET(var, vartype, ptr) \
488 (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
490 #endif /* !USE_LSB_TAG */
492 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
493 #define make_number(N) \
494 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
495 #else
496 extern Lisp_Object make_number P_ ((EMACS_INT));
497 #endif
499 #endif /* USE_LISP_UNION_TYPE */
501 /* For integers known to be positive, XFASTINT sometimes provides
502 faster retrieval and XSETFASTINT provides faster storage.
503 If not, fallback on the non-accelerated path. */
504 #ifndef XFASTINT
505 # define XFASTINT(a) (XINT (a))
506 # define XSETFASTINT(a, b) (XSETINT (a, b))
507 #endif
509 #define EQ(x, y) (XHASH (x) == XHASH (y))
511 #ifndef XPNTR
512 #ifdef HAVE_SHM
513 /* In this representation, data is found in two widely separated segments. */
514 extern size_t pure_size;
515 #define XPNTR(a) \
516 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
517 #else /* not HAVE_SHM */
518 #ifdef DATA_SEG_BITS
519 /* This case is used for the rt-pc.
520 In the diffs I was given, it checked for ptr = 0
521 and did not adjust it in that case.
522 But I don't think that zero should ever be found
523 in a Lisp object whose data type says it points to something. */
524 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
525 #else
526 /* Some versions of gcc seem to consider the bitfield width when
527 issuing the "cast to pointer from integer of different size"
528 warning, so the cast is here to widen the value back to its natural
529 size. */
530 #define XPNTR(a) ((EMACS_INT) XUINT (a))
531 #endif
532 #endif /* not HAVE_SHM */
533 #endif /* no XPNTR */
535 /* Largest and smallest representable fixnum values. These are the C
536 values. */
538 #ifdef USE_2_TAGS_FOR_INTS
539 # define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << VALBITS)
540 # define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << VALBITS) - 1)
541 /* Mask indicating the significant bits of a Lisp_Int.
542 I.e. (x & INTMASK) == XUINT (make_number (x)). */
543 # define INTMASK ((((EMACS_INT) 1) << (VALBITS + 1)) - 1)
544 #else
545 # define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << (VALBITS - 1))
546 # define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << (VALBITS - 1)) - 1)
547 /* Mask indicating the significant bits of a Lisp_Int.
548 I.e. (x & INTMASK) == XUINT (make_number (x)). */
549 # define INTMASK ((((EMACS_INT) 1) << VALBITS) - 1)
550 #endif
552 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
553 written this way so that it also works if I is of unsigned
554 type. */
556 #define FIXNUM_OVERFLOW_P(i) \
557 ((i) > MOST_POSITIVE_FIXNUM \
558 || ((i) < 0 && (i) < MOST_NEGATIVE_FIXNUM))
560 /* Extract a value or address from a Lisp_Object. */
562 #define XCONS(a) (eassert (CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
563 #define XVECTOR(a) (eassert (VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
564 #define XSTRING(a) (eassert (STRINGP(a)),(struct Lisp_String *) XPNTR(a))
565 #define XSYMBOL(a) (eassert (SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
566 #define XFLOAT(a) (eassert (FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
568 /* Misc types. */
570 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
571 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC(a)->u_any))
572 #define XMISCTYPE(a) (XMISCANY (a)->type)
573 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC(a)->u_marker))
574 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
575 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
577 /* Forwarding object types. */
579 #define XFWDTYPE(a) (a->u_intfwd.type)
580 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
581 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
582 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
583 #define XBUFFER_OBJFWD(a) \
584 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
585 #define XKBOARD_OBJFWD(a) \
586 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
588 /* Pseudovector types. */
590 #define XPROCESS(a) (eassert (PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
591 #define XWINDOW(a) (eassert (WINDOWP(a)),(struct window *) XPNTR(a))
592 #define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
593 #define XSUBR(a) (eassert (SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
594 #define XBUFFER(a) (eassert (BUFFERP(a)),(struct buffer *) XPNTR(a))
595 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
596 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR(a))
597 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
599 /* Construct a Lisp_Object from a value or address. */
601 #define XSETINT(a, b) (a) = make_number (b)
602 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
603 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
604 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
605 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
606 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
608 /* Misc types. */
610 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
611 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
613 /* Pseudovector types. */
615 #define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
616 #define XSETPSEUDOVECTOR(a, b, code) \
617 (XSETVECTOR (a, b), \
618 eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
619 == (PSEUDOVECTOR_FLAG | (code))))
620 #define XSETWINDOW_CONFIGURATION(a, b) \
621 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
622 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
623 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
624 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
625 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
626 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
627 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
628 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
629 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
630 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
632 /* Convenience macros for dealing with Lisp arrays. */
634 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
635 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->size
636 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
637 #define ASET(ARRAY, IDX, VAL) \
638 (eassert ((IDX) == (IDX)), \
639 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
640 AREF ((ARRAY), (IDX)) = (VAL))
642 /* Convenience macros for dealing with Lisp strings. */
644 #define SDATA(string) (XSTRING (string)->data + 0)
645 #define SREF(string, index) (SDATA (string)[index] + 0)
646 #define SSET(string, index, new) (SDATA (string)[index] = (new))
647 #define SCHARS(string) (XSTRING (string)->size + 0)
648 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
650 #define STRING_SET_CHARS(string, newsize) \
651 (XSTRING (string)->size = (newsize))
653 #define STRING_COPYIN(string, index, new, count) \
654 bcopy (new, SDATA (string) + index, count)
656 /* Type checking. */
658 #define CHECK_TYPE(ok, Qxxxp, x) \
659 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
663 /* See the macros in intervals.h. */
665 typedef struct interval *INTERVAL;
667 /* Complain if object is not string or buffer type */
668 #define CHECK_STRING_OR_BUFFER(x) \
669 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
672 /* In a cons, the markbit of the car is the gc mark bit */
674 struct Lisp_Cons
676 /* Please do not use the names of these elements in code other
677 than the core lisp implementation. Use XCAR and XCDR below. */
678 #ifdef HIDE_LISP_IMPLEMENTATION
679 Lisp_Object car_;
680 union
682 Lisp_Object cdr_;
683 struct Lisp_Cons *chain;
684 } u;
685 #else
686 Lisp_Object car;
687 union
689 Lisp_Object cdr;
690 struct Lisp_Cons *chain;
691 } u;
692 #endif
695 /* Take the car or cdr of something known to be a cons cell. */
696 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
697 of code that has to know what a cons cell looks like. Other code not
698 part of the basic lisp implementation should assume that the car and cdr
699 fields are not accessible as lvalues. (What if we want to switch to
700 a copying collector someday? Cached cons cell field addresses may be
701 invalidated at arbitrary points.) */
702 #ifdef HIDE_LISP_IMPLEMENTATION
703 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
704 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
705 #else
706 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
707 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
708 #endif
710 /* Use these from normal code. */
711 #define XCAR(c) LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
712 #define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))
714 /* Use these to set the fields of a cons cell.
716 Note that both arguments may refer to the same object, so 'n'
717 should not be read after 'c' is first modified. Also, neither
718 argument should be evaluated more than once; side effects are
719 especially common in the second argument. */
720 #define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
721 #define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))
723 /* Take the car or cdr of something whose type is not known. */
724 #define CAR(c) \
725 (CONSP ((c)) ? XCAR ((c)) \
726 : NILP ((c)) ? Qnil \
727 : wrong_type_argument (Qlistp, (c)))
729 #define CDR(c) \
730 (CONSP ((c)) ? XCDR ((c)) \
731 : NILP ((c)) ? Qnil \
732 : wrong_type_argument (Qlistp, (c)))
734 /* Take the car or cdr of something whose type is not known. */
735 #define CAR_SAFE(c) \
736 (CONSP ((c)) ? XCAR ((c)) : Qnil)
738 #define CDR_SAFE(c) \
739 (CONSP ((c)) ? XCDR ((c)) : Qnil)
741 /* Nonzero if STR is a multibyte string. */
742 #define STRING_MULTIBYTE(STR) \
743 (XSTRING (STR)->size_byte >= 0)
745 /* Return the length in bytes of STR. */
747 #ifdef GC_CHECK_STRING_BYTES
749 struct Lisp_String;
750 extern int string_bytes P_ ((struct Lisp_String *));
751 #define STRING_BYTES(S) string_bytes ((S))
753 #else /* not GC_CHECK_STRING_BYTES */
755 #define STRING_BYTES(STR) \
756 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
758 #endif /* not GC_CHECK_STRING_BYTES */
760 /* Mark STR as a unibyte string. */
761 #define STRING_SET_UNIBYTE(STR) \
762 do { if (EQ (STR, empty_multibyte_string)) \
763 (STR) = empty_unibyte_string; \
764 else XSTRING (STR)->size_byte = -1; } while (0)
766 /* Mark STR as a multibyte string. Assure that STR contains only
767 ASCII characters in advance. */
768 #define STRING_SET_MULTIBYTE(STR) \
769 do { if (EQ (STR, empty_unibyte_string)) \
770 (STR) = empty_multibyte_string; \
771 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
773 /* Get text properties. */
774 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
776 /* Set text properties. */
777 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
779 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
781 struct Lisp_String
783 EMACS_INT size;
784 EMACS_INT size_byte;
785 INTERVAL intervals; /* text properties in this string */
786 unsigned char *data;
789 #ifdef offsetof
790 #define OFFSETOF(type,field) offsetof(type,field)
791 #else
792 #define OFFSETOF(type,field) \
793 ((int)((char*)&((type*)0)->field - (char*)0))
794 #endif
796 struct Lisp_Vector
798 EMACS_UINT size;
799 struct Lisp_Vector *next;
800 Lisp_Object contents[1];
803 /* If a struct is made to look like a vector, this macro returns the length
804 of the shortest vector that would hold that struct. */
805 #define VECSIZE(type) ((sizeof (type) \
806 - OFFSETOF (struct Lisp_Vector, contents[0]) \
807 + sizeof(Lisp_Object) - 1) /* round up */ \
808 / sizeof (Lisp_Object))
810 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
811 at the end and we need to compute the number of Lisp_Object fields (the
812 ones that the GC needs to trace). */
813 #define PSEUDOVECSIZE(type, nonlispfield) \
814 ((OFFSETOF(type, nonlispfield) - OFFSETOF(struct Lisp_Vector, contents[0])) \
815 / sizeof (Lisp_Object))
817 /* A char-table is a kind of vectorlike, with contents are like a
818 vector but with a few other slots. For some purposes, it makes
819 sense to handle a char-table with type struct Lisp_Vector. An
820 element of a char table can be any Lisp objects, but if it is a sub
821 char-table, we treat it a table that contains information of a
822 specific range of characters. A sub char-table has the same
823 structure as a vector. A sub char table appears only in an element
824 of a char-table, and there's no way to access it directly from
825 Emacs Lisp program. */
827 /* This is the number of slots that every char table must have. This
828 counts the ordinary slots and the top, defalt, parent, and purpose
829 slots. */
830 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
832 /* Return the number of "extra" slots in the char table CT. */
834 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
835 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
837 #ifdef __GNUC__
839 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
840 ({struct Lisp_Char_Table *_tbl = NULL; \
841 Lisp_Object _val; \
842 do { \
843 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
844 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
845 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
846 if (NILP (_val)) \
847 _val = _tbl->defalt; \
848 } while (NILP (_val) && ! NILP (_tbl->parent)); \
849 _val; })
851 #else /* not __GNUC__ */
853 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
854 (! NILP (XCHAR_TABLE (CT)->ascii) \
855 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
856 ? XCHAR_TABLE (CT)->ascii \
857 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
858 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
859 : char_table_ref ((CT), (IDX))) \
860 : char_table_ref ((CT), (IDX)))
862 #endif /* not __GNUC__ */
864 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
865 characters. Do not check validity of CT. */
866 #define CHAR_TABLE_REF(CT, IDX) \
867 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
868 : char_table_ref ((CT), (IDX)))
870 /* Almost equivalent to Faref (CT, IDX). However, if the result is
871 not a character, return IDX.
873 For these characters, do not check validity of CT
874 and do not follow parent. */
875 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
876 char_table_translate (CT, IDX)
878 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
879 8-bit European characters. Do not check validity of CT. */
880 #define CHAR_TABLE_SET(CT, IDX, VAL) \
881 (((IDX) >= 0 && ASCII_CHAR_P (IDX) \
882 && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)) \
883 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
884 : char_table_set (CT, IDX, VAL))
886 #define CHARTAB_SIZE_BITS_0 6
887 #define CHARTAB_SIZE_BITS_1 4
888 #define CHARTAB_SIZE_BITS_2 5
889 #define CHARTAB_SIZE_BITS_3 7
891 extern const int chartab_size[4];
893 struct Lisp_Sub_Char_Table;
895 struct Lisp_Char_Table
897 /* This is the vector's size field, which also holds the
898 pseudovector type information. It holds the size, too.
899 The size counts the defalt, parent, purpose, ascii,
900 contents, and extras slots. */
901 EMACS_UINT size;
902 struct Lisp_Vector *next;
904 /* This holds a default value,
905 which is used whenever the value for a specific character is nil. */
906 Lisp_Object defalt;
908 /* This points to another char table, which we inherit from when the
909 value for a specific character is nil. The `defalt' slot takes
910 precedence over this. */
911 Lisp_Object parent;
913 /* This is a symbol which says what kind of use this char-table is
914 meant for. */
915 Lisp_Object purpose;
917 /* The bottom sub char-table for characters of the range 0..127. It
918 is nil if none of ASCII character has a specific value. */
919 Lisp_Object ascii;
921 Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)];
923 /* These hold additional data. It is a vector. */
924 Lisp_Object extras[1];
927 struct Lisp_Sub_Char_Table
929 /* This is the vector's size field, which also holds the
930 pseudovector type information. It holds the size, too. */
931 EMACS_INT size;
932 struct Lisp_Vector *next;
934 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
935 char-table of depth 1 contains 16 elments, and each element
936 covers 4096 (128*32) characters. A sub char-table of depth 2
937 contains 32 elements, and each element covers 128 characters. A
938 sub char-table of depth 3 contains 128 elements, and each element
939 is for one character. */
940 Lisp_Object depth;
942 /* Minimum character covered by the sub char-table. */
943 Lisp_Object min_char;
945 Lisp_Object contents[1];
948 /* A boolvector is a kind of vectorlike, with contents are like a string. */
949 struct Lisp_Bool_Vector
951 /* This is the vector's size field. It doesn't have the real size,
952 just the subtype information. */
953 EMACS_UINT vector_size;
954 struct Lisp_Vector *next;
955 /* This is the size in bits. */
956 EMACS_UINT size;
957 /* This contains the actual bits, packed into bytes. */
958 unsigned char data[1];
961 /* This structure describes a built-in function.
962 It is generated by the DEFUN macro only.
963 defsubr makes it into a Lisp object.
965 This type is treated in most respects as a pseudovector,
966 but since we never dynamically allocate or free them,
967 we don't need a next-vector field. */
969 struct Lisp_Subr
971 EMACS_UINT size;
972 Lisp_Object (*function) ();
973 short min_args, max_args;
974 const char *symbol_name;
975 char *intspec;
976 char *doc;
980 /***********************************************************************
981 Symbols
982 ***********************************************************************/
984 /* Interned state of a symbol. */
986 enum symbol_interned
988 SYMBOL_UNINTERNED = 0,
989 SYMBOL_INTERNED = 1,
990 SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
993 enum symbol_redirect
995 SYMBOL_PLAINVAL = 4,
996 SYMBOL_VARALIAS = 1,
997 SYMBOL_LOCALIZED = 2,
998 SYMBOL_FORWARDED = 3
1001 /* In a symbol, the markbit of the plist is used as the gc mark bit */
1003 struct Lisp_Symbol
1005 unsigned gcmarkbit : 1;
1007 /* Indicates where the value can be found:
1008 0 : it's a plain var, the value is in the `value' field.
1009 1 : it's a varalias, the value is really in the `alias' symbol.
1010 2 : it's a localized var, the value is in the `blv' object.
1011 3 : it's a forwarding variable, the value is in `forward'.
1013 enum symbol_redirect redirect : 3;
1015 /* Non-zero means symbol is constant, i.e. changing its value
1016 should signal an error. If the value is 3, then the var
1017 can be changed, but only by `defconst'. */
1018 unsigned constant : 2;
1020 /* Interned state of the symbol. This is an enumerator from
1021 enum symbol_interned. */
1022 unsigned interned : 2;
1024 /* The symbol's name, as a Lisp string.
1026 The name "xname" is used to intentionally break code referring to
1027 the old field "name" of type pointer to struct Lisp_String. */
1028 Lisp_Object xname;
1030 /* Value of the symbol or Qunbound if unbound. If this symbol is a
1031 defvaralias, `alias' contains the symbol for which it is an
1032 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
1033 and set a symbol's value, to take defvaralias into account. */
1034 union {
1035 Lisp_Object value;
1036 struct Lisp_Symbol *alias;
1037 struct Lisp_Buffer_Local_Value *blv;
1038 union Lisp_Fwd *fwd;
1039 } val;
1041 /* Function value of the symbol or Qunbound if not fboundp. */
1042 Lisp_Object function;
1044 /* The symbol's property list. */
1045 Lisp_Object plist;
1047 /* Next symbol in obarray bucket, if the symbol is interned. */
1048 struct Lisp_Symbol *next;
1051 /* Value is name of symbol. */
1053 #define SYMBOL_VAL(sym) \
1054 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1055 #define SYMBOL_ALIAS(sym) \
1056 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1057 #define SYMBOL_BLV(sym) \
1058 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1059 #define SYMBOL_FWD(sym) \
1060 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1061 #define SET_SYMBOL_VAL(sym, v) \
1062 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1063 #define SET_SYMBOL_ALIAS(sym, v) \
1064 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1065 #define SET_SYMBOL_BLV(sym, v) \
1066 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1067 #define SET_SYMBOL_FWD(sym, v) \
1068 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1070 #define SYMBOL_NAME(sym) \
1071 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1073 /* Value is non-zero if SYM is an interned symbol. */
1075 #define SYMBOL_INTERNED_P(sym) \
1076 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1078 /* Value is non-zero if SYM is interned in initial_obarray. */
1080 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1081 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1083 /* Value is non-zero if symbol is considered a constant, i.e. its
1084 value cannot be changed (there is an exception for keyword symbols,
1085 whose value can be set to the keyword symbol itself). */
1087 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1090 /***********************************************************************
1091 Hash Tables
1092 ***********************************************************************/
1094 /* The structure of a Lisp hash table. */
1096 struct Lisp_Hash_Table
1098 /* Vector fields. The hash table code doesn't refer to these. */
1099 EMACS_UINT size;
1100 struct Lisp_Vector *vec_next;
1102 /* Function used to compare keys. */
1103 Lisp_Object test;
1105 /* Nil if table is non-weak. Otherwise a symbol describing the
1106 weakness of the table. */
1107 Lisp_Object weak;
1109 /* When the table is resized, and this is an integer, compute the
1110 new size by adding this to the old size. If a float, compute the
1111 new size by multiplying the old size with this factor. */
1112 Lisp_Object rehash_size;
1114 /* Resize hash table when number of entries/ table size is >= this
1115 ratio, a float. */
1116 Lisp_Object rehash_threshold;
1118 /* Vector of hash codes.. If hash[I] is nil, this means that that
1119 entry I is unused. */
1120 Lisp_Object hash;
1122 /* Vector used to chain entries. If entry I is free, next[I] is the
1123 entry number of the next free item. If entry I is non-free,
1124 next[I] is the index of the next entry in the collision chain. */
1125 Lisp_Object next;
1127 /* Index of first free entry in free list. */
1128 Lisp_Object next_free;
1130 /* Bucket vector. A non-nil entry is the index of the first item in
1131 a collision chain. This vector's size can be larger than the
1132 hash table size to reduce collisions. */
1133 Lisp_Object index;
1135 /* User-supplied hash function, or nil. */
1136 Lisp_Object user_hash_function;
1138 /* User-supplied key comparison function, or nil. */
1139 Lisp_Object user_cmp_function;
1141 /* Only the fields above are traced normally by the GC. The ones below
1142 `count'. are special and are either ignored by the GC or traced in
1143 a special way (e.g. because of weakness). */
1145 /* Number of key/value entries in the table. */
1146 unsigned int count;
1148 /* Vector of keys and values. The key of item I is found at index
1149 2 * I, the value is found at index 2 * I + 1.
1150 This is gc_marked specially if the table is weak. */
1151 Lisp_Object key_and_value;
1153 /* Next weak hash table if this is a weak hash table. The head
1154 of the list is in weak_hash_tables. */
1155 struct Lisp_Hash_Table *next_weak;
1157 /* C function to compare two keys. */
1158 int (* cmpfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object,
1159 unsigned, Lisp_Object, unsigned));
1161 /* C function to compute hash code. */
1162 unsigned (* hashfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object));
1166 #define XHASH_TABLE(OBJ) \
1167 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1169 #define XSET_HASH_TABLE(VAR, PTR) \
1170 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1172 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1174 #define CHECK_HASH_TABLE(x) \
1175 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1177 /* Value is the key part of entry IDX in hash table H. */
1179 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1181 /* Value is the value part of entry IDX in hash table H. */
1183 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1185 /* Value is the index of the next entry following the one at IDX
1186 in hash table H. */
1188 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1190 /* Value is the hash code computed for entry IDX in hash table H. */
1192 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1194 /* Value is the index of the element in hash table H that is the
1195 start of the collision list at index IDX in the index vector of H. */
1197 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1199 /* Value is the size of hash table H. */
1201 #define HASH_TABLE_SIZE(H) XVECTOR ((H)->next)->size
1203 /* Default size for hash tables if not specified. */
1205 #define DEFAULT_HASH_SIZE 65
1207 /* Default threshold specifying when to resize a hash table. The
1208 value gives the ratio of current entries in the hash table and the
1209 size of the hash table. */
1211 #define DEFAULT_REHASH_THRESHOLD 0.8
1213 /* Default factor by which to increase the size of a hash table. */
1215 #define DEFAULT_REHASH_SIZE 1.5
1218 /* These structures are used for various misc types. */
1220 struct Lisp_Misc_Any /* Supertype of all Misc types. */
1222 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_??? */
1223 unsigned gcmarkbit : 1;
1224 int spacer : 15;
1225 /* Make it as long as "Lisp_Free without padding". */
1226 void *fill;
1229 struct Lisp_Marker
1231 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Marker */
1232 unsigned gcmarkbit : 1;
1233 int spacer : 13;
1234 /* This flag is temporarily used in the functions
1235 decode/encode_coding_object to record that the marker position
1236 must be adjusted after the conversion. */
1237 unsigned int need_adjustment : 1;
1238 /* 1 means normal insertion at the marker's position
1239 leaves the marker after the inserted text. */
1240 unsigned int insertion_type : 1;
1241 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1242 Note: a chain of markers can contain markers pointing into different
1243 buffers (the chain is per buffer_text rather than per buffer, so it's
1244 shared between indirect buffers). */
1245 /* This is used for (other than NULL-checking):
1246 - Fmarker_buffer
1247 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1248 - unchain_marker: to find the list from which to unchain.
1249 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1251 struct buffer *buffer;
1253 /* The remaining fields are meaningless in a marker that
1254 does not point anywhere. */
1256 /* For markers that point somewhere,
1257 this is used to chain of all the markers in a given buffer. */
1258 /* We could remove it and use an array in buffer_text instead.
1259 That would also allow to preserve it ordered. */
1260 struct Lisp_Marker *next;
1261 /* This is the char position where the marker points. */
1262 EMACS_INT charpos;
1263 /* This is the byte position.
1264 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1265 used to implement the functionality of markers, but rather to (ab)use
1266 markers as a cache for char<->byte mappings). */
1267 EMACS_INT bytepos;
1270 /* Forwarding pointer to an int variable.
1271 This is allowed only in the value cell of a symbol,
1272 and it means that the symbol's value really lives in the
1273 specified int variable. */
1274 struct Lisp_Intfwd
1276 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Int */
1277 EMACS_INT *intvar;
1280 /* Boolean forwarding pointer to an int variable.
1281 This is like Lisp_Intfwd except that the ostensible
1282 "value" of the symbol is t if the int variable is nonzero,
1283 nil if it is zero. */
1284 struct Lisp_Boolfwd
1286 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Bool */
1287 int *boolvar;
1290 /* Forwarding pointer to a Lisp_Object variable.
1291 This is allowed only in the value cell of a symbol,
1292 and it means that the symbol's value really lives in the
1293 specified variable. */
1294 struct Lisp_Objfwd
1296 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Obj */
1297 Lisp_Object *objvar;
1300 /* Like Lisp_Objfwd except that value lives in a slot in the
1301 current buffer. Value is byte index of slot within buffer. */
1302 struct Lisp_Buffer_Objfwd
1304 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Buffer_Obj */
1305 int offset;
1306 Lisp_Object slottype; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1309 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1310 the symbol has buffer-local or frame-local bindings. (Exception:
1311 some buffer-local variables are built-in, with their values stored
1312 in the buffer structure itself. They are handled differently,
1313 using struct Lisp_Buffer_Objfwd.)
1315 The `realvalue' slot holds the variable's current value, or a
1316 forwarding pointer to where that value is kept. This value is the
1317 one that corresponds to the loaded binding. To read or set the
1318 variable, you must first make sure the right binding is loaded;
1319 then you can access the value in (or through) `realvalue'.
1321 `buffer' and `frame' are the buffer and frame for which the loaded
1322 binding was found. If those have changed, to make sure the right
1323 binding is loaded it is necessary to find which binding goes with
1324 the current buffer and selected frame, then load it. To load it,
1325 first unload the previous binding, then copy the value of the new
1326 binding into `realvalue' (or through it). Also update
1327 LOADED-BINDING to point to the newly loaded binding.
1329 `local_if_set' indicates that merely setting the variable creates a local
1330 binding for the current buffer. Otherwise the latter, setting the
1331 variable does not do that; only make-local-variable does that. */
1333 struct Lisp_Buffer_Local_Value
1335 /* 1 means that merely setting the variable creates a local
1336 binding for the current buffer */
1337 unsigned int local_if_set : 1;
1338 /* 1 means this variable can have frame-local bindings, otherwise, it is
1339 can have buffer-local bindings. The two cannot be combined. */
1340 unsigned int frame_local : 1;
1341 /* 1 means that the binding now loaded was found.
1342 Presumably equivalent to (defcell!=valcell) */
1343 unsigned int found : 1;
1344 /* If non-NULL, a forwarding to the C var where it should also be set. */
1345 union Lisp_Fwd *fwd; /* Should never be (Buffer|Kboard)_Objfwd. */
1346 /* The buffer or frame for which the loaded binding was found. */
1347 Lisp_Object where;
1348 /* A cons cell that holds the default value. It has the form
1349 (SYMBOL . DEFAULT-VALUE). */
1350 Lisp_Object defcell;
1351 /* The cons cell from `where's parameter alist.
1352 It always has the form (SYMBOL . VALUE)
1353 Note that if `forward' is non-nil, VALUE may be out of date.
1354 Also if the currently loaded binding is the default binding, then
1355 this is `eq'ual to defcell. */
1356 Lisp_Object valcell;
1359 #define BLV_FOUND(blv) \
1360 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1361 #define SET_BLV_FOUND(blv, v) \
1362 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1364 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1365 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1367 /* START and END are markers in the overlay's buffer, and
1368 PLIST is the overlay's property list. */
1369 struct Lisp_Overlay
1370 /* An overlay's real data content is:
1371 - plist
1372 - buffer
1373 - insertion type of both ends
1374 - start & start_byte
1375 - end & end_byte
1376 - next (singly linked list of overlays).
1377 - start_next and end_next (singly linked list of markers).
1378 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1381 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Overlay */
1382 unsigned gcmarkbit : 1;
1383 int spacer : 15;
1384 struct Lisp_Overlay *next;
1385 Lisp_Object start, end, plist;
1388 /* Like Lisp_Objfwd except that value lives in a slot in the
1389 current kboard. */
1390 struct Lisp_Kboard_Objfwd
1392 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Kboard_Obj */
1393 int offset;
1396 /* Hold a C pointer for later use.
1397 This type of object is used in the arg to record_unwind_protect. */
1398 struct Lisp_Save_Value
1400 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Save_Value */
1401 unsigned gcmarkbit : 1;
1402 int spacer : 14;
1403 /* If DOGC is set, POINTER is the address of a memory
1404 area containing INTEGER potential Lisp_Objects. */
1405 unsigned int dogc : 1;
1406 void *pointer;
1407 int integer;
1411 /* A miscellaneous object, when it's on the free list. */
1412 struct Lisp_Free
1414 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Free */
1415 unsigned gcmarkbit : 1;
1416 int spacer : 15;
1417 union Lisp_Misc *chain;
1418 #ifdef USE_LSB_TAG
1419 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1420 This assumes that Lisp_Marker is the largest of the alternatives and
1421 that Lisp_Misc_Any has the same size as "Lisp_Free w/o padding". */
1422 char padding[((((sizeof (struct Lisp_Marker) - 1) >> GCTYPEBITS) + 1)
1423 << GCTYPEBITS) - sizeof (struct Lisp_Misc_Any)];
1424 #endif
1427 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1428 It uses one of these struct subtypes to get the type field. */
1430 union Lisp_Misc
1432 struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */
1433 struct Lisp_Free u_free; /* Includes padding to force alignment. */
1434 struct Lisp_Marker u_marker; /* 5 */
1435 struct Lisp_Overlay u_overlay; /* 5 */
1436 struct Lisp_Save_Value u_save_value; /* 3 */
1439 union Lisp_Fwd
1441 struct Lisp_Intfwd u_intfwd; /* 2 */
1442 struct Lisp_Boolfwd u_boolfwd; /* 2 */
1443 struct Lisp_Objfwd u_objfwd; /* 2 */
1444 struct Lisp_Buffer_Objfwd u_buffer_objfwd; /* 2 */
1445 struct Lisp_Kboard_Objfwd u_kboard_objfwd; /* 2 */
1448 /* Lisp floating point type */
1449 struct Lisp_Float
1451 union
1453 #ifdef HIDE_LISP_IMPLEMENTATION
1454 double data_;
1455 #else
1456 double data;
1457 #endif
1458 struct Lisp_Float *chain;
1459 } u;
1462 #ifdef HIDE_LISP_IMPLEMENTATION
1463 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1464 #else
1465 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1466 /* This should be used only in alloc.c, which always disables
1467 HIDE_LISP_IMPLEMENTATION. */
1468 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1469 #endif
1471 /* A character, declared with the following typedef, is a member
1472 of some character set associated with the current buffer. */
1473 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1474 #define _UCHAR_T
1475 typedef unsigned char UCHAR;
1476 #endif
1478 /* Meanings of slots in a Lisp_Compiled: */
1480 #define COMPILED_ARGLIST 0
1481 #define COMPILED_BYTECODE 1
1482 #define COMPILED_CONSTANTS 2
1483 #define COMPILED_STACK_DEPTH 3
1484 #define COMPILED_DOC_STRING 4
1485 #define COMPILED_INTERACTIVE 5
1487 /* Flag bits in a character. These also get used in termhooks.h.
1488 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1489 (MUlti-Lingual Emacs) might need 22 bits for the character value
1490 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1491 #define CHAR_ALT (0x0400000)
1492 #define CHAR_SUPER (0x0800000)
1493 #define CHAR_HYPER (0x1000000)
1494 #define CHAR_SHIFT (0x2000000)
1495 #define CHAR_CTL (0x4000000)
1496 #define CHAR_META (0x8000000)
1498 #define CHAR_MODIFIER_MASK \
1499 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1502 /* Actually, the current Emacs uses 22 bits for the character value
1503 itself. */
1504 #define CHARACTERBITS 22
1506 /* The maximum byte size consumed by push_key_description.
1507 All callers should assure that at least this size of memory is
1508 allocated at the place pointed by the second argument.
1510 There are 6 modifiers, each consumes 2 chars.
1511 The octal form of a character code consumes
1512 (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
1513 We need one more byte for string terminator `\0'. */
1514 #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)
1517 /* The glyph datatype, used to represent characters on the display.
1518 It consists of a char code and a face id. */
1520 typedef struct {
1521 int ch;
1522 int face_id;
1523 } GLYPH;
1525 /* Return a glyph's character code. */
1526 #define GLYPH_CHAR(glyph) ((glyph).ch)
1528 /* Return a glyph's face ID. */
1529 #define GLYPH_FACE(glyph) ((glyph).face_id)
1531 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1532 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1533 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1535 /* Return 1 if GLYPH contains valid character code. */
1536 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph), 1)
1539 /* Glyph Code from a display vector may either be an integer which
1540 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1541 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1543 #define GLYPH_CODE_CHAR(gc) \
1544 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1546 #define GLYPH_CODE_FACE(gc) \
1547 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1549 /* Return 1 if glyph code from display vector contains valid character code. */
1550 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc), 1)
1552 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1554 /* Only called when GLYPH_CODE_P (gc) is true. */
1555 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1556 do \
1558 if (CONSP (gc)) \
1559 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1560 else \
1561 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1562 (XINT (gc) >> CHARACTERBITS)); \
1564 while (0)
1566 /* The ID of the mode line highlighting face. */
1567 #define GLYPH_MODE_LINE_FACE 1
1569 /* Data type checking */
1571 #define NILP(x) EQ (x, Qnil)
1573 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1574 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1576 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1577 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1578 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1579 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1580 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1581 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1583 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1584 #define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1585 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1586 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1587 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1589 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1590 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1591 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1592 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1593 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1595 /* True if object X is a pseudovector whose code is CODE. */
1596 #define PSEUDOVECTORP(x, code) \
1597 (VECTORLIKEP (x) \
1598 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1599 == (PSEUDOVECTOR_FLAG | (code))))
1601 /* Test for specific pseudovector types. */
1602 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1603 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1604 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1605 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1606 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1607 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1608 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1609 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1610 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1611 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1612 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1614 /* Test for image (image . spec) */
1615 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1617 /* Array types. */
1619 #define ARRAYP(x) \
1620 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1622 #define CHECK_LIST(x) \
1623 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1625 #define CHECK_LIST_CONS(x, y) \
1626 CHECK_TYPE (CONSP (x), Qlistp, y)
1628 #define CHECK_LIST_END(x, y) \
1629 CHECK_TYPE (NILP (x), Qlistp, y)
1631 #define CHECK_STRING(x) \
1632 CHECK_TYPE (STRINGP (x), Qstringp, x)
1634 #define CHECK_STRING_CAR(x) \
1635 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1637 #define CHECK_CONS(x) \
1638 CHECK_TYPE (CONSP (x), Qconsp, x)
1640 #define CHECK_SYMBOL(x) \
1641 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1643 #define CHECK_CHAR_TABLE(x) \
1644 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1646 #define CHECK_VECTOR(x) \
1647 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1649 #define CHECK_VECTOR_OR_STRING(x) \
1650 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1652 #define CHECK_ARRAY(x, Qxxxp) \
1653 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1655 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1656 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1658 #define CHECK_BUFFER(x) \
1659 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1661 #define CHECK_WINDOW(x) \
1662 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1664 #define CHECK_WINDOW_CONFIGURATION(x) \
1665 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1667 /* This macro rejects windows on the interior of the window tree as
1668 "dead", which is what we want; this is an argument-checking macro, and
1669 the user should never get access to interior windows.
1671 A window of any sort, leaf or interior, is dead if the buffer,
1672 vchild, and hchild members are all nil. */
1674 #define CHECK_LIVE_WINDOW(x) \
1675 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1677 #define CHECK_PROCESS(x) \
1678 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1680 #define CHECK_SUBR(x) \
1681 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1683 #define CHECK_NUMBER(x) \
1684 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1686 #define CHECK_NATNUM(x) \
1687 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1689 #define CHECK_MARKER(x) \
1690 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1692 #define CHECK_NUMBER_COERCE_MARKER(x) \
1693 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1694 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1696 #define XFLOATINT(n) extract_float((n))
1698 #define CHECK_FLOAT(x) \
1699 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1701 #define CHECK_NUMBER_OR_FLOAT(x) \
1702 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1704 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1705 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1706 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1708 #define CHECK_OVERLAY(x) \
1709 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1711 /* Since we can't assign directly to the CAR or CDR fields of a cons
1712 cell, use these when checking that those fields contain numbers. */
1713 #define CHECK_NUMBER_CAR(x) \
1714 do { \
1715 Lisp_Object tmp = XCAR (x); \
1716 CHECK_NUMBER (tmp); \
1717 XSETCAR ((x), tmp); \
1718 } while (0)
1720 #define CHECK_NUMBER_CDR(x) \
1721 do { \
1722 Lisp_Object tmp = XCDR (x); \
1723 CHECK_NUMBER (tmp); \
1724 XSETCDR ((x), tmp); \
1725 } while (0)
1727 #define CHECK_NATNUM_CAR(x) \
1728 do { \
1729 Lisp_Object tmp = XCAR (x); \
1730 CHECK_NATNUM (tmp); \
1731 XSETCAR ((x), tmp); \
1732 } while (0)
1734 #define CHECK_NATNUM_CDR(x) \
1735 do { \
1736 Lisp_Object tmp = XCDR (x); \
1737 CHECK_NATNUM (tmp); \
1738 XSETCDR ((x), tmp); \
1739 } while (0)
1741 /* Cast pointers to this type to compare them. Some machines want int. */
1742 #define PNTR_COMPARISON_TYPE EMACS_UINT
1744 /* Define a built-in function for calling from Lisp.
1745 `lname' should be the name to give the function in Lisp,
1746 as a null-terminated C string.
1747 `fnname' should be the name of the function in C.
1748 By convention, it starts with F.
1749 `sname' should be the name for the C constant structure
1750 that records information on this function for internal use.
1751 By convention, it should be the same as `fnname' but with S instead of F.
1752 It's too bad that C macros can't compute this from `fnname'.
1753 `minargs' should be a number, the minimum number of arguments allowed.
1754 `maxargs' should be a number, the maximum number of arguments allowed,
1755 or else MANY or UNEVALLED.
1756 MANY means pass a vector of evaluated arguments,
1757 in the form of an integer number-of-arguments
1758 followed by the address of a vector of Lisp_Objects
1759 which contains the argument values.
1760 UNEVALLED means pass the list of unevaluated arguments
1761 `intspec' says how interactive arguments are to be fetched.
1762 If the string starts with a `(', `intspec' is evaluated and the resulting
1763 list is the list of arguments.
1764 If it's a string that doesn't start with `(', the value should follow
1765 the one of the doc string for `interactive'.
1766 A null string means call interactively with no arguments.
1767 `doc' is documentation for the user. */
1769 /* This version of DEFUN declares a function prototype with the right
1770 arguments, so we can catch errors with maxargs at compile-time. */
1771 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1772 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1773 DECL_ALIGN (struct Lisp_Subr, sname) = \
1774 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1775 fnname, minargs, maxargs, lname, intspec, 0}; \
1776 Lisp_Object fnname
1778 /* Note that the weird token-substitution semantics of ANSI C makes
1779 this work for MANY and UNEVALLED. */
1780 #define DEFUN_ARGS_MANY (int, Lisp_Object *)
1781 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1782 #define DEFUN_ARGS_0 (void)
1783 #define DEFUN_ARGS_1 (Lisp_Object)
1784 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1785 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1786 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1787 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1788 Lisp_Object)
1789 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1790 Lisp_Object, Lisp_Object)
1791 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1792 Lisp_Object, Lisp_Object, Lisp_Object)
1793 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1794 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1795 /* Non-zero if OBJ is a Lisp function. */
1797 #define FUNCTIONP(OBJ) \
1798 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1799 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1800 || COMPILEDP (OBJ) \
1801 || SUBRP (OBJ))
1803 /* defsubr (Sname);
1804 is how we define the symbol for function `name' at start-up time. */
1805 extern void defsubr P_ ((struct Lisp_Subr *));
1807 #define MANY -2
1808 #define UNEVALLED -1
1810 extern void defvar_lisp (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1811 extern void defvar_lisp_nopro (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1812 extern void defvar_bool (struct Lisp_Boolfwd *, const char *, int *);
1813 extern void defvar_int (struct Lisp_Intfwd *, const char *, EMACS_INT *);
1814 extern void defvar_kboard (struct Lisp_Kboard_Objfwd *, const char *, int);
1816 /* Macros we use to define forwarded Lisp variables.
1817 These are used in the syms_of_FILENAME functions. */
1819 #define DEFVAR_LISP(lname, vname, doc) \
1820 do { \
1821 static struct Lisp_Objfwd o_fwd; \
1822 defvar_lisp (&o_fwd, lname, vname); \
1823 } while (0)
1824 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1825 do { \
1826 static struct Lisp_Objfwd o_fwd; \
1827 defvar_lisp_nopro (&o_fwd, lname, vname); \
1828 } while (0)
1829 #define DEFVAR_BOOL(lname, vname, doc) \
1830 do { \
1831 static struct Lisp_Boolfwd b_fwd; \
1832 defvar_bool (&b_fwd, lname, vname); \
1833 } while (0)
1834 #define DEFVAR_INT(lname, vname, doc) \
1835 do { \
1836 static struct Lisp_Intfwd i_fwd; \
1837 defvar_int (&i_fwd, lname, vname); \
1838 } while (0)
1840 #define DEFVAR_KBOARD(lname, vname, doc) \
1841 do { \
1842 static struct Lisp_Kboard_Objfwd ko_fwd; \
1843 defvar_kboard (&ko_fwd, \
1844 lname, \
1845 (int)((char *)(&current_kboard->vname) \
1846 - (char *)current_kboard)); \
1847 } while (0)
1851 /* Structure for recording Lisp call stack for backtrace purposes. */
1853 /* The special binding stack holds the outer values of variables while
1854 they are bound by a function application or a let form, stores the
1855 code to be executed for Lisp unwind-protect forms, and stores the C
1856 functions to be called for record_unwind_protect.
1858 If func is non-zero, undoing this binding applies func to old_value;
1859 This implements record_unwind_protect.
1861 Otherwise, the element is a variable binding.
1863 If the symbol field is a symbol, it is an ordinary variable binding.
1865 Otherwise, it should be a structure (SYMBOL WHERE
1866 . CURRENT-BUFFER), which means having bound a local value while
1867 CURRENT-BUFFER was active. If WHERE is nil this means we saw the
1868 default value when binding SYMBOL. WHERE being a buffer or frame
1869 means we saw a buffer-local or frame-local value. Other values of
1870 WHERE mean an internal error. */
1872 typedef Lisp_Object (*specbinding_func) P_ ((Lisp_Object));
1874 struct specbinding
1876 Lisp_Object symbol, old_value;
1877 specbinding_func func;
1878 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
1881 extern struct specbinding *specpdl;
1882 extern struct specbinding *specpdl_ptr;
1883 extern int specpdl_size;
1885 extern EMACS_INT max_specpdl_size;
1887 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
1889 /* Everything needed to describe an active condition case. */
1890 struct handler
1892 /* The handler clauses and variable from the condition-case form. */
1893 /* For a handler set up in Lisp code, this is always a list.
1894 For an internal handler set up by internal_condition_case*,
1895 this can instead be the symbol t or `error'.
1896 t: handle all conditions.
1897 error: handle all conditions, and errors can run the debugger
1898 or display a backtrace. */
1899 Lisp_Object handler;
1900 Lisp_Object var;
1901 /* Fsignal stores here the condition-case clause that applies,
1902 and Fcondition_case thus knows which clause to run. */
1903 Lisp_Object chosen_clause;
1905 /* Used to effect the longjump out to the handler. */
1906 struct catchtag *tag;
1908 /* The next enclosing handler. */
1909 struct handler *next;
1912 extern struct handler *handlerlist;
1914 /* This structure helps implement the `catch' and `throw' control
1915 structure. A struct catchtag contains all the information needed
1916 to restore the state of the interpreter after a non-local jump.
1918 Handlers for error conditions (represented by `struct handler'
1919 structures) just point to a catch tag to do the cleanup required
1920 for their jumps.
1922 catchtag structures are chained together in the C calling stack;
1923 the `next' member points to the next outer catchtag.
1925 A call like (throw TAG VAL) searches for a catchtag whose `tag'
1926 member is TAG, and then unbinds to it. The `val' member is used to
1927 hold VAL while the stack is unwound; `val' is returned as the value
1928 of the catch form.
1930 All the other members are concerned with restoring the interpreter
1931 state. */
1933 struct catchtag
1935 Lisp_Object tag;
1936 Lisp_Object val;
1937 struct catchtag *next;
1938 struct gcpro *gcpro;
1939 jmp_buf jmp;
1940 struct backtrace *backlist;
1941 struct handler *handlerlist;
1942 int lisp_eval_depth;
1943 int pdlcount;
1944 int poll_suppress_count;
1945 int interrupt_input_blocked;
1946 struct byte_stack *byte_stack;
1949 extern struct catchtag *catchlist;
1950 extern struct backtrace *backtrace_list;
1952 extern Lisp_Object memory_signal_data;
1954 /* An address near the bottom of the stack.
1955 Tells GC how to save a copy of the stack. */
1956 extern char *stack_bottom;
1958 /* Check quit-flag and quit if it is non-nil.
1959 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
1960 So the program needs to do QUIT at times when it is safe to quit.
1961 Every loop that might run for a long time or might not exit
1962 ought to do QUIT at least once, at a safe place.
1963 Unless that is impossible, of course.
1964 But it is very desirable to avoid creating loops where QUIT is impossible.
1966 Exception: if you set immediate_quit to nonzero,
1967 then the handler that responds to the C-g does the quit itself.
1968 This is a good thing to do around a loop that has no side effects
1969 and (in particular) cannot call arbitrary Lisp code. */
1971 #ifdef SYNC_INPUT
1972 extern void process_pending_signals P_ ((void));
1973 extern int pending_signals;
1974 #define ELSE_PENDING_SIGNALS \
1975 else if (pending_signals) \
1976 process_pending_signals ();
1977 #else /* not SYNC_INPUT */
1978 #define ELSE_PENDING_SIGNALS
1979 #endif /* not SYNC_INPUT */
1981 #define QUIT \
1982 do { \
1983 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1985 Lisp_Object flag = Vquit_flag; \
1986 Vquit_flag = Qnil; \
1987 if (EQ (Vthrow_on_input, flag)) \
1988 Fthrow (Vthrow_on_input, Qt); \
1989 Fsignal (Qquit, Qnil); \
1991 ELSE_PENDING_SIGNALS \
1992 } while (0)
1995 /* Nonzero if ought to quit now. */
1997 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
1999 /* Variables used locally in the following case handling macros. */
2000 extern int case_temp1;
2001 extern Lisp_Object case_temp2;
2003 /* Current buffer's map from characters to lower-case characters. */
2005 #define DOWNCASE_TABLE current_buffer->downcase_table
2007 /* Current buffer's map from characters to upper-case characters. */
2009 #define UPCASE_TABLE current_buffer->upcase_table
2011 /* Downcase a character, or make no change if that cannot be done. */
2013 #define DOWNCASE(CH) \
2014 ((case_temp1 = (CH), \
2015 case_temp2 = CHAR_TABLE_REF (DOWNCASE_TABLE, case_temp1), \
2016 NATNUMP (case_temp2)) \
2017 ? XFASTINT (case_temp2) : case_temp1)
2019 /* 1 if CH is upper case. */
2021 #define UPPERCASEP(CH) (DOWNCASE (CH) != (CH))
2023 /* 1 if CH is neither upper nor lower case. */
2025 #define NOCASEP(CH) (UPCASE1 (CH) == (CH))
2027 /* 1 if CH is lower case. */
2029 #define LOWERCASEP(CH) (!UPPERCASEP (CH) && !NOCASEP(CH))
2031 /* Upcase a character, or make no change if that cannot be done. */
2033 #define UPCASE(CH) (!UPPERCASEP (CH) ? UPCASE1 (CH) : (CH))
2035 /* Upcase a character known to be not upper case. */
2037 #define UPCASE1(CH) \
2038 ((case_temp1 = (CH), \
2039 case_temp2 = CHAR_TABLE_REF (UPCASE_TABLE, case_temp1), \
2040 NATNUMP (case_temp2)) \
2041 ? XFASTINT (case_temp2) : case_temp1)
2043 extern Lisp_Object Vascii_downcase_table, Vascii_upcase_table;
2044 extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
2046 /* Number of bytes of structure consed since last GC. */
2048 extern int consing_since_gc;
2050 /* Thresholds for doing another gc. */
2052 extern EMACS_INT gc_cons_threshold;
2054 extern EMACS_INT gc_relative_threshold;
2056 extern EMACS_INT memory_full_cons_threshold;
2058 /* Structure for recording stack slots that need marking. */
2060 /* This is a chain of structures, each of which points at a Lisp_Object variable
2061 whose value should be marked in garbage collection.
2062 Normally every link of the chain is an automatic variable of a function,
2063 and its `val' points to some argument or local variable of the function.
2064 On exit to the function, the chain is set back to the value it had on entry.
2065 This way, no link remains in the chain when the stack frame containing the
2066 link disappears.
2068 Every function that can call Feval must protect in this fashion all
2069 Lisp_Object variables whose contents will be used again. */
2071 extern struct gcpro *gcprolist;
2073 struct gcpro
2075 struct gcpro *next;
2077 /* Address of first protected variable. */
2078 volatile Lisp_Object *var;
2080 /* Number of consecutive protected variables. */
2081 int nvars;
2083 #ifdef DEBUG_GCPRO
2084 int level;
2085 #endif
2088 /* Values of GC_MARK_STACK during compilation:
2090 0 Use GCPRO as before
2091 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2092 2 Mark the stack, and check that everything GCPRO'd is
2093 marked.
2094 3 Mark using GCPRO's, mark stack last, and count how many
2095 dead objects are kept alive. */
2098 #define GC_USE_GCPROS_AS_BEFORE 0
2099 #define GC_MAKE_GCPROS_NOOPS 1
2100 #define GC_MARK_STACK_CHECK_GCPROS 2
2101 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2103 #ifndef GC_MARK_STACK
2104 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2105 #endif
2107 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2109 /* Do something silly with gcproN vars just so gcc shuts up. */
2110 /* You get warnings from MIPSPro... */
2112 #define GCPRO1(varname) ((void) gcpro1)
2113 #define GCPRO2(varname1, varname2)(((void) gcpro2, (void) gcpro1))
2114 #define GCPRO3(varname1, varname2, varname3) \
2115 (((void) gcpro3, (void) gcpro2, (void) gcpro1))
2116 #define GCPRO4(varname1, varname2, varname3, varname4) \
2117 (((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2118 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2119 (((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2120 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2121 (((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2122 #define UNGCPRO ((void) 0)
2124 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2126 #ifndef DEBUG_GCPRO
2128 #define GCPRO1(varname) \
2129 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2130 gcprolist = &gcpro1; }
2132 #define GCPRO2(varname1, varname2) \
2133 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2134 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2135 gcprolist = &gcpro2; }
2137 #define GCPRO3(varname1, varname2, varname3) \
2138 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2139 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2140 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2141 gcprolist = &gcpro3; }
2143 #define GCPRO4(varname1, varname2, varname3, varname4) \
2144 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2145 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2146 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2147 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2148 gcprolist = &gcpro4; }
2150 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2151 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2152 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2153 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2154 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2155 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2156 gcprolist = &gcpro5; }
2158 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2159 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2160 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2161 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2162 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2163 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2164 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2165 gcprolist = &gcpro6; }
2167 #define UNGCPRO (gcprolist = gcpro1.next)
2169 #else
2171 extern int gcpro_level;
2173 #define GCPRO1(varname) \
2174 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2175 gcpro1.level = gcpro_level++; \
2176 gcprolist = &gcpro1; }
2178 #define GCPRO2(varname1, varname2) \
2179 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2180 gcpro1.level = gcpro_level; \
2181 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2182 gcpro2.level = gcpro_level++; \
2183 gcprolist = &gcpro2; }
2185 #define GCPRO3(varname1, varname2, varname3) \
2186 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2187 gcpro1.level = gcpro_level; \
2188 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2189 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2190 gcpro3.level = gcpro_level++; \
2191 gcprolist = &gcpro3; }
2193 #define GCPRO4(varname1, varname2, varname3, varname4) \
2194 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2195 gcpro1.level = gcpro_level; \
2196 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2197 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2198 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2199 gcpro4.level = gcpro_level++; \
2200 gcprolist = &gcpro4; }
2202 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2203 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2204 gcpro1.level = gcpro_level; \
2205 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2206 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2207 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2208 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2209 gcpro5.level = gcpro_level++; \
2210 gcprolist = &gcpro5; }
2212 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2213 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2214 gcpro1.level = gcpro_level; \
2215 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2216 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2217 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2218 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2219 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2220 gcpro6.level = gcpro_level++; \
2221 gcprolist = &gcpro6; }
2223 #define UNGCPRO \
2224 ((--gcpro_level != gcpro1.level) \
2225 ? (abort (), 0) \
2226 : ((gcprolist = gcpro1.next), 0))
2228 #endif /* DEBUG_GCPRO */
2229 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2232 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2233 #define RETURN_UNGCPRO(expr) \
2234 do \
2236 Lisp_Object ret_ungc_val; \
2237 ret_ungc_val = (expr); \
2238 UNGCPRO; \
2239 return ret_ungc_val; \
2241 while (0)
2243 /* Call staticpro (&var) to protect static variable `var'. */
2245 void staticpro P_ ((Lisp_Object *));
2247 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2248 meaning as in the DEFUN macro, and is used to construct a prototype. */
2249 /* We can use the same trick as in the DEFUN macro to generate the
2250 appropriate prototype. */
2251 #define EXFUN(fnname, maxargs) \
2252 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2254 /* Forward declarations for prototypes. */
2255 struct window;
2256 struct frame;
2258 /* Defined in data.c */
2259 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
2260 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
2261 extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
2262 extern Lisp_Object Qvoid_variable, Qvoid_function;
2263 extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
2264 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
2265 extern Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
2266 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
2267 extern Lisp_Object Qtext_read_only;
2269 extern Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
2270 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
2271 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
2272 extern Lisp_Object Qbuffer_or_string_p;
2273 extern Lisp_Object Qboundp, Qfboundp;
2274 extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
2276 extern Lisp_Object Qcdr;
2278 extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
2279 extern Lisp_Object Qoverflow_error, Qunderflow_error;
2281 extern Lisp_Object Qfloatp;
2282 extern Lisp_Object Qnumberp, Qnumber_or_marker_p;
2284 extern Lisp_Object Qinteger;
2286 extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
2288 extern void circular_list_error P_ ((Lisp_Object)) NO_RETURN;
2289 EXFUN (Finteractive_form, 1);
2290 EXFUN (Fbyteorder, 0);
2292 /* Defined in frame.c */
2293 extern Lisp_Object Qframep;
2295 EXFUN (Feq, 2);
2296 EXFUN (Fnull, 1);
2297 EXFUN (Flistp, 1);
2298 EXFUN (Fconsp, 1);
2299 EXFUN (Fatom, 1);
2300 EXFUN (Fnlistp, 1);
2301 EXFUN (Fintegerp, 1);
2302 EXFUN (Fnatnump, 1);
2303 EXFUN (Fsymbolp, 1);
2304 EXFUN (Fvectorp, 1);
2305 EXFUN (Fstringp, 1);
2306 EXFUN (Fmultibyte_string_p, 1);
2307 EXFUN (Farrayp, 1);
2308 EXFUN (Fsequencep, 1);
2309 EXFUN (Fbufferp, 1);
2310 EXFUN (Fmarkerp, 1);
2311 EXFUN (Fsubrp, 1);
2312 EXFUN (Fchar_or_string_p, 1);
2313 EXFUN (Finteger_or_marker_p, 1);
2314 EXFUN (Ffloatp, 1);
2315 EXFUN (Finteger_or_floatp, 1);
2316 EXFUN (Finteger_or_float_or_marker_p, 1);
2318 EXFUN (Fcar, 1);
2319 EXFUN (Fcar_safe, 1);
2320 EXFUN (Fcdr, 1);
2321 EXFUN (Fcdr_safe, 1);
2322 EXFUN (Fsetcar, 2);
2323 EXFUN (Fsetcdr, 2);
2324 EXFUN (Fboundp, 1);
2325 EXFUN (Ffboundp, 1);
2326 EXFUN (Fmakunbound, 1);
2327 EXFUN (Ffmakunbound, 1);
2328 EXFUN (Fsymbol_function, 1);
2329 EXFUN (Fsymbol_plist, 1);
2330 EXFUN (Fsymbol_name, 1);
2331 extern Lisp_Object indirect_function P_ ((Lisp_Object));
2332 EXFUN (Findirect_function, 2);
2333 EXFUN (Ffset, 2);
2334 EXFUN (Fsetplist, 2);
2335 EXFUN (Fsymbol_value, 1);
2336 extern Lisp_Object find_symbol_value P_ ((Lisp_Object));
2337 EXFUN (Fset, 2);
2338 EXFUN (Fdefault_value, 1);
2339 EXFUN (Fset_default, 2);
2340 EXFUN (Fdefault_boundp, 1);
2341 EXFUN (Fmake_local_variable, 1);
2342 EXFUN (Flocal_variable_p, 2);
2343 EXFUN (Flocal_variable_if_set_p, 2);
2345 EXFUN (Faref, 2);
2346 EXFUN (Faset, 3);
2348 EXFUN (Fstring_to_number, 2);
2349 EXFUN (Fnumber_to_string, 1);
2350 EXFUN (Feqlsign, 2);
2351 EXFUN (Fgtr, 2);
2352 EXFUN (Flss, 2);
2353 EXFUN (Fgeq, 2);
2354 EXFUN (Fleq, 2);
2355 EXFUN (Fneq, 2);
2356 EXFUN (Fzerop, 1);
2357 EXFUN (Fplus, MANY);
2358 EXFUN (Fminus, MANY);
2359 EXFUN (Ftimes, MANY);
2360 EXFUN (Fquo, MANY);
2361 EXFUN (Frem, 2);
2362 EXFUN (Fmax, MANY);
2363 EXFUN (Fmin, MANY);
2364 EXFUN (Flogand, MANY);
2365 EXFUN (Flogior, MANY);
2366 EXFUN (Flogxor, MANY);
2367 EXFUN (Flognot, 1);
2368 EXFUN (Flsh, 2);
2369 EXFUN (Fash, 2);
2371 EXFUN (Fadd1, 1);
2372 EXFUN (Fsub1, 1);
2373 EXFUN (Fmake_variable_buffer_local, 1);
2375 extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *);
2376 extern Lisp_Object long_to_cons P_ ((unsigned long));
2377 extern unsigned long cons_to_long P_ ((Lisp_Object));
2378 extern void args_out_of_range P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2379 extern void args_out_of_range_3 P_ ((Lisp_Object, Lisp_Object,
2380 Lisp_Object)) NO_RETURN;
2381 extern Lisp_Object wrong_type_argument P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2382 extern Lisp_Object do_symval_forwarding (union Lisp_Fwd *);
2383 extern void set_internal (Lisp_Object, Lisp_Object, Lisp_Object, int);
2384 extern void syms_of_data P_ ((void));
2385 extern void init_data P_ ((void));
2386 extern void swap_in_global_binding P_ ((struct Lisp_Symbol *));
2388 /* Defined in cmds.c */
2389 EXFUN (Fend_of_line, 1);
2390 EXFUN (Fforward_char, 1);
2391 EXFUN (Fforward_line, 1);
2392 extern int internal_self_insert P_ ((int, int));
2393 extern void syms_of_cmds P_ ((void));
2394 extern void keys_of_cmds P_ ((void));
2396 /* Defined in coding.c */
2397 EXFUN (Fcoding_system_p, 1);
2398 EXFUN (Fcoding_system_base, 1);
2399 EXFUN (Fcoding_system_eol_type, 1);
2400 EXFUN (Fcheck_coding_system, 1);
2401 EXFUN (Fcheck_coding_system, 1);
2402 EXFUN (Fread_coding_system, 2);
2403 EXFUN (Fread_non_nil_coding_system, 1);
2404 EXFUN (Ffind_operation_coding_system, MANY);
2405 EXFUN (Fupdate_coding_systems_internal, 0);
2406 EXFUN (Fencode_coding_string, 4);
2407 EXFUN (Fdecode_coding_string, 4);
2408 extern Lisp_Object detect_coding_system P_ ((const unsigned char *, EMACS_INT,
2409 EMACS_INT, int, int, Lisp_Object));
2410 extern void init_coding P_ ((void));
2411 extern void init_coding_once P_ ((void));
2412 extern void syms_of_coding P_ ((void));
2414 /* Defined in character.c */
2415 extern void init_character_once P_ ((void));
2416 extern void syms_of_character P_ ((void));
2417 EXFUN (Funibyte_char_to_multibyte, 1);
2419 /* Defined in charset.c */
2420 EXFUN (Fchar_bytes, 1);
2421 EXFUN (Fchar_width, 1);
2422 EXFUN (Fstring, MANY);
2423 extern EMACS_INT chars_in_text P_ ((const unsigned char *, EMACS_INT));
2424 extern EMACS_INT multibyte_chars_in_text P_ ((const unsigned char *, EMACS_INT));
2425 extern int multibyte_char_to_unibyte P_ ((int, Lisp_Object));
2426 extern int multibyte_char_to_unibyte_safe P_ ((int));
2427 extern Lisp_Object Qcharset;
2428 extern void init_charset P_ ((void));
2429 extern void init_charset_once P_ ((void));
2430 extern void syms_of_charset P_ ((void));
2431 /* Structure forward declarations. */
2432 struct charset;
2434 /* Defined in composite.c */
2435 extern void syms_of_composite P_ ((void));
2437 /* Defined in syntax.c */
2438 EXFUN (Fforward_word, 1);
2439 EXFUN (Fskip_chars_forward, 2);
2440 EXFUN (Fskip_chars_backward, 2);
2441 EXFUN (Fsyntax_table_p, 1);
2442 EXFUN (Fsyntax_table, 0);
2443 EXFUN (Fset_syntax_table, 1);
2444 extern void init_syntax_once P_ ((void));
2445 extern void syms_of_syntax P_ ((void));
2447 /* Defined in fns.c */
2448 extern int use_dialog_box;
2449 extern int next_almost_prime P_ ((int));
2450 extern Lisp_Object larger_vector P_ ((Lisp_Object, int, Lisp_Object));
2451 extern void sweep_weak_hash_tables P_ ((void));
2452 extern Lisp_Object Qstring_lessp;
2453 extern Lisp_Object Vfeatures;
2454 extern Lisp_Object QCtest, QCweakness, Qequal, Qeq;
2455 unsigned sxhash P_ ((Lisp_Object, int));
2456 Lisp_Object make_hash_table P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
2457 Lisp_Object, Lisp_Object, Lisp_Object,
2458 Lisp_Object));
2459 Lisp_Object copy_hash_table P_ ((struct Lisp_Hash_Table *));
2460 int hash_lookup P_ ((struct Lisp_Hash_Table *, Lisp_Object, unsigned *));
2461 int hash_put P_ ((struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
2462 unsigned));
2463 void hash_clear P_ ((struct Lisp_Hash_Table *));
2464 void init_weak_hash_tables P_ ((void));
2465 extern void init_fns P_ ((void));
2466 EXFUN (Fsxhash, 1);
2467 EXFUN (Fmake_hash_table, MANY);
2468 EXFUN (Fmakehash, 1);
2469 EXFUN (Fcopy_hash_table, 1);
2470 EXFUN (Fhash_table_count, 1);
2471 EXFUN (Fhash_table_rehash_size, 1);
2472 EXFUN (Fhash_table_rehash_threshold, 1);
2473 EXFUN (Fhash_table_size, 1);
2474 EXFUN (Fhash_table_test, 1);
2475 EXFUN (Fhash_table_weak, 1);
2476 EXFUN (Fhash_table_p, 1);
2477 EXFUN (Fclrhash, 1);
2478 EXFUN (Fgethash, 3);
2479 EXFUN (Fputhash, 3);
2480 EXFUN (Fremhash, 2);
2481 EXFUN (Fmaphash, 2);
2482 EXFUN (Fdefine_hash_table_test, 3);
2484 EXFUN (Fidentity, 1);
2485 EXFUN (Frandom, 1);
2486 EXFUN (Flength, 1);
2487 EXFUN (Fsafe_length, 1);
2488 EXFUN (Fappend, MANY);
2489 EXFUN (Fconcat, MANY);
2490 EXFUN (Fvconcat, MANY);
2491 EXFUN (Fcopy_sequence, 1);
2492 EXFUN (Fstring_make_multibyte, 1);
2493 EXFUN (Fstring_make_unibyte, 1);
2494 EXFUN (Fstring_as_multibyte, 1);
2495 EXFUN (Fstring_as_unibyte, 1);
2496 EXFUN (Fstring_to_multibyte, 1);
2497 EXFUN (Fstring_to_unibyte, 1);
2498 EXFUN (Fsubstring, 3);
2499 extern Lisp_Object substring_both P_ ((Lisp_Object, int, int, int, int));
2500 EXFUN (Fnth, 2);
2501 EXFUN (Fnthcdr, 2);
2502 EXFUN (Fmemq, 2);
2503 EXFUN (Fassq, 2);
2504 EXFUN (Fassoc, 2);
2505 EXFUN (Felt, 2);
2506 EXFUN (Fmember, 2);
2507 EXFUN (Frassq, 2);
2508 EXFUN (Fdelq, 2);
2509 EXFUN (Fdelete, 2);
2510 EXFUN (Fsort, 2);
2511 EXFUN (Freverse, 1);
2512 EXFUN (Fnreverse, 1);
2513 EXFUN (Fget, 2);
2514 EXFUN (Fput, 3);
2515 EXFUN (Fequal, 2);
2516 EXFUN (Ffillarray, 2);
2517 EXFUN (Fnconc, MANY);
2518 EXFUN (Fmapcar, 2);
2519 EXFUN (Fmapconcat, 3);
2520 EXFUN (Fy_or_n_p, 1);
2521 extern Lisp_Object do_yes_or_no_p P_ ((Lisp_Object));
2522 EXFUN (Frequire, 3);
2523 EXFUN (Fprovide, 2);
2524 extern Lisp_Object concat2 P_ ((Lisp_Object, Lisp_Object));
2525 extern Lisp_Object concat3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2526 extern Lisp_Object nconc2 P_ ((Lisp_Object, Lisp_Object));
2527 extern Lisp_Object assq_no_quit P_ ((Lisp_Object, Lisp_Object));
2528 extern Lisp_Object assoc_no_quit P_ ((Lisp_Object, Lisp_Object));
2529 extern void clear_string_char_byte_cache P_ ((void));
2530 extern EMACS_INT string_char_to_byte P_ ((Lisp_Object, EMACS_INT));
2531 extern EMACS_INT string_byte_to_char P_ ((Lisp_Object, EMACS_INT));
2532 extern Lisp_Object string_make_multibyte P_ ((Lisp_Object));
2533 extern Lisp_Object string_to_multibyte P_ ((Lisp_Object));
2534 extern Lisp_Object string_make_unibyte P_ ((Lisp_Object));
2535 EXFUN (Fcopy_alist, 1);
2536 EXFUN (Fplist_get, 2);
2537 EXFUN (Fplist_put, 3);
2538 EXFUN (Fplist_member, 2);
2539 EXFUN (Frassoc, 2);
2540 EXFUN (Fstring_equal, 2);
2541 EXFUN (Fcompare_strings, 7);
2542 EXFUN (Fstring_lessp, 2);
2543 extern void syms_of_fns P_ ((void));
2545 /* Defined in floatfns.c */
2546 extern double extract_float P_ ((Lisp_Object));
2547 EXFUN (Ffloat, 1);
2548 EXFUN (Ftruncate, 2);
2549 extern void init_floatfns P_ ((void));
2550 extern void syms_of_floatfns P_ ((void));
2552 /* Defined in fringe.c */
2553 extern void syms_of_fringe P_ ((void));
2554 extern void init_fringe P_ ((void));
2555 extern void init_fringe_once P_ ((void));
2557 /* Defined in image.c */
2558 EXFUN (Finit_image_library, 2);
2559 extern void syms_of_image P_ ((void));
2560 extern void init_image P_ ((void));
2562 /* Defined in insdel.c */
2563 extern Lisp_Object Qinhibit_modification_hooks;
2564 extern void move_gap (EMACS_INT);
2565 extern void move_gap_both (EMACS_INT, EMACS_INT);
2566 extern void make_gap (EMACS_INT);
2567 extern EMACS_INT copy_text (const unsigned char *, unsigned char *,
2568 EMACS_INT, int, int);
2569 extern EMACS_INT count_size_as_multibyte (const unsigned char *, EMACS_INT);
2570 extern int count_combining_before (const unsigned char *,
2571 EMACS_INT, EMACS_INT, EMACS_INT);
2572 extern int count_combining_after (const unsigned char *,
2573 EMACS_INT, EMACS_INT, EMACS_INT);
2574 extern void insert (const unsigned char *, EMACS_INT);
2575 extern void insert_and_inherit (const unsigned char *, EMACS_INT);
2576 extern void insert_1 (const unsigned char *, EMACS_INT, int, int, int);
2577 extern void insert_1_both (const unsigned char *, EMACS_INT, EMACS_INT,
2578 int, int, int);
2579 extern void insert_from_gap (EMACS_INT, EMACS_INT);
2580 extern void insert_from_string (Lisp_Object, EMACS_INT, EMACS_INT,
2581 EMACS_INT, EMACS_INT, int);
2582 extern void insert_from_buffer (struct buffer *, EMACS_INT, EMACS_INT, int);
2583 extern void insert_char (int);
2584 extern void insert_string (const char *);
2585 extern void insert_before_markers (const unsigned char *, EMACS_INT);
2586 extern void insert_before_markers_and_inherit (const unsigned char *,
2587 EMACS_INT);
2588 extern void insert_from_string_before_markers (Lisp_Object, EMACS_INT,
2589 EMACS_INT, EMACS_INT,
2590 EMACS_INT, int);
2591 extern void del_range (EMACS_INT, EMACS_INT);
2592 extern Lisp_Object del_range_1 (EMACS_INT, EMACS_INT, int, int);
2593 extern void del_range_byte (EMACS_INT, EMACS_INT, int);
2594 extern void del_range_both (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT, int);
2595 extern Lisp_Object del_range_2 (EMACS_INT, EMACS_INT,
2596 EMACS_INT, EMACS_INT, int);
2597 extern void modify_region (struct buffer *, EMACS_INT, EMACS_INT, int);
2598 extern void prepare_to_modify_buffer (EMACS_INT, EMACS_INT, EMACS_INT *);
2599 extern void signal_before_change (EMACS_INT, EMACS_INT, EMACS_INT *);
2600 extern void signal_after_change (EMACS_INT, EMACS_INT, EMACS_INT);
2601 extern void adjust_after_replace (EMACS_INT, EMACS_INT, Lisp_Object,
2602 EMACS_INT, EMACS_INT);
2603 extern void adjust_after_replace_noundo (EMACS_INT, EMACS_INT, EMACS_INT,
2604 EMACS_INT, EMACS_INT, EMACS_INT);
2605 extern void adjust_after_insert (EMACS_INT, EMACS_INT, EMACS_INT,
2606 EMACS_INT, EMACS_INT);
2607 extern void adjust_markers_for_delete (EMACS_INT, EMACS_INT,
2608 EMACS_INT, EMACS_INT);
2609 extern void replace_range (EMACS_INT, EMACS_INT, Lisp_Object, int, int, int);
2610 extern void replace_range_2 (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
2611 char *, EMACS_INT, EMACS_INT, int);
2612 extern void syms_of_insdel (void);
2614 /* Defined in dispnew.c */
2615 extern Lisp_Object selected_frame;
2616 extern EMACS_INT baud_rate;
2617 EXFUN (Fding, 1);
2618 EXFUN (Fredraw_frame, 1);
2619 EXFUN (Fredraw_display, 0);
2620 EXFUN (Fsleep_for, 2);
2621 EXFUN (Fredisplay, 1);
2622 extern Lisp_Object sit_for P_ ((Lisp_Object, int, int));
2623 extern void init_display P_ ((void));
2624 extern void syms_of_display P_ ((void));
2625 extern void safe_bcopy P_ ((const char *, char *, int));
2627 /* Defined in xdisp.c */
2628 extern Lisp_Object Qinhibit_point_motion_hooks;
2629 extern Lisp_Object Qinhibit_redisplay, Qdisplay;
2630 extern Lisp_Object Qinhibit_eval_during_redisplay;
2631 extern Lisp_Object Qmessage_truncate_lines;
2632 extern Lisp_Object Qimage, Qtext, Qboth, Qboth_horiz;
2633 extern Lisp_Object Vmessage_log_max;
2634 extern int message_enable_multibyte;
2635 extern Lisp_Object echo_area_buffer[2];
2636 extern void check_message_stack P_ ((void));
2637 extern void setup_echo_area_for_printing P_ ((int));
2638 extern int push_message P_ ((void));
2639 extern Lisp_Object pop_message_unwind P_ ((Lisp_Object));
2640 extern Lisp_Object restore_message_unwind P_ ((Lisp_Object));
2641 extern void pop_message P_ ((void));
2642 extern void restore_message P_ ((void));
2643 extern Lisp_Object current_message P_ ((void));
2644 extern void set_message P_ ((const char *s, Lisp_Object, int, int));
2645 extern void clear_message P_ ((int, int));
2646 extern void message P_ ((/* char *, ... */));
2647 extern void message_nolog P_ ((/* char *, ... */));
2648 extern void message1 P_ ((char *));
2649 extern void message1_nolog P_ ((char *));
2650 extern void message2 P_ ((const char *, int, int));
2651 extern void message2_nolog P_ ((const char *, int, int));
2652 extern void message3 P_ ((Lisp_Object, int, int));
2653 extern void message3_nolog P_ ((Lisp_Object, int, int));
2654 extern void message_dolog P_ ((const char *, int, int, int));
2655 extern void message_with_string P_ ((char *, Lisp_Object, int));
2656 extern void message_log_maybe_newline P_ ((void));
2657 extern void update_echo_area P_ ((void));
2658 extern void truncate_echo_area P_ ((int));
2659 extern void redisplay P_ ((void));
2660 extern int check_point_in_composition
2661 P_ ((struct buffer *, int, struct buffer *, int));
2662 extern void redisplay_preserve_echo_area P_ ((int));
2663 extern void prepare_menu_bars P_ ((void));
2665 void set_frame_cursor_types P_ ((struct frame *, Lisp_Object));
2666 extern void syms_of_xdisp P_ ((void));
2667 extern void init_xdisp P_ ((void));
2668 extern Lisp_Object safe_eval P_ ((Lisp_Object));
2669 extern int pos_visible_p P_ ((struct window *, int, int *,
2670 int *, int *, int *, int *, int *));
2672 /* Defined in xsettings.c */
2673 extern void syms_of_xsettings P_ ((void));
2675 /* Defined in vm-limit.c. */
2676 extern void memory_warnings P_ ((POINTER_TYPE *, void (*warnfun) ()));
2678 /* Defined in alloc.c */
2679 extern void check_pure_size P_ ((void));
2680 extern void allocate_string_data P_ ((struct Lisp_String *, int, int));
2681 extern void reset_malloc_hooks P_ ((void));
2682 extern void uninterrupt_malloc P_ ((void));
2683 extern void malloc_warning P_ ((char *));
2684 extern void memory_full P_ ((void)) NO_RETURN;
2685 extern void buffer_memory_full P_ ((void)) NO_RETURN;
2686 extern int survives_gc_p P_ ((Lisp_Object));
2687 extern void mark_object P_ ((Lisp_Object));
2688 extern Lisp_Object Vpurify_flag;
2689 extern Lisp_Object Vmemory_full;
2690 EXFUN (Fcons, 2);
2691 EXFUN (list1, 1);
2692 EXFUN (list2, 2);
2693 EXFUN (list3, 3);
2694 EXFUN (list4, 4);
2695 EXFUN (list5, 5);
2696 EXFUN (Flist, MANY);
2697 EXFUN (Fmake_list, 2);
2698 extern Lisp_Object allocate_misc P_ ((void));
2699 EXFUN (Fmake_vector, 2);
2700 EXFUN (Fvector, MANY);
2701 EXFUN (Fmake_symbol, 1);
2702 EXFUN (Fmake_marker, 0);
2703 EXFUN (Fmake_string, 2);
2704 extern Lisp_Object build_string P_ ((const char *));
2705 extern Lisp_Object make_string P_ ((const char *, int));
2706 extern Lisp_Object make_unibyte_string P_ ((const char *, int));
2707 extern Lisp_Object make_multibyte_string P_ ((const char *, int, int));
2708 extern Lisp_Object make_event_array P_ ((int, Lisp_Object *));
2709 extern Lisp_Object make_uninit_string P_ ((int));
2710 extern Lisp_Object make_uninit_multibyte_string P_ ((int, int));
2711 extern Lisp_Object make_string_from_bytes P_ ((const char *, int, int));
2712 extern Lisp_Object make_specified_string P_ ((const char *, int, int, int));
2713 EXFUN (Fpurecopy, 1);
2714 extern Lisp_Object make_pure_string P_ ((const char *, int, int, int));
2715 extern Lisp_Object make_pure_c_string (const char *data);
2716 extern Lisp_Object pure_cons P_ ((Lisp_Object, Lisp_Object));
2717 extern Lisp_Object make_pure_vector P_ ((EMACS_INT));
2718 EXFUN (Fgarbage_collect, 0);
2719 EXFUN (Fmake_byte_code, MANY);
2720 EXFUN (Fmake_bool_vector, 2);
2721 extern Lisp_Object Qchar_table_extra_slots;
2722 extern struct Lisp_Vector *allocate_vector P_ ((EMACS_INT));
2723 extern struct Lisp_Vector *allocate_pseudovector P_ ((int memlen, int lisplen, EMACS_INT tag));
2724 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2725 ((typ*) \
2726 allocate_pseudovector \
2727 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2728 extern struct Lisp_Hash_Table *allocate_hash_table P_ ((void));
2729 extern struct window *allocate_window P_ ((void));
2730 extern struct frame *allocate_frame P_ ((void));
2731 extern struct Lisp_Process *allocate_process P_ ((void));
2732 extern struct terminal *allocate_terminal P_ ((void));
2733 extern int gc_in_progress;
2734 extern int abort_on_gc;
2735 extern Lisp_Object make_float P_ ((double));
2736 extern void display_malloc_warning P_ ((void));
2737 extern int inhibit_garbage_collection P_ ((void));
2738 extern Lisp_Object make_save_value P_ ((void *, int));
2739 extern void free_misc P_ ((Lisp_Object));
2740 extern void free_marker P_ ((Lisp_Object));
2741 extern void free_cons P_ ((struct Lisp_Cons *));
2742 extern void init_alloc_once P_ ((void));
2743 extern void init_alloc P_ ((void));
2744 extern void syms_of_alloc P_ ((void));
2745 extern struct buffer * allocate_buffer P_ ((void));
2746 extern int valid_lisp_object_p P_ ((Lisp_Object));
2748 /* Defined in chartab.c */
2749 EXFUN (Fmake_char_table, 2);
2750 EXFUN (Fchar_table_parent, 1);
2751 EXFUN (Fset_char_table_parent, 2);
2752 EXFUN (Fchar_table_extra_slot, 2);
2753 EXFUN (Fset_char_table_extra_slot, 3);
2754 EXFUN (Fchar_table_range, 2);
2755 EXFUN (Fset_char_table_range, 3);
2756 EXFUN (Fset_char_table_default, 3);
2757 EXFUN (Foptimize_char_table, 2);
2758 EXFUN (Fmap_char_table, 2);
2759 extern Lisp_Object copy_char_table P_ ((Lisp_Object));
2760 extern Lisp_Object sub_char_table_ref P_ ((Lisp_Object, int));
2761 extern Lisp_Object char_table_ref P_ ((Lisp_Object, int));
2762 extern Lisp_Object char_table_ref_and_range P_ ((Lisp_Object, int,
2763 int *, int *));
2764 extern Lisp_Object char_table_set P_ ((Lisp_Object, int, Lisp_Object));
2765 extern Lisp_Object char_table_set_range P_ ((Lisp_Object, int, int,
2766 Lisp_Object));
2767 extern int char_table_translate P_ ((Lisp_Object, int));
2768 extern void map_char_table P_ ((void (*) (Lisp_Object, Lisp_Object,
2769 Lisp_Object),
2770 Lisp_Object, Lisp_Object, Lisp_Object));
2771 extern void syms_of_chartab P_ ((void));
2773 /* Defined in print.c */
2774 extern Lisp_Object Vprin1_to_string_buffer;
2775 extern void debug_print P_ ((Lisp_Object));
2776 EXFUN (Fprin1, 2);
2777 EXFUN (Fprin1_to_string, 2);
2778 EXFUN (Fprinc, 2);
2779 EXFUN (Fterpri, 1);
2780 EXFUN (Fprint, 2);
2781 EXFUN (Ferror_message_string, 1);
2782 extern Lisp_Object Vstandard_output, Qstandard_output;
2783 extern Lisp_Object Qexternal_debugging_output;
2784 extern void temp_output_buffer_setup P_ ((const char *));
2785 extern int print_level, print_escape_newlines;
2786 extern Lisp_Object Qprint_escape_newlines;
2787 extern void write_string P_ ((char *, int));
2788 extern void write_string_1 P_ ((char *, int, Lisp_Object));
2789 extern void print_error_message P_ ((Lisp_Object, Lisp_Object, char *, Lisp_Object));
2790 extern Lisp_Object internal_with_output_to_temp_buffer
2791 P_ ((const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object));
2792 extern void float_to_string P_ ((unsigned char *, double));
2793 extern void syms_of_print P_ ((void));
2795 /* Defined in doprnt.c */
2796 extern int doprnt P_ ((char *, int, char *, char *, int, char **));
2798 /* Defined in lread.c */
2799 extern Lisp_Object Qvariable_documentation, Qstandard_input;
2800 extern Lisp_Object Vobarray, initial_obarray, Vstandard_input;
2801 EXFUN (Fread, 1);
2802 EXFUN (Fread_from_string, 3);
2803 EXFUN (Fintern, 2);
2804 EXFUN (Fintern_soft, 2);
2805 EXFUN (Fload, 5);
2806 EXFUN (Fget_load_suffixes, 0);
2807 EXFUN (Fget_file_char, 0);
2808 EXFUN (Fread_char, 3);
2809 EXFUN (Fread_event, 3);
2810 extern Lisp_Object read_filtered_event P_ ((int, int, int, int, Lisp_Object));
2811 EXFUN (Feval_region, 4);
2812 extern Lisp_Object check_obarray P_ ((Lisp_Object));
2813 extern Lisp_Object intern P_ ((const char *));
2814 extern Lisp_Object intern_c_string (const char *);
2815 extern Lisp_Object make_symbol P_ ((char *));
2816 extern Lisp_Object oblookup P_ ((Lisp_Object, const char *, int, int));
2817 #define LOADHIST_ATTACH(x) \
2818 do { \
2819 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2820 } while (0)
2821 extern Lisp_Object Vcurrent_load_list;
2822 extern Lisp_Object Vload_history, Vload_suffixes, Vload_file_rep_suffixes;
2823 extern int openp P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
2824 Lisp_Object *, Lisp_Object));
2825 extern int isfloat_string P_ ((char *, int));
2826 extern void map_obarray P_ ((Lisp_Object, void (*) (Lisp_Object, Lisp_Object),
2827 Lisp_Object));
2828 extern void dir_warning P_ ((char *, Lisp_Object));
2829 extern void close_load_descs P_ ((void));
2830 extern void init_obarray P_ ((void));
2831 extern void init_lread P_ ((void));
2832 extern void syms_of_lread P_ ((void));
2834 /* Defined in eval.c */
2835 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
2836 extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
2837 extern Lisp_Object Vautoload_queue;
2838 extern Lisp_Object Vdebug_on_error;
2839 extern Lisp_Object Vsignaling_function;
2840 extern int handling_signal;
2841 extern int interactive_p P_ ((int));
2843 /* To run a normal hook, use the appropriate function from the list below.
2844 The calling convention:
2846 if (!NILP (Vrun_hooks))
2847 call1 (Vrun_hooks, Qmy_funny_hook);
2849 should no longer be used. */
2850 extern Lisp_Object Vrun_hooks;
2851 EXFUN (Frun_hooks, MANY);
2852 EXFUN (Frun_hook_with_args, MANY);
2853 EXFUN (Frun_hook_with_args_until_success, MANY);
2854 EXFUN (Frun_hook_with_args_until_failure, MANY);
2855 extern Lisp_Object run_hook_list_with_args P_ ((Lisp_Object, int, Lisp_Object *));
2856 extern void run_hook_with_args_2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2857 EXFUN (Fand, UNEVALLED);
2858 EXFUN (For, UNEVALLED);
2859 EXFUN (Fif, UNEVALLED);
2860 EXFUN (Fprogn, UNEVALLED);
2861 EXFUN (Fprog1, UNEVALLED);
2862 EXFUN (Fprog2, UNEVALLED);
2863 EXFUN (Fsetq, UNEVALLED);
2864 EXFUN (Fquote, UNEVALLED);
2865 EXFUN (Fuser_variable_p, 1);
2866 EXFUN (Finteractive_p, 0);
2867 EXFUN (Fdefun, UNEVALLED);
2868 EXFUN (Flet, UNEVALLED);
2869 EXFUN (FletX, UNEVALLED);
2870 EXFUN (Fwhile, UNEVALLED);
2871 EXFUN (Fcatch, UNEVALLED);
2872 EXFUN (Fthrow, 2) NO_RETURN;
2873 EXFUN (Funwind_protect, UNEVALLED);
2874 EXFUN (Fcondition_case, UNEVALLED);
2875 EXFUN (Fsignal, 2);
2876 extern void xsignal P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2877 extern void xsignal0 P_ ((Lisp_Object)) NO_RETURN;
2878 extern void xsignal1 P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2879 extern void xsignal2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object)) NO_RETURN;
2880 extern void xsignal3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)) NO_RETURN;
2881 extern void signal_error P_ ((char *, Lisp_Object)) NO_RETURN;
2882 EXFUN (Fautoload, 5);
2883 EXFUN (Fcommandp, 2);
2884 EXFUN (Feval, 1);
2885 EXFUN (Fapply, MANY);
2886 EXFUN (Ffuncall, MANY);
2887 EXFUN (Fbacktrace, 0);
2888 extern Lisp_Object apply1 P_ ((Lisp_Object, Lisp_Object));
2889 extern Lisp_Object call0 P_ ((Lisp_Object));
2890 extern Lisp_Object call1 P_ ((Lisp_Object, Lisp_Object));
2891 extern Lisp_Object call2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2892 extern Lisp_Object call3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2893 extern Lisp_Object call4 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2894 extern Lisp_Object call5 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2895 extern Lisp_Object call6 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2896 extern Lisp_Object call7 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2897 EXFUN (Fdo_auto_save, 2);
2898 extern Lisp_Object apply_lambda P_ ((Lisp_Object, Lisp_Object, int));
2899 extern Lisp_Object internal_catch P_ ((Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object));
2900 extern Lisp_Object internal_lisp_condition_case P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2901 extern Lisp_Object internal_condition_case P_ ((Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2902 extern Lisp_Object internal_condition_case_1 P_ ((Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2903 extern Lisp_Object internal_condition_case_2 P_ ((Lisp_Object (*) (Lisp_Object, Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2904 extern Lisp_Object internal_condition_case_n P_ ((Lisp_Object (*) (int, Lisp_Object *), int, Lisp_Object *, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2905 extern void specbind P_ ((Lisp_Object, Lisp_Object));
2906 extern void record_unwind_protect P_ ((Lisp_Object (*) (Lisp_Object), Lisp_Object));
2907 extern Lisp_Object unbind_to P_ ((int, Lisp_Object));
2908 extern void error P_ ((/* char *, ... */)) NO_RETURN;
2909 extern void do_autoload P_ ((Lisp_Object, Lisp_Object));
2910 extern Lisp_Object un_autoload P_ ((Lisp_Object));
2911 EXFUN (Ffetch_bytecode, 1);
2912 extern void init_eval_once P_ ((void));
2913 extern Lisp_Object safe_call P_ ((int, Lisp_Object *));
2914 extern Lisp_Object safe_call1 P_ ((Lisp_Object, Lisp_Object));
2915 extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2916 extern void init_eval P_ ((void));
2917 extern void syms_of_eval P_ ((void));
2919 /* Defined in editfns.c */
2920 EXFUN (Fpropertize, MANY);
2921 EXFUN (Fcurrent_message, 0);
2922 EXFUN (Fgoto_char, 1);
2923 EXFUN (Fpoint_min_marker, 0);
2924 EXFUN (Fpoint_max_marker, 0);
2925 EXFUN (Fpoint_min, 0);
2926 EXFUN (Fpoint_max, 0);
2927 EXFUN (Fpoint, 0);
2928 EXFUN (Fpoint_marker, 0);
2929 EXFUN (Fmark_marker, 0);
2930 EXFUN (Fline_beginning_position, 1);
2931 EXFUN (Fline_end_position, 1);
2932 EXFUN (Ffollowing_char, 0);
2933 EXFUN (Fprevious_char, 0);
2934 EXFUN (Fchar_after, 1);
2935 EXFUN (Finsert, MANY);
2936 EXFUN (Finsert_and_inherit, MANY);
2937 EXFUN (Finsert_before_markers, MANY);
2938 EXFUN (Finsert_buffer_substring, 3);
2939 EXFUN (Finsert_char, 3);
2940 extern void insert1 P_ ((Lisp_Object));
2941 EXFUN (Feolp, 0);
2942 EXFUN (Feobp, 0);
2943 EXFUN (Fbolp, 0);
2944 EXFUN (Fbobp, 0);
2945 EXFUN (Fformat, MANY);
2946 EXFUN (Fmessage, MANY);
2947 extern Lisp_Object format2 P_ ((char *, Lisp_Object, Lisp_Object));
2948 EXFUN (Fbuffer_substring, 2);
2949 EXFUN (Fbuffer_string, 0);
2950 extern Lisp_Object save_excursion_save P_ ((void));
2951 extern Lisp_Object save_restriction_save P_ ((void));
2952 extern Lisp_Object save_excursion_restore P_ ((Lisp_Object));
2953 extern Lisp_Object save_restriction_restore P_ ((Lisp_Object));
2954 EXFUN (Fchar_to_string, 1);
2955 EXFUN (Fdelete_region, 2);
2956 EXFUN (Fnarrow_to_region, 2);
2957 EXFUN (Fwiden, 0);
2958 EXFUN (Fuser_login_name, 1);
2959 EXFUN (Fsystem_name, 0);
2960 EXFUN (Fcurrent_time, 0);
2961 extern int clip_to_bounds P_ ((int, int, int));
2962 extern Lisp_Object make_buffer_string P_ ((int, int, int));
2963 extern Lisp_Object make_buffer_string_both P_ ((int, int, int, int, int));
2964 extern void init_editfns P_ ((void));
2965 extern void syms_of_editfns P_ ((void));
2966 extern Lisp_Object Vinhibit_field_text_motion;
2967 EXFUN (Fconstrain_to_field, 5);
2968 EXFUN (Ffield_string, 1);
2969 EXFUN (Fdelete_field, 1);
2970 EXFUN (Ffield_beginning, 3);
2971 EXFUN (Ffield_end, 3);
2972 EXFUN (Ffield_string_no_properties, 1);
2973 extern void set_time_zone_rule P_ ((char *));
2975 /* defined in buffer.c */
2976 extern int mouse_face_overlay_overlaps P_ ((Lisp_Object));
2977 extern void nsberror P_ ((Lisp_Object)) NO_RETURN;
2978 EXFUN (Fset_buffer_multibyte, 1);
2979 EXFUN (Foverlay_start, 1);
2980 EXFUN (Foverlay_end, 1);
2981 EXFUN (Foverlay_buffer, 1);
2982 extern void adjust_overlays_for_insert P_ ((EMACS_INT, EMACS_INT));
2983 extern void adjust_overlays_for_delete P_ ((EMACS_INT, EMACS_INT));
2984 extern void fix_start_end_in_overlays P_ ((int, int));
2985 extern void report_overlay_modification P_ ((Lisp_Object, Lisp_Object, int,
2986 Lisp_Object, Lisp_Object, Lisp_Object));
2987 extern int overlay_touches_p P_ ((int));
2988 extern Lisp_Object Vbuffer_alist, Vinhibit_read_only;
2989 EXFUN (Fbuffer_list, 1);
2990 EXFUN (Fget_buffer, 1);
2991 EXFUN (Fget_buffer_create, 1);
2992 EXFUN (Fgenerate_new_buffer_name, 2);
2993 EXFUN (Fset_buffer, 1);
2994 EXFUN (set_buffer_if_live, 1);
2995 EXFUN (Fbarf_if_buffer_read_only, 0);
2996 EXFUN (Fcurrent_buffer, 0);
2997 EXFUN (Fswitch_to_buffer, 2);
2998 EXFUN (Fother_buffer, 3);
2999 EXFUN (Foverlay_get, 2);
3000 EXFUN (Fbuffer_modified_p, 1);
3001 EXFUN (Fset_buffer_modified_p, 1);
3002 EXFUN (Fkill_buffer, 1);
3003 EXFUN (Fkill_all_local_variables, 0);
3004 EXFUN (Fbuffer_disable_undo, 1);
3005 EXFUN (Fbuffer_enable_undo, 1);
3006 EXFUN (Ferase_buffer, 0);
3007 extern Lisp_Object Qoverlayp;
3008 extern Lisp_Object Qevaporate;
3009 extern Lisp_Object get_truename_buffer P_ ((Lisp_Object));
3010 extern struct buffer *all_buffers;
3011 EXFUN (Fprevious_overlay_change, 1);
3012 EXFUN (Fbuffer_file_name, 1);
3013 extern void init_buffer_once P_ ((void));
3014 extern void init_buffer P_ ((void));
3015 extern void syms_of_buffer P_ ((void));
3016 extern void keys_of_buffer P_ ((void));
3018 /* defined in marker.c */
3020 EXFUN (Fmarker_position, 1);
3021 EXFUN (Fmarker_buffer, 1);
3022 EXFUN (Fcopy_marker, 2);
3023 EXFUN (Fset_marker, 3);
3024 extern int marker_position P_ ((Lisp_Object));
3025 extern int marker_byte_position P_ ((Lisp_Object));
3026 extern void clear_charpos_cache P_ ((struct buffer *));
3027 extern int charpos_to_bytepos P_ ((int));
3028 extern int buf_charpos_to_bytepos P_ ((struct buffer *, int));
3029 extern int buf_bytepos_to_charpos P_ ((struct buffer *, int));
3030 extern void unchain_marker P_ ((struct Lisp_Marker *marker));
3031 extern Lisp_Object set_marker_restricted P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
3032 extern Lisp_Object set_marker_both P_ ((Lisp_Object, Lisp_Object, int, int));
3033 extern Lisp_Object set_marker_restricted_both P_ ((Lisp_Object, Lisp_Object,
3034 int, int));
3035 extern void syms_of_marker P_ ((void));
3037 /* Defined in fileio.c */
3039 extern Lisp_Object Qfile_error;
3040 EXFUN (Ffind_file_name_handler, 2);
3041 EXFUN (Ffile_name_as_directory, 1);
3042 EXFUN (Fmake_temp_name, 1);
3043 EXFUN (Fexpand_file_name, 2);
3044 EXFUN (Ffile_name_nondirectory, 1);
3045 EXFUN (Fsubstitute_in_file_name, 1);
3046 EXFUN (Ffile_symlink_p, 1);
3047 EXFUN (Fverify_visited_file_modtime, 1);
3048 EXFUN (Ffile_exists_p, 1);
3049 EXFUN (Ffile_name_absolute_p, 1);
3050 EXFUN (Fdirectory_file_name, 1);
3051 EXFUN (Ffile_name_directory, 1);
3052 extern Lisp_Object expand_and_dir_to_file P_ ((Lisp_Object, Lisp_Object));
3053 EXFUN (Ffile_accessible_directory_p, 1);
3054 EXFUN (Funhandled_file_name_directory, 1);
3055 EXFUN (Ffile_directory_p, 1);
3056 EXFUN (Fwrite_region, 7);
3057 EXFUN (Ffile_readable_p, 1);
3058 EXFUN (Ffile_executable_p, 1);
3059 EXFUN (Fread_file_name, 6);
3060 extern Lisp_Object close_file_unwind P_ ((Lisp_Object));
3061 extern Lisp_Object restore_point_unwind P_ ((Lisp_Object));
3062 extern void report_file_error P_ ((const char *, Lisp_Object)) NO_RETURN;
3063 extern int internal_delete_file P_ ((Lisp_Object));
3064 extern void syms_of_fileio P_ ((void));
3065 extern Lisp_Object make_temp_name P_ ((Lisp_Object, int));
3066 EXFUN (Fmake_symbolic_link, 3);
3067 extern Lisp_Object Qdelete_file;
3069 /* Defined in abbrev.c */
3071 extern void syms_of_abbrev P_ ((void));
3073 /* defined in search.c */
3074 extern void shrink_regexp_cache P_ ((void));
3075 EXFUN (Fstring_match, 3);
3076 extern void restore_search_regs P_ ((void));
3077 EXFUN (Fmatch_data, 3);
3078 EXFUN (Fset_match_data, 2);
3079 EXFUN (Fmatch_beginning, 1);
3080 EXFUN (Fmatch_end, 1);
3081 extern void record_unwind_save_match_data P_ ((void));
3082 EXFUN (Flooking_at, 1);
3083 extern int fast_string_match P_ ((Lisp_Object, Lisp_Object));
3084 extern int fast_c_string_match_ignore_case P_ ((Lisp_Object, const char *));
3085 extern int fast_string_match_ignore_case P_ ((Lisp_Object, Lisp_Object));
3086 extern EMACS_INT fast_looking_at P_ ((Lisp_Object, EMACS_INT, EMACS_INT,
3087 EMACS_INT, EMACS_INT, Lisp_Object));
3088 extern int scan_buffer P_ ((int, EMACS_INT, EMACS_INT, int, int *, int));
3089 extern int scan_newline P_ ((EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
3090 int, int));
3091 extern int find_next_newline P_ ((EMACS_INT, int));
3092 extern int find_next_newline_no_quit P_ ((EMACS_INT, int));
3093 extern int find_before_next_newline P_ ((EMACS_INT, EMACS_INT, int));
3094 extern void syms_of_search P_ ((void));
3095 extern void clear_regexp_cache P_ ((void));
3097 /* defined in minibuf.c */
3099 extern Lisp_Object last_minibuf_string;
3100 extern void choose_minibuf_frame P_ ((void));
3101 EXFUN (Fcompleting_read, 8);
3102 EXFUN (Fread_from_minibuffer, 7);
3103 EXFUN (Fread_variable, 2);
3104 EXFUN (Fread_buffer, 3);
3105 EXFUN (Fread_minibuffer, 2);
3106 EXFUN (Feval_minibuffer, 2);
3107 EXFUN (Fread_string, 5);
3108 EXFUN (Fread_no_blanks_input, 3);
3109 EXFUN (Fassoc_string, 3);
3110 extern Lisp_Object get_minibuffer P_ ((int));
3111 extern void temp_echo_area_glyphs P_ ((Lisp_Object));
3112 extern void init_minibuf_once P_ ((void));
3113 extern void syms_of_minibuf P_ ((void));
3115 /* Defined in callint.c */
3117 extern Lisp_Object Qminus, Qplus, Vcurrent_prefix_arg;
3118 extern Lisp_Object Vcommand_history;
3119 extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
3120 EXFUN (Fcall_interactively, 3);
3121 EXFUN (Fprefix_numeric_value, 1);
3122 extern void syms_of_callint P_ ((void));
3124 /* defined in casefiddle.c */
3126 EXFUN (Fdowncase, 1);
3127 EXFUN (Fupcase, 1);
3128 EXFUN (Fcapitalize, 1);
3129 EXFUN (Fupcase_region, 2);
3130 EXFUN (Fupcase_initials, 1);
3131 EXFUN (Fupcase_initials_region, 2);
3132 extern void syms_of_casefiddle P_ ((void));
3133 extern void keys_of_casefiddle P_ ((void));
3135 /* defined in casetab.c */
3137 EXFUN (Fset_case_table, 1);
3138 EXFUN (Fset_standard_case_table, 1);
3139 extern void init_casetab_once P_ ((void));
3140 extern void syms_of_casetab P_ ((void));
3142 /* defined in keyboard.c */
3144 extern int echoing;
3145 extern Lisp_Object echo_message_buffer;
3146 extern struct kboard *echo_kboard;
3147 extern void cancel_echoing P_ ((void));
3148 extern Lisp_Object Qdisabled, QCfilter;
3149 extern Lisp_Object Vtty_erase_char, Vhelp_form, Vtop_level;
3150 extern Lisp_Object Vthrow_on_input;
3151 extern int input_pending;
3152 EXFUN (Fdiscard_input, 0);
3153 EXFUN (Frecursive_edit, 0);
3154 EXFUN (Ftop_level, 0);
3155 EXFUN (Fcommand_execute, 4);
3156 EXFUN (Finput_pending_p, 0);
3157 extern Lisp_Object menu_bar_items P_ ((Lisp_Object));
3158 extern Lisp_Object tool_bar_items P_ ((Lisp_Object, int *));
3159 extern Lisp_Object Qvertical_scroll_bar;
3160 extern void discard_mouse_events P_ ((void));
3161 EXFUN (Fevent_convert_list, 1);
3162 EXFUN (Fread_key_sequence, 5);
3163 EXFUN (Fset_input_interrupt_mode, 1);
3164 EXFUN (Fset_output_flow_control, 2);
3165 EXFUN (Fset_input_meta_mode, 2);
3166 EXFUN (Fset_quit_char, 1);
3167 EXFUN (Fset_input_mode, 4);
3168 extern Lisp_Object pending_funcalls;
3169 extern int detect_input_pending P_ ((void));
3170 extern int detect_input_pending_ignore_squeezables P_ ((void));
3171 extern int detect_input_pending_run_timers P_ ((int));
3172 extern void safe_run_hooks P_ ((Lisp_Object));
3173 extern void cmd_error_internal P_ ((Lisp_Object, char *));
3174 extern Lisp_Object command_loop_1 P_ ((void));
3175 extern Lisp_Object recursive_edit_1 P_ ((void));
3176 extern void record_auto_save P_ ((void));
3177 extern void init_keyboard P_ ((void));
3178 extern void syms_of_keyboard P_ ((void));
3179 extern void keys_of_keyboard P_ ((void));
3180 extern char *push_key_description P_ ((unsigned int, char *, int));
3183 /* defined in indent.c */
3184 EXFUN (Fvertical_motion, 2);
3185 EXFUN (Findent_to, 2);
3186 EXFUN (Fcurrent_column, 0);
3187 EXFUN (Fmove_to_column, 2);
3188 extern double current_column P_ ((void));
3189 extern void invalidate_current_column P_ ((void));
3190 extern int indented_beyond_p P_ ((int, int, double));
3191 extern void syms_of_indent P_ ((void));
3193 /* defined in frame.c */
3194 #ifdef HAVE_WINDOW_SYSTEM
3195 extern Lisp_Object Vx_resource_name;
3196 extern Lisp_Object Vx_resource_class;
3197 #endif /* HAVE_WINDOW_SYSTEM */
3198 extern Lisp_Object Qvisible;
3199 extern void store_frame_param P_ ((struct frame *, Lisp_Object, Lisp_Object));
3200 extern void store_in_alist P_ ((Lisp_Object *, Lisp_Object, Lisp_Object));
3201 extern Lisp_Object do_switch_frame P_ ((Lisp_Object, int, int, Lisp_Object));
3202 extern Lisp_Object get_frame_param P_ ((struct frame *, Lisp_Object));
3203 extern Lisp_Object frame_buffer_predicate P_ ((Lisp_Object));
3204 EXFUN (Fframep, 1);
3205 EXFUN (Fselect_frame, 2);
3206 EXFUN (Fselected_frame, 0);
3207 EXFUN (Fwindow_frame, 1);
3208 EXFUN (Fframe_root_window, 1);
3209 EXFUN (Fframe_first_window, 1);
3210 EXFUN (Fframe_selected_window, 1);
3211 EXFUN (Fframe_list, 0);
3212 EXFUN (Fnext_frame, 2);
3213 EXFUN (Fdelete_frame, 2);
3214 EXFUN (Fset_mouse_position, 3);
3215 EXFUN (Fmake_frame_visible, 1);
3216 EXFUN (Fmake_frame_invisible, 2);
3217 EXFUN (Ficonify_frame, 1);
3218 EXFUN (Fframe_visible_p, 1);
3219 EXFUN (Fvisible_frame_list, 0);
3220 EXFUN (Fframe_parameter, 2);
3221 EXFUN (Fframe_parameters, 1);
3222 EXFUN (Fmodify_frame_parameters, 2);
3223 EXFUN (Fset_frame_height, 3);
3224 EXFUN (Fset_frame_width, 3);
3225 EXFUN (Fset_frame_size, 3);
3226 EXFUN (Fset_frame_position, 3);
3227 EXFUN (Fraise_frame, 1);
3228 EXFUN (Fredirect_frame_focus, 2);
3229 EXFUN (Fset_frame_selected_window, 3);
3230 extern Lisp_Object frame_buffer_list P_ ((Lisp_Object));
3231 extern void frames_discard_buffer P_ ((Lisp_Object));
3232 extern void set_frame_buffer_list P_ ((Lisp_Object, Lisp_Object));
3233 extern void frames_bury_buffer P_ ((Lisp_Object));
3234 extern void syms_of_frame P_ ((void));
3236 /* defined in emacs.c */
3237 extern Lisp_Object decode_env_path P_ ((char *, char *));
3238 extern Lisp_Object Vinvocation_name, Vinvocation_directory;
3239 extern Lisp_Object Vbefore_init_time, Vafter_init_time;
3240 extern Lisp_Object Vinstallation_directory;
3241 extern Lisp_Object empty_unibyte_string, empty_multibyte_string;
3242 EXFUN (Fkill_emacs, 1);
3243 #if HAVE_SETLOCALE
3244 void fixup_locale P_ ((void));
3245 void synchronize_system_messages_locale P_ ((void));
3246 void synchronize_system_time_locale P_ ((void));
3247 #else
3248 #define setlocale(category, locale)
3249 #define fixup_locale()
3250 #define synchronize_system_messages_locale()
3251 #define synchronize_system_time_locale()
3252 #endif
3253 void shut_down_emacs P_ ((int, int, Lisp_Object));
3254 /* Nonzero means don't do interactive redisplay and don't change tty modes */
3255 extern int noninteractive;
3257 /* Nonzero means don't load X resources or Windows Registry settings. */
3258 extern int inhibit_x_resources;
3260 /* Pipe used to send exit notification to the daemon parent at
3261 startup. */
3262 extern int daemon_pipe[2];
3263 #define IS_DAEMON (daemon_pipe[1] != 0)
3265 /* Nonzero means don't do use window-system-specific display code */
3266 extern int inhibit_window_system;
3267 /* Nonzero means that a filter or a sentinel is running. */
3268 extern int running_asynch_code;
3270 /* defined in process.c */
3271 EXFUN (Fget_process, 1);
3272 EXFUN (Fget_buffer_process, 1);
3273 EXFUN (Fprocessp, 1);
3274 EXFUN (Fprocess_status, 1);
3275 EXFUN (Fkill_process, 2);
3276 EXFUN (Fprocess_send_eof, 1);
3277 EXFUN (Fwaiting_for_user_input_p, 0);
3278 extern Lisp_Object Qprocessp;
3279 extern void kill_buffer_processes P_ ((Lisp_Object));
3280 extern int wait_reading_process_output P_ ((int, int, int, int,
3281 Lisp_Object,
3282 struct Lisp_Process *,
3283 int));
3284 extern void add_keyboard_wait_descriptor P_ ((int));
3285 extern void delete_keyboard_wait_descriptor P_ ((int));
3286 extern void add_gpm_wait_descriptor P_ ((int));
3287 extern void delete_gpm_wait_descriptor P_ ((int));
3288 extern void close_process_descs P_ ((void));
3289 extern void init_process P_ ((void));
3290 extern void syms_of_process P_ ((void));
3291 extern void setup_process_coding_systems P_ ((Lisp_Object));
3293 /* defined in callproc.c */
3294 extern Lisp_Object Vexec_path, Vexec_suffixes,
3295 Vexec_directory, Vdata_directory;
3296 extern Lisp_Object Vdoc_directory;
3297 EXFUN (Fcall_process, MANY);
3298 extern int child_setup P_ ((int, int, int, char **, int, Lisp_Object));
3299 extern void init_callproc_1 P_ ((void));
3300 extern void init_callproc P_ ((void));
3301 extern void set_initial_environment P_ ((void));
3302 extern void syms_of_callproc P_ ((void));
3304 /* defined in doc.c */
3305 extern Lisp_Object Vdoc_file_name;
3306 EXFUN (Fsubstitute_command_keys, 1);
3307 EXFUN (Fdocumentation, 2);
3308 EXFUN (Fdocumentation_property, 3);
3309 extern Lisp_Object read_doc_string P_ ((Lisp_Object));
3310 extern Lisp_Object get_doc_string P_ ((Lisp_Object, int, int));
3311 extern void syms_of_doc P_ ((void));
3312 extern int read_bytecode_char P_ ((int));
3314 /* defined in bytecode.c */
3315 extern Lisp_Object Qbytecode;
3316 EXFUN (Fbyte_code, 3);
3317 extern void syms_of_bytecode P_ ((void));
3318 extern struct byte_stack *byte_stack_list;
3319 extern void mark_byte_stack P_ ((void));
3320 extern void unmark_byte_stack P_ ((void));
3322 /* defined in macros.c */
3323 extern Lisp_Object Qexecute_kbd_macro;
3324 EXFUN (Fexecute_kbd_macro, 3);
3325 EXFUN (Fcancel_kbd_macro_events, 0);
3326 extern void init_macros P_ ((void));
3327 extern void syms_of_macros P_ ((void));
3329 /* defined in undo.c */
3330 extern Lisp_Object Qinhibit_read_only;
3331 EXFUN (Fundo_boundary, 0);
3332 extern void truncate_undo_list P_ ((struct buffer *));
3333 extern void record_marker_adjustment P_ ((Lisp_Object, int));
3334 extern void record_insert P_ ((int, int));
3335 extern void record_delete P_ ((int, Lisp_Object));
3336 extern void record_first_change P_ ((void));
3337 extern void record_change P_ ((int, int));
3338 extern void record_property_change P_ ((int, int, Lisp_Object, Lisp_Object,
3339 Lisp_Object));
3340 extern void syms_of_undo P_ ((void));
3341 extern Lisp_Object Vundo_outer_limit;
3343 /* defined in textprop.c */
3344 extern Lisp_Object Qfont, Qmouse_face;
3345 extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
3346 EXFUN (Fnext_single_property_change, 4);
3347 EXFUN (Fnext_single_char_property_change, 4);
3348 EXFUN (Fprevious_single_property_change, 4);
3349 EXFUN (Fget_text_property, 3);
3350 EXFUN (Fput_text_property, 5);
3351 EXFUN (Fget_text_property, 3);
3352 EXFUN (Fprevious_char_property_change, 2);
3353 EXFUN (Fnext_char_property_change, 2);
3354 extern void report_interval_modification P_ ((Lisp_Object, Lisp_Object));
3355 extern Lisp_Object next_single_char_property_change P_ ((Lisp_Object,
3356 Lisp_Object,
3357 Lisp_Object,
3358 Lisp_Object));
3360 /* defined in menu.c */
3361 extern void syms_of_menu P_ ((void));
3363 /* defined in xmenu.c */
3364 EXFUN (Fx_popup_menu, 2);
3365 EXFUN (Fx_popup_dialog, 3);
3366 extern void syms_of_xmenu P_ ((void));
3368 /* defined in termchar.h */
3369 struct tty_display_info;
3371 /* defined in termhooks.h */
3372 struct terminal;
3374 /* defined in sysdep.c */
3375 #ifndef HAVE_GET_CURRENT_DIR_NAME
3376 extern char *get_current_dir_name P_ ((void));
3377 #endif
3378 extern void stuff_char P_ ((char c));
3379 extern void init_sigio P_ ((int));
3380 extern void sys_subshell P_ ((void));
3381 extern void sys_suspend P_ ((void));
3382 extern void discard_tty_input P_ ((void));
3383 extern void init_sys_modes P_ ((struct tty_display_info *));
3384 extern void reset_sys_modes P_ ((struct tty_display_info *));
3385 extern void init_all_sys_modes P_ ((void));
3386 extern void reset_all_sys_modes P_ ((void));
3387 extern void wait_for_termination P_ ((int));
3388 extern void flush_pending_output P_ ((int));
3389 extern void child_setup_tty P_ ((int));
3390 extern void setup_pty P_ ((int));
3391 extern int set_window_size P_ ((int, int, int));
3392 extern void create_process P_ ((Lisp_Object, char **, Lisp_Object));
3393 extern int emacs_open P_ ((const char *, int, int));
3394 extern int emacs_close P_ ((int));
3395 extern int emacs_read P_ ((int, char *, unsigned int));
3396 extern int emacs_write P_ ((int, const char *, unsigned int));
3398 /* defined in filelock.c */
3399 EXFUN (Funlock_buffer, 0);
3400 EXFUN (Ffile_locked_p, 1);
3401 extern void unlock_all_files P_ ((void));
3402 extern void lock_file P_ ((Lisp_Object));
3403 extern void unlock_file P_ ((Lisp_Object));
3404 extern void unlock_buffer P_ ((struct buffer *));
3405 extern void syms_of_filelock P_ ((void));
3406 extern void init_filelock P_ ((void));
3408 /* Defined in sound.c */
3409 extern void syms_of_sound P_ ((void));
3410 extern void init_sound P_ ((void));
3412 /* Defined in category.c */
3413 extern void init_category_once P_ ((void));
3414 extern Lisp_Object char_category_set P_ ((int));
3415 extern void syms_of_category P_ ((void));
3417 /* Defined in ccl.c */
3418 extern void syms_of_ccl P_ ((void));
3420 /* Defined in dired.c */
3421 EXFUN (Ffile_attributes, 2);
3422 extern void syms_of_dired P_ ((void));
3423 extern Lisp_Object directory_files_internal P_ ((Lisp_Object, Lisp_Object,
3424 Lisp_Object, Lisp_Object,
3425 int, Lisp_Object));
3427 /* Defined in term.c */
3428 extern void syms_of_term P_ ((void));
3429 extern void fatal P_ ((const char *msgid, ...)) NO_RETURN;
3431 /* Defined in terminal.c */
3432 EXFUN (Fframe_terminal, 1);
3433 EXFUN (Fdelete_terminal, 2);
3434 extern void syms_of_terminal P_ ((void));
3436 /* Defined in font.c */
3437 extern void syms_of_font P_ ((void));
3438 extern void init_font P_ ((void));
3440 #ifdef HAVE_WINDOW_SYSTEM
3441 /* Defined in fontset.c */
3442 extern void syms_of_fontset P_ ((void));
3443 EXFUN (Fset_fontset_font, 5);
3444 EXFUN (Fnew_fontset, 2);
3446 /* Defined in xfns.c, w32fns.c, or macfns.c */
3447 EXFUN (Fxw_display_color_p, 1);
3448 EXFUN (Fx_file_dialog, 5);
3449 EXFUN (Fx_focus_frame, 1);
3450 #endif
3452 /* Defined in xfaces.c */
3453 EXFUN (Fclear_face_cache, 1);
3454 EXFUN (Fx_load_color_file, 1);
3455 extern void syms_of_xfaces P_ ((void));
3457 #ifndef HAVE_GETLOADAVG
3458 /* Defined in getloadavg.c */
3459 extern int getloadavg P_ ((double *, int));
3460 #endif
3462 #ifdef HAVE_X_WINDOWS
3463 /* Defined in xfns.c */
3464 extern void syms_of_xfns P_ ((void));
3466 /* Defined in xsmfns.c */
3467 extern void syms_of_xsmfns P_ ((void));
3469 /* Defined in xselect.c */
3470 EXFUN (Fx_send_client_event, 6);
3471 extern void syms_of_xselect P_ ((void));
3473 /* Defined in xterm.c */
3474 extern void syms_of_xterm P_ ((void));
3475 #endif /* HAVE_X_WINDOWS */
3477 #ifdef MSDOS
3478 /* Defined in msdos.c */
3479 EXFUN (Fmsdos_downcase_filename, 1);
3480 #endif
3482 #ifdef HAVE_MENUS
3483 /* Defined in (x|w32)fns.c, nsfns.m... */
3484 extern int have_menus_p P_ ((void));
3485 #endif
3487 #ifdef HAVE_DBUS
3488 /* Defined in dbusbind.c */
3489 int xd_pending_messages P_ ((void));
3490 void xd_read_queued_messages P_ ((void));
3491 void syms_of_dbusbind P_ ((void));
3492 #endif
3494 /* Nonzero means Emacs has already been initialized.
3495 Used during startup to detect startup of dumped Emacs. */
3496 extern int initialized;
3498 extern int immediate_quit; /* Nonzero means ^G can quit instantly */
3500 extern POINTER_TYPE *xmalloc P_ ((size_t));
3501 extern POINTER_TYPE *xrealloc P_ ((POINTER_TYPE *, size_t));
3502 extern void xfree P_ ((POINTER_TYPE *));
3504 extern char *xstrdup P_ ((const char *));
3506 extern char *egetenv P_ ((char *));
3508 /* Set up the name of the machine we're running on. */
3509 extern void init_system_name P_ ((void));
3511 /* Some systems (e.g., NT) use a different path separator than Unix,
3512 in addition to a device separator. Default the path separator
3513 to '/', and don't test for a device separator in IS_ANY_SEP. */
3515 #ifdef WINDOWSNT
3516 extern Lisp_Object Vdirectory_sep_char;
3517 #endif
3519 #ifndef DIRECTORY_SEP
3520 #define DIRECTORY_SEP '/'
3521 #endif
3522 #ifndef IS_DIRECTORY_SEP
3523 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3524 #endif
3525 #ifndef IS_DEVICE_SEP
3526 #ifndef DEVICE_SEP
3527 #define IS_DEVICE_SEP(_c_) 0
3528 #else
3529 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3530 #endif
3531 #endif
3532 #ifndef IS_ANY_SEP
3533 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3534 #endif
3536 #define SWITCH_ENUM_CAST(x) (x)
3538 /* Loop over Lisp list LIST. Signal an error if LIST is not a proper
3539 list, or if it contains circles.
3541 HARE and TORTOISE should be the names of Lisp_Object variables, and
3542 N should be the name of an EMACS_INT variable declared in the
3543 function where the macro is used. Each nested loop should use
3544 its own variables.
3546 In the loop body, HARE is set to each cons of LIST, and N is the
3547 length of the list processed so far. */
3549 #define LIST_END_P(list, obj) \
3550 (NILP (obj) \
3551 ? 1 \
3552 : (CONSP (obj) \
3553 ? 0 \
3554 : (wrong_type_argument (Qlistp, (list))), 1))
3556 #define FOREACH(hare, list, tortoise, n) \
3557 for (tortoise = hare = (list), n = 0; \
3558 !LIST_END_P (list, hare); \
3559 (hare = XCDR (hare), ++n, \
3560 ((n & 1) != 0 \
3561 ? (tortoise = XCDR (tortoise), \
3562 (EQ (hare, tortoise) \
3563 && (circular_list_error ((list)), 1))) \
3564 : 0)))
3566 /* The ubiquitous min and max macros. */
3568 #ifdef max
3569 #undef max
3570 #undef min
3571 #endif
3572 #define min(a, b) ((a) < (b) ? (a) : (b))
3573 #define max(a, b) ((a) > (b) ? (a) : (b))
3575 /* We used to use `abs', but that clashes with system headers on some
3576 platforms, and using a name reserved by Standard C is a bad idea
3577 anyway. */
3578 #if !defined(eabs)
3579 #define eabs(x) ((x) < 0 ? -(x) : (x))
3580 #endif
3582 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3583 fixnum. */
3585 #define make_fixnum_or_float(val) \
3586 (FIXNUM_OVERFLOW_P (val) \
3587 ? make_float (val) \
3588 : make_number ((EMACS_INT)(val)))
3591 /* Checks the `cycle check' variable CHECK to see if it indicates that
3592 EL is part of a cycle; CHECK must be either Qnil or a value returned
3593 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3594 elements after which a cycle might be suspected; after that many
3595 elements, this macro begins consing in order to keep more precise
3596 track of elements.
3598 Returns nil if a cycle was detected, otherwise a new value for CHECK
3599 that includes EL.
3601 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3602 the caller should make sure that's ok. */
3604 #define CYCLE_CHECK(check, el, suspicious) \
3605 (NILP (check) \
3606 ? make_number (0) \
3607 : (INTEGERP (check) \
3608 ? (XFASTINT (check) < (suspicious) \
3609 ? make_number (XFASTINT (check) + 1) \
3610 : Fcons (el, Qnil)) \
3611 : (!NILP (Fmemq ((el), (check))) \
3612 ? Qnil \
3613 : Fcons ((el), (check)))))
3616 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3617 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3619 #define MAX_ALLOCA 16*1024
3621 extern Lisp_Object safe_alloca_unwind (Lisp_Object);
3623 #define USE_SAFE_ALLOCA \
3624 int sa_count = SPECPDL_INDEX (), sa_must_free = 0
3626 /* SAFE_ALLOCA allocates a simple buffer. */
3628 #define SAFE_ALLOCA(buf, type, size) \
3629 do { \
3630 if ((size) < MAX_ALLOCA) \
3631 buf = (type) alloca (size); \
3632 else \
3634 buf = (type) xmalloc (size); \
3635 sa_must_free++; \
3636 record_unwind_protect (safe_alloca_unwind, \
3637 make_save_value (buf, 0)); \
3639 } while (0)
3641 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3643 #define SAFE_FREE() \
3644 do { \
3645 if (sa_must_free) { \
3646 sa_must_free = 0; \
3647 unbind_to (sa_count, Qnil); \
3649 } while (0)
3652 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3654 #define SAFE_ALLOCA_LISP(buf, nelt) \
3655 do { \
3656 int size_ = (nelt) * sizeof (Lisp_Object); \
3657 if (size_ < MAX_ALLOCA) \
3658 buf = (Lisp_Object *) alloca (size_); \
3659 else \
3661 Lisp_Object arg_; \
3662 buf = (Lisp_Object *) xmalloc (size_); \
3663 arg_ = make_save_value (buf, nelt); \
3664 XSAVE_VALUE (arg_)->dogc = 1; \
3665 sa_must_free++; \
3666 record_unwind_protect (safe_alloca_unwind, arg_); \
3668 } while (0)
3671 #endif /* EMACS_LISP_H */
3673 /* arch-tag: 9b2ed020-70eb-47ac-94ee-e1c2a5107d5e
3674 (do not change this comment) */