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