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