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