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