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/>. */
35 # define LISP_INLINE INLINE
38 /* The ubiquitous max and min macros. */
41 #define max(a, b) ((a) > (b) ? (a) : (b))
42 #define min(a, b) ((a) < (b) ? (a) : (b))
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 bool 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. */
156 /* Number of bits in a Lisp_Object tag. This can be used in #if,
157 and for GDB's sake also as a regular symbol. */
162 /* 2**GCTYPEBITS. This must also be a macro that expands to a
163 literal integer constant, for MSVC. */
165 #define GCALIGNMENT 8
168 /* Number of bits in a Lisp_Object value, not counting the tag. */
169 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
171 /* Number of bits in a Lisp fixnum tag. */
172 INTTYPEBITS
= GCTYPEBITS
- 1,
174 /* Number of bits in a Lisp fixnum value, not counting the tag. */
175 FIXNUM_BITS
= VALBITS
+ 1
178 #if GCALIGNMENT != 1 << GCTYPEBITS
179 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
182 /* The maximum value that can be stored in a EMACS_INT, assuming all
183 bits other than the type bits contribute to a nonnegative signed value.
184 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
185 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
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
207 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
208 # define USE_LSB_TAG 1
210 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
211 # define USE_LSB_TAG 0
215 # define alignas(alignment) /* empty */
217 # error "USE_LSB_TAG requires alignas"
222 /* Define the fundamental Lisp data structures. */
224 /* This is the set of Lisp data types. */
226 /* Lisp integers use 2 tags, to give them one extra bit, thus
227 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
228 static EMACS_INT
const INTMASK
= EMACS_INT_MAX
>> (INTTYPEBITS
- 1);
229 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
230 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
232 /* Stolen from GDB. The only known compiler that doesn't support
233 enums in bitfields is MSVC. */
235 #define ENUM_BF(TYPE) unsigned int
237 #define ENUM_BF(TYPE) enum TYPE
243 /* Integer. XINT (obj) is the integer value. */
245 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
247 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
250 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
251 whose first member indicates the subtype. */
254 /* String. XSTRING (object) points to a struct Lisp_String.
255 The length of the string, and its contents, are stored therein. */
256 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
258 /* Vector of Lisp objects, or something resembling it.
259 XVECTOR (object) points to a struct Lisp_Vector, which contains
260 the size and contents. The size field also contains the type
261 information, if it's not a real vector object. */
264 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
270 /* This is the set of data types that share a common structure.
271 The first member of the structure is a type code from this set.
272 The enum values are arbitrary, but we'll use large numbers to make it
273 more likely that we'll spot the error if a random word in memory is
274 mistakenly interpreted as a Lisp_Misc. */
277 Lisp_Misc_Free
= 0x5eab,
280 Lisp_Misc_Save_Value
,
281 /* Currently floats are not a misc type,
282 but let's define this in case we want to change that. */
284 /* This is not a type code. It is for range checking. */
288 /* These are the types of forwarding objects used in the value slot
289 of symbols for special built-in variables whose value is stored in
293 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
294 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
295 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
296 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
297 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
300 #ifdef CHECK_LISP_OBJECT_TYPE
302 typedef struct { EMACS_INT i
; } Lisp_Object
;
305 LISP_INLINE Lisp_Object
308 Lisp_Object o
= { i
};
312 LISP_INLINE Lisp_Object
313 LISP_MAKE_RVALUE (Lisp_Object o
)
318 #define LISP_INITIALLY_ZERO {0}
320 #undef CHECK_LISP_OBJECT_TYPE
321 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
322 #else /* CHECK_LISP_OBJECT_TYPE */
324 /* If a struct type is not wanted, define Lisp_Object as just a number. */
326 typedef EMACS_INT Lisp_Object
;
329 #define LISP_MAKE_RVALUE(o) (0 + (o))
330 #define LISP_INITIALLY_ZERO 0
331 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
332 #endif /* CHECK_LISP_OBJECT_TYPE */
334 /* In the size word of a vector, this bit means the vector has been marked. */
336 static ptrdiff_t const ARRAY_MARK_FLAG
337 #define ARRAY_MARK_FLAG PTRDIFF_MIN
340 /* In the size word of a struct Lisp_Vector, this bit means it's really
341 some other vector-like object. */
342 static ptrdiff_t const PSEUDOVECTOR_FLAG
343 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
346 /* In a pseudovector, the size field actually contains a word with one
347 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
348 indicate the actual type.
349 We use a bitset, even tho only one of the bits can be set at any
350 particular time just so as to be able to use micro-optimizations such as
351 testing membership of a particular subset of pseudovectors in Fequal.
352 It is not crucial, but there are plenty of bits here, so why not do it? */
355 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
364 PVEC_WINDOW_CONFIGURATION
,
372 /* These last 4 are special because we OR them in fns.c:internal_equal,
373 so they have to use a disjoint bit pattern:
374 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
375 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
376 PVEC_COMPILED
= 0x10,
377 PVEC_CHAR_TABLE
= 0x20,
378 PVEC_SUB_CHAR_TABLE
= 0x30,
382 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
383 which were stored in a Lisp_Object. */
384 #ifndef DATA_SEG_BITS
385 # define DATA_SEG_BITS 0
387 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
392 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
394 /* For convenience, we also store the number of elements in these bits.
395 Note that this size is not necessarily the memory-footprint size, but
396 only the number of Lisp_Object fields (that need to be traced by GC).
397 The distinction is used, e.g., by Lisp_Process, which places extra
398 non-Lisp_Object fields at the end of the structure. */
399 PSEUDOVECTOR_SIZE_BITS
= 16,
400 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
401 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
403 /* Number of bits to put in each character in the internal representation
404 of bool vectors. This should not vary across implementations. */
405 BOOL_VECTOR_BITS_PER_CHAR
= 8
408 /* These macros extract various sorts of values from a Lisp_Object.
409 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
410 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
412 /* Return a perfect hash of the Lisp_Object representation. */
413 #define XHASH(a) XLI (a)
419 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
422 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
423 #define XINT(a) (XLI (a) >> INTTYPEBITS)
424 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
425 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
426 #define make_lisp_ptr(ptr, type) \
427 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
428 XIL ((type) | (intptr_t) (ptr)))
430 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
431 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
433 #else /* not USE_LSB_TAG */
435 static EMACS_INT
const VALMASK
436 #define VALMASK VAL_MAX
439 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
441 /* For integers known to be positive, XFASTINT provides fast retrieval
442 and XSETFASTINT provides fast storage. This takes advantage of the
443 fact that Lisp integers have zero-bits in their tags. */
444 #define XFASTINT(a) (XLI (a) + 0)
445 #define XSETFASTINT(a, b) ((a) = XIL (b))
447 /* Extract the value of a Lisp_Object as a (un)signed integer. */
449 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
450 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
451 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
453 #define make_lisp_ptr(ptr, type) \
454 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
455 + ((intptr_t) (ptr) & VALMASK)))
458 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
459 which were stored in a Lisp_Object. */
460 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
462 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
465 #endif /* not USE_LSB_TAG */
467 /* For integers known to be positive, XFASTINT sometimes provides
468 faster retrieval and XSETFASTINT provides faster storage.
469 If not, fallback on the non-accelerated path. */
471 # define XFASTINT(a) (XINT (a))
472 # define XSETFASTINT(a, b) (XSETINT (a, b))
475 /* Extract the pointer value of the Lisp object A, under the
476 assumption that A's type is TYPE. This is a fallback
477 implementation if nothing faster is available. */
479 # define XUNTAG(a, type) XPNTR (a)
482 #define EQ(x, y) (XHASH (x) == XHASH (y))
484 /* Largest and smallest representable fixnum values. These are the C
485 values. They are macros for use in static initializers, and
486 constants for visibility to GDB. */
487 static EMACS_INT
const MOST_POSITIVE_FIXNUM
=
488 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
489 MOST_POSITIVE_FIXNUM
;
490 static EMACS_INT
const MOST_NEGATIVE_FIXNUM
=
491 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
492 MOST_NEGATIVE_FIXNUM
;
494 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
495 written this way so that it also works if I is of unsigned
496 type or if I is a NaN. */
498 #define FIXNUM_OVERFLOW_P(i) \
499 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
501 LISP_INLINE
ptrdiff_t
502 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
504 return num
< lower
? lower
: num
<= upper
? num
: upper
;
507 /* Extract a value or address from a Lisp_Object. */
509 #define XCONS(a) (eassert (CONSP (a)), \
510 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
511 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
512 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
513 #define XSTRING(a) (eassert (STRINGP (a)), \
514 (struct Lisp_String *) XUNTAG (a, Lisp_String))
515 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
516 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
517 #define XFLOAT(a) (eassert (FLOATP (a)), \
518 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
522 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
523 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
524 #define XMISCTYPE(a) (XMISCANY (a)->type)
525 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
526 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
527 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
529 /* Forwarding object types. */
531 #define XFWDTYPE(a) (a->u_intfwd.type)
532 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
533 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
534 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
535 #define XBUFFER_OBJFWD(a) \
536 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
537 #define XKBOARD_OBJFWD(a) \
538 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
540 /* Pseudovector types. */
542 #define XPROCESS(a) (eassert (PROCESSP (a)), \
543 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
544 #define XWINDOW(a) (eassert (WINDOWP (a)), \
545 (struct window *) XUNTAG (a, Lisp_Vectorlike))
546 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
547 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
548 #define XSUBR(a) (eassert (SUBRP (a)), \
549 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
550 #define XBUFFER(a) (eassert (BUFFERP (a)), \
551 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
552 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
553 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
554 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
555 ((struct Lisp_Sub_Char_Table *) \
556 XUNTAG (a, Lisp_Vectorlike)))
557 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
558 ((struct Lisp_Bool_Vector *) \
559 XUNTAG (a, Lisp_Vectorlike)))
561 /* Construct a Lisp_Object from a value or address. */
563 #define XSETINT(a, b) ((a) = make_number (b))
564 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
565 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
566 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
567 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
568 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
572 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
573 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
575 /* Pseudovector types. */
577 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
578 #define XSETTYPED_PVECTYPE(v, size_member, code) \
579 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
580 #define XSETPVECTYPESIZE(v, code, sizeval) \
581 ((v)->header.size = (PSEUDOVECTOR_FLAG \
582 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
585 /* The cast to struct vectorlike_header * avoids aliasing issues. */
586 #define XSETPSEUDOVECTOR(a, b, code) \
587 XSETTYPED_PSEUDOVECTOR (a, b, \
588 (((struct vectorlike_header *) \
589 XUNTAG (a, Lisp_Vectorlike)) \
592 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
593 (XSETVECTOR (a, b), \
594 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
595 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
597 #define XSETWINDOW_CONFIGURATION(a, b) \
598 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
599 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
600 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
601 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
602 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
603 #define XSETSUBR(a, b) \
604 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
605 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
606 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
607 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
608 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
609 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
611 /* Convenience macros for dealing with Lisp arrays. */
613 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
614 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
615 #define ASET(ARRAY, IDX, VAL) \
616 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
617 XVECTOR (ARRAY)->contents[IDX] = (VAL))
619 /* Convenience macros for dealing with Lisp strings. */
621 #define SDATA(string) (XSTRING (string)->data + 0)
622 #define SREF(string, index) (SDATA (string)[index] + 0)
623 #define SSET(string, index, new) (SDATA (string)[index] = (new))
624 #define SCHARS(string) (XSTRING (string)->size + 0)
625 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
627 /* Avoid "differ in sign" warnings. */
628 #define SSDATA(x) ((char *) SDATA (x))
630 #define STRING_SET_CHARS(string, newsize) \
631 (XSTRING (string)->size = (newsize))
633 #define STRING_COPYIN(string, index, new, count) \
634 memcpy (SDATA (string) + index, new, count)
638 #define CHECK_TYPE(ok, Qxxxp, x) \
639 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
641 /* Deprecated and will be removed soon. */
643 #define INTERNAL_FIELD(field) field ## _
645 /* See the macros in intervals.h. */
647 typedef struct interval
*INTERVAL
;
649 /* Complain if object is not string or buffer type. */
650 #define CHECK_STRING_OR_BUFFER(x) \
651 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
655 /* Car of this cons cell. */
660 /* Cdr of this cons cell. */
663 /* Used to chain conses on a free list. */
664 struct Lisp_Cons
*chain
;
668 /* Take the car or cdr of something known to be a cons cell. */
669 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
670 of code that has to know what a cons cell looks like. Other code not
671 part of the basic lisp implementation should assume that the car and cdr
672 fields are not accessible as lvalues. (What if we want to switch to
673 a copying collector someday? Cached cons cell field addresses may be
674 invalidated at arbitrary points.) */
675 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
676 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
678 /* Use these from normal code. */
679 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
680 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
682 /* Use these to set the fields of a cons cell.
684 Note that both arguments may refer to the same object, so 'n'
685 should not be read after 'c' is first modified. Also, neither
686 argument should be evaluated more than once; side effects are
687 especially common in the second argument. */
688 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
689 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
691 /* Take the car or cdr of something whose type is not known. */
693 (CONSP ((c)) ? XCAR ((c)) \
694 : NILP ((c)) ? Qnil \
695 : wrong_type_argument (Qlistp, (c)))
698 (CONSP ((c)) ? XCDR ((c)) \
699 : NILP ((c)) ? Qnil \
700 : wrong_type_argument (Qlistp, (c)))
702 /* Take the car or cdr of something whose type is not known. */
703 #define CAR_SAFE(c) \
704 (CONSP ((c)) ? XCAR ((c)) : Qnil)
706 #define CDR_SAFE(c) \
707 (CONSP ((c)) ? XCDR ((c)) : Qnil)
709 /* True if STR is a multibyte string. */
710 #define STRING_MULTIBYTE(STR) \
711 (XSTRING (STR)->size_byte >= 0)
713 /* Return the length in bytes of STR. */
715 #ifdef GC_CHECK_STRING_BYTES
718 extern ptrdiff_t string_bytes (struct Lisp_String
*);
719 #define STRING_BYTES(S) string_bytes ((S))
721 #else /* not GC_CHECK_STRING_BYTES */
723 #define STRING_BYTES(STR) \
724 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
726 #endif /* not GC_CHECK_STRING_BYTES */
728 /* An upper bound on the number of bytes in a Lisp string, not
729 counting the terminating null. This a tight enough bound to
730 prevent integer overflow errors that would otherwise occur during
731 string size calculations. A string cannot contain more bytes than
732 a fixnum can represent, nor can it be so long that C pointer
733 arithmetic stops working on the string plus its terminating null.
734 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
735 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
736 would expose alloc.c internal details that we'd rather keep
739 This is a macro for use in static initializers, and a constant for
740 visibility to GDB. The cast to ptrdiff_t ensures that
741 the macro is signed. */
742 static ptrdiff_t const STRING_BYTES_BOUND
=
743 #define STRING_BYTES_BOUND \
744 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
747 /* Mark STR as a unibyte string. */
748 #define STRING_SET_UNIBYTE(STR) \
749 do { if (EQ (STR, empty_multibyte_string)) \
750 (STR) = empty_unibyte_string; \
751 else XSTRING (STR)->size_byte = -1; } while (0)
753 /* Mark STR as a multibyte string. Assure that STR contains only
754 ASCII characters in advance. */
755 #define STRING_SET_MULTIBYTE(STR) \
756 do { if (EQ (STR, empty_unibyte_string)) \
757 (STR) = empty_multibyte_string; \
758 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
760 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
766 INTERVAL intervals
; /* Text properties in this string. */
770 /* Header of vector-like objects. This documents the layout constraints on
771 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
772 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
773 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
774 because when two such pointers potentially alias, a compiler won't
775 incorrectly reorder loads and stores to their size fields. See
776 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
777 struct vectorlike_header
779 /* This field contains various pieces of information:
780 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
781 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
782 vector (0) or a pseudovector (1).
783 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
784 of slots) of the vector.
785 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
786 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
787 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
788 Lisp_Object slots at the beginning of the object that need to be
789 traced by the GC, tho some types use it slightly differently.
790 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
791 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
795 /* When the vector is allocated from a vector block, NBYTES is used
796 if the vector is not on a free list, and VECTOR is used otherwise.
797 For large vector-like objects, BUFFER or VECTOR is used as a pointer
798 to the next vector-like object. It is generally a buffer or a
799 Lisp_Vector alias, so for convenience it is a union instead of a
800 pointer: this way, one can write P->next.vector instead of ((struct
801 Lisp_Vector *) P->next). */
803 /* This is only needed for small vectors that are not free because the
804 `size' field only gives us the number of Lisp_Object slots, whereas we
805 need to know the total size, including non-Lisp_Object data.
806 FIXME: figure out a way to store this info elsewhere so we can
807 finally get rid of this extra word of overhead. */
809 struct buffer
*buffer
;
810 /* FIXME: This can be removed: For large vectors, this field could be
811 placed *before* the vector itself. And for small vectors on a free
812 list, this field could be stored in the vector's bytes, since the
813 empty vector is handled specially anyway. */
814 struct Lisp_Vector
*vector
;
818 /* Regular vector is just a header plus array of Lisp_Objects. */
822 struct vectorlike_header header
;
823 Lisp_Object contents
[1];
826 /* A boolvector is a kind of vectorlike, with contents are like a string. */
828 struct Lisp_Bool_Vector
830 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
831 just the subtype information. */
832 struct vectorlike_header header
;
833 /* This is the size in bits. */
835 /* This contains the actual bits, packed into bytes. */
836 unsigned char data
[1];
839 /* Some handy constants for calculating sizes
840 and offsets, mostly of vectorlike objects. */
844 header_size
= offsetof (struct Lisp_Vector
, contents
),
845 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
846 word_size
= sizeof (Lisp_Object
)
849 /* If a struct is made to look like a vector, this macro returns the length
850 of the shortest vector that would hold that struct. */
852 #define VECSIZE(type) \
853 ((sizeof (type) - header_size + word_size - 1) / word_size)
855 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
856 at the end and we need to compute the number of Lisp_Object fields (the
857 ones that the GC needs to trace). */
859 #define PSEUDOVECSIZE(type, nonlispfield) \
860 ((offsetof (type, nonlispfield) - header_size) / word_size)
862 /* A char-table is a kind of vectorlike, with contents are like a
863 vector but with a few other slots. For some purposes, it makes
864 sense to handle a char-table with type struct Lisp_Vector. An
865 element of a char table can be any Lisp objects, but if it is a sub
866 char-table, we treat it a table that contains information of a
867 specific range of characters. A sub char-table has the same
868 structure as a vector. A sub char table appears only in an element
869 of a char-table, and there's no way to access it directly from
870 Emacs Lisp program. */
874 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
875 ({struct Lisp_Char_Table *_tbl = NULL; \
878 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
879 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
880 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
882 _val = _tbl->defalt; \
883 } while (NILP (_val) && ! NILP (_tbl->parent)); \
886 #else /* not __GNUC__ */
888 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
889 (! NILP (XCHAR_TABLE (CT)->ascii) \
890 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
891 ? XCHAR_TABLE (CT)->ascii \
892 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
893 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
894 : char_table_ref ((CT), (IDX))) \
895 : char_table_ref ((CT), (IDX)))
897 #endif /* not __GNUC__ */
899 /* Compute A OP B, using the unsigned comparison operator OP. A and B
900 should be integer expressions. This is not the same as
901 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
902 returns 1. For efficiency, prefer plain unsigned comparison if A
903 and B's sizes both fit (after integer promotion). */
904 #define UNSIGNED_CMP(a, op, b) \
905 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
906 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
907 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
909 /* Nonzero iff C is an ASCII character. */
910 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
912 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
913 characters. Do not check validity of CT. */
914 #define CHAR_TABLE_REF(CT, IDX) \
915 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
916 : char_table_ref ((CT), (IDX)))
918 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
919 8-bit European characters. Do not check validity of CT. */
920 #define CHAR_TABLE_SET(CT, IDX, VAL) \
921 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
922 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
923 : char_table_set (CT, IDX, VAL))
925 enum CHARTAB_SIZE_BITS
927 CHARTAB_SIZE_BITS_0
= 6,
928 CHARTAB_SIZE_BITS_1
= 4,
929 CHARTAB_SIZE_BITS_2
= 5,
930 CHARTAB_SIZE_BITS_3
= 7
933 extern const int chartab_size
[4];
935 struct Lisp_Char_Table
937 /* HEADER.SIZE is the vector's size field, which also holds the
938 pseudovector type information. It holds the size, too.
939 The size counts the defalt, parent, purpose, ascii,
940 contents, and extras slots. */
941 struct vectorlike_header header
;
943 /* This holds a default value,
944 which is used whenever the value for a specific character is nil. */
947 /* This points to another char table, which we inherit from when the
948 value for a specific character is nil. The `defalt' slot takes
949 precedence over this. */
952 /* This is a symbol which says what kind of use this char-table is
956 /* The bottom sub char-table for characters of the range 0..127. It
957 is nil if none of ASCII character has a specific value. */
960 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
962 /* These hold additional data. It is a vector. */
963 Lisp_Object extras
[1];
966 struct Lisp_Sub_Char_Table
968 /* HEADER.SIZE is the vector's size field, which also holds the
969 pseudovector type information. It holds the size, too. */
970 struct vectorlike_header header
;
972 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
973 char-table of depth 1 contains 16 elements, and each element
974 covers 4096 (128*32) characters. A sub char-table of depth 2
975 contains 32 elements, and each element covers 128 characters. A
976 sub char-table of depth 3 contains 128 elements, and each element
977 is for one character. */
980 /* Minimum character covered by the sub char-table. */
981 Lisp_Object min_char
;
983 /* Use set_sub_char_table_contents to set this. */
984 Lisp_Object contents
[1];
987 /* This structure describes a built-in function.
988 It is generated by the DEFUN macro only.
989 defsubr makes it into a Lisp object.
991 This type is treated in most respects as a pseudovector,
992 but since we never dynamically allocate or free them,
993 we don't need a struct vectorlike_header and its 'next' field. */
999 Lisp_Object (*a0
) (void);
1000 Lisp_Object (*a1
) (Lisp_Object
);
1001 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1002 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1003 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1004 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1005 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1006 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1007 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1008 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1009 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1011 short min_args
, max_args
;
1012 const char *symbol_name
;
1013 const char *intspec
;
1017 /* This is the number of slots that every char table must have. This
1018 counts the ordinary slots and the top, defalt, parent, and purpose
1020 enum CHAR_TABLE_STANDARD_SLOTS
1022 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1025 /* Return the number of "extra" slots in the char table CT. */
1027 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1028 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1031 /***********************************************************************
1033 ***********************************************************************/
1035 /* Interned state of a symbol. */
1037 enum symbol_interned
1039 SYMBOL_UNINTERNED
= 0,
1040 SYMBOL_INTERNED
= 1,
1041 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1044 enum symbol_redirect
1046 SYMBOL_PLAINVAL
= 4,
1047 SYMBOL_VARALIAS
= 1,
1048 SYMBOL_LOCALIZED
= 2,
1049 SYMBOL_FORWARDED
= 3
1054 unsigned gcmarkbit
: 1;
1056 /* Indicates where the value can be found:
1057 0 : it's a plain var, the value is in the `value' field.
1058 1 : it's a varalias, the value is really in the `alias' symbol.
1059 2 : it's a localized var, the value is in the `blv' object.
1060 3 : it's a forwarding variable, the value is in `forward'. */
1061 ENUM_BF (symbol_redirect
) redirect
: 3;
1063 /* Non-zero means symbol is constant, i.e. changing its value
1064 should signal an error. If the value is 3, then the var
1065 can be changed, but only by `defconst'. */
1066 unsigned constant
: 2;
1068 /* Interned state of the symbol. This is an enumerator from
1069 enum symbol_interned. */
1070 unsigned interned
: 2;
1072 /* Non-zero means that this variable has been explicitly declared
1073 special (with `defvar' etc), and shouldn't be lexically bound. */
1074 unsigned declared_special
: 1;
1076 /* The symbol's name, as a Lisp string. */
1079 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1080 union is used depends on the `redirect' field above. */
1083 struct Lisp_Symbol
*alias
;
1084 struct Lisp_Buffer_Local_Value
*blv
;
1085 union Lisp_Fwd
*fwd
;
1088 /* Function value of the symbol or Qunbound if not fboundp. */
1089 Lisp_Object function
;
1091 /* The symbol's property list. */
1094 /* Next symbol in obarray bucket, if the symbol is interned. */
1095 struct Lisp_Symbol
*next
;
1098 /* Value is name of symbol. */
1100 #define SYMBOL_VAL(sym) \
1101 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1102 #define SYMBOL_ALIAS(sym) \
1103 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1104 #define SYMBOL_BLV(sym) \
1105 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1106 #define SYMBOL_FWD(sym) \
1107 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1108 #define SET_SYMBOL_VAL(sym, v) \
1109 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1110 #define SET_SYMBOL_ALIAS(sym, v) \
1111 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1112 #define SET_SYMBOL_BLV(sym, v) \
1113 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1114 #define SET_SYMBOL_FWD(sym, v) \
1115 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1117 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1119 /* Value is non-zero if SYM is an interned symbol. */
1121 #define SYMBOL_INTERNED_P(sym) \
1122 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1124 /* Value is non-zero if SYM is interned in initial_obarray. */
1126 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1127 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1129 /* Value is non-zero if symbol is considered a constant, i.e. its
1130 value cannot be changed (there is an exception for keyword symbols,
1131 whose value can be set to the keyword symbol itself). */
1133 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1135 #define DEFSYM(sym, name) \
1136 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1139 /***********************************************************************
1141 ***********************************************************************/
1143 /* The structure of a Lisp hash table. */
1145 struct Lisp_Hash_Table
1147 /* This is for Lisp; the hash table code does not refer to it. */
1148 struct vectorlike_header header
;
1150 /* Function used to compare keys. */
1153 /* Nil if table is non-weak. Otherwise a symbol describing the
1154 weakness of the table. */
1157 /* When the table is resized, and this is an integer, compute the
1158 new size by adding this to the old size. If a float, compute the
1159 new size by multiplying the old size with this factor. */
1160 Lisp_Object rehash_size
;
1162 /* Resize hash table when number of entries/ table size is >= this
1164 Lisp_Object rehash_threshold
;
1166 /* Vector of hash codes.. If hash[I] is nil, this means that that
1167 entry I is unused. */
1170 /* Vector used to chain entries. If entry I is free, next[I] is the
1171 entry number of the next free item. If entry I is non-free,
1172 next[I] is the index of the next entry in the collision chain. */
1175 /* Index of first free entry in free list. */
1176 Lisp_Object next_free
;
1178 /* Bucket vector. A non-nil entry is the index of the first item in
1179 a collision chain. This vector's size can be larger than the
1180 hash table size to reduce collisions. */
1183 /* User-supplied hash function, or nil. */
1184 Lisp_Object user_hash_function
;
1186 /* User-supplied key comparison function, or nil. */
1187 Lisp_Object user_cmp_function
;
1189 /* Only the fields above are traced normally by the GC. The ones below
1190 `count' are special and are either ignored by the GC or traced in
1191 a special way (e.g. because of weakness). */
1193 /* Number of key/value entries in the table. */
1196 /* Vector of keys and values. The key of item I is found at index
1197 2 * I, the value is found at index 2 * I + 1.
1198 This is gc_marked specially if the table is weak. */
1199 Lisp_Object key_and_value
;
1201 /* Next weak hash table if this is a weak hash table. The head
1202 of the list is in weak_hash_tables. */
1203 struct Lisp_Hash_Table
*next_weak
;
1205 /* C function to compare two keys. */
1206 bool (*cmpfn
) (struct Lisp_Hash_Table
*,
1207 Lisp_Object
, EMACS_UINT
,
1208 Lisp_Object
, EMACS_UINT
);
1210 /* C function to compute hash code. */
1211 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1215 #define XHASH_TABLE(OBJ) \
1216 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1218 #define XSET_HASH_TABLE(VAR, PTR) \
1219 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1221 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1223 #define CHECK_HASH_TABLE(x) \
1224 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1226 /* Value is the key part of entry IDX in hash table H. */
1228 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1230 /* Value is the value part of entry IDX in hash table H. */
1232 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1234 /* Value is the index of the next entry following the one at IDX
1237 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1239 /* Value is the hash code computed for entry IDX in hash table H. */
1241 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1243 /* Value is the index of the element in hash table H that is the
1244 start of the collision list at index IDX in the index vector of H. */
1246 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1248 /* Value is the size of hash table H. */
1250 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1252 /* Default size for hash tables if not specified. */
1254 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1256 /* Default threshold specifying when to resize a hash table. The
1257 value gives the ratio of current entries in the hash table and the
1258 size of the hash table. */
1260 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1262 /* Default factor by which to increase the size of a hash table. */
1264 static double const DEFAULT_REHASH_SIZE
= 1.5;
1266 /* These structures are used for various misc types. */
1268 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1270 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1271 unsigned gcmarkbit
: 1;
1277 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1278 unsigned gcmarkbit
: 1;
1280 /* This flag is temporarily used in the functions
1281 decode/encode_coding_object to record that the marker position
1282 must be adjusted after the conversion. */
1283 unsigned int need_adjustment
: 1;
1284 /* 1 means normal insertion at the marker's position
1285 leaves the marker after the inserted text. */
1286 unsigned int insertion_type
: 1;
1287 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1288 Note: a chain of markers can contain markers pointing into different
1289 buffers (the chain is per buffer_text rather than per buffer, so it's
1290 shared between indirect buffers). */
1291 /* This is used for (other than NULL-checking):
1293 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1294 - unchain_marker: to find the list from which to unchain.
1295 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1297 struct buffer
*buffer
;
1299 /* The remaining fields are meaningless in a marker that
1300 does not point anywhere. */
1302 /* For markers that point somewhere,
1303 this is used to chain of all the markers in a given buffer. */
1304 /* We could remove it and use an array in buffer_text instead.
1305 That would also allow to preserve it ordered. */
1306 struct Lisp_Marker
*next
;
1307 /* This is the char position where the marker points. */
1309 /* This is the byte position.
1310 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1311 used to implement the functionality of markers, but rather to (ab)use
1312 markers as a cache for char<->byte mappings). */
1316 /* START and END are markers in the overlay's buffer, and
1317 PLIST is the overlay's property list. */
1319 /* An overlay's real data content is:
1321 - buffer (really there are two buffer pointers, one per marker,
1322 and both points to the same buffer)
1323 - insertion type of both ends (per-marker fields)
1324 - start & start byte (of start marker)
1325 - end & end byte (of end marker)
1326 - next (singly linked list of overlays)
1327 - next fields of start and end markers (singly linked list of markers).
1328 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1331 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1332 unsigned gcmarkbit
: 1;
1334 struct Lisp_Overlay
*next
;
1340 /* Hold a C pointer for later use.
1341 This type of object is used in the arg to record_unwind_protect. */
1342 struct Lisp_Save_Value
1344 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1345 unsigned gcmarkbit
: 1;
1347 /* If DOGC is set, POINTER is the address of a memory
1348 area containing INTEGER potential Lisp_Objects. */
1349 unsigned int dogc
: 1;
1355 /* A miscellaneous object, when it's on the free list. */
1358 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1359 unsigned gcmarkbit
: 1;
1361 union Lisp_Misc
*chain
;
1364 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1365 It uses one of these struct subtypes to get the type field. */
1369 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1370 struct Lisp_Free u_free
;
1371 struct Lisp_Marker u_marker
;
1372 struct Lisp_Overlay u_overlay
;
1373 struct Lisp_Save_Value u_save_value
;
1376 /* Forwarding pointer to an int variable.
1377 This is allowed only in the value cell of a symbol,
1378 and it means that the symbol's value really lives in the
1379 specified int variable. */
1382 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1386 /* Boolean forwarding pointer to an int variable.
1387 This is like Lisp_Intfwd except that the ostensible
1388 "value" of the symbol is t if the int variable is nonzero,
1389 nil if it is zero. */
1392 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1396 /* Forwarding pointer to a Lisp_Object variable.
1397 This is allowed only in the value cell of a symbol,
1398 and it means that the symbol's value really lives in the
1399 specified variable. */
1402 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1403 Lisp_Object
*objvar
;
1406 /* Like Lisp_Objfwd except that value lives in a slot in the
1407 current buffer. Value is byte index of slot within buffer. */
1408 struct Lisp_Buffer_Objfwd
1410 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1412 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1415 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1416 the symbol has buffer-local or frame-local bindings. (Exception:
1417 some buffer-local variables are built-in, with their values stored
1418 in the buffer structure itself. They are handled differently,
1419 using struct Lisp_Buffer_Objfwd.)
1421 The `realvalue' slot holds the variable's current value, or a
1422 forwarding pointer to where that value is kept. This value is the
1423 one that corresponds to the loaded binding. To read or set the
1424 variable, you must first make sure the right binding is loaded;
1425 then you can access the value in (or through) `realvalue'.
1427 `buffer' and `frame' are the buffer and frame for which the loaded
1428 binding was found. If those have changed, to make sure the right
1429 binding is loaded it is necessary to find which binding goes with
1430 the current buffer and selected frame, then load it. To load it,
1431 first unload the previous binding, then copy the value of the new
1432 binding into `realvalue' (or through it). Also update
1433 LOADED-BINDING to point to the newly loaded binding.
1435 `local_if_set' indicates that merely setting the variable creates a
1436 local binding for the current buffer. Otherwise the latter, setting
1437 the variable does not do that; only make-local-variable does that. */
1439 struct Lisp_Buffer_Local_Value
1441 /* 1 means that merely setting the variable creates a local
1442 binding for the current buffer. */
1443 unsigned int local_if_set
: 1;
1444 /* 1 means this variable can have frame-local bindings, otherwise, it is
1445 can have buffer-local bindings. The two cannot be combined. */
1446 unsigned int frame_local
: 1;
1447 /* 1 means that the binding now loaded was found.
1448 Presumably equivalent to (defcell!=valcell). */
1449 unsigned int found
: 1;
1450 /* If non-NULL, a forwarding to the C var where it should also be set. */
1451 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1452 /* The buffer or frame for which the loaded binding was found. */
1454 /* A cons cell that holds the default value. It has the form
1455 (SYMBOL . DEFAULT-VALUE). */
1456 Lisp_Object defcell
;
1457 /* The cons cell from `where's parameter alist.
1458 It always has the form (SYMBOL . VALUE)
1459 Note that if `forward' is non-nil, VALUE may be out of date.
1460 Also if the currently loaded binding is the default binding, then
1461 this is `eq'ual to defcell. */
1462 Lisp_Object valcell
;
1465 /* Like Lisp_Objfwd except that value lives in a slot in the
1467 struct Lisp_Kboard_Objfwd
1469 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1475 struct Lisp_Intfwd u_intfwd
;
1476 struct Lisp_Boolfwd u_boolfwd
;
1477 struct Lisp_Objfwd u_objfwd
;
1478 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1479 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1482 /* Lisp floating point type. */
1488 struct Lisp_Float
*chain
;
1492 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1493 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1495 /* A character, declared with the following typedef, is a member
1496 of some character set associated with the current buffer. */
1497 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1499 typedef unsigned char UCHAR
;
1502 /* Meanings of slots in a Lisp_Compiled: */
1506 COMPILED_ARGLIST
= 0,
1507 COMPILED_BYTECODE
= 1,
1508 COMPILED_CONSTANTS
= 2,
1509 COMPILED_STACK_DEPTH
= 3,
1510 COMPILED_DOC_STRING
= 4,
1511 COMPILED_INTERACTIVE
= 5
1514 /* Flag bits in a character. These also get used in termhooks.h.
1515 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1516 (MUlti-Lingual Emacs) might need 22 bits for the character value
1517 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1520 CHAR_ALT
= 0x0400000,
1521 CHAR_SUPER
= 0x0800000,
1522 CHAR_HYPER
= 0x1000000,
1523 CHAR_SHIFT
= 0x2000000,
1524 CHAR_CTL
= 0x4000000,
1525 CHAR_META
= 0x8000000,
1527 CHAR_MODIFIER_MASK
=
1528 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1530 /* Actually, the current Emacs uses 22 bits for the character value
1538 /* The glyph datatype, used to represent characters on the display.
1539 It consists of a char code and a face id. */
1546 /* Return a glyph's character code. */
1547 #define GLYPH_CHAR(glyph) ((glyph).ch)
1549 /* Return a glyph's face ID. */
1550 #define GLYPH_FACE(glyph) ((glyph).face_id)
1552 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1553 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1554 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1556 /* Return 1 if GLYPH contains valid character code. */
1557 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1560 /* Glyph Code from a display vector may either be an integer which
1561 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1562 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1564 #define GLYPH_CODE_P(gc) \
1566 ? (CHARACTERP (XCAR (gc)) \
1567 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1568 : (RANGED_INTEGERP \
1570 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1571 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1572 : TYPE_MAXIMUM (EMACS_INT)))))
1574 /* The following are valid only if GLYPH_CODE_P (gc). */
1576 #define GLYPH_CODE_CHAR(gc) \
1577 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1579 #define GLYPH_CODE_FACE(gc) \
1580 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1582 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1586 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1588 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1589 (XINT (gc) >> CHARACTERBITS)); \
1593 /* Structure to hold mouse highlight data. This is here because other
1594 header files need it for defining struct x_output etc. */
1596 /* These variables describe the range of text currently shown in its
1597 mouse-face, together with the window they apply to. As long as
1598 the mouse stays within this range, we need not redraw anything on
1599 its account. Rows and columns are glyph matrix positions in
1600 MOUSE_FACE_WINDOW. */
1601 int mouse_face_beg_row
, mouse_face_beg_col
;
1602 int mouse_face_beg_x
, mouse_face_beg_y
;
1603 int mouse_face_end_row
, mouse_face_end_col
;
1604 int mouse_face_end_x
, mouse_face_end_y
;
1605 int mouse_face_past_end
;
1606 Lisp_Object mouse_face_window
;
1607 int mouse_face_face_id
;
1608 Lisp_Object mouse_face_overlay
;
1610 /* 1 if a mouse motion event came and we didn't handle it right away because
1611 gc was in progress. */
1612 int mouse_face_deferred_gc
;
1614 /* FRAME and X, Y position of mouse when last checked for
1615 highlighting. X and Y can be negative or out of range for the frame. */
1616 struct frame
*mouse_face_mouse_frame
;
1617 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1619 /* Nonzero means defer mouse-motion highlighting. */
1620 int mouse_face_defer
;
1622 /* Nonzero means that the mouse highlight should not be shown. */
1623 int mouse_face_hidden
;
1625 int mouse_face_image_state
;
1628 /* Data type checking. */
1630 #define NILP(x) EQ (x, Qnil)
1632 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1633 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1635 #define RANGED_INTEGERP(lo, x, hi) \
1636 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1637 #define TYPE_RANGED_INTEGERP(type, x) \
1638 (TYPE_SIGNED (type) \
1639 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1640 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1642 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1643 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1644 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1645 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1646 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1647 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1649 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1650 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1651 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1652 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1653 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1655 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1656 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1657 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1658 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1659 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1661 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1662 vectorlike_header * avoids aliasing issues. */
1663 #define PSEUDOVECTORP(x, code) \
1664 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1666 #define PSEUDOVECTOR_TYPEP(v, code) \
1667 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1668 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1670 /* True if object X, with internal type struct T *, is a pseudovector whose
1672 #define TYPED_PSEUDOVECTORP(x, t, code) \
1674 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1676 /* Test for specific pseudovector types. */
1677 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1678 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1679 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1680 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1681 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1682 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1683 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1684 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1685 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1686 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1687 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1688 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1690 /* Test for image (image . spec) */
1691 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1696 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1698 #define CHECK_LIST(x) \
1699 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1701 #define CHECK_LIST_CONS(x, y) \
1702 CHECK_TYPE (CONSP (x), Qlistp, y)
1704 #define CHECK_LIST_END(x, y) \
1705 CHECK_TYPE (NILP (x), Qlistp, y)
1707 #define CHECK_STRING(x) \
1708 CHECK_TYPE (STRINGP (x), Qstringp, x)
1710 #define CHECK_STRING_CAR(x) \
1711 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1713 #define CHECK_CONS(x) \
1714 CHECK_TYPE (CONSP (x), Qconsp, x)
1716 #define CHECK_SYMBOL(x) \
1717 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1719 #define CHECK_CHAR_TABLE(x) \
1720 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1722 #define CHECK_VECTOR(x) \
1723 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1725 #define CHECK_VECTOR_OR_STRING(x) \
1726 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1728 #define CHECK_ARRAY(x, Qxxxp) \
1729 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1731 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1732 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1734 #define CHECK_BUFFER(x) \
1735 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1737 #define CHECK_WINDOW(x) \
1738 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1740 #define CHECK_WINDOW_CONFIGURATION(x) \
1741 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1743 /* A window of any sort, leaf or interior, is "valid" if one of its
1744 buffer, vchild, or hchild members is non-nil. */
1745 #define CHECK_VALID_WINDOW(x) \
1746 CHECK_TYPE (WINDOWP (x) \
1747 && (!NILP (XWINDOW (x)->buffer) \
1748 || !NILP (XWINDOW (x)->vchild) \
1749 || !NILP (XWINDOW (x)->hchild)), \
1752 /* A window is "live" if and only if it shows a buffer. */
1753 #define CHECK_LIVE_WINDOW(x) \
1754 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), \
1757 #define CHECK_PROCESS(x) \
1758 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1760 #define CHECK_SUBR(x) \
1761 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1763 #define CHECK_NUMBER(x) \
1764 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1766 #define CHECK_NATNUM(x) \
1767 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1769 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1772 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1773 args_out_of_range_3 \
1775 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1776 ? MOST_NEGATIVE_FIXNUM \
1778 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1780 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1782 if (TYPE_SIGNED (type)) \
1783 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1785 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1788 #define CHECK_MARKER(x) \
1789 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1791 #define CHECK_NUMBER_COERCE_MARKER(x) \
1792 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1793 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1795 #define XFLOATINT(n) extract_float((n))
1797 #define CHECK_FLOAT(x) \
1798 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1800 #define CHECK_NUMBER_OR_FLOAT(x) \
1801 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1803 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1804 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1805 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1807 #define CHECK_OVERLAY(x) \
1808 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1810 /* Since we can't assign directly to the CAR or CDR fields of a cons
1811 cell, use these when checking that those fields contain numbers. */
1812 #define CHECK_NUMBER_CAR(x) \
1814 Lisp_Object tmp = XCAR (x); \
1815 CHECK_NUMBER (tmp); \
1816 XSETCAR ((x), tmp); \
1819 #define CHECK_NUMBER_CDR(x) \
1821 Lisp_Object tmp = XCDR (x); \
1822 CHECK_NUMBER (tmp); \
1823 XSETCDR ((x), tmp); \
1826 #define CHECK_NATNUM_CAR(x) \
1828 Lisp_Object tmp = XCAR (x); \
1829 CHECK_NATNUM (tmp); \
1830 XSETCAR ((x), tmp); \
1833 #define CHECK_NATNUM_CDR(x) \
1835 Lisp_Object tmp = XCDR (x); \
1836 CHECK_NATNUM (tmp); \
1837 XSETCDR ((x), tmp); \
1840 /* Define a built-in function for calling from Lisp.
1841 `lname' should be the name to give the function in Lisp,
1842 as a null-terminated C string.
1843 `fnname' should be the name of the function in C.
1844 By convention, it starts with F.
1845 `sname' should be the name for the C constant structure
1846 that records information on this function for internal use.
1847 By convention, it should be the same as `fnname' but with S instead of F.
1848 It's too bad that C macros can't compute this from `fnname'.
1849 `minargs' should be a number, the minimum number of arguments allowed.
1850 `maxargs' should be a number, the maximum number of arguments allowed,
1851 or else MANY or UNEVALLED.
1852 MANY means pass a vector of evaluated arguments,
1853 in the form of an integer number-of-arguments
1854 followed by the address of a vector of Lisp_Objects
1855 which contains the argument values.
1856 UNEVALLED means pass the list of unevaluated arguments
1857 `intspec' says how interactive arguments are to be fetched.
1858 If the string starts with a `(', `intspec' is evaluated and the resulting
1859 list is the list of arguments.
1860 If it's a string that doesn't start with `(', the value should follow
1861 the one of the doc string for `interactive'.
1862 A null string means call interactively with no arguments.
1863 `doc' is documentation for the user. */
1865 /* This version of DEFUN declares a function prototype with the right
1866 arguments, so we can catch errors with maxargs at compile-time. */
1868 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1869 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1870 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1871 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1872 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1873 { (Lisp_Object (__cdecl *)(void))fnname }, \
1874 minargs, maxargs, lname, intspec, 0}; \
1876 #else /* not _MSC_VER */
1877 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1878 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1879 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1880 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1881 { .a ## maxargs = fnname }, \
1882 minargs, maxargs, lname, intspec, 0}; \
1886 /* Note that the weird token-substitution semantics of ANSI C makes
1887 this work for MANY and UNEVALLED. */
1888 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1889 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1890 #define DEFUN_ARGS_0 (void)
1891 #define DEFUN_ARGS_1 (Lisp_Object)
1892 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1893 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1894 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1895 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1897 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1898 Lisp_Object, Lisp_Object)
1899 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1900 Lisp_Object, Lisp_Object, Lisp_Object)
1901 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1902 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1904 /* Non-zero if OBJ is a Lisp function. */
1905 #define FUNCTIONP(OBJ) functionp(OBJ)
1908 is how we define the symbol for function `name' at start-up time. */
1909 extern void defsubr (struct Lisp_Subr
*);
1917 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1918 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1919 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1920 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1921 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1923 /* Macros we use to define forwarded Lisp variables.
1924 These are used in the syms_of_FILENAME functions.
1926 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1927 lisp variable is actually a field in `struct emacs_globals'. The
1928 field's name begins with "f_", which is a convention enforced by
1929 these macros. Each such global has a corresponding #define in
1930 globals.h; the plain name should be used in the code.
1932 E.g., the global "cons_cells_consed" is declared as "int
1933 f_cons_cells_consed" in globals.h, but there is a define:
1935 #define cons_cells_consed globals.f_cons_cells_consed
1937 All C code uses the `cons_cells_consed' name. This is all done
1938 this way to support indirection for multi-threaded Emacs. */
1940 #define DEFVAR_LISP(lname, vname, doc) \
1942 static struct Lisp_Objfwd o_fwd; \
1943 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1945 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1947 static struct Lisp_Objfwd o_fwd; \
1948 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1950 #define DEFVAR_BOOL(lname, vname, doc) \
1952 static struct Lisp_Boolfwd b_fwd; \
1953 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1955 #define DEFVAR_INT(lname, vname, doc) \
1957 static struct Lisp_Intfwd i_fwd; \
1958 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1961 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1963 static struct Lisp_Objfwd o_fwd; \
1964 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1967 #define DEFVAR_KBOARD(lname, vname, doc) \
1969 static struct Lisp_Kboard_Objfwd ko_fwd; \
1970 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1973 /* Save and restore the instruction and environment pointers,
1974 without affecting the signal mask. */
1977 typedef jmp_buf sys_jmp_buf
;
1978 # define sys_setjmp(j) _setjmp (j)
1979 # define sys_longjmp(j, v) _longjmp (j, v)
1980 #elif defined HAVE_SIGSETJMP
1981 typedef sigjmp_buf sys_jmp_buf
;
1982 # define sys_setjmp(j) sigsetjmp (j, 0)
1983 # define sys_longjmp(j, v) siglongjmp (j, v)
1985 /* A platform that uses neither _longjmp nor siglongjmp; assume
1986 longjmp does not affect the sigmask. */
1987 typedef jmp_buf sys_jmp_buf
;
1988 # define sys_setjmp(j) setjmp (j)
1989 # define sys_longjmp(j, v) longjmp (j, v)
1993 /* Structure for recording Lisp call stack for backtrace purposes. */
1995 /* The special binding stack holds the outer values of variables while
1996 they are bound by a function application or a let form, stores the
1997 code to be executed for Lisp unwind-protect forms, and stores the C
1998 functions to be called for record_unwind_protect.
2000 If func is non-zero, undoing this binding applies func to old_value;
2001 This implements record_unwind_protect.
2003 Otherwise, the element is a variable binding.
2005 If the symbol field is a symbol, it is an ordinary variable binding.
2007 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2008 which means having bound a local value while CURRENT-BUFFER was active.
2009 If WHERE is nil this means we saw the default value when binding SYMBOL.
2010 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2011 value. Other values of WHERE mean an internal error. */
2013 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2017 Lisp_Object symbol
, old_value
;
2018 specbinding_func func
;
2019 Lisp_Object unused
; /* Dividing by 16 is faster than by 12. */
2022 extern struct specbinding
*specpdl
;
2023 extern struct specbinding
*specpdl_ptr
;
2024 extern ptrdiff_t specpdl_size
;
2026 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2028 /* Everything needed to describe an active condition case.
2030 Members are volatile if their values need to survive _longjmp when
2031 a 'struct handler' is a local variable. */
2034 /* The handler clauses and variable from the condition-case form. */
2035 /* For a handler set up in Lisp code, this is always a list.
2036 For an internal handler set up by internal_condition_case*,
2037 this can instead be the symbol t or `error'.
2038 t: handle all conditions.
2039 error: handle all conditions, and errors can run the debugger
2040 or display a backtrace. */
2041 Lisp_Object handler
;
2043 Lisp_Object
volatile var
;
2045 /* Fsignal stores here the condition-case clause that applies,
2046 and Fcondition_case thus knows which clause to run. */
2047 Lisp_Object
volatile chosen_clause
;
2049 /* Used to effect the longjump out to the handler. */
2050 struct catchtag
*tag
;
2052 /* The next enclosing handler. */
2053 struct handler
*next
;
2056 /* This structure helps implement the `catch' and `throw' control
2057 structure. A struct catchtag contains all the information needed
2058 to restore the state of the interpreter after a non-local jump.
2060 Handlers for error conditions (represented by `struct handler'
2061 structures) just point to a catch tag to do the cleanup required
2064 catchtag structures are chained together in the C calling stack;
2065 the `next' member points to the next outer catchtag.
2067 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2068 member is TAG, and then unbinds to it. The `val' member is used to
2069 hold VAL while the stack is unwound; `val' is returned as the value
2072 All the other members are concerned with restoring the interpreter
2075 Members are volatile if their values need to survive _longjmp when
2076 a 'struct catchtag' is a local variable. */
2080 Lisp_Object
volatile val
;
2081 struct catchtag
*volatile next
;
2082 struct gcpro
*gcpro
;
2084 struct backtrace
*backlist
;
2085 struct handler
*handlerlist
;
2086 EMACS_INT lisp_eval_depth
;
2087 ptrdiff_t volatile pdlcount
;
2088 int poll_suppress_count
;
2089 int interrupt_input_blocked
;
2090 struct byte_stack
*byte_stack
;
2093 extern Lisp_Object memory_signal_data
;
2095 /* An address near the bottom of the stack.
2096 Tells GC how to save a copy of the stack. */
2097 extern char *stack_bottom
;
2099 /* Check quit-flag and quit if it is non-nil.
2100 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2101 So the program needs to do QUIT at times when it is safe to quit.
2102 Every loop that might run for a long time or might not exit
2103 ought to do QUIT at least once, at a safe place.
2104 Unless that is impossible, of course.
2105 But it is very desirable to avoid creating loops where QUIT is impossible.
2107 Exception: if you set immediate_quit to nonzero,
2108 then the handler that responds to the C-g does the quit itself.
2109 This is a good thing to do around a loop that has no side effects
2110 and (in particular) cannot call arbitrary Lisp code.
2112 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2113 a request to exit Emacs when it is safe to do. */
2115 extern void process_pending_signals (void);
2116 extern int pending_signals
;
2118 extern void process_quit_flag (void);
2121 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2122 process_quit_flag (); \
2123 else if (pending_signals) \
2124 process_pending_signals (); \
2128 /* Nonzero if ought to quit now. */
2130 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2132 extern Lisp_Object Vascii_downcase_table
;
2133 extern Lisp_Object Vascii_canon_table
;
2135 /* Structure for recording stack slots that need marking. */
2137 /* This is a chain of structures, each of which points at a Lisp_Object
2138 variable whose value should be marked in garbage collection.
2139 Normally every link of the chain is an automatic variable of a function,
2140 and its `val' points to some argument or local variable of the function.
2141 On exit to the function, the chain is set back to the value it had on entry.
2142 This way, no link remains in the chain when the stack frame containing the
2145 Every function that can call Feval must protect in this fashion all
2146 Lisp_Object variables whose contents will be used again. */
2148 extern struct gcpro
*gcprolist
;
2154 /* Address of first protected variable. */
2155 volatile Lisp_Object
*var
;
2157 /* Number of consecutive protected variables. */
2165 /* Values of GC_MARK_STACK during compilation:
2167 0 Use GCPRO as before
2168 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2169 2 Mark the stack, and check that everything GCPRO'd is
2171 3 Mark using GCPRO's, mark stack last, and count how many
2172 dead objects are kept alive. */
2175 #define GC_USE_GCPROS_AS_BEFORE 0
2176 #define GC_MAKE_GCPROS_NOOPS 1
2177 #define GC_MARK_STACK_CHECK_GCPROS 2
2178 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2180 #ifndef GC_MARK_STACK
2181 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2184 /* Whether we do the stack marking manually. */
2185 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2186 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2189 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2191 /* Do something silly with gcproN vars just so gcc shuts up. */
2192 /* You get warnings from MIPSPro... */
2194 #define GCPRO1(varname) ((void) gcpro1)
2195 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2196 #define GCPRO3(varname1, varname2, varname3) \
2197 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2198 #define GCPRO4(varname1, varname2, varname3, varname4) \
2199 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2200 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2201 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2202 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2203 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2205 #define UNGCPRO ((void) 0)
2207 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2211 #define GCPRO1(varname) \
2212 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2213 gcprolist = &gcpro1; }
2215 #define GCPRO2(varname1, varname2) \
2216 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2217 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2218 gcprolist = &gcpro2; }
2220 #define GCPRO3(varname1, varname2, varname3) \
2221 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2222 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2223 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2224 gcprolist = &gcpro3; }
2226 #define GCPRO4(varname1, varname2, varname3, varname4) \
2227 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2228 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2229 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2230 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2231 gcprolist = &gcpro4; }
2233 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2234 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2235 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2236 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2237 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2238 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2239 gcprolist = &gcpro5; }
2241 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2242 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2243 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2244 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2245 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2246 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2247 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2248 gcprolist = &gcpro6; }
2250 #define UNGCPRO (gcprolist = gcpro1.next)
2254 extern int gcpro_level
;
2256 #define GCPRO1(varname) \
2257 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2258 gcpro1.level = gcpro_level++; \
2259 gcprolist = &gcpro1; }
2261 #define GCPRO2(varname1, varname2) \
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 gcpro2.level = gcpro_level++; \
2266 gcprolist = &gcpro2; }
2268 #define GCPRO3(varname1, varname2, varname3) \
2269 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2270 gcpro1.level = gcpro_level; \
2271 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2272 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2273 gcpro3.level = gcpro_level++; \
2274 gcprolist = &gcpro3; }
2276 #define GCPRO4(varname1, varname2, varname3, varname4) \
2277 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2278 gcpro1.level = gcpro_level; \
2279 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2280 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2281 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2282 gcpro4.level = gcpro_level++; \
2283 gcprolist = &gcpro4; }
2285 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2286 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2287 gcpro1.level = gcpro_level; \
2288 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2289 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2290 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2291 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2292 gcpro5.level = gcpro_level++; \
2293 gcprolist = &gcpro5; }
2295 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2296 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2297 gcpro1.level = gcpro_level; \
2298 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2299 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2300 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2301 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2302 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2303 gcpro6.level = gcpro_level++; \
2304 gcprolist = &gcpro6; }
2307 ((--gcpro_level != gcpro1.level) \
2308 ? (emacs_abort (), 0) \
2309 : ((gcprolist = gcpro1.next), 0))
2311 #endif /* DEBUG_GCPRO */
2312 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2315 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2316 #define RETURN_UNGCPRO(expr) \
2319 Lisp_Object ret_ungc_val; \
2320 ret_ungc_val = (expr); \
2322 return ret_ungc_val; \
2326 /* Call staticpro (&var) to protect static variable `var'. */
2328 void staticpro (Lisp_Object
*);
2330 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2331 meaning as in the DEFUN macro, and is used to construct a prototype. */
2332 /* We can use the same trick as in the DEFUN macro to generate the
2333 appropriate prototype. */
2334 #define EXFUN(fnname, maxargs) \
2335 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2337 /* Forward declarations for prototypes. */
2341 /* Simple access functions. */
2343 LISP_INLINE Lisp_Object
*
2344 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2346 return & XVECTOR (array
)->contents
[idx
];
2350 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2352 /* Like ASET, but also can be used in the garbage collector:
2353 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2354 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2355 XVECTOR (array
)->contents
[idx
] = val
;
2358 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2361 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2363 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2364 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2367 /* Functions to modify hash tables. */
2370 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2372 h
->key_and_value
= key_and_value
;
2376 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2378 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2382 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2384 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2388 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2394 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2396 gc_aset (h
->next
, idx
, val
);
2400 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2406 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2408 gc_aset (h
->hash
, idx
, val
);
2412 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2418 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2420 gc_aset (h
->index
, idx
, val
);
2423 /* Use these functions to set Lisp_Object
2424 or pointer slots of struct Lisp_Symbol. */
2427 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2429 XSYMBOL (sym
)->name
= name
;
2433 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2435 XSYMBOL (sym
)->function
= function
;
2439 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2441 XSYMBOL (sym
)->plist
= plist
;
2445 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2447 XSYMBOL (sym
)->next
= next
;
2450 /* Buffer-local (also frame-local) variable access functions. */
2453 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2455 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2460 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2462 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2466 LISP_INLINE Lisp_Object
2467 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2469 return XCDR (blv
->valcell
);
2473 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2475 XSETCDR (blv
->valcell
, val
);
2479 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2485 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2491 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2496 /* Set overlay's property list. */
2499 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2501 XOVERLAY (overlay
)->plist
= plist
;
2504 /* Get text properties of S. */
2506 LISP_INLINE INTERVAL
2507 string_intervals (Lisp_Object s
)
2509 return XSTRING (s
)->intervals
;
2512 /* Set text properties of S to I. */
2515 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2517 XSTRING (s
)->intervals
= i
;
2520 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2521 of setting slots directly. */
2524 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2526 XCHAR_TABLE (table
)->ascii
= val
;
2529 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2531 XCHAR_TABLE (table
)->defalt
= val
;
2534 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2536 XCHAR_TABLE (table
)->parent
= val
;
2539 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2541 XCHAR_TABLE (table
)->purpose
= val
;
2544 /* Set different slots in (sub)character tables. */
2547 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2549 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2550 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2554 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2556 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2557 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2561 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2563 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2566 /* Defined in data.c. */
2567 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2568 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2569 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2570 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2571 extern Lisp_Object Qinvalid_read_syntax
;
2572 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2573 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2574 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2575 extern Lisp_Object Qtext_read_only
;
2576 extern Lisp_Object Qinteractive_form
;
2577 extern Lisp_Object Qcircular_list
;
2578 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2579 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2580 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2581 extern Lisp_Object Qbuffer_or_string_p
;
2582 extern Lisp_Object Qfboundp
;
2583 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2585 extern Lisp_Object Qcdr
;
2587 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2589 extern Lisp_Object Qfloatp
;
2590 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2592 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2594 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2596 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2598 /* Defined in frame.c. */
2599 extern Lisp_Object Qframep
;
2601 /* Defined in data.c. */
2602 extern Lisp_Object
indirect_function (Lisp_Object
);
2603 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2605 /* Convert the integer I to an Emacs representation, either the integer
2606 itself, or a cons of two or three integers, or if all else fails a float.
2607 I should not have side effects. */
2608 #define INTEGER_TO_CONS(i) \
2609 (! FIXNUM_OVERFLOW_P (i) \
2611 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2612 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2613 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2614 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2615 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2616 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2617 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2618 ? Fcons (make_number ((i) >> 16 >> 24), \
2619 Fcons (make_number ((i) >> 16 & 0xffffff), \
2620 make_number ((i) & 0xffff))) \
2623 /* Convert the Emacs representation CONS back to an integer of type
2624 TYPE, storing the result the variable VAR. Signal an error if CONS
2625 is not a valid representation or is out of range for TYPE. */
2626 #define CONS_TO_INTEGER(cons, type, var) \
2627 (TYPE_SIGNED (type) \
2628 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2629 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2630 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2631 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2633 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2634 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2635 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2637 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2638 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2639 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2640 extern void syms_of_data (void);
2641 extern void init_data (void);
2642 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2644 /* Defined in cmds.c */
2645 extern void syms_of_cmds (void);
2646 extern void keys_of_cmds (void);
2648 /* Defined in coding.c. */
2649 extern Lisp_Object Qcharset
;
2650 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2651 ptrdiff_t, bool, bool, Lisp_Object
);
2652 extern void init_coding (void);
2653 extern void init_coding_once (void);
2654 extern void syms_of_coding (void);
2656 /* Defined in character.c. */
2657 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2658 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2659 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2660 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2661 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2662 extern void syms_of_character (void);
2664 /* Defined in charset.c. */
2665 extern void init_charset (void);
2666 extern void init_charset_once (void);
2667 extern void syms_of_charset (void);
2668 /* Structure forward declarations. */
2671 /* Defined in composite.c. */
2672 extern void syms_of_composite (void);
2674 /* Defined in syntax.c. */
2675 extern void init_syntax_once (void);
2676 extern void syms_of_syntax (void);
2678 /* Defined in fns.c. */
2679 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2680 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2681 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2682 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2683 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2684 extern void sweep_weak_hash_tables (void);
2685 extern Lisp_Object Qcursor_in_echo_area
;
2686 extern Lisp_Object Qstring_lessp
;
2687 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2688 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2689 EMACS_UINT
sxhash (Lisp_Object
, int);
2690 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2691 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2693 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2694 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2697 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2698 ptrdiff_t, ptrdiff_t);
2699 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2700 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2701 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2702 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2703 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2704 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2705 extern void clear_string_char_byte_cache (void);
2706 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2707 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2708 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2709 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2710 extern void syms_of_fns (void);
2712 /* Defined in floatfns.c. */
2713 extern double extract_float (Lisp_Object
);
2714 extern void syms_of_floatfns (void);
2715 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2717 /* Defined in fringe.c. */
2718 extern void syms_of_fringe (void);
2719 extern void init_fringe (void);
2720 #ifdef HAVE_WINDOW_SYSTEM
2721 extern void mark_fringe_data (void);
2722 extern void init_fringe_once (void);
2723 #endif /* HAVE_WINDOW_SYSTEM */
2725 /* Defined in image.c. */
2726 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2727 extern Lisp_Object QCconversion
;
2728 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2729 extern void syms_of_image (void);
2731 /* Defined in insdel.c. */
2732 extern Lisp_Object Qinhibit_modification_hooks
;
2733 extern void move_gap (ptrdiff_t);
2734 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2735 extern _Noreturn
void buffer_overflow (void);
2736 extern void make_gap (ptrdiff_t);
2737 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2738 ptrdiff_t, bool, bool);
2739 extern int count_combining_before (const unsigned char *,
2740 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2741 extern int count_combining_after (const unsigned char *,
2742 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2743 extern void insert (const char *, ptrdiff_t);
2744 extern void insert_and_inherit (const char *, ptrdiff_t);
2745 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2746 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2748 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2749 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2750 ptrdiff_t, ptrdiff_t, bool);
2751 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2752 extern void insert_char (int);
2753 extern void insert_string (const char *);
2754 extern void insert_before_markers (const char *, ptrdiff_t);
2755 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2756 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2757 ptrdiff_t, ptrdiff_t,
2759 extern void del_range (ptrdiff_t, ptrdiff_t);
2760 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2761 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2762 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2763 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2764 ptrdiff_t, ptrdiff_t, bool);
2765 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2766 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2767 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2768 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2769 ptrdiff_t, ptrdiff_t);
2770 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2771 ptrdiff_t, ptrdiff_t);
2772 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2773 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2774 const char *, ptrdiff_t, ptrdiff_t, bool);
2775 extern void syms_of_insdel (void);
2777 /* Defined in dispnew.c. */
2778 #if (defined PROFILING \
2779 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2780 _Noreturn
void __executable_start (void);
2782 extern Lisp_Object selected_frame
;
2783 extern Lisp_Object Vwindow_system
;
2784 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2785 extern void init_display (void);
2786 extern void syms_of_display (void);
2788 /* Defined in xdisp.c. */
2789 extern Lisp_Object Qinhibit_point_motion_hooks
;
2790 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2791 extern Lisp_Object Qmenu_bar_update_hook
;
2792 extern Lisp_Object Qwindow_scroll_functions
;
2793 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2794 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2795 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2796 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2797 extern Lisp_Object Qleft_margin
, Qright_margin
;
2798 extern Lisp_Object Qglyphless_char
;
2799 extern Lisp_Object QCdata
, QCfile
;
2800 extern Lisp_Object QCmap
;
2801 extern Lisp_Object Qrisky_local_variable
;
2802 extern struct frame
*last_glyphless_glyph_frame
;
2803 extern int last_glyphless_glyph_face_id
;
2804 extern int last_glyphless_glyph_merged_face_id
;
2805 extern int noninteractive_need_newline
;
2806 extern Lisp_Object echo_area_buffer
[2];
2807 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2808 extern void check_message_stack (void);
2809 extern void setup_echo_area_for_printing (int);
2810 extern bool push_message (void);
2811 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2812 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2813 extern void restore_message (void);
2814 extern Lisp_Object
current_message (void);
2815 extern void clear_message (int, int);
2816 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2817 extern void message1 (const char *);
2818 extern void message1_nolog (const char *);
2819 extern void message2 (const char *, ptrdiff_t, int);
2820 extern void message2_nolog (const char *, ptrdiff_t, int);
2821 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2822 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2823 extern void message_dolog (const char *, ptrdiff_t, int, int);
2824 extern void message_with_string (const char *, Lisp_Object
, int);
2825 extern void message_log_maybe_newline (void);
2826 extern void update_echo_area (void);
2827 extern void truncate_echo_area (ptrdiff_t);
2828 extern void redisplay (void);
2829 extern void redisplay_preserve_echo_area (int);
2830 extern void prepare_menu_bars (void);
2832 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2833 extern void syms_of_xdisp (void);
2834 extern void init_xdisp (void);
2835 extern Lisp_Object
safe_eval (Lisp_Object
);
2836 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2837 int *, int *, int *, int *, int *);
2839 /* Defined in xsettings.c. */
2840 extern void syms_of_xsettings (void);
2842 /* Defined in vm-limit.c. */
2843 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2845 /* Defined in alloc.c. */
2846 extern void check_pure_size (void);
2847 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2848 extern void malloc_warning (const char *);
2849 extern _Noreturn
void memory_full (size_t);
2850 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2851 extern bool survives_gc_p (Lisp_Object
);
2852 extern void mark_object (Lisp_Object
);
2853 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2854 extern void refill_memory_reserve (void);
2856 extern const char *pending_malloc_warning
;
2857 extern Lisp_Object zero_vector
;
2858 extern Lisp_Object
*stack_base
;
2859 extern EMACS_INT consing_since_gc
;
2860 extern EMACS_INT gc_relative_threshold
;
2861 extern EMACS_INT memory_full_cons_threshold
;
2862 extern Lisp_Object
list1 (Lisp_Object
);
2863 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2864 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2865 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2866 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2868 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2869 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2870 extern _Noreturn
void string_overflow (void);
2871 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2872 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2873 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2874 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2876 /* Make unibyte string from C string when the length isn't known. */
2878 LISP_INLINE Lisp_Object
2879 build_unibyte_string (const char *str
)
2881 return make_unibyte_string (str
, strlen (str
));
2884 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2885 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2886 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2887 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2888 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2889 extern Lisp_Object
make_specified_string (const char *,
2890 ptrdiff_t, ptrdiff_t, bool);
2891 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2892 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2894 /* Make a string allocated in pure space, use STR as string data. */
2896 LISP_INLINE Lisp_Object
2897 build_pure_c_string (const char *str
)
2899 return make_pure_c_string (str
, strlen (str
));
2902 /* Make a string from the data at STR, treating it as multibyte if the
2905 LISP_INLINE Lisp_Object
2906 build_string (const char *str
)
2908 return make_string (str
, strlen (str
));
2911 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2912 extern void make_byte_code (struct Lisp_Vector
*);
2913 extern Lisp_Object Qchar_table_extra_slots
;
2914 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2915 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2916 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2918 allocate_pseudovector \
2919 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2920 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2921 extern struct window
*allocate_window (void);
2922 extern struct frame
*allocate_frame (void);
2923 extern struct Lisp_Process
*allocate_process (void);
2924 extern struct terminal
*allocate_terminal (void);
2925 extern bool gc_in_progress
;
2926 extern bool abort_on_gc
;
2927 extern Lisp_Object
make_float (double);
2928 extern void display_malloc_warning (void);
2929 extern ptrdiff_t inhibit_garbage_collection (void);
2930 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2931 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2932 extern void free_marker (Lisp_Object
);
2933 extern void free_cons (struct Lisp_Cons
*);
2934 extern void init_alloc_once (void);
2935 extern void init_alloc (void);
2936 extern void syms_of_alloc (void);
2937 extern struct buffer
* allocate_buffer (void);
2938 extern int valid_lisp_object_p (Lisp_Object
);
2939 #ifdef GC_CHECK_CONS_LIST
2940 extern void check_cons_list (void);
2942 #define check_cons_list() ((void) 0)
2946 /* Defined in ralloc.c. */
2947 extern void *r_alloc (void **, size_t);
2948 extern void r_alloc_free (void **);
2949 extern void *r_re_alloc (void **, size_t);
2950 extern void r_alloc_reset_variable (void **, void **);
2951 extern void r_alloc_inhibit_buffer_relocation (int);
2954 /* Defined in chartab.c. */
2955 extern Lisp_Object
copy_char_table (Lisp_Object
);
2956 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2957 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2959 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
2960 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
2961 extern int char_table_translate (Lisp_Object
, int);
2962 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2964 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2965 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2966 Lisp_Object
, Lisp_Object
,
2967 Lisp_Object
, struct charset
*,
2968 unsigned, unsigned);
2969 extern Lisp_Object
uniprop_table (Lisp_Object
);
2970 extern void syms_of_chartab (void);
2972 /* Defined in print.c. */
2973 extern Lisp_Object Vprin1_to_string_buffer
;
2974 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2975 extern Lisp_Object Qstandard_output
;
2976 extern Lisp_Object Qexternal_debugging_output
;
2977 extern void temp_output_buffer_setup (const char *);
2978 extern int print_level
;
2979 extern Lisp_Object Qprint_escape_newlines
;
2980 extern void write_string (const char *, int);
2981 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2983 extern Lisp_Object internal_with_output_to_temp_buffer
2984 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2985 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
2986 extern int float_to_string (char *, double);
2987 extern void syms_of_print (void);
2989 /* Defined in doprnt.c. */
2990 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2992 extern ptrdiff_t esprintf (char *, char const *, ...)
2993 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2994 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2996 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2997 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2998 char const *, va_list)
2999 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3001 /* Defined in lread.c. */
3002 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3003 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3004 extern Lisp_Object Qlexical_binding
;
3005 extern Lisp_Object
check_obarray (Lisp_Object
);
3006 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3007 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3008 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3009 #define LOADHIST_ATTACH(x) \
3011 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3013 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3014 Lisp_Object
*, Lisp_Object
);
3015 Lisp_Object
string_to_number (char const *, int, int);
3016 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3018 extern void dir_warning (const char *, Lisp_Object
);
3019 extern void close_load_descs (void);
3020 extern void init_obarray (void);
3021 extern void init_lread (void);
3022 extern void syms_of_lread (void);
3024 LISP_INLINE Lisp_Object
3025 intern (const char *str
)
3027 return intern_1 (str
, strlen (str
));
3030 LISP_INLINE Lisp_Object
3031 intern_c_string (const char *str
)
3033 return intern_c_string_1 (str
, strlen (str
));
3036 /* Defined in eval.c. */
3037 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3038 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3039 extern Lisp_Object Qand_rest
;
3040 extern Lisp_Object Vautoload_queue
;
3041 extern Lisp_Object Vsignaling_function
;
3042 extern Lisp_Object inhibit_lisp_code
;
3044 extern struct catchtag
*catchlist
;
3045 extern struct handler
*handlerlist
;
3047 /* To run a normal hook, use the appropriate function from the list below.
3048 The calling convention:
3050 if (!NILP (Vrun_hooks))
3051 call1 (Vrun_hooks, Qmy_funny_hook);
3053 should no longer be used. */
3054 extern Lisp_Object Vrun_hooks
;
3055 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3056 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3057 Lisp_Object (*funcall
)
3058 (ptrdiff_t nargs
, Lisp_Object
*args
));
3059 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3060 extern _Noreturn
void xsignal0 (Lisp_Object
);
3061 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3062 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3063 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3065 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3066 extern Lisp_Object
eval_sub (Lisp_Object form
);
3067 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3068 extern Lisp_Object
call0 (Lisp_Object
);
3069 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3070 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3071 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3072 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3073 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3074 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3075 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3076 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3077 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3078 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3079 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3080 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3081 extern Lisp_Object internal_condition_case_n
3082 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3083 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3084 extern void specbind (Lisp_Object
, Lisp_Object
);
3085 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3086 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3087 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3088 extern _Noreturn
void verror (const char *, va_list)
3089 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3090 extern Lisp_Object
un_autoload (Lisp_Object
);
3091 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3092 extern void init_eval_once (void);
3093 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3094 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3095 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3096 extern void init_eval (void);
3098 extern void mark_backtrace (void);
3100 extern void syms_of_eval (void);
3102 /* Defined in editfns.c. */
3103 extern Lisp_Object Qfield
;
3104 extern void insert1 (Lisp_Object
);
3105 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3106 extern Lisp_Object
save_excursion_save (void);
3107 extern Lisp_Object
save_restriction_save (void);
3108 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3109 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3110 extern _Noreturn
void time_overflow (void);
3111 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3112 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3114 extern void init_editfns (void);
3115 const char *get_system_name (void);
3116 extern void syms_of_editfns (void);
3117 extern void set_time_zone_rule (const char *);
3119 /* Defined in buffer.c. */
3120 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3121 extern _Noreturn
void nsberror (Lisp_Object
);
3122 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3123 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3124 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3125 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3126 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3127 extern bool overlay_touches_p (ptrdiff_t);
3128 extern Lisp_Object Vbuffer_alist
;
3129 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3130 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3131 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3132 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3133 extern void init_buffer_once (void);
3134 extern void init_buffer (void);
3135 extern void syms_of_buffer (void);
3136 extern void keys_of_buffer (void);
3138 /* Defined in marker.c. */
3140 extern ptrdiff_t marker_position (Lisp_Object
);
3141 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3142 extern void clear_charpos_cache (struct buffer
*);
3143 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3144 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3145 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3146 extern void unchain_marker (struct Lisp_Marker
*marker
);
3147 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3148 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3149 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3150 ptrdiff_t, ptrdiff_t);
3151 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3152 extern void syms_of_marker (void);
3154 /* Defined in fileio.c. */
3156 extern Lisp_Object Qfile_error
;
3157 extern Lisp_Object Qfile_exists_p
;
3158 extern Lisp_Object Qfile_directory_p
;
3159 extern Lisp_Object Qinsert_file_contents
;
3160 extern Lisp_Object Qfile_name_history
;
3161 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3162 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3163 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3164 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3165 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3166 extern void internal_delete_file (Lisp_Object
);
3167 extern void syms_of_fileio (void);
3168 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3169 extern Lisp_Object Qdelete_file
;
3171 /* Defined in search.c. */
3172 extern void shrink_regexp_cache (void);
3173 extern void restore_search_regs (void);
3174 extern void record_unwind_save_match_data (void);
3175 struct re_registers
;
3176 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3177 struct re_registers
*,
3178 Lisp_Object
, int, int);
3179 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3180 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3182 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3183 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3184 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3185 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3187 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3189 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3190 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3191 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3192 extern void syms_of_search (void);
3193 extern void clear_regexp_cache (void);
3195 /* Defined in minibuf.c. */
3197 extern Lisp_Object Qcompletion_ignore_case
;
3198 extern Lisp_Object Vminibuffer_list
;
3199 extern Lisp_Object last_minibuf_string
;
3200 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3201 extern void init_minibuf_once (void);
3202 extern void syms_of_minibuf (void);
3204 /* Defined in callint.c. */
3206 extern Lisp_Object Qminus
, Qplus
;
3207 extern Lisp_Object Qwhen
;
3208 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3209 extern void syms_of_callint (void);
3211 /* Defined in casefiddle.c. */
3213 extern Lisp_Object Qidentity
;
3214 extern void syms_of_casefiddle (void);
3215 extern void keys_of_casefiddle (void);
3217 /* Defined in casetab.c. */
3219 extern void init_casetab_once (void);
3220 extern void syms_of_casetab (void);
3222 /* Defined in keyboard.c. */
3224 extern Lisp_Object echo_message_buffer
;
3225 extern struct kboard
*echo_kboard
;
3226 extern void cancel_echoing (void);
3227 extern Lisp_Object Qdisabled
, QCfilter
;
3228 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3229 extern Lisp_Object Qtop
;
3230 extern Lisp_Object last_undo_boundary
;
3231 extern int input_pending
;
3232 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3233 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3234 extern void discard_mouse_events (void);
3235 extern Lisp_Object pending_funcalls
;
3236 extern int detect_input_pending (void);
3237 extern int detect_input_pending_ignore_squeezables (void);
3238 extern int detect_input_pending_run_timers (int);
3239 extern void safe_run_hooks (Lisp_Object
);
3240 extern void cmd_error_internal (Lisp_Object
, const char *);
3241 extern Lisp_Object
command_loop_1 (void);
3242 extern Lisp_Object
recursive_edit_1 (void);
3243 extern void record_auto_save (void);
3244 extern void force_auto_save_soon (void);
3245 extern void init_keyboard (void);
3246 extern void syms_of_keyboard (void);
3247 extern void keys_of_keyboard (void);
3249 /* Defined in indent.c. */
3250 extern ptrdiff_t current_column (void);
3251 extern void invalidate_current_column (void);
3252 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3253 extern void syms_of_indent (void);
3255 /* Defined in frame.c. */
3256 extern Lisp_Object Qonly
, Qnone
;
3257 extern Lisp_Object Qvisible
;
3258 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3259 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3260 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3262 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3264 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3265 extern void frames_discard_buffer (Lisp_Object
);
3266 extern void syms_of_frame (void);
3268 /* Defined in emacs.c. */
3269 extern char **initial_argv
;
3270 extern int initial_argc
;
3271 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3272 extern bool display_arg
;
3274 extern Lisp_Object
decode_env_path (const char *, const char *);
3275 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3276 extern Lisp_Object Qfile_name_handler_alist
;
3277 extern _Noreturn
void fatal_error_backtrace (int, int);
3278 extern Lisp_Object Qkill_emacs
;
3280 void fixup_locale (void);
3281 void synchronize_system_messages_locale (void);
3282 void synchronize_system_time_locale (void);
3284 #define setlocale(category, locale)
3285 #define fixup_locale()
3286 #define synchronize_system_messages_locale()
3287 #define synchronize_system_time_locale()
3289 extern void shut_down_emacs (int, Lisp_Object
);
3291 /* True means don't do interactive redisplay and don't change tty modes. */
3292 extern bool noninteractive
;
3294 /* True means remove site-lisp directories from load-path. */
3295 extern bool no_site_lisp
;
3297 /* Pipe used to send exit notification to the daemon parent at
3299 extern int daemon_pipe
[2];
3300 #define IS_DAEMON (daemon_pipe[1] != 0)
3302 /* True if handling a fatal error already. */
3303 extern bool fatal_error_in_progress
;
3305 /* True means don't do use window-system-specific display code. */
3306 extern bool inhibit_window_system
;
3307 /* True means that a filter or a sentinel is running. */
3308 extern bool running_asynch_code
;
3310 /* Defined in process.c. */
3311 extern Lisp_Object QCtype
, Qlocal
;
3312 extern Lisp_Object Qprocessp
;
3313 extern void kill_buffer_processes (Lisp_Object
);
3314 extern int wait_reading_process_output (intmax_t, int, int, int,
3316 struct Lisp_Process
*,
3318 /* Max value for the first argument of wait_reading_process_output. */
3319 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3320 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3321 The bug merely causes a bogus warning, but the warning is annoying. */
3322 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3324 # define WAIT_READING_MAX INTMAX_MAX
3326 extern void add_keyboard_wait_descriptor (int);
3327 extern void delete_keyboard_wait_descriptor (int);
3329 extern void add_gpm_wait_descriptor (int);
3330 extern void delete_gpm_wait_descriptor (int);
3332 extern void close_process_descs (void);
3333 extern void init_process_emacs (void);
3334 extern void syms_of_process (void);
3335 extern void setup_process_coding_systems (Lisp_Object
);
3340 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3341 extern void init_callproc_1 (void);
3342 extern void init_callproc (void);
3343 extern void set_initial_environment (void);
3344 extern void syms_of_callproc (void);
3346 /* Defined in doc.c. */
3347 extern Lisp_Object Qfunction_documentation
;
3348 extern Lisp_Object
read_doc_string (Lisp_Object
);
3349 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3350 extern void syms_of_doc (void);
3351 extern int read_bytecode_char (bool);
3353 /* Defined in bytecode.c. */
3354 extern Lisp_Object Qbytecode
;
3355 extern void syms_of_bytecode (void);
3356 extern struct byte_stack
*byte_stack_list
;
3358 extern void mark_byte_stack (void);
3360 extern void unmark_byte_stack (void);
3361 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3362 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3364 /* Defined in macros.c. */
3365 extern Lisp_Object Qexecute_kbd_macro
;
3366 extern void init_macros (void);
3367 extern void syms_of_macros (void);
3369 /* Defined in undo.c. */
3370 extern Lisp_Object Qapply
;
3371 extern Lisp_Object Qinhibit_read_only
;
3372 extern void truncate_undo_list (struct buffer
*);
3373 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3374 extern void record_insert (ptrdiff_t, ptrdiff_t);
3375 extern void record_delete (ptrdiff_t, Lisp_Object
);
3376 extern void record_first_change (void);
3377 extern void record_change (ptrdiff_t, ptrdiff_t);
3378 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3379 Lisp_Object
, Lisp_Object
,
3381 extern void syms_of_undo (void);
3382 /* Defined in textprop.c. */
3383 extern Lisp_Object Qfont
, Qmouse_face
;
3384 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3385 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3386 extern Lisp_Object Qminibuffer_prompt
;
3388 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3390 /* Defined in menu.c. */
3391 extern void syms_of_menu (void);
3393 /* Defined in xmenu.c. */
3394 extern void syms_of_xmenu (void);
3396 /* Defined in termchar.h. */
3397 struct tty_display_info
;
3399 /* Defined in termhooks.h. */
3402 /* Defined in sysdep.c. */
3403 #ifndef HAVE_GET_CURRENT_DIR_NAME
3404 extern char *get_current_dir_name (void);
3406 extern void stuff_char (char c
);
3407 extern void init_sigio (int);
3408 extern void sys_subshell (void);
3409 extern void sys_suspend (void);
3410 extern void discard_tty_input (void);
3411 extern void init_sys_modes (struct tty_display_info
*);
3412 extern void reset_sys_modes (struct tty_display_info
*);
3413 extern void init_all_sys_modes (void);
3414 extern void reset_all_sys_modes (void);
3415 extern void wait_for_termination (pid_t
);
3416 extern void interruptible_wait_for_termination (pid_t
);
3417 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3418 extern void child_setup_tty (int);
3419 extern void setup_pty (int);
3420 extern int set_window_size (int, int, int);
3421 extern EMACS_INT
get_random (void);
3422 extern void seed_random (void *, ptrdiff_t);
3423 extern void init_random (void);
3424 extern void emacs_backtrace (int);
3425 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3426 extern int emacs_open (const char *, int, int);
3427 extern int emacs_close (int);
3428 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3429 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3430 enum { READLINK_BUFSIZE
= 1024 };
3431 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3433 extern void unlock_all_files (void);
3434 extern void lock_file (Lisp_Object
);
3435 extern void unlock_file (Lisp_Object
);
3436 extern void unlock_buffer (struct buffer
*);
3437 extern void syms_of_filelock (void);
3439 /* Defined in sound.c. */
3440 extern void syms_of_sound (void);
3442 /* Defined in category.c. */
3443 extern void init_category_once (void);
3444 extern Lisp_Object
char_category_set (int);
3445 extern void syms_of_category (void);
3447 /* Defined in ccl.c. */
3448 extern void syms_of_ccl (void);
3450 /* Defined in dired.c. */
3451 extern void syms_of_dired (void);
3452 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3453 Lisp_Object
, Lisp_Object
,
3456 /* Defined in term.c. */
3457 extern int *char_ins_del_vector
;
3458 extern void syms_of_term (void);
3459 extern _Noreturn
void fatal (const char *msgid
, ...)
3460 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3462 /* Defined in terminal.c. */
3463 extern void syms_of_terminal (void);
3465 /* Defined in font.c. */
3466 extern void syms_of_font (void);
3467 extern void init_font (void);
3469 #ifdef HAVE_WINDOW_SYSTEM
3470 /* Defined in fontset.c. */
3471 extern void syms_of_fontset (void);
3473 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3474 extern Lisp_Object Qfont_param
;
3477 /* Defined in xfaces.c. */
3478 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3479 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3480 extern Lisp_Object Qmode_line_inactive
;
3481 extern Lisp_Object Qface
;
3482 extern Lisp_Object Qnormal
;
3483 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3484 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3485 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3486 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3487 extern Lisp_Object Qoblique
, Qitalic
;
3488 extern Lisp_Object Vface_alternative_font_family_alist
;
3489 extern Lisp_Object Vface_alternative_font_registry_alist
;
3490 extern void syms_of_xfaces (void);
3492 #ifdef HAVE_X_WINDOWS
3493 /* Defined in xfns.c. */
3494 extern void syms_of_xfns (void);
3496 /* Defined in xsmfns.c. */
3497 extern void syms_of_xsmfns (void);
3499 /* Defined in xselect.c. */
3500 extern void syms_of_xselect (void);
3502 /* Defined in xterm.c. */
3503 extern void syms_of_xterm (void);
3504 #endif /* HAVE_X_WINDOWS */
3506 #ifdef HAVE_WINDOW_SYSTEM
3507 /* Defined in xterm.c, nsterm.m, w32term.c. */
3508 extern char *x_get_keysym_name (int);
3509 #endif /* HAVE_WINDOW_SYSTEM */
3512 /* Defined in xml.c. */
3513 extern void syms_of_xml (void);
3514 extern void xml_cleanup_parser (void);
3518 /* Defined in (x|w32)fns.c, nsfns.m... */
3519 extern int have_menus_p (void);
3523 /* Defined in dbusbind.c. */
3524 void syms_of_dbusbind (void);
3528 /* Defined in msdos.c, w32.c. */
3529 extern char *emacs_root_dir (void);
3532 /* True means Emacs has already been initialized.
3533 Used during startup to detect startup of dumped Emacs. */
3534 extern bool initialized
;
3536 extern int immediate_quit
; /* Nonzero means ^G can quit instantly. */
3538 extern void *xmalloc (size_t);
3539 extern void *xzalloc (size_t);
3540 extern void *xrealloc (void *, size_t);
3541 extern void xfree (void *);
3542 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3543 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3544 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3546 extern char *xstrdup (const char *);
3548 extern char *egetenv (const char *);
3550 /* Set up the name of the machine we're running on. */
3551 extern void init_system_name (void);
3553 /* We used to use `abs', but that clashes with system headers on some
3554 platforms, and using a name reserved by Standard C is a bad idea
3557 #define eabs(x) ((x) < 0 ? -(x) : (x))
3560 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3563 #define make_fixnum_or_float(val) \
3564 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3566 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3567 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3569 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3571 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3572 extern void *record_xmalloc (size_t);
3574 #define USE_SAFE_ALLOCA \
3575 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3577 /* SAFE_ALLOCA allocates a simple buffer. */
3579 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3581 : (sa_must_free = 1, record_xmalloc (size)))
3583 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3584 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3585 positive. The code is tuned for MULTIPLIER being a constant. */
3587 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3589 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3590 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3593 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3595 record_unwind_protect (safe_alloca_unwind, \
3596 make_save_value (buf, 0)); \
3600 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3602 #define SAFE_FREE() \
3604 if (sa_must_free) { \
3606 unbind_to (sa_count, Qnil); \
3611 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3613 #define SAFE_ALLOCA_LISP(buf, nelt) \
3615 if ((nelt) < MAX_ALLOCA / word_size) \
3616 buf = alloca ((nelt) * word_size); \
3617 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3620 buf = xmalloc ((nelt) * word_size); \
3621 arg_ = make_save_value (buf, nelt); \
3622 XSAVE_VALUE (arg_)->dogc = 1; \
3624 record_unwind_protect (safe_alloca_unwind, arg_); \
3627 memory_full (SIZE_MAX); \
3631 #include "globals.h"
3633 /* Check whether it's time for GC, and run it if so. */
3638 if ((consing_since_gc
> gc_cons_threshold
3639 && consing_since_gc
> gc_relative_threshold
)
3640 || (!NILP (Vmemory_full
)
3641 && consing_since_gc
> memory_full_cons_threshold
))
3642 Fgarbage_collect ();
3646 functionp (Lisp_Object object
)
3648 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3650 object
= Findirect_function (object
, Qt
);
3652 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3654 /* Autoloaded symbols are functions, except if they load
3655 macros or keymaps. */
3657 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3658 object
= XCDR (object
);
3660 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3665 return XSUBR (object
)->max_args
!= UNEVALLED
;
3666 else if (COMPILEDP (object
))
3668 else if (CONSP (object
))
3670 Lisp_Object car
= XCAR (object
);
3671 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3679 #endif /* EMACS_LISP_H */