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