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