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