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