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