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