Mutex object initial implementation.
[emacs.git] / src / lisp.h
blobd4392bc7eabfbdbc0c94fe1b1d6cc74e283aab2d
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_Intfwd,
227 Lisp_Misc_Boolfwd,
228 Lisp_Misc_Objfwd,
229 Lisp_Misc_Buffer_Objfwd,
230 Lisp_Misc_Buffer_Local_Value,
231 Lisp_Misc_Overlay,
232 Lisp_Misc_Kboard_Objfwd,
233 Lisp_Misc_Save_Value,
234 /* Currently floats are not a misc type,
235 but let's define this in case we want to change that. */
236 Lisp_Misc_Float,
237 Lisp_Misc_ThreadLocal,
238 /* This is not a type code. It is for range checking. */
239 Lisp_Misc_Limit
242 #ifndef GCTYPEBITS
243 #define GCTYPEBITS 3
244 #endif
246 /* These values are overridden by the m- file on some machines. */
247 #ifndef VALBITS
248 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
249 #endif
251 #ifdef USE_LISP_UNION_TYPE
253 #ifndef WORDS_BIG_ENDIAN
255 /* Definition of Lisp_Object for little-endian machines. */
257 typedef
258 union Lisp_Object
260 /* Used for comparing two Lisp_Objects;
261 also, positive integers can be accessed fast this way. */
262 EMACS_UINT i;
264 struct
266 EMACS_INT val : VALBITS;
267 enum Lisp_Type type : GCTYPEBITS;
268 } s;
269 struct
271 EMACS_UINT val : VALBITS;
272 enum Lisp_Type type : GCTYPEBITS;
273 } u;
275 Lisp_Object;
277 #else /* If WORDS_BIG_ENDIAN */
279 typedef
280 union Lisp_Object
282 /* Used for comparing two Lisp_Objects;
283 also, positive integers can be accessed fast this way. */
284 EMACS_UINT i;
286 struct
288 enum Lisp_Type type : GCTYPEBITS;
289 EMACS_INT val : VALBITS;
290 } s;
291 struct
293 enum Lisp_Type type : GCTYPEBITS;
294 EMACS_UINT val : VALBITS;
295 } u;
297 Lisp_Object;
299 #endif /* WORDS_BIG_ENDIAN */
301 #ifdef __GNUC__
302 static __inline__ Lisp_Object
303 LISP_MAKE_RVALUE (Lisp_Object o)
305 return o;
307 #else
308 /* This isn't quite right - it keeps the argument as an lvalue.
309 Making it const via casting would help avoid code actually
310 modifying the location in question, but the casting could cover
311 other type-related bugs. */
312 #define LISP_MAKE_RVALUE(o) (o)
313 #endif
315 #else /* USE_LISP_UNION_TYPE */
317 /* If union type is not wanted, define Lisp_Object as just a number. */
319 typedef EMACS_INT Lisp_Object;
320 #define LISP_MAKE_RVALUE(o) (0+(o))
321 #endif /* USE_LISP_UNION_TYPE */
323 /* In the size word of a vector, this bit means the vector has been marked. */
325 #define ARRAY_MARK_FLAG ((EMACS_UINT) 1 << (BITS_PER_EMACS_INT - 1))
327 /* In the size word of a struct Lisp_Vector, this bit means it's really
328 some other vector-like object. */
329 #define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1))
331 /* In a pseudovector, the size field actually contains a word with one
332 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
333 indicate the actual type.
334 We use a bitset, even tho only one of the bits can be set at any
335 particular time just so as to be able to use micro-optimizations such as
336 testing membership of a particular subset of pseudovectors in Fequal.
337 It is not crucial, but there are plenty of bits here, so why not do it? */
338 enum pvec_type
340 PVEC_NORMAL_VECTOR = 0,
341 PVEC_PROCESS = 0x200,
342 PVEC_FRAME = 0x400,
343 PVEC_COMPILED = 0x800,
344 PVEC_WINDOW = 0x1000,
345 PVEC_WINDOW_CONFIGURATION = 0x2000,
346 PVEC_SUBR = 0x4000,
347 PVEC_CHAR_TABLE = 0x8000,
348 PVEC_BOOL_VECTOR = 0x10000,
349 PVEC_BUFFER = 0x20000,
350 PVEC_HASH_TABLE = 0x40000,
351 PVEC_TERMINAL = 0x80000,
352 PVEC_SUB_CHAR_TABLE = 0x100000,
353 PVEC_FONT = 0x200000,
354 PVEC_OTHER = 0x400000,
355 PVEC_THREAD = 0x800000,
356 PVEC_MUTEX = 0x1000000,
357 PVEC_TYPE_MASK = 0xfffe00
359 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
360 GDB. It doesn't work on OS Alpha. Moved to a variable in
361 emacs.c. */
362 PVEC_FLAG = PSEUDOVECTOR_FLAG
363 #endif
366 /* For convenience, we also store the number of elements in these bits.
367 Note that this size is not necessarily the memory-footprint size, but
368 only the number of Lisp_Object fields (that need to be traced by the GC).
369 The distinction is used e.g. by Lisp_Process which places extra
370 non-Lisp_Object fields at the end of the structure. */
371 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
373 /* Number of bits to put in each character in the internal representation
374 of bool vectors. This should not vary across implementations. */
375 #define BOOL_VECTOR_BITS_PER_CHAR 8
377 /* These macros extract various sorts of values from a Lisp_Object.
378 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
379 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
381 #ifndef USE_LISP_UNION_TYPE
383 /* Return a perfect hash of the Lisp_Object representation. */
384 #define XHASH(a) (a)
386 #ifdef USE_LSB_TAG
388 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
389 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) & TYPEMASK))
390 #ifdef USE_2_TAGS_FOR_INTS
391 # define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
392 # define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
393 # define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
394 #else
395 # define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
396 # define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
397 # define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
398 #endif
399 #define XSET(var, type, ptr) \
400 (eassert (XTYPE (ptr) == 0), /* Check alignment. */ \
401 (var) = ((EMACS_INT) (type)) | ((EMACS_INT) (ptr)))
403 #define XPNTR(a) ((EMACS_INT) ((a) & ~TYPEMASK))
405 #else /* not USE_LSB_TAG */
407 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
409 /* One need to override this if there must be high bits set in data space
410 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
411 on all machines, but would penalize machines which don't need it)
413 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
415 /* For integers known to be positive, XFASTINT provides fast retrieval
416 and XSETFASTINT provides fast storage. This takes advantage of the
417 fact that Lisp_Int is 0. */
418 #define XFASTINT(a) ((a) + 0)
419 #define XSETFASTINT(a, b) ((a) = (b))
421 /* Extract the value of a Lisp_Object as a (un)signed integer. */
423 #ifdef USE_2_TAGS_FOR_INTS
424 # define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
425 # define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
426 # define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
427 #else
428 # define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
429 >> (BITS_PER_EMACS_INT - VALBITS))
430 # define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
431 # define make_number(N) \
432 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
433 #endif
435 #define XSET(var, type, ptr) \
436 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
438 #define XPNTR(a) ((EMACS_UINT) ((a) & VALMASK))
440 #endif /* not USE_LSB_TAG */
442 #else /* USE_LISP_UNION_TYPE */
444 #ifdef USE_2_TAGS_FOR_INTS
445 # error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
446 #endif
448 #define XHASH(a) ((a).i)
450 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
452 #ifdef EXPLICIT_SIGN_EXTEND
453 /* Make sure we sign-extend; compilers have been known to fail to do so.
454 We additionally cast to EMACS_INT since it seems that some compilers
455 have been known to fail to do so, even though the bitfield is declared
456 as EMACS_INT already. */
457 #define XINT(a) ((((EMACS_INT) (a).s.val) << (BITS_PER_EMACS_INT - VALBITS)) \
458 >> (BITS_PER_EMACS_INT - VALBITS))
459 #else
460 #define XINT(a) ((a).s.val)
461 #endif /* EXPLICIT_SIGN_EXTEND */
463 #define XUINT(a) ((a).u.val)
465 #ifdef USE_LSB_TAG
467 # define XSET(var, vartype, ptr) \
468 (eassert ((((EMACS_UINT) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0), \
469 (var).u.val = ((EMACS_UINT) (ptr)) >> GCTYPEBITS, \
470 (var).u.type = ((char) (vartype)))
472 /* Some versions of gcc seem to consider the bitfield width when issuing
473 the "cast to pointer from integer of different size" warning, so the
474 cast is here to widen the value back to its natural size. */
475 # define XPNTR(v) ((EMACS_INT)((v).s.val) << GCTYPEBITS)
477 #else /* !USE_LSB_TAG */
479 /* For integers known to be positive, XFASTINT provides fast retrieval
480 and XSETFASTINT provides fast storage. This takes advantage of the
481 fact that Lisp_Int is 0. */
482 # define XFASTINT(a) ((a).i + 0)
483 # define XSETFASTINT(a, b) ((a).i = (b))
485 # define XSET(var, vartype, ptr) \
486 (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
488 #endif /* !USE_LSB_TAG */
490 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
491 #define make_number(N) \
492 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
493 #else
494 extern Lisp_Object make_number P_ ((EMACS_INT));
495 #endif
497 #endif /* USE_LISP_UNION_TYPE */
499 /* For integers known to be positive, XFASTINT sometimes provides
500 faster retrieval and XSETFASTINT provides faster storage.
501 If not, fallback on the non-accelerated path. */
502 #ifndef XFASTINT
503 # define XFASTINT(a) (XINT (a))
504 # define XSETFASTINT(a, b) (XSETINT (a, b))
505 #endif
507 #define EQ(x, y) (XHASH (x) == XHASH (y))
509 #ifndef XPNTR
510 #ifdef HAVE_SHM
511 /* In this representation, data is found in two widely separated segments. */
512 extern size_t pure_size;
513 #define XPNTR(a) \
514 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
515 #else /* not HAVE_SHM */
516 #ifdef DATA_SEG_BITS
517 /* This case is used for the rt-pc.
518 In the diffs I was given, it checked for ptr = 0
519 and did not adjust it in that case.
520 But I don't think that zero should ever be found
521 in a Lisp object whose data type says it points to something. */
522 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
523 #else
524 /* Some versions of gcc seem to consider the bitfield width when
525 issuing the "cast to pointer from integer of different size"
526 warning, so the cast is here to widen the value back to its natural
527 size. */
528 #define XPNTR(a) ((EMACS_INT) XUINT (a))
529 #endif
530 #endif /* not HAVE_SHM */
531 #endif /* no XPNTR */
533 /* Largest and smallest representable fixnum values. These are the C
534 values. */
536 #ifdef USE_2_TAGS_FOR_INTS
537 # define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << VALBITS)
538 # define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << VALBITS) - 1)
539 /* Mask indicating the significant bits of a Lisp_Int.
540 I.e. (x & INTMASK) == XUINT (make_number (x)). */
541 # define INTMASK ((((EMACS_INT) 1) << (VALBITS + 1)) - 1)
542 #else
543 # define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << (VALBITS - 1))
544 # define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << (VALBITS - 1)) - 1)
545 /* Mask indicating the significant bits of a Lisp_Int.
546 I.e. (x & INTMASK) == XUINT (make_number (x)). */
547 # define INTMASK ((((EMACS_INT) 1) << VALBITS) - 1)
548 #endif
550 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
551 written this way so that it also works if I is of unsigned
552 type. */
554 #define FIXNUM_OVERFLOW_P(i) \
555 ((i) > MOST_POSITIVE_FIXNUM \
556 || ((i) < 0 && (i) < MOST_NEGATIVE_FIXNUM))
558 /* Extract a value or address from a Lisp_Object. */
560 #define XCONS(a) (eassert (CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
561 #define XVECTOR(a) (eassert (VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
562 #define XSTRING(a) (eassert (STRINGP(a)),(struct Lisp_String *) XPNTR(a))
563 #define XSYMBOL(a) (eassert (SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
564 #define XFLOAT(a) (eassert (FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
566 /* Misc types. */
568 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
569 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC(a)->u_any))
570 #define XMISCTYPE(a) (XMISCANY (a)->type)
571 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC(a)->u_marker))
572 #define XINTFWD(a) (eassert (INTFWDP (a)), &(XMISC(a)->u_intfwd))
573 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &(XMISC(a)->u_boolfwd))
574 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &(XMISC(a)->u_objfwd))
575 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
576 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
577 #define XBUFFER_OBJFWD(a) \
578 (eassert (BUFFER_OBJFWDP (a)), &(XMISC(a)->u_buffer_objfwd))
579 #define XBUFFER_LOCAL_VALUE(a) \
580 (eassert (BUFFER_LOCAL_VALUEP (a)), &(XMISC(a)->u_buffer_local_value))
581 #define XKBOARD_OBJFWD(a) \
582 (eassert (KBOARD_OBJFWDP (a)), &(XMISC(a)->u_kboard_objfwd))
583 #define XTHREADLOCAL(a) \
584 (eassert (THREADLOCALP (a)), &(XMISC(a)->u_threadlocal))
586 /* Pseudovector types. */
588 #define XPROCESS(a) (eassert (PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
589 #define XWINDOW(a) (eassert (WINDOWP(a)),(struct window *) XPNTR(a))
590 #define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
591 #define XSUBR(a) (eassert (SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
592 #define XBUFFER(a) (eassert (BUFFERP(a)),(struct buffer *) XPNTR(a))
593 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
594 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR(a))
595 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
596 #define XMUTEX(a) (eassert (MUTEXP(a)),(struct Lisp_Mutex *) XPNTR(a))
598 /* Construct a Lisp_Object from a value or address. */
600 #define XSETINT(a, b) (a) = make_number (b)
601 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
602 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
603 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
604 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
605 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
607 /* Misc types. */
609 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
610 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
611 #define XSETTHREADLOCAL(a, b) \
612 (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_ThreadLocal)
614 /* Pseudovector types. */
616 #define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
617 #define XSETPSEUDOVECTOR(a, b, code) \
618 (XSETVECTOR (a, b), \
619 eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
620 == (PSEUDOVECTOR_FLAG | (code))))
621 #define XSETWINDOW_CONFIGURATION(a, b) \
622 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
623 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
624 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
625 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
626 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
627 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
628 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
629 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
630 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
631 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
632 #define XSETTHREAD(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_THREAD))
633 #define XSETMUTEX(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_MUTEX))
635 /* Convenience macros for dealing with Lisp arrays. */
637 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
638 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->size
639 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
640 #define ASET(ARRAY, IDX, VAL) \
641 (eassert ((IDX) == (IDX)), \
642 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
643 AREF ((ARRAY), (IDX)) = (VAL))
645 /* Convenience macros for dealing with Lisp strings. */
647 #define SDATA(string) (XSTRING (string)->data + 0)
648 #define SREF(string, index) (SDATA (string)[index] + 0)
649 #define SSET(string, index, new) (SDATA (string)[index] = (new))
650 #define SCHARS(string) (XSTRING (string)->size + 0)
651 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
653 #define STRING_SET_CHARS(string, newsize) \
654 (XSTRING (string)->size = (newsize))
656 #define STRING_COPYIN(string, index, new, count) \
657 bcopy (new, SDATA (string) + index, count)
659 /* Type checking. */
661 #define CHECK_TYPE(ok, Qxxxp, x) \
662 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
666 /* See the macros in intervals.h. */
668 typedef struct interval *INTERVAL;
670 /* Complain if object is not string or buffer type */
671 #define CHECK_STRING_OR_BUFFER(x) \
672 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
675 /* In a cons, the markbit of the car is the gc mark bit */
677 struct Lisp_Cons
679 /* Please do not use the names of these elements in code other
680 than the core lisp implementation. Use XCAR and XCDR below. */
681 #ifdef HIDE_LISP_IMPLEMENTATION
682 Lisp_Object car_;
683 union
685 Lisp_Object cdr_;
686 struct Lisp_Cons *chain;
687 } u;
688 #else
689 Lisp_Object car;
690 union
692 Lisp_Object cdr;
693 struct Lisp_Cons *chain;
694 } u;
695 #endif
698 /* Take the car or cdr of something known to be a cons cell. */
699 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
700 of code that has to know what a cons cell looks like. Other code not
701 part of the basic lisp implementation should assume that the car and cdr
702 fields are not accessible as lvalues. (What if we want to switch to
703 a copying collector someday? Cached cons cell field addresses may be
704 invalidated at arbitrary points.) */
705 #ifdef HIDE_LISP_IMPLEMENTATION
706 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
707 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
708 #else
709 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
710 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
711 #endif
713 /* Use these from normal code. */
714 #define XCAR(c) LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
715 #define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))
717 /* Use these to set the fields of a cons cell.
719 Note that both arguments may refer to the same object, so 'n'
720 should not be read after 'c' is first modified. Also, neither
721 argument should be evaluated more than once; side effects are
722 especially common in the second argument. */
723 #define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
724 #define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))
726 /* For performance: Fast storage of positive integers into the
727 fields of a cons cell. See above caveats. */
728 #define XSETCARFASTINT(c,n) XSETFASTINT(XCAR_AS_LVALUE(c),(n))
729 #define XSETCDRFASTINT(c,n) XSETFASTINT(XCDR_AS_LVALUE(c),(n))
731 /* Take the car or cdr of something whose type is not known. */
732 #define CAR(c) \
733 (CONSP ((c)) ? XCAR ((c)) \
734 : NILP ((c)) ? Qnil \
735 : wrong_type_argument (Qlistp, (c)))
737 #define CDR(c) \
738 (CONSP ((c)) ? XCDR ((c)) \
739 : NILP ((c)) ? Qnil \
740 : wrong_type_argument (Qlistp, (c)))
742 /* Take the car or cdr of something whose type is not known. */
743 #define CAR_SAFE(c) \
744 (CONSP ((c)) ? XCAR ((c)) : Qnil)
746 #define CDR_SAFE(c) \
747 (CONSP ((c)) ? XCDR ((c)) : Qnil)
749 /* Nonzero if STR is a multibyte string. */
750 #define STRING_MULTIBYTE(STR) \
751 (XSTRING (STR)->size_byte >= 0)
753 /* Return the length in bytes of STR. */
755 #ifdef GC_CHECK_STRING_BYTES
757 struct Lisp_String;
758 extern int string_bytes P_ ((struct Lisp_String *));
759 #define STRING_BYTES(S) string_bytes ((S))
761 #else /* not GC_CHECK_STRING_BYTES */
763 #define STRING_BYTES(STR) \
764 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
766 #endif /* not GC_CHECK_STRING_BYTES */
768 /* Mark STR as a unibyte string. */
769 #define STRING_SET_UNIBYTE(STR) \
770 do { if (EQ (STR, empty_multibyte_string)) \
771 (STR) = empty_unibyte_string; \
772 else XSTRING (STR)->size_byte = -1; } while (0)
774 /* Mark STR as a multibyte string. Assure that STR contains only
775 ASCII characters in advance. */
776 #define STRING_SET_MULTIBYTE(STR) \
777 do { if (EQ (STR, empty_unibyte_string)) \
778 (STR) = empty_multibyte_string; \
779 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
781 /* Get text properties. */
782 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
784 /* Set text properties. */
785 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
787 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
789 struct Lisp_String
791 EMACS_INT size;
792 EMACS_INT size_byte;
793 INTERVAL intervals; /* text properties in this string */
794 unsigned char *data;
797 #ifdef offsetof
798 #define OFFSETOF(type,field) offsetof(type,field)
799 #else
800 #define OFFSETOF(type,field) \
801 ((int)((char*)&((type*)0)->field - (char*)0))
802 #endif
804 struct Lisp_Vector
806 EMACS_UINT size;
807 struct Lisp_Vector *next;
808 Lisp_Object contents[1];
811 /* If a struct is made to look like a vector, this macro returns the length
812 of the shortest vector that would hold that struct. */
813 #define VECSIZE(type) ((sizeof (type) \
814 - OFFSETOF (struct Lisp_Vector, contents[0]) \
815 + sizeof(Lisp_Object) - 1) /* round up */ \
816 / sizeof (Lisp_Object))
818 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
819 at the end and we need to compute the number of Lisp_Object fields (the
820 ones that the GC needs to trace). */
821 #define PSEUDOVECSIZE(type, nonlispfield) \
822 ((OFFSETOF(type, nonlispfield) - OFFSETOF(struct Lisp_Vector, contents[0])) \
823 / sizeof (Lisp_Object))
825 /* A char-table is a kind of vectorlike, with contents are like a
826 vector but with a few other slots. For some purposes, it makes
827 sense to handle a char-table with type struct Lisp_Vector. An
828 element of a char table can be any Lisp objects, but if it is a sub
829 char-table, we treat it a table that contains information of a
830 specific range of characters. A sub char-table has the same
831 structure as a vector. A sub char table appears only in an element
832 of a char-table, and there's no way to access it directly from
833 Emacs Lisp program. */
835 /* This is the number of slots that every char table must have. This
836 counts the ordinary slots and the top, defalt, parent, and purpose
837 slots. */
838 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
840 /* Return the number of "extra" slots in the char table CT. */
842 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
843 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
845 #ifdef __GNUC__
847 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
848 ({struct Lisp_Char_Table *_tbl = NULL; \
849 Lisp_Object _val; \
850 do { \
851 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
852 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
853 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
854 if (NILP (_val)) \
855 _val = _tbl->defalt; \
856 } while (NILP (_val) && ! NILP (_tbl->parent)); \
857 _val; })
859 #else /* not __GNUC__ */
861 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
862 (! NILP (XCHAR_TABLE (CT)->ascii) \
863 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
864 ? XCHAR_TABLE (CT)->ascii \
865 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
866 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
867 : char_table_ref ((CT), (IDX))) \
868 : char_table_ref ((CT), (IDX)))
870 #endif /* not __GNUC__ */
872 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
873 characters. Do not check validity of CT. */
874 #define CHAR_TABLE_REF(CT, IDX) \
875 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
876 : char_table_ref ((CT), (IDX)))
878 /* Almost equivalent to Faref (CT, IDX). However, if the result is
879 not a character, return IDX.
881 For these characters, do not check validity of CT
882 and do not follow parent. */
883 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
884 char_table_translate (CT, IDX)
886 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
887 8-bit European characters. Do not check validity of CT. */
888 #define CHAR_TABLE_SET(CT, IDX, VAL) \
889 (((IDX) >= 0 && ASCII_CHAR_P (IDX) \
890 && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)) \
891 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
892 : char_table_set (CT, IDX, VAL))
894 #define CHARTAB_SIZE_BITS_0 6
895 #define CHARTAB_SIZE_BITS_1 4
896 #define CHARTAB_SIZE_BITS_2 5
897 #define CHARTAB_SIZE_BITS_3 7
899 extern const int chartab_size[4];
901 struct Lisp_Sub_Char_Table;
903 struct Lisp_Char_Table
905 /* This is the vector's size field, which also holds the
906 pseudovector type information. It holds the size, too.
907 The size counts the defalt, parent, purpose, ascii,
908 contents, and extras slots. */
909 EMACS_UINT size;
910 struct Lisp_Vector *next;
912 /* This holds a default value,
913 which is used whenever the value for a specific character is nil. */
914 Lisp_Object defalt;
916 /* This points to another char table, which we inherit from when the
917 value for a specific character is nil. The `defalt' slot takes
918 precedence over this. */
919 Lisp_Object parent;
921 /* This is a symbol which says what kind of use this char-table is
922 meant for. */
923 Lisp_Object purpose;
925 /* The bottom sub char-table for characters of the range 0..127. It
926 is nil if none of ASCII character has a specific value. */
927 Lisp_Object ascii;
929 Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)];
931 /* These hold additional data. It is a vector. */
932 Lisp_Object extras[1];
935 struct Lisp_Sub_Char_Table
937 /* This is the vector's size field, which also holds the
938 pseudovector type information. It holds the size, too. */
939 EMACS_INT size;
940 struct Lisp_Vector *next;
942 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
943 char-table of depth 1 contains 16 elments, and each element
944 covers 4096 (128*32) characters. A sub char-table of depth 2
945 contains 32 elements, and each element covers 128 characters. A
946 sub char-table of depth 3 contains 128 elements, and each element
947 is for one character. */
948 Lisp_Object depth;
950 /* Minimum character covered by the sub char-table. */
951 Lisp_Object min_char;
953 Lisp_Object contents[1];
956 /* A boolvector is a kind of vectorlike, with contents are like a string. */
957 struct Lisp_Bool_Vector
959 /* This is the vector's size field. It doesn't have the real size,
960 just the subtype information. */
961 EMACS_UINT vector_size;
962 struct Lisp_Vector *next;
963 /* This is the size in bits. */
964 EMACS_UINT size;
965 /* This contains the actual bits, packed into bytes. */
966 unsigned char data[1];
969 /* This structure describes a built-in function.
970 It is generated by the DEFUN macro only.
971 defsubr makes it into a Lisp object.
973 This type is treated in most respects as a pseudovector,
974 but since we never dynamically allocate or free them,
975 we don't need a next-vector field. */
977 struct Lisp_Subr
979 EMACS_UINT size;
980 Lisp_Object (*function) ();
981 short min_args, max_args;
982 const char *symbol_name;
983 char *intspec;
984 char *doc;
988 /***********************************************************************
989 Symbols
990 ***********************************************************************/
992 /* Interned state of a symbol. */
994 enum symbol_interned
996 SYMBOL_UNINTERNED = 0,
997 SYMBOL_INTERNED = 1,
998 SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
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 /* Non-zero means symbol serves as a variable alias. The symbol
1008 holding the real value is found in the value slot. */
1009 unsigned indirect_variable : 1;
1011 /* Non-zero means symbol is constant, i.e. changing its value
1012 should signal an error. */
1013 unsigned constant : 1;
1015 /* Interned state of the symbol. This is an enumerator from
1016 enum symbol_interned. */
1017 unsigned interned : 2;
1019 /* The symbol's name, as a Lisp string.
1021 The name "xname" is used to intentionally break code referring to
1022 the old field "name" of type pointer to struct Lisp_String. */
1023 Lisp_Object xname;
1025 /* Value of the symbol or Qunbound if unbound. If this symbol is a
1026 defvaralias, `value' contains the symbol for which it is an
1027 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
1028 and set a symbol's value, to take defvaralias into account. */
1029 Lisp_Object value;
1031 /* Function value of the symbol or Qunbound if not fboundp. */
1032 Lisp_Object function;
1034 /* The symbol's property list. */
1035 Lisp_Object plist;
1037 /* Next symbol in obarray bucket, if the symbol is interned. */
1038 struct Lisp_Symbol *next;
1041 /* Value is name of symbol. */
1043 #define SYMBOL_NAME(sym) \
1044 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1046 /* Value is non-zero if SYM is an interned symbol. */
1048 #define SYMBOL_INTERNED_P(sym) \
1049 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1051 /* Value is non-zero if SYM is interned in initial_obarray. */
1053 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1054 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1056 /* Value is non-zero if symbol is considered a constant, i.e. its
1057 value cannot be changed (there is an exception for keyword symbols,
1058 whose value can be set to the keyword symbol itself). */
1060 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1062 /* Value is the value of SYM, with defvaralias taken into
1063 account. */
1065 #define SYMBOL_VALUE(sym) \
1066 (XSYMBOL (sym)->indirect_variable \
1067 ? indirect_variable (XSYMBOL (sym))->value \
1068 : XSYMBOL (sym)->value)
1070 /* Set SYM's value to VAL, taking defvaralias into account. */
1072 #define SET_SYMBOL_VALUE(sym, val) \
1073 do { \
1074 if (XSYMBOL (sym)->indirect_variable) \
1075 indirect_variable (XSYMBOL (sym))->value = (val); \
1076 else \
1077 XSYMBOL (sym)->value = (val); \
1078 } while (0)
1081 /***********************************************************************
1082 Hash Tables
1083 ***********************************************************************/
1085 /* The structure of a Lisp hash table. */
1087 struct Lisp_Hash_Table
1089 /* Vector fields. The hash table code doesn't refer to these. */
1090 EMACS_UINT size;
1091 struct Lisp_Vector *vec_next;
1093 /* Function used to compare keys. */
1094 Lisp_Object test;
1096 /* Nil if table is non-weak. Otherwise a symbol describing the
1097 weakness of the table. */
1098 Lisp_Object weak;
1100 /* When the table is resized, and this is an integer, compute the
1101 new size by adding this to the old size. If a float, compute the
1102 new size by multiplying the old size with this factor. */
1103 Lisp_Object rehash_size;
1105 /* Resize hash table when number of entries/ table size is >= this
1106 ratio, a float. */
1107 Lisp_Object rehash_threshold;
1109 /* Vector of hash codes.. If hash[I] is nil, this means that that
1110 entry I is unused. */
1111 Lisp_Object hash;
1113 /* Vector used to chain entries. If entry I is free, next[I] is the
1114 entry number of the next free item. If entry I is non-free,
1115 next[I] is the index of the next entry in the collision chain. */
1116 Lisp_Object next;
1118 /* Index of first free entry in free list. */
1119 Lisp_Object next_free;
1121 /* Bucket vector. A non-nil entry is the index of the first item in
1122 a collision chain. This vector's size can be larger than the
1123 hash table size to reduce collisions. */
1124 Lisp_Object index;
1126 /* User-supplied hash function, or nil. */
1127 Lisp_Object user_hash_function;
1129 /* User-supplied key comparison function, or nil. */
1130 Lisp_Object user_cmp_function;
1132 /* Only the fields above are traced normally by the GC. The ones below
1133 `count'. are special and are either ignored by the GC or traced in
1134 a special way (e.g. because of weakness). */
1136 /* Number of key/value entries in the table. */
1137 unsigned int count;
1139 /* Vector of keys and values. The key of item I is found at index
1140 2 * I, the value is found at index 2 * I + 1.
1141 This is gc_marked specially if the table is weak. */
1142 Lisp_Object key_and_value;
1144 /* Next weak hash table if this is a weak hash table. The head
1145 of the list is in weak_hash_tables. */
1146 struct Lisp_Hash_Table *next_weak;
1148 /* C function to compare two keys. */
1149 int (* cmpfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object,
1150 unsigned, Lisp_Object, unsigned));
1152 /* C function to compute hash code. */
1153 unsigned (* hashfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object));
1157 #define XHASH_TABLE(OBJ) \
1158 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1160 #define XSET_HASH_TABLE(VAR, PTR) \
1161 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1163 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1165 #define CHECK_HASH_TABLE(x) \
1166 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1168 /* Value is the key part of entry IDX in hash table H. */
1170 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1172 /* Value is the value part of entry IDX in hash table H. */
1174 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1176 /* Value is the index of the next entry following the one at IDX
1177 in hash table H. */
1179 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1181 /* Value is the hash code computed for entry IDX in hash table H. */
1183 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1185 /* Value is the index of the element in hash table H that is the
1186 start of the collision list at index IDX in the index vector of H. */
1188 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1190 /* Value is the size of hash table H. */
1192 #define HASH_TABLE_SIZE(H) XVECTOR ((H)->next)->size
1194 /* Default size for hash tables if not specified. */
1196 #define DEFAULT_HASH_SIZE 65
1198 /* Default threshold specifying when to resize a hash table. The
1199 value gives the ratio of current entries in the hash table and the
1200 size of the hash table. */
1202 #define DEFAULT_REHASH_THRESHOLD 0.8
1204 /* Default factor by which to increase the size of a hash table. */
1206 #define DEFAULT_REHASH_SIZE 1.5
1209 /* These structures are used for various misc types. */
1211 struct Lisp_Misc_Any /* Supertype of all Misc types. */
1213 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Marker */
1214 unsigned gcmarkbit : 1;
1215 int spacer : 15;
1218 struct Lisp_Marker
1220 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Marker */
1221 unsigned gcmarkbit : 1;
1222 int spacer : 13;
1223 /* This flag is temporarily used in the functions
1224 decode/encode_coding_object to record that the marker position
1225 must be adjusted after the conversion. */
1226 unsigned int need_adjustment : 1;
1227 /* 1 means normal insertion at the marker's position
1228 leaves the marker after the inserted text. */
1229 unsigned int insertion_type : 1;
1230 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1231 Note: a chain of markers can contain markers pointing into different
1232 buffers (the chain is per buffer_text rather than per buffer, so it's
1233 shared between indirect buffers). */
1234 /* This is used for (other than NULL-checking):
1235 - Fmarker_buffer
1236 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1237 - unchain_marker: to find the list from which to unchain.
1238 - Fkill_buffer: to unchain the markers of current indirect buffer.
1240 struct buffer *buffer;
1242 /* The remaining fields are meaningless in a marker that
1243 does not point anywhere. */
1245 /* For markers that point somewhere,
1246 this is used to chain of all the markers in a given buffer. */
1247 /* We could remove it and use an array in buffer_text instead.
1248 That would also allow to preserve it ordered. */
1249 struct Lisp_Marker *next;
1250 /* This is the char position where the marker points. */
1251 EMACS_INT charpos;
1252 /* This is the byte position. */
1253 EMACS_INT bytepos;
1256 /* Forwarding pointer to an int variable.
1257 This is allowed only in the value cell of a symbol,
1258 and it means that the symbol's value really lives in the
1259 specified int variable. */
1260 struct Lisp_Intfwd
1262 int type : 16; /* = Lisp_Misc_Intfwd */
1263 unsigned gcmarkbit : 1;
1264 int spacer : 15;
1265 EMACS_INT *intvar;
1268 /* Boolean forwarding pointer to an int variable.
1269 This is like Lisp_Intfwd except that the ostensible
1270 "value" of the symbol is t if the int variable is nonzero,
1271 nil if it is zero. */
1272 struct Lisp_Boolfwd
1274 int type : 16; /* = Lisp_Misc_Boolfwd */
1275 unsigned gcmarkbit : 1;
1276 int spacer : 15;
1277 int *boolvar;
1280 /* Forwarding pointer to a Lisp_Object variable.
1281 This is allowed only in the value cell of a symbol,
1282 and it means that the symbol's value really lives in the
1283 specified variable. */
1284 struct Lisp_Objfwd
1286 int type : 16; /* = Lisp_Misc_Objfwd */
1287 unsigned gcmarkbit : 1;
1288 int spacer : 15;
1289 Lisp_Object *objvar;
1292 /* Like Lisp_Objfwd except that value lives in a slot in the
1293 current buffer. Value is byte index of slot within buffer. */
1294 struct Lisp_Buffer_Objfwd
1296 int type : 16; /* = Lisp_Misc_Buffer_Objfwd */
1297 unsigned gcmarkbit : 1;
1298 int spacer : 15;
1299 Lisp_Object slottype; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1300 int offset;
1303 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1304 the symbol has buffer-local or frame-local bindings. (Exception:
1305 some buffer-local variables are built-in, with their values stored
1306 in the buffer structure itself. They are handled differently,
1307 using struct Lisp_Buffer_Objfwd.)
1309 The `realvalue' slot holds the variable's current value, or a
1310 forwarding pointer to where that value is kept. This value is the
1311 one that corresponds to the loaded binding. To read or set the
1312 variable, you must first make sure the right binding is loaded;
1313 then you can access the value in (or through) `realvalue'.
1315 `buffer' and `frame' are the buffer and frame for which the loaded
1316 binding was found. If those have changed, to make sure the right
1317 binding is loaded it is necessary to find which binding goes with
1318 the current buffer and selected frame, then load it. To load it,
1319 first unload the previous binding, then copy the value of the new
1320 binding into `realvalue' (or through it). Also update
1321 LOADED-BINDING to point to the newly loaded binding.
1323 `local_if_set' indicates that merely setting the variable creates a local
1324 binding for the current buffer. Otherwise the latter, setting the
1325 variable does not do that; only make-local-variable does that. */
1327 struct Lisp_Buffer_Local_Value
1329 int type : 16; /* = Lisp_Misc_Buffer_Local_Value */
1330 unsigned gcmarkbit : 1;
1331 int spacer : 11;
1333 /* 1 means that merely setting the variable creates a local
1334 binding for the current buffer */
1335 unsigned int local_if_set : 1;
1336 /* 1 means this variable is allowed to have frame-local bindings,
1337 so check for them when looking for the proper binding. */
1338 unsigned int check_frame : 1;
1339 /* 1 means that the binding now loaded was found
1340 as a local binding for the buffer in the `buffer' slot. */
1341 /* unsigned int found_for_buffer : 1; */
1342 /* 1 means that the binding now loaded was found
1343 as a local binding for the frame in the `frame' slot. */
1344 /* unsigned int found_for_frame : 1; */
1345 Lisp_Object realvalue;
1347 /* The buffer and frame for which the loaded binding was found. */
1348 /* Having both is only needed if we want to allow variables that are
1349 both buffer local and frame local (in which case, we currently give
1350 precedence to the buffer-local binding). I don't think such
1351 a combination is desirable. --Stef */
1352 /* Lisp_Object buffer, frame; */
1354 /* A cons cell, (LOADED-BINDING . DEFAULT-VALUE).
1356 LOADED-BINDING is the binding now loaded. It is a cons cell
1357 whose cdr is the binding's value. The cons cell may be an
1358 element of a buffer's local-variable alist, or an element of a
1359 frame's parameter alist, or it may be this cons cell.
1361 DEFAULT-VALUE is the variable's default value, seen when the
1362 current buffer and selected frame do not have their own
1363 bindings for the variable. When the default binding is loaded,
1364 LOADED-BINDING is actually this very cons cell; thus, its car
1365 points to itself. */
1366 /* Lisp_Object cdr; */
1368 Lisp_Object thread_data;
1371 void blocal_unbind_thread (Lisp_Object thread);
1372 Lisp_Object *blocal_get_thread_data (struct Lisp_Buffer_Local_Value *l,
1373 Lisp_Object sym);
1374 void blocal_set_thread_data (struct Lisp_Buffer_Local_Value *l, Lisp_Object o);
1376 #define BLOCAL_CLEAR_FLAGS_VEC(VEC) XSETFASTINT (AREF ((VEC), 0), 0)
1377 #define BLOCAL_FOUND_FOR_BUFFER_VEC(VEC) ((XFASTINT (AREF ((VEC), 0))) == 1)
1378 #define BLOCAL_SET_FOUND_FOR_BUFFER_VEC(VEC) XSETFASTINT (AREF ((VEC), 0), 1)
1379 #define BLOCAL_FOUND_FOR_FRAME_VEC(VEC) ((XFASTINT (AREF ((VEC), 0))) == 2)
1380 #define BLOCAL_SET_FOUND_FOR_FRAME_VEC(VEC) XSETFASTINT (AREF ((VEC), 0), 2)
1381 #define BLOCAL_BUFFER_VEC(VEC) (AREF ((VEC), 1))
1382 #define BLOCAL_FRAME_VEC(VEC) (AREF ((VEC), 2))
1383 #define BLOCAL_CDR_VEC(VEC) (AREF ((VEC), 3))
1384 #define BLOCAL_THREAD_DATA(A) (*blocal_get_thread_data (A, Qnil))
1385 #define BLOCAL_SET_THREAD_DATA(A, B) (blocal_set_thread_data (A, B))
1386 #define BLOCAL_CLEAR_FLAGS(A) (BLOCAL_CLEAR_FLAGS_VEC (BLOCAL_THREAD_DATA (A)))
1387 #define BLOCAL_FOUND_FOR_BUFFER(A) (BLOCAL_FOUND_FOR_BUFFER_VEC (BLOCAL_THREAD_DATA (A)))
1388 #define BLOCAL_SET_FOUND_FOR_BUFFER(A) (BLOCAL_SET_FOUND_FOR_BUFFER_VEC (BLOCAL_THREAD_DATA (A)))
1389 #define BLOCAL_FOUND_FOR_FRAME(A) (BLOCAL_FOUND_FOR_FRAME_VEC (BLOCAL_THREAD_DATA (A)))
1390 #define BLOCAL_SET_FOUND_FOR_FRAME(A) (BLOCAL_SET_FOUND_FOR_FRAME_VEC (BLOCAL_THREAD_DATA (A)))
1391 #define BLOCAL_BUFFER(A) (BLOCAL_BUFFER_VEC (BLOCAL_THREAD_DATA (A)))
1392 #define BLOCAL_FRAME(A) (BLOCAL_FRAME_VEC (BLOCAL_THREAD_DATA (A)))
1393 #define BLOCAL_CDR(A) (BLOCAL_CDR_VEC (BLOCAL_THREAD_DATA (A)))
1394 #define BLOCAL_REALVALUE(A) (XCDR_AS_LVALUE (ensure_thread_local (&((A)->realvalue))))
1396 /* START and END are markers in the overlay's buffer, and
1397 PLIST is the overlay's property list. */
1398 struct Lisp_Overlay
1400 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Overlay */
1401 unsigned gcmarkbit : 1;
1402 int spacer : 15;
1403 struct Lisp_Overlay *next;
1404 Lisp_Object start, end, plist;
1407 /* Like Lisp_Objfwd except that value lives in a slot in the
1408 current kboard. */
1409 struct Lisp_Kboard_Objfwd
1411 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Kboard_Objfwd */
1412 unsigned gcmarkbit : 1;
1413 int spacer : 15;
1414 int offset;
1417 /* Hold a C pointer for later use.
1418 This type of object is used in the arg to record_unwind_protect. */
1419 struct Lisp_Save_Value
1421 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Save_Value */
1422 unsigned gcmarkbit : 1;
1423 int spacer : 14;
1424 /* If DOGC is set, POINTER is the address of a memory
1425 area containing INTEGER potential Lisp_Objects. */
1426 unsigned int dogc : 1;
1427 void *pointer;
1428 int integer;
1431 struct Lisp_ThreadLocal
1433 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_ThreadLocal */
1434 unsigned gcmarkbit : 1;
1435 int spacer : 15;
1436 Lisp_Object global;
1437 Lisp_Object thread_alist;
1441 /* A miscellaneous object, when it's on the free list. */
1442 struct Lisp_Free
1444 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Free */
1445 unsigned gcmarkbit : 1;
1446 int spacer : 15;
1447 union Lisp_Misc *chain;
1448 #ifdef USE_LSB_TAG
1449 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1450 This assumes that Lisp_Marker is the largest of the alternatives and
1451 that Lisp_Intfwd has the same size as "Lisp_Free w/o padding". */
1452 char padding[((((sizeof (struct Lisp_Marker) - 1) >> GCTYPEBITS) + 1)
1453 << GCTYPEBITS) - sizeof (struct Lisp_Intfwd)];
1454 #endif
1457 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1458 It uses one of these struct subtypes to get the type field. */
1460 union Lisp_Misc
1462 struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */
1463 struct Lisp_Free u_free; /* Includes padding to force alignment. */
1464 struct Lisp_Marker u_marker;
1465 struct Lisp_Intfwd u_intfwd;
1466 struct Lisp_Boolfwd u_boolfwd;
1467 struct Lisp_Objfwd u_objfwd;
1468 struct Lisp_Buffer_Objfwd u_buffer_objfwd;
1469 struct Lisp_Buffer_Local_Value u_buffer_local_value;
1470 struct Lisp_Overlay u_overlay;
1471 struct Lisp_Kboard_Objfwd u_kboard_objfwd;
1472 struct Lisp_Save_Value u_save_value;
1473 struct Lisp_ThreadLocal u_threadlocal;
1476 /* Lisp floating point type */
1477 struct Lisp_Float
1479 union
1481 #ifdef HIDE_LISP_IMPLEMENTATION
1482 double data_;
1483 #else
1484 double data;
1485 #endif
1486 struct Lisp_Float *chain;
1487 } u;
1490 #ifdef HIDE_LISP_IMPLEMENTATION
1491 #define XFLOAT_DATA(f) (XFLOAT (f)->u.data_ + 0)
1492 #else
1493 #define XFLOAT_DATA(f) (XFLOAT (f)->u.data + 0)
1494 /* This should be used only in alloc.c, which always disables
1495 HIDE_LISP_IMPLEMENTATION. */
1496 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1497 #endif
1499 /* A character, declared with the following typedef, is a member
1500 of some character set associated with the current buffer. */
1501 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1502 #define _UCHAR_T
1503 typedef unsigned char UCHAR;
1504 #endif
1506 /* Meanings of slots in a Lisp_Compiled: */
1508 #define COMPILED_ARGLIST 0
1509 #define COMPILED_BYTECODE 1
1510 #define COMPILED_CONSTANTS 2
1511 #define COMPILED_STACK_DEPTH 3
1512 #define COMPILED_DOC_STRING 4
1513 #define COMPILED_INTERACTIVE 5
1515 /* Flag bits in a character. These also get used in termhooks.h.
1516 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1517 (MUlti-Lingual Emacs) might need 22 bits for the character value
1518 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1519 #define CHAR_ALT (0x0400000)
1520 #define CHAR_SUPER (0x0800000)
1521 #define CHAR_HYPER (0x1000000)
1522 #define CHAR_SHIFT (0x2000000)
1523 #define CHAR_CTL (0x4000000)
1524 #define CHAR_META (0x8000000)
1526 #define CHAR_MODIFIER_MASK \
1527 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1530 /* Actually, the current Emacs uses 22 bits for the character value
1531 itself. */
1532 #define CHARACTERBITS 22
1534 /* The maximum byte size consumed by push_key_description.
1535 All callers should assure that at least this size of memory is
1536 allocated at the place pointed by the second argument.
1538 There are 6 modifiers, each consumes 2 chars.
1539 The octal form of a character code consumes
1540 (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
1541 We need one more byte for string terminator `\0'. */
1542 #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)
1545 /* The glyph datatype, used to represent characters on the display.
1546 It consists of a char code and a face id. */
1548 typedef struct {
1549 int ch;
1550 int face_id;
1551 } GLYPH;
1553 /* Return a glyph's character code. */
1554 #define GLYPH_CHAR(glyph) ((glyph).ch)
1556 /* Return a glyph's face ID. */
1557 #define GLYPH_FACE(glyph) ((glyph).face_id)
1559 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1560 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1561 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1563 /* Return 1 if GLYPH contains valid character code. */
1564 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph), 1)
1567 /* Glyph Code from a display vector may either be an integer which
1568 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1569 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1571 #define GLYPH_CODE_CHAR(gc) \
1572 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1574 #define GLYPH_CODE_FACE(gc) \
1575 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1577 /* Return 1 if glyph code from display vector contains valid character code. */
1578 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc), 1)
1580 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1582 /* Only called when GLYPH_CODE_P (gc) is true. */
1583 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1584 do \
1586 if (CONSP (gc)) \
1587 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1588 else \
1589 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1590 (XINT (gc) >> CHARACTERBITS)); \
1592 while (0)
1594 /* The ID of the mode line highlighting face. */
1595 #define GLYPH_MODE_LINE_FACE 1
1597 /* Data type checking */
1599 #define NILP(x) EQ (x, Qnil)
1601 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1602 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1604 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1605 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1606 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1607 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1608 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1609 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1611 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1612 #define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1613 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1614 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1615 #define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
1616 #define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
1617 #define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
1618 #define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
1619 #define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
1620 #define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1621 #define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1622 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1623 #define THREADLOCALP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_ThreadLocal)
1626 /* True if object X is a pseudovector whose code is CODE. */
1627 #define PSEUDOVECTORP(x, code) \
1628 (VECTORLIKEP (x) \
1629 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1630 == (PSEUDOVECTOR_FLAG | (code))))
1632 /* Test for specific pseudovector types. */
1633 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1634 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1635 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1636 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1637 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1638 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1639 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1640 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1641 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1642 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1643 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1644 #define THREADP(x) PSEUDOVECTORP (x, PVEC_THREAD)
1645 #define MUTEXP(x) PSEUDOVECTORP (x, PVEC_MUTEX)
1647 /* Test for image (image . spec) */
1648 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1650 /* Array types. */
1652 #define ARRAYP(x) \
1653 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1655 #define CHECK_LIST(x) \
1656 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1658 #define CHECK_LIST_CONS(x, y) \
1659 CHECK_TYPE (CONSP (x), Qlistp, y)
1661 #define CHECK_LIST_END(x, y) \
1662 CHECK_TYPE (NILP (x), Qlistp, y)
1664 #define CHECK_STRING(x) \
1665 CHECK_TYPE (STRINGP (x), Qstringp, x)
1667 #define CHECK_STRING_CAR(x) \
1668 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1670 #define CHECK_CONS(x) \
1671 CHECK_TYPE (CONSP (x), Qconsp, x)
1673 #define CHECK_SYMBOL(x) \
1674 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1676 #define CHECK_CHAR_TABLE(x) \
1677 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1679 #define CHECK_VECTOR(x) \
1680 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1682 #define CHECK_VECTOR_OR_STRING(x) \
1683 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1685 #define CHECK_ARRAY(x, Qxxxp) \
1686 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1688 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1689 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1691 #define CHECK_BUFFER(x) \
1692 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1694 #define CHECK_WINDOW(x) \
1695 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1697 #define CHECK_WINDOW_CONFIGURATION(x) \
1698 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1700 /* This macro rejects windows on the interior of the window tree as
1701 "dead", which is what we want; this is an argument-checking macro, and
1702 the user should never get access to interior windows.
1704 A window of any sort, leaf or interior, is dead if the buffer,
1705 vchild, and hchild members are all nil. */
1707 #define CHECK_LIVE_WINDOW(x) \
1708 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1710 #define CHECK_PROCESS(x) \
1711 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1713 #define CHECK_SUBR(x) \
1714 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1716 #define CHECK_NUMBER(x) \
1717 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1719 #define CHECK_NATNUM(x) \
1720 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1722 #define CHECK_MARKER(x) \
1723 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1725 #define CHECK_NUMBER_COERCE_MARKER(x) \
1726 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1727 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1729 #define XFLOATINT(n) extract_float((n))
1731 #define CHECK_FLOAT(x) \
1732 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1734 #define CHECK_NUMBER_OR_FLOAT(x) \
1735 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1737 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1738 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1739 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1741 #define CHECK_OVERLAY(x) \
1742 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1744 /* Since we can't assign directly to the CAR or CDR fields of a cons
1745 cell, use these when checking that those fields contain numbers. */
1746 #define CHECK_NUMBER_CAR(x) \
1747 do { \
1748 Lisp_Object tmp = XCAR (x); \
1749 CHECK_NUMBER (tmp); \
1750 XSETCAR ((x), tmp); \
1751 } while (0)
1753 #define CHECK_NUMBER_CDR(x) \
1754 do { \
1755 Lisp_Object tmp = XCDR (x); \
1756 CHECK_NUMBER (tmp); \
1757 XSETCDR ((x), tmp); \
1758 } while (0)
1760 #define CHECK_NATNUM_CAR(x) \
1761 do { \
1762 Lisp_Object tmp = XCAR (x); \
1763 CHECK_NATNUM (tmp); \
1764 XSETCAR ((x), tmp); \
1765 } while (0)
1767 #define CHECK_NATNUM_CDR(x) \
1768 do { \
1769 Lisp_Object tmp = XCDR (x); \
1770 CHECK_NATNUM (tmp); \
1771 XSETCDR ((x), tmp); \
1772 } while (0)
1774 /* Cast pointers to this type to compare them. Some machines want int. */
1775 #define PNTR_COMPARISON_TYPE EMACS_UINT
1777 /* Define a built-in function for calling from Lisp.
1778 `lname' should be the name to give the function in Lisp,
1779 as a null-terminated C string.
1780 `fnname' should be the name of the function in C.
1781 By convention, it starts with F.
1782 `sname' should be the name for the C constant structure
1783 that records information on this function for internal use.
1784 By convention, it should be the same as `fnname' but with S instead of F.
1785 It's too bad that C macros can't compute this from `fnname'.
1786 `minargs' should be a number, the minimum number of arguments allowed.
1787 `maxargs' should be a number, the maximum number of arguments allowed,
1788 or else MANY or UNEVALLED.
1789 MANY means pass a vector of evaluated arguments,
1790 in the form of an integer number-of-arguments
1791 followed by the address of a vector of Lisp_Objects
1792 which contains the argument values.
1793 UNEVALLED means pass the list of unevaluated arguments
1794 `intspec' says how interactive arguments are to be fetched.
1795 If the string starts with a `(', `intspec' is evaluated and the resulting
1796 list is the list of arguments.
1797 If it's a string that doesn't start with `(', the value should follow
1798 the one of the doc string for `interactive'.
1799 A null string means call interactively with no arguments.
1800 `doc' is documentation for the user. */
1802 /* This version of DEFUN declares a function prototype with the right
1803 arguments, so we can catch errors with maxargs at compile-time. */
1804 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1805 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1806 DECL_ALIGN (struct Lisp_Subr, sname) = \
1807 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1808 fnname, minargs, maxargs, lname, intspec, 0}; \
1809 Lisp_Object fnname
1811 /* Note that the weird token-substitution semantics of ANSI C makes
1812 this work for MANY and UNEVALLED. */
1813 #define DEFUN_ARGS_MANY (int, Lisp_Object *)
1814 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1815 #define DEFUN_ARGS_0 (void)
1816 #define DEFUN_ARGS_1 (Lisp_Object)
1817 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1818 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1819 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1820 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1821 Lisp_Object)
1822 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1823 Lisp_Object, Lisp_Object)
1824 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1825 Lisp_Object, Lisp_Object, Lisp_Object)
1826 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1827 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1828 /* Non-zero if OBJ is a Lisp function. */
1830 #define FUNCTIONP(OBJ) \
1831 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1832 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1833 || COMPILEDP (OBJ) \
1834 || SUBRP (OBJ))
1836 /* defsubr (Sname);
1837 is how we define the symbol for function `name' at start-up time. */
1838 extern void defsubr P_ ((struct Lisp_Subr *));
1840 #define MANY -2
1841 #define UNEVALLED -1
1843 extern void defvar_lisp (const char *, Lisp_Object *);
1844 extern void defvar_lisp_nopro (const char *, Lisp_Object *);
1845 extern void defvar_bool (const char *, int *);
1846 extern void defvar_int (const char *, EMACS_INT *);
1847 extern void defvar_kboard (const char *, int);
1849 /* Macros we use to define forwarded Lisp variables.
1850 These are used in the syms_of_FILENAME functions. */
1852 #define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
1853 #define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
1854 #define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
1855 #define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
1857 #define DEFVAR_KBOARD(lname, vname, doc) \
1858 defvar_kboard (lname, \
1859 (int)((char *)(&current_kboard->vname) \
1860 - (char *)current_kboard))
1864 /* Structure for recording Lisp call stack for backtrace purposes. */
1866 /* The special binding stack holds the outer values of variables while
1867 they are bound by a function application or a let form, stores the
1868 code to be executed for Lisp unwind-protect forms, and stores the C
1869 functions to be called for record_unwind_protect.
1871 If func is non-zero, undoing this binding applies func to old_value;
1872 This implements record_unwind_protect.
1874 Otherwise, the element is a variable binding.
1876 If the symbol field is a symbol, it is an ordinary variable binding.
1878 Otherwise, it should be a structure (SYMBOL WHERE
1879 . CURRENT-BUFFER), which means having bound a local value while
1880 CURRENT-BUFFER was active. If WHERE is nil this means we saw the
1881 default value when binding SYMBOL. WHERE being a buffer or frame
1882 means we saw a buffer-local or frame-local value. Other values of
1883 WHERE mean an internal error. */
1885 typedef Lisp_Object (*specbinding_func) P_ ((Lisp_Object));
1887 struct specbinding
1889 Lisp_Object symbol, old_value;
1890 specbinding_func func;
1891 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
1894 extern EMACS_INT max_specpdl_size;
1896 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
1898 /* Everything needed to describe an active condition case. */
1899 struct handler
1901 /* The handler clauses and variable from the condition-case form. */
1902 /* For a handler set up in Lisp code, this is always a list.
1903 For an internal handler set up by internal_condition_case*,
1904 this can instead be the symbol t or `error'.
1905 t: handle all conditions.
1906 error: handle all conditions, and errors can run the debugger
1907 or display a backtrace. */
1908 Lisp_Object handler;
1909 Lisp_Object var;
1910 /* Fsignal stores here the condition-case clause that applies,
1911 and Fcondition_case thus knows which clause to run. */
1912 Lisp_Object chosen_clause;
1914 /* Used to effect the longjump out to the handler. */
1915 struct catchtag *tag;
1917 /* The next enclosing handler. */
1918 struct handler *next;
1921 extern struct handler *handlerlist;
1923 /* This structure helps implement the `catch' and `throw' control
1924 structure. A struct catchtag contains all the information needed
1925 to restore the state of the interpreter after a non-local jump.
1927 Handlers for error conditions (represented by `struct handler'
1928 structures) just point to a catch tag to do the cleanup required
1929 for their jumps.
1931 catchtag structures are chained together in the C calling stack;
1932 the `next' member points to the next outer catchtag.
1934 A call like (throw TAG VAL) searches for a catchtag whose `tag'
1935 member is TAG, and then unbinds to it. The `val' member is used to
1936 hold VAL while the stack is unwound; `val' is returned as the value
1937 of the catch form.
1939 All the other members are concerned with restoring the interpreter
1940 state. */
1942 struct catchtag
1944 Lisp_Object tag;
1945 Lisp_Object val;
1946 struct catchtag *next;
1947 struct gcpro *gcpro;
1948 jmp_buf jmp;
1949 struct backtrace *backlist;
1950 struct handler *handlerlist;
1951 int lisp_eval_depth;
1952 int pdlcount;
1953 int poll_suppress_count;
1954 int interrupt_input_blocked;
1955 struct byte_stack *byte_stack;
1958 extern struct catchtag *catchlist;
1959 extern struct backtrace *backtrace_list;
1961 extern Lisp_Object memory_signal_data;
1963 /* Check quit-flag and quit if it is non-nil.
1964 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
1965 So the program needs to do QUIT at times when it is safe to quit.
1966 Every loop that might run for a long time or might not exit
1967 ought to do QUIT at least once, at a safe place.
1968 Unless that is impossible, of course.
1969 But it is very desirable to avoid creating loops where QUIT is impossible.
1971 Exception: if you set immediate_quit to nonzero,
1972 then the handler that responds to the C-g does the quit itself.
1973 This is a good thing to do around a loop that has no side effects
1974 and (in particular) cannot call arbitrary Lisp code. */
1976 #ifdef SYNC_INPUT
1977 extern void process_pending_signals P_ ((void));
1978 extern int pending_signals;
1979 #define ELSE_PENDING_SIGNALS \
1980 else if (pending_signals) \
1981 process_pending_signals ();
1982 #else /* not SYNC_INPUT */
1983 #define ELSE_PENDING_SIGNALS
1984 #endif /* not SYNC_INPUT */
1986 #define QUIT \
1987 do { \
1988 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1990 Lisp_Object flag = Vquit_flag; \
1991 Vquit_flag = Qnil; \
1992 if (EQ (Vthrow_on_input, flag)) \
1993 Fthrow (Vthrow_on_input, Qt); \
1994 Fsignal (Qquit, Qnil); \
1996 ELSE_PENDING_SIGNALS \
1997 } while (0)
2000 /* Nonzero if ought to quit now. */
2002 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2004 /* Variables used locally in the following case handling macros. */
2005 extern int case_temp1;
2006 extern Lisp_Object case_temp2;
2008 /* Current buffer's map from characters to lower-case characters. */
2010 #define DOWNCASE_TABLE BUF_DOWNCASE_TABLE (current_buffer)
2012 /* Current buffer's map from characters to upper-case characters. */
2014 #define UPCASE_TABLE BUF_UPCASE_TABLE (current_buffer)
2016 /* Downcase a character, or make no change if that cannot be done. */
2018 #define DOWNCASE(CH) \
2019 ((case_temp1 = (CH), \
2020 case_temp2 = CHAR_TABLE_REF (DOWNCASE_TABLE, case_temp1), \
2021 NATNUMP (case_temp2)) \
2022 ? XFASTINT (case_temp2) : case_temp1)
2024 /* 1 if CH is upper case. */
2026 #define UPPERCASEP(CH) (DOWNCASE (CH) != (CH))
2028 /* 1 if CH is neither upper nor lower case. */
2030 #define NOCASEP(CH) (UPCASE1 (CH) == (CH))
2032 /* 1 if CH is lower case. */
2034 #define LOWERCASEP(CH) (!UPPERCASEP (CH) && !NOCASEP(CH))
2036 /* Upcase a character, or make no change if that cannot be done. */
2038 #define UPCASE(CH) (!UPPERCASEP (CH) ? UPCASE1 (CH) : (CH))
2040 /* Upcase a character known to be not upper case. */
2042 #define UPCASE1(CH) \
2043 ((case_temp1 = (CH), \
2044 case_temp2 = CHAR_TABLE_REF (UPCASE_TABLE, case_temp1), \
2045 NATNUMP (case_temp2)) \
2046 ? XFASTINT (case_temp2) : case_temp1)
2048 extern Lisp_Object Vascii_downcase_table, Vascii_upcase_table;
2049 extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
2051 /* Number of bytes of structure consed since last GC. */
2053 extern int consing_since_gc;
2055 /* Thresholds for doing another gc. */
2057 extern EMACS_INT gc_cons_threshold;
2059 extern EMACS_INT gc_relative_threshold;
2061 extern EMACS_INT memory_full_cons_threshold;
2063 /* Structure for recording stack slots that need marking. */
2065 /* This is a chain of structures, each of which points at a Lisp_Object variable
2066 whose value should be marked in garbage collection.
2067 Normally every link of the chain is an automatic variable of a function,
2068 and its `val' points to some argument or local variable of the function.
2069 On exit to the function, the chain is set back to the value it had on entry.
2070 This way, no link remains in the chain when the stack frame containing the
2071 link disappears.
2073 Every function that can call Feval must protect in this fashion all
2074 Lisp_Object variables whose contents will be used again. */
2076 struct gcpro
2078 struct gcpro *next;
2080 /* Address of first protected variable. */
2081 volatile Lisp_Object *var;
2083 /* Number of consecutive protected variables. */
2084 int nvars;
2086 #ifdef DEBUG_GCPRO
2087 int level;
2088 #endif
2091 /* Values of GC_MARK_STACK during compilation:
2093 0 Use GCPRO as before
2094 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2095 2 Mark the stack, and check that everything GCPRO'd is
2096 marked.
2097 3 Mark using GCPRO's, mark stack last, and count how many
2098 dead objects are kept alive. */
2101 #define GC_USE_GCPROS_AS_BEFORE 0
2102 #define GC_MAKE_GCPROS_NOOPS 1
2103 #define GC_MARK_STACK_CHECK_GCPROS 2
2104 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2106 #ifndef GC_MARK_STACK
2107 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2108 #endif
2110 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2112 /* Do something silly with gcproN vars just so gcc shuts up. */
2113 /* You get warnings from MIPSPro... */
2115 #define GCPRO1(varname) ((void) gcpro1)
2116 #define GCPRO2(varname1, varname2)(((void) gcpro2, (void) gcpro1))
2117 #define GCPRO3(varname1, varname2, varname3) \
2118 (((void) gcpro3, (void) gcpro2, (void) gcpro1))
2119 #define GCPRO4(varname1, varname2, varname3, varname4) \
2120 (((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2121 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2122 (((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2123 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2124 (((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2125 #define UNGCPRO ((void) 0)
2127 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2129 #ifndef DEBUG_GCPRO
2131 #define GCPRO1(varname) \
2132 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2133 gcprolist = &gcpro1; }
2135 #define GCPRO2(varname1, varname2) \
2136 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2137 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2138 gcprolist = &gcpro2; }
2140 #define GCPRO3(varname1, varname2, varname3) \
2141 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2142 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2143 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2144 gcprolist = &gcpro3; }
2146 #define GCPRO4(varname1, varname2, varname3, varname4) \
2147 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2148 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2149 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2150 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2151 gcprolist = &gcpro4; }
2153 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2154 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2155 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2156 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2157 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2158 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2159 gcprolist = &gcpro5; }
2161 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2162 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2163 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2164 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2165 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2166 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2167 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2168 gcprolist = &gcpro6; }
2170 #define UNGCPRO (gcprolist = gcpro1.next)
2172 #else
2174 #define GCPRO1(varname) \
2175 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2176 gcpro1.level = gcpro_level++; \
2177 gcprolist = &gcpro1; }
2179 #define GCPRO2(varname1, varname2) \
2180 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2181 gcpro1.level = gcpro_level; \
2182 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2183 gcpro2.level = gcpro_level++; \
2184 gcprolist = &gcpro2; }
2186 #define GCPRO3(varname1, varname2, varname3) \
2187 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2188 gcpro1.level = gcpro_level; \
2189 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2190 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2191 gcpro3.level = gcpro_level++; \
2192 gcprolist = &gcpro3; }
2194 #define GCPRO4(varname1, varname2, varname3, varname4) \
2195 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2196 gcpro1.level = gcpro_level; \
2197 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2198 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2199 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2200 gcpro4.level = gcpro_level++; \
2201 gcprolist = &gcpro4; }
2203 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2204 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2205 gcpro1.level = gcpro_level; \
2206 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2207 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2208 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2209 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2210 gcpro5.level = gcpro_level++; \
2211 gcprolist = &gcpro5; }
2213 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2214 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2215 gcpro1.level = gcpro_level; \
2216 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2217 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2218 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2219 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2220 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2221 gcpro6.level = gcpro_level++; \
2222 gcprolist = &gcpro6; }
2224 #define UNGCPRO \
2225 ((--gcpro_level != gcpro1.level) \
2226 ? (abort (), 0) \
2227 : ((gcprolist = gcpro1.next), 0))
2229 #endif /* DEBUG_GCPRO */
2230 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2233 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2234 #define RETURN_UNGCPRO(expr) \
2235 do \
2237 Lisp_Object ret_ungc_val; \
2238 ret_ungc_val = (expr); \
2239 UNGCPRO; \
2240 return ret_ungc_val; \
2242 while (0)
2244 /* Call staticpro (&var) to protect static variable `var'. */
2246 void staticpro P_ ((Lisp_Object *));
2248 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2249 meaning as in the DEFUN macro, and is used to construct a prototype. */
2250 /* We can use the same trick as in the DEFUN macro to generate the
2251 appropriate prototype. */
2252 #define EXFUN(fnname, maxargs) \
2253 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2255 /* Forward declarations for prototypes. */
2256 struct window;
2257 struct frame;
2259 /* Defined in data.c */
2260 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
2261 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
2262 extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
2263 extern Lisp_Object Qvoid_variable, Qvoid_function;
2264 extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
2265 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
2266 extern Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
2267 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
2268 extern Lisp_Object Qtext_read_only;
2270 extern Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
2271 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
2272 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
2273 extern Lisp_Object Qbuffer_or_string_p;
2274 extern Lisp_Object Qboundp, Qfboundp;
2275 extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
2277 extern Lisp_Object Qcdr;
2279 extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
2280 extern Lisp_Object Qoverflow_error, Qunderflow_error;
2282 extern Lisp_Object Qfloatp;
2283 extern Lisp_Object Qnumberp, Qnumber_or_marker_p;
2285 extern Lisp_Object Qinteger;
2287 extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
2289 extern void circular_list_error P_ ((Lisp_Object)) NO_RETURN;
2290 EXFUN (Finteractive_form, 1);
2291 EXFUN (Fbyteorder, 0);
2293 /* Defined in frame.c */
2294 extern Lisp_Object Qframep;
2296 EXFUN (Feq, 2);
2297 EXFUN (Fnull, 1);
2298 EXFUN (Flistp, 1);
2299 EXFUN (Fconsp, 1);
2300 EXFUN (Fatom, 1);
2301 EXFUN (Fnlistp, 1);
2302 EXFUN (Fintegerp, 1);
2303 EXFUN (Fnatnump, 1);
2304 EXFUN (Fsymbolp, 1);
2305 EXFUN (Fvectorp, 1);
2306 EXFUN (Fstringp, 1);
2307 EXFUN (Fmultibyte_string_p, 1);
2308 EXFUN (Farrayp, 1);
2309 EXFUN (Fsequencep, 1);
2310 EXFUN (Fbufferp, 1);
2311 EXFUN (Fmarkerp, 1);
2312 EXFUN (Fsubrp, 1);
2313 EXFUN (Fchar_or_string_p, 1);
2314 EXFUN (Finteger_or_marker_p, 1);
2315 EXFUN (Ffloatp, 1);
2316 EXFUN (Finteger_or_floatp, 1);
2317 EXFUN (Finteger_or_float_or_marker_p, 1);
2319 EXFUN (Fcar, 1);
2320 EXFUN (Fcar_safe, 1);
2321 EXFUN (Fcdr, 1);
2322 EXFUN (Fcdr_safe, 1);
2323 EXFUN (Fsetcar, 2);
2324 EXFUN (Fsetcdr, 2);
2325 EXFUN (Fboundp, 1);
2326 EXFUN (Ffboundp, 1);
2327 EXFUN (Fmakunbound, 1);
2328 EXFUN (Ffmakunbound, 1);
2329 EXFUN (Fsymbol_function, 1);
2330 EXFUN (Fsymbol_plist, 1);
2331 EXFUN (Fsymbol_name, 1);
2332 extern Lisp_Object indirect_function P_ ((Lisp_Object));
2333 EXFUN (Findirect_function, 2);
2334 EXFUN (Ffset, 2);
2335 EXFUN (Fsetplist, 2);
2336 EXFUN (Fsymbol_value, 1);
2337 extern Lisp_Object find_symbol_value P_ ((Lisp_Object));
2338 EXFUN (Fset, 2);
2339 EXFUN (Fdefault_value, 1);
2340 EXFUN (Fset_default, 2);
2341 EXFUN (Fdefault_boundp, 1);
2342 EXFUN (Fmake_local_variable, 1);
2343 EXFUN (Flocal_variable_p, 2);
2344 EXFUN (Flocal_variable_if_set_p, 2);
2346 EXFUN (Faref, 2);
2347 EXFUN (Faset, 3);
2349 EXFUN (Fstring_to_number, 2);
2350 EXFUN (Fnumber_to_string, 1);
2351 EXFUN (Feqlsign, 2);
2352 EXFUN (Fgtr, 2);
2353 EXFUN (Flss, 2);
2354 EXFUN (Fgeq, 2);
2355 EXFUN (Fleq, 2);
2356 EXFUN (Fneq, 2);
2357 EXFUN (Fzerop, 1);
2358 EXFUN (Fplus, MANY);
2359 EXFUN (Fminus, MANY);
2360 EXFUN (Ftimes, MANY);
2361 EXFUN (Fquo, MANY);
2362 EXFUN (Frem, 2);
2363 EXFUN (Fmax, MANY);
2364 EXFUN (Fmin, MANY);
2365 EXFUN (Flogand, MANY);
2366 EXFUN (Flogior, MANY);
2367 EXFUN (Flogxor, MANY);
2368 EXFUN (Flognot, 1);
2369 EXFUN (Flsh, 2);
2370 EXFUN (Fash, 2);
2372 EXFUN (Fadd1, 1);
2373 EXFUN (Fsub1, 1);
2374 EXFUN (Fmake_variable_buffer_local, 1);
2376 extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *);
2377 extern Lisp_Object *find_variable_location (Lisp_Object *);
2378 extern Lisp_Object ensure_thread_local (Lisp_Object *);
2379 extern void remove_thread_local P_ ((Lisp_Object *));
2380 extern Lisp_Object Qthread_local_mark;
2381 extern Lisp_Object long_to_cons P_ ((unsigned long));
2382 extern unsigned long cons_to_long P_ ((Lisp_Object));
2383 extern void args_out_of_range P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2384 extern void args_out_of_range_3 P_ ((Lisp_Object, Lisp_Object,
2385 Lisp_Object)) NO_RETURN;
2386 extern Lisp_Object wrong_type_argument P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2387 extern void store_symval_forwarding P_ ((Lisp_Object, Lisp_Object,
2388 Lisp_Object, struct buffer *));
2389 extern Lisp_Object do_symval_forwarding P_ ((Lisp_Object));
2390 extern Lisp_Object set_internal P_ ((Lisp_Object, Lisp_Object, struct buffer *, int));
2391 extern void syms_of_data P_ ((void));
2392 extern void init_data P_ ((void));
2393 extern void swap_in_global_binding P_ ((Lisp_Object));
2395 /* Defined in cmds.c */
2396 EXFUN (Fend_of_line, 1);
2397 EXFUN (Fforward_char, 1);
2398 EXFUN (Fforward_line, 1);
2399 extern int internal_self_insert P_ ((int, int));
2400 extern void syms_of_cmds P_ ((void));
2401 extern void keys_of_cmds P_ ((void));
2403 /* Defined in coding.c */
2404 EXFUN (Fcoding_system_p, 1);
2405 EXFUN (Fcoding_system_base, 1);
2406 EXFUN (Fcoding_system_eol_type, 1);
2407 EXFUN (Fcheck_coding_system, 1);
2408 EXFUN (Fcheck_coding_system, 1);
2409 EXFUN (Fread_coding_system, 2);
2410 EXFUN (Fread_non_nil_coding_system, 1);
2411 EXFUN (Ffind_operation_coding_system, MANY);
2412 EXFUN (Fupdate_coding_systems_internal, 0);
2413 EXFUN (Fencode_coding_string, 4);
2414 EXFUN (Fdecode_coding_string, 4);
2415 extern Lisp_Object detect_coding_system P_ ((const unsigned char *, EMACS_INT,
2416 EMACS_INT, int, int, Lisp_Object));
2417 extern void init_coding P_ ((void));
2418 extern void init_coding_once P_ ((void));
2419 extern void syms_of_coding P_ ((void));
2421 /* Defined in character.c */
2422 extern void init_character_once P_ ((void));
2423 extern void syms_of_character P_ ((void));
2424 EXFUN (Funibyte_char_to_multibyte, 1);
2426 /* Defined in charset.c */
2427 EXFUN (Fchar_bytes, 1);
2428 EXFUN (Fchar_width, 1);
2429 EXFUN (Fstring, MANY);
2430 extern EMACS_INT chars_in_text P_ ((const unsigned char *, EMACS_INT));
2431 extern EMACS_INT multibyte_chars_in_text P_ ((const unsigned char *, EMACS_INT));
2432 extern int multibyte_char_to_unibyte P_ ((int, Lisp_Object));
2433 extern int multibyte_char_to_unibyte_safe P_ ((int));
2434 extern Lisp_Object Qcharset;
2435 extern void init_charset P_ ((void));
2436 extern void init_charset_once P_ ((void));
2437 extern void syms_of_charset P_ ((void));
2438 /* Structure forward declarations. */
2439 struct charset;
2441 /* Defined in composite.c */
2442 extern void syms_of_composite P_ ((void));
2444 /* Defined in syntax.c */
2445 EXFUN (Fforward_word, 1);
2446 EXFUN (Fskip_chars_forward, 2);
2447 EXFUN (Fskip_chars_backward, 2);
2448 EXFUN (Fsyntax_table_p, 1);
2449 EXFUN (Fsyntax_table, 0);
2450 EXFUN (Fset_syntax_table, 1);
2451 extern void init_syntax_once P_ ((void));
2452 extern void syms_of_syntax P_ ((void));
2454 /* Defined in fns.c */
2455 extern int use_dialog_box;
2456 extern int next_almost_prime P_ ((int));
2457 extern Lisp_Object larger_vector P_ ((Lisp_Object, int, Lisp_Object));
2458 extern void sweep_weak_hash_tables P_ ((void));
2459 extern Lisp_Object Qstring_lessp;
2460 extern Lisp_Object impl_Vfeatures;
2461 extern Lisp_Object QCtest, QCweakness, Qequal, Qeq;
2462 unsigned sxhash P_ ((Lisp_Object, int));
2463 Lisp_Object make_hash_table P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
2464 Lisp_Object, Lisp_Object, Lisp_Object,
2465 Lisp_Object));
2466 Lisp_Object copy_hash_table P_ ((struct Lisp_Hash_Table *));
2467 int hash_lookup P_ ((struct Lisp_Hash_Table *, Lisp_Object, unsigned *));
2468 int hash_put P_ ((struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
2469 unsigned));
2470 void hash_clear P_ ((struct Lisp_Hash_Table *));
2471 void init_weak_hash_tables P_ ((void));
2472 extern void init_fns P_ ((void));
2473 EXFUN (Fsxhash, 1);
2474 EXFUN (Fmake_hash_table, MANY);
2475 EXFUN (Fmakehash, 1);
2476 EXFUN (Fcopy_hash_table, 1);
2477 EXFUN (Fhash_table_count, 1);
2478 EXFUN (Fhash_table_rehash_size, 1);
2479 EXFUN (Fhash_table_rehash_threshold, 1);
2480 EXFUN (Fhash_table_size, 1);
2481 EXFUN (Fhash_table_test, 1);
2482 EXFUN (Fhash_table_weak, 1);
2483 EXFUN (Fhash_table_p, 1);
2484 EXFUN (Fclrhash, 1);
2485 EXFUN (Fgethash, 3);
2486 EXFUN (Fputhash, 3);
2487 EXFUN (Fremhash, 2);
2488 EXFUN (Fmaphash, 2);
2489 EXFUN (Fdefine_hash_table_test, 3);
2491 EXFUN (Fidentity, 1);
2492 EXFUN (Frandom, 1);
2493 EXFUN (Flength, 1);
2494 EXFUN (Fsafe_length, 1);
2495 EXFUN (Fappend, MANY);
2496 EXFUN (Fconcat, MANY);
2497 EXFUN (Fvconcat, MANY);
2498 EXFUN (Fcopy_sequence, 1);
2499 EXFUN (Fstring_make_multibyte, 1);
2500 EXFUN (Fstring_make_unibyte, 1);
2501 EXFUN (Fstring_as_multibyte, 1);
2502 EXFUN (Fstring_as_unibyte, 1);
2503 EXFUN (Fstring_to_multibyte, 1);
2504 EXFUN (Fstring_to_unibyte, 1);
2505 EXFUN (Fsubstring, 3);
2506 extern Lisp_Object substring_both P_ ((Lisp_Object, int, int, int, int));
2507 EXFUN (Fnth, 2);
2508 EXFUN (Fnthcdr, 2);
2509 EXFUN (Fmemq, 2);
2510 EXFUN (Fassq, 2);
2511 EXFUN (Fassoc, 2);
2512 EXFUN (Felt, 2);
2513 EXFUN (Fmember, 2);
2514 EXFUN (Frassq, 2);
2515 EXFUN (Fdelq, 2);
2516 EXFUN (Fdelete, 2);
2517 EXFUN (Fsort, 2);
2518 EXFUN (Freverse, 1);
2519 EXFUN (Fnreverse, 1);
2520 EXFUN (Fget, 2);
2521 EXFUN (Fput, 3);
2522 EXFUN (Fequal, 2);
2523 EXFUN (Ffillarray, 2);
2524 EXFUN (Fnconc, MANY);
2525 EXFUN (Fmapcar, 2);
2526 EXFUN (Fmapconcat, 3);
2527 EXFUN (Fy_or_n_p, 1);
2528 extern Lisp_Object do_yes_or_no_p P_ ((Lisp_Object));
2529 EXFUN (Frequire, 3);
2530 EXFUN (Fprovide, 2);
2531 extern Lisp_Object concat2 P_ ((Lisp_Object, Lisp_Object));
2532 extern Lisp_Object concat3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2533 extern Lisp_Object nconc2 P_ ((Lisp_Object, Lisp_Object));
2534 extern Lisp_Object assq_no_quit P_ ((Lisp_Object, Lisp_Object));
2535 extern Lisp_Object assoc_no_quit P_ ((Lisp_Object, Lisp_Object));
2536 extern void clear_string_char_byte_cache P_ ((void));
2537 extern EMACS_INT string_char_to_byte P_ ((Lisp_Object, EMACS_INT));
2538 extern EMACS_INT string_byte_to_char P_ ((Lisp_Object, EMACS_INT));
2539 extern Lisp_Object string_make_multibyte P_ ((Lisp_Object));
2540 extern Lisp_Object string_to_multibyte P_ ((Lisp_Object));
2541 extern Lisp_Object string_make_unibyte P_ ((Lisp_Object));
2542 EXFUN (Fcopy_alist, 1);
2543 EXFUN (Fplist_get, 2);
2544 EXFUN (Fplist_put, 3);
2545 EXFUN (Fplist_member, 2);
2546 EXFUN (Frassoc, 2);
2547 EXFUN (Fstring_equal, 2);
2548 EXFUN (Fcompare_strings, 7);
2549 EXFUN (Fstring_lessp, 2);
2550 extern void syms_of_fns P_ ((void));
2552 /* Defined in floatfns.c */
2553 extern double extract_float P_ ((Lisp_Object));
2554 EXFUN (Ffloat, 1);
2555 EXFUN (Ftruncate, 2);
2556 extern void init_floatfns P_ ((void));
2557 extern void syms_of_floatfns P_ ((void));
2559 /* Defined in fringe.c */
2560 extern void syms_of_fringe P_ ((void));
2561 extern void init_fringe P_ ((void));
2562 extern void init_fringe_once P_ ((void));
2564 /* Defined in image.c */
2565 EXFUN (Finit_image_library, 2);
2566 extern void syms_of_image P_ ((void));
2567 extern void init_image P_ ((void));
2569 /* Defined in insdel.c */
2570 extern Lisp_Object Qinhibit_modification_hooks;
2571 extern void move_gap (EMACS_INT);
2572 extern void move_gap_both (EMACS_INT, EMACS_INT);
2573 extern void make_gap (EMACS_INT);
2574 extern EMACS_INT copy_text (const unsigned char *, unsigned char *,
2575 EMACS_INT, int, int);
2576 extern EMACS_INT count_size_as_multibyte (const unsigned char *, EMACS_INT);
2577 extern int count_combining_before (const unsigned char *,
2578 EMACS_INT, EMACS_INT, EMACS_INT);
2579 extern int count_combining_after (const unsigned char *,
2580 EMACS_INT, EMACS_INT, EMACS_INT);
2581 extern void insert (const unsigned char *, EMACS_INT);
2582 extern void insert_and_inherit (const unsigned char *, EMACS_INT);
2583 extern void insert_1 (const unsigned char *, EMACS_INT, int, int, int);
2584 extern void insert_1_both (const unsigned char *, EMACS_INT, EMACS_INT,
2585 int, int, int);
2586 extern void insert_from_gap (EMACS_INT, EMACS_INT);
2587 extern void insert_from_string (Lisp_Object, EMACS_INT, EMACS_INT,
2588 EMACS_INT, EMACS_INT, int);
2589 extern void insert_from_buffer (struct buffer *, EMACS_INT, EMACS_INT, int);
2590 extern void insert_char (int);
2591 extern void insert_string (const char *);
2592 extern void insert_before_markers (const unsigned char *, EMACS_INT);
2593 extern void insert_before_markers_and_inherit (const unsigned char *,
2594 EMACS_INT);
2595 extern void insert_from_string_before_markers (Lisp_Object, EMACS_INT,
2596 EMACS_INT, EMACS_INT,
2597 EMACS_INT, int);
2598 extern void del_range (EMACS_INT, EMACS_INT);
2599 extern Lisp_Object del_range_1 (EMACS_INT, EMACS_INT, int, int);
2600 extern void del_range_byte (EMACS_INT, EMACS_INT, int);
2601 extern void del_range_both (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT, int);
2602 extern Lisp_Object del_range_2 (EMACS_INT, EMACS_INT,
2603 EMACS_INT, EMACS_INT, int);
2604 extern void modify_region (struct buffer *, EMACS_INT, EMACS_INT, int);
2605 extern void prepare_to_modify_buffer (EMACS_INT, EMACS_INT, EMACS_INT *);
2606 extern void signal_before_change (EMACS_INT, EMACS_INT, EMACS_INT *);
2607 extern void signal_after_change (EMACS_INT, EMACS_INT, EMACS_INT);
2608 extern void adjust_after_replace (EMACS_INT, EMACS_INT, Lisp_Object,
2609 EMACS_INT, EMACS_INT);
2610 extern void adjust_after_replace_noundo (EMACS_INT, EMACS_INT, EMACS_INT,
2611 EMACS_INT, EMACS_INT, EMACS_INT);
2612 extern void adjust_after_insert (EMACS_INT, EMACS_INT, EMACS_INT,
2613 EMACS_INT, EMACS_INT);
2614 extern void adjust_markers_for_delete (EMACS_INT, EMACS_INT,
2615 EMACS_INT, EMACS_INT);
2616 extern void replace_range (EMACS_INT, EMACS_INT, Lisp_Object, int, int, int);
2617 extern void replace_range_2 (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
2618 char *, EMACS_INT, EMACS_INT, int);
2619 extern void syms_of_insdel (void);
2621 /* Defined in dispnew.c */
2622 extern Lisp_Object selected_frame;
2623 extern EMACS_INT baud_rate;
2624 EXFUN (Fding, 1);
2625 EXFUN (Fredraw_frame, 1);
2626 EXFUN (Fredraw_display, 0);
2627 EXFUN (Fsleep_for, 2);
2628 EXFUN (Fredisplay, 1);
2629 extern Lisp_Object sit_for P_ ((Lisp_Object, int, int));
2630 extern void init_display P_ ((void));
2631 extern void syms_of_display P_ ((void));
2632 extern void safe_bcopy P_ ((const char *, char *, int));
2634 /* Defined in xdisp.c */
2635 extern Lisp_Object Qinhibit_point_motion_hooks;
2636 extern Lisp_Object Qinhibit_redisplay, Qdisplay;
2637 extern Lisp_Object Qinhibit_eval_during_redisplay;
2638 extern Lisp_Object Qmessage_truncate_lines;
2639 extern Lisp_Object Qimage;
2640 extern Lisp_Object impl_Vmessage_log_max;
2641 extern int message_enable_multibyte;
2642 extern Lisp_Object echo_area_buffer[2];
2643 extern void check_message_stack P_ ((void));
2644 extern void setup_echo_area_for_printing P_ ((int));
2645 extern int push_message P_ ((void));
2646 extern Lisp_Object pop_message_unwind P_ ((Lisp_Object));
2647 extern Lisp_Object restore_message_unwind P_ ((Lisp_Object));
2648 extern void pop_message P_ ((void));
2649 extern void restore_message P_ ((void));
2650 extern Lisp_Object current_message P_ ((void));
2651 extern void set_message P_ ((const char *s, Lisp_Object, int, int));
2652 extern void clear_message P_ ((int, int));
2653 extern void message P_ ((/* char *, ... */));
2654 extern void message_nolog P_ ((/* char *, ... */));
2655 extern void message1 P_ ((char *));
2656 extern void message1_nolog P_ ((char *));
2657 extern void message2 P_ ((const char *, int, int));
2658 extern void message2_nolog P_ ((const char *, int, int));
2659 extern void message3 P_ ((Lisp_Object, int, int));
2660 extern void message3_nolog P_ ((Lisp_Object, int, int));
2661 extern void message_dolog P_ ((const char *, int, int, int));
2662 extern void message_with_string P_ ((char *, Lisp_Object, int));
2663 extern void message_log_maybe_newline P_ ((void));
2664 extern void update_echo_area P_ ((void));
2665 extern void truncate_echo_area P_ ((int));
2666 extern void redisplay P_ ((void));
2667 extern int check_point_in_composition
2668 P_ ((struct buffer *, int, struct buffer *, int));
2669 extern void redisplay_preserve_echo_area P_ ((int));
2670 extern void prepare_menu_bars P_ ((void));
2672 void set_frame_cursor_types P_ ((struct frame *, Lisp_Object));
2673 extern void syms_of_xdisp P_ ((void));
2674 extern void init_xdisp P_ ((void));
2675 extern Lisp_Object safe_eval P_ ((Lisp_Object));
2676 extern int pos_visible_p P_ ((struct window *, int, int *,
2677 int *, int *, int *, int *, int *));
2679 /* Defined in xsettings.c */
2680 extern void syms_of_xsettings P_ ((void));
2682 /* Defined in vm-limit.c. */
2683 extern void memory_warnings P_ ((POINTER_TYPE *, void (*warnfun) ()));
2685 /* Defined in alloc.c */
2686 extern void check_pure_size P_ ((void));
2687 extern void allocate_string_data P_ ((struct Lisp_String *, int, int));
2688 extern void reset_malloc_hooks P_ ((void));
2689 extern void uninterrupt_malloc P_ ((void));
2690 extern void malloc_warning P_ ((char *));
2691 extern void memory_full P_ ((void)) NO_RETURN;
2692 extern void buffer_memory_full P_ ((void)) NO_RETURN;
2693 extern int survives_gc_p P_ ((Lisp_Object));
2694 extern void mark_object P_ ((Lisp_Object));
2695 extern Lisp_Object impl_Vpurify_flag;
2696 extern Lisp_Object impl_Vmemory_full;
2697 EXFUN (Fcons, 2);
2698 EXFUN (list1, 1);
2699 EXFUN (list2, 2);
2700 EXFUN (list3, 3);
2701 EXFUN (list4, 4);
2702 EXFUN (list5, 5);
2703 EXFUN (Flist, MANY);
2704 EXFUN (Fmake_list, 2);
2705 extern Lisp_Object allocate_misc P_ ((void));
2706 EXFUN (Fmake_vector, 2);
2707 EXFUN (Fvector, MANY);
2708 EXFUN (Fmake_symbol, 1);
2709 EXFUN (Fmake_marker, 0);
2710 EXFUN (Fmake_string, 2);
2711 extern Lisp_Object build_string P_ ((const char *));
2712 extern Lisp_Object make_string P_ ((const char *, int));
2713 extern Lisp_Object make_unibyte_string P_ ((const char *, int));
2714 extern Lisp_Object make_multibyte_string P_ ((const char *, int, int));
2715 extern Lisp_Object make_event_array P_ ((int, Lisp_Object *));
2716 extern Lisp_Object make_uninit_string P_ ((int));
2717 extern Lisp_Object make_uninit_multibyte_string P_ ((int, int));
2718 extern Lisp_Object make_string_from_bytes P_ ((const char *, int, int));
2719 extern Lisp_Object make_specified_string P_ ((const char *, int, int, int));
2720 EXFUN (Fpurecopy, 1);
2721 extern Lisp_Object make_pure_string P_ ((const char *, int, int, int));
2722 extern Lisp_Object make_pure_c_string (const char *data);
2723 extern Lisp_Object pure_cons P_ ((Lisp_Object, Lisp_Object));
2724 extern Lisp_Object make_pure_vector P_ ((EMACS_INT));
2725 EXFUN (Fgarbage_collect, 0);
2726 EXFUN (Fmake_byte_code, MANY);
2727 EXFUN (Fmake_bool_vector, 2);
2728 extern Lisp_Object Qchar_table_extra_slots;
2729 extern struct Lisp_Vector *allocate_vector P_ ((EMACS_INT));
2730 extern struct Lisp_Vector *allocate_pseudovector P_ ((int memlen, int lisplen, EMACS_INT tag));
2731 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2732 ((typ*) \
2733 allocate_pseudovector \
2734 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2735 extern struct Lisp_Hash_Table *allocate_hash_table P_ ((void));
2736 extern struct window *allocate_window P_ ((void));
2737 extern struct frame *allocate_frame P_ ((void));
2738 extern struct Lisp_Process *allocate_process P_ ((void));
2739 extern struct Lisp_Mutex *allocate_mutex P_ ((void));
2740 extern struct terminal *allocate_terminal P_ ((void));
2741 extern int gc_in_progress;
2742 extern int abort_on_gc;
2743 extern Lisp_Object make_float P_ ((double));
2744 extern void display_malloc_warning P_ ((void));
2745 extern int inhibit_garbage_collection P_ ((void));
2746 extern Lisp_Object make_save_value P_ ((void *, int));
2747 extern void free_misc P_ ((Lisp_Object));
2748 extern void free_marker P_ ((Lisp_Object));
2749 extern void free_cons P_ ((struct Lisp_Cons *));
2750 extern void init_alloc_once P_ ((void));
2751 extern void init_alloc P_ ((void));
2752 extern void syms_of_alloc P_ ((void));
2753 extern struct buffer * allocate_buffer P_ ((void));
2754 extern int valid_lisp_object_p P_ ((Lisp_Object));
2756 /* Defined in chartab.c */
2757 EXFUN (Fmake_char_table, 2);
2758 EXFUN (Fchar_table_parent, 1);
2759 EXFUN (Fset_char_table_parent, 2);
2760 EXFUN (Fchar_table_extra_slot, 2);
2761 EXFUN (Fset_char_table_extra_slot, 3);
2762 EXFUN (Fchar_table_range, 2);
2763 EXFUN (Fset_char_table_range, 3);
2764 EXFUN (Fset_char_table_default, 3);
2765 EXFUN (Foptimize_char_table, 2);
2766 EXFUN (Fmap_char_table, 2);
2767 extern Lisp_Object copy_char_table P_ ((Lisp_Object));
2768 extern Lisp_Object sub_char_table_ref P_ ((Lisp_Object, int));
2769 extern Lisp_Object char_table_ref P_ ((Lisp_Object, int));
2770 extern Lisp_Object char_table_ref_and_range P_ ((Lisp_Object, int,
2771 int *, int *));
2772 extern Lisp_Object char_table_set P_ ((Lisp_Object, int, Lisp_Object));
2773 extern Lisp_Object char_table_set_range P_ ((Lisp_Object, int, int,
2774 Lisp_Object));
2775 extern int char_table_translate P_ ((Lisp_Object, int));
2776 extern void map_char_table P_ ((void (*) (Lisp_Object, Lisp_Object,
2777 Lisp_Object),
2778 Lisp_Object, Lisp_Object, Lisp_Object));
2779 extern void syms_of_chartab P_ ((void));
2781 /* Defined in print.c */
2782 extern Lisp_Object Vprin1_to_string_buffer;
2783 extern void debug_print P_ ((Lisp_Object));
2784 EXFUN (Fprin1, 2);
2785 EXFUN (Fprin1_to_string, 2);
2786 EXFUN (Fprinc, 2);
2787 EXFUN (Fterpri, 1);
2788 EXFUN (Fprint, 2);
2789 EXFUN (Ferror_message_string, 1);
2790 extern Lisp_Object impl_Vstandard_output, Qstandard_output;
2791 extern Lisp_Object Qexternal_debugging_output;
2792 extern void temp_output_buffer_setup P_ ((const char *));
2793 extern int print_level, print_escape_newlines;
2794 extern Lisp_Object Qprint_escape_newlines;
2795 extern void write_string P_ ((char *, int));
2796 extern void write_string_1 P_ ((char *, int, Lisp_Object));
2797 extern void print_error_message P_ ((Lisp_Object, Lisp_Object, char *, Lisp_Object));
2798 extern Lisp_Object internal_with_output_to_temp_buffer
2799 P_ ((const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object));
2800 extern void float_to_string P_ ((unsigned char *, double));
2801 extern void syms_of_print P_ ((void));
2803 /* Defined in doprnt.c */
2804 extern int doprnt P_ ((char *, int, char *, char *, int, char **));
2806 /* Defined in lread.c */
2807 extern Lisp_Object Qvariable_documentation, Qstandard_input;
2808 extern Lisp_Object impl_Vobarray, initial_obarray, impl_Vstandard_input;
2809 EXFUN (Fread, 1);
2810 EXFUN (Fread_from_string, 3);
2811 EXFUN (Fintern, 2);
2812 EXFUN (Fintern_soft, 2);
2813 EXFUN (Fload, 5);
2814 EXFUN (Fget_load_suffixes, 0);
2815 EXFUN (Fget_file_char, 0);
2816 EXFUN (Fread_char, 3);
2817 EXFUN (Fread_event, 3);
2818 extern Lisp_Object read_filtered_event P_ ((int, int, int, int, Lisp_Object));
2819 EXFUN (Feval_region, 4);
2820 extern Lisp_Object check_obarray P_ ((Lisp_Object));
2821 extern Lisp_Object intern P_ ((const char *));
2822 extern Lisp_Object intern_c_string (const char *);
2823 extern Lisp_Object make_symbol P_ ((char *));
2824 extern Lisp_Object oblookup P_ ((Lisp_Object, const char *, int, int));
2825 #define LOADHIST_ATTACH(x) \
2826 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
2827 extern Lisp_Object impl_Vcurrent_load_list;
2828 extern Lisp_Object impl_Vload_history, impl_Vload_suffixes, impl_Vload_file_rep_suffixes;
2829 extern int openp P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
2830 Lisp_Object *, Lisp_Object));
2831 extern int isfloat_string P_ ((char *, int));
2832 extern void map_obarray P_ ((Lisp_Object, void (*) (Lisp_Object, Lisp_Object),
2833 Lisp_Object));
2834 extern void dir_warning P_ ((char *, Lisp_Object));
2835 extern void close_load_descs P_ ((void));
2836 extern void init_obarray P_ ((void));
2837 extern void init_lread P_ ((void));
2838 extern void syms_of_lread P_ ((void));
2840 /* Defined in eval.c */
2841 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
2842 extern Lisp_Object impl_Vinhibit_quit, Qinhibit_quit, impl_Vquit_flag;
2843 extern Lisp_Object Vautoload_queue;
2844 extern Lisp_Object impl_Vdebug_on_error;
2845 extern Lisp_Object Vsignaling_function;
2846 extern int handling_signal;
2847 extern int interactive_p P_ ((int));
2849 /* To run a normal hook, use the appropriate function from the list below.
2850 The calling convention:
2852 if (!NILP (Vrun_hooks))
2853 call1 (Vrun_hooks, Qmy_funny_hook);
2855 should no longer be used. */
2856 extern Lisp_Object Vrun_hooks;
2857 EXFUN (Frun_hooks, MANY);
2858 EXFUN (Frun_hook_with_args, MANY);
2859 EXFUN (Frun_hook_with_args_until_success, MANY);
2860 EXFUN (Frun_hook_with_args_until_failure, MANY);
2861 extern Lisp_Object run_hook_list_with_args P_ ((Lisp_Object, int, Lisp_Object *));
2862 extern void run_hook_with_args_2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2863 EXFUN (Fand, UNEVALLED);
2864 EXFUN (For, UNEVALLED);
2865 EXFUN (Fif, UNEVALLED);
2866 EXFUN (Fprogn, UNEVALLED);
2867 EXFUN (Fprog1, UNEVALLED);
2868 EXFUN (Fprog2, UNEVALLED);
2869 EXFUN (Fsetq, UNEVALLED);
2870 EXFUN (Fquote, UNEVALLED);
2871 EXFUN (Fuser_variable_p, 1);
2872 EXFUN (Finteractive_p, 0);
2873 EXFUN (Fdefun, UNEVALLED);
2874 EXFUN (Flet, UNEVALLED);
2875 EXFUN (FletX, UNEVALLED);
2876 EXFUN (Fwhile, UNEVALLED);
2877 EXFUN (Fcatch, UNEVALLED);
2878 EXFUN (Fthrow, 2) NO_RETURN;
2879 EXFUN (Funwind_protect, UNEVALLED);
2880 EXFUN (Fcondition_case, UNEVALLED);
2881 EXFUN (Fsignal, 2);
2882 extern void xsignal P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2883 extern void xsignal0 P_ ((Lisp_Object)) NO_RETURN;
2884 extern void xsignal1 P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2885 extern void xsignal2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object)) NO_RETURN;
2886 extern void xsignal3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)) NO_RETURN;
2887 extern void signal_error P_ ((char *, Lisp_Object)) NO_RETURN;
2888 EXFUN (Fautoload, 5);
2889 EXFUN (Fcommandp, 2);
2890 EXFUN (Feval, 1);
2891 EXFUN (Fapply, MANY);
2892 EXFUN (Ffuncall, MANY);
2893 EXFUN (Fbacktrace, 0);
2894 extern Lisp_Object apply1 P_ ((Lisp_Object, Lisp_Object));
2895 extern Lisp_Object call0 P_ ((Lisp_Object));
2896 extern Lisp_Object call1 P_ ((Lisp_Object, Lisp_Object));
2897 extern Lisp_Object call2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2898 extern Lisp_Object call3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2899 extern Lisp_Object call4 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2900 extern Lisp_Object call5 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2901 extern Lisp_Object call6 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2902 EXFUN (Fdo_auto_save, 2);
2903 extern Lisp_Object apply_lambda P_ ((Lisp_Object, Lisp_Object, int));
2904 extern Lisp_Object internal_catch P_ ((Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object));
2905 extern Lisp_Object internal_lisp_condition_case P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2906 extern Lisp_Object internal_condition_case P_ ((Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2907 extern Lisp_Object internal_condition_case_1 P_ ((Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2908 extern Lisp_Object internal_condition_case_2 P_ ((Lisp_Object (*) (int, Lisp_Object *), int, Lisp_Object *, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2909 extern void specbind P_ ((Lisp_Object, Lisp_Object));
2910 extern void record_unwind_protect P_ ((Lisp_Object (*) (Lisp_Object), Lisp_Object));
2911 extern Lisp_Object unbind_to P_ ((int, Lisp_Object));
2912 extern void error P_ ((/* char *, ... */)) NO_RETURN;
2913 extern void do_autoload P_ ((Lisp_Object, Lisp_Object));
2914 extern Lisp_Object un_autoload P_ ((Lisp_Object));
2915 EXFUN (Ffetch_bytecode, 1);
2916 extern void init_eval_once P_ ((void));
2917 extern Lisp_Object safe_call P_ ((int, Lisp_Object *));
2918 extern Lisp_Object safe_call1 P_ ((Lisp_Object, Lisp_Object));
2919 extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2920 extern void init_eval P_ ((void));
2921 extern void syms_of_eval P_ ((void));
2923 /* Defined in editfns.c */
2924 EXFUN (Fpropertize, MANY);
2925 EXFUN (Fcurrent_message, 0);
2926 EXFUN (Fgoto_char, 1);
2927 EXFUN (Fpoint_min_marker, 0);
2928 EXFUN (Fpoint_max_marker, 0);
2929 EXFUN (Fpoint_min, 0);
2930 EXFUN (Fpoint_max, 0);
2931 EXFUN (Fpoint, 0);
2932 EXFUN (Fpoint_marker, 0);
2933 EXFUN (Fmark_marker, 0);
2934 EXFUN (Fline_beginning_position, 1);
2935 EXFUN (Fline_end_position, 1);
2936 EXFUN (Ffollowing_char, 0);
2937 EXFUN (Fprevious_char, 0);
2938 EXFUN (Fchar_after, 1);
2939 EXFUN (Finsert, MANY);
2940 EXFUN (Finsert_and_inherit, MANY);
2941 EXFUN (Finsert_before_markers, MANY);
2942 EXFUN (Finsert_buffer_substring, 3);
2943 EXFUN (Finsert_char, 3);
2944 extern void insert1 P_ ((Lisp_Object));
2945 EXFUN (Feolp, 0);
2946 EXFUN (Feobp, 0);
2947 EXFUN (Fbolp, 0);
2948 EXFUN (Fbobp, 0);
2949 EXFUN (Fformat, MANY);
2950 EXFUN (Fmessage, MANY);
2951 extern Lisp_Object format2 P_ ((char *, Lisp_Object, Lisp_Object));
2952 EXFUN (Fbuffer_substring, 2);
2953 EXFUN (Fbuffer_string, 0);
2954 extern Lisp_Object save_excursion_save P_ ((void));
2955 extern Lisp_Object save_restriction_save P_ ((void));
2956 extern Lisp_Object save_excursion_restore P_ ((Lisp_Object));
2957 extern Lisp_Object save_restriction_restore P_ ((Lisp_Object));
2958 EXFUN (Fchar_to_string, 1);
2959 EXFUN (Fdelete_region, 2);
2960 EXFUN (Fnarrow_to_region, 2);
2961 EXFUN (Fwiden, 0);
2962 EXFUN (Fuser_login_name, 1);
2963 EXFUN (Fsystem_name, 0);
2964 EXFUN (Fcurrent_time, 0);
2965 extern int clip_to_bounds P_ ((int, int, int));
2966 extern Lisp_Object make_buffer_string P_ ((int, int, int));
2967 extern Lisp_Object make_buffer_string_both P_ ((int, int, int, int, int));
2968 extern void init_editfns P_ ((void));
2969 extern void syms_of_editfns P_ ((void));
2970 extern Lisp_Object impl_Vinhibit_field_text_motion;
2971 EXFUN (Fconstrain_to_field, 5);
2972 EXFUN (Ffield_string, 1);
2973 EXFUN (Fdelete_field, 1);
2974 EXFUN (Ffield_beginning, 3);
2975 EXFUN (Ffield_end, 3);
2976 EXFUN (Ffield_string_no_properties, 1);
2977 extern void set_time_zone_rule P_ ((char *));
2979 /* defined in buffer.c */
2980 extern int mouse_face_overlay_overlaps P_ ((Lisp_Object));
2981 extern void nsberror P_ ((Lisp_Object)) NO_RETURN;
2982 EXFUN (Fset_buffer_multibyte, 1);
2983 EXFUN (Foverlay_start, 1);
2984 EXFUN (Foverlay_end, 1);
2985 EXFUN (Foverlay_buffer, 1);
2986 extern void adjust_overlays_for_insert P_ ((EMACS_INT, EMACS_INT));
2987 extern void adjust_overlays_for_delete P_ ((EMACS_INT, EMACS_INT));
2988 extern void fix_start_end_in_overlays P_ ((int, int));
2989 extern void report_overlay_modification P_ ((Lisp_Object, Lisp_Object, int,
2990 Lisp_Object, Lisp_Object, Lisp_Object));
2991 extern int overlay_touches_p P_ ((int));
2992 extern Lisp_Object Vbuffer_alist, impl_Vinhibit_read_only;
2993 EXFUN (Fbuffer_list, 1);
2994 EXFUN (Fget_buffer, 1);
2995 EXFUN (Fget_buffer_create, 1);
2996 EXFUN (Fgenerate_new_buffer_name, 2);
2997 EXFUN (Fset_buffer, 1);
2998 EXFUN (set_buffer_if_live, 1);
2999 EXFUN (Fbarf_if_buffer_read_only, 0);
3000 EXFUN (Fcurrent_buffer, 0);
3001 EXFUN (Fswitch_to_buffer, 2);
3002 EXFUN (Fother_buffer, 3);
3003 EXFUN (Foverlay_get, 2);
3004 EXFUN (Fbuffer_modified_p, 1);
3005 EXFUN (Fset_buffer_modified_p, 1);
3006 EXFUN (Fkill_buffer, 1);
3007 EXFUN (Fkill_all_local_variables, 0);
3008 EXFUN (Fbuffer_disable_undo, 1);
3009 EXFUN (Fbuffer_enable_undo, 1);
3010 EXFUN (Ferase_buffer, 0);
3011 extern Lisp_Object Qoverlayp;
3012 extern Lisp_Object Qevaporate;
3013 extern Lisp_Object get_truename_buffer P_ ((Lisp_Object));
3014 extern struct buffer *all_buffers;
3015 EXFUN (Fprevious_overlay_change, 1);
3016 EXFUN (Fbuffer_file_name, 1);
3017 extern void init_buffer_once P_ ((void));
3018 extern void init_buffer P_ ((void));
3019 extern void syms_of_buffer P_ ((void));
3020 extern void keys_of_buffer P_ ((void));
3022 /* defined in marker.c */
3024 EXFUN (Fmarker_position, 1);
3025 EXFUN (Fmarker_buffer, 1);
3026 EXFUN (Fcopy_marker, 2);
3027 EXFUN (Fset_marker, 3);
3028 extern int marker_position P_ ((Lisp_Object));
3029 extern int marker_byte_position P_ ((Lisp_Object));
3030 extern void clear_charpos_cache P_ ((struct buffer *));
3031 extern int charpos_to_bytepos P_ ((int));
3032 extern int buf_charpos_to_bytepos P_ ((struct buffer *, int));
3033 extern int buf_bytepos_to_charpos P_ ((struct buffer *, int));
3034 extern void unchain_marker P_ ((struct Lisp_Marker *marker));
3035 extern Lisp_Object set_marker_restricted P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
3036 extern Lisp_Object set_marker_both P_ ((Lisp_Object, Lisp_Object, int, int));
3037 extern Lisp_Object set_marker_restricted_both P_ ((Lisp_Object, Lisp_Object,
3038 int, int));
3039 extern void syms_of_marker P_ ((void));
3041 /* Defined in fileio.c */
3043 extern Lisp_Object Qfile_error;
3044 EXFUN (Ffind_file_name_handler, 2);
3045 EXFUN (Ffile_name_as_directory, 1);
3046 EXFUN (Fmake_temp_name, 1);
3047 EXFUN (Fexpand_file_name, 2);
3048 EXFUN (Ffile_name_nondirectory, 1);
3049 EXFUN (Fsubstitute_in_file_name, 1);
3050 EXFUN (Ffile_symlink_p, 1);
3051 EXFUN (Fverify_visited_file_modtime, 1);
3052 EXFUN (Ffile_exists_p, 1);
3053 EXFUN (Ffile_name_absolute_p, 1);
3054 EXFUN (Fdirectory_file_name, 1);
3055 EXFUN (Ffile_name_directory, 1);
3056 extern Lisp_Object expand_and_dir_to_file P_ ((Lisp_Object, Lisp_Object));
3057 EXFUN (Ffile_accessible_directory_p, 1);
3058 EXFUN (Funhandled_file_name_directory, 1);
3059 EXFUN (Ffile_directory_p, 1);
3060 EXFUN (Fwrite_region, 7);
3061 EXFUN (Ffile_readable_p, 1);
3062 EXFUN (Ffile_executable_p, 1);
3063 EXFUN (Fread_file_name, 6);
3064 extern Lisp_Object close_file_unwind P_ ((Lisp_Object));
3065 extern void report_file_error P_ ((const char *, Lisp_Object)) NO_RETURN;
3066 extern int internal_delete_file P_ ((Lisp_Object));
3067 extern void syms_of_fileio P_ ((void));
3068 extern Lisp_Object make_temp_name P_ ((Lisp_Object, int));
3069 EXFUN (Fmake_symbolic_link, 3);
3070 extern Lisp_Object Qdelete_file;
3072 /* Defined in abbrev.c */
3074 extern void syms_of_abbrev P_ ((void));
3076 /* defined in search.c */
3077 extern void shrink_regexp_cache P_ ((void));
3078 EXFUN (Fstring_match, 3);
3079 extern void restore_search_regs P_ ((void));
3080 EXFUN (Fmatch_data, 3);
3081 EXFUN (Fset_match_data, 2);
3082 EXFUN (Fmatch_beginning, 1);
3083 EXFUN (Fmatch_end, 1);
3084 extern void record_unwind_save_match_data P_ ((void));
3085 EXFUN (Flooking_at, 1);
3086 extern int fast_string_match P_ ((Lisp_Object, Lisp_Object));
3087 extern int fast_c_string_match_ignore_case P_ ((Lisp_Object, const char *));
3088 extern int fast_string_match_ignore_case P_ ((Lisp_Object, Lisp_Object));
3089 extern EMACS_INT fast_looking_at P_ ((Lisp_Object, EMACS_INT, EMACS_INT,
3090 EMACS_INT, EMACS_INT, Lisp_Object));
3091 extern int scan_buffer P_ ((int, EMACS_INT, EMACS_INT, int, int *, int));
3092 extern int scan_newline P_ ((EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
3093 int, int));
3094 extern int find_next_newline P_ ((EMACS_INT, int));
3095 extern int find_next_newline_no_quit P_ ((EMACS_INT, int));
3096 extern int find_before_next_newline P_ ((EMACS_INT, EMACS_INT, int));
3097 extern void syms_of_search P_ ((void));
3098 extern void clear_regexp_cache P_ ((void));
3100 /* defined in minibuf.c */
3102 extern Lisp_Object last_minibuf_string;
3103 extern void choose_minibuf_frame P_ ((void));
3104 EXFUN (Fcompleting_read, 8);
3105 EXFUN (Fread_from_minibuffer, 7);
3106 EXFUN (Fread_variable, 2);
3107 EXFUN (Fread_buffer, 3);
3108 EXFUN (Fread_minibuffer, 2);
3109 EXFUN (Feval_minibuffer, 2);
3110 EXFUN (Fread_string, 5);
3111 EXFUN (Fread_no_blanks_input, 3);
3112 EXFUN (Fassoc_string, 3);
3113 extern Lisp_Object get_minibuffer P_ ((int));
3114 extern void temp_echo_area_glyphs P_ ((Lisp_Object));
3115 extern void init_minibuf_once P_ ((void));
3116 extern void syms_of_minibuf P_ ((void));
3118 /* Defined in callint.c */
3120 extern Lisp_Object Qminus, Qplus, impl_Vcurrent_prefix_arg;
3121 extern Lisp_Object impl_Vcommand_history;
3122 extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
3123 EXFUN (Fcall_interactively, 3);
3124 EXFUN (Fprefix_numeric_value, 1);
3125 extern void syms_of_callint P_ ((void));
3127 /* defined in casefiddle.c */
3129 EXFUN (Fdowncase, 1);
3130 EXFUN (Fupcase, 1);
3131 EXFUN (Fcapitalize, 1);
3132 EXFUN (Fupcase_region, 2);
3133 EXFUN (Fupcase_initials, 1);
3134 EXFUN (Fupcase_initials_region, 2);
3135 extern void syms_of_casefiddle P_ ((void));
3136 extern void keys_of_casefiddle P_ ((void));
3138 /* defined in casetab.c */
3140 EXFUN (Fset_case_table, 1);
3141 EXFUN (Fset_standard_case_table, 1);
3142 extern void init_casetab_once P_ ((void));
3143 extern void syms_of_casetab P_ ((void));
3145 /* defined in keyboard.c */
3147 extern int echoing;
3148 extern Lisp_Object echo_message_buffer;
3149 extern struct kboard *echo_kboard;
3150 extern void cancel_echoing P_ ((void));
3151 extern Lisp_Object Qdisabled, QCfilter;
3152 extern Lisp_Object impl_Vtty_erase_char, impl_Vhelp_form, impl_Vtop_level;
3153 extern Lisp_Object impl_Vthrow_on_input;
3154 extern int input_pending;
3155 EXFUN (Fdiscard_input, 0);
3156 EXFUN (Frecursive_edit, 0);
3157 EXFUN (Ftop_level, 0);
3158 EXFUN (Fcommand_execute, 4);
3159 EXFUN (Finput_pending_p, 0);
3160 extern Lisp_Object menu_bar_items P_ ((Lisp_Object));
3161 extern Lisp_Object tool_bar_items P_ ((Lisp_Object, int *));
3162 extern Lisp_Object Qvertical_scroll_bar;
3163 extern void discard_mouse_events P_ ((void));
3164 EXFUN (Fevent_convert_list, 1);
3165 EXFUN (Fread_key_sequence, 5);
3166 EXFUN (Fset_input_interrupt_mode, 1);
3167 EXFUN (Fset_output_flow_control, 2);
3168 EXFUN (Fset_input_meta_mode, 2);
3169 EXFUN (Fset_quit_char, 1);
3170 EXFUN (Fset_input_mode, 4);
3171 extern Lisp_Object pending_funcalls;
3172 extern int detect_input_pending P_ ((void));
3173 extern int detect_input_pending_ignore_squeezables P_ ((void));
3174 extern int detect_input_pending_run_timers P_ ((int));
3175 extern void safe_run_hooks P_ ((Lisp_Object));
3176 extern void cmd_error_internal P_ ((Lisp_Object, char *));
3177 extern Lisp_Object command_loop_1 P_ ((void));
3178 extern Lisp_Object recursive_edit_1 P_ ((void));
3179 extern void record_auto_save P_ ((void));
3180 extern void init_keyboard P_ ((void));
3181 extern void syms_of_keyboard P_ ((void));
3182 extern void keys_of_keyboard P_ ((void));
3183 extern char *push_key_description P_ ((unsigned int, char *, int));
3186 /* defined in indent.c */
3187 EXFUN (Fvertical_motion, 2);
3188 EXFUN (Findent_to, 2);
3189 EXFUN (Fcurrent_column, 0);
3190 EXFUN (Fmove_to_column, 2);
3191 extern double current_column P_ ((void));
3192 extern void invalidate_current_column P_ ((void));
3193 extern int indented_beyond_p P_ ((int, int, double));
3194 extern void syms_of_indent P_ ((void));
3196 /* defined in frame.c */
3197 #ifdef HAVE_WINDOW_SYSTEM
3198 extern Lisp_Object impl_Vx_resource_name;
3199 extern Lisp_Object impl_Vx_resource_class;
3200 #endif /* HAVE_WINDOW_SYSTEM */
3201 extern Lisp_Object Qvisible;
3202 extern void store_frame_param P_ ((struct frame *, Lisp_Object, Lisp_Object));
3203 extern void store_in_alist P_ ((Lisp_Object *, Lisp_Object, Lisp_Object));
3204 extern Lisp_Object do_switch_frame P_ ((Lisp_Object, int, int, Lisp_Object));
3205 extern Lisp_Object get_frame_param P_ ((struct frame *, Lisp_Object));
3206 extern Lisp_Object frame_buffer_predicate P_ ((Lisp_Object));
3207 EXFUN (Fframep, 1);
3208 EXFUN (Fselect_frame, 2);
3209 EXFUN (Fselected_frame, 0);
3210 EXFUN (Fwindow_frame, 1);
3211 EXFUN (Fframe_root_window, 1);
3212 EXFUN (Fframe_first_window, 1);
3213 EXFUN (Fframe_selected_window, 1);
3214 EXFUN (Fframe_list, 0);
3215 EXFUN (Fnext_frame, 2);
3216 EXFUN (Fdelete_frame, 2);
3217 EXFUN (Fset_mouse_position, 3);
3218 EXFUN (Fmake_frame_visible, 1);
3219 EXFUN (Fmake_frame_invisible, 2);
3220 EXFUN (Ficonify_frame, 1);
3221 EXFUN (Fframe_visible_p, 1);
3222 EXFUN (Fvisible_frame_list, 0);
3223 EXFUN (Fframe_parameter, 2);
3224 EXFUN (Fframe_parameters, 1);
3225 EXFUN (Fmodify_frame_parameters, 2);
3226 EXFUN (Fset_frame_height, 3);
3227 EXFUN (Fset_frame_width, 3);
3228 EXFUN (Fset_frame_size, 3);
3229 EXFUN (Fset_frame_position, 3);
3230 EXFUN (Fraise_frame, 1);
3231 EXFUN (Fredirect_frame_focus, 2);
3232 EXFUN (Fset_frame_selected_window, 3);
3233 extern Lisp_Object frame_buffer_list P_ ((Lisp_Object));
3234 extern void frames_discard_buffer P_ ((Lisp_Object));
3235 extern void set_frame_buffer_list P_ ((Lisp_Object, Lisp_Object));
3236 extern void frames_bury_buffer P_ ((Lisp_Object));
3237 extern void syms_of_frame P_ ((void));
3239 /* defined in emacs.c */
3240 extern Lisp_Object decode_env_path P_ ((char *, char *));
3241 extern Lisp_Object impl_Vinvocation_name, impl_Vinvocation_directory;
3242 extern Lisp_Object impl_Vbefore_init_time, impl_Vafter_init_time;
3243 extern Lisp_Object impl_Vinstallation_directory;
3244 extern Lisp_Object empty_unibyte_string, empty_multibyte_string;
3245 EXFUN (Fkill_emacs, 1);
3246 #if HAVE_SETLOCALE
3247 void fixup_locale P_ ((void));
3248 void synchronize_system_messages_locale P_ ((void));
3249 void synchronize_system_time_locale P_ ((void));
3250 #else
3251 #define setlocale(category, locale)
3252 #define fixup_locale()
3253 #define synchronize_system_messages_locale()
3254 #define synchronize_system_time_locale()
3255 #endif
3256 void shut_down_emacs P_ ((int, int, Lisp_Object));
3257 /* Nonzero means don't do interactive redisplay and don't change tty modes */
3258 extern int noninteractive;
3260 /* Nonzero means don't load X resources or Windows Registry settings. */
3261 extern int inhibit_x_resources;
3263 /* Pipe used to send exit notification to the daemon parent at
3264 startup. */
3265 extern int daemon_pipe[2];
3266 #define IS_DAEMON (daemon_pipe[1] != 0)
3268 /* Nonzero means don't do use window-system-specific display code */
3269 extern int inhibit_window_system;
3270 /* Nonzero means that a filter or a sentinel is running. */
3271 extern int running_asynch_code;
3273 /* defined in process.c */
3274 EXFUN (Fget_process, 1);
3275 EXFUN (Fget_buffer_process, 1);
3276 EXFUN (Fprocessp, 1);
3277 EXFUN (Fprocess_status, 1);
3278 EXFUN (Fkill_process, 2);
3279 EXFUN (Fprocess_send_eof, 1);
3280 EXFUN (Fwaiting_for_user_input_p, 0);
3281 extern Lisp_Object Qprocessp;
3282 extern void kill_buffer_processes P_ ((Lisp_Object));
3283 extern int wait_reading_process_output P_ ((int, int, int, int,
3284 Lisp_Object,
3285 struct Lisp_Process *,
3286 int));
3287 extern void add_keyboard_wait_descriptor P_ ((int));
3288 extern void delete_keyboard_wait_descriptor P_ ((int));
3289 extern void add_gpm_wait_descriptor P_ ((int));
3290 extern void delete_gpm_wait_descriptor P_ ((int));
3291 extern void close_process_descs P_ ((void));
3292 extern void init_process P_ ((void));
3293 extern void syms_of_process P_ ((void));
3294 extern void setup_process_coding_systems P_ ((Lisp_Object));
3296 /* defined in callproc.c */
3297 extern Lisp_Object impl_Vexec_path, impl_Vexec_suffixes,
3298 impl_Vexec_directory, impl_Vdata_directory;
3299 extern Lisp_Object impl_Vdoc_directory;
3300 EXFUN (Fcall_process, MANY);
3301 extern int child_setup P_ ((int, int, int, char **, int, Lisp_Object));
3302 extern void init_callproc_1 P_ ((void));
3303 extern void init_callproc P_ ((void));
3304 extern void set_initial_environment P_ ((void));
3305 extern void syms_of_callproc P_ ((void));
3307 /* defined in doc.c */
3308 extern Lisp_Object impl_Vdoc_file_name;
3309 EXFUN (Fsubstitute_command_keys, 1);
3310 EXFUN (Fdocumentation, 2);
3311 EXFUN (Fdocumentation_property, 3);
3312 extern Lisp_Object read_doc_string P_ ((Lisp_Object));
3313 extern Lisp_Object get_doc_string P_ ((Lisp_Object, int, int));
3314 extern void syms_of_doc P_ ((void));
3315 extern int read_bytecode_char P_ ((int));
3317 /* defined in bytecode.c */
3318 extern Lisp_Object Qbytecode;
3319 EXFUN (Fbyte_code, 3);
3320 extern void syms_of_bytecode 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 impl_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 (Fdelete_terminal, 2);
3433 extern void syms_of_terminal P_ ((void));
3435 /* Defined in font.c */
3436 extern void syms_of_font P_ ((void));
3437 extern void init_font P_ ((void));
3439 #ifdef HAVE_WINDOW_SYSTEM
3440 /* Defined in fontset.c */
3441 extern void syms_of_fontset P_ ((void));
3442 EXFUN (Fset_fontset_font, 5);
3443 EXFUN (Fnew_fontset, 2);
3445 /* Defined in xfns.c, w32fns.c, or macfns.c */
3446 EXFUN (Fxw_display_color_p, 1);
3447 EXFUN (Fx_file_dialog, 5);
3448 EXFUN (Fx_focus_frame, 1);
3449 #endif
3451 /* Defined in xfaces.c */
3452 EXFUN (Fclear_face_cache, 1);
3453 EXFUN (Fx_load_color_file, 1);
3454 extern void syms_of_xfaces P_ ((void));
3456 #ifndef HAVE_GETLOADAVG
3457 /* Defined in getloadavg.c */
3458 extern int getloadavg P_ ((double *, int));
3459 #endif
3461 #ifdef HAVE_X_WINDOWS
3462 /* Defined in xfns.c */
3463 extern void syms_of_xfns P_ ((void));
3465 /* Defined in xsmfns.c */
3466 extern void syms_of_xsmfns P_ ((void));
3468 /* Defined in xselect.c */
3469 EXFUN (Fx_send_client_event, 6);
3470 extern void syms_of_xselect P_ ((void));
3472 /* Defined in xterm.c */
3473 extern void syms_of_xterm P_ ((void));
3474 #endif /* HAVE_X_WINDOWS */
3476 #ifdef MSDOS
3477 /* Defined in msdos.c */
3478 EXFUN (Fmsdos_downcase_filename, 1);
3479 #endif
3481 #ifdef HAVE_MENUS
3482 /* Defined in (x|w32)fns.c, nsfns.m... */
3483 extern int have_menus_p P_ ((void));
3484 #endif
3486 #ifdef HAVE_DBUS
3487 /* Defined in dbusbind.c */
3488 int xd_pending_messages P_ ((void));
3489 void xd_read_queued_messages P_ ((void));
3490 void syms_of_dbusbind P_ ((void));
3491 #endif
3493 /* Nonzero means Emacs has already been initialized.
3494 Used during startup to detect startup of dumped Emacs. */
3495 extern int initialized;
3497 extern int immediate_quit; /* Nonzero means ^G can quit instantly */
3499 extern POINTER_TYPE *xmalloc P_ ((size_t));
3500 extern POINTER_TYPE *xrealloc P_ ((POINTER_TYPE *, size_t));
3501 extern void xfree P_ ((POINTER_TYPE *));
3503 extern char *xstrdup P_ ((const char *));
3505 extern char *egetenv P_ ((char *));
3507 /* Set up the name of the machine we're running on. */
3508 extern void init_system_name P_ ((void));
3510 /* Some systems (e.g., NT) use a different path separator than Unix,
3511 in addition to a device separator. Default the path separator
3512 to '/', and don't test for a device separator in IS_ANY_SEP. */
3514 #ifdef WINDOWSNT
3515 extern Lisp_Object impl_Vdirectory_sep_char;
3516 #endif
3518 #ifndef DIRECTORY_SEP
3519 #define DIRECTORY_SEP '/'
3520 #endif
3521 #ifndef IS_DIRECTORY_SEP
3522 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3523 #endif
3524 #ifndef IS_DEVICE_SEP
3525 #ifndef DEVICE_SEP
3526 #define IS_DEVICE_SEP(_c_) 0
3527 #else
3528 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3529 #endif
3530 #endif
3531 #ifndef IS_ANY_SEP
3532 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3533 #endif
3535 #define SWITCH_ENUM_CAST(x) (x)
3537 /* Loop over Lisp list LIST. Signal an error if LIST is not a proper
3538 list, or if it contains circles.
3540 HARE and TORTOISE should be the names of Lisp_Object variables, and
3541 N should be the name of an EMACS_INT variable declared in the
3542 function where the macro is used. Each nested loop should use
3543 its own variables.
3545 In the loop body, HARE is set to each cons of LIST, and N is the
3546 length of the list processed so far. */
3548 #define LIST_END_P(list, obj) \
3549 (NILP (obj) \
3550 ? 1 \
3551 : (CONSP (obj) \
3552 ? 0 \
3553 : (wrong_type_argument (Qlistp, (list))), 1))
3555 #define FOREACH(hare, list, tortoise, n) \
3556 for (tortoise = hare = (list), n = 0; \
3557 !LIST_END_P (list, hare); \
3558 (hare = XCDR (hare), ++n, \
3559 ((n & 1) != 0 \
3560 ? (tortoise = XCDR (tortoise), \
3561 (EQ (hare, tortoise) \
3562 && (circular_list_error ((list)), 1))) \
3563 : 0)))
3565 /* The ubiquitous min and max macros. */
3567 #ifdef max
3568 #undef max
3569 #undef min
3570 #endif
3571 #define min(a, b) ((a) < (b) ? (a) : (b))
3572 #define max(a, b) ((a) > (b) ? (a) : (b))
3574 /* We used to use `abs', but that clashes with system headers on some
3575 platforms, and using a name reserved by Standard C is a bad idea
3576 anyway. */
3577 #if !defined(eabs)
3578 #define eabs(x) ((x) < 0 ? -(x) : (x))
3579 #endif
3581 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3582 fixnum. */
3584 #define make_fixnum_or_float(val) \
3585 (FIXNUM_OVERFLOW_P (val) \
3586 ? make_float (val) \
3587 : make_number ((EMACS_INT)(val)))
3590 /* Checks the `cycle check' variable CHECK to see if it indicates that
3591 EL is part of a cycle; CHECK must be either Qnil or a value returned
3592 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3593 elements after which a cycle might be suspected; after that many
3594 elements, this macro begins consing in order to keep more precise
3595 track of elements.
3597 Returns nil if a cycle was detected, otherwise a new value for CHECK
3598 that includes EL.
3600 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3601 the caller should make sure that's ok. */
3603 #define CYCLE_CHECK(check, el, suspicious) \
3604 (NILP (check) \
3605 ? make_number (0) \
3606 : (INTEGERP (check) \
3607 ? (XFASTINT (check) < (suspicious) \
3608 ? make_number (XFASTINT (check) + 1) \
3609 : Fcons (el, Qnil)) \
3610 : (!NILP (Fmemq ((el), (check))) \
3611 ? Qnil \
3612 : Fcons ((el), (check)))))
3615 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3616 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3618 #define MAX_ALLOCA 16*1024
3620 extern Lisp_Object safe_alloca_unwind (Lisp_Object);
3622 #define USE_SAFE_ALLOCA \
3623 int sa_count = SPECPDL_INDEX (), sa_must_free = 0
3625 /* SAFE_ALLOCA allocates a simple buffer. */
3627 #define SAFE_ALLOCA(buf, type, size) \
3628 do { \
3629 if ((size) < MAX_ALLOCA) \
3630 buf = (type) alloca (size); \
3631 else \
3633 buf = (type) xmalloc (size); \
3634 sa_must_free++; \
3635 record_unwind_protect (safe_alloca_unwind, \
3636 make_save_value (buf, 0)); \
3638 } while (0)
3640 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3642 #define SAFE_FREE() \
3643 do { \
3644 if (sa_must_free) { \
3645 sa_must_free = 0; \
3646 unbind_to (sa_count, Qnil); \
3648 } while (0)
3651 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3653 #define SAFE_ALLOCA_LISP(buf, nelt) \
3654 do { \
3655 int size_ = (nelt) * sizeof (Lisp_Object); \
3656 if (size_ < MAX_ALLOCA) \
3657 buf = (Lisp_Object *) alloca (size_); \
3658 else \
3660 Lisp_Object arg_; \
3661 buf = (Lisp_Object *) xmalloc (size_); \
3662 arg_ = make_save_value (buf, nelt); \
3663 XSAVE_VALUE (arg_)->dogc = 1; \
3664 sa_must_free++; \
3665 record_unwind_protect (safe_alloca_unwind, arg_); \
3667 } while (0)
3670 #include "globals.h"
3672 #include "thread.h"
3674 #endif /* EMACS_LISP_H */
3676 /* arch-tag: 9b2ed020-70eb-47ac-94ee-e1c2a5107d5e
3677 (do not change this comment) */