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