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