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