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