Remove duplicate declarations.
[emacs.git] / src / lisp.h
blob218c6e630fc416ad0e770ff91c441755279fc59e
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 #include <stdarg.h>
25 #include <stddef.h>
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 (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 /* Use the configure flag --enable-use-lisp-union-type to make
99 Lisp_Object use a union type instead of the default int. The flag
100 causes USE_LISP_UNION_TYPE to be defined. */
102 /***** Select the tagging scheme. *****/
103 /* There are basically two options that control the tagging scheme:
104 - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
105 of an integer.
106 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
107 always 0, and we can thus use them to hold tag bits, without
108 restricting our addressing space.
110 If USE_LSB_TAG is not set, then we use the top 3 bits for tagging, thus
111 restricting our possible address range. Currently USE_LSB_TAG is not
112 allowed together with a union. This is not due to any fundamental
113 technical (or political ;-) problem: nobody wrote the code to do it yet.
115 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
116 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
117 on the few static Lisp_Objects used: all the defsubr as well
118 as the two special buffers buffer_defaults and buffer_local_symbols. */
120 /* First, try and define DECL_ALIGN(type,var) which declares a static
121 variable VAR of type TYPE with the added requirement that it be
122 TYPEBITS-aligned. */
123 #ifndef NO_DECL_ALIGN
124 # ifndef DECL_ALIGN
125 /* What compiler directive should we use for non-gcc compilers? -stef */
126 # if defined (__GNUC__)
127 # define DECL_ALIGN(type, var) \
128 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
129 # endif
130 # endif
131 #endif
133 /* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8. */
134 #if defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ || defined DARWIN_OS
135 /* We also need to be able to specify mult-of-8 alignment on static vars. */
136 # if defined DECL_ALIGN
137 # define USE_LSB_TAG
138 # endif
139 #endif
141 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
142 #ifndef DECL_ALIGN
143 # ifdef USE_LSB_TAG
144 # error "USE_LSB_TAG used without defining DECL_ALIGN"
145 # endif
146 # define DECL_ALIGN(type, var) type var
147 #endif
150 /* Define the fundamental Lisp data structures. */
152 /* If USE_2_TAGBITS_FOR_INTS is defined, then Lisp integers use
153 2 tags, to give them one extra bit, thus extending their range from
154 e.g -2^28..2^28-1 to -2^29..2^29-1. */
155 #define USE_2_TAGS_FOR_INTS
157 /* Making it work for the union case is too much trouble. */
158 #ifdef USE_LISP_UNION_TYPE
159 # undef USE_2_TAGS_FOR_INTS
160 #endif
162 /* This is the set of Lisp data types. */
164 #if !defined USE_2_TAGS_FOR_INTS
165 # define LISP_INT_TAG Lisp_Int
166 # define case_Lisp_Int case Lisp_Int
167 # define LISP_STRING_TAG 4
168 # define LISP_INT_TAG_P(x) ((x) == Lisp_Int)
169 #else
170 # define LISP_INT_TAG Lisp_Int0
171 # define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
172 # ifdef USE_LSB_TAG
173 # define LISP_INT1_TAG 4
174 # define LISP_STRING_TAG 1
175 # define LISP_INT_TAG_P(x) (((x) & 3) == 0)
176 # else
177 # define LISP_INT1_TAG 1
178 # define LISP_STRING_TAG 4
179 # define LISP_INT_TAG_P(x) (((x) & 6) == 0)
180 # endif
181 #endif
183 enum Lisp_Type
185 /* Integer. XINT (obj) is the integer value. */
186 #ifdef USE_2_TAGS_FOR_INTS
187 Lisp_Int0 = 0,
188 Lisp_Int1 = LISP_INT1_TAG,
189 #else
190 Lisp_Int = 0,
191 #endif
193 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
194 Lisp_Symbol = 2,
196 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
197 whose first member indicates the subtype. */
198 Lisp_Misc = 3,
200 /* String. XSTRING (object) points to a struct Lisp_String.
201 The length of the string, and its contents, are stored therein. */
202 Lisp_String = LISP_STRING_TAG,
204 /* Vector of Lisp objects, or something resembling it.
205 XVECTOR (object) points to a struct Lisp_Vector, which contains
206 the size and contents. The size field also contains the type
207 information, if it's not a real vector object. */
208 Lisp_Vectorlike = 5,
210 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
211 Lisp_Cons = 6,
213 Lisp_Float = 7,
216 /* This is the set of data types that share a common structure.
217 The first member of the structure is a type code from this set.
218 The enum values are arbitrary, but we'll use large numbers to make it
219 more likely that we'll spot the error if a random word in memory is
220 mistakenly interpreted as a Lisp_Misc. */
221 enum Lisp_Misc_Type
223 Lisp_Misc_Free = 0x5eab,
224 Lisp_Misc_Marker,
225 Lisp_Misc_Overlay,
226 Lisp_Misc_Save_Value,
227 /* Currently floats are not a misc type,
228 but let's define this in case we want to change that. */
229 Lisp_Misc_Float,
230 /* This is not a type code. It is for range checking. */
231 Lisp_Misc_Limit
234 /* These are the types of forwarding objects used in the value slot
235 of symbols for special built-in variables whose value is stored in
236 C variables. */
237 enum Lisp_Fwd_Type
239 Lisp_Fwd_Int, /* Fwd to a C `int' variable. */
240 Lisp_Fwd_Bool, /* Fwd to a C boolean var. */
241 Lisp_Fwd_Obj, /* Fwd to a C Lisp_Object variable. */
242 Lisp_Fwd_Buffer_Obj, /* Fwd to a Lisp_Object field of buffers. */
243 Lisp_Fwd_Kboard_Obj, /* Fwd to a Lisp_Object field of kboards. */
246 #ifndef GCTYPEBITS
247 #define GCTYPEBITS 3
248 #endif
250 /* These values are overridden by the m- file on some machines. */
251 #ifndef VALBITS
252 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
253 #endif
255 #ifdef USE_LISP_UNION_TYPE
257 #ifndef WORDS_BIG_ENDIAN
259 /* Definition of Lisp_Object for little-endian machines. */
261 typedef
262 union Lisp_Object
264 /* Used for comparing two Lisp_Objects;
265 also, positive integers can be accessed fast this way. */
266 EMACS_UINT i;
268 struct
270 EMACS_INT val : VALBITS;
271 enum Lisp_Type type : GCTYPEBITS;
272 } s;
273 struct
275 EMACS_UINT val : VALBITS;
276 enum Lisp_Type type : GCTYPEBITS;
277 } u;
279 Lisp_Object;
281 #else /* If WORDS_BIG_ENDIAN */
283 typedef
284 union Lisp_Object
286 /* Used for comparing two Lisp_Objects;
287 also, positive integers can be accessed fast this way. */
288 EMACS_UINT i;
290 struct
292 enum Lisp_Type type : GCTYPEBITS;
293 EMACS_INT val : VALBITS;
294 } s;
295 struct
297 enum Lisp_Type type : GCTYPEBITS;
298 EMACS_UINT val : VALBITS;
299 } u;
301 Lisp_Object;
303 #endif /* WORDS_BIG_ENDIAN */
305 #ifdef __GNUC__
306 static __inline__ Lisp_Object
307 LISP_MAKE_RVALUE (Lisp_Object o)
309 return o;
311 #else
312 /* This is more portable to pre-C99 non-GCC compilers, but for
313 backwards compatibility GCC still accepts an old GNU extension
314 which caused this to only generate a warning. */
315 #define LISP_MAKE_RVALUE(o) (0 ? (o) : (o))
316 #endif
318 #else /* USE_LISP_UNION_TYPE */
320 /* If union type is not wanted, define Lisp_Object as just a number. */
322 typedef EMACS_INT Lisp_Object;
323 #define LISP_MAKE_RVALUE(o) (0+(o))
324 #endif /* USE_LISP_UNION_TYPE */
326 /* In the size word of a vector, this bit means the vector has been marked. */
328 #define ARRAY_MARK_FLAG ((EMACS_UINT) 1 << (BITS_PER_EMACS_INT - 1))
330 /* In the size word of a struct Lisp_Vector, this bit means it's really
331 some other vector-like object. */
332 #define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1))
334 /* In a pseudovector, the size field actually contains a word with one
335 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
336 indicate the actual type.
337 We use a bitset, even tho only one of the bits can be set at any
338 particular time just so as to be able to use micro-optimizations such as
339 testing membership of a particular subset of pseudovectors in Fequal.
340 It is not crucial, but there are plenty of bits here, so why not do it? */
341 enum pvec_type
343 PVEC_NORMAL_VECTOR = 0,
344 PVEC_PROCESS = 0x200,
345 PVEC_FRAME = 0x400,
346 PVEC_COMPILED = 0x800,
347 PVEC_WINDOW = 0x1000,
348 PVEC_WINDOW_CONFIGURATION = 0x2000,
349 PVEC_SUBR = 0x4000,
350 PVEC_CHAR_TABLE = 0x8000,
351 PVEC_BOOL_VECTOR = 0x10000,
352 PVEC_BUFFER = 0x20000,
353 PVEC_HASH_TABLE = 0x40000,
354 PVEC_TERMINAL = 0x80000,
355 PVEC_SUB_CHAR_TABLE = 0x100000,
356 PVEC_FONT = 0x200000,
357 PVEC_OTHER = 0x400000,
358 PVEC_TYPE_MASK = 0x7ffe00
360 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
361 GDB. It doesn't work on OS Alpha. Moved to a variable in
362 emacs.c. */
363 PVEC_FLAG = PSEUDOVECTOR_FLAG
364 #endif
367 /* For convenience, we also store the number of elements in these bits.
368 Note that this size is not necessarily the memory-footprint size, but
369 only the number of Lisp_Object fields (that need to be traced by the GC).
370 The distinction is used e.g. by Lisp_Process which places extra
371 non-Lisp_Object fields at the end of the structure. */
372 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
374 /* Number of bits to put in each character in the internal representation
375 of bool vectors. This should not vary across implementations. */
376 #define BOOL_VECTOR_BITS_PER_CHAR 8
378 /* These macros extract various sorts of values from a Lisp_Object.
379 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
380 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
382 #ifndef USE_LISP_UNION_TYPE
384 /* Return a perfect hash of the Lisp_Object representation. */
385 #define XHASH(a) (a)
387 #ifdef USE_LSB_TAG
389 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
390 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) & TYPEMASK))
391 #ifdef USE_2_TAGS_FOR_INTS
392 # define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
393 # define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
394 # define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
395 #else
396 # define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
397 # define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
398 # define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
399 #endif
400 #define XSET(var, type, ptr) \
401 (eassert (XTYPE (ptr) == 0), /* Check alignment. */ \
402 (var) = ((EMACS_INT) (type)) | ((EMACS_INT) (ptr)))
404 #define XPNTR(a) ((EMACS_INT) ((a) & ~TYPEMASK))
406 #else /* not USE_LSB_TAG */
408 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
410 /* One need to override this if there must be high bits set in data space
411 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
412 on all machines, but would penalize machines which don't need it)
414 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
416 /* For integers known to be positive, XFASTINT provides fast retrieval
417 and XSETFASTINT provides fast storage. This takes advantage of the
418 fact that Lisp_Int is 0. */
419 #define XFASTINT(a) ((a) + 0)
420 #define XSETFASTINT(a, b) ((a) = (b))
422 /* Extract the value of a Lisp_Object as a (un)signed integer. */
424 #ifdef USE_2_TAGS_FOR_INTS
425 # define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
426 # define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
427 # define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
428 #else
429 # define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
430 >> (BITS_PER_EMACS_INT - VALBITS))
431 # define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
432 # define make_number(N) \
433 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
434 #endif
436 #define XSET(var, type, ptr) \
437 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
439 #define XPNTR(a) ((EMACS_UINT) ((a) & VALMASK))
441 #endif /* not USE_LSB_TAG */
443 #else /* USE_LISP_UNION_TYPE */
445 #ifdef USE_2_TAGS_FOR_INTS
446 # error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
447 #endif
449 #define XHASH(a) ((a).i)
451 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
453 #ifdef EXPLICIT_SIGN_EXTEND
454 /* Make sure we sign-extend; compilers have been known to fail to do so.
455 We additionally cast to EMACS_INT since it seems that some compilers
456 have been known to fail to do so, even though the bitfield is declared
457 as EMACS_INT already. */
458 #define XINT(a) ((((EMACS_INT) (a).s.val) << (BITS_PER_EMACS_INT - VALBITS)) \
459 >> (BITS_PER_EMACS_INT - VALBITS))
460 #else
461 #define XINT(a) ((a).s.val)
462 #endif /* EXPLICIT_SIGN_EXTEND */
464 #define XUINT(a) ((a).u.val)
466 #ifdef USE_LSB_TAG
468 # define XSET(var, vartype, ptr) \
469 (eassert ((((EMACS_UINT) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0), \
470 (var).u.val = ((EMACS_UINT) (ptr)) >> GCTYPEBITS, \
471 (var).u.type = ((char) (vartype)))
473 /* Some versions of gcc seem to consider the bitfield width when issuing
474 the "cast to pointer from integer of different size" warning, so the
475 cast is here to widen the value back to its natural size. */
476 # define XPNTR(v) ((EMACS_INT)((v).s.val) << GCTYPEBITS)
478 #else /* !USE_LSB_TAG */
480 /* For integers known to be positive, XFASTINT provides fast retrieval
481 and XSETFASTINT provides fast storage. This takes advantage of the
482 fact that Lisp_Int is 0. */
483 # define XFASTINT(a) ((a).i + 0)
484 # define XSETFASTINT(a, b) ((a).i = (b))
486 # define XSET(var, vartype, ptr) \
487 (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
489 #endif /* !USE_LSB_TAG */
491 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
492 #define make_number(N) \
493 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
494 #else
495 extern Lisp_Object make_number (EMACS_INT);
496 #endif
498 #endif /* USE_LISP_UNION_TYPE */
500 /* For integers known to be positive, XFASTINT sometimes provides
501 faster retrieval and XSETFASTINT provides faster storage.
502 If not, fallback on the non-accelerated path. */
503 #ifndef XFASTINT
504 # define XFASTINT(a) (XINT (a))
505 # define XSETFASTINT(a, b) (XSETINT (a, b))
506 #endif
508 #define EQ(x, y) (XHASH (x) == XHASH (y))
510 #ifndef XPNTR
511 #ifdef DATA_SEG_BITS
512 /* This case is used for the rt-pc.
513 In the diffs I was given, it checked for ptr = 0
514 and did not adjust it in that case.
515 But I don't think that zero should ever be found
516 in a Lisp object whose data type says it points to something. */
517 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
518 #else
519 /* Some versions of gcc seem to consider the bitfield width when
520 issuing the "cast to pointer from integer of different size"
521 warning, so the cast is here to widen the value back to its natural
522 size. */
523 #define XPNTR(a) ((EMACS_INT) XUINT (a))
524 #endif
525 #endif /* no XPNTR */
527 /* Largest and smallest representable fixnum values. These are the C
528 values. */
530 #ifdef USE_2_TAGS_FOR_INTS
531 # define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << VALBITS)
532 # define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << VALBITS) - 1)
533 /* Mask indicating the significant bits of a Lisp_Int.
534 I.e. (x & INTMASK) == XUINT (make_number (x)). */
535 # define INTMASK ((((EMACS_INT) 1) << (VALBITS + 1)) - 1)
536 #else
537 # define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << (VALBITS - 1))
538 # define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << (VALBITS - 1)) - 1)
539 /* Mask indicating the significant bits of a Lisp_Int.
540 I.e. (x & INTMASK) == XUINT (make_number (x)). */
541 # define INTMASK ((((EMACS_INT) 1) << VALBITS) - 1)
542 #endif
544 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
545 written this way so that it also works if I is of unsigned
546 type. */
548 #define FIXNUM_OVERFLOW_P(i) \
549 ((i) > MOST_POSITIVE_FIXNUM \
550 || ((i) < 0 && (i) < MOST_NEGATIVE_FIXNUM))
552 /* Extract a value or address from a Lisp_Object. */
554 #define XCONS(a) (eassert (CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
555 #define XVECTOR(a) (eassert (VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
556 #define XSTRING(a) (eassert (STRINGP(a)),(struct Lisp_String *) XPNTR(a))
557 #define XSYMBOL(a) (eassert (SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
558 #define XFLOAT(a) (eassert (FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
560 /* Misc types. */
562 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
563 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC(a)->u_any))
564 #define XMISCTYPE(a) (XMISCANY (a)->type)
565 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC(a)->u_marker))
566 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
567 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
569 /* Forwarding object types. */
571 #define XFWDTYPE(a) (a->u_intfwd.type)
572 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
573 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
574 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
575 #define XBUFFER_OBJFWD(a) \
576 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
577 #define XKBOARD_OBJFWD(a) \
578 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
580 /* Pseudovector types. */
582 #define XPROCESS(a) (eassert (PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
583 #define XWINDOW(a) (eassert (WINDOWP(a)),(struct window *) XPNTR(a))
584 #define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
585 #define XSUBR(a) (eassert (SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
586 #define XBUFFER(a) (eassert (BUFFERP(a)),(struct buffer *) XPNTR(a))
587 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
588 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR(a))
589 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
591 /* Construct a Lisp_Object from a value or address. */
593 #define XSETINT(a, b) (a) = make_number (b)
594 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
595 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
596 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
597 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
598 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
600 /* Misc types. */
602 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
603 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
605 /* Pseudovector types. */
607 #define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
608 #define XSETPSEUDOVECTOR(a, b, code) \
609 (XSETVECTOR (a, b), \
610 eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
611 == (PSEUDOVECTOR_FLAG | (code))))
612 #define XSETWINDOW_CONFIGURATION(a, b) \
613 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
614 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
615 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
616 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
617 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
618 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
619 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
620 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
621 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
622 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
624 /* Convenience macros for dealing with Lisp arrays. */
626 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
627 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->size
628 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
629 #define ASET(ARRAY, IDX, VAL) \
630 (eassert ((IDX) == (IDX)), \
631 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
632 AREF ((ARRAY), (IDX)) = (VAL))
634 /* Convenience macros for dealing with Lisp strings. */
636 #define SDATA(string) (XSTRING (string)->data + 0)
637 #define SREF(string, index) (SDATA (string)[index] + 0)
638 #define SSET(string, index, new) (SDATA (string)[index] = (new))
639 #define SCHARS(string) (XSTRING (string)->size + 0)
640 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
642 #define STRING_SET_CHARS(string, newsize) \
643 (XSTRING (string)->size = (newsize))
645 #define STRING_COPYIN(string, index, new, count) \
646 memcpy (SDATA (string) + index, new, count)
648 /* Type checking. */
650 #define CHECK_TYPE(ok, Qxxxp, x) \
651 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
655 /* See the macros in intervals.h. */
657 typedef struct interval *INTERVAL;
659 /* Complain if object is not string or buffer type */
660 #define CHECK_STRING_OR_BUFFER(x) \
661 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
664 /* In a cons, the markbit of the car is the gc mark bit */
666 struct Lisp_Cons
668 /* Please do not use the names of these elements in code other
669 than the core lisp implementation. Use XCAR and XCDR below. */
670 #ifdef HIDE_LISP_IMPLEMENTATION
671 Lisp_Object car_;
672 union
674 Lisp_Object cdr_;
675 struct Lisp_Cons *chain;
676 } u;
677 #else
678 Lisp_Object car;
679 union
681 Lisp_Object cdr;
682 struct Lisp_Cons *chain;
683 } u;
684 #endif
687 /* Take the car or cdr of something known to be a cons cell. */
688 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
689 of code that has to know what a cons cell looks like. Other code not
690 part of the basic lisp implementation should assume that the car and cdr
691 fields are not accessible as lvalues. (What if we want to switch to
692 a copying collector someday? Cached cons cell field addresses may be
693 invalidated at arbitrary points.) */
694 #ifdef HIDE_LISP_IMPLEMENTATION
695 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
696 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
697 #else
698 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
699 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
700 #endif
702 /* Use these from normal code. */
703 #define XCAR(c) LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
704 #define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))
706 /* Use these to set the fields of a cons cell.
708 Note that both arguments may refer to the same object, so 'n'
709 should not be read after 'c' is first modified. Also, neither
710 argument should be evaluated more than once; side effects are
711 especially common in the second argument. */
712 #define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
713 #define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))
715 /* Take the car or cdr of something whose type is not known. */
716 #define CAR(c) \
717 (CONSP ((c)) ? XCAR ((c)) \
718 : NILP ((c)) ? Qnil \
719 : wrong_type_argument (Qlistp, (c)))
721 #define CDR(c) \
722 (CONSP ((c)) ? XCDR ((c)) \
723 : NILP ((c)) ? Qnil \
724 : wrong_type_argument (Qlistp, (c)))
726 /* Take the car or cdr of something whose type is not known. */
727 #define CAR_SAFE(c) \
728 (CONSP ((c)) ? XCAR ((c)) : Qnil)
730 #define CDR_SAFE(c) \
731 (CONSP ((c)) ? XCDR ((c)) : Qnil)
733 /* Nonzero if STR is a multibyte string. */
734 #define STRING_MULTIBYTE(STR) \
735 (XSTRING (STR)->size_byte >= 0)
737 /* Return the length in bytes of STR. */
739 #ifdef GC_CHECK_STRING_BYTES
741 struct Lisp_String;
742 extern int string_bytes (struct Lisp_String *);
743 #define STRING_BYTES(S) string_bytes ((S))
745 #else /* not GC_CHECK_STRING_BYTES */
747 #define STRING_BYTES(STR) \
748 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
750 #endif /* not GC_CHECK_STRING_BYTES */
752 /* Mark STR as a unibyte string. */
753 #define STRING_SET_UNIBYTE(STR) \
754 do { if (EQ (STR, empty_multibyte_string)) \
755 (STR) = empty_unibyte_string; \
756 else XSTRING (STR)->size_byte = -1; } while (0)
758 /* Mark STR as a multibyte string. Assure that STR contains only
759 ASCII characters in advance. */
760 #define STRING_SET_MULTIBYTE(STR) \
761 do { if (EQ (STR, empty_unibyte_string)) \
762 (STR) = empty_multibyte_string; \
763 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
765 /* Get text properties. */
766 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
768 /* Set text properties. */
769 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
771 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
773 struct Lisp_String
775 EMACS_INT size;
776 EMACS_INT size_byte;
777 INTERVAL intervals; /* text properties in this string */
778 unsigned char *data;
781 struct Lisp_Vector
783 EMACS_UINT size;
784 struct Lisp_Vector *next;
785 Lisp_Object contents[1];
788 /* If a struct is made to look like a vector, this macro returns the length
789 of the shortest vector that would hold that struct. */
790 #define VECSIZE(type) ((sizeof (type) \
791 - offsetof (struct Lisp_Vector, contents[0]) \
792 + sizeof(Lisp_Object) - 1) /* round up */ \
793 / sizeof (Lisp_Object))
795 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
796 at the end and we need to compute the number of Lisp_Object fields (the
797 ones that the GC needs to trace). */
798 #define PSEUDOVECSIZE(type, nonlispfield) \
799 ((offsetof(type, nonlispfield) - offsetof(struct Lisp_Vector, contents[0])) \
800 / sizeof (Lisp_Object))
802 /* A char-table is a kind of vectorlike, with contents are like a
803 vector but with a few other slots. For some purposes, it makes
804 sense to handle a char-table with type struct Lisp_Vector. An
805 element of a char table can be any Lisp objects, but if it is a sub
806 char-table, we treat it a table that contains information of a
807 specific range of characters. A sub char-table has the same
808 structure as a vector. A sub char table appears only in an element
809 of a char-table, and there's no way to access it directly from
810 Emacs Lisp program. */
812 /* This is the number of slots that every char table must have. This
813 counts the ordinary slots and the top, defalt, parent, and purpose
814 slots. */
815 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
817 /* Return the number of "extra" slots in the char table CT. */
819 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
820 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
822 #ifdef __GNUC__
824 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
825 ({struct Lisp_Char_Table *_tbl = NULL; \
826 Lisp_Object _val; \
827 do { \
828 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
829 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
830 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
831 if (NILP (_val)) \
832 _val = _tbl->defalt; \
833 } while (NILP (_val) && ! NILP (_tbl->parent)); \
834 _val; })
836 #else /* not __GNUC__ */
838 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
839 (! NILP (XCHAR_TABLE (CT)->ascii) \
840 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
841 ? XCHAR_TABLE (CT)->ascii \
842 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
843 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
844 : char_table_ref ((CT), (IDX))) \
845 : char_table_ref ((CT), (IDX)))
847 #endif /* not __GNUC__ */
849 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
850 characters. Do not check validity of CT. */
851 #define CHAR_TABLE_REF(CT, IDX) \
852 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
853 : char_table_ref ((CT), (IDX)))
855 /* Almost equivalent to Faref (CT, IDX). However, if the result is
856 not a character, return IDX.
858 For these characters, do not check validity of CT
859 and do not follow parent. */
860 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
861 char_table_translate (CT, IDX)
863 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
864 8-bit European characters. Do not check validity of CT. */
865 #define CHAR_TABLE_SET(CT, IDX, VAL) \
866 (((IDX) >= 0 && ASCII_CHAR_P (IDX) \
867 && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)) \
868 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
869 : char_table_set (CT, IDX, VAL))
871 #define CHARTAB_SIZE_BITS_0 6
872 #define CHARTAB_SIZE_BITS_1 4
873 #define CHARTAB_SIZE_BITS_2 5
874 #define CHARTAB_SIZE_BITS_3 7
876 extern const int chartab_size[4];
878 struct Lisp_Sub_Char_Table;
880 struct Lisp_Char_Table
882 /* This is the vector's size field, which also holds the
883 pseudovector type information. It holds the size, too.
884 The size counts the defalt, parent, purpose, ascii,
885 contents, and extras slots. */
886 EMACS_UINT size;
887 struct Lisp_Vector *next;
889 /* This holds a default value,
890 which is used whenever the value for a specific character is nil. */
891 Lisp_Object defalt;
893 /* This points to another char table, which we inherit from when the
894 value for a specific character is nil. The `defalt' slot takes
895 precedence over this. */
896 Lisp_Object parent;
898 /* This is a symbol which says what kind of use this char-table is
899 meant for. */
900 Lisp_Object purpose;
902 /* The bottom sub char-table for characters of the range 0..127. It
903 is nil if none of ASCII character has a specific value. */
904 Lisp_Object ascii;
906 Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)];
908 /* These hold additional data. It is a vector. */
909 Lisp_Object extras[1];
912 struct Lisp_Sub_Char_Table
914 /* This is the vector's size field, which also holds the
915 pseudovector type information. It holds the size, too. */
916 EMACS_INT size;
917 struct Lisp_Vector *next;
919 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
920 char-table of depth 1 contains 16 elements, and each element
921 covers 4096 (128*32) characters. A sub char-table of depth 2
922 contains 32 elements, and each element covers 128 characters. A
923 sub char-table of depth 3 contains 128 elements, and each element
924 is for one character. */
925 Lisp_Object depth;
927 /* Minimum character covered by the sub char-table. */
928 Lisp_Object min_char;
930 Lisp_Object contents[1];
933 /* A boolvector is a kind of vectorlike, with contents are like a string. */
934 struct Lisp_Bool_Vector
936 /* This is the vector's size field. It doesn't have the real size,
937 just the subtype information. */
938 EMACS_UINT vector_size;
939 struct Lisp_Vector *next;
940 /* This is the size in bits. */
941 EMACS_UINT size;
942 /* This contains the actual bits, packed into bytes. */
943 unsigned char data[1];
946 /* This structure describes a built-in function.
947 It is generated by the DEFUN macro only.
948 defsubr makes it into a Lisp object.
950 This type is treated in most respects as a pseudovector,
951 but since we never dynamically allocate or free them,
952 we don't need a next-vector field. */
954 struct Lisp_Subr
956 EMACS_UINT size;
957 union {
958 Lisp_Object (*a0) (void);
959 Lisp_Object (*a1) (Lisp_Object);
960 Lisp_Object (*a2) (Lisp_Object, Lisp_Object);
961 Lisp_Object (*a3) (Lisp_Object, Lisp_Object, Lisp_Object);
962 Lisp_Object (*a4) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
963 Lisp_Object (*a5) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
964 Lisp_Object (*a6) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
965 Lisp_Object (*a7) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
966 Lisp_Object (*a8) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
967 Lisp_Object (*aUNEVALLED) (Lisp_Object args);
968 Lisp_Object (*aMANY) (int, Lisp_Object *);
969 } function;
970 short min_args, max_args;
971 const char *symbol_name;
972 const char *intspec;
973 const char *doc;
977 /***********************************************************************
978 Symbols
979 ***********************************************************************/
981 /* Interned state of a symbol. */
983 enum symbol_interned
985 SYMBOL_UNINTERNED = 0,
986 SYMBOL_INTERNED = 1,
987 SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
990 enum symbol_redirect
992 SYMBOL_PLAINVAL = 4,
993 SYMBOL_VARALIAS = 1,
994 SYMBOL_LOCALIZED = 2,
995 SYMBOL_FORWARDED = 3
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 /* Indicates where the value can be found:
1005 0 : it's a plain var, the value is in the `value' field.
1006 1 : it's a varalias, the value is really in the `alias' symbol.
1007 2 : it's a localized var, the value is in the `blv' object.
1008 3 : it's a forwarding variable, the value is in `forward'.
1010 enum symbol_redirect redirect : 3;
1012 /* Non-zero means symbol is constant, i.e. changing its value
1013 should signal an error. If the value is 3, then the var
1014 can be changed, but only by `defconst'. */
1015 unsigned constant : 2;
1017 /* Interned state of the symbol. This is an enumerator from
1018 enum symbol_interned. */
1019 unsigned interned : 2;
1021 /* The symbol's name, as a Lisp string.
1023 The name "xname" is used to intentionally break code referring to
1024 the old field "name" of type pointer to struct Lisp_String. */
1025 Lisp_Object xname;
1027 /* Value of the symbol or Qunbound if unbound. If this symbol is a
1028 defvaralias, `alias' contains the symbol for which it is an
1029 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
1030 and set a symbol's value, to take defvaralias into account. */
1031 union {
1032 Lisp_Object value;
1033 struct Lisp_Symbol *alias;
1034 struct Lisp_Buffer_Local_Value *blv;
1035 union Lisp_Fwd *fwd;
1036 } val;
1038 /* Function value of the symbol or Qunbound if not fboundp. */
1039 Lisp_Object function;
1041 /* The symbol's property list. */
1042 Lisp_Object plist;
1044 /* Next symbol in obarray bucket, if the symbol is interned. */
1045 struct Lisp_Symbol *next;
1048 /* Value is name of symbol. */
1050 #define SYMBOL_VAL(sym) \
1051 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1052 #define SYMBOL_ALIAS(sym) \
1053 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1054 #define SYMBOL_BLV(sym) \
1055 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1056 #define SYMBOL_FWD(sym) \
1057 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1058 #define SET_SYMBOL_VAL(sym, v) \
1059 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1060 #define SET_SYMBOL_ALIAS(sym, v) \
1061 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1062 #define SET_SYMBOL_BLV(sym, v) \
1063 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1064 #define SET_SYMBOL_FWD(sym, v) \
1065 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1067 #define SYMBOL_NAME(sym) \
1068 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1070 /* Value is non-zero if SYM is an interned symbol. */
1072 #define SYMBOL_INTERNED_P(sym) \
1073 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1075 /* Value is non-zero if SYM is interned in initial_obarray. */
1077 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1078 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1080 /* Value is non-zero if symbol is considered a constant, i.e. its
1081 value cannot be changed (there is an exception for keyword symbols,
1082 whose value can be set to the keyword symbol itself). */
1084 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1087 /***********************************************************************
1088 Hash Tables
1089 ***********************************************************************/
1091 /* The structure of a Lisp hash table. */
1093 struct Lisp_Hash_Table
1095 /* Vector fields. The hash table code doesn't refer to these. */
1096 EMACS_UINT size;
1097 struct Lisp_Vector *vec_next;
1099 /* Function used to compare keys. */
1100 Lisp_Object test;
1102 /* Nil if table is non-weak. Otherwise a symbol describing the
1103 weakness of the table. */
1104 Lisp_Object weak;
1106 /* When the table is resized, and this is an integer, compute the
1107 new size by adding this to the old size. If a float, compute the
1108 new size by multiplying the old size with this factor. */
1109 Lisp_Object rehash_size;
1111 /* Resize hash table when number of entries/ table size is >= this
1112 ratio, a float. */
1113 Lisp_Object rehash_threshold;
1115 /* Vector of hash codes.. If hash[I] is nil, this means that that
1116 entry I is unused. */
1117 Lisp_Object hash;
1119 /* Vector used to chain entries. If entry I is free, next[I] is the
1120 entry number of the next free item. If entry I is non-free,
1121 next[I] is the index of the next entry in the collision chain. */
1122 Lisp_Object next;
1124 /* Index of first free entry in free list. */
1125 Lisp_Object next_free;
1127 /* Bucket vector. A non-nil entry is the index of the first item in
1128 a collision chain. This vector's size can be larger than the
1129 hash table size to reduce collisions. */
1130 Lisp_Object index;
1132 /* User-supplied hash function, or nil. */
1133 Lisp_Object user_hash_function;
1135 /* User-supplied key comparison function, or nil. */
1136 Lisp_Object user_cmp_function;
1138 /* Only the fields above are traced normally by the GC. The ones below
1139 `count' are special and are either ignored by the GC or traced in
1140 a special way (e.g. because of weakness). */
1142 /* Number of key/value entries in the table. */
1143 unsigned int count;
1145 /* Vector of keys and values. The key of item I is found at index
1146 2 * I, the value is found at index 2 * I + 1.
1147 This is gc_marked specially if the table is weak. */
1148 Lisp_Object key_and_value;
1150 /* Next weak hash table if this is a weak hash table. The head
1151 of the list is in weak_hash_tables. */
1152 struct Lisp_Hash_Table *next_weak;
1154 /* C function to compare two keys. */
1155 int (* cmpfn) (struct Lisp_Hash_Table *, Lisp_Object,
1156 unsigned, Lisp_Object, unsigned);
1158 /* C function to compute hash code. */
1159 unsigned (* hashfn) (struct Lisp_Hash_Table *, Lisp_Object);
1163 #define XHASH_TABLE(OBJ) \
1164 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1166 #define XSET_HASH_TABLE(VAR, PTR) \
1167 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1169 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1171 #define CHECK_HASH_TABLE(x) \
1172 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1174 /* Value is the key part of entry IDX in hash table H. */
1176 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1178 /* Value is the value part of entry IDX in hash table H. */
1180 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1182 /* Value is the index of the next entry following the one at IDX
1183 in hash table H. */
1185 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1187 /* Value is the hash code computed for entry IDX in hash table H. */
1189 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1191 /* Value is the index of the element in hash table H that is the
1192 start of the collision list at index IDX in the index vector of H. */
1194 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1196 /* Value is the size of hash table H. */
1198 #define HASH_TABLE_SIZE(H) XVECTOR ((H)->next)->size
1200 /* Default size for hash tables if not specified. */
1202 #define DEFAULT_HASH_SIZE 65
1204 /* Default threshold specifying when to resize a hash table. The
1205 value gives the ratio of current entries in the hash table and the
1206 size of the hash table. */
1208 #define DEFAULT_REHASH_THRESHOLD 0.8
1210 /* Default factor by which to increase the size of a hash table. */
1212 #define DEFAULT_REHASH_SIZE 1.5
1215 /* These structures are used for various misc types. */
1217 struct Lisp_Misc_Any /* Supertype of all Misc types. */
1219 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_??? */
1220 unsigned gcmarkbit : 1;
1221 int spacer : 15;
1222 /* Make it as long as "Lisp_Free without padding". */
1223 void *fill;
1226 struct Lisp_Marker
1228 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Marker */
1229 unsigned gcmarkbit : 1;
1230 int spacer : 13;
1231 /* This flag is temporarily used in the functions
1232 decode/encode_coding_object to record that the marker position
1233 must be adjusted after the conversion. */
1234 unsigned int need_adjustment : 1;
1235 /* 1 means normal insertion at the marker's position
1236 leaves the marker after the inserted text. */
1237 unsigned int insertion_type : 1;
1238 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1239 Note: a chain of markers can contain markers pointing into different
1240 buffers (the chain is per buffer_text rather than per buffer, so it's
1241 shared between indirect buffers). */
1242 /* This is used for (other than NULL-checking):
1243 - Fmarker_buffer
1244 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1245 - unchain_marker: to find the list from which to unchain.
1246 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1248 struct buffer *buffer;
1250 /* The remaining fields are meaningless in a marker that
1251 does not point anywhere. */
1253 /* For markers that point somewhere,
1254 this is used to chain of all the markers in a given buffer. */
1255 /* We could remove it and use an array in buffer_text instead.
1256 That would also allow to preserve it ordered. */
1257 struct Lisp_Marker *next;
1258 /* This is the char position where the marker points. */
1259 EMACS_INT charpos;
1260 /* This is the byte position.
1261 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1262 used to implement the functionality of markers, but rather to (ab)use
1263 markers as a cache for char<->byte mappings). */
1264 EMACS_INT bytepos;
1267 /* Forwarding pointer to an int variable.
1268 This is allowed only in the value cell of a symbol,
1269 and it means that the symbol's value really lives in the
1270 specified int variable. */
1271 struct Lisp_Intfwd
1273 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Int */
1274 EMACS_INT *intvar;
1277 /* Boolean forwarding pointer to an int variable.
1278 This is like Lisp_Intfwd except that the ostensible
1279 "value" of the symbol is t if the int variable is nonzero,
1280 nil if it is zero. */
1281 struct Lisp_Boolfwd
1283 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Bool */
1284 int *boolvar;
1287 /* Forwarding pointer to a Lisp_Object variable.
1288 This is allowed only in the value cell of a symbol,
1289 and it means that the symbol's value really lives in the
1290 specified variable. */
1291 struct Lisp_Objfwd
1293 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Obj */
1294 Lisp_Object *objvar;
1297 /* Like Lisp_Objfwd except that value lives in a slot in the
1298 current buffer. Value is byte index of slot within buffer. */
1299 struct Lisp_Buffer_Objfwd
1301 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Buffer_Obj */
1302 int offset;
1303 Lisp_Object slottype; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1306 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1307 the symbol has buffer-local or frame-local bindings. (Exception:
1308 some buffer-local variables are built-in, with their values stored
1309 in the buffer structure itself. They are handled differently,
1310 using struct Lisp_Buffer_Objfwd.)
1312 The `realvalue' slot holds the variable's current value, or a
1313 forwarding pointer to where that value is kept. This value is the
1314 one that corresponds to the loaded binding. To read or set the
1315 variable, you must first make sure the right binding is loaded;
1316 then you can access the value in (or through) `realvalue'.
1318 `buffer' and `frame' are the buffer and frame for which the loaded
1319 binding was found. If those have changed, to make sure the right
1320 binding is loaded it is necessary to find which binding goes with
1321 the current buffer and selected frame, then load it. To load it,
1322 first unload the previous binding, then copy the value of the new
1323 binding into `realvalue' (or through it). Also update
1324 LOADED-BINDING to point to the newly loaded binding.
1326 `local_if_set' indicates that merely setting the variable creates a
1327 local binding for the current buffer. Otherwise the latter, setting
1328 the variable does not do that; only make-local-variable does that. */
1330 struct Lisp_Buffer_Local_Value
1332 /* 1 means that merely setting the variable creates a local
1333 binding for the current buffer */
1334 unsigned int local_if_set : 1;
1335 /* 1 means this variable can have frame-local bindings, otherwise, it is
1336 can have buffer-local bindings. The two cannot be combined. */
1337 unsigned int frame_local : 1;
1338 /* 1 means that the binding now loaded was found.
1339 Presumably equivalent to (defcell!=valcell) */
1340 unsigned int found : 1;
1341 /* If non-NULL, a forwarding to the C var where it should also be set. */
1342 union Lisp_Fwd *fwd; /* Should never be (Buffer|Kboard)_Objfwd. */
1343 /* The buffer or frame for which the loaded binding was found. */
1344 Lisp_Object where;
1345 /* A cons cell that holds the default value. It has the form
1346 (SYMBOL . DEFAULT-VALUE). */
1347 Lisp_Object defcell;
1348 /* The cons cell from `where's parameter alist.
1349 It always has the form (SYMBOL . VALUE)
1350 Note that if `forward' is non-nil, VALUE may be out of date.
1351 Also if the currently loaded binding is the default binding, then
1352 this is `eq'ual to defcell. */
1353 Lisp_Object valcell;
1356 #define BLV_FOUND(blv) \
1357 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1358 #define SET_BLV_FOUND(blv, v) \
1359 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1361 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1362 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1364 /* START and END are markers in the overlay's buffer, and
1365 PLIST is the overlay's property list. */
1366 struct Lisp_Overlay
1367 /* An overlay's real data content is:
1368 - plist
1369 - buffer
1370 - insertion type of both ends
1371 - start & start_byte
1372 - end & end_byte
1373 - next (singly linked list of overlays).
1374 - start_next and end_next (singly linked list of markers).
1375 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1378 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Overlay */
1379 unsigned gcmarkbit : 1;
1380 int spacer : 15;
1381 struct Lisp_Overlay *next;
1382 Lisp_Object start, end, plist;
1385 /* Like Lisp_Objfwd except that value lives in a slot in the
1386 current kboard. */
1387 struct Lisp_Kboard_Objfwd
1389 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Kboard_Obj */
1390 int offset;
1393 /* Hold a C pointer for later use.
1394 This type of object is used in the arg to record_unwind_protect. */
1395 struct Lisp_Save_Value
1397 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Save_Value */
1398 unsigned gcmarkbit : 1;
1399 int spacer : 14;
1400 /* If DOGC is set, POINTER is the address of a memory
1401 area containing INTEGER potential Lisp_Objects. */
1402 unsigned int dogc : 1;
1403 void *pointer;
1404 int integer;
1408 /* A miscellaneous object, when it's on the free list. */
1409 struct Lisp_Free
1411 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Free */
1412 unsigned gcmarkbit : 1;
1413 int spacer : 15;
1414 union Lisp_Misc *chain;
1415 #ifdef USE_LSB_TAG
1416 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1417 This assumes that Lisp_Marker is the largest of the alternatives and
1418 that Lisp_Misc_Any has the same size as "Lisp_Free w/o padding". */
1419 char padding[((((sizeof (struct Lisp_Marker) - 1) >> GCTYPEBITS) + 1)
1420 << GCTYPEBITS) - sizeof (struct Lisp_Misc_Any)];
1421 #endif
1424 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1425 It uses one of these struct subtypes to get the type field. */
1427 union Lisp_Misc
1429 struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */
1430 struct Lisp_Free u_free; /* Includes padding to force alignment. */
1431 struct Lisp_Marker u_marker; /* 5 */
1432 struct Lisp_Overlay u_overlay; /* 5 */
1433 struct Lisp_Save_Value u_save_value; /* 3 */
1436 union Lisp_Fwd
1438 struct Lisp_Intfwd u_intfwd; /* 2 */
1439 struct Lisp_Boolfwd u_boolfwd; /* 2 */
1440 struct Lisp_Objfwd u_objfwd; /* 2 */
1441 struct Lisp_Buffer_Objfwd u_buffer_objfwd; /* 2 */
1442 struct Lisp_Kboard_Objfwd u_kboard_objfwd; /* 2 */
1445 /* Lisp floating point type */
1446 struct Lisp_Float
1448 union
1450 #ifdef HIDE_LISP_IMPLEMENTATION
1451 double data_;
1452 #else
1453 double data;
1454 #endif
1455 struct Lisp_Float *chain;
1456 } u;
1459 #ifdef HIDE_LISP_IMPLEMENTATION
1460 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1461 #else
1462 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1463 /* This should be used only in alloc.c, which always disables
1464 HIDE_LISP_IMPLEMENTATION. */
1465 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1466 #endif
1468 /* A character, declared with the following typedef, is a member
1469 of some character set associated with the current buffer. */
1470 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1471 #define _UCHAR_T
1472 typedef unsigned char UCHAR;
1473 #endif
1475 /* Meanings of slots in a Lisp_Compiled: */
1477 #define COMPILED_ARGLIST 0
1478 #define COMPILED_BYTECODE 1
1479 #define COMPILED_CONSTANTS 2
1480 #define COMPILED_STACK_DEPTH 3
1481 #define COMPILED_DOC_STRING 4
1482 #define COMPILED_INTERACTIVE 5
1484 /* Flag bits in a character. These also get used in termhooks.h.
1485 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1486 (MUlti-Lingual Emacs) might need 22 bits for the character value
1487 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1488 #define CHAR_ALT (0x0400000)
1489 #define CHAR_SUPER (0x0800000)
1490 #define CHAR_HYPER (0x1000000)
1491 #define CHAR_SHIFT (0x2000000)
1492 #define CHAR_CTL (0x4000000)
1493 #define CHAR_META (0x8000000)
1495 #define CHAR_MODIFIER_MASK \
1496 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1499 /* Actually, the current Emacs uses 22 bits for the character value
1500 itself. */
1501 #define CHARACTERBITS 22
1503 /* The maximum byte size consumed by push_key_description.
1504 All callers should assure that at least this size of memory is
1505 allocated at the place pointed by the second argument.
1507 There are 6 modifiers, each consumes 2 chars.
1508 The octal form of a character code consumes
1509 (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
1510 We need one more byte for string terminator `\0'. */
1511 #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)
1514 /* The glyph datatype, used to represent characters on the display.
1515 It consists of a char code and a face id. */
1517 typedef struct {
1518 int ch;
1519 int face_id;
1520 } GLYPH;
1522 /* Return a glyph's character code. */
1523 #define GLYPH_CHAR(glyph) ((glyph).ch)
1525 /* Return a glyph's face ID. */
1526 #define GLYPH_FACE(glyph) ((glyph).face_id)
1528 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1529 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1530 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1532 /* Return 1 if GLYPH contains valid character code. */
1533 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph), 1)
1536 /* Glyph Code from a display vector may either be an integer which
1537 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1538 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1540 #define GLYPH_CODE_CHAR(gc) \
1541 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1543 #define GLYPH_CODE_FACE(gc) \
1544 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1546 /* Return 1 if glyph code from display vector contains valid character code. */
1547 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc), 1)
1549 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1551 /* Only called when GLYPH_CODE_P (gc) is true. */
1552 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1553 do \
1555 if (CONSP (gc)) \
1556 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1557 else \
1558 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1559 (XINT (gc) >> CHARACTERBITS)); \
1561 while (0)
1563 /* The ID of the mode line highlighting face. */
1564 #define GLYPH_MODE_LINE_FACE 1
1566 /* Data type checking */
1568 #define NILP(x) EQ (x, Qnil)
1570 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1571 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1573 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1574 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1575 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1576 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1577 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1578 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1580 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1581 #define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1582 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1583 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1584 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1586 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1587 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1588 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1589 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1590 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1592 /* True if object X is a pseudovector whose code is CODE. */
1593 #define PSEUDOVECTORP(x, code) \
1594 (VECTORLIKEP (x) \
1595 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1596 == (PSEUDOVECTOR_FLAG | (code))))
1598 /* Test for specific pseudovector types. */
1599 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1600 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1601 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1602 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1603 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1604 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1605 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1606 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1607 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1608 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1609 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1611 /* Test for image (image . spec) */
1612 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1614 /* Array types. */
1616 #define ARRAYP(x) \
1617 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1619 #define CHECK_LIST(x) \
1620 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1622 #define CHECK_LIST_CONS(x, y) \
1623 CHECK_TYPE (CONSP (x), Qlistp, y)
1625 #define CHECK_LIST_END(x, y) \
1626 CHECK_TYPE (NILP (x), Qlistp, y)
1628 #define CHECK_STRING(x) \
1629 CHECK_TYPE (STRINGP (x), Qstringp, x)
1631 #define CHECK_STRING_CAR(x) \
1632 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1634 #define CHECK_CONS(x) \
1635 CHECK_TYPE (CONSP (x), Qconsp, x)
1637 #define CHECK_SYMBOL(x) \
1638 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1640 #define CHECK_CHAR_TABLE(x) \
1641 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1643 #define CHECK_VECTOR(x) \
1644 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1646 #define CHECK_VECTOR_OR_STRING(x) \
1647 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1649 #define CHECK_ARRAY(x, Qxxxp) \
1650 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1652 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1653 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1655 #define CHECK_BUFFER(x) \
1656 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1658 #define CHECK_WINDOW(x) \
1659 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1661 #define CHECK_WINDOW_CONFIGURATION(x) \
1662 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1664 /* This macro rejects windows on the interior of the window tree as
1665 "dead", which is what we want; this is an argument-checking macro, and
1666 the user should never get access to interior windows.
1668 A window of any sort, leaf or interior, is dead if the buffer,
1669 vchild, and hchild members are all nil. */
1671 #define CHECK_LIVE_WINDOW(x) \
1672 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1674 #define CHECK_PROCESS(x) \
1675 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1677 #define CHECK_SUBR(x) \
1678 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1680 #define CHECK_NUMBER(x) \
1681 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1683 #define CHECK_NATNUM(x) \
1684 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1686 #define CHECK_MARKER(x) \
1687 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1689 #define CHECK_NUMBER_COERCE_MARKER(x) \
1690 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1691 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1693 #define XFLOATINT(n) extract_float((n))
1695 #define CHECK_FLOAT(x) \
1696 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1698 #define CHECK_NUMBER_OR_FLOAT(x) \
1699 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1701 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1702 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1703 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1705 #define CHECK_OVERLAY(x) \
1706 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1708 /* Since we can't assign directly to the CAR or CDR fields of a cons
1709 cell, use these when checking that those fields contain numbers. */
1710 #define CHECK_NUMBER_CAR(x) \
1711 do { \
1712 Lisp_Object tmp = XCAR (x); \
1713 CHECK_NUMBER (tmp); \
1714 XSETCAR ((x), tmp); \
1715 } while (0)
1717 #define CHECK_NUMBER_CDR(x) \
1718 do { \
1719 Lisp_Object tmp = XCDR (x); \
1720 CHECK_NUMBER (tmp); \
1721 XSETCDR ((x), tmp); \
1722 } while (0)
1724 #define CHECK_NATNUM_CAR(x) \
1725 do { \
1726 Lisp_Object tmp = XCAR (x); \
1727 CHECK_NATNUM (tmp); \
1728 XSETCAR ((x), tmp); \
1729 } while (0)
1731 #define CHECK_NATNUM_CDR(x) \
1732 do { \
1733 Lisp_Object tmp = XCDR (x); \
1734 CHECK_NATNUM (tmp); \
1735 XSETCDR ((x), tmp); \
1736 } while (0)
1738 /* Cast pointers to this type to compare them. Some machines want int. */
1739 #define PNTR_COMPARISON_TYPE EMACS_UINT
1741 /* Define a built-in function for calling from Lisp.
1742 `lname' should be the name to give the function in Lisp,
1743 as a null-terminated C string.
1744 `fnname' should be the name of the function in C.
1745 By convention, it starts with F.
1746 `sname' should be the name for the C constant structure
1747 that records information on this function for internal use.
1748 By convention, it should be the same as `fnname' but with S instead of F.
1749 It's too bad that C macros can't compute this from `fnname'.
1750 `minargs' should be a number, the minimum number of arguments allowed.
1751 `maxargs' should be a number, the maximum number of arguments allowed,
1752 or else MANY or UNEVALLED.
1753 MANY means pass a vector of evaluated arguments,
1754 in the form of an integer number-of-arguments
1755 followed by the address of a vector of Lisp_Objects
1756 which contains the argument values.
1757 UNEVALLED means pass the list of unevaluated arguments
1758 `intspec' says how interactive arguments are to be fetched.
1759 If the string starts with a `(', `intspec' is evaluated and the resulting
1760 list is the list of arguments.
1761 If it's a string that doesn't start with `(', the value should follow
1762 the one of the doc string for `interactive'.
1763 A null string means call interactively with no arguments.
1764 `doc' is documentation for the user. */
1766 /* This version of DEFUN declares a function prototype with the right
1767 arguments, so we can catch errors with maxargs at compile-time. */
1768 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1769 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1770 DECL_ALIGN (struct Lisp_Subr, sname) = \
1771 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1772 { .a ## maxargs = fnname }, \
1773 minargs, maxargs, lname, intspec, 0}; \
1774 Lisp_Object fnname
1776 /* Note that the weird token-substitution semantics of ANSI C makes
1777 this work for MANY and UNEVALLED. */
1778 #define DEFUN_ARGS_MANY (int, Lisp_Object *)
1779 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1780 #define DEFUN_ARGS_0 (void)
1781 #define DEFUN_ARGS_1 (Lisp_Object)
1782 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1783 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1784 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1785 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1786 Lisp_Object)
1787 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1788 Lisp_Object, Lisp_Object)
1789 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1790 Lisp_Object, Lisp_Object, Lisp_Object)
1791 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1792 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1794 /* Non-zero if OBJ is a Lisp function. */
1795 #define FUNCTIONP(OBJ) \
1796 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1797 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1798 || COMPILEDP (OBJ) \
1799 || SUBRP (OBJ))
1801 /* defsubr (Sname);
1802 is how we define the symbol for function `name' at start-up time. */
1803 extern void defsubr (struct Lisp_Subr *);
1805 #define MANY -2
1806 #define UNEVALLED -1
1808 extern void defvar_lisp (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1809 extern void defvar_lisp_nopro (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1810 extern void defvar_bool (struct Lisp_Boolfwd *, const char *, int *);
1811 extern void defvar_int (struct Lisp_Intfwd *, const char *, EMACS_INT *);
1812 extern void defvar_kboard (struct Lisp_Kboard_Objfwd *, const char *, int);
1814 /* Macros we use to define forwarded Lisp variables.
1815 These are used in the syms_of_FILENAME functions. */
1817 #define DEFVAR_LISP(lname, vname, doc) \
1818 do { \
1819 static struct Lisp_Objfwd o_fwd; \
1820 defvar_lisp (&o_fwd, lname, vname); \
1821 } while (0)
1822 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1823 do { \
1824 static struct Lisp_Objfwd o_fwd; \
1825 defvar_lisp_nopro (&o_fwd, lname, vname); \
1826 } while (0)
1827 #define DEFVAR_BOOL(lname, vname, doc) \
1828 do { \
1829 static struct Lisp_Boolfwd b_fwd; \
1830 defvar_bool (&b_fwd, lname, vname); \
1831 } while (0)
1832 #define DEFVAR_INT(lname, vname, doc) \
1833 do { \
1834 static struct Lisp_Intfwd i_fwd; \
1835 defvar_int (&i_fwd, lname, vname); \
1836 } while (0)
1838 #define DEFVAR_KBOARD(lname, vname, doc) \
1839 do { \
1840 static struct Lisp_Kboard_Objfwd ko_fwd; \
1841 defvar_kboard (&ko_fwd, \
1842 lname, \
1843 (int)((char *)(&current_kboard->vname) \
1844 - (char *)current_kboard)); \
1845 } while (0)
1849 /* Structure for recording Lisp call stack for backtrace purposes. */
1851 /* The special binding stack holds the outer values of variables while
1852 they are bound by a function application or a let form, stores the
1853 code to be executed for Lisp unwind-protect forms, and stores the C
1854 functions to be called for record_unwind_protect.
1856 If func is non-zero, undoing this binding applies func to old_value;
1857 This implements record_unwind_protect.
1859 Otherwise, the element is a variable binding.
1861 If the symbol field is a symbol, it is an ordinary variable binding.
1863 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
1864 which means having bound a local value while CURRENT-BUFFER was active.
1865 If WHERE is nil this means we saw the default value when binding SYMBOL.
1866 WHERE being a buffer or frame means we saw a buffer-local or frame-local
1867 value. Other values of WHERE mean an internal error. */
1869 typedef Lisp_Object (*specbinding_func) (Lisp_Object);
1871 struct specbinding
1873 Lisp_Object symbol, old_value;
1874 specbinding_func func;
1875 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
1878 extern struct specbinding *specpdl;
1879 extern struct specbinding *specpdl_ptr;
1880 extern int specpdl_size;
1882 extern EMACS_INT max_specpdl_size;
1884 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
1886 /* Everything needed to describe an active condition case. */
1887 struct handler
1889 /* The handler clauses and variable from the condition-case form. */
1890 /* For a handler set up in Lisp code, this is always a list.
1891 For an internal handler set up by internal_condition_case*,
1892 this can instead be the symbol t or `error'.
1893 t: handle all conditions.
1894 error: handle all conditions, and errors can run the debugger
1895 or display a backtrace. */
1896 Lisp_Object handler;
1897 Lisp_Object var;
1898 /* Fsignal stores here the condition-case clause that applies,
1899 and Fcondition_case thus knows which clause to run. */
1900 Lisp_Object chosen_clause;
1902 /* Used to effect the longjump out to the handler. */
1903 struct catchtag *tag;
1905 /* The next enclosing handler. */
1906 struct handler *next;
1909 extern struct handler *handlerlist;
1911 /* This structure helps implement the `catch' and `throw' control
1912 structure. A struct catchtag contains all the information needed
1913 to restore the state of the interpreter after a non-local jump.
1915 Handlers for error conditions (represented by `struct handler'
1916 structures) just point to a catch tag to do the cleanup required
1917 for their jumps.
1919 catchtag structures are chained together in the C calling stack;
1920 the `next' member points to the next outer catchtag.
1922 A call like (throw TAG VAL) searches for a catchtag whose `tag'
1923 member is TAG, and then unbinds to it. The `val' member is used to
1924 hold VAL while the stack is unwound; `val' is returned as the value
1925 of the catch form.
1927 All the other members are concerned with restoring the interpreter
1928 state. */
1930 struct catchtag
1932 Lisp_Object tag;
1933 Lisp_Object val;
1934 struct catchtag *next;
1935 struct gcpro *gcpro;
1936 jmp_buf jmp;
1937 struct backtrace *backlist;
1938 struct handler *handlerlist;
1939 int lisp_eval_depth;
1940 int pdlcount;
1941 int poll_suppress_count;
1942 int interrupt_input_blocked;
1943 struct byte_stack *byte_stack;
1946 extern struct catchtag *catchlist;
1947 extern struct backtrace *backtrace_list;
1949 extern Lisp_Object memory_signal_data;
1951 /* An address near the bottom of the stack.
1952 Tells GC how to save a copy of the stack. */
1953 extern char *stack_bottom;
1955 /* Check quit-flag and quit if it is non-nil.
1956 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
1957 So the program needs to do QUIT at times when it is safe to quit.
1958 Every loop that might run for a long time or might not exit
1959 ought to do QUIT at least once, at a safe place.
1960 Unless that is impossible, of course.
1961 But it is very desirable to avoid creating loops where QUIT is impossible.
1963 Exception: if you set immediate_quit to nonzero,
1964 then the handler that responds to the C-g does the quit itself.
1965 This is a good thing to do around a loop that has no side effects
1966 and (in particular) cannot call arbitrary Lisp code. */
1968 #ifdef SYNC_INPUT
1969 extern void process_pending_signals (void);
1970 extern int pending_signals;
1971 #define ELSE_PENDING_SIGNALS \
1972 else if (pending_signals) \
1973 process_pending_signals ();
1974 #else /* not SYNC_INPUT */
1975 #define ELSE_PENDING_SIGNALS
1976 #endif /* not SYNC_INPUT */
1978 #define QUIT \
1979 do { \
1980 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1982 Lisp_Object flag = Vquit_flag; \
1983 Vquit_flag = Qnil; \
1984 if (EQ (Vthrow_on_input, flag)) \
1985 Fthrow (Vthrow_on_input, Qt); \
1986 Fsignal (Qquit, Qnil); \
1988 ELSE_PENDING_SIGNALS \
1989 } while (0)
1992 /* Nonzero if ought to quit now. */
1994 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
1996 /* Variables used locally in the following case handling macros. */
1997 extern int case_temp1;
1998 extern Lisp_Object case_temp2;
2000 /* Current buffer's map from characters to lower-case characters. */
2002 #define DOWNCASE_TABLE current_buffer->downcase_table
2004 /* Current buffer's map from characters to upper-case characters. */
2006 #define UPCASE_TABLE current_buffer->upcase_table
2008 /* Downcase a character, or make no change if that cannot be done. */
2010 #define DOWNCASE(CH) \
2011 ((case_temp1 = (CH), \
2012 case_temp2 = CHAR_TABLE_REF (DOWNCASE_TABLE, case_temp1), \
2013 NATNUMP (case_temp2)) \
2014 ? XFASTINT (case_temp2) : case_temp1)
2016 /* 1 if CH is upper case. */
2018 #define UPPERCASEP(CH) (DOWNCASE (CH) != (CH))
2020 /* 1 if CH is neither upper nor lower case. */
2022 #define NOCASEP(CH) (UPCASE1 (CH) == (CH))
2024 /* 1 if CH is lower case. */
2026 #define LOWERCASEP(CH) (!UPPERCASEP (CH) && !NOCASEP(CH))
2028 /* Upcase a character, or make no change if that cannot be done. */
2030 #define UPCASE(CH) (!UPPERCASEP (CH) ? UPCASE1 (CH) : (CH))
2032 /* Upcase a character known to be not upper case. */
2034 #define UPCASE1(CH) \
2035 ((case_temp1 = (CH), \
2036 case_temp2 = CHAR_TABLE_REF (UPCASE_TABLE, case_temp1), \
2037 NATNUMP (case_temp2)) \
2038 ? XFASTINT (case_temp2) : case_temp1)
2040 extern Lisp_Object Vascii_downcase_table, Vascii_upcase_table;
2041 extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
2043 /* Number of bytes of structure consed since last GC. */
2045 extern int consing_since_gc;
2047 /* Thresholds for doing another gc. */
2049 extern EMACS_INT gc_cons_threshold;
2051 extern EMACS_INT gc_relative_threshold;
2053 extern EMACS_INT memory_full_cons_threshold;
2055 /* Structure for recording stack slots that need marking. */
2057 /* This is a chain of structures, each of which points at a Lisp_Object
2058 variable whose value should be marked in garbage collection.
2059 Normally every link of the chain is an automatic variable of a function,
2060 and its `val' points to some argument or local variable of the function.
2061 On exit to the function, the chain is set back to the value it had on entry.
2062 This way, no link remains in the chain when the stack frame containing the
2063 link disappears.
2065 Every function that can call Feval must protect in this fashion all
2066 Lisp_Object variables whose contents will be used again. */
2068 extern struct gcpro *gcprolist;
2070 struct gcpro
2072 struct gcpro *next;
2074 /* Address of first protected variable. */
2075 volatile Lisp_Object *var;
2077 /* Number of consecutive protected variables. */
2078 int nvars;
2080 #ifdef DEBUG_GCPRO
2081 int level;
2082 #endif
2085 /* Values of GC_MARK_STACK during compilation:
2087 0 Use GCPRO as before
2088 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2089 2 Mark the stack, and check that everything GCPRO'd is
2090 marked.
2091 3 Mark using GCPRO's, mark stack last, and count how many
2092 dead objects are kept alive. */
2095 #define GC_USE_GCPROS_AS_BEFORE 0
2096 #define GC_MAKE_GCPROS_NOOPS 1
2097 #define GC_MARK_STACK_CHECK_GCPROS 2
2098 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2100 #ifndef GC_MARK_STACK
2101 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
2102 #endif
2104 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2106 /* Do something silly with gcproN vars just so gcc shuts up. */
2107 /* You get warnings from MIPSPro... */
2109 #define GCPRO1(varname) ((void) gcpro1)
2110 #define GCPRO2(varname1, varname2)(((void) gcpro2, (void) gcpro1))
2111 #define GCPRO3(varname1, varname2, varname3) \
2112 (((void) gcpro3, (void) gcpro2, (void) gcpro1))
2113 #define GCPRO4(varname1, varname2, varname3, varname4) \
2114 (((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2115 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2116 (((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2117 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2118 (((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2119 #define UNGCPRO ((void) 0)
2121 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2123 #ifndef DEBUG_GCPRO
2125 #define GCPRO1(varname) \
2126 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2127 gcprolist = &gcpro1; }
2129 #define GCPRO2(varname1, varname2) \
2130 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2131 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2132 gcprolist = &gcpro2; }
2134 #define GCPRO3(varname1, varname2, varname3) \
2135 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2136 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2137 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2138 gcprolist = &gcpro3; }
2140 #define GCPRO4(varname1, varname2, varname3, varname4) \
2141 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2142 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2143 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2144 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2145 gcprolist = &gcpro4; }
2147 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2148 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2149 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2150 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2151 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2152 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2153 gcprolist = &gcpro5; }
2155 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2156 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2157 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2158 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2159 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2160 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2161 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2162 gcprolist = &gcpro6; }
2164 #define UNGCPRO (gcprolist = gcpro1.next)
2166 #else
2168 extern int gcpro_level;
2170 #define GCPRO1(varname) \
2171 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2172 gcpro1.level = gcpro_level++; \
2173 gcprolist = &gcpro1; }
2175 #define GCPRO2(varname1, varname2) \
2176 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2177 gcpro1.level = gcpro_level; \
2178 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2179 gcpro2.level = gcpro_level++; \
2180 gcprolist = &gcpro2; }
2182 #define GCPRO3(varname1, varname2, varname3) \
2183 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2184 gcpro1.level = gcpro_level; \
2185 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2186 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2187 gcpro3.level = gcpro_level++; \
2188 gcprolist = &gcpro3; }
2190 #define GCPRO4(varname1, varname2, varname3, varname4) \
2191 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2192 gcpro1.level = gcpro_level; \
2193 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2194 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2195 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2196 gcpro4.level = gcpro_level++; \
2197 gcprolist = &gcpro4; }
2199 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2200 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2201 gcpro1.level = gcpro_level; \
2202 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2203 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2204 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2205 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2206 gcpro5.level = gcpro_level++; \
2207 gcprolist = &gcpro5; }
2209 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2210 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2211 gcpro1.level = gcpro_level; \
2212 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2213 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2214 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2215 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2216 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2217 gcpro6.level = gcpro_level++; \
2218 gcprolist = &gcpro6; }
2220 #define UNGCPRO \
2221 ((--gcpro_level != gcpro1.level) \
2222 ? (abort (), 0) \
2223 : ((gcprolist = gcpro1.next), 0))
2225 #endif /* DEBUG_GCPRO */
2226 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2229 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2230 #define RETURN_UNGCPRO(expr) \
2231 do \
2233 Lisp_Object ret_ungc_val; \
2234 ret_ungc_val = (expr); \
2235 UNGCPRO; \
2236 return ret_ungc_val; \
2238 while (0)
2240 /* Call staticpro (&var) to protect static variable `var'. */
2242 void staticpro (Lisp_Object *);
2244 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2245 meaning as in the DEFUN macro, and is used to construct a prototype. */
2246 /* We can use the same trick as in the DEFUN macro to generate the
2247 appropriate prototype. */
2248 #define EXFUN(fnname, maxargs) \
2249 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2251 /* Forward declarations for prototypes. */
2252 struct window;
2253 struct frame;
2255 /* Defined in data.c */
2256 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
2257 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
2258 extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
2259 extern Lisp_Object Qvoid_variable, Qvoid_function;
2260 extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
2261 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
2262 extern Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
2263 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
2264 extern Lisp_Object Qtext_read_only;
2265 extern Lisp_Object Qinteractive_form;
2266 extern Lisp_Object Qcircular_list;
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 (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 (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 (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 long_to_cons (unsigned long);
2375 extern unsigned long cons_to_long (Lisp_Object);
2376 extern void args_out_of_range (Lisp_Object, Lisp_Object) NO_RETURN;
2377 extern void args_out_of_range_3 (Lisp_Object, Lisp_Object,
2378 Lisp_Object) NO_RETURN;
2379 extern Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object) NO_RETURN;
2380 extern Lisp_Object do_symval_forwarding (union Lisp_Fwd *);
2381 extern void set_internal (Lisp_Object, Lisp_Object, Lisp_Object, int);
2382 extern void syms_of_data (void);
2383 extern void init_data (void);
2384 extern void swap_in_global_binding (struct Lisp_Symbol *);
2386 /* Defined in cmds.c */
2387 EXFUN (Fend_of_line, 1);
2388 EXFUN (Fforward_char, 1);
2389 EXFUN (Fforward_line, 1);
2390 extern void syms_of_cmds (void);
2391 extern void keys_of_cmds (void);
2393 /* Defined in coding.c */
2394 EXFUN (Fcoding_system_p, 1);
2395 EXFUN (Fcoding_system_base, 1);
2396 EXFUN (Fcoding_system_eol_type, 1);
2397 EXFUN (Fcheck_coding_system, 1);
2398 EXFUN (Fread_coding_system, 2);
2399 EXFUN (Fread_non_nil_coding_system, 1);
2400 EXFUN (Ffind_operation_coding_system, MANY);
2401 EXFUN (Fupdate_coding_systems_internal, 0);
2402 EXFUN (Fencode_coding_string, 4);
2403 EXFUN (Fdecode_coding_string, 4);
2404 extern Lisp_Object detect_coding_system (const unsigned char *, EMACS_INT,
2405 EMACS_INT, int, int, Lisp_Object);
2406 extern void init_coding (void);
2407 extern void init_coding_once (void);
2408 extern void syms_of_coding (void);
2410 /* Defined in character.c */
2411 extern void init_character_once (void);
2412 extern void syms_of_character (void);
2413 EXFUN (Funibyte_char_to_multibyte, 1);
2415 /* Defined in charset.c */
2416 EXFUN (Fchar_bytes, 1);
2417 EXFUN (Fchar_width, 1);
2418 EXFUN (Fstring, MANY);
2419 extern EMACS_INT chars_in_text (const unsigned char *, EMACS_INT);
2420 extern EMACS_INT multibyte_chars_in_text (const unsigned char *, EMACS_INT);
2421 extern int multibyte_char_to_unibyte (int, Lisp_Object);
2422 extern int multibyte_char_to_unibyte_safe (int);
2423 extern Lisp_Object Qcharset;
2424 extern void init_charset (void);
2425 extern void init_charset_once (void);
2426 extern void syms_of_charset (void);
2427 /* Structure forward declarations. */
2428 struct charset;
2430 /* Defined in composite.c */
2431 extern void syms_of_composite (void);
2433 /* Defined in syntax.c */
2434 EXFUN (Fforward_word, 1);
2435 EXFUN (Fskip_chars_forward, 2);
2436 EXFUN (Fskip_chars_backward, 2);
2437 EXFUN (Fsyntax_table_p, 1);
2438 EXFUN (Fsyntax_table, 0);
2439 EXFUN (Fset_syntax_table, 1);
2440 extern void init_syntax_once (void);
2441 extern void syms_of_syntax (void);
2443 /* Defined in fns.c */
2444 extern Lisp_Object QCrehash_size, QCrehash_threshold;
2445 extern int use_dialog_box;
2446 extern int use_file_dialog;
2447 extern int next_almost_prime (int);
2448 extern Lisp_Object larger_vector (Lisp_Object, int, Lisp_Object);
2449 extern void sweep_weak_hash_tables (void);
2450 extern Lisp_Object Qcursor_in_echo_area;
2451 extern Lisp_Object Qstring_lessp;
2452 extern Lisp_Object Vfeatures;
2453 extern Lisp_Object QCsize, QCtest, QCweakness, Qequal, Qeq, Qeql;
2454 unsigned sxhash (Lisp_Object, int);
2455 Lisp_Object make_hash_table (Lisp_Object, Lisp_Object, Lisp_Object,
2456 Lisp_Object, Lisp_Object, Lisp_Object,
2457 Lisp_Object);
2458 Lisp_Object copy_hash_table (struct Lisp_Hash_Table *);
2459 int hash_lookup (struct Lisp_Hash_Table *, Lisp_Object, unsigned *);
2460 int hash_put (struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
2461 unsigned);
2462 void hash_clear (struct Lisp_Hash_Table *);
2463 void init_weak_hash_tables (void);
2464 extern void init_fns (void);
2465 EXFUN (Fsxhash, 1);
2466 EXFUN (Fmake_hash_table, MANY);
2467 EXFUN (Fmakehash, 1);
2468 EXFUN (Fcopy_hash_table, 1);
2469 EXFUN (Fhash_table_count, 1);
2470 EXFUN (Fhash_table_rehash_size, 1);
2471 EXFUN (Fhash_table_rehash_threshold, 1);
2472 EXFUN (Fhash_table_size, 1);
2473 EXFUN (Fhash_table_test, 1);
2474 EXFUN (Fhash_table_weak, 1);
2475 EXFUN (Fhash_table_p, 1);
2476 EXFUN (Fclrhash, 1);
2477 EXFUN (Fgethash, 3);
2478 EXFUN (Fputhash, 3);
2479 EXFUN (Fremhash, 2);
2480 EXFUN (Fmaphash, 2);
2481 EXFUN (Fdefine_hash_table_test, 3);
2483 EXFUN (Fidentity, 1);
2484 EXFUN (Frandom, 1);
2485 EXFUN (Flength, 1);
2486 EXFUN (Fsafe_length, 1);
2487 EXFUN (Fappend, MANY);
2488 EXFUN (Fconcat, MANY);
2489 EXFUN (Fvconcat, MANY);
2490 EXFUN (Fcopy_sequence, 1);
2491 EXFUN (Fstring_make_multibyte, 1);
2492 EXFUN (Fstring_make_unibyte, 1);
2493 EXFUN (Fstring_as_multibyte, 1);
2494 EXFUN (Fstring_as_unibyte, 1);
2495 EXFUN (Fstring_to_multibyte, 1);
2496 EXFUN (Fstring_to_unibyte, 1);
2497 EXFUN (Fsubstring, 3);
2498 extern Lisp_Object substring_both (Lisp_Object, int, int, int, int);
2499 EXFUN (Fnth, 2);
2500 EXFUN (Fnthcdr, 2);
2501 EXFUN (Fmemq, 2);
2502 EXFUN (Fassq, 2);
2503 EXFUN (Fassoc, 2);
2504 EXFUN (Felt, 2);
2505 EXFUN (Fmember, 2);
2506 EXFUN (Frassq, 2);
2507 EXFUN (Fdelq, 2);
2508 EXFUN (Fdelete, 2);
2509 EXFUN (Fsort, 2);
2510 EXFUN (Freverse, 1);
2511 EXFUN (Fnreverse, 1);
2512 EXFUN (Fget, 2);
2513 EXFUN (Fput, 3);
2514 EXFUN (Fequal, 2);
2515 EXFUN (Ffillarray, 2);
2516 EXFUN (Fnconc, MANY);
2517 EXFUN (Fmapcar, 2);
2518 EXFUN (Fmapconcat, 3);
2519 EXFUN (Fy_or_n_p, 1);
2520 extern Lisp_Object do_yes_or_no_p (Lisp_Object);
2521 EXFUN (Frequire, 3);
2522 EXFUN (Fprovide, 2);
2523 extern Lisp_Object concat2 (Lisp_Object, Lisp_Object);
2524 extern Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2525 extern Lisp_Object nconc2 (Lisp_Object, Lisp_Object);
2526 extern Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object);
2527 extern Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object);
2528 extern void clear_string_char_byte_cache (void);
2529 extern EMACS_INT string_char_to_byte (Lisp_Object, EMACS_INT);
2530 extern EMACS_INT string_byte_to_char (Lisp_Object, EMACS_INT);
2531 extern Lisp_Object string_make_multibyte (Lisp_Object);
2532 extern Lisp_Object string_to_multibyte (Lisp_Object);
2533 extern Lisp_Object string_make_unibyte (Lisp_Object);
2534 EXFUN (Fcopy_alist, 1);
2535 EXFUN (Fplist_get, 2);
2536 EXFUN (Fplist_put, 3);
2537 EXFUN (Fplist_member, 2);
2538 EXFUN (Frassoc, 2);
2539 EXFUN (Fstring_equal, 2);
2540 EXFUN (Fcompare_strings, 7);
2541 EXFUN (Fstring_lessp, 2);
2542 extern void syms_of_fns (void);
2544 /* Defined in floatfns.c */
2545 extern double extract_float (Lisp_Object);
2546 EXFUN (Ffloat, 1);
2547 EXFUN (Ftruncate, 2);
2548 extern void init_floatfns (void);
2549 extern void syms_of_floatfns (void);
2550 extern Lisp_Object fmod_float (Lisp_Object x, Lisp_Object y);
2552 /* Defined in fringe.c */
2553 extern void syms_of_fringe (void);
2554 extern void init_fringe (void);
2555 extern void init_fringe_once (void);
2557 /* Defined in image.c */
2558 extern Lisp_Object QCascent, QCmargin, QCrelief, Qcount, Qextension_data;
2559 extern Lisp_Object QCconversion, QCcolor_symbols, QCheuristic_mask;
2560 extern Lisp_Object QCindex, QCmatrix, QCcolor_adjustment, QCmask;
2561 EXFUN (Finit_image_library, 2);
2562 extern void syms_of_image (void);
2563 extern void init_image (void);
2565 /* Defined in insdel.c */
2566 extern Lisp_Object Qinhibit_modification_hooks;
2567 extern void move_gap (EMACS_INT);
2568 extern void move_gap_both (EMACS_INT, EMACS_INT);
2569 extern void make_gap (EMACS_INT);
2570 extern EMACS_INT copy_text (const unsigned char *, unsigned char *,
2571 EMACS_INT, int, int);
2572 extern EMACS_INT count_size_as_multibyte (const unsigned char *, EMACS_INT);
2573 extern int count_combining_before (const unsigned char *,
2574 EMACS_INT, EMACS_INT, EMACS_INT);
2575 extern int count_combining_after (const unsigned char *,
2576 EMACS_INT, EMACS_INT, EMACS_INT);
2577 extern void insert (const unsigned char *, EMACS_INT);
2578 extern void insert_and_inherit (const unsigned char *, EMACS_INT);
2579 extern void insert_1 (const unsigned char *, EMACS_INT, int, int, int);
2580 extern void insert_1_both (const unsigned char *, EMACS_INT, EMACS_INT,
2581 int, int, int);
2582 extern void insert_from_gap (EMACS_INT, EMACS_INT);
2583 extern void insert_from_string (Lisp_Object, EMACS_INT, EMACS_INT,
2584 EMACS_INT, EMACS_INT, int);
2585 extern void insert_from_buffer (struct buffer *, EMACS_INT, EMACS_INT, int);
2586 extern void insert_char (int);
2587 extern void insert_string (const char *);
2588 extern void insert_before_markers (const unsigned char *, EMACS_INT);
2589 extern void insert_before_markers_and_inherit (const unsigned char *,
2590 EMACS_INT);
2591 extern void insert_from_string_before_markers (Lisp_Object, EMACS_INT,
2592 EMACS_INT, EMACS_INT,
2593 EMACS_INT, int);
2594 extern void del_range (EMACS_INT, EMACS_INT);
2595 extern Lisp_Object del_range_1 (EMACS_INT, EMACS_INT, int, int);
2596 extern void del_range_byte (EMACS_INT, EMACS_INT, int);
2597 extern void del_range_both (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT, int);
2598 extern Lisp_Object del_range_2 (EMACS_INT, EMACS_INT,
2599 EMACS_INT, EMACS_INT, int);
2600 extern void modify_region (struct buffer *, EMACS_INT, EMACS_INT, int);
2601 extern void prepare_to_modify_buffer (EMACS_INT, EMACS_INT, EMACS_INT *);
2602 extern void signal_before_change (EMACS_INT, EMACS_INT, EMACS_INT *);
2603 extern void signal_after_change (EMACS_INT, EMACS_INT, EMACS_INT);
2604 extern void adjust_after_replace (EMACS_INT, EMACS_INT, Lisp_Object,
2605 EMACS_INT, EMACS_INT);
2606 extern void adjust_after_replace_noundo (EMACS_INT, EMACS_INT, EMACS_INT,
2607 EMACS_INT, EMACS_INT, EMACS_INT);
2608 extern void adjust_after_insert (EMACS_INT, EMACS_INT, EMACS_INT,
2609 EMACS_INT, EMACS_INT);
2610 extern void adjust_markers_for_delete (EMACS_INT, EMACS_INT,
2611 EMACS_INT, EMACS_INT);
2612 extern void replace_range (EMACS_INT, EMACS_INT, Lisp_Object, int, int, int);
2613 extern void replace_range_2 (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
2614 const char *, EMACS_INT, EMACS_INT, int);
2615 extern void syms_of_insdel (void);
2617 /* Defined in dispnew.c */
2618 extern Lisp_Object selected_frame;
2619 extern Lisp_Object Vwindow_system_version;
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 (Lisp_Object, int, int);
2627 extern void init_display (void);
2628 extern void syms_of_display (void);
2630 /* Defined in xdisp.c */
2631 extern Lisp_Object Qinhibit_point_motion_hooks;
2632 extern Lisp_Object Qinhibit_redisplay, Qdisplay;
2633 extern Lisp_Object Qinhibit_eval_during_redisplay;
2634 extern Lisp_Object Qmessage_truncate_lines;
2635 extern Lisp_Object Qmenu_bar_update_hook;
2636 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
2637 extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
2638 extern Lisp_Object Qimage, Qtext, Qboth, Qboth_horiz, Qtext_image_horiz;
2639 extern Lisp_Object Qspace, Qcenter, QCalign_to;
2640 extern Lisp_Object Qbar, Qhbar, Qbox, Qhollow;
2641 extern Lisp_Object Qleft_margin, Qright_margin;
2642 extern Lisp_Object Vmessage_log_max;
2643 extern Lisp_Object QCdata, QCfile;
2644 extern Lisp_Object QCmap;
2645 extern Lisp_Object Qrisky_local_variable;
2646 extern Lisp_Object Vinhibit_redisplay;
2647 extern int message_enable_multibyte;
2648 extern int noninteractive_need_newline;
2649 extern EMACS_INT scroll_margin;
2650 extern Lisp_Object echo_area_buffer[2];
2651 extern void add_to_log (const char *, Lisp_Object, Lisp_Object);
2652 extern void check_message_stack (void);
2653 extern void setup_echo_area_for_printing (int);
2654 extern int push_message (void);
2655 extern Lisp_Object pop_message_unwind (Lisp_Object);
2656 extern Lisp_Object restore_message_unwind (Lisp_Object);
2657 extern void pop_message (void);
2658 extern void restore_message (void);
2659 extern Lisp_Object current_message (void);
2660 extern void set_message (const char *s, Lisp_Object, int, int);
2661 extern void clear_message (int, int);
2662 extern void message (const char *, ...);
2663 extern void message_nolog (const char *, ...);
2664 extern void message1 (const char *);
2665 extern void message1_nolog (const char *);
2666 extern void message2 (const char *, int, int);
2667 extern void message2_nolog (const char *, int, int);
2668 extern void message3 (Lisp_Object, int, int);
2669 extern void message3_nolog (Lisp_Object, int, int);
2670 extern void message_dolog (const char *, int, int, int);
2671 extern void message_with_string (const char *, Lisp_Object, int);
2672 extern void message_log_maybe_newline (void);
2673 extern void update_echo_area (void);
2674 extern void truncate_echo_area (int);
2675 extern void redisplay (void);
2676 extern int check_point_in_composition
2677 (struct buffer *, int, struct buffer *, int);
2678 extern void redisplay_preserve_echo_area (int);
2679 extern void prepare_menu_bars (void);
2681 void set_frame_cursor_types (struct frame *, Lisp_Object);
2682 extern void syms_of_xdisp (void);
2683 extern void init_xdisp (void);
2684 extern Lisp_Object safe_eval (Lisp_Object);
2685 extern int pos_visible_p (struct window *, int, int *,
2686 int *, int *, int *, int *, int *);
2688 /* Defined in xsettings.c */
2689 extern void syms_of_xsettings (void);
2691 /* Defined in vm-limit.c. */
2692 extern void memory_warnings (POINTER_TYPE *, void (*warnfun) (const char *));
2694 /* Defined in alloc.c */
2695 extern void check_pure_size (void);
2696 extern void allocate_string_data (struct Lisp_String *, int, int);
2697 extern void reset_malloc_hooks (void);
2698 extern void uninterrupt_malloc (void);
2699 extern void malloc_warning (const char *);
2700 extern void memory_full (void) NO_RETURN;
2701 extern void buffer_memory_full (void) NO_RETURN;
2702 extern int survives_gc_p (Lisp_Object);
2703 extern void mark_object (Lisp_Object);
2704 extern Lisp_Object Vpurify_flag;
2705 extern Lisp_Object Vmemory_full;
2706 extern Lisp_Object *stack_base;
2707 EXFUN (Fcons, 2);
2708 EXFUN (list1, 1);
2709 EXFUN (list2, 2);
2710 EXFUN (list3, 3);
2711 EXFUN (list4, 4);
2712 EXFUN (list5, 5);
2713 EXFUN (Flist, MANY);
2714 EXFUN (Fmake_list, 2);
2715 extern Lisp_Object allocate_misc (void);
2716 EXFUN (Fmake_vector, 2);
2717 EXFUN (Fvector, MANY);
2718 EXFUN (Fmake_symbol, 1);
2719 EXFUN (Fmake_marker, 0);
2720 EXFUN (Fmake_string, 2);
2721 extern Lisp_Object build_string (const char *);
2722 extern Lisp_Object make_string (const char *, int);
2723 extern Lisp_Object make_unibyte_string (const char *, int);
2724 extern Lisp_Object make_multibyte_string (const char *, int, int);
2725 extern Lisp_Object make_event_array (int, Lisp_Object *);
2726 extern Lisp_Object make_uninit_string (int);
2727 extern Lisp_Object make_uninit_multibyte_string (int, int);
2728 extern Lisp_Object make_string_from_bytes (const char *, int, int);
2729 extern Lisp_Object make_specified_string (const char *, int, int, int);
2730 EXFUN (Fpurecopy, 1);
2731 extern Lisp_Object make_pure_string (const char *, int, int, int);
2732 extern Lisp_Object make_pure_c_string (const char *data);
2733 extern Lisp_Object pure_cons (Lisp_Object, Lisp_Object);
2734 extern Lisp_Object make_pure_vector (EMACS_INT);
2735 EXFUN (Fgarbage_collect, 0);
2736 EXFUN (Fmake_byte_code, MANY);
2737 EXFUN (Fmake_bool_vector, 2);
2738 extern Lisp_Object Qchar_table_extra_slots;
2739 extern struct Lisp_Vector *allocate_vector (EMACS_INT);
2740 extern struct Lisp_Vector *allocate_pseudovector (int memlen, int lisplen, EMACS_INT tag);
2741 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2742 ((typ*) \
2743 allocate_pseudovector \
2744 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2745 extern struct Lisp_Hash_Table *allocate_hash_table (void);
2746 extern struct window *allocate_window (void);
2747 extern struct frame *allocate_frame (void);
2748 extern struct Lisp_Process *allocate_process (void);
2749 extern struct terminal *allocate_terminal (void);
2750 extern int gc_in_progress;
2751 extern int abort_on_gc;
2752 extern Lisp_Object make_float (double);
2753 extern void display_malloc_warning (void);
2754 extern int inhibit_garbage_collection (void);
2755 extern Lisp_Object make_save_value (void *, int);
2756 extern void free_misc (Lisp_Object);
2757 extern void free_marker (Lisp_Object);
2758 extern void free_cons (struct Lisp_Cons *);
2759 extern void init_alloc_once (void);
2760 extern void init_alloc (void);
2761 extern void syms_of_alloc (void);
2762 extern struct buffer * allocate_buffer (void);
2763 extern int valid_lisp_object_p (Lisp_Object);
2765 /* Defined in chartab.c */
2766 EXFUN (Fmake_char_table, 2);
2767 EXFUN (Fchar_table_parent, 1);
2768 EXFUN (Fset_char_table_parent, 2);
2769 EXFUN (Fchar_table_extra_slot, 2);
2770 EXFUN (Fset_char_table_extra_slot, 3);
2771 EXFUN (Fchar_table_range, 2);
2772 EXFUN (Fset_char_table_range, 3);
2773 EXFUN (Fset_char_table_default, 3);
2774 EXFUN (Foptimize_char_table, 2);
2775 EXFUN (Fmap_char_table, 2);
2776 extern Lisp_Object copy_char_table (Lisp_Object);
2777 extern Lisp_Object sub_char_table_ref (Lisp_Object, int);
2778 extern Lisp_Object char_table_ref (Lisp_Object, int);
2779 extern Lisp_Object char_table_ref_and_range (Lisp_Object, int,
2780 int *, int *);
2781 extern Lisp_Object char_table_set (Lisp_Object, int, Lisp_Object);
2782 extern Lisp_Object char_table_set_range (Lisp_Object, int, int,
2783 Lisp_Object);
2784 extern int char_table_translate (Lisp_Object, int);
2785 extern void map_char_table (void (*) (Lisp_Object, Lisp_Object,
2786 Lisp_Object),
2787 Lisp_Object, Lisp_Object, Lisp_Object);
2788 extern void map_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object),
2789 Lisp_Object, Lisp_Object,
2790 Lisp_Object, struct charset *,
2791 unsigned, unsigned);
2792 extern void syms_of_chartab (void);
2794 /* Defined in print.c */
2795 extern Lisp_Object Vprin1_to_string_buffer;
2796 extern Lisp_Object Vprint_level, Vprint_length;
2797 extern void debug_print (Lisp_Object);
2798 EXFUN (Fprin1, 2);
2799 EXFUN (Fprin1_to_string, 2);
2800 EXFUN (Fprinc, 2);
2801 EXFUN (Fterpri, 1);
2802 EXFUN (Fprint, 2);
2803 EXFUN (Ferror_message_string, 1);
2804 extern Lisp_Object Vstandard_output, Qstandard_output;
2805 extern Lisp_Object Qexternal_debugging_output;
2806 extern void temp_output_buffer_setup (const char *);
2807 extern int print_level, print_escape_newlines;
2808 extern Lisp_Object Qprint_escape_newlines;
2809 extern void write_string (const char *, int);
2810 extern void write_string_1 (const char *, int, Lisp_Object);
2811 extern void print_error_message (Lisp_Object, Lisp_Object, const char *,
2812 Lisp_Object);
2813 extern Lisp_Object internal_with_output_to_temp_buffer
2814 (const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object);
2815 extern void float_to_string (unsigned char *, double);
2816 extern void syms_of_print (void);
2818 /* Defined in doprnt.c */
2819 extern int doprnt (char *, int, const char *, const char *, va_list);
2821 /* Defined in lread.c */
2822 extern Lisp_Object Vafter_load_alist;
2823 extern Lisp_Object Qvariable_documentation, Qstandard_input;
2824 extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
2825 extern Lisp_Object Vobarray, initial_obarray, Vstandard_input;
2826 extern int load_in_progress;
2827 EXFUN (Fread, 1);
2828 EXFUN (Fread_from_string, 3);
2829 EXFUN (Fintern, 2);
2830 EXFUN (Fintern_soft, 2);
2831 EXFUN (Fload, 5);
2832 EXFUN (Fget_load_suffixes, 0);
2833 EXFUN (Fget_file_char, 0);
2834 EXFUN (Fread_char, 3);
2835 EXFUN (Fread_event, 3);
2836 extern Lisp_Object read_filtered_event (int, int, int, int, Lisp_Object);
2837 EXFUN (Feval_region, 4);
2838 extern Lisp_Object check_obarray (Lisp_Object);
2839 extern Lisp_Object intern (const char *);
2840 extern Lisp_Object intern_c_string (const char *);
2841 extern Lisp_Object make_symbol (const char *);
2842 extern Lisp_Object oblookup (Lisp_Object, const char *, int, int);
2843 #define LOADHIST_ATTACH(x) \
2844 do { \
2845 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2846 } while (0)
2847 extern Lisp_Object Vcurrent_load_list;
2848 extern Lisp_Object Vload_history, Vload_suffixes, Vload_file_rep_suffixes;
2849 extern int openp (Lisp_Object, Lisp_Object, Lisp_Object,
2850 Lisp_Object *, Lisp_Object);
2851 extern int isfloat_string (const char *, int);
2852 extern void map_obarray (Lisp_Object, void (*) (Lisp_Object, Lisp_Object),
2853 Lisp_Object);
2854 extern void dir_warning (const char *, Lisp_Object);
2855 extern void close_load_descs (void);
2856 extern void init_obarray (void);
2857 extern void init_lread (void);
2858 extern void syms_of_lread (void);
2860 /* Defined in eval.c */
2861 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
2862 extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
2863 extern Lisp_Object Vautoload_queue;
2864 extern Lisp_Object Vdebug_on_error;
2865 extern Lisp_Object Vsignaling_function;
2866 extern int handling_signal;
2867 extern int debug_on_next_call;
2868 extern int interactive_p (int);
2870 /* To run a normal hook, use the appropriate function from the list below.
2871 The calling convention:
2873 if (!NILP (Vrun_hooks))
2874 call1 (Vrun_hooks, Qmy_funny_hook);
2876 should no longer be used. */
2877 extern Lisp_Object Vrun_hooks;
2878 EXFUN (Frun_hooks, MANY);
2879 EXFUN (Frun_hook_with_args, MANY);
2880 EXFUN (Frun_hook_with_args_until_success, MANY);
2881 EXFUN (Frun_hook_with_args_until_failure, MANY);
2882 extern Lisp_Object run_hook_list_with_args (Lisp_Object, int, Lisp_Object *);
2883 extern void run_hook_with_args_2 (Lisp_Object, Lisp_Object, Lisp_Object);
2884 EXFUN (Fand, UNEVALLED);
2885 EXFUN (For, UNEVALLED);
2886 EXFUN (Fif, UNEVALLED);
2887 EXFUN (Fprogn, UNEVALLED);
2888 EXFUN (Fprog1, UNEVALLED);
2889 EXFUN (Fprog2, UNEVALLED);
2890 EXFUN (Fsetq, UNEVALLED);
2891 EXFUN (Fquote, UNEVALLED);
2892 EXFUN (Fuser_variable_p, 1);
2893 EXFUN (Finteractive_p, 0);
2894 EXFUN (Fdefun, UNEVALLED);
2895 EXFUN (Flet, UNEVALLED);
2896 EXFUN (FletX, UNEVALLED);
2897 EXFUN (Fwhile, UNEVALLED);
2898 EXFUN (Fcatch, UNEVALLED);
2899 EXFUN (Fthrow, 2) NO_RETURN;
2900 EXFUN (Funwind_protect, UNEVALLED);
2901 EXFUN (Fcondition_case, UNEVALLED);
2902 EXFUN (Fsignal, 2);
2903 extern void xsignal (Lisp_Object, Lisp_Object) NO_RETURN;
2904 extern void xsignal0 (Lisp_Object) NO_RETURN;
2905 extern void xsignal1 (Lisp_Object, Lisp_Object) NO_RETURN;
2906 extern void xsignal2 (Lisp_Object, Lisp_Object, Lisp_Object) NO_RETURN;
2907 extern void xsignal3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object) NO_RETURN;
2908 extern void signal_error (const char *, Lisp_Object) NO_RETURN;
2909 EXFUN (Fautoload, 5);
2910 EXFUN (Fcommandp, 2);
2911 EXFUN (Feval, 1);
2912 EXFUN (Fapply, MANY);
2913 EXFUN (Ffuncall, MANY);
2914 EXFUN (Fbacktrace, 0);
2915 extern Lisp_Object apply1 (Lisp_Object, Lisp_Object);
2916 extern Lisp_Object call0 (Lisp_Object);
2917 extern Lisp_Object call1 (Lisp_Object, Lisp_Object);
2918 extern Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2919 extern Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2920 extern Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2921 extern Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2922 extern Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2923 extern Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2924 EXFUN (Fdo_auto_save, 2);
2925 extern Lisp_Object apply_lambda (Lisp_Object, Lisp_Object, int);
2926 extern Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object);
2927 extern Lisp_Object internal_lisp_condition_case (Lisp_Object, Lisp_Object, Lisp_Object);
2928 extern Lisp_Object internal_condition_case (Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object));
2929 extern Lisp_Object internal_condition_case_1 (Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
2930 extern Lisp_Object internal_condition_case_2 (Lisp_Object (*) (Lisp_Object, Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
2931 extern Lisp_Object internal_condition_case_n (Lisp_Object (*) (int, Lisp_Object *), int, Lisp_Object *, Lisp_Object, Lisp_Object (*) (Lisp_Object));
2932 extern void specbind (Lisp_Object, Lisp_Object);
2933 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object), Lisp_Object);
2934 extern Lisp_Object unbind_to (int, Lisp_Object);
2935 extern void error (const char *, ...) NO_RETURN;
2936 extern void verror (const char *, va_list) NO_RETURN;
2937 extern void do_autoload (Lisp_Object, Lisp_Object);
2938 extern Lisp_Object un_autoload (Lisp_Object);
2939 EXFUN (Ffetch_bytecode, 1);
2940 extern void init_eval_once (void);
2941 extern Lisp_Object safe_call (int, Lisp_Object *);
2942 extern Lisp_Object safe_call1 (Lisp_Object, Lisp_Object);
2943 extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2944 extern void init_eval (void);
2945 extern void syms_of_eval (void);
2947 /* Defined in editfns.c */
2948 extern Lisp_Object last_nonmenu_event;
2949 extern Lisp_Object Qfield;
2950 extern Lisp_Object Vinhibit_field_text_motion;
2951 extern Lisp_Object Vsystem_name;
2952 extern Lisp_Object Vuser_login_name;
2953 EXFUN (Fpropertize, MANY);
2954 EXFUN (Fcurrent_message, 0);
2955 EXFUN (Fgoto_char, 1);
2956 EXFUN (Fpoint_min_marker, 0);
2957 EXFUN (Fpoint_max_marker, 0);
2958 EXFUN (Fpoint_min, 0);
2959 EXFUN (Fpoint_max, 0);
2960 EXFUN (Fpoint, 0);
2961 EXFUN (Fpoint_marker, 0);
2962 EXFUN (Fmark_marker, 0);
2963 EXFUN (Fline_beginning_position, 1);
2964 EXFUN (Fline_end_position, 1);
2965 EXFUN (Ffollowing_char, 0);
2966 EXFUN (Fprevious_char, 0);
2967 EXFUN (Fchar_after, 1);
2968 EXFUN (Finsert, MANY);
2969 EXFUN (Finsert_and_inherit, MANY);
2970 EXFUN (Finsert_before_markers, MANY);
2971 EXFUN (Finsert_buffer_substring, 3);
2972 EXFUN (Finsert_char, 3);
2973 extern void insert1 (Lisp_Object);
2974 EXFUN (Feolp, 0);
2975 EXFUN (Feobp, 0);
2976 EXFUN (Fbolp, 0);
2977 EXFUN (Fbobp, 0);
2978 EXFUN (Fformat, MANY);
2979 EXFUN (Fmessage, MANY);
2980 extern Lisp_Object format2 (const char *, Lisp_Object, Lisp_Object);
2981 EXFUN (Fbuffer_substring, 2);
2982 EXFUN (Fbuffer_string, 0);
2983 extern Lisp_Object save_excursion_save (void);
2984 extern Lisp_Object save_restriction_save (void);
2985 extern Lisp_Object save_excursion_restore (Lisp_Object);
2986 extern Lisp_Object save_restriction_restore (Lisp_Object);
2987 EXFUN (Fchar_to_string, 1);
2988 EXFUN (Fdelete_region, 2);
2989 EXFUN (Fnarrow_to_region, 2);
2990 EXFUN (Fwiden, 0);
2991 EXFUN (Fuser_login_name, 1);
2992 EXFUN (Fsystem_name, 0);
2993 EXFUN (Fcurrent_time, 0);
2994 extern int clip_to_bounds (int, int, int);
2995 extern Lisp_Object make_buffer_string (int, int, int);
2996 extern Lisp_Object make_buffer_string_both (int, int, int, int, int);
2997 extern void init_editfns (void);
2998 extern void syms_of_editfns (void);
2999 EXFUN (Fconstrain_to_field, 5);
3000 EXFUN (Ffield_string, 1);
3001 EXFUN (Fdelete_field, 1);
3002 EXFUN (Ffield_beginning, 3);
3003 EXFUN (Ffield_end, 3);
3004 EXFUN (Ffield_string_no_properties, 1);
3005 extern void set_time_zone_rule (const char *);
3007 /* Defined in buffer.c */
3008 extern int mouse_face_overlay_overlaps (Lisp_Object);
3009 extern void nsberror (Lisp_Object) NO_RETURN;
3010 EXFUN (Fset_buffer_multibyte, 1);
3011 EXFUN (Foverlay_start, 1);
3012 EXFUN (Foverlay_end, 1);
3013 EXFUN (Foverlay_buffer, 1);
3014 extern void adjust_overlays_for_insert (EMACS_INT, EMACS_INT);
3015 extern void adjust_overlays_for_delete (EMACS_INT, EMACS_INT);
3016 extern void fix_start_end_in_overlays (int, int);
3017 extern void report_overlay_modification (Lisp_Object, Lisp_Object, int,
3018 Lisp_Object, Lisp_Object, Lisp_Object);
3019 extern int overlay_touches_p (int);
3020 extern Lisp_Object Vbuffer_alist, Vinhibit_read_only;
3021 EXFUN (Fbuffer_list, 1);
3022 EXFUN (Fget_buffer, 1);
3023 EXFUN (Fget_buffer_create, 1);
3024 EXFUN (Fgenerate_new_buffer_name, 2);
3025 EXFUN (Fset_buffer, 1);
3026 EXFUN (set_buffer_if_live, 1);
3027 EXFUN (Fbarf_if_buffer_read_only, 0);
3028 EXFUN (Fcurrent_buffer, 0);
3029 EXFUN (Fswitch_to_buffer, 2);
3030 EXFUN (Fother_buffer, 3);
3031 EXFUN (Foverlay_get, 2);
3032 EXFUN (Fbuffer_modified_p, 1);
3033 EXFUN (Fset_buffer_modified_p, 1);
3034 EXFUN (Fkill_buffer, 1);
3035 EXFUN (Fkill_all_local_variables, 0);
3036 EXFUN (Fbuffer_disable_undo, 1);
3037 EXFUN (Fbuffer_enable_undo, 1);
3038 EXFUN (Ferase_buffer, 0);
3039 extern Lisp_Object Qoverlayp;
3040 extern Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
3041 extern Lisp_Object get_truename_buffer (Lisp_Object);
3042 extern struct buffer *all_buffers;
3043 EXFUN (Fprevious_overlay_change, 1);
3044 EXFUN (Fbuffer_file_name, 1);
3045 extern void init_buffer_once (void);
3046 extern void init_buffer (void);
3047 extern void syms_of_buffer (void);
3048 extern void keys_of_buffer (void);
3050 /* Defined in marker.c */
3052 EXFUN (Fmarker_position, 1);
3053 EXFUN (Fmarker_buffer, 1);
3054 EXFUN (Fcopy_marker, 2);
3055 EXFUN (Fset_marker, 3);
3056 extern int marker_position (Lisp_Object);
3057 extern int marker_byte_position (Lisp_Object);
3058 extern void clear_charpos_cache (struct buffer *);
3059 extern int charpos_to_bytepos (int);
3060 extern int buf_charpos_to_bytepos (struct buffer *, int);
3061 extern int buf_bytepos_to_charpos (struct buffer *, int);
3062 extern void unchain_marker (struct Lisp_Marker *marker);
3063 extern Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object);
3064 extern Lisp_Object set_marker_both (Lisp_Object, Lisp_Object, int, int);
3065 extern Lisp_Object set_marker_restricted_both (Lisp_Object, Lisp_Object,
3066 int, int);
3067 extern void syms_of_marker (void);
3069 /* Defined in fileio.c */
3071 extern Lisp_Object Qfile_error;
3072 extern Lisp_Object Qfile_exists_p;
3073 extern Lisp_Object Qfile_directory_p;
3074 extern Lisp_Object Qinsert_file_contents;
3075 extern Lisp_Object Vauto_save_list_file_name;
3076 EXFUN (Ffind_file_name_handler, 2);
3077 EXFUN (Ffile_name_as_directory, 1);
3078 EXFUN (Fmake_temp_name, 1);
3079 EXFUN (Fexpand_file_name, 2);
3080 EXFUN (Ffile_name_nondirectory, 1);
3081 EXFUN (Fsubstitute_in_file_name, 1);
3082 EXFUN (Ffile_symlink_p, 1);
3083 EXFUN (Fverify_visited_file_modtime, 1);
3084 EXFUN (Ffile_exists_p, 1);
3085 EXFUN (Ffile_name_absolute_p, 1);
3086 EXFUN (Fdirectory_file_name, 1);
3087 EXFUN (Ffile_name_directory, 1);
3088 extern Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object);
3089 EXFUN (Ffile_accessible_directory_p, 1);
3090 EXFUN (Funhandled_file_name_directory, 1);
3091 EXFUN (Ffile_directory_p, 1);
3092 EXFUN (Fwrite_region, 7);
3093 EXFUN (Ffile_readable_p, 1);
3094 EXFUN (Ffile_executable_p, 1);
3095 EXFUN (Fread_file_name, 6);
3096 extern Lisp_Object close_file_unwind (Lisp_Object);
3097 extern Lisp_Object restore_point_unwind (Lisp_Object);
3098 extern void report_file_error (const char *, Lisp_Object) NO_RETURN;
3099 extern int internal_delete_file (Lisp_Object);
3100 extern void syms_of_fileio (void);
3101 extern Lisp_Object make_temp_name (Lisp_Object, int);
3102 EXFUN (Fmake_symbolic_link, 3);
3103 extern Lisp_Object Qdelete_file;
3105 /* Defined in abbrev.c */
3107 extern void syms_of_abbrev (void);
3109 /* Defined in search.c */
3110 extern void shrink_regexp_cache (void);
3111 EXFUN (Fstring_match, 3);
3112 extern void restore_search_regs (void);
3113 EXFUN (Fmatch_data, 3);
3114 EXFUN (Fset_match_data, 2);
3115 EXFUN (Fmatch_beginning, 1);
3116 EXFUN (Fmatch_end, 1);
3117 extern void record_unwind_save_match_data (void);
3118 EXFUN (Flooking_at, 1);
3119 extern int fast_string_match (Lisp_Object, Lisp_Object);
3120 extern int fast_c_string_match_ignore_case (Lisp_Object, const char *);
3121 extern int fast_string_match_ignore_case (Lisp_Object, Lisp_Object);
3122 extern EMACS_INT fast_looking_at (Lisp_Object, EMACS_INT, EMACS_INT,
3123 EMACS_INT, EMACS_INT, Lisp_Object);
3124 extern int scan_buffer (int, EMACS_INT, EMACS_INT, int, int *, int);
3125 extern int scan_newline (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
3126 int, int);
3127 extern int find_next_newline (EMACS_INT, int);
3128 extern int find_next_newline_no_quit (EMACS_INT, int);
3129 extern int find_before_next_newline (EMACS_INT, EMACS_INT, int);
3130 extern void syms_of_search (void);
3131 extern void clear_regexp_cache (void);
3133 /* Defined in minibuf.c */
3135 extern Lisp_Object Qcompletion_ignore_case;
3136 extern Lisp_Object Vcompletion_regexp_list;
3137 extern Lisp_Object Vhistory_length;
3138 extern Lisp_Object Vminibuffer_list;
3139 extern Lisp_Object last_minibuf_string;
3140 extern int completion_ignore_case;
3141 extern int history_delete_duplicates;
3142 extern int minibuffer_auto_raise;
3143 extern void choose_minibuf_frame (void);
3144 EXFUN (Fcompleting_read, 8);
3145 EXFUN (Fread_from_minibuffer, 7);
3146 EXFUN (Fread_variable, 2);
3147 EXFUN (Fread_buffer, 3);
3148 EXFUN (Fread_minibuffer, 2);
3149 EXFUN (Feval_minibuffer, 2);
3150 EXFUN (Fread_string, 5);
3151 EXFUN (Fread_no_blanks_input, 3);
3152 EXFUN (Fassoc_string, 3);
3153 extern Lisp_Object get_minibuffer (int);
3154 extern void temp_echo_area_glyphs (Lisp_Object);
3155 extern void init_minibuf_once (void);
3156 extern void syms_of_minibuf (void);
3158 /* Defined in callint.c */
3160 extern Lisp_Object Qminus, Qplus, Vcurrent_prefix_arg;
3161 extern Lisp_Object Qwhen;
3162 extern Lisp_Object Vcommand_history;
3163 extern Lisp_Object Vmark_even_if_inactive;
3164 extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
3165 EXFUN (Fcall_interactively, 3);
3166 EXFUN (Fprefix_numeric_value, 1);
3167 extern void syms_of_callint (void);
3169 /* Defined in casefiddle.c */
3171 extern Lisp_Object Qidentity;
3172 EXFUN (Fdowncase, 1);
3173 EXFUN (Fupcase, 1);
3174 EXFUN (Fcapitalize, 1);
3175 EXFUN (Fupcase_region, 2);
3176 EXFUN (Fupcase_initials, 1);
3177 EXFUN (Fupcase_initials_region, 2);
3178 extern void syms_of_casefiddle (void);
3179 extern void keys_of_casefiddle (void);
3181 /* Defined in casetab.c */
3183 EXFUN (Fset_case_table, 1);
3184 EXFUN (Fset_standard_case_table, 1);
3185 extern void init_casetab_once (void);
3186 extern void syms_of_casetab (void);
3188 /* Defined in keyboard.c */
3190 extern int echoing;
3191 extern Lisp_Object echo_message_buffer;
3192 extern struct kboard *echo_kboard;
3193 extern void cancel_echoing (void);
3194 extern Lisp_Object Qdisabled, QCfilter;
3195 extern Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
3196 extern Lisp_Object Qup, Qdown, Qbottom, Qend_scroll;
3197 extern Lisp_Object Qtop, Qratio;
3198 extern Lisp_Object Vtty_erase_char, Vhelp_form, Vtop_level;
3199 extern Lisp_Object Vthrow_on_input;
3200 extern int input_pending;
3201 EXFUN (Fdiscard_input, 0);
3202 EXFUN (Frecursive_edit, 0);
3203 EXFUN (Ftop_level, 0) NO_RETURN;
3204 EXFUN (Fexit_recursive_edit, 0) NO_RETURN;
3205 EXFUN (Fabort_recursive_edit, 0) NO_RETURN;
3206 EXFUN (Fcommand_execute, 4);
3207 EXFUN (Finput_pending_p, 0);
3208 extern Lisp_Object menu_bar_items (Lisp_Object);
3209 extern Lisp_Object tool_bar_items (Lisp_Object, int *);
3210 extern Lisp_Object Qvertical_scroll_bar;
3211 extern void discard_mouse_events (void);
3212 EXFUN (Fevent_convert_list, 1);
3213 EXFUN (Fread_key_sequence, 5);
3214 EXFUN (Fset_input_interrupt_mode, 1);
3215 EXFUN (Fset_output_flow_control, 2);
3216 EXFUN (Fset_input_meta_mode, 2);
3217 EXFUN (Fset_quit_char, 1);
3218 EXFUN (Fset_input_mode, 4);
3219 extern Lisp_Object pending_funcalls;
3220 extern int detect_input_pending (void);
3221 extern int detect_input_pending_ignore_squeezables (void);
3222 extern int detect_input_pending_run_timers (int);
3223 extern void safe_run_hooks (Lisp_Object);
3224 extern void cmd_error_internal (Lisp_Object, const char *);
3225 extern Lisp_Object command_loop_1 (void);
3226 extern Lisp_Object recursive_edit_1 (void);
3227 extern void record_auto_save (void);
3228 extern void init_keyboard (void);
3229 extern void syms_of_keyboard (void);
3230 extern void keys_of_keyboard (void);
3231 extern char *push_key_description (unsigned int, char *, int);
3234 /* Defined in indent.c */
3235 EXFUN (Fvertical_motion, 2);
3236 EXFUN (Findent_to, 2);
3237 EXFUN (Fcurrent_column, 0);
3238 EXFUN (Fmove_to_column, 2);
3239 extern double current_column (void);
3240 extern void invalidate_current_column (void);
3241 extern int indented_beyond_p (int, int, double);
3242 extern void syms_of_indent (void);
3244 /* Defined in frame.c */
3245 #ifdef HAVE_WINDOW_SYSTEM
3246 extern Lisp_Object Vx_resource_name;
3247 extern Lisp_Object Vx_resource_class;
3248 #endif /* HAVE_WINDOW_SYSTEM */
3249 extern Lisp_Object Qonly;
3250 extern Lisp_Object Qvisible;
3251 extern void store_frame_param (struct frame *, Lisp_Object, Lisp_Object);
3252 extern void store_in_alist (Lisp_Object *, Lisp_Object, Lisp_Object);
3253 extern Lisp_Object do_switch_frame (Lisp_Object, int, int, Lisp_Object);
3254 extern Lisp_Object get_frame_param (struct frame *, Lisp_Object);
3255 extern Lisp_Object frame_buffer_predicate (Lisp_Object);
3256 EXFUN (Fframep, 1);
3257 EXFUN (Fselect_frame, 2);
3258 EXFUN (Fselected_frame, 0);
3259 EXFUN (Fwindow_frame, 1);
3260 EXFUN (Fframe_root_window, 1);
3261 EXFUN (Fframe_first_window, 1);
3262 EXFUN (Fframe_selected_window, 1);
3263 EXFUN (Fframe_list, 0);
3264 EXFUN (Fnext_frame, 2);
3265 EXFUN (Fdelete_frame, 2);
3266 EXFUN (Fset_mouse_position, 3);
3267 EXFUN (Fmake_frame_visible, 1);
3268 EXFUN (Fmake_frame_invisible, 2);
3269 EXFUN (Ficonify_frame, 1);
3270 EXFUN (Fframe_visible_p, 1);
3271 EXFUN (Fvisible_frame_list, 0);
3272 EXFUN (Fframe_parameter, 2);
3273 EXFUN (Fframe_parameters, 1);
3274 EXFUN (Fmodify_frame_parameters, 2);
3275 EXFUN (Fset_frame_height, 3);
3276 EXFUN (Fset_frame_width, 3);
3277 EXFUN (Fset_frame_size, 3);
3278 EXFUN (Fset_frame_position, 3);
3279 EXFUN (Fraise_frame, 1);
3280 EXFUN (Fredirect_frame_focus, 2);
3281 EXFUN (Fset_frame_selected_window, 3);
3282 extern Lisp_Object frame_buffer_list (Lisp_Object);
3283 extern void frames_discard_buffer (Lisp_Object);
3284 extern void set_frame_buffer_list (Lisp_Object, Lisp_Object);
3285 extern void frames_bury_buffer (Lisp_Object);
3286 extern void syms_of_frame (void);
3288 /* Defined in emacs.c */
3289 extern char **initial_argv;
3290 extern int initial_argc;
3291 #if defined(HAVE_X_WINDOWS) || defined(HAVE_NS)
3292 extern int display_arg;
3293 #endif
3294 extern Lisp_Object decode_env_path (const char *, const char *);
3295 extern Lisp_Object Vinvocation_name, Vinvocation_directory;
3296 extern Lisp_Object Vbefore_init_time, Vafter_init_time;
3297 extern Lisp_Object Vinstallation_directory;
3298 extern Lisp_Object empty_unibyte_string, empty_multibyte_string;
3299 extern Lisp_Object Qfile_name_handler_alist;
3300 extern void (*fatal_error_signal_hook) (void);
3301 EXFUN (Fkill_emacs, 1) NO_RETURN;
3302 #if HAVE_SETLOCALE
3303 void fixup_locale (void);
3304 void synchronize_system_messages_locale (void);
3305 void synchronize_system_time_locale (void);
3306 #else
3307 #define setlocale(category, locale)
3308 #define fixup_locale()
3309 #define synchronize_system_messages_locale()
3310 #define synchronize_system_time_locale()
3311 #endif
3312 void shut_down_emacs (int, int, Lisp_Object);
3313 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3314 extern int noninteractive;
3316 /* Nonzero means don't load X resources or Windows Registry settings. */
3317 extern int inhibit_x_resources;
3319 /* Pipe used to send exit notification to the daemon parent at
3320 startup. */
3321 extern int daemon_pipe[2];
3322 #define IS_DAEMON (daemon_pipe[1] != 0)
3324 /* Nonzero means don't do use window-system-specific display code. */
3325 extern int inhibit_window_system;
3326 /* Nonzero means that a filter or a sentinel is running. */
3327 extern int running_asynch_code;
3329 /* Defined in process.c */
3330 extern Lisp_Object QCtype, Qlocal;
3331 EXFUN (Fget_process, 1);
3332 EXFUN (Fget_buffer_process, 1);
3333 EXFUN (Fprocessp, 1);
3334 EXFUN (Fprocess_status, 1);
3335 EXFUN (Fkill_process, 2);
3336 EXFUN (Fprocess_send_eof, 1);
3337 EXFUN (Fwaiting_for_user_input_p, 0);
3338 extern Lisp_Object Qprocessp;
3339 extern void kill_buffer_processes (Lisp_Object);
3340 extern int wait_reading_process_output (int, int, int, int,
3341 Lisp_Object,
3342 struct Lisp_Process *,
3343 int);
3344 extern void add_keyboard_wait_descriptor (int);
3345 extern void delete_keyboard_wait_descriptor (int);
3346 extern void add_gpm_wait_descriptor (int);
3347 extern void delete_gpm_wait_descriptor (int);
3348 extern void close_process_descs (void);
3349 extern void init_process (void);
3350 extern void syms_of_process (void);
3351 extern void setup_process_coding_systems (Lisp_Object);
3353 /* Defined in callproc.c */
3354 extern Lisp_Object Vexec_path, Vexec_suffixes,
3355 Vexec_directory, Vdata_directory;
3356 extern Lisp_Object Vdoc_directory;
3357 extern Lisp_Object Vshell_file_name;
3358 EXFUN (Fcall_process, MANY);
3359 extern int child_setup (int, int, int, char **, int, Lisp_Object);
3360 extern void init_callproc_1 (void);
3361 extern void init_callproc (void);
3362 extern void set_initial_environment (void);
3363 extern void syms_of_callproc (void);
3365 /* Defined in doc.c */
3366 extern Lisp_Object Qfunction_documentation;
3367 extern Lisp_Object Vdoc_file_name;
3368 EXFUN (Fsubstitute_command_keys, 1);
3369 EXFUN (Fdocumentation, 2);
3370 EXFUN (Fdocumentation_property, 3);
3371 extern Lisp_Object read_doc_string (Lisp_Object);
3372 extern Lisp_Object get_doc_string (Lisp_Object, int, int);
3373 extern void syms_of_doc (void);
3374 extern int read_bytecode_char (int);
3376 /* Defined in bytecode.c */
3377 extern Lisp_Object Qbytecode;
3378 EXFUN (Fbyte_code, 3);
3379 extern void syms_of_bytecode (void);
3380 extern struct byte_stack *byte_stack_list;
3381 extern void mark_byte_stack (void);
3382 extern void unmark_byte_stack (void);
3384 /* Defined in macros.c */
3385 extern Lisp_Object Qexecute_kbd_macro;
3386 EXFUN (Fexecute_kbd_macro, 3);
3387 EXFUN (Fcancel_kbd_macro_events, 0);
3388 extern void init_macros (void);
3389 extern void syms_of_macros (void);
3391 /* Defined in undo.c */
3392 extern Lisp_Object Qapply;
3393 extern Lisp_Object Qinhibit_read_only;
3394 EXFUN (Fundo_boundary, 0);
3395 extern void truncate_undo_list (struct buffer *);
3396 extern void record_marker_adjustment (Lisp_Object, int);
3397 extern void record_insert (int, int);
3398 extern void record_delete (int, Lisp_Object);
3399 extern void record_first_change (void);
3400 extern void record_change (int, int);
3401 extern void record_property_change (int, int, Lisp_Object, Lisp_Object,
3402 Lisp_Object);
3403 extern void syms_of_undo (void);
3404 extern Lisp_Object Vundo_outer_limit;
3406 /* Defined in textprop.c */
3407 extern Lisp_Object Qfont, Qmouse_face;
3408 extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
3409 extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
3410 extern Lisp_Object Qminibuffer_prompt;
3412 EXFUN (Fnext_single_property_change, 4);
3413 EXFUN (Fnext_single_char_property_change, 4);
3414 EXFUN (Fprevious_single_property_change, 4);
3415 EXFUN (Fget_text_property, 3);
3416 EXFUN (Fput_text_property, 5);
3417 EXFUN (Fprevious_char_property_change, 2);
3418 EXFUN (Fnext_char_property_change, 2);
3419 extern void report_interval_modification (Lisp_Object, Lisp_Object);
3420 extern Lisp_Object next_single_char_property_change (Lisp_Object,
3421 Lisp_Object,
3422 Lisp_Object,
3423 Lisp_Object);
3425 /* Defined in menu.c */
3426 extern void syms_of_menu (void);
3428 /* Defined in xmenu.c */
3429 EXFUN (Fx_popup_menu, 2);
3430 EXFUN (Fx_popup_dialog, 3);
3431 extern void syms_of_xmenu (void);
3433 /* Defined in termchar.h */
3434 struct tty_display_info;
3436 /* Defined in termhooks.h */
3437 struct terminal;
3439 /* Defined in sysdep.c */
3440 #ifndef HAVE_GET_CURRENT_DIR_NAME
3441 extern char *get_current_dir_name (void);
3442 #endif
3443 extern void stuff_char (char c);
3444 extern void init_sigio (int);
3445 extern void sys_subshell (void);
3446 extern void sys_suspend (void);
3447 extern void discard_tty_input (void);
3448 extern void init_sys_modes (struct tty_display_info *);
3449 extern void reset_sys_modes (struct tty_display_info *);
3450 extern void init_all_sys_modes (void);
3451 extern void reset_all_sys_modes (void);
3452 extern void wait_for_termination (int);
3453 extern void flush_pending_output (int);
3454 extern void child_setup_tty (int);
3455 extern void setup_pty (int);
3456 extern int set_window_size (int, int, int);
3457 extern void create_process (Lisp_Object, char **, Lisp_Object);
3458 extern int emacs_open (const char *, int, int);
3459 extern int emacs_close (int);
3460 extern int emacs_read (int, char *, unsigned int);
3461 extern int emacs_write (int, const char *, unsigned int);
3462 #ifndef HAVE_MEMSET
3463 extern void *memset (void *, int, size_t);
3464 #endif
3465 #ifndef HAVE_MEMCPY
3466 extern void *memcpy (void *, void *, size_t);
3467 #endif
3468 #ifndef HAVE_MEMMOVE
3469 extern void *memmove (void *, void *, size_t);
3470 #endif
3471 #ifndef HAVE_MEMCMP
3472 extern int memcmp (void *, void *, size_t);
3473 #endif
3475 /* Defined in filelock.c */
3476 extern Lisp_Object Vtemporary_file_directory;
3477 EXFUN (Funlock_buffer, 0);
3478 EXFUN (Ffile_locked_p, 1);
3479 extern void unlock_all_files (void);
3480 extern void lock_file (Lisp_Object);
3481 extern void unlock_file (Lisp_Object);
3482 extern void unlock_buffer (struct buffer *);
3483 extern void syms_of_filelock (void);
3484 extern void init_filelock (void);
3486 /* Defined in sound.c */
3487 extern void syms_of_sound (void);
3488 extern void init_sound (void);
3490 /* Defined in category.c */
3491 extern void init_category_once (void);
3492 extern Lisp_Object char_category_set (int);
3493 extern void syms_of_category (void);
3495 /* Defined in ccl.c */
3496 extern void syms_of_ccl (void);
3498 /* Defined in dired.c */
3499 EXFUN (Ffile_attributes, 2);
3500 extern void syms_of_dired (void);
3501 extern Lisp_Object directory_files_internal (Lisp_Object, Lisp_Object,
3502 Lisp_Object, Lisp_Object,
3503 int, Lisp_Object);
3505 /* Defined in term.c */
3506 extern int *char_ins_del_vector;
3507 extern void syms_of_term (void);
3508 extern void fatal (const char *msgid, ...) NO_RETURN;
3510 /* Defined in terminal.c */
3511 EXFUN (Fframe_terminal, 1);
3512 EXFUN (Fdelete_terminal, 2);
3513 extern void syms_of_terminal (void);
3515 /* Defined in font.c */
3516 extern void syms_of_font (void);
3517 extern void init_font (void);
3519 #ifdef HAVE_WINDOW_SYSTEM
3520 /* Defined in fontset.c */
3521 extern void syms_of_fontset (void);
3522 EXFUN (Fset_fontset_font, 5);
3523 EXFUN (Fnew_fontset, 2);
3525 /* Defined in xfns.c, w32fns.c, or macfns.c */
3526 extern Lisp_Object Qfont_param;
3527 extern Lisp_Object Vx_no_window_manager;
3528 EXFUN (Fxw_display_color_p, 1);
3529 EXFUN (Fx_file_dialog, 5);
3530 EXFUN (Fx_focus_frame, 1);
3531 #endif
3533 /* Defined in xfaces.c */
3534 extern Lisp_Object Qdefault, Qtool_bar, Qregion, Qfringe;
3535 extern Lisp_Object Qheader_line, Qscroll_bar, Qcursor, Qborder, Qmouse, Qmenu;
3536 extern Lisp_Object Qmode_line_inactive, Qvertical_border;
3537 extern Lisp_Object Qface;
3538 extern Lisp_Object Qnormal;
3539 extern Lisp_Object QCfamily, QCweight, QCslant;
3540 extern Lisp_Object QCheight, QCname, QCwidth, QCforeground, QCbackground;
3541 extern Lisp_Object Vface_alternative_font_family_alist;
3542 extern Lisp_Object Vface_font_rescale_alist;
3543 extern Lisp_Object Vface_ignored_fonts;
3544 extern Lisp_Object Vface_alternative_font_registry_alist;
3545 extern Lisp_Object Vscalable_fonts_allowed;
3546 EXFUN (Fclear_face_cache, 1);
3547 EXFUN (Fx_load_color_file, 1);
3548 extern void syms_of_xfaces (void);
3550 #ifndef HAVE_GETLOADAVG
3551 /* Defined in getloadavg.c */
3552 extern int getloadavg (double *, int);
3553 #endif
3555 #ifdef HAVE_X_WINDOWS
3556 /* Defined in xfns.c */
3557 extern void syms_of_xfns (void);
3559 /* Defined in xsmfns.c */
3560 extern void syms_of_xsmfns (void);
3562 /* Defined in xselect.c */
3563 EXFUN (Fx_send_client_event, 6);
3564 extern void syms_of_xselect (void);
3566 /* Defined in xterm.c */
3567 extern void syms_of_xterm (void);
3568 #endif /* HAVE_X_WINDOWS */
3570 #ifdef HAVE_WINDOW_SYSTEM
3571 /* Defined in xterm.c, nsterm.m, w32term.c */
3572 extern char *x_get_keysym_name (int);
3573 #endif /* HAVE_WINDOW_SYSTEM */
3575 #ifdef MSDOS
3576 /* Defined in msdos.c */
3577 EXFUN (Fmsdos_downcase_filename, 1);
3578 #endif
3580 #ifdef HAVE_MENUS
3581 /* Defined in (x|w32)fns.c, nsfns.m... */
3582 extern int have_menus_p (void);
3583 #endif
3585 #ifdef HAVE_DBUS
3586 /* Defined in dbusbind.c */
3587 int xd_pending_messages (void);
3588 void xd_read_queued_messages (void);
3589 void syms_of_dbusbind (void);
3590 #endif
3592 #ifdef DOS_NT
3593 /* Defined in msdos.c, w32.c */
3594 extern char *emacs_root_dir (void);
3595 #endif /* DOS_NT */
3597 /* Nonzero means Emacs has already been initialized.
3598 Used during startup to detect startup of dumped Emacs. */
3599 extern int initialized;
3601 extern int immediate_quit; /* Nonzero means ^G can quit instantly */
3603 extern POINTER_TYPE *xmalloc (size_t);
3604 extern POINTER_TYPE *xrealloc (POINTER_TYPE *, size_t);
3605 extern void xfree (POINTER_TYPE *);
3607 extern char *xstrdup (const char *);
3609 extern char *egetenv (const char *);
3611 /* Set up the name of the machine we're running on. */
3612 extern void init_system_name (void);
3614 /* Some systems (e.g., NT) use a different path separator than Unix,
3615 in addition to a device separator. Set the path separator
3616 to '/', and don't test for a device separator in IS_ANY_SEP. */
3618 #define DIRECTORY_SEP '/'
3619 #ifndef IS_DIRECTORY_SEP
3620 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3621 #endif
3622 #ifndef IS_DEVICE_SEP
3623 #ifndef DEVICE_SEP
3624 #define IS_DEVICE_SEP(_c_) 0
3625 #else
3626 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3627 #endif
3628 #endif
3629 #ifndef IS_ANY_SEP
3630 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3631 #endif
3633 #define SWITCH_ENUM_CAST(x) (x)
3635 /* Loop over Lisp list LIST. Signal an error if LIST is not a proper
3636 list, or if it contains circles.
3638 HARE and TORTOISE should be the names of Lisp_Object variables, and
3639 N should be the name of an EMACS_INT variable declared in the
3640 function where the macro is used. Each nested loop should use
3641 its own variables.
3643 In the loop body, HARE is set to each cons of LIST, and N is the
3644 length of the list processed so far. */
3646 #define LIST_END_P(list, obj) \
3647 (NILP (obj) \
3648 ? 1 \
3649 : (CONSP (obj) \
3650 ? 0 \
3651 : (wrong_type_argument (Qlistp, (list))), 1))
3653 #define FOREACH(hare, list, tortoise, n) \
3654 for (tortoise = hare = (list), n = 0; \
3655 !LIST_END_P (list, hare); \
3656 (hare = XCDR (hare), ++n, \
3657 ((n & 1) != 0 \
3658 ? (tortoise = XCDR (tortoise), \
3659 (EQ (hare, tortoise) \
3660 && (circular_list_error ((list)), 1))) \
3661 : 0)))
3663 /* The ubiquitous min and max macros. */
3665 #ifdef max
3666 #undef max
3667 #undef min
3668 #endif
3669 #define min(a, b) ((a) < (b) ? (a) : (b))
3670 #define max(a, b) ((a) > (b) ? (a) : (b))
3672 /* We used to use `abs', but that clashes with system headers on some
3673 platforms, and using a name reserved by Standard C is a bad idea
3674 anyway. */
3675 #if !defined(eabs)
3676 #define eabs(x) ((x) < 0 ? -(x) : (x))
3677 #endif
3679 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3680 fixnum. */
3682 #define make_fixnum_or_float(val) \
3683 (FIXNUM_OVERFLOW_P (val) \
3684 ? make_float (val) \
3685 : make_number ((EMACS_INT)(val)))
3688 /* Checks the `cycle check' variable CHECK to see if it indicates that
3689 EL is part of a cycle; CHECK must be either Qnil or a value returned
3690 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3691 elements after which a cycle might be suspected; after that many
3692 elements, this macro begins consing in order to keep more precise
3693 track of elements.
3695 Returns nil if a cycle was detected, otherwise a new value for CHECK
3696 that includes EL.
3698 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3699 the caller should make sure that's ok. */
3701 #define CYCLE_CHECK(check, el, suspicious) \
3702 (NILP (check) \
3703 ? make_number (0) \
3704 : (INTEGERP (check) \
3705 ? (XFASTINT (check) < (suspicious) \
3706 ? make_number (XFASTINT (check) + 1) \
3707 : Fcons (el, Qnil)) \
3708 : (!NILP (Fmemq ((el), (check))) \
3709 ? Qnil \
3710 : Fcons ((el), (check)))))
3713 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3714 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3716 #define MAX_ALLOCA 16*1024
3718 extern Lisp_Object safe_alloca_unwind (Lisp_Object);
3720 #define USE_SAFE_ALLOCA \
3721 int sa_count = SPECPDL_INDEX (), sa_must_free = 0
3723 /* SAFE_ALLOCA allocates a simple buffer. */
3725 #define SAFE_ALLOCA(buf, type, size) \
3726 do { \
3727 if ((size) < MAX_ALLOCA) \
3728 buf = (type) alloca (size); \
3729 else \
3731 buf = (type) xmalloc (size); \
3732 sa_must_free++; \
3733 record_unwind_protect (safe_alloca_unwind, \
3734 make_save_value (buf, 0)); \
3736 } while (0)
3738 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3740 #define SAFE_FREE() \
3741 do { \
3742 if (sa_must_free) { \
3743 sa_must_free = 0; \
3744 unbind_to (sa_count, Qnil); \
3746 } while (0)
3749 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3751 #define SAFE_ALLOCA_LISP(buf, nelt) \
3752 do { \
3753 int size_ = (nelt) * sizeof (Lisp_Object); \
3754 if (size_ < MAX_ALLOCA) \
3755 buf = (Lisp_Object *) alloca (size_); \
3756 else \
3758 Lisp_Object arg_; \
3759 buf = (Lisp_Object *) xmalloc (size_); \
3760 arg_ = make_save_value (buf, nelt); \
3761 XSAVE_VALUE (arg_)->dogc = 1; \
3762 sa_must_free++; \
3763 record_unwind_protect (safe_alloca_unwind, arg_); \
3765 } while (0)
3768 #endif /* EMACS_LISP_H */
3770 /* arch-tag: 9b2ed020-70eb-47ac-94ee-e1c2a5107d5e
3771 (do not change this comment) */