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