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