1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985,86,87,93,94,95, 1997 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
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)
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.
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, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
22 /* These are default choices for the types to use. */
25 #define BITS_PER_EMACS_INT BITS_PER_INT
28 #define EMACS_UINT unsigned int
31 /* Define the fundamental Lisp data structures. */
33 /* This is the set of Lisp data types. */
37 /* Integer. XINT (obj) is the integer value. */
40 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
43 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
44 whose first member indicates the subtype. */
47 /* String. XSTRING (object) points to a struct Lisp_String.
48 The length of the string, and its contents, are stored therein. */
51 /* Vector of Lisp objects, or something resembling it.
52 XVECTOR (object) points to a struct Lisp_Vector, which contains
53 the size and contents. The size field also contains the type
54 information, if it's not a real vector object. */
57 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
60 #ifdef LISP_FLOAT_TYPE
62 #endif /* LISP_FLOAT_TYPE */
64 /* This is not a type code. It is for range checking. */
68 /* This is the set of datatypes that share a common structure.
69 The first member of the structure is a type code from this set.
70 The enum values are arbitrary, but we'll use large numbers to make it
71 more likely that we'll spot the error if a random word in memory is
72 mistakenly interpreted as a Lisp_Misc. */
75 Lisp_Misc_Free
= 0x5eab,
80 Lisp_Misc_Buffer_Objfwd
,
81 Lisp_Misc_Buffer_Local_Value
,
82 Lisp_Misc_Some_Buffer_Local_Value
,
84 Lisp_Misc_Kboard_Objfwd
,
85 /* Currently floats are not a misc type,
86 but let's define this in case we want to change that. */
88 /* This is not a type code. It is for range checking. */
92 /* These values are overridden by the m- file on some machines. */
101 /* Make these values available in GDB, which sees enums but not macros. */
105 gdb_valbits
= VALBITS
,
106 gdb_gctypebits
= GCTYPEBITS
,
107 gdb_emacs_intbits
= sizeof (EMACS_INT
) * BITS_PER_CHAR
,
109 gdb_data_seg_bits
= DATA_SEG_BITS
111 gdb_data_seg_bits
= 0
115 #ifndef NO_UNION_TYPE
117 #ifndef WORDS_BIG_ENDIAN
119 /* Definition of Lisp_Object for little-endian machines. */
124 /* Used for comparing two Lisp_Objects;
125 also, positive integers can be accessed fast this way. */
131 int type
: GCTYPEBITS
+1;
135 unsigned int val
: VALBITS
;
136 int type
: GCTYPEBITS
+1;
140 unsigned int val
: VALBITS
;
141 enum Lisp_Type type
: GCTYPEBITS
;
142 /* The markbit is not really part of the value of a Lisp_Object,
143 and is always zero except during garbage collection. */
144 unsigned int markbit
: 1;
149 #else /* If WORDS_BIG_ENDIAN */
154 /* Used for comparing two Lisp_Objects;
155 also, positive integers can be accessed fast this way. */
160 int type
: GCTYPEBITS
+1;
165 int type
: GCTYPEBITS
+1;
166 unsigned int val
: VALBITS
;
170 /* The markbit is not really part of the value of a Lisp_Object,
171 and is always zero except during garbage collection. */
172 unsigned int markbit
: 1;
173 enum Lisp_Type type
: GCTYPEBITS
;
174 unsigned int val
: VALBITS
;
179 #endif /* WORDS_BIG_ENDIAN */
181 #endif /* NO_UNION_TYPE */
184 /* If union type is not wanted, define Lisp_Object as just a number. */
187 #define Lisp_Object EMACS_INT
188 #endif /* NO_UNION_TYPE */
191 #define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
193 #define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
195 /* Two flags that are set during GC. On some machines, these flags
196 are defined differently by the m- file. */
198 /* This is set in the car of a cons and in the plist slot of a symbol
199 to indicate it is marked. Likewise in the plist slot of an interval,
200 the chain slot of a marker, the type slot of a float, and the name
203 In strings, this bit in the size field indicates that the string
204 is a "large" one, one which was separately malloc'd
205 rather than being part of a string block. */
208 #define MARKBIT ((int) ((unsigned int) 1 << (VALBITS + GCTYPEBITS)))
211 /* In the size word of a vector, this bit means the vector has been marked.
212 In the size word of a large string, likewise. */
214 #ifndef ARRAY_MARK_FLAG
215 #define ARRAY_MARK_FLAG ((MARKBIT >> 1) & ~MARKBIT)
216 #endif /* no ARRAY_MARK_FLAG */
218 /* In the size word of a struct Lisp_Vector, this bit means it's really
219 some other vector-like object. */
220 #ifndef PSEUDOVECTOR_FLAG
221 #define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1) & ~ARRAY_MARK_FLAG)
224 /* In a pseudovector, the size field actually contains a word with one
225 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
226 indicate the actual type. */
229 PVEC_NORMAL_VECTOR
= 0,
230 PVEC_PROCESS
= 0x200,
232 PVEC_COMPILED
= 0x800,
233 PVEC_WINDOW
= 0x1000,
234 PVEC_WINDOW_CONFIGURATION
= 0x2000,
236 PVEC_CHAR_TABLE
= 0x8000,
237 PVEC_BOOL_VECTOR
= 0x10000,
238 PVEC_BUFFER
= 0x20000,
239 PVEC_TYPE_MASK
= 0x3fe00,
240 PVEC_FLAG
= PSEUDOVECTOR_FLAG
243 /* For convenience, we also store the number of elements in these bits. */
244 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
246 /* These macros extract various sorts of values from a Lisp_Object.
247 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
248 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
252 /* One need to override this if there must be high bits set in data space
253 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
254 on all machines, but would penalise machines which don't need it)
257 #define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
261 #define XSETTYPE(a, b) ((a) = XUINT (a) | ((EMACS_INT)(b) << VALBITS))
264 /* For integers known to be positive, XFASTINT provides fast retrieval
265 and XSETFASTINT provides fast storage. This takes advantage of the
266 fact that Lisp_Int is 0. */
267 #define XFASTINT(a) ((a) + 0)
268 #define XSETFASTINT(a, b) ((a) = (b))
270 /* Extract the value of a Lisp_Object as a signed integer. */
272 #ifndef XINT /* Some machines need to do this differently. */
273 #define XINT(a) (((a) << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
276 /* Extract the value as an unsigned integer. This is a basis
277 for extracting it as a pointer to a structure in storage. */
280 #define XUINT(a) ((a) & VALMASK)
285 /* In this representation, data is found in two widely separated segments. */
286 extern int pure_size
;
288 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
289 #else /* not HAVE_SHM */
291 /* This case is used for the rt-pc.
292 In the diffs I was given, it checked for ptr = 0
293 and did not adjust it in that case.
294 But I don't think that zero should ever be found
295 in a Lisp object whose data type says it points to something. */
296 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
298 #define XPNTR(a) XUINT (a)
300 #endif /* not HAVE_SHM */
301 #endif /* no XPNTR */
304 #define XSET(var, type, ptr) \
305 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
308 /* Convert a C integer into a Lisp_Object integer. */
310 #define make_number(N) \
311 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
313 /* During garbage collection, XGCTYPE must be used for extracting types
314 so that the mark bit is ignored. XMARKBIT accesses the markbit.
315 Markbits are used only in particular slots of particular structure types.
316 Other markbits are always zero.
317 Outside of garbage collection, all mark bits are always zero. */
320 #define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
323 #if VALBITS + GCTYPEBITS == BITS_PER_EMACS_INT - 1
324 /* Make XMARKBIT faster if mark bit is sign bit. */
326 #define XMARKBIT(a) ((a) < 0)
328 #endif /* markbit is sign bit */
331 #define XMARKBIT(a) ((a) & MARKBIT)
335 #define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
339 #define XMARK(a) ((a) |= MARKBIT)
343 #define XUNMARK(a) ((a) &= ~MARKBIT)
346 #endif /* NO_UNION_TYPE */
348 #ifndef NO_UNION_TYPE
350 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
351 #define XSETTYPE(a, b) ((a).u.type = (char) (b))
353 /* For integers known to be positive, XFASTINT provides fast retrieval
354 and XSETFASTINT provides fast storage. This takes advantage of the
355 fact that Lisp_Int is 0. */
356 #define XFASTINT(a) ((a).i + 0)
357 #define XSETFASTINT(a, b) ((a).i = (b))
359 #ifdef EXPLICIT_SIGN_EXTEND
360 /* Make sure we sign-extend; compilers have been known to fail to do so. */
361 #define XINT(a) (((a).i << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
363 #define XINT(a) ((a).s.val)
364 #endif /* EXPLICIT_SIGN_EXTEND */
366 #define XUINT(a) ((a).u.val)
367 #define XPNTR(a) ((a).u.val)
369 #define XSET(var, vartype, ptr) \
370 (((var).s.type = ((char) (vartype))), ((var).s.val = ((int) (ptr))))
372 extern Lisp_Object
make_number ();
374 /* During garbage collection, XGCTYPE must be used for extracting types
375 so that the mark bit is ignored. XMARKBIT access the markbit.
376 Markbits are used only in particular slots of particular structure types.
377 Other markbits are always zero.
378 Outside of garbage collection, all mark bits are always zero. */
380 #define XGCTYPE(a) ((a).gu.type)
381 #define XMARKBIT(a) ((a).gu.markbit)
382 #define XSETMARKBIT(a,b) (XMARKBIT(a) = (b))
383 #define XMARK(a) (XMARKBIT(a) = 1)
384 #define XUNMARK(a) (XMARKBIT(a) = 0)
386 #endif /* NO_UNION_TYPE */
388 /* Extract a value or address from a Lisp_Object. */
390 #define XCONS(a) ((struct Lisp_Cons *) XPNTR(a))
391 #define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
392 #define XSTRING(a) ((struct Lisp_String *) XPNTR(a))
393 #define XSYMBOL(a) ((struct Lisp_Symbol *) XPNTR(a))
394 #define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
397 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
398 #define XMISCTYPE(a) (XMARKER (a)->type)
399 #define XMARKER(a) (&(XMISC(a)->u_marker))
400 #define XINTFWD(a) (&(XMISC(a)->u_intfwd))
401 #define XBOOLFWD(a) (&(XMISC(a)->u_boolfwd))
402 #define XOBJFWD(a) (&(XMISC(a)->u_objfwd))
403 #define XBUFFER_OBJFWD(a) (&(XMISC(a)->u_buffer_objfwd))
404 #define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
405 #define XOVERLAY(a) (&(XMISC(a)->u_overlay))
406 #define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
408 /* Pseudovector types. */
409 #define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
410 #define XWINDOW(a) ((struct window *) XPNTR(a))
411 #define XSUBR(a) ((struct Lisp_Subr *) XPNTR(a))
412 #define XBUFFER(a) ((struct buffer *) XPNTR(a))
413 #define XCHAR_TABLE(a) ((struct Lisp_Char_Table *) XPNTR(a))
414 #define XBOOL_VECTOR(a) ((struct Lisp_Bool_Vector *) XPNTR(a))
417 /* Construct a Lisp_Object from a value or address. */
419 #define XSETINT(a, b) XSET (a, Lisp_Int, b)
420 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
421 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
422 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
423 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
424 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
427 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
428 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
430 /* Pseudovector types. */
431 #define XSETPSEUDOVECTOR(a, b, code) \
432 (XSETVECTOR (a, b), XVECTOR (a)->size |= PSEUDOVECTOR_FLAG | (code))
433 #define XSETWINDOW_CONFIGURATION(a, b) \
434 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
435 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
436 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
437 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
438 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
439 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
440 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
441 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
443 #ifdef USE_TEXT_PROPERTIES
444 /* Basic data type for use of intervals. See the macros in intervals.h. */
448 /* The first group of entries deal with the tree structure. */
450 unsigned int total_length
; /* Length of myself and both children. */
451 unsigned int position
; /* Cache of interval's character position. */
452 struct interval
*left
; /* Intervals which precede me. */
453 struct interval
*right
; /* Intervals which succeed me. */
455 /* Parent in the tree, or the Lisp_Object containing this interval tree.
457 The mark bit on the root interval of an interval tree says
458 whether we have started (and possibly finished) marking the
459 tree. If GC comes across an interval tree whose root's parent
460 field has its markbit set, it leaves the tree alone.
462 You'd think we could store this information in the parent object
463 somewhere (after all, that should be visited once and then
464 ignored too, right?), but strings are GC'd strangely. */
465 struct interval
*parent
;
467 /* The remaining components are `properties' of the interval.
468 The first four are duplicates for things which can be on the list,
469 for purposes of speed. */
471 unsigned char write_protect
; /* Non-zero means can't modify. */
472 unsigned char visible
; /* Zero means don't display. */
473 unsigned char front_sticky
; /* Non-zero means text inserted just
474 before this interval goes into it. */
475 unsigned char rear_sticky
; /* Likewise for just after it. */
477 /* Properties of this interval.
478 The mark bit on this field says whether this particular interval
479 tree node has been visited. Since intervals should never be
480 shared, GC aborts if it seems to have visited an interval twice. */
484 typedef struct interval
*INTERVAL
;
486 /* Complain if object is not string or buffer type */
487 #define CHECK_STRING_OR_BUFFER(x, i) \
488 { if (!STRINGP ((x)) && !BUFFERP ((x))) \
489 x = wrong_type_argument (Qbuffer_or_string_p, (x)); }
491 /* Macro used to conditionally compile intervals into certain data
492 structures. See, e.g., struct Lisp_String below. */
493 #define DECLARE_INTERVALS INTERVAL intervals;
495 /* Macro used to conditionally compile interval initialization into
496 certain code. See, e.g., alloc.c. */
497 #define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val
499 #else /* No text properties */
501 /* If no intervals are used, make the above definitions go away. */
503 #define CHECK_STRING_OR_BUFFER(x, i)
506 #define DECLARE_INTERVALS
507 #define INITIALIZE_INTERVAL(ptr,val)
509 #endif /* USE_TEXT_PROPERTIES */
511 /* In a cons, the markbit of the car is the gc mark bit */
515 Lisp_Object car
, cdr
;
518 /* Take the car or cdr of something known to be a cons cell. */
519 #define XCAR(c) (XCONS ((c))->car)
520 #define XCDR(c) (XCONS ((c))->cdr)
522 /* Take the car or cdr of something whose type is not known. */
524 (CONSP ((c)) ? XCAR ((c)) \
525 : NILP ((c)) ? Qnil \
526 : wrong_type_argument (Qlistp, (c)))
529 (CONSP ((c)) ? XCDR ((c)) \
530 : NILP ((c)) ? Qnil \
531 : wrong_type_argument (Qlistp, (c)))
533 /* Like a cons, but records info on where the text lives that it was read from */
534 /* This is not really in use now */
536 struct Lisp_Buffer_Cons
538 Lisp_Object car
, cdr
;
539 struct buffer
*buffer
;
543 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
548 DECLARE_INTERVALS
/* `data' field must be last. */
549 unsigned char data
[1];
552 /* If a struct is made to look like a vector, this macro returns the length
553 of the shortest vector that would hold that struct. */
554 #define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector) \
555 - sizeof (Lisp_Object)) \
556 + sizeof(Lisp_Object) - 1) /* round up */ \
557 / sizeof (Lisp_Object))
562 struct Lisp_Vector
*next
;
563 Lisp_Object contents
[1];
566 /* A char table is a kind of vectorlike, with contents are like a
567 vector but with a few other slots. For some purposes, it makes
568 sense to handle a chartable with type struct Lisp_Vector. An
569 element of a char table can be any Lisp objects, but if it is a sub
570 char-table, we treat it a table that contains information of a
571 group of characters of the same charsets or a specific character of
572 a charset. A sub char-table has the same structure as a char table
573 except for that the former omits several slots at the tail. A sub
574 char table appears only in an element of a char table, and there's
575 no way to access it directly from Emacs Lisp program. */
577 /* This is the number of slots that apply to characters or character
578 sets. The first 128 are for ASCII, the next 128 are for 8-bit
579 European characters, and the last 128 are for multibyte characters.
580 The first 256 are indexed by the code itself, but the last 128 are
581 indexed by (charset-id + 128). */
582 #define CHAR_TABLE_ORDINARY_SLOTS 384
584 /* This is the number of slots that apply to characters of ASCII and
585 8-bit Europeans only. */
586 #define CHAR_TABLE_SINGLE_BYTE_SLOTS 256
588 /* This is the number of slots that every char table must have. This
589 counts the ordinary slots and the top, defalt, parent, and purpose
591 #define CHAR_TABLE_STANDARD_SLOTS (CHAR_TABLE_ORDINARY_SLOTS + 4)
593 /* This is the number of slots that apply to position-code-1 and
594 position-code-2 of a multibyte character at the 2nd and 3rd level
595 sub char tables respectively. */
596 #define SUB_CHAR_TABLE_ORDINARY_SLOTS 128
598 /* This is the number of slots that every sub char table must have.
599 This counts the ordinary slots and the top and defalt slot. */
600 #define SUB_CHAR_TABLE_STANDARD_SLOTS (SUB_CHAR_TABLE_ORDINARY_SLOTS + 2)
602 /* Return the number of "extra" slots in the char table CT. */
604 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
605 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
607 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
608 and 8-bit Europeans characters. For these characters, do not check
609 validity of CT. Do not follow parent. */
610 #define CHAR_TABLE_REF(CT, IDX) \
611 ((IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS \
612 ? (!NILP (XCHAR_TABLE (CT)->contents[IDX]) \
613 ? XCHAR_TABLE (CT)->contents[IDX] \
614 : XCHAR_TABLE (CT)->defalt) \
615 : Faref (CT, make_number (IDX)))
617 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
618 8-bit Europeans characters. Do not check validity of CT. */
619 #define CHAR_TABLE_SET(CT, IDX, VAL) \
621 if (XFASTINT (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS) \
622 XCHAR_TABLE (CT)->contents[XFASTINT (IDX)] = VAL; \
624 Faset (CT, IDX, VAL); \
627 struct Lisp_Char_Table
629 /* This is the vector's size field, which also holds the
630 pseudovector type information. It holds the size, too.
631 The size counts the top, defalt, purpose, and parent slots.
632 The last three are not counted if this is a sub char table. */
634 struct Lisp_Vector
*next
;
635 /* This holds a flag to tell if this is a top level char table (t)
636 or a sub char table (nil). */
638 /* This holds a default value,
639 which is used whenever the value for a specific character is nil. */
641 /* This holds an actual value of each element. A sub char table
642 has only SUB_CHAR_TABLE_ORDINARY_SLOTS number of elements. */
643 Lisp_Object contents
[CHAR_TABLE_ORDINARY_SLOTS
];
645 /* A sub char table doesn't has the following slots. */
647 /* This points to another char table, which we inherit from
648 when the value for a specific character is nil.
649 The `defalt' slot takes precedence over this. */
651 /* This should be a symbol which says what kind of use
652 this char-table is meant for.
653 Typically now the values can be `syntax-table' and `display-table'. */
655 /* These hold additional data. */
656 Lisp_Object extras
[1];
659 /* A boolvector is a kind of vectorlike, with contents are like a string. */
660 struct Lisp_Bool_Vector
662 /* This is the vector's size field. It doesn't have the real size,
663 just the subtype information. */
664 EMACS_INT vector_size
;
665 struct Lisp_Vector
*next
;
666 /* This is the size in bits. */
668 /* This contains the actual bits, packed into bytes. */
669 unsigned char data
[1];
672 /* In a symbol, the markbit of the plist is used as the gc mark bit */
676 struct Lisp_String
*name
;
678 Lisp_Object function
;
681 struct Lisp_Symbol
*next
; /* -> next symbol in this obarray bucket */
684 /* This structure describes a built-in function.
685 It is generated by the DEFUN macro only.
686 defsubr makes it into a Lisp object.
688 This type is treated in most respects as a pseudovector,
689 but since we never dynamically allocate or free them,
690 we don't need a next-vector field. */
695 Lisp_Object (*function
) ();
696 short min_args
, max_args
;
702 /* These structures are used for various misc types. */
704 /* A miscellaneous object, when it's on the free list. */
707 int type
: 16; /* = Lisp_Misc_Free */
709 union Lisp_Misc
*chain
;
712 /* In a marker, the markbit of the chain field is used as the gc mark bit. */
715 int type
: 16; /* = Lisp_Misc_Marker */
717 /* 1 means normal insertion at the marker's position
718 leaves the marker after the inserted text. */
719 unsigned int insertion_type
: 1;
720 struct buffer
*buffer
;
725 /* Forwarding pointer to an int variable.
726 This is allowed only in the value cell of a symbol,
727 and it means that the symbol's value really lives in the
728 specified int variable. */
731 int type
: 16; /* = Lisp_Misc_Intfwd */
736 /* Boolean forwarding pointer to an int variable.
737 This is like Lisp_Intfwd except that the ostensible
738 "value" of the symbol is t if the int variable is nonzero,
739 nil if it is zero. */
742 int type
: 16; /* = Lisp_Misc_Boolfwd */
747 /* Forwarding pointer to a Lisp_Object variable.
748 This is allowed only in the value cell of a symbol,
749 and it means that the symbol's value really lives in the
750 specified variable. */
753 int type
: 16; /* = Lisp_Misc_Objfwd */
758 /* Like Lisp_Objfwd except that value lives in a slot in the
759 current buffer. Value is byte index of slot within buffer. */
760 struct Lisp_Buffer_Objfwd
762 int type
: 16; /* = Lisp_Misc_Buffer_Objfwd */
767 /* Used in a symbol value cell when the symbol's value is per-buffer.
768 The actual contents resemble a cons cell which starts a list like this:
769 (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).
771 The cons-like structure is for historical reasons; it might be better
772 to just put these elements into the struct, now.
774 BUFFER is the last buffer for which this symbol's value was
777 CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
778 local_var_alist, that being the element whose car is this
779 variable. Or it can be a pointer to the
780 (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE),
781 if BUFFER does not have an element in its alist for this
782 variable (that is, if BUFFER sees the default value of this
785 If we want to examine or set the value and BUFFER is current,
786 we just examine or set REALVALUE. If BUFFER is not current, we
787 store the current REALVALUE value into CURRENT-ALIST-ELEMENT,
788 then find the appropriate alist element for the buffer now
789 current and set up CURRENT-ALIST-ELEMENT. Then we set
790 REALVALUE out of that element, and store into BUFFER.
792 If we are setting the variable and the current buffer does not
793 have an alist entry for this variable, an alist entry is
796 Note that REALVALUE can be a forwarding pointer. Each time it
797 is examined or set, forwarding must be done. Each time we
798 switch buffers, buffer-local variables which forward into C
799 variables are swapped immediately, so the C code can assume
800 that they are always up to date.
802 Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
803 use the same substructure. The difference is that with the latter,
804 merely setting the variable while some buffer is current
805 does not cause that buffer to have its own local value of this variable.
806 Only make-local-variable does that. */
807 struct Lisp_Buffer_Local_Value
809 int type
: 16; /* = Lisp_Misc_Buffer_Local_Value
810 or Lisp_Misc_Some_Buffer_Local_Value */
812 Lisp_Object car
, cdr
;
815 /* In an overlay object, the mark bit of the plist is used as the GC mark.
816 START and END are markers in the overlay's buffer, and
817 PLIST is the overlay's property list. */
820 int type
: 16; /* = Lisp_Misc_Overlay */
822 Lisp_Object start
, end
, plist
;
825 /* Like Lisp_Objfwd except that value lives in a slot in the
827 struct Lisp_Kboard_Objfwd
829 int type
: 16; /* = Lisp_Misc_Kboard_Objfwd */
835 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
836 It uses one of these struct subtypes to get the type field. */
840 struct Lisp_Free u_free
;
841 struct Lisp_Marker u_marker
;
842 struct Lisp_Intfwd u_intfwd
;
843 struct Lisp_Boolfwd u_boolfwd
;
844 struct Lisp_Objfwd u_objfwd
;
845 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
846 struct Lisp_Buffer_Local_Value u_buffer_local_value
;
847 struct Lisp_Overlay u_overlay
;
848 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
851 #ifdef LISP_FLOAT_TYPE
852 /* Optional Lisp floating point type */
855 Lisp_Object type
; /* essentially used for mark-bit
856 and chaining when on free-list */
859 #endif /* LISP_FLOAT_TYPE */
861 /* A character, declared with the following typedef, is a member
862 of some character set associated with the current buffer. */
863 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
865 typedef unsigned char UCHAR
;
868 /* Meanings of slots in a Lisp_Compiled: */
870 #define COMPILED_ARGLIST 0
871 #define COMPILED_BYTECODE 1
872 #define COMPILED_CONSTANTS 2
873 #define COMPILED_STACK_DEPTH 3
874 #define COMPILED_DOC_STRING 4
875 #define COMPILED_INTERACTIVE 5
877 /* Flag bits in a character. These also get used in termhooks.h.
878 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
879 (MUlti-Lingual Emacs) might need 22 bits for the character value
880 itself, so we probably shouldn't use any bits lower than 0x0400000. */
881 #define CHAR_ALT (0x0400000)
882 #define CHAR_SUPER (0x0800000)
883 #define CHAR_HYPER (0x1000000)
884 #define CHAR_SHIFT (0x2000000)
885 #define CHAR_CTL (0x4000000)
886 #define CHAR_META (0x8000000)
888 /* Actually, the current Emacs uses 19 bits for the character value
890 #define CHARACTERBITS 19
894 /* Use this for turning a (void *) into a Lisp_Object, as when the
895 Lisp_Object is passed into a toolkit callback function. */
896 #define VOID_TO_LISP(larg,varg) \
897 do { ((larg) = ((Lisp_Object) (varg))); } while (0)
898 #define CVOID_TO_LISP VOID_TO_LISP
900 /* Use this for turning a Lisp_Object into a (void *), as when the
901 Lisp_Object is passed into a toolkit callback function. */
902 #define LISP_TO_VOID(larg) ((void *) (larg))
903 #define LISP_TO_CVOID(varg) ((const void *) (larg))
905 #else /* not NO_UNION_TYPE */
906 /* Use this for turning a (void *) into a Lisp_Object, as when the
907 Lisp_Object is passed into a toolkit callback function. */
908 #define VOID_TO_LISP(larg,varg) \
909 do { ((larg).v = (void *) (varg)); } while (0)
910 #define CVOID_TO_LISP(larg,varg) \
911 do { ((larg).cv = (const void *) (varg)); } while (0)
913 /* Use this for turning a Lisp_Object into a (void *), as when the
914 Lisp_Object is passed into a toolkit callback function. */
915 #define LISP_TO_VOID(larg) ((larg).v)
916 #define LISP_TO_CVOID(larg) ((larg).cv)
917 #endif /* not NO_UNION_TYPE */
918 #endif /* USE_X_TOOLKIT */
921 /* The glyph datatype, used to represent characters on the display. */
923 /* The low 19 bits (CHARACTERBITS) are the character code, and the
924 bits above them except for the topmost two bits are the numeric
925 face ID. If FID is the face ID of a glyph on a frame F, then
926 F->display.x->faces[FID] contains the description of that face.
927 This is an int instead of a short, so we can support a good bunch
928 of face ID's (i.e. 2^(32 - 19 - 2) = 2048 ID's) ; given that we
929 have no mechanism for tossing unused frame face ID's yet, we'll
930 probably run out of 255 pretty quickly. */
931 #define GLYPH unsigned int
933 /* Mask bit for a glyph of a character which should be written from
935 #define GLYPH_MASK_REV_DIR 0x80000000
936 /* Mask bit for a padding glyph of a multi-column character. */
937 #define GLYPH_MASK_PADDING 0x40000000
938 /* Mask bits for face. */
939 #define GLYPH_MASK_FACE 0x3FF80000
940 /* Mask bits for character code. */
941 #define GLYPH_MASK_CHAR 0x0007FFFF /* The lowest 19 bits */
944 /* The FAST macros assume that we already know we're in an X window. */
946 /* Given a character code and a face ID, return the appropriate glyph. */
947 #define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << CHARACTERBITS))
949 /* Return a glyph's character code. */
950 #define FAST_GLYPH_CHAR(glyph) ((glyph) & GLYPH_MASK_CHAR)
952 /* Return a glyph's face ID. */
953 #define FAST_GLYPH_FACE(glyph) (((glyph) & GLYPH_MASK_FACE) >> CHARACTERBITS)
955 /* Slower versions that test the frame type first. */
956 #define MAKE_GLYPH(f, char, face) (FRAME_TERMCAP_P (f) ? (char) \
957 : FAST_MAKE_GLYPH (char, face))
958 #define GLYPH_CHAR(f, g) (FRAME_TERMCAP_P (f) ? (g) : FAST_GLYPH_CHAR (g))
959 #define GLYPH_FACE(f, g) (FRAME_TERMCAP_P (f) ? (0) : FAST_GLYPH_FACE (g))
960 #else /* not HAVE_FACES */
961 #define MAKE_GLYPH(f, char, face) (char)
962 #define FAST_MAKE_GLYPH(char, face) (char)
963 #define GLYPH_CHAR(f, g) ((g) & GLYPH_MASK_CHAR)
964 #define FAST_GLYPH_CHAR(g) ((g) & GLYPH_MASK_CHAR)
965 #define GLYPH_FACE(f, g) ((g) & GLYPH_MASK_FACE)
966 #define FAST_GLYPH_FACE(g) ((g) & GLYPH_MASK_FACE)
967 #endif /* not HAVE_FACES */
969 /* Return 1 iff GLYPH contains valid character code. */
970 #define GLYPH_CHAR_VALID_P(glyph) \
971 ((GLYPH) (FAST_GLYPH_CHAR (glyph)) <= MAX_CHAR)
973 /* The ID of the mode line highlighting face. */
974 #define GLYPH_MODE_LINE_FACE 1
976 /* Data type checking */
978 #define NILP(x) (XFASTINT (x) == XFASTINT (Qnil))
979 #define GC_NILP(x) GC_EQ (x, Qnil)
981 #ifdef LISP_FLOAT_TYPE
982 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
983 #define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
985 #define NUMBERP(x) (INTEGERP (x))
986 #define GC_NUMBERP(x) (GC_INTEGERP (x))
988 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
989 #define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
991 #define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
992 #define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
993 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
994 #define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
995 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
996 #define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
997 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
998 #define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
999 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1000 #define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
1001 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1002 #define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
1004 #ifdef LISP_FLOAT_TYPE
1005 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1006 #define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
1008 #define FLOATP(x) (0)
1009 #define GC_FLOATP(x) (0)
1011 #define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1012 #define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1013 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1014 #define GC_OVERLAYP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1015 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1016 #define GC_MARKERP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1017 #define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
1018 #define GC_INTFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
1019 #define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
1020 #define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
1021 #define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
1022 #define GC_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
1023 #define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
1024 #define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
1025 #define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
1026 #define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
1027 #define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1028 #define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1029 #define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1030 #define GC_KBOARD_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1033 /* True if object X is a pseudovector whose code is CODE. */
1034 #define PSEUDOVECTORP(x, code) \
1036 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1037 == (PSEUDOVECTOR_FLAG | (code))))
1039 /* True if object X is a pseudovector whose code is CODE.
1040 This one works during GC. */
1041 #define GC_PSEUDOVECTORP(x, code) \
1042 (GC_VECTORLIKEP (x) \
1043 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1044 == (PSEUDOVECTOR_FLAG | (code))))
1046 /* Test for specific pseudovector types. */
1047 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1048 #define GC_WINDOW_CONFIGURATIONP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1049 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1050 #define GC_PROCESSP(x) GC_PSEUDOVECTORP (x, PVEC_PROCESS)
1051 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1052 #define GC_WINDOWP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW)
1053 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1054 #define GC_SUBRP(x) GC_PSEUDOVECTORP (x, PVEC_SUBR)
1055 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1056 #define GC_COMPILEDP(x) GC_PSEUDOVECTORP (x, PVEC_COMPILED)
1057 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1058 #define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
1059 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1060 #define GC_CHAR_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1061 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1062 #define GC_BOOL_VECTOR_P(x) GC_PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1063 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1064 #define GC_FRAMEP(x) GC_PSEUDOVECTORP (x, PVEC_FRAME)
1066 #define SUB_CHAR_TABLE_P(x) (CHAR_TABLE_P (x) && NILP (XCHAR_TABLE (x)->top))
1068 #define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
1069 #define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
1071 #define CHECK_LIST(x, i) \
1072 do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
1074 #define CHECK_STRING(x, i) \
1075 do { if (!STRINGP ((x))) x = wrong_type_argument (Qstringp, (x)); } while (0)
1077 #define CHECK_CONS(x, i) \
1078 do { if (!CONSP ((x))) x = wrong_type_argument (Qconsp, (x)); } while (0)
1080 #define CHECK_SYMBOL(x, i) \
1081 do { if (!SYMBOLP ((x))) x = wrong_type_argument (Qsymbolp, (x)); } while (0)
1083 #define CHECK_CHAR_TABLE(x, i) \
1084 do { if (!CHAR_TABLE_P ((x))) \
1085 x = wrong_type_argument (Qchar_table_p, (x)); } while (0)
1087 #define CHECK_VECTOR(x, i) \
1088 do { if (!VECTORP ((x))) x = wrong_type_argument (Qvectorp, (x)); } while (0)
1090 #define CHECK_VECTOR_OR_CHAR_TABLE(x, i) \
1091 do { if (!VECTORP ((x)) && !CHAR_TABLE_P ((x))) \
1092 x = wrong_type_argument (Qvector_or_char_table_p, (x)); \
1095 #define CHECK_BUFFER(x, i) \
1096 do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
1098 #define CHECK_WINDOW(x, i) \
1099 do { if (!WINDOWP ((x))) x = wrong_type_argument (Qwindowp, (x)); } while (0)
1101 /* This macro rejects windows on the interior of the window tree as
1102 "dead", which is what we want; this is an argument-checking macro, and
1103 the user should never get access to interior windows.
1105 A window of any sort, leaf or interior, is dead iff the buffer,
1106 vchild, and hchild members are all nil. */
1108 #define CHECK_LIVE_WINDOW(x, i) \
1110 if (!WINDOWP ((x)) \
1111 || NILP (XWINDOW ((x))->buffer)) \
1112 x = wrong_type_argument (Qwindow_live_p, (x)); \
1115 #define CHECK_PROCESS(x, i) \
1116 do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
1118 #define CHECK_NUMBER(x, i) \
1119 do { if (!INTEGERP ((x))) x = wrong_type_argument (Qintegerp, (x)); } while (0)
1121 #define CHECK_NATNUM(x, i) \
1122 do { if (!NATNUMP (x)) x = wrong_type_argument (Qwholenump, (x)); } while (0)
1124 #define CHECK_MARKER(x, i) \
1125 do { if (!MARKERP ((x))) x = wrong_type_argument (Qmarkerp, (x)); } while (0)
1127 #define CHECK_NUMBER_COERCE_MARKER(x, i) \
1128 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1129 else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
1131 #ifdef LISP_FLOAT_TYPE
1137 #define XFLOATINT(n) extract_float((n))
1139 #define CHECK_FLOAT(x, i) \
1140 do { if (!FLOATP (x)) \
1141 x = wrong_type_argument (Qfloatp, (x)); } while (0)
1143 #define CHECK_NUMBER_OR_FLOAT(x, i) \
1144 do { if (!FLOATP (x) && !INTEGERP (x)) \
1145 x = wrong_type_argument (Qnumberp, (x)); } while (0)
1147 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
1148 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1149 else if (!INTEGERP (x) && !FLOATP (x)) \
1150 x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
1152 #else /* Not LISP_FLOAT_TYPE */
1154 #define CHECK_NUMBER_OR_FLOAT CHECK_NUMBER
1156 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER CHECK_NUMBER_COERCE_MARKER
1158 #define XFLOATINT(n) XINT((n))
1159 #endif /* LISP_FLOAT_TYPE */
1161 #define CHECK_OVERLAY(x, i) \
1162 do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
1164 /* Cast pointers to this type to compare them. Some machines want int. */
1165 #ifndef PNTR_COMPARISON_TYPE
1166 #define PNTR_COMPARISON_TYPE unsigned int
1169 /* Define a built-in function for calling from Lisp.
1170 `lname' should be the name to give the function in Lisp,
1171 as a null-terminated C string.
1172 `fnname' should be the name of the function in C.
1173 By convention, it starts with F.
1174 `sname' should be the name for the C constant structure
1175 that records information on this function for internal use.
1176 By convention, it should be the same as `fnname' but with S instead of F.
1177 It's too bad that C macros can't compute this from `fnname'.
1178 `minargs' should be a number, the minimum number of arguments allowed.
1179 `maxargs' should be a number, the maximum number of arguments allowed,
1180 or else MANY or UNEVALLED.
1181 MANY means pass a vector of evaluated arguments,
1182 in the form of an integer number-of-arguments
1183 followed by the address of a vector of Lisp_Objects
1184 which contains the argument values.
1185 UNEVALLED means pass the list of unevaluated arguments
1186 `prompt' says how to read arguments for an interactive call.
1187 See the doc string for `interactive'.
1188 A null string means call interactively with no arguments.
1189 `doc' is documentation for the user. */
1191 #if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
1192 #define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1193 Lisp_Object fnname (); \
1194 struct Lisp_Subr sname = \
1195 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1196 fnname, minargs, maxargs, lname, prompt, 0}; \
1201 /* This version of DEFUN declares a function prototype with the right
1202 arguments, so we can catch errors with maxargs at compile-time. */
1203 #define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1204 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1205 struct Lisp_Subr sname = \
1206 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1207 fnname, minargs, maxargs, lname, prompt, 0}; \
1210 /* Note that the weird token-substitution semantics of ANSI C makes
1211 this work for MANY and UNEVALLED. */
1212 #define DEFUN_ARGS_MANY (int, Lisp_Object *)
1213 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1214 #define DEFUN_ARGS_0 (void)
1215 #define DEFUN_ARGS_1 (Lisp_Object)
1216 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1217 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1218 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1219 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1221 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1222 Lisp_Object, Lisp_Object)
1223 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1224 Lisp_Object, Lisp_Object, Lisp_Object)
1228 is how we define the symbol for function `name' at start-up time. */
1229 extern void defsubr ();
1232 #define UNEVALLED -1
1234 extern void defvar_lisp ();
1235 extern void defvar_bool ();
1236 extern void defvar_int ();
1237 extern void defvar_kboard ();
1239 /* Macros we use to define forwarded Lisp variables.
1240 These are used in the syms_of_FILENAME functions. */
1242 #define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
1243 #define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
1244 #define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
1245 #define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
1246 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
1247 defvar_per_buffer (lname, vname, type, 0)
1248 #define DEFVAR_KBOARD(lname, vname, doc) \
1249 defvar_kboard (lname, \
1250 (int)((char *)(¤t_kboard->vname) \
1251 - (char *)current_kboard))
1253 /* Structure for recording Lisp call stack for backtrace purposes. */
1255 /* The special binding stack holds the outer values of variables while
1256 they are bound by a function application or a let form, stores the
1257 code to be executed for Lisp unwind-protect forms, and stores the C
1258 functions to be called for record_unwind_protect.
1260 If func is non-zero, undoing this binding applies func to old_value;
1261 This implements record_unwind_protect.
1262 If func is zero and symbol is nil, undoing this binding evaluates
1263 the list of forms in old_value; this implements Lisp's unwind-protect
1265 Otherwise, undoing this binding stores old_value as symbol's value; this
1266 undoes the bindings made by a let form or function call. */
1269 Lisp_Object symbol
, old_value
;
1270 Lisp_Object (*func
) ();
1271 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
1274 extern struct specbinding
*specpdl
;
1275 extern struct specbinding
*specpdl_ptr
;
1276 extern int specpdl_size
;
1278 /* Everything needed to describe an active condition case. */
1281 /* The handler clauses and variable from the condition-case form. */
1282 Lisp_Object handler
;
1284 /* Fsignal stores here the condition-case clause that applies,
1285 and Fcondition_case thus knows which clause to run. */
1286 Lisp_Object chosen_clause
;
1288 /* Used to effect the longjump out to the handler. */
1289 struct catchtag
*tag
;
1291 /* The next enclosing handler. */
1292 struct handler
*next
;
1295 extern struct handler
*handlerlist
;
1297 extern struct catchtag
*catchlist
;
1298 extern struct backtrace
*backtrace_list
;
1300 extern Lisp_Object memory_signal_data
;
1302 /* An address near the bottom of the stack.
1303 Tells GC how to save a copy of the stack. */
1304 extern char *stack_bottom
;
1306 /* Check quit-flag and quit if it is non-nil. */
1309 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1310 { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }
1312 /* Nonzero if ought to quit now. */
1314 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
1316 /* Variables used locally in the following case handling macros. */
1317 extern int case_temp1
;
1318 extern Lisp_Object case_temp2
;
1320 /* Current buffer's map from characters to lower-case characters. */
1322 #define DOWNCASE_TABLE current_buffer->downcase_table
1324 /* Current buffer's map from characters to upper-case characters. */
1326 #define UPCASE_TABLE current_buffer->upcase_table
1328 /* Downcase a character, or make no change if that cannot be done. */
1330 #define DOWNCASE(CH) \
1331 ((case_temp1 = (CH), \
1332 case_temp2 = CHAR_TABLE_REF (DOWNCASE_TABLE, case_temp1), \
1333 NATNUMP (case_temp2)) \
1334 ? XFASTINT (case_temp2) : case_temp1)
1336 /* 1 if CH is upper case. */
1338 #define UPPERCASEP(CH) (DOWNCASE (CH) != (CH))
1340 /* 1 if CH is neither upper nor lower case. */
1342 #define NOCASEP(CH) (UPCASE1 (CH) == (CH))
1344 /* 1 if CH is lower case. */
1346 #define LOWERCASEP(CH) (!UPPERCASEP (CH) && !NOCASEP(CH))
1348 /* Upcase a character, or make no change if that cannot be done. */
1350 #define UPCASE(CH) (!UPPERCASEP (CH) ? UPCASE1 (CH) : (CH))
1352 /* Upcase a character known to be not upper case. */
1354 #define UPCASE1(CH) \
1355 ((case_temp1 = (CH), \
1356 case_temp2 = CHAR_TABLE_REF (UPCASE_TABLE, case_temp1), \
1357 NATNUMP (case_temp2)) \
1358 ? XFASTINT (case_temp2) : case_temp1)
1360 extern Lisp_Object Vascii_downcase_table
;
1362 /* Number of bytes of structure consed since last GC. */
1364 extern int consing_since_gc
;
1366 /* Threshold for doing another gc. */
1368 extern int gc_cons_threshold
;
1370 /* Structure for recording stack slots that need marking. */
1372 /* This is a chain of structures, each of which points at a Lisp_Object variable
1373 whose value should be marked in garbage collection.
1374 Normally every link of the chain is an automatic variable of a function,
1375 and its `val' points to some argument or local variable of the function.
1376 On exit to the function, the chain is set back to the value it had on entry.
1377 This way, no link remains in the chain when the stack frame containing the
1380 Every function that can call Feval must protect in this fashion all
1381 Lisp_Object variables whose contents will be used again. */
1383 extern struct gcpro
*gcprolist
;
1388 Lisp_Object
*var
; /* Address of first protected variable */
1389 int nvars
; /* Number of consecutive protected variables */
1392 #define GCPRO1(varname) \
1393 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
1394 gcprolist = &gcpro1; }
1396 #define GCPRO2(varname1, varname2) \
1397 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1398 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1399 gcprolist = &gcpro2; }
1401 #define GCPRO3(varname1, varname2, varname3) \
1402 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1403 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1404 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1405 gcprolist = &gcpro3; }
1407 #define GCPRO4(varname1, varname2, varname3, varname4) \
1408 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1409 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1410 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1411 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1412 gcprolist = &gcpro4; }
1414 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
1415 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1416 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1417 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1418 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1419 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1420 gcprolist = &gcpro5; }
1422 /* Call staticpro (&var) to protect static variable `var'. */
1426 #define UNGCPRO (gcprolist = gcpro1.next)
1428 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
1429 #define RETURN_UNGCPRO(expr) \
1432 Lisp_Object ret_ungc_val; \
1433 ret_ungc_val = (expr); \
1435 return ret_ungc_val; \
1439 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
1440 meaning as in the DEFUN macro, and is used to construct a prototype. */
1441 #if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
1442 #define EXFUN(fnname, maxargs) \
1443 extern Lisp_Object fnname ()
1445 /* We can use the same trick as in the DEFUN macro to generate the
1446 appropriate prototype. */
1447 #define EXFUN(fnname, maxargs) \
1448 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
1451 /* Declare the prototype for a general external function. */
1453 #define P_(proto) proto
1455 #define P_(proto) ()
1458 /* Defined in data.c */
1459 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qsubr
, Qunbound
;
1460 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
1461 extern Lisp_Object Qerror
, Qquit
, Qwrong_type_argument
, Qargs_out_of_range
;
1462 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
1463 extern Lisp_Object Qsetting_constant
, Qinvalid_read_syntax
;
1464 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
1465 extern Lisp_Object Qend_of_file
, Qarith_error
;
1466 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
1467 extern Lisp_Object Qmark_inactive
;
1469 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
1470 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
1472 extern Lisp_Object Qintegerp
, Qnumberp
, Qnatnump
, Qwholenump
;
1473 extern Lisp_Object Qsymbolp
, Qlistp
, Qconsp
;
1474 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
1475 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qvectorp
;
1476 extern Lisp_Object Qinteger_or_marker_p
, Qnumber_or_marker_p
;
1477 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
1478 extern Lisp_Object Qboundp
, Qfboundp
;
1479 extern Lisp_Object Qbuffer_or_string_p
;
1480 extern Lisp_Object Qcdr
;
1482 #ifdef LISP_FLOAT_TYPE
1483 extern Lisp_Object Qfloatp
, Qinteger_or_floatp
, Qinteger_or_float_or_marker_p
;
1484 #endif /* LISP_FLOAT_TYPE */
1486 extern Lisp_Object Qframep
;
1494 EXFUN (Fintegerp
, 1);
1495 EXFUN (Fnatnump
, 1);
1496 EXFUN (Fsymbolp
, 1);
1497 EXFUN (Fvectorp
, 1);
1498 EXFUN (Fstringp
, 1);
1500 EXFUN (Fsequencep
, 1);
1501 EXFUN (Fbufferp
, 1);
1502 EXFUN (Fmarkerp
, 1);
1504 EXFUN (Fchar_or_string_p
, 1);
1505 EXFUN (Finteger_or_marker_p
, 1);
1506 #ifdef LISP_FLOAT_TYPE
1508 EXFUN (Finteger_or_floatp
, 1);
1509 EXFUN (Finteger_or_float_or_marker_p
, 1);
1510 #endif /* LISP_FLOAT_TYPE */
1513 EXFUN (Fcar_safe
, 1);
1515 EXFUN (Fcdr_safe
, 1);
1519 EXFUN (Ffboundp
, 1);
1520 EXFUN (Fmakunbound
, 1);
1521 EXFUN (Ffmakunbound
, 1);
1522 EXFUN (Fsymbol_function
, 1);
1523 EXFUN (Fsymbol_plist
, 1);
1524 EXFUN (Fsymbol_name
, 1);
1525 extern Lisp_Object indirect_function
P_ ((Lisp_Object
));
1526 EXFUN (Findirect_function
, 1);
1528 EXFUN (Fsetplist
, 2);
1529 EXFUN (Fsymbol_value
, 1);
1530 EXFUN (find_symbol_value
, 1);
1532 EXFUN (Fdefault_value
, 1);
1533 EXFUN (Fset_default
, 2);
1534 EXFUN (Fdefault_boundp
, 1);
1535 EXFUN (Fmake_local_variable
, 1);
1536 EXFUN (Flocal_variable_if_set_p
, 2);
1541 EXFUN (Fstring_to_number
, 2);
1542 EXFUN (Fnumber_to_string
, 1);
1543 EXFUN (Feqlsign
, 2);
1550 EXFUN (Fplus
, MANY
);
1551 EXFUN (Fminus
, MANY
);
1552 EXFUN (Ftimes
, MANY
);
1557 EXFUN (Flogand
, MANY
);
1558 EXFUN (Flogior
, MANY
);
1559 EXFUN (Flogxor
, MANY
);
1567 extern Lisp_Object long_to_cons
P_ ((unsigned long));
1568 extern unsigned long cons_to_long
P_ ((Lisp_Object
));
1569 extern void args_out_of_range
P_ ((Lisp_Object
, Lisp_Object
));
1570 extern void args_out_of_range_3
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1571 extern Lisp_Object wrong_type_argument
P_ ((Lisp_Object
, Lisp_Object
));
1572 extern void store_symval_forwarding
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1573 extern Lisp_Object do_symval_forwarding
P_ ((Lisp_Object
));
1575 /* Defined in cmds.c */
1576 EXFUN (Fend_of_line
, 1);
1577 EXFUN (Fforward_char
, 1);
1578 EXFUN (Fforward_line
, 1);
1580 /* Defined in coding.c */
1581 EXFUN (Fcoding_system_p
, 1);
1582 EXFUN (Fcheck_coding_system
, 1);
1583 EXFUN (Fread_coding_system
, 1);
1584 EXFUN (Fread_non_nil_coding_system
, 1);
1585 EXFUN (Ffind_coding_system
, MANY
);
1587 /* Defined in syntax.c */
1588 EXFUN (Fforward_word
, 1);
1589 EXFUN (Fskip_chars_forward
, 2);
1590 EXFUN (Fskip_chars_backward
, 2);
1592 /* Defined in fns.c */
1593 extern Lisp_Object Qstring_lessp
;
1594 extern Lisp_Object Vfeatures
;
1595 EXFUN (Fidentity
, 1);
1598 EXFUN (Fsafe_length
, 1);
1599 EXFUN (Fappend
, MANY
);
1600 EXFUN (Fconcat
, MANY
);
1601 EXFUN (Fvconcat
, MANY
);
1602 EXFUN (Fcopy_sequence
, 1);
1603 EXFUN (Fsubstring
, 3);
1614 EXFUN (Freverse
, 1);
1615 EXFUN (Fnreverse
, 1);
1619 EXFUN (Ffillarray
, 2);
1620 EXFUN (Fnconc
, MANY
);
1622 EXFUN (Fmapconcat
, 3);
1623 EXFUN (Fy_or_n_p
, 1);
1624 extern Lisp_Object do_yes_or_no_p
P_ ((Lisp_Object
));
1625 EXFUN (Ffeaturep
, 1);
1626 EXFUN (Frequire
, 2);
1627 EXFUN (Fprovide
, 1);
1628 extern Lisp_Object concat2
P_ ((Lisp_Object
, Lisp_Object
));
1629 extern Lisp_Object concat3
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1630 extern Lisp_Object nconc2
P_ ((Lisp_Object
, Lisp_Object
));
1631 extern Lisp_Object assq_no_quit
P_ ((Lisp_Object
, Lisp_Object
));
1632 EXFUN (Fcopy_alist
, 1);
1633 EXFUN (Fplist_get
, 2);
1634 EXFUN (Fset_char_table_parent
, 2);
1635 EXFUN (Fchar_table_extra_slot
, 2);
1637 EXFUN (Fstring_equal
, 2);
1638 EXFUN (Fstring_lessp
, 2);
1640 /* Defined in floatfns.c */
1641 #ifdef LISP_FLOAT_TYPE
1642 extern double extract_float
P_ ((Lisp_Object
));
1644 #endif /* LISP_FLOAT_TYPE */
1645 EXFUN (Ftruncate
, 2);
1647 /* Defined in insdel.c */
1648 extern void move_gap
P_ ((int));
1649 extern void make_gap
P_ ((int));
1650 extern void insert
P_ ((unsigned char *, int));
1651 extern void insert_and_inherit
P_ ((unsigned char *, int));
1652 extern void insert_1
P_ ((unsigned char *, int, int, int));
1653 extern void insert_from_string
P_ ((Lisp_Object
, int, int, int));
1654 extern void insert_from_buffer
P_ ((struct buffer
*, int, int, int));
1655 extern void insert_char
P_ ((int));
1656 extern void insert_string
P_ ((char *));
1657 extern void insert_before_markers
P_ ((unsigned char *, int));
1658 extern void insert_before_markers_and_inherit
P_ ((unsigned char *, int));
1659 extern void insert_from_string_before_markers
P_ ((Lisp_Object
, int, int, int));
1660 extern void del_range
P_ ((int, int));
1661 extern void del_range_1
P_ ((int, int, int));
1662 extern void modify_region
P_ ((struct buffer
*, int, int));
1663 extern void prepare_to_modify_buffer
P_ ((int, int, int *));
1664 extern void signal_before_change
P_ ((int, int, int *));
1665 extern void signal_after_change
P_ ((int, int, int));
1667 /* Defined in dispnew.c */
1669 EXFUN (Fredraw_display
, 0);
1670 EXFUN (Fsleep_for
, 2);
1671 EXFUN (Fsit_for
, 3);
1673 /* Defined in xdisp.c */
1674 extern Lisp_Object Vmessage_log_max
;
1675 extern void message
P_ ((/* char *, ... */));
1676 extern void message_nolog
P_ ((/* char *, ... */));
1677 extern void message1
P_ ((char *));
1678 extern void message1_nolog
P_ ((char *));
1679 extern void message2
P_ ((char *, int));
1680 extern void message2_nolog
P_ ((char *, int));
1681 extern void message_dolog
P_ ((char *, int, int));
1682 extern void message_log_maybe_newline
P_ ((void));
1684 /* Defined in alloc.c */
1685 extern Lisp_Object Vpurify_flag
;
1687 EXFUN (Flist
, MANY
);
1688 EXFUN (Fmake_list
, 2);
1689 extern Lisp_Object allocate_misc
P_ ((void));
1690 EXFUN (Fmake_vector
, 2);
1691 EXFUN (Fvector
, MANY
);
1692 EXFUN (Fmake_symbol
, 1);
1693 EXFUN (Fmake_marker
, 0);
1694 EXFUN (Fmake_string
, 2);
1695 extern Lisp_Object build_string
P_ ((char *));
1696 extern Lisp_Object make_string
P_ ((char *, int));
1697 extern Lisp_Object make_event_array
P_ ((int, Lisp_Object
*));
1698 extern Lisp_Object make_uninit_string
P_ ((int));
1699 EXFUN (Fpurecopy
, 1);
1700 extern Lisp_Object make_pure_string
P_ ((char *, int));
1701 extern Lisp_Object pure_cons
P_ ((Lisp_Object
, Lisp_Object
));
1702 extern Lisp_Object make_pure_vector
P_ ((EMACS_INT
));
1703 EXFUN (Fgarbage_collect
, 0);
1704 EXFUN (Fmake_byte_code
, MANY
);
1705 EXFUN (Fmake_bool_vector
, 2);
1706 EXFUN (Fmake_char_table
, 2);
1707 extern Lisp_Object make_sub_char_table
P_ ((Lisp_Object
));
1708 extern Lisp_Object Qchar_table_extra_slots
;
1709 extern struct Lisp_Vector
*allocate_vectorlike
P_ ((EMACS_INT
));
1710 extern int gc_in_progress
;
1711 #ifdef LISP_FLOAT_TYPE
1712 extern Lisp_Object make_float
P_ ((double));
1713 #endif /* LISP_FLOAT_TYPE */
1715 /* Defined in print.c */
1716 extern Lisp_Object Vprin1_to_string_buffer
;
1718 EXFUN (Fprin1_to_string
, 2);
1722 EXFUN (Ferror_message_string
, 1);
1723 extern Lisp_Object Vstandard_output
, Qstandard_output
;
1724 extern Lisp_Object Qexternal_debugging_output
;
1725 extern void temp_output_buffer_setup
P_ ((char *));
1726 extern int print_level
, print_escape_newlines
;
1727 extern Lisp_Object Qprint_escape_newlines
;
1729 /* Defined in lread.c */
1730 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
1731 extern Lisp_Object Vobarray
, Vstandard_input
;
1733 EXFUN (Fread_from_string
, 3);
1735 EXFUN (Fintern_soft
, 2);
1737 EXFUN (Fget_file_char
, 0);
1738 EXFUN (Fread_char
, 0);
1739 extern Lisp_Object read_filtered_event
P_ ((int, int, int));
1740 EXFUN (Feval_region
, 3);
1741 extern Lisp_Object intern
P_ ((char *));
1742 extern Lisp_Object make_symbol
P_ ((char *));
1743 extern Lisp_Object oblookup
P_ ((Lisp_Object
, char *, int));
1744 #define LOADHIST_ATTACH(x) \
1745 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
1746 extern Lisp_Object Vcurrent_load_list
;
1747 extern Lisp_Object Vload_history
;
1749 /* Defined in eval.c */
1750 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
, Qmacro
;
1751 extern Lisp_Object Vinhibit_quit
, Qinhibit_quit
, Vquit_flag
;
1752 extern Lisp_Object Vmocklisp_arguments
, Qmocklisp
, Qmocklisp_arguments
;
1753 extern Lisp_Object Vautoload_queue
;
1754 extern Lisp_Object Vdebug_on_error
;
1755 /* To run a normal hook, use the appropriate function from the list below.
1756 The calling convention:
1758 if (!NILP (Vrun_hooks))
1759 call1 (Vrun_hooks, Qmy_funny_hook);
1761 should no longer be used. */
1762 extern Lisp_Object Vrun_hooks
;
1763 EXFUN (Frun_hooks
, MANY
);
1764 EXFUN (Frun_hook_with_args
, MANY
);
1765 EXFUN (Frun_hook_with_args_until_success
, MANY
);
1766 EXFUN (Frun_hook_with_args_until_failure
, MANY
);
1767 EXFUN (Fand
, UNEVALLED
);
1768 EXFUN (For
, UNEVALLED
);
1769 EXFUN (Fif
, UNEVALLED
);
1770 EXFUN (Fprogn
, UNEVALLED
);
1771 EXFUN (Fprog1
, UNEVALLED
);
1772 EXFUN (Fprog2
, UNEVALLED
);
1773 EXFUN (Fsetq
, UNEVALLED
);
1774 EXFUN (Fquote
, UNEVALLED
);
1775 EXFUN (Fuser_variable_p
, 1);
1776 EXFUN (Finteractive_p
, 0);
1777 EXFUN (Fdefun
, UNEVALLED
);
1778 EXFUN (Flet
, UNEVALLED
);
1779 EXFUN (FletX
, UNEVALLED
);
1780 EXFUN (Fwhile
, UNEVALLED
);
1781 EXFUN (Fcatch
, UNEVALLED
);
1783 EXFUN (Funwind_protect
, UNEVALLED
);
1784 EXFUN (Fcondition_case
, UNEVALLED
);
1786 EXFUN (Fautoload
, 5);
1787 EXFUN (Fcommandp
, 1);
1789 EXFUN (Fapply
, MANY
);
1790 EXFUN (Ffuncall
, MANY
);
1791 EXFUN (Fbacktrace
, 0);
1792 extern Lisp_Object apply1
P_ ((Lisp_Object
, Lisp_Object
));
1793 extern Lisp_Object call0
P_ ((Lisp_Object
));
1794 extern Lisp_Object call1
P_ ((Lisp_Object
, Lisp_Object
));
1795 extern Lisp_Object call2
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1796 extern Lisp_Object call3
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
));
1797 extern Lisp_Object call4
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
));
1798 extern Lisp_Object call5
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
));
1799 extern Lisp_Object call6
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
));
1800 EXFUN (Fdo_auto_save
, 2);
1801 extern Lisp_Object apply_lambda
P_ ((Lisp_Object
, Lisp_Object
, int));
1802 extern Lisp_Object internal_catch
P_ ((Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
));
1803 extern Lisp_Object internal_condition_case
P_ ((Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
)));
1804 extern Lisp_Object internal_condition_case_1
P_ ((Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
)));
1805 extern Lisp_Object unbind_to
P_ ((int, Lisp_Object
));
1806 extern void error
P_ ((/* char *, ... */));
1807 extern Lisp_Object un_autoload
P_ ((Lisp_Object
));
1808 EXFUN (Ffetch_bytecode
, 1);
1810 /* Defined in editfns.c */
1811 EXFUN (Fgoto_char
, 1);
1812 EXFUN (Fpoint_min_marker
, 0);
1813 EXFUN (Fpoint_max_marker
, 0);
1814 EXFUN (Fpoint_min
, 0);
1815 EXFUN (Fpoint_max
, 0);
1817 EXFUN (Fpoint_marker
, 0);
1818 EXFUN (Fmark_marker
, 0);
1819 EXFUN (Fline_beginning_position
, 1);
1820 EXFUN (Fline_end_position
, 1);
1821 EXFUN (Ffollowing_char
, 0);
1822 EXFUN (Fprevious_char
, 0);
1823 EXFUN (Fchar_after
, 1);
1824 EXFUN (Finsert
, MANY
);
1825 EXFUN (Finsert_and_inherit
, MANY
);
1826 EXFUN (Finsert_before_markers
, MANY
);
1827 EXFUN (Finsert_buffer_substring
, 3);
1828 EXFUN (Finsert_char
, 3);
1833 EXFUN (Fformat
, MANY
);
1834 extern Lisp_Object format1
P_ ((/* char *, ... */));
1835 extern Lisp_Object make_buffer_string
P_ ((int, int, int));
1836 EXFUN (Fbuffer_substring
, 2);
1837 EXFUN (Fbuffer_string
, 0);
1838 extern Lisp_Object save_excursion_save
P_ ((void));
1839 extern Lisp_Object save_restriction_save
P_ ((void));
1840 extern Lisp_Object save_excursion_restore
P_ ((Lisp_Object
));
1841 extern Lisp_Object save_restriction_restore
P_ ((Lisp_Object
));
1842 EXFUN (Fchar_to_string
, 1);
1843 EXFUN (Fdelete_region
, 2);
1844 EXFUN (Fnarrow_to_region
, 2);
1846 EXFUN (Fuser_login_name
, 1);
1847 EXFUN (Fsystem_name
, 0);
1849 /* defined in buffer.c */
1850 EXFUN (Foverlay_start
, 1);
1851 EXFUN (Foverlay_end
, 1);
1852 extern void adjust_overlays_for_insert
P_ ((int, int));
1853 extern void adjust_overlays_for_delete
P_ ((int, int));
1854 extern void fix_overlays_in_range
P_ ((int, int));
1855 extern int overlay_touches_p
P_ ((int));
1856 extern Lisp_Object Vbuffer_alist
, Vinhibit_read_only
;
1857 EXFUN (Fget_buffer
, 1);
1858 EXFUN (Fget_buffer_create
, 1);
1859 EXFUN (Fset_buffer
, 1);
1860 EXFUN (Fbarf_if_buffer_read_only
, 0);
1861 EXFUN (Fcurrent_buffer
, 0);
1862 EXFUN (Fswitch_to_buffer
, 2);
1863 EXFUN (Fpop_to_buffer
, 3);
1864 EXFUN (Fother_buffer
, 2);
1865 EXFUN (Foverlay_get
, 2);
1866 EXFUN (Fbuffer_modified_p
, 1);
1867 EXFUN (Fset_buffer_modified_p
, 1);
1868 EXFUN (Fkill_buffer
, 1);
1869 EXFUN (Fkill_all_local_variables
, 0);
1870 EXFUN (Fbuffer_disable_undo
, 1);
1871 EXFUN (Fbuffer_enable_undo
, 1);
1872 EXFUN (Ferase_buffer
, 0);
1873 extern Lisp_Object Qoverlayp
;
1874 extern Lisp_Object get_truename_buffer
P_ ((Lisp_Object
));
1875 extern struct buffer
*all_buffers
;
1876 EXFUN (Fprevious_overlay_change
, 1);
1878 /* defined in marker.c */
1880 EXFUN (Fmarker_position
, 1);
1881 EXFUN (Fmarker_buffer
, 1);
1882 EXFUN (Fcopy_marker
, 2);
1883 EXFUN (Fset_marker
, 3);
1885 /* Defined in fileio.c */
1887 extern Lisp_Object Qfile_error
;
1888 EXFUN (Ffind_file_name_handler
, 2);
1889 EXFUN (Ffile_name_as_directory
, 1);
1890 EXFUN (Fexpand_file_name
, 2);
1891 EXFUN (Ffile_name_nondirectory
, 1);
1892 EXFUN (Fsubstitute_in_file_name
, 1);
1893 EXFUN (Ffile_symlink_p
, 1);
1894 EXFUN (Fverify_visited_file_modtime
, 1);
1895 EXFUN (Ffile_exists_p
, 1);
1896 EXFUN (Ffile_name_absolute_p
, 1);
1897 EXFUN (Fdirectory_file_name
, 1);
1898 EXFUN (Ffile_name_directory
, 1);
1899 extern Lisp_Object expand_and_dir_to_file
P_ ((Lisp_Object
, Lisp_Object
));
1900 EXFUN (Ffile_accessible_directory_p
, 1);
1901 EXFUN (Funhandled_file_name_directory
, 1);
1902 EXFUN (Ffile_directory_p
, 1);
1903 EXFUN (Fwrite_region
, 6);
1904 EXFUN (Ffile_readable_p
, 1);
1905 EXFUN (Ffile_executable_p
, 1);
1906 EXFUN (Fread_file_name
, 5);
1908 /* Defined in abbrev.c */
1910 extern Lisp_Object Vfundamental_mode_abbrev_table
;
1912 /* defined in search.c */
1913 EXFUN (Fstring_match
, 3);
1914 extern void restore_match_data
P_ ((void));
1915 EXFUN (Fmatch_data
, 2);
1916 EXFUN (Fstore_match_data
, 1);
1917 EXFUN (Fmatch_beginning
, 1);
1918 EXFUN (Fmatch_end
, 1);
1920 /* defined in minibuf.c */
1922 extern Lisp_Object last_minibuf_string
;
1923 EXFUN (Fcompleting_read
, 7);
1924 EXFUN (Fread_from_minibuffer
, 6);
1925 EXFUN (Fread_variable
, 2);
1926 EXFUN (Fread_buffer
, 3);
1927 EXFUN (Fread_minibuffer
, 2);
1928 EXFUN (Feval_minibuffer
, 2);
1929 EXFUN (Fread_string
, 4);
1930 EXFUN (Fread_no_blanks_input
, 2);
1931 extern Lisp_Object get_minibuffer
P_ ((int));
1933 /* Defined in callint.c */
1935 extern Lisp_Object Qminus
, Qplus
, Vcurrent_prefix_arg
;
1936 extern Lisp_Object Vcommand_history
;
1937 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
1938 EXFUN (Fcall_interactively
, 3);
1939 EXFUN (Fprefix_numeric_value
, 1);
1941 /* defined in casefiddle.c */
1943 EXFUN (Fdowncase
, 1);
1945 EXFUN (Fcapitalize
, 1);
1946 EXFUN (Fupcase_region
, 2);
1947 EXFUN (Fupcase_initials
, 1);
1948 EXFUN (Fupcase_initials_region
, 2);
1950 /* defined in casetab.c */
1952 EXFUN (Fset_case_table
, 1);
1953 EXFUN (Fset_standard_case_table
, 1);
1955 /* defined in keyboard.c */
1957 extern Lisp_Object Qdisabled
;
1958 extern Lisp_Object Vtty_erase_char
, Vhelp_form
, Vtop_level
;
1959 EXFUN (Fdiscard_input
, 0);
1960 EXFUN (Frecursive_edit
, 0);
1961 EXFUN (Fcommand_execute
, 4);
1962 EXFUN (Finput_pending_p
, 0);
1963 extern Lisp_Object menu_bar_items
P_ ((Lisp_Object
));
1964 extern Lisp_Object Qvertical_scroll_bar
;
1965 EXFUN (Fevent_convert_list
, 1);
1967 extern void delete_kboard
P_ ((/* KBOARD * */));
1969 EXFUN (Fread_key_sequence
, 4);
1971 /* defined in keymap.c */
1973 extern Lisp_Object Qkeymap
, Qmenu_bar
;
1974 extern Lisp_Object current_global_map
;
1975 EXFUN (Fdefine_key
, 3);
1976 EXFUN (Fkey_binding
, 2);
1977 EXFUN (Fkey_description
, 1);
1978 EXFUN (Fsingle_key_description
, 1);
1979 EXFUN (Fwhere_is_internal
, 4);
1980 extern Lisp_Object access_keymap
P_ ((Lisp_Object
, Lisp_Object
, int, int));
1981 extern Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1982 extern Lisp_Object get_keyelt
P_ ((Lisp_Object
, int));
1983 extern Lisp_Object get_keymap
P_ ((Lisp_Object
));
1984 extern Lisp_Object get_keymap_1
P_ ((Lisp_Object
, int, int));
1985 extern void describe_map_tree
P_ ((Lisp_Object
, int, Lisp_Object
, Lisp_Object
, char *, int, int, int));
1987 /* defined in indent.c */
1988 EXFUN (Fvertical_motion
, 2);
1989 EXFUN (Findent_to
, 2);
1990 EXFUN (Fcurrent_column
, 0);
1991 EXFUN (Fmove_to_column
, 2);
1993 /* defined in window.c */
1994 extern Lisp_Object Qwindowp
, Qwindow_live_p
;
1995 EXFUN (Fselected_window
, 0);
1996 EXFUN (Fget_buffer_window
, 2);
1997 EXFUN (Fsave_window_excursion
, UNEVALLED
);
1998 EXFUN (Fset_window_configuration
, 1);
1999 EXFUN (Fcurrent_window_configuration
, 1);
2000 EXFUN (Fcoordinates_in_window_p
, 2);
2001 EXFUN (Fwindow_at
, 3);
2002 EXFUN (Fpos_visible_in_window_p
, 2);
2003 extern int window_internal_height
P_ ((/* struct window * */));
2004 extern int window_internal_width
P_ ((/* struct window * */));
2005 EXFUN (Frecenter
, 1);
2006 EXFUN (Fscroll_other_window
, 1);
2007 EXFUN (Fset_window_start
, 3);
2008 extern void temp_output_buffer_show
P_ ((Lisp_Object
));
2010 /* defined in frame.c */
2011 extern Lisp_Object Qvisible
;
2012 extern void store_frame_param
P_ ((/* struct frame *, Lisp_Object, Lisp_Object */));
2013 extern void store_in_alist
P_ ((Lisp_Object
*, Lisp_Object
, Lisp_Object
));
2014 extern Lisp_Object do_switch_frame
P_ ((Lisp_Object
, Lisp_Object
, int));
2015 extern Lisp_Object get_frame_param
P_ ((/* struct frame *, Lisp_Object */));
2016 extern Lisp_Object frame_buffer_predicate
P_ ((void));
2018 EXFUN (Fselect_frame
, 2);
2019 EXFUN (Fselected_frame
, 0);
2020 EXFUN (Fwindow_frame
, 1);
2021 EXFUN (Fframe_root_window
, 1);
2022 EXFUN (Fframe_first_window
, 1);
2023 EXFUN (Fframe_selected_window
, 1);
2024 EXFUN (Fframe_list
, 0);
2025 EXFUN (Fnext_frame
, 2);
2026 EXFUN (Fdelete_frame
, 2);
2027 EXFUN (Fset_mouse_position
, 3);
2028 EXFUN (Fmake_frame_visible
, 1);
2029 EXFUN (Fmake_frame_invisible
, 2);
2030 EXFUN (Ficonify_frame
, 1);
2031 EXFUN (Fframe_visible_p
, 1);
2032 EXFUN (Fvisible_frame_list
, 0);
2033 EXFUN (Fframe_parameters
, 1);
2034 EXFUN (Fmodify_frame_parameters
, 2);
2035 EXFUN (Fset_frame_height
, 3);
2036 EXFUN (Fset_frame_width
, 3);
2037 EXFUN (Fset_frame_size
, 3);
2038 EXFUN (Fset_frame_position
, 3);
2039 EXFUN (Fraise_frame
, 1);
2040 EXFUN (Fredirect_frame_focus
, 2);
2041 extern Lisp_Object frame_buffer_list
P_ ((void));
2043 /* defined in emacs.c */
2044 extern Lisp_Object decode_env_path
P_ ((char *, char *));
2045 extern Lisp_Object Vinvocation_name
, Vinvocation_directory
;
2046 extern Lisp_Object Vinstallation_directory
;
2047 EXFUN (Fkill_emacs
, 1);
2048 void shut_down_emacs
P_ ((int, int, Lisp_Object
));
2049 /* Nonzero means don't do interactive redisplay and don't change tty modes */
2050 extern int noninteractive
;
2051 /* Nonzero means don't do use window-system-specific display code */
2052 extern int inhibit_window_system
;
2053 /* Nonzero means that a filter or a sentinel is running. */
2054 extern int running_asynch_code
;
2056 /* defined in process.c */
2057 EXFUN (Fget_process
, 1);
2058 EXFUN (Fget_buffer_process
, 1);
2059 EXFUN (Fprocessp
, 1);
2060 EXFUN (Fprocess_status
, 1);
2061 EXFUN (Fkill_process
, 2);
2062 EXFUN (Fprocess_send_eof
, 1);
2063 EXFUN (Fwaiting_for_user_input_p
, 0);
2064 extern Lisp_Object Qprocessp
;
2066 /* defined in callproc.c */
2067 extern Lisp_Object Vexec_path
, Vexec_directory
, Vdata_directory
;
2068 extern Lisp_Object Vdoc_directory
;
2070 /* defined in doc.c */
2071 extern Lisp_Object Vdoc_file_name
;
2072 EXFUN (Fsubstitute_command_keys
, 1);
2073 EXFUN (Fdocumentation
, 2);
2074 EXFUN (Fdocumentation_property
, 3);
2075 extern Lisp_Object read_doc_string
P_ ((Lisp_Object
));
2077 /* defined in bytecode.c */
2078 extern Lisp_Object Qbytecode
;
2079 EXFUN (Fbyte_code
, 3);
2081 /* defined in macros.c */
2082 extern Lisp_Object Qexecute_kbd_macro
;
2083 EXFUN (Fexecute_kbd_macro
, 2);
2085 /* defined in undo.c */
2086 extern Lisp_Object Qinhibit_read_only
;
2087 EXFUN (Fundo_boundary
, 0);
2088 extern Lisp_Object truncate_undo_list
P_ ((Lisp_Object
, int, int));
2090 /* defined in textprop.c */
2091 extern Lisp_Object Qmodification_hooks
;
2092 extern Lisp_Object Qrear_nonsticky
, Qfont
;
2093 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
2094 EXFUN (Fnext_property_change
, 3);
2095 EXFUN (Fnext_single_property_change
, 4);
2096 EXFUN (Fprevious_single_property_change
, 4);
2097 EXFUN (Fget_text_property
, 3);
2098 EXFUN (Fput_text_property
, 5);
2099 EXFUN (Fset_text_properties
, 4);
2100 EXFUN (Ftext_property_not_all
, 5);
2101 EXFUN (Fprevious_char_property_change
, 2);
2102 EXFUN (Fnext_char_property_change
, 2);
2104 /* defined in intervals.c */
2105 extern Lisp_Object get_local_map
P_ ((int, struct buffer
*));
2107 /* defined in xmenu.c */
2108 EXFUN (Fx_popup_menu
, 2);
2109 EXFUN (Fx_popup_dialog
, 2);
2111 /* Nonzero means Emacs has already been initialized.
2112 Used during startup to detect startup of dumped Emacs. */
2113 extern int initialized
;
2115 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
2117 extern void debugger ();
2119 extern char *getenv (), *ctime (), *getwd ();
2120 extern long *xmalloc (), *xrealloc ();
2121 extern void xfree ();
2123 extern char *egetenv ();
2125 /* Set up the name of the machine we're running on. */
2126 extern void init_system_name ();
2128 /* Some systems (e.g., NT) use a different path separator than Unix,
2129 in addition to a device separator. Default the path separator
2130 to '/', and don't test for a device separator in IS_ANY_SEP. */
2133 extern Lisp_Object Vdirectory_sep_char
;
2136 #ifndef DIRECTORY_SEP
2137 #define DIRECTORY_SEP '/'
2139 #ifndef IS_DIRECTORY_SEP
2140 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
2142 #ifndef IS_DEVICE_SEP
2144 #define IS_DEVICE_SEP(_c_) 0
2146 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
2150 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
2153 #ifdef SWITCH_ENUM_BUG
2154 #define SWITCH_ENUM_CAST(x) ((int)(x))
2156 #define SWITCH_ENUM_CAST(x) (x)