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