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