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