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