*** empty log message ***
[bpt/emacs.git] / src / lisp.h
1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1987, 1992 Free Software Foundation, Inc.
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
8 the Free Software Foundation; either version 2, or (at your option)
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
89 /* Pointer to a vector-like object describing a display screen
90 on which Emacs can display a window hierarchy. */
91 Lisp_Screen,
92
93 /* Used when a FILE * value needs to be passed
94 in an argument of type Lisp_Object.
95 You must do *(FILE **) XPNTR(obj) to get the value.
96 The user will never see this data type. */
97 Lisp_Internal_Stream,
98
99 /* Used in a symbol value cell when the symbol's value is per-buffer.
100 The actual contents are a cons cell which starts a list like this:
101 (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).
102
103 BUFFER is the last buffer for which this symbol's value was
104 made up to date.
105
106 CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
107 local_var_alist, that being the element whose car is this
108 variable. Or it can be a pointer to the
109 (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE),
110 if BUFFER does not have an element in its alist for this
111 variable (that is, if BUFFER sees the default value of this
112 variable).
113
114 If we want to examine or set the value and BUFFER is current,
115 we just examine or set REALVALUE. If BUFFER is not current, we
116 store the current REALVALUE value into CURRENT-ALIST-ELEMENT,
117 then find the appropriate alist element for the buffer now
118 current and set up CURRENT-ALIST-ELEMENT. Then we set
119 REALVALUE out of that element, and store into BUFFER.
120
121 If we are setting the variable and the current buffer does not
122 have an alist entry for this variable, an alist entry is
123 created.
124
125 Note that REALVALUE can be a forwarding pointer. Each time it
126 is examined or set, forwarding must be done. */
127 Lisp_Buffer_Local_Value,
128
129 /* Like Lisp_Buffer_Local_Value with one difference:
130 merely setting the variable while some buffer is current
131 does not cause that buffer to have its own local value of this variable.
132 Only make-local-variable does that. */
133 Lisp_Some_Buffer_Local_Value,
134
135
136 /* Like Lisp_Objfwd except that value lives in a slot
137 in the current buffer. Value is byte index of slot within buffer */
138 Lisp_Buffer_Objfwd,
139
140 /* In symbol value cell, means var is unbound.
141 In symbol function cell, means function name is undefined. */
142 Lisp_Void,
143
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 */
149 Lisp_Window_Configuration
150
151 #ifdef LISP_FLOAT_TYPE
152 ,
153 Lisp_Float
154 #endif /* LISP_FLOAT_TYPE */
155 };
156
157 #ifndef NO_UNION_TYPE
158
159 #ifndef BIG_ENDIAN
160
161 /* Definition of Lisp_Object for little-endian machines. */
162
163 typedef
164 union Lisp_Object
165 {
166 /* Used for comparing two Lisp_Objects;
167 also, positive integers can be accessed fast this way. */
168 int i;
169
170 struct
171 {
172 int val: 24;
173 char type;
174 } s;
175 struct
176 {
177 unsigned int val: 24;
178 char type;
179 } u;
180 struct
181 {
182 unsigned int val: 24;
183 enum Lisp_Type type: 7;
184 /* The markbit is not really part of the value of a Lisp_Object,
185 and is always zero except during garbage collection. */
186 unsigned int markbit: 1;
187 } gu;
188 }
189 Lisp_Object;
190
191 #else /* If BIG_ENDIAN */
192
193 typedef
194 union Lisp_Object
195 {
196 /* Used for comparing two Lisp_Objects;
197 also, positive integers can be accessed fast this way. */
198 int i;
199
200 struct
201 {
202 char type;
203 int val: 24;
204 } s;
205 struct
206 {
207 char type;
208 unsigned int val: 24;
209 } u;
210 struct
211 {
212 /* The markbit is not really part of the value of a Lisp_Object,
213 and is always zero except during garbage collection. */
214 unsigned int markbit: 1;
215 enum Lisp_Type type: 7;
216 unsigned int val: 24;
217 } gu;
218 }
219 Lisp_Object;
220
221 #endif /* BIG_ENDIAN */
222
223 #endif /* NO_UNION_TYPE */
224
225
226 /* If union type is not wanted, define Lisp_Object as just a number
227 and define the macros below to extract fields by shifting */
228
229 #ifdef NO_UNION_TYPE
230
231 #define Lisp_Object int
232
233 /* These values are overridden by the m- file on some machines. */
234 #ifndef VALBITS
235 #define VALBITS 24
236 #endif
237
238 #ifndef GCTYPEBITS
239 #define GCTYPEBITS 7
240 #endif
241
242 #ifndef VALMASK
243 #define VALMASK ((1<<VALBITS) - 1)
244 #endif
245 #define GCTYPEMASK ((1<<GCTYPEBITS) - 1)
246 #define MARKBIT (1 << (VALBITS + GCTYPEBITS))
247
248 #endif /* NO_UNION_TYPE */
249 \f
250 /* These macros extract various sorts of values from a Lisp_Object.
251 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
252 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
253
254 #ifdef NO_UNION_TYPE
255
256 /* One need to override this if there must be high bits set in data space
257 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
258 on all machines, but would penalise machines which don't need it)
259 */
260 #ifndef XTYPE
261 #define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
262 #endif
263
264 #ifndef XSETTYPE
265 #define XSETTYPE(a, b) ((a) = XUINT (a) | ((int)(b) << VALBITS))
266 #endif
267
268 /* Use XFASTINT for fast retrieval and storage of integers known
269 to be positive. This takes advantage of the fact that Lisp_Int is 0. */
270 #define XFASTINT(a) (a)
271
272 /* Extract the value of a Lisp_Object as a signed integer. */
273
274 #ifndef XINT /* Some machines need to do this differently. */
275 #define XINT(a) (((a) << (INTBITS-VALBITS)) >> (INTBITS-VALBITS))
276 #endif
277
278 /* Extract the value as an unsigned integer. This is a basis
279 for extracting it as a pointer to a structure in storage. */
280
281 #ifndef XUINT
282 #define XUINT(a) ((a) & VALMASK)
283 #endif
284
285 #ifndef XPNTR
286 #ifdef HAVE_SHM
287 /* In this representation, data is found in two widely separated segments. */
288 extern int pure_size;
289 #define XPNTR(a) \
290 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
291 #else /* not HAVE_SHM */
292 #ifdef DATA_SEG_BITS
293 /* This case is used for the rt-pc.
294 In the diffs I was given, it checked for ptr = 0
295 and did not adjust it in that case.
296 But I don't think that zero should ever be found
297 in a Lisp object whose data type says it points to something. */
298 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
299 #else
300 #define XPNTR(a) XUINT (a)
301 #endif
302 #endif /* not HAVE_SHM */
303 #endif /* no XPNTR */
304
305 #ifndef XSETINT
306 #define XSETINT(a, b) ((a) = ((a) & ~VALMASK) | ((b) & VALMASK))
307 #endif
308
309 #ifndef XSETUINT
310 #define XSETUINT(a, b) XSETINT (a, b)
311 #endif
312
313 #ifndef XSETPNTR
314 #define XSETPNTR(a, b) XSETINT (a, b)
315 #endif
316
317 #ifndef XSET
318 #define XSET(var, type, ptr) \
319 ((var) = ((int)(type) << VALBITS) + ((int) (ptr) & VALMASK))
320 #endif
321
322 /* During garbage collection, XGCTYPE must be used for extracting types
323 so that the mark bit is ignored. XMARKBIT accesses the markbit.
324 Markbits are used only in particular slots of particular structure types.
325 Other markbits are always zero.
326 Outside of garbage collection, all mark bits are always zero. */
327
328 #ifndef XGCTYPE
329 #define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
330 #endif
331
332 #if VALBITS + GCTYPEBITS == INTBITS - 1
333 /* Make XMARKBIT faster if mark bit is sign bit. */
334 #ifndef XMARKBIT
335 #define XMARKBIT(a) ((a) < 0)
336 #endif
337 #endif /* markbit is sign bit */
338
339 #ifndef XMARKBIT
340 #define XMARKBIT(a) ((a) & MARKBIT)
341 #endif
342
343 #ifndef XSETMARKBIT
344 #define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
345 #endif
346
347 #ifndef XMARK
348 #define XMARK(a) ((a) |= MARKBIT)
349 #endif
350
351 #ifndef XUNMARK
352 #define XUNMARK(a) ((a) &= ~MARKBIT)
353 #endif
354
355 #endif /* NO_UNION_TYPE */
356
357 #ifndef NO_UNION_TYPE
358
359 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
360 #define XSETTYPE(a, b) ((a).u.type = (char) (b))
361
362 /* Use XFASTINT for fast retrieval and storage of integers known
363 to be positive. This takes advantage of the fact that Lisp_Int is 0. */
364 #define XFASTINT(a) ((a).i)
365
366 #ifdef EXPLICIT_SIGN_EXTEND
367 /* Make sure we sign-extend; compilers have been known to fail to do so. */
368 #define XINT(a) (((a).i << 8) >> 8)
369 #else
370 #define XINT(a) ((a).s.val)
371 #endif /* EXPLICIT_SIGN_EXTEND */
372
373 #define XUINT(a) ((a).u.val)
374 #define XPNTR(a) ((a).u.val)
375 #define XSETINT(a, b) ((a).s.val = (int) (b))
376 #define XSETUINT(a, b) ((a).s.val = (int) (b))
377 #define XSETPNTR(a, b) ((a).s.val = (int) (b))
378
379 #define XSET(var, vartype, ptr) \
380 (((var).s.type = ((char) (vartype))), ((var).s.val = ((int) (ptr))))
381
382 /* During garbage collection, XGCTYPE must be used for extracting types
383 so that the mark bit is ignored. XMARKBIT access the markbit.
384 Markbits are used only in particular slots of particular structure types.
385 Other markbits are always zero.
386 Outside of garbage collection, all mark bits are always zero. */
387
388 #define XGCTYPE(a) ((a).gu.type)
389 #define XMARKBIT(a) ((a).gu.markbit)
390 #define XSETMARKBIT(a,b) (XMARKBIT(a) = (b))
391 #define XMARK(a) (XMARKBIT(a) = 1)
392 #define XUNMARK(a) (XMARKBIT(a) = 0)
393
394 #endif /* NO_UNION_TYPE */
395
396
397 #define XCONS(a) ((struct Lisp_Cons *) XPNTR(a))
398 #define XBUFFER(a) ((struct buffer *) XPNTR(a))
399 #define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
400 #define XSUBR(a) ((struct Lisp_Subr *) XPNTR(a))
401 #define XSTRING(a) ((struct Lisp_String *) XPNTR(a))
402 #define XSYMBOL(a) ((struct Lisp_Symbol *) XPNTR(a))
403 #define XFUNCTION(a) ((Lisp_Object (*)()) XPNTR(a))
404 #define XMARKER(a) ((struct Lisp_Marker *) XPNTR(a))
405 #define XOBJFWD(a) ((Lisp_Object *) XPNTR(a))
406 #define XINTPTR(a) ((int *) XPNTR(a))
407 #define XWINDOW(a) ((struct window *) XPNTR(a))
408 #define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
409 #define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
410
411 #define XSETCONS(a, b) XSETPNTR(a, (int) (b))
412 #define XSETBUFFER(a, b) XSETPNTR(a, (int) (b))
413 #define XSETVECTOR(a, b) XSETPNTR(a, (int) (b))
414 #define XSETSUBR(a, b) XSETPNTR(a, (int) (b))
415 #define XSETSTRING(a, b) XSETPNTR(a, (int) (b))
416 #define XSETSYMBOL(a, b) XSETPNTR(a, (int) (b))
417 #define XSETFUNCTION(a, b) XSETPNTR(a, (int) (b))
418 #define XSETMARKER(a, b) XSETPNTR(a, (int) (b))
419 #define XSETOBJFWD(a, b) XSETPNTR(a, (int) (b))
420 #define XSETINTPTR(a, b) XSETPNTR(a, (int) (b))
421 #define XSETWINDOW(a, b) XSETPNTR(a, (int) (b))
422 #define XSETPROCESS(a, b) XSETPNTR(a, (int) (b))
423 #define XSETFLOAT(a, b) XSETPNTR(a, (int) (b))
424 \f
425 /* In a cons, the markbit of the car is the gc mark bit */
426
427 struct Lisp_Cons
428 {
429 Lisp_Object car, cdr;
430 };
431
432 /* Like a cons, but records info on where the text lives that it was read from */
433 /* This is not really in use now */
434
435 struct Lisp_Buffer_Cons
436 {
437 Lisp_Object car, cdr;
438 struct buffer *buffer;
439 int bufpos;
440 };
441
442 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
443
444 struct Lisp_String
445 {
446 int size;
447 unsigned char data[1];
448 };
449
450 struct Lisp_Vector
451 {
452 int size;
453 struct Lisp_Vector *next;
454 Lisp_Object contents[1];
455 };
456
457 /* In a symbol, the markbit of the plist is used as the gc mark bit */
458
459 struct Lisp_Symbol
460 {
461 struct Lisp_String *name;
462 Lisp_Object value;
463 Lisp_Object function;
464 Lisp_Object plist;
465 struct Lisp_Symbol *next; /* -> next symbol in this obarray bucket */
466 };
467
468 struct Lisp_Subr
469 {
470 Lisp_Object (*function) ();
471 short min_args, max_args;
472 char *symbol_name;
473 char *prompt;
474 char *doc;
475 };
476
477 /* In a marker, the markbit of the chain field is used as the gc mark bit */
478
479 struct Lisp_Marker
480 {
481 struct buffer *buffer;
482 Lisp_Object chain;
483 int bufpos;
484 int modified;
485 };
486
487 #ifdef LISP_FLOAT_TYPE
488 /* Optional Lisp floating point type */
489 struct Lisp_Float
490 {
491 Lisp_Object type; /* essentially used for mark-bit
492 and chaining when on free-list */
493 double data;
494 };
495 #endif /* LISP_FLOAT_TYPE */
496
497 /* A character, declared with the following typedef, is a member
498 of some character set associated with the current buffer. */
499 typedef unsigned char UCHAR;
500
501 /* Meanings of slots in a Lisp_Compiled: */
502
503 #define COMPILED_ARGLIST 0
504 #define COMPILED_BYTECODE 1
505 #define COMPILED_CONSTANTS 2
506 #define COMPILED_STACK_DEPTH 3
507 #define COMPILED_DOC_STRING 4
508 #define COMPILED_INTERACTIVE 5
509 \f
510 /* Data type checking */
511
512 #define NILP(x) (XFASTINT (x) == XFASTINT (Qnil))
513
514 #ifdef LISP_FLOAT_TYPE
515 #define NUMBERP(x) (XTYPE (x) == Lisp_Int || XTYPE (x) == Lisp_Float)
516 #else
517 #define NUMBERP(x) (XTYPE (x) == Lisp_Int)
518 #endif
519
520 /* #define LISTP(x) (XTYPE ((x)) == Lisp_Cons)*/
521 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
522 #define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
523
524
525 #define CHECK_LIST(x, i) \
526 { if ((XTYPE ((x)) != Lisp_Cons) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); }
527
528 #define CHECK_STRING(x, i) \
529 { if (XTYPE ((x)) != Lisp_String) x = wrong_type_argument (Qstringp, (x)); }
530
531 #define CHECK_CONS(x, i) \
532 { if (XTYPE ((x)) != Lisp_Cons) x = wrong_type_argument (Qconsp, (x)); }
533
534 #define CHECK_SYMBOL(x, i) \
535 { if (XTYPE ((x)) != Lisp_Symbol) x = wrong_type_argument (Qsymbolp, (x)); }
536
537 #define CHECK_VECTOR(x, i) \
538 { if (XTYPE ((x)) != Lisp_Vector) x = wrong_type_argument (Qvectorp, (x)); }
539
540 #define CHECK_BUFFER(x, i) \
541 { if (XTYPE ((x)) != Lisp_Buffer) x = wrong_type_argument (Qbufferp, (x)); }
542
543 #define CHECK_WINDOW(x, i) \
544 { if (XTYPE ((x)) != Lisp_Window) x = wrong_type_argument (Qwindowp, (x)); }
545
546 #define CHECK_PROCESS(x, i) \
547 { if (XTYPE ((x)) != Lisp_Process) x = wrong_type_argument (Qprocessp, (x)); }
548
549 #define CHECK_NUMBER(x, i) \
550 { if (XTYPE ((x)) != Lisp_Int) x = wrong_type_argument (Qintegerp, (x)); }
551
552 #define CHECK_NATNUM(x, i) \
553 { if (XTYPE ((x)) != Lisp_Int || XINT ((x)) < 0) \
554 x = wrong_type_argument (Qnatnump, (x)); }
555
556 #define CHECK_MARKER(x, i) \
557 { if (XTYPE ((x)) != Lisp_Marker) x = wrong_type_argument (Qmarkerp, (x)); }
558
559 #define CHECK_NUMBER_COERCE_MARKER(x, i) \
560 { if (XTYPE ((x)) == Lisp_Marker) XFASTINT (x) = marker_position (x); \
561 else if (XTYPE ((x)) != Lisp_Int) x = wrong_type_argument (Qinteger_or_marker_p, (x)); }
562
563 #ifdef LISP_FLOAT_TYPE
564
565 #ifndef DBL_DIG
566 #define DBL_DIG 20
567 #endif
568
569 #define XFLOATINT(n) extract_float((n))
570
571 #define CHECK_FLOAT(x, i) \
572 { if (XTYPE (x) != Lisp_Float) \
573 x = wrong_type_argument (Qfloatp, (x)); }
574
575 #define CHECK_NUMBER_OR_FLOAT(x, i) \
576 { if (XTYPE (x) != Lisp_Float && XTYPE (x) != Lisp_Int) \
577 x = wrong_type_argument (Qnumberp, (x)); }
578
579 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
580 { if (XTYPE (x) == Lisp_Marker) XFASTINT (x) = marker_position (x); \
581 else if (XTYPE (x) != Lisp_Int && XTYPE (x) != Lisp_Float) \
582 x = wrong_type_argument (Qnumber_or_marker_p, (x)); }
583
584 #else /* Not LISP_FLOAT_TYPE */
585
586 #define CHECK_NUMBER_OR_FLOAT CHECK_NUMBER
587
588 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER CHECK_NUMBER_COERCE_MARKER
589
590 #define XFLOATINT(n) XINT((n))
591 #endif /* LISP_FLOAT_TYPE */
592
593 /* Cast pointers to this type to compare them. Some machines want int. */
594 #ifndef PNTR_COMPARISON_TYPE
595 #define PNTR_COMPARISON_TYPE unsigned int
596 #endif
597 \f
598 /* Define a built-in function for calling from Lisp.
599 `lname' should be the name to give the function in Lisp,
600 as a null-terminated C string.
601 `fnname' should be the name of the function in C.
602 By convention, it starts with F.
603 `sname' should be the name for the C constant structure
604 that records information on this function for internal use.
605 By convention, it should be the same as `fnname' but with S instead of F.
606 It's too bad that C macros can't compute this from `fnname'.
607 `minargs' should be a number, the minimum number of arguments allowed.
608 `maxargs' should be a number, the maximum number of arguments allowed,
609 or else MANY or UNEVALLED.
610 MANY means pass a vector of evaluated arguments,
611 in the form of an integer number-of-arguments
612 followed by the address of a vector of Lisp_Objects
613 which contains the argument values.
614 UNEVALLED means pass the list of unevaluated arguments
615 `prompt' says how to read arguments for an interactive call.
616 This can be zero or a C string.
617 Zero means that interactive calls are not allowed.
618 A string is interpreted in a hairy way:
619 it should contain one line for each argument to be read, terminated by \n.
620 The first character of the line controls the type of parsing:
621 s -- read a string.
622 S -- read a symbol.
623 k -- read a key sequence and return it as a string.
624 a -- read a function name (symbol) with completion.
625 C -- read a command name (symbol) with completion.
626 v -- read a variable name (symbol) with completion.
627 b -- read a buffer name (a string) with completion.
628 B -- buffer name, may be existing buffer or may not be.
629 f -- read a file name, file must exist.
630 F -- read a file name, file need not exist.
631 n -- read a number.
632 c -- read a character and return it as a number.
633 p -- use the numeric value of the prefix argument.
634 P -- use raw value of prefix - can be nil, -, (NUMBER) or NUMBER.
635 x -- read a Lisp object from the minibuffer.
636 X -- read a Lisp form from the minibuffer and use its value.
637 A null string means call interactively with no arguments.
638 `doc' is documentation for the user.
639 */
640
641 #define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
642 Lisp_Object fnname (); \
643 struct Lisp_Subr sname = {fnname, minargs, maxargs, lname, prompt, 0}; \
644 Lisp_Object fnname
645
646 /* defsubr (Sname);
647 is how we define the symbol for function `name' at start-up time. */
648 extern void defsubr ();
649
650 #define MANY -2
651 #define UNEVALLED -1
652
653 extern void defvar_lisp ();
654 extern void defvar_bool ();
655 extern void defvar_int ();
656
657 /* Macros we use to define forwarded Lisp variables.
658 These are used in the syms_of_FILENAME functions. */
659
660 #define DEFVARLISP(lname, vname, doc) defvar_lisp (lname, vname)
661 #define DEFVARBOOL(lname, vname, doc) defvar_bool (lname, vname)
662 #define DEFVARINT(lname, vname, doc) defvar_int (lname, vname)
663 #define DEFVARPERBUFFER(lname, vname, doc) \
664 defvar_per_buffer (lname, vname)
665
666 #define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
667 #define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
668 #define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
669 #define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
670 #define DEFVAR_PER_BUFFER(lname, vname, doc) \
671 defvar_per_buffer (lname, vname)
672 \f
673 /* Structure for recording Lisp call stack for backtrace purposes */
674
675 struct specbinding
676 {
677 Lisp_Object symbol, old_value;
678 Lisp_Object (*func) ();
679 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
680 };
681
682 extern struct specbinding *specpdl;
683 extern struct specbinding *specpdl_ptr;
684 extern int specpdl_size;
685
686 struct handler
687 {
688 Lisp_Object handler;
689 Lisp_Object var;
690 int poll_suppress_count; /* No error should exit a piece of code
691 in which polling is suppressed. */
692 struct catchtag *tag;
693 struct handler *next;
694 };
695
696 extern struct handler *handlerlist;
697
698 extern struct catchtag *catchlist;
699 extern struct backtrace *backtrace_list;
700
701 /* An address near the bottom of the stack.
702 Tells GC how to save a copy of the stack. */
703 extern char *stack_bottom;
704
705 /* Check quit-flag and quit if it is non-nil. */
706
707 #define QUIT \
708 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
709 { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }
710
711 /* Nonzero if ought to quit now. */
712
713 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
714 \f
715 /* 1 if CH is upper case. */
716
717 #define UPPERCASEP(CH) \
718 (XSTRING (current_buffer->downcase_table)->data[CH] != (CH))
719
720 /* 1 if CH is lower case. */
721
722 #define LOWERCASEP(CH) \
723 (!UPPERCASEP (CH) \
724 && XSTRING (current_buffer->upcase_table)->data[CH] != (CH))
725
726 /* 1 if CH is neither upper nor lower case. */
727
728 #define NOCASEP(CH) (XSTRING (current_buffer->upcase_table)->data[CH] == (CH))
729
730 /* Upcase a character, or make no change if that cannot be done. */
731
732 #define UPCASE(CH) \
733 (XSTRING (current_buffer->downcase_table)->data[CH] == (CH) \
734 ? UPCASE1 (CH) : (CH))
735
736 /* Upcase a character known to be not upper case. */
737
738 #define UPCASE1(CH) (XSTRING (current_buffer->upcase_table)->data[CH])
739
740 /* Downcase a character, or make no change if that cannot be done. */
741
742 #define DOWNCASE(CH) (XSTRING (current_buffer->downcase_table)->data[CH])
743
744 /* Current buffer's map from characters to lower-case characters. */
745
746 #define DOWNCASE_TABLE XSTRING (current_buffer->downcase_table)->data
747
748 /* Table mapping each char to the next char with the same lowercase version.
749 This mapping is a no-op only for characters that don't have case. */
750 #define UPCASE_TABLE XSTRING (current_buffer->upcase_table)->data
751
752 extern Lisp_Object Vascii_downcase_table, Vascii_upcase_table;
753 \f
754 /* number of bytes of structure consed since last GC */
755
756 extern int consing_since_gc;
757
758 /* threshold for doing another gc */
759
760 extern int gc_cons_threshold;
761
762 /* Structure for recording stack slots that need marking */
763
764 /* This is a chain of structures, each of which points at a Lisp_Object variable
765 whose value should be marked in garbage collection.
766 Normally every link of the chain is an automatic variable of a function,
767 and its `val' points to some argument or local variable of the function.
768 On exit to the function, the chain is set back to the value it had on entry.
769 This way, no link remains in the chain when the stack frame containing the link disappears.
770
771 Every function that can call Feval must protect in this fashion all
772 Lisp_Object variables whose contents will be used again. */
773
774 extern struct gcpro *gcprolist;
775
776 struct gcpro
777 {
778 struct gcpro *next;
779 Lisp_Object *var; /* Address of first protected variable */
780 int nvars; /* Number of consecutive protected variables */
781 };
782
783 #define GCPRO1(varname) \
784 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
785 gcprolist = &gcpro1; }
786
787 #define GCPRO2(varname1, varname2) \
788 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
789 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
790 gcprolist = &gcpro2; }
791
792 #define GCPRO3(varname1, varname2, varname3) \
793 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
794 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
795 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
796 gcprolist = &gcpro3; }
797
798 #define GCPRO4(varname1, varname2, varname3, varname4) \
799 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
800 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
801 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
802 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
803 gcprolist = &gcpro4; }
804
805 /* Call staticpro (&var) to protect static variable `var'. */
806
807 void staticpro();
808
809 #define UNGCPRO (gcprolist = gcpro1.next)
810
811 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
812 #define RETURN_UNGCPRO(expr) \
813 do \
814 { \
815 Lisp_Object ret_ungc_val; \
816 ret_ungc_val = (expr); \
817 UNGCPRO; \
818 return ret_ungc_val; \
819 } \
820 while (0)
821 \f
822 /* Defined in data.c */
823 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
824 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
825 extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
826 extern Lisp_Object Qvoid_variable, Qvoid_function;
827 extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
828 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
829 extern Lisp_Object Qend_of_file, Qarith_error;
830 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
831
832 extern Lisp_Object Qintegerp, Qnumberp, Qnatnump, Qsymbolp, Qlistp, Qconsp;
833 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
834 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qvectorp;
835 extern Lisp_Object Qinteger_or_marker_p, Qnumber_or_marker_p;
836 extern Lisp_Object Qboundp, Qfboundp;
837 extern Lisp_Object Qcdr;
838
839 #ifdef LISP_FLOAT_TYPE
840 extern Lisp_Object Qfloatp, Qinteger_or_floatp, Qinteger_or_float_or_marker_p;
841 #endif /* LISP_FLOAT_TYPE */
842
843 extern Lisp_Object Qscreenp;
844
845 extern Lisp_Object Feq (), Fnull (), Flistp (), Fconsp (), Fatom (), Fnlistp ();
846 extern Lisp_Object Fintegerp (), Fnatnump (), Fsymbolp ();
847 extern Lisp_Object Fvectorp (), Fstringp (), Farrayp (), Fsequencep ();
848 extern Lisp_Object Fbufferp (), Fmarkerp (), Fsubrp (), Fchar_or_string_p ();
849 extern Lisp_Object Finteger_or_marker_p ();
850 #ifdef LISP_FLOAT_TYPE
851 extern Lisp_Object Ffloatp(), Finteger_or_floatp();
852 extern Lisp_Object Finteger_or_float_or_marker_p(), Ftruncate();
853 #endif /* LISP_FLOAT_TYPE */
854
855 extern Lisp_Object Fcar (), Fcar_safe(), Fcdr (), Fcdr_safe();
856 extern Lisp_Object Fsetcar (), Fsetcdr ();
857 extern Lisp_Object Fboundp (), Ffboundp (), Fmakunbound (), Ffmakunbound ();
858 extern Lisp_Object Fsymbol_function (), Fsymbol_plist (), Fsymbol_name ();
859 extern Lisp_Object indirect_function (), Findirect_function ();
860 extern Lisp_Object Ffset (), Fsetplist ();
861 extern Lisp_Object Fsymbol_value (), find_symbol_value (), Fset ();
862 extern Lisp_Object Fdefault_value (), Fset_default ();
863
864 extern Lisp_Object Faref (), Faset (), Farray_length ();
865
866 extern Lisp_Object Fstring_to_int (), Fint_to_string ();
867 extern Lisp_Object Feqlsign (), Fgtr (), Flss (), Fgeq (), Fleq (), Fneq (), Fzerop ();
868 extern Lisp_Object Fplus (), Fminus (), Ftimes (), Fquo (), Frem (), Fmax (), Fmin ();
869 extern Lisp_Object Flogand (), Flogior (), Flogxor (), Flognot (), Flsh (), Fash ();
870 extern Lisp_Object Fadd1 (), Fsub1 ();
871
872 extern Lisp_Object make_number ();
873 extern void args_out_of_range ();
874 extern void args_out_of_range_3 ();
875 extern Lisp_Object wrong_type_argument ();
876 #ifdef LISP_FLOAT_TYPE
877 extern Lisp_Object Ffloat_to_int(), Fint_to_float();
878 extern double extract_float();
879 #endif /* LISP_FLOAT_TYPE */
880
881 /* Defined in fns.c */
882 extern Lisp_Object Qstring_lessp;
883 extern Lisp_Object Vfeatures;
884 extern Lisp_Object Fidentity (), Frandom ();
885 extern Lisp_Object Flength ();
886 extern Lisp_Object Fappend (), Fconcat (), Fvconcat (), Fcopy_sequence ();
887 extern Lisp_Object Fsubstring ();
888 extern Lisp_Object Fnthcdr (), Fmemq (), Fassq (), Fassoc ();
889 extern Lisp_Object Frassq (), Fdelq (), Fsort ();
890 extern Lisp_Object Freverse (), Fnreverse (), Fget (), Fput (), Fequal ();
891 extern Lisp_Object Ffillarray (), Fnconc (), Fmapcar (), Fmapconcat ();
892 extern Lisp_Object Fy_or_n_p (), do_yes_or_no_p ();
893 extern Lisp_Object Ffeaturep (), Frequire () , Fprovide ();
894 extern Lisp_Object concat2 (), nconc2 ();
895 extern Lisp_Object assq_no_quit ();
896
897 /* Defined in alloc.c */
898 extern Lisp_Object Vpurify_flag;
899 extern Lisp_Object Fcons (), Flist(), Fmake_list ();
900 extern Lisp_Object Fmake_vector (), Fvector (), Fmake_symbol (), Fmake_marker ();
901 extern Lisp_Object Fmake_string (), build_string (), make_string ();
902 extern Lisp_Object make_array (), make_uninit_string ();
903 extern Lisp_Object Fpurecopy (), make_pure_string ();
904 extern Lisp_Object pure_cons (), make_pure_vector ();
905 extern Lisp_Object Fgarbage_collect ();
906
907 /* Defined in print.c */
908 extern Lisp_Object Vprin1_to_string_buffer;
909 extern Lisp_Object Fprin1 (), Fprin1_to_string (), Fprinc ();
910 extern Lisp_Object Fterpri (), Fprint ();
911 extern Lisp_Object Vstandard_output, Qstandard_output;
912 extern Lisp_Object Qexternal_debugging_output;
913 extern void temp_output_buffer_setup (), temp_output_buffer_show ();
914 extern int print_level, print_escape_newlines;
915 extern Lisp_Object Qprint_escape_newlines;
916
917 /* Defined in lread.c */
918 extern Lisp_Object Qvariable_documentation, Qstandard_input;
919 extern Lisp_Object Vobarray, Vstandard_input;
920 extern Lisp_Object Fread (), Fread_from_string ();
921 extern Lisp_Object Fintern (), Fintern_soft (), Fload ();
922 extern Lisp_Object Fget_file_char (), Fread_char ();
923 extern Lisp_Object Feval_current_buffer (), Feval_region ();
924 extern Lisp_Object intern (), oblookup ();
925
926 /* Defined in eval.c */
927 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
928 extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
929 extern Lisp_Object Vmocklisp_arguments, Qmocklisp, Qmocklisp_arguments;
930 extern Lisp_Object Vautoload_queue;
931 extern Lisp_Object Vrun_hooks;
932 extern Lisp_Object Fand (), For (), Fif (), Fprogn (), Fprog1 (), Fprog2 ();
933 extern Lisp_Object Fsetq (), Fquote ();
934 extern Lisp_Object Fuser_variable_p (), Finteractive_p ();
935 extern Lisp_Object Fdefun (), Flet (), FletX (), Fwhile ();
936 extern Lisp_Object Fcatch (), Fthrow (), Funwind_protect ();
937 extern Lisp_Object Fcondition_case (), Fsignal ();
938 extern Lisp_Object Ffunction_type (), Fautoload (), Fcommandp ();
939 extern Lisp_Object Feval (), Fapply (), Ffuncall ();
940 extern Lisp_Object Fglobal_set (), Fglobal_value (), Fbacktrace ();
941 extern Lisp_Object apply1 (), call0 (), call1 (), call2 (), call3 ();
942 extern Lisp_Object apply_lambda ();
943 extern Lisp_Object internal_catch ();
944 extern Lisp_Object internal_condition_case ();
945 extern Lisp_Object unbind_to ();
946 extern void error ();
947 extern Lisp_Object un_autoload ();
948
949 /* Defined in editfns.c */
950 extern Lisp_Object Vprefix_arg, Qminus, Vcurrent_prefix_arg;
951 extern Lisp_Object Fgoto_char ();
952 extern Lisp_Object Fpoint_min_marker (), Fpoint_max_marker ();
953 extern Lisp_Object Fpoint_min (), Fpoint_max ();
954 extern Lisp_Object Fpoint (), Fpoint_marker (), Fmark_marker ();
955 extern Lisp_Object Ffollowing_char (), Fprevious_char (), Fchar_after ();
956 extern Lisp_Object Finsert ();
957 extern Lisp_Object Feolp (), Feobp (), Fbolp (), Fbobp ();
958 extern Lisp_Object Fformat (), format1 ();
959 extern Lisp_Object make_buffer_string (), Fbuffer_substring ();
960 extern Lisp_Object Fbuffer_string ();
961 extern Lisp_Object Fstring_equal (), Fstring_lessp (), Fbuffer_substring_lessp ();
962 extern Lisp_Object save_excursion_save (), save_restriction_save ();
963 extern Lisp_Object save_excursion_restore (), save_restriction_restore ();
964 extern Lisp_Object Fchar_to_string ();
965
966 /* defined in buffer.c */
967 extern Lisp_Object Vbuffer_alist;
968 extern Lisp_Object Fget_buffer (), Fget_buffer_create (), Fset_buffer ();
969 extern Lisp_Object Fbarf_if_buffer_read_only ();
970 extern Lisp_Object Fcurrent_buffer (), Fswitch_to_buffer (), Fpop_to_buffer ();
971 extern Lisp_Object Fother_buffer ();
972 extern struct buffer *all_buffers;
973
974 /* defined in marker.c */
975
976 extern Lisp_Object Fmarker_position (), Fmarker_buffer ();
977 extern Lisp_Object Fcopy_marker ();
978
979 /* Defined in fileio.c */
980
981 extern Lisp_Object Qfile_error;
982 extern Lisp_Object Ffile_name_as_directory ();
983 extern Lisp_Object Fexpand_file_name (), Ffile_name_nondirectory ();
984 extern Lisp_Object Fsubstitute_in_file_name ();
985 extern Lisp_Object Ffile_symlink_p ();
986
987 /* Defined in abbrev.c */
988
989 extern Lisp_Object Vfundamental_mode_abbrev_table;
990
991 /* defined in search.c */
992 extern Lisp_Object Fstring_match ();
993 extern Lisp_Object Fscan_buffer ();
994
995 /* defined in minibuf.c */
996
997 extern Lisp_Object last_minibuf_string;
998 extern Lisp_Object read_minibuf (), Fcompleting_read ();
999 extern Lisp_Object Fread_from_minibuffer ();
1000 extern Lisp_Object Fread_variable (), Fread_buffer (), Fread_key_sequence ();
1001 extern Lisp_Object Fread_minibuffer (), Feval_minibuffer ();
1002 extern Lisp_Object Fread_string (), Fread_file_name ();
1003 extern Lisp_Object Fread_no_blanks_input ();
1004
1005 /* Defined in callint.c */
1006
1007 extern Lisp_Object Vcommand_history;
1008 extern Lisp_Object Qcall_interactively;
1009 extern Lisp_Object Fcall_interactively ();
1010 extern Lisp_Object Fprefix_numeric_value ();
1011
1012 /* defined in casefiddle.c */
1013
1014 extern Lisp_Object Fdowncase (), Fupcase (), Fcapitalize ();
1015
1016 /* defined in keyboard.c */
1017
1018 extern Lisp_Object Qdisabled;
1019 extern Lisp_Object Vhelp_form, Vtop_level;
1020 extern Lisp_Object Fdiscard_input (), Frecursive_edit ();
1021 extern Lisp_Object Fcommand_execute (), Finput_pending_p ();
1022
1023 /* defined in keymap.c */
1024
1025 extern Lisp_Object Qkeymap;
1026 extern Lisp_Object current_global_map;
1027 extern Lisp_Object Fkey_description (), Fsingle_key_description ();
1028 extern Lisp_Object Fwhere_is_internal ();
1029 extern Lisp_Object access_keymap (), store_in_keymap ();
1030 extern Lisp_Object get_keyelt (), get_keymap();
1031
1032 /* defined in indent.c */
1033 extern Lisp_Object Fvertical_motion (), Findent_to (), Fcurrent_column ();
1034
1035 /* defined in window.c */
1036 extern Lisp_Object Qwindowp;
1037 extern Lisp_Object Fget_buffer_window ();
1038 extern Lisp_Object Fsave_window_excursion ();
1039 extern Lisp_Object Fset_window_configuration (), Fcurrent_window_configuration ();
1040 extern Lisp_Object Fcoordinates_in_window_p ();
1041 extern Lisp_Object Fwindow_at ();
1042
1043 /* defined in screen.c */
1044 extern Lisp_Object Fscreenp ();
1045 extern Lisp_Object Fselect_screen ();
1046 extern Lisp_Object Ffocus_screen ();
1047 extern Lisp_Object Funfocus_screen ();
1048 extern Lisp_Object Fselected_screen ();
1049 extern Lisp_Object Fwindow_screen ();
1050 extern Lisp_Object Fscreen_root_window ();
1051 extern Lisp_Object Fscreen_selected_window ();
1052 extern Lisp_Object Fscreen_list ();
1053 extern Lisp_Object Fnext_screen ();
1054 extern Lisp_Object Fdelete_screen ();
1055 extern Lisp_Object Fread_mouse_position ();
1056 extern Lisp_Object Fset_mouse_position ();
1057 extern Lisp_Object Fmake_screen_visible ();
1058 extern Lisp_Object Fmake_screen_invisible ();
1059 extern Lisp_Object Ficonify_screen ();
1060 extern Lisp_Object Fdeiconify_screen ();
1061 extern Lisp_Object Fscreen_visible_p ();
1062 extern Lisp_Object Fvisible_screen_list ();
1063 extern Lisp_Object Fscreen_parameters ();
1064 extern Lisp_Object Fmodify_screen_parameters ();
1065 extern Lisp_Object Fscreen_pixel_size ();
1066 extern Lisp_Object Fscreen_height ();
1067 extern Lisp_Object Fscreen_width ();
1068 extern Lisp_Object Fset_screen_height ();
1069 extern Lisp_Object Fset_screen_width ();
1070 extern Lisp_Object Fset_screen_size ();
1071 extern Lisp_Object Fset_screen_position ();
1072 #ifndef HAVE_X11
1073 extern Lisp_Object Frubber_band_rectangle ();
1074 #endif /* HAVE_X11 */
1075
1076 /* defined in emacs.c */
1077 extern Lisp_Object decode_env_path ();
1078 /* Nonzero means don't do interactive redisplay and don't change tty modes */
1079 extern int noninteractive;
1080 /* Nonzero means don't do use window-system-specific display code */
1081 extern int inhibit_window_system;
1082
1083 /* defined in process.c */
1084 extern Lisp_Object Fget_process (), Fget_buffer_process (), Fprocessp ();
1085 extern Lisp_Object Fprocess_status (), Fkill_process ();
1086
1087 /* defined in callproc.c */
1088 extern Lisp_Object Vexec_path, Vexec_directory, Vdata_directory;
1089
1090 /* defined in doc.c */
1091 extern Lisp_Object Vdoc_file_name;
1092 extern Lisp_Object Fsubstitute_command_keys ();
1093 extern Lisp_Object Fdocumentation (), Fdocumentation_property ();
1094
1095 /* defined in bytecode.c */
1096 extern Lisp_Object Qbytecode;
1097
1098 /* defined in macros.c */
1099 extern Lisp_Object Qexecute_kbd_macro;
1100 extern Lisp_Object Fexecute_kbd_macro ();
1101
1102 /* Nonzero means Emacs has already been initialized.
1103 Used during startup to detect startup of dumped Emacs. */
1104 extern int initialized;
1105
1106 extern int immediate_quit; /* Nonzero means ^G can quit instantly */
1107
1108 extern void debugger ();
1109
1110 extern char *malloc (), *realloc (), *getenv (), *ctime (), *getwd ();
1111 extern long *xmalloc (), *xrealloc ();
1112
1113 extern char *egetenv ();