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