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