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