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