Add cygwin32; Put eabi .sdata2/.sbss2 into read-only memory
[bpt/emacs.git] / src / lisp.h
CommitLineData
3cfe6dfd 1/* Fundamental definitions for GNU Emacs Lisp interpreter.
e07d7a05 2 Copyright (C) 1985,86,87,93,94,95 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
25#endif
26#ifndef EMACS_UINT
27#define EMACS_UINT unsigned int
28#endif
29
99a3d506 30/* Define the fundamental Lisp data structures. */
3cfe6dfd 31
99a3d506 32/* This is the set of Lisp data types. */
3cfe6dfd
JB
33
34enum Lisp_Type
35 {
99a3d506 36 /* Integer. XINT (obj) is the integer value. */
3cfe6dfd
JB
37 Lisp_Int,
38
99a3d506 39 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
3cfe6dfd
JB
40 Lisp_Symbol,
41
84d1833e
KH
42 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
43 whose first member indicates the subtype. */
44 Lisp_Misc,
3cfe6dfd
JB
45
46 /* String. XSTRING (object) points to a struct Lisp_String.
99a3d506 47 The length of the string, and its contents, are stored therein. */
3cfe6dfd
JB
48 Lisp_String,
49
b5088f80 50 /* Vector of Lisp objects, or something resembling it.
7c06ac2b 51 XVECTOR (object) points to a struct Lisp_Vector, which contains
b5088f80
KH
52 the size and contents. The size field also contains the type
53 information, if it's not a real vector object. */
54 Lisp_Vectorlike,
3cfe6dfd 55
99a3d506 56 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
3cfe6dfd
JB
57 Lisp_Cons,
58
3cfe6dfd 59#ifdef LISP_FLOAT_TYPE
20280af7 60 Lisp_Float,
3cfe6dfd 61#endif /* LISP_FLOAT_TYPE */
4d1207f6
RS
62
63 /* This is not a type code. It is for range checking. */
e2ba196c 64 Lisp_Type_Limit
3cfe6dfd
JB
65 };
66
84d1833e 67/* This is the set of datatypes that share a common structure.
c98adc1b
KH
68 The first member of the structure is a type code from this set.
69 The enum values are arbitrary, but we'll use large numbers to make it
70 more likely that we'll spot the error if a random word in memory is
71 mistakenly interpreted as a Lisp_Misc. */
1c4ca5a3
KH
72enum Lisp_Misc_Type
73 {
c98adc1b 74 Lisp_Misc_Free = 0x5eab,
84d1833e 75 Lisp_Misc_Marker,
ee4c9ce4
KH
76 Lisp_Misc_Intfwd,
77 Lisp_Misc_Boolfwd,
78 Lisp_Misc_Objfwd,
7d65f1c2
KH
79 Lisp_Misc_Buffer_Objfwd,
80 Lisp_Misc_Buffer_Local_Value,
ce7d8eec 81 Lisp_Misc_Some_Buffer_Local_Value,
99a3d506 82 Lisp_Misc_Overlay,
32462604 83 Lisp_Misc_Kboard_Objfwd,
99a3d506
RS
84 /* Currently floats are not a misc type,
85 but let's define this in case we want to change that. */
86 Lisp_Misc_Float,
87 /* This is not a type code. It is for range checking. */
88 Lisp_Misc_Limit
1c4ca5a3
KH
89 };
90
e2ba196c
KH
91/* These values are overridden by the m- file on some machines. */
92#ifndef VALBITS
93#define VALBITS 28
94#endif
95
96#ifndef GCTYPEBITS
97#define GCTYPEBITS 3
98#endif
99
c9ddd39d
KH
100/* Make these values available in GDB, which sees enums but not macros. */
101
102enum gdb_lisp_params
103{
104 gdb_valbits = VALBITS,
105 gdb_gctypebits = GCTYPEBITS,
68be917d 106 gdb_emacs_intbits = sizeof (EMACS_INT) * BITS_PER_CHAR,
c9ddd39d
KH
107#ifdef DATA_SEG_BITS
108 gdb_data_seg_bits = DATA_SEG_BITS
109#else
110 gdb_data_seg_bits = 0
111#endif
112};
113
3cfe6dfd
JB
114#ifndef NO_UNION_TYPE
115
c451d7b1 116#ifndef WORDS_BIG_ENDIAN
3cfe6dfd
JB
117
118/* Definition of Lisp_Object for little-endian machines. */
119
120typedef
121union Lisp_Object
122 {
123 /* Used for comparing two Lisp_Objects;
99a3d506 124 also, positive integers can be accessed fast this way. */
3cfe6dfd
JB
125 int i;
126
127 struct
128 {
e2ba196c
KH
129 int val: VALBITS;
130 int type: GCTYPEBITS+1;
3cfe6dfd
JB
131 } s;
132 struct
133 {
e2ba196c
KH
134 unsigned int val: VALBITS;
135 int type: GCTYPEBITS+1;
3cfe6dfd
JB
136 } u;
137 struct
138 {
e2ba196c
KH
139 unsigned int val: VALBITS;
140 enum Lisp_Type type: GCTYPEBITS;
3cfe6dfd
JB
141 /* The markbit is not really part of the value of a Lisp_Object,
142 and is always zero except during garbage collection. */
143 unsigned int markbit: 1;
144 } gu;
145 }
146Lisp_Object;
147
c451d7b1 148#else /* If WORDS_BIG_ENDIAN */
3cfe6dfd
JB
149
150typedef
151union Lisp_Object
152 {
153 /* Used for comparing two Lisp_Objects;
99a3d506 154 also, positive integers can be accessed fast this way. */
3cfe6dfd
JB
155 int i;
156
157 struct
158 {
e2ba196c
KH
159 int type: GCTYPEBITS+1;
160 int val: VALBITS;
3cfe6dfd
JB
161 } s;
162 struct
163 {
e2ba196c
KH
164 int type: GCTYPEBITS+1;
165 unsigned int val: VALBITS;
3cfe6dfd
JB
166 } u;
167 struct
168 {
169 /* The markbit is not really part of the value of a Lisp_Object,
170 and is always zero except during garbage collection. */
171 unsigned int markbit: 1;
e2ba196c
KH
172 enum Lisp_Type type: GCTYPEBITS;
173 unsigned int val: VALBITS;
3cfe6dfd
JB
174 } gu;
175 }
176Lisp_Object;
177
c451d7b1 178#endif /* WORDS_BIG_ENDIAN */
3cfe6dfd
JB
179
180#endif /* NO_UNION_TYPE */
181
182
183/* If union type is not wanted, define Lisp_Object as just a number
184 and define the macros below to extract fields by shifting */
185
186#ifdef NO_UNION_TYPE
187
627a9502 188#define Lisp_Object EMACS_INT
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
b5088f80 245
3cfe6dfd
JB
246#endif /* NO_UNION_TYPE */
247\f
248/* These macros extract various sorts of values from a Lisp_Object.
249 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
99a3d506 250 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
3cfe6dfd
JB
251
252#ifdef NO_UNION_TYPE
253
254/* One need to override this if there must be high bits set in data space
255 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
256 on all machines, but would penalise machines which don't need it)
257 */
258#ifndef XTYPE
259#define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
260#endif
261
262#ifndef XSETTYPE
627a9502 263#define XSETTYPE(a, b) ((a) = XUINT (a) | ((EMACS_INT)(b) << VALBITS))
3cfe6dfd
JB
264#endif
265
221f4ef3
KH
266/* For integers known to be positive, XFASTINT provides fast retrieval
267 and XSETFASTINT provides fast storage. This takes advantage of the
268 fact that Lisp_Int is 0. */
e43ec785 269#define XFASTINT(a) ((a) + 0)
221f4ef3 270#define XSETFASTINT(a, b) ((a) = (b))
3cfe6dfd
JB
271
272/* Extract the value of a Lisp_Object as a signed integer. */
273
274#ifndef XINT /* Some machines need to do this differently. */
68be917d 275#define XINT(a) (((a) << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
3cfe6dfd
JB
276#endif
277
278/* Extract the value as an unsigned integer. This is a basis
279 for extracting it as a pointer to a structure in storage. */
280
281#ifndef XUINT
282#define XUINT(a) ((a) & VALMASK)
283#endif
284
285#ifndef XPNTR
286#ifdef HAVE_SHM
287/* In this representation, data is found in two widely separated segments. */
29eab336 288extern int pure_size;
3cfe6dfd 289#define XPNTR(a) \
29eab336 290 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
3cfe6dfd
JB
291#else /* not HAVE_SHM */
292#ifdef DATA_SEG_BITS
293/* This case is used for the rt-pc.
294 In the diffs I was given, it checked for ptr = 0
295 and did not adjust it in that case.
296 But I don't think that zero should ever be found
297 in a Lisp object whose data type says it points to something. */
298#define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
299#else
300#define XPNTR(a) XUINT (a)
301#endif
302#endif /* not HAVE_SHM */
303#endif /* no XPNTR */
304
3cfe6dfd
JB
305#ifndef XSET
306#define XSET(var, type, ptr) \
627a9502 307 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
3cfe6dfd
JB
308#endif
309
b7acde90
KH
310/* Convert a C integer into a Lisp_Object integer. */
311
312#define make_number(N) \
313 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
314
3cfe6dfd
JB
315/* During garbage collection, XGCTYPE must be used for extracting types
316 so that the mark bit is ignored. XMARKBIT accesses the markbit.
317 Markbits are used only in particular slots of particular structure types.
318 Other markbits are always zero.
319 Outside of garbage collection, all mark bits are always zero. */
320
321#ifndef XGCTYPE
322#define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
323#endif
324
68be917d 325#if VALBITS + GCTYPEBITS == BITS_PER_INT - 1
3cfe6dfd
JB
326/* Make XMARKBIT faster if mark bit is sign bit. */
327#ifndef XMARKBIT
328#define XMARKBIT(a) ((a) < 0)
329#endif
330#endif /* markbit is sign bit */
331
332#ifndef XMARKBIT
333#define XMARKBIT(a) ((a) & MARKBIT)
334#endif
335
336#ifndef XSETMARKBIT
337#define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
338#endif
339
340#ifndef XMARK
341#define XMARK(a) ((a) |= MARKBIT)
342#endif
343
344#ifndef XUNMARK
345#define XUNMARK(a) ((a) &= ~MARKBIT)
346#endif
347
348#endif /* NO_UNION_TYPE */
349
350#ifndef NO_UNION_TYPE
351
352#define XTYPE(a) ((enum Lisp_Type) (a).u.type)
353#define XSETTYPE(a, b) ((a).u.type = (char) (b))
354
221f4ef3
KH
355/* For integers known to be positive, XFASTINT provides fast retrieval
356 and XSETFASTINT provides fast storage. This takes advantage of the
357 fact that Lisp_Int is 0. */
e43ec785 358#define XFASTINT(a) ((a).i + 0)
221f4ef3 359#define XSETFASTINT(a, b) ((a).i = (b))
3cfe6dfd
JB
360
361#ifdef EXPLICIT_SIGN_EXTEND
362/* Make sure we sign-extend; compilers have been known to fail to do so. */
68be917d 363#define XINT(a) (((a).i << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
3cfe6dfd
JB
364#else
365#define XINT(a) ((a).s.val)
366#endif /* EXPLICIT_SIGN_EXTEND */
367
368#define XUINT(a) ((a).u.val)
369#define XPNTR(a) ((a).u.val)
3cfe6dfd
JB
370
371#define XSET(var, vartype, ptr) \
372 (((var).s.type = ((char) (vartype))), ((var).s.val = ((int) (ptr))))
373
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
KH
552/* If a struct is made to look like a vector, this macro returns the length
553 of that vector. */
554#define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector) \
555 - sizeof (Lisp_Object))) \
556 / sizeof (Lisp_Object))
557
3cfe6dfd
JB
558struct Lisp_Vector
559 {
627a9502 560 EMACS_INT size;
3cfe6dfd
JB
561 struct Lisp_Vector *next;
562 Lisp_Object contents[1];
563 };
564
608ff985
RS
565/* A char table is a kind of vectorlike, with contents are like a vector
566 but with a few other slots. For some purposes, it makes sense
567 to handle a chartable with type struct Lisp_Vector. */
568
569/* This is the number of slots that apply to characters
570 or character sets. */
571#define CHAR_TABLE_ORDINARY_SLOTS 256
572
573/* This is the number of slots that every char table must have.
574 This counts the ordinary slots and the parent and defalt slots. */
7f73dc9d 575#define CHAR_TABLE_STANDARD_SLOTS (256+3)
608ff985
RS
576
577/* Return the number of "extra" slots in the char table CT. */
578
579#define CHAR_TABLE_EXTRA_SLOTS(CT) \
580 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
581
582struct Lisp_Char_Table
583 {
584 /* This is the vector's size field, which also holds the
585 pseudovector type information. It holds the size, too.
586 The size counts the defalt and parent slots. */
587 EMACS_INT size;
588 struct Lisp_Vector *next;
589 Lisp_Object contents[CHAR_TABLE_ORDINARY_SLOTS];
590 /* This holds a default value,
591 which is used whenever the value for a specific character is nil. */
592 Lisp_Object defalt;
593 /* This points to another char table, which we inherit from
594 when the value for a specific character is nil.
595 The `defalt' slot takes precedence over this. */
596 Lisp_Object parent;
7f73dc9d
RS
597 /* This should be a symbol which says what kind of use
598 this char-table is meant for.
599 Typically now the values can be `syntax-table' and `display-table'. */
600 Lisp_Object purpose;
608ff985
RS
601 /* These hold additional data. */
602 Lisp_Object extras[1];
603 };
604
605/* A boolvector is a kind of vectorlike, with contents are like a string. */
606struct Lisp_Bool_Vector
607 {
608 /* This is the vector's size field. It doesn't have the real size,
609 just the subtype information. */
610 EMACS_INT vector_size;
611 struct Lisp_Vector *next;
612 /* This is the size in bits. */
613 EMACS_INT size;
614 /* This contains the actual bits, packed into bytes. */
615 unsigned char data[1];
616 };
617
3cfe6dfd
JB
618/* In a symbol, the markbit of the plist is used as the gc mark bit */
619
620struct Lisp_Symbol
621 {
622 struct Lisp_String *name;
623 Lisp_Object value;
624 Lisp_Object function;
625 Lisp_Object plist;
626 struct Lisp_Symbol *next; /* -> next symbol in this obarray bucket */
627 };
628
7c06ac2b
RS
629/* This structure describes a built-in function.
630 It is generated by the DEFUN macro only.
631 defsubr makes it into a Lisp object.
632
633 This type is treated in most respects as a pseudovector,
634 but since we never dynamically allocate or free them,
635 we don't need a next-vector field. */
636
3cfe6dfd
JB
637struct Lisp_Subr
638 {
7c06ac2b 639 EMACS_INT size;
3cfe6dfd
JB
640 Lisp_Object (*function) ();
641 short min_args, max_args;
642 char *symbol_name;
643 char *prompt;
644 char *doc;
645 };
ee4c9ce4 646\f
7c06ac2b
RS
647/* These structures are used for various misc types. */
648
ee4c9ce4
KH
649/* A miscellaneous object, when it's on the free list. */
650struct Lisp_Free
651 {
5bfac5a9
RS
652 int type : 16; /* = Lisp_Misc_Free */
653 int spacer : 16;
ee4c9ce4
KH
654 union Lisp_Misc *chain;
655 };
3cfe6dfd
JB
656
657/* In a marker, the markbit of the chain field is used as the gc mark bit */
3cfe6dfd 658struct Lisp_Marker
308e97d0
RS
659{
660 int type : 16; /* = Lisp_Misc_Marker */
661 int spacer : 15;
662 /* 1 means normal insertion at the marker's position
663 leaves the marker after the inserted text. */
664 unsigned int insertion_type : 1;
665 struct buffer *buffer;
666 Lisp_Object chain;
667 int bufpos;
668};
3cfe6dfd 669
ee4c9ce4
KH
670/* Forwarding pointer to an int variable.
671 This is allowed only in the value cell of a symbol,
672 and it means that the symbol's value really lives in the
673 specified int variable. */
674struct Lisp_Intfwd
84d1833e 675 {
5bfac5a9
RS
676 int type : 16; /* = Lisp_Misc_Intfwd */
677 int spacer : 16;
ee4c9ce4
KH
678 int *intvar;
679 };
680
681/* Boolean forwarding pointer to an int variable.
682 This is like Lisp_Intfwd except that the ostensible
683 "value" of the symbol is t if the int variable is nonzero,
684 nil if it is zero. */
685struct Lisp_Boolfwd
686 {
5bfac5a9
RS
687 int type : 16; /* = Lisp_Misc_Boolfwd */
688 int spacer : 16;
ee4c9ce4
KH
689 int *boolvar;
690 };
691
692/* Forwarding pointer to a Lisp_Object variable.
693 This is allowed only in the value cell of a symbol,
694 and it means that the symbol's value really lives in the
695 specified variable. */
696struct Lisp_Objfwd
697 {
5bfac5a9
RS
698 int type : 16; /* = Lisp_Misc_Objfwd */
699 int spacer : 16;
ee4c9ce4
KH
700 Lisp_Object *objvar;
701 };
702
703/* Like Lisp_Objfwd except that value lives in a slot in the
704 current buffer. Value is byte index of slot within buffer. */
705struct Lisp_Buffer_Objfwd
706 {
5bfac5a9
RS
707 int type : 16; /* = Lisp_Misc_Buffer_Objfwd */
708 int spacer : 16;
ee4c9ce4 709 int offset;
84d1833e
KH
710 };
711
7d65f1c2
KH
712/* Used in a symbol value cell when the symbol's value is per-buffer.
713 The actual contents resemble a cons cell which starts a list like this:
714 (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).
715
ce7d8eec
KH
716 The cons-like structure is for historical reasons; it might be better
717 to just put these elements into the struct, now.
718
7d65f1c2
KH
719 BUFFER is the last buffer for which this symbol's value was
720 made up to date.
721
722 CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
723 local_var_alist, that being the element whose car is this
724 variable. Or it can be a pointer to the
725 (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE),
726 if BUFFER does not have an element in its alist for this
727 variable (that is, if BUFFER sees the default value of this
728 variable).
729
730 If we want to examine or set the value and BUFFER is current,
99a3d506 731 we just examine or set REALVALUE. If BUFFER is not current, we
7d65f1c2
KH
732 store the current REALVALUE value into CURRENT-ALIST-ELEMENT,
733 then find the appropriate alist element for the buffer now
734 current and set up CURRENT-ALIST-ELEMENT. Then we set
735 REALVALUE out of that element, and store into BUFFER.
736
737 If we are setting the variable and the current buffer does not
738 have an alist entry for this variable, an alist entry is
739 created.
740
741 Note that REALVALUE can be a forwarding pointer. Each time it
742 is examined or set, forwarding must be done. Each time we
743 switch buffers, buffer-local variables which forward into C
744 variables are swapped immediately, so the C code can assume
745 that they are always up to date.
746
747 Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
748 use the same substructure. The difference is that with the latter,
749 merely setting the variable while some buffer is current
750 does not cause that buffer to have its own local value of this variable.
751 Only make-local-variable does that. */
752struct Lisp_Buffer_Local_Value
753 {
5bfac5a9
RS
754 int type : 16; /* = Lisp_Misc_Buffer_Local_Value
755 or Lisp_Misc_Some_Buffer_Local_Value */
756 int spacer : 16;
7d65f1c2
KH
757 Lisp_Object car, cdr;
758 };
759
ce7d8eec
KH
760/* In an overlay object, the mark bit of the plist is used as the GC mark.
761 START and END are markers in the overlay's buffer, and
762 PLIST is the overlay's property list. */
763struct Lisp_Overlay
764 {
5bfac5a9
RS
765 int type : 16; /* = Lisp_Misc_Overlay */
766 int spacer : 16;
ce7d8eec
KH
767 Lisp_Object start, end, plist;
768 };
5bfac5a9 769
f334de0e 770/* Like Lisp_Objfwd except that value lives in a slot in the
32462604
KH
771 current kboard. */
772struct Lisp_Kboard_Objfwd
f334de0e 773 {
32462604 774 int type : 16; /* = Lisp_Misc_Kboard_Objfwd */
f334de0e
KH
775 int spacer : 16;
776 int offset;
777 };
778
5bfac5a9 779
a7aa28f6
RS
780/* To get the type field of a union Lisp_Misc, use XMISCTYPE.
781 It uses one of these struct subtypes to get the type field. */
782
84d1833e
KH
783union Lisp_Misc
784 {
84d1833e
KH
785 struct Lisp_Free u_free;
786 struct Lisp_Marker u_marker;
ee4c9ce4
KH
787 struct Lisp_Intfwd u_intfwd;
788 struct Lisp_Boolfwd u_boolfwd;
789 struct Lisp_Objfwd u_objfwd;
790 struct Lisp_Buffer_Objfwd u_buffer_objfwd;
7d65f1c2 791 struct Lisp_Buffer_Local_Value u_buffer_local_value;
ce7d8eec 792 struct Lisp_Overlay u_overlay;
32462604 793 struct Lisp_Kboard_Objfwd u_kboard_objfwd;
84d1833e 794 };
7c06ac2b 795\f
3cfe6dfd
JB
796#ifdef LISP_FLOAT_TYPE
797/* Optional Lisp floating point type */
798struct Lisp_Float
799 {
800 Lisp_Object type; /* essentially used for mark-bit
801 and chaining when on free-list */
802 double data;
803 };
804#endif /* LISP_FLOAT_TYPE */
805
806/* A character, declared with the following typedef, is a member
99a3d506 807 of some character set associated with the current buffer. */
b2ba7b00
RS
808#ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
809#define _UCHAR_T
3cfe6dfd 810typedef unsigned char UCHAR;
b2ba7b00 811#endif
3cfe6dfd
JB
812
813/* Meanings of slots in a Lisp_Compiled: */
814
815#define COMPILED_ARGLIST 0
816#define COMPILED_BYTECODE 1
817#define COMPILED_CONSTANTS 2
818#define COMPILED_STACK_DEPTH 3
819#define COMPILED_DOC_STRING 4
820#define COMPILED_INTERACTIVE 5
88dbfee5 821
d03f79ef
JB
822/* Flag bits in a character. These also get used in termhooks.h.
823 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
7c06ac2b
RS
824 (MUlti-Lingual Emacs) might need 22 bits for the character value
825 itself, so we probably shouldn't use any bits lower than 0x0400000. */
826#define CHAR_ALT (0x0400000)
827#define CHAR_SUPER (0x0800000)
828#define CHAR_HYPER (0x1000000)
829#define CHAR_SHIFT (0x2000000)
830#define CHAR_CTL (0x4000000)
831#define CHAR_META (0x8000000)
703f2808 832
e6faba7f
RS
833#ifdef USE_X_TOOLKIT
834#ifdef NO_UNION_TYPE
835/* Use this for turning a (void *) into a Lisp_Object, as when the
836 Lisp_Object is passed into a toolkit callback function. */
837#define VOID_TO_LISP(larg,varg) \
838 do { ((larg) = ((Lisp_Object) (varg))); } while (0)
839#define CVOID_TO_LISP VOID_TO_LISP
840
841/* Use this for turning a Lisp_Object into a (void *), as when the
842 Lisp_Object is passed into a toolkit callback function. */
843#define LISP_TO_VOID(larg) ((void *) (larg))
844#define LISP_TO_CVOID(varg) ((const void *) (larg))
845
846#else /* not NO_UNION_TYPE */
847/* Use this for turning a (void *) into a Lisp_Object, as when the
848 Lisp_Object is passed into a toolkit callback function. */
849#define VOID_TO_LISP(larg,varg) \
850 do { ((larg).v = (void *) (varg)); } while (0)
851#define CVOID_TO_LISP(larg,varg) \
852 do { ((larg).cv = (const void *) (varg)); } while (0)
853
854/* Use this for turning a Lisp_Object into a (void *), as when the
855 Lisp_Object is passed into a toolkit callback function. */
856#define LISP_TO_VOID(larg) ((larg).v)
857#define LISP_TO_CVOID(larg) ((larg).cv)
858#endif /* not NO_UNION_TYPE */
859#endif /* USE_X_TOOLKIT */
860
703f2808
JB
861\f
862/* The glyph datatype, used to represent characters on the display. */
863
864/* The low eight bits are the character code, and the bits above them
865 are the numeric face ID. If FID is the face ID of a glyph on a
866 frame F, then F->display.x->faces[FID] contains the description of
867 that face. This is an int instead of a short, so we can support a
868 good bunch of face ID's; given that we have no mechanism for
869 tossing unused frame face ID's yet, we'll probably run out of 255
870 pretty quickly. */
871#define GLYPH unsigned int
872
87485d6f 873#ifdef HAVE_FACES
49b0dd75
KH
874/* The FAST macros assume that we already know we're in an X window. */
875
703f2808 876/* Given a character code and a face ID, return the appropriate glyph. */
49b0dd75 877#define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << 8))
703f2808
JB
878
879/* Return a glyph's character code. */
49b0dd75 880#define FAST_GLYPH_CHAR(glyph) ((glyph) & 0xff)
703f2808
JB
881
882/* Return a glyph's face ID. */
49b0dd75
KH
883#define FAST_GLYPH_FACE(glyph) (((glyph) >> 8) & ((1 << 24) - 1))
884
885/* Slower versions that test the frame type first. */
886#define MAKE_GLYPH(f, char, face) (FRAME_TERMCAP_P (f) ? (char) \
887 : FAST_MAKE_GLYPH (char, face))
888#define GLYPH_CHAR(f, g) (FRAME_TERMCAP_P (f) ? (g) : FAST_GLYPH_CHAR (g))
889#define GLYPH_FACE(f, g) (FRAME_TERMCAP_P (f) ? (0) : FAST_GLYPH_FACE (g))
87485d6f 890#else /* not HAVE_FACES */
49b0dd75
KH
891#define MAKE_GLYPH(f, char, face) (char)
892#define GLYPH_CHAR(f, g) (g)
893#define GLYPH_FACE(f, g) (g)
87485d6f 894#endif /* not HAVE_FACES */
703f2808 895
4606cc9d
RS
896/* The ID of the mode line highlighting face. */
897#define GLYPH_MODE_LINE_FACE 1
3cfe6dfd
JB
898\f
899/* Data type checking */
900
efb859b4 901#define NILP(x) (XFASTINT (x) == XFASTINT (Qnil))
f498e3b2 902#define GC_NILP(x) GC_EQ (x, Qnil)
3cfe6dfd 903
4746118a 904#ifdef LISP_FLOAT_TYPE
c5af3bb9 905#define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
c1a2bfad 906#define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
4746118a 907#else
c5af3bb9 908#define NUMBERP(x) (INTEGERP (x))
c1a2bfad 909#define GC_NUMBERP(x) (GC_INTEGERP (x))
4746118a 910#endif
a4a9f09f 911#define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
c1a2bfad 912#define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
4746118a 913
edfa9106 914#define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
c1a2bfad 915#define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
edfa9106 916#define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
c1a2bfad 917#define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
84d1833e 918#define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
c1a2bfad 919#define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
b5088f80
KH
920#define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
921#define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
edfa9106 922#define STRINGP(x) (XTYPE ((x)) == Lisp_String)
c1a2bfad 923#define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
3cfe6dfd 924#define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
c1a2bfad 925#define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
7c06ac2b 926
20280af7 927#ifdef LISP_FLOAT_TYPE
edfa9106 928#define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
c1a2bfad 929#define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
20280af7
JB
930#else
931#define FLOATP(x) (0)
c1a2bfad 932#define GC_FLOATP(x) (0)
20280af7 933#endif
b5088f80
KH
934#define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
935#define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
a7aa28f6
RS
936#define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
937#define GC_OVERLAYP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
938#define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
939#define GC_MARKERP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
940#define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
941#define GC_INTFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
942#define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
943#define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
944#define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
945#define GC_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
946#define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
947#define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
948#define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
949#define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
950#define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
951#define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
952#define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
953#define GC_KBOARD_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
edfa9106 954
7c06ac2b 955
303a5c93 956/* True if object X is a pseudovector whose code is CODE. */
7c06ac2b
RS
957#define PSEUDOVECTORP(x, code) \
958 (VECTORLIKEP (x) \
959 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
960 == (PSEUDOVECTOR_FLAG | (code))))
961
303a5c93 962/* True if object X is a pseudovector whose code is CODE.
7c06ac2b
RS
963 This one works during GC. */
964#define GC_PSEUDOVECTORP(x, code) \
965 (GC_VECTORLIKEP (x) \
966 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
967 == (PSEUDOVECTOR_FLAG | (code))))
968
969/* Test for specific pseudovector types. */
970#define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
971#define GC_WINDOW_CONFIGURATIONP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
972#define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
973#define GC_PROCESSP(x) GC_PSEUDOVECTORP (x, PVEC_PROCESS)
974#define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
975#define GC_WINDOWP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW)
976#define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
977#define GC_SUBRP(x) GC_PSEUDOVECTORP (x, PVEC_SUBR)
978#define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
979#define GC_COMPILEDP(x) GC_PSEUDOVECTORP (x, PVEC_COMPILED)
99a3d506
RS
980#define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
981#define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
608ff985
RS
982#define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
983#define GC_CHAR_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
984#define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
985#define GC_BOOL_VECTOR_P(x) GC_PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
7c06ac2b
RS
986
987#ifdef MULTI_FRAME
988#define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
989#define GC_FRAMEP(x) GC_PSEUDOVECTORP (x, PVEC_FRAME)
990#else
991#ifdef HAVE_MOUSE
992/* We could use this in the !HAVE_MOUSE case also, but we prefer a compile-time
993 error message in case FRAMEP is used. */
994#define FRAMEP(x) (EQ (x, Fselected_frame ()))
995#define GC_FRAMEP(x) (GC_EQ (x, Fselected_frame ()))
996#endif
997#endif
998
999\f
3cfe6dfd 1000#define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
f498e3b2 1001#define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
4746118a 1002
3cfe6dfd 1003#define CHECK_LIST(x, i) \
c5af3bb9 1004 do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
3cfe6dfd
JB
1005
1006#define CHECK_STRING(x, i) \
c5af3bb9 1007 do { if (!STRINGP ((x))) x = wrong_type_argument (Qstringp, (x)); } while (0)
3cfe6dfd
JB
1008
1009#define CHECK_CONS(x, i) \
c5af3bb9 1010 do { if (!CONSP ((x))) x = wrong_type_argument (Qconsp, (x)); } while (0)
3cfe6dfd
JB
1011
1012#define CHECK_SYMBOL(x, i) \
c5af3bb9 1013 do { if (!SYMBOLP ((x))) x = wrong_type_argument (Qsymbolp, (x)); } while (0)
3cfe6dfd 1014
608ff985 1015#define CHECK_CHAR_TABLE(x, i) \
a97eb3f3 1016 do { if (!CHAR_TABLE_P ((x))) \
608ff985
RS
1017 x = wrong_type_argument (Qchar_table_p, (x)); } while (0)
1018
3cfe6dfd 1019#define CHECK_VECTOR(x, i) \
c5af3bb9 1020 do { if (!VECTORP ((x))) x = wrong_type_argument (Qvectorp, (x)); } while (0)
3cfe6dfd 1021
7f73dc9d
RS
1022#define CHECK_VECTOR_OR_CHAR_TABLE(x, i) \
1023 do { if (!VECTORP ((x)) && !CHAR_TABLE_P ((x))) \
1024 x = wrong_type_argument (Qvector_or_char_table_p, (x)); \
1025 } while (0)
1026
3cfe6dfd 1027#define CHECK_BUFFER(x, i) \
c5af3bb9 1028 do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
3cfe6dfd
JB
1029
1030#define CHECK_WINDOW(x, i) \
c5af3bb9 1031 do { if (!WINDOWP ((x))) x = wrong_type_argument (Qwindowp, (x)); } while (0)
3cfe6dfd 1032
03273ec5
JB
1033/* This macro rejects windows on the interior of the window tree as
1034 "dead", which is what we want; this is an argument-checking macro, and
1035 the user should never get access to interior windows.
1036
1037 A window of any sort, leaf or interior, is dead iff the buffer,
1038 vchild, and hchild members are all nil. */
1039
1040#define CHECK_LIVE_WINDOW(x, i) \
2ad18bfd 1041 do { \
c5af3bb9 1042 if (!WINDOWP ((x)) \
03273ec5 1043 || NILP (XWINDOW ((x))->buffer)) \
806b4d9b 1044 x = wrong_type_argument (Qwindow_live_p, (x)); \
2ad18bfd 1045 } while (0)
03273ec5 1046
3cfe6dfd 1047#define CHECK_PROCESS(x, i) \
c5af3bb9 1048 do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
3cfe6dfd
JB
1049
1050#define CHECK_NUMBER(x, i) \
c5af3bb9 1051 do { if (!INTEGERP ((x))) x = wrong_type_argument (Qintegerp, (x)); } while (0)
3cfe6dfd
JB
1052
1053#define CHECK_NATNUM(x, i) \
a4a9f09f 1054 do { if (!NATNUMP (x)) x = wrong_type_argument (Qwholenump, (x)); } while (0)
3cfe6dfd
JB
1055
1056#define CHECK_MARKER(x, i) \
c5af3bb9 1057 do { if (!MARKERP ((x))) x = wrong_type_argument (Qmarkerp, (x)); } while (0)
3cfe6dfd
JB
1058
1059#define CHECK_NUMBER_COERCE_MARKER(x, i) \
221f4ef3 1060 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
c5af3bb9 1061 else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
3cfe6dfd
JB
1062
1063#ifdef LISP_FLOAT_TYPE
1064
1065#ifndef DBL_DIG
1066#define DBL_DIG 20
1067#endif
1068
1069#define XFLOATINT(n) extract_float((n))
1070
1071#define CHECK_FLOAT(x, i) \
c5af3bb9 1072 do { if (!FLOATP (x)) \
2ad18bfd 1073 x = wrong_type_argument (Qfloatp, (x)); } while (0)
3cfe6dfd
JB
1074
1075#define CHECK_NUMBER_OR_FLOAT(x, i) \
c5af3bb9 1076 do { if (!FLOATP (x) && !INTEGERP (x)) \
2ad18bfd 1077 x = wrong_type_argument (Qnumberp, (x)); } while (0)
3cfe6dfd
JB
1078
1079#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
221f4ef3 1080 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
c5af3bb9 1081 else if (!INTEGERP (x) && !FLOATP (x)) \
2ad18bfd 1082 x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
3cfe6dfd
JB
1083
1084#else /* Not LISP_FLOAT_TYPE */
1085
1086#define CHECK_NUMBER_OR_FLOAT CHECK_NUMBER
1087
1088#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER CHECK_NUMBER_COERCE_MARKER
1089
1090#define XFLOATINT(n) XINT((n))
1091#endif /* LISP_FLOAT_TYPE */
1092
20280af7 1093#define CHECK_OVERLAY(x, i) \
c5af3bb9 1094 do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
20280af7 1095
3cfe6dfd
JB
1096/* Cast pointers to this type to compare them. Some machines want int. */
1097#ifndef PNTR_COMPARISON_TYPE
1098#define PNTR_COMPARISON_TYPE unsigned int
1099#endif
1100\f
1101/* Define a built-in function for calling from Lisp.
1102 `lname' should be the name to give the function in Lisp,
1103 as a null-terminated C string.
1104 `fnname' should be the name of the function in C.
1105 By convention, it starts with F.
1106 `sname' should be the name for the C constant structure
1107 that records information on this function for internal use.
1108 By convention, it should be the same as `fnname' but with S instead of F.
1109 It's too bad that C macros can't compute this from `fnname'.
1110 `minargs' should be a number, the minimum number of arguments allowed.
1111 `maxargs' should be a number, the maximum number of arguments allowed,
1112 or else MANY or UNEVALLED.
1113 MANY means pass a vector of evaluated arguments,
1114 in the form of an integer number-of-arguments
1115 followed by the address of a vector of Lisp_Objects
1116 which contains the argument values.
1117 UNEVALLED means pass the list of unevaluated arguments
1118 `prompt' says how to read arguments for an interactive call.
eab9d423 1119 See the doc string for `interactive'.
3cfe6dfd 1120 A null string means call interactively with no arguments.
eab9d423 1121 `doc' is documentation for the user. */
3cfe6dfd 1122
5125ca93 1123#if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
7c06ac2b
RS
1124#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1125 Lisp_Object fnname (); \
1126 struct Lisp_Subr sname = \
1127 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1128 fnname, minargs, maxargs, lname, prompt, 0}; \
3cfe6dfd
JB
1129 Lisp_Object fnname
1130
c451d7b1
RS
1131#else
1132
1133/* This version of DEFUN declares a function prototype with the right
99a3d506 1134 arguments, so we can catch errors with maxargs at compile-time. */
7c06ac2b
RS
1135#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1136 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1137 struct Lisp_Subr sname = \
1138 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1139 fnname, minargs, maxargs, lname, prompt, 0}; \
c451d7b1
RS
1140 Lisp_Object fnname
1141
1142/* Note that the weird token-substitution semantics of ANSI C makes
99a3d506 1143 this work for MANY and UNEVALLED. */
c451d7b1
RS
1144#define DEFUN_ARGS_MANY (int, Lisp_Object *)
1145#define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1146#define DEFUN_ARGS_0 (void)
1147#define DEFUN_ARGS_1 (Lisp_Object)
1148#define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1149#define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1150#define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1151#define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1152 Lisp_Object)
1153#define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1154 Lisp_Object, Lisp_Object)
1155#define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1156 Lisp_Object, Lisp_Object, Lisp_Object)
1157#endif
1158
3cfe6dfd 1159/* defsubr (Sname);
99a3d506 1160 is how we define the symbol for function `name' at start-up time. */
3cfe6dfd
JB
1161extern void defsubr ();
1162
1163#define MANY -2
1164#define UNEVALLED -1
1165
1166extern void defvar_lisp ();
1167extern void defvar_bool ();
1168extern void defvar_int ();
32462604 1169extern void defvar_kboard ();
3cfe6dfd
JB
1170
1171/* Macros we use to define forwarded Lisp variables.
1172 These are used in the syms_of_FILENAME functions. */
1173
3cfe6dfd
JB
1174#define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
1175#define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
1176#define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
1177#define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
ef15f270
JB
1178#define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
1179 defvar_per_buffer (lname, vname, type, 0)
32462604
KH
1180#define DEFVAR_KBOARD(lname, vname, doc) \
1181 defvar_kboard (lname, \
1182 (int)((char *)(&current_kboard->vname) \
1183 - (char *)current_kboard))
3cfe6dfd 1184\f
78ca380c
JB
1185/* Structure for recording Lisp call stack for backtrace purposes. */
1186
1187/* The special binding stack holds the outer values of variables while
1188 they are bound by a function application or a let form, stores the
1189 code to be executed for Lisp unwind-protect forms, and stores the C
1190 functions to be called for record_unwind_protect.
1191
1192 If func is non-zero, undoing this binding applies func to old_value;
1193 This implements record_unwind_protect.
1194 If func is zero and symbol is nil, undoing this binding evaluates
1195 the list of forms in old_value; this implements Lisp's unwind-protect
1196 form.
1197 Otherwise, undoing this binding stores old_value as symbol's value; this
1198 undoes the bindings made by a let form or function call. */
3cfe6dfd
JB
1199struct specbinding
1200 {
1201 Lisp_Object symbol, old_value;
1202 Lisp_Object (*func) ();
1203 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
1204 };
1205
1206extern struct specbinding *specpdl;
1207extern struct specbinding *specpdl_ptr;
1208extern int specpdl_size;
1209
78ca380c 1210/* Everything needed to describe an active condition case. */
3cfe6dfd
JB
1211struct handler
1212 {
78ca380c 1213 /* The handler clauses and variable from the condition-case form. */
3cfe6dfd
JB
1214 Lisp_Object handler;
1215 Lisp_Object var;
22bbbd42
RS
1216 /* Fsignal stores here the condition-case clause that applies,
1217 and Fcondition_case thus knows which clause to run. */
1218 Lisp_Object chosen_clause;
78ca380c
JB
1219
1220 /* Used to effect the longjump out to the handler. */
3cfe6dfd 1221 struct catchtag *tag;
78ca380c
JB
1222
1223 /* The next enclosing handler. */
3cfe6dfd
JB
1224 struct handler *next;
1225 };
1226
1227extern struct handler *handlerlist;
1228
1229extern struct catchtag *catchlist;
1230extern struct backtrace *backtrace_list;
1231
22bbbd42
RS
1232extern Lisp_Object memory_signal_data;
1233
3cfe6dfd
JB
1234/* An address near the bottom of the stack.
1235 Tells GC how to save a copy of the stack. */
1236extern char *stack_bottom;
1237
99a3d506 1238/* Check quit-flag and quit if it is non-nil. */
3cfe6dfd
JB
1239
1240#define QUIT \
efb859b4 1241 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3cfe6dfd
JB
1242 { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }
1243
1244/* Nonzero if ought to quit now. */
1245
efb859b4 1246#define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3cfe6dfd
JB
1247\f
1248/* 1 if CH is upper case. */
1249
7b15897a 1250#define UPPERCASEP(CH) \
c6a3c83c 1251 (XCHAR_TABLE (current_buffer->downcase_table)->contents[CH] != (CH))
3cfe6dfd
JB
1252
1253/* 1 if CH is lower case. */
1254
1255#define LOWERCASEP(CH) \
7b15897a 1256 (!UPPERCASEP (CH) \
c6a3c83c 1257 && XCHAR_TABLE (current_buffer->upcase_table)->contents[CH] != (CH))
3cfe6dfd
JB
1258
1259/* 1 if CH is neither upper nor lower case. */
1260
c6a3c83c
RS
1261#define NOCASEP(CH) \
1262 (XCHAR_TABLE (current_buffer->upcase_table)->contents[CH] == (CH))
3cfe6dfd
JB
1263
1264/* Upcase a character, or make no change if that cannot be done. */
1265
7b15897a 1266#define UPCASE(CH) \
c6a3c83c 1267 (XCHAR_TABLE (current_buffer->downcase_table)->contents[CH] == (CH) \
7b15897a 1268 ? UPCASE1 (CH) : (CH))
3cfe6dfd
JB
1269
1270/* Upcase a character known to be not upper case. */
1271
c6a3c83c 1272#define UPCASE1(CH) (XCHAR_TABLE (current_buffer->upcase_table)->contents[CH])
3cfe6dfd 1273
99a3d506 1274/* Downcase a character, or make no change if that cannot be done. */
3cfe6dfd 1275
c6a3c83c
RS
1276#define DOWNCASE(CH) \
1277 (XCHAR_TABLE (current_buffer->downcase_table)->contents[CH])
3cfe6dfd
JB
1278
1279/* Current buffer's map from characters to lower-case characters. */
1280
c6a3c83c 1281#define DOWNCASE_TABLE XCHAR_TABLE (current_buffer->downcase_table)->contents
3cfe6dfd 1282
c6a3c83c 1283extern Lisp_Object Vascii_downcase_table;
3cfe6dfd 1284\f
99a3d506 1285/* Number of bytes of structure consed since last GC. */
3cfe6dfd
JB
1286
1287extern int consing_since_gc;
1288
99a3d506 1289/* Threshold for doing another gc. */
3cfe6dfd 1290
65deefca 1291extern int gc_cons_threshold;
3cfe6dfd 1292
99a3d506 1293/* Structure for recording stack slots that need marking. */
3cfe6dfd
JB
1294
1295/* This is a chain of structures, each of which points at a Lisp_Object variable
1296 whose value should be marked in garbage collection.
1297 Normally every link of the chain is an automatic variable of a function,
1298 and its `val' points to some argument or local variable of the function.
1299 On exit to the function, the chain is set back to the value it had on entry.
e5f55f07
BF
1300 This way, no link remains in the chain when the stack frame containing the
1301 link disappears.
3cfe6dfd
JB
1302
1303 Every function that can call Feval must protect in this fashion all
99a3d506 1304 Lisp_Object variables whose contents will be used again. */
3cfe6dfd
JB
1305
1306extern struct gcpro *gcprolist;
1307
1308struct gcpro
1309 {
1310 struct gcpro *next;
1311 Lisp_Object *var; /* Address of first protected variable */
1312 int nvars; /* Number of consecutive protected variables */
1313 };
1314
1315#define GCPRO1(varname) \
1316 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
1317 gcprolist = &gcpro1; }
1318
1319#define GCPRO2(varname1, varname2) \
1320 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1321 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1322 gcprolist = &gcpro2; }
1323
1324#define GCPRO3(varname1, varname2, varname3) \
1325 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1326 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1327 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1328 gcprolist = &gcpro3; }
1329
1330#define GCPRO4(varname1, varname2, varname3, varname4) \
1331 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1332 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1333 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1334 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1335 gcprolist = &gcpro4; }
1336
c47b8d02
RS
1337#define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
1338 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1339 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1340 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1341 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1342 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1343 gcprolist = &gcpro5; }
1344
99a3d506 1345/* Call staticpro (&var) to protect static variable `var'. */
3cfe6dfd
JB
1346
1347void staticpro();
1348
1349#define UNGCPRO (gcprolist = gcpro1.next)
1350
5db82c9d 1351/* Evaluate expr, UNGCPRO, and then return the value of expr. */
c47b8d02 1352#define RETURN_UNGCPRO(expr) \
f3ca341e 1353if (1) \
c47b8d02
RS
1354 { \
1355 Lisp_Object ret_ungc_val; \
1356 ret_ungc_val = (expr); \
1357 UNGCPRO; \
1358 return ret_ungc_val; \
1359 } \
f3ca341e 1360else
3cfe6dfd
JB
1361\f
1362/* Defined in data.c */
1363extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
1364extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
1365extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
1366extern Lisp_Object Qvoid_variable, Qvoid_function;
1367extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
1368extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
1369extern Lisp_Object Qend_of_file, Qarith_error;
1370extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
83125cd7 1371extern Lisp_Object Qmark_inactive;
3cfe6dfd 1372
59b4254d
JB
1373extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
1374extern Lisp_Object Qoverflow_error, Qunderflow_error;
623ed1b0 1375
07a97bf8
RS
1376extern Lisp_Object Qintegerp, Qnumberp, Qnatnump, Qwholenump;
1377extern Lisp_Object Qsymbolp, Qlistp, Qconsp;
3cfe6dfd
JB
1378extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
1379extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qvectorp;
4de86b16 1380extern Lisp_Object Qinteger_or_marker_p, Qnumber_or_marker_p;
7f73dc9d 1381extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
4de86b16 1382extern Lisp_Object Qboundp, Qfboundp;
cde20f41 1383extern Lisp_Object Qbuffer_or_string_p;
3cfe6dfd
JB
1384extern Lisp_Object Qcdr;
1385
1386#ifdef LISP_FLOAT_TYPE
1387extern Lisp_Object Qfloatp, Qinteger_or_floatp, Qinteger_or_float_or_marker_p;
1388#endif /* LISP_FLOAT_TYPE */
1389
ff11dfa1 1390extern Lisp_Object Qframep;
3cfe6dfd
JB
1391
1392extern Lisp_Object Feq (), Fnull (), Flistp (), Fconsp (), Fatom (), Fnlistp ();
1393extern Lisp_Object Fintegerp (), Fnatnump (), Fsymbolp ();
1394extern Lisp_Object Fvectorp (), Fstringp (), Farrayp (), Fsequencep ();
1395extern Lisp_Object Fbufferp (), Fmarkerp (), Fsubrp (), Fchar_or_string_p ();
1396extern Lisp_Object Finteger_or_marker_p ();
1397#ifdef LISP_FLOAT_TYPE
1398extern Lisp_Object Ffloatp(), Finteger_or_floatp();
1399extern Lisp_Object Finteger_or_float_or_marker_p(), Ftruncate();
1400#endif /* LISP_FLOAT_TYPE */
1401
1402extern Lisp_Object Fcar (), Fcar_safe(), Fcdr (), Fcdr_safe();
1403extern Lisp_Object Fsetcar (), Fsetcdr ();
1404extern Lisp_Object Fboundp (), Ffboundp (), Fmakunbound (), Ffmakunbound ();
1405extern Lisp_Object Fsymbol_function (), Fsymbol_plist (), Fsymbol_name ();
ffd56f97 1406extern Lisp_Object indirect_function (), Findirect_function ();
3cfe6dfd 1407extern Lisp_Object Ffset (), Fsetplist ();
760cbdd3 1408extern Lisp_Object Fsymbol_value (), find_symbol_value (), Fset ();
d20c2151 1409extern Lisp_Object Fdefault_value (), Fset_default (), Fdefault_boundp ();
3cfe6dfd 1410
b8e0549d 1411extern Lisp_Object Faref (), Faset ();
3cfe6dfd 1412
f2980264 1413extern Lisp_Object Fstring_to_number (), Fnumber_to_string ();
c6cd5420
JB
1414extern Lisp_Object Feqlsign (), Fgtr (), Flss (), Fgeq (), Fleq ();
1415extern Lisp_Object Fneq (), Fzerop ();
1416extern Lisp_Object Fplus (), Fminus (), Ftimes (), Fquo (), Frem ();
1417extern Lisp_Object Fmax (), Fmin ();
1418extern Lisp_Object Flogand (), Flogior (), Flogxor (), Flognot ();
1419extern Lisp_Object Flsh (), Fash ();
1420
3cfe6dfd
JB
1421extern Lisp_Object Fadd1 (), Fsub1 ();
1422
51cf3e31
JB
1423extern Lisp_Object long_to_cons ();
1424extern unsigned long cons_to_long ();
3cfe6dfd
JB
1425extern void args_out_of_range ();
1426extern void args_out_of_range_3 ();
1427extern Lisp_Object wrong_type_argument ();
7751ddd7 1428extern void store_symval_forwarding ();
a2b27e73 1429extern Lisp_Object do_symval_forwarding ();
3cfe6dfd
JB
1430#ifdef LISP_FLOAT_TYPE
1431extern Lisp_Object Ffloat_to_int(), Fint_to_float();
1432extern double extract_float();
d20c2151
JB
1433extern Lisp_Object make_float ();
1434extern Lisp_Object Ffloat ();
3cfe6dfd
JB
1435#endif /* LISP_FLOAT_TYPE */
1436
a37e10f9
KH
1437/* Defined in cmds.c */
1438extern Lisp_Object Fend_of_line (), Fforward_char (), Fforward_line ();
1439
1440/* Defined in syntax.c */
1441extern Lisp_Object Fforward_word ();
1442
3cfe6dfd
JB
1443/* Defined in fns.c */
1444extern Lisp_Object Qstring_lessp;
1445extern Lisp_Object Vfeatures;
1446extern Lisp_Object Fidentity (), Frandom ();
643f822f 1447extern Lisp_Object Flength (), Fsafe_length ();
3cfe6dfd
JB
1448extern Lisp_Object Fappend (), Fconcat (), Fvconcat (), Fcopy_sequence ();
1449extern Lisp_Object Fsubstring ();
d20c2151 1450extern Lisp_Object Fnth (), Fnthcdr (), Fmemq (), Fassq (), Fassoc ();
a37e10f9 1451extern Lisp_Object Felt (), Fmember (), Frassq (), Fdelq (), Fsort ();
3cfe6dfd
JB
1452extern Lisp_Object Freverse (), Fnreverse (), Fget (), Fput (), Fequal ();
1453extern Lisp_Object Ffillarray (), Fnconc (), Fmapcar (), Fmapconcat ();
1454extern Lisp_Object Fy_or_n_p (), do_yes_or_no_p ();
1455extern Lisp_Object Ffeaturep (), Frequire () , Fprovide ();
1456extern Lisp_Object concat2 (), nconc2 ();
1457extern Lisp_Object assq_no_quit ();
d20c2151 1458extern Lisp_Object Fcopy_alist ();
40131ef5 1459extern Lisp_Object Fplist_get ();
3cfe6dfd 1460
c98adc1b
KH
1461/* Defined in insdel.c */
1462extern void move_gap ();
1463extern void make_gap ();
1464extern void insert ();
1465extern void insert_and_inherit ();
1466extern void insert_1 ();
1467extern void insert_from_string ();
1468extern void insert_from_buffer ();
1469extern void insert_char ();
1470extern void insert_string ();
1471extern void insert_before_markers ();
1472extern void insert_before_markers_and_inherit ();
1473extern void insert_from_string_before_markers ();
1474extern void del_range ();
1475extern void del_range_1 ();
1476extern void modify_region ();
1477extern void prepare_to_modify_buffer ();
1478extern void signal_before_change ();
1479extern void signal_after_change ();
1480
1481/* Defined in xdisp.c */
439ae27b 1482extern Lisp_Object Vmessage_log_max;
c98adc1b 1483extern void message ();
1979717a 1484extern void message_nolog ();
c98adc1b
KH
1485extern void message1 ();
1486extern void message1_nolog ();
1487extern void message2 ();
1488extern void message2_nolog ();
3d3938e1 1489extern void message_dolog ();
eaecdb81 1490extern void message_log_maybe_newline ();
c98adc1b 1491
3cfe6dfd
JB
1492/* Defined in alloc.c */
1493extern Lisp_Object Vpurify_flag;
ee4c9ce4 1494extern Lisp_Object Fcons (), Flist(), Fmake_list (), allocate_misc ();
3cfe6dfd
JB
1495extern Lisp_Object Fmake_vector (), Fvector (), Fmake_symbol (), Fmake_marker ();
1496extern Lisp_Object Fmake_string (), build_string (), make_string ();
88dbfee5 1497extern Lisp_Object make_event_array (), make_uninit_string ();
3cfe6dfd
JB
1498extern Lisp_Object Fpurecopy (), make_pure_string ();
1499extern Lisp_Object pure_cons (), make_pure_vector ();
1500extern Lisp_Object Fgarbage_collect ();
d20c2151 1501extern Lisp_Object Fmake_byte_code ();
7f73dc9d 1502extern Lisp_Object Qchar_table_extra_slots;
94225242 1503extern struct Lisp_Vector *allocate_vectorlike ();
4d57802e 1504extern int gc_in_progress;
3cfe6dfd
JB
1505
1506/* Defined in print.c */
1507extern Lisp_Object Vprin1_to_string_buffer;
1508extern Lisp_Object Fprin1 (), Fprin1_to_string (), Fprinc ();
1509extern Lisp_Object Fterpri (), Fprint ();
1510extern Lisp_Object Vstandard_output, Qstandard_output;
9453ea7b 1511extern Lisp_Object Qexternal_debugging_output;
3cfe6dfd
JB
1512extern void temp_output_buffer_setup (), temp_output_buffer_show ();
1513extern int print_level, print_escape_newlines;
1514extern Lisp_Object Qprint_escape_newlines;
1515
1516/* Defined in lread.c */
1517extern Lisp_Object Qvariable_documentation, Qstandard_input;
1518extern Lisp_Object Vobarray, Vstandard_input;
1519extern Lisp_Object Fread (), Fread_from_string ();
1520extern Lisp_Object Fintern (), Fintern_soft (), Fload ();
1521extern Lisp_Object Fget_file_char (), Fread_char ();
59b4254d 1522extern Lisp_Object read_filtered_event ();
3cfe6dfd
JB
1523extern Lisp_Object Feval_current_buffer (), Feval_region ();
1524extern Lisp_Object intern (), oblookup ();
c5e3de70
RS
1525#define LOADHIST_ATTACH(x) \
1526 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
1527extern Lisp_Object Vcurrent_load_list;
1528extern Lisp_Object Vload_history;
3cfe6dfd
JB
1529
1530/* Defined in eval.c */
1531extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
ad236261 1532extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
3cfe6dfd
JB
1533extern Lisp_Object Vmocklisp_arguments, Qmocklisp, Qmocklisp_arguments;
1534extern Lisp_Object Vautoload_queue;
973e8873 1535extern Lisp_Object Vdebug_on_error;
f1b6e5fc
SM
1536/* To run a normal hook, use the appropriate function from the list below.
1537 The calling convention:
1538
846d69ac 1539 if (!NILP (Vrun_hooks))
f1b6e5fc
SM
1540 call1 (Vrun_hooks, Qmy_funny_hook);
1541
1542 should no longer be used. */
3cfe6dfd 1543extern Lisp_Object Vrun_hooks;
f1b6e5fc
SM
1544extern Lisp_Object Frun_hooks (), Frun_hook_with_args ();
1545extern Lisp_Object Frun_hook_with_args_until_success ();
1546extern Lisp_Object Frun_hook_with_args_until_failure ();
3cfe6dfd
JB
1547extern Lisp_Object Fand (), For (), Fif (), Fprogn (), Fprog1 (), Fprog2 ();
1548extern Lisp_Object Fsetq (), Fquote ();
1549extern Lisp_Object Fuser_variable_p (), Finteractive_p ();
1550extern Lisp_Object Fdefun (), Flet (), FletX (), Fwhile ();
1551extern Lisp_Object Fcatch (), Fthrow (), Funwind_protect ();
1552extern Lisp_Object Fcondition_case (), Fsignal ();
1553extern Lisp_Object Ffunction_type (), Fautoload (), Fcommandp ();
1554extern Lisp_Object Feval (), Fapply (), Ffuncall ();
1555extern Lisp_Object Fglobal_set (), Fglobal_value (), Fbacktrace ();
1556extern Lisp_Object apply1 (), call0 (), call1 (), call2 (), call3 ();
023c80d0
KH
1557extern Lisp_Object call4 (), call5 (), call6 ();
1558extern Lisp_Object Fkill_emacs (), Fkey_binding (), Fsit_for ();
1559extern Lisp_Object Fdo_auto_save (), Fset_marker ();
3cfe6dfd
JB
1560extern Lisp_Object apply_lambda ();
1561extern Lisp_Object internal_catch ();
1562extern Lisp_Object internal_condition_case ();
a9656089 1563extern Lisp_Object internal_condition_case_1 ();
3cfe6dfd
JB
1564extern Lisp_Object unbind_to ();
1565extern void error ();
1566extern Lisp_Object un_autoload ();
c6972ec8 1567extern Lisp_Object Ffetch_bytecode ();
3cfe6dfd
JB
1568
1569/* Defined in editfns.c */
3cfe6dfd
JB
1570extern Lisp_Object Fgoto_char ();
1571extern Lisp_Object Fpoint_min_marker (), Fpoint_max_marker ();
1572extern Lisp_Object Fpoint_min (), Fpoint_max ();
1573extern Lisp_Object Fpoint (), Fpoint_marker (), Fmark_marker ();
760cbdd3
JB
1574extern Lisp_Object Ffollowing_char (), Fprevious_char (), Fchar_after ();
1575extern Lisp_Object Finsert ();
3cfe6dfd
JB
1576extern Lisp_Object Feolp (), Feobp (), Fbolp (), Fbobp ();
1577extern Lisp_Object Fformat (), format1 ();
ffd56f97
JB
1578extern Lisp_Object make_buffer_string (), Fbuffer_substring ();
1579extern Lisp_Object Fbuffer_string ();
3cfe6dfd
JB
1580extern Lisp_Object Fstring_equal (), Fstring_lessp (), Fbuffer_substring_lessp ();
1581extern Lisp_Object save_excursion_save (), save_restriction_save ();
1582extern Lisp_Object save_excursion_restore (), save_restriction_restore ();
1583extern Lisp_Object Fchar_to_string ();
a37e10f9 1584extern Lisp_Object Fdelete_region (), Fnarrow_to_region (), Fwiden ();
3cfe6dfd
JB
1585
1586/* defined in buffer.c */
a37e10f9 1587extern Lisp_Object Foverlay_start (), Foverlay_end ();
2c782c9f
KH
1588extern void adjust_overlays_for_insert ();
1589extern void adjust_overlays_for_delete ();
1590extern void fix_overlays_in_range ();
64c947d3 1591extern int overlay_touches_p ();
628300ba 1592extern Lisp_Object Vbuffer_alist, Vinhibit_read_only;
3cfe6dfd
JB
1593extern Lisp_Object Fget_buffer (), Fget_buffer_create (), Fset_buffer ();
1594extern Lisp_Object Fbarf_if_buffer_read_only ();
1595extern Lisp_Object Fcurrent_buffer (), Fswitch_to_buffer (), Fpop_to_buffer ();
1596extern Lisp_Object Fother_buffer ();
7cdedc3f 1597extern Lisp_Object Foverlay_get ();
20280af7 1598extern Lisp_Object Qoverlayp;
3cfe6dfd
JB
1599extern struct buffer *all_buffers;
1600
1601/* defined in marker.c */
1602
1603extern Lisp_Object Fmarker_position (), Fmarker_buffer ();
1604extern Lisp_Object Fcopy_marker ();
1605
1606/* Defined in fileio.c */
1607
1608extern Lisp_Object Qfile_error;
997bf68d 1609extern Lisp_Object Ffind_file_name_handler ();
3cfe6dfd
JB
1610extern Lisp_Object Ffile_name_as_directory ();
1611extern Lisp_Object Fexpand_file_name (), Ffile_name_nondirectory ();
1612extern Lisp_Object Fsubstitute_in_file_name ();
1613extern Lisp_Object Ffile_symlink_p ();
d20c2151
JB
1614extern Lisp_Object Fverify_visited_file_modtime ();
1615extern Lisp_Object Ffile_exists_p ();
a37e10f9 1616extern Lisp_Object Ffile_name_absolute_p ();
d20c2151
JB
1617extern Lisp_Object Fdirectory_file_name ();
1618extern Lisp_Object Ffile_name_directory ();
1619extern Lisp_Object expand_and_dir_to_file ();
1620extern Lisp_Object Ffile_accessible_directory_p ();
5b658538 1621extern Lisp_Object Funhandled_file_name_directory ();
3cfe6dfd
JB
1622
1623/* Defined in abbrev.c */
1624
1625extern Lisp_Object Vfundamental_mode_abbrev_table;
1626
1627/* defined in search.c */
1628extern Lisp_Object Fstring_match ();
1629extern Lisp_Object Fscan_buffer ();
7074fde6 1630extern void restore_match_data ();
238959e9 1631extern Lisp_Object Fmatch_data (), Fstore_match_data ();
a37e10f9
KH
1632extern Lisp_Object Fmatch_beginning (), Fmatch_end ();
1633extern Lisp_Object Fskip_chars_forward (), Fskip_chars_backward ();
3cfe6dfd
JB
1634
1635/* defined in minibuf.c */
1636
1637extern Lisp_Object last_minibuf_string;
1638extern Lisp_Object read_minibuf (), Fcompleting_read ();
1639extern Lisp_Object Fread_from_minibuffer ();
1640extern Lisp_Object Fread_variable (), Fread_buffer (), Fread_key_sequence ();
1641extern Lisp_Object Fread_minibuffer (), Feval_minibuffer ();
1642extern Lisp_Object Fread_string (), Fread_file_name ();
1643extern Lisp_Object Fread_no_blanks_input ();
1644
1645/* Defined in callint.c */
1646
de7885bb 1647extern Lisp_Object Qminus, Qplus, Vcurrent_prefix_arg;
3cfe6dfd
JB
1648extern Lisp_Object Vcommand_history;
1649extern Lisp_Object Qcall_interactively;
1650extern Lisp_Object Fcall_interactively ();
1651extern Lisp_Object Fprefix_numeric_value ();
1652
1653/* defined in casefiddle.c */
1654
1655extern Lisp_Object Fdowncase (), Fupcase (), Fcapitalize ();
40131ef5 1656extern Lisp_Object Fupcase_initials (), Fupcase_initials_region ();
3cfe6dfd
JB
1657
1658/* defined in keyboard.c */
1659
1660extern Lisp_Object Qdisabled;
1661extern Lisp_Object Vhelp_form, Vtop_level;
1662extern Lisp_Object Fdiscard_input (), Frecursive_edit ();
1663extern Lisp_Object Fcommand_execute (), Finput_pending_p ();
dd913f03 1664extern Lisp_Object menu_bar_items ();
f498e3b2 1665extern Lisp_Object Qvertical_scroll_bar;
5647f04f
KH
1666#ifdef MULTI_KBOARD
1667extern void delete_kboard ();
1668#endif
3cfe6dfd
JB
1669
1670/* defined in keymap.c */
1671
c451d7b1 1672extern Lisp_Object Qkeymap, Qmenu_bar;
3cfe6dfd
JB
1673extern Lisp_Object current_global_map;
1674extern Lisp_Object Fkey_description (), Fsingle_key_description ();
1675extern Lisp_Object Fwhere_is_internal ();
1676extern Lisp_Object access_keymap (), store_in_keymap ();
553a1e46 1677extern Lisp_Object get_keyelt (), get_keymap (), get_keymap_1 ();
a37e10f9 1678extern void describe_map_tree ();
3cfe6dfd
JB
1679
1680/* defined in indent.c */
1681extern Lisp_Object Fvertical_motion (), Findent_to (), Fcurrent_column ();
1682
1683/* defined in window.c */
afd0d237 1684extern Lisp_Object Qwindowp, Qwindow_live_p;
3cfe6dfd
JB
1685extern Lisp_Object Fget_buffer_window ();
1686extern Lisp_Object Fsave_window_excursion ();
1687extern Lisp_Object Fset_window_configuration (), Fcurrent_window_configuration ();
9453ea7b
JB
1688extern Lisp_Object Fcoordinates_in_window_p ();
1689extern Lisp_Object Fwindow_at ();
02213e82 1690extern int window_internal_height (), window_internal_width ();
3cfe6dfd 1691
ff11dfa1 1692/* defined in frame.c */
362fb47a 1693extern Lisp_Object Qvisible;
a37e10f9 1694extern void store_frame_param (), store_in_alist ();
82351c12 1695extern Lisp_Object do_switch_frame ();
a37e10f9 1696extern Lisp_Object get_frame_param();
a2b27e73 1697extern Lisp_Object frame_buffer_predicate ();
ff11dfa1
JB
1698extern Lisp_Object Fframep ();
1699extern Lisp_Object Fselect_frame ();
1700extern Lisp_Object Ffocus_frame ();
1701extern Lisp_Object Funfocus_frame ();
1702extern Lisp_Object Fselected_frame ();
1703extern Lisp_Object Fwindow_frame ();
1704extern Lisp_Object Fframe_root_window ();
40131ef5 1705extern Lisp_Object Fframe_first_window ();
ff11dfa1
JB
1706extern Lisp_Object Fframe_selected_window ();
1707extern Lisp_Object Fframe_list ();
1708extern Lisp_Object Fnext_frame ();
1709extern Lisp_Object Fdelete_frame ();
3cfe6dfd
JB
1710extern Lisp_Object Fread_mouse_position ();
1711extern Lisp_Object Fset_mouse_position ();
ff11dfa1
JB
1712extern Lisp_Object Fmake_frame_visible ();
1713extern Lisp_Object Fmake_frame_invisible ();
1714extern Lisp_Object Ficonify_frame ();
1715extern Lisp_Object Fdeiconify_frame ();
1716extern Lisp_Object Fframe_visible_p ();
1717extern Lisp_Object Fvisible_frame_list ();
1718extern Lisp_Object Fframe_parameters ();
1719extern Lisp_Object Fmodify_frame_parameters ();
1720extern Lisp_Object Fframe_pixel_size ();
1721extern Lisp_Object Fframe_height ();
1722extern Lisp_Object Fframe_width ();
1723extern Lisp_Object Fset_frame_height ();
1724extern Lisp_Object Fset_frame_width ();
1725extern Lisp_Object Fset_frame_size ();
1726extern Lisp_Object Fset_frame_position ();
3cfe6dfd
JB
1727
1728/* defined in emacs.c */
1729extern Lisp_Object decode_env_path ();
3530d534 1730extern Lisp_Object Vinvocation_name, Vinvocation_directory;
e6faba7f 1731extern Lisp_Object Vinstallation_directory;
d0068e25 1732void shut_down_emacs ( /* int signal, int no_x, Lisp_Object stuff */ );
3cfe6dfd
JB
1733/* Nonzero means don't do interactive redisplay and don't change tty modes */
1734extern int noninteractive;
1735/* Nonzero means don't do use window-system-specific display code */
1736extern int inhibit_window_system;
99a3d506 1737/* Nonzero means that a filter or a sentinel is running. */
7074fde6 1738extern int running_asynch_code;
3cfe6dfd
JB
1739
1740/* defined in process.c */
1741extern Lisp_Object Fget_process (), Fget_buffer_process (), Fprocessp ();
1742extern Lisp_Object Fprocess_status (), Fkill_process ();
7cdedc3f 1743extern Lisp_Object Fprocess_send_eof ();
40131ef5 1744extern Lisp_Object Fwaiting_for_user_input_p ();
6efad63b 1745extern Lisp_Object Qprocessp;
3cfe6dfd
JB
1746
1747/* defined in callproc.c */
9453ea7b 1748extern Lisp_Object Vexec_path, Vexec_directory, Vdata_directory;
c65be0e1 1749extern Lisp_Object Vdoc_directory;
3cfe6dfd 1750
3cfe6dfd
JB
1751/* defined in doc.c */
1752extern Lisp_Object Vdoc_file_name;
1753extern Lisp_Object Fsubstitute_command_keys ();
1754extern Lisp_Object Fdocumentation (), Fdocumentation_property ();
a37e10f9 1755extern Lisp_Object read_doc_string ();
3cfe6dfd
JB
1756
1757/* defined in bytecode.c */
1758extern Lisp_Object Qbytecode;
d20c2151 1759extern Lisp_Object Fbyte_code ();
3cfe6dfd
JB
1760
1761/* defined in macros.c */
1762extern Lisp_Object Qexecute_kbd_macro;
1763extern Lisp_Object Fexecute_kbd_macro ();
1764
d20c2151
JB
1765/* defined in undo.c */
1766extern Lisp_Object Fundo_boundary ();
1767extern Lisp_Object truncate_undo_list ();
1768
8537f1cb 1769/* defined in textprop.c */
c2d8811c 1770extern Lisp_Object Qmodification_hooks;
2a96daeb 1771extern Lisp_Object Qrear_nonsticky;
c2d8811c 1772extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
55253957
RS
1773extern Lisp_Object Fnext_property_change ();
1774extern Lisp_Object Fnext_single_property_change ();
a37e10f9 1775extern Lisp_Object Fprevious_single_property_change ();
8537f1cb 1776
40131ef5
KH
1777/* defined in intervals.c */
1778extern Lisp_Object get_local_map ();
1779
1780/* defined in xmenu.c */
1781extern Lisp_Object Fx_popup_menu (), Fx_popup_dialog ();
1782\f
3cfe6dfd
JB
1783/* Nonzero means Emacs has already been initialized.
1784 Used during startup to detect startup of dumped Emacs. */
1785extern int initialized;
1786
1787extern int immediate_quit; /* Nonzero means ^G can quit instantly */
1788
1789extern void debugger ();
1790
339747e4 1791extern char *getenv (), *ctime (), *getwd ();
3cfe6dfd 1792extern long *xmalloc (), *xrealloc ();
9ac0d9e0 1793extern void xfree ();
3cfe6dfd 1794
efb859b4 1795extern char *egetenv ();
c5e3de70 1796
5d6be39f
KH
1797/* Set up the name of the machine we're running on. */
1798extern void init_system_name ();
881a5a80
RS
1799
1800/* Some systems (e.g., NT) use a different path separator than Unix,
1801 in addition to a device separator. Default the path separator
1802 to '/', and don't test for a device separator in IS_ANY_SEP. */
1803
1804#ifndef DIRECTORY_SEP
1805#define DIRECTORY_SEP '/'
1806#endif
881a5a80
RS
1807#ifndef IS_DIRECTORY_SEP
1808#define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
1809#endif
1810#ifndef IS_DEVICE_SEP
1811#ifndef DEVICE_SEP
1812#define IS_DEVICE_SEP(_c_) 0
1813#else
1814#define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
1815#endif
1816#endif
1817#ifndef IS_ANY_SEP
1818#define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
1819#endif
51bd4610
KH
1820
1821#ifdef SWITCH_ENUM_BUG
1822#define SWITCH_ENUM_CAST(x) ((int)(x))
1823#else
1824#define SWITCH_ENUM_CAST(x) (x)
1825#endif