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