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