1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2012 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 3 of the License, or
10 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
30 /* Use the configure flag --enable-checking[=LIST] to enable various
31 types of run time checks for Lisp objects. */
33 #ifdef GC_CHECK_CONS_LIST
34 extern void check_cons_list (void);
35 #define CHECK_CONS_LIST() check_cons_list ()
37 #define CHECK_CONS_LIST() ((void) 0)
40 /* Temporarily disable wider-than-pointer integers until they're tested more.
41 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
42 /* #undef WIDE_EMACS_INT */
44 /* EMACS_INT - signed integer wide enough to hold an Emacs value
45 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
46 pI - printf length modifier for EMACS_INT
47 EMACS_UINT - unsigned variant of EMACS_INT */
49 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
50 typedef long long int EMACS_INT
;
51 typedef unsigned long long int EMACS_UINT
;
52 # define EMACS_INT_MAX LLONG_MAX
54 # elif INT_MAX < LONG_MAX
55 typedef long int EMACS_INT
;
56 typedef unsigned long int EMACS_UINT
;
57 # define EMACS_INT_MAX LONG_MAX
60 typedef int EMACS_INT
;
61 typedef unsigned int EMACS_UINT
;
62 # define EMACS_INT_MAX INT_MAX
67 /* Number of bits in some machine integer types. */
70 BITS_PER_CHAR
= CHAR_BIT
,
71 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
72 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
73 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
74 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
77 /* printmax_t and uprintmax_t are types for printing large integers.
78 These are the widest integers that are supported for printing.
79 pMd etc. are conversions for printing them.
80 On C99 hosts, there's no problem, as even the widest integers work.
81 Fall back on EMACS_INT on pre-C99 hosts. */
83 typedef intmax_t printmax_t
;
84 typedef uintmax_t uprintmax_t
;
88 typedef EMACS_INT printmax_t
;
89 typedef EMACS_UINT uprintmax_t
;
94 /* Use pD to format ptrdiff_t values, which suffice for indexes into
95 buffers and strings. Emacs never allocates objects larger than
96 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
97 In C99, pD can always be "t"; configure it here for the sake of
98 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
99 #if PTRDIFF_MAX == INT_MAX
101 #elif PTRDIFF_MAX == LONG_MAX
103 #elif PTRDIFF_MAX == LLONG_MAX
109 /* Extra internal type checking? */
111 /* Define an Emacs version of 'assert (COND)', since some
112 system-defined 'assert's are flaky. COND should be free of side
113 effects; it may or may not be evaluated. */
114 #ifndef ENABLE_CHECKING
115 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
116 #else /* ENABLE_CHECKING */
118 extern _Noreturn
void die (const char *, const char *, int);
120 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
121 it to 1 using a debugger to temporarily disable aborting on
122 detected internal inconsistencies or error conditions.
124 In some cases, a good compiler may be able to optimize away the
125 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
126 STRINGP (x), but a particular use of XSTRING is invoked only after
127 testing that STRINGP (x) is true, making the test redundant. */
128 extern int suppress_checking EXTERNALLY_VISIBLE
;
130 # define eassert(cond) \
131 ((cond) || suppress_checking \
133 : die ("assertion failed: " # cond, __FILE__, __LINE__))
134 #endif /* ENABLE_CHECKING */
136 /* Use the configure flag --enable-check-lisp-object-type to make
137 Lisp_Object use a struct type instead of the default int. The flag
138 causes CHECK_LISP_OBJECT_TYPE to be defined. */
140 /***** Select the tagging scheme. *****/
141 /* The following option controls the tagging scheme:
142 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
143 always 0, and we can thus use them to hold tag bits, without
144 restricting our addressing space.
146 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
147 restricting our possible address range.
149 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
150 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
151 on the few static Lisp_Objects used: all the defsubr as well
152 as the two special buffers buffer_defaults and buffer_local_symbols. */
154 /* First, try and define DECL_ALIGN(type,var) which declares a static
155 variable VAR of type TYPE with the added requirement that it be
158 /* Number of bits in a Lisp_Obect tag. This can be used in #if. */
161 /* Number of bits in a Lisp_Object value, not counting the tag. */
162 enum { VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
};
164 /* The maximum value that can be stored in a EMACS_INT, assuming all
165 bits other than the type bits contribute to a nonnegative signed value.
166 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
167 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
169 #ifndef NO_DECL_ALIGN
171 # if HAVE_ATTRIBUTE_ALIGNED
172 # define DECL_ALIGN(type, var) \
173 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
174 # elif defined(_MSC_VER)
175 # define ALIGN_GCTYPEBITS 8
176 # if (1 << GCTYPEBITS) != ALIGN_GCTYPEBITS
177 # error ALIGN_GCTYPEBITS is wrong!
179 # define DECL_ALIGN(type, var) \
180 type __declspec(align(ALIGN_GCTYPEBITS)) var
182 /* What directives do other compilers use? */
187 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
189 /* 1. We know malloc returns a multiple of 8. */
190 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
191 || defined DARWIN_OS || defined __sun)
192 /* 2. We can specify multiple-of-8 alignment on static variables. */
194 /* 3. Pointers-as-ints exceed VAL_MAX.
195 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
196 a. unnecessary, because the top bits of an EMACS_INT are unused, and
197 b. slower, because it typically requires extra masking.
198 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
199 # if VAL_MAX < UINTPTR_MAX
200 # define USE_LSB_TAG 1
206 # define USE_LSB_TAG 0
209 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
212 # error "USE_LSB_TAG used without defining DECL_ALIGN"
214 # define DECL_ALIGN(type, var) type var
218 /* Define the fundamental Lisp data structures. */
220 /* This is the set of Lisp data types. */
222 /* Lisp integers use 2 tags, to give them one extra bit, thus
223 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
224 enum { INTTYPEBITS
= GCTYPEBITS
- 1 };
225 enum { FIXNUM_BITS
= VALBITS
+ 1 };
226 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
227 #define LISP_INT_TAG Lisp_Int0
228 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
229 #define LISP_INT1_TAG (USE_LSB_TAG ? 1 << INTTYPEBITS : 1)
230 #define LISP_STRING_TAG (5 - LISP_INT1_TAG)
231 #define LISP_INT_TAG_P(x) (((x) & ~LISP_INT1_TAG) == 0)
233 /* Stolen from GDB. The only known compiler that doesn't support
234 enums in bitfields is MSVC. */
236 #define ENUM_BF(TYPE) unsigned int
238 #define ENUM_BF(TYPE) enum TYPE
244 /* Integer. XINT (obj) is the integer value. */
246 Lisp_Int1
= LISP_INT1_TAG
,
248 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
251 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
252 whose first member indicates the subtype. */
255 /* String. XSTRING (object) points to a struct Lisp_String.
256 The length of the string, and its contents, are stored therein. */
257 Lisp_String
= LISP_STRING_TAG
,
259 /* Vector of Lisp objects, or something resembling it.
260 XVECTOR (object) points to a struct Lisp_Vector, which contains
261 the size and contents. The size field also contains the type
262 information, if it's not a real vector object. */
265 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
271 /* This is the set of data types that share a common structure.
272 The first member of the structure is a type code from this set.
273 The enum values are arbitrary, but we'll use large numbers to make it
274 more likely that we'll spot the error if a random word in memory is
275 mistakenly interpreted as a Lisp_Misc. */
278 Lisp_Misc_Free
= 0x5eab,
281 Lisp_Misc_Save_Value
,
282 /* Currently floats are not a misc type,
283 but let's define this in case we want to change that. */
285 /* This is not a type code. It is for range checking. */
289 /* These are the types of forwarding objects used in the value slot
290 of symbols for special built-in variables whose value is stored in
294 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
295 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
296 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
297 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
298 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
301 #ifdef CHECK_LISP_OBJECT_TYPE
303 typedef struct { EMACS_INT i
; } Lisp_Object
;
306 static inline Lisp_Object
309 Lisp_Object o
= { i
};
313 static inline Lisp_Object
314 LISP_MAKE_RVALUE (Lisp_Object o
)
319 #define LISP_INITIALLY_ZERO {0}
321 #else /* CHECK_LISP_OBJECT_TYPE */
323 /* If a struct type is not wanted, define Lisp_Object as just a number. */
325 typedef EMACS_INT Lisp_Object
;
328 #define LISP_MAKE_RVALUE(o) (0+(o))
329 #define LISP_INITIALLY_ZERO 0
330 #define CHECK_LISP_OBJECT_TYPE 0
331 #endif /* CHECK_LISP_OBJECT_TYPE */
333 /* In the size word of a vector, this bit means the vector has been marked. */
335 #define ARRAY_MARK_FLAG PTRDIFF_MIN
337 /* In the size word of a struct Lisp_Vector, this bit means it's really
338 some other vector-like object. */
339 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
341 /* In a pseudovector, the size field actually contains a word with one
342 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
343 indicate the actual type.
344 We use a bitset, even tho only one of the bits can be set at any
345 particular time just so as to be able to use micro-optimizations such as
346 testing membership of a particular subset of pseudovectors in Fequal.
347 It is not crucial, but there are plenty of bits here, so why not do it? */
350 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
359 PVEC_WINDOW_CONFIGURATION
,
362 /* These last 4 are special because we OR them in fns.c:internal_equal,
363 so they have to use a disjoint bit pattern:
364 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
365 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
366 PVEC_COMPILED
= 0x10,
367 PVEC_CHAR_TABLE
= 0x20,
368 PVEC_SUB_CHAR_TABLE
= 0x30,
372 /* For convenience, we also store the number of elements in these bits.
373 Note that this size is not necessarily the memory-footprint size, but
374 only the number of Lisp_Object fields (that need to be traced by the GC).
375 The distinction is used e.g. by Lisp_Process which places extra
376 non-Lisp_Object fields at the end of the structure. */
379 PSEUDOVECTOR_SIZE_BITS
= 16,
380 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
381 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
384 /* Number of bits to put in each character in the internal representation
385 of bool vectors. This should not vary across implementations. */
386 enum { BOOL_VECTOR_BITS_PER_CHAR
= 8 };
388 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
389 which were stored in a Lisp_Object */
390 #ifndef DATA_SEG_BITS
391 # define DATA_SEG_BITS 0
394 /* These macros extract various sorts of values from a Lisp_Object.
395 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
396 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
398 /* Return a perfect hash of the Lisp_Object representation. */
399 #define XHASH(a) XLI (a)
403 #define VALMASK (-1 << GCTYPEBITS)
404 #define TYPEMASK ((1 << GCTYPEBITS) - 1)
405 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
406 #define XINT(a) (XLI (a) >> INTTYPEBITS)
407 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
408 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
409 #define XSET(var, type, ptr) \
410 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
411 (var) = XIL ((type) | (intptr_t) (ptr)))
413 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
414 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
416 #else /* not USE_LSB_TAG */
418 #define VALMASK VAL_MAX
420 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
422 /* For integers known to be positive, XFASTINT provides fast retrieval
423 and XSETFASTINT provides fast storage. This takes advantage of the
424 fact that Lisp integers have zero-bits in their tags. */
425 #define XFASTINT(a) (XLI (a) + 0)
426 #define XSETFASTINT(a, b) ((a) = XIL (b))
428 /* Extract the value of a Lisp_Object as a (un)signed integer. */
430 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
431 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
432 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
434 #define XSET(var, type, ptr) \
435 ((var) = XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
436 + ((intptr_t) (ptr) & VALMASK)))
439 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
440 which were stored in a Lisp_Object */
441 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
443 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
446 #endif /* not USE_LSB_TAG */
448 /* For integers known to be positive, XFASTINT sometimes provides
449 faster retrieval and XSETFASTINT provides faster storage.
450 If not, fallback on the non-accelerated path. */
452 # define XFASTINT(a) (XINT (a))
453 # define XSETFASTINT(a, b) (XSETINT (a, b))
456 /* Extract the pointer value of the Lisp object A, under the
457 assumption that A's type is TYPE. This is a fallback
458 implementation if nothing faster is available. */
460 # define XUNTAG(a, type) XPNTR (a)
463 #define EQ(x, y) (XHASH (x) == XHASH (y))
465 /* Largest and smallest representable fixnum values. These are the C
467 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
468 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
470 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
471 written this way so that it also works if I is of unsigned
472 type or if I is a NaN. */
474 #define FIXNUM_OVERFLOW_P(i) \
475 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
477 static inline ptrdiff_t
478 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
480 return num
< lower
? lower
: num
<= upper
? num
: upper
;
483 /* Extract a value or address from a Lisp_Object. */
485 #define XCONS(a) (eassert (CONSP (a)), \
486 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
487 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
488 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
489 #define XSTRING(a) (eassert (STRINGP (a)), \
490 (struct Lisp_String *) XUNTAG (a, Lisp_String))
491 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
492 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
493 #define XFLOAT(a) (eassert (FLOATP (a)), \
494 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
498 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
499 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
500 #define XMISCTYPE(a) (XMISCANY (a)->type)
501 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
502 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
503 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
505 /* Forwarding object types. */
507 #define XFWDTYPE(a) (a->u_intfwd.type)
508 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
509 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
510 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
511 #define XBUFFER_OBJFWD(a) \
512 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
513 #define XKBOARD_OBJFWD(a) \
514 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
516 /* Pseudovector types. */
518 #define XPROCESS(a) (eassert (PROCESSP (a)), \
519 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
520 #define XWINDOW(a) (eassert (WINDOWP (a)), \
521 (struct window *) XUNTAG (a, Lisp_Vectorlike))
522 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
523 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
524 #define XSUBR(a) (eassert (SUBRP (a)), \
525 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
526 #define XBUFFER(a) (eassert (BUFFERP (a)), \
527 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
528 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
529 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
530 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
531 ((struct Lisp_Sub_Char_Table *) \
532 XUNTAG (a, Lisp_Vectorlike)))
533 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
534 ((struct Lisp_Bool_Vector *) \
535 XUNTAG (a, Lisp_Vectorlike)))
537 /* Construct a Lisp_Object from a value or address. */
539 #define XSETINT(a, b) (a) = make_number (b)
540 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
541 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
542 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
543 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
544 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
548 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
549 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
551 /* Pseudovector types. */
553 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
554 #define XSETTYPED_PVECTYPE(v, size_member, code) \
555 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
556 #define XSETPVECTYPESIZE(v, code, sizeval) \
557 ((v)->header.size = (PSEUDOVECTOR_FLAG \
558 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
561 /* The cast to struct vectorlike_header * avoids aliasing issues. */
562 #define XSETPSEUDOVECTOR(a, b, code) \
563 XSETTYPED_PSEUDOVECTOR (a, b, \
564 (((struct vectorlike_header *) \
565 XUNTAG (a, Lisp_Vectorlike)) \
568 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
569 (XSETVECTOR (a, b), \
570 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
571 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
573 #define XSETWINDOW_CONFIGURATION(a, b) \
574 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
575 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
576 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
577 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
578 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
579 #define XSETSUBR(a, b) \
580 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
581 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
582 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
583 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
584 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
585 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
587 /* Convenience macros for dealing with Lisp arrays. */
589 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
590 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
591 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
592 #define ASET(ARRAY, IDX, VAL) \
593 (eassert ((IDX) == (IDX)), \
594 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
595 AREF ((ARRAY), (IDX)) = (VAL))
597 /* Convenience macros for dealing with Lisp strings. */
599 #define SDATA(string) (XSTRING (string)->data + 0)
600 #define SREF(string, index) (SDATA (string)[index] + 0)
601 #define SSET(string, index, new) (SDATA (string)[index] = (new))
602 #define SCHARS(string) (XSTRING (string)->size + 0)
603 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
605 /* Avoid "differ in sign" warnings. */
606 #define SSDATA(x) ((char *) SDATA (x))
608 #define STRING_SET_CHARS(string, newsize) \
609 (XSTRING (string)->size = (newsize))
611 #define STRING_COPYIN(string, index, new, count) \
612 memcpy (SDATA (string) + index, new, count)
616 #define CHECK_TYPE(ok, Qxxxp, x) \
617 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
621 /* See the macros in intervals.h. */
623 typedef struct interval
*INTERVAL
;
625 /* Complain if object is not string or buffer type */
626 #define CHECK_STRING_OR_BUFFER(x) \
627 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
630 /* In a cons, the markbit of the car is the gc mark bit */
634 /* Please do not use the names of these elements in code other
635 than the core lisp implementation. Use XCAR and XCDR below. */
636 #ifdef HIDE_LISP_IMPLEMENTATION
641 struct Lisp_Cons
*chain
;
648 struct Lisp_Cons
*chain
;
653 /* Take the car or cdr of something known to be a cons cell. */
654 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
655 of code that has to know what a cons cell looks like. Other code not
656 part of the basic lisp implementation should assume that the car and cdr
657 fields are not accessible as lvalues. (What if we want to switch to
658 a copying collector someday? Cached cons cell field addresses may be
659 invalidated at arbitrary points.) */
660 #ifdef HIDE_LISP_IMPLEMENTATION
661 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
662 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
664 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
665 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
668 /* Use these from normal code. */
669 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
670 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
672 /* Use these to set the fields of a cons cell.
674 Note that both arguments may refer to the same object, so 'n'
675 should not be read after 'c' is first modified. Also, neither
676 argument should be evaluated more than once; side effects are
677 especially common in the second argument. */
678 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
679 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
681 /* Take the car or cdr of something whose type is not known. */
683 (CONSP ((c)) ? XCAR ((c)) \
684 : NILP ((c)) ? Qnil \
685 : wrong_type_argument (Qlistp, (c)))
688 (CONSP ((c)) ? XCDR ((c)) \
689 : NILP ((c)) ? Qnil \
690 : wrong_type_argument (Qlistp, (c)))
692 /* Take the car or cdr of something whose type is not known. */
693 #define CAR_SAFE(c) \
694 (CONSP ((c)) ? XCAR ((c)) : Qnil)
696 #define CDR_SAFE(c) \
697 (CONSP ((c)) ? XCDR ((c)) : Qnil)
699 /* Nonzero if STR is a multibyte string. */
700 #define STRING_MULTIBYTE(STR) \
701 (XSTRING (STR)->size_byte >= 0)
703 /* Return the length in bytes of STR. */
705 #ifdef GC_CHECK_STRING_BYTES
708 extern ptrdiff_t string_bytes (struct Lisp_String
*);
709 #define STRING_BYTES(S) string_bytes ((S))
711 #else /* not GC_CHECK_STRING_BYTES */
713 #define STRING_BYTES(STR) \
714 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
716 #endif /* not GC_CHECK_STRING_BYTES */
718 /* An upper bound on the number of bytes in a Lisp string, not
719 counting the terminating null. This a tight enough bound to
720 prevent integer overflow errors that would otherwise occur during
721 string size calculations. A string cannot contain more bytes than
722 a fixnum can represent, nor can it be so long that C pointer
723 arithmetic stops working on the string plus its terminating null.
724 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
725 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
726 would expose alloc.c internal details that we'd rather keep
727 private. The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is
729 #define STRING_BYTES_BOUND \
730 min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1)
732 /* Mark STR as a unibyte string. */
733 #define STRING_SET_UNIBYTE(STR) \
734 do { if (EQ (STR, empty_multibyte_string)) \
735 (STR) = empty_unibyte_string; \
736 else XSTRING (STR)->size_byte = -1; } while (0)
738 /* Mark STR as a multibyte string. Assure that STR contains only
739 ASCII characters in advance. */
740 #define STRING_SET_MULTIBYTE(STR) \
741 do { if (EQ (STR, empty_unibyte_string)) \
742 (STR) = empty_multibyte_string; \
743 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
745 /* Get text properties. */
746 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
748 /* Set text properties. */
749 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
751 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
757 INTERVAL intervals
; /* Text properties in this string. */
761 /* Header of vector-like objects. This documents the layout constraints on
762 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
763 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
764 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
765 because when two such pointers potentially alias, a compiler won't
766 incorrectly reorder loads and stores to their size fields. See
767 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
768 struct vectorlike_header
770 /* This field contains various pieces of information:
771 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
772 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
773 vector (0) or a pseudovector (1).
774 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
775 of slots) of the vector.
776 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
777 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
778 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
779 Lisp_Object slots at the beginning of the object that need to be
780 traced by the GC, tho some types use it slightly differently.
781 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
782 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
786 /* When the vector is allocated from a vector block, NBYTES is used
787 if the vector is not on a free list, and VECTOR is used otherwise.
788 For large vector-like objects, BUFFER or VECTOR is used as a pointer
789 to the next vector-like object. It is generally a buffer or a
790 Lisp_Vector alias, so for convenience it is a union instead of a
791 pointer: this way, one can write P->next.vector instead of ((struct
792 Lisp_Vector *) P->next). */
794 /* This is only needed for small vectors that are not free because the
795 `size' field only gives us the number of Lisp_Object slots, whereas we
796 need to know the total size, including non-Lisp_Object data.
797 FIXME: figure out a way to store this info elsewhere so we can
798 finally get rid of this extra word of overhead. */
800 struct buffer
*buffer
;
801 /* FIXME: This can be removed: For large vectors, this field could be
802 placed *before* the vector itself. And for small vectors on a free
803 list, this field could be stored in the vector's bytes, since the
804 empty vector is handled specially anyway. */
805 struct Lisp_Vector
*vector
;
811 struct vectorlike_header header
;
812 Lisp_Object contents
[1];
815 /* If a struct is made to look like a vector, this macro returns the length
816 of the shortest vector that would hold that struct. */
817 #define VECSIZE(type) ((sizeof (type) \
818 - offsetof (struct Lisp_Vector, contents[0]) \
819 + sizeof (Lisp_Object) - 1) /* Round up. */ \
820 / sizeof (Lisp_Object))
822 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
823 at the end and we need to compute the number of Lisp_Object fields (the
824 ones that the GC needs to trace). */
825 #define PSEUDOVECSIZE(type, nonlispfield) \
826 ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \
827 / sizeof (Lisp_Object))
829 /* A char-table is a kind of vectorlike, with contents are like a
830 vector but with a few other slots. For some purposes, it makes
831 sense to handle a char-table with type struct Lisp_Vector. An
832 element of a char table can be any Lisp objects, but if it is a sub
833 char-table, we treat it a table that contains information of a
834 specific range of characters. A sub char-table has the same
835 structure as a vector. A sub char table appears only in an element
836 of a char-table, and there's no way to access it directly from
837 Emacs Lisp program. */
839 /* This is the number of slots that every char table must have. This
840 counts the ordinary slots and the top, defalt, parent, and purpose
842 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
844 /* Return the number of "extra" slots in the char table CT. */
846 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
847 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
851 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
852 ({struct Lisp_Char_Table *_tbl = NULL; \
855 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
856 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
857 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
859 _val = _tbl->defalt; \
860 } while (NILP (_val) && ! NILP (_tbl->parent)); \
863 #else /* not __GNUC__ */
865 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
866 (! NILP (XCHAR_TABLE (CT)->ascii) \
867 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
868 ? XCHAR_TABLE (CT)->ascii \
869 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
870 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
871 : char_table_ref ((CT), (IDX))) \
872 : char_table_ref ((CT), (IDX)))
874 #endif /* not __GNUC__ */
876 /* Compute A OP B, using the unsigned comparison operator OP. A and B
877 should be integer expressions. This is not the same as
878 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
879 returns 1. For efficiency, prefer plain unsigned comparison if A
880 and B's sizes both fit (after integer promotion). */
881 #define UNSIGNED_CMP(a, op, b) \
882 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
883 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
884 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
886 /* Nonzero iff C is an ASCII character. */
887 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
889 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
890 characters. Do not check validity of CT. */
891 #define CHAR_TABLE_REF(CT, IDX) \
892 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
893 : char_table_ref ((CT), (IDX)))
895 /* Almost equivalent to Faref (CT, IDX). However, if the result is
896 not a character, return IDX.
898 For these characters, do not check validity of CT
899 and do not follow parent. */
900 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
901 char_table_translate (CT, IDX)
903 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
904 8-bit European characters. Do not check validity of CT. */
905 #define CHAR_TABLE_SET(CT, IDX, VAL) \
906 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
907 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
908 : char_table_set (CT, IDX, VAL))
910 #define CHARTAB_SIZE_BITS_0 6
911 #define CHARTAB_SIZE_BITS_1 4
912 #define CHARTAB_SIZE_BITS_2 5
913 #define CHARTAB_SIZE_BITS_3 7
915 extern const int chartab_size
[4];
917 struct Lisp_Sub_Char_Table
;
919 struct Lisp_Char_Table
921 /* HEADER.SIZE is the vector's size field, which also holds the
922 pseudovector type information. It holds the size, too.
923 The size counts the defalt, parent, purpose, ascii,
924 contents, and extras slots. */
925 struct vectorlike_header header
;
927 /* This holds a default value,
928 which is used whenever the value for a specific character is nil. */
931 /* This points to another char table, which we inherit from when the
932 value for a specific character is nil. The `defalt' slot takes
933 precedence over this. */
936 /* This is a symbol which says what kind of use this char-table is
940 /* The bottom sub char-table for characters of the range 0..127. It
941 is nil if none of ASCII character has a specific value. */
944 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
946 /* These hold additional data. It is a vector. */
947 Lisp_Object extras
[1];
950 struct Lisp_Sub_Char_Table
952 /* HEADER.SIZE is the vector's size field, which also holds the
953 pseudovector type information. It holds the size, too. */
954 struct vectorlike_header header
;
956 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
957 char-table of depth 1 contains 16 elements, and each element
958 covers 4096 (128*32) characters. A sub char-table of depth 2
959 contains 32 elements, and each element covers 128 characters. A
960 sub char-table of depth 3 contains 128 elements, and each element
961 is for one character. */
964 /* Minimum character covered by the sub char-table. */
965 Lisp_Object min_char
;
967 Lisp_Object contents
[1];
970 /* A boolvector is a kind of vectorlike, with contents are like a string. */
971 struct Lisp_Bool_Vector
973 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
974 just the subtype information. */
975 struct vectorlike_header header
;
976 /* This is the size in bits. */
978 /* This contains the actual bits, packed into bytes. */
979 unsigned char data
[1];
982 /* This structure describes a built-in function.
983 It is generated by the DEFUN macro only.
984 defsubr makes it into a Lisp object.
986 This type is treated in most respects as a pseudovector,
987 but since we never dynamically allocate or free them,
988 we don't need a struct vectorlike_header and its 'next' field. */
994 Lisp_Object (*a0
) (void);
995 Lisp_Object (*a1
) (Lisp_Object
);
996 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
997 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
998 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
999 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1000 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1001 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1002 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1003 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1004 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1006 short min_args
, max_args
;
1007 const char *symbol_name
;
1008 const char *intspec
;
1013 /***********************************************************************
1015 ***********************************************************************/
1017 /* Interned state of a symbol. */
1019 enum symbol_interned
1021 SYMBOL_UNINTERNED
= 0,
1022 SYMBOL_INTERNED
= 1,
1023 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1026 enum symbol_redirect
1028 SYMBOL_PLAINVAL
= 4,
1029 SYMBOL_VARALIAS
= 1,
1030 SYMBOL_LOCALIZED
= 2,
1031 SYMBOL_FORWARDED
= 3
1036 unsigned gcmarkbit
: 1;
1038 /* Indicates where the value can be found:
1039 0 : it's a plain var, the value is in the `value' field.
1040 1 : it's a varalias, the value is really in the `alias' symbol.
1041 2 : it's a localized var, the value is in the `blv' object.
1042 3 : it's a forwarding variable, the value is in `forward'. */
1043 ENUM_BF (symbol_redirect
) redirect
: 3;
1045 /* Non-zero means symbol is constant, i.e. changing its value
1046 should signal an error. If the value is 3, then the var
1047 can be changed, but only by `defconst'. */
1048 unsigned constant
: 2;
1050 /* Interned state of the symbol. This is an enumerator from
1051 enum symbol_interned. */
1052 unsigned interned
: 2;
1054 /* Non-zero means that this variable has been explicitly declared
1055 special (with `defvar' etc), and shouldn't be lexically bound. */
1056 unsigned declared_special
: 1;
1058 /* The symbol's name, as a Lisp string.
1059 The name "xname" is used to intentionally break code referring to
1060 the old field "name" of type pointer to struct Lisp_String. */
1063 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1064 union is used depends on the `redirect' field above. */
1067 struct Lisp_Symbol
*alias
;
1068 struct Lisp_Buffer_Local_Value
*blv
;
1069 union Lisp_Fwd
*fwd
;
1072 /* Function value of the symbol or Qunbound if not fboundp. */
1073 Lisp_Object function
;
1075 /* The symbol's property list. */
1078 /* Next symbol in obarray bucket, if the symbol is interned. */
1079 struct Lisp_Symbol
*next
;
1082 /* Value is name of symbol. */
1084 #define SYMBOL_VAL(sym) \
1085 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1086 #define SYMBOL_ALIAS(sym) \
1087 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1088 #define SYMBOL_BLV(sym) \
1089 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1090 #define SYMBOL_FWD(sym) \
1091 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1092 #define SET_SYMBOL_VAL(sym, v) \
1093 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1094 #define SET_SYMBOL_ALIAS(sym, v) \
1095 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1096 #define SET_SYMBOL_BLV(sym, v) \
1097 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1098 #define SET_SYMBOL_FWD(sym, v) \
1099 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1101 #define SYMBOL_NAME(sym) \
1102 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1104 /* Value is non-zero if SYM is an interned symbol. */
1106 #define SYMBOL_INTERNED_P(sym) \
1107 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1109 /* Value is non-zero if SYM is interned in initial_obarray. */
1111 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1112 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1114 /* Value is non-zero if symbol is considered a constant, i.e. its
1115 value cannot be changed (there is an exception for keyword symbols,
1116 whose value can be set to the keyword symbol itself). */
1118 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1120 #define DEFSYM(sym, name) \
1121 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1124 /***********************************************************************
1126 ***********************************************************************/
1128 /* The structure of a Lisp hash table. */
1130 struct Lisp_Hash_Table
1132 /* This is for Lisp; the hash table code does not refer to it. */
1133 struct vectorlike_header header
;
1135 /* Function used to compare keys. */
1138 /* Nil if table is non-weak. Otherwise a symbol describing the
1139 weakness of the table. */
1142 /* When the table is resized, and this is an integer, compute the
1143 new size by adding this to the old size. If a float, compute the
1144 new size by multiplying the old size with this factor. */
1145 Lisp_Object rehash_size
;
1147 /* Resize hash table when number of entries/ table size is >= this
1149 Lisp_Object rehash_threshold
;
1151 /* Vector of hash codes.. If hash[I] is nil, this means that that
1152 entry I is unused. */
1155 /* Vector used to chain entries. If entry I is free, next[I] is the
1156 entry number of the next free item. If entry I is non-free,
1157 next[I] is the index of the next entry in the collision chain. */
1160 /* Index of first free entry in free list. */
1161 Lisp_Object next_free
;
1163 /* Bucket vector. A non-nil entry is the index of the first item in
1164 a collision chain. This vector's size can be larger than the
1165 hash table size to reduce collisions. */
1168 /* User-supplied hash function, or nil. */
1169 Lisp_Object user_hash_function
;
1171 /* User-supplied key comparison function, or nil. */
1172 Lisp_Object user_cmp_function
;
1174 /* Only the fields above are traced normally by the GC. The ones below
1175 `count' are special and are either ignored by the GC or traced in
1176 a special way (e.g. because of weakness). */
1178 /* Number of key/value entries in the table. */
1181 /* Vector of keys and values. The key of item I is found at index
1182 2 * I, the value is found at index 2 * I + 1.
1183 This is gc_marked specially if the table is weak. */
1184 Lisp_Object key_and_value
;
1186 /* Next weak hash table if this is a weak hash table. The head
1187 of the list is in weak_hash_tables. */
1188 struct Lisp_Hash_Table
*next_weak
;
1190 /* C function to compare two keys. */
1191 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1192 Lisp_Object
, EMACS_UINT
,
1193 Lisp_Object
, EMACS_UINT
);
1195 /* C function to compute hash code. */
1196 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1200 #define XHASH_TABLE(OBJ) \
1201 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1203 #define XSET_HASH_TABLE(VAR, PTR) \
1204 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1206 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1208 #define CHECK_HASH_TABLE(x) \
1209 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1211 /* Value is the key part of entry IDX in hash table H. */
1213 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1215 /* Value is the value part of entry IDX in hash table H. */
1217 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1219 /* Value is the index of the next entry following the one at IDX
1222 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1224 /* Value is the hash code computed for entry IDX in hash table H. */
1226 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1228 /* Value is the index of the element in hash table H that is the
1229 start of the collision list at index IDX in the index vector of H. */
1231 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1233 /* Value is the size of hash table H. */
1235 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1237 /* Default size for hash tables if not specified. */
1239 #define DEFAULT_HASH_SIZE 65
1241 /* Default threshold specifying when to resize a hash table. The
1242 value gives the ratio of current entries in the hash table and the
1243 size of the hash table. */
1245 #define DEFAULT_REHASH_THRESHOLD 0.8
1247 /* Default factor by which to increase the size of a hash table. */
1249 #define DEFAULT_REHASH_SIZE 1.5
1252 /* These structures are used for various misc types. */
1254 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1256 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1257 unsigned gcmarkbit
: 1;
1263 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1264 unsigned gcmarkbit
: 1;
1266 /* This flag is temporarily used in the functions
1267 decode/encode_coding_object to record that the marker position
1268 must be adjusted after the conversion. */
1269 unsigned int need_adjustment
: 1;
1270 /* 1 means normal insertion at the marker's position
1271 leaves the marker after the inserted text. */
1272 unsigned int insertion_type
: 1;
1273 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1274 Note: a chain of markers can contain markers pointing into different
1275 buffers (the chain is per buffer_text rather than per buffer, so it's
1276 shared between indirect buffers). */
1277 /* This is used for (other than NULL-checking):
1279 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1280 - unchain_marker: to find the list from which to unchain.
1281 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1283 struct buffer
*buffer
;
1285 /* The remaining fields are meaningless in a marker that
1286 does not point anywhere. */
1288 /* For markers that point somewhere,
1289 this is used to chain of all the markers in a given buffer. */
1290 /* We could remove it and use an array in buffer_text instead.
1291 That would also allow to preserve it ordered. */
1292 struct Lisp_Marker
*next
;
1293 /* This is the char position where the marker points. */
1295 /* This is the byte position.
1296 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1297 used to implement the functionality of markers, but rather to (ab)use
1298 markers as a cache for char<->byte mappings). */
1302 /* START and END are markers in the overlay's buffer, and
1303 PLIST is the overlay's property list. */
1305 /* An overlay's real data content is:
1307 - buffer (really there are two buffer pointers, one per marker,
1308 and both points to the same buffer)
1309 - insertion type of both ends (per-marker fields)
1310 - start & start byte (of start marker)
1311 - end & end byte (of end marker)
1312 - next (singly linked list of overlays)
1313 - next fields of start and end markers (singly linked list of markers).
1314 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1317 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1318 unsigned gcmarkbit
: 1;
1320 struct Lisp_Overlay
*next
;
1321 Lisp_Object start
, end
, plist
;
1324 /* Hold a C pointer for later use.
1325 This type of object is used in the arg to record_unwind_protect. */
1326 struct Lisp_Save_Value
1328 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1329 unsigned gcmarkbit
: 1;
1331 /* If DOGC is set, POINTER is the address of a memory
1332 area containing INTEGER potential Lisp_Objects. */
1333 unsigned int dogc
: 1;
1339 /* A miscellaneous object, when it's on the free list. */
1342 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1343 unsigned gcmarkbit
: 1;
1345 union Lisp_Misc
*chain
;
1348 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1349 It uses one of these struct subtypes to get the type field. */
1353 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1354 struct Lisp_Free u_free
;
1355 struct Lisp_Marker u_marker
;
1356 struct Lisp_Overlay u_overlay
;
1357 struct Lisp_Save_Value u_save_value
;
1360 /* Forwarding pointer to an int variable.
1361 This is allowed only in the value cell of a symbol,
1362 and it means that the symbol's value really lives in the
1363 specified int variable. */
1366 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1370 /* Boolean forwarding pointer to an int variable.
1371 This is like Lisp_Intfwd except that the ostensible
1372 "value" of the symbol is t if the int variable is nonzero,
1373 nil if it is zero. */
1376 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1380 /* Forwarding pointer to a Lisp_Object variable.
1381 This is allowed only in the value cell of a symbol,
1382 and it means that the symbol's value really lives in the
1383 specified variable. */
1386 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1387 Lisp_Object
*objvar
;
1390 /* Like Lisp_Objfwd except that value lives in a slot in the
1391 current buffer. Value is byte index of slot within buffer. */
1392 struct Lisp_Buffer_Objfwd
1394 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1396 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1399 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1400 the symbol has buffer-local or frame-local bindings. (Exception:
1401 some buffer-local variables are built-in, with their values stored
1402 in the buffer structure itself. They are handled differently,
1403 using struct Lisp_Buffer_Objfwd.)
1405 The `realvalue' slot holds the variable's current value, or a
1406 forwarding pointer to where that value is kept. This value is the
1407 one that corresponds to the loaded binding. To read or set the
1408 variable, you must first make sure the right binding is loaded;
1409 then you can access the value in (or through) `realvalue'.
1411 `buffer' and `frame' are the buffer and frame for which the loaded
1412 binding was found. If those have changed, to make sure the right
1413 binding is loaded it is necessary to find which binding goes with
1414 the current buffer and selected frame, then load it. To load it,
1415 first unload the previous binding, then copy the value of the new
1416 binding into `realvalue' (or through it). Also update
1417 LOADED-BINDING to point to the newly loaded binding.
1419 `local_if_set' indicates that merely setting the variable creates a
1420 local binding for the current buffer. Otherwise the latter, setting
1421 the variable does not do that; only make-local-variable does that. */
1423 struct Lisp_Buffer_Local_Value
1425 /* 1 means that merely setting the variable creates a local
1426 binding for the current buffer. */
1427 unsigned int local_if_set
: 1;
1428 /* 1 means this variable can have frame-local bindings, otherwise, it is
1429 can have buffer-local bindings. The two cannot be combined. */
1430 unsigned int frame_local
: 1;
1431 /* 1 means that the binding now loaded was found.
1432 Presumably equivalent to (defcell!=valcell). */
1433 unsigned int found
: 1;
1434 /* If non-NULL, a forwarding to the C var where it should also be set. */
1435 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1436 /* The buffer or frame for which the loaded binding was found. */
1438 /* A cons cell that holds the default value. It has the form
1439 (SYMBOL . DEFAULT-VALUE). */
1440 Lisp_Object defcell
;
1441 /* The cons cell from `where's parameter alist.
1442 It always has the form (SYMBOL . VALUE)
1443 Note that if `forward' is non-nil, VALUE may be out of date.
1444 Also if the currently loaded binding is the default binding, then
1445 this is `eq'ual to defcell. */
1446 Lisp_Object valcell
;
1449 #define BLV_FOUND(blv) \
1450 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1451 #define SET_BLV_FOUND(blv, v) \
1452 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1454 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1455 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1457 /* Like Lisp_Objfwd except that value lives in a slot in the
1459 struct Lisp_Kboard_Objfwd
1461 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1467 struct Lisp_Intfwd u_intfwd
;
1468 struct Lisp_Boolfwd u_boolfwd
;
1469 struct Lisp_Objfwd u_objfwd
;
1470 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1471 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1474 /* Lisp floating point type. */
1479 #ifdef HIDE_LISP_IMPLEMENTATION
1484 struct Lisp_Float
*chain
;
1488 #ifdef HIDE_LISP_IMPLEMENTATION
1489 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1491 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1492 /* This should be used only in alloc.c, which always disables
1493 HIDE_LISP_IMPLEMENTATION. */
1494 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1497 /* A character, declared with the following typedef, is a member
1498 of some character set associated with the current buffer. */
1499 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1501 typedef unsigned char UCHAR
;
1504 /* Meanings of slots in a Lisp_Compiled: */
1506 #define COMPILED_ARGLIST 0
1507 #define COMPILED_BYTECODE 1
1508 #define COMPILED_CONSTANTS 2
1509 #define COMPILED_STACK_DEPTH 3
1510 #define COMPILED_DOC_STRING 4
1511 #define COMPILED_INTERACTIVE 5
1513 /* Flag bits in a character. These also get used in termhooks.h.
1514 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1515 (MUlti-Lingual Emacs) might need 22 bits for the character value
1516 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1517 #define CHAR_ALT (0x0400000)
1518 #define CHAR_SUPER (0x0800000)
1519 #define CHAR_HYPER (0x1000000)
1520 #define CHAR_SHIFT (0x2000000)
1521 #define CHAR_CTL (0x4000000)
1522 #define CHAR_META (0x8000000)
1524 #define CHAR_MODIFIER_MASK \
1525 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1528 /* Actually, the current Emacs uses 22 bits for the character value
1530 #define CHARACTERBITS 22
1533 /* The glyph datatype, used to represent characters on the display.
1534 It consists of a char code and a face id. */
1541 /* Return a glyph's character code. */
1542 #define GLYPH_CHAR(glyph) ((glyph).ch)
1544 /* Return a glyph's face ID. */
1545 #define GLYPH_FACE(glyph) ((glyph).face_id)
1547 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1548 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1549 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1551 /* Return 1 if GLYPH contains valid character code. */
1552 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1555 /* Glyph Code from a display vector may either be an integer which
1556 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1557 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1559 #define GLYPH_CODE_P(gc) \
1561 ? (CHARACTERP (XCAR (gc)) \
1562 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1563 : (RANGED_INTEGERP \
1565 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1566 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1567 : TYPE_MAXIMUM (EMACS_INT)))))
1569 /* The following are valid only if GLYPH_CODE_P (gc). */
1571 #define GLYPH_CODE_CHAR(gc) \
1572 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1574 #define GLYPH_CODE_FACE(gc) \
1575 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1577 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1581 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1583 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1584 (XINT (gc) >> CHARACTERBITS)); \
1588 /* The ID of the mode line highlighting face. */
1589 #define GLYPH_MODE_LINE_FACE 1
1591 /* Structure to hold mouse highlight data. This is here because other
1592 header files need it for defining struct x_output etc. */
1594 /* These variables describe the range of text currently shown in its
1595 mouse-face, together with the window they apply to. As long as
1596 the mouse stays within this range, we need not redraw anything on
1597 its account. Rows and columns are glyph matrix positions in
1598 MOUSE_FACE_WINDOW. */
1599 int mouse_face_beg_row
, mouse_face_beg_col
;
1600 int mouse_face_beg_x
, mouse_face_beg_y
;
1601 int mouse_face_end_row
, mouse_face_end_col
;
1602 int mouse_face_end_x
, mouse_face_end_y
;
1603 int mouse_face_past_end
;
1604 Lisp_Object mouse_face_window
;
1605 int mouse_face_face_id
;
1606 Lisp_Object mouse_face_overlay
;
1608 /* 1 if a mouse motion event came and we didn't handle it right away because
1609 gc was in progress. */
1610 int mouse_face_deferred_gc
;
1612 /* FRAME and X, Y position of mouse when last checked for
1613 highlighting. X and Y can be negative or out of range for the frame. */
1614 struct frame
*mouse_face_mouse_frame
;
1615 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1617 /* Nonzero means defer mouse-motion highlighting. */
1618 int mouse_face_defer
;
1620 /* Nonzero means that the mouse highlight should not be shown. */
1621 int mouse_face_hidden
;
1623 int mouse_face_image_state
;
1626 /* Data type checking */
1628 #define NILP(x) EQ (x, Qnil)
1630 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1631 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1633 #define RANGED_INTEGERP(lo, x, hi) \
1634 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1635 #define TYPE_RANGED_INTEGERP(type, x) \
1636 (TYPE_SIGNED (type) \
1637 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1638 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1640 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1641 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1642 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1643 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1644 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1645 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1647 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1648 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1649 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1650 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1651 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1653 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1654 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1655 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1656 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1657 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1659 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1660 vectorlike_header * avoids aliasing issues. */
1661 #define PSEUDOVECTORP(x, code) \
1662 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1664 #define PSEUDOVECTOR_TYPEP(v, code) \
1665 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1666 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1668 /* True if object X, with internal type struct T *, is a pseudovector whose
1670 #define TYPED_PSEUDOVECTORP(x, t, code) \
1672 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1674 /* Test for specific pseudovector types. */
1675 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1676 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1677 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1678 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1679 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1680 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1681 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1682 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1683 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1684 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1685 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1686 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1688 /* Test for image (image . spec) */
1689 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1694 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1696 #define CHECK_LIST(x) \
1697 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1699 #define CHECK_LIST_CONS(x, y) \
1700 CHECK_TYPE (CONSP (x), Qlistp, y)
1702 #define CHECK_LIST_END(x, y) \
1703 CHECK_TYPE (NILP (x), Qlistp, y)
1705 #define CHECK_STRING(x) \
1706 CHECK_TYPE (STRINGP (x), Qstringp, x)
1708 #define CHECK_STRING_CAR(x) \
1709 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1711 #define CHECK_CONS(x) \
1712 CHECK_TYPE (CONSP (x), Qconsp, x)
1714 #define CHECK_SYMBOL(x) \
1715 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1717 #define CHECK_CHAR_TABLE(x) \
1718 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1720 #define CHECK_VECTOR(x) \
1721 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1723 #define CHECK_VECTOR_OR_STRING(x) \
1724 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1726 #define CHECK_ARRAY(x, Qxxxp) \
1727 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1729 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1730 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1732 #define CHECK_BUFFER(x) \
1733 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1735 #define CHECK_WINDOW(x) \
1736 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1738 #define CHECK_WINDOW_CONFIGURATION(x) \
1739 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1741 /* This macro rejects windows on the interior of the window tree as
1742 "dead", which is what we want; this is an argument-checking macro, and
1743 the user should never get access to interior windows.
1745 A window of any sort, leaf or interior, is dead if the buffer,
1746 vchild, and hchild members are all nil. */
1748 #define CHECK_LIVE_WINDOW(x) \
1749 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1751 #define CHECK_PROCESS(x) \
1752 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1754 #define CHECK_SUBR(x) \
1755 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1757 #define CHECK_NUMBER(x) \
1758 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1760 #define CHECK_NATNUM(x) \
1761 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1763 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1766 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1767 args_out_of_range_3 \
1769 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1770 ? MOST_NEGATIVE_FIXNUM \
1772 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1774 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1776 if (TYPE_SIGNED (type)) \
1777 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1779 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1782 #define CHECK_MARKER(x) \
1783 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1785 #define CHECK_NUMBER_COERCE_MARKER(x) \
1786 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1787 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1789 #define XFLOATINT(n) extract_float((n))
1791 #define CHECK_FLOAT(x) \
1792 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1794 #define CHECK_NUMBER_OR_FLOAT(x) \
1795 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1797 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1798 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1799 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1801 #define CHECK_OVERLAY(x) \
1802 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1804 /* Since we can't assign directly to the CAR or CDR fields of a cons
1805 cell, use these when checking that those fields contain numbers. */
1806 #define CHECK_NUMBER_CAR(x) \
1808 Lisp_Object tmp = XCAR (x); \
1809 CHECK_NUMBER (tmp); \
1810 XSETCAR ((x), tmp); \
1813 #define CHECK_NUMBER_CDR(x) \
1815 Lisp_Object tmp = XCDR (x); \
1816 CHECK_NUMBER (tmp); \
1817 XSETCDR ((x), tmp); \
1820 #define CHECK_NATNUM_CAR(x) \
1822 Lisp_Object tmp = XCAR (x); \
1823 CHECK_NATNUM (tmp); \
1824 XSETCAR ((x), tmp); \
1827 #define CHECK_NATNUM_CDR(x) \
1829 Lisp_Object tmp = XCDR (x); \
1830 CHECK_NATNUM (tmp); \
1831 XSETCDR ((x), tmp); \
1834 /* Define a built-in function for calling from Lisp.
1835 `lname' should be the name to give the function in Lisp,
1836 as a null-terminated C string.
1837 `fnname' should be the name of the function in C.
1838 By convention, it starts with F.
1839 `sname' should be the name for the C constant structure
1840 that records information on this function for internal use.
1841 By convention, it should be the same as `fnname' but with S instead of F.
1842 It's too bad that C macros can't compute this from `fnname'.
1843 `minargs' should be a number, the minimum number of arguments allowed.
1844 `maxargs' should be a number, the maximum number of arguments allowed,
1845 or else MANY or UNEVALLED.
1846 MANY means pass a vector of evaluated arguments,
1847 in the form of an integer number-of-arguments
1848 followed by the address of a vector of Lisp_Objects
1849 which contains the argument values.
1850 UNEVALLED means pass the list of unevaluated arguments
1851 `intspec' says how interactive arguments are to be fetched.
1852 If the string starts with a `(', `intspec' is evaluated and the resulting
1853 list is the list of arguments.
1854 If it's a string that doesn't start with `(', the value should follow
1855 the one of the doc string for `interactive'.
1856 A null string means call interactively with no arguments.
1857 `doc' is documentation for the user. */
1859 /* This version of DEFUN declares a function prototype with the right
1860 arguments, so we can catch errors with maxargs at compile-time. */
1862 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1863 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1864 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1865 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1866 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1867 { (Lisp_Object (__cdecl *)(void))fnname }, \
1868 minargs, maxargs, lname, intspec, 0}; \
1870 #else /* not _MSC_VER */
1871 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1872 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1873 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1874 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1875 { .a ## maxargs = fnname }, \
1876 minargs, maxargs, lname, intspec, 0}; \
1880 /* Note that the weird token-substitution semantics of ANSI C makes
1881 this work for MANY and UNEVALLED. */
1882 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1883 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1884 #define DEFUN_ARGS_0 (void)
1885 #define DEFUN_ARGS_1 (Lisp_Object)
1886 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1887 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1888 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1889 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1891 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1892 Lisp_Object, Lisp_Object)
1893 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1894 Lisp_Object, Lisp_Object, Lisp_Object)
1895 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1896 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1898 /* Non-zero if OBJ is a Lisp function. */
1899 #define FUNCTIONP(OBJ) \
1900 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1901 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1902 || COMPILEDP (OBJ) \
1906 is how we define the symbol for function `name' at start-up time. */
1907 extern void defsubr (struct Lisp_Subr
*);
1910 #define UNEVALLED -1
1912 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1913 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1914 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1915 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1916 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1918 /* Macros we use to define forwarded Lisp variables.
1919 These are used in the syms_of_FILENAME functions.
1921 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1922 lisp variable is actually a field in `struct emacs_globals'. The
1923 field's name begins with "f_", which is a convention enforced by
1924 these macros. Each such global has a corresponding #define in
1925 globals.h; the plain name should be used in the code.
1927 E.g., the global "cons_cells_consed" is declared as "int
1928 f_cons_cells_consed" in globals.h, but there is a define:
1930 #define cons_cells_consed globals.f_cons_cells_consed
1932 All C code uses the `cons_cells_consed' name. This is all done
1933 this way to support indirection for multi-threaded Emacs. */
1935 #define DEFVAR_LISP(lname, vname, doc) \
1937 static struct Lisp_Objfwd o_fwd; \
1938 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1940 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1942 static struct Lisp_Objfwd o_fwd; \
1943 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1945 #define DEFVAR_BOOL(lname, vname, doc) \
1947 static struct Lisp_Boolfwd b_fwd; \
1948 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1950 #define DEFVAR_INT(lname, vname, doc) \
1952 static struct Lisp_Intfwd i_fwd; \
1953 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1956 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1958 static struct Lisp_Objfwd o_fwd; \
1959 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1962 #define DEFVAR_KBOARD(lname, vname, doc) \
1964 static struct Lisp_Kboard_Objfwd ko_fwd; \
1965 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1970 /* Structure for recording Lisp call stack for backtrace purposes. */
1972 /* The special binding stack holds the outer values of variables while
1973 they are bound by a function application or a let form, stores the
1974 code to be executed for Lisp unwind-protect forms, and stores the C
1975 functions to be called for record_unwind_protect.
1977 If func is non-zero, undoing this binding applies func to old_value;
1978 This implements record_unwind_protect.
1980 Otherwise, the element is a variable binding.
1982 If the symbol field is a symbol, it is an ordinary variable binding.
1984 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
1985 which means having bound a local value while CURRENT-BUFFER was active.
1986 If WHERE is nil this means we saw the default value when binding SYMBOL.
1987 WHERE being a buffer or frame means we saw a buffer-local or frame-local
1988 value. Other values of WHERE mean an internal error. */
1990 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
1994 Lisp_Object symbol
, old_value
;
1995 specbinding_func func
;
1996 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
1999 extern struct specbinding
*specpdl
;
2000 extern struct specbinding
*specpdl_ptr
;
2001 extern ptrdiff_t specpdl_size
;
2003 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2005 /* Everything needed to describe an active condition case. */
2008 /* The handler clauses and variable from the condition-case form. */
2009 /* For a handler set up in Lisp code, this is always a list.
2010 For an internal handler set up by internal_condition_case*,
2011 this can instead be the symbol t or `error'.
2012 t: handle all conditions.
2013 error: handle all conditions, and errors can run the debugger
2014 or display a backtrace. */
2015 Lisp_Object handler
;
2017 /* Fsignal stores here the condition-case clause that applies,
2018 and Fcondition_case thus knows which clause to run. */
2019 Lisp_Object chosen_clause
;
2021 /* Used to effect the longjump out to the handler. */
2022 struct catchtag
*tag
;
2024 /* The next enclosing handler. */
2025 struct handler
*next
;
2028 /* This structure helps implement the `catch' and `throw' control
2029 structure. A struct catchtag contains all the information needed
2030 to restore the state of the interpreter after a non-local jump.
2032 Handlers for error conditions (represented by `struct handler'
2033 structures) just point to a catch tag to do the cleanup required
2036 catchtag structures are chained together in the C calling stack;
2037 the `next' member points to the next outer catchtag.
2039 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2040 member is TAG, and then unbinds to it. The `val' member is used to
2041 hold VAL while the stack is unwound; `val' is returned as the value
2044 All the other members are concerned with restoring the interpreter
2051 struct catchtag
*next
;
2052 struct gcpro
*gcpro
;
2054 struct backtrace
*backlist
;
2055 struct handler
*handlerlist
;
2056 EMACS_INT lisp_eval_depth
;
2058 int poll_suppress_count
;
2059 int interrupt_input_blocked
;
2060 struct byte_stack
*byte_stack
;
2063 extern Lisp_Object memory_signal_data
;
2065 /* An address near the bottom of the stack.
2066 Tells GC how to save a copy of the stack. */
2067 extern char *stack_bottom
;
2069 /* Check quit-flag and quit if it is non-nil.
2070 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2071 So the program needs to do QUIT at times when it is safe to quit.
2072 Every loop that might run for a long time or might not exit
2073 ought to do QUIT at least once, at a safe place.
2074 Unless that is impossible, of course.
2075 But it is very desirable to avoid creating loops where QUIT is impossible.
2077 Exception: if you set immediate_quit to nonzero,
2078 then the handler that responds to the C-g does the quit itself.
2079 This is a good thing to do around a loop that has no side effects
2080 and (in particular) cannot call arbitrary Lisp code.
2082 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2083 a request to exit Emacs when it is safe to do. */
2086 extern void process_pending_signals (void);
2087 extern int pending_signals
;
2088 #define ELSE_PENDING_SIGNALS \
2089 else if (pending_signals) \
2090 process_pending_signals ();
2091 #else /* not SYNC_INPUT */
2092 #define ELSE_PENDING_SIGNALS
2093 #endif /* not SYNC_INPUT */
2095 extern void process_quit_flag (void);
2098 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2099 process_quit_flag (); \
2100 ELSE_PENDING_SIGNALS \
2104 /* Nonzero if ought to quit now. */
2106 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2108 extern Lisp_Object Vascii_downcase_table
;
2109 extern Lisp_Object Vascii_canon_table
;
2111 /* Structure for recording stack slots that need marking. */
2113 /* This is a chain of structures, each of which points at a Lisp_Object
2114 variable whose value should be marked in garbage collection.
2115 Normally every link of the chain is an automatic variable of a function,
2116 and its `val' points to some argument or local variable of the function.
2117 On exit to the function, the chain is set back to the value it had on entry.
2118 This way, no link remains in the chain when the stack frame containing the
2121 Every function that can call Feval must protect in this fashion all
2122 Lisp_Object variables whose contents will be used again. */
2124 extern struct gcpro
*gcprolist
;
2130 /* Address of first protected variable. */
2131 volatile Lisp_Object
*var
;
2133 /* Number of consecutive protected variables. */
2141 /* Values of GC_MARK_STACK during compilation:
2143 0 Use GCPRO as before
2144 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2145 2 Mark the stack, and check that everything GCPRO'd is
2147 3 Mark using GCPRO's, mark stack last, and count how many
2148 dead objects are kept alive. */
2151 #define GC_USE_GCPROS_AS_BEFORE 0
2152 #define GC_MAKE_GCPROS_NOOPS 1
2153 #define GC_MARK_STACK_CHECK_GCPROS 2
2154 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2156 #ifndef GC_MARK_STACK
2157 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2160 /* Whether we do the stack marking manually. */
2161 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2162 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2165 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2167 /* Do something silly with gcproN vars just so gcc shuts up. */
2168 /* You get warnings from MIPSPro... */
2170 #define GCPRO1(varname) ((void) gcpro1)
2171 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2172 #define GCPRO3(varname1, varname2, varname3) \
2173 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2174 #define GCPRO4(varname1, varname2, varname3, varname4) \
2175 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2176 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2177 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2178 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2179 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2181 #define UNGCPRO ((void) 0)
2183 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2187 #define GCPRO1(varname) \
2188 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2189 gcprolist = &gcpro1; }
2191 #define GCPRO2(varname1, varname2) \
2192 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2193 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2194 gcprolist = &gcpro2; }
2196 #define GCPRO3(varname1, varname2, varname3) \
2197 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2198 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2199 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2200 gcprolist = &gcpro3; }
2202 #define GCPRO4(varname1, varname2, varname3, varname4) \
2203 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2204 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2205 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2206 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2207 gcprolist = &gcpro4; }
2209 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2210 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2211 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2212 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2213 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2214 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2215 gcprolist = &gcpro5; }
2217 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2218 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2219 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2220 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2221 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2222 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2223 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2224 gcprolist = &gcpro6; }
2226 #define UNGCPRO (gcprolist = gcpro1.next)
2230 extern int gcpro_level
;
2232 #define GCPRO1(varname) \
2233 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2234 gcpro1.level = gcpro_level++; \
2235 gcprolist = &gcpro1; }
2237 #define GCPRO2(varname1, varname2) \
2238 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2239 gcpro1.level = gcpro_level; \
2240 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2241 gcpro2.level = gcpro_level++; \
2242 gcprolist = &gcpro2; }
2244 #define GCPRO3(varname1, varname2, varname3) \
2245 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2246 gcpro1.level = gcpro_level; \
2247 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2248 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2249 gcpro3.level = gcpro_level++; \
2250 gcprolist = &gcpro3; }
2252 #define GCPRO4(varname1, varname2, varname3, varname4) \
2253 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2254 gcpro1.level = gcpro_level; \
2255 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2256 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2257 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2258 gcpro4.level = gcpro_level++; \
2259 gcprolist = &gcpro4; }
2261 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2262 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2263 gcpro1.level = gcpro_level; \
2264 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2265 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2266 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2267 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2268 gcpro5.level = gcpro_level++; \
2269 gcprolist = &gcpro5; }
2271 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2272 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2273 gcpro1.level = gcpro_level; \
2274 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2275 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2276 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2277 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2278 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2279 gcpro6.level = gcpro_level++; \
2280 gcprolist = &gcpro6; }
2283 ((--gcpro_level != gcpro1.level) \
2285 : ((gcprolist = gcpro1.next), 0))
2287 #endif /* DEBUG_GCPRO */
2288 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2291 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2292 #define RETURN_UNGCPRO(expr) \
2295 Lisp_Object ret_ungc_val; \
2296 ret_ungc_val = (expr); \
2298 return ret_ungc_val; \
2302 /* Call staticpro (&var) to protect static variable `var'. */
2304 void staticpro (Lisp_Object
*);
2306 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2307 meaning as in the DEFUN macro, and is used to construct a prototype. */
2308 /* We can use the same trick as in the DEFUN macro to generate the
2309 appropriate prototype. */
2310 #define EXFUN(fnname, maxargs) \
2311 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2313 /* Forward declarations for prototypes. */
2317 /* Defined in data.c. */
2318 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2319 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2320 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2321 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2322 extern Lisp_Object Qinvalid_read_syntax
;
2323 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2324 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2325 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2326 extern Lisp_Object Qtext_read_only
;
2327 extern Lisp_Object Qinteractive_form
;
2328 extern Lisp_Object Qcircular_list
;
2329 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2330 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2331 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2332 extern Lisp_Object Qbuffer_or_string_p
;
2333 extern Lisp_Object Qfboundp
;
2334 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2336 extern Lisp_Object Qcdr
;
2338 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2339 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2341 extern Lisp_Object Qfloatp
;
2342 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2344 extern Lisp_Object Qinteger
, Qinterval
, Qsymbol
, Qstring
;
2345 extern Lisp_Object Qmisc
, Qvector
, Qfloat
, Qcons
, Qbuffer
;
2347 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2349 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2351 /* Defined in frame.c */
2352 extern Lisp_Object Qframep
;
2354 /* Defined in data.c */
2355 extern Lisp_Object
indirect_function (Lisp_Object
);
2356 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2358 /* Convert the integer I to an Emacs representation, either the integer
2359 itself, or a cons of two or three integers, or if all else fails a float.
2360 I should not have side effects. */
2361 #define INTEGER_TO_CONS(i) \
2362 (! FIXNUM_OVERFLOW_P (i) \
2364 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2365 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2366 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2367 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2368 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2369 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2370 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2371 ? Fcons (make_number ((i) >> 16 >> 24), \
2372 Fcons (make_number ((i) >> 16 & 0xffffff), \
2373 make_number ((i) & 0xffff))) \
2376 /* Convert the Emacs representation CONS back to an integer of type
2377 TYPE, storing the result the variable VAR. Signal an error if CONS
2378 is not a valid representation or is out of range for TYPE. */
2379 #define CONS_TO_INTEGER(cons, type, var) \
2380 (TYPE_SIGNED (type) \
2381 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2382 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2383 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2384 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2386 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2387 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2388 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2390 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2391 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2392 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2393 extern void syms_of_data (void);
2394 extern void init_data (void);
2395 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2397 /* Defined in cmds.c */
2398 extern void syms_of_cmds (void);
2399 extern void keys_of_cmds (void);
2401 /* Defined in coding.c */
2402 extern Lisp_Object Qcharset
;
2403 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2404 ptrdiff_t, int, int, Lisp_Object
);
2405 extern void init_coding (void);
2406 extern void init_coding_once (void);
2407 extern void syms_of_coding (void);
2409 /* Defined in character.c */
2410 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2411 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2412 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2413 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2414 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2415 extern void syms_of_character (void);
2417 /* Defined in charset.c */
2418 extern void init_charset (void);
2419 extern void init_charset_once (void);
2420 extern void syms_of_charset (void);
2421 /* Structure forward declarations. */
2424 /* Defined in composite.c */
2425 extern void syms_of_composite (void);
2427 /* Defined in syntax.c */
2428 extern void init_syntax_once (void);
2429 extern void syms_of_syntax (void);
2431 /* Defined in fns.c */
2432 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2433 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2434 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2435 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2436 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2437 extern void sweep_weak_hash_tables (void);
2438 extern Lisp_Object Qcursor_in_echo_area
;
2439 extern Lisp_Object Qstring_lessp
;
2440 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2441 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2442 EMACS_UINT
sxhash (Lisp_Object
, int);
2443 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2444 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2446 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2447 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2450 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2451 ptrdiff_t, ptrdiff_t);
2452 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2453 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2454 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2455 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2456 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2457 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2458 extern void clear_string_char_byte_cache (void);
2459 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2460 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2461 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2462 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2463 extern void syms_of_fns (void);
2465 /* Defined in floatfns.c */
2466 extern double extract_float (Lisp_Object
);
2467 extern void init_floatfns (void);
2468 extern void syms_of_floatfns (void);
2469 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2471 /* Defined in fringe.c */
2472 extern void syms_of_fringe (void);
2473 extern void init_fringe (void);
2474 #ifdef HAVE_WINDOW_SYSTEM
2475 extern void mark_fringe_data (void);
2476 extern void init_fringe_once (void);
2477 #endif /* HAVE_WINDOW_SYSTEM */
2479 /* Defined in image.c */
2480 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2481 extern Lisp_Object QCconversion
;
2482 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2483 extern void syms_of_image (void);
2485 /* Defined in insdel.c */
2486 extern Lisp_Object Qinhibit_modification_hooks
;
2487 extern void move_gap (ptrdiff_t);
2488 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2489 extern _Noreturn
void buffer_overflow (void);
2490 extern void make_gap (ptrdiff_t);
2491 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2492 ptrdiff_t, int, int);
2493 extern int count_combining_before (const unsigned char *,
2494 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2495 extern int count_combining_after (const unsigned char *,
2496 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2497 extern void insert (const char *, ptrdiff_t);
2498 extern void insert_and_inherit (const char *, ptrdiff_t);
2499 extern void insert_1 (const char *, ptrdiff_t, int, int, int);
2500 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2502 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2503 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2504 ptrdiff_t, ptrdiff_t, int);
2505 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2506 extern void insert_char (int);
2507 extern void insert_string (const char *);
2508 extern void insert_before_markers (const char *, ptrdiff_t);
2509 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2510 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2511 ptrdiff_t, ptrdiff_t,
2513 extern void del_range (ptrdiff_t, ptrdiff_t);
2514 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, int, int);
2515 extern void del_range_byte (ptrdiff_t, ptrdiff_t, int);
2516 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int);
2517 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2518 ptrdiff_t, ptrdiff_t, int);
2519 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2520 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2521 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2522 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2523 ptrdiff_t, ptrdiff_t);
2524 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2525 ptrdiff_t, ptrdiff_t);
2526 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, int, int, int);
2527 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2528 const char *, ptrdiff_t, ptrdiff_t, int);
2529 extern void syms_of_insdel (void);
2531 /* Defined in dispnew.c */
2532 #if (defined PROFILING \
2533 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2534 _Noreturn
void __executable_start (void);
2536 extern Lisp_Object selected_frame
;
2537 extern Lisp_Object Vwindow_system
;
2538 void duration_to_sec_usec (double, int *, int *);
2539 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2540 extern void init_display (void);
2541 extern void syms_of_display (void);
2543 /* Defined in xdisp.c */
2544 extern Lisp_Object Qinhibit_point_motion_hooks
;
2545 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2546 extern Lisp_Object Qmenu_bar_update_hook
;
2547 extern Lisp_Object Qwindow_scroll_functions
;
2548 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2549 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2550 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2551 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2552 extern Lisp_Object Qleft_margin
, Qright_margin
;
2553 extern Lisp_Object Qglyphless_char
;
2554 extern Lisp_Object QCdata
, QCfile
;
2555 extern Lisp_Object QCmap
;
2556 extern Lisp_Object Qrisky_local_variable
;
2557 extern struct frame
*last_glyphless_glyph_frame
;
2558 extern int last_glyphless_glyph_face_id
;
2559 extern int last_glyphless_glyph_merged_face_id
;
2560 extern int noninteractive_need_newline
;
2561 extern Lisp_Object echo_area_buffer
[2];
2562 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2563 extern void check_message_stack (void);
2564 extern void setup_echo_area_for_printing (int);
2565 extern int push_message (void);
2566 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2567 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2568 extern void restore_message (void);
2569 extern Lisp_Object
current_message (void);
2570 extern void clear_message (int, int);
2571 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2572 extern void message1 (const char *);
2573 extern void message1_nolog (const char *);
2574 extern void message2 (const char *, ptrdiff_t, int);
2575 extern void message2_nolog (const char *, ptrdiff_t, int);
2576 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2577 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2578 extern void message_dolog (const char *, ptrdiff_t, int, int);
2579 extern void message_with_string (const char *, Lisp_Object
, int);
2580 extern void message_log_maybe_newline (void);
2581 extern void update_echo_area (void);
2582 extern void truncate_echo_area (ptrdiff_t);
2583 extern void redisplay (void);
2584 extern void redisplay_preserve_echo_area (int);
2585 extern void prepare_menu_bars (void);
2587 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2588 extern void syms_of_xdisp (void);
2589 extern void init_xdisp (void);
2590 extern Lisp_Object
safe_eval (Lisp_Object
);
2591 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2592 int *, int *, int *, int *, int *);
2594 /* Defined in xsettings.c */
2595 extern void syms_of_xsettings (void);
2597 /* Defined in vm-limit.c. */
2598 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2600 /* Defined in alloc.c */
2601 extern void check_pure_size (void);
2602 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2603 extern void reset_malloc_hooks (void);
2604 extern void uninterrupt_malloc (void);
2605 extern void malloc_warning (const char *);
2606 extern _Noreturn
void memory_full (size_t);
2607 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2608 extern int survives_gc_p (Lisp_Object
);
2609 extern void mark_object (Lisp_Object
);
2610 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2611 extern void refill_memory_reserve (void);
2613 extern const char *pending_malloc_warning
;
2614 extern Lisp_Object zero_vector
;
2615 extern Lisp_Object
*stack_base
;
2616 extern EMACS_INT consing_since_gc
;
2617 extern EMACS_INT gc_relative_threshold
;
2618 extern EMACS_INT memory_full_cons_threshold
;
2619 extern Lisp_Object
list1 (Lisp_Object
);
2620 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2621 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2622 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2623 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2625 extern _Noreturn
void string_overflow (void);
2626 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2627 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2628 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2629 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2631 /* Make unibyte string from C string when the length isn't known. */
2633 static inline Lisp_Object
2634 build_unibyte_string (const char *str
)
2636 return make_unibyte_string (str
, strlen (str
));
2639 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2640 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2641 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2642 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2643 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2644 extern Lisp_Object
make_specified_string (const char *,
2645 ptrdiff_t, ptrdiff_t, int);
2646 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, int);
2647 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2649 /* Make a string allocated in pure space, use STR as string data. */
2651 static inline Lisp_Object
2652 build_pure_c_string (const char *str
)
2654 return make_pure_c_string (str
, strlen (str
));
2657 /* Make a string from the data at STR, treating it as multibyte if the
2660 static inline Lisp_Object
2661 build_string (const char *str
)
2663 return make_string (str
, strlen (str
));
2666 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2667 extern void make_byte_code (struct Lisp_Vector
*);
2668 extern Lisp_Object Qchar_table_extra_slots
;
2669 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2670 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2671 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2673 allocate_pseudovector \
2674 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2675 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2676 extern struct window
*allocate_window (void);
2677 extern struct frame
*allocate_frame (void);
2678 extern struct Lisp_Process
*allocate_process (void);
2679 extern struct terminal
*allocate_terminal (void);
2680 extern int gc_in_progress
;
2681 extern int abort_on_gc
;
2682 extern Lisp_Object
make_float (double);
2683 extern void display_malloc_warning (void);
2684 extern ptrdiff_t inhibit_garbage_collection (void);
2685 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2686 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2687 extern void free_marker (Lisp_Object
);
2688 extern void free_cons (struct Lisp_Cons
*);
2689 extern void init_alloc_once (void);
2690 extern void init_alloc (void);
2691 extern void syms_of_alloc (void);
2692 extern struct buffer
* allocate_buffer (void);
2693 extern int valid_lisp_object_p (Lisp_Object
);
2696 /* Defined in ralloc.c */
2697 extern void *r_alloc (void **, size_t);
2698 extern void r_alloc_free (void **);
2699 extern void *r_re_alloc (void **, size_t);
2700 extern void r_alloc_reset_variable (void **, void **);
2701 extern void r_alloc_inhibit_buffer_relocation (int);
2704 /* Defined in chartab.c */
2705 extern Lisp_Object
copy_char_table (Lisp_Object
);
2706 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2707 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2709 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2710 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2712 extern int char_table_translate (Lisp_Object
, int);
2713 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2715 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2716 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2717 Lisp_Object
, Lisp_Object
,
2718 Lisp_Object
, struct charset
*,
2719 unsigned, unsigned);
2720 extern Lisp_Object
uniprop_table (Lisp_Object
);
2721 extern void syms_of_chartab (void);
2723 /* Defined in print.c */
2724 extern Lisp_Object Vprin1_to_string_buffer
;
2725 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2726 extern Lisp_Object Qstandard_output
;
2727 extern Lisp_Object Qexternal_debugging_output
;
2728 extern void temp_output_buffer_setup (const char *);
2729 extern int print_level
;
2730 extern Lisp_Object Qprint_escape_newlines
;
2731 extern void write_string (const char *, int);
2732 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2734 extern Lisp_Object internal_with_output_to_temp_buffer
2735 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2736 #define FLOAT_TO_STRING_BUFSIZE 350
2737 extern int float_to_string (char *, double);
2738 extern void syms_of_print (void);
2740 /* Defined in doprnt.c */
2741 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2743 extern ptrdiff_t esprintf (char *, char const *, ...)
2744 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2745 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2747 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2748 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2749 char const *, va_list)
2750 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2752 /* Defined in lread.c. */
2753 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2754 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2755 extern Lisp_Object
check_obarray (Lisp_Object
);
2756 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
2757 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
2758 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
2759 #define LOADHIST_ATTACH(x) \
2761 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2763 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2764 Lisp_Object
*, Lisp_Object
);
2765 Lisp_Object
string_to_number (char const *, int, int);
2766 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2768 extern void dir_warning (const char *, Lisp_Object
);
2769 extern void close_load_descs (void);
2770 extern void init_obarray (void);
2771 extern void init_lread (void);
2772 extern void syms_of_lread (void);
2774 static inline Lisp_Object
2775 intern (const char *str
)
2777 return intern_1 (str
, strlen (str
));
2780 static inline Lisp_Object
2781 intern_c_string (const char *str
)
2783 return intern_c_string_1 (str
, strlen (str
));
2786 /* Defined in eval.c. */
2787 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
2788 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2789 extern Lisp_Object Qand_rest
;
2790 extern Lisp_Object Vautoload_queue
;
2791 extern Lisp_Object Vsignaling_function
;
2792 extern Lisp_Object inhibit_lisp_code
;
2793 extern int handling_signal
;
2795 extern struct catchtag
*catchlist
;
2796 extern struct handler
*handlerlist
;
2798 /* To run a normal hook, use the appropriate function from the list below.
2799 The calling convention:
2801 if (!NILP (Vrun_hooks))
2802 call1 (Vrun_hooks, Qmy_funny_hook);
2804 should no longer be used. */
2805 extern Lisp_Object Vrun_hooks
;
2806 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2807 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2808 Lisp_Object (*funcall
)
2809 (ptrdiff_t nargs
, Lisp_Object
*args
));
2810 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
2811 extern _Noreturn
void xsignal0 (Lisp_Object
);
2812 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
2813 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2814 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2816 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
2817 extern Lisp_Object
eval_sub (Lisp_Object form
);
2818 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2819 extern Lisp_Object
call0 (Lisp_Object
);
2820 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2821 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2822 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2823 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2824 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2825 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2826 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2827 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2828 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2829 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2830 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2831 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2832 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2833 extern void specbind (Lisp_Object
, Lisp_Object
);
2834 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2835 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
2836 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2837 extern _Noreturn
void verror (const char *, va_list)
2838 ATTRIBUTE_FORMAT_PRINTF (1, 0);
2839 extern Lisp_Object
un_autoload (Lisp_Object
);
2840 extern void init_eval_once (void);
2841 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
*);
2842 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
2843 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2844 extern void init_eval (void);
2846 extern void mark_backtrace (void);
2848 extern void syms_of_eval (void);
2850 /* Defined in editfns.c. */
2851 extern Lisp_Object Qfield
;
2852 extern void insert1 (Lisp_Object
);
2853 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
2854 extern Lisp_Object
save_excursion_save (void);
2855 extern Lisp_Object
save_restriction_save (void);
2856 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
2857 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
2858 extern _Noreturn
void time_overflow (void);
2859 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, int);
2860 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2862 extern void init_editfns (void);
2863 const char *get_system_name (void);
2864 extern void syms_of_editfns (void);
2865 extern void set_time_zone_rule (const char *);
2867 /* Defined in buffer.c. */
2868 extern int mouse_face_overlay_overlaps (Lisp_Object
);
2869 extern _Noreturn
void nsberror (Lisp_Object
);
2870 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
2871 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
2872 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
2873 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
2874 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2875 extern int overlay_touches_p (ptrdiff_t);
2876 extern Lisp_Object Vbuffer_alist
;
2877 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
2878 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
2879 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
2880 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
2881 extern void init_buffer_once (void);
2882 extern void init_buffer (void);
2883 extern void syms_of_buffer (void);
2884 extern void keys_of_buffer (void);
2886 /* Defined in marker.c. */
2888 extern ptrdiff_t marker_position (Lisp_Object
);
2889 extern ptrdiff_t marker_byte_position (Lisp_Object
);
2890 extern void clear_charpos_cache (struct buffer
*);
2891 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
2892 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
2893 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
2894 extern void unchain_marker (struct Lisp_Marker
*marker
);
2895 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2896 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
2897 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
2898 ptrdiff_t, ptrdiff_t);
2899 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
2900 extern void syms_of_marker (void);
2902 /* Defined in fileio.c */
2904 extern Lisp_Object Qfile_error
;
2905 extern Lisp_Object Qfile_exists_p
;
2906 extern Lisp_Object Qfile_directory_p
;
2907 extern Lisp_Object Qinsert_file_contents
;
2908 extern Lisp_Object Qfile_name_history
;
2909 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
2910 EXFUN (Fread_file_name
, 6); /* not a normal DEFUN */
2911 extern Lisp_Object
close_file_unwind (Lisp_Object
);
2912 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
2913 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
2914 extern int internal_delete_file (Lisp_Object
);
2915 extern void syms_of_fileio (void);
2916 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
2917 extern Lisp_Object Qdelete_file
;
2919 /* Defined in search.c */
2920 extern void shrink_regexp_cache (void);
2921 extern void restore_search_regs (void);
2922 extern void record_unwind_save_match_data (void);
2923 struct re_registers
;
2924 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
2925 struct re_registers
*,
2926 Lisp_Object
, int, int);
2927 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
2928 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
2930 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
2931 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2932 ptrdiff_t, ptrdiff_t, Lisp_Object
);
2933 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2935 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2937 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
2938 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
2939 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2940 extern void syms_of_search (void);
2941 extern void clear_regexp_cache (void);
2943 /* Defined in minibuf.c. */
2945 extern Lisp_Object Qcompletion_ignore_case
;
2946 extern Lisp_Object Vminibuffer_list
;
2947 extern Lisp_Object last_minibuf_string
;
2948 extern Lisp_Object
get_minibuffer (EMACS_INT
);
2949 extern void init_minibuf_once (void);
2950 extern void syms_of_minibuf (void);
2952 /* Defined in callint.c. */
2954 extern Lisp_Object Qminus
, Qplus
;
2955 extern Lisp_Object Qwhen
;
2956 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
2957 extern void syms_of_callint (void);
2959 /* Defined in casefiddle.c. */
2961 extern Lisp_Object Qidentity
;
2962 extern void syms_of_casefiddle (void);
2963 extern void keys_of_casefiddle (void);
2965 /* Defined in casetab.c. */
2967 extern void init_casetab_once (void);
2968 extern void syms_of_casetab (void);
2970 /* Defined in keyboard.c. */
2972 extern Lisp_Object echo_message_buffer
;
2973 extern struct kboard
*echo_kboard
;
2974 extern void cancel_echoing (void);
2975 extern Lisp_Object Qdisabled
, QCfilter
;
2976 extern Lisp_Object Qup
, Qdown
, Qbottom
;
2977 extern Lisp_Object Qtop
;
2978 extern Lisp_Object last_undo_boundary
;
2979 extern int input_pending
;
2980 extern Lisp_Object
menu_bar_items (Lisp_Object
);
2981 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
2982 extern void discard_mouse_events (void);
2983 extern Lisp_Object pending_funcalls
;
2984 extern int detect_input_pending (void);
2985 extern int detect_input_pending_ignore_squeezables (void);
2986 extern int detect_input_pending_run_timers (int);
2987 extern void safe_run_hooks (Lisp_Object
);
2988 extern void cmd_error_internal (Lisp_Object
, const char *);
2989 extern Lisp_Object
command_loop_1 (void);
2990 extern Lisp_Object
recursive_edit_1 (void);
2991 extern void record_auto_save (void);
2993 extern void force_auto_save_soon (void);
2995 extern void init_keyboard (void);
2996 extern void syms_of_keyboard (void);
2997 extern void keys_of_keyboard (void);
2999 /* Defined in indent.c. */
3000 extern ptrdiff_t current_column (void);
3001 extern void invalidate_current_column (void);
3002 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3003 extern void syms_of_indent (void);
3005 /* Defined in frame.c. */
3006 extern Lisp_Object Qonly
;
3007 extern Lisp_Object Qvisible
;
3008 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3009 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3010 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3012 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3014 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3015 extern void frames_discard_buffer (Lisp_Object
);
3016 extern void syms_of_frame (void);
3018 /* Defined in emacs.c. */
3019 extern char **initial_argv
;
3020 extern int initial_argc
;
3021 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3022 extern int display_arg
;
3024 extern Lisp_Object
decode_env_path (const char *, const char *);
3025 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3026 extern Lisp_Object Qfile_name_handler_alist
;
3027 #ifdef FLOAT_CATCH_SIGILL
3028 extern void fatal_error_signal (int);
3030 extern Lisp_Object Qkill_emacs
;
3032 void fixup_locale (void);
3033 void synchronize_system_messages_locale (void);
3034 void synchronize_system_time_locale (void);
3036 #define setlocale(category, locale)
3037 #define fixup_locale()
3038 #define synchronize_system_messages_locale()
3039 #define synchronize_system_time_locale()
3041 void shut_down_emacs (int, int, Lisp_Object
);
3042 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3043 extern int noninteractive
;
3045 /* Nonzero means remove site-lisp directories from load-path. */
3046 extern int no_site_lisp
;
3048 /* Pipe used to send exit notification to the daemon parent at
3050 extern int daemon_pipe
[2];
3051 #define IS_DAEMON (daemon_pipe[1] != 0)
3053 /* Nonzero means don't do use window-system-specific display code. */
3054 extern int inhibit_window_system
;
3055 /* Nonzero means that a filter or a sentinel is running. */
3056 extern int running_asynch_code
;
3058 /* Defined in process.c. */
3059 extern Lisp_Object QCtype
, Qlocal
;
3060 extern Lisp_Object Qprocessp
;
3061 extern void kill_buffer_processes (Lisp_Object
);
3062 extern int wait_reading_process_output (intmax_t, int, int, int,
3064 struct Lisp_Process
*,
3066 /* Max value for the first argument of wait_reading_process_output. */
3067 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3068 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3069 The bug merely causes a bogus warning, but the warning is annoying. */
3070 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3072 # define WAIT_READING_MAX INTMAX_MAX
3074 extern void add_keyboard_wait_descriptor (int);
3075 extern void delete_keyboard_wait_descriptor (int);
3077 extern void add_gpm_wait_descriptor (int);
3078 extern void delete_gpm_wait_descriptor (int);
3080 extern void close_process_descs (void);
3081 extern void init_process_emacs (void);
3082 extern void syms_of_process (void);
3083 extern void setup_process_coding_systems (Lisp_Object
);
3088 extern int child_setup (int, int, int, char **, int, Lisp_Object
);
3089 extern void init_callproc_1 (void);
3090 extern void init_callproc (void);
3091 extern void set_initial_environment (void);
3092 extern void syms_of_callproc (void);
3094 /* Defined in doc.c */
3095 extern Lisp_Object Qfunction_documentation
;
3096 extern Lisp_Object
read_doc_string (Lisp_Object
);
3097 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3098 extern void syms_of_doc (void);
3099 extern int read_bytecode_char (int);
3101 /* Defined in bytecode.c */
3102 extern Lisp_Object Qbytecode
;
3103 extern void syms_of_bytecode (void);
3104 extern struct byte_stack
*byte_stack_list
;
3106 extern void mark_byte_stack (void);
3108 extern void unmark_byte_stack (void);
3109 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3110 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3112 /* Defined in macros.c */
3113 extern Lisp_Object Qexecute_kbd_macro
;
3114 extern void init_macros (void);
3115 extern void syms_of_macros (void);
3117 /* Defined in undo.c */
3118 extern Lisp_Object Qapply
;
3119 extern Lisp_Object Qinhibit_read_only
;
3120 extern void truncate_undo_list (struct buffer
*);
3121 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3122 extern void record_insert (ptrdiff_t, ptrdiff_t);
3123 extern void record_delete (ptrdiff_t, Lisp_Object
);
3124 extern void record_first_change (void);
3125 extern void record_change (ptrdiff_t, ptrdiff_t);
3126 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3127 Lisp_Object
, Lisp_Object
,
3129 extern void syms_of_undo (void);
3130 /* Defined in textprop.c */
3131 extern Lisp_Object Qfont
, Qmouse_face
;
3132 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3133 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3134 extern Lisp_Object Qminibuffer_prompt
;
3136 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3138 /* Defined in menu.c */
3139 extern void syms_of_menu (void);
3141 /* Defined in xmenu.c */
3142 extern void syms_of_xmenu (void);
3144 /* Defined in termchar.h */
3145 struct tty_display_info
;
3147 /* Defined in termhooks.h */
3150 /* Defined in sysdep.c */
3151 #ifndef HAVE_GET_CURRENT_DIR_NAME
3152 extern char *get_current_dir_name (void);
3154 extern void stuff_char (char c
);
3155 extern void init_sigio (int);
3156 extern void sys_subshell (void);
3157 extern void sys_suspend (void);
3158 extern void discard_tty_input (void);
3159 extern void init_sys_modes (struct tty_display_info
*);
3160 extern void reset_sys_modes (struct tty_display_info
*);
3161 extern void init_all_sys_modes (void);
3162 extern void reset_all_sys_modes (void);
3163 extern void wait_for_termination (pid_t
);
3164 extern void interruptible_wait_for_termination (pid_t
);
3165 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3166 extern void child_setup_tty (int);
3167 extern void setup_pty (int);
3168 extern int set_window_size (int, int, int);
3169 extern EMACS_INT
get_random (void);
3170 extern void seed_random (long);
3171 extern int emacs_open (const char *, int, int);
3172 extern int emacs_close (int);
3173 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3174 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3175 enum { READLINK_BUFSIZE
= 1024 };
3176 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3178 extern void unlock_all_files (void);
3179 extern void lock_file (Lisp_Object
);
3180 extern void unlock_file (Lisp_Object
);
3181 extern void unlock_buffer (struct buffer
*);
3182 extern void syms_of_filelock (void);
3184 /* Defined in sound.c */
3185 extern void syms_of_sound (void);
3187 /* Defined in category.c */
3188 extern void init_category_once (void);
3189 extern Lisp_Object
char_category_set (int);
3190 extern void syms_of_category (void);
3192 /* Defined in ccl.c */
3193 extern void syms_of_ccl (void);
3195 /* Defined in dired.c */
3196 extern void syms_of_dired (void);
3197 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3198 Lisp_Object
, Lisp_Object
,
3201 /* Defined in term.c */
3202 extern int *char_ins_del_vector
;
3203 extern void mark_ttys (void);
3204 extern void syms_of_term (void);
3205 extern _Noreturn
void fatal (const char *msgid
, ...)
3206 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3208 /* Defined in terminal.c */
3209 extern void syms_of_terminal (void);
3211 /* Defined in font.c */
3212 extern void syms_of_font (void);
3213 extern void init_font (void);
3215 #ifdef HAVE_WINDOW_SYSTEM
3216 /* Defined in fontset.c */
3217 extern void syms_of_fontset (void);
3219 /* Defined in xfns.c, w32fns.c, or macfns.c */
3220 extern Lisp_Object Qfont_param
;
3223 /* Defined in xfaces.c */
3224 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3225 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3226 extern Lisp_Object Qmode_line_inactive
;
3227 extern Lisp_Object Qface
;
3228 extern Lisp_Object Qnormal
;
3229 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3230 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3231 extern Lisp_Object Vface_alternative_font_family_alist
;
3232 extern Lisp_Object Vface_alternative_font_registry_alist
;
3233 extern void syms_of_xfaces (void);
3235 #ifdef HAVE_X_WINDOWS
3236 /* Defined in xfns.c */
3237 extern void syms_of_xfns (void);
3239 /* Defined in xsmfns.c */
3240 extern void syms_of_xsmfns (void);
3242 /* Defined in xselect.c */
3243 extern void syms_of_xselect (void);
3245 /* Defined in xterm.c */
3246 extern void syms_of_xterm (void);
3247 #endif /* HAVE_X_WINDOWS */
3249 #ifdef HAVE_WINDOW_SYSTEM
3250 /* Defined in xterm.c, nsterm.m, w32term.c */
3251 extern char *x_get_keysym_name (int);
3252 #endif /* HAVE_WINDOW_SYSTEM */
3255 /* Defined in xml.c */
3256 extern void syms_of_xml (void);
3257 extern void xml_cleanup_parser (void);
3261 /* Defined in (x|w32)fns.c, nsfns.m... */
3262 extern int have_menus_p (void);
3266 /* Defined in dbusbind.c */
3267 void syms_of_dbusbind (void);
3271 /* Defined in msdos.c, w32.c */
3272 extern char *emacs_root_dir (void);
3275 /* Nonzero means Emacs has already been initialized.
3276 Used during startup to detect startup of dumped Emacs. */
3277 extern int initialized
;
3279 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3281 extern void *xmalloc (size_t);
3282 extern void *xzalloc (size_t);
3283 extern void *xrealloc (void *, size_t);
3284 extern void xfree (void *);
3285 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3286 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3287 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3289 extern char *xstrdup (const char *);
3291 extern char *egetenv (const char *);
3293 /* Set up the name of the machine we're running on. */
3294 extern void init_system_name (void);
3296 /* Some systems (e.g., NT) use a different path separator than Unix,
3297 in addition to a device separator. Set the path separator
3298 to '/', and don't test for a device separator in IS_ANY_SEP. */
3300 #define DIRECTORY_SEP '/'
3301 #ifndef IS_DIRECTORY_SEP
3302 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3304 #ifndef IS_DEVICE_SEP
3306 #define IS_DEVICE_SEP(_c_) 0
3308 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3312 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3315 #define SWITCH_ENUM_CAST(x) (x)
3317 /* Use this to suppress gcc's warnings. */
3320 /* Use CODE only if lint checking is in effect. */
3321 # define IF_LINT(Code) Code
3323 /* Assume that the expression COND is true. This differs in intent
3324 from 'assert', as it is a message from the programmer to the compiler. */
3325 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3328 # define IF_LINT(Code) /* empty */
3329 # define lint_assume(cond) ((void) (0 && (cond)))
3332 /* The ubiquitous min and max macros. */
3338 #define min(a, b) ((a) < (b) ? (a) : (b))
3339 #define max(a, b) ((a) > (b) ? (a) : (b))
3341 /* We used to use `abs', but that clashes with system headers on some
3342 platforms, and using a name reserved by Standard C is a bad idea
3345 #define eabs(x) ((x) < 0 ? -(x) : (x))
3348 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3351 #define make_fixnum_or_float(val) \
3352 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3355 /* Checks the `cycle check' variable CHECK to see if it indicates that
3356 EL is part of a cycle; CHECK must be either Qnil or a value returned
3357 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3358 elements after which a cycle might be suspected; after that many
3359 elements, this macro begins consing in order to keep more precise
3362 Returns nil if a cycle was detected, otherwise a new value for CHECK
3365 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3366 the caller should make sure that's ok. */
3368 #define CYCLE_CHECK(check, el, suspicious) \
3371 : (INTEGERP (check) \
3372 ? (XFASTINT (check) < (suspicious) \
3373 ? make_number (XFASTINT (check) + 1) \
3374 : Fcons (el, Qnil)) \
3375 : (!NILP (Fmemq ((el), (check))) \
3377 : Fcons ((el), (check)))))
3380 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3381 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3383 #define MAX_ALLOCA 16*1024
3385 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3387 #define USE_SAFE_ALLOCA \
3388 ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0
3390 /* SAFE_ALLOCA allocates a simple buffer. */
3392 #define SAFE_ALLOCA(buf, type, size) \
3394 if ((size) < MAX_ALLOCA) \
3395 buf = (type) alloca (size); \
3398 buf = xmalloc (size); \
3400 record_unwind_protect (safe_alloca_unwind, \
3401 make_save_value (buf, 0)); \
3405 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3406 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3407 positive. The code is tuned for MULTIPLIER being a constant. */
3409 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3411 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3412 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3415 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3417 record_unwind_protect (safe_alloca_unwind, \
3418 make_save_value (buf, 0)); \
3422 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3424 #define SAFE_FREE() \
3426 if (sa_must_free) { \
3428 unbind_to (sa_count, Qnil); \
3433 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3435 #define SAFE_ALLOCA_LISP(buf, nelt) \
3437 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3438 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3439 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3442 buf = xmalloc ((nelt) * sizeof (Lisp_Object)); \
3443 arg_ = make_save_value (buf, nelt); \
3444 XSAVE_VALUE (arg_)->dogc = 1; \
3446 record_unwind_protect (safe_alloca_unwind, arg_); \
3449 memory_full (SIZE_MAX); \
3453 #include "globals.h"
3455 /* Check whether it's time for GC, and run it if so. */
3460 if ((consing_since_gc
> gc_cons_threshold
3461 && consing_since_gc
> gc_relative_threshold
)
3462 || (!NILP (Vmemory_full
)
3463 && consing_since_gc
> memory_full_cons_threshold
))
3464 Fgarbage_collect ();
3467 #endif /* EMACS_LISP_H */