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