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