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