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