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