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