1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985,86,87,93,94,95,97,98,1999,2000, 2001, 2002
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* Declare the prototype for a general external function. */
23 #if defined (PROTOTYPES) || defined (WINDOWSNT)
24 #define P_(proto) proto
30 /* Define this temporarily to hunt a bug. If defined, the size of
31 strings is redundantly recorded in sdata structures so that it can
32 be compared to the sizes recorded in Lisp strings. */
34 #define GC_CHECK_STRING_BYTES 1
38 /* These are default choices for the types to use. */
41 #define EMACS_INT long
42 #define BITS_PER_EMACS_INT BITS_PER_LONG
45 #define EMACS_UINT unsigned long
50 #define BITS_PER_EMACS_INT BITS_PER_INT
53 #define EMACS_UINT unsigned int
57 /* Extra internal type checking? */
58 extern int suppress_checking
;
59 extern void die
P_((const char *, const char *, int));
61 #ifdef ENABLE_CHECKING
63 #define CHECK(check,msg) ((check || suppress_checking \
65 : die (msg, __FILE__, __LINE__)), \
68 /* Let's get some compile-time checking too. */
73 /* Produce same side effects and result, but don't complain. */
74 #define CHECK(check,msg) ((check),0)
78 /* Used for making sure that Emacs is compilable in all
81 #ifdef USE_LISP_UNION_TYPE
85 /* Define an Emacs version of "assert", since some system ones are
87 #ifndef ENABLE_CHECKING
88 #define eassert(X) (void) 0
89 #else /* ENABLE_CHECKING */
90 #if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
91 #define eassert(cond) CHECK(cond,"assertion failed: " #cond)
93 #define eassert(cond) CHECK(cond,"assertion failed")
95 #endif /* ENABLE_CHECKING */
97 /* Define the fundamental Lisp data structures. */
99 /* This is the set of Lisp data types. */
103 /* Integer. XINT (obj) is the integer value. */
106 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
109 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
110 whose first member indicates the subtype. */
113 /* String. XSTRING (object) points to a struct Lisp_String.
114 The length of the string, and its contents, are stored therein. */
117 /* Vector of Lisp objects, or something resembling it.
118 XVECTOR (object) points to a struct Lisp_Vector, which contains
119 the size and contents. The size field also contains the type
120 information, if it's not a real vector object. */
123 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
128 /* This is not a type code. It is for range checking. */
132 /* This is the set of data types that share a common structure.
133 The first member of the structure is a type code from this set.
134 The enum values are arbitrary, but we'll use large numbers to make it
135 more likely that we'll spot the error if a random word in memory is
136 mistakenly interpreted as a Lisp_Misc. */
139 Lisp_Misc_Free
= 0x5eab,
144 Lisp_Misc_Buffer_Objfwd
,
145 Lisp_Misc_Buffer_Local_Value
,
146 Lisp_Misc_Some_Buffer_Local_Value
,
148 Lisp_Misc_Kboard_Objfwd
,
149 /* Currently floats are not a misc type,
150 but let's define this in case we want to change that. */
152 /* This is not a type code. It is for range checking. */
156 /* These values are overridden by the m- file on some machines. */
158 #define VALBITS (BITS_PER_EMACS_INT - 4)
165 #ifndef NO_UNION_TYPE
167 #ifndef WORDS_BIG_ENDIAN
169 /* Definition of Lisp_Object for little-endian machines. */
174 /* Used for comparing two Lisp_Objects;
175 also, positive integers can be accessed fast this way. */
180 EMACS_INT val
: VALBITS
;
181 EMACS_INT type
: GCTYPEBITS
+ 1;
185 EMACS_UINT val
: VALBITS
;
186 EMACS_INT type
: GCTYPEBITS
+ 1;
190 EMACS_UINT val
: VALBITS
;
191 enum Lisp_Type type
: GCTYPEBITS
;
192 /* The markbit is not really part of the value of a Lisp_Object,
193 and is always zero except during garbage collection. */
194 EMACS_UINT markbit
: 1;
199 #else /* If WORDS_BIG_ENDIAN */
204 /* Used for comparing two Lisp_Objects;
205 also, positive integers can be accessed fast this way. */
210 EMACS_INT type
: GCTYPEBITS
+1;
211 EMACS_INT val
: VALBITS
;
215 EMACS_INT type
: GCTYPEBITS
+1;
216 EMACS_UINT val
: VALBITS
;
220 /* The markbit is not really part of the value of a Lisp_Object,
221 and is always zero except during garbage collection. */
222 EMACS_UINT markbit
: 1;
223 enum Lisp_Type type
: GCTYPEBITS
;
224 EMACS_UINT val
: VALBITS
;
229 #endif /* WORDS_BIG_ENDIAN */
232 static __inline__ Lisp_Object
233 LISP_MAKE_RVALUE (Lisp_Object o
)
238 /* This isn't quite right - it keeps the argument as an lvalue.
239 Making it const via casting would help avoid code actually
240 modifying the location in question, but the casting could cover
241 other type-related bugs. */
242 #define LISP_MAKE_RVALUE(o) (o)
245 #endif /* NO_UNION_TYPE */
248 /* If union type is not wanted, define Lisp_Object as just a number. */
251 #define Lisp_Object EMACS_INT
252 #define LISP_MAKE_RVALUE(o) (0+(o))
253 #endif /* NO_UNION_TYPE */
256 #define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
258 #define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
260 /* Two flags that are set during GC. On some machines, these flags
261 are defined differently by the m- file. */
263 /* This is set in the car of a cons and in the plist slot of a symbol
264 to indicate it is marked. Likewise in the plist slot of an interval,
265 the chain slot of a marker, the type slot of a float, and the name
268 In strings, this bit in the size field indicates that the string
269 is a "large" one, one which was separately malloc'd
270 rather than being part of a string block. */
273 #define MARKBIT ((EMACS_INT) ((EMACS_UINT) 1 << (VALBITS + GCTYPEBITS)))
276 /* In the size word of a vector, this bit means the vector has been marked.
277 In the size word of a large string, likewise. */
279 #ifndef ARRAY_MARK_FLAG
280 #define ARRAY_MARK_FLAG ((MARKBIT >> 1) & ~MARKBIT)
281 #endif /* no ARRAY_MARK_FLAG */
283 /* In the size word of a struct Lisp_Vector, this bit means it's really
284 some other vector-like object. */
285 #ifndef PSEUDOVECTOR_FLAG
286 #define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1) & ~ARRAY_MARK_FLAG)
289 /* In a pseudovector, the size field actually contains a word with one
290 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
291 indicate the actual type. */
294 PVEC_NORMAL_VECTOR
= 0,
295 PVEC_PROCESS
= 0x200,
297 PVEC_COMPILED
= 0x800,
298 PVEC_WINDOW
= 0x1000,
299 PVEC_WINDOW_CONFIGURATION
= 0x2000,
301 PVEC_CHAR_TABLE
= 0x8000,
302 PVEC_BOOL_VECTOR
= 0x10000,
303 PVEC_BUFFER
= 0x20000,
304 PVEC_HASH_TABLE
= 0x40000,
305 PVEC_TYPE_MASK
= 0x7fe00
307 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
308 GDB. It doesn't work on OS Alpha. Moved to a variable in
310 PVEC_FLAG
= PSEUDOVECTOR_FLAG
314 /* For convenience, we also store the number of elements in these bits. */
315 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
317 /* These macros extract various sorts of values from a Lisp_Object.
318 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
319 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
323 /* One need to override this if there must be high bits set in data space
324 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
325 on all machines, but would penalize machines which don't need it)
328 #define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
332 #define XSETTYPE(a, b) ((a) = XUINT (a) | ((EMACS_INT)(b) << VALBITS))
335 /* For integers known to be positive, XFASTINT provides fast retrieval
336 and XSETFASTINT provides fast storage. This takes advantage of the
337 fact that Lisp_Int is 0. */
338 #define XFASTINT(a) ((a) + 0)
339 #define XSETFASTINT(a, b) ((a) = (b))
341 /* Extract the value of a Lisp_Object as a signed integer. */
343 #ifndef XINT /* Some machines need to do this differently. */
344 #define XINT(a) ((EMACS_INT) (((a) << (BITS_PER_EMACS_INT - VALBITS)) \
345 >> (BITS_PER_EMACS_INT - VALBITS)))
348 /* Extract the value as an unsigned integer. This is a basis
349 for extracting it as a pointer to a structure in storage. */
352 #define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
357 /* In this representation, data is found in two widely separated segments. */
358 extern size_t pure_size
;
360 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
361 #else /* not HAVE_SHM */
363 /* This case is used for the rt-pc.
364 In the diffs I was given, it checked for ptr = 0
365 and did not adjust it in that case.
366 But I don't think that zero should ever be found
367 in a Lisp object whose data type says it points to something. */
368 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
370 #define XPNTR(a) XUINT (a)
372 #endif /* not HAVE_SHM */
373 #endif /* no XPNTR */
376 #define XSET(var, type, ptr) \
377 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
380 /* Convert a C integer into a Lisp_Object integer. */
382 #define make_number(N) \
383 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
385 /* During garbage collection, XGCTYPE must be used for extracting types
386 so that the mark bit is ignored. XMARKBIT accesses the markbit.
387 Markbits are used only in particular slots of particular structure types.
388 Other markbits are always zero.
389 Outside of garbage collection, all mark bits are always zero. */
392 #define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
395 #if VALBITS + GCTYPEBITS == BITS_PER_EMACS_INT - 1
396 /* Make XMARKBIT faster if mark bit is sign bit. */
398 #define XMARKBIT(a) ((a) < 0)
400 #endif /* markbit is sign bit */
403 #define XMARKBIT(a) ((a) & MARKBIT)
407 #define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
411 #define XMARK(a) ((a) |= MARKBIT)
415 #define XUNMARK(a) ((a) &= ~MARKBIT)
418 #endif /* NO_UNION_TYPE */
420 #ifndef NO_UNION_TYPE
422 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
423 #define XSETTYPE(a, b) ((a).u.type = (char) (b))
425 /* For integers known to be positive, XFASTINT provides fast retrieval
426 and XSETFASTINT provides fast storage. This takes advantage of the
427 fact that Lisp_Int is 0. */
428 #define XFASTINT(a) ((a).i + 0)
429 #define XSETFASTINT(a, b) ((a).i = (b))
431 #ifdef EXPLICIT_SIGN_EXTEND
432 /* Make sure we sign-extend; compilers have been known to fail to do so. */
433 #define XINT(a) (((a).i << (BITS_PER_EMACS_INT - VALBITS)) \
434 >> (BITS_PER_EMACS_INT - VALBITS))
436 #define XINT(a) ((a).s.val)
437 #endif /* EXPLICIT_SIGN_EXTEND */
439 #define XUINT(a) ((a).u.val)
440 #define XPNTR(a) ((a).u.val)
442 #define XSET(var, vartype, ptr) \
443 (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
445 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
446 #define make_number(N) \
447 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
449 extern Lisp_Object
make_number ();
452 /* During garbage collection, XGCTYPE must be used for extracting types
453 so that the mark bit is ignored. XMARKBIT access the markbit.
454 Markbits are used only in particular slots of particular structure types.
455 Other markbits are always zero.
456 Outside of garbage collection, all mark bits are always zero. */
458 #define XGCTYPE(a) ((a).gu.type)
459 #define XMARKBIT(a) ((a).gu.markbit)
460 #define XSETMARKBIT(a,b) (XMARKBIT(a) = (b))
461 #define XMARK(a) (XMARKBIT(a) = 1)
462 #define XUNMARK(a) (XMARKBIT(a) = 0)
464 #endif /* NO_UNION_TYPE */
466 /* Largest and smallest representable fixnum values. These are the C
469 #define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << (VALBITS - 1))
470 #define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << (VALBITS - 1)) - 1)
472 /* Value is non-zero if C integer I doesn't fit into a Lisp fixnum. */
474 #define FIXNUM_OVERFLOW_P(i) \
475 ((EMACS_INT)(i) > MOST_POSITIVE_FIXNUM \
476 || (EMACS_INT) (i) < MOST_NEGATIVE_FIXNUM)
478 /* Extract a value or address from a Lisp_Object. */
480 #define XCONS(a) (eassert (GC_CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
481 #define XVECTOR(a) (eassert (GC_VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
482 #define XSTRING(a) (eassert (GC_STRINGP(a)),(struct Lisp_String *) XPNTR(a))
483 #define XSYMBOL(a) (eassert (GC_SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
484 #define XFLOAT(a) (eassert (GC_FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
488 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
489 #define XMISCTYPE(a) (XMARKER (a)->type)
490 #define XMARKER(a) (&(XMISC(a)->u_marker))
491 #define XINTFWD(a) (&(XMISC(a)->u_intfwd))
492 #define XBOOLFWD(a) (&(XMISC(a)->u_boolfwd))
493 #define XOBJFWD(a) (&(XMISC(a)->u_objfwd))
494 #define XBUFFER_OBJFWD(a) (&(XMISC(a)->u_buffer_objfwd))
495 #define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
496 #define XOVERLAY(a) (&(XMISC(a)->u_overlay))
497 #define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
499 /* Pseudovector types. */
501 #define XPROCESS(a) (eassert (GC_PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
502 #define XWINDOW(a) (eassert (GC_WINDOWP(a)),(struct window *) XPNTR(a))
503 #define XSUBR(a) (eassert (GC_SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
504 #define XBUFFER(a) (eassert (GC_BUFFERP(a)),(struct buffer *) XPNTR(a))
505 #define XCHAR_TABLE(a) ((struct Lisp_Char_Table *) XPNTR(a))
506 #define XBOOL_VECTOR(a) ((struct Lisp_Bool_Vector *) XPNTR(a))
508 /* Construct a Lisp_Object from a value or address. */
510 #define XSETINT(a, b) XSET (a, Lisp_Int, b)
511 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
512 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
513 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
514 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
515 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
519 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
520 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
522 /* Pseudovector types. */
524 #define XSETPSEUDOVECTOR(a, b, code) \
525 (XSETVECTOR (a, b), XVECTOR (a)->size |= PSEUDOVECTOR_FLAG | (code))
526 #define XSETWINDOW_CONFIGURATION(a, b) \
527 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
528 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
529 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
530 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
531 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
532 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
533 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
534 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
536 /* Convenience macros for dealing with Lisp arrays. */
538 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
539 #define ASET(ARRAY, IDX, VAL) (AREF ((ARRAY), (IDX)) = (VAL))
540 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->size
542 /* Convenience macros for dealing with Lisp strings. */
544 #define SREF(string, index) (XSTRING (string)->data[index] + 0)
545 #define SSET(string, index, new) (XSTRING (string)->data[index] = (new))
546 #define SDATA(string) (XSTRING (string)->data + 0)
547 #define SCHARS(string) (XSTRING (string)->size + 0)
548 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
550 #define STRING_SET_CHARS(string, newsize) \
551 (XSTRING (string)->size = (newsize))
554 /* Basic data type for use of intervals. See the macros in intervals.h. */
558 /* The first group of entries deal with the tree structure. */
560 unsigned int total_length
; /* Length of myself and both children. */
561 unsigned int position
; /* Cache of interval's character position. */
562 /* This field is usually updated
563 simultaneously with an interval
564 traversal, there is no guarantee
565 that it is valid for a random
567 struct interval
*left
; /* Intervals which precede me. */
568 struct interval
*right
; /* Intervals which succeed me. */
570 /* Parent in the tree, or the Lisp_Object containing this interval tree.
572 The mark bit on the root interval of an interval tree says
573 whether we have started (and possibly finished) marking the
574 tree. If GC comes across an interval tree whose root's parent
575 field has its markbit set, it leaves the tree alone.
577 You'd think we could store this information in the parent object
578 somewhere (after all, that should be visited once and then
579 ignored too, right?), but strings are GC'd strangely. */
582 struct interval
*interval
;
585 unsigned int up_obj
: 1;
587 /* The remaining components are `properties' of the interval.
588 The first four are duplicates for things which can be on the list,
589 for purposes of speed. */
591 unsigned int write_protect
: 1; /* Non-zero means can't modify. */
592 unsigned int visible
: 1; /* Zero means don't display. */
593 unsigned int front_sticky
: 1; /* Non-zero means text inserted just
594 before this interval goes into it. */
595 unsigned int rear_sticky
: 1; /* Likewise for just after it. */
597 /* Properties of this interval.
598 The mark bit on this field says whether this particular interval
599 tree node has been visited. Since intervals should never be
600 shared, GC aborts if it seems to have visited an interval twice. */
604 typedef struct interval
*INTERVAL
;
606 /* Complain if object is not string or buffer type */
607 #define CHECK_STRING_OR_BUFFER(x) \
608 { if (!STRINGP ((x)) && !BUFFERP ((x))) \
609 x = wrong_type_argument (Qbuffer_or_string_p, (x)); }
611 /* In a cons, the markbit of the car is the gc mark bit */
615 /* Please do not use the names of these elements in code other
616 than the core lisp implementation. Use XCAR and XCDR below. */
617 #ifdef HIDE_LISP_IMPLEMENTATION
618 Lisp_Object car_
, cdr_
;
620 Lisp_Object car
, cdr
;
624 /* Take the car or cdr of something known to be a cons cell. */
625 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
626 of code that has to know what a cons cell looks like. Other code not
627 part of the basic lisp implementation should assume that the car and cdr
628 fields are not accessible as lvalues. (What if we want to switch to
629 a copying collector someday? Cached cons cell field addresses may be
630 invalidated at arbitrary points.) */
631 #ifdef HIDE_LISP_IMPLEMENTATION
632 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
633 #define XCDR_AS_LVALUE(c) (XCONS ((c))->cdr_)
635 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
636 #define XCDR_AS_LVALUE(c) (XCONS ((c))->cdr)
639 /* Use these from normal code. */
640 #define XCAR(c) LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
641 #define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))
643 /* Use these to set the fields of a cons cell.
645 Note that both arguments may refer to the same object, so 'n'
646 should not be read after 'c' is first modified. Also, neither
647 argument should be evaluated more than once; side effects are
648 especially common in the second argument. */
649 #define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
650 #define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))
652 /* For performance: Fast storage of positive integers into the
653 fields of a cons cell. See above caveats. */
654 #define XSETCARFASTINT(c,n) XSETFASTINT(XCAR_AS_LVALUE(c),(n))
655 #define XSETCDRFASTINT(c,n) XSETFASTINT(XCDR_AS_LVALUE(c),(n))
657 /* Take the car or cdr of something whose type is not known. */
659 (CONSP ((c)) ? XCAR ((c)) \
660 : NILP ((c)) ? Qnil \
661 : wrong_type_argument (Qlistp, (c)))
664 (CONSP ((c)) ? XCDR ((c)) \
665 : NILP ((c)) ? Qnil \
666 : wrong_type_argument (Qlistp, (c)))
668 /* Nonzero if STR is a multibyte string. */
669 #define STRING_MULTIBYTE(STR) \
670 (XSTRING (STR)->size_byte >= 0)
672 /* Return the length in bytes of STR. */
674 #ifdef GC_CHECK_STRING_BYTES
677 extern int string_bytes
P_ ((struct Lisp_String
*));
678 #define STRING_BYTES(S) string_bytes ((S))
680 #else /* not GC_CHECK_STRING_BYTES */
682 #define STRING_BYTES(STR) \
683 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
685 #endif /* not GC_CHECK_STRING_BYTES */
687 /* Mark STR as a unibyte string. */
688 #define STRING_SET_UNIBYTE(STR) (XSTRING (STR)->size_byte = -1)
690 /* Get text properties. */
691 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
693 /* Set text properties. */
694 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
696 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
702 INTERVAL intervals
; /* text properties in this string */
706 /* If a struct is made to look like a vector, this macro returns the length
707 of the shortest vector that would hold that struct. */
708 #define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector) \
709 - sizeof (Lisp_Object)) \
710 + sizeof(Lisp_Object) - 1) /* round up */ \
711 / sizeof (Lisp_Object))
716 struct Lisp_Vector
*next
;
717 Lisp_Object contents
[1];
720 /* A char table is a kind of vectorlike, with contents are like a
721 vector but with a few other slots. For some purposes, it makes
722 sense to handle a chartable with type struct Lisp_Vector. An
723 element of a char table can be any Lisp objects, but if it is a sub
724 char-table, we treat it a table that contains information of a
725 group of characters of the same charsets or a specific character of
726 a charset. A sub char-table has the same structure as a char table
727 except for that the former omits several slots at the tail. A sub
728 char table appears only in an element of a char table, and there's
729 no way to access it directly from Emacs Lisp program. */
731 /* This is the number of slots that apply to characters or character
732 sets. The first 128 are for ASCII, the next 128 are for 8-bit
733 European characters, and the last 128 are for multibyte characters.
734 The first 256 are indexed by the code itself, but the last 128 are
735 indexed by (charset-id + 128). */
736 #define CHAR_TABLE_ORDINARY_SLOTS 384
738 /* This is the number of slots that apply to characters of ASCII and
739 8-bit Europeans only. */
740 #define CHAR_TABLE_SINGLE_BYTE_SLOTS 256
742 /* This is the number of slots that every char table must have. This
743 counts the ordinary slots and the top, defalt, parent, and purpose
745 #define CHAR_TABLE_STANDARD_SLOTS (CHAR_TABLE_ORDINARY_SLOTS + 4)
747 /* This is the number of slots that apply to position-code-1 and
748 position-code-2 of a multibyte character at the 2nd and 3rd level
749 sub char tables respectively. */
750 #define SUB_CHAR_TABLE_ORDINARY_SLOTS 128
752 /* This is the number of slots that every sub char table must have.
753 This counts the ordinary slots and the top and defalt slot. */
754 #define SUB_CHAR_TABLE_STANDARD_SLOTS (SUB_CHAR_TABLE_ORDINARY_SLOTS + 2)
756 /* Return the number of "extra" slots in the char table CT. */
758 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
759 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
761 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
762 and 8-bit Europeans characters. For these characters, do not check
763 validity of CT. Do not follow parent. */
764 #define CHAR_TABLE_REF(CT, IDX) \
765 ((IDX) >= 0 && (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS \
766 ? (!NILP (XCHAR_TABLE (CT)->contents[IDX]) \
767 ? XCHAR_TABLE (CT)->contents[IDX] \
768 : XCHAR_TABLE (CT)->defalt) \
769 : Faref (CT, make_number (IDX)))
771 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
772 and 8-bit Europeans characters. However, if the result is nil,
775 For these characters, do not check validity of CT
776 and do not follow parent. */
777 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
778 ((IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS \
779 ? (!NILP (XCHAR_TABLE (CT)->contents[IDX]) \
780 ? XINT (XCHAR_TABLE (CT)->contents[IDX]) \
782 : char_table_translate (CT, IDX))
784 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
785 8-bit Europeans characters. Do not check validity of CT. */
786 #define CHAR_TABLE_SET(CT, IDX, VAL) \
788 if (XFASTINT (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS) \
789 XCHAR_TABLE (CT)->contents[XFASTINT (IDX)] = VAL; \
791 Faset (CT, IDX, VAL); \
794 struct Lisp_Char_Table
796 /* This is the vector's size field, which also holds the
797 pseudovector type information. It holds the size, too.
798 The size counts the top, defalt, purpose, and parent slots.
799 The last three are not counted if this is a sub char table. */
801 struct Lisp_Vector
*next
;
802 /* This holds a flag to tell if this is a top level char table (t)
803 or a sub char table (nil). */
805 /* This holds a default value,
806 which is used whenever the value for a specific character is nil. */
808 /* This holds an actual value of each element. A sub char table
809 has only SUB_CHAR_TABLE_ORDINARY_SLOTS number of elements. */
810 Lisp_Object contents
[CHAR_TABLE_ORDINARY_SLOTS
];
812 /* A sub char table doesn't has the following slots. */
814 /* This points to another char table, which we inherit from
815 when the value for a specific character is nil.
816 The `defalt' slot takes precedence over this. */
818 /* This should be a symbol which says what kind of use
819 this char-table is meant for.
820 Typically now the values can be `syntax-table' and `display-table'. */
822 /* These hold additional data. */
823 Lisp_Object extras
[1];
826 /* A boolvector is a kind of vectorlike, with contents are like a string. */
827 struct Lisp_Bool_Vector
829 /* This is the vector's size field. It doesn't have the real size,
830 just the subtype information. */
831 EMACS_INT vector_size
;
832 struct Lisp_Vector
*next
;
833 /* This is the size in bits. */
835 /* This contains the actual bits, packed into bytes. */
836 unsigned char data
[1];
839 /* This structure describes a built-in function.
840 It is generated by the DEFUN macro only.
841 defsubr makes it into a Lisp object.
843 This type is treated in most respects as a pseudovector,
844 but since we never dynamically allocate or free them,
845 we don't need a next-vector field. */
850 Lisp_Object (*function
) ();
851 short min_args
, max_args
;
858 /***********************************************************************
860 ***********************************************************************/
862 /* Interned state of a symbol. */
866 SYMBOL_UNINTERNED
= 0,
868 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
871 /* In a symbol, the markbit of the plist is used as the gc mark bit */
875 /* Non-zero means symbol serves as a variable alias. The symbol
876 holding the real value is found in the value slot. */
877 unsigned indirect_variable
: 1;
879 /* Non-zero means symbol is constant, i.e. changing its value
880 should signal an error. */
881 unsigned constant
: 1;
883 /* Interned state of the symbol. This is an enumerator from
884 enum symbol_interned. */
885 unsigned interned
: 2;
887 /* The symbol's name, as a Lisp string.
889 The name "xname" is used to intentionally break code referring to
890 the old field "name" of type pointer to struct Lisp_String. */
893 /* Value of the symbol or Qunbound if unbound. If this symbol is a
894 defvaralias, `value' contains the symbol for which it is an
895 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
896 and set a symbol's value, to take defvaralias into account. */
899 /* Function value of the symbol or Qunbound if not fboundp. */
900 Lisp_Object function
;
902 /* The symbol's property list. */
905 /* Next symbol in obarray bucket, if the symbol is interned. */
906 struct Lisp_Symbol
*next
;
909 /* Value is name of symbol. */
911 #define SYMBOL_NAME(sym) \
912 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
914 /* Value is non-zero if SYM is an interned symbol. */
916 #define SYMBOL_INTERNED_P(sym) \
917 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
919 /* Value is non-zero if SYM is interned in initial_obarray. */
921 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
922 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
924 /* Value is non-zero if symbol is considered a constant, i.e. its
925 value cannot be changed (there is an exception for keyword symbols,
926 whose value can be set to the keyword symbol itself). */
928 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
930 /* Value is the value of SYM, with defvaralias taken into
933 #define SYMBOL_VALUE(sym) \
934 (XSYMBOL (sym)->indirect_variable \
935 ? XSYMBOL (indirect_variable (sym))->value \
936 : XSYMBOL (sym)->value)
938 /* Set SYM's value to VAL, taking defvaralias into account. */
940 #define SET_SYMBOL_VALUE(sym, val) \
942 if (XSYMBOL (sym)->indirect_variable) \
943 XSYMBOL (indirect_variable ((sym)))->value = (val); \
945 XSYMBOL (sym)->value = (val); \
949 /***********************************************************************
951 ***********************************************************************/
953 /* The structure of a Lisp hash table. */
955 struct Lisp_Hash_Table
957 /* Vector fields. The hash table code doesn't refer to these. */
959 struct Lisp_Vector
*vec_next
;
961 /* Function used to compare keys. */
964 /* Nil if table is non-weak. Otherwise a symbol describing the
965 weakness of the table. */
968 /* When the table is resized, and this is an integer, compute the
969 new size by adding this to the old size. If a float, compute the
970 new size by multiplying the old size with this factor. */
971 Lisp_Object rehash_size
;
973 /* Resize hash table when number of entries/ table size is >= this
975 Lisp_Object rehash_threshold
;
977 /* Number of key/value entries in the table. */
980 /* Vector of keys and values. The key of item I is found at index
981 2 * I, the value is found at index 2 * I + 1. */
982 Lisp_Object key_and_value
;
984 /* Vector of hash codes.. If hash[I] is nil, this means that that
985 entry I is unused. */
988 /* Vector used to chain entries. If entry I is free, next[I] is the
989 entry number of the next free item. If entry I is non-free,
990 next[I] is the index of the next entry in the collision chain. */
993 /* Index of first free entry in free list. */
994 Lisp_Object next_free
;
996 /* Bucket vector. A non-nil entry is the index of the first item in
997 a collision chain. This vector's size can be larger than the
998 hash table size to reduce collisions. */
1001 /* Next weak hash table if this is a weak hash table. The head
1002 of the list is in Vweak_hash_tables. */
1003 Lisp_Object next_weak
;
1005 /* User-supplied hash function, or nil. */
1006 Lisp_Object user_hash_function
;
1008 /* User-supplied key comparison function, or nil. */
1009 Lisp_Object user_cmp_function
;
1011 /* C function to compare two keys. */
1012 int (* cmpfn
) P_ ((struct Lisp_Hash_Table
*, Lisp_Object
,
1013 unsigned, Lisp_Object
, unsigned));
1015 /* C function to compute hash code. */
1016 unsigned (* hashfn
) P_ ((struct Lisp_Hash_Table
*, Lisp_Object
));
1020 #define XHASH_TABLE(OBJ) \
1021 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1023 #define XSET_HASH_TABLE(VAR, PTR) \
1024 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1026 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1027 #define GC_HASH_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_HASH_TABLE)
1029 #define CHECK_HASH_TABLE(x) \
1032 if (!HASH_TABLE_P ((x))) \
1033 x = wrong_type_argument (Qhash_table_p, (x)); \
1037 /* Value is the key part of entry IDX in hash table H. */
1039 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1041 /* Value is the value part of entry IDX in hash table H. */
1043 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1045 /* Value is the index of the next entry following the one at IDX
1048 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1050 /* Value is the hash code computed for entry IDX in hash table H. */
1052 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1054 /* Value is the index of the element in hash table H that is the
1055 start of the collision list at index IDX in the index vector of H. */
1057 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1059 /* Value is the size of hash table H. */
1061 #define HASH_TABLE_SIZE(H) XVECTOR ((H)->next)->size
1063 /* Default size for hash tables if not specified. */
1065 #define DEFAULT_HASH_SIZE 65
1067 /* Default threshold specifying when to resize a hash table. The
1068 value gives the ratio of current entries in the hash table and the
1069 size of the hash table. */
1071 #define DEFAULT_REHASH_THRESHOLD 0.8
1073 /* Default factor by which to increase the size of a hash table. */
1075 #define DEFAULT_REHASH_SIZE 1.5
1078 /* These structures are used for various misc types. */
1080 /* A miscellaneous object, when it's on the free list. */
1083 int type
: 16; /* = Lisp_Misc_Free */
1085 union Lisp_Misc
*chain
;
1088 /* In a marker, the markbit of the chain field is used as the gc mark bit. */
1091 int type
: 16; /* = Lisp_Misc_Marker */
1093 /* 1 means normal insertion at the marker's position
1094 leaves the marker after the inserted text. */
1095 unsigned int insertion_type
: 1;
1096 /* This is the buffer that the marker points into,
1097 or 0 if it points nowhere. */
1098 struct buffer
*buffer
;
1100 /* The remaining fields are meaningless in a marker that
1101 does not point anywhere. */
1103 /* For markers that point somewhere,
1104 this is used to chain of all the markers in a given buffer. */
1106 /* This is the char position where the marker points. */
1108 /* This is the byte position. */
1112 /* Forwarding pointer to an int variable.
1113 This is allowed only in the value cell of a symbol,
1114 and it means that the symbol's value really lives in the
1115 specified int variable. */
1118 int type
: 16; /* = Lisp_Misc_Intfwd */
1123 /* Boolean forwarding pointer to an int variable.
1124 This is like Lisp_Intfwd except that the ostensible
1125 "value" of the symbol is t if the int variable is nonzero,
1126 nil if it is zero. */
1129 int type
: 16; /* = Lisp_Misc_Boolfwd */
1134 /* Forwarding pointer to a Lisp_Object variable.
1135 This is allowed only in the value cell of a symbol,
1136 and it means that the symbol's value really lives in the
1137 specified variable. */
1140 int type
: 16; /* = Lisp_Misc_Objfwd */
1142 Lisp_Object
*objvar
;
1145 /* Like Lisp_Objfwd except that value lives in a slot in the
1146 current buffer. Value is byte index of slot within buffer. */
1147 struct Lisp_Buffer_Objfwd
1149 int type
: 16; /* = Lisp_Misc_Buffer_Objfwd */
1154 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1155 the symbol has buffer-local or frame-local bindings. (Exception:
1156 some buffer-local variables are built-in, with their values stored
1157 in the buffer structure itself. They are handled differently,
1158 using struct Lisp_Buffer_Objfwd.)
1160 The `realvalue' slot holds the variable's current value, or a
1161 forwarding pointer to where that value is kept. This value is the
1162 one that corresponds to the loaded binding. To read or set the
1163 variable, you must first make sure the right binding is loaded;
1164 then you can access the value in (or through) `realvalue'.
1166 `buffer' and `frame' are the buffer and frame for which the loaded
1167 binding was found. If those have changed, to make sure the right
1168 binding is loaded it is necessary to find which binding goes with
1169 the current buffer and selected frame, then load it. To load it,
1170 first unload the previous binding, then copy the value of the new
1171 binding into `realvalue' (or through it). Also update
1172 LOADED-BINDING to point to the newly loaded binding.
1174 Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
1175 both use this kind of structure. With the former, merely setting
1176 the variable creates a local binding for the current buffer. With
1177 the latter, setting the variable does not do that; only
1178 make-local-variable does that. */
1180 struct Lisp_Buffer_Local_Value
1182 int type
: 16; /* = Lisp_Misc_Buffer_Local_Value
1183 or Lisp_Misc_Some_Buffer_Local_Value */
1186 /* 1 means this variable is allowed to have frame-local bindings,
1187 so check for them when looking for the proper binding. */
1188 unsigned int check_frame
: 1;
1189 /* 1 means that the binding now loaded was found
1190 as a local binding for the buffer in the `buffer' slot. */
1191 unsigned int found_for_buffer
: 1;
1192 /* 1 means that the binding now loaded was found
1193 as a local binding for the frame in the `frame' slot. */
1194 unsigned int found_for_frame
: 1;
1195 Lisp_Object realvalue
;
1196 /* The buffer and frame for which the loaded binding was found. */
1197 Lisp_Object buffer
, frame
;
1199 /* A cons cell, (LOADED-BINDING . DEFAULT-VALUE).
1201 LOADED-BINDING is the binding now loaded. It is a cons cell
1202 whose cdr is the binding's value. The cons cell may be an
1203 element of a buffer's local-variable alist, or an element of a
1204 frame's parameter alist, or it may be this cons cell.
1206 DEFAULT-VALUE is the variable's default value, seen when the
1207 current buffer and selected frame do not have their own
1208 bindings for the variable. When the default binding is loaded,
1209 LOADED-BINDING is actually this very cons cell; thus, its car
1210 points to itself. */
1214 /* In an overlay object, the mark bit of the plist is used as the GC mark.
1215 START and END are markers in the overlay's buffer, and
1216 PLIST is the overlay's property list. */
1219 int type
: 16; /* = Lisp_Misc_Overlay */
1221 Lisp_Object start
, end
, plist
;
1224 /* Like Lisp_Objfwd except that value lives in a slot in the
1226 struct Lisp_Kboard_Objfwd
1228 int type
: 16; /* = Lisp_Misc_Kboard_Objfwd */
1234 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1235 It uses one of these struct subtypes to get the type field. */
1239 struct Lisp_Free u_free
;
1240 struct Lisp_Marker u_marker
;
1241 struct Lisp_Intfwd u_intfwd
;
1242 struct Lisp_Boolfwd u_boolfwd
;
1243 struct Lisp_Objfwd u_objfwd
;
1244 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1245 struct Lisp_Buffer_Local_Value u_buffer_local_value
;
1246 struct Lisp_Overlay u_overlay
;
1247 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1250 /* Lisp floating point type */
1253 Lisp_Object type
; /* essentially used for mark-bit
1254 and chaining when on free-list */
1255 #ifdef HIDE_LISP_IMPLEMENTATION
1262 #ifdef HIDE_LISP_IMPLEMENTATION
1263 #define XFLOAT_DATA(f) (XFLOAT (f)->data_)
1265 #define XFLOAT_DATA(f) (XFLOAT (f)->data)
1268 /* A character, declared with the following typedef, is a member
1269 of some character set associated with the current buffer. */
1270 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1272 typedef unsigned char UCHAR
;
1275 /* Meanings of slots in a Lisp_Compiled: */
1277 #define COMPILED_ARGLIST 0
1278 #define COMPILED_BYTECODE 1
1279 #define COMPILED_CONSTANTS 2
1280 #define COMPILED_STACK_DEPTH 3
1281 #define COMPILED_DOC_STRING 4
1282 #define COMPILED_INTERACTIVE 5
1284 /* Flag bits in a character. These also get used in termhooks.h.
1285 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1286 (MUlti-Lingual Emacs) might need 22 bits for the character value
1287 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1288 #define CHAR_ALT (0x0400000)
1289 #define CHAR_SUPER (0x0800000)
1290 #define CHAR_HYPER (0x1000000)
1291 #define CHAR_SHIFT (0x2000000)
1292 #define CHAR_CTL (0x4000000)
1293 #define CHAR_META (0x8000000)
1295 #define CHAR_MODIFIER_MASK \
1296 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1299 /* Actually, the current Emacs uses 19 bits for the character value
1301 #define CHARACTERBITS 19
1303 /* The maximum byte size consumed by push_key_description.
1304 All callers should assure that at least this size of memory is
1305 allocated at the place pointed by the second argument.
1307 Thers are 6 modifiers, each consumes 2 chars.
1308 The octal form of a character code consumes
1309 (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
1310 We need one more byte for string terminator `\0'. */
1311 #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)
1313 #ifdef USE_X_TOOLKIT
1314 #ifdef NO_UNION_TYPE
1315 /* Use this for turning a (void *) into a Lisp_Object, as when the
1316 Lisp_Object is passed into a toolkit callback function. */
1317 #define VOID_TO_LISP(larg,varg) \
1318 do { ((larg) = ((Lisp_Object) (varg))); } while (0)
1319 #define CVOID_TO_LISP VOID_TO_LISP
1321 /* Use this for turning a Lisp_Object into a (void *), as when the
1322 Lisp_Object is passed into a toolkit callback function. */
1323 #define LISP_TO_VOID(larg) ((void *) (larg))
1324 #define LISP_TO_CVOID(varg) ((const void *) (larg))
1326 #else /* not NO_UNION_TYPE */
1327 /* Use this for turning a (void *) into a Lisp_Object, as when the
1328 Lisp_Object is passed into a toolkit callback function. */
1329 #define VOID_TO_LISP(larg,varg) \
1330 do { ((larg).v = (void *) (varg)); } while (0)
1331 #define CVOID_TO_LISP(larg,varg) \
1332 do { ((larg).cv = (const void *) (varg)); } while (0)
1334 /* Use this for turning a Lisp_Object into a (void *), as when the
1335 Lisp_Object is passed into a toolkit callback function. */
1336 #define LISP_TO_VOID(larg) ((larg).v)
1337 #define LISP_TO_CVOID(larg) ((larg).cv)
1338 #endif /* not NO_UNION_TYPE */
1339 #endif /* USE_X_TOOLKIT */
1342 /* The glyph datatype, used to represent characters on the display. */
1344 /* Glyph code to use as an index to the glyph table. If it is out of
1345 range for the glyph table, or the corresonding element in the table
1346 is nil, the low 8 bits are the single byte character code, and the
1347 bits above are the numeric face ID. If FID is the face ID of a
1348 glyph on a frame F, then F->display.x->faces[FID] contains the
1349 description of that face. This is an int instead of a short, so we
1350 can support a good bunch of face ID's (2^(31 - 8)); given that we
1351 have no mechanism for tossing unused frame face ID's yet, we'll
1352 probably run out of 255 pretty quickly.
1353 This is always -1 for a multibyte character. */
1356 /* Mask bits for face. */
1357 #define GLYPH_MASK_FACE 0x7FF80000
1358 /* Mask bits for character code. */
1359 #define GLYPH_MASK_CHAR 0x0007FFFF /* The lowest 19 bits */
1361 /* The FAST macros assume that we already know we're in an X window. */
1363 /* Set a character code and a face ID in a glyph G. */
1364 #define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << CHARACTERBITS))
1366 /* Return a glyph's character code. */
1367 #define FAST_GLYPH_CHAR(glyph) ((glyph) & GLYPH_MASK_CHAR)
1369 /* Return a glyph's face ID. */
1370 #define FAST_GLYPH_FACE(glyph) (((glyph) & GLYPH_MASK_FACE) >> CHARACTERBITS)
1372 /* Slower versions that test the frame type first. */
1373 #define MAKE_GLYPH(f, char, face) (FAST_MAKE_GLYPH (char, face))
1374 #define GLYPH_CHAR(f, g) (FAST_GLYPH_CHAR (g))
1375 #define GLYPH_FACE(f, g) (FAST_GLYPH_FACE (g))
1377 /* Return 1 iff GLYPH contains valid character code. */
1378 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (FAST_GLYPH_CHAR (glyph), 1)
1380 /* The ID of the mode line highlighting face. */
1381 #define GLYPH_MODE_LINE_FACE 1
1383 /* Data type checking */
1385 #define NILP(x) (XFASTINT (x) == XFASTINT (Qnil))
1386 #define GC_NILP(x) GC_EQ (x, Qnil)
1388 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1389 #define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
1390 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1391 #define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
1393 #define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
1394 #define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
1395 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1396 #define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
1397 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1398 #define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
1399 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1400 #define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
1401 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1402 #define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
1403 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1404 #define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
1406 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1407 #define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
1408 #define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1409 #define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1410 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1411 #define GC_OVERLAYP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1412 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1413 #define GC_MARKERP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1414 #define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
1415 #define GC_INTFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
1416 #define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
1417 #define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
1418 #define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
1419 #define GC_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
1420 #define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
1421 #define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
1422 #define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
1423 #define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
1424 #define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1425 #define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1426 #define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1427 #define GC_KBOARD_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1430 /* True if object X is a pseudovector whose code is CODE. */
1431 #define PSEUDOVECTORP(x, code) \
1433 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1434 == (PSEUDOVECTOR_FLAG | (code))))
1436 /* True if object X is a pseudovector whose code is CODE.
1437 This one works during GC. */
1438 #define GC_PSEUDOVECTORP(x, code) \
1439 (GC_VECTORLIKEP (x) \
1440 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1441 == (PSEUDOVECTOR_FLAG | (code))))
1443 /* Test for specific pseudovector types. */
1444 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1445 #define GC_WINDOW_CONFIGURATIONP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1446 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1447 #define GC_PROCESSP(x) GC_PSEUDOVECTORP (x, PVEC_PROCESS)
1448 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1449 #define GC_WINDOWP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW)
1450 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1451 #define GC_SUBRP(x) GC_PSEUDOVECTORP (x, PVEC_SUBR)
1452 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1453 #define GC_COMPILEDP(x) GC_PSEUDOVECTORP (x, PVEC_COMPILED)
1454 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1455 #define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
1456 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1457 #define GC_CHAR_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1458 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1459 #define GC_BOOL_VECTOR_P(x) GC_PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1460 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1461 #define GC_FRAMEP(x) GC_PSEUDOVECTORP (x, PVEC_FRAME)
1463 #define SUB_CHAR_TABLE_P(x) (CHAR_TABLE_P (x) && NILP (XCHAR_TABLE (x)->top))
1465 #define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
1466 #define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
1468 #define CHECK_LIST(x) \
1469 do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
1471 #define CHECK_STRING(x) \
1472 do { if (!STRINGP ((x))) x = wrong_type_argument (Qstringp, (x)); } while (0)
1474 #define CHECK_STRING_CAR(x) \
1475 do { if (!STRINGP (XCAR (x))) XSETCAR (x, wrong_type_argument (Qstringp, XCAR (x))); } while (0)
1477 #define CHECK_CONS(x) \
1478 do { if (!CONSP ((x))) x = wrong_type_argument (Qconsp, (x)); } while (0)
1480 #define CHECK_SYMBOL(x) \
1481 do { if (!SYMBOLP ((x))) x = wrong_type_argument (Qsymbolp, (x)); } while (0)
1483 #define CHECK_CHAR_TABLE(x) \
1484 do { if (!CHAR_TABLE_P ((x))) \
1485 x = wrong_type_argument (Qchar_table_p, (x)); } while (0)
1487 #define CHECK_VECTOR(x) \
1488 do { if (!VECTORP ((x))) x = wrong_type_argument (Qvectorp, (x)); } while (0)
1490 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1491 do { if (!VECTORP ((x)) && !CHAR_TABLE_P ((x))) \
1492 x = wrong_type_argument (Qvector_or_char_table_p, (x)); \
1495 #define CHECK_BUFFER(x) \
1496 do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
1498 #define CHECK_WINDOW(x) \
1499 do { if (!WINDOWP ((x))) x = wrong_type_argument (Qwindowp, (x)); } while (0)
1501 /* This macro rejects windows on the interior of the window tree as
1502 "dead", which is what we want; this is an argument-checking macro, and
1503 the user should never get access to interior windows.
1505 A window of any sort, leaf or interior, is dead iff the buffer,
1506 vchild, and hchild members are all nil. */
1508 #define CHECK_LIVE_WINDOW(x) \
1510 if (!WINDOWP ((x)) \
1511 || NILP (XWINDOW ((x))->buffer)) \
1512 x = wrong_type_argument (Qwindow_live_p, (x)); \
1515 #define CHECK_PROCESS(x) \
1516 do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
1518 #define CHECK_NUMBER(x) \
1519 do { if (!INTEGERP ((x))) x = wrong_type_argument (Qintegerp, (x)); } while (0)
1521 #define CHECK_NATNUM(x) \
1522 do { if (!NATNUMP (x)) x = wrong_type_argument (Qwholenump, (x)); } while (0)
1524 #define CHECK_MARKER(x) \
1525 do { if (!MARKERP ((x))) x = wrong_type_argument (Qmarkerp, (x)); } while (0)
1527 #define CHECK_NUMBER_COERCE_MARKER(x) \
1528 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1529 else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
1531 #define XFLOATINT(n) extract_float((n))
1533 #define CHECK_FLOAT(x) \
1534 do { if (!FLOATP (x)) \
1535 x = wrong_type_argument (Qfloatp, (x)); } while (0)
1537 #define CHECK_NUMBER_OR_FLOAT(x) \
1538 do { if (!FLOATP (x) && !INTEGERP (x)) \
1539 x = wrong_type_argument (Qnumberp, (x)); } while (0)
1541 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1542 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1543 else if (!INTEGERP (x) && !FLOATP (x)) \
1544 x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
1546 #define CHECK_OVERLAY(x) \
1547 do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
1549 /* Since we can't assign directly to the CAR or CDR fields of a cons
1550 cell, use these when checking that those fields contain numbers. */
1551 #define CHECK_NUMBER_CAR(x) \
1553 Lisp_Object tmp = XCAR (x); \
1554 CHECK_NUMBER (tmp); \
1555 XSETCAR ((x), tmp); \
1558 #define CHECK_NUMBER_CDR(x) \
1560 Lisp_Object tmp = XCDR (x); \
1561 CHECK_NUMBER (tmp); \
1562 XSETCDR ((x), tmp); \
1565 /* Cast pointers to this type to compare them. Some machines want int. */
1566 #ifndef PNTR_COMPARISON_TYPE
1567 #define PNTR_COMPARISON_TYPE EMACS_UINT
1570 /* Define a built-in function for calling from Lisp.
1571 `lname' should be the name to give the function in Lisp,
1572 as a null-terminated C string.
1573 `fnname' should be the name of the function in C.
1574 By convention, it starts with F.
1575 `sname' should be the name for the C constant structure
1576 that records information on this function for internal use.
1577 By convention, it should be the same as `fnname' but with S instead of F.
1578 It's too bad that C macros can't compute this from `fnname'.
1579 `minargs' should be a number, the minimum number of arguments allowed.
1580 `maxargs' should be a number, the maximum number of arguments allowed,
1581 or else MANY or UNEVALLED.
1582 MANY means pass a vector of evaluated arguments,
1583 in the form of an integer number-of-arguments
1584 followed by the address of a vector of Lisp_Objects
1585 which contains the argument values.
1586 UNEVALLED means pass the list of unevaluated arguments
1587 `prompt' says how to read arguments for an interactive call.
1588 See the doc string for `interactive'.
1589 A null string means call interactively with no arguments.
1590 `doc' is documentation for the user. */
1592 #if (!defined (__STDC__) && !defined (PROTOTYPES)) \
1593 || defined (USE_NONANSI_DEFUN)
1595 #define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1596 Lisp_Object fnname (); \
1597 struct Lisp_Subr sname = \
1598 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1599 fnname, minargs, maxargs, lname, prompt, 0}; \
1604 /* This version of DEFUN declares a function prototype with the right
1605 arguments, so we can catch errors with maxargs at compile-time. */
1606 #define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1607 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1608 struct Lisp_Subr sname = \
1609 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1610 fnname, minargs, maxargs, lname, prompt, 0}; \
1613 /* Note that the weird token-substitution semantics of ANSI C makes
1614 this work for MANY and UNEVALLED. */
1615 #define DEFUN_ARGS_MANY (int, Lisp_Object *)
1616 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1617 #define DEFUN_ARGS_0 (void)
1618 #define DEFUN_ARGS_1 (Lisp_Object)
1619 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1620 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1621 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1622 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1624 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1625 Lisp_Object, Lisp_Object)
1626 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1627 Lisp_Object, Lisp_Object, Lisp_Object)
1628 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1629 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1632 /* Non-zero if OBJ is a Lisp function. */
1634 #define FUNCTIONP(OBJ) \
1635 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1636 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1637 || COMPILEDP (OBJ) \
1641 is how we define the symbol for function `name' at start-up time. */
1642 extern void defsubr
P_ ((struct Lisp_Subr
*));
1645 #define UNEVALLED -1
1647 extern void defvar_lisp
P_ ((char *, Lisp_Object
*));
1648 extern void defvar_lisp_nopro
P_ ((char *, Lisp_Object
*));
1649 extern void defvar_bool
P_ ((char *, int *));
1650 extern void defvar_int
P_ ((char *, EMACS_INT
*));
1651 extern void defvar_per_buffer
P_ ((char *, Lisp_Object
*, Lisp_Object
, char *));
1652 extern void defvar_kboard
P_ ((char *, int));
1654 /* Macros we use to define forwarded Lisp variables.
1655 These are used in the syms_of_FILENAME functions. */
1657 #define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
1658 #define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
1659 #define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
1660 #define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
1661 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
1662 defvar_per_buffer (lname, vname, type, 0)
1663 #define DEFVAR_KBOARD(lname, vname, doc) \
1664 defvar_kboard (lname, \
1665 (int)((char *)(¤t_kboard->vname) \
1666 - (char *)current_kboard))
1670 /* Structure for recording Lisp call stack for backtrace purposes. */
1672 /* The special binding stack holds the outer values of variables while
1673 they are bound by a function application or a let form, stores the
1674 code to be executed for Lisp unwind-protect forms, and stores the C
1675 functions to be called for record_unwind_protect.
1677 If func is non-zero, undoing this binding applies func to old_value;
1678 This implements record_unwind_protect.
1679 If func is zero and symbol is nil, undoing this binding evaluates
1680 the list of forms in old_value; this implements Lisp's unwind-protect
1683 Otherwise, the element is a variable binding.
1685 If the symbol field is a symbol, it is an ordinary variable binding.
1687 Otherwise, it should be a structure (SYMBOL WHERE
1688 . CURRENT-BUFFER), which means having bound a local value while
1689 CURRENT-BUFFER was active. If WHERE is nil this means we saw the
1690 default value when binding SYMBOL. WHERE being a buffer or frame
1691 means we saw a buffer-local or frame-local value. Other values of
1692 WHERE mean an internal error. */
1696 Lisp_Object symbol
, old_value
;
1697 Lisp_Object (*func
) P_ ((Lisp_Object
));
1698 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
1701 extern struct specbinding
*specpdl
;
1702 extern struct specbinding
*specpdl_ptr
;
1703 extern int specpdl_size
;
1705 extern EMACS_INT max_specpdl_size
;
1707 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
1709 /* Everything needed to describe an active condition case. */
1712 /* The handler clauses and variable from the condition-case form. */
1713 Lisp_Object handler
;
1715 /* Fsignal stores here the condition-case clause that applies,
1716 and Fcondition_case thus knows which clause to run. */
1717 Lisp_Object chosen_clause
;
1719 /* Used to effect the longjump out to the handler. */
1720 struct catchtag
*tag
;
1722 /* The next enclosing handler. */
1723 struct handler
*next
;
1726 extern struct handler
*handlerlist
;
1728 extern struct catchtag
*catchlist
;
1729 extern struct backtrace
*backtrace_list
;
1731 extern Lisp_Object memory_signal_data
;
1733 /* An address near the bottom of the stack.
1734 Tells GC how to save a copy of the stack. */
1735 extern char *stack_bottom
;
1737 /* Check quit-flag and quit if it is non-nil.
1738 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
1739 So the program needs to do QUIT at times when it is safe to quit.
1740 Every loop that might run for a long time or might not exit
1741 ought to do QUIT at least once, at a safe place.
1742 Unless that is impossible, of course.
1743 But it is very desirable to avoid creating loops where QUIT is impossible.
1745 Exception: if you set immediate_quit to nonzero,
1746 then the handler that responds to the C-g does the quit itself.
1747 This is a good thing to do around a loop that has no side effects
1748 and (in particular) cannot call arbitrary Lisp code. */
1752 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1754 Vquit_flag = Qnil; \
1755 Fsignal (Qquit, Qnil); \
1759 /* Nonzero if ought to quit now. */
1761 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
1763 /* Variables used locally in the following case handling macros. */
1764 extern int case_temp1
;
1765 extern Lisp_Object case_temp2
;
1767 /* Current buffer's map from characters to lower-case characters. */
1769 #define DOWNCASE_TABLE current_buffer->downcase_table
1771 /* Current buffer's map from characters to upper-case characters. */
1773 #define UPCASE_TABLE current_buffer->upcase_table
1775 /* Downcase a character, or make no change if that cannot be done. */
1777 #define DOWNCASE(CH) \
1778 ((case_temp1 = (CH), \
1779 case_temp2 = CHAR_TABLE_REF (DOWNCASE_TABLE, case_temp1), \
1780 NATNUMP (case_temp2)) \
1781 ? XFASTINT (case_temp2) : case_temp1)
1783 /* 1 if CH is upper case. */
1785 #define UPPERCASEP(CH) (DOWNCASE (CH) != (CH))
1787 /* 1 if CH is neither upper nor lower case. */
1789 #define NOCASEP(CH) (UPCASE1 (CH) == (CH))
1791 /* 1 if CH is lower case. */
1793 #define LOWERCASEP(CH) (!UPPERCASEP (CH) && !NOCASEP(CH))
1795 /* Upcase a character, or make no change if that cannot be done. */
1797 #define UPCASE(CH) (!UPPERCASEP (CH) ? UPCASE1 (CH) : (CH))
1799 /* Upcase a character known to be not upper case. */
1801 #define UPCASE1(CH) \
1802 ((case_temp1 = (CH), \
1803 case_temp2 = CHAR_TABLE_REF (UPCASE_TABLE, case_temp1), \
1804 NATNUMP (case_temp2)) \
1805 ? XFASTINT (case_temp2) : case_temp1)
1807 extern Lisp_Object Vascii_downcase_table
;
1809 /* Number of bytes of structure consed since last GC. */
1811 extern int consing_since_gc
;
1813 /* Threshold for doing another gc. */
1815 extern EMACS_INT gc_cons_threshold
;
1817 /* Structure for recording stack slots that need marking. */
1819 /* This is a chain of structures, each of which points at a Lisp_Object variable
1820 whose value should be marked in garbage collection.
1821 Normally every link of the chain is an automatic variable of a function,
1822 and its `val' points to some argument or local variable of the function.
1823 On exit to the function, the chain is set back to the value it had on entry.
1824 This way, no link remains in the chain when the stack frame containing the
1827 Every function that can call Feval must protect in this fashion all
1828 Lisp_Object variables whose contents will be used again. */
1830 extern struct gcpro
*gcprolist
;
1836 /* Address of first protected variable. */
1837 volatile Lisp_Object
*var
;
1839 /* Number of consecutive protected variables. */
1847 /* Values of GC_MARK_STACK during compilation:
1849 0 Use GCPRO as before
1850 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
1851 2 Mark the stack, and check that everything GCPRO'd is
1853 3 Mark using GCPRO's, mark stack last, and count how many
1854 dead objects are kept alive. */
1857 #define GC_USE_GCPROS_AS_BEFORE 0
1858 #define GC_MAKE_GCPROS_NOOPS 1
1859 #define GC_MARK_STACK_CHECK_GCPROS 2
1860 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
1862 #ifndef GC_MARK_STACK
1863 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
1866 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
1868 /* Do something silly with gcproN vars just so gcc shuts up. */
1870 #define GCPRO1(varname) ((void) gcpro1)
1871 #define GCPRO2(varname1, varname2)(((void) gcpro2, (void) gcpro1))
1872 #define GCPRO3(varname1, varname2, varname3) \
1873 (((void) gcpro3, (void) gcpro2, (void) gcpro1))
1874 #define GCPRO4(varname1, varname2, varname3, varname4) \
1875 (((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
1876 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
1877 (((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
1878 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
1879 (((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
1880 #define UNGCPRO ((void) 0)
1882 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
1886 #define GCPRO1(varname) \
1887 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
1888 gcprolist = &gcpro1; }
1890 #define GCPRO2(varname1, varname2) \
1891 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1892 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1893 gcprolist = &gcpro2; }
1895 #define GCPRO3(varname1, varname2, varname3) \
1896 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1897 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1898 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1899 gcprolist = &gcpro3; }
1901 #define GCPRO4(varname1, varname2, varname3, varname4) \
1902 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1903 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1904 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1905 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1906 gcprolist = &gcpro4; }
1908 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
1909 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1910 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1911 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1912 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1913 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1914 gcprolist = &gcpro5; }
1916 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
1917 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1918 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1919 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1920 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1921 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1922 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
1923 gcprolist = &gcpro6; }
1925 #define UNGCPRO (gcprolist = gcpro1.next)
1929 extern int gcpro_level
;
1931 #define GCPRO1(varname) \
1932 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
1933 gcpro1.level = gcpro_level++; \
1934 gcprolist = &gcpro1; }
1936 #define GCPRO2(varname1, varname2) \
1937 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1938 gcpro1.level = gcpro_level; \
1939 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1940 gcpro2.level = gcpro_level++; \
1941 gcprolist = &gcpro2; }
1943 #define GCPRO3(varname1, varname2, varname3) \
1944 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1945 gcpro1.level = gcpro_level; \
1946 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1947 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1948 gcpro3.level = gcpro_level++; \
1949 gcprolist = &gcpro3; }
1951 #define GCPRO4(varname1, varname2, varname3, varname4) \
1952 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1953 gcpro1.level = gcpro_level; \
1954 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1955 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1956 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1957 gcpro4.level = gcpro_level++; \
1958 gcprolist = &gcpro4; }
1960 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
1961 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1962 gcpro1.level = gcpro_level; \
1963 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1964 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1965 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1966 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1967 gcpro5.level = gcpro_level++; \
1968 gcprolist = &gcpro5; }
1970 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
1971 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1972 gcpro1.level = gcpro_level; \
1973 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1974 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1975 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1976 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1977 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
1978 gcpro6.level = gcpro_level++; \
1979 gcprolist = &gcpro6; }
1982 ((--gcpro_level != gcpro1.level) \
1984 : ((gcprolist = gcpro1.next), 0))
1986 #endif /* DEBUG_GCPRO */
1987 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
1990 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
1991 #define RETURN_UNGCPRO(expr) \
1994 Lisp_Object ret_ungc_val; \
1995 ret_ungc_val = (expr); \
1997 return ret_ungc_val; \
2001 /* Call staticpro (&var) to protect static variable `var'. */
2003 void staticpro
P_ ((Lisp_Object
*));
2005 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2006 meaning as in the DEFUN macro, and is used to construct a prototype. */
2007 #if (!defined (__STDC__) && !defined (PROTOTYPES)) \
2008 || defined (USE_NONANSI_DEFUN)
2009 #define EXFUN(fnname, maxargs) \
2010 extern Lisp_Object fnname ()
2012 /* We can use the same trick as in the DEFUN macro to generate the
2013 appropriate prototype. */
2014 #define EXFUN(fnname, maxargs) \
2015 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2018 /* Forward declarations for prototypes. */
2022 /* Defined in data.c */
2023 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qsubr
, Qunbound
;
2024 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2025 extern Lisp_Object Qerror
, Qquit
, Qwrong_type_argument
, Qargs_out_of_range
;
2026 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2027 extern Lisp_Object Qsetting_constant
, Qinvalid_read_syntax
;
2028 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2029 extern Lisp_Object Qend_of_file
, Qarith_error
;
2030 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2031 extern Lisp_Object Qmark_inactive
, Qtext_read_only
;
2033 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2034 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2036 extern Lisp_Object Qintegerp
, Qnumberp
, Qnatnump
, Qwholenump
;
2037 extern Lisp_Object Qsymbolp
, Qlistp
, Qconsp
;
2038 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2039 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qvectorp
;
2040 extern Lisp_Object Qinteger_or_marker_p
, Qnumber_or_marker_p
;
2041 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2042 extern Lisp_Object Qboundp
, Qfboundp
;
2043 extern Lisp_Object Qbuffer_or_string_p
;
2044 extern Lisp_Object Qcdr
;
2046 extern Lisp_Object Qfloatp
, Qinteger_or_floatp
, Qinteger_or_float_or_marker_p
;
2048 extern Lisp_Object Qframep
;
2050 extern void circular_list_error
P_ ((Lisp_Object
));
2058 EXFUN (Fintegerp
, 1);
2059 EXFUN (Fnatnump
, 1);
2060 EXFUN (Fsymbolp
, 1);
2061 EXFUN (Fvectorp
, 1);
2062 EXFUN (Fstringp
, 1);
2063 EXFUN (Fmultibyte_string_p
, 1);
2065 EXFUN (Fsequencep
, 1);
2066 EXFUN (Fbufferp
, 1);
2067 EXFUN (Fmarkerp
, 1);
2069 EXFUN (Fchar_or_string_p
, 1);
2070 EXFUN (Finteger_or_marker_p
, 1);
2072 EXFUN (Finteger_or_floatp
, 1);
2073 EXFUN (Finteger_or_float_or_marker_p
, 1);
2076 EXFUN (Fcar_safe
, 1);
2078 EXFUN (Fcdr_safe
, 1);
2082 EXFUN (Ffboundp
, 1);
2083 EXFUN (Fmakunbound
, 1);
2084 EXFUN (Ffmakunbound
, 1);
2085 EXFUN (Fsymbol_function
, 1);
2086 EXFUN (Fsymbol_plist
, 1);
2087 EXFUN (Fsymbol_name
, 1);
2088 extern Lisp_Object indirect_function
P_ ((Lisp_Object
));
2089 EXFUN (Findirect_function
, 1);
2091 EXFUN (Fsetplist
, 2);
2092 EXFUN (Fsymbol_value
, 1);
2093 extern Lisp_Object find_symbol_value
P_ ((Lisp_Object
));
2095 EXFUN (Fdefault_value
, 1);
2096 EXFUN (Fset_default
, 2);
2097 EXFUN (Fdefault_boundp
, 1);
2098 EXFUN (Fmake_local_variable
, 1);
2099 EXFUN (Flocal_variable_p
, 2);
2100 EXFUN (Flocal_variable_if_set_p
, 2);
2105 EXFUN (Fstring_to_number
, 2);
2106 EXFUN (Fnumber_to_string
, 1);
2107 EXFUN (Feqlsign
, 2);
2114 EXFUN (Fplus
, MANY
);
2115 EXFUN (Fminus
, MANY
);
2116 EXFUN (Ftimes
, MANY
);
2121 EXFUN (Flogand
, MANY
);
2122 EXFUN (Flogior
, MANY
);
2123 EXFUN (Flogxor
, MANY
);
2130 EXFUN (Fmake_variable_buffer_local
, 1);
2132 extern Lisp_Object indirect_variable
P_ ((Lisp_Object
));
2133 extern Lisp_Object long_to_cons
P_ ((unsigned long));
2134 extern unsigned long cons_to_long
P_ ((Lisp_Object
));
2135 extern void args_out_of_range
P_ ((Lisp_Object
, Lisp_Object
));
2136 extern void args_out_of_range_3
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2137 extern Lisp_Object wrong_type_argument
P_ ((Lisp_Object
, Lisp_Object
));
2138 extern void store_symval_forwarding
P_ ((Lisp_Object
, Lisp_Object
,
2139 Lisp_Object
, struct buffer
*));
2140 extern Lisp_Object do_symval_forwarding
P_ ((Lisp_Object
));
2141 extern Lisp_Object set_internal
P_ ((Lisp_Object
, Lisp_Object
, struct buffer
*, int));
2142 extern void syms_of_data
P_ ((void));
2143 extern void init_data
P_ ((void));
2144 extern void swap_in_global_binding
P_ ((Lisp_Object
));
2146 /* Defined in cmds.c */
2147 EXFUN (Fend_of_line
, 1);
2148 EXFUN (Fforward_char
, 1);
2149 EXFUN (Fforward_line
, 1);
2150 extern int forward_point
P_ ((int));
2151 extern int internal_self_insert
P_ ((int, int));
2152 extern void syms_of_cmds
P_ ((void));
2153 extern void keys_of_cmds
P_ ((void));
2155 /* Defined in coding.c */
2156 EXFUN (Fcoding_system_p
, 1);
2157 EXFUN (Fcheck_coding_system
, 1);
2158 EXFUN (Fread_coding_system
, 2);
2159 EXFUN (Fread_non_nil_coding_system
, 1);
2160 EXFUN (Ffind_operation_coding_system
, MANY
);
2161 EXFUN (Fupdate_coding_systems_internal
, 0);
2162 EXFUN (Fencode_coding_string
, 3);
2163 EXFUN (Fdecode_coding_string
, 3);
2164 extern Lisp_Object detect_coding_system
P_ ((unsigned char *, int, int, int));
2165 extern void init_coding
P_ ((void));
2166 extern void init_coding_once
P_ ((void));
2167 extern void syms_of_coding
P_ ((void));
2168 extern Lisp_Object code_convert_string_norecord
P_ ((Lisp_Object
, Lisp_Object
,
2171 /* Defined in charset.c */
2172 extern EMACS_INT nonascii_insert_offset
;
2173 extern Lisp_Object Vnonascii_translation_table
;
2174 EXFUN (Fchar_bytes
, 1);
2175 EXFUN (Fchar_width
, 1);
2176 EXFUN (Fstring
, MANY
);
2177 extern int chars_in_text
P_ ((const unsigned char *, int));
2178 extern int multibyte_chars_in_text
P_ ((const unsigned char *, int));
2179 extern int unibyte_char_to_multibyte
P_ ((int));
2180 extern int multibyte_char_to_unibyte
P_ ((int, Lisp_Object
));
2181 extern Lisp_Object Qcharset
;
2182 extern void init_charset_once
P_ ((void));
2183 extern void syms_of_charset
P_ ((void));
2185 /* Defined in syntax.c */
2186 EXFUN (Fforward_word
, 1);
2187 EXFUN (Fskip_chars_forward
, 2);
2188 EXFUN (Fskip_chars_backward
, 2);
2189 EXFUN (Fsyntax_table_p
, 1);
2190 EXFUN (Fsyntax_table
, 0);
2191 EXFUN (Fset_syntax_table
, 1);
2192 extern void init_syntax_once
P_ ((void));
2193 extern void syms_of_syntax
P_ ((void));
2195 /* Defined in fns.c */
2196 extern int use_dialog_box
;
2197 extern int next_almost_prime
P_ ((int));
2198 extern Lisp_Object larger_vector
P_ ((Lisp_Object
, int, Lisp_Object
));
2199 extern void sweep_weak_hash_tables
P_ ((void));
2200 extern Lisp_Object Qstring_lessp
;
2201 EXFUN (Foptimize_char_table
, 1);
2202 extern Lisp_Object Vfeatures
;
2203 extern Lisp_Object QCtest
, QCweakness
, Qequal
;
2204 unsigned sxhash
P_ ((Lisp_Object
, int));
2205 Lisp_Object make_hash_table
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
2206 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2208 Lisp_Object copy_hash_table
P_ ((struct Lisp_Hash_Table
*));
2209 int hash_lookup
P_ ((struct Lisp_Hash_Table
*, Lisp_Object
, unsigned *));
2210 int hash_put
P_ ((struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2212 void hash_remove
P_ ((struct Lisp_Hash_Table
*, Lisp_Object
));
2213 void hash_clear
P_ ((struct Lisp_Hash_Table
*));
2214 void remove_hash_entry
P_ ((struct Lisp_Hash_Table
*, int));
2215 extern void init_fns
P_ ((void));
2217 EXFUN (Fmake_hash_table
, MANY
);
2218 EXFUN (Fcopy_hash_table
, 1);
2219 EXFUN (Fhash_table_count
, 1);
2220 EXFUN (Fhash_table_rehash_size
, 1);
2221 EXFUN (Fhash_table_rehash_threshold
, 1);
2222 EXFUN (Fhash_table_size
, 1);
2223 EXFUN (Fhash_table_test
, 1);
2224 EXFUN (Fhash_table_weak
, 1);
2225 EXFUN (Fhash_table_p
, 1);
2226 EXFUN (Fclrhash
, 1);
2227 EXFUN (Fgethash
, 3);
2228 EXFUN (Fputhash
, 3);
2229 EXFUN (Fremhash
, 2);
2230 EXFUN (Fmaphash
, 2);
2231 EXFUN (Fdefine_hash_table_test
, 3);
2233 EXFUN (Fidentity
, 1);
2236 EXFUN (Fsafe_length
, 1);
2237 EXFUN (Fappend
, MANY
);
2238 EXFUN (Fconcat
, MANY
);
2239 EXFUN (Fvconcat
, MANY
);
2240 EXFUN (Fcopy_sequence
, 1);
2241 EXFUN (Fstring_make_multibyte
, 1);
2242 EXFUN (Fstring_make_unibyte
, 1);
2243 EXFUN (Fstring_as_multibyte
, 1);
2244 EXFUN (Fstring_as_unibyte
, 1);
2245 EXFUN (Fsubstring
, 3);
2246 extern Lisp_Object substring_both
P_ ((Lisp_Object
, int, int, int, int));
2257 EXFUN (Freverse
, 1);
2258 EXFUN (Fnreverse
, 1);
2262 EXFUN (Ffillarray
, 2);
2263 EXFUN (Fnconc
, MANY
);
2265 EXFUN (Fmapconcat
, 3);
2266 EXFUN (Fy_or_n_p
, 1);
2267 extern Lisp_Object do_yes_or_no_p
P_ ((Lisp_Object
));
2268 EXFUN (Frequire
, 3);
2269 EXFUN (Fprovide
, 2);
2270 extern Lisp_Object concat2
P_ ((Lisp_Object
, Lisp_Object
));
2271 extern Lisp_Object concat3
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2272 extern Lisp_Object nconc2
P_ ((Lisp_Object
, Lisp_Object
));
2273 extern Lisp_Object assq_no_quit
P_ ((Lisp_Object
, Lisp_Object
));
2274 extern void clear_string_char_byte_cache
P_ ((void));
2275 extern int string_char_to_byte
P_ ((Lisp_Object
, int));
2276 extern int string_byte_to_char
P_ ((Lisp_Object
, int));
2277 extern Lisp_Object string_make_multibyte
P_ ((Lisp_Object
));
2278 extern Lisp_Object string_make_unibyte
P_ ((Lisp_Object
));
2279 EXFUN (Fcopy_alist
, 1);
2280 EXFUN (Fplist_get
, 2);
2281 EXFUN (Fplist_put
, 3);
2282 EXFUN (Fplist_member
, 2);
2283 EXFUN (Fset_char_table_parent
, 2);
2284 EXFUN (Fchar_table_extra_slot
, 2);
2285 EXFUN (Fset_char_table_extra_slot
, 3);
2287 EXFUN (Fstring_equal
, 2);
2288 EXFUN (Fcompare_strings
, 7);
2289 EXFUN (Fstring_lessp
, 2);
2290 extern int char_table_translate
P_ ((Lisp_Object
, int));
2291 extern void map_char_table
P_ ((void (*) (Lisp_Object
, Lisp_Object
, Lisp_Object
),
2292 Lisp_Object
, Lisp_Object
, Lisp_Object
, int,
2294 extern Lisp_Object char_table_ref_and_index
P_ ((Lisp_Object
, int, int *));
2295 extern void syms_of_fns
P_ ((void));
2297 /* Defined in floatfns.c */
2298 extern double extract_float
P_ ((Lisp_Object
));
2300 EXFUN (Ftruncate
, 2);
2301 extern void init_floatfns
P_ ((void));
2302 extern void syms_of_floatfns
P_ ((void));
2304 /* Defined in insdel.c */
2305 extern Lisp_Object Qinhibit_modification_hooks
;
2306 extern void move_gap
P_ ((int));
2307 extern void move_gap_both
P_ ((int, int));
2308 extern void make_gap
P_ ((int));
2309 extern int copy_text
P_ ((const unsigned char *, unsigned char *, int, int, int));
2310 extern int count_size_as_multibyte
P_ ((const unsigned char *, int));
2311 extern int count_combining_before
P_ ((const unsigned char *, int, int, int));
2312 extern int count_combining_after
P_ ((const unsigned char *, int, int, int));
2313 extern void insert
P_ ((const unsigned char *, int));
2314 extern void insert_and_inherit
P_ ((const unsigned char *, int));
2315 extern void insert_1
P_ ((const unsigned char *, int, int, int, int));
2316 extern void insert_1_both
P_ ((const unsigned char *, int, int, int, int, int));
2317 extern void insert_from_string
P_ ((Lisp_Object
, int, int, int, int, int));
2318 extern void insert_from_buffer
P_ ((struct buffer
*, int, int, int));
2319 extern void insert_char
P_ ((int));
2320 extern void insert_string
P_ ((const char *));
2321 extern void insert_before_markers
P_ ((const unsigned char *, int));
2322 extern void insert_before_markers_and_inherit
P_ ((const unsigned char *, int));
2323 extern void insert_from_string_before_markers
P_ ((Lisp_Object
, int, int, int, int, int));
2324 extern void del_range
P_ ((int, int));
2325 extern Lisp_Object del_range_1
P_ ((int, int, int, int));
2326 extern void del_range_byte
P_ ((int, int, int));
2327 extern void del_range_both
P_ ((int, int, int, int, int));
2328 extern Lisp_Object del_range_2
P_ ((int, int, int, int, int));
2329 extern void modify_region
P_ ((struct buffer
*, int, int));
2330 extern void prepare_to_modify_buffer
P_ ((int, int, int *));
2331 extern void signal_before_change
P_ ((int, int, int *));
2332 extern void signal_after_change
P_ ((int, int, int));
2333 extern void adjust_after_replace
P_ ((int, int, Lisp_Object
, int, int));
2334 extern void adjust_after_replace_noundo
P_ ((int, int, int, int, int, int));
2335 extern void adjust_after_insert
P_ ((int, int, int, int, int));
2336 extern void replace_range
P_ ((int, int, Lisp_Object
, int, int, int));
2337 extern void syms_of_insdel
P_ ((void));
2339 /* Defined in dispnew.c */
2340 extern Lisp_Object selected_frame
;
2341 extern EMACS_INT baud_rate
;
2343 EXFUN (Fredraw_frame
, 1);
2344 EXFUN (Fredraw_display
, 0);
2345 EXFUN (Fsleep_for
, 2);
2346 EXFUN (Fsit_for
, 3);
2347 extern Lisp_Object sit_for
P_ ((int, int, int, int, int));
2348 extern void init_display
P_ ((void));
2349 extern void syms_of_display
P_ ((void));
2350 extern void safe_bcopy
P_ ((char *, char *, int));
2352 /* Defined in xdisp.c */
2353 extern Lisp_Object Qinhibit_point_motion_hooks
;
2354 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2355 extern Lisp_Object Qinhibit_eval_during_redisplay
;
2356 extern Lisp_Object Qmessage_truncate_lines
;
2357 extern Lisp_Object Qcursor_in_non_selected_windows
;
2358 extern Lisp_Object Vmessage_log_max
;
2359 extern int message_enable_multibyte
;
2360 extern Lisp_Object echo_area_buffer
[2];
2361 extern void check_message_stack
P_ ((void));
2362 extern void setup_echo_area_for_printing
P_ ((int));
2363 extern int push_message
P_ ((void));
2364 extern Lisp_Object push_message_unwind
P_ ((Lisp_Object
));
2365 extern void pop_message
P_ ((void));
2366 extern void restore_message
P_ ((void));
2367 extern Lisp_Object current_message
P_ ((void));
2368 extern void set_message
P_ ((const char *s
, Lisp_Object
, int, int));
2369 extern void clear_message
P_ ((int, int));
2370 extern void message
P_ ((/* char *, ... */));
2371 extern void message_nolog
P_ ((/* char *, ... */));
2372 extern void message1
P_ ((char *));
2373 extern void message1_nolog
P_ ((char *));
2374 extern void message2
P_ ((const char *, int, int));
2375 extern void message2_nolog
P_ ((const char *, int, int));
2376 extern void message3
P_ ((Lisp_Object
, int, int));
2377 extern void message3_nolog
P_ ((Lisp_Object
, int, int));
2378 extern void message_dolog
P_ ((const char *, int, int, int));
2379 extern void message_with_string
P_ ((char *, Lisp_Object
, int));
2380 extern void message_log_maybe_newline
P_ ((void));
2381 extern void update_echo_area
P_ ((void));
2382 extern void truncate_echo_area
P_ ((int));
2383 extern void redisplay
P_ ((void));
2384 extern int check_point_in_composition
2385 P_ ((struct buffer
*, int, struct buffer
*, int));
2386 extern void redisplay_preserve_echo_area
P_ ((int));
2387 extern void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2388 extern void prepare_menu_bars
P_ ((void));
2389 extern void syms_of_xdisp
P_ ((void));
2390 extern void init_xdisp
P_ ((void));
2391 extern Lisp_Object safe_eval
P_ ((Lisp_Object
));
2392 extern int pos_visible_p
P_ ((struct window
*, int, int *, int));
2394 /* Defined in vm-limit.c. */
2395 extern void memory_warnings
P_ ((POINTER_TYPE
*, void (*warnfun
) ()));
2397 /* Defined in alloc.c */
2398 extern void check_pure_size
P_ ((void));
2399 extern void allocate_string_data
P_ ((struct Lisp_String
*, int, int));
2400 extern void uninterrupt_malloc
P_ ((void));
2401 extern void malloc_warning
P_ ((char *));
2402 extern void memory_full
P_ ((void));
2403 extern void buffer_memory_full
P_ ((void));
2404 extern int survives_gc_p
P_ ((Lisp_Object
));
2405 extern void mark_object
P_ ((Lisp_Object
*));
2406 extern Lisp_Object Vpurify_flag
;
2407 extern Lisp_Object Vmemory_full
;
2413 EXFUN (Flist
, MANY
);
2414 EXFUN (Fmake_list
, 2);
2415 extern Lisp_Object allocate_misc
P_ ((void));
2416 EXFUN (Fmake_vector
, 2);
2417 EXFUN (Fvector
, MANY
);
2418 EXFUN (Fmake_symbol
, 1);
2419 EXFUN (Fmake_marker
, 0);
2420 EXFUN (Fmake_string
, 2);
2421 extern Lisp_Object build_string
P_ ((const char *));
2422 extern Lisp_Object make_string
P_ ((const char *, int));
2423 extern Lisp_Object make_unibyte_string
P_ ((const char *, int));
2424 extern Lisp_Object make_multibyte_string
P_ ((const char *, int, int));
2425 extern Lisp_Object make_event_array
P_ ((int, Lisp_Object
*));
2426 extern Lisp_Object make_uninit_string
P_ ((int));
2427 extern Lisp_Object make_uninit_multibyte_string
P_ ((int, int));
2428 extern Lisp_Object make_string_from_bytes
P_ ((char *, int, int));
2429 extern Lisp_Object make_specified_string
P_ ((char *, int, int, int));
2430 EXFUN (Fpurecopy
, 1);
2431 extern Lisp_Object make_pure_string
P_ ((char *, int, int, int));
2432 extern Lisp_Object pure_cons
P_ ((Lisp_Object
, Lisp_Object
));
2433 extern Lisp_Object make_pure_vector
P_ ((EMACS_INT
));
2434 EXFUN (Fgarbage_collect
, 0);
2435 EXFUN (Fmake_byte_code
, MANY
);
2436 EXFUN (Fmake_bool_vector
, 2);
2437 EXFUN (Fmake_char_table
, 2);
2438 extern Lisp_Object make_sub_char_table
P_ ((Lisp_Object
));
2439 extern Lisp_Object Qchar_table_extra_slots
;
2440 extern struct Lisp_Vector
*allocate_vector
P_ ((EMACS_INT
));
2441 extern struct Lisp_Vector
*allocate_other_vector
P_ ((EMACS_INT
));
2442 extern struct Lisp_Hash_Table
*allocate_hash_table
P_ ((void));
2443 extern struct window
*allocate_window
P_ ((void));
2444 extern struct frame
*allocate_frame
P_ ((void));
2445 extern struct Lisp_Process
*allocate_process
P_ ((void));
2446 extern int gc_in_progress
;
2447 extern Lisp_Object make_float
P_ ((double));
2448 extern void display_malloc_warning
P_ ((void));
2449 extern int inhibit_garbage_collection
P_ ((void));
2450 extern void free_marker
P_ ((Lisp_Object
));
2451 extern void free_cons
P_ ((struct Lisp_Cons
*));
2452 extern void init_alloc_once
P_ ((void));
2453 extern void init_alloc
P_ ((void));
2454 extern void syms_of_alloc
P_ ((void));
2455 extern struct buffer
* allocate_buffer
P_ ((void));
2457 /* Defined in print.c */
2458 extern Lisp_Object Vprin1_to_string_buffer
;
2459 extern void debug_print
P_ ((Lisp_Object
));
2461 EXFUN (Fprin1_to_string
, 2);
2465 EXFUN (Ferror_message_string
, 1);
2466 extern Lisp_Object Vstandard_output
, Qstandard_output
;
2467 extern Lisp_Object Qexternal_debugging_output
;
2468 extern void temp_output_buffer_setup
P_ ((char *));
2469 extern int print_level
, print_escape_newlines
;
2470 extern Lisp_Object Qprint_escape_newlines
;
2471 extern void write_string
P_ ((char *, int));
2472 extern void write_string_1
P_ ((char *, int, Lisp_Object
));
2473 extern void print_error_message
P_ ((Lisp_Object
, Lisp_Object
));
2474 extern Lisp_Object internal_with_output_to_temp_buffer
2475 P_ ((char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
));
2476 extern void float_to_string
P_ ((unsigned char *, double));
2477 extern void syms_of_print
P_ ((void));
2479 /* Defined in doprnt.c */
2480 extern int doprnt
P_ ((char *, int, char *, char *, int, char **));
2481 extern int doprnt_lisp
P_ ((char *, int, char *, char *, int, char **));
2483 /* Defined in lread.c */
2484 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2485 extern Lisp_Object Vobarray
, initial_obarray
, Vstandard_input
;
2487 EXFUN (Fread_from_string
, 3);
2489 EXFUN (Fintern_soft
, 2);
2491 EXFUN (Fget_file_char
, 0);
2492 EXFUN (Fread_char
, 2);
2493 EXFUN (Fread_event
, 2);
2494 extern Lisp_Object read_filtered_event
P_ ((int, int, int, int));
2495 EXFUN (Feval_region
, 4);
2496 extern Lisp_Object intern
P_ ((const char *));
2497 extern Lisp_Object make_symbol
P_ ((char *));
2498 extern Lisp_Object oblookup
P_ ((Lisp_Object
, const char *, int, int));
2499 #define LOADHIST_ATTACH(x) \
2500 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
2501 extern Lisp_Object Vcurrent_load_list
;
2502 extern Lisp_Object Vload_history
, Vload_suffixes
;
2503 extern int openp
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
2504 Lisp_Object
*, Lisp_Object
));
2505 extern int isfloat_string
P_ ((char *));
2506 extern void map_obarray
P_ ((Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2508 extern void dir_warning
P_ ((char *, Lisp_Object
));
2509 extern void close_load_descs
P_ ((void));
2510 extern void init_obarray
P_ ((void));
2511 extern void init_lread
P_ ((void));
2512 extern void syms_of_lread
P_ ((void));
2514 /* Defined in eval.c */
2515 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
, Qmacro
;
2516 extern Lisp_Object Vinhibit_quit
, Qinhibit_quit
, Vquit_flag
;
2517 extern Lisp_Object Vautoload_queue
;
2518 extern Lisp_Object Vdebug_on_error
;
2519 extern Lisp_Object Vsignaling_function
;
2520 extern int handling_signal
;
2521 extern int interactive_p
P_ ((int));
2523 /* To run a normal hook, use the appropriate function from the list below.
2524 The calling convention:
2526 if (!NILP (Vrun_hooks))
2527 call1 (Vrun_hooks, Qmy_funny_hook);
2529 should no longer be used. */
2530 extern Lisp_Object Vrun_hooks
;
2531 EXFUN (Frun_hooks
, MANY
);
2532 EXFUN (Frun_hook_with_args
, MANY
);
2533 EXFUN (Frun_hook_with_args_until_success
, MANY
);
2534 EXFUN (Frun_hook_with_args_until_failure
, MANY
);
2535 extern Lisp_Object run_hook_list_with_args
P_ ((Lisp_Object
, int, Lisp_Object
*));
2536 extern void run_hook_with_args_2
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2537 EXFUN (Fand
, UNEVALLED
);
2538 EXFUN (For
, UNEVALLED
);
2539 EXFUN (Fif
, UNEVALLED
);
2540 EXFUN (Fprogn
, UNEVALLED
);
2541 EXFUN (Fprog1
, UNEVALLED
);
2542 EXFUN (Fprog2
, UNEVALLED
);
2543 EXFUN (Fsetq
, UNEVALLED
);
2544 EXFUN (Fquote
, UNEVALLED
);
2545 EXFUN (Fuser_variable_p
, 1);
2546 EXFUN (Finteractive_p
, 0);
2547 EXFUN (Fdefun
, UNEVALLED
);
2548 EXFUN (Flet
, UNEVALLED
);
2549 EXFUN (FletX
, UNEVALLED
);
2550 EXFUN (Fwhile
, UNEVALLED
);
2551 EXFUN (Fcatch
, UNEVALLED
);
2552 EXFUN (Fthrow
, 2) NO_RETURN
;
2553 EXFUN (Funwind_protect
, UNEVALLED
);
2554 EXFUN (Fcondition_case
, UNEVALLED
);
2556 EXFUN (Fautoload
, 5);
2557 EXFUN (Fcommandp
, 2);
2559 EXFUN (Fapply
, MANY
);
2560 EXFUN (Ffuncall
, MANY
);
2561 EXFUN (Fbacktrace
, 0);
2562 extern Lisp_Object apply1
P_ ((Lisp_Object
, Lisp_Object
));
2563 extern Lisp_Object call0
P_ ((Lisp_Object
));
2564 extern Lisp_Object call1
P_ ((Lisp_Object
, Lisp_Object
));
2565 extern Lisp_Object call2
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2566 extern Lisp_Object call3
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
));
2567 extern Lisp_Object call4
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
));
2568 extern Lisp_Object call5
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
));
2569 extern Lisp_Object call6
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
));
2570 EXFUN (Fdo_auto_save
, 2);
2571 extern Lisp_Object apply_lambda
P_ ((Lisp_Object
, Lisp_Object
, int));
2572 extern Lisp_Object internal_catch
P_ ((Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
));
2573 extern Lisp_Object internal_condition_case
P_ ((Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
)));
2574 extern Lisp_Object internal_condition_case_1
P_ ((Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
)));
2575 extern Lisp_Object internal_condition_case_2
P_ ((Lisp_Object (*) (int, Lisp_Object
*), int, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
)));
2576 extern void specbind
P_ ((Lisp_Object
, Lisp_Object
));
2577 extern void record_unwind_protect
P_ ((Lisp_Object (*) (Lisp_Object
), Lisp_Object
));
2578 extern Lisp_Object unbind_to
P_ ((int, Lisp_Object
));
2579 extern void error
P_ ((/* char *, ... */)) NO_RETURN
;
2580 extern void do_autoload
P_ ((Lisp_Object
, Lisp_Object
));
2581 extern Lisp_Object un_autoload
P_ ((Lisp_Object
));
2582 EXFUN (Ffetch_bytecode
, 1);
2583 extern void init_eval_once
P_ ((void));
2584 extern Lisp_Object safe_call
P_ ((int, Lisp_Object
*));
2585 extern Lisp_Object safe_call1
P_ ((Lisp_Object
, Lisp_Object
));
2586 extern void init_eval
P_ ((void));
2587 extern void syms_of_eval
P_ ((void));
2589 /* Defined in editfns.c */
2590 EXFUN (Fpropertize
, MANY
);
2591 EXFUN (Fcurrent_message
, 0);
2592 EXFUN (Fgoto_char
, 1);
2593 EXFUN (Fpoint_min_marker
, 0);
2594 EXFUN (Fpoint_max_marker
, 0);
2595 EXFUN (Fpoint_min
, 0);
2596 EXFUN (Fpoint_max
, 0);
2598 EXFUN (Fpoint_marker
, 0);
2599 EXFUN (Fmark_marker
, 0);
2600 EXFUN (Fline_beginning_position
, 1);
2601 EXFUN (Fline_end_position
, 1);
2602 EXFUN (Ffollowing_char
, 0);
2603 EXFUN (Fprevious_char
, 0);
2604 EXFUN (Fchar_after
, 1);
2605 EXFUN (Finsert
, MANY
);
2606 EXFUN (Finsert_and_inherit
, MANY
);
2607 EXFUN (Finsert_before_markers
, MANY
);
2608 EXFUN (Finsert_buffer_substring
, 3);
2609 EXFUN (Finsert_char
, 3);
2610 extern void insert1
P_ ((Lisp_Object
));
2615 EXFUN (Fformat
, MANY
);
2616 EXFUN (Fmessage
, MANY
);
2617 extern Lisp_Object format1
P_ ((/* char *, ... */));
2618 extern Lisp_Object make_buffer_string
P_ ((int, int, int));
2619 EXFUN (Fbuffer_substring
, 2);
2620 EXFUN (Fbuffer_string
, 0);
2621 extern Lisp_Object save_excursion_save
P_ ((void));
2622 extern Lisp_Object save_restriction_save
P_ ((void));
2623 extern Lisp_Object save_excursion_restore
P_ ((Lisp_Object
));
2624 extern Lisp_Object save_restriction_restore
P_ ((Lisp_Object
));
2625 EXFUN (Fchar_to_string
, 1);
2626 EXFUN (Fdelete_region
, 2);
2627 EXFUN (Fnarrow_to_region
, 2);
2629 EXFUN (Fuser_login_name
, 1);
2630 EXFUN (Fsystem_name
, 0);
2631 EXFUN (Fcurrent_time
, 0);
2632 extern int clip_to_bounds
P_ ((int, int, int));
2633 extern Lisp_Object make_buffer_string
P_ ((int, int, int));
2634 extern Lisp_Object make_buffer_string_both
P_ ((int, int, int, int, int));
2635 extern void init_editfns
P_ ((void));
2636 extern void syms_of_editfns
P_ ((void));
2637 EXFUN (Fcurrent_message
, 0);
2638 extern Lisp_Object Vinhibit_field_text_motion
;
2639 EXFUN (Fconstrain_to_field
, 5);
2640 EXFUN (Ffield_string
, 1);
2641 EXFUN (Fdelete_field
, 1);
2642 EXFUN (Ffield_beginning
, 3);
2643 EXFUN (Ffield_end
, 3);
2644 EXFUN (Ffield_string_no_properties
, 1);
2645 extern void set_time_zone_rule
P_ ((char *));
2647 /* defined in buffer.c */
2648 extern int mouse_face_overlay_overlaps
P_ ((Lisp_Object
));
2649 extern void nsberror
P_ ((Lisp_Object
));
2650 extern char *no_switch_window
P_ ((Lisp_Object window
));
2651 EXFUN (Fset_buffer_multibyte
, 1);
2652 EXFUN (Foverlay_start
, 1);
2653 EXFUN (Foverlay_end
, 1);
2654 extern void adjust_overlays_for_insert
P_ ((int, int));
2655 extern void adjust_overlays_for_delete
P_ ((int, int));
2656 extern void fix_overlays_in_range
P_ ((int, int));
2657 extern void report_overlay_modification
P_ ((Lisp_Object
, Lisp_Object
, int,
2658 Lisp_Object
, Lisp_Object
, Lisp_Object
));
2659 extern int overlay_touches_p
P_ ((int));
2660 extern Lisp_Object Vbuffer_alist
, Vinhibit_read_only
;
2661 EXFUN (Fget_buffer
, 1);
2662 EXFUN (Fget_buffer_create
, 1);
2663 EXFUN (Fset_buffer
, 1);
2664 EXFUN (set_buffer_if_live
, 1);
2665 EXFUN (Fbarf_if_buffer_read_only
, 0);
2666 EXFUN (Fcurrent_buffer
, 0);
2667 EXFUN (Fswitch_to_buffer
, 2);
2668 EXFUN (Fpop_to_buffer
, 3);
2669 EXFUN (Fother_buffer
, 3);
2670 EXFUN (Foverlay_get
, 2);
2671 EXFUN (Fbuffer_modified_p
, 1);
2672 EXFUN (Fset_buffer_modified_p
, 1);
2673 EXFUN (Fkill_buffer
, 1);
2674 EXFUN (Fkill_all_local_variables
, 0);
2675 EXFUN (Fbuffer_disable_undo
, 1);
2676 EXFUN (Fbuffer_enable_undo
, 1);
2677 EXFUN (Ferase_buffer
, 0);
2678 extern Lisp_Object Qoverlayp
;
2679 extern Lisp_Object get_truename_buffer
P_ ((Lisp_Object
));
2680 extern struct buffer
*all_buffers
;
2681 EXFUN (Fprevious_overlay_change
, 1);
2682 EXFUN (Fbuffer_file_name
, 1);
2683 extern void init_buffer_once
P_ ((void));
2684 extern void init_buffer
P_ ((void));
2685 extern void syms_of_buffer
P_ ((void));
2686 extern void keys_of_buffer
P_ ((void));
2688 /* defined in marker.c */
2690 EXFUN (Fmarker_position
, 1);
2691 EXFUN (Fmarker_buffer
, 1);
2692 EXFUN (Fcopy_marker
, 2);
2693 EXFUN (Fset_marker
, 3);
2694 extern int marker_position
P_ ((Lisp_Object
));
2695 extern int marker_byte_position
P_ ((Lisp_Object
));
2696 extern void clear_charpos_cache
P_ ((struct buffer
*));
2697 extern int charpos_to_bytepos
P_ ((int));
2698 extern int buf_charpos_to_bytepos
P_ ((struct buffer
*, int));
2699 extern int buf_bytepos_to_charpos
P_ ((struct buffer
*, int));
2700 extern void unchain_marker
P_ ((Lisp_Object
));
2701 extern Lisp_Object set_marker_restricted
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2702 extern Lisp_Object set_marker_both
P_ ((Lisp_Object
, Lisp_Object
, int, int));
2703 extern Lisp_Object set_marker_restricted_both
P_ ((Lisp_Object
, Lisp_Object
,
2705 extern void syms_of_marker
P_ ((void));
2707 /* Defined in fileio.c */
2709 extern Lisp_Object Qfile_error
;
2710 EXFUN (Ffind_file_name_handler
, 2);
2711 EXFUN (Ffile_name_as_directory
, 1);
2712 EXFUN (Fmake_temp_name
, 1);
2713 EXFUN (Fexpand_file_name
, 2);
2714 EXFUN (Ffile_name_nondirectory
, 1);
2715 EXFUN (Fsubstitute_in_file_name
, 1);
2716 EXFUN (Ffile_symlink_p
, 1);
2717 EXFUN (Fverify_visited_file_modtime
, 1);
2718 EXFUN (Ffile_exists_p
, 1);
2719 EXFUN (Ffile_name_absolute_p
, 1);
2720 EXFUN (Fdirectory_file_name
, 1);
2721 EXFUN (Ffile_name_directory
, 1);
2722 extern Lisp_Object expand_and_dir_to_file
P_ ((Lisp_Object
, Lisp_Object
));
2723 EXFUN (Ffile_accessible_directory_p
, 1);
2724 EXFUN (Funhandled_file_name_directory
, 1);
2725 EXFUN (Ffile_directory_p
, 1);
2726 EXFUN (Fwrite_region
, 7);
2727 EXFUN (Ffile_readable_p
, 1);
2728 EXFUN (Ffile_executable_p
, 1);
2729 EXFUN (Fread_file_name
, 6);
2730 extern Lisp_Object close_file_unwind
P_ ((Lisp_Object
));
2731 extern void report_file_error
P_ ((const char *, Lisp_Object
));
2732 extern int internal_delete_file
P_ ((Lisp_Object
));
2733 extern void syms_of_fileio
P_ ((void));
2734 EXFUN (Fmake_temp_name
, 1);
2735 extern void init_fileio_once
P_ ((void));
2736 extern Lisp_Object make_temp_name
P_ ((Lisp_Object
, int));
2738 /* Defined in abbrev.c */
2740 extern Lisp_Object Vfundamental_mode_abbrev_table
;
2741 extern void syms_of_abbrev
P_ ((void));
2743 /* defined in search.c */
2744 extern void shrink_regexp_cache
P_ ((void));
2745 EXFUN (Fstring_match
, 3);
2746 extern void restore_match_data
P_ ((void));
2747 EXFUN (Fmatch_data
, 2);
2748 EXFUN (Fset_match_data
, 1);
2749 EXFUN (Fmatch_beginning
, 1);
2750 EXFUN (Fmatch_end
, 1);
2751 EXFUN (Flooking_at
, 1);
2752 extern int fast_string_match
P_ ((Lisp_Object
, Lisp_Object
));
2753 extern int fast_c_string_match_ignore_case
P_ ((Lisp_Object
, const char *));
2754 extern int scan_buffer
P_ ((int, int, int, int, int *, int));
2755 extern int scan_newline
P_ ((int, int, int, int, int, int));
2756 extern int find_next_newline
P_ ((int, int));
2757 extern int find_next_newline_no_quit
P_ ((int, int));
2758 extern int find_before_next_newline
P_ ((int, int, int));
2759 extern void syms_of_search
P_ ((void));
2761 /* defined in minibuf.c */
2763 extern Lisp_Object last_minibuf_string
;
2764 extern void choose_minibuf_frame
P_ ((void));
2765 EXFUN (Fcompleting_read
, 8);
2766 EXFUN (Fread_from_minibuffer
, 7);
2767 EXFUN (Fread_variable
, 2);
2768 EXFUN (Fread_buffer
, 3);
2769 EXFUN (Fread_minibuffer
, 2);
2770 EXFUN (Feval_minibuffer
, 2);
2771 EXFUN (Fread_string
, 5);
2772 EXFUN (Fread_no_blanks_input
, 3);
2773 extern Lisp_Object get_minibuffer
P_ ((int));
2774 extern void temp_echo_area_glyphs
P_ ((const char *));
2775 extern void init_minibuf_once
P_ ((void));
2776 extern void syms_of_minibuf
P_ ((void));
2777 extern void keys_of_minibuf
P_ ((void));
2779 /* Defined in callint.c */
2781 extern Lisp_Object Qminus
, Qplus
, Vcurrent_prefix_arg
;
2782 extern Lisp_Object Vcommand_history
;
2783 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
2784 EXFUN (Fcall_interactively
, 3);
2785 EXFUN (Fprefix_numeric_value
, 1);
2786 extern void syms_of_callint
P_ ((void));
2788 /* defined in casefiddle.c */
2790 EXFUN (Fdowncase
, 1);
2792 EXFUN (Fcapitalize
, 1);
2793 EXFUN (Fupcase_region
, 2);
2794 EXFUN (Fupcase_initials
, 1);
2795 EXFUN (Fupcase_initials_region
, 2);
2796 extern void syms_of_casefiddle
P_ ((void));
2797 extern void keys_of_casefiddle
P_ ((void));
2799 /* defined in casetab.c */
2801 EXFUN (Fset_case_table
, 1);
2802 EXFUN (Fset_standard_case_table
, 1);
2803 extern void init_casetab_once
P_ ((void));
2804 extern void syms_of_casetab
P_ ((void));
2806 /* defined in keyboard.c */
2809 extern Lisp_Object echo_message_buffer
;
2810 extern struct kboard
*echo_kboard
;
2811 extern void cancel_echoing
P_ ((void));
2812 extern Lisp_Object Qdisabled
, QCfilter
;
2813 extern Lisp_Object Vtty_erase_char
, Vhelp_form
, Vtop_level
;
2814 extern int input_pending
;
2815 EXFUN (Fdiscard_input
, 0);
2816 EXFUN (Frecursive_edit
, 0);
2817 EXFUN (Ftop_level
, 0);
2818 EXFUN (Fcommand_execute
, 4);
2819 EXFUN (Finput_pending_p
, 0);
2820 extern Lisp_Object menu_bar_items
P_ ((Lisp_Object
));
2821 extern Lisp_Object tool_bar_items
P_ ((Lisp_Object
, int *));
2822 extern Lisp_Object Qvertical_scroll_bar
;
2823 extern void discard_mouse_events
P_ ((void));
2824 EXFUN (Fevent_convert_list
, 1);
2825 EXFUN (Fread_key_sequence
, 5);
2826 EXFUN (Fset_input_mode
, 4);
2827 extern int detect_input_pending
P_ ((void));
2828 extern int detect_input_pending_run_timers
P_ ((int));
2829 extern void safe_run_hooks
P_ ((Lisp_Object
));
2830 extern void cmd_error_internal
P_ ((Lisp_Object
, char *));
2831 extern Lisp_Object command_loop_1
P_ ((void));
2832 extern Lisp_Object recursive_edit_1
P_ ((void));
2833 extern void record_auto_save
P_ ((void));
2834 extern void init_keyboard
P_ ((void));
2835 extern void syms_of_keyboard
P_ ((void));
2836 extern void keys_of_keyboard
P_ ((void));
2837 extern char *push_key_description
P_ ((unsigned int, char *, int));
2840 /* defined in indent.c */
2841 EXFUN (Fvertical_motion
, 2);
2842 EXFUN (Findent_to
, 2);
2843 EXFUN (Fcurrent_column
, 0);
2844 EXFUN (Fmove_to_column
, 2);
2845 extern double current_column
P_ ((void));
2846 extern void invalidate_current_column
P_ ((void));
2847 extern int indented_beyond_p
P_ ((int, int, double));
2848 extern void syms_of_indent
P_ ((void));
2850 /* defined in window.c */
2851 extern Lisp_Object Qwindowp
, Qwindow_live_p
;
2852 extern Lisp_Object Vwindow_list
;
2853 EXFUN (Fwindow_end
, 2);
2854 EXFUN (Fselected_window
, 0);
2855 EXFUN (Fnext_window
, 3);
2856 EXFUN (Fdelete_window
, 1);
2857 EXFUN (Fselect_window
, 1);
2858 EXFUN (Fset_window_buffer
, 2);
2859 EXFUN (Fwindow_buffer
, 1);
2860 EXFUN (Fget_buffer_window
, 2);
2861 EXFUN (Fsave_window_excursion
, UNEVALLED
);
2862 EXFUN (Fsplit_window
, 3);
2863 EXFUN (Fset_window_configuration
, 1);
2864 EXFUN (Fcurrent_window_configuration
, 1);
2865 extern int compare_window_configurations
P_ ((Lisp_Object
, Lisp_Object
, int));
2866 EXFUN (Fcoordinates_in_window_p
, 2);
2867 EXFUN (Fwindow_at
, 3);
2868 EXFUN (Fpos_visible_in_window_p
, 3);
2869 extern void mark_window_cursors_off
P_ ((struct window
*));
2870 extern int window_internal_height
P_ ((struct window
*));
2871 extern int window_internal_width
P_ ((struct window
*));
2872 EXFUN (Frecenter
, 1);
2873 EXFUN (Fscroll_other_window
, 1);
2874 EXFUN (Fset_window_start
, 3);
2875 extern void temp_output_buffer_show
P_ ((Lisp_Object
));
2876 extern void replace_buffer_in_all_windows
P_ ((Lisp_Object
));
2877 extern void init_window_once
P_ ((void));
2878 extern void init_window
P_ ((void));
2879 extern void syms_of_window
P_ ((void));
2880 extern void keys_of_window
P_ ((void));
2882 /* defined in frame.c */
2883 extern Lisp_Object Qvisible
;
2884 extern void store_frame_param
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2885 extern void store_in_alist
P_ ((Lisp_Object
*, Lisp_Object
, Lisp_Object
));
2886 extern Lisp_Object do_switch_frame
P_ ((Lisp_Object
, int, int));
2887 extern Lisp_Object get_frame_param
P_ ((struct frame
*, Lisp_Object
));
2888 extern Lisp_Object frame_buffer_predicate
P_ ((Lisp_Object
));
2890 EXFUN (Fselect_frame
, 2);
2891 EXFUN (Fselected_frame
, 0);
2892 EXFUN (Fwindow_frame
, 1);
2893 EXFUN (Fframe_root_window
, 1);
2894 EXFUN (Fframe_first_window
, 1);
2895 EXFUN (Fframe_selected_window
, 1);
2896 EXFUN (Fframe_list
, 0);
2897 EXFUN (Fnext_frame
, 2);
2898 EXFUN (Fdelete_frame
, 2);
2899 EXFUN (Fset_mouse_position
, 3);
2900 EXFUN (Fmake_frame_visible
, 1);
2901 EXFUN (Fmake_frame_invisible
, 2);
2902 EXFUN (Ficonify_frame
, 1);
2903 EXFUN (Fframe_visible_p
, 1);
2904 EXFUN (Fvisible_frame_list
, 0);
2905 EXFUN (Fframe_parameter
, 2);
2906 EXFUN (Fframe_parameters
, 1);
2907 EXFUN (Fmodify_frame_parameters
, 2);
2908 EXFUN (Fset_frame_height
, 3);
2909 EXFUN (Fset_frame_width
, 3);
2910 EXFUN (Fset_frame_size
, 3);
2911 EXFUN (Fset_frame_position
, 3);
2912 EXFUN (Fraise_frame
, 1);
2913 EXFUN (Fredirect_frame_focus
, 2);
2914 EXFUN (Fset_frame_selected_window
, 2);
2915 extern Lisp_Object frame_buffer_list
P_ ((Lisp_Object
));
2916 extern void frames_discard_buffer
P_ ((Lisp_Object
));
2917 extern void set_frame_buffer_list
P_ ((Lisp_Object
, Lisp_Object
));
2918 extern void frames_bury_buffer
P_ ((Lisp_Object
));
2919 extern void syms_of_frame
P_ ((void));
2921 /* defined in emacs.c */
2922 extern Lisp_Object decode_env_path
P_ ((char *, char *));
2923 extern Lisp_Object Vinvocation_name
, Vinvocation_directory
;
2924 extern Lisp_Object Vinstallation_directory
, empty_string
;
2925 EXFUN (Fkill_emacs
, 1);
2927 void fixup_locale
P_ ((void));
2928 void synchronize_system_messages_locale
P_ ((void));
2929 void synchronize_system_time_locale
P_ ((void));
2931 #define setlocale(category, locale)
2932 #define fixup_locale()
2933 #define synchronize_system_messages_locale()
2934 #define synchronize_system_time_locale()
2936 void shut_down_emacs
P_ ((int, int, Lisp_Object
));
2937 /* Nonzero means don't do interactive redisplay and don't change tty modes */
2938 extern int noninteractive
;
2939 /* Nonzero means don't do use window-system-specific display code */
2940 extern int inhibit_window_system
;
2941 /* Nonzero means that a filter or a sentinel is running. */
2942 extern int running_asynch_code
;
2944 /* defined in process.c */
2945 EXFUN (Fget_process
, 1);
2946 EXFUN (Fget_buffer_process
, 1);
2947 EXFUN (Fprocessp
, 1);
2948 EXFUN (Fprocess_status
, 1);
2949 EXFUN (Fkill_process
, 2);
2950 EXFUN (Fprocess_send_eof
, 1);
2951 EXFUN (Fwaiting_for_user_input_p
, 0);
2952 extern Lisp_Object Qprocessp
;
2953 extern void kill_buffer_processes
P_ ((Lisp_Object
));
2954 extern int wait_reading_process_input
P_ ((int, int, Lisp_Object
, int));
2955 extern void deactivate_process
P_ ((Lisp_Object
));
2956 extern void add_keyboard_wait_descriptor
P_ ((int));
2957 extern void delete_keyboard_wait_descriptor
P_ ((int));
2958 extern void close_process_descs
P_ ((void));
2959 extern void status_notify
P_ ((void));
2960 extern int read_process_output
P_ ((Lisp_Object
, int));
2961 extern void init_process
P_ ((void));
2962 extern void syms_of_process
P_ ((void));
2964 /* defined in callproc.c */
2965 extern Lisp_Object Vexec_path
, Vexec_suffixes
,
2966 Vexec_directory
, Vdata_directory
;
2967 extern Lisp_Object Vdoc_directory
;
2968 EXFUN (Fcall_process
, MANY
);
2969 extern int child_setup
P_ ((int, int, int, char **, int, Lisp_Object
));
2970 extern void init_callproc_1
P_ ((void));
2971 extern void init_callproc
P_ ((void));
2972 extern void set_process_environment
P_ ((void));
2973 extern void syms_of_callproc
P_ ((void));
2975 /* defined in doc.c */
2976 extern Lisp_Object Vdoc_file_name
;
2977 EXFUN (Fsubstitute_command_keys
, 1);
2978 EXFUN (Fdocumentation
, 2);
2979 EXFUN (Fdocumentation_property
, 3);
2980 extern Lisp_Object read_doc_string
P_ ((Lisp_Object
));
2981 extern Lisp_Object get_doc_string
P_ ((Lisp_Object
, int, int));
2982 extern void syms_of_doc
P_ ((void));
2983 extern int read_bytecode_char
P_ ((int));
2985 /* defined in bytecode.c */
2986 extern Lisp_Object Qbytecode
;
2987 EXFUN (Fbyte_code
, 3);
2988 extern void syms_of_bytecode
P_ ((void));
2989 extern struct byte_stack
*byte_stack_list
;
2990 extern void mark_byte_stack
P_ ((void));
2991 extern void unmark_byte_stack
P_ ((void));
2993 /* defined in macros.c */
2994 extern Lisp_Object Qexecute_kbd_macro
;
2995 EXFUN (Fexecute_kbd_macro
, 2);
2996 extern void init_macros
P_ ((void));
2997 extern void syms_of_macros
P_ ((void));
2999 /* defined in undo.c */
3000 extern Lisp_Object Qinhibit_read_only
;
3001 EXFUN (Fundo_boundary
, 0);
3002 extern Lisp_Object truncate_undo_list
P_ ((Lisp_Object
, int, int));
3003 extern void record_marker_adjustment
P_ ((Lisp_Object
, int));
3004 extern void record_insert
P_ ((int, int));
3005 extern void record_delete
P_ ((int, Lisp_Object
));
3006 extern void record_first_change
P_ ((void));
3007 extern void record_change
P_ ((int, int));
3008 extern void record_property_change
P_ ((int, int, Lisp_Object
, Lisp_Object
,
3010 extern void syms_of_undo
P_ ((void));
3012 /* defined in textprop.c */
3013 extern Lisp_Object Qmodification_hooks
;
3014 extern Lisp_Object Qrear_nonsticky
, Qfont
, Qmouse_face
;
3015 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3016 EXFUN (Fnext_property_change
, 3);
3017 EXFUN (Fnext_single_property_change
, 4);
3018 EXFUN (Fnext_single_char_property_change
, 4);
3019 EXFUN (Fprevious_single_property_change
, 4);
3020 EXFUN (Fget_text_property
, 3);
3021 EXFUN (Fput_text_property
, 5);
3022 EXFUN (Fset_text_properties
, 4);
3023 EXFUN (Ftext_property_not_all
, 5);
3024 EXFUN (Fprevious_char_property_change
, 2);
3025 EXFUN (Fnext_char_property_change
, 2);
3026 extern void report_interval_modification
P_ ((Lisp_Object
, Lisp_Object
));
3027 extern void syms_of_textprop
P_ ((void));
3028 extern Lisp_Object next_single_char_property_change
P_ ((Lisp_Object
,
3032 extern Lisp_Object set_text_properties
P_ ((Lisp_Object
, Lisp_Object
,
3033 Lisp_Object
, Lisp_Object
,
3036 /* defined in xmenu.c */
3037 EXFUN (Fx_popup_menu
, 2);
3038 EXFUN (Fx_popup_dialog
, 2);
3039 extern void syms_of_xmenu
P_ ((void));
3040 extern int popup_activated_flag
;
3042 /* defined in sysdep.c */
3043 extern void stuff_char
P_ ((char c
));
3044 extern void init_sigio
P_ ((int));
3045 extern void request_sigio
P_ ((void));
3046 extern void unrequest_sigio
P_ ((void));
3047 extern void reset_sys_modes
P_ ((void));
3048 extern void sys_subshell
P_ ((void));
3049 extern void sys_suspend
P_ ((void));
3050 extern void discard_tty_input
P_ ((void));
3051 extern void init_sys_modes
P_ ((void));
3052 extern void reset_sys_modes
P_ ((void));
3053 extern void get_frame_size
P_ ((int *, int *));
3054 extern void wait_for_termination
P_ ((int));
3055 extern void flush_pending_output
P_ ((int));
3056 extern void child_setup_tty
P_ ((int));
3057 extern void setup_pty
P_ ((int));
3058 extern int set_window_size
P_ ((int, int, int));
3059 extern void create_process
P_ ((Lisp_Object
, char **, Lisp_Object
));
3060 extern int tabs_safe_p
P_ ((void));
3061 extern void init_baud_rate
P_ ((void));
3062 extern int emacs_open
P_ ((const char *, int, int));
3063 extern int emacs_close
P_ ((int));
3064 extern int emacs_read
P_ ((int, char *, unsigned int));
3065 extern int emacs_write
P_ ((int, char *, unsigned int));
3067 /* defined in filelock.c */
3068 EXFUN (Funlock_buffer
, 0);
3069 EXFUN (Ffile_locked_p
, 1);
3070 extern void unlock_all_files
P_ ((void));
3071 extern void lock_file
P_ ((Lisp_Object
));
3072 extern void unlock_file
P_ ((Lisp_Object
));
3073 extern void unlock_buffer
P_ ((struct buffer
*));
3074 extern void syms_of_filelock
P_ ((void));
3075 extern void init_filelock
P_ ((void));
3077 /* Defined in sound.c */
3078 extern void syms_of_sound
P_ ((void));
3079 extern void init_sound
P_ ((void));
3081 /* Defined in category.c */
3082 extern void init_category_once
P_ ((void));
3083 extern void syms_of_category
P_ ((void));
3085 /* Defined in ccl.c */
3086 extern void syms_of_ccl
P_ ((void));
3088 /* Defined in dired.c */
3089 EXFUN (Ffile_attributes
, 1);
3090 extern void syms_of_dired
P_ ((void));
3092 /* Defined in term.c */
3093 extern void syms_of_term
P_ ((void));
3094 extern void fatal () NO_RETURN
;
3096 #ifdef HAVE_X_WINDOWS
3097 /* Defined in fontset.c */
3098 extern void syms_of_fontset
P_ ((void));
3099 EXFUN (Fset_fontset_font
, 4);
3102 /* Defined in xfaces.c */
3103 extern void syms_of_xfaces
P_ ((void));
3105 /* Defined in getloadavg.c */
3106 extern int getloadavg
P_ ((double *, int));
3108 #ifdef HAVE_X_WINDOWS
3109 /* Defined in xfns.c */
3110 extern void syms_of_xfns
P_ ((void));
3111 extern void init_xfns
P_ ((void));
3112 extern Lisp_Object Vx_resource_name
;
3113 EXFUN (Fxw_display_color_p
, 1);
3114 EXFUN (Fx_file_dialog
, 4);
3115 #endif /* HAVE_X_WINDOWS */
3117 /* Defined in xsmfns.c */
3118 extern void syms_of_xsmfns
P_ ((void));
3120 /* Defined in xselect.c */
3121 extern void syms_of_xselect
P_ ((void));
3123 /* Defined in xterm.c */
3124 extern void syms_of_xterm
P_ ((void));
3126 /* Defined in getloadavg.c */
3127 extern int getloadavg
P_ ((double [], int));
3129 /* Nonzero means Emacs has already been initialized.
3130 Used during startup to detect startup of dumped Emacs. */
3131 extern int initialized
;
3133 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3135 extern POINTER_TYPE
*xmalloc
P_ ((size_t));
3136 extern POINTER_TYPE
*xrealloc
P_ ((POINTER_TYPE
*, size_t));
3137 extern void xfree
P_ ((POINTER_TYPE
*));
3139 extern char *xstrdup
P_ ((const char *));
3142 extern char *egetenv
P_ ((char *));
3145 /* Set up the name of the machine we're running on. */
3146 extern void init_system_name
P_ ((void));
3148 /* Some systems (e.g., NT) use a different path separator than Unix,
3149 in addition to a device separator. Default the path separator
3150 to '/', and don't test for a device separator in IS_ANY_SEP. */
3153 extern Lisp_Object Vdirectory_sep_char
;
3156 #ifndef DIRECTORY_SEP
3157 #define DIRECTORY_SEP '/'
3159 #ifndef IS_DIRECTORY_SEP
3160 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3162 #ifndef IS_DEVICE_SEP
3164 #define IS_DEVICE_SEP(_c_) 0
3166 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3170 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3173 #ifdef SWITCH_ENUM_BUG
3174 #define SWITCH_ENUM_CAST(x) ((int)(x))
3176 #define SWITCH_ENUM_CAST(x) (x)
3179 /* Loop over Lisp list LIST. Signal an error if LIST is not a proper
3180 list, or if it contains circles.
3182 HARE and TORTOISE should be the names of Lisp_Object variables, and
3183 N should be the name of an EMACS_INT variable declared in the
3184 function where the macro is used. Each nested loop should use
3187 In the loop body, HARE is set to each cons of LIST, and N is the
3188 length of the list processed so far. */
3190 #define LIST_END_P(list, obj) \
3195 : (wrong_type_argument (Qlistp, (list))), 1))
3197 #define FOREACH(hare, list, tortoise, n) \
3198 for (tortoise = hare = (list), n = 0; \
3199 !LIST_END_P (list, hare); \
3200 (hare = XCDR (hare), ++n, \
3202 ? (tortoise = XCDR (tortoise), \
3203 (EQ (hare, tortoise) \
3204 && (circular_list_error ((list)), 1))) \
3207 /* The ubiquitous min and max macros. */
3213 #define min(a, b) ((a) < (b) ? (a) : (b))
3214 #define max(a, b) ((a) > (b) ? (a) : (b))
3216 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3219 #define make_fixnum_or_float(val) \
3220 (FIXNUM_OVERFLOW_P (val) \
3221 ? make_float (val) \
3222 : make_number ((EMACS_INT)(val)))