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