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