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