(x_clear_frame_selections, wait_for_property_change): Use new accessor macros
[bpt/emacs.git] / src / lisp.h
CommitLineData
3cfe6dfd 1/* Fundamental definitions for GNU Emacs Lisp interpreter.
3a22ee35 2 Copyright (C) 1985, 1986, 1987, 1993, 1994 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
3cfe6dfd
JB
29/* Define the fundamental Lisp data structures */
30
31/* This is the set of Lisp data types */
32
33enum Lisp_Type
34 {
35 /* Integer. XINT(obj) is the integer value. */
36 Lisp_Int,
37
38 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
39 Lisp_Symbol,
40
41 /* Marker (buffer ptr). XMARKER(object) points to a struct Lisp_Marker. */
42 Lisp_Marker,
43
44 /* String. XSTRING (object) points to a struct Lisp_String.
45 The length of the string, and its contents, are stored therein. */
46 Lisp_String,
47
48 /* Vector of Lisp objects. XVECTOR(object) points to a struct Lisp_Vector.
49 The length of the vector, and its contents, are stored therein. */
50 Lisp_Vector,
51
52 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
53 Lisp_Cons,
54
55 /* Byte-compiled function. A vector of 4 to 6 elements which are the
56 arglist, bytecode-string, constant vector, stack size,
57 (optional) doc string, and (optional) interactive spec. */
58 Lisp_Compiled,
59
60 /* Editor buffer. XBUFFER(obj) points to a struct buffer. */
61 Lisp_Buffer,
62
63 /* Built-in function. XSUBR(obj) points to a struct Lisp_Subr
64 which describes how to call the function, and its documentation,
65 as well as pointing to the code. */
66 Lisp_Subr,
67
68 /* Internal value return by subroutines of read.
69 The user never sees this data type.
70 Its value is just a number. */
71 Lisp_Internal,
72
73 /* Forwarding pointer to an int variable.
74 This is allowed only in the value cell of a symbol,
75 and it means that the symbol's value really lives in the
76 specified int variable.
77 XINTPTR(obj) points to the int variable. */
78 Lisp_Intfwd,
79
80 /* Boolean forwarding pointer to an int variable.
81 This is like Lisp_Intfwd except that the ostensible
82 "value" of the symbol is t if the int variable is nonzero,
83 nil if it is zero. XINTPTR(obj) points to the int variable. */
84 Lisp_Boolfwd,
85
86 /* Object describing a connection to a subprocess.
87 It points to storage of type struct Lisp_Process */
88 Lisp_Process,
89
90 /* Forwarding pointer to a Lisp_Object variable.
91 This is allowed only in the value cell of a symbol,
92 and it means that the symbol's value really lives in the
93 specified variable.
94 XOBJFWD(obj) points to the Lisp_Object variable. */
95 Lisp_Objfwd,
96
f1b76ec0 97#ifdef MULTI_FRAME
ff11dfa1 98 /* Pointer to a vector-like object describing a display frame
f1b76ec0
JB
99 on which Emacs can display a window hierarchy. We don't define
100 this unless MULTI_FRAME is defined; this helps the compiler catch
101 code that won't work on a non-MULTI_FRAME configuration. */
ff11dfa1 102 Lisp_Frame,
f1b76ec0 103#endif
3cfe6dfd
JB
104
105 /* Used when a FILE * value needs to be passed
106 in an argument of type Lisp_Object.
107 You must do *(FILE **) XPNTR(obj) to get the value.
108 The user will never see this data type. */
109 Lisp_Internal_Stream,
110
111 /* Used in a symbol value cell when the symbol's value is per-buffer.
e5d77022
JB
112 The actual contents are a cons cell which starts a list like this:
113 (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).
114
115 BUFFER is the last buffer for which this symbol's value was
116 made up to date.
117
118 CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
119 local_var_alist, that being the element whose car is this
120 variable. Or it can be a pointer to the
121 (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE),
122 if BUFFER does not have an element in its alist for this
123 variable (that is, if BUFFER sees the default value of this
124 variable).
125
126 If we want to examine or set the value and BUFFER is current,
127 we just examine or set REALVALUE. If BUFFER is not current, we
128 store the current REALVALUE value into CURRENT-ALIST-ELEMENT,
129 then find the appropriate alist element for the buffer now
130 current and set up CURRENT-ALIST-ELEMENT. Then we set
131 REALVALUE out of that element, and store into BUFFER.
132
133 If we are setting the variable and the current buffer does not
134 have an alist entry for this variable, an alist entry is
135 created.
136
137 Note that REALVALUE can be a forwarding pointer. Each time it
bad481d4
JB
138 is examined or set, forwarding must be done. Each time we
139 switch buffers, buffer-local variables which forward into C
140 variables are swapped immediately, so the C code can assume
141 that they are always up to date. */
3cfe6dfd
JB
142 Lisp_Buffer_Local_Value,
143
144 /* Like Lisp_Buffer_Local_Value with one difference:
35a4d143
RS
145 merely setting the variable while some buffer is current
146 does not cause that buffer to have its own local value of this variable.
147 Only make-local-variable does that. */
3cfe6dfd
JB
148 Lisp_Some_Buffer_Local_Value,
149
150
151 /* Like Lisp_Objfwd except that value lives in a slot
152 in the current buffer. Value is byte index of slot within buffer */
153 Lisp_Buffer_Objfwd,
154
155 /* In symbol value cell, means var is unbound.
156 In symbol function cell, means function name is undefined. */
157 Lisp_Void,
158
159 /* Window used for Emacs display.
160 Data inside looks like a Lisp_Vector. */
161 Lisp_Window,
162
163 /* Used by save,set,restore-window-configuration */
20280af7 164 Lisp_Window_Configuration,
3cfe6dfd
JB
165
166#ifdef LISP_FLOAT_TYPE
20280af7 167 Lisp_Float,
3cfe6dfd 168#endif /* LISP_FLOAT_TYPE */
20280af7
JB
169
170 /* The overlay type.
171 An overlay values is actually a retagged cons, the first in a
172 list of the form
173 ((START . END) nil . PLIST)
174 where START and END are markers in the overlay's buffer, and
175 PLIST is the overlay's property list. */
176 Lisp_Overlay
3cfe6dfd
JB
177 };
178
179#ifndef NO_UNION_TYPE
180
c451d7b1 181#ifndef WORDS_BIG_ENDIAN
3cfe6dfd
JB
182
183/* Definition of Lisp_Object for little-endian machines. */
184
185typedef
186union Lisp_Object
187 {
188 /* Used for comparing two Lisp_Objects;
189 also, positive integers can be accessed fast this way. */
190 int i;
191
192 struct
193 {
194 int val: 24;
195 char type;
196 } s;
197 struct
198 {
199 unsigned int val: 24;
200 char type;
201 } u;
202 struct
203 {
204 unsigned int val: 24;
205 enum Lisp_Type type: 7;
206 /* The markbit is not really part of the value of a Lisp_Object,
207 and is always zero except during garbage collection. */
208 unsigned int markbit: 1;
209 } gu;
210 }
211Lisp_Object;
212
c451d7b1 213#else /* If WORDS_BIG_ENDIAN */
3cfe6dfd
JB
214
215typedef
216union Lisp_Object
217 {
218 /* Used for comparing two Lisp_Objects;
219 also, positive integers can be accessed fast this way. */
220 int i;
221
222 struct
223 {
224 char type;
225 int val: 24;
226 } s;
227 struct
228 {
229 char type;
230 unsigned int val: 24;
231 } u;
232 struct
233 {
234 /* The markbit is not really part of the value of a Lisp_Object,
235 and is always zero except during garbage collection. */
236 unsigned int markbit: 1;
237 enum Lisp_Type type: 7;
238 unsigned int val: 24;
239 } gu;
240 }
241Lisp_Object;
242
c451d7b1 243#endif /* WORDS_BIG_ENDIAN */
3cfe6dfd
JB
244
245#endif /* NO_UNION_TYPE */
246
247
248/* If union type is not wanted, define Lisp_Object as just a number
249 and define the macros below to extract fields by shifting */
250
251#ifdef NO_UNION_TYPE
252
627a9502 253#define Lisp_Object EMACS_INT
3cfe6dfd
JB
254
255/* These values are overridden by the m- file on some machines. */
256#ifndef VALBITS
257#define VALBITS 24
258#endif
259
260#ifndef GCTYPEBITS
261#define GCTYPEBITS 7
262#endif
263
264#ifndef VALMASK
627a9502 265#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
3cfe6dfd 266#endif
627a9502 267#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
846d69ac
RS
268
269/* Two flags that are set during GC. On some machines, these flags
270 are defined differently by the m- file. */
271
272/* This is set in the car of a cons and in the plist slot of a symbol
273 to indicate it is marked. Likewise in the plist slot of an interval,
274 the chain slot of a marker, the type slot of a float, and the name
275 slot of a buffer.
276
277 In strings, this bit in the size field indicates that the string
278 is a "large" one, one which was separately malloc'd
279 rather than being part of a string block. */
280
627a9502 281#ifndef MARKBIT
3cfe6dfd 282#define MARKBIT (1 << (VALBITS + GCTYPEBITS))
627a9502 283#endif /*MARKBIT */
3cfe6dfd 284
846d69ac
RS
285/* In the size word of a vector, this bit means the vector has been marked.
286 In the size word of a large string, likewise. */
287
288#ifndef ARRAY_MARK_FLAG
289#define ARRAY_MARK_FLAG ((MARKBIT >> 1) & ~MARKBIT)
290#endif /* no ARRAY_MARK_FLAG */
291
292#if ARRAY_MARK_FLAG == MARKBIT
293you lose
294#endif
295
3cfe6dfd
JB
296#endif /* NO_UNION_TYPE */
297\f
298/* These macros extract various sorts of values from a Lisp_Object.
299 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
300 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
301
302#ifdef NO_UNION_TYPE
303
304/* One need to override this if there must be high bits set in data space
305 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
306 on all machines, but would penalise machines which don't need it)
307 */
308#ifndef XTYPE
309#define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
310#endif
311
312#ifndef XSETTYPE
627a9502 313#define XSETTYPE(a, b) ((a) = XUINT (a) | ((EMACS_INT)(b) << VALBITS))
3cfe6dfd
JB
314#endif
315
316/* Use XFASTINT for fast retrieval and storage of integers known
317 to be positive. This takes advantage of the fact that Lisp_Int is 0. */
318#define XFASTINT(a) (a)
319
320/* Extract the value of a Lisp_Object as a signed integer. */
321
322#ifndef XINT /* Some machines need to do this differently. */
e065a56e 323#define XINT(a) (((a) << (INTBITS-VALBITS)) >> (INTBITS-VALBITS))
3cfe6dfd
JB
324#endif
325
326/* Extract the value as an unsigned integer. This is a basis
327 for extracting it as a pointer to a structure in storage. */
328
329#ifndef XUINT
330#define XUINT(a) ((a) & VALMASK)
331#endif
332
333#ifndef XPNTR
334#ifdef HAVE_SHM
335/* In this representation, data is found in two widely separated segments. */
29eab336 336extern int pure_size;
3cfe6dfd 337#define XPNTR(a) \
29eab336 338 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
3cfe6dfd
JB
339#else /* not HAVE_SHM */
340#ifdef DATA_SEG_BITS
341/* This case is used for the rt-pc.
342 In the diffs I was given, it checked for ptr = 0
343 and did not adjust it in that case.
344 But I don't think that zero should ever be found
345 in a Lisp object whose data type says it points to something. */
346#define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
347#else
348#define XPNTR(a) XUINT (a)
349#endif
350#endif /* not HAVE_SHM */
351#endif /* no XPNTR */
352
353#ifndef XSETINT
354#define XSETINT(a, b) ((a) = ((a) & ~VALMASK) | ((b) & VALMASK))
355#endif
356
357#ifndef XSETUINT
358#define XSETUINT(a, b) XSETINT (a, b)
359#endif
360
361#ifndef XSETPNTR
362#define XSETPNTR(a, b) XSETINT (a, b)
363#endif
364
365#ifndef XSET
366#define XSET(var, type, ptr) \
627a9502 367 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
3cfe6dfd
JB
368#endif
369
370/* During garbage collection, XGCTYPE must be used for extracting types
371 so that the mark bit is ignored. XMARKBIT accesses the markbit.
372 Markbits are used only in particular slots of particular structure types.
373 Other markbits are always zero.
374 Outside of garbage collection, all mark bits are always zero. */
375
376#ifndef XGCTYPE
377#define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
378#endif
379
380#if VALBITS + GCTYPEBITS == INTBITS - 1
381/* Make XMARKBIT faster if mark bit is sign bit. */
382#ifndef XMARKBIT
383#define XMARKBIT(a) ((a) < 0)
384#endif
385#endif /* markbit is sign bit */
386
387#ifndef XMARKBIT
388#define XMARKBIT(a) ((a) & MARKBIT)
389#endif
390
391#ifndef XSETMARKBIT
392#define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
393#endif
394
395#ifndef XMARK
396#define XMARK(a) ((a) |= MARKBIT)
397#endif
398
399#ifndef XUNMARK
400#define XUNMARK(a) ((a) &= ~MARKBIT)
401#endif
402
403#endif /* NO_UNION_TYPE */
404
405#ifndef NO_UNION_TYPE
406
407#define XTYPE(a) ((enum Lisp_Type) (a).u.type)
408#define XSETTYPE(a, b) ((a).u.type = (char) (b))
409
410/* Use XFASTINT for fast retrieval and storage of integers known
411 to be positive. This takes advantage of the fact that Lisp_Int is 0. */
412#define XFASTINT(a) ((a).i)
413
414#ifdef EXPLICIT_SIGN_EXTEND
415/* Make sure we sign-extend; compilers have been known to fail to do so. */
416#define XINT(a) (((a).i << 8) >> 8)
417#else
418#define XINT(a) ((a).s.val)
419#endif /* EXPLICIT_SIGN_EXTEND */
420
421#define XUINT(a) ((a).u.val)
422#define XPNTR(a) ((a).u.val)
423#define XSETINT(a, b) ((a).s.val = (int) (b))
424#define XSETUINT(a, b) ((a).s.val = (int) (b))
425#define XSETPNTR(a, b) ((a).s.val = (int) (b))
426
427#define XSET(var, vartype, ptr) \
428 (((var).s.type = ((char) (vartype))), ((var).s.val = ((int) (ptr))))
429
430/* During garbage collection, XGCTYPE must be used for extracting types
431 so that the mark bit is ignored. XMARKBIT access the markbit.
432 Markbits are used only in particular slots of particular structure types.
433 Other markbits are always zero.
434 Outside of garbage collection, all mark bits are always zero. */
435
436#define XGCTYPE(a) ((a).gu.type)
437#define XMARKBIT(a) ((a).gu.markbit)
438#define XSETMARKBIT(a,b) (XMARKBIT(a) = (b))
439#define XMARK(a) (XMARKBIT(a) = 1)
440#define XUNMARK(a) (XMARKBIT(a) = 0)
441
442#endif /* NO_UNION_TYPE */
443
444
445#define XCONS(a) ((struct Lisp_Cons *) XPNTR(a))
446#define XBUFFER(a) ((struct buffer *) XPNTR(a))
447#define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
448#define XSUBR(a) ((struct Lisp_Subr *) XPNTR(a))
449#define XSTRING(a) ((struct Lisp_String *) XPNTR(a))
450#define XSYMBOL(a) ((struct Lisp_Symbol *) XPNTR(a))
451#define XFUNCTION(a) ((Lisp_Object (*)()) XPNTR(a))
452#define XMARKER(a) ((struct Lisp_Marker *) XPNTR(a))
453#define XOBJFWD(a) ((Lisp_Object *) XPNTR(a))
454#define XINTPTR(a) ((int *) XPNTR(a))
455#define XWINDOW(a) ((struct window *) XPNTR(a))
456#define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
457#define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
458
627a9502
RS
459#define XSETCONS(a, b) XSETPNTR(a, (EMACS_INT) (b))
460#define XSETBUFFER(a, b) XSETPNTR(a, (EMACS_INT) (b))
461#define XSETVECTOR(a, b) XSETPNTR(a, (EMACS_INT) (b))
462#define XSETSUBR(a, b) XSETPNTR(a, (EMACS_INT) (b))
463#define XSETSTRING(a, b) XSETPNTR(a, (EMACS_INT) (b))
464#define XSETSYMBOL(a, b) XSETPNTR(a, (EMACS_INT) (b))
465#define XSETFUNCTION(a, b) XSETPNTR(a, (EMACS_INT) (b))
466#define XSETMARKER(a, b) XSETPNTR(a, (EMACS_INT) (b))
467#define XSETOBJFWD(a, b) XSETPNTR(a, (EMACS_INT) (b))
468#define XSETINTPTR(a, b) XSETPNTR(a, (EMACS_INT) (b))
469#define XSETWINDOW(a, b) XSETPNTR(a, (EMACS_INT) (b))
470#define XSETPROCESS(a, b) XSETPNTR(a, (EMACS_INT) (b))
471#define XSETFLOAT(a, b) XSETPNTR(a, (EMACS_INT) (b))
3cfe6dfd 472\f
e221eae3
JA
473#ifdef USE_TEXT_PROPERTIES
474/* Basic data type for use of intervals. See the macros in intervals.h */
475
476struct interval
477{
478 /* The first group of entries deal with the tree structure. */
479
480 unsigned int total_length; /* Length of myself and both children. */
481 unsigned int position; /* Cache of interval's character position */
482 struct interval *left; /* Intervals which precede me. */
483 struct interval *right; /* Intervals which succeed me. */
e8720644
JB
484
485 /* Parent in the tree, or the Lisp_Object containing this interval tree.
486
487 The mark bit on the root interval of an interval tree says
488 whether we have started (and possibly finished) marking the
489 tree. If GC comes across an interval tree whose root's parent
490 field has its markbit set, it leaves the tree alone.
491
492 You'd think we could store this information in the parent object
493 somewhere (after all, that should be visited once and then
494 ignored too, right?), but strings are GC'd strangely. */
495 struct interval *parent;
e221eae3
JA
496
497 /* The remaining components are `properties' of the interval.
498 The first four are duplicates for things which can be on the list,
499 for purposes of speed. */
500
501 unsigned char write_protect; /* Non-zero means can't modify. */
502 unsigned char visible; /* Zero means don't display. */
cde20f41 503 unsigned char front_sticky; /* Non-zero means text inserted just
e221eae3 504 before this interval goes into it. */
cde20f41 505 unsigned char rear_sticky; /* Likewise for just after it. */
e221eae3 506
e8720644
JB
507 /* Properties of this interval.
508 The mark bit on this field says whether this particular interval
509 tree node has been visited. Since intervals should never be
510 shared, GC aborts if it seems to have visited an interval twice. */
511 Lisp_Object plist;
e221eae3
JA
512};
513
514typedef struct interval *INTERVAL;
515
516/* Complain if object is not string or buffer type */
517#define CHECK_STRING_OR_BUFFER(x, i) \
c5af3bb9 518 { if (!STRINGP ((x)) && !BUFFERP ((x))) \
e221eae3
JA
519 x = wrong_type_argument (Qbuffer_or_string_p, (x)); }
520
521/* Macro used to conditionally compile intervals into certain data
522 structures. See, e.g., struct Lisp_String below. */
523#define DECLARE_INTERVALS INTERVAL intervals;
524
eb8c3be9 525/* Macro used to conditionally compile interval initialization into
e221eae3
JA
526 certain code. See, e.g., alloc.c. */
527#define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val
528
529#else /* No text properties */
530
531/* If no intervals are used, make the above definitions go away. */
532
533#define CHECK_STRING_OR_BUFFER(x, i)
534
535#define INTERVAL
536#define DECLARE_INTERVALS
537#define INITIALIZE_INTERVAL(ptr,val)
538
539#endif /* USE_TEXT_PROPERTIES */
540\f
3cfe6dfd
JB
541/* In a cons, the markbit of the car is the gc mark bit */
542
543struct Lisp_Cons
544 {
545 Lisp_Object car, cdr;
546 };
547
548/* Like a cons, but records info on where the text lives that it was read from */
549/* This is not really in use now */
550
551struct Lisp_Buffer_Cons
552 {
553 Lisp_Object car, cdr;
554 struct buffer *buffer;
555 int bufpos;
556 };
557
558/* In a string or vector, the sign bit of the `size' is the gc mark bit */
559
560struct Lisp_String
561 {
627a9502 562 EMACS_INT size;
e221eae3 563 DECLARE_INTERVALS /* `data' field must be last. */
3cfe6dfd
JB
564 unsigned char data[1];
565 };
566
567struct Lisp_Vector
568 {
627a9502 569 EMACS_INT size;
3cfe6dfd
JB
570 struct Lisp_Vector *next;
571 Lisp_Object contents[1];
572 };
573
574/* In a symbol, the markbit of the plist is used as the gc mark bit */
575
576struct Lisp_Symbol
577 {
578 struct Lisp_String *name;
579 Lisp_Object value;
580 Lisp_Object function;
581 Lisp_Object plist;
582 struct Lisp_Symbol *next; /* -> next symbol in this obarray bucket */
583 };
584
585struct Lisp_Subr
586 {
587 Lisp_Object (*function) ();
588 short min_args, max_args;
589 char *symbol_name;
590 char *prompt;
591 char *doc;
592 };
593
594/* In a marker, the markbit of the chain field is used as the gc mark bit */
595
596struct Lisp_Marker
597 {
598 struct buffer *buffer;
599 Lisp_Object chain;
600 int bufpos;
601 int modified;
602 };
603
604#ifdef LISP_FLOAT_TYPE
605/* Optional Lisp floating point type */
606struct Lisp_Float
607 {
608 Lisp_Object type; /* essentially used for mark-bit
609 and chaining when on free-list */
610 double data;
611 };
612#endif /* LISP_FLOAT_TYPE */
613
614/* A character, declared with the following typedef, is a member
615 of some character set associated with the current buffer. */
b2ba7b00
RS
616#ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
617#define _UCHAR_T
3cfe6dfd 618typedef unsigned char UCHAR;
b2ba7b00 619#endif
3cfe6dfd
JB
620
621/* Meanings of slots in a Lisp_Compiled: */
622
623#define COMPILED_ARGLIST 0
624#define COMPILED_BYTECODE 1
625#define COMPILED_CONSTANTS 2
626#define COMPILED_STACK_DEPTH 3
627#define COMPILED_DOC_STRING 4
628#define COMPILED_INTERACTIVE 5
88dbfee5 629
d03f79ef
JB
630/* Flag bits in a character. These also get used in termhooks.h.
631 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
632 (MUlti-Lingual Emacs) might need 18 bits for the character value
633 itself, so we probably shouldn't use any bits lower than 0x040000. */
634#define CHAR_ALT (0x040000)
635#define CHAR_SUPER (0x080000)
636#define CHAR_HYPER (0x100000)
637#define CHAR_SHIFT (0x200000)
638#define CHAR_CTL (0x400000)
639#define CHAR_META (0x800000)
703f2808 640
e6faba7f
RS
641#ifdef USE_X_TOOLKIT
642#ifdef NO_UNION_TYPE
643/* Use this for turning a (void *) into a Lisp_Object, as when the
644 Lisp_Object is passed into a toolkit callback function. */
645#define VOID_TO_LISP(larg,varg) \
646 do { ((larg) = ((Lisp_Object) (varg))); } while (0)
647#define CVOID_TO_LISP VOID_TO_LISP
648
649/* Use this for turning a Lisp_Object into a (void *), as when the
650 Lisp_Object is passed into a toolkit callback function. */
651#define LISP_TO_VOID(larg) ((void *) (larg))
652#define LISP_TO_CVOID(varg) ((const void *) (larg))
653
654#else /* not NO_UNION_TYPE */
655/* Use this for turning a (void *) into a Lisp_Object, as when the
656 Lisp_Object is passed into a toolkit callback function. */
657#define VOID_TO_LISP(larg,varg) \
658 do { ((larg).v = (void *) (varg)); } while (0)
659#define CVOID_TO_LISP(larg,varg) \
660 do { ((larg).cv = (const void *) (varg)); } while (0)
661
662/* Use this for turning a Lisp_Object into a (void *), as when the
663 Lisp_Object is passed into a toolkit callback function. */
664#define LISP_TO_VOID(larg) ((larg).v)
665#define LISP_TO_CVOID(larg) ((larg).cv)
666#endif /* not NO_UNION_TYPE */
667#endif /* USE_X_TOOLKIT */
668
703f2808
JB
669\f
670/* The glyph datatype, used to represent characters on the display. */
671
672/* The low eight bits are the character code, and the bits above them
673 are the numeric face ID. If FID is the face ID of a glyph on a
674 frame F, then F->display.x->faces[FID] contains the description of
675 that face. This is an int instead of a short, so we can support a
676 good bunch of face ID's; given that we have no mechanism for
677 tossing unused frame face ID's yet, we'll probably run out of 255
678 pretty quickly. */
679#define GLYPH unsigned int
680
49b0dd75
KH
681#ifdef HAVE_X_WINDOWS
682/* The FAST macros assume that we already know we're in an X window. */
683
703f2808 684/* Given a character code and a face ID, return the appropriate glyph. */
49b0dd75 685#define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << 8))
703f2808
JB
686
687/* Return a glyph's character code. */
49b0dd75 688#define FAST_GLYPH_CHAR(glyph) ((glyph) & 0xff)
703f2808
JB
689
690/* Return a glyph's face ID. */
49b0dd75
KH
691#define FAST_GLYPH_FACE(glyph) (((glyph) >> 8) & ((1 << 24) - 1))
692
693/* Slower versions that test the frame type first. */
694#define MAKE_GLYPH(f, char, face) (FRAME_TERMCAP_P (f) ? (char) \
695 : FAST_MAKE_GLYPH (char, face))
696#define GLYPH_CHAR(f, g) (FRAME_TERMCAP_P (f) ? (g) : FAST_GLYPH_CHAR (g))
697#define GLYPH_FACE(f, g) (FRAME_TERMCAP_P (f) ? (0) : FAST_GLYPH_FACE (g))
698#else
699#define MAKE_GLYPH(f, char, face) (char)
700#define GLYPH_CHAR(f, g) (g)
701#define GLYPH_FACE(f, g) (g)
702#endif
703f2808 703
4606cc9d
RS
704/* The ID of the mode line highlighting face. */
705#define GLYPH_MODE_LINE_FACE 1
3cfe6dfd
JB
706\f
707/* Data type checking */
708
efb859b4 709#define NILP(x) (XFASTINT (x) == XFASTINT (Qnil))
f498e3b2 710#define GC_NILP(x) GC_EQ (x, Qnil)
3cfe6dfd 711
4746118a 712#ifdef LISP_FLOAT_TYPE
c5af3bb9 713#define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
4746118a 714#else
c5af3bb9 715#define NUMBERP(x) (INTEGERP (x))
4746118a
JB
716#endif
717
edfa9106
RS
718#define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
719#define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
720#define MARKERP(x) (XTYPE ((x)) == Lisp_Marker)
721#define STRINGP(x) (XTYPE ((x)) == Lisp_String)
722#define VECTORP(x) (XTYPE ((x)) == Lisp_Vector)
3cfe6dfd 723#define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
edfa9106
RS
724#define COMPILEDP(x) (XTYPE ((x)) == Lisp_Compiled)
725#define BUFFERP(x) (XTYPE ((x)) == Lisp_Buffer)
726#define SUBRP(x) (XTYPE ((x)) == Lisp_Subr)
727#define PROCESSP(x) (XTYPE ((x)) == Lisp_Process)
728#define FRAMEP(x) (XTYPE ((x)) == Lisp_Frame)
729#define WINDOWP(x) (XTYPE ((x)) == Lisp_Window)
730#define WINDOW_CONFIGURATIONP(x) (XTYPE ((x)) == Lisp_Window_Configuration)
20280af7 731#ifdef LISP_FLOAT_TYPE
edfa9106 732#define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
20280af7
JB
733#else
734#define FLOATP(x) (0)
735#endif
736#define OVERLAYP(x) (XTYPE ((x)) == Lisp_Overlay)
c5af3bb9
KH
737#define BOOLFWDP(x) (XTYPE ((x)) == Lisp_Boolfwd)
738#define INTERNALP(x) (XTYPE ((x)) == Lisp_Internal)
739#define INTFWDP(x) (XTYPE ((x)) == Lisp_Intfwd)
740#define OBJFWDP(x) (XTYPE ((x)) == Lisp_Objfwd)
741#define INTERNAL_STREAMP(x) (XTYPE ((x)) == Lisp_Internal_Stream)
742#define BUFFER_LOCAL_VALUEP(x) (XTYPE ((x)) == Lisp_Buffer_Local_Value)
743#define SOME_BUFFER_LOCAL_VALUEP(x) (XTYPE ((x)) == Lisp_Some_Buffer_Local_Value)
744#define BUFFER_OBJFWDP(x) (XTYPE ((x)) == Lisp_Buffer_Objfwd)
745#define VOIDP(x) (XTYPE ((x)) == Lisp_Void)
edfa9106 746
3cfe6dfd 747#define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
f498e3b2 748#define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
4746118a 749
3cfe6dfd 750#define CHECK_LIST(x, i) \
c5af3bb9 751 do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
3cfe6dfd
JB
752
753#define CHECK_STRING(x, i) \
c5af3bb9 754 do { if (!STRINGP ((x))) x = wrong_type_argument (Qstringp, (x)); } while (0)
3cfe6dfd
JB
755
756#define CHECK_CONS(x, i) \
c5af3bb9 757 do { if (!CONSP ((x))) x = wrong_type_argument (Qconsp, (x)); } while (0)
3cfe6dfd
JB
758
759#define CHECK_SYMBOL(x, i) \
c5af3bb9 760 do { if (!SYMBOLP ((x))) x = wrong_type_argument (Qsymbolp, (x)); } while (0)
3cfe6dfd
JB
761
762#define CHECK_VECTOR(x, i) \
c5af3bb9 763 do { if (!VECTORP ((x))) x = wrong_type_argument (Qvectorp, (x)); } while (0)
3cfe6dfd
JB
764
765#define CHECK_BUFFER(x, i) \
c5af3bb9 766 do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
3cfe6dfd
JB
767
768#define CHECK_WINDOW(x, i) \
c5af3bb9 769 do { if (!WINDOWP ((x))) x = wrong_type_argument (Qwindowp, (x)); } while (0)
3cfe6dfd 770
03273ec5
JB
771/* This macro rejects windows on the interior of the window tree as
772 "dead", which is what we want; this is an argument-checking macro, and
773 the user should never get access to interior windows.
774
775 A window of any sort, leaf or interior, is dead iff the buffer,
776 vchild, and hchild members are all nil. */
777
778#define CHECK_LIVE_WINDOW(x, i) \
2ad18bfd 779 do { \
c5af3bb9 780 if (!WINDOWP ((x)) \
03273ec5 781 || NILP (XWINDOW ((x))->buffer)) \
806b4d9b 782 x = wrong_type_argument (Qwindow_live_p, (x)); \
2ad18bfd 783 } while (0)
03273ec5 784
3cfe6dfd 785#define CHECK_PROCESS(x, i) \
c5af3bb9 786 do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
3cfe6dfd
JB
787
788#define CHECK_NUMBER(x, i) \
c5af3bb9 789 do { if (!INTEGERP ((x))) x = wrong_type_argument (Qintegerp, (x)); } while (0)
3cfe6dfd
JB
790
791#define CHECK_NATNUM(x, i) \
c5af3bb9 792 do { if (!INTEGERP ((x)) || XINT ((x)) < 0) \
07a97bf8 793 x = wrong_type_argument (Qwholenump, (x)); } while (0)
3cfe6dfd
JB
794
795#define CHECK_MARKER(x, i) \
c5af3bb9 796 do { if (!MARKERP ((x))) x = wrong_type_argument (Qmarkerp, (x)); } while (0)
3cfe6dfd
JB
797
798#define CHECK_NUMBER_COERCE_MARKER(x, i) \
c5af3bb9
KH
799 do { if (MARKERP ((x))) XFASTINT (x) = marker_position (x); \
800 else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
3cfe6dfd
JB
801
802#ifdef LISP_FLOAT_TYPE
803
804#ifndef DBL_DIG
805#define DBL_DIG 20
806#endif
807
808#define XFLOATINT(n) extract_float((n))
809
810#define CHECK_FLOAT(x, i) \
c5af3bb9 811 do { if (!FLOATP (x)) \
2ad18bfd 812 x = wrong_type_argument (Qfloatp, (x)); } while (0)
3cfe6dfd
JB
813
814#define CHECK_NUMBER_OR_FLOAT(x, i) \
c5af3bb9 815 do { if (!FLOATP (x) && !INTEGERP (x)) \
2ad18bfd 816 x = wrong_type_argument (Qnumberp, (x)); } while (0)
3cfe6dfd
JB
817
818#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
c5af3bb9
KH
819 do { if (MARKERP (x)) XFASTINT (x) = marker_position (x); \
820 else if (!INTEGERP (x) && !FLOATP (x)) \
2ad18bfd 821 x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
3cfe6dfd
JB
822
823#else /* Not LISP_FLOAT_TYPE */
824
825#define CHECK_NUMBER_OR_FLOAT CHECK_NUMBER
826
827#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER CHECK_NUMBER_COERCE_MARKER
828
829#define XFLOATINT(n) XINT((n))
830#endif /* LISP_FLOAT_TYPE */
831
20280af7 832#define CHECK_OVERLAY(x, i) \
c5af3bb9 833 do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
20280af7 834
3cfe6dfd
JB
835/* Cast pointers to this type to compare them. Some machines want int. */
836#ifndef PNTR_COMPARISON_TYPE
837#define PNTR_COMPARISON_TYPE unsigned int
838#endif
839\f
840/* Define a built-in function for calling from Lisp.
841 `lname' should be the name to give the function in Lisp,
842 as a null-terminated C string.
843 `fnname' should be the name of the function in C.
844 By convention, it starts with F.
845 `sname' should be the name for the C constant structure
846 that records information on this function for internal use.
847 By convention, it should be the same as `fnname' but with S instead of F.
848 It's too bad that C macros can't compute this from `fnname'.
849 `minargs' should be a number, the minimum number of arguments allowed.
850 `maxargs' should be a number, the maximum number of arguments allowed,
851 or else MANY or UNEVALLED.
852 MANY means pass a vector of evaluated arguments,
853 in the form of an integer number-of-arguments
854 followed by the address of a vector of Lisp_Objects
855 which contains the argument values.
856 UNEVALLED means pass the list of unevaluated arguments
857 `prompt' says how to read arguments for an interactive call.
858 This can be zero or a C string.
859 Zero means that interactive calls are not allowed.
860 A string is interpreted in a hairy way:
861 it should contain one line for each argument to be read, terminated by \n.
862 The first character of the line controls the type of parsing:
863 s -- read a string.
864 S -- read a symbol.
865 k -- read a key sequence and return it as a string.
866 a -- read a function name (symbol) with completion.
867 C -- read a command name (symbol) with completion.
868 v -- read a variable name (symbol) with completion.
869 b -- read a buffer name (a string) with completion.
870 B -- buffer name, may be existing buffer or may not be.
871 f -- read a file name, file must exist.
872 F -- read a file name, file need not exist.
873 n -- read a number.
874 c -- read a character and return it as a number.
875 p -- use the numeric value of the prefix argument.
876 P -- use raw value of prefix - can be nil, -, (NUMBER) or NUMBER.
877 x -- read a Lisp object from the minibuffer.
878 X -- read a Lisp form from the minibuffer and use its value.
879 A null string means call interactively with no arguments.
880 `doc' is documentation for the user.
881*/
882
5125ca93 883#if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
3cfe6dfd
JB
884#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
885 Lisp_Object fnname (); \
886 struct Lisp_Subr sname = {fnname, minargs, maxargs, lname, prompt, 0}; \
887 Lisp_Object fnname
888
c451d7b1
RS
889#else
890
891/* This version of DEFUN declares a function prototype with the right
892 arguments, so we can catch errors with maxargs at compile-time. */
893#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
894 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
895 struct Lisp_Subr sname = {fnname, minargs, maxargs, lname, prompt, 0}; \
896 Lisp_Object fnname
897
898/* Note that the weird token-substitution semantics of ANSI C makes
899 this work for MANY and UNEVALLED. */
900#define DEFUN_ARGS_MANY (int, Lisp_Object *)
901#define DEFUN_ARGS_UNEVALLED (Lisp_Object)
902#define DEFUN_ARGS_0 (void)
903#define DEFUN_ARGS_1 (Lisp_Object)
904#define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
905#define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
906#define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
907#define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
908 Lisp_Object)
909#define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
910 Lisp_Object, Lisp_Object)
911#define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
912 Lisp_Object, Lisp_Object, Lisp_Object)
913#endif
914
3cfe6dfd
JB
915/* defsubr (Sname);
916 is how we define the symbol for function `name' at start-up time. */
917extern void defsubr ();
918
919#define MANY -2
920#define UNEVALLED -1
921
922extern void defvar_lisp ();
923extern void defvar_bool ();
924extern void defvar_int ();
925
926/* Macros we use to define forwarded Lisp variables.
927 These are used in the syms_of_FILENAME functions. */
928
3cfe6dfd
JB
929#define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
930#define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
931#define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
932#define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
ef15f270
JB
933#define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
934 defvar_per_buffer (lname, vname, type, 0)
3cfe6dfd 935\f
78ca380c
JB
936/* Structure for recording Lisp call stack for backtrace purposes. */
937
938/* The special binding stack holds the outer values of variables while
939 they are bound by a function application or a let form, stores the
940 code to be executed for Lisp unwind-protect forms, and stores the C
941 functions to be called for record_unwind_protect.
942
943 If func is non-zero, undoing this binding applies func to old_value;
944 This implements record_unwind_protect.
945 If func is zero and symbol is nil, undoing this binding evaluates
946 the list of forms in old_value; this implements Lisp's unwind-protect
947 form.
948 Otherwise, undoing this binding stores old_value as symbol's value; this
949 undoes the bindings made by a let form or function call. */
3cfe6dfd
JB
950struct specbinding
951 {
952 Lisp_Object symbol, old_value;
953 Lisp_Object (*func) ();
954 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
955 };
956
957extern struct specbinding *specpdl;
958extern struct specbinding *specpdl_ptr;
959extern int specpdl_size;
960
78ca380c 961/* Everything needed to describe an active condition case. */
3cfe6dfd
JB
962struct handler
963 {
78ca380c 964 /* The handler clauses and variable from the condition-case form. */
3cfe6dfd
JB
965 Lisp_Object handler;
966 Lisp_Object var;
22bbbd42
RS
967 /* Fsignal stores here the condition-case clause that applies,
968 and Fcondition_case thus knows which clause to run. */
969 Lisp_Object chosen_clause;
78ca380c
JB
970
971 /* Used to effect the longjump out to the handler. */
3cfe6dfd 972 struct catchtag *tag;
78ca380c
JB
973
974 /* The next enclosing handler. */
3cfe6dfd
JB
975 struct handler *next;
976 };
977
978extern struct handler *handlerlist;
979
980extern struct catchtag *catchlist;
981extern struct backtrace *backtrace_list;
982
22bbbd42
RS
983extern Lisp_Object memory_signal_data;
984
3cfe6dfd
JB
985/* An address near the bottom of the stack.
986 Tells GC how to save a copy of the stack. */
987extern char *stack_bottom;
988
989/* Check quit-flag and quit if it is non-nil. */
990
991#define QUIT \
efb859b4 992 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3cfe6dfd
JB
993 { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }
994
995/* Nonzero if ought to quit now. */
996
efb859b4 997#define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3cfe6dfd
JB
998\f
999/* 1 if CH is upper case. */
1000
7b15897a
JB
1001#define UPPERCASEP(CH) \
1002 (XSTRING (current_buffer->downcase_table)->data[CH] != (CH))
3cfe6dfd
JB
1003
1004/* 1 if CH is lower case. */
1005
1006#define LOWERCASEP(CH) \
7b15897a
JB
1007 (!UPPERCASEP (CH) \
1008 && XSTRING (current_buffer->upcase_table)->data[CH] != (CH))
3cfe6dfd
JB
1009
1010/* 1 if CH is neither upper nor lower case. */
1011
1012#define NOCASEP(CH) (XSTRING (current_buffer->upcase_table)->data[CH] == (CH))
1013
1014/* Upcase a character, or make no change if that cannot be done. */
1015
7b15897a
JB
1016#define UPCASE(CH) \
1017 (XSTRING (current_buffer->downcase_table)->data[CH] == (CH) \
1018 ? UPCASE1 (CH) : (CH))
3cfe6dfd
JB
1019
1020/* Upcase a character known to be not upper case. */
1021
1022#define UPCASE1(CH) (XSTRING (current_buffer->upcase_table)->data[CH])
1023
1024/* Downcase a character, or make no change if that cannot be done. */
1025
1026#define DOWNCASE(CH) (XSTRING (current_buffer->downcase_table)->data[CH])
1027
1028/* Current buffer's map from characters to lower-case characters. */
1029
1030#define DOWNCASE_TABLE XSTRING (current_buffer->downcase_table)->data
1031
1032/* Table mapping each char to the next char with the same lowercase version.
1033 This mapping is a no-op only for characters that don't have case. */
1034#define UPCASE_TABLE XSTRING (current_buffer->upcase_table)->data
1035
1036extern Lisp_Object Vascii_downcase_table, Vascii_upcase_table;
a21cfa11 1037extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
3cfe6dfd
JB
1038\f
1039/* number of bytes of structure consed since last GC */
1040
1041extern int consing_since_gc;
1042
1043/* threshold for doing another gc */
1044
1045extern int gc_cons_threshold;
1046
1047/* Structure for recording stack slots that need marking */
1048
1049/* This is a chain of structures, each of which points at a Lisp_Object variable
1050 whose value should be marked in garbage collection.
1051 Normally every link of the chain is an automatic variable of a function,
1052 and its `val' points to some argument or local variable of the function.
1053 On exit to the function, the chain is set back to the value it had on entry.
e5f55f07
BF
1054 This way, no link remains in the chain when the stack frame containing the
1055 link disappears.
3cfe6dfd
JB
1056
1057 Every function that can call Feval must protect in this fashion all
1058 Lisp_Object variables whose contents will be used again. */
1059
1060extern struct gcpro *gcprolist;
1061
1062struct gcpro
1063 {
1064 struct gcpro *next;
1065 Lisp_Object *var; /* Address of first protected variable */
1066 int nvars; /* Number of consecutive protected variables */
1067 };
1068
1069#define GCPRO1(varname) \
1070 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
1071 gcprolist = &gcpro1; }
1072
1073#define GCPRO2(varname1, varname2) \
1074 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1075 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1076 gcprolist = &gcpro2; }
1077
1078#define GCPRO3(varname1, varname2, varname3) \
1079 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1080 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1081 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1082 gcprolist = &gcpro3; }
1083
1084#define GCPRO4(varname1, varname2, varname3, varname4) \
1085 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1086 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1087 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1088 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1089 gcprolist = &gcpro4; }
1090
c47b8d02
RS
1091#define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
1092 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1093 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1094 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1095 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1096 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1097 gcprolist = &gcpro5; }
1098
3cfe6dfd
JB
1099/* Call staticpro (&var) to protect static variable `var'. */
1100
1101void staticpro();
1102
1103#define UNGCPRO (gcprolist = gcpro1.next)
1104
5db82c9d 1105/* Evaluate expr, UNGCPRO, and then return the value of expr. */
c47b8d02 1106#define RETURN_UNGCPRO(expr) \
f3ca341e 1107if (1) \
c47b8d02
RS
1108 { \
1109 Lisp_Object ret_ungc_val; \
1110 ret_ungc_val = (expr); \
1111 UNGCPRO; \
1112 return ret_ungc_val; \
1113 } \
f3ca341e 1114else
3cfe6dfd
JB
1115\f
1116/* Defined in data.c */
1117extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
1118extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
1119extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
1120extern Lisp_Object Qvoid_variable, Qvoid_function;
1121extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
1122extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
1123extern Lisp_Object Qend_of_file, Qarith_error;
1124extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
83125cd7 1125extern Lisp_Object Qmark_inactive;
3cfe6dfd 1126
59b4254d
JB
1127extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
1128extern Lisp_Object Qoverflow_error, Qunderflow_error;
623ed1b0 1129
07a97bf8
RS
1130extern Lisp_Object Qintegerp, Qnumberp, Qnatnump, Qwholenump;
1131extern Lisp_Object Qsymbolp, Qlistp, Qconsp;
3cfe6dfd
JB
1132extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
1133extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qvectorp;
4de86b16
RS
1134extern Lisp_Object Qinteger_or_marker_p, Qnumber_or_marker_p;
1135extern Lisp_Object Qboundp, Qfboundp;
cde20f41 1136extern Lisp_Object Qbuffer_or_string_p;
3cfe6dfd
JB
1137extern Lisp_Object Qcdr;
1138
1139#ifdef LISP_FLOAT_TYPE
1140extern Lisp_Object Qfloatp, Qinteger_or_floatp, Qinteger_or_float_or_marker_p;
1141#endif /* LISP_FLOAT_TYPE */
1142
ff11dfa1 1143extern Lisp_Object Qframep;
3cfe6dfd
JB
1144
1145extern Lisp_Object Feq (), Fnull (), Flistp (), Fconsp (), Fatom (), Fnlistp ();
1146extern Lisp_Object Fintegerp (), Fnatnump (), Fsymbolp ();
1147extern Lisp_Object Fvectorp (), Fstringp (), Farrayp (), Fsequencep ();
1148extern Lisp_Object Fbufferp (), Fmarkerp (), Fsubrp (), Fchar_or_string_p ();
1149extern Lisp_Object Finteger_or_marker_p ();
1150#ifdef LISP_FLOAT_TYPE
1151extern Lisp_Object Ffloatp(), Finteger_or_floatp();
1152extern Lisp_Object Finteger_or_float_or_marker_p(), Ftruncate();
1153#endif /* LISP_FLOAT_TYPE */
1154
1155extern Lisp_Object Fcar (), Fcar_safe(), Fcdr (), Fcdr_safe();
1156extern Lisp_Object Fsetcar (), Fsetcdr ();
1157extern Lisp_Object Fboundp (), Ffboundp (), Fmakunbound (), Ffmakunbound ();
1158extern Lisp_Object Fsymbol_function (), Fsymbol_plist (), Fsymbol_name ();
ffd56f97 1159extern Lisp_Object indirect_function (), Findirect_function ();
3cfe6dfd 1160extern Lisp_Object Ffset (), Fsetplist ();
760cbdd3 1161extern Lisp_Object Fsymbol_value (), find_symbol_value (), Fset ();
d20c2151 1162extern Lisp_Object Fdefault_value (), Fset_default (), Fdefault_boundp ();
3cfe6dfd
JB
1163
1164extern Lisp_Object Faref (), Faset (), Farray_length ();
1165
f2980264 1166extern Lisp_Object Fstring_to_number (), Fnumber_to_string ();
c6cd5420
JB
1167extern Lisp_Object Feqlsign (), Fgtr (), Flss (), Fgeq (), Fleq ();
1168extern Lisp_Object Fneq (), Fzerop ();
1169extern Lisp_Object Fplus (), Fminus (), Ftimes (), Fquo (), Frem ();
1170extern Lisp_Object Fmax (), Fmin ();
1171extern Lisp_Object Flogand (), Flogior (), Flogxor (), Flognot ();
1172extern Lisp_Object Flsh (), Fash ();
1173
3cfe6dfd
JB
1174extern Lisp_Object Fadd1 (), Fsub1 ();
1175
1176extern Lisp_Object make_number ();
51cf3e31
JB
1177extern Lisp_Object long_to_cons ();
1178extern unsigned long cons_to_long ();
3cfe6dfd
JB
1179extern void args_out_of_range ();
1180extern void args_out_of_range_3 ();
1181extern Lisp_Object wrong_type_argument ();
1182#ifdef LISP_FLOAT_TYPE
1183extern Lisp_Object Ffloat_to_int(), Fint_to_float();
1184extern double extract_float();
d20c2151
JB
1185extern Lisp_Object make_float ();
1186extern Lisp_Object Ffloat ();
3cfe6dfd
JB
1187#endif /* LISP_FLOAT_TYPE */
1188
1189/* Defined in fns.c */
1190extern Lisp_Object Qstring_lessp;
1191extern Lisp_Object Vfeatures;
1192extern Lisp_Object Fidentity (), Frandom ();
1193extern Lisp_Object Flength ();
1194extern Lisp_Object Fappend (), Fconcat (), Fvconcat (), Fcopy_sequence ();
1195extern Lisp_Object Fsubstring ();
d20c2151 1196extern Lisp_Object Fnth (), Fnthcdr (), Fmemq (), Fassq (), Fassoc ();
adff7f18 1197extern Lisp_Object Fmember (), Frassq (), Fdelq (), Fsort ();
3cfe6dfd
JB
1198extern Lisp_Object Freverse (), Fnreverse (), Fget (), Fput (), Fequal ();
1199extern Lisp_Object Ffillarray (), Fnconc (), Fmapcar (), Fmapconcat ();
1200extern Lisp_Object Fy_or_n_p (), do_yes_or_no_p ();
1201extern Lisp_Object Ffeaturep (), Frequire () , Fprovide ();
1202extern Lisp_Object concat2 (), nconc2 ();
1203extern Lisp_Object assq_no_quit ();
d20c2151 1204extern Lisp_Object Fcopy_alist ();
3cfe6dfd
JB
1205
1206/* Defined in alloc.c */
1207extern Lisp_Object Vpurify_flag;
1208extern Lisp_Object Fcons (), Flist(), Fmake_list ();
1209extern Lisp_Object Fmake_vector (), Fvector (), Fmake_symbol (), Fmake_marker ();
1210extern Lisp_Object Fmake_string (), build_string (), make_string ();
88dbfee5 1211extern Lisp_Object make_event_array (), make_uninit_string ();
3cfe6dfd
JB
1212extern Lisp_Object Fpurecopy (), make_pure_string ();
1213extern Lisp_Object pure_cons (), make_pure_vector ();
1214extern Lisp_Object Fgarbage_collect ();
d20c2151 1215extern Lisp_Object Fmake_byte_code ();
4d57802e 1216extern int gc_in_progress;
3cfe6dfd
JB
1217
1218/* Defined in print.c */
1219extern Lisp_Object Vprin1_to_string_buffer;
1220extern Lisp_Object Fprin1 (), Fprin1_to_string (), Fprinc ();
1221extern Lisp_Object Fterpri (), Fprint ();
1222extern Lisp_Object Vstandard_output, Qstandard_output;
9453ea7b 1223extern Lisp_Object Qexternal_debugging_output;
3cfe6dfd
JB
1224extern void temp_output_buffer_setup (), temp_output_buffer_show ();
1225extern int print_level, print_escape_newlines;
1226extern Lisp_Object Qprint_escape_newlines;
1227
1228/* Defined in lread.c */
1229extern Lisp_Object Qvariable_documentation, Qstandard_input;
1230extern Lisp_Object Vobarray, Vstandard_input;
1231extern Lisp_Object Fread (), Fread_from_string ();
1232extern Lisp_Object Fintern (), Fintern_soft (), Fload ();
1233extern Lisp_Object Fget_file_char (), Fread_char ();
59b4254d 1234extern Lisp_Object read_filtered_event ();
3cfe6dfd
JB
1235extern Lisp_Object Feval_current_buffer (), Feval_region ();
1236extern Lisp_Object intern (), oblookup ();
c5e3de70
RS
1237#define LOADHIST_ATTACH(x) \
1238 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
1239extern Lisp_Object Vcurrent_load_list;
1240extern Lisp_Object Vload_history;
3cfe6dfd
JB
1241
1242/* Defined in eval.c */
1243extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
ad236261 1244extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
3cfe6dfd
JB
1245extern Lisp_Object Vmocklisp_arguments, Qmocklisp, Qmocklisp_arguments;
1246extern Lisp_Object Vautoload_queue;
973e8873 1247extern Lisp_Object Vdebug_on_error;
846d69ac
RS
1248/* To run a normal hook, do
1249 if (!NILP (Vrun_hooks))
1250 call1 (Vrun_hooks, Qmy_funny_hook); */
3cfe6dfd
JB
1251extern Lisp_Object Vrun_hooks;
1252extern Lisp_Object Fand (), For (), Fif (), Fprogn (), Fprog1 (), Fprog2 ();
1253extern Lisp_Object Fsetq (), Fquote ();
1254extern Lisp_Object Fuser_variable_p (), Finteractive_p ();
1255extern Lisp_Object Fdefun (), Flet (), FletX (), Fwhile ();
1256extern Lisp_Object Fcatch (), Fthrow (), Funwind_protect ();
1257extern Lisp_Object Fcondition_case (), Fsignal ();
1258extern Lisp_Object Ffunction_type (), Fautoload (), Fcommandp ();
1259extern Lisp_Object Feval (), Fapply (), Ffuncall ();
1260extern Lisp_Object Fglobal_set (), Fglobal_value (), Fbacktrace ();
1261extern Lisp_Object apply1 (), call0 (), call1 (), call2 (), call3 ();
023c80d0
KH
1262extern Lisp_Object call4 (), call5 (), call6 ();
1263extern Lisp_Object Fkill_emacs (), Fkey_binding (), Fsit_for ();
1264extern Lisp_Object Fdo_auto_save (), Fset_marker ();
3cfe6dfd
JB
1265extern Lisp_Object apply_lambda ();
1266extern Lisp_Object internal_catch ();
1267extern Lisp_Object internal_condition_case ();
a9656089 1268extern Lisp_Object internal_condition_case_1 ();
3cfe6dfd
JB
1269extern Lisp_Object unbind_to ();
1270extern void error ();
1271extern Lisp_Object un_autoload ();
1272
1273/* Defined in editfns.c */
3cfe6dfd
JB
1274extern Lisp_Object Fgoto_char ();
1275extern Lisp_Object Fpoint_min_marker (), Fpoint_max_marker ();
1276extern Lisp_Object Fpoint_min (), Fpoint_max ();
1277extern Lisp_Object Fpoint (), Fpoint_marker (), Fmark_marker ();
760cbdd3
JB
1278extern Lisp_Object Ffollowing_char (), Fprevious_char (), Fchar_after ();
1279extern Lisp_Object Finsert ();
3cfe6dfd
JB
1280extern Lisp_Object Feolp (), Feobp (), Fbolp (), Fbobp ();
1281extern Lisp_Object Fformat (), format1 ();
ffd56f97
JB
1282extern Lisp_Object make_buffer_string (), Fbuffer_substring ();
1283extern Lisp_Object Fbuffer_string ();
3cfe6dfd
JB
1284extern Lisp_Object Fstring_equal (), Fstring_lessp (), Fbuffer_substring_lessp ();
1285extern Lisp_Object save_excursion_save (), save_restriction_save ();
1286extern Lisp_Object save_excursion_restore (), save_restriction_restore ();
1287extern Lisp_Object Fchar_to_string ();
1288
1289/* defined in buffer.c */
628300ba 1290extern Lisp_Object Vbuffer_alist, Vinhibit_read_only;
3cfe6dfd
JB
1291extern Lisp_Object Fget_buffer (), Fget_buffer_create (), Fset_buffer ();
1292extern Lisp_Object Fbarf_if_buffer_read_only ();
1293extern Lisp_Object Fcurrent_buffer (), Fswitch_to_buffer (), Fpop_to_buffer ();
1294extern Lisp_Object Fother_buffer ();
7cdedc3f 1295extern Lisp_Object Foverlay_get ();
20280af7 1296extern Lisp_Object Qoverlayp;
3cfe6dfd
JB
1297extern struct buffer *all_buffers;
1298
1299/* defined in marker.c */
1300
1301extern Lisp_Object Fmarker_position (), Fmarker_buffer ();
1302extern Lisp_Object Fcopy_marker ();
1303
1304/* Defined in fileio.c */
1305
1306extern Lisp_Object Qfile_error;
997bf68d 1307extern Lisp_Object Ffind_file_name_handler ();
3cfe6dfd
JB
1308extern Lisp_Object Ffile_name_as_directory ();
1309extern Lisp_Object Fexpand_file_name (), Ffile_name_nondirectory ();
1310extern Lisp_Object Fsubstitute_in_file_name ();
1311extern Lisp_Object Ffile_symlink_p ();
d20c2151
JB
1312extern Lisp_Object Fverify_visited_file_modtime ();
1313extern Lisp_Object Ffile_exists_p ();
1314extern Lisp_Object Fdirectory_file_name ();
1315extern Lisp_Object Ffile_name_directory ();
1316extern Lisp_Object expand_and_dir_to_file ();
1317extern Lisp_Object Ffile_accessible_directory_p ();
3cfe6dfd
JB
1318
1319/* Defined in abbrev.c */
1320
1321extern Lisp_Object Vfundamental_mode_abbrev_table;
1322
1323/* defined in search.c */
1324extern Lisp_Object Fstring_match ();
1325extern Lisp_Object Fscan_buffer ();
1326
1327/* defined in minibuf.c */
1328
1329extern Lisp_Object last_minibuf_string;
1330extern Lisp_Object read_minibuf (), Fcompleting_read ();
1331extern Lisp_Object Fread_from_minibuffer ();
1332extern Lisp_Object Fread_variable (), Fread_buffer (), Fread_key_sequence ();
1333extern Lisp_Object Fread_minibuffer (), Feval_minibuffer ();
1334extern Lisp_Object Fread_string (), Fread_file_name ();
1335extern Lisp_Object Fread_no_blanks_input ();
1336
1337/* Defined in callint.c */
1338
7beb53fb 1339extern Lisp_Object Vprefix_arg, Qminus, Qplus, Vcurrent_prefix_arg;
3cfe6dfd
JB
1340extern Lisp_Object Vcommand_history;
1341extern Lisp_Object Qcall_interactively;
1342extern Lisp_Object Fcall_interactively ();
1343extern Lisp_Object Fprefix_numeric_value ();
1344
1345/* defined in casefiddle.c */
1346
1347extern Lisp_Object Fdowncase (), Fupcase (), Fcapitalize ();
1348
1349/* defined in keyboard.c */
1350
1351extern Lisp_Object Qdisabled;
1352extern Lisp_Object Vhelp_form, Vtop_level;
1353extern Lisp_Object Fdiscard_input (), Frecursive_edit ();
1354extern Lisp_Object Fcommand_execute (), Finput_pending_p ();
f498e3b2 1355extern Lisp_Object Qvertical_scroll_bar;
3cfe6dfd
JB
1356
1357/* defined in keymap.c */
1358
c451d7b1 1359extern Lisp_Object Qkeymap, Qmenu_bar;
3cfe6dfd
JB
1360extern Lisp_Object current_global_map;
1361extern Lisp_Object Fkey_description (), Fsingle_key_description ();
1362extern Lisp_Object Fwhere_is_internal ();
1363extern Lisp_Object access_keymap (), store_in_keymap ();
1364extern Lisp_Object get_keyelt (), get_keymap();
1365
1366/* defined in indent.c */
1367extern Lisp_Object Fvertical_motion (), Findent_to (), Fcurrent_column ();
1368
1369/* defined in window.c */
afd0d237 1370extern Lisp_Object Qwindowp, Qwindow_live_p;
3cfe6dfd
JB
1371extern Lisp_Object Fget_buffer_window ();
1372extern Lisp_Object Fsave_window_excursion ();
1373extern Lisp_Object Fset_window_configuration (), Fcurrent_window_configuration ();
9453ea7b
JB
1374extern Lisp_Object Fcoordinates_in_window_p ();
1375extern Lisp_Object Fwindow_at ();
02213e82 1376extern int window_internal_height (), window_internal_width ();
3cfe6dfd 1377
ff11dfa1 1378/* defined in frame.c */
362fb47a 1379extern Lisp_Object Qvisible;
ff11dfa1
JB
1380extern Lisp_Object Fframep ();
1381extern Lisp_Object Fselect_frame ();
1382extern Lisp_Object Ffocus_frame ();
1383extern Lisp_Object Funfocus_frame ();
1384extern Lisp_Object Fselected_frame ();
1385extern Lisp_Object Fwindow_frame ();
1386extern Lisp_Object Fframe_root_window ();
1387extern Lisp_Object Fframe_selected_window ();
1388extern Lisp_Object Fframe_list ();
1389extern Lisp_Object Fnext_frame ();
1390extern Lisp_Object Fdelete_frame ();
3cfe6dfd
JB
1391extern Lisp_Object Fread_mouse_position ();
1392extern Lisp_Object Fset_mouse_position ();
ff11dfa1
JB
1393extern Lisp_Object Fmake_frame_visible ();
1394extern Lisp_Object Fmake_frame_invisible ();
1395extern Lisp_Object Ficonify_frame ();
1396extern Lisp_Object Fdeiconify_frame ();
1397extern Lisp_Object Fframe_visible_p ();
1398extern Lisp_Object Fvisible_frame_list ();
1399extern Lisp_Object Fframe_parameters ();
1400extern Lisp_Object Fmodify_frame_parameters ();
1401extern Lisp_Object Fframe_pixel_size ();
1402extern Lisp_Object Fframe_height ();
1403extern Lisp_Object Fframe_width ();
1404extern Lisp_Object Fset_frame_height ();
1405extern Lisp_Object Fset_frame_width ();
1406extern Lisp_Object Fset_frame_size ();
1407extern Lisp_Object Fset_frame_position ();
3cfe6dfd
JB
1408#ifndef HAVE_X11
1409extern Lisp_Object Frubber_band_rectangle ();
1410#endif /* HAVE_X11 */
1411
1412/* defined in emacs.c */
1413extern Lisp_Object decode_env_path ();
3530d534 1414extern Lisp_Object Vinvocation_name, Vinvocation_directory;
e6faba7f 1415extern Lisp_Object Vinstallation_directory;
d0068e25 1416void shut_down_emacs ( /* int signal, int no_x, Lisp_Object stuff */ );
3cfe6dfd
JB
1417/* Nonzero means don't do interactive redisplay and don't change tty modes */
1418extern int noninteractive;
1419/* Nonzero means don't do use window-system-specific display code */
1420extern int inhibit_window_system;
1421
1422/* defined in process.c */
1423extern Lisp_Object Fget_process (), Fget_buffer_process (), Fprocessp ();
1424extern Lisp_Object Fprocess_status (), Fkill_process ();
7cdedc3f 1425extern Lisp_Object Fprocess_send_eof ();
3cfe6dfd
JB
1426
1427/* defined in callproc.c */
9453ea7b 1428extern Lisp_Object Vexec_path, Vexec_directory, Vdata_directory;
c65be0e1 1429extern Lisp_Object Vdoc_directory;
3cfe6dfd 1430
3cfe6dfd
JB
1431/* defined in doc.c */
1432extern Lisp_Object Vdoc_file_name;
1433extern Lisp_Object Fsubstitute_command_keys ();
1434extern Lisp_Object Fdocumentation (), Fdocumentation_property ();
1435
1436/* defined in bytecode.c */
1437extern Lisp_Object Qbytecode;
d20c2151 1438extern Lisp_Object Fbyte_code ();
3cfe6dfd
JB
1439
1440/* defined in macros.c */
1441extern Lisp_Object Qexecute_kbd_macro;
1442extern Lisp_Object Fexecute_kbd_macro ();
1443
d20c2151
JB
1444/* defined in undo.c */
1445extern Lisp_Object Fundo_boundary ();
1446extern Lisp_Object truncate_undo_list ();
1447
8537f1cb 1448/* defined in textprop.c */
c2d8811c
RS
1449extern Lisp_Object Qmodification_hooks;
1450extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
55253957
RS
1451extern Lisp_Object Fnext_property_change ();
1452extern Lisp_Object Fnext_single_property_change ();
8537f1cb 1453
3cfe6dfd
JB
1454/* Nonzero means Emacs has already been initialized.
1455 Used during startup to detect startup of dumped Emacs. */
1456extern int initialized;
1457
1458extern int immediate_quit; /* Nonzero means ^G can quit instantly */
1459
1460extern void debugger ();
1461
339747e4 1462extern char *getenv (), *ctime (), *getwd ();
3cfe6dfd 1463extern long *xmalloc (), *xrealloc ();
9ac0d9e0 1464extern void xfree ();
3cfe6dfd 1465
efb859b4 1466extern char *egetenv ();
c5e3de70 1467
5d6be39f
KH
1468/* Set up the name of the machine we're running on. */
1469extern void init_system_name ();