(DEFUN_ARGS_8): New macro.
[bpt/emacs.git] / src / lisp.h
CommitLineData
3cfe6dfd 1/* Fundamental definitions for GNU Emacs Lisp interpreter.
2f69f2ec 2 Copyright (C) 1985,86,87,93,94,95, 1997 Free Software Foundation, Inc.
3cfe6dfd
JB
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
4746118a 8the Free Software Foundation; either version 2, or (at your option)
3cfe6dfd
JB
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
18the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19Boston, MA 02111-1307, USA. */
3cfe6dfd
JB
20
21
ce99fd65
RS
22/* These are default choices for the types to use. */
23#ifndef EMACS_INT
24#define EMACS_INT int
1747fb16 25#define BITS_PER_EMACS_INT BITS_PER_INT
ce99fd65
RS
26#endif
27#ifndef EMACS_UINT
28#define EMACS_UINT unsigned int
29#endif
30
99a3d506 31/* Define the fundamental Lisp data structures. */
3cfe6dfd 32
99a3d506 33/* This is the set of Lisp data types. */
3cfe6dfd
JB
34
35enum Lisp_Type
36 {
99a3d506 37 /* Integer. XINT (obj) is the integer value. */
3cfe6dfd
JB
38 Lisp_Int,
39
99a3d506 40 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
3cfe6dfd
JB
41 Lisp_Symbol,
42
84d1833e
KH
43 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
44 whose first member indicates the subtype. */
45 Lisp_Misc,
3cfe6dfd
JB
46
47 /* String. XSTRING (object) points to a struct Lisp_String.
99a3d506 48 The length of the string, and its contents, are stored therein. */
3cfe6dfd
JB
49 Lisp_String,
50
b5088f80 51 /* Vector of Lisp objects, or something resembling it.
7c06ac2b 52 XVECTOR (object) points to a struct Lisp_Vector, which contains
b5088f80
KH
53 the size and contents. The size field also contains the type
54 information, if it's not a real vector object. */
55 Lisp_Vectorlike,
3cfe6dfd 56
99a3d506 57 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
3cfe6dfd
JB
58 Lisp_Cons,
59
3cfe6dfd 60#ifdef LISP_FLOAT_TYPE
20280af7 61 Lisp_Float,
3cfe6dfd 62#endif /* LISP_FLOAT_TYPE */
4d1207f6
RS
63
64 /* This is not a type code. It is for range checking. */
e2ba196c 65 Lisp_Type_Limit
3cfe6dfd
JB
66 };
67
84d1833e 68/* This is the set of datatypes that share a common structure.
c98adc1b
KH
69 The first member of the structure is a type code from this set.
70 The enum values are arbitrary, but we'll use large numbers to make it
71 more likely that we'll spot the error if a random word in memory is
72 mistakenly interpreted as a Lisp_Misc. */
1c4ca5a3
KH
73enum Lisp_Misc_Type
74 {
c98adc1b 75 Lisp_Misc_Free = 0x5eab,
84d1833e 76 Lisp_Misc_Marker,
ee4c9ce4
KH
77 Lisp_Misc_Intfwd,
78 Lisp_Misc_Boolfwd,
79 Lisp_Misc_Objfwd,
7d65f1c2
KH
80 Lisp_Misc_Buffer_Objfwd,
81 Lisp_Misc_Buffer_Local_Value,
ce7d8eec 82 Lisp_Misc_Some_Buffer_Local_Value,
99a3d506 83 Lisp_Misc_Overlay,
32462604 84 Lisp_Misc_Kboard_Objfwd,
99a3d506
RS
85 /* Currently floats are not a misc type,
86 but let's define this in case we want to change that. */
87 Lisp_Misc_Float,
88 /* This is not a type code. It is for range checking. */
89 Lisp_Misc_Limit
1c4ca5a3
KH
90 };
91
e2ba196c
KH
92/* These values are overridden by the m- file on some machines. */
93#ifndef VALBITS
94#define VALBITS 28
95#endif
96
97#ifndef GCTYPEBITS
98#define GCTYPEBITS 3
99#endif
100
c9ddd39d
KH
101/* Make these values available in GDB, which sees enums but not macros. */
102
103enum gdb_lisp_params
104{
105 gdb_valbits = VALBITS,
106 gdb_gctypebits = GCTYPEBITS,
68be917d 107 gdb_emacs_intbits = sizeof (EMACS_INT) * BITS_PER_CHAR,
c9ddd39d
KH
108#ifdef DATA_SEG_BITS
109 gdb_data_seg_bits = DATA_SEG_BITS
110#else
111 gdb_data_seg_bits = 0
112#endif
113};
114
3cfe6dfd
JB
115#ifndef NO_UNION_TYPE
116
c451d7b1 117#ifndef WORDS_BIG_ENDIAN
3cfe6dfd
JB
118
119/* Definition of Lisp_Object for little-endian machines. */
120
121typedef
122union Lisp_Object
123 {
124 /* Used for comparing two Lisp_Objects;
99a3d506 125 also, positive integers can be accessed fast this way. */
3cfe6dfd
JB
126 int i;
127
128 struct
129 {
e2ba196c
KH
130 int val: VALBITS;
131 int type: GCTYPEBITS+1;
3cfe6dfd
JB
132 } s;
133 struct
134 {
e2ba196c
KH
135 unsigned int val: VALBITS;
136 int type: GCTYPEBITS+1;
3cfe6dfd
JB
137 } u;
138 struct
139 {
e2ba196c
KH
140 unsigned int val: VALBITS;
141 enum Lisp_Type type: GCTYPEBITS;
3cfe6dfd
JB
142 /* The markbit is not really part of the value of a Lisp_Object,
143 and is always zero except during garbage collection. */
144 unsigned int markbit: 1;
145 } gu;
146 }
147Lisp_Object;
148
c451d7b1 149#else /* If WORDS_BIG_ENDIAN */
3cfe6dfd
JB
150
151typedef
152union Lisp_Object
153 {
154 /* Used for comparing two Lisp_Objects;
99a3d506 155 also, positive integers can be accessed fast this way. */
3cfe6dfd
JB
156 int i;
157
158 struct
159 {
e2ba196c
KH
160 int type: GCTYPEBITS+1;
161 int val: VALBITS;
3cfe6dfd
JB
162 } s;
163 struct
164 {
e2ba196c
KH
165 int type: GCTYPEBITS+1;
166 unsigned int val: VALBITS;
3cfe6dfd
JB
167 } u;
168 struct
169 {
170 /* The markbit is not really part of the value of a Lisp_Object,
171 and is always zero except during garbage collection. */
172 unsigned int markbit: 1;
e2ba196c
KH
173 enum Lisp_Type type: GCTYPEBITS;
174 unsigned int val: VALBITS;
3cfe6dfd
JB
175 } gu;
176 }
177Lisp_Object;
178
c451d7b1 179#endif /* WORDS_BIG_ENDIAN */
3cfe6dfd
JB
180
181#endif /* NO_UNION_TYPE */
182
183
1c5ca8b6 184/* If union type is not wanted, define Lisp_Object as just a number. */
3cfe6dfd
JB
185
186#ifdef NO_UNION_TYPE
627a9502 187#define Lisp_Object EMACS_INT
1c5ca8b6 188#endif /* NO_UNION_TYPE */
3cfe6dfd 189
3cfe6dfd 190#ifndef VALMASK
627a9502 191#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
3cfe6dfd 192#endif
627a9502 193#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
846d69ac
RS
194
195/* Two flags that are set during GC. On some machines, these flags
196 are defined differently by the m- file. */
197
198/* This is set in the car of a cons and in the plist slot of a symbol
199 to indicate it is marked. Likewise in the plist slot of an interval,
200 the chain slot of a marker, the type slot of a float, and the name
201 slot of a buffer.
202
203 In strings, this bit in the size field indicates that the string
204 is a "large" one, one which was separately malloc'd
205 rather than being part of a string block. */
206
627a9502 207#ifndef MARKBIT
8ce6977e 208#define MARKBIT ((int) ((unsigned int) 1 << (VALBITS + GCTYPEBITS)))
627a9502 209#endif /*MARKBIT */
3cfe6dfd 210
846d69ac
RS
211/* In the size word of a vector, this bit means the vector has been marked.
212 In the size word of a large string, likewise. */
213
214#ifndef ARRAY_MARK_FLAG
215#define ARRAY_MARK_FLAG ((MARKBIT >> 1) & ~MARKBIT)
216#endif /* no ARRAY_MARK_FLAG */
217
b5088f80
KH
218/* In the size word of a struct Lisp_Vector, this bit means it's really
219 some other vector-like object. */
220#ifndef PSEUDOVECTOR_FLAG
221#define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1) & ~ARRAY_MARK_FLAG)
222#endif
223
303a5c93 224/* In a pseudovector, the size field actually contains a word with one
b5088f80
KH
225 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
226 indicate the actual type. */
99a3d506
RS
227enum pvec_type
228{
229 PVEC_NORMAL_VECTOR = 0,
99a3d506
RS
230 PVEC_PROCESS = 0x200,
231 PVEC_FRAME = 0x400,
232 PVEC_COMPILED = 0x800,
233 PVEC_WINDOW = 0x1000,
234 PVEC_WINDOW_CONFIGURATION = 0x2000,
235 PVEC_SUBR = 0x4000,
608ff985
RS
236 PVEC_CHAR_TABLE = 0x8000,
237 PVEC_BOOL_VECTOR = 0x10000,
238 PVEC_BUFFER = 0x20000,
782dad44 239 PVEC_TYPE_MASK = 0x3fe00,
e3d48049 240 PVEC_FLAG = PSEUDOVECTOR_FLAG
99a3d506 241};
b5088f80
KH
242
243/* For convenience, we also store the number of elements in these bits. */
608ff985 244#define PSEUDOVECTOR_SIZE_MASK 0x1ff
3cfe6dfd
JB
245\f
246/* These macros extract various sorts of values from a Lisp_Object.
247 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
99a3d506 248 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
3cfe6dfd
JB
249
250#ifdef NO_UNION_TYPE
251
252/* One need to override this if there must be high bits set in data space
253 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
254 on all machines, but would penalise machines which don't need it)
255 */
256#ifndef XTYPE
257#define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
258#endif
259
260#ifndef XSETTYPE
627a9502 261#define XSETTYPE(a, b) ((a) = XUINT (a) | ((EMACS_INT)(b) << VALBITS))
3cfe6dfd
JB
262#endif
263
221f4ef3
KH
264/* For integers known to be positive, XFASTINT provides fast retrieval
265 and XSETFASTINT provides fast storage. This takes advantage of the
266 fact that Lisp_Int is 0. */
e43ec785 267#define XFASTINT(a) ((a) + 0)
221f4ef3 268#define XSETFASTINT(a, b) ((a) = (b))
3cfe6dfd
JB
269
270/* Extract the value of a Lisp_Object as a signed integer. */
271
272#ifndef XINT /* Some machines need to do this differently. */
68be917d 273#define XINT(a) (((a) << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
3cfe6dfd
JB
274#endif
275
276/* Extract the value as an unsigned integer. This is a basis
277 for extracting it as a pointer to a structure in storage. */
278
279#ifndef XUINT
280#define XUINT(a) ((a) & VALMASK)
281#endif
282
283#ifndef XPNTR
284#ifdef HAVE_SHM
285/* In this representation, data is found in two widely separated segments. */
29eab336 286extern int pure_size;
3cfe6dfd 287#define XPNTR(a) \
29eab336 288 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
3cfe6dfd
JB
289#else /* not HAVE_SHM */
290#ifdef DATA_SEG_BITS
291/* This case is used for the rt-pc.
292 In the diffs I was given, it checked for ptr = 0
293 and did not adjust it in that case.
294 But I don't think that zero should ever be found
295 in a Lisp object whose data type says it points to something. */
296#define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
297#else
298#define XPNTR(a) XUINT (a)
299#endif
300#endif /* not HAVE_SHM */
301#endif /* no XPNTR */
302
3cfe6dfd
JB
303#ifndef XSET
304#define XSET(var, type, ptr) \
627a9502 305 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
3cfe6dfd
JB
306#endif
307
b7acde90
KH
308/* Convert a C integer into a Lisp_Object integer. */
309
310#define make_number(N) \
311 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
312
3cfe6dfd
JB
313/* During garbage collection, XGCTYPE must be used for extracting types
314 so that the mark bit is ignored. XMARKBIT accesses the markbit.
315 Markbits are used only in particular slots of particular structure types.
316 Other markbits are always zero.
317 Outside of garbage collection, all mark bits are always zero. */
318
319#ifndef XGCTYPE
320#define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
321#endif
322
1747fb16 323#if VALBITS + GCTYPEBITS == BITS_PER_EMACS_INT - 1
3cfe6dfd
JB
324/* Make XMARKBIT faster if mark bit is sign bit. */
325#ifndef XMARKBIT
326#define XMARKBIT(a) ((a) < 0)
327#endif
328#endif /* markbit is sign bit */
329
330#ifndef XMARKBIT
331#define XMARKBIT(a) ((a) & MARKBIT)
332#endif
333
334#ifndef XSETMARKBIT
335#define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
336#endif
337
338#ifndef XMARK
339#define XMARK(a) ((a) |= MARKBIT)
340#endif
341
342#ifndef XUNMARK
343#define XUNMARK(a) ((a) &= ~MARKBIT)
344#endif
345
346#endif /* NO_UNION_TYPE */
347
348#ifndef NO_UNION_TYPE
349
350#define XTYPE(a) ((enum Lisp_Type) (a).u.type)
351#define XSETTYPE(a, b) ((a).u.type = (char) (b))
352
221f4ef3
KH
353/* For integers known to be positive, XFASTINT provides fast retrieval
354 and XSETFASTINT provides fast storage. This takes advantage of the
355 fact that Lisp_Int is 0. */
e43ec785 356#define XFASTINT(a) ((a).i + 0)
221f4ef3 357#define XSETFASTINT(a, b) ((a).i = (b))
3cfe6dfd
JB
358
359#ifdef EXPLICIT_SIGN_EXTEND
360/* Make sure we sign-extend; compilers have been known to fail to do so. */
68be917d 361#define XINT(a) (((a).i << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
3cfe6dfd
JB
362#else
363#define XINT(a) ((a).s.val)
364#endif /* EXPLICIT_SIGN_EXTEND */
365
366#define XUINT(a) ((a).u.val)
367#define XPNTR(a) ((a).u.val)
3cfe6dfd
JB
368
369#define XSET(var, vartype, ptr) \
370 (((var).s.type = ((char) (vartype))), ((var).s.val = ((int) (ptr))))
371
e98227af
KH
372extern Lisp_Object make_number ();
373
3cfe6dfd
JB
374/* During garbage collection, XGCTYPE must be used for extracting types
375 so that the mark bit is ignored. XMARKBIT access the markbit.
376 Markbits are used only in particular slots of particular structure types.
377 Other markbits are always zero.
378 Outside of garbage collection, all mark bits are always zero. */
379
380#define XGCTYPE(a) ((a).gu.type)
381#define XMARKBIT(a) ((a).gu.markbit)
382#define XSETMARKBIT(a,b) (XMARKBIT(a) = (b))
383#define XMARK(a) (XMARKBIT(a) = 1)
384#define XUNMARK(a) (XMARKBIT(a) = 0)
385
386#endif /* NO_UNION_TYPE */
387
99a3d506 388/* Extract a value or address from a Lisp_Object. */
3cfe6dfd
JB
389
390#define XCONS(a) ((struct Lisp_Cons *) XPNTR(a))
3cfe6dfd 391#define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
3cfe6dfd
JB
392#define XSTRING(a) ((struct Lisp_String *) XPNTR(a))
393#define XSYMBOL(a) ((struct Lisp_Symbol *) XPNTR(a))
3cfe6dfd 394#define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
7c06ac2b
RS
395
396/* Misc types. */
397#define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
a7aa28f6 398#define XMISCTYPE(a) (XMARKER (a)->type)
84d1833e 399#define XMARKER(a) (&(XMISC(a)->u_marker))
ee4c9ce4
KH
400#define XINTFWD(a) (&(XMISC(a)->u_intfwd))
401#define XBOOLFWD(a) (&(XMISC(a)->u_boolfwd))
402#define XOBJFWD(a) (&(XMISC(a)->u_objfwd))
403#define XBUFFER_OBJFWD(a) (&(XMISC(a)->u_buffer_objfwd))
7d65f1c2 404#define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
ce7d8eec 405#define XOVERLAY(a) (&(XMISC(a)->u_overlay))
32462604 406#define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
3cfe6dfd 407
7c06ac2b
RS
408/* Pseudovector types. */
409#define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
410#define XWINDOW(a) ((struct window *) XPNTR(a))
411#define XSUBR(a) ((struct Lisp_Subr *) XPNTR(a))
99a3d506 412#define XBUFFER(a) ((struct buffer *) XPNTR(a))
608ff985
RS
413#define XCHAR_TABLE(a) ((struct Lisp_Char_Table *) XPNTR(a))
414#define XBOOL_VECTOR(a) ((struct Lisp_Bool_Vector *) XPNTR(a))
99a3d506
RS
415
416
417/* Construct a Lisp_Object from a value or address. */
7c06ac2b 418
a94ef819
KH
419#define XSETINT(a, b) XSET (a, Lisp_Int, b)
420#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
b5088f80 421#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
a94ef819
KH
422#define XSETSTRING(a, b) XSET (a, Lisp_String, b)
423#define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
a94ef819 424#define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
7c06ac2b
RS
425
426/* Misc types. */
427#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
a7aa28f6 428#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
7c06ac2b
RS
429
430/* Pseudovector types. */
431#define XSETPSEUDOVECTOR(a, b, code) \
432 (XSETVECTOR (a, b), XVECTOR (a)->size |= PSEUDOVECTOR_FLAG | (code))
433#define XSETWINDOW_CONFIGURATION(a, b) \
434 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
435#define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
436#define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
437#define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
438#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
99a3d506 439#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
608ff985
RS
440#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
441#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
3cfe6dfd 442\f
e221eae3 443#ifdef USE_TEXT_PROPERTIES
99a3d506 444/* Basic data type for use of intervals. See the macros in intervals.h. */
e221eae3
JA
445
446struct interval
447{
99a3d506 448 /* The first group of entries deal with the tree structure. */
e221eae3 449
99a3d506
RS
450 unsigned int total_length; /* Length of myself and both children. */
451 unsigned int position; /* Cache of interval's character position. */
452 struct interval *left; /* Intervals which precede me. */
453 struct interval *right; /* Intervals which succeed me. */
e8720644
JB
454
455 /* Parent in the tree, or the Lisp_Object containing this interval tree.
456
457 The mark bit on the root interval of an interval tree says
458 whether we have started (and possibly finished) marking the
459 tree. If GC comes across an interval tree whose root's parent
460 field has its markbit set, it leaves the tree alone.
461
462 You'd think we could store this information in the parent object
463 somewhere (after all, that should be visited once and then
464 ignored too, right?), but strings are GC'd strangely. */
465 struct interval *parent;
e221eae3
JA
466
467 /* The remaining components are `properties' of the interval.
468 The first four are duplicates for things which can be on the list,
99a3d506 469 for purposes of speed. */
e221eae3
JA
470
471 unsigned char write_protect; /* Non-zero means can't modify. */
99a3d506 472 unsigned char visible; /* Zero means don't display. */
cde20f41 473 unsigned char front_sticky; /* Non-zero means text inserted just
99a3d506
RS
474 before this interval goes into it. */
475 unsigned char rear_sticky; /* Likewise for just after it. */
e221eae3 476
e8720644
JB
477 /* Properties of this interval.
478 The mark bit on this field says whether this particular interval
479 tree node has been visited. Since intervals should never be
480 shared, GC aborts if it seems to have visited an interval twice. */
481 Lisp_Object plist;
e221eae3
JA
482};
483
484typedef struct interval *INTERVAL;
485
486/* Complain if object is not string or buffer type */
487#define CHECK_STRING_OR_BUFFER(x, i) \
c5af3bb9 488 { if (!STRINGP ((x)) && !BUFFERP ((x))) \
e221eae3
JA
489 x = wrong_type_argument (Qbuffer_or_string_p, (x)); }
490
491/* Macro used to conditionally compile intervals into certain data
99a3d506 492 structures. See, e.g., struct Lisp_String below. */
e221eae3
JA
493#define DECLARE_INTERVALS INTERVAL intervals;
494
eb8c3be9 495/* Macro used to conditionally compile interval initialization into
99a3d506 496 certain code. See, e.g., alloc.c. */
e221eae3
JA
497#define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val
498
499#else /* No text properties */
500
99a3d506 501/* If no intervals are used, make the above definitions go away. */
e221eae3
JA
502
503#define CHECK_STRING_OR_BUFFER(x, i)
504
505#define INTERVAL
506#define DECLARE_INTERVALS
507#define INITIALIZE_INTERVAL(ptr,val)
508
509#endif /* USE_TEXT_PROPERTIES */
510\f
3cfe6dfd
JB
511/* In a cons, the markbit of the car is the gc mark bit */
512
513struct Lisp_Cons
514 {
515 Lisp_Object car, cdr;
516 };
517
b7acde90
KH
518/* Take the car or cdr of something known to be a cons cell. */
519#define XCAR(c) (XCONS ((c))->car)
520#define XCDR(c) (XCONS ((c))->cdr)
521
522/* Take the car or cdr of something whose type is not known. */
523#define CAR(c) \
524 (CONSP ((c)) ? XCAR ((c)) \
525 : NILP ((c)) ? Qnil \
526 : wrong_type_argument (Qlistp, (c)))
527
528#define CDR(c) \
529 (CONSP ((c)) ? XCDR ((c)) \
530 : NILP ((c)) ? Qnil \
531 : wrong_type_argument (Qlistp, (c)))
532
3cfe6dfd
JB
533/* Like a cons, but records info on where the text lives that it was read from */
534/* This is not really in use now */
535
536struct Lisp_Buffer_Cons
537 {
538 Lisp_Object car, cdr;
539 struct buffer *buffer;
540 int bufpos;
541 };
542
543/* In a string or vector, the sign bit of the `size' is the gc mark bit */
544
545struct Lisp_String
546 {
627a9502 547 EMACS_INT size;
99a3d506 548 DECLARE_INTERVALS /* `data' field must be last. */
3cfe6dfd
JB
549 unsigned char data[1];
550 };
551
94225242 552/* If a struct is made to look like a vector, this macro returns the length
4115d3f7
RS
553 of the shortest vector that would hold that struct. */
554#define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector) \
555 - sizeof (Lisp_Object)) \
556 + sizeof(Lisp_Object) - 1) /* round up */ \
94225242
KH
557 / sizeof (Lisp_Object))
558
3cfe6dfd
JB
559struct Lisp_Vector
560 {
627a9502 561 EMACS_INT size;
3cfe6dfd
JB
562 struct Lisp_Vector *next;
563 Lisp_Object contents[1];
564 };
565
ea724a01
KH
566/* A char table is a kind of vectorlike, with contents are like a
567 vector but with a few other slots. For some purposes, it makes
568 sense to handle a chartable with type struct Lisp_Vector. An
569 element of a char table can be any Lisp objects, but if it is a sub
570 char-table, we treat it a table that contains information of a
571 group of characters of the same charsets or a specific character of
572 a charset. A sub char-table has the same structure as a char table
573 except for that the former omits several slots at the tail. A sub
574 char table appears only in an element of a char table, and there's
575 no way to access it directly from Emacs Lisp program. */
e98227af 576
b96656ce
KH
577/* This is the number of slots that apply to characters or character
578 sets. The first 128 are for ASCII, the next 128 are for 8-bit
ea724a01
KH
579 European characters, and the last 128 are for multibyte characters.
580 The first 256 are indexed by the code itself, but the last 128 are
581 indexed by (charset-id + 128). */
b96656ce
KH
582#define CHAR_TABLE_ORDINARY_SLOTS 384
583
584/* This is the number of slots that apply to characters of ASCII and
585 8-bit Europeans only. */
586#define CHAR_TABLE_SINGLE_BYTE_SLOTS 256
608ff985 587
ea724a01
KH
588/* This is the number of slots that every char table must have. This
589 counts the ordinary slots and the top, defalt, parent, and purpose
590 slots. */
591#define CHAR_TABLE_STANDARD_SLOTS (CHAR_TABLE_ORDINARY_SLOTS + 4)
592
593/* This is the number of slots that apply to position-code-1 and
594 position-code-2 of a multibyte character at the 2nd and 3rd level
595 sub char tables respectively. */
596#define SUB_CHAR_TABLE_ORDINARY_SLOTS 128
597
598/* This is the number of slots that every sub char table must have.
599 This counts the ordinary slots and the top and defalt slot. */
e98227af 600#define SUB_CHAR_TABLE_STANDARD_SLOTS (SUB_CHAR_TABLE_ORDINARY_SLOTS + 2)
608ff985
RS
601
602/* Return the number of "extra" slots in the char table CT. */
603
604#define CHAR_TABLE_EXTRA_SLOTS(CT) \
605 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
606
b96656ce 607/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
8ac90470
KH
608 and 8-bit Europeans characters. For these characters, do not check
609 validity of CT. Do not follow parent. */
610#define CHAR_TABLE_REF(CT, IDX) \
2e34157c
RS
611 ((IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS \
612 ? (!NILP (XCHAR_TABLE (CT)->contents[IDX]) \
613 ? XCHAR_TABLE (CT)->contents[IDX] \
8ac90470 614 : XCHAR_TABLE (CT)->defalt) \
2e34157c 615 : Faref (CT, make_number (IDX)))
b96656ce
KH
616
617/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
8ac90470
KH
618 8-bit Europeans characters. Do not check validity of CT. */
619#define CHAR_TABLE_SET(CT, IDX, VAL) \
620 do { \
621 if (XFASTINT (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS) \
622 XCHAR_TABLE (CT)->contents[XFASTINT (IDX)] = VAL; \
623 else \
624 Faset (CT, IDX, VAL); \
b96656ce
KH
625 } while (0)
626
608ff985
RS
627struct Lisp_Char_Table
628 {
629 /* This is the vector's size field, which also holds the
630 pseudovector type information. It holds the size, too.
ea724a01
KH
631 The size counts the top, defalt, purpose, and parent slots.
632 The last three are not counted if this is a sub char table. */
608ff985
RS
633 EMACS_INT size;
634 struct Lisp_Vector *next;
ea724a01
KH
635 /* This holds a flag to tell if this is a top level char table (t)
636 or a sub char table (nil). */
637 Lisp_Object top;
608ff985
RS
638 /* This holds a default value,
639 which is used whenever the value for a specific character is nil. */
640 Lisp_Object defalt;
ea724a01
KH
641 /* This holds an actual value of each element. A sub char table
642 has only SUB_CHAR_TABLE_ORDINARY_SLOTS number of elements. */
643 Lisp_Object contents[CHAR_TABLE_ORDINARY_SLOTS];
644
645 /* A sub char table doesn't has the following slots. */
646
608ff985
RS
647 /* This points to another char table, which we inherit from
648 when the value for a specific character is nil.
649 The `defalt' slot takes precedence over this. */
650 Lisp_Object parent;
7f73dc9d
RS
651 /* This should be a symbol which says what kind of use
652 this char-table is meant for.
653 Typically now the values can be `syntax-table' and `display-table'. */
654 Lisp_Object purpose;
608ff985
RS
655 /* These hold additional data. */
656 Lisp_Object extras[1];
657 };
658
659/* A boolvector is a kind of vectorlike, with contents are like a string. */
660struct Lisp_Bool_Vector
661 {
662 /* This is the vector's size field. It doesn't have the real size,
663 just the subtype information. */
664 EMACS_INT vector_size;
665 struct Lisp_Vector *next;
666 /* This is the size in bits. */
667 EMACS_INT size;
668 /* This contains the actual bits, packed into bytes. */
669 unsigned char data[1];
670 };
671
3cfe6dfd
JB
672/* In a symbol, the markbit of the plist is used as the gc mark bit */
673
674struct Lisp_Symbol
675 {
676 struct Lisp_String *name;
677 Lisp_Object value;
678 Lisp_Object function;
679 Lisp_Object plist;
92a2515a 680 Lisp_Object obarray;
3cfe6dfd
JB
681 struct Lisp_Symbol *next; /* -> next symbol in this obarray bucket */
682 };
683
7c06ac2b
RS
684/* This structure describes a built-in function.
685 It is generated by the DEFUN macro only.
686 defsubr makes it into a Lisp object.
687
688 This type is treated in most respects as a pseudovector,
689 but since we never dynamically allocate or free them,
690 we don't need a next-vector field. */
e98227af 691
3cfe6dfd
JB
692struct Lisp_Subr
693 {
7c06ac2b 694 EMACS_INT size;
3cfe6dfd
JB
695 Lisp_Object (*function) ();
696 short min_args, max_args;
697 char *symbol_name;
698 char *prompt;
699 char *doc;
700 };
ee4c9ce4 701\f
7c06ac2b
RS
702/* These structures are used for various misc types. */
703
ee4c9ce4
KH
704/* A miscellaneous object, when it's on the free list. */
705struct Lisp_Free
706 {
5bfac5a9
RS
707 int type : 16; /* = Lisp_Misc_Free */
708 int spacer : 16;
ee4c9ce4
KH
709 union Lisp_Misc *chain;
710 };
3cfe6dfd 711
609c36fe 712/* In a marker, the markbit of the chain field is used as the gc mark bit. */
3cfe6dfd 713struct Lisp_Marker
308e97d0
RS
714{
715 int type : 16; /* = Lisp_Misc_Marker */
716 int spacer : 15;
717 /* 1 means normal insertion at the marker's position
718 leaves the marker after the inserted text. */
719 unsigned int insertion_type : 1;
720 struct buffer *buffer;
721 Lisp_Object chain;
722 int bufpos;
723};
3cfe6dfd 724
ee4c9ce4
KH
725/* Forwarding pointer to an int variable.
726 This is allowed only in the value cell of a symbol,
727 and it means that the symbol's value really lives in the
728 specified int variable. */
729struct Lisp_Intfwd
84d1833e 730 {
5bfac5a9
RS
731 int type : 16; /* = Lisp_Misc_Intfwd */
732 int spacer : 16;
ee4c9ce4
KH
733 int *intvar;
734 };
735
736/* Boolean forwarding pointer to an int variable.
737 This is like Lisp_Intfwd except that the ostensible
738 "value" of the symbol is t if the int variable is nonzero,
739 nil if it is zero. */
740struct Lisp_Boolfwd
741 {
5bfac5a9
RS
742 int type : 16; /* = Lisp_Misc_Boolfwd */
743 int spacer : 16;
ee4c9ce4
KH
744 int *boolvar;
745 };
746
747/* Forwarding pointer to a Lisp_Object variable.
748 This is allowed only in the value cell of a symbol,
749 and it means that the symbol's value really lives in the
750 specified variable. */
751struct Lisp_Objfwd
752 {
5bfac5a9
RS
753 int type : 16; /* = Lisp_Misc_Objfwd */
754 int spacer : 16;
ee4c9ce4
KH
755 Lisp_Object *objvar;
756 };
757
758/* Like Lisp_Objfwd except that value lives in a slot in the
759 current buffer. Value is byte index of slot within buffer. */
760struct Lisp_Buffer_Objfwd
761 {
5bfac5a9
RS
762 int type : 16; /* = Lisp_Misc_Buffer_Objfwd */
763 int spacer : 16;
ee4c9ce4 764 int offset;
84d1833e
KH
765 };
766
7d65f1c2
KH
767/* Used in a symbol value cell when the symbol's value is per-buffer.
768 The actual contents resemble a cons cell which starts a list like this:
769 (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).
770
ce7d8eec
KH
771 The cons-like structure is for historical reasons; it might be better
772 to just put these elements into the struct, now.
773
7d65f1c2
KH
774 BUFFER is the last buffer for which this symbol's value was
775 made up to date.
776
777 CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
778 local_var_alist, that being the element whose car is this
779 variable. Or it can be a pointer to the
780 (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE),
781 if BUFFER does not have an element in its alist for this
782 variable (that is, if BUFFER sees the default value of this
783 variable).
784
785 If we want to examine or set the value and BUFFER is current,
99a3d506 786 we just examine or set REALVALUE. If BUFFER is not current, we
7d65f1c2
KH
787 store the current REALVALUE value into CURRENT-ALIST-ELEMENT,
788 then find the appropriate alist element for the buffer now
789 current and set up CURRENT-ALIST-ELEMENT. Then we set
790 REALVALUE out of that element, and store into BUFFER.
791
792 If we are setting the variable and the current buffer does not
793 have an alist entry for this variable, an alist entry is
794 created.
795
796 Note that REALVALUE can be a forwarding pointer. Each time it
797 is examined or set, forwarding must be done. Each time we
798 switch buffers, buffer-local variables which forward into C
799 variables are swapped immediately, so the C code can assume
800 that they are always up to date.
801
802 Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
803 use the same substructure. The difference is that with the latter,
804 merely setting the variable while some buffer is current
805 does not cause that buffer to have its own local value of this variable.
806 Only make-local-variable does that. */
807struct Lisp_Buffer_Local_Value
808 {
5bfac5a9
RS
809 int type : 16; /* = Lisp_Misc_Buffer_Local_Value
810 or Lisp_Misc_Some_Buffer_Local_Value */
811 int spacer : 16;
7d65f1c2
KH
812 Lisp_Object car, cdr;
813 };
814
ce7d8eec
KH
815/* In an overlay object, the mark bit of the plist is used as the GC mark.
816 START and END are markers in the overlay's buffer, and
817 PLIST is the overlay's property list. */
818struct Lisp_Overlay
819 {
5bfac5a9
RS
820 int type : 16; /* = Lisp_Misc_Overlay */
821 int spacer : 16;
ce7d8eec
KH
822 Lisp_Object start, end, plist;
823 };
5bfac5a9 824
f334de0e 825/* Like Lisp_Objfwd except that value lives in a slot in the
32462604
KH
826 current kboard. */
827struct Lisp_Kboard_Objfwd
f334de0e 828 {
32462604 829 int type : 16; /* = Lisp_Misc_Kboard_Objfwd */
f334de0e
KH
830 int spacer : 16;
831 int offset;
832 };
833
5bfac5a9 834
a7aa28f6
RS
835/* To get the type field of a union Lisp_Misc, use XMISCTYPE.
836 It uses one of these struct subtypes to get the type field. */
837
84d1833e
KH
838union Lisp_Misc
839 {
84d1833e
KH
840 struct Lisp_Free u_free;
841 struct Lisp_Marker u_marker;
ee4c9ce4
KH
842 struct Lisp_Intfwd u_intfwd;
843 struct Lisp_Boolfwd u_boolfwd;
844 struct Lisp_Objfwd u_objfwd;
845 struct Lisp_Buffer_Objfwd u_buffer_objfwd;
7d65f1c2 846 struct Lisp_Buffer_Local_Value u_buffer_local_value;
ce7d8eec 847 struct Lisp_Overlay u_overlay;
32462604 848 struct Lisp_Kboard_Objfwd u_kboard_objfwd;
84d1833e 849 };
7c06ac2b 850\f
3cfe6dfd
JB
851#ifdef LISP_FLOAT_TYPE
852/* Optional Lisp floating point type */
853struct Lisp_Float
854 {
e98227af 855 Lisp_Object type; /* essentially used for mark-bit
3cfe6dfd 856 and chaining when on free-list */
e98227af 857 double data;
3cfe6dfd
JB
858 };
859#endif /* LISP_FLOAT_TYPE */
860
861/* A character, declared with the following typedef, is a member
99a3d506 862 of some character set associated with the current buffer. */
b2ba7b00
RS
863#ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
864#define _UCHAR_T
3cfe6dfd 865typedef unsigned char UCHAR;
b2ba7b00 866#endif
3cfe6dfd
JB
867
868/* Meanings of slots in a Lisp_Compiled: */
869
870#define COMPILED_ARGLIST 0
871#define COMPILED_BYTECODE 1
872#define COMPILED_CONSTANTS 2
873#define COMPILED_STACK_DEPTH 3
874#define COMPILED_DOC_STRING 4
875#define COMPILED_INTERACTIVE 5
88dbfee5 876
d03f79ef
JB
877/* Flag bits in a character. These also get used in termhooks.h.
878 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
7c06ac2b
RS
879 (MUlti-Lingual Emacs) might need 22 bits for the character value
880 itself, so we probably shouldn't use any bits lower than 0x0400000. */
881#define CHAR_ALT (0x0400000)
882#define CHAR_SUPER (0x0800000)
883#define CHAR_HYPER (0x1000000)
884#define CHAR_SHIFT (0x2000000)
885#define CHAR_CTL (0x4000000)
886#define CHAR_META (0x8000000)
703f2808 887
6b768554
KH
888/* Actually, the current Emacs uses 19 bits for the character value
889 itself. */
890#define CHARACTERBITS 19
891
e6faba7f
RS
892#ifdef USE_X_TOOLKIT
893#ifdef NO_UNION_TYPE
894/* Use this for turning a (void *) into a Lisp_Object, as when the
895 Lisp_Object is passed into a toolkit callback function. */
896#define VOID_TO_LISP(larg,varg) \
897 do { ((larg) = ((Lisp_Object) (varg))); } while (0)
898#define CVOID_TO_LISP VOID_TO_LISP
899
900/* Use this for turning a Lisp_Object into a (void *), as when the
901 Lisp_Object is passed into a toolkit callback function. */
902#define LISP_TO_VOID(larg) ((void *) (larg))
903#define LISP_TO_CVOID(varg) ((const void *) (larg))
904
905#else /* not NO_UNION_TYPE */
906/* Use this for turning a (void *) into a Lisp_Object, as when the
907 Lisp_Object is passed into a toolkit callback function. */
908#define VOID_TO_LISP(larg,varg) \
909 do { ((larg).v = (void *) (varg)); } while (0)
910#define CVOID_TO_LISP(larg,varg) \
911 do { ((larg).cv = (const void *) (varg)); } while (0)
912
913/* Use this for turning a Lisp_Object into a (void *), as when the
914 Lisp_Object is passed into a toolkit callback function. */
915#define LISP_TO_VOID(larg) ((larg).v)
916#define LISP_TO_CVOID(larg) ((larg).cv)
917#endif /* not NO_UNION_TYPE */
918#endif /* USE_X_TOOLKIT */
919
703f2808
JB
920\f
921/* The glyph datatype, used to represent characters on the display. */
922
6b768554
KH
923/* The low 19 bits (CHARACTERBITS) are the character code, and the
924 bits above them except for the topmost two bits are the numeric
925 face ID. If FID is the face ID of a glyph on a frame F, then
926 F->display.x->faces[FID] contains the description of that face.
927 This is an int instead of a short, so we can support a good bunch
928 of face ID's (i.e. 2^(32 - 19 - 2) = 2048 ID's) ; given that we
929 have no mechanism for tossing unused frame face ID's yet, we'll
930 probably run out of 255 pretty quickly. */
703f2808
JB
931#define GLYPH unsigned int
932
6b768554
KH
933/* Mask bit for a glyph of a character which should be written from
934 right to left. */
935#define GLYPH_MASK_REV_DIR 0x80000000
936/* Mask bit for a padding glyph of a multi-column character. */
937#define GLYPH_MASK_PADDING 0x40000000
938/* Mask bits for face. */
939#define GLYPH_MASK_FACE 0x3FF80000
940/* Mask bits for character code. */
941#define GLYPH_MASK_CHAR 0x0007FFFF /* The lowest 19 bits */
942
87485d6f 943#ifdef HAVE_FACES
49b0dd75
KH
944/* The FAST macros assume that we already know we're in an X window. */
945
703f2808 946/* Given a character code and a face ID, return the appropriate glyph. */
000f4621 947#define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << CHARACTERBITS))
703f2808
JB
948
949/* Return a glyph's character code. */
6b768554 950#define FAST_GLYPH_CHAR(glyph) ((glyph) & GLYPH_MASK_CHAR)
703f2808
JB
951
952/* Return a glyph's face ID. */
6b768554 953#define FAST_GLYPH_FACE(glyph) (((glyph) & GLYPH_MASK_FACE) >> CHARACTERBITS)
49b0dd75
KH
954
955/* Slower versions that test the frame type first. */
956#define MAKE_GLYPH(f, char, face) (FRAME_TERMCAP_P (f) ? (char) \
957 : FAST_MAKE_GLYPH (char, face))
958#define GLYPH_CHAR(f, g) (FRAME_TERMCAP_P (f) ? (g) : FAST_GLYPH_CHAR (g))
959#define GLYPH_FACE(f, g) (FRAME_TERMCAP_P (f) ? (0) : FAST_GLYPH_FACE (g))
87485d6f 960#else /* not HAVE_FACES */
49b0dd75 961#define MAKE_GLYPH(f, char, face) (char)
6b768554
KH
962#define FAST_MAKE_GLYPH(char, face) (char)
963#define GLYPH_CHAR(f, g) ((g) & GLYPH_MASK_CHAR)
964#define FAST_GLYPH_CHAR(g) ((g) & GLYPH_MASK_CHAR)
965#define GLYPH_FACE(f, g) ((g) & GLYPH_MASK_FACE)
966#define FAST_GLYPH_FACE(g) ((g) & GLYPH_MASK_FACE)
87485d6f 967#endif /* not HAVE_FACES */
703f2808 968
b96656ce
KH
969/* Return 1 iff GLYPH contains valid character code. */
970#define GLYPH_CHAR_VALID_P(glyph) \
971 ((GLYPH) (FAST_GLYPH_CHAR (glyph)) <= MAX_CHAR)
972
4606cc9d
RS
973/* The ID of the mode line highlighting face. */
974#define GLYPH_MODE_LINE_FACE 1
3cfe6dfd
JB
975\f
976/* Data type checking */
977
efb859b4 978#define NILP(x) (XFASTINT (x) == XFASTINT (Qnil))
f498e3b2 979#define GC_NILP(x) GC_EQ (x, Qnil)
3cfe6dfd 980
4746118a 981#ifdef LISP_FLOAT_TYPE
c5af3bb9 982#define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
c1a2bfad 983#define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
4746118a 984#else
c5af3bb9 985#define NUMBERP(x) (INTEGERP (x))
c1a2bfad 986#define GC_NUMBERP(x) (GC_INTEGERP (x))
4746118a 987#endif
a4a9f09f 988#define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
c1a2bfad 989#define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
4746118a 990
edfa9106 991#define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
c1a2bfad 992#define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
edfa9106 993#define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
c1a2bfad 994#define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
84d1833e 995#define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
c1a2bfad 996#define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
b5088f80
KH
997#define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
998#define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
edfa9106 999#define STRINGP(x) (XTYPE ((x)) == Lisp_String)
c1a2bfad 1000#define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
3cfe6dfd 1001#define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
c1a2bfad 1002#define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
7c06ac2b 1003
20280af7 1004#ifdef LISP_FLOAT_TYPE
edfa9106 1005#define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
c1a2bfad 1006#define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
20280af7
JB
1007#else
1008#define FLOATP(x) (0)
c1a2bfad 1009#define GC_FLOATP(x) (0)
20280af7 1010#endif
b5088f80
KH
1011#define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1012#define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
a7aa28f6
RS
1013#define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1014#define GC_OVERLAYP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1015#define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1016#define GC_MARKERP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1017#define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
1018#define GC_INTFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
1019#define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
1020#define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
1021#define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
1022#define GC_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
1023#define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
1024#define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
1025#define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
1026#define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
1027#define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1028#define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1029#define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1030#define GC_KBOARD_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
edfa9106 1031
7c06ac2b 1032
303a5c93 1033/* True if object X is a pseudovector whose code is CODE. */
7c06ac2b
RS
1034#define PSEUDOVECTORP(x, code) \
1035 (VECTORLIKEP (x) \
1036 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1037 == (PSEUDOVECTOR_FLAG | (code))))
1038
303a5c93 1039/* True if object X is a pseudovector whose code is CODE.
7c06ac2b
RS
1040 This one works during GC. */
1041#define GC_PSEUDOVECTORP(x, code) \
1042 (GC_VECTORLIKEP (x) \
1043 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1044 == (PSEUDOVECTOR_FLAG | (code))))
1045
1046/* Test for specific pseudovector types. */
1047#define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1048#define GC_WINDOW_CONFIGURATIONP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1049#define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1050#define GC_PROCESSP(x) GC_PSEUDOVECTORP (x, PVEC_PROCESS)
1051#define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1052#define GC_WINDOWP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW)
1053#define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1054#define GC_SUBRP(x) GC_PSEUDOVECTORP (x, PVEC_SUBR)
1055#define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1056#define GC_COMPILEDP(x) GC_PSEUDOVECTORP (x, PVEC_COMPILED)
99a3d506
RS
1057#define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1058#define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
608ff985
RS
1059#define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1060#define GC_CHAR_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1061#define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1062#define GC_BOOL_VECTOR_P(x) GC_PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
7c06ac2b
RS
1063#define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1064#define GC_FRAMEP(x) GC_PSEUDOVECTORP (x, PVEC_FRAME)
ea724a01
KH
1065
1066#define SUB_CHAR_TABLE_P(x) (CHAR_TABLE_P (x) && NILP (XCHAR_TABLE (x)->top))
7c06ac2b 1067\f
3cfe6dfd 1068#define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
f498e3b2 1069#define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
4746118a 1070
3cfe6dfd 1071#define CHECK_LIST(x, i) \
c5af3bb9 1072 do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
3cfe6dfd
JB
1073
1074#define CHECK_STRING(x, i) \
c5af3bb9 1075 do { if (!STRINGP ((x))) x = wrong_type_argument (Qstringp, (x)); } while (0)
3cfe6dfd
JB
1076
1077#define CHECK_CONS(x, i) \
c5af3bb9 1078 do { if (!CONSP ((x))) x = wrong_type_argument (Qconsp, (x)); } while (0)
3cfe6dfd
JB
1079
1080#define CHECK_SYMBOL(x, i) \
c5af3bb9 1081 do { if (!SYMBOLP ((x))) x = wrong_type_argument (Qsymbolp, (x)); } while (0)
3cfe6dfd 1082
608ff985 1083#define CHECK_CHAR_TABLE(x, i) \
a97eb3f3 1084 do { if (!CHAR_TABLE_P ((x))) \
608ff985
RS
1085 x = wrong_type_argument (Qchar_table_p, (x)); } while (0)
1086
3cfe6dfd 1087#define CHECK_VECTOR(x, i) \
c5af3bb9 1088 do { if (!VECTORP ((x))) x = wrong_type_argument (Qvectorp, (x)); } while (0)
3cfe6dfd 1089
7f73dc9d
RS
1090#define CHECK_VECTOR_OR_CHAR_TABLE(x, i) \
1091 do { if (!VECTORP ((x)) && !CHAR_TABLE_P ((x))) \
1092 x = wrong_type_argument (Qvector_or_char_table_p, (x)); \
1093 } while (0)
1094
3cfe6dfd 1095#define CHECK_BUFFER(x, i) \
c5af3bb9 1096 do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
3cfe6dfd
JB
1097
1098#define CHECK_WINDOW(x, i) \
c5af3bb9 1099 do { if (!WINDOWP ((x))) x = wrong_type_argument (Qwindowp, (x)); } while (0)
3cfe6dfd 1100
03273ec5 1101/* This macro rejects windows on the interior of the window tree as
e98227af 1102 "dead", which is what we want; this is an argument-checking macro, and
03273ec5
JB
1103 the user should never get access to interior windows.
1104
1105 A window of any sort, leaf or interior, is dead iff the buffer,
1106 vchild, and hchild members are all nil. */
1107
1108#define CHECK_LIVE_WINDOW(x, i) \
2ad18bfd 1109 do { \
c5af3bb9 1110 if (!WINDOWP ((x)) \
03273ec5 1111 || NILP (XWINDOW ((x))->buffer)) \
806b4d9b 1112 x = wrong_type_argument (Qwindow_live_p, (x)); \
2ad18bfd 1113 } while (0)
03273ec5 1114
3cfe6dfd 1115#define CHECK_PROCESS(x, i) \
c5af3bb9 1116 do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
3cfe6dfd
JB
1117
1118#define CHECK_NUMBER(x, i) \
c5af3bb9 1119 do { if (!INTEGERP ((x))) x = wrong_type_argument (Qintegerp, (x)); } while (0)
3cfe6dfd
JB
1120
1121#define CHECK_NATNUM(x, i) \
a4a9f09f 1122 do { if (!NATNUMP (x)) x = wrong_type_argument (Qwholenump, (x)); } while (0)
3cfe6dfd
JB
1123
1124#define CHECK_MARKER(x, i) \
c5af3bb9 1125 do { if (!MARKERP ((x))) x = wrong_type_argument (Qmarkerp, (x)); } while (0)
3cfe6dfd
JB
1126
1127#define CHECK_NUMBER_COERCE_MARKER(x, i) \
221f4ef3 1128 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
c5af3bb9 1129 else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
3cfe6dfd
JB
1130
1131#ifdef LISP_FLOAT_TYPE
1132
1133#ifndef DBL_DIG
1134#define DBL_DIG 20
1135#endif
1136
1137#define XFLOATINT(n) extract_float((n))
1138
1139#define CHECK_FLOAT(x, i) \
c5af3bb9 1140 do { if (!FLOATP (x)) \
2ad18bfd 1141 x = wrong_type_argument (Qfloatp, (x)); } while (0)
3cfe6dfd
JB
1142
1143#define CHECK_NUMBER_OR_FLOAT(x, i) \
c5af3bb9 1144 do { if (!FLOATP (x) && !INTEGERP (x)) \
2ad18bfd 1145 x = wrong_type_argument (Qnumberp, (x)); } while (0)
3cfe6dfd
JB
1146
1147#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
221f4ef3 1148 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
c5af3bb9 1149 else if (!INTEGERP (x) && !FLOATP (x)) \
2ad18bfd 1150 x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
3cfe6dfd
JB
1151
1152#else /* Not LISP_FLOAT_TYPE */
1153
1154#define CHECK_NUMBER_OR_FLOAT CHECK_NUMBER
1155
1156#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER CHECK_NUMBER_COERCE_MARKER
1157
1158#define XFLOATINT(n) XINT((n))
1159#endif /* LISP_FLOAT_TYPE */
1160
20280af7 1161#define CHECK_OVERLAY(x, i) \
c5af3bb9 1162 do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
20280af7 1163
3cfe6dfd
JB
1164/* Cast pointers to this type to compare them. Some machines want int. */
1165#ifndef PNTR_COMPARISON_TYPE
1166#define PNTR_COMPARISON_TYPE unsigned int
1167#endif
1168\f
1169/* Define a built-in function for calling from Lisp.
1170 `lname' should be the name to give the function in Lisp,
1171 as a null-terminated C string.
1172 `fnname' should be the name of the function in C.
1173 By convention, it starts with F.
1174 `sname' should be the name for the C constant structure
1175 that records information on this function for internal use.
1176 By convention, it should be the same as `fnname' but with S instead of F.
1177 It's too bad that C macros can't compute this from `fnname'.
1178 `minargs' should be a number, the minimum number of arguments allowed.
1179 `maxargs' should be a number, the maximum number of arguments allowed,
1180 or else MANY or UNEVALLED.
1181 MANY means pass a vector of evaluated arguments,
1182 in the form of an integer number-of-arguments
1183 followed by the address of a vector of Lisp_Objects
1184 which contains the argument values.
1185 UNEVALLED means pass the list of unevaluated arguments
1186 `prompt' says how to read arguments for an interactive call.
eab9d423 1187 See the doc string for `interactive'.
3cfe6dfd 1188 A null string means call interactively with no arguments.
eab9d423 1189 `doc' is documentation for the user. */
3cfe6dfd 1190
5125ca93 1191#if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
7c06ac2b
RS
1192#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1193 Lisp_Object fnname (); \
1194 struct Lisp_Subr sname = \
1195 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1196 fnname, minargs, maxargs, lname, prompt, 0}; \
3cfe6dfd
JB
1197 Lisp_Object fnname
1198
c451d7b1
RS
1199#else
1200
1201/* This version of DEFUN declares a function prototype with the right
99a3d506 1202 arguments, so we can catch errors with maxargs at compile-time. */
7c06ac2b
RS
1203#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1204 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1205 struct Lisp_Subr sname = \
1206 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1207 fnname, minargs, maxargs, lname, prompt, 0}; \
c451d7b1
RS
1208 Lisp_Object fnname
1209
1210/* Note that the weird token-substitution semantics of ANSI C makes
99a3d506 1211 this work for MANY and UNEVALLED. */
c451d7b1
RS
1212#define DEFUN_ARGS_MANY (int, Lisp_Object *)
1213#define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1214#define DEFUN_ARGS_0 (void)
1215#define DEFUN_ARGS_1 (Lisp_Object)
1216#define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1217#define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1218#define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1219#define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1220 Lisp_Object)
1221#define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1222 Lisp_Object, Lisp_Object)
1223#define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1224 Lisp_Object, Lisp_Object, Lisp_Object)
5593f7e3
KH
1225#define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1226 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
c451d7b1
RS
1227#endif
1228
3cfe6dfd 1229/* defsubr (Sname);
99a3d506 1230 is how we define the symbol for function `name' at start-up time. */
3cfe6dfd
JB
1231extern void defsubr ();
1232
1233#define MANY -2
1234#define UNEVALLED -1
1235
1236extern void defvar_lisp ();
1237extern void defvar_bool ();
1238extern void defvar_int ();
32462604 1239extern void defvar_kboard ();
3cfe6dfd
JB
1240
1241/* Macros we use to define forwarded Lisp variables.
1242 These are used in the syms_of_FILENAME functions. */
1243
3cfe6dfd
JB
1244#define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
1245#define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
1246#define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
1247#define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
ef15f270
JB
1248#define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
1249 defvar_per_buffer (lname, vname, type, 0)
32462604
KH
1250#define DEFVAR_KBOARD(lname, vname, doc) \
1251 defvar_kboard (lname, \
1252 (int)((char *)(&current_kboard->vname) \
1253 - (char *)current_kboard))
3cfe6dfd 1254\f
78ca380c
JB
1255/* Structure for recording Lisp call stack for backtrace purposes. */
1256
1257/* The special binding stack holds the outer values of variables while
1258 they are bound by a function application or a let form, stores the
1259 code to be executed for Lisp unwind-protect forms, and stores the C
1260 functions to be called for record_unwind_protect.
1261
1262 If func is non-zero, undoing this binding applies func to old_value;
1263 This implements record_unwind_protect.
1264 If func is zero and symbol is nil, undoing this binding evaluates
1265 the list of forms in old_value; this implements Lisp's unwind-protect
1266 form.
1267 Otherwise, undoing this binding stores old_value as symbol's value; this
1268 undoes the bindings made by a let form or function call. */
3cfe6dfd
JB
1269struct specbinding
1270 {
1271 Lisp_Object symbol, old_value;
1272 Lisp_Object (*func) ();
1273 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
1274 };
1275
1276extern struct specbinding *specpdl;
1277extern struct specbinding *specpdl_ptr;
1278extern int specpdl_size;
1279
78ca380c 1280/* Everything needed to describe an active condition case. */
3cfe6dfd
JB
1281struct handler
1282 {
78ca380c 1283 /* The handler clauses and variable from the condition-case form. */
3cfe6dfd
JB
1284 Lisp_Object handler;
1285 Lisp_Object var;
22bbbd42
RS
1286 /* Fsignal stores here the condition-case clause that applies,
1287 and Fcondition_case thus knows which clause to run. */
1288 Lisp_Object chosen_clause;
78ca380c
JB
1289
1290 /* Used to effect the longjump out to the handler. */
3cfe6dfd 1291 struct catchtag *tag;
78ca380c
JB
1292
1293 /* The next enclosing handler. */
3cfe6dfd
JB
1294 struct handler *next;
1295 };
1296
1297extern struct handler *handlerlist;
1298
1299extern struct catchtag *catchlist;
1300extern struct backtrace *backtrace_list;
1301
22bbbd42
RS
1302extern Lisp_Object memory_signal_data;
1303
3cfe6dfd
JB
1304/* An address near the bottom of the stack.
1305 Tells GC how to save a copy of the stack. */
1306extern char *stack_bottom;
1307
99a3d506 1308/* Check quit-flag and quit if it is non-nil. */
3cfe6dfd
JB
1309
1310#define QUIT \
efb859b4 1311 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3cfe6dfd
JB
1312 { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }
1313
1314/* Nonzero if ought to quit now. */
1315
efb859b4 1316#define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3cfe6dfd 1317\f
8ac90470 1318/* Variables used locally in the following case handling macros. */
2e34157c
RS
1319extern int case_temp1;
1320extern Lisp_Object case_temp2;
8ac90470 1321
e98227af 1322/* Current buffer's map from characters to lower-case characters. */
3cfe6dfd 1323
8ac90470 1324#define DOWNCASE_TABLE current_buffer->downcase_table
3cfe6dfd 1325
e98227af 1326/* Current buffer's map from characters to upper-case characters. */
3cfe6dfd 1327
8ac90470 1328#define UPCASE_TABLE current_buffer->upcase_table
3cfe6dfd 1329
e98227af 1330/* Downcase a character, or make no change if that cannot be done. */
3cfe6dfd 1331
8ac90470
KH
1332#define DOWNCASE(CH) \
1333 ((case_temp1 = (CH), \
1334 case_temp2 = CHAR_TABLE_REF (DOWNCASE_TABLE, case_temp1), \
1335 NATNUMP (case_temp2)) \
1336 ? XFASTINT (case_temp2) : case_temp1)
3cfe6dfd 1337
e98227af 1338/* 1 if CH is upper case. */
3cfe6dfd 1339
476d47ce 1340#define UPPERCASEP(CH) (DOWNCASE (CH) != (CH))
3cfe6dfd 1341
e98227af 1342/* 1 if CH is neither upper nor lower case. */
3cfe6dfd 1343
8ac90470 1344#define NOCASEP(CH) (UPCASE1 (CH) == (CH))
3cfe6dfd 1345
e98227af 1346/* 1 if CH is lower case. */
3cfe6dfd 1347
e98227af 1348#define LOWERCASEP(CH) (!UPPERCASEP (CH) && !NOCASEP(CH))
3cfe6dfd 1349
e98227af 1350/* Upcase a character, or make no change if that cannot be done. */
3cfe6dfd 1351
e98227af
KH
1352#define UPCASE(CH) (!UPPERCASEP (CH) ? UPCASE1 (CH) : (CH))
1353
1354/* Upcase a character known to be not upper case. */
1355
8ac90470
KH
1356#define UPCASE1(CH) \
1357 ((case_temp1 = (CH), \
1358 case_temp2 = CHAR_TABLE_REF (UPCASE_TABLE, case_temp1), \
1359 NATNUMP (case_temp2)) \
1360 ? XFASTINT (case_temp2) : case_temp1)
3cfe6dfd 1361
c6a3c83c 1362extern Lisp_Object Vascii_downcase_table;
3cfe6dfd 1363\f
99a3d506 1364/* Number of bytes of structure consed since last GC. */
3cfe6dfd
JB
1365
1366extern int consing_since_gc;
1367
99a3d506 1368/* Threshold for doing another gc. */
3cfe6dfd 1369
65deefca 1370extern int gc_cons_threshold;
3cfe6dfd 1371
99a3d506 1372/* Structure for recording stack slots that need marking. */
3cfe6dfd
JB
1373
1374/* This is a chain of structures, each of which points at a Lisp_Object variable
1375 whose value should be marked in garbage collection.
1376 Normally every link of the chain is an automatic variable of a function,
1377 and its `val' points to some argument or local variable of the function.
1378 On exit to the function, the chain is set back to the value it had on entry.
e5f55f07
BF
1379 This way, no link remains in the chain when the stack frame containing the
1380 link disappears.
3cfe6dfd
JB
1381
1382 Every function that can call Feval must protect in this fashion all
99a3d506 1383 Lisp_Object variables whose contents will be used again. */
3cfe6dfd
JB
1384
1385extern struct gcpro *gcprolist;
1386
1387struct gcpro
1388 {
1389 struct gcpro *next;
1390 Lisp_Object *var; /* Address of first protected variable */
1391 int nvars; /* Number of consecutive protected variables */
1392 };
1393
1394#define GCPRO1(varname) \
1395 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
1396 gcprolist = &gcpro1; }
1397
1398#define GCPRO2(varname1, varname2) \
1399 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1400 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1401 gcprolist = &gcpro2; }
1402
1403#define GCPRO3(varname1, varname2, varname3) \
1404 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1405 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1406 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1407 gcprolist = &gcpro3; }
1408
1409#define GCPRO4(varname1, varname2, varname3, varname4) \
1410 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1411 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1412 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1413 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1414 gcprolist = &gcpro4; }
1415
c47b8d02
RS
1416#define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
1417 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1418 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1419 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1420 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1421 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1422 gcprolist = &gcpro5; }
1423
99a3d506 1424/* Call staticpro (&var) to protect static variable `var'. */
3cfe6dfd
JB
1425
1426void staticpro();
e98227af 1427
3cfe6dfd
JB
1428#define UNGCPRO (gcprolist = gcpro1.next)
1429
5db82c9d 1430/* Evaluate expr, UNGCPRO, and then return the value of expr. */
c47b8d02 1431#define RETURN_UNGCPRO(expr) \
f3ca341e 1432if (1) \
c47b8d02
RS
1433 { \
1434 Lisp_Object ret_ungc_val; \
1435 ret_ungc_val = (expr); \
1436 UNGCPRO; \
1437 return ret_ungc_val; \
1438 } \
f3ca341e 1439else
3cfe6dfd 1440\f
2f69f2ec
RS
1441/* Declare a Lisp-callable function. The MAXARGS parameter has the same
1442 meaning as in the DEFUN macro, and is used to construct a prototype. */
1443#if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
1444#define EXFUN(fnname, maxargs) \
1445 extern Lisp_Object fnname ()
1446#else
1447/* We can use the same trick as in the DEFUN macro to generate the
1448 appropriate prototype. */
1449#define EXFUN(fnname, maxargs) \
1450 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
1451#endif
1452
1453/* Declare the prototype for a general external function. */
1454#ifdef __STDC__
1455#define P_(proto) proto
1456#else
1457#define P_(proto) ()
1458#endif
1459
3cfe6dfd
JB
1460/* Defined in data.c */
1461extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
1462extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
1463extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
1464extern Lisp_Object Qvoid_variable, Qvoid_function;
1465extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
1466extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
1467extern Lisp_Object Qend_of_file, Qarith_error;
1468extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
83125cd7 1469extern Lisp_Object Qmark_inactive;
3cfe6dfd 1470
59b4254d
JB
1471extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
1472extern Lisp_Object Qoverflow_error, Qunderflow_error;
623ed1b0 1473
07a97bf8
RS
1474extern Lisp_Object Qintegerp, Qnumberp, Qnatnump, Qwholenump;
1475extern Lisp_Object Qsymbolp, Qlistp, Qconsp;
3cfe6dfd
JB
1476extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
1477extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qvectorp;
4de86b16 1478extern Lisp_Object Qinteger_or_marker_p, Qnumber_or_marker_p;
7f73dc9d 1479extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
4de86b16 1480extern Lisp_Object Qboundp, Qfboundp;
cde20f41 1481extern Lisp_Object Qbuffer_or_string_p;
3cfe6dfd
JB
1482extern Lisp_Object Qcdr;
1483
1484#ifdef LISP_FLOAT_TYPE
1485extern Lisp_Object Qfloatp, Qinteger_or_floatp, Qinteger_or_float_or_marker_p;
1486#endif /* LISP_FLOAT_TYPE */
1487
ff11dfa1 1488extern Lisp_Object Qframep;
3cfe6dfd 1489
2f69f2ec
RS
1490EXFUN (Feq, 2);
1491EXFUN (Fnull, 1);
1492EXFUN (Flistp, 1);
1493EXFUN (Fconsp, 1);
1494EXFUN (Fatom, 1);
1495EXFUN (Fnlistp, 1);
1496EXFUN (Fintegerp, 1);
1497EXFUN (Fnatnump, 1);
1498EXFUN (Fsymbolp, 1);
1499EXFUN (Fvectorp, 1);
1500EXFUN (Fstringp, 1);
1501EXFUN (Farrayp, 1);
1502EXFUN (Fsequencep, 1);
1503EXFUN (Fbufferp, 1);
1504EXFUN (Fmarkerp, 1);
1505EXFUN (Fsubrp, 1);
1506EXFUN (Fchar_or_string_p, 1);
1507EXFUN (Finteger_or_marker_p, 1);
3cfe6dfd 1508#ifdef LISP_FLOAT_TYPE
2f69f2ec
RS
1509EXFUN (Ffloatp, 1);
1510EXFUN (Finteger_or_floatp, 1);
1511EXFUN (Finteger_or_float_or_marker_p, 1);
3cfe6dfd
JB
1512#endif /* LISP_FLOAT_TYPE */
1513
2f69f2ec
RS
1514EXFUN (Fcar, 1);
1515EXFUN (Fcar_safe, 1);
1516EXFUN (Fcdr, 1);
1517EXFUN (Fcdr_safe, 1);
1518EXFUN (Fsetcar, 2);
1519EXFUN (Fsetcdr, 2);
1520EXFUN (Fboundp, 1);
1521EXFUN (Ffboundp, 1);
1522EXFUN (Fmakunbound, 1);
1523EXFUN (Ffmakunbound, 1);
1524EXFUN (Fsymbol_function, 1);
1525EXFUN (Fsymbol_plist, 1);
1526EXFUN (Fsymbol_name, 1);
1527extern Lisp_Object indirect_function P_ ((Lisp_Object));
1528EXFUN (Findirect_function, 1);
1529EXFUN (Ffset, 2);
1530EXFUN (Fsetplist, 2);
1531EXFUN (Fsymbol_value, 1);
a154f406 1532extern Lisp_Object find_symbol_value P_ ((Lisp_Object));
2f69f2ec
RS
1533EXFUN (Fset, 2);
1534EXFUN (Fdefault_value, 1);
1535EXFUN (Fset_default, 2);
1536EXFUN (Fdefault_boundp, 1);
1537EXFUN (Fmake_local_variable, 1);
a154f406 1538EXFUN (Flocal_variable_p, 2);
2f69f2ec
RS
1539EXFUN (Flocal_variable_if_set_p, 2);
1540
1541EXFUN (Faref, 2);
1542EXFUN (Faset, 3);
1543
1544EXFUN (Fstring_to_number, 2);
1545EXFUN (Fnumber_to_string, 1);
1546EXFUN (Feqlsign, 2);
1547EXFUN (Fgtr, 2);
1548EXFUN (Flss, 2);
1549EXFUN (Fgeq, 2);
1550EXFUN (Fleq, 2);
1551EXFUN (Fneq, 2);
1552EXFUN (Fzerop, 1);
1553EXFUN (Fplus, MANY);
1554EXFUN (Fminus, MANY);
1555EXFUN (Ftimes, MANY);
1556EXFUN (Fquo, MANY);
1557EXFUN (Frem, 2);
1558EXFUN (Fmax, MANY);
1559EXFUN (Fmin, MANY);
1560EXFUN (Flogand, MANY);
1561EXFUN (Flogior, MANY);
1562EXFUN (Flogxor, MANY);
1563EXFUN (Flognot, 1);
1564EXFUN (Flsh, 2);
1565EXFUN (Fash, 2);
1566
1567EXFUN (Fadd1, 1);
1568EXFUN (Fsub1, 1);
1569
1570extern Lisp_Object long_to_cons P_ ((unsigned long));
1571extern unsigned long cons_to_long P_ ((Lisp_Object));
1572extern void args_out_of_range P_ ((Lisp_Object, Lisp_Object));
1573extern void args_out_of_range_3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
1574extern Lisp_Object wrong_type_argument P_ ((Lisp_Object, Lisp_Object));
1575extern void store_symval_forwarding P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
1576extern Lisp_Object do_symval_forwarding P_ ((Lisp_Object));
3cfe6dfd 1577
a37e10f9 1578/* Defined in cmds.c */
2f69f2ec
RS
1579EXFUN (Fend_of_line, 1);
1580EXFUN (Fforward_char, 1);
1581EXFUN (Fforward_line, 1);
a37e10f9 1582
6b768554 1583/* Defined in coding.c */
2f69f2ec
RS
1584EXFUN (Fcoding_system_p, 1);
1585EXFUN (Fcheck_coding_system, 1);
1586EXFUN (Fread_coding_system, 1);
1587EXFUN (Fread_non_nil_coding_system, 1);
a154f406 1588EXFUN (Ffind_operation_coding_system, MANY);
6b768554 1589
a37e10f9 1590/* Defined in syntax.c */
2f69f2ec
RS
1591EXFUN (Fforward_word, 1);
1592EXFUN (Fskip_chars_forward, 2);
1593EXFUN (Fskip_chars_backward, 2);
a37e10f9 1594
3cfe6dfd
JB
1595/* Defined in fns.c */
1596extern Lisp_Object Qstring_lessp;
1597extern Lisp_Object Vfeatures;
2f69f2ec
RS
1598EXFUN (Fidentity, 1);
1599EXFUN (Frandom, 1);
1600EXFUN (Flength, 1);
1601EXFUN (Fsafe_length, 1);
1602EXFUN (Fappend, MANY);
1603EXFUN (Fconcat, MANY);
1604EXFUN (Fvconcat, MANY);
1605EXFUN (Fcopy_sequence, 1);
1606EXFUN (Fsubstring, 3);
1607EXFUN (Fnth, 2);
1608EXFUN (Fnthcdr, 2);
1609EXFUN (Fmemq, 2);
1610EXFUN (Fassq, 2);
1611EXFUN (Fassoc, 2);
1612EXFUN (Felt, 2);
1613EXFUN (Fmember, 2);
1614EXFUN (Frassq, 2);
1615EXFUN (Fdelq, 2);
1616EXFUN (Fsort, 2);
1617EXFUN (Freverse, 1);
1618EXFUN (Fnreverse, 1);
1619EXFUN (Fget, 2);
1620EXFUN (Fput, 3);
1621EXFUN (Fequal, 2);
1622EXFUN (Ffillarray, 2);
1623EXFUN (Fnconc, MANY);
1624EXFUN (Fmapcar, 2);
1625EXFUN (Fmapconcat, 3);
1626EXFUN (Fy_or_n_p, 1);
1627extern Lisp_Object do_yes_or_no_p P_ ((Lisp_Object));
1628EXFUN (Ffeaturep, 1);
1629EXFUN (Frequire, 2);
1630EXFUN (Fprovide, 1);
1631extern Lisp_Object concat2 P_ ((Lisp_Object, Lisp_Object));
1632extern Lisp_Object concat3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
1633extern Lisp_Object nconc2 P_ ((Lisp_Object, Lisp_Object));
1634extern Lisp_Object assq_no_quit P_ ((Lisp_Object, Lisp_Object));
1635EXFUN (Fcopy_alist, 1);
1636EXFUN (Fplist_get, 2);
1637EXFUN (Fset_char_table_parent, 2);
1638EXFUN (Fchar_table_extra_slot, 2);
1639EXFUN (Frassoc, 2);
1640EXFUN (Fstring_equal, 2);
1641EXFUN (Fstring_lessp, 2);
1642
1643/* Defined in floatfns.c */
1644#ifdef LISP_FLOAT_TYPE
1645extern double extract_float P_ ((Lisp_Object));
1646EXFUN (Ffloat, 1);
1647#endif /* LISP_FLOAT_TYPE */
1648EXFUN (Ftruncate, 2);
3cfe6dfd 1649
c98adc1b 1650/* Defined in insdel.c */
2f69f2ec
RS
1651extern void move_gap P_ ((int));
1652extern void make_gap P_ ((int));
1653extern void insert P_ ((unsigned char *, int));
1654extern void insert_and_inherit P_ ((unsigned char *, int));
1655extern void insert_1 P_ ((unsigned char *, int, int, int));
1656extern void insert_from_string P_ ((Lisp_Object, int, int, int));
1657extern void insert_from_buffer P_ ((struct buffer *, int, int, int));
1658extern void insert_char P_ ((int));
1659extern void insert_string P_ ((char *));
1660extern void insert_before_markers P_ ((unsigned char *, int));
1661extern void insert_before_markers_and_inherit P_ ((unsigned char *, int));
1662extern void insert_from_string_before_markers P_ ((Lisp_Object, int, int, int));
1663extern void del_range P_ ((int, int));
1664extern void del_range_1 P_ ((int, int, int));
1665extern void modify_region P_ ((struct buffer *, int, int));
1666extern void prepare_to_modify_buffer P_ ((int, int, int *));
1667extern void signal_before_change P_ ((int, int, int *));
1668extern void signal_after_change P_ ((int, int, int));
c98adc1b 1669
1747fb16 1670/* Defined in dispnew.c */
2f69f2ec
RS
1671EXFUN (Fding, 1);
1672EXFUN (Fredraw_display, 0);
1673EXFUN (Fsleep_for, 2);
1674EXFUN (Fsit_for, 3);
1747fb16 1675
c98adc1b 1676/* Defined in xdisp.c */
439ae27b 1677extern Lisp_Object Vmessage_log_max;
2f69f2ec
RS
1678extern void message P_ ((/* char *, ... */));
1679extern void message_nolog P_ ((/* char *, ... */));
1680extern void message1 P_ ((char *));
1681extern void message1_nolog P_ ((char *));
1682extern void message2 P_ ((char *, int));
1683extern void message2_nolog P_ ((char *, int));
1684extern void message_dolog P_ ((char *, int, int));
1685extern void message_log_maybe_newline P_ ((void));
c98adc1b 1686
3cfe6dfd
JB
1687/* Defined in alloc.c */
1688extern Lisp_Object Vpurify_flag;
2f69f2ec
RS
1689EXFUN (Fcons, 2);
1690EXFUN (Flist, MANY);
1691EXFUN (Fmake_list, 2);
1692extern Lisp_Object allocate_misc P_ ((void));
1693EXFUN (Fmake_vector, 2);
1694EXFUN (Fvector, MANY);
1695EXFUN (Fmake_symbol, 1);
1696EXFUN (Fmake_marker, 0);
1697EXFUN (Fmake_string, 2);
1698extern Lisp_Object build_string P_ ((char *));
1699extern Lisp_Object make_string P_ ((char *, int));
1700extern Lisp_Object make_event_array P_ ((int, Lisp_Object *));
1701extern Lisp_Object make_uninit_string P_ ((int));
1702EXFUN (Fpurecopy, 1);
1703extern Lisp_Object make_pure_string P_ ((char *, int));
1704extern Lisp_Object pure_cons P_ ((Lisp_Object, Lisp_Object));
1705extern Lisp_Object make_pure_vector P_ ((EMACS_INT));
1706EXFUN (Fgarbage_collect, 0);
1707EXFUN (Fmake_byte_code, MANY);
1708EXFUN (Fmake_bool_vector, 2);
1709EXFUN (Fmake_char_table, 2);
1710extern Lisp_Object make_sub_char_table P_ ((Lisp_Object));
7f73dc9d 1711extern Lisp_Object Qchar_table_extra_slots;
2f69f2ec 1712extern struct Lisp_Vector *allocate_vectorlike P_ ((EMACS_INT));
4d57802e 1713extern int gc_in_progress;
2f69f2ec
RS
1714#ifdef LISP_FLOAT_TYPE
1715extern Lisp_Object make_float P_ ((double));
1716#endif /* LISP_FLOAT_TYPE */
3cfe6dfd
JB
1717
1718/* Defined in print.c */
1719extern Lisp_Object Vprin1_to_string_buffer;
2f69f2ec
RS
1720EXFUN (Fprin1, 2);
1721EXFUN (Fprin1_to_string, 2);
1722EXFUN (Fprinc, 2);
1723EXFUN (Fterpri, 1);
1724EXFUN (Fprint, 2);
1725EXFUN (Ferror_message_string, 1);
3cfe6dfd 1726extern Lisp_Object Vstandard_output, Qstandard_output;
9453ea7b 1727extern Lisp_Object Qexternal_debugging_output;
2f69f2ec 1728extern void temp_output_buffer_setup P_ ((char *));
3cfe6dfd
JB
1729extern int print_level, print_escape_newlines;
1730extern Lisp_Object Qprint_escape_newlines;
1731
1732/* Defined in lread.c */
1733extern Lisp_Object Qvariable_documentation, Qstandard_input;
1734extern Lisp_Object Vobarray, Vstandard_input;
2f69f2ec
RS
1735EXFUN (Fread, 1);
1736EXFUN (Fread_from_string, 3);
1737EXFUN (Fintern, 2);
1738EXFUN (Fintern_soft, 2);
5d8c7983 1739EXFUN (Fload, 5);
2f69f2ec
RS
1740EXFUN (Fget_file_char, 0);
1741EXFUN (Fread_char, 0);
1742extern Lisp_Object read_filtered_event P_ ((int, int, int));
1743EXFUN (Feval_region, 3);
1744extern Lisp_Object intern P_ ((char *));
1745extern Lisp_Object make_symbol P_ ((char *));
1746extern Lisp_Object oblookup P_ ((Lisp_Object, char *, int));
c5e3de70
RS
1747#define LOADHIST_ATTACH(x) \
1748 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
1749extern Lisp_Object Vcurrent_load_list;
1750extern Lisp_Object Vload_history;
3cfe6dfd
JB
1751
1752/* Defined in eval.c */
1753extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
ad236261 1754extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
3cfe6dfd
JB
1755extern Lisp_Object Vmocklisp_arguments, Qmocklisp, Qmocklisp_arguments;
1756extern Lisp_Object Vautoload_queue;
973e8873 1757extern Lisp_Object Vdebug_on_error;
f1b6e5fc
SM
1758/* To run a normal hook, use the appropriate function from the list below.
1759 The calling convention:
1760
846d69ac 1761 if (!NILP (Vrun_hooks))
f1b6e5fc
SM
1762 call1 (Vrun_hooks, Qmy_funny_hook);
1763
1764 should no longer be used. */
3cfe6dfd 1765extern Lisp_Object Vrun_hooks;
2f69f2ec
RS
1766EXFUN (Frun_hooks, MANY);
1767EXFUN (Frun_hook_with_args, MANY);
1768EXFUN (Frun_hook_with_args_until_success, MANY);
1769EXFUN (Frun_hook_with_args_until_failure, MANY);
1770EXFUN (Fand, UNEVALLED);
1771EXFUN (For, UNEVALLED);
1772EXFUN (Fif, UNEVALLED);
1773EXFUN (Fprogn, UNEVALLED);
1774EXFUN (Fprog1, UNEVALLED);
1775EXFUN (Fprog2, UNEVALLED);
1776EXFUN (Fsetq, UNEVALLED);
1777EXFUN (Fquote, UNEVALLED);
1778EXFUN (Fuser_variable_p, 1);
1779EXFUN (Finteractive_p, 0);
1780EXFUN (Fdefun, UNEVALLED);
1781EXFUN (Flet, UNEVALLED);
1782EXFUN (FletX, UNEVALLED);
1783EXFUN (Fwhile, UNEVALLED);
1784EXFUN (Fcatch, UNEVALLED);
1785EXFUN (Fthrow, 2);
1786EXFUN (Funwind_protect, UNEVALLED);
1787EXFUN (Fcondition_case, UNEVALLED);
1788EXFUN (Fsignal, 2);
1789EXFUN (Fautoload, 5);
1790EXFUN (Fcommandp, 1);
1791EXFUN (Feval, 1);
1792EXFUN (Fapply, MANY);
1793EXFUN (Ffuncall, MANY);
1794EXFUN (Fbacktrace, 0);
1795extern Lisp_Object apply1 P_ ((Lisp_Object, Lisp_Object));
1796extern Lisp_Object call0 P_ ((Lisp_Object));
1797extern Lisp_Object call1 P_ ((Lisp_Object, Lisp_Object));
1798extern Lisp_Object call2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
1799extern Lisp_Object call3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
1800extern Lisp_Object call4 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
1801extern Lisp_Object call5 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
1802extern Lisp_Object call6 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
1803EXFUN (Fdo_auto_save, 2);
1804extern Lisp_Object apply_lambda P_ ((Lisp_Object, Lisp_Object, int));
1805extern Lisp_Object internal_catch P_ ((Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object));
1806extern Lisp_Object internal_condition_case P_ ((Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object)));
1807extern Lisp_Object internal_condition_case_1 P_ ((Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
1808extern Lisp_Object unbind_to P_ ((int, Lisp_Object));
1809extern void error P_ ((/* char *, ... */));
1810extern Lisp_Object un_autoload P_ ((Lisp_Object));
1811EXFUN (Ffetch_bytecode, 1);
3cfe6dfd
JB
1812
1813/* Defined in editfns.c */
2f69f2ec
RS
1814EXFUN (Fgoto_char, 1);
1815EXFUN (Fpoint_min_marker, 0);
1816EXFUN (Fpoint_max_marker, 0);
1817EXFUN (Fpoint_min, 0);
1818EXFUN (Fpoint_max, 0);
1819EXFUN (Fpoint, 0);
1820EXFUN (Fpoint_marker, 0);
1821EXFUN (Fmark_marker, 0);
1822EXFUN (Fline_beginning_position, 1);
1823EXFUN (Fline_end_position, 1);
1824EXFUN (Ffollowing_char, 0);
1825EXFUN (Fprevious_char, 0);
1826EXFUN (Fchar_after, 1);
1827EXFUN (Finsert, MANY);
1828EXFUN (Finsert_and_inherit, MANY);
1829EXFUN (Finsert_before_markers, MANY);
1830EXFUN (Finsert_buffer_substring, 3);
1831EXFUN (Finsert_char, 3);
1832EXFUN (Feolp, 0);
1833EXFUN (Feobp, 0);
1834EXFUN (Fbolp, 0);
1835EXFUN (Fbobp, 0);
1836EXFUN (Fformat, MANY);
1837extern Lisp_Object format1 P_ ((/* char *, ... */));
1838extern Lisp_Object make_buffer_string P_ ((int, int, int));
1839EXFUN (Fbuffer_substring, 2);
1840EXFUN (Fbuffer_string, 0);
1841extern Lisp_Object save_excursion_save P_ ((void));
1842extern Lisp_Object save_restriction_save P_ ((void));
1843extern Lisp_Object save_excursion_restore P_ ((Lisp_Object));
1844extern Lisp_Object save_restriction_restore P_ ((Lisp_Object));
1845EXFUN (Fchar_to_string, 1);
1846EXFUN (Fdelete_region, 2);
1847EXFUN (Fnarrow_to_region, 2);
1848EXFUN (Fwiden, 0);
1849EXFUN (Fuser_login_name, 1);
1850EXFUN (Fsystem_name, 0);
3cfe6dfd
JB
1851
1852/* defined in buffer.c */
2f69f2ec
RS
1853EXFUN (Foverlay_start, 1);
1854EXFUN (Foverlay_end, 1);
1855extern void adjust_overlays_for_insert P_ ((int, int));
1856extern void adjust_overlays_for_delete P_ ((int, int));
1857extern void fix_overlays_in_range P_ ((int, int));
1858extern int overlay_touches_p P_ ((int));
628300ba 1859extern Lisp_Object Vbuffer_alist, Vinhibit_read_only;
2f69f2ec
RS
1860EXFUN (Fget_buffer, 1);
1861EXFUN (Fget_buffer_create, 1);
1862EXFUN (Fset_buffer, 1);
1863EXFUN (Fbarf_if_buffer_read_only, 0);
1864EXFUN (Fcurrent_buffer, 0);
1865EXFUN (Fswitch_to_buffer, 2);
1866EXFUN (Fpop_to_buffer, 3);
1867EXFUN (Fother_buffer, 2);
1868EXFUN (Foverlay_get, 2);
1869EXFUN (Fbuffer_modified_p, 1);
1870EXFUN (Fset_buffer_modified_p, 1);
1871EXFUN (Fkill_buffer, 1);
1872EXFUN (Fkill_all_local_variables, 0);
1873EXFUN (Fbuffer_disable_undo, 1);
1874EXFUN (Fbuffer_enable_undo, 1);
1875EXFUN (Ferase_buffer, 0);
20280af7 1876extern Lisp_Object Qoverlayp;
2f69f2ec 1877extern Lisp_Object get_truename_buffer P_ ((Lisp_Object));
3cfe6dfd 1878extern struct buffer *all_buffers;
2f69f2ec 1879EXFUN (Fprevious_overlay_change, 1);
3cfe6dfd
JB
1880
1881/* defined in marker.c */
1882
2f69f2ec
RS
1883EXFUN (Fmarker_position, 1);
1884EXFUN (Fmarker_buffer, 1);
1885EXFUN (Fcopy_marker, 2);
1886EXFUN (Fset_marker, 3);
3cfe6dfd
JB
1887
1888/* Defined in fileio.c */
1889
1890extern Lisp_Object Qfile_error;
2f69f2ec
RS
1891EXFUN (Ffind_file_name_handler, 2);
1892EXFUN (Ffile_name_as_directory, 1);
1893EXFUN (Fexpand_file_name, 2);
1894EXFUN (Ffile_name_nondirectory, 1);
1895EXFUN (Fsubstitute_in_file_name, 1);
1896EXFUN (Ffile_symlink_p, 1);
1897EXFUN (Fverify_visited_file_modtime, 1);
1898EXFUN (Ffile_exists_p, 1);
1899EXFUN (Ffile_name_absolute_p, 1);
1900EXFUN (Fdirectory_file_name, 1);
1901EXFUN (Ffile_name_directory, 1);
1902extern Lisp_Object expand_and_dir_to_file P_ ((Lisp_Object, Lisp_Object));
1903EXFUN (Ffile_accessible_directory_p, 1);
1904EXFUN (Funhandled_file_name_directory, 1);
1905EXFUN (Ffile_directory_p, 1);
1906EXFUN (Fwrite_region, 6);
1907EXFUN (Ffile_readable_p, 1);
1908EXFUN (Ffile_executable_p, 1);
1909EXFUN (Fread_file_name, 5);
3cfe6dfd
JB
1910
1911/* Defined in abbrev.c */
1912
1913extern Lisp_Object Vfundamental_mode_abbrev_table;
1914
1915/* defined in search.c */
2f69f2ec
RS
1916EXFUN (Fstring_match, 3);
1917extern void restore_match_data P_ ((void));
1918EXFUN (Fmatch_data, 2);
1919EXFUN (Fstore_match_data, 1);
1920EXFUN (Fmatch_beginning, 1);
1921EXFUN (Fmatch_end, 1);
3cfe6dfd
JB
1922
1923/* defined in minibuf.c */
1924
1925extern Lisp_Object last_minibuf_string;
5593f7e3
KH
1926EXFUN (Fcompleting_read, 8);
1927EXFUN (Fread_from_minibuffer, 7);
2f69f2ec
RS
1928EXFUN (Fread_variable, 2);
1929EXFUN (Fread_buffer, 3);
1930EXFUN (Fread_minibuffer, 2);
1931EXFUN (Feval_minibuffer, 2);
5593f7e3
KH
1932EXFUN (Fread_string, 5);
1933EXFUN (Fread_no_blanks_input, 3);
2f69f2ec 1934extern Lisp_Object get_minibuffer P_ ((int));
3cfe6dfd
JB
1935
1936/* Defined in callint.c */
1937
de7885bb 1938extern Lisp_Object Qminus, Qplus, Vcurrent_prefix_arg;
3cfe6dfd 1939extern Lisp_Object Vcommand_history;
7fd61057 1940extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
2f69f2ec
RS
1941EXFUN (Fcall_interactively, 3);
1942EXFUN (Fprefix_numeric_value, 1);
3cfe6dfd
JB
1943
1944/* defined in casefiddle.c */
1945
2f69f2ec
RS
1946EXFUN (Fdowncase, 1);
1947EXFUN (Fupcase, 1);
1948EXFUN (Fcapitalize, 1);
1949EXFUN (Fupcase_region, 2);
1950EXFUN (Fupcase_initials, 1);
1951EXFUN (Fupcase_initials_region, 2);
3cfe6dfd 1952
1747fb16
RS
1953/* defined in casetab.c */
1954
2f69f2ec
RS
1955EXFUN (Fset_case_table, 1);
1956EXFUN (Fset_standard_case_table, 1);
1747fb16 1957
3cfe6dfd
JB
1958/* defined in keyboard.c */
1959
1960extern Lisp_Object Qdisabled;
4b657f72 1961extern Lisp_Object Vtty_erase_char, Vhelp_form, Vtop_level;
2f69f2ec
RS
1962EXFUN (Fdiscard_input, 0);
1963EXFUN (Frecursive_edit, 0);
1964EXFUN (Fcommand_execute, 4);
1965EXFUN (Finput_pending_p, 0);
1966extern Lisp_Object menu_bar_items P_ ((Lisp_Object));
f498e3b2 1967extern Lisp_Object Qvertical_scroll_bar;
2f69f2ec 1968EXFUN (Fevent_convert_list, 1);
5647f04f 1969#ifdef MULTI_KBOARD
2f69f2ec 1970extern void delete_kboard P_ ((/* KBOARD * */));
5647f04f 1971#endif
2f69f2ec 1972EXFUN (Fread_key_sequence, 4);
3cfe6dfd
JB
1973
1974/* defined in keymap.c */
1975
c451d7b1 1976extern Lisp_Object Qkeymap, Qmenu_bar;
3cfe6dfd 1977extern Lisp_Object current_global_map;
2f69f2ec
RS
1978EXFUN (Fdefine_key, 3);
1979EXFUN (Fkey_binding, 2);
1980EXFUN (Fkey_description, 1);
1981EXFUN (Fsingle_key_description, 1);
1982EXFUN (Fwhere_is_internal, 4);
1983extern Lisp_Object access_keymap P_ ((Lisp_Object, Lisp_Object, int, int));
1984extern Lisp_Object store_in_keymap P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
1985extern Lisp_Object get_keyelt P_ ((Lisp_Object, int));
1986extern Lisp_Object get_keymap P_ ((Lisp_Object));
1987extern Lisp_Object get_keymap_1 P_ ((Lisp_Object, int, int));
1988extern void describe_map_tree P_ ((Lisp_Object, int, Lisp_Object, Lisp_Object, char *, int, int, int));
3cfe6dfd
JB
1989
1990/* defined in indent.c */
2f69f2ec
RS
1991EXFUN (Fvertical_motion, 2);
1992EXFUN (Findent_to, 2);
1993EXFUN (Fcurrent_column, 0);
1994EXFUN (Fmove_to_column, 2);
3cfe6dfd
JB
1995
1996/* defined in window.c */
afd0d237 1997extern Lisp_Object Qwindowp, Qwindow_live_p;
2f69f2ec
RS
1998EXFUN (Fselected_window, 0);
1999EXFUN (Fget_buffer_window, 2);
2000EXFUN (Fsave_window_excursion, UNEVALLED);
2001EXFUN (Fset_window_configuration, 1);
2002EXFUN (Fcurrent_window_configuration, 1);
2003EXFUN (Fcoordinates_in_window_p, 2);
2004EXFUN (Fwindow_at, 3);
2005EXFUN (Fpos_visible_in_window_p, 2);
2006extern int window_internal_height P_ ((/* struct window * */));
2007extern int window_internal_width P_ ((/* struct window * */));
2008EXFUN (Frecenter, 1);
2009EXFUN (Fscroll_other_window, 1);
2010EXFUN (Fset_window_start, 3);
2011extern void temp_output_buffer_show P_ ((Lisp_Object));
3cfe6dfd 2012
ff11dfa1 2013/* defined in frame.c */
362fb47a 2014extern Lisp_Object Qvisible;
2f69f2ec
RS
2015extern void store_frame_param P_ ((/* struct frame *, Lisp_Object, Lisp_Object */));
2016extern void store_in_alist P_ ((Lisp_Object *, Lisp_Object, Lisp_Object));
2017extern Lisp_Object do_switch_frame P_ ((Lisp_Object, Lisp_Object, int));
2018extern Lisp_Object get_frame_param P_ ((/* struct frame *, Lisp_Object */));
2019extern Lisp_Object frame_buffer_predicate P_ ((void));
2020EXFUN (Fframep, 1);
2021EXFUN (Fselect_frame, 2);
2022EXFUN (Fselected_frame, 0);
2023EXFUN (Fwindow_frame, 1);
2024EXFUN (Fframe_root_window, 1);
2025EXFUN (Fframe_first_window, 1);
2026EXFUN (Fframe_selected_window, 1);
2027EXFUN (Fframe_list, 0);
2028EXFUN (Fnext_frame, 2);
2029EXFUN (Fdelete_frame, 2);
2030EXFUN (Fset_mouse_position, 3);
2031EXFUN (Fmake_frame_visible, 1);
2032EXFUN (Fmake_frame_invisible, 2);
2033EXFUN (Ficonify_frame, 1);
2034EXFUN (Fframe_visible_p, 1);
2035EXFUN (Fvisible_frame_list, 0);
2036EXFUN (Fframe_parameters, 1);
2037EXFUN (Fmodify_frame_parameters, 2);
2038EXFUN (Fset_frame_height, 3);
2039EXFUN (Fset_frame_width, 3);
2040EXFUN (Fset_frame_size, 3);
2041EXFUN (Fset_frame_position, 3);
2042EXFUN (Fraise_frame, 1);
2043EXFUN (Fredirect_frame_focus, 2);
2044extern Lisp_Object frame_buffer_list P_ ((void));
3cfe6dfd
JB
2045
2046/* defined in emacs.c */
2f69f2ec 2047extern Lisp_Object decode_env_path P_ ((char *, char *));
3530d534 2048extern Lisp_Object Vinvocation_name, Vinvocation_directory;
e6faba7f 2049extern Lisp_Object Vinstallation_directory;
2f69f2ec
RS
2050EXFUN (Fkill_emacs, 1);
2051void shut_down_emacs P_ ((int, int, Lisp_Object));
3cfe6dfd
JB
2052/* Nonzero means don't do interactive redisplay and don't change tty modes */
2053extern int noninteractive;
2054/* Nonzero means don't do use window-system-specific display code */
2055extern int inhibit_window_system;
99a3d506 2056/* Nonzero means that a filter or a sentinel is running. */
7074fde6 2057extern int running_asynch_code;
3cfe6dfd
JB
2058
2059/* defined in process.c */
2f69f2ec
RS
2060EXFUN (Fget_process, 1);
2061EXFUN (Fget_buffer_process, 1);
2062EXFUN (Fprocessp, 1);
2063EXFUN (Fprocess_status, 1);
2064EXFUN (Fkill_process, 2);
2065EXFUN (Fprocess_send_eof, 1);
2066EXFUN (Fwaiting_for_user_input_p, 0);
6efad63b 2067extern Lisp_Object Qprocessp;
3cfe6dfd
JB
2068
2069/* defined in callproc.c */
9453ea7b 2070extern Lisp_Object Vexec_path, Vexec_directory, Vdata_directory;
c65be0e1 2071extern Lisp_Object Vdoc_directory;
3cfe6dfd 2072
3cfe6dfd
JB
2073/* defined in doc.c */
2074extern Lisp_Object Vdoc_file_name;
2f69f2ec
RS
2075EXFUN (Fsubstitute_command_keys, 1);
2076EXFUN (Fdocumentation, 2);
2077EXFUN (Fdocumentation_property, 3);
2078extern Lisp_Object read_doc_string P_ ((Lisp_Object));
3cfe6dfd
JB
2079
2080/* defined in bytecode.c */
2081extern Lisp_Object Qbytecode;
2f69f2ec 2082EXFUN (Fbyte_code, 3);
3cfe6dfd
JB
2083
2084/* defined in macros.c */
2085extern Lisp_Object Qexecute_kbd_macro;
2f69f2ec 2086EXFUN (Fexecute_kbd_macro, 2);
3cfe6dfd 2087
d20c2151 2088/* defined in undo.c */
a387611b 2089extern Lisp_Object Qinhibit_read_only;
2f69f2ec
RS
2090EXFUN (Fundo_boundary, 0);
2091extern Lisp_Object truncate_undo_list P_ ((Lisp_Object, int, int));
d20c2151 2092
8537f1cb 2093/* defined in textprop.c */
c2d8811c 2094extern Lisp_Object Qmodification_hooks;
23bc39b5 2095extern Lisp_Object Qrear_nonsticky, Qfont;
c2d8811c 2096extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
2f69f2ec
RS
2097EXFUN (Fnext_property_change, 3);
2098EXFUN (Fnext_single_property_change, 4);
2099EXFUN (Fprevious_single_property_change, 4);
2100EXFUN (Fget_text_property, 3);
2101EXFUN (Fput_text_property, 5);
2102EXFUN (Fset_text_properties, 4);
2103EXFUN (Ftext_property_not_all, 5);
2104EXFUN (Fprevious_char_property_change, 2);
2105EXFUN (Fnext_char_property_change, 2);
8537f1cb 2106
40131ef5 2107/* defined in intervals.c */
2f69f2ec 2108extern Lisp_Object get_local_map P_ ((int, struct buffer *));
40131ef5
KH
2109
2110/* defined in xmenu.c */
2f69f2ec
RS
2111EXFUN (Fx_popup_menu, 2);
2112EXFUN (Fx_popup_dialog, 2);
40131ef5 2113\f
3cfe6dfd
JB
2114/* Nonzero means Emacs has already been initialized.
2115 Used during startup to detect startup of dumped Emacs. */
2116extern int initialized;
2117
2118extern int immediate_quit; /* Nonzero means ^G can quit instantly */
2119
2120extern void debugger ();
2121
339747e4 2122extern char *getenv (), *ctime (), *getwd ();
3cfe6dfd 2123extern long *xmalloc (), *xrealloc ();
9ac0d9e0 2124extern void xfree ();
3cfe6dfd 2125
efb859b4 2126extern char *egetenv ();
e98227af 2127
5d6be39f
KH
2128/* Set up the name of the machine we're running on. */
2129extern void init_system_name ();
881a5a80
RS
2130
2131/* Some systems (e.g., NT) use a different path separator than Unix,
2132 in addition to a device separator. Default the path separator
2133 to '/', and don't test for a device separator in IS_ANY_SEP. */
2134
e0c07012
RS
2135#ifdef WINDOWSNT
2136extern Lisp_Object Vdirectory_sep_char;
2137#endif
2138
881a5a80
RS
2139#ifndef DIRECTORY_SEP
2140#define DIRECTORY_SEP '/'
2141#endif
881a5a80
RS
2142#ifndef IS_DIRECTORY_SEP
2143#define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
2144#endif
2145#ifndef IS_DEVICE_SEP
2146#ifndef DEVICE_SEP
2147#define IS_DEVICE_SEP(_c_) 0
2148#else
2149#define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
2150#endif
2151#endif
2152#ifndef IS_ANY_SEP
2153#define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
2154#endif
51bd4610
KH
2155
2156#ifdef SWITCH_ENUM_BUG
2157#define SWITCH_ENUM_CAST(x) ((int)(x))
2158#else
2159#define SWITCH_ENUM_CAST(x) (x)
2160#endif