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