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