local_var_alist_ is shared by threads.
[emacs.git] / src / lisp.h
blobe459160c52a063fbebddfae0448ab0127aadd8ec
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_TYPE_MASK = 0xfffe00
358 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
359 GDB. It doesn't work on OS Alpha. Moved to a variable in
360 emacs.c. */
361 PVEC_FLAG = PSEUDOVECTOR_FLAG
362 #endif
365 /* For convenience, we also store the number of elements in these bits.
366 Note that this size is not necessarily the memory-footprint size, but
367 only the number of Lisp_Object fields (that need to be traced by the GC).
368 The distinction is used e.g. by Lisp_Process which places extra
369 non-Lisp_Object fields at the end of the structure. */
370 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
372 /* Number of bits to put in each character in the internal representation
373 of bool vectors. This should not vary across implementations. */
374 #define BOOL_VECTOR_BITS_PER_CHAR 8
376 /* These macros extract various sorts of values from a Lisp_Object.
377 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
378 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
380 #ifndef USE_LISP_UNION_TYPE
382 /* Return a perfect hash of the Lisp_Object representation. */
383 #define XHASH(a) (a)
385 #ifdef USE_LSB_TAG
387 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
388 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) & TYPEMASK))
389 #ifdef USE_2_TAGS_FOR_INTS
390 # define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
391 # define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
392 # define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
393 #else
394 # define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
395 # define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
396 # define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
397 #endif
398 #define XSET(var, type, ptr) \
399 (eassert (XTYPE (ptr) == 0), /* Check alignment. */ \
400 (var) = ((EMACS_INT) (type)) | ((EMACS_INT) (ptr)))
402 #define XPNTR(a) ((EMACS_INT) ((a) & ~TYPEMASK))
404 #else /* not USE_LSB_TAG */
406 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
408 /* One need to override this if there must be high bits set in data space
409 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
410 on all machines, but would penalize machines which don't need it)
412 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
414 /* For integers known to be positive, XFASTINT provides fast retrieval
415 and XSETFASTINT provides fast storage. This takes advantage of the
416 fact that Lisp_Int is 0. */
417 #define XFASTINT(a) ((a) + 0)
418 #define XSETFASTINT(a, b) ((a) = (b))
420 /* Extract the value of a Lisp_Object as a (un)signed integer. */
422 #ifdef USE_2_TAGS_FOR_INTS
423 # define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
424 # define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
425 # define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
426 #else
427 # define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
428 >> (BITS_PER_EMACS_INT - VALBITS))
429 # define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
430 # define make_number(N) \
431 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
432 #endif
434 #define XSET(var, type, ptr) \
435 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
437 #define XPNTR(a) ((EMACS_UINT) ((a) & VALMASK))
439 #endif /* not USE_LSB_TAG */
441 #else /* USE_LISP_UNION_TYPE */
443 #ifdef USE_2_TAGS_FOR_INTS
444 # error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
445 #endif
447 #define XHASH(a) ((a).i)
449 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
451 #ifdef EXPLICIT_SIGN_EXTEND
452 /* Make sure we sign-extend; compilers have been known to fail to do so.
453 We additionally cast to EMACS_INT since it seems that some compilers
454 have been known to fail to do so, even though the bitfield is declared
455 as EMACS_INT already. */
456 #define XINT(a) ((((EMACS_INT) (a).s.val) << (BITS_PER_EMACS_INT - VALBITS)) \
457 >> (BITS_PER_EMACS_INT - VALBITS))
458 #else
459 #define XINT(a) ((a).s.val)
460 #endif /* EXPLICIT_SIGN_EXTEND */
462 #define XUINT(a) ((a).u.val)
464 #ifdef USE_LSB_TAG
466 # define XSET(var, vartype, ptr) \
467 (eassert ((((EMACS_UINT) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0), \
468 (var).u.val = ((EMACS_UINT) (ptr)) >> GCTYPEBITS, \
469 (var).u.type = ((char) (vartype)))
471 /* Some versions of gcc seem to consider the bitfield width when issuing
472 the "cast to pointer from integer of different size" warning, so the
473 cast is here to widen the value back to its natural size. */
474 # define XPNTR(v) ((EMACS_INT)((v).s.val) << GCTYPEBITS)
476 #else /* !USE_LSB_TAG */
478 /* For integers known to be positive, XFASTINT provides fast retrieval
479 and XSETFASTINT provides fast storage. This takes advantage of the
480 fact that Lisp_Int is 0. */
481 # define XFASTINT(a) ((a).i + 0)
482 # define XSETFASTINT(a, b) ((a).i = (b))
484 # define XSET(var, vartype, ptr) \
485 (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
487 #endif /* !USE_LSB_TAG */
489 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
490 #define make_number(N) \
491 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
492 #else
493 extern Lisp_Object make_number P_ ((EMACS_INT));
494 #endif
496 #endif /* USE_LISP_UNION_TYPE */
498 /* For integers known to be positive, XFASTINT sometimes provides
499 faster retrieval and XSETFASTINT provides faster storage.
500 If not, fallback on the non-accelerated path. */
501 #ifndef XFASTINT
502 # define XFASTINT(a) (XINT (a))
503 # define XSETFASTINT(a, b) (XSETINT (a, b))
504 #endif
506 #define EQ(x, y) (XHASH (x) == XHASH (y))
508 #ifndef XPNTR
509 #ifdef HAVE_SHM
510 /* In this representation, data is found in two widely separated segments. */
511 extern size_t pure_size;
512 #define XPNTR(a) \
513 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
514 #else /* not HAVE_SHM */
515 #ifdef DATA_SEG_BITS
516 /* This case is used for the rt-pc.
517 In the diffs I was given, it checked for ptr = 0
518 and did not adjust it in that case.
519 But I don't think that zero should ever be found
520 in a Lisp object whose data type says it points to something. */
521 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
522 #else
523 /* Some versions of gcc seem to consider the bitfield width when
524 issuing the "cast to pointer from integer of different size"
525 warning, so the cast is here to widen the value back to its natural
526 size. */
527 #define XPNTR(a) ((EMACS_INT) XUINT (a))
528 #endif
529 #endif /* not HAVE_SHM */
530 #endif /* no XPNTR */
532 /* Largest and smallest representable fixnum values. These are the C
533 values. */
535 #ifdef USE_2_TAGS_FOR_INTS
536 # define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << VALBITS)
537 # define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << VALBITS) - 1)
538 /* Mask indicating the significant bits of a Lisp_Int.
539 I.e. (x & INTMASK) == XUINT (make_number (x)). */
540 # define INTMASK ((((EMACS_INT) 1) << (VALBITS + 1)) - 1)
541 #else
542 # define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << (VALBITS - 1))
543 # define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << (VALBITS - 1)) - 1)
544 /* Mask indicating the significant bits of a Lisp_Int.
545 I.e. (x & INTMASK) == XUINT (make_number (x)). */
546 # define INTMASK ((((EMACS_INT) 1) << VALBITS) - 1)
547 #endif
549 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
550 written this way so that it also works if I is of unsigned
551 type. */
553 #define FIXNUM_OVERFLOW_P(i) \
554 ((i) > MOST_POSITIVE_FIXNUM \
555 || ((i) < 0 && (i) < MOST_NEGATIVE_FIXNUM))
557 /* Extract a value or address from a Lisp_Object. */
559 #define XCONS(a) (eassert (CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
560 #define XVECTOR(a) (eassert (VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
561 #define XSTRING(a) (eassert (STRINGP(a)),(struct Lisp_String *) XPNTR(a))
562 #define XSYMBOL(a) (eassert (SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
563 #define XFLOAT(a) (eassert (FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
565 /* Misc types. */
567 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
568 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC(a)->u_any))
569 #define XMISCTYPE(a) (XMISCANY (a)->type)
570 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC(a)->u_marker))
571 #define XINTFWD(a) (eassert (INTFWDP (a)), &(XMISC(a)->u_intfwd))
572 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &(XMISC(a)->u_boolfwd))
573 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &(XMISC(a)->u_objfwd))
574 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
575 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
576 #define XBUFFER_OBJFWD(a) \
577 (eassert (BUFFER_OBJFWDP (a)), &(XMISC(a)->u_buffer_objfwd))
578 #define XBUFFER_LOCAL_VALUE(a) \
579 (eassert (BUFFER_LOCAL_VALUEP (a)), &(XMISC(a)->u_buffer_local_value))
580 #define XKBOARD_OBJFWD(a) \
581 (eassert (KBOARD_OBJFWDP (a)), &(XMISC(a)->u_kboard_objfwd))
582 #define XTHREADLOCAL(a) \
583 (eassert (THREADLOCALP (a)), &(XMISC(a)->u_threadlocal))
585 /* Pseudovector types. */
587 #define XPROCESS(a) (eassert (PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
588 #define XWINDOW(a) (eassert (WINDOWP(a)),(struct window *) XPNTR(a))
589 #define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
590 #define XSUBR(a) (eassert (SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
591 #define XBUFFER(a) (eassert (BUFFERP(a)),(struct buffer *) XPNTR(a))
592 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
593 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR(a))
594 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
596 /* Construct a Lisp_Object from a value or address. */
598 #define XSETINT(a, b) (a) = make_number (b)
599 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
600 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
601 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
602 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
603 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
605 /* Misc types. */
607 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
608 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
609 #define XSETTHREADLOCAL(a, b) \
610 (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_ThreadLocal)
612 /* Pseudovector types. */
614 #define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
615 #define XSETPSEUDOVECTOR(a, b, code) \
616 (XSETVECTOR (a, b), \
617 eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
618 == (PSEUDOVECTOR_FLAG | (code))))
619 #define XSETWINDOW_CONFIGURATION(a, b) \
620 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
621 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
622 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
623 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
624 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
625 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
626 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
627 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
628 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
629 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
630 #define XSETTHREAD(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_THREAD))
632 /* Convenience macros for dealing with Lisp arrays. */
634 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
635 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->size
636 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
637 #define ASET(ARRAY, IDX, VAL) \
638 (eassert ((IDX) == (IDX)), \
639 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
640 AREF ((ARRAY), (IDX)) = (VAL))
642 /* Convenience macros for dealing with Lisp strings. */
644 #define SDATA(string) (XSTRING (string)->data + 0)
645 #define SREF(string, index) (SDATA (string)[index] + 0)
646 #define SSET(string, index, new) (SDATA (string)[index] = (new))
647 #define SCHARS(string) (XSTRING (string)->size + 0)
648 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
650 #define STRING_SET_CHARS(string, newsize) \
651 (XSTRING (string)->size = (newsize))
653 #define STRING_COPYIN(string, index, new, count) \
654 bcopy (new, SDATA (string) + index, count)
656 /* Type checking. */
658 #define CHECK_TYPE(ok, Qxxxp, x) \
659 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
663 /* See the macros in intervals.h. */
665 typedef struct interval *INTERVAL;
667 /* Complain if object is not string or buffer type */
668 #define CHECK_STRING_OR_BUFFER(x) \
669 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
672 /* In a cons, the markbit of the car is the gc mark bit */
674 struct Lisp_Cons
676 /* Please do not use the names of these elements in code other
677 than the core lisp implementation. Use XCAR and XCDR below. */
678 #ifdef HIDE_LISP_IMPLEMENTATION
679 Lisp_Object car_;
680 union
682 Lisp_Object cdr_;
683 struct Lisp_Cons *chain;
684 } u;
685 #else
686 Lisp_Object car;
687 union
689 Lisp_Object cdr;
690 struct Lisp_Cons *chain;
691 } u;
692 #endif
695 /* Take the car or cdr of something known to be a cons cell. */
696 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
697 of code that has to know what a cons cell looks like. Other code not
698 part of the basic lisp implementation should assume that the car and cdr
699 fields are not accessible as lvalues. (What if we want to switch to
700 a copying collector someday? Cached cons cell field addresses may be
701 invalidated at arbitrary points.) */
702 #ifdef HIDE_LISP_IMPLEMENTATION
703 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
704 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
705 #else
706 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
707 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
708 #endif
710 /* Use these from normal code. */
711 #define XCAR(c) LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
712 #define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))
714 /* Use these to set the fields of a cons cell.
716 Note that both arguments may refer to the same object, so 'n'
717 should not be read after 'c' is first modified. Also, neither
718 argument should be evaluated more than once; side effects are
719 especially common in the second argument. */
720 #define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
721 #define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))
723 /* For performance: Fast storage of positive integers into the
724 fields of a cons cell. See above caveats. */
725 #define XSETCARFASTINT(c,n) XSETFASTINT(XCAR_AS_LVALUE(c),(n))
726 #define XSETCDRFASTINT(c,n) XSETFASTINT(XCDR_AS_LVALUE(c),(n))
728 /* Take the car or cdr of something whose type is not known. */
729 #define CAR(c) \
730 (CONSP ((c)) ? XCAR ((c)) \
731 : NILP ((c)) ? Qnil \
732 : wrong_type_argument (Qlistp, (c)))
734 #define CDR(c) \
735 (CONSP ((c)) ? XCDR ((c)) \
736 : NILP ((c)) ? Qnil \
737 : wrong_type_argument (Qlistp, (c)))
739 /* Take the car or cdr of something whose type is not known. */
740 #define CAR_SAFE(c) \
741 (CONSP ((c)) ? XCAR ((c)) : Qnil)
743 #define CDR_SAFE(c) \
744 (CONSP ((c)) ? XCDR ((c)) : Qnil)
746 /* Nonzero if STR is a multibyte string. */
747 #define STRING_MULTIBYTE(STR) \
748 (XSTRING (STR)->size_byte >= 0)
750 /* Return the length in bytes of STR. */
752 #ifdef GC_CHECK_STRING_BYTES
754 struct Lisp_String;
755 extern int string_bytes P_ ((struct Lisp_String *));
756 #define STRING_BYTES(S) string_bytes ((S))
758 #else /* not GC_CHECK_STRING_BYTES */
760 #define STRING_BYTES(STR) \
761 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
763 #endif /* not GC_CHECK_STRING_BYTES */
765 /* Mark STR as a unibyte string. */
766 #define STRING_SET_UNIBYTE(STR) \
767 do { if (EQ (STR, empty_multibyte_string)) \
768 (STR) = empty_unibyte_string; \
769 else XSTRING (STR)->size_byte = -1; } while (0)
771 /* Mark STR as a multibyte string. Assure that STR contains only
772 ASCII characters in advance. */
773 #define STRING_SET_MULTIBYTE(STR) \
774 do { if (EQ (STR, empty_unibyte_string)) \
775 (STR) = empty_multibyte_string; \
776 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
778 /* Get text properties. */
779 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
781 /* Set text properties. */
782 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
784 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
786 struct Lisp_String
788 EMACS_INT size;
789 EMACS_INT size_byte;
790 INTERVAL intervals; /* text properties in this string */
791 unsigned char *data;
794 #ifdef offsetof
795 #define OFFSETOF(type,field) offsetof(type,field)
796 #else
797 #define OFFSETOF(type,field) \
798 ((int)((char*)&((type*)0)->field - (char*)0))
799 #endif
801 struct Lisp_Vector
803 EMACS_UINT size;
804 struct Lisp_Vector *next;
805 Lisp_Object contents[1];
808 /* If a struct is made to look like a vector, this macro returns the length
809 of the shortest vector that would hold that struct. */
810 #define VECSIZE(type) ((sizeof (type) \
811 - OFFSETOF (struct Lisp_Vector, contents[0]) \
812 + sizeof(Lisp_Object) - 1) /* round up */ \
813 / sizeof (Lisp_Object))
815 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
816 at the end and we need to compute the number of Lisp_Object fields (the
817 ones that the GC needs to trace). */
818 #define PSEUDOVECSIZE(type, nonlispfield) \
819 ((OFFSETOF(type, nonlispfield) - OFFSETOF(struct Lisp_Vector, contents[0])) \
820 / sizeof (Lisp_Object))
822 /* A char-table is a kind of vectorlike, with contents are like a
823 vector but with a few other slots. For some purposes, it makes
824 sense to handle a char-table with type struct Lisp_Vector. An
825 element of a char table can be any Lisp objects, but if it is a sub
826 char-table, we treat it a table that contains information of a
827 specific range of characters. A sub char-table has the same
828 structure as a vector. A sub char table appears only in an element
829 of a char-table, and there's no way to access it directly from
830 Emacs Lisp program. */
832 /* This is the number of slots that every char table must have. This
833 counts the ordinary slots and the top, defalt, parent, and purpose
834 slots. */
835 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
837 /* Return the number of "extra" slots in the char table CT. */
839 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
840 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
842 #ifdef __GNUC__
844 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
845 ({struct Lisp_Char_Table *_tbl = NULL; \
846 Lisp_Object _val; \
847 do { \
848 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
849 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
850 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
851 if (NILP (_val)) \
852 _val = _tbl->defalt; \
853 } while (NILP (_val) && ! NILP (_tbl->parent)); \
854 _val; })
856 #else /* not __GNUC__ */
858 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
859 (! NILP (XCHAR_TABLE (CT)->ascii) \
860 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
861 ? XCHAR_TABLE (CT)->ascii \
862 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
863 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
864 : char_table_ref ((CT), (IDX))) \
865 : char_table_ref ((CT), (IDX)))
867 #endif /* not __GNUC__ */
869 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
870 characters. Do not check validity of CT. */
871 #define CHAR_TABLE_REF(CT, IDX) \
872 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
873 : char_table_ref ((CT), (IDX)))
875 /* Almost equivalent to Faref (CT, IDX). However, if the result is
876 not a character, return IDX.
878 For these characters, do not check validity of CT
879 and do not follow parent. */
880 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
881 char_table_translate (CT, IDX)
883 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
884 8-bit European characters. Do not check validity of CT. */
885 #define CHAR_TABLE_SET(CT, IDX, VAL) \
886 (((IDX) >= 0 && ASCII_CHAR_P (IDX) \
887 && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)) \
888 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
889 : char_table_set (CT, IDX, VAL))
891 #define CHARTAB_SIZE_BITS_0 6
892 #define CHARTAB_SIZE_BITS_1 4
893 #define CHARTAB_SIZE_BITS_2 5
894 #define CHARTAB_SIZE_BITS_3 7
896 extern const int chartab_size[4];
898 struct Lisp_Sub_Char_Table;
900 struct Lisp_Char_Table
902 /* This is the vector's size field, which also holds the
903 pseudovector type information. It holds the size, too.
904 The size counts the defalt, parent, purpose, ascii,
905 contents, and extras slots. */
906 EMACS_UINT size;
907 struct Lisp_Vector *next;
909 /* This holds a default value,
910 which is used whenever the value for a specific character is nil. */
911 Lisp_Object defalt;
913 /* This points to another char table, which we inherit from when the
914 value for a specific character is nil. The `defalt' slot takes
915 precedence over this. */
916 Lisp_Object parent;
918 /* This is a symbol which says what kind of use this char-table is
919 meant for. */
920 Lisp_Object purpose;
922 /* The bottom sub char-table for characters of the range 0..127. It
923 is nil if none of ASCII character has a specific value. */
924 Lisp_Object ascii;
926 Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)];
928 /* These hold additional data. It is a vector. */
929 Lisp_Object extras[1];
932 struct Lisp_Sub_Char_Table
934 /* This is the vector's size field, which also holds the
935 pseudovector type information. It holds the size, too. */
936 EMACS_INT size;
937 struct Lisp_Vector *next;
939 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
940 char-table of depth 1 contains 16 elments, and each element
941 covers 4096 (128*32) characters. A sub char-table of depth 2
942 contains 32 elements, and each element covers 128 characters. A
943 sub char-table of depth 3 contains 128 elements, and each element
944 is for one character. */
945 Lisp_Object depth;
947 /* Minimum character covered by the sub char-table. */
948 Lisp_Object min_char;
950 Lisp_Object contents[1];
953 /* A boolvector is a kind of vectorlike, with contents are like a string. */
954 struct Lisp_Bool_Vector
956 /* This is the vector's size field. It doesn't have the real size,
957 just the subtype information. */
958 EMACS_UINT vector_size;
959 struct Lisp_Vector *next;
960 /* This is the size in bits. */
961 EMACS_UINT size;
962 /* This contains the actual bits, packed into bytes. */
963 unsigned char data[1];
966 /* This structure describes a built-in function.
967 It is generated by the DEFUN macro only.
968 defsubr makes it into a Lisp object.
970 This type is treated in most respects as a pseudovector,
971 but since we never dynamically allocate or free them,
972 we don't need a next-vector field. */
974 struct Lisp_Subr
976 EMACS_UINT size;
977 Lisp_Object (*function) ();
978 short min_args, max_args;
979 const char *symbol_name;
980 char *intspec;
981 char *doc;
985 /***********************************************************************
986 Symbols
987 ***********************************************************************/
989 /* Interned state of a symbol. */
991 enum symbol_interned
993 SYMBOL_UNINTERNED = 0,
994 SYMBOL_INTERNED = 1,
995 SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
998 /* In a symbol, the markbit of the plist is used as the gc mark bit */
1000 struct Lisp_Symbol
1002 unsigned gcmarkbit : 1;
1004 /* Non-zero means symbol serves as a variable alias. The symbol
1005 holding the real value is found in the value slot. */
1006 unsigned indirect_variable : 1;
1008 /* Non-zero means symbol is constant, i.e. changing its value
1009 should signal an error. */
1010 unsigned constant : 1;
1012 /* Interned state of the symbol. This is an enumerator from
1013 enum symbol_interned. */
1014 unsigned interned : 2;
1016 /* The symbol's name, as a Lisp string.
1018 The name "xname" is used to intentionally break code referring to
1019 the old field "name" of type pointer to struct Lisp_String. */
1020 Lisp_Object xname;
1022 /* Value of the symbol or Qunbound if unbound. If this symbol is a
1023 defvaralias, `value' contains the symbol for which it is an
1024 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
1025 and set a symbol's value, to take defvaralias into account. */
1026 Lisp_Object value;
1028 /* Function value of the symbol or Qunbound if not fboundp. */
1029 Lisp_Object function;
1031 /* The symbol's property list. */
1032 Lisp_Object plist;
1034 /* Next symbol in obarray bucket, if the symbol is interned. */
1035 struct Lisp_Symbol *next;
1038 /* Value is name of symbol. */
1040 #define SYMBOL_NAME(sym) \
1041 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1043 /* Value is non-zero if SYM is an interned symbol. */
1045 #define SYMBOL_INTERNED_P(sym) \
1046 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1048 /* Value is non-zero if SYM is interned in initial_obarray. */
1050 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1051 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1053 /* Value is non-zero if symbol is considered a constant, i.e. its
1054 value cannot be changed (there is an exception for keyword symbols,
1055 whose value can be set to the keyword symbol itself). */
1057 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1059 /* Value is the value of SYM, with defvaralias taken into
1060 account. */
1062 #define SYMBOL_VALUE(sym) \
1063 (XSYMBOL (sym)->indirect_variable \
1064 ? indirect_variable (XSYMBOL (sym))->value \
1065 : XSYMBOL (sym)->value)
1067 /* Set SYM's value to VAL, taking defvaralias into account. */
1069 #define SET_SYMBOL_VALUE(sym, val) \
1070 do { \
1071 if (XSYMBOL (sym)->indirect_variable) \
1072 indirect_variable (XSYMBOL (sym))->value = (val); \
1073 else \
1074 XSYMBOL (sym)->value = (val); \
1075 } while (0)
1078 /***********************************************************************
1079 Hash Tables
1080 ***********************************************************************/
1082 /* The structure of a Lisp hash table. */
1084 struct Lisp_Hash_Table
1086 /* Vector fields. The hash table code doesn't refer to these. */
1087 EMACS_UINT size;
1088 struct Lisp_Vector *vec_next;
1090 /* Function used to compare keys. */
1091 Lisp_Object test;
1093 /* Nil if table is non-weak. Otherwise a symbol describing the
1094 weakness of the table. */
1095 Lisp_Object weak;
1097 /* When the table is resized, and this is an integer, compute the
1098 new size by adding this to the old size. If a float, compute the
1099 new size by multiplying the old size with this factor. */
1100 Lisp_Object rehash_size;
1102 /* Resize hash table when number of entries/ table size is >= this
1103 ratio, a float. */
1104 Lisp_Object rehash_threshold;
1106 /* Vector of hash codes.. If hash[I] is nil, this means that that
1107 entry I is unused. */
1108 Lisp_Object hash;
1110 /* Vector used to chain entries. If entry I is free, next[I] is the
1111 entry number of the next free item. If entry I is non-free,
1112 next[I] is the index of the next entry in the collision chain. */
1113 Lisp_Object next;
1115 /* Index of first free entry in free list. */
1116 Lisp_Object next_free;
1118 /* Bucket vector. A non-nil entry is the index of the first item in
1119 a collision chain. This vector's size can be larger than the
1120 hash table size to reduce collisions. */
1121 Lisp_Object index;
1123 /* User-supplied hash function, or nil. */
1124 Lisp_Object user_hash_function;
1126 /* User-supplied key comparison function, or nil. */
1127 Lisp_Object user_cmp_function;
1129 /* Only the fields above are traced normally by the GC. The ones below
1130 `count'. are special and are either ignored by the GC or traced in
1131 a special way (e.g. because of weakness). */
1133 /* Number of key/value entries in the table. */
1134 unsigned int count;
1136 /* Vector of keys and values. The key of item I is found at index
1137 2 * I, the value is found at index 2 * I + 1.
1138 This is gc_marked specially if the table is weak. */
1139 Lisp_Object key_and_value;
1141 /* Next weak hash table if this is a weak hash table. The head
1142 of the list is in weak_hash_tables. */
1143 struct Lisp_Hash_Table *next_weak;
1145 /* C function to compare two keys. */
1146 int (* cmpfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object,
1147 unsigned, Lisp_Object, unsigned));
1149 /* C function to compute hash code. */
1150 unsigned (* hashfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object));
1154 #define XHASH_TABLE(OBJ) \
1155 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1157 #define XSET_HASH_TABLE(VAR, PTR) \
1158 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1160 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1162 #define CHECK_HASH_TABLE(x) \
1163 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1165 /* Value is the key part of entry IDX in hash table H. */
1167 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1169 /* Value is the value part of entry IDX in hash table H. */
1171 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1173 /* Value is the index of the next entry following the one at IDX
1174 in hash table H. */
1176 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1178 /* Value is the hash code computed for entry IDX in hash table H. */
1180 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1182 /* Value is the index of the element in hash table H that is the
1183 start of the collision list at index IDX in the index vector of H. */
1185 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1187 /* Value is the size of hash table H. */
1189 #define HASH_TABLE_SIZE(H) XVECTOR ((H)->next)->size
1191 /* Default size for hash tables if not specified. */
1193 #define DEFAULT_HASH_SIZE 65
1195 /* Default threshold specifying when to resize a hash table. The
1196 value gives the ratio of current entries in the hash table and the
1197 size of the hash table. */
1199 #define DEFAULT_REHASH_THRESHOLD 0.8
1201 /* Default factor by which to increase the size of a hash table. */
1203 #define DEFAULT_REHASH_SIZE 1.5
1206 /* These structures are used for various misc types. */
1208 struct Lisp_Misc_Any /* Supertype of all Misc types. */
1210 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Marker */
1211 unsigned gcmarkbit : 1;
1212 int spacer : 15;
1215 struct Lisp_Marker
1217 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Marker */
1218 unsigned gcmarkbit : 1;
1219 int spacer : 13;
1220 /* This flag is temporarily used in the functions
1221 decode/encode_coding_object to record that the marker position
1222 must be adjusted after the conversion. */
1223 unsigned int need_adjustment : 1;
1224 /* 1 means normal insertion at the marker's position
1225 leaves the marker after the inserted text. */
1226 unsigned int insertion_type : 1;
1227 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1228 Note: a chain of markers can contain markers pointing into different
1229 buffers (the chain is per buffer_text rather than per buffer, so it's
1230 shared between indirect buffers). */
1231 /* This is used for (other than NULL-checking):
1232 - Fmarker_buffer
1233 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1234 - unchain_marker: to find the list from which to unchain.
1235 - Fkill_buffer: to unchain the markers of current indirect buffer.
1237 struct buffer *buffer;
1239 /* The remaining fields are meaningless in a marker that
1240 does not point anywhere. */
1242 /* For markers that point somewhere,
1243 this is used to chain of all the markers in a given buffer. */
1244 /* We could remove it and use an array in buffer_text instead.
1245 That would also allow to preserve it ordered. */
1246 struct Lisp_Marker *next;
1247 /* This is the char position where the marker points. */
1248 EMACS_INT charpos;
1249 /* This is the byte position. */
1250 EMACS_INT bytepos;
1253 /* Forwarding pointer to an int variable.
1254 This is allowed only in the value cell of a symbol,
1255 and it means that the symbol's value really lives in the
1256 specified int variable. */
1257 struct Lisp_Intfwd
1259 int type : 16; /* = Lisp_Misc_Intfwd */
1260 unsigned gcmarkbit : 1;
1261 int spacer : 15;
1262 EMACS_INT *intvar;
1265 /* Boolean forwarding pointer to an int variable.
1266 This is like Lisp_Intfwd except that the ostensible
1267 "value" of the symbol is t if the int variable is nonzero,
1268 nil if it is zero. */
1269 struct Lisp_Boolfwd
1271 int type : 16; /* = Lisp_Misc_Boolfwd */
1272 unsigned gcmarkbit : 1;
1273 int spacer : 15;
1274 int *boolvar;
1277 /* Forwarding pointer to a Lisp_Object variable.
1278 This is allowed only in the value cell of a symbol,
1279 and it means that the symbol's value really lives in the
1280 specified variable. */
1281 struct Lisp_Objfwd
1283 int type : 16; /* = Lisp_Misc_Objfwd */
1284 unsigned gcmarkbit : 1;
1285 int spacer : 15;
1286 Lisp_Object *objvar;
1289 /* Like Lisp_Objfwd except that value lives in a slot in the
1290 current buffer. Value is byte index of slot within buffer. */
1291 struct Lisp_Buffer_Objfwd
1293 int type : 16; /* = Lisp_Misc_Buffer_Objfwd */
1294 unsigned gcmarkbit : 1;
1295 int spacer : 15;
1296 Lisp_Object slottype; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1297 int offset;
1300 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1301 the symbol has buffer-local or frame-local bindings. (Exception:
1302 some buffer-local variables are built-in, with their values stored
1303 in the buffer structure itself. They are handled differently,
1304 using struct Lisp_Buffer_Objfwd.)
1306 The `realvalue' slot holds the variable's current value, or a
1307 forwarding pointer to where that value is kept. This value is the
1308 one that corresponds to the loaded binding. To read or set the
1309 variable, you must first make sure the right binding is loaded;
1310 then you can access the value in (or through) `realvalue'.
1312 `buffer' and `frame' are the buffer and frame for which the loaded
1313 binding was found. If those have changed, to make sure the right
1314 binding is loaded it is necessary to find which binding goes with
1315 the current buffer and selected frame, then load it. To load it,
1316 first unload the previous binding, then copy the value of the new
1317 binding into `realvalue' (or through it). Also update
1318 LOADED-BINDING to point to the newly loaded binding.
1320 `local_if_set' indicates that merely setting the variable creates a local
1321 binding for the current buffer. Otherwise the latter, setting the
1322 variable does not do that; only make-local-variable does that. */
1324 struct Lisp_Buffer_Local_Value
1326 int type : 16; /* = Lisp_Misc_Buffer_Local_Value */
1327 unsigned gcmarkbit : 1;
1328 int spacer : 11;
1330 /* 1 means that merely setting the variable creates a local
1331 binding for the current buffer */
1332 unsigned int local_if_set : 1;
1333 /* 1 means this variable is allowed to have frame-local bindings,
1334 so check for them when looking for the proper binding. */
1335 unsigned int check_frame : 1;
1336 /* 1 means that the binding now loaded was found
1337 as a local binding for the buffer in the `buffer' slot. */
1338 /* unsigned int found_for_buffer : 1; */
1339 /* 1 means that the binding now loaded was found
1340 as a local binding for the frame in the `frame' slot. */
1341 /* unsigned int found_for_frame : 1; */
1342 Lisp_Object realvalue;
1344 /* The buffer and frame for which the loaded binding was found. */
1345 /* Having both is only needed if we want to allow variables that are
1346 both buffer local and frame local (in which case, we currently give
1347 precedence to the buffer-local binding). I don't think such
1348 a combination is desirable. --Stef */
1349 /* Lisp_Object buffer, frame; */
1351 /* A cons cell, (LOADED-BINDING . DEFAULT-VALUE).
1353 LOADED-BINDING is the binding now loaded. It is a cons cell
1354 whose cdr is the binding's value. The cons cell may be an
1355 element of a buffer's local-variable alist, or an element of a
1356 frame's parameter alist, or it may be this cons cell.
1358 DEFAULT-VALUE is the variable's default value, seen when the
1359 current buffer and selected frame do not have their own
1360 bindings for the variable. When the default binding is loaded,
1361 LOADED-BINDING is actually this very cons cell; thus, its car
1362 points to itself. */
1363 /* Lisp_Object cdr; */
1365 Lisp_Object thread_data;
1368 void blocal_unbind_thread (Lisp_Object thread);
1369 Lisp_Object *blocal_get_thread_data (struct Lisp_Buffer_Local_Value *l,
1370 Lisp_Object sym);
1371 void blocal_set_thread_data (struct Lisp_Buffer_Local_Value *l, Lisp_Object o);
1372 Lisp_Object *blocal_getrealvalue (struct Lisp_Buffer_Local_Value *l);
1374 #define BLOCAL_CLEAR_FLAGS_VEC(VEC) XSETFASTINT (AREF ((VEC), 0), 0)
1375 #define BLOCAL_FOUND_FOR_BUFFER_VEC(VEC) ((XFASTINT (AREF ((VEC), 0))) == 1)
1376 #define BLOCAL_SET_FOUND_FOR_BUFFER_VEC(VEC) XSETFASTINT (AREF ((VEC), 0), 1)
1377 #define BLOCAL_FOUND_FOR_FRAME_VEC(VEC) ((XFASTINT (AREF ((VEC), 0))) == 2)
1378 #define BLOCAL_SET_FOUND_FOR_FRAME_VEC(VEC) XSETFASTINT (AREF ((VEC), 0), 2)
1379 #define BLOCAL_BUFFER_VEC(VEC) (AREF ((VEC), 1))
1380 #define BLOCAL_FRAME_VEC(VEC) (AREF ((VEC), 2))
1381 #define BLOCAL_CDR_VEC(VEC) (AREF ((VEC), 3))
1382 #define BLOCAL_THREAD_DATA(A) (*blocal_get_thread_data (A, Qnil))
1383 #define BLOCAL_SET_THREAD_DATA(A, B) (blocal_set_thread_data (A, B))
1384 #define BLOCAL_CLEAR_FLAGS(A) (BLOCAL_CLEAR_FLAGS_VEC (BLOCAL_THREAD_DATA (A)))
1385 #define BLOCAL_FOUND_FOR_BUFFER(A) (BLOCAL_FOUND_FOR_BUFFER_VEC (BLOCAL_THREAD_DATA (A)))
1386 #define BLOCAL_SET_FOUND_FOR_BUFFER(A) (BLOCAL_SET_FOUND_FOR_BUFFER_VEC (BLOCAL_THREAD_DATA (A)))
1387 #define BLOCAL_FOUND_FOR_FRAME(A) (BLOCAL_FOUND_FOR_FRAME_VEC (BLOCAL_THREAD_DATA (A)))
1388 #define BLOCAL_SET_FOUND_FOR_FRAME(A) (BLOCAL_SET_FOUND_FOR_FRAME_VEC (BLOCAL_THREAD_DATA (A)))
1389 #define BLOCAL_BUFFER(A) (BLOCAL_BUFFER_VEC (BLOCAL_THREAD_DATA (A)))
1390 #define BLOCAL_FRAME(A) (BLOCAL_FRAME_VEC (BLOCAL_THREAD_DATA (A)))
1391 #define BLOCAL_CDR(A) (BLOCAL_CDR_VEC (BLOCAL_THREAD_DATA (A)))
1392 #define BLOCAL_REALVALUE(A) (*blocal_getrealvalue (A))
1394 /* START and END are markers in the overlay's buffer, and
1395 PLIST is the overlay's property list. */
1396 struct Lisp_Overlay
1398 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Overlay */
1399 unsigned gcmarkbit : 1;
1400 int spacer : 15;
1401 struct Lisp_Overlay *next;
1402 Lisp_Object start, end, plist;
1405 /* Like Lisp_Objfwd except that value lives in a slot in the
1406 current kboard. */
1407 struct Lisp_Kboard_Objfwd
1409 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Kboard_Objfwd */
1410 unsigned gcmarkbit : 1;
1411 int spacer : 15;
1412 int offset;
1415 /* Hold a C pointer for later use.
1416 This type of object is used in the arg to record_unwind_protect. */
1417 struct Lisp_Save_Value
1419 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Save_Value */
1420 unsigned gcmarkbit : 1;
1421 int spacer : 14;
1422 /* If DOGC is set, POINTER is the address of a memory
1423 area containing INTEGER potential Lisp_Objects. */
1424 unsigned int dogc : 1;
1425 void *pointer;
1426 int integer;
1429 struct Lisp_ThreadLocal
1431 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_ThreadLocal */
1432 unsigned gcmarkbit : 1;
1433 int spacer : 15;
1434 Lisp_Object global;
1435 Lisp_Object thread_alist;
1439 /* A miscellaneous object, when it's on the free list. */
1440 struct Lisp_Free
1442 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Free */
1443 unsigned gcmarkbit : 1;
1444 int spacer : 15;
1445 union Lisp_Misc *chain;
1446 #ifdef USE_LSB_TAG
1447 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1448 This assumes that Lisp_Marker is the largest of the alternatives and
1449 that Lisp_Intfwd has the same size as "Lisp_Free w/o padding". */
1450 char padding[((((sizeof (struct Lisp_Marker) - 1) >> GCTYPEBITS) + 1)
1451 << GCTYPEBITS) - sizeof (struct Lisp_Intfwd)];
1452 #endif
1455 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1456 It uses one of these struct subtypes to get the type field. */
1458 union Lisp_Misc
1460 struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */
1461 struct Lisp_Free u_free; /* Includes padding to force alignment. */
1462 struct Lisp_Marker u_marker;
1463 struct Lisp_Intfwd u_intfwd;
1464 struct Lisp_Boolfwd u_boolfwd;
1465 struct Lisp_Objfwd u_objfwd;
1466 struct Lisp_Buffer_Objfwd u_buffer_objfwd;
1467 struct Lisp_Buffer_Local_Value u_buffer_local_value;
1468 struct Lisp_Overlay u_overlay;
1469 struct Lisp_Kboard_Objfwd u_kboard_objfwd;
1470 struct Lisp_Save_Value u_save_value;
1471 struct Lisp_ThreadLocal u_threadlocal;
1474 /* Lisp floating point type */
1475 struct Lisp_Float
1477 union
1479 #ifdef HIDE_LISP_IMPLEMENTATION
1480 double data_;
1481 #else
1482 double data;
1483 #endif
1484 struct Lisp_Float *chain;
1485 } u;
1488 #ifdef HIDE_LISP_IMPLEMENTATION
1489 #define XFLOAT_DATA(f) (XFLOAT (f)->u.data_ + 0)
1490 #else
1491 #define XFLOAT_DATA(f) (XFLOAT (f)->u.data + 0)
1492 /* This should be used only in alloc.c, which always disables
1493 HIDE_LISP_IMPLEMENTATION. */
1494 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1495 #endif
1497 /* A character, declared with the following typedef, is a member
1498 of some character set associated with the current buffer. */
1499 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1500 #define _UCHAR_T
1501 typedef unsigned char UCHAR;
1502 #endif
1504 /* Meanings of slots in a Lisp_Compiled: */
1506 #define COMPILED_ARGLIST 0
1507 #define COMPILED_BYTECODE 1
1508 #define COMPILED_CONSTANTS 2
1509 #define COMPILED_STACK_DEPTH 3
1510 #define COMPILED_DOC_STRING 4
1511 #define COMPILED_INTERACTIVE 5
1513 /* Flag bits in a character. These also get used in termhooks.h.
1514 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1515 (MUlti-Lingual Emacs) might need 22 bits for the character value
1516 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1517 #define CHAR_ALT (0x0400000)
1518 #define CHAR_SUPER (0x0800000)
1519 #define CHAR_HYPER (0x1000000)
1520 #define CHAR_SHIFT (0x2000000)
1521 #define CHAR_CTL (0x4000000)
1522 #define CHAR_META (0x8000000)
1524 #define CHAR_MODIFIER_MASK \
1525 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1528 /* Actually, the current Emacs uses 22 bits for the character value
1529 itself. */
1530 #define CHARACTERBITS 22
1532 /* The maximum byte size consumed by push_key_description.
1533 All callers should assure that at least this size of memory is
1534 allocated at the place pointed by the second argument.
1536 There are 6 modifiers, each consumes 2 chars.
1537 The octal form of a character code consumes
1538 (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
1539 We need one more byte for string terminator `\0'. */
1540 #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)
1543 /* The glyph datatype, used to represent characters on the display.
1544 It consists of a char code and a face id. */
1546 typedef struct {
1547 int ch;
1548 int face_id;
1549 } GLYPH;
1551 /* Return a glyph's character code. */
1552 #define GLYPH_CHAR(glyph) ((glyph).ch)
1554 /* Return a glyph's face ID. */
1555 #define GLYPH_FACE(glyph) ((glyph).face_id)
1557 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1558 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1559 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1561 /* Return 1 if GLYPH contains valid character code. */
1562 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph), 1)
1565 /* Glyph Code from a display vector may either be an integer which
1566 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1567 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1569 #define GLYPH_CODE_CHAR(gc) \
1570 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1572 #define GLYPH_CODE_FACE(gc) \
1573 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1575 /* Return 1 if glyph code from display vector contains valid character code. */
1576 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc), 1)
1578 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1580 /* Only called when GLYPH_CODE_P (gc) is true. */
1581 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1582 do \
1584 if (CONSP (gc)) \
1585 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1586 else \
1587 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1588 (XINT (gc) >> CHARACTERBITS)); \
1590 while (0)
1592 /* The ID of the mode line highlighting face. */
1593 #define GLYPH_MODE_LINE_FACE 1
1595 /* Data type checking */
1597 #define NILP(x) EQ (x, Qnil)
1599 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1600 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1602 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1603 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1604 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1605 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1606 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1607 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1609 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1610 #define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1611 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1612 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1613 #define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
1614 #define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
1615 #define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
1616 #define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
1617 #define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
1618 #define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1619 #define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1620 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1621 #define THREADLOCALP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_ThreadLocal)
1624 /* True if object X is a pseudovector whose code is CODE. */
1625 #define PSEUDOVECTORP(x, code) \
1626 (VECTORLIKEP (x) \
1627 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1628 == (PSEUDOVECTOR_FLAG | (code))))
1630 /* Test for specific pseudovector types. */
1631 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1632 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1633 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1634 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1635 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1636 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1637 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1638 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1639 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1640 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1641 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1642 #define THREADP(x) PSEUDOVECTORP (x, PVEC_THREAD)
1644 /* Test for image (image . spec) */
1645 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1647 /* Array types. */
1649 #define ARRAYP(x) \
1650 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1652 #define CHECK_LIST(x) \
1653 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1655 #define CHECK_LIST_CONS(x, y) \
1656 CHECK_TYPE (CONSP (x), Qlistp, y)
1658 #define CHECK_LIST_END(x, y) \
1659 CHECK_TYPE (NILP (x), Qlistp, y)
1661 #define CHECK_STRING(x) \
1662 CHECK_TYPE (STRINGP (x), Qstringp, x)
1664 #define CHECK_STRING_CAR(x) \
1665 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1667 #define CHECK_CONS(x) \
1668 CHECK_TYPE (CONSP (x), Qconsp, x)
1670 #define CHECK_SYMBOL(x) \
1671 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1673 #define CHECK_CHAR_TABLE(x) \
1674 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1676 #define CHECK_VECTOR(x) \
1677 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1679 #define CHECK_VECTOR_OR_STRING(x) \
1680 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1682 #define CHECK_ARRAY(x, Qxxxp) \
1683 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1685 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1686 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1688 #define CHECK_BUFFER(x) \
1689 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1691 #define CHECK_WINDOW(x) \
1692 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1694 #define CHECK_WINDOW_CONFIGURATION(x) \
1695 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1697 /* This macro rejects windows on the interior of the window tree as
1698 "dead", which is what we want; this is an argument-checking macro, and
1699 the user should never get access to interior windows.
1701 A window of any sort, leaf or interior, is dead if the buffer,
1702 vchild, and hchild members are all nil. */
1704 #define CHECK_LIVE_WINDOW(x) \
1705 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1707 #define CHECK_PROCESS(x) \
1708 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1710 #define CHECK_SUBR(x) \
1711 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1713 #define CHECK_NUMBER(x) \
1714 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1716 #define CHECK_NATNUM(x) \
1717 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1719 #define CHECK_MARKER(x) \
1720 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1722 #define CHECK_NUMBER_COERCE_MARKER(x) \
1723 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1724 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1726 #define XFLOATINT(n) extract_float((n))
1728 #define CHECK_FLOAT(x) \
1729 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1731 #define CHECK_NUMBER_OR_FLOAT(x) \
1732 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1734 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1735 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1736 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1738 #define CHECK_OVERLAY(x) \
1739 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1741 /* Since we can't assign directly to the CAR or CDR fields of a cons
1742 cell, use these when checking that those fields contain numbers. */
1743 #define CHECK_NUMBER_CAR(x) \
1744 do { \
1745 Lisp_Object tmp = XCAR (x); \
1746 CHECK_NUMBER (tmp); \
1747 XSETCAR ((x), tmp); \
1748 } while (0)
1750 #define CHECK_NUMBER_CDR(x) \
1751 do { \
1752 Lisp_Object tmp = XCDR (x); \
1753 CHECK_NUMBER (tmp); \
1754 XSETCDR ((x), tmp); \
1755 } while (0)
1757 #define CHECK_NATNUM_CAR(x) \
1758 do { \
1759 Lisp_Object tmp = XCAR (x); \
1760 CHECK_NATNUM (tmp); \
1761 XSETCAR ((x), tmp); \
1762 } while (0)
1764 #define CHECK_NATNUM_CDR(x) \
1765 do { \
1766 Lisp_Object tmp = XCDR (x); \
1767 CHECK_NATNUM (tmp); \
1768 XSETCDR ((x), tmp); \
1769 } while (0)
1771 /* Cast pointers to this type to compare them. Some machines want int. */
1772 #define PNTR_COMPARISON_TYPE EMACS_UINT
1774 /* Define a built-in function for calling from Lisp.
1775 `lname' should be the name to give the function in Lisp,
1776 as a null-terminated C string.
1777 `fnname' should be the name of the function in C.
1778 By convention, it starts with F.
1779 `sname' should be the name for the C constant structure
1780 that records information on this function for internal use.
1781 By convention, it should be the same as `fnname' but with S instead of F.
1782 It's too bad that C macros can't compute this from `fnname'.
1783 `minargs' should be a number, the minimum number of arguments allowed.
1784 `maxargs' should be a number, the maximum number of arguments allowed,
1785 or else MANY or UNEVALLED.
1786 MANY means pass a vector of evaluated arguments,
1787 in the form of an integer number-of-arguments
1788 followed by the address of a vector of Lisp_Objects
1789 which contains the argument values.
1790 UNEVALLED means pass the list of unevaluated arguments
1791 `intspec' says how interactive arguments are to be fetched.
1792 If the string starts with a `(', `intspec' is evaluated and the resulting
1793 list is the list of arguments.
1794 If it's a string that doesn't start with `(', the value should follow
1795 the one of the doc string for `interactive'.
1796 A null string means call interactively with no arguments.
1797 `doc' is documentation for the user. */
1799 /* This version of DEFUN declares a function prototype with the right
1800 arguments, so we can catch errors with maxargs at compile-time. */
1801 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1802 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1803 DECL_ALIGN (struct Lisp_Subr, sname) = \
1804 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1805 fnname, minargs, maxargs, lname, intspec, 0}; \
1806 Lisp_Object fnname
1808 /* Note that the weird token-substitution semantics of ANSI C makes
1809 this work for MANY and UNEVALLED. */
1810 #define DEFUN_ARGS_MANY (int, Lisp_Object *)
1811 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1812 #define DEFUN_ARGS_0 (void)
1813 #define DEFUN_ARGS_1 (Lisp_Object)
1814 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1815 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1816 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1817 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1818 Lisp_Object)
1819 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1820 Lisp_Object, Lisp_Object)
1821 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1822 Lisp_Object, Lisp_Object, Lisp_Object)
1823 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1824 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1825 /* Non-zero if OBJ is a Lisp function. */
1827 #define FUNCTIONP(OBJ) \
1828 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1829 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1830 || COMPILEDP (OBJ) \
1831 || SUBRP (OBJ))
1833 /* defsubr (Sname);
1834 is how we define the symbol for function `name' at start-up time. */
1835 extern void defsubr P_ ((struct Lisp_Subr *));
1837 #define MANY -2
1838 #define UNEVALLED -1
1840 extern void defvar_lisp (const char *, Lisp_Object *);
1841 extern void defvar_lisp_nopro (const char *, Lisp_Object *);
1842 extern void defvar_bool (const char *, int *);
1843 extern void defvar_int (const char *, EMACS_INT *);
1844 extern void defvar_kboard (const char *, int);
1846 /* Macros we use to define forwarded Lisp variables.
1847 These are used in the syms_of_FILENAME functions. */
1849 #define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
1850 #define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
1851 #define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
1852 #define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
1854 #define DEFVAR_KBOARD(lname, vname, doc) \
1855 defvar_kboard (lname, \
1856 (int)((char *)(&current_kboard->vname) \
1857 - (char *)current_kboard))
1861 /* Structure for recording Lisp call stack for backtrace purposes. */
1863 /* The special binding stack holds the outer values of variables while
1864 they are bound by a function application or a let form, stores the
1865 code to be executed for Lisp unwind-protect forms, and stores the C
1866 functions to be called for record_unwind_protect.
1868 If func is non-zero, undoing this binding applies func to old_value;
1869 This implements record_unwind_protect.
1871 Otherwise, the element is a variable binding.
1873 If the symbol field is a symbol, it is an ordinary variable binding.
1875 Otherwise, it should be a structure (SYMBOL WHERE
1876 . CURRENT-BUFFER), which means having bound a local value while
1877 CURRENT-BUFFER was active. If WHERE is nil this means we saw the
1878 default value when binding SYMBOL. WHERE being a buffer or frame
1879 means we saw a buffer-local or frame-local value. Other values of
1880 WHERE mean an internal error. */
1882 typedef Lisp_Object (*specbinding_func) P_ ((Lisp_Object));
1884 struct specbinding
1886 Lisp_Object symbol, old_value;
1887 specbinding_func func;
1888 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
1891 extern EMACS_INT max_specpdl_size;
1893 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
1895 /* Everything needed to describe an active condition case. */
1896 struct handler
1898 /* The handler clauses and variable from the condition-case form. */
1899 /* For a handler set up in Lisp code, this is always a list.
1900 For an internal handler set up by internal_condition_case*,
1901 this can instead be the symbol t or `error'.
1902 t: handle all conditions.
1903 error: handle all conditions, and errors can run the debugger
1904 or display a backtrace. */
1905 Lisp_Object handler;
1906 Lisp_Object var;
1907 /* Fsignal stores here the condition-case clause that applies,
1908 and Fcondition_case thus knows which clause to run. */
1909 Lisp_Object chosen_clause;
1911 /* Used to effect the longjump out to the handler. */
1912 struct catchtag *tag;
1914 /* The next enclosing handler. */
1915 struct handler *next;
1918 extern struct handler *handlerlist;
1920 /* This structure helps implement the `catch' and `throw' control
1921 structure. A struct catchtag contains all the information needed
1922 to restore the state of the interpreter after a non-local jump.
1924 Handlers for error conditions (represented by `struct handler'
1925 structures) just point to a catch tag to do the cleanup required
1926 for their jumps.
1928 catchtag structures are chained together in the C calling stack;
1929 the `next' member points to the next outer catchtag.
1931 A call like (throw TAG VAL) searches for a catchtag whose `tag'
1932 member is TAG, and then unbinds to it. The `val' member is used to
1933 hold VAL while the stack is unwound; `val' is returned as the value
1934 of the catch form.
1936 All the other members are concerned with restoring the interpreter
1937 state. */
1939 struct catchtag
1941 Lisp_Object tag;
1942 Lisp_Object val;
1943 struct catchtag *next;
1944 struct gcpro *gcpro;
1945 jmp_buf jmp;
1946 struct backtrace *backlist;
1947 struct handler *handlerlist;
1948 int lisp_eval_depth;
1949 int pdlcount;
1950 int poll_suppress_count;
1951 int interrupt_input_blocked;
1952 struct byte_stack *byte_stack;
1955 extern struct catchtag *catchlist;
1956 extern struct backtrace *backtrace_list;
1958 extern Lisp_Object memory_signal_data;
1960 /* Check quit-flag and quit if it is non-nil.
1961 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
1962 So the program needs to do QUIT at times when it is safe to quit.
1963 Every loop that might run for a long time or might not exit
1964 ought to do QUIT at least once, at a safe place.
1965 Unless that is impossible, of course.
1966 But it is very desirable to avoid creating loops where QUIT is impossible.
1968 Exception: if you set immediate_quit to nonzero,
1969 then the handler that responds to the C-g does the quit itself.
1970 This is a good thing to do around a loop that has no side effects
1971 and (in particular) cannot call arbitrary Lisp code. */
1973 #ifdef SYNC_INPUT
1974 extern void process_pending_signals P_ ((void));
1975 extern int pending_signals;
1976 #define ELSE_PENDING_SIGNALS \
1977 else if (pending_signals) \
1978 process_pending_signals ();
1979 #else /* not SYNC_INPUT */
1980 #define ELSE_PENDING_SIGNALS
1981 #endif /* not SYNC_INPUT */
1983 #define QUIT \
1984 do { \
1985 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1987 Lisp_Object flag = Vquit_flag; \
1988 Vquit_flag = Qnil; \
1989 if (EQ (Vthrow_on_input, flag)) \
1990 Fthrow (Vthrow_on_input, Qt); \
1991 Fsignal (Qquit, Qnil); \
1993 ELSE_PENDING_SIGNALS \
1994 } while (0)
1997 /* Nonzero if ought to quit now. */
1999 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2001 /* Variables used locally in the following case handling macros. */
2002 extern int case_temp1;
2003 extern Lisp_Object case_temp2;
2005 /* Current buffer's map from characters to lower-case characters. */
2007 #define DOWNCASE_TABLE BUF_DOWNCASE_TABLE (current_buffer)
2009 /* Current buffer's map from characters to upper-case characters. */
2011 #define UPCASE_TABLE BUF_UPCASE_TABLE (current_buffer)
2013 /* Downcase a character, or make no change if that cannot be done. */
2015 #define DOWNCASE(CH) \
2016 ((case_temp1 = (CH), \
2017 case_temp2 = CHAR_TABLE_REF (DOWNCASE_TABLE, case_temp1), \
2018 NATNUMP (case_temp2)) \
2019 ? XFASTINT (case_temp2) : case_temp1)
2021 /* 1 if CH is upper case. */
2023 #define UPPERCASEP(CH) (DOWNCASE (CH) != (CH))
2025 /* 1 if CH is neither upper nor lower case. */
2027 #define NOCASEP(CH) (UPCASE1 (CH) == (CH))
2029 /* 1 if CH is lower case. */
2031 #define LOWERCASEP(CH) (!UPPERCASEP (CH) && !NOCASEP(CH))
2033 /* Upcase a character, or make no change if that cannot be done. */
2035 #define UPCASE(CH) (!UPPERCASEP (CH) ? UPCASE1 (CH) : (CH))
2037 /* Upcase a character known to be not upper case. */
2039 #define UPCASE1(CH) \
2040 ((case_temp1 = (CH), \
2041 case_temp2 = CHAR_TABLE_REF (UPCASE_TABLE, case_temp1), \
2042 NATNUMP (case_temp2)) \
2043 ? XFASTINT (case_temp2) : case_temp1)
2045 extern Lisp_Object Vascii_downcase_table, Vascii_upcase_table;
2046 extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
2048 /* Number of bytes of structure consed since last GC. */
2050 extern int consing_since_gc;
2052 /* Thresholds for doing another gc. */
2054 extern EMACS_INT gc_cons_threshold;
2056 extern EMACS_INT gc_relative_threshold;
2058 extern EMACS_INT memory_full_cons_threshold;
2060 /* Structure for recording stack slots that need marking. */
2062 /* This is a chain of structures, each of which points at a Lisp_Object variable
2063 whose value should be marked in garbage collection.
2064 Normally every link of the chain is an automatic variable of a function,
2065 and its `val' points to some argument or local variable of the function.
2066 On exit to the function, the chain is set back to the value it had on entry.
2067 This way, no link remains in the chain when the stack frame containing the
2068 link disappears.
2070 Every function that can call Feval must protect in this fashion all
2071 Lisp_Object variables whose contents will be used again. */
2073 struct gcpro
2075 struct gcpro *next;
2077 /* Address of first protected variable. */
2078 volatile Lisp_Object *var;
2080 /* Number of consecutive protected variables. */
2081 int nvars;
2083 #ifdef DEBUG_GCPRO
2084 int level;
2085 #endif
2088 /* Values of GC_MARK_STACK during compilation:
2090 0 Use GCPRO as before
2091 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2092 2 Mark the stack, and check that everything GCPRO'd is
2093 marked.
2094 3 Mark using GCPRO's, mark stack last, and count how many
2095 dead objects are kept alive. */
2098 #define GC_USE_GCPROS_AS_BEFORE 0
2099 #define GC_MAKE_GCPROS_NOOPS 1
2100 #define GC_MARK_STACK_CHECK_GCPROS 2
2101 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2103 #ifndef GC_MARK_STACK
2104 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2105 #endif
2107 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2109 /* Do something silly with gcproN vars just so gcc shuts up. */
2110 /* You get warnings from MIPSPro... */
2112 #define GCPRO1(varname) ((void) gcpro1)
2113 #define GCPRO2(varname1, varname2)(((void) gcpro2, (void) gcpro1))
2114 #define GCPRO3(varname1, varname2, varname3) \
2115 (((void) gcpro3, (void) gcpro2, (void) gcpro1))
2116 #define GCPRO4(varname1, varname2, varname3, varname4) \
2117 (((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2118 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2119 (((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2120 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2121 (((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2122 #define UNGCPRO ((void) 0)
2124 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2126 #ifndef DEBUG_GCPRO
2128 #define GCPRO1(varname) \
2129 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2130 gcprolist = &gcpro1; }
2132 #define GCPRO2(varname1, varname2) \
2133 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2134 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2135 gcprolist = &gcpro2; }
2137 #define GCPRO3(varname1, varname2, varname3) \
2138 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2139 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2140 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2141 gcprolist = &gcpro3; }
2143 #define GCPRO4(varname1, varname2, varname3, varname4) \
2144 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2145 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2146 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2147 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2148 gcprolist = &gcpro4; }
2150 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2151 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2152 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2153 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2154 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2155 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2156 gcprolist = &gcpro5; }
2158 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2159 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2160 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2161 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2162 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2163 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2164 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2165 gcprolist = &gcpro6; }
2167 #define UNGCPRO (gcprolist = gcpro1.next)
2169 #else
2171 #define GCPRO1(varname) \
2172 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2173 gcpro1.level = gcpro_level++; \
2174 gcprolist = &gcpro1; }
2176 #define GCPRO2(varname1, varname2) \
2177 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2178 gcpro1.level = gcpro_level; \
2179 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2180 gcpro2.level = gcpro_level++; \
2181 gcprolist = &gcpro2; }
2183 #define GCPRO3(varname1, varname2, varname3) \
2184 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2185 gcpro1.level = gcpro_level; \
2186 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2187 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2188 gcpro3.level = gcpro_level++; \
2189 gcprolist = &gcpro3; }
2191 #define GCPRO4(varname1, varname2, varname3, varname4) \
2192 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2193 gcpro1.level = gcpro_level; \
2194 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2195 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2196 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2197 gcpro4.level = gcpro_level++; \
2198 gcprolist = &gcpro4; }
2200 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2201 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2202 gcpro1.level = gcpro_level; \
2203 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2204 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2205 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2206 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2207 gcpro5.level = gcpro_level++; \
2208 gcprolist = &gcpro5; }
2210 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2211 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2212 gcpro1.level = gcpro_level; \
2213 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2214 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2215 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2216 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2217 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2218 gcpro6.level = gcpro_level++; \
2219 gcprolist = &gcpro6; }
2221 #define UNGCPRO \
2222 ((--gcpro_level != gcpro1.level) \
2223 ? (abort (), 0) \
2224 : ((gcprolist = gcpro1.next), 0))
2226 #endif /* DEBUG_GCPRO */
2227 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2230 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2231 #define RETURN_UNGCPRO(expr) \
2232 do \
2234 Lisp_Object ret_ungc_val; \
2235 ret_ungc_val = (expr); \
2236 UNGCPRO; \
2237 return ret_ungc_val; \
2239 while (0)
2241 /* Call staticpro (&var) to protect static variable `var'. */
2243 void staticpro P_ ((Lisp_Object *));
2245 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2246 meaning as in the DEFUN macro, and is used to construct a prototype. */
2247 /* We can use the same trick as in the DEFUN macro to generate the
2248 appropriate prototype. */
2249 #define EXFUN(fnname, maxargs) \
2250 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2252 /* Forward declarations for prototypes. */
2253 struct window;
2254 struct frame;
2256 /* Defined in data.c */
2257 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
2258 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
2259 extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
2260 extern Lisp_Object Qvoid_variable, Qvoid_function;
2261 extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
2262 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
2263 extern Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
2264 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
2265 extern Lisp_Object Qtext_read_only;
2267 extern Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
2268 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
2269 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
2270 extern Lisp_Object Qbuffer_or_string_p;
2271 extern Lisp_Object Qboundp, Qfboundp;
2272 extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
2274 extern Lisp_Object Qcdr;
2276 extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
2277 extern Lisp_Object Qoverflow_error, Qunderflow_error;
2279 extern Lisp_Object Qfloatp;
2280 extern Lisp_Object Qnumberp, Qnumber_or_marker_p;
2282 extern Lisp_Object Qinteger;
2284 extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
2286 extern void circular_list_error P_ ((Lisp_Object)) NO_RETURN;
2287 EXFUN (Finteractive_form, 1);
2288 EXFUN (Fbyteorder, 0);
2290 /* Defined in frame.c */
2291 extern Lisp_Object Qframep;
2293 EXFUN (Feq, 2);
2294 EXFUN (Fnull, 1);
2295 EXFUN (Flistp, 1);
2296 EXFUN (Fconsp, 1);
2297 EXFUN (Fatom, 1);
2298 EXFUN (Fnlistp, 1);
2299 EXFUN (Fintegerp, 1);
2300 EXFUN (Fnatnump, 1);
2301 EXFUN (Fsymbolp, 1);
2302 EXFUN (Fvectorp, 1);
2303 EXFUN (Fstringp, 1);
2304 EXFUN (Fmultibyte_string_p, 1);
2305 EXFUN (Farrayp, 1);
2306 EXFUN (Fsequencep, 1);
2307 EXFUN (Fbufferp, 1);
2308 EXFUN (Fmarkerp, 1);
2309 EXFUN (Fsubrp, 1);
2310 EXFUN (Fchar_or_string_p, 1);
2311 EXFUN (Finteger_or_marker_p, 1);
2312 EXFUN (Ffloatp, 1);
2313 EXFUN (Finteger_or_floatp, 1);
2314 EXFUN (Finteger_or_float_or_marker_p, 1);
2316 EXFUN (Fcar, 1);
2317 EXFUN (Fcar_safe, 1);
2318 EXFUN (Fcdr, 1);
2319 EXFUN (Fcdr_safe, 1);
2320 EXFUN (Fsetcar, 2);
2321 EXFUN (Fsetcdr, 2);
2322 EXFUN (Fboundp, 1);
2323 EXFUN (Ffboundp, 1);
2324 EXFUN (Fmakunbound, 1);
2325 EXFUN (Ffmakunbound, 1);
2326 EXFUN (Fsymbol_function, 1);
2327 EXFUN (Fsymbol_plist, 1);
2328 EXFUN (Fsymbol_name, 1);
2329 extern Lisp_Object indirect_function P_ ((Lisp_Object));
2330 EXFUN (Findirect_function, 2);
2331 EXFUN (Ffset, 2);
2332 EXFUN (Fsetplist, 2);
2333 EXFUN (Fsymbol_value, 1);
2334 extern Lisp_Object find_symbol_value P_ ((Lisp_Object));
2335 EXFUN (Fset, 2);
2336 EXFUN (Fdefault_value, 1);
2337 EXFUN (Fset_default, 2);
2338 EXFUN (Fdefault_boundp, 1);
2339 EXFUN (Fmake_local_variable, 1);
2340 EXFUN (Flocal_variable_p, 2);
2341 EXFUN (Flocal_variable_if_set_p, 2);
2343 EXFUN (Faref, 2);
2344 EXFUN (Faset, 3);
2346 EXFUN (Fstring_to_number, 2);
2347 EXFUN (Fnumber_to_string, 1);
2348 EXFUN (Feqlsign, 2);
2349 EXFUN (Fgtr, 2);
2350 EXFUN (Flss, 2);
2351 EXFUN (Fgeq, 2);
2352 EXFUN (Fleq, 2);
2353 EXFUN (Fneq, 2);
2354 EXFUN (Fzerop, 1);
2355 EXFUN (Fplus, MANY);
2356 EXFUN (Fminus, MANY);
2357 EXFUN (Ftimes, MANY);
2358 EXFUN (Fquo, MANY);
2359 EXFUN (Frem, 2);
2360 EXFUN (Fmax, MANY);
2361 EXFUN (Fmin, MANY);
2362 EXFUN (Flogand, MANY);
2363 EXFUN (Flogior, MANY);
2364 EXFUN (Flogxor, MANY);
2365 EXFUN (Flognot, 1);
2366 EXFUN (Flsh, 2);
2367 EXFUN (Fash, 2);
2369 EXFUN (Fadd1, 1);
2370 EXFUN (Fsub1, 1);
2371 EXFUN (Fmake_variable_buffer_local, 1);
2373 extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *);
2374 extern Lisp_Object *find_variable_location (Lisp_Object *);
2375 extern Lisp_Object ensure_thread_local (Lisp_Object *);
2376 extern void remove_thread_local P_ ((Lisp_Object *));
2377 extern Lisp_Object Qthread_local_mark;
2378 extern Lisp_Object long_to_cons P_ ((unsigned long));
2379 extern unsigned long cons_to_long P_ ((Lisp_Object));
2380 extern void args_out_of_range P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2381 extern void args_out_of_range_3 P_ ((Lisp_Object, Lisp_Object,
2382 Lisp_Object)) NO_RETURN;
2383 extern Lisp_Object wrong_type_argument P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2384 extern void store_symval_forwarding P_ ((Lisp_Object, Lisp_Object,
2385 Lisp_Object, struct buffer *));
2386 extern Lisp_Object do_symval_forwarding P_ ((Lisp_Object));
2387 extern Lisp_Object set_internal P_ ((Lisp_Object, Lisp_Object, struct buffer *, int));
2388 extern void syms_of_data P_ ((void));
2389 extern void init_data P_ ((void));
2390 extern void swap_in_global_binding P_ ((Lisp_Object));
2392 /* Defined in cmds.c */
2393 EXFUN (Fend_of_line, 1);
2394 EXFUN (Fforward_char, 1);
2395 EXFUN (Fforward_line, 1);
2396 extern int internal_self_insert P_ ((int, int));
2397 extern void syms_of_cmds P_ ((void));
2398 extern void keys_of_cmds P_ ((void));
2400 /* Defined in coding.c */
2401 EXFUN (Fcoding_system_p, 1);
2402 EXFUN (Fcoding_system_base, 1);
2403 EXFUN (Fcoding_system_eol_type, 1);
2404 EXFUN (Fcheck_coding_system, 1);
2405 EXFUN (Fcheck_coding_system, 1);
2406 EXFUN (Fread_coding_system, 2);
2407 EXFUN (Fread_non_nil_coding_system, 1);
2408 EXFUN (Ffind_operation_coding_system, MANY);
2409 EXFUN (Fupdate_coding_systems_internal, 0);
2410 EXFUN (Fencode_coding_string, 4);
2411 EXFUN (Fdecode_coding_string, 4);
2412 extern Lisp_Object detect_coding_system P_ ((const unsigned char *, EMACS_INT,
2413 EMACS_INT, int, int, Lisp_Object));
2414 extern void init_coding P_ ((void));
2415 extern void init_coding_once P_ ((void));
2416 extern void syms_of_coding P_ ((void));
2418 /* Defined in character.c */
2419 extern void init_character_once P_ ((void));
2420 extern void syms_of_character P_ ((void));
2421 EXFUN (Funibyte_char_to_multibyte, 1);
2423 /* Defined in charset.c */
2424 EXFUN (Fchar_bytes, 1);
2425 EXFUN (Fchar_width, 1);
2426 EXFUN (Fstring, MANY);
2427 extern EMACS_INT chars_in_text P_ ((const unsigned char *, EMACS_INT));
2428 extern EMACS_INT multibyte_chars_in_text P_ ((const unsigned char *, EMACS_INT));
2429 extern int multibyte_char_to_unibyte P_ ((int, Lisp_Object));
2430 extern int multibyte_char_to_unibyte_safe P_ ((int));
2431 extern Lisp_Object Qcharset;
2432 extern void init_charset P_ ((void));
2433 extern void init_charset_once P_ ((void));
2434 extern void syms_of_charset P_ ((void));
2435 /* Structure forward declarations. */
2436 struct charset;
2438 /* Defined in composite.c */
2439 extern void syms_of_composite P_ ((void));
2441 /* Defined in syntax.c */
2442 EXFUN (Fforward_word, 1);
2443 EXFUN (Fskip_chars_forward, 2);
2444 EXFUN (Fskip_chars_backward, 2);
2445 EXFUN (Fsyntax_table_p, 1);
2446 EXFUN (Fsyntax_table, 0);
2447 EXFUN (Fset_syntax_table, 1);
2448 extern void init_syntax_once P_ ((void));
2449 extern void syms_of_syntax P_ ((void));
2451 /* Defined in fns.c */
2452 extern int use_dialog_box;
2453 extern int next_almost_prime P_ ((int));
2454 extern Lisp_Object larger_vector P_ ((Lisp_Object, int, Lisp_Object));
2455 extern void sweep_weak_hash_tables P_ ((void));
2456 extern Lisp_Object Qstring_lessp;
2457 extern Lisp_Object impl_Vfeatures;
2458 extern Lisp_Object QCtest, QCweakness, Qequal, Qeq;
2459 unsigned sxhash P_ ((Lisp_Object, int));
2460 Lisp_Object make_hash_table P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
2461 Lisp_Object, Lisp_Object, Lisp_Object,
2462 Lisp_Object));
2463 Lisp_Object copy_hash_table P_ ((struct Lisp_Hash_Table *));
2464 int hash_lookup P_ ((struct Lisp_Hash_Table *, Lisp_Object, unsigned *));
2465 int hash_put P_ ((struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
2466 unsigned));
2467 void hash_clear P_ ((struct Lisp_Hash_Table *));
2468 void init_weak_hash_tables P_ ((void));
2469 extern void init_fns P_ ((void));
2470 EXFUN (Fsxhash, 1);
2471 EXFUN (Fmake_hash_table, MANY);
2472 EXFUN (Fmakehash, 1);
2473 EXFUN (Fcopy_hash_table, 1);
2474 EXFUN (Fhash_table_count, 1);
2475 EXFUN (Fhash_table_rehash_size, 1);
2476 EXFUN (Fhash_table_rehash_threshold, 1);
2477 EXFUN (Fhash_table_size, 1);
2478 EXFUN (Fhash_table_test, 1);
2479 EXFUN (Fhash_table_weak, 1);
2480 EXFUN (Fhash_table_p, 1);
2481 EXFUN (Fclrhash, 1);
2482 EXFUN (Fgethash, 3);
2483 EXFUN (Fputhash, 3);
2484 EXFUN (Fremhash, 2);
2485 EXFUN (Fmaphash, 2);
2486 EXFUN (Fdefine_hash_table_test, 3);
2488 EXFUN (Fidentity, 1);
2489 EXFUN (Frandom, 1);
2490 EXFUN (Flength, 1);
2491 EXFUN (Fsafe_length, 1);
2492 EXFUN (Fappend, MANY);
2493 EXFUN (Fconcat, MANY);
2494 EXFUN (Fvconcat, MANY);
2495 EXFUN (Fcopy_sequence, 1);
2496 EXFUN (Fstring_make_multibyte, 1);
2497 EXFUN (Fstring_make_unibyte, 1);
2498 EXFUN (Fstring_as_multibyte, 1);
2499 EXFUN (Fstring_as_unibyte, 1);
2500 EXFUN (Fstring_to_multibyte, 1);
2501 EXFUN (Fstring_to_unibyte, 1);
2502 EXFUN (Fsubstring, 3);
2503 extern Lisp_Object substring_both P_ ((Lisp_Object, int, int, int, int));
2504 EXFUN (Fnth, 2);
2505 EXFUN (Fnthcdr, 2);
2506 EXFUN (Fmemq, 2);
2507 EXFUN (Fassq, 2);
2508 EXFUN (Fassoc, 2);
2509 EXFUN (Felt, 2);
2510 EXFUN (Fmember, 2);
2511 EXFUN (Frassq, 2);
2512 EXFUN (Fdelq, 2);
2513 EXFUN (Fdelete, 2);
2514 EXFUN (Fsort, 2);
2515 EXFUN (Freverse, 1);
2516 EXFUN (Fnreverse, 1);
2517 EXFUN (Fget, 2);
2518 EXFUN (Fput, 3);
2519 EXFUN (Fequal, 2);
2520 EXFUN (Ffillarray, 2);
2521 EXFUN (Fnconc, MANY);
2522 EXFUN (Fmapcar, 2);
2523 EXFUN (Fmapconcat, 3);
2524 EXFUN (Fy_or_n_p, 1);
2525 extern Lisp_Object do_yes_or_no_p P_ ((Lisp_Object));
2526 EXFUN (Frequire, 3);
2527 EXFUN (Fprovide, 2);
2528 extern Lisp_Object concat2 P_ ((Lisp_Object, Lisp_Object));
2529 extern Lisp_Object concat3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2530 extern Lisp_Object nconc2 P_ ((Lisp_Object, Lisp_Object));
2531 extern Lisp_Object assq_no_quit P_ ((Lisp_Object, Lisp_Object));
2532 extern Lisp_Object assoc_no_quit P_ ((Lisp_Object, Lisp_Object));
2533 extern void clear_string_char_byte_cache P_ ((void));
2534 extern EMACS_INT string_char_to_byte P_ ((Lisp_Object, EMACS_INT));
2535 extern EMACS_INT string_byte_to_char P_ ((Lisp_Object, EMACS_INT));
2536 extern Lisp_Object string_make_multibyte P_ ((Lisp_Object));
2537 extern Lisp_Object string_to_multibyte P_ ((Lisp_Object));
2538 extern Lisp_Object string_make_unibyte P_ ((Lisp_Object));
2539 EXFUN (Fcopy_alist, 1);
2540 EXFUN (Fplist_get, 2);
2541 EXFUN (Fplist_put, 3);
2542 EXFUN (Fplist_member, 2);
2543 EXFUN (Frassoc, 2);
2544 EXFUN (Fstring_equal, 2);
2545 EXFUN (Fcompare_strings, 7);
2546 EXFUN (Fstring_lessp, 2);
2547 extern void syms_of_fns P_ ((void));
2549 /* Defined in floatfns.c */
2550 extern double extract_float P_ ((Lisp_Object));
2551 EXFUN (Ffloat, 1);
2552 EXFUN (Ftruncate, 2);
2553 extern void init_floatfns P_ ((void));
2554 extern void syms_of_floatfns P_ ((void));
2556 /* Defined in fringe.c */
2557 extern void syms_of_fringe P_ ((void));
2558 extern void init_fringe P_ ((void));
2559 extern void init_fringe_once P_ ((void));
2561 /* Defined in image.c */
2562 EXFUN (Finit_image_library, 2);
2563 extern void syms_of_image P_ ((void));
2564 extern void init_image P_ ((void));
2566 /* Defined in insdel.c */
2567 extern Lisp_Object Qinhibit_modification_hooks;
2568 extern void move_gap (EMACS_INT);
2569 extern void move_gap_both (EMACS_INT, EMACS_INT);
2570 extern void make_gap (EMACS_INT);
2571 extern EMACS_INT copy_text (const unsigned char *, unsigned char *,
2572 EMACS_INT, int, int);
2573 extern EMACS_INT count_size_as_multibyte (const unsigned char *, EMACS_INT);
2574 extern int count_combining_before (const unsigned char *,
2575 EMACS_INT, EMACS_INT, EMACS_INT);
2576 extern int count_combining_after (const unsigned char *,
2577 EMACS_INT, EMACS_INT, EMACS_INT);
2578 extern void insert (const unsigned char *, EMACS_INT);
2579 extern void insert_and_inherit (const unsigned char *, EMACS_INT);
2580 extern void insert_1 (const unsigned char *, EMACS_INT, int, int, int);
2581 extern void insert_1_both (const unsigned char *, EMACS_INT, EMACS_INT,
2582 int, int, int);
2583 extern void insert_from_gap (EMACS_INT, EMACS_INT);
2584 extern void insert_from_string (Lisp_Object, EMACS_INT, EMACS_INT,
2585 EMACS_INT, EMACS_INT, int);
2586 extern void insert_from_buffer (struct buffer *, EMACS_INT, EMACS_INT, int);
2587 extern void insert_char (int);
2588 extern void insert_string (const char *);
2589 extern void insert_before_markers (const unsigned char *, EMACS_INT);
2590 extern void insert_before_markers_and_inherit (const unsigned char *,
2591 EMACS_INT);
2592 extern void insert_from_string_before_markers (Lisp_Object, EMACS_INT,
2593 EMACS_INT, EMACS_INT,
2594 EMACS_INT, int);
2595 extern void del_range (EMACS_INT, EMACS_INT);
2596 extern Lisp_Object del_range_1 (EMACS_INT, EMACS_INT, int, int);
2597 extern void del_range_byte (EMACS_INT, EMACS_INT, int);
2598 extern void del_range_both (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT, int);
2599 extern Lisp_Object del_range_2 (EMACS_INT, EMACS_INT,
2600 EMACS_INT, EMACS_INT, int);
2601 extern void modify_region (struct buffer *, EMACS_INT, EMACS_INT, int);
2602 extern void prepare_to_modify_buffer (EMACS_INT, EMACS_INT, EMACS_INT *);
2603 extern void signal_before_change (EMACS_INT, EMACS_INT, EMACS_INT *);
2604 extern void signal_after_change (EMACS_INT, EMACS_INT, EMACS_INT);
2605 extern void adjust_after_replace (EMACS_INT, EMACS_INT, Lisp_Object,
2606 EMACS_INT, EMACS_INT);
2607 extern void adjust_after_replace_noundo (EMACS_INT, EMACS_INT, EMACS_INT,
2608 EMACS_INT, EMACS_INT, EMACS_INT);
2609 extern void adjust_after_insert (EMACS_INT, EMACS_INT, EMACS_INT,
2610 EMACS_INT, EMACS_INT);
2611 extern void adjust_markers_for_delete (EMACS_INT, EMACS_INT,
2612 EMACS_INT, EMACS_INT);
2613 extern void replace_range (EMACS_INT, EMACS_INT, Lisp_Object, int, int, int);
2614 extern void replace_range_2 (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
2615 char *, EMACS_INT, EMACS_INT, int);
2616 extern void syms_of_insdel (void);
2618 /* Defined in dispnew.c */
2619 extern Lisp_Object selected_frame;
2620 extern EMACS_INT baud_rate;
2621 EXFUN (Fding, 1);
2622 EXFUN (Fredraw_frame, 1);
2623 EXFUN (Fredraw_display, 0);
2624 EXFUN (Fsleep_for, 2);
2625 EXFUN (Fredisplay, 1);
2626 extern Lisp_Object sit_for P_ ((Lisp_Object, int, int));
2627 extern void init_display P_ ((void));
2628 extern void syms_of_display P_ ((void));
2629 extern void safe_bcopy P_ ((const char *, char *, int));
2631 /* Defined in xdisp.c */
2632 extern Lisp_Object Qinhibit_point_motion_hooks;
2633 extern Lisp_Object Qinhibit_redisplay, Qdisplay;
2634 extern Lisp_Object Qinhibit_eval_during_redisplay;
2635 extern Lisp_Object Qmessage_truncate_lines;
2636 extern Lisp_Object Qimage;
2637 extern Lisp_Object impl_Vmessage_log_max;
2638 extern int message_enable_multibyte;
2639 extern Lisp_Object echo_area_buffer[2];
2640 extern void check_message_stack P_ ((void));
2641 extern void setup_echo_area_for_printing P_ ((int));
2642 extern int push_message P_ ((void));
2643 extern Lisp_Object pop_message_unwind P_ ((Lisp_Object));
2644 extern Lisp_Object restore_message_unwind P_ ((Lisp_Object));
2645 extern void pop_message P_ ((void));
2646 extern void restore_message P_ ((void));
2647 extern Lisp_Object current_message P_ ((void));
2648 extern void set_message P_ ((const char *s, Lisp_Object, int, int));
2649 extern void clear_message P_ ((int, int));
2650 extern void message P_ ((/* char *, ... */));
2651 extern void message_nolog P_ ((/* char *, ... */));
2652 extern void message1 P_ ((char *));
2653 extern void message1_nolog P_ ((char *));
2654 extern void message2 P_ ((const char *, int, int));
2655 extern void message2_nolog P_ ((const char *, int, int));
2656 extern void message3 P_ ((Lisp_Object, int, int));
2657 extern void message3_nolog P_ ((Lisp_Object, int, int));
2658 extern void message_dolog P_ ((const char *, int, int, int));
2659 extern void message_with_string P_ ((char *, Lisp_Object, int));
2660 extern void message_log_maybe_newline P_ ((void));
2661 extern void update_echo_area P_ ((void));
2662 extern void truncate_echo_area P_ ((int));
2663 extern void redisplay P_ ((void));
2664 extern int check_point_in_composition
2665 P_ ((struct buffer *, int, struct buffer *, int));
2666 extern void redisplay_preserve_echo_area P_ ((int));
2667 extern void prepare_menu_bars P_ ((void));
2669 void set_frame_cursor_types P_ ((struct frame *, Lisp_Object));
2670 extern void syms_of_xdisp P_ ((void));
2671 extern void init_xdisp P_ ((void));
2672 extern Lisp_Object safe_eval P_ ((Lisp_Object));
2673 extern int pos_visible_p P_ ((struct window *, int, int *,
2674 int *, int *, int *, int *, int *));
2676 /* Defined in xsettings.c */
2677 extern void syms_of_xsettings P_ ((void));
2679 /* Defined in vm-limit.c. */
2680 extern void memory_warnings P_ ((POINTER_TYPE *, void (*warnfun) ()));
2682 /* Defined in alloc.c */
2683 extern void check_pure_size P_ ((void));
2684 extern void allocate_string_data P_ ((struct Lisp_String *, int, int));
2685 extern void reset_malloc_hooks P_ ((void));
2686 extern void uninterrupt_malloc P_ ((void));
2687 extern void malloc_warning P_ ((char *));
2688 extern void memory_full P_ ((void)) NO_RETURN;
2689 extern void buffer_memory_full P_ ((void)) NO_RETURN;
2690 extern int survives_gc_p P_ ((Lisp_Object));
2691 extern void mark_object P_ ((Lisp_Object));
2692 extern Lisp_Object impl_Vpurify_flag;
2693 extern Lisp_Object impl_Vmemory_full;
2694 EXFUN (Fcons, 2);
2695 EXFUN (list1, 1);
2696 EXFUN (list2, 2);
2697 EXFUN (list3, 3);
2698 EXFUN (list4, 4);
2699 EXFUN (list5, 5);
2700 EXFUN (Flist, MANY);
2701 EXFUN (Fmake_list, 2);
2702 extern Lisp_Object allocate_misc P_ ((void));
2703 EXFUN (Fmake_vector, 2);
2704 EXFUN (Fvector, MANY);
2705 EXFUN (Fmake_symbol, 1);
2706 EXFUN (Fmake_marker, 0);
2707 EXFUN (Fmake_string, 2);
2708 extern Lisp_Object build_string P_ ((const char *));
2709 extern Lisp_Object make_string P_ ((const char *, int));
2710 extern Lisp_Object make_unibyte_string P_ ((const char *, int));
2711 extern Lisp_Object make_multibyte_string P_ ((const char *, int, int));
2712 extern Lisp_Object make_event_array P_ ((int, Lisp_Object *));
2713 extern Lisp_Object make_uninit_string P_ ((int));
2714 extern Lisp_Object make_uninit_multibyte_string P_ ((int, int));
2715 extern Lisp_Object make_string_from_bytes P_ ((const char *, int, int));
2716 extern Lisp_Object make_specified_string P_ ((const char *, int, int, int));
2717 EXFUN (Fpurecopy, 1);
2718 extern Lisp_Object make_pure_string P_ ((const char *, int, int, int));
2719 extern Lisp_Object make_pure_c_string (const char *data);
2720 extern Lisp_Object pure_cons P_ ((Lisp_Object, Lisp_Object));
2721 extern Lisp_Object make_pure_vector P_ ((EMACS_INT));
2722 EXFUN (Fgarbage_collect, 0);
2723 EXFUN (Fmake_byte_code, MANY);
2724 EXFUN (Fmake_bool_vector, 2);
2725 extern Lisp_Object Qchar_table_extra_slots;
2726 extern struct Lisp_Vector *allocate_vector P_ ((EMACS_INT));
2727 extern struct Lisp_Vector *allocate_pseudovector P_ ((int memlen, int lisplen, EMACS_INT tag));
2728 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2729 ((typ*) \
2730 allocate_pseudovector \
2731 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2732 extern struct Lisp_Hash_Table *allocate_hash_table P_ ((void));
2733 extern struct window *allocate_window P_ ((void));
2734 extern struct frame *allocate_frame P_ ((void));
2735 extern struct Lisp_Process *allocate_process P_ ((void));
2736 extern struct terminal *allocate_terminal P_ ((void));
2737 extern int gc_in_progress;
2738 extern int abort_on_gc;
2739 extern Lisp_Object make_float P_ ((double));
2740 extern void display_malloc_warning P_ ((void));
2741 extern int inhibit_garbage_collection P_ ((void));
2742 extern Lisp_Object make_save_value P_ ((void *, int));
2743 extern void free_misc P_ ((Lisp_Object));
2744 extern void free_marker P_ ((Lisp_Object));
2745 extern void free_cons P_ ((struct Lisp_Cons *));
2746 extern void init_alloc_once P_ ((void));
2747 extern void init_alloc P_ ((void));
2748 extern void syms_of_alloc P_ ((void));
2749 extern struct buffer * allocate_buffer P_ ((void));
2750 extern int valid_lisp_object_p P_ ((Lisp_Object));
2752 /* Defined in chartab.c */
2753 EXFUN (Fmake_char_table, 2);
2754 EXFUN (Fchar_table_parent, 1);
2755 EXFUN (Fset_char_table_parent, 2);
2756 EXFUN (Fchar_table_extra_slot, 2);
2757 EXFUN (Fset_char_table_extra_slot, 3);
2758 EXFUN (Fchar_table_range, 2);
2759 EXFUN (Fset_char_table_range, 3);
2760 EXFUN (Fset_char_table_default, 3);
2761 EXFUN (Foptimize_char_table, 2);
2762 EXFUN (Fmap_char_table, 2);
2763 extern Lisp_Object copy_char_table P_ ((Lisp_Object));
2764 extern Lisp_Object sub_char_table_ref P_ ((Lisp_Object, int));
2765 extern Lisp_Object char_table_ref P_ ((Lisp_Object, int));
2766 extern Lisp_Object char_table_ref_and_range P_ ((Lisp_Object, int,
2767 int *, int *));
2768 extern Lisp_Object char_table_set P_ ((Lisp_Object, int, Lisp_Object));
2769 extern Lisp_Object char_table_set_range P_ ((Lisp_Object, int, int,
2770 Lisp_Object));
2771 extern int char_table_translate P_ ((Lisp_Object, int));
2772 extern void map_char_table P_ ((void (*) (Lisp_Object, Lisp_Object,
2773 Lisp_Object),
2774 Lisp_Object, Lisp_Object, Lisp_Object));
2775 extern void syms_of_chartab P_ ((void));
2777 /* Defined in print.c */
2778 extern Lisp_Object Vprin1_to_string_buffer;
2779 extern void debug_print P_ ((Lisp_Object));
2780 EXFUN (Fprin1, 2);
2781 EXFUN (Fprin1_to_string, 2);
2782 EXFUN (Fprinc, 2);
2783 EXFUN (Fterpri, 1);
2784 EXFUN (Fprint, 2);
2785 EXFUN (Ferror_message_string, 1);
2786 extern Lisp_Object impl_Vstandard_output, Qstandard_output;
2787 extern Lisp_Object Qexternal_debugging_output;
2788 extern void temp_output_buffer_setup P_ ((const char *));
2789 extern int print_level, print_escape_newlines;
2790 extern Lisp_Object Qprint_escape_newlines;
2791 extern void write_string P_ ((char *, int));
2792 extern void write_string_1 P_ ((char *, int, Lisp_Object));
2793 extern void print_error_message P_ ((Lisp_Object, Lisp_Object, char *, Lisp_Object));
2794 extern Lisp_Object internal_with_output_to_temp_buffer
2795 P_ ((const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object));
2796 extern void float_to_string P_ ((unsigned char *, double));
2797 extern void syms_of_print P_ ((void));
2799 /* Defined in doprnt.c */
2800 extern int doprnt P_ ((char *, int, char *, char *, int, char **));
2802 /* Defined in lread.c */
2803 extern Lisp_Object Qvariable_documentation, Qstandard_input;
2804 extern Lisp_Object impl_Vobarray, initial_obarray, impl_Vstandard_input;
2805 EXFUN (Fread, 1);
2806 EXFUN (Fread_from_string, 3);
2807 EXFUN (Fintern, 2);
2808 EXFUN (Fintern_soft, 2);
2809 EXFUN (Fload, 5);
2810 EXFUN (Fget_load_suffixes, 0);
2811 EXFUN (Fget_file_char, 0);
2812 EXFUN (Fread_char, 3);
2813 EXFUN (Fread_event, 3);
2814 extern Lisp_Object read_filtered_event P_ ((int, int, int, int, Lisp_Object));
2815 EXFUN (Feval_region, 4);
2816 extern Lisp_Object check_obarray P_ ((Lisp_Object));
2817 extern Lisp_Object intern P_ ((const char *));
2818 extern Lisp_Object intern_c_string (const char *);
2819 extern Lisp_Object make_symbol P_ ((char *));
2820 extern Lisp_Object oblookup P_ ((Lisp_Object, const char *, int, int));
2821 #define LOADHIST_ATTACH(x) \
2822 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
2823 extern Lisp_Object impl_Vcurrent_load_list;
2824 extern Lisp_Object impl_Vload_history, impl_Vload_suffixes, impl_Vload_file_rep_suffixes;
2825 extern int openp P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
2826 Lisp_Object *, Lisp_Object));
2827 extern int isfloat_string P_ ((char *, int));
2828 extern void map_obarray P_ ((Lisp_Object, void (*) (Lisp_Object, Lisp_Object),
2829 Lisp_Object));
2830 extern void dir_warning P_ ((char *, Lisp_Object));
2831 extern void close_load_descs P_ ((void));
2832 extern void init_obarray P_ ((void));
2833 extern void init_lread P_ ((void));
2834 extern void syms_of_lread P_ ((void));
2836 /* Defined in eval.c */
2837 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
2838 extern Lisp_Object impl_Vinhibit_quit, Qinhibit_quit, impl_Vquit_flag;
2839 extern Lisp_Object Vautoload_queue;
2840 extern Lisp_Object impl_Vdebug_on_error;
2841 extern Lisp_Object Vsignaling_function;
2842 extern int handling_signal;
2843 extern int interactive_p P_ ((int));
2845 /* To run a normal hook, use the appropriate function from the list below.
2846 The calling convention:
2848 if (!NILP (Vrun_hooks))
2849 call1 (Vrun_hooks, Qmy_funny_hook);
2851 should no longer be used. */
2852 extern Lisp_Object Vrun_hooks;
2853 EXFUN (Frun_hooks, MANY);
2854 EXFUN (Frun_hook_with_args, MANY);
2855 EXFUN (Frun_hook_with_args_until_success, MANY);
2856 EXFUN (Frun_hook_with_args_until_failure, MANY);
2857 extern Lisp_Object run_hook_list_with_args P_ ((Lisp_Object, int, Lisp_Object *));
2858 extern void run_hook_with_args_2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2859 EXFUN (Fand, UNEVALLED);
2860 EXFUN (For, UNEVALLED);
2861 EXFUN (Fif, UNEVALLED);
2862 EXFUN (Fprogn, UNEVALLED);
2863 EXFUN (Fprog1, UNEVALLED);
2864 EXFUN (Fprog2, UNEVALLED);
2865 EXFUN (Fsetq, UNEVALLED);
2866 EXFUN (Fquote, UNEVALLED);
2867 EXFUN (Fuser_variable_p, 1);
2868 EXFUN (Finteractive_p, 0);
2869 EXFUN (Fdefun, UNEVALLED);
2870 EXFUN (Flet, UNEVALLED);
2871 EXFUN (FletX, UNEVALLED);
2872 EXFUN (Fwhile, UNEVALLED);
2873 EXFUN (Fcatch, UNEVALLED);
2874 EXFUN (Fthrow, 2) NO_RETURN;
2875 EXFUN (Funwind_protect, UNEVALLED);
2876 EXFUN (Fcondition_case, UNEVALLED);
2877 EXFUN (Fsignal, 2);
2878 extern void xsignal P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2879 extern void xsignal0 P_ ((Lisp_Object)) NO_RETURN;
2880 extern void xsignal1 P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2881 extern void xsignal2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object)) NO_RETURN;
2882 extern void xsignal3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)) NO_RETURN;
2883 extern void signal_error P_ ((char *, Lisp_Object)) NO_RETURN;
2884 EXFUN (Fautoload, 5);
2885 EXFUN (Fcommandp, 2);
2886 EXFUN (Feval, 1);
2887 EXFUN (Fapply, MANY);
2888 EXFUN (Ffuncall, MANY);
2889 EXFUN (Fbacktrace, 0);
2890 extern Lisp_Object apply1 P_ ((Lisp_Object, Lisp_Object));
2891 extern Lisp_Object call0 P_ ((Lisp_Object));
2892 extern Lisp_Object call1 P_ ((Lisp_Object, Lisp_Object));
2893 extern Lisp_Object call2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2894 extern Lisp_Object call3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2895 extern Lisp_Object call4 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2896 extern Lisp_Object call5 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2897 extern Lisp_Object call6 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2898 EXFUN (Fdo_auto_save, 2);
2899 extern Lisp_Object apply_lambda P_ ((Lisp_Object, Lisp_Object, int));
2900 extern Lisp_Object internal_catch P_ ((Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object));
2901 extern Lisp_Object internal_lisp_condition_case P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2902 extern Lisp_Object internal_condition_case P_ ((Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2903 extern Lisp_Object internal_condition_case_1 P_ ((Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2904 extern Lisp_Object internal_condition_case_2 P_ ((Lisp_Object (*) (int, Lisp_Object *), int, Lisp_Object *, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2905 extern void specbind P_ ((Lisp_Object, Lisp_Object));
2906 extern void record_unwind_protect P_ ((Lisp_Object (*) (Lisp_Object), Lisp_Object));
2907 extern Lisp_Object unbind_to P_ ((int, Lisp_Object));
2908 extern void error P_ ((/* char *, ... */)) NO_RETURN;
2909 extern void do_autoload P_ ((Lisp_Object, Lisp_Object));
2910 extern Lisp_Object un_autoload P_ ((Lisp_Object));
2911 EXFUN (Ffetch_bytecode, 1);
2912 extern void init_eval_once P_ ((void));
2913 extern Lisp_Object safe_call P_ ((int, Lisp_Object *));
2914 extern Lisp_Object safe_call1 P_ ((Lisp_Object, Lisp_Object));
2915 extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2916 extern void init_eval P_ ((void));
2917 extern void syms_of_eval P_ ((void));
2919 /* Defined in editfns.c */
2920 EXFUN (Fpropertize, MANY);
2921 EXFUN (Fcurrent_message, 0);
2922 EXFUN (Fgoto_char, 1);
2923 EXFUN (Fpoint_min_marker, 0);
2924 EXFUN (Fpoint_max_marker, 0);
2925 EXFUN (Fpoint_min, 0);
2926 EXFUN (Fpoint_max, 0);
2927 EXFUN (Fpoint, 0);
2928 EXFUN (Fpoint_marker, 0);
2929 EXFUN (Fmark_marker, 0);
2930 EXFUN (Fline_beginning_position, 1);
2931 EXFUN (Fline_end_position, 1);
2932 EXFUN (Ffollowing_char, 0);
2933 EXFUN (Fprevious_char, 0);
2934 EXFUN (Fchar_after, 1);
2935 EXFUN (Finsert, MANY);
2936 EXFUN (Finsert_and_inherit, MANY);
2937 EXFUN (Finsert_before_markers, MANY);
2938 EXFUN (Finsert_buffer_substring, 3);
2939 EXFUN (Finsert_char, 3);
2940 extern void insert1 P_ ((Lisp_Object));
2941 EXFUN (Feolp, 0);
2942 EXFUN (Feobp, 0);
2943 EXFUN (Fbolp, 0);
2944 EXFUN (Fbobp, 0);
2945 EXFUN (Fformat, MANY);
2946 EXFUN (Fmessage, MANY);
2947 extern Lisp_Object format2 P_ ((char *, Lisp_Object, Lisp_Object));
2948 EXFUN (Fbuffer_substring, 2);
2949 EXFUN (Fbuffer_string, 0);
2950 extern Lisp_Object save_excursion_save P_ ((void));
2951 extern Lisp_Object save_restriction_save P_ ((void));
2952 extern Lisp_Object save_excursion_restore P_ ((Lisp_Object));
2953 extern Lisp_Object save_restriction_restore P_ ((Lisp_Object));
2954 EXFUN (Fchar_to_string, 1);
2955 EXFUN (Fdelete_region, 2);
2956 EXFUN (Fnarrow_to_region, 2);
2957 EXFUN (Fwiden, 0);
2958 EXFUN (Fuser_login_name, 1);
2959 EXFUN (Fsystem_name, 0);
2960 EXFUN (Fcurrent_time, 0);
2961 extern int clip_to_bounds P_ ((int, int, int));
2962 extern Lisp_Object make_buffer_string P_ ((int, int, int));
2963 extern Lisp_Object make_buffer_string_both P_ ((int, int, int, int, int));
2964 extern void init_editfns P_ ((void));
2965 extern void syms_of_editfns P_ ((void));
2966 extern Lisp_Object impl_Vinhibit_field_text_motion;
2967 EXFUN (Fconstrain_to_field, 5);
2968 EXFUN (Ffield_string, 1);
2969 EXFUN (Fdelete_field, 1);
2970 EXFUN (Ffield_beginning, 3);
2971 EXFUN (Ffield_end, 3);
2972 EXFUN (Ffield_string_no_properties, 1);
2973 extern void set_time_zone_rule P_ ((char *));
2975 /* defined in buffer.c */
2976 extern int mouse_face_overlay_overlaps P_ ((Lisp_Object));
2977 extern void nsberror P_ ((Lisp_Object)) NO_RETURN;
2978 EXFUN (Fset_buffer_multibyte, 1);
2979 EXFUN (Foverlay_start, 1);
2980 EXFUN (Foverlay_end, 1);
2981 EXFUN (Foverlay_buffer, 1);
2982 extern void adjust_overlays_for_insert P_ ((EMACS_INT, EMACS_INT));
2983 extern void adjust_overlays_for_delete P_ ((EMACS_INT, EMACS_INT));
2984 extern void fix_start_end_in_overlays P_ ((int, int));
2985 extern void report_overlay_modification P_ ((Lisp_Object, Lisp_Object, int,
2986 Lisp_Object, Lisp_Object, Lisp_Object));
2987 extern int overlay_touches_p P_ ((int));
2988 extern Lisp_Object Vbuffer_alist, impl_Vinhibit_read_only;
2989 EXFUN (Fbuffer_list, 1);
2990 EXFUN (Fget_buffer, 1);
2991 EXFUN (Fget_buffer_create, 1);
2992 EXFUN (Fgenerate_new_buffer_name, 2);
2993 EXFUN (Fset_buffer, 1);
2994 EXFUN (set_buffer_if_live, 1);
2995 EXFUN (Fbarf_if_buffer_read_only, 0);
2996 EXFUN (Fcurrent_buffer, 0);
2997 EXFUN (Fswitch_to_buffer, 2);
2998 EXFUN (Fother_buffer, 3);
2999 EXFUN (Foverlay_get, 2);
3000 EXFUN (Fbuffer_modified_p, 1);
3001 EXFUN (Fset_buffer_modified_p, 1);
3002 EXFUN (Fkill_buffer, 1);
3003 EXFUN (Fkill_all_local_variables, 0);
3004 EXFUN (Fbuffer_disable_undo, 1);
3005 EXFUN (Fbuffer_enable_undo, 1);
3006 EXFUN (Ferase_buffer, 0);
3007 extern Lisp_Object Qoverlayp;
3008 extern Lisp_Object Qevaporate;
3009 extern Lisp_Object get_truename_buffer P_ ((Lisp_Object));
3010 extern struct buffer *all_buffers;
3011 EXFUN (Fprevious_overlay_change, 1);
3012 EXFUN (Fbuffer_file_name, 1);
3013 extern void init_buffer_once P_ ((void));
3014 extern void init_buffer P_ ((void));
3015 extern void syms_of_buffer P_ ((void));
3016 extern void keys_of_buffer P_ ((void));
3018 /* defined in marker.c */
3020 EXFUN (Fmarker_position, 1);
3021 EXFUN (Fmarker_buffer, 1);
3022 EXFUN (Fcopy_marker, 2);
3023 EXFUN (Fset_marker, 3);
3024 extern int marker_position P_ ((Lisp_Object));
3025 extern int marker_byte_position P_ ((Lisp_Object));
3026 extern void clear_charpos_cache P_ ((struct buffer *));
3027 extern int charpos_to_bytepos P_ ((int));
3028 extern int buf_charpos_to_bytepos P_ ((struct buffer *, int));
3029 extern int buf_bytepos_to_charpos P_ ((struct buffer *, int));
3030 extern void unchain_marker P_ ((struct Lisp_Marker *marker));
3031 extern Lisp_Object set_marker_restricted P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
3032 extern Lisp_Object set_marker_both P_ ((Lisp_Object, Lisp_Object, int, int));
3033 extern Lisp_Object set_marker_restricted_both P_ ((Lisp_Object, Lisp_Object,
3034 int, int));
3035 extern void syms_of_marker P_ ((void));
3037 /* Defined in fileio.c */
3039 extern Lisp_Object Qfile_error;
3040 EXFUN (Ffind_file_name_handler, 2);
3041 EXFUN (Ffile_name_as_directory, 1);
3042 EXFUN (Fmake_temp_name, 1);
3043 EXFUN (Fexpand_file_name, 2);
3044 EXFUN (Ffile_name_nondirectory, 1);
3045 EXFUN (Fsubstitute_in_file_name, 1);
3046 EXFUN (Ffile_symlink_p, 1);
3047 EXFUN (Fverify_visited_file_modtime, 1);
3048 EXFUN (Ffile_exists_p, 1);
3049 EXFUN (Ffile_name_absolute_p, 1);
3050 EXFUN (Fdirectory_file_name, 1);
3051 EXFUN (Ffile_name_directory, 1);
3052 extern Lisp_Object expand_and_dir_to_file P_ ((Lisp_Object, Lisp_Object));
3053 EXFUN (Ffile_accessible_directory_p, 1);
3054 EXFUN (Funhandled_file_name_directory, 1);
3055 EXFUN (Ffile_directory_p, 1);
3056 EXFUN (Fwrite_region, 7);
3057 EXFUN (Ffile_readable_p, 1);
3058 EXFUN (Ffile_executable_p, 1);
3059 EXFUN (Fread_file_name, 6);
3060 extern Lisp_Object close_file_unwind P_ ((Lisp_Object));
3061 extern void report_file_error P_ ((const char *, Lisp_Object)) NO_RETURN;
3062 extern int internal_delete_file P_ ((Lisp_Object));
3063 extern void syms_of_fileio P_ ((void));
3064 extern Lisp_Object make_temp_name P_ ((Lisp_Object, int));
3065 EXFUN (Fmake_symbolic_link, 3);
3066 extern Lisp_Object Qdelete_file;
3068 /* Defined in abbrev.c */
3070 extern void syms_of_abbrev P_ ((void));
3072 /* defined in search.c */
3073 extern void shrink_regexp_cache P_ ((void));
3074 EXFUN (Fstring_match, 3);
3075 extern void restore_search_regs P_ ((void));
3076 EXFUN (Fmatch_data, 3);
3077 EXFUN (Fset_match_data, 2);
3078 EXFUN (Fmatch_beginning, 1);
3079 EXFUN (Fmatch_end, 1);
3080 extern void record_unwind_save_match_data P_ ((void));
3081 EXFUN (Flooking_at, 1);
3082 extern int fast_string_match P_ ((Lisp_Object, Lisp_Object));
3083 extern int fast_c_string_match_ignore_case P_ ((Lisp_Object, const char *));
3084 extern int fast_string_match_ignore_case P_ ((Lisp_Object, Lisp_Object));
3085 extern EMACS_INT fast_looking_at P_ ((Lisp_Object, EMACS_INT, EMACS_INT,
3086 EMACS_INT, EMACS_INT, Lisp_Object));
3087 extern int scan_buffer P_ ((int, EMACS_INT, EMACS_INT, int, int *, int));
3088 extern int scan_newline P_ ((EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
3089 int, int));
3090 extern int find_next_newline P_ ((EMACS_INT, int));
3091 extern int find_next_newline_no_quit P_ ((EMACS_INT, int));
3092 extern int find_before_next_newline P_ ((EMACS_INT, EMACS_INT, int));
3093 extern void syms_of_search P_ ((void));
3094 extern void clear_regexp_cache P_ ((void));
3096 /* defined in minibuf.c */
3098 extern Lisp_Object last_minibuf_string;
3099 extern void choose_minibuf_frame P_ ((void));
3100 EXFUN (Fcompleting_read, 8);
3101 EXFUN (Fread_from_minibuffer, 7);
3102 EXFUN (Fread_variable, 2);
3103 EXFUN (Fread_buffer, 3);
3104 EXFUN (Fread_minibuffer, 2);
3105 EXFUN (Feval_minibuffer, 2);
3106 EXFUN (Fread_string, 5);
3107 EXFUN (Fread_no_blanks_input, 3);
3108 EXFUN (Fassoc_string, 3);
3109 extern Lisp_Object get_minibuffer P_ ((int));
3110 extern void temp_echo_area_glyphs P_ ((Lisp_Object));
3111 extern void init_minibuf_once P_ ((void));
3112 extern void syms_of_minibuf P_ ((void));
3114 /* Defined in callint.c */
3116 extern Lisp_Object Qminus, Qplus, impl_Vcurrent_prefix_arg;
3117 extern Lisp_Object impl_Vcommand_history;
3118 extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
3119 EXFUN (Fcall_interactively, 3);
3120 EXFUN (Fprefix_numeric_value, 1);
3121 extern void syms_of_callint P_ ((void));
3123 /* defined in casefiddle.c */
3125 EXFUN (Fdowncase, 1);
3126 EXFUN (Fupcase, 1);
3127 EXFUN (Fcapitalize, 1);
3128 EXFUN (Fupcase_region, 2);
3129 EXFUN (Fupcase_initials, 1);
3130 EXFUN (Fupcase_initials_region, 2);
3131 extern void syms_of_casefiddle P_ ((void));
3132 extern void keys_of_casefiddle P_ ((void));
3134 /* defined in casetab.c */
3136 EXFUN (Fset_case_table, 1);
3137 EXFUN (Fset_standard_case_table, 1);
3138 extern void init_casetab_once P_ ((void));
3139 extern void syms_of_casetab P_ ((void));
3141 /* defined in keyboard.c */
3143 extern int echoing;
3144 extern Lisp_Object echo_message_buffer;
3145 extern struct kboard *echo_kboard;
3146 extern void cancel_echoing P_ ((void));
3147 extern Lisp_Object Qdisabled, QCfilter;
3148 extern Lisp_Object impl_Vtty_erase_char, impl_Vhelp_form, impl_Vtop_level;
3149 extern Lisp_Object impl_Vthrow_on_input;
3150 extern int input_pending;
3151 EXFUN (Fdiscard_input, 0);
3152 EXFUN (Frecursive_edit, 0);
3153 EXFUN (Ftop_level, 0);
3154 EXFUN (Fcommand_execute, 4);
3155 EXFUN (Finput_pending_p, 0);
3156 extern Lisp_Object menu_bar_items P_ ((Lisp_Object));
3157 extern Lisp_Object tool_bar_items P_ ((Lisp_Object, int *));
3158 extern Lisp_Object Qvertical_scroll_bar;
3159 extern void discard_mouse_events P_ ((void));
3160 EXFUN (Fevent_convert_list, 1);
3161 EXFUN (Fread_key_sequence, 5);
3162 EXFUN (Fset_input_interrupt_mode, 1);
3163 EXFUN (Fset_output_flow_control, 2);
3164 EXFUN (Fset_input_meta_mode, 2);
3165 EXFUN (Fset_quit_char, 1);
3166 EXFUN (Fset_input_mode, 4);
3167 extern Lisp_Object pending_funcalls;
3168 extern int detect_input_pending P_ ((void));
3169 extern int detect_input_pending_ignore_squeezables P_ ((void));
3170 extern int detect_input_pending_run_timers P_ ((int));
3171 extern void safe_run_hooks P_ ((Lisp_Object));
3172 extern void cmd_error_internal P_ ((Lisp_Object, char *));
3173 extern Lisp_Object command_loop_1 P_ ((void));
3174 extern Lisp_Object recursive_edit_1 P_ ((void));
3175 extern void record_auto_save P_ ((void));
3176 extern void init_keyboard P_ ((void));
3177 extern void syms_of_keyboard P_ ((void));
3178 extern void keys_of_keyboard P_ ((void));
3179 extern char *push_key_description P_ ((unsigned int, char *, int));
3182 /* defined in indent.c */
3183 EXFUN (Fvertical_motion, 2);
3184 EXFUN (Findent_to, 2);
3185 EXFUN (Fcurrent_column, 0);
3186 EXFUN (Fmove_to_column, 2);
3187 extern double current_column P_ ((void));
3188 extern void invalidate_current_column P_ ((void));
3189 extern int indented_beyond_p P_ ((int, int, double));
3190 extern void syms_of_indent P_ ((void));
3192 /* defined in frame.c */
3193 #ifdef HAVE_WINDOW_SYSTEM
3194 extern Lisp_Object impl_Vx_resource_name;
3195 extern Lisp_Object impl_Vx_resource_class;
3196 #endif /* HAVE_WINDOW_SYSTEM */
3197 extern Lisp_Object Qvisible;
3198 extern void store_frame_param P_ ((struct frame *, Lisp_Object, Lisp_Object));
3199 extern void store_in_alist P_ ((Lisp_Object *, Lisp_Object, Lisp_Object));
3200 extern Lisp_Object do_switch_frame P_ ((Lisp_Object, int, int, Lisp_Object));
3201 extern Lisp_Object get_frame_param P_ ((struct frame *, Lisp_Object));
3202 extern Lisp_Object frame_buffer_predicate P_ ((Lisp_Object));
3203 EXFUN (Fframep, 1);
3204 EXFUN (Fselect_frame, 2);
3205 EXFUN (Fselected_frame, 0);
3206 EXFUN (Fwindow_frame, 1);
3207 EXFUN (Fframe_root_window, 1);
3208 EXFUN (Fframe_first_window, 1);
3209 EXFUN (Fframe_selected_window, 1);
3210 EXFUN (Fframe_list, 0);
3211 EXFUN (Fnext_frame, 2);
3212 EXFUN (Fdelete_frame, 2);
3213 EXFUN (Fset_mouse_position, 3);
3214 EXFUN (Fmake_frame_visible, 1);
3215 EXFUN (Fmake_frame_invisible, 2);
3216 EXFUN (Ficonify_frame, 1);
3217 EXFUN (Fframe_visible_p, 1);
3218 EXFUN (Fvisible_frame_list, 0);
3219 EXFUN (Fframe_parameter, 2);
3220 EXFUN (Fframe_parameters, 1);
3221 EXFUN (Fmodify_frame_parameters, 2);
3222 EXFUN (Fset_frame_height, 3);
3223 EXFUN (Fset_frame_width, 3);
3224 EXFUN (Fset_frame_size, 3);
3225 EXFUN (Fset_frame_position, 3);
3226 EXFUN (Fraise_frame, 1);
3227 EXFUN (Fredirect_frame_focus, 2);
3228 EXFUN (Fset_frame_selected_window, 3);
3229 extern Lisp_Object frame_buffer_list P_ ((Lisp_Object));
3230 extern void frames_discard_buffer P_ ((Lisp_Object));
3231 extern void set_frame_buffer_list P_ ((Lisp_Object, Lisp_Object));
3232 extern void frames_bury_buffer P_ ((Lisp_Object));
3233 extern void syms_of_frame P_ ((void));
3235 /* defined in emacs.c */
3236 extern Lisp_Object decode_env_path P_ ((char *, char *));
3237 extern Lisp_Object impl_Vinvocation_name, impl_Vinvocation_directory;
3238 extern Lisp_Object impl_Vbefore_init_time, impl_Vafter_init_time;
3239 extern Lisp_Object impl_Vinstallation_directory;
3240 extern Lisp_Object empty_unibyte_string, empty_multibyte_string;
3241 EXFUN (Fkill_emacs, 1);
3242 #if HAVE_SETLOCALE
3243 void fixup_locale P_ ((void));
3244 void synchronize_system_messages_locale P_ ((void));
3245 void synchronize_system_time_locale P_ ((void));
3246 #else
3247 #define setlocale(category, locale)
3248 #define fixup_locale()
3249 #define synchronize_system_messages_locale()
3250 #define synchronize_system_time_locale()
3251 #endif
3252 void shut_down_emacs P_ ((int, int, Lisp_Object));
3253 /* Nonzero means don't do interactive redisplay and don't change tty modes */
3254 extern int noninteractive;
3256 /* Nonzero means don't load X resources or Windows Registry settings. */
3257 extern int inhibit_x_resources;
3259 /* Pipe used to send exit notification to the daemon parent at
3260 startup. */
3261 extern int daemon_pipe[2];
3262 #define IS_DAEMON (daemon_pipe[1] != 0)
3264 /* Nonzero means don't do use window-system-specific display code */
3265 extern int inhibit_window_system;
3266 /* Nonzero means that a filter or a sentinel is running. */
3267 extern int running_asynch_code;
3269 /* defined in process.c */
3270 EXFUN (Fget_process, 1);
3271 EXFUN (Fget_buffer_process, 1);
3272 EXFUN (Fprocessp, 1);
3273 EXFUN (Fprocess_status, 1);
3274 EXFUN (Fkill_process, 2);
3275 EXFUN (Fprocess_send_eof, 1);
3276 EXFUN (Fwaiting_for_user_input_p, 0);
3277 extern Lisp_Object Qprocessp;
3278 extern void kill_buffer_processes P_ ((Lisp_Object));
3279 extern int wait_reading_process_output P_ ((int, int, int, int,
3280 Lisp_Object,
3281 struct Lisp_Process *,
3282 int));
3283 extern void add_keyboard_wait_descriptor P_ ((int));
3284 extern void delete_keyboard_wait_descriptor P_ ((int));
3285 extern void add_gpm_wait_descriptor P_ ((int));
3286 extern void delete_gpm_wait_descriptor P_ ((int));
3287 extern void close_process_descs P_ ((void));
3288 extern void init_process P_ ((void));
3289 extern void syms_of_process P_ ((void));
3290 extern void setup_process_coding_systems P_ ((Lisp_Object));
3292 /* defined in callproc.c */
3293 extern Lisp_Object impl_Vexec_path, impl_Vexec_suffixes,
3294 impl_Vexec_directory, impl_Vdata_directory;
3295 extern Lisp_Object impl_Vdoc_directory;
3296 EXFUN (Fcall_process, MANY);
3297 extern int child_setup P_ ((int, int, int, char **, int, Lisp_Object));
3298 extern void init_callproc_1 P_ ((void));
3299 extern void init_callproc P_ ((void));
3300 extern void set_initial_environment P_ ((void));
3301 extern void syms_of_callproc P_ ((void));
3303 /* defined in doc.c */
3304 extern Lisp_Object impl_Vdoc_file_name;
3305 EXFUN (Fsubstitute_command_keys, 1);
3306 EXFUN (Fdocumentation, 2);
3307 EXFUN (Fdocumentation_property, 3);
3308 extern Lisp_Object read_doc_string P_ ((Lisp_Object));
3309 extern Lisp_Object get_doc_string P_ ((Lisp_Object, int, int));
3310 extern void syms_of_doc P_ ((void));
3311 extern int read_bytecode_char P_ ((int));
3313 /* defined in bytecode.c */
3314 extern Lisp_Object Qbytecode;
3315 EXFUN (Fbyte_code, 3);
3316 extern void syms_of_bytecode P_ ((void));
3318 /* defined in macros.c */
3319 extern Lisp_Object Qexecute_kbd_macro;
3320 EXFUN (Fexecute_kbd_macro, 3);
3321 EXFUN (Fcancel_kbd_macro_events, 0);
3322 extern void init_macros P_ ((void));
3323 extern void syms_of_macros P_ ((void));
3325 /* defined in undo.c */
3326 extern Lisp_Object Qinhibit_read_only;
3327 EXFUN (Fundo_boundary, 0);
3328 extern void truncate_undo_list P_ ((struct buffer *));
3329 extern void record_marker_adjustment P_ ((Lisp_Object, int));
3330 extern void record_insert P_ ((int, int));
3331 extern void record_delete P_ ((int, Lisp_Object));
3332 extern void record_first_change P_ ((void));
3333 extern void record_change P_ ((int, int));
3334 extern void record_property_change P_ ((int, int, Lisp_Object, Lisp_Object,
3335 Lisp_Object));
3336 extern void syms_of_undo P_ ((void));
3337 extern Lisp_Object impl_Vundo_outer_limit;
3339 /* defined in textprop.c */
3340 extern Lisp_Object Qfont, Qmouse_face;
3341 extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
3342 EXFUN (Fnext_single_property_change, 4);
3343 EXFUN (Fnext_single_char_property_change, 4);
3344 EXFUN (Fprevious_single_property_change, 4);
3345 EXFUN (Fget_text_property, 3);
3346 EXFUN (Fput_text_property, 5);
3347 EXFUN (Fget_text_property, 3);
3348 EXFUN (Fprevious_char_property_change, 2);
3349 EXFUN (Fnext_char_property_change, 2);
3350 extern void report_interval_modification P_ ((Lisp_Object, Lisp_Object));
3351 extern Lisp_Object next_single_char_property_change P_ ((Lisp_Object,
3352 Lisp_Object,
3353 Lisp_Object,
3354 Lisp_Object));
3356 /* defined in menu.c */
3357 extern void syms_of_menu P_ ((void));
3359 /* defined in xmenu.c */
3360 EXFUN (Fx_popup_menu, 2);
3361 EXFUN (Fx_popup_dialog, 3);
3362 extern void syms_of_xmenu P_ ((void));
3364 /* defined in termchar.h */
3365 struct tty_display_info;
3367 /* defined in termhooks.h */
3368 struct terminal;
3370 /* defined in sysdep.c */
3371 #ifndef HAVE_GET_CURRENT_DIR_NAME
3372 extern char *get_current_dir_name P_ ((void));
3373 #endif
3374 extern void stuff_char P_ ((char c));
3375 extern void init_sigio P_ ((int));
3376 extern void sys_subshell P_ ((void));
3377 extern void sys_suspend P_ ((void));
3378 extern void discard_tty_input P_ ((void));
3379 extern void init_sys_modes P_ ((struct tty_display_info *));
3380 extern void reset_sys_modes P_ ((struct tty_display_info *));
3381 extern void init_all_sys_modes P_ ((void));
3382 extern void reset_all_sys_modes P_ ((void));
3383 extern void wait_for_termination P_ ((int));
3384 extern void flush_pending_output P_ ((int));
3385 extern void child_setup_tty P_ ((int));
3386 extern void setup_pty P_ ((int));
3387 extern int set_window_size P_ ((int, int, int));
3388 extern void create_process P_ ((Lisp_Object, char **, Lisp_Object));
3389 extern int emacs_open P_ ((const char *, int, int));
3390 extern int emacs_close P_ ((int));
3391 extern int emacs_read P_ ((int, char *, unsigned int));
3392 extern int emacs_write P_ ((int, const char *, unsigned int));
3394 /* defined in filelock.c */
3395 EXFUN (Funlock_buffer, 0);
3396 EXFUN (Ffile_locked_p, 1);
3397 extern void unlock_all_files P_ ((void));
3398 extern void lock_file P_ ((Lisp_Object));
3399 extern void unlock_file P_ ((Lisp_Object));
3400 extern void unlock_buffer P_ ((struct buffer *));
3401 extern void syms_of_filelock P_ ((void));
3402 extern void init_filelock P_ ((void));
3404 /* Defined in sound.c */
3405 extern void syms_of_sound P_ ((void));
3406 extern void init_sound P_ ((void));
3408 /* Defined in category.c */
3409 extern void init_category_once P_ ((void));
3410 extern Lisp_Object char_category_set P_ ((int));
3411 extern void syms_of_category P_ ((void));
3413 /* Defined in ccl.c */
3414 extern void syms_of_ccl P_ ((void));
3416 /* Defined in dired.c */
3417 EXFUN (Ffile_attributes, 2);
3418 extern void syms_of_dired P_ ((void));
3419 extern Lisp_Object directory_files_internal P_ ((Lisp_Object, Lisp_Object,
3420 Lisp_Object, Lisp_Object,
3421 int, Lisp_Object));
3423 /* Defined in term.c */
3424 extern void syms_of_term P_ ((void));
3425 extern void fatal P_ ((const char *msgid, ...)) NO_RETURN;
3427 /* Defined in terminal.c */
3428 EXFUN (Fdelete_terminal, 2);
3429 extern void syms_of_terminal P_ ((void));
3431 /* Defined in font.c */
3432 extern void syms_of_font P_ ((void));
3433 extern void init_font P_ ((void));
3435 #ifdef HAVE_WINDOW_SYSTEM
3436 /* Defined in fontset.c */
3437 extern void syms_of_fontset P_ ((void));
3438 EXFUN (Fset_fontset_font, 5);
3439 EXFUN (Fnew_fontset, 2);
3441 /* Defined in xfns.c, w32fns.c, or macfns.c */
3442 EXFUN (Fxw_display_color_p, 1);
3443 EXFUN (Fx_file_dialog, 5);
3444 EXFUN (Fx_focus_frame, 1);
3445 #endif
3447 /* Defined in xfaces.c */
3448 EXFUN (Fclear_face_cache, 1);
3449 EXFUN (Fx_load_color_file, 1);
3450 extern void syms_of_xfaces P_ ((void));
3452 #ifndef HAVE_GETLOADAVG
3453 /* Defined in getloadavg.c */
3454 extern int getloadavg P_ ((double *, int));
3455 #endif
3457 #ifdef HAVE_X_WINDOWS
3458 /* Defined in xfns.c */
3459 extern void syms_of_xfns P_ ((void));
3461 /* Defined in xsmfns.c */
3462 extern void syms_of_xsmfns P_ ((void));
3464 /* Defined in xselect.c */
3465 EXFUN (Fx_send_client_event, 6);
3466 extern void syms_of_xselect P_ ((void));
3468 /* Defined in xterm.c */
3469 extern void syms_of_xterm P_ ((void));
3470 #endif /* HAVE_X_WINDOWS */
3472 #ifdef MSDOS
3473 /* Defined in msdos.c */
3474 EXFUN (Fmsdos_downcase_filename, 1);
3475 #endif
3477 #ifdef HAVE_MENUS
3478 /* Defined in (x|w32)fns.c, nsfns.m... */
3479 extern int have_menus_p P_ ((void));
3480 #endif
3482 #ifdef HAVE_DBUS
3483 /* Defined in dbusbind.c */
3484 int xd_pending_messages P_ ((void));
3485 void xd_read_queued_messages P_ ((void));
3486 void syms_of_dbusbind P_ ((void));
3487 #endif
3489 /* Nonzero means Emacs has already been initialized.
3490 Used during startup to detect startup of dumped Emacs. */
3491 extern int initialized;
3493 extern int immediate_quit; /* Nonzero means ^G can quit instantly */
3495 extern POINTER_TYPE *xmalloc P_ ((size_t));
3496 extern POINTER_TYPE *xrealloc P_ ((POINTER_TYPE *, size_t));
3497 extern void xfree P_ ((POINTER_TYPE *));
3499 extern char *xstrdup P_ ((const char *));
3501 extern char *egetenv P_ ((char *));
3503 /* Set up the name of the machine we're running on. */
3504 extern void init_system_name P_ ((void));
3506 /* Some systems (e.g., NT) use a different path separator than Unix,
3507 in addition to a device separator. Default the path separator
3508 to '/', and don't test for a device separator in IS_ANY_SEP. */
3510 #ifdef WINDOWSNT
3511 extern Lisp_Object impl_Vdirectory_sep_char;
3512 #endif
3514 #ifndef DIRECTORY_SEP
3515 #define DIRECTORY_SEP '/'
3516 #endif
3517 #ifndef IS_DIRECTORY_SEP
3518 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3519 #endif
3520 #ifndef IS_DEVICE_SEP
3521 #ifndef DEVICE_SEP
3522 #define IS_DEVICE_SEP(_c_) 0
3523 #else
3524 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3525 #endif
3526 #endif
3527 #ifndef IS_ANY_SEP
3528 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3529 #endif
3531 #define SWITCH_ENUM_CAST(x) (x)
3533 /* Loop over Lisp list LIST. Signal an error if LIST is not a proper
3534 list, or if it contains circles.
3536 HARE and TORTOISE should be the names of Lisp_Object variables, and
3537 N should be the name of an EMACS_INT variable declared in the
3538 function where the macro is used. Each nested loop should use
3539 its own variables.
3541 In the loop body, HARE is set to each cons of LIST, and N is the
3542 length of the list processed so far. */
3544 #define LIST_END_P(list, obj) \
3545 (NILP (obj) \
3546 ? 1 \
3547 : (CONSP (obj) \
3548 ? 0 \
3549 : (wrong_type_argument (Qlistp, (list))), 1))
3551 #define FOREACH(hare, list, tortoise, n) \
3552 for (tortoise = hare = (list), n = 0; \
3553 !LIST_END_P (list, hare); \
3554 (hare = XCDR (hare), ++n, \
3555 ((n & 1) != 0 \
3556 ? (tortoise = XCDR (tortoise), \
3557 (EQ (hare, tortoise) \
3558 && (circular_list_error ((list)), 1))) \
3559 : 0)))
3561 /* The ubiquitous min and max macros. */
3563 #ifdef max
3564 #undef max
3565 #undef min
3566 #endif
3567 #define min(a, b) ((a) < (b) ? (a) : (b))
3568 #define max(a, b) ((a) > (b) ? (a) : (b))
3570 /* We used to use `abs', but that clashes with system headers on some
3571 platforms, and using a name reserved by Standard C is a bad idea
3572 anyway. */
3573 #if !defined(eabs)
3574 #define eabs(x) ((x) < 0 ? -(x) : (x))
3575 #endif
3577 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3578 fixnum. */
3580 #define make_fixnum_or_float(val) \
3581 (FIXNUM_OVERFLOW_P (val) \
3582 ? make_float (val) \
3583 : make_number ((EMACS_INT)(val)))
3586 /* Checks the `cycle check' variable CHECK to see if it indicates that
3587 EL is part of a cycle; CHECK must be either Qnil or a value returned
3588 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3589 elements after which a cycle might be suspected; after that many
3590 elements, this macro begins consing in order to keep more precise
3591 track of elements.
3593 Returns nil if a cycle was detected, otherwise a new value for CHECK
3594 that includes EL.
3596 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3597 the caller should make sure that's ok. */
3599 #define CYCLE_CHECK(check, el, suspicious) \
3600 (NILP (check) \
3601 ? make_number (0) \
3602 : (INTEGERP (check) \
3603 ? (XFASTINT (check) < (suspicious) \
3604 ? make_number (XFASTINT (check) + 1) \
3605 : Fcons (el, Qnil)) \
3606 : (!NILP (Fmemq ((el), (check))) \
3607 ? Qnil \
3608 : Fcons ((el), (check)))))
3611 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3612 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3614 #define MAX_ALLOCA 16*1024
3616 extern Lisp_Object safe_alloca_unwind (Lisp_Object);
3618 #define USE_SAFE_ALLOCA \
3619 int sa_count = SPECPDL_INDEX (), sa_must_free = 0
3621 /* SAFE_ALLOCA allocates a simple buffer. */
3623 #define SAFE_ALLOCA(buf, type, size) \
3624 do { \
3625 if ((size) < MAX_ALLOCA) \
3626 buf = (type) alloca (size); \
3627 else \
3629 buf = (type) xmalloc (size); \
3630 sa_must_free++; \
3631 record_unwind_protect (safe_alloca_unwind, \
3632 make_save_value (buf, 0)); \
3634 } while (0)
3636 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3638 #define SAFE_FREE() \
3639 do { \
3640 if (sa_must_free) { \
3641 sa_must_free = 0; \
3642 unbind_to (sa_count, Qnil); \
3644 } while (0)
3647 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3649 #define SAFE_ALLOCA_LISP(buf, nelt) \
3650 do { \
3651 int size_ = (nelt) * sizeof (Lisp_Object); \
3652 if (size_ < MAX_ALLOCA) \
3653 buf = (Lisp_Object *) alloca (size_); \
3654 else \
3656 Lisp_Object arg_; \
3657 buf = (Lisp_Object *) xmalloc (size_); \
3658 arg_ = make_save_value (buf, nelt); \
3659 XSAVE_VALUE (arg_)->dogc = 1; \
3660 sa_must_free++; \
3661 record_unwind_protect (safe_alloca_unwind, arg_); \
3663 } while (0)
3666 #include "globals.h"
3668 #include "thread.h"
3670 #endif /* EMACS_LISP_H */
3672 /* arch-tag: 9b2ed020-70eb-47ac-94ee-e1c2a5107d5e
3673 (do not change this comment) */