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