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