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/>. */
36 # define LISP_INLINE INLINE
39 /* The ubiquitous max and min macros. */
42 #define max(a, b) ((a) > (b) ? (a) : (b))
43 #define min(a, b) ((a) < (b) ? (a) : (b))
45 /* EMACS_INT - signed integer wide enough to hold an Emacs value
46 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
47 pI - printf length modifier for EMACS_INT
48 EMACS_UINT - unsigned variant of EMACS_INT */
50 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
51 typedef long long int EMACS_INT
;
52 typedef unsigned long long int EMACS_UINT
;
53 # define EMACS_INT_MAX LLONG_MAX
55 # elif INT_MAX < LONG_MAX
56 typedef long int EMACS_INT
;
57 typedef unsigned long int EMACS_UINT
;
58 # define EMACS_INT_MAX LONG_MAX
61 typedef int EMACS_INT
;
62 typedef unsigned int EMACS_UINT
;
63 # define EMACS_INT_MAX INT_MAX
68 /* Number of bits in some machine integer types. */
71 BITS_PER_CHAR
= CHAR_BIT
,
72 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
73 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
74 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
75 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
78 /* printmax_t and uprintmax_t are types for printing large integers.
79 These are the widest integers that are supported for printing.
80 pMd etc. are conversions for printing them.
81 On C99 hosts, there's no problem, as even the widest integers work.
82 Fall back on EMACS_INT on pre-C99 hosts. */
84 typedef intmax_t printmax_t
;
85 typedef uintmax_t uprintmax_t
;
89 typedef EMACS_INT printmax_t
;
90 typedef EMACS_UINT uprintmax_t
;
95 /* Use pD to format ptrdiff_t values, which suffice for indexes into
96 buffers and strings. Emacs never allocates objects larger than
97 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
98 In C99, pD can always be "t"; configure it here for the sake of
99 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
100 #if PTRDIFF_MAX == INT_MAX
102 #elif PTRDIFF_MAX == LONG_MAX
104 #elif PTRDIFF_MAX == LLONG_MAX
110 /* Extra internal type checking? */
112 /* Define an Emacs version of 'assert (COND)', since some
113 system-defined 'assert's are flaky. COND should be free of side
114 effects; it may or may not be evaluated. */
115 #ifndef ENABLE_CHECKING
116 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
117 #else /* ENABLE_CHECKING */
119 extern _Noreturn
void die (const char *, const char *, int);
121 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
122 it to 1 using a debugger to temporarily disable aborting on
123 detected internal inconsistencies or error conditions.
125 In some cases, a good compiler may be able to optimize away the
126 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
127 STRINGP (x), but a particular use of XSTRING is invoked only after
128 testing that STRINGP (x) is true, making the test redundant. */
129 extern bool suppress_checking EXTERNALLY_VISIBLE
;
131 # define eassert(cond) \
132 ((cond) || suppress_checking \
134 : die ("assertion failed: " # cond, __FILE__, __LINE__))
135 #endif /* ENABLE_CHECKING */
137 /* Use the configure flag --enable-check-lisp-object-type to make
138 Lisp_Object use a struct type instead of the default int. The flag
139 causes CHECK_LISP_OBJECT_TYPE to be defined. */
141 /***** Select the tagging scheme. *****/
142 /* The following option controls the tagging scheme:
143 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
144 always 0, and we can thus use them to hold tag bits, without
145 restricting our addressing space.
147 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
148 restricting our possible address range.
150 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
151 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
152 on the few static Lisp_Objects used: all the defsubr as well
153 as the two special buffers buffer_defaults and buffer_local_symbols. */
157 /* Number of bits in a Lisp_Object tag. This can be used in #if,
158 and for GDB's sake also as a regular symbol. */
163 /* 2**GCTYPEBITS. This must also be a macro that expands to a
164 literal integer constant, for MSVC. */
166 #define GCALIGNMENT 8
169 /* Number of bits in a Lisp_Object value, not counting the tag. */
170 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
172 /* Number of bits in a Lisp fixnum tag. */
173 INTTYPEBITS
= GCTYPEBITS
- 1,
175 /* Number of bits in a Lisp fixnum value, not counting the tag. */
176 FIXNUM_BITS
= VALBITS
+ 1
179 #if GCALIGNMENT != 1 << GCTYPEBITS
180 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
183 /* The maximum value that can be stored in a EMACS_INT, assuming all
184 bits other than the type bits contribute to a nonnegative signed value.
185 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
186 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
188 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
190 /* 1. We know malloc returns a multiple of 8. */
191 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
192 || defined DARWIN_OS || defined __sun)
193 /* 2. We can specify multiple-of-8 alignment on static variables. */
195 /* 3. Pointers-as-ints exceed VAL_MAX.
196 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
197 a. unnecessary, because the top bits of an EMACS_INT are unused, and
198 b. slower, because it typically requires extra masking.
199 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
200 # if VAL_MAX < UINTPTR_MAX
201 # define USE_LSB_TAG 1
208 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
209 # define USE_LSB_TAG 1
211 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
212 # define USE_LSB_TAG 0
216 # define alignas(alignment) /* empty */
218 # error "USE_LSB_TAG requires alignas"
223 /* Define the fundamental Lisp data structures. */
225 /* This is the set of Lisp data types. */
227 /* Lisp integers use 2 tags, to give them one extra bit, thus
228 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
229 static EMACS_INT
const INTMASK
= EMACS_INT_MAX
>> (INTTYPEBITS
- 1);
230 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
231 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
233 /* Stolen from GDB. The only known compiler that doesn't support
234 enums in bitfields is MSVC. */
236 #define ENUM_BF(TYPE) unsigned int
238 #define ENUM_BF(TYPE) enum TYPE
244 /* Integer. XINT (obj) is the integer value. */
246 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
248 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
251 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
252 whose first member indicates the subtype. */
255 /* String. XSTRING (object) points to a struct Lisp_String.
256 The length of the string, and its contents, are stored therein. */
257 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
259 /* Vector of Lisp objects, or something resembling it.
260 XVECTOR (object) points to a struct Lisp_Vector, which contains
261 the size and contents. The size field also contains the type
262 information, if it's not a real vector object. */
265 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
271 /* This is the set of data types that share a common structure.
272 The first member of the structure is a type code from this set.
273 The enum values are arbitrary, but we'll use large numbers to make it
274 more likely that we'll spot the error if a random word in memory is
275 mistakenly interpreted as a Lisp_Misc. */
278 Lisp_Misc_Free
= 0x5eab,
281 Lisp_Misc_Save_Value
,
282 /* Currently floats are not a misc type,
283 but let's define this in case we want to change that. */
285 /* This is not a type code. It is for range checking. */
289 /* These are the types of forwarding objects used in the value slot
290 of symbols for special built-in variables whose value is stored in
294 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
295 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
296 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
297 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
298 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
301 #ifdef CHECK_LISP_OBJECT_TYPE
303 typedef struct { EMACS_INT i
; } Lisp_Object
;
306 LISP_INLINE Lisp_Object
309 Lisp_Object o
= { i
};
313 LISP_INLINE Lisp_Object
314 LISP_MAKE_RVALUE (Lisp_Object o
)
319 #define LISP_INITIALLY_ZERO {0}
321 #undef CHECK_LISP_OBJECT_TYPE
322 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
323 #else /* CHECK_LISP_OBJECT_TYPE */
325 /* If a struct type is not wanted, define Lisp_Object as just a number. */
327 typedef EMACS_INT Lisp_Object
;
330 #define LISP_MAKE_RVALUE(o) (0 + (o))
331 #define LISP_INITIALLY_ZERO 0
332 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
333 #endif /* CHECK_LISP_OBJECT_TYPE */
335 /* In the size word of a vector, this bit means the vector has been marked. */
337 static ptrdiff_t const ARRAY_MARK_FLAG
338 #define ARRAY_MARK_FLAG PTRDIFF_MIN
341 /* In the size word of a struct Lisp_Vector, this bit means it's really
342 some other vector-like object. */
343 static ptrdiff_t const PSEUDOVECTOR_FLAG
344 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
347 /* In a pseudovector, the size field actually contains a word with one
348 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
349 indicate the actual type.
350 We use a bitset, even tho only one of the bits can be set at any
351 particular time just so as to be able to use micro-optimizations such as
352 testing membership of a particular subset of pseudovectors in Fequal.
353 It is not crucial, but there are plenty of bits here, so why not do it? */
356 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
365 PVEC_WINDOW_CONFIGURATION
,
373 /* These last 4 are special because we OR them in fns.c:internal_equal,
374 so they have to use a disjoint bit pattern:
375 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
376 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
377 PVEC_COMPILED
= 0x10,
378 PVEC_CHAR_TABLE
= 0x20,
379 PVEC_SUB_CHAR_TABLE
= 0x30,
383 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
384 which were stored in a Lisp_Object. */
385 #ifndef DATA_SEG_BITS
386 # define DATA_SEG_BITS 0
388 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
393 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
395 /* For convenience, we also store the number of elements in these bits.
396 Note that this size is not necessarily the memory-footprint size, but
397 only the number of Lisp_Object fields (that need to be traced by GC).
398 The distinction is used, e.g., by Lisp_Process, which places extra
399 non-Lisp_Object fields at the end of the structure. */
400 PSEUDOVECTOR_SIZE_BITS
= 16,
401 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
402 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
404 /* Number of bits to put in each character in the internal representation
405 of bool vectors. This should not vary across implementations. */
406 BOOL_VECTOR_BITS_PER_CHAR
= 8
409 /* These macros extract various sorts of values from a Lisp_Object.
410 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
411 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
413 /* Return a perfect hash of the Lisp_Object representation. */
414 #define XHASH(a) XLI (a)
420 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
423 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
424 #define XINT(a) (XLI (a) >> INTTYPEBITS)
425 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
426 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
427 #define make_lisp_ptr(ptr, type) \
428 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
429 XIL ((type) | (intptr_t) (ptr)))
431 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
432 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
434 #else /* not USE_LSB_TAG */
436 static EMACS_INT
const VALMASK
437 #define VALMASK VAL_MAX
440 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
442 /* For integers known to be positive, XFASTINT provides fast retrieval
443 and XSETFASTINT provides fast storage. This takes advantage of the
444 fact that Lisp integers have zero-bits in their tags. */
445 #define XFASTINT(a) (XLI (a) + 0)
446 #define XSETFASTINT(a, b) ((a) = XIL (b))
448 /* Extract the value of a Lisp_Object as a (un)signed integer. */
450 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
451 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
452 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
454 #define make_lisp_ptr(ptr, type) \
455 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
456 + ((intptr_t) (ptr) & VALMASK)))
459 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
460 which were stored in a Lisp_Object. */
461 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
463 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
466 #endif /* not USE_LSB_TAG */
468 /* For integers known to be positive, XFASTINT sometimes provides
469 faster retrieval and XSETFASTINT provides faster storage.
470 If not, fallback on the non-accelerated path. */
472 # define XFASTINT(a) (XINT (a))
473 # define XSETFASTINT(a, b) (XSETINT (a, b))
476 /* Extract the pointer value of the Lisp object A, under the
477 assumption that A's type is TYPE. This is a fallback
478 implementation if nothing faster is available. */
480 # define XUNTAG(a, type) XPNTR (a)
483 #define EQ(x, y) (XHASH (x) == XHASH (y))
485 /* Largest and smallest representable fixnum values. These are the C
486 values. They are macros for use in static initializers, and
487 constants for visibility to GDB. */
488 static EMACS_INT
const MOST_POSITIVE_FIXNUM
=
489 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
490 MOST_POSITIVE_FIXNUM
;
491 static EMACS_INT
const MOST_NEGATIVE_FIXNUM
=
492 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
493 MOST_NEGATIVE_FIXNUM
;
495 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
496 written this way so that it also works if I is of unsigned
497 type or if I is a NaN. */
499 #define FIXNUM_OVERFLOW_P(i) \
500 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
502 LISP_INLINE
ptrdiff_t
503 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
505 return num
< lower
? lower
: num
<= upper
? num
: upper
;
508 /* Extract a value or address from a Lisp_Object. */
510 #define XCONS(a) (eassert (CONSP (a)), \
511 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
512 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
513 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
514 #define XSTRING(a) (eassert (STRINGP (a)), \
515 (struct Lisp_String *) XUNTAG (a, Lisp_String))
516 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
517 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
518 #define XFLOAT(a) (eassert (FLOATP (a)), \
519 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
523 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
524 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
525 #define XMISCTYPE(a) (XMISCANY (a)->type)
526 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
527 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
528 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
530 /* Forwarding object types. */
532 #define XFWDTYPE(a) (a->u_intfwd.type)
533 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
534 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
535 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
536 #define XBUFFER_OBJFWD(a) \
537 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
538 #define XKBOARD_OBJFWD(a) \
539 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
541 /* Pseudovector types. */
543 #define XPROCESS(a) (eassert (PROCESSP (a)), \
544 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
545 #define XWINDOW(a) (eassert (WINDOWP (a)), \
546 (struct window *) XUNTAG (a, Lisp_Vectorlike))
547 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
548 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
549 #define XSUBR(a) (eassert (SUBRP (a)), \
550 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
551 #define XBUFFER(a) (eassert (BUFFERP (a)), \
552 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
553 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
554 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
555 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
556 ((struct Lisp_Sub_Char_Table *) \
557 XUNTAG (a, Lisp_Vectorlike)))
558 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
559 ((struct Lisp_Bool_Vector *) \
560 XUNTAG (a, Lisp_Vectorlike)))
562 /* Construct a Lisp_Object from a value or address. */
564 #define XSETINT(a, b) ((a) = make_number (b))
565 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
566 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
567 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
568 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
569 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
573 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
574 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
576 /* Pseudovector types. */
578 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
579 #define XSETTYPED_PVECTYPE(v, size_member, code) \
580 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
581 #define XSETPVECTYPESIZE(v, code, sizeval) \
582 ((v)->header.size = (PSEUDOVECTOR_FLAG \
583 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
586 /* The cast to struct vectorlike_header * avoids aliasing issues. */
587 #define XSETPSEUDOVECTOR(a, b, code) \
588 XSETTYPED_PSEUDOVECTOR (a, b, \
589 (((struct vectorlike_header *) \
590 XUNTAG (a, Lisp_Vectorlike)) \
593 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
594 (XSETVECTOR (a, b), \
595 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
596 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
598 #define XSETWINDOW_CONFIGURATION(a, b) \
599 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
600 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
601 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
602 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
603 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
604 #define XSETSUBR(a, b) \
605 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
606 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
607 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
608 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
609 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
610 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
612 /* Convenience macros for dealing with Lisp arrays. */
614 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
615 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
616 #define ASET(ARRAY, IDX, VAL) \
617 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
618 XVECTOR (ARRAY)->contents[IDX] = (VAL))
620 /* Convenience macros for dealing with Lisp strings. */
622 #define SDATA(string) (XSTRING (string)->data + 0)
623 #define SREF(string, index) (SDATA (string)[index] + 0)
624 #define SSET(string, index, new) (SDATA (string)[index] = (new))
625 #define SCHARS(string) (XSTRING (string)->size + 0)
626 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
628 /* Avoid "differ in sign" warnings. */
629 #define SSDATA(x) ((char *) SDATA (x))
631 #define STRING_SET_CHARS(string, newsize) \
632 (XSTRING (string)->size = (newsize))
634 #define STRING_COPYIN(string, index, new, count) \
635 memcpy (SDATA (string) + index, new, count)
639 #define CHECK_TYPE(ok, Qxxxp, x) \
640 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
642 /* Deprecated and will be removed soon. */
644 #define INTERNAL_FIELD(field) field ## _
646 /* See the macros in intervals.h. */
648 typedef struct interval
*INTERVAL
;
650 /* Complain if object is not string or buffer type. */
651 #define CHECK_STRING_OR_BUFFER(x) \
652 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
656 /* Car of this cons cell. */
661 /* Cdr of this cons cell. */
664 /* Used to chain conses on a free list. */
665 struct Lisp_Cons
*chain
;
669 /* Take the car or cdr of something known to be a cons cell. */
670 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
671 of code that has to know what a cons cell looks like. Other code not
672 part of the basic lisp implementation should assume that the car and cdr
673 fields are not accessible as lvalues. (What if we want to switch to
674 a copying collector someday? Cached cons cell field addresses may be
675 invalidated at arbitrary points.) */
676 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
677 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
679 /* Use these from normal code. */
680 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
681 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
683 /* Use these to set the fields of a cons cell.
685 Note that both arguments may refer to the same object, so 'n'
686 should not be read after 'c' is first modified. Also, neither
687 argument should be evaluated more than once; side effects are
688 especially common in the second argument. */
689 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
690 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
692 /* Take the car or cdr of something whose type is not known. */
694 (CONSP ((c)) ? XCAR ((c)) \
695 : NILP ((c)) ? Qnil \
696 : wrong_type_argument (Qlistp, (c)))
699 (CONSP ((c)) ? XCDR ((c)) \
700 : NILP ((c)) ? Qnil \
701 : wrong_type_argument (Qlistp, (c)))
703 /* Take the car or cdr of something whose type is not known. */
704 #define CAR_SAFE(c) \
705 (CONSP ((c)) ? XCAR ((c)) : Qnil)
707 #define CDR_SAFE(c) \
708 (CONSP ((c)) ? XCDR ((c)) : Qnil)
710 /* True if STR is a multibyte string. */
711 #define STRING_MULTIBYTE(STR) \
712 (XSTRING (STR)->size_byte >= 0)
714 /* Return the length in bytes of STR. */
716 #ifdef GC_CHECK_STRING_BYTES
719 extern ptrdiff_t string_bytes (struct Lisp_String
*);
720 #define STRING_BYTES(S) string_bytes ((S))
722 #else /* not GC_CHECK_STRING_BYTES */
724 #define STRING_BYTES(STR) \
725 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
727 #endif /* not GC_CHECK_STRING_BYTES */
729 /* An upper bound on the number of bytes in a Lisp string, not
730 counting the terminating null. This a tight enough bound to
731 prevent integer overflow errors that would otherwise occur during
732 string size calculations. A string cannot contain more bytes than
733 a fixnum can represent, nor can it be so long that C pointer
734 arithmetic stops working on the string plus its terminating null.
735 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
736 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
737 would expose alloc.c internal details that we'd rather keep
740 This is a macro for use in static initializers, and a constant for
741 visibility to GDB. The cast to ptrdiff_t ensures that
742 the macro is signed. */
743 static ptrdiff_t const STRING_BYTES_BOUND
=
744 #define STRING_BYTES_BOUND \
745 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
748 /* Mark STR as a unibyte string. */
749 #define STRING_SET_UNIBYTE(STR) \
750 do { if (EQ (STR, empty_multibyte_string)) \
751 (STR) = empty_unibyte_string; \
752 else XSTRING (STR)->size_byte = -1; } while (0)
754 /* Mark STR as a multibyte string. Assure that STR contains only
755 ASCII characters in advance. */
756 #define STRING_SET_MULTIBYTE(STR) \
757 do { if (EQ (STR, empty_unibyte_string)) \
758 (STR) = empty_multibyte_string; \
759 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
761 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
767 INTERVAL intervals
; /* Text properties in this string. */
771 /* Header of vector-like objects. This documents the layout constraints on
772 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
773 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
774 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
775 because when two such pointers potentially alias, a compiler won't
776 incorrectly reorder loads and stores to their size fields. See
777 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
778 struct vectorlike_header
780 /* This field contains various pieces of information:
781 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
782 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
783 vector (0) or a pseudovector (1).
784 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
785 of slots) of the vector.
786 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
787 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
788 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
789 Lisp_Object slots at the beginning of the object that need to be
790 traced by the GC, tho some types use it slightly differently.
791 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
792 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
796 /* When the vector is allocated from a vector block, NBYTES is used
797 if the vector is not on a free list, and VECTOR is used otherwise.
798 For large vector-like objects, BUFFER or VECTOR is used as a pointer
799 to the next vector-like object. It is generally a buffer or a
800 Lisp_Vector alias, so for convenience it is a union instead of a
801 pointer: this way, one can write P->next.vector instead of ((struct
802 Lisp_Vector *) P->next). */
804 /* This is only needed for small vectors that are not free because the
805 `size' field only gives us the number of Lisp_Object slots, whereas we
806 need to know the total size, including non-Lisp_Object data.
807 FIXME: figure out a way to store this info elsewhere so we can
808 finally get rid of this extra word of overhead. */
810 struct buffer
*buffer
;
811 /* FIXME: This can be removed: For large vectors, this field could be
812 placed *before* the vector itself. And for small vectors on a free
813 list, this field could be stored in the vector's bytes, since the
814 empty vector is handled specially anyway. */
815 struct Lisp_Vector
*vector
;
819 /* Regular vector is just a header plus array of Lisp_Objects. */
823 struct vectorlike_header header
;
824 Lisp_Object contents
[1];
827 /* A boolvector is a kind of vectorlike, with contents are like a string. */
829 struct Lisp_Bool_Vector
831 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
832 just the subtype information. */
833 struct vectorlike_header header
;
834 /* This is the size in bits. */
836 /* This contains the actual bits, packed into bytes. */
837 unsigned char data
[1];
840 /* Some handy constants for calculating sizes
841 and offsets, mostly of vectorlike objects. */
845 header_size
= offsetof (struct Lisp_Vector
, contents
),
846 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
847 word_size
= sizeof (Lisp_Object
)
850 /* If a struct is made to look like a vector, this macro returns the length
851 of the shortest vector that would hold that struct. */
853 #define VECSIZE(type) \
854 ((sizeof (type) - header_size + word_size - 1) / word_size)
856 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
857 at the end and we need to compute the number of Lisp_Object fields (the
858 ones that the GC needs to trace). */
860 #define PSEUDOVECSIZE(type, nonlispfield) \
861 ((offsetof (type, nonlispfield) - header_size) / word_size)
863 /* A char-table is a kind of vectorlike, with contents are like a
864 vector but with a few other slots. For some purposes, it makes
865 sense to handle a char-table with type struct Lisp_Vector. An
866 element of a char table can be any Lisp objects, but if it is a sub
867 char-table, we treat it a table that contains information of a
868 specific range of characters. A sub char-table has the same
869 structure as a vector. A sub char table appears only in an element
870 of a char-table, and there's no way to access it directly from
871 Emacs Lisp program. */
875 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
876 ({struct Lisp_Char_Table *_tbl = NULL; \
879 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
880 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
881 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
883 _val = _tbl->defalt; \
884 } while (NILP (_val) && ! NILP (_tbl->parent)); \
887 #else /* not __GNUC__ */
889 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
890 (! NILP (XCHAR_TABLE (CT)->ascii) \
891 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
892 ? XCHAR_TABLE (CT)->ascii \
893 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
894 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
895 : char_table_ref ((CT), (IDX))) \
896 : char_table_ref ((CT), (IDX)))
898 #endif /* not __GNUC__ */
900 /* Compute A OP B, using the unsigned comparison operator OP. A and B
901 should be integer expressions. This is not the same as
902 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
903 returns 1. For efficiency, prefer plain unsigned comparison if A
904 and B's sizes both fit (after integer promotion). */
905 #define UNSIGNED_CMP(a, op, b) \
906 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
907 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
908 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
910 /* Nonzero iff C is an ASCII character. */
911 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
913 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
914 characters. Do not check validity of CT. */
915 #define CHAR_TABLE_REF(CT, IDX) \
916 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
917 : char_table_ref ((CT), (IDX)))
919 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
920 8-bit European characters. Do not check validity of CT. */
921 #define CHAR_TABLE_SET(CT, IDX, VAL) \
922 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
923 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
924 : char_table_set (CT, IDX, VAL))
926 enum CHARTAB_SIZE_BITS
928 CHARTAB_SIZE_BITS_0
= 6,
929 CHARTAB_SIZE_BITS_1
= 4,
930 CHARTAB_SIZE_BITS_2
= 5,
931 CHARTAB_SIZE_BITS_3
= 7
934 extern const int chartab_size
[4];
936 struct Lisp_Char_Table
938 /* HEADER.SIZE is the vector's size field, which also holds the
939 pseudovector type information. It holds the size, too.
940 The size counts the defalt, parent, purpose, ascii,
941 contents, and extras slots. */
942 struct vectorlike_header header
;
944 /* This holds a default value,
945 which is used whenever the value for a specific character is nil. */
948 /* This points to another char table, which we inherit from when the
949 value for a specific character is nil. The `defalt' slot takes
950 precedence over this. */
953 /* This is a symbol which says what kind of use this char-table is
957 /* The bottom sub char-table for characters of the range 0..127. It
958 is nil if none of ASCII character has a specific value. */
961 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
963 /* These hold additional data. It is a vector. */
964 Lisp_Object extras
[1];
967 struct Lisp_Sub_Char_Table
969 /* HEADER.SIZE is the vector's size field, which also holds the
970 pseudovector type information. It holds the size, too. */
971 struct vectorlike_header header
;
973 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
974 char-table of depth 1 contains 16 elements, and each element
975 covers 4096 (128*32) characters. A sub char-table of depth 2
976 contains 32 elements, and each element covers 128 characters. A
977 sub char-table of depth 3 contains 128 elements, and each element
978 is for one character. */
981 /* Minimum character covered by the sub char-table. */
982 Lisp_Object min_char
;
984 /* Use set_sub_char_table_contents to set this. */
985 Lisp_Object contents
[1];
988 /* This structure describes a built-in function.
989 It is generated by the DEFUN macro only.
990 defsubr makes it into a Lisp object.
992 This type is treated in most respects as a pseudovector,
993 but since we never dynamically allocate or free them,
994 we don't need a struct vectorlike_header and its 'next' field. */
1000 Lisp_Object (*a0
) (void);
1001 Lisp_Object (*a1
) (Lisp_Object
);
1002 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1003 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1004 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1005 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1006 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1007 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1008 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1009 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1010 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1012 short min_args
, max_args
;
1013 const char *symbol_name
;
1014 const char *intspec
;
1018 /* This is the number of slots that every char table must have. This
1019 counts the ordinary slots and the top, defalt, parent, and purpose
1021 enum CHAR_TABLE_STANDARD_SLOTS
1023 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1026 /* Return the number of "extra" slots in the char table CT. */
1028 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1029 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1032 /***********************************************************************
1034 ***********************************************************************/
1036 /* Interned state of a symbol. */
1038 enum symbol_interned
1040 SYMBOL_UNINTERNED
= 0,
1041 SYMBOL_INTERNED
= 1,
1042 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1045 enum symbol_redirect
1047 SYMBOL_PLAINVAL
= 4,
1048 SYMBOL_VARALIAS
= 1,
1049 SYMBOL_LOCALIZED
= 2,
1050 SYMBOL_FORWARDED
= 3
1055 unsigned gcmarkbit
: 1;
1057 /* Indicates where the value can be found:
1058 0 : it's a plain var, the value is in the `value' field.
1059 1 : it's a varalias, the value is really in the `alias' symbol.
1060 2 : it's a localized var, the value is in the `blv' object.
1061 3 : it's a forwarding variable, the value is in `forward'. */
1062 ENUM_BF (symbol_redirect
) redirect
: 3;
1064 /* Non-zero means symbol is constant, i.e. changing its value
1065 should signal an error. If the value is 3, then the var
1066 can be changed, but only by `defconst'. */
1067 unsigned constant
: 2;
1069 /* Interned state of the symbol. This is an enumerator from
1070 enum symbol_interned. */
1071 unsigned interned
: 2;
1073 /* Non-zero means that this variable has been explicitly declared
1074 special (with `defvar' etc), and shouldn't be lexically bound. */
1075 unsigned declared_special
: 1;
1077 /* The symbol's name, as a Lisp string. */
1080 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1081 union is used depends on the `redirect' field above. */
1084 struct Lisp_Symbol
*alias
;
1085 struct Lisp_Buffer_Local_Value
*blv
;
1086 union Lisp_Fwd
*fwd
;
1089 /* Function value of the symbol or Qunbound if not fboundp. */
1090 Lisp_Object function
;
1092 /* The symbol's property list. */
1095 /* Next symbol in obarray bucket, if the symbol is interned. */
1096 struct Lisp_Symbol
*next
;
1099 /* Value is name of symbol. */
1101 #define SYMBOL_VAL(sym) \
1102 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1103 #define SYMBOL_ALIAS(sym) \
1104 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1105 #define SYMBOL_BLV(sym) \
1106 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1107 #define SYMBOL_FWD(sym) \
1108 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1109 #define SET_SYMBOL_VAL(sym, v) \
1110 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1111 #define SET_SYMBOL_ALIAS(sym, v) \
1112 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1113 #define SET_SYMBOL_BLV(sym, v) \
1114 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1115 #define SET_SYMBOL_FWD(sym, v) \
1116 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1118 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1120 /* Value is non-zero if SYM is an interned symbol. */
1122 #define SYMBOL_INTERNED_P(sym) \
1123 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1125 /* Value is non-zero if SYM is interned in initial_obarray. */
1127 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1128 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1130 /* Value is non-zero if symbol is considered a constant, i.e. its
1131 value cannot be changed (there is an exception for keyword symbols,
1132 whose value can be set to the keyword symbol itself). */
1134 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1136 #define DEFSYM(sym, name) \
1137 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1140 /***********************************************************************
1142 ***********************************************************************/
1144 /* The structure of a Lisp hash table. */
1146 struct Lisp_Hash_Table
1148 /* This is for Lisp; the hash table code does not refer to it. */
1149 struct vectorlike_header header
;
1151 /* Function used to compare keys. */
1154 /* Nil if table is non-weak. Otherwise a symbol describing the
1155 weakness of the table. */
1158 /* When the table is resized, and this is an integer, compute the
1159 new size by adding this to the old size. If a float, compute the
1160 new size by multiplying the old size with this factor. */
1161 Lisp_Object rehash_size
;
1163 /* Resize hash table when number of entries/ table size is >= this
1165 Lisp_Object rehash_threshold
;
1167 /* Vector of hash codes.. If hash[I] is nil, this means that that
1168 entry I is unused. */
1171 /* Vector used to chain entries. If entry I is free, next[I] is the
1172 entry number of the next free item. If entry I is non-free,
1173 next[I] is the index of the next entry in the collision chain. */
1176 /* Index of first free entry in free list. */
1177 Lisp_Object next_free
;
1179 /* Bucket vector. A non-nil entry is the index of the first item in
1180 a collision chain. This vector's size can be larger than the
1181 hash table size to reduce collisions. */
1184 /* User-supplied hash function, or nil. */
1185 Lisp_Object user_hash_function
;
1187 /* User-supplied key comparison function, or nil. */
1188 Lisp_Object user_cmp_function
;
1190 /* Only the fields above are traced normally by the GC. The ones below
1191 `count' are special and are either ignored by the GC or traced in
1192 a special way (e.g. because of weakness). */
1194 /* Number of key/value entries in the table. */
1197 /* Vector of keys and values. The key of item I is found at index
1198 2 * I, the value is found at index 2 * I + 1.
1199 This is gc_marked specially if the table is weak. */
1200 Lisp_Object key_and_value
;
1202 /* Next weak hash table if this is a weak hash table. The head
1203 of the list is in weak_hash_tables. */
1204 struct Lisp_Hash_Table
*next_weak
;
1206 /* C function to compare two keys. */
1207 bool (*cmpfn
) (struct Lisp_Hash_Table
*,
1208 Lisp_Object
, EMACS_UINT
,
1209 Lisp_Object
, EMACS_UINT
);
1211 /* C function to compute hash code. */
1212 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1216 #define XHASH_TABLE(OBJ) \
1217 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1219 #define XSET_HASH_TABLE(VAR, PTR) \
1220 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1222 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1224 #define CHECK_HASH_TABLE(x) \
1225 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1227 /* Value is the key part of entry IDX in hash table H. */
1229 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1231 /* Value is the value part of entry IDX in hash table H. */
1233 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1235 /* Value is the index of the next entry following the one at IDX
1238 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1240 /* Value is the hash code computed for entry IDX in hash table H. */
1242 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1244 /* Value is the index of the element in hash table H that is the
1245 start of the collision list at index IDX in the index vector of H. */
1247 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1249 /* Value is the size of hash table H. */
1251 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1253 /* Default size for hash tables if not specified. */
1255 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1257 /* Default threshold specifying when to resize a hash table. The
1258 value gives the ratio of current entries in the hash table and the
1259 size of the hash table. */
1261 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1263 /* Default factor by which to increase the size of a hash table. */
1265 static double const DEFAULT_REHASH_SIZE
= 1.5;
1267 /* These structures are used for various misc types. */
1269 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1271 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1272 unsigned gcmarkbit
: 1;
1278 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1279 unsigned gcmarkbit
: 1;
1281 /* This flag is temporarily used in the functions
1282 decode/encode_coding_object to record that the marker position
1283 must be adjusted after the conversion. */
1284 unsigned int need_adjustment
: 1;
1285 /* 1 means normal insertion at the marker's position
1286 leaves the marker after the inserted text. */
1287 unsigned int insertion_type
: 1;
1288 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1289 Note: a chain of markers can contain markers pointing into different
1290 buffers (the chain is per buffer_text rather than per buffer, so it's
1291 shared between indirect buffers). */
1292 /* This is used for (other than NULL-checking):
1294 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1295 - unchain_marker: to find the list from which to unchain.
1296 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1298 struct buffer
*buffer
;
1300 /* The remaining fields are meaningless in a marker that
1301 does not point anywhere. */
1303 /* For markers that point somewhere,
1304 this is used to chain of all the markers in a given buffer. */
1305 /* We could remove it and use an array in buffer_text instead.
1306 That would also allow to preserve it ordered. */
1307 struct Lisp_Marker
*next
;
1308 /* This is the char position where the marker points. */
1310 /* This is the byte position.
1311 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1312 used to implement the functionality of markers, but rather to (ab)use
1313 markers as a cache for char<->byte mappings). */
1317 /* START and END are markers in the overlay's buffer, and
1318 PLIST is the overlay's property list. */
1320 /* An overlay's real data content is:
1322 - buffer (really there are two buffer pointers, one per marker,
1323 and both points to the same buffer)
1324 - insertion type of both ends (per-marker fields)
1325 - start & start byte (of start marker)
1326 - end & end byte (of end marker)
1327 - next (singly linked list of overlays)
1328 - next fields of start and end markers (singly linked list of markers).
1329 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1332 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1333 unsigned gcmarkbit
: 1;
1335 struct Lisp_Overlay
*next
;
1341 /* Hold a C pointer for later use.
1342 This type of object is used in the arg to record_unwind_protect. */
1343 struct Lisp_Save_Value
1345 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1346 unsigned gcmarkbit
: 1;
1348 /* If DOGC is set, POINTER is the address of a memory
1349 area containing INTEGER potential Lisp_Objects. */
1350 unsigned int dogc
: 1;
1356 /* A miscellaneous object, when it's on the free list. */
1359 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1360 unsigned gcmarkbit
: 1;
1362 union Lisp_Misc
*chain
;
1365 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1366 It uses one of these struct subtypes to get the type field. */
1370 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1371 struct Lisp_Free u_free
;
1372 struct Lisp_Marker u_marker
;
1373 struct Lisp_Overlay u_overlay
;
1374 struct Lisp_Save_Value u_save_value
;
1377 /* Forwarding pointer to an int variable.
1378 This is allowed only in the value cell of a symbol,
1379 and it means that the symbol's value really lives in the
1380 specified int variable. */
1383 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1387 /* Boolean forwarding pointer to an int variable.
1388 This is like Lisp_Intfwd except that the ostensible
1389 "value" of the symbol is t if the int variable is nonzero,
1390 nil if it is zero. */
1393 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1397 /* Forwarding pointer to a Lisp_Object variable.
1398 This is allowed only in the value cell of a symbol,
1399 and it means that the symbol's value really lives in the
1400 specified variable. */
1403 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1404 Lisp_Object
*objvar
;
1407 /* Like Lisp_Objfwd except that value lives in a slot in the
1408 current buffer. Value is byte index of slot within buffer. */
1409 struct Lisp_Buffer_Objfwd
1411 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1413 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1416 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1417 the symbol has buffer-local or frame-local bindings. (Exception:
1418 some buffer-local variables are built-in, with their values stored
1419 in the buffer structure itself. They are handled differently,
1420 using struct Lisp_Buffer_Objfwd.)
1422 The `realvalue' slot holds the variable's current value, or a
1423 forwarding pointer to where that value is kept. This value is the
1424 one that corresponds to the loaded binding. To read or set the
1425 variable, you must first make sure the right binding is loaded;
1426 then you can access the value in (or through) `realvalue'.
1428 `buffer' and `frame' are the buffer and frame for which the loaded
1429 binding was found. If those have changed, to make sure the right
1430 binding is loaded it is necessary to find which binding goes with
1431 the current buffer and selected frame, then load it. To load it,
1432 first unload the previous binding, then copy the value of the new
1433 binding into `realvalue' (or through it). Also update
1434 LOADED-BINDING to point to the newly loaded binding.
1436 `local_if_set' indicates that merely setting the variable creates a
1437 local binding for the current buffer. Otherwise the latter, setting
1438 the variable does not do that; only make-local-variable does that. */
1440 struct Lisp_Buffer_Local_Value
1442 /* 1 means that merely setting the variable creates a local
1443 binding for the current buffer. */
1444 unsigned int local_if_set
: 1;
1445 /* 1 means this variable can have frame-local bindings, otherwise, it is
1446 can have buffer-local bindings. The two cannot be combined. */
1447 unsigned int frame_local
: 1;
1448 /* 1 means that the binding now loaded was found.
1449 Presumably equivalent to (defcell!=valcell). */
1450 unsigned int found
: 1;
1451 /* If non-NULL, a forwarding to the C var where it should also be set. */
1452 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1453 /* The buffer or frame for which the loaded binding was found. */
1455 /* A cons cell that holds the default value. It has the form
1456 (SYMBOL . DEFAULT-VALUE). */
1457 Lisp_Object defcell
;
1458 /* The cons cell from `where's parameter alist.
1459 It always has the form (SYMBOL . VALUE)
1460 Note that if `forward' is non-nil, VALUE may be out of date.
1461 Also if the currently loaded binding is the default binding, then
1462 this is `eq'ual to defcell. */
1463 Lisp_Object valcell
;
1466 /* Like Lisp_Objfwd except that value lives in a slot in the
1468 struct Lisp_Kboard_Objfwd
1470 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1476 struct Lisp_Intfwd u_intfwd
;
1477 struct Lisp_Boolfwd u_boolfwd
;
1478 struct Lisp_Objfwd u_objfwd
;
1479 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1480 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1483 /* Lisp floating point type. */
1489 struct Lisp_Float
*chain
;
1493 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1494 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1496 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1497 representations, have infinities and NaNs, and do not trap on
1498 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1499 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1500 wanted here, but is not quite right because Emacs does not require
1501 all the features of C11 Annex F (and does not require C11 at all,
1502 for that matter). */
1503 #define IEEE_FLOATING_POINT (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
1504 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
1506 /* A character, declared with the following typedef, is a member
1507 of some character set associated with the current buffer. */
1508 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1510 typedef unsigned char UCHAR
;
1513 /* Meanings of slots in a Lisp_Compiled: */
1517 COMPILED_ARGLIST
= 0,
1518 COMPILED_BYTECODE
= 1,
1519 COMPILED_CONSTANTS
= 2,
1520 COMPILED_STACK_DEPTH
= 3,
1521 COMPILED_DOC_STRING
= 4,
1522 COMPILED_INTERACTIVE
= 5
1525 /* Flag bits in a character. These also get used in termhooks.h.
1526 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1527 (MUlti-Lingual Emacs) might need 22 bits for the character value
1528 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1531 CHAR_ALT
= 0x0400000,
1532 CHAR_SUPER
= 0x0800000,
1533 CHAR_HYPER
= 0x1000000,
1534 CHAR_SHIFT
= 0x2000000,
1535 CHAR_CTL
= 0x4000000,
1536 CHAR_META
= 0x8000000,
1538 CHAR_MODIFIER_MASK
=
1539 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1541 /* Actually, the current Emacs uses 22 bits for the character value
1549 /* The glyph datatype, used to represent characters on the display.
1550 It consists of a char code and a face id. */
1557 /* Return a glyph's character code. */
1558 #define GLYPH_CHAR(glyph) ((glyph).ch)
1560 /* Return a glyph's face ID. */
1561 #define GLYPH_FACE(glyph) ((glyph).face_id)
1563 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1564 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1565 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1567 /* Return 1 if GLYPH contains valid character code. */
1568 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1571 /* Glyph Code from a display vector may either be an integer which
1572 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1573 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1575 #define GLYPH_CODE_P(gc) \
1577 ? (CHARACTERP (XCAR (gc)) \
1578 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1579 : (RANGED_INTEGERP \
1581 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1582 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1583 : TYPE_MAXIMUM (EMACS_INT)))))
1585 /* The following are valid only if GLYPH_CODE_P (gc). */
1587 #define GLYPH_CODE_CHAR(gc) \
1588 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1590 #define GLYPH_CODE_FACE(gc) \
1591 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1593 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1597 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1599 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1600 (XINT (gc) >> CHARACTERBITS)); \
1604 /* Structure to hold mouse highlight data. This is here because other
1605 header files need it for defining struct x_output etc. */
1607 /* These variables describe the range of text currently shown in its
1608 mouse-face, together with the window they apply to. As long as
1609 the mouse stays within this range, we need not redraw anything on
1610 its account. Rows and columns are glyph matrix positions in
1611 MOUSE_FACE_WINDOW. */
1612 int mouse_face_beg_row
, mouse_face_beg_col
;
1613 int mouse_face_beg_x
, mouse_face_beg_y
;
1614 int mouse_face_end_row
, mouse_face_end_col
;
1615 int mouse_face_end_x
, mouse_face_end_y
;
1616 int mouse_face_past_end
;
1617 Lisp_Object mouse_face_window
;
1618 int mouse_face_face_id
;
1619 Lisp_Object mouse_face_overlay
;
1621 /* 1 if a mouse motion event came and we didn't handle it right away because
1622 gc was in progress. */
1623 int mouse_face_deferred_gc
;
1625 /* FRAME and X, Y position of mouse when last checked for
1626 highlighting. X and Y can be negative or out of range for the frame. */
1627 struct frame
*mouse_face_mouse_frame
;
1628 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1630 /* Nonzero means defer mouse-motion highlighting. */
1631 int mouse_face_defer
;
1633 /* Nonzero means that the mouse highlight should not be shown. */
1634 int mouse_face_hidden
;
1636 int mouse_face_image_state
;
1639 /* Data type checking. */
1641 #define NILP(x) EQ (x, Qnil)
1643 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1644 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1646 #define RANGED_INTEGERP(lo, x, hi) \
1647 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1648 #define TYPE_RANGED_INTEGERP(type, x) \
1649 (TYPE_SIGNED (type) \
1650 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1651 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1653 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1654 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1655 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1656 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1657 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1658 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1660 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1661 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1662 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1663 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1664 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1666 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1667 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1668 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1669 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1670 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1672 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1673 vectorlike_header * avoids aliasing issues. */
1674 #define PSEUDOVECTORP(x, code) \
1675 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1677 #define PSEUDOVECTOR_TYPEP(v, code) \
1678 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1679 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1681 /* True if object X, with internal type struct T *, is a pseudovector whose
1683 #define TYPED_PSEUDOVECTORP(x, t, code) \
1685 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1687 /* Test for specific pseudovector types. */
1688 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1689 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1690 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1691 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1692 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1693 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1694 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1695 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1696 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1697 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1698 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1699 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1701 /* Test for image (image . spec) */
1702 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1707 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1709 #define CHECK_LIST(x) \
1710 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1712 #define CHECK_LIST_CONS(x, y) \
1713 CHECK_TYPE (CONSP (x), Qlistp, y)
1715 #define CHECK_LIST_END(x, y) \
1716 CHECK_TYPE (NILP (x), Qlistp, y)
1718 #define CHECK_STRING(x) \
1719 CHECK_TYPE (STRINGP (x), Qstringp, x)
1721 #define CHECK_STRING_CAR(x) \
1722 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1724 #define CHECK_CONS(x) \
1725 CHECK_TYPE (CONSP (x), Qconsp, x)
1727 #define CHECK_SYMBOL(x) \
1728 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1730 #define CHECK_CHAR_TABLE(x) \
1731 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1733 #define CHECK_VECTOR(x) \
1734 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1736 #define CHECK_VECTOR_OR_STRING(x) \
1737 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1739 #define CHECK_ARRAY(x, Qxxxp) \
1740 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1742 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1743 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1745 #define CHECK_BUFFER(x) \
1746 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1748 #define CHECK_WINDOW(x) \
1749 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1751 #define CHECK_WINDOW_CONFIGURATION(x) \
1752 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1754 /* A window of any sort, leaf or interior, is "valid" if one of its
1755 buffer, vchild, or hchild members is non-nil. */
1756 #define CHECK_VALID_WINDOW(x) \
1757 CHECK_TYPE (WINDOWP (x) \
1758 && (!NILP (XWINDOW (x)->buffer) \
1759 || !NILP (XWINDOW (x)->vchild) \
1760 || !NILP (XWINDOW (x)->hchild)), \
1763 /* A window is "live" if and only if it shows a buffer. */
1764 #define CHECK_LIVE_WINDOW(x) \
1765 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), \
1768 #define CHECK_PROCESS(x) \
1769 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1771 #define CHECK_SUBR(x) \
1772 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1774 #define CHECK_NUMBER(x) \
1775 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1777 #define CHECK_NATNUM(x) \
1778 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1780 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1783 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1784 args_out_of_range_3 \
1786 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1787 ? MOST_NEGATIVE_FIXNUM \
1789 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1791 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1793 if (TYPE_SIGNED (type)) \
1794 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1796 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1799 #define CHECK_MARKER(x) \
1800 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1802 #define CHECK_NUMBER_COERCE_MARKER(x) \
1803 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1804 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1806 #define XFLOATINT(n) extract_float((n))
1808 #define CHECK_FLOAT(x) \
1809 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1811 #define CHECK_NUMBER_OR_FLOAT(x) \
1812 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1814 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1815 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1816 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1818 #define CHECK_OVERLAY(x) \
1819 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1821 /* Since we can't assign directly to the CAR or CDR fields of a cons
1822 cell, use these when checking that those fields contain numbers. */
1823 #define CHECK_NUMBER_CAR(x) \
1825 Lisp_Object tmp = XCAR (x); \
1826 CHECK_NUMBER (tmp); \
1827 XSETCAR ((x), tmp); \
1830 #define CHECK_NUMBER_CDR(x) \
1832 Lisp_Object tmp = XCDR (x); \
1833 CHECK_NUMBER (tmp); \
1834 XSETCDR ((x), tmp); \
1837 #define CHECK_NATNUM_CAR(x) \
1839 Lisp_Object tmp = XCAR (x); \
1840 CHECK_NATNUM (tmp); \
1841 XSETCAR ((x), tmp); \
1844 #define CHECK_NATNUM_CDR(x) \
1846 Lisp_Object tmp = XCDR (x); \
1847 CHECK_NATNUM (tmp); \
1848 XSETCDR ((x), tmp); \
1851 /* Define a built-in function for calling from Lisp.
1852 `lname' should be the name to give the function in Lisp,
1853 as a null-terminated C string.
1854 `fnname' should be the name of the function in C.
1855 By convention, it starts with F.
1856 `sname' should be the name for the C constant structure
1857 that records information on this function for internal use.
1858 By convention, it should be the same as `fnname' but with S instead of F.
1859 It's too bad that C macros can't compute this from `fnname'.
1860 `minargs' should be a number, the minimum number of arguments allowed.
1861 `maxargs' should be a number, the maximum number of arguments allowed,
1862 or else MANY or UNEVALLED.
1863 MANY means pass a vector of evaluated arguments,
1864 in the form of an integer number-of-arguments
1865 followed by the address of a vector of Lisp_Objects
1866 which contains the argument values.
1867 UNEVALLED means pass the list of unevaluated arguments
1868 `intspec' says how interactive arguments are to be fetched.
1869 If the string starts with a `(', `intspec' is evaluated and the resulting
1870 list is the list of arguments.
1871 If it's a string that doesn't start with `(', the value should follow
1872 the one of the doc string for `interactive'.
1873 A null string means call interactively with no arguments.
1874 `doc' is documentation for the user. */
1876 /* This version of DEFUN declares a function prototype with the right
1877 arguments, so we can catch errors with maxargs at compile-time. */
1879 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1880 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1881 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1882 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1883 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1884 { (Lisp_Object (__cdecl *)(void))fnname }, \
1885 minargs, maxargs, lname, intspec, 0}; \
1887 #else /* not _MSC_VER */
1888 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1889 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1890 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1891 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1892 { .a ## maxargs = fnname }, \
1893 minargs, maxargs, lname, intspec, 0}; \
1897 /* Note that the weird token-substitution semantics of ANSI C makes
1898 this work for MANY and UNEVALLED. */
1899 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1900 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1901 #define DEFUN_ARGS_0 (void)
1902 #define DEFUN_ARGS_1 (Lisp_Object)
1903 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1904 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1905 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1906 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1908 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1909 Lisp_Object, Lisp_Object)
1910 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1911 Lisp_Object, Lisp_Object, Lisp_Object)
1912 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1913 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1915 /* Non-zero if OBJ is a Lisp function. */
1916 #define FUNCTIONP(OBJ) functionp(OBJ)
1919 is how we define the symbol for function `name' at start-up time. */
1920 extern void defsubr (struct Lisp_Subr
*);
1928 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1929 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1930 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1931 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1932 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1934 /* Macros we use to define forwarded Lisp variables.
1935 These are used in the syms_of_FILENAME functions.
1937 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1938 lisp variable is actually a field in `struct emacs_globals'. The
1939 field's name begins with "f_", which is a convention enforced by
1940 these macros. Each such global has a corresponding #define in
1941 globals.h; the plain name should be used in the code.
1943 E.g., the global "cons_cells_consed" is declared as "int
1944 f_cons_cells_consed" in globals.h, but there is a define:
1946 #define cons_cells_consed globals.f_cons_cells_consed
1948 All C code uses the `cons_cells_consed' name. This is all done
1949 this way to support indirection for multi-threaded Emacs. */
1951 #define DEFVAR_LISP(lname, vname, doc) \
1953 static struct Lisp_Objfwd o_fwd; \
1954 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1956 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1958 static struct Lisp_Objfwd o_fwd; \
1959 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1961 #define DEFVAR_BOOL(lname, vname, doc) \
1963 static struct Lisp_Boolfwd b_fwd; \
1964 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1966 #define DEFVAR_INT(lname, vname, doc) \
1968 static struct Lisp_Intfwd i_fwd; \
1969 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1972 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1974 static struct Lisp_Objfwd o_fwd; \
1975 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1978 #define DEFVAR_KBOARD(lname, vname, doc) \
1980 static struct Lisp_Kboard_Objfwd ko_fwd; \
1981 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1984 /* Save and restore the instruction and environment pointers,
1985 without affecting the signal mask. */
1988 typedef jmp_buf sys_jmp_buf
;
1989 # define sys_setjmp(j) _setjmp (j)
1990 # define sys_longjmp(j, v) _longjmp (j, v)
1991 #elif defined HAVE_SIGSETJMP
1992 typedef sigjmp_buf sys_jmp_buf
;
1993 # define sys_setjmp(j) sigsetjmp (j, 0)
1994 # define sys_longjmp(j, v) siglongjmp (j, v)
1996 /* A platform that uses neither _longjmp nor siglongjmp; assume
1997 longjmp does not affect the sigmask. */
1998 typedef jmp_buf sys_jmp_buf
;
1999 # define sys_setjmp(j) setjmp (j)
2000 # define sys_longjmp(j, v) longjmp (j, v)
2004 /* Structure for recording Lisp call stack for backtrace purposes. */
2006 /* The special binding stack holds the outer values of variables while
2007 they are bound by a function application or a let form, stores the
2008 code to be executed for Lisp unwind-protect forms, and stores the C
2009 functions to be called for record_unwind_protect.
2011 If func is non-zero, undoing this binding applies func to old_value;
2012 This implements record_unwind_protect.
2014 Otherwise, the element is a variable binding.
2016 If the symbol field is a symbol, it is an ordinary variable binding.
2018 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2019 which means having bound a local value while CURRENT-BUFFER was active.
2020 If WHERE is nil this means we saw the default value when binding SYMBOL.
2021 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2022 value. Other values of WHERE mean an internal error. */
2024 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2028 Lisp_Object symbol
, old_value
;
2029 specbinding_func func
;
2030 Lisp_Object unused
; /* Dividing by 16 is faster than by 12. */
2033 extern struct specbinding
*specpdl
;
2034 extern struct specbinding
*specpdl_ptr
;
2035 extern ptrdiff_t specpdl_size
;
2037 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2041 struct backtrace
*next
;
2042 Lisp_Object function
;
2043 Lisp_Object
*args
; /* Points to vector of args. */
2044 ptrdiff_t nargs
; /* Length of vector. */
2045 /* Nonzero means call value of debugger when done with this operation. */
2046 unsigned int debug_on_exit
: 1;
2049 extern struct backtrace
*backtrace_list
;
2051 /* Everything needed to describe an active condition case.
2053 Members are volatile if their values need to survive _longjmp when
2054 a 'struct handler' is a local variable. */
2057 /* The handler clauses and variable from the condition-case form. */
2058 /* For a handler set up in Lisp code, this is always a list.
2059 For an internal handler set up by internal_condition_case*,
2060 this can instead be the symbol t or `error'.
2061 t: handle all conditions.
2062 error: handle all conditions, and errors can run the debugger
2063 or display a backtrace. */
2064 Lisp_Object handler
;
2066 Lisp_Object
volatile var
;
2068 /* Fsignal stores here the condition-case clause that applies,
2069 and Fcondition_case thus knows which clause to run. */
2070 Lisp_Object
volatile chosen_clause
;
2072 /* Used to effect the longjump out to the handler. */
2073 struct catchtag
*tag
;
2075 /* The next enclosing handler. */
2076 struct handler
*next
;
2079 /* This structure helps implement the `catch' and `throw' control
2080 structure. A struct catchtag contains all the information needed
2081 to restore the state of the interpreter after a non-local jump.
2083 Handlers for error conditions (represented by `struct handler'
2084 structures) just point to a catch tag to do the cleanup required
2087 catchtag structures are chained together in the C calling stack;
2088 the `next' member points to the next outer catchtag.
2090 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2091 member is TAG, and then unbinds to it. The `val' member is used to
2092 hold VAL while the stack is unwound; `val' is returned as the value
2095 All the other members are concerned with restoring the interpreter
2098 Members are volatile if their values need to survive _longjmp when
2099 a 'struct catchtag' is a local variable. */
2103 Lisp_Object
volatile val
;
2104 struct catchtag
*volatile next
;
2105 struct gcpro
*gcpro
;
2107 struct backtrace
*backlist
;
2108 struct handler
*handlerlist
;
2109 EMACS_INT lisp_eval_depth
;
2110 ptrdiff_t volatile pdlcount
;
2111 int poll_suppress_count
;
2112 int interrupt_input_blocked
;
2113 struct byte_stack
*byte_stack
;
2116 extern Lisp_Object memory_signal_data
;
2118 /* An address near the bottom of the stack.
2119 Tells GC how to save a copy of the stack. */
2120 extern char *stack_bottom
;
2122 /* Check quit-flag and quit if it is non-nil.
2123 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2124 So the program needs to do QUIT at times when it is safe to quit.
2125 Every loop that might run for a long time or might not exit
2126 ought to do QUIT at least once, at a safe place.
2127 Unless that is impossible, of course.
2128 But it is very desirable to avoid creating loops where QUIT is impossible.
2130 Exception: if you set immediate_quit to nonzero,
2131 then the handler that responds to the C-g does the quit itself.
2132 This is a good thing to do around a loop that has no side effects
2133 and (in particular) cannot call arbitrary Lisp code.
2135 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2136 a request to exit Emacs when it is safe to do. */
2138 extern void process_pending_signals (void);
2139 extern int volatile pending_signals
;
2141 extern void process_quit_flag (void);
2144 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2145 process_quit_flag (); \
2146 else if (pending_signals) \
2147 process_pending_signals (); \
2151 /* Nonzero if ought to quit now. */
2153 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2155 extern Lisp_Object Vascii_downcase_table
;
2156 extern Lisp_Object Vascii_canon_table
;
2158 /* Structure for recording stack slots that need marking. */
2160 /* This is a chain of structures, each of which points at a Lisp_Object
2161 variable whose value should be marked in garbage collection.
2162 Normally every link of the chain is an automatic variable of a function,
2163 and its `val' points to some argument or local variable of the function.
2164 On exit to the function, the chain is set back to the value it had on entry.
2165 This way, no link remains in the chain when the stack frame containing the
2168 Every function that can call Feval must protect in this fashion all
2169 Lisp_Object variables whose contents will be used again. */
2171 extern struct gcpro
*gcprolist
;
2177 /* Address of first protected variable. */
2178 volatile Lisp_Object
*var
;
2180 /* Number of consecutive protected variables. */
2188 /* Values of GC_MARK_STACK during compilation:
2190 0 Use GCPRO as before
2191 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2192 2 Mark the stack, and check that everything GCPRO'd is
2194 3 Mark using GCPRO's, mark stack last, and count how many
2195 dead objects are kept alive. */
2198 #define GC_USE_GCPROS_AS_BEFORE 0
2199 #define GC_MAKE_GCPROS_NOOPS 1
2200 #define GC_MARK_STACK_CHECK_GCPROS 2
2201 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2203 #ifndef GC_MARK_STACK
2204 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2207 /* Whether we do the stack marking manually. */
2208 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2209 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2212 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2214 /* Do something silly with gcproN vars just so gcc shuts up. */
2215 /* You get warnings from MIPSPro... */
2217 #define GCPRO1(varname) ((void) gcpro1)
2218 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2219 #define GCPRO3(varname1, varname2, varname3) \
2220 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2221 #define GCPRO4(varname1, varname2, varname3, varname4) \
2222 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2223 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2224 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2225 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2226 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2228 #define UNGCPRO ((void) 0)
2230 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2234 #define GCPRO1(varname) \
2235 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2236 gcprolist = &gcpro1; }
2238 #define GCPRO2(varname1, varname2) \
2239 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2240 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2241 gcprolist = &gcpro2; }
2243 #define GCPRO3(varname1, varname2, varname3) \
2244 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2245 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2246 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2247 gcprolist = &gcpro3; }
2249 #define GCPRO4(varname1, varname2, varname3, varname4) \
2250 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2251 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2252 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2253 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2254 gcprolist = &gcpro4; }
2256 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2257 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2258 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2259 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2260 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2261 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2262 gcprolist = &gcpro5; }
2264 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2265 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2266 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2267 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2268 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2269 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2270 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2271 gcprolist = &gcpro6; }
2273 #define UNGCPRO (gcprolist = gcpro1.next)
2277 extern int gcpro_level
;
2279 #define GCPRO1(varname) \
2280 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2281 gcpro1.level = gcpro_level++; \
2282 gcprolist = &gcpro1; }
2284 #define GCPRO2(varname1, varname2) \
2285 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2286 gcpro1.level = gcpro_level; \
2287 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2288 gcpro2.level = gcpro_level++; \
2289 gcprolist = &gcpro2; }
2291 #define GCPRO3(varname1, varname2, varname3) \
2292 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2293 gcpro1.level = gcpro_level; \
2294 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2295 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2296 gcpro3.level = gcpro_level++; \
2297 gcprolist = &gcpro3; }
2299 #define GCPRO4(varname1, varname2, varname3, varname4) \
2300 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2301 gcpro1.level = gcpro_level; \
2302 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2303 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2304 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2305 gcpro4.level = gcpro_level++; \
2306 gcprolist = &gcpro4; }
2308 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2309 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2310 gcpro1.level = gcpro_level; \
2311 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2312 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2313 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2314 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2315 gcpro5.level = gcpro_level++; \
2316 gcprolist = &gcpro5; }
2318 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2319 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2320 gcpro1.level = gcpro_level; \
2321 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2322 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2323 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2324 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2325 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2326 gcpro6.level = gcpro_level++; \
2327 gcprolist = &gcpro6; }
2330 ((--gcpro_level != gcpro1.level) \
2331 ? (emacs_abort (), 0) \
2332 : ((gcprolist = gcpro1.next), 0))
2334 #endif /* DEBUG_GCPRO */
2335 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2338 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2339 #define RETURN_UNGCPRO(expr) \
2342 Lisp_Object ret_ungc_val; \
2343 ret_ungc_val = (expr); \
2345 return ret_ungc_val; \
2349 /* Call staticpro (&var) to protect static variable `var'. */
2351 void staticpro (Lisp_Object
*);
2353 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2354 meaning as in the DEFUN macro, and is used to construct a prototype. */
2355 /* We can use the same trick as in the DEFUN macro to generate the
2356 appropriate prototype. */
2357 #define EXFUN(fnname, maxargs) \
2358 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2360 /* Forward declarations for prototypes. */
2364 /* Simple access functions. */
2366 LISP_INLINE Lisp_Object
*
2367 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2369 return & XVECTOR (array
)->contents
[idx
];
2373 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2375 /* Like ASET, but also can be used in the garbage collector:
2376 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2377 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2378 XVECTOR (array
)->contents
[idx
] = val
;
2381 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2384 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2386 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2387 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2390 /* Functions to modify hash tables. */
2393 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2395 h
->key_and_value
= key_and_value
;
2399 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2401 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2405 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2407 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2411 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2417 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2419 gc_aset (h
->next
, idx
, val
);
2423 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2429 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2431 gc_aset (h
->hash
, idx
, val
);
2435 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2441 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2443 gc_aset (h
->index
, idx
, val
);
2446 /* Use these functions to set Lisp_Object
2447 or pointer slots of struct Lisp_Symbol. */
2450 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2452 XSYMBOL (sym
)->name
= name
;
2456 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2458 XSYMBOL (sym
)->function
= function
;
2462 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2464 XSYMBOL (sym
)->plist
= plist
;
2468 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2470 XSYMBOL (sym
)->next
= next
;
2473 /* Buffer-local (also frame-local) variable access functions. */
2476 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2478 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2483 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2485 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2489 LISP_INLINE Lisp_Object
2490 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2492 return XCDR (blv
->valcell
);
2496 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2498 XSETCDR (blv
->valcell
, val
);
2502 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2508 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2514 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2519 /* Set overlay's property list. */
2522 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2524 XOVERLAY (overlay
)->plist
= plist
;
2527 /* Get text properties of S. */
2529 LISP_INLINE INTERVAL
2530 string_intervals (Lisp_Object s
)
2532 return XSTRING (s
)->intervals
;
2535 /* Set text properties of S to I. */
2538 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2540 XSTRING (s
)->intervals
= i
;
2543 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2544 of setting slots directly. */
2547 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2549 XCHAR_TABLE (table
)->ascii
= val
;
2552 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2554 XCHAR_TABLE (table
)->defalt
= val
;
2557 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2559 XCHAR_TABLE (table
)->parent
= val
;
2562 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2564 XCHAR_TABLE (table
)->purpose
= val
;
2567 /* Set different slots in (sub)character tables. */
2570 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2572 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2573 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2577 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2579 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2580 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2584 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2586 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2589 /* Defined in data.c. */
2590 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2591 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2592 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2593 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2594 extern Lisp_Object Qinvalid_read_syntax
;
2595 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2596 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2597 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2598 extern Lisp_Object Qtext_read_only
;
2599 extern Lisp_Object Qinteractive_form
;
2600 extern Lisp_Object Qcircular_list
;
2601 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2602 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2603 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2604 extern Lisp_Object Qbuffer_or_string_p
;
2605 extern Lisp_Object Qfboundp
;
2606 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2608 extern Lisp_Object Qcdr
;
2610 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2612 extern Lisp_Object Qfloatp
;
2613 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2615 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2617 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2619 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2621 /* Defined in frame.c. */
2622 extern Lisp_Object Qframep
;
2624 /* Defined in data.c. */
2625 extern Lisp_Object
indirect_function (Lisp_Object
);
2626 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2628 /* Convert the integer I to an Emacs representation, either the integer
2629 itself, or a cons of two or three integers, or if all else fails a float.
2630 I should not have side effects. */
2631 #define INTEGER_TO_CONS(i) \
2632 (! FIXNUM_OVERFLOW_P (i) \
2634 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2635 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2636 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2637 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2638 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2639 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2640 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2641 ? Fcons (make_number ((i) >> 16 >> 24), \
2642 Fcons (make_number ((i) >> 16 & 0xffffff), \
2643 make_number ((i) & 0xffff))) \
2646 /* Convert the Emacs representation CONS back to an integer of type
2647 TYPE, storing the result the variable VAR. Signal an error if CONS
2648 is not a valid representation or is out of range for TYPE. */
2649 #define CONS_TO_INTEGER(cons, type, var) \
2650 (TYPE_SIGNED (type) \
2651 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2652 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2653 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2654 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2656 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2657 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2658 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2660 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2661 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2662 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2663 extern void syms_of_data (void);
2664 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2666 /* Defined in cmds.c */
2667 extern void syms_of_cmds (void);
2668 extern void keys_of_cmds (void);
2670 /* Defined in coding.c. */
2671 extern Lisp_Object Qcharset
;
2672 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2673 ptrdiff_t, bool, bool, Lisp_Object
);
2674 extern void init_coding (void);
2675 extern void init_coding_once (void);
2676 extern void syms_of_coding (void);
2678 /* Defined in character.c. */
2679 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2680 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2681 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2682 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2683 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2684 extern void syms_of_character (void);
2686 /* Defined in charset.c. */
2687 extern void init_charset (void);
2688 extern void init_charset_once (void);
2689 extern void syms_of_charset (void);
2690 /* Structure forward declarations. */
2693 /* Defined in composite.c. */
2694 extern void syms_of_composite (void);
2696 /* Defined in syntax.c. */
2697 extern void init_syntax_once (void);
2698 extern void syms_of_syntax (void);
2700 /* Defined in fns.c. */
2701 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2702 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2703 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2704 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2705 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2706 extern void sweep_weak_hash_tables (void);
2707 extern Lisp_Object Qcursor_in_echo_area
;
2708 extern Lisp_Object Qstring_lessp
;
2709 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2710 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2711 EMACS_UINT
sxhash (Lisp_Object
, int);
2712 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2713 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2715 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2716 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2719 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2720 ptrdiff_t, ptrdiff_t);
2721 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2722 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2723 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2724 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2725 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2726 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2727 extern void clear_string_char_byte_cache (void);
2728 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2729 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2730 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2731 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2732 extern void syms_of_fns (void);
2734 /* Defined in floatfns.c. */
2735 extern double extract_float (Lisp_Object
);
2736 extern void syms_of_floatfns (void);
2737 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2739 /* Defined in fringe.c. */
2740 extern void syms_of_fringe (void);
2741 extern void init_fringe (void);
2742 #ifdef HAVE_WINDOW_SYSTEM
2743 extern void mark_fringe_data (void);
2744 extern void init_fringe_once (void);
2745 #endif /* HAVE_WINDOW_SYSTEM */
2747 /* Defined in image.c. */
2748 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2749 extern Lisp_Object QCconversion
;
2750 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2751 extern void reset_image_types (void);
2752 extern void syms_of_image (void);
2754 /* Defined in insdel.c. */
2755 extern Lisp_Object Qinhibit_modification_hooks
;
2756 extern void move_gap (ptrdiff_t);
2757 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2758 extern _Noreturn
void buffer_overflow (void);
2759 extern void make_gap (ptrdiff_t);
2760 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2761 ptrdiff_t, bool, bool);
2762 extern int count_combining_before (const unsigned char *,
2763 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2764 extern int count_combining_after (const unsigned char *,
2765 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2766 extern void insert (const char *, ptrdiff_t);
2767 extern void insert_and_inherit (const char *, ptrdiff_t);
2768 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2769 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2771 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2772 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2773 ptrdiff_t, ptrdiff_t, bool);
2774 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2775 extern void insert_char (int);
2776 extern void insert_string (const char *);
2777 extern void insert_before_markers (const char *, ptrdiff_t);
2778 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2779 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2780 ptrdiff_t, ptrdiff_t,
2782 extern void del_range (ptrdiff_t, ptrdiff_t);
2783 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2784 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2785 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2786 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2787 ptrdiff_t, ptrdiff_t, bool);
2788 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2789 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2790 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2791 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2792 ptrdiff_t, ptrdiff_t);
2793 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2794 ptrdiff_t, ptrdiff_t);
2795 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2796 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2797 const char *, ptrdiff_t, ptrdiff_t, bool);
2798 extern void syms_of_insdel (void);
2800 /* Defined in dispnew.c. */
2801 #if (defined PROFILING \
2802 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2803 _Noreturn
void __executable_start (void);
2805 extern Lisp_Object selected_frame
;
2806 extern Lisp_Object Vwindow_system
;
2807 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2808 extern void init_display (void);
2809 extern void syms_of_display (void);
2811 /* Defined in xdisp.c. */
2812 extern Lisp_Object Qinhibit_point_motion_hooks
;
2813 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2814 extern Lisp_Object Qmenu_bar_update_hook
;
2815 extern Lisp_Object Qwindow_scroll_functions
;
2816 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2817 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2818 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2819 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2820 extern Lisp_Object Qleft_margin
, Qright_margin
;
2821 extern Lisp_Object Qglyphless_char
;
2822 extern Lisp_Object QCdata
, QCfile
;
2823 extern Lisp_Object QCmap
;
2824 extern Lisp_Object Qrisky_local_variable
;
2825 extern struct frame
*last_glyphless_glyph_frame
;
2826 extern int last_glyphless_glyph_face_id
;
2827 extern int last_glyphless_glyph_merged_face_id
;
2828 extern int noninteractive_need_newline
;
2829 extern Lisp_Object echo_area_buffer
[2];
2830 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2831 extern void check_message_stack (void);
2832 extern void setup_echo_area_for_printing (int);
2833 extern bool push_message (void);
2834 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2835 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2836 extern void restore_message (void);
2837 extern Lisp_Object
current_message (void);
2838 extern void clear_message (int, int);
2839 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2840 extern void message1 (const char *);
2841 extern void message1_nolog (const char *);
2842 extern void message2 (const char *, ptrdiff_t, int);
2843 extern void message2_nolog (const char *, ptrdiff_t, int);
2844 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2845 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2846 extern void message_dolog (const char *, ptrdiff_t, int, int);
2847 extern void message_with_string (const char *, Lisp_Object
, int);
2848 extern void message_log_maybe_newline (void);
2849 extern void update_echo_area (void);
2850 extern void truncate_echo_area (ptrdiff_t);
2851 extern void redisplay (void);
2852 extern void redisplay_preserve_echo_area (int);
2853 extern void prepare_menu_bars (void);
2855 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2856 extern void syms_of_xdisp (void);
2857 extern void init_xdisp (void);
2858 extern Lisp_Object
safe_eval (Lisp_Object
);
2859 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2860 int *, int *, int *, int *, int *);
2862 /* Defined in xsettings.c. */
2863 extern void syms_of_xsettings (void);
2865 /* Defined in vm-limit.c. */
2866 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2868 /* Defined in alloc.c. */
2869 extern void check_pure_size (void);
2870 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2871 extern void malloc_warning (const char *);
2872 extern _Noreturn
void memory_full (size_t);
2873 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2874 extern bool survives_gc_p (Lisp_Object
);
2875 extern void mark_object (Lisp_Object
);
2876 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2877 extern void refill_memory_reserve (void);
2879 extern const char *pending_malloc_warning
;
2880 extern Lisp_Object zero_vector
;
2881 extern Lisp_Object
*stack_base
;
2882 extern EMACS_INT consing_since_gc
;
2883 extern EMACS_INT gc_relative_threshold
;
2884 extern EMACS_INT memory_full_cons_threshold
;
2885 extern Lisp_Object
list1 (Lisp_Object
);
2886 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2887 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2888 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2889 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2891 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2892 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2893 extern _Noreturn
void string_overflow (void);
2894 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2895 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2896 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2897 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2899 /* Make unibyte string from C string when the length isn't known. */
2901 LISP_INLINE Lisp_Object
2902 build_unibyte_string (const char *str
)
2904 return make_unibyte_string (str
, strlen (str
));
2907 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2908 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2909 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2910 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2911 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2912 extern Lisp_Object
make_specified_string (const char *,
2913 ptrdiff_t, ptrdiff_t, bool);
2914 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2915 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2917 /* Make a string allocated in pure space, use STR as string data. */
2919 LISP_INLINE Lisp_Object
2920 build_pure_c_string (const char *str
)
2922 return make_pure_c_string (str
, strlen (str
));
2925 /* Make a string from the data at STR, treating it as multibyte if the
2928 LISP_INLINE Lisp_Object
2929 build_string (const char *str
)
2931 return make_string (str
, strlen (str
));
2934 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2935 extern void make_byte_code (struct Lisp_Vector
*);
2936 extern Lisp_Object Qautomatic_gc
;
2937 extern Lisp_Object Qchar_table_extra_slots
;
2938 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2939 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2940 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2942 allocate_pseudovector \
2943 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2944 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2945 extern struct window
*allocate_window (void);
2946 extern struct frame
*allocate_frame (void);
2947 extern struct Lisp_Process
*allocate_process (void);
2948 extern struct terminal
*allocate_terminal (void);
2949 extern bool gc_in_progress
;
2950 extern bool abort_on_gc
;
2951 extern Lisp_Object
make_float (double);
2952 extern void display_malloc_warning (void);
2953 extern ptrdiff_t inhibit_garbage_collection (void);
2954 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2955 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2956 extern void free_marker (Lisp_Object
);
2957 extern void free_cons (struct Lisp_Cons
*);
2958 extern void init_alloc_once (void);
2959 extern void init_alloc (void);
2960 extern void syms_of_alloc (void);
2961 extern struct buffer
* allocate_buffer (void);
2962 extern int valid_lisp_object_p (Lisp_Object
);
2963 #ifdef GC_CHECK_CONS_LIST
2964 extern void check_cons_list (void);
2966 #define check_cons_list() ((void) 0)
2970 /* Defined in ralloc.c. */
2971 extern void *r_alloc (void **, size_t);
2972 extern void r_alloc_free (void **);
2973 extern void *r_re_alloc (void **, size_t);
2974 extern void r_alloc_reset_variable (void **, void **);
2975 extern void r_alloc_inhibit_buffer_relocation (int);
2978 /* Defined in chartab.c. */
2979 extern Lisp_Object
copy_char_table (Lisp_Object
);
2980 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2981 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2983 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
2984 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
2985 extern int char_table_translate (Lisp_Object
, int);
2986 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2988 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2989 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2990 Lisp_Object
, Lisp_Object
,
2991 Lisp_Object
, struct charset
*,
2992 unsigned, unsigned);
2993 extern Lisp_Object
uniprop_table (Lisp_Object
);
2994 extern void syms_of_chartab (void);
2996 /* Defined in print.c. */
2997 extern Lisp_Object Vprin1_to_string_buffer
;
2998 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2999 extern Lisp_Object Qstandard_output
;
3000 extern Lisp_Object Qexternal_debugging_output
;
3001 extern void temp_output_buffer_setup (const char *);
3002 extern int print_level
;
3003 extern Lisp_Object Qprint_escape_newlines
;
3004 extern void write_string (const char *, int);
3005 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3007 extern Lisp_Object internal_with_output_to_temp_buffer
3008 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3009 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3010 extern int float_to_string (char *, double);
3011 extern void syms_of_print (void);
3013 /* Defined in doprnt.c. */
3014 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3016 extern ptrdiff_t esprintf (char *, char const *, ...)
3017 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3018 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3020 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3021 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3022 char const *, va_list)
3023 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3025 /* Defined in lread.c. */
3026 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3027 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3028 extern Lisp_Object Qlexical_binding
;
3029 extern Lisp_Object
check_obarray (Lisp_Object
);
3030 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3031 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3032 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3033 #define LOADHIST_ATTACH(x) \
3035 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3037 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3038 Lisp_Object
*, Lisp_Object
);
3039 Lisp_Object
string_to_number (char const *, int, int);
3040 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3042 extern void dir_warning (const char *, Lisp_Object
);
3043 extern void close_load_descs (void);
3044 extern void init_obarray (void);
3045 extern void init_lread (void);
3046 extern void syms_of_lread (void);
3048 LISP_INLINE Lisp_Object
3049 intern (const char *str
)
3051 return intern_1 (str
, strlen (str
));
3054 LISP_INLINE Lisp_Object
3055 intern_c_string (const char *str
)
3057 return intern_c_string_1 (str
, strlen (str
));
3060 /* Defined in eval.c. */
3061 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3062 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3063 extern Lisp_Object Qand_rest
;
3064 extern Lisp_Object Vautoload_queue
;
3065 extern Lisp_Object Vsignaling_function
;
3066 extern Lisp_Object inhibit_lisp_code
;
3068 extern struct catchtag
*catchlist
;
3069 extern struct handler
*handlerlist
;
3071 /* To run a normal hook, use the appropriate function from the list below.
3072 The calling convention:
3074 if (!NILP (Vrun_hooks))
3075 call1 (Vrun_hooks, Qmy_funny_hook);
3077 should no longer be used. */
3078 extern Lisp_Object Vrun_hooks
;
3079 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3080 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3081 Lisp_Object (*funcall
)
3082 (ptrdiff_t nargs
, Lisp_Object
*args
));
3083 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3084 extern _Noreturn
void xsignal0 (Lisp_Object
);
3085 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3086 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3087 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3089 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3090 extern Lisp_Object
eval_sub (Lisp_Object form
);
3091 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3092 extern Lisp_Object
call0 (Lisp_Object
);
3093 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3094 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3095 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3096 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3097 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3098 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3099 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3100 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3101 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3102 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3103 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3104 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3105 extern Lisp_Object internal_condition_case_n
3106 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3107 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3108 extern void specbind (Lisp_Object
, Lisp_Object
);
3109 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3110 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3111 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3112 extern _Noreturn
void verror (const char *, va_list)
3113 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3114 extern Lisp_Object
un_autoload (Lisp_Object
);
3115 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3116 extern void init_eval_once (void);
3117 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3118 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3119 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3120 extern void init_eval (void);
3122 extern void mark_backtrace (void);
3124 extern void syms_of_eval (void);
3126 /* Defined in editfns.c. */
3127 extern Lisp_Object Qfield
;
3128 extern void insert1 (Lisp_Object
);
3129 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3130 extern Lisp_Object
save_excursion_save (void);
3131 extern Lisp_Object
save_restriction_save (void);
3132 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3133 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3134 extern _Noreturn
void time_overflow (void);
3135 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3136 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3138 extern void init_editfns (void);
3139 const char *get_system_name (void);
3140 extern void syms_of_editfns (void);
3141 extern void set_time_zone_rule (const char *);
3143 /* Defined in buffer.c. */
3144 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3145 extern _Noreturn
void nsberror (Lisp_Object
);
3146 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3147 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3148 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3149 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3150 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3151 extern bool overlay_touches_p (ptrdiff_t);
3152 extern Lisp_Object Vbuffer_alist
;
3153 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3154 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3155 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3156 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3157 extern void init_buffer_once (void);
3158 extern void init_buffer (void);
3159 extern void syms_of_buffer (void);
3160 extern void keys_of_buffer (void);
3162 /* Defined in marker.c. */
3164 extern ptrdiff_t marker_position (Lisp_Object
);
3165 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3166 extern void clear_charpos_cache (struct buffer
*);
3167 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3168 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3169 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3170 extern void unchain_marker (struct Lisp_Marker
*marker
);
3171 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3172 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3173 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3174 ptrdiff_t, ptrdiff_t);
3175 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3176 extern void syms_of_marker (void);
3178 /* Defined in fileio.c. */
3180 extern Lisp_Object Qfile_error
;
3181 extern Lisp_Object Qfile_exists_p
;
3182 extern Lisp_Object Qfile_directory_p
;
3183 extern Lisp_Object Qinsert_file_contents
;
3184 extern Lisp_Object Qfile_name_history
;
3185 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3186 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3187 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3188 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3189 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3190 extern void internal_delete_file (Lisp_Object
);
3191 extern void syms_of_fileio (void);
3192 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3193 extern Lisp_Object Qdelete_file
;
3195 /* Defined in search.c. */
3196 extern void shrink_regexp_cache (void);
3197 extern void restore_search_regs (void);
3198 extern void record_unwind_save_match_data (void);
3199 struct re_registers
;
3200 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3201 struct re_registers
*,
3202 Lisp_Object
, int, int);
3203 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3204 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3206 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3207 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3208 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3209 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3211 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3213 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3214 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3215 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3216 extern void syms_of_search (void);
3217 extern void clear_regexp_cache (void);
3219 /* Defined in minibuf.c. */
3221 extern Lisp_Object Qcompletion_ignore_case
;
3222 extern Lisp_Object Vminibuffer_list
;
3223 extern Lisp_Object last_minibuf_string
;
3224 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3225 extern void init_minibuf_once (void);
3226 extern void syms_of_minibuf (void);
3228 /* Defined in callint.c. */
3230 extern Lisp_Object Qminus
, Qplus
;
3231 extern Lisp_Object Qwhen
;
3232 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3233 extern void syms_of_callint (void);
3235 /* Defined in casefiddle.c. */
3237 extern Lisp_Object Qidentity
;
3238 extern void syms_of_casefiddle (void);
3239 extern void keys_of_casefiddle (void);
3241 /* Defined in casetab.c. */
3243 extern void init_casetab_once (void);
3244 extern void syms_of_casetab (void);
3246 /* Defined in keyboard.c. */
3248 extern Lisp_Object echo_message_buffer
;
3249 extern struct kboard
*echo_kboard
;
3250 extern void cancel_echoing (void);
3251 extern Lisp_Object Qdisabled
, QCfilter
;
3252 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3253 extern Lisp_Object Qtop
;
3254 extern Lisp_Object last_undo_boundary
;
3255 extern int input_pending
;
3256 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3257 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3258 extern void discard_mouse_events (void);
3260 void handle_input_available_signal (int);
3262 extern Lisp_Object pending_funcalls
;
3263 extern int detect_input_pending (void);
3264 extern int detect_input_pending_ignore_squeezables (void);
3265 extern int detect_input_pending_run_timers (int);
3266 extern void safe_run_hooks (Lisp_Object
);
3267 extern void cmd_error_internal (Lisp_Object
, const char *);
3268 extern Lisp_Object
command_loop_1 (void);
3269 extern Lisp_Object
recursive_edit_1 (void);
3270 extern void record_auto_save (void);
3271 extern void force_auto_save_soon (void);
3272 extern void init_keyboard (void);
3273 extern void syms_of_keyboard (void);
3274 extern void keys_of_keyboard (void);
3276 /* Defined in indent.c. */
3277 extern ptrdiff_t current_column (void);
3278 extern void invalidate_current_column (void);
3279 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3280 extern void syms_of_indent (void);
3282 /* Defined in frame.c. */
3283 extern Lisp_Object Qonly
, Qnone
;
3284 extern Lisp_Object Qvisible
;
3285 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3286 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3287 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3289 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3291 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3292 extern void frames_discard_buffer (Lisp_Object
);
3293 extern void syms_of_frame (void);
3295 /* Defined in emacs.c. */
3296 extern char **initial_argv
;
3297 extern int initial_argc
;
3298 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3299 extern bool display_arg
;
3301 extern Lisp_Object
decode_env_path (const char *, const char *);
3302 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3303 extern Lisp_Object Qfile_name_handler_alist
;
3304 extern _Noreturn
void terminate_due_to_signal (int, int);
3305 extern Lisp_Object Qkill_emacs
;
3307 extern Lisp_Object Vlibrary_cache
;
3310 void fixup_locale (void);
3311 void synchronize_system_messages_locale (void);
3312 void synchronize_system_time_locale (void);
3314 #define setlocale(category, locale)
3315 #define fixup_locale()
3316 #define synchronize_system_messages_locale()
3317 #define synchronize_system_time_locale()
3319 extern void shut_down_emacs (int, Lisp_Object
);
3321 /* True means don't do interactive redisplay and don't change tty modes. */
3322 extern bool noninteractive
;
3324 /* True means remove site-lisp directories from load-path. */
3325 extern bool no_site_lisp
;
3327 /* Pipe used to send exit notification to the daemon parent at
3329 extern int daemon_pipe
[2];
3330 #define IS_DAEMON (daemon_pipe[1] != 0)
3332 /* True if handling a fatal error already. */
3333 extern bool fatal_error_in_progress
;
3335 /* True means don't do use window-system-specific display code. */
3336 extern bool inhibit_window_system
;
3337 /* True means that a filter or a sentinel is running. */
3338 extern bool running_asynch_code
;
3340 /* Defined in process.c. */
3341 extern Lisp_Object QCtype
, Qlocal
;
3342 extern Lisp_Object Qprocessp
;
3343 extern void kill_buffer_processes (Lisp_Object
);
3344 extern int wait_reading_process_output (intmax_t, int, int, int,
3346 struct Lisp_Process
*,
3348 /* Max value for the first argument of wait_reading_process_output. */
3349 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3350 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3351 The bug merely causes a bogus warning, but the warning is annoying. */
3352 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3354 # define WAIT_READING_MAX INTMAX_MAX
3356 extern void add_keyboard_wait_descriptor (int);
3357 extern void delete_keyboard_wait_descriptor (int);
3359 extern void add_gpm_wait_descriptor (int);
3360 extern void delete_gpm_wait_descriptor (int);
3362 extern void close_process_descs (void);
3363 extern void init_process_emacs (void);
3364 extern void syms_of_process (void);
3365 extern void setup_process_coding_systems (Lisp_Object
);
3370 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3371 extern void init_callproc_1 (void);
3372 extern void init_callproc (void);
3373 extern void set_initial_environment (void);
3374 extern void syms_of_callproc (void);
3376 /* Defined in doc.c. */
3377 extern Lisp_Object Qfunction_documentation
;
3378 extern Lisp_Object
read_doc_string (Lisp_Object
);
3379 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3380 extern void syms_of_doc (void);
3381 extern int read_bytecode_char (bool);
3383 /* Defined in bytecode.c. */
3384 extern Lisp_Object Qbytecode
;
3385 extern void syms_of_bytecode (void);
3386 extern struct byte_stack
*byte_stack_list
;
3388 extern void mark_byte_stack (void);
3390 extern void unmark_byte_stack (void);
3391 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3392 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3394 /* Defined in macros.c. */
3395 extern Lisp_Object Qexecute_kbd_macro
;
3396 extern void init_macros (void);
3397 extern void syms_of_macros (void);
3399 /* Defined in undo.c. */
3400 extern Lisp_Object Qapply
;
3401 extern Lisp_Object Qinhibit_read_only
;
3402 extern void truncate_undo_list (struct buffer
*);
3403 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3404 extern void record_insert (ptrdiff_t, ptrdiff_t);
3405 extern void record_delete (ptrdiff_t, Lisp_Object
);
3406 extern void record_first_change (void);
3407 extern void record_change (ptrdiff_t, ptrdiff_t);
3408 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3409 Lisp_Object
, Lisp_Object
,
3411 extern void syms_of_undo (void);
3412 /* Defined in textprop.c. */
3413 extern Lisp_Object Qfont
, Qmouse_face
;
3414 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3415 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3416 extern Lisp_Object Qminibuffer_prompt
;
3418 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3420 /* Defined in menu.c. */
3421 extern void syms_of_menu (void);
3423 /* Defined in xmenu.c. */
3424 extern void syms_of_xmenu (void);
3426 /* Defined in termchar.h. */
3427 struct tty_display_info
;
3429 /* Defined in termhooks.h. */
3432 /* Defined in sysdep.c. */
3433 #ifndef HAVE_GET_CURRENT_DIR_NAME
3434 extern char *get_current_dir_name (void);
3436 extern void stuff_char (char c
);
3437 extern void init_sigio (int);
3438 extern void sys_subshell (void);
3439 extern void sys_suspend (void);
3440 extern void discard_tty_input (void);
3441 extern void init_sys_modes (struct tty_display_info
*);
3442 extern void reset_sys_modes (struct tty_display_info
*);
3443 extern void init_all_sys_modes (void);
3444 extern void reset_all_sys_modes (void);
3445 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3446 extern void child_setup_tty (int);
3447 extern void setup_pty (int);
3448 extern int set_window_size (int, int, int);
3449 extern EMACS_INT
get_random (void);
3450 extern void seed_random (void *, ptrdiff_t);
3451 extern void init_random (void);
3452 extern void emacs_backtrace (int);
3453 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3454 extern int emacs_open (const char *, int, int);
3455 extern int emacs_close (int);
3456 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3457 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3458 enum { READLINK_BUFSIZE
= 1024 };
3459 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3461 extern void unlock_all_files (void);
3462 extern void lock_file (Lisp_Object
);
3463 extern void unlock_file (Lisp_Object
);
3464 extern void unlock_buffer (struct buffer
*);
3465 extern void syms_of_filelock (void);
3467 /* Defined in sound.c. */
3468 extern void syms_of_sound (void);
3470 /* Defined in category.c. */
3471 extern void init_category_once (void);
3472 extern Lisp_Object
char_category_set (int);
3473 extern void syms_of_category (void);
3475 /* Defined in ccl.c. */
3476 extern void syms_of_ccl (void);
3478 /* Defined in dired.c. */
3479 extern void syms_of_dired (void);
3480 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3481 Lisp_Object
, Lisp_Object
,
3484 /* Defined in term.c. */
3485 extern int *char_ins_del_vector
;
3486 extern void syms_of_term (void);
3487 extern _Noreturn
void fatal (const char *msgid
, ...)
3488 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3490 /* Defined in terminal.c. */
3491 extern void syms_of_terminal (void);
3493 /* Defined in font.c. */
3494 extern void syms_of_font (void);
3495 extern void init_font (void);
3497 #ifdef HAVE_WINDOW_SYSTEM
3498 /* Defined in fontset.c. */
3499 extern void syms_of_fontset (void);
3501 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3502 extern Lisp_Object Qfont_param
;
3505 /* Defined in xfaces.c. */
3506 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3507 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3508 extern Lisp_Object Qmode_line_inactive
;
3509 extern Lisp_Object Qface
;
3510 extern Lisp_Object Qnormal
;
3511 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3512 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3513 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3514 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3515 extern Lisp_Object Qoblique
, Qitalic
;
3516 extern Lisp_Object Vface_alternative_font_family_alist
;
3517 extern Lisp_Object Vface_alternative_font_registry_alist
;
3518 extern void syms_of_xfaces (void);
3520 #ifdef HAVE_X_WINDOWS
3521 /* Defined in xfns.c. */
3522 extern void syms_of_xfns (void);
3524 /* Defined in xsmfns.c. */
3525 extern void syms_of_xsmfns (void);
3527 /* Defined in xselect.c. */
3528 extern void syms_of_xselect (void);
3530 /* Defined in xterm.c. */
3531 extern void syms_of_xterm (void);
3532 #endif /* HAVE_X_WINDOWS */
3534 #ifdef HAVE_WINDOW_SYSTEM
3535 /* Defined in xterm.c, nsterm.m, w32term.c. */
3536 extern char *x_get_keysym_name (int);
3537 #endif /* HAVE_WINDOW_SYSTEM */
3540 /* Defined in xml.c. */
3541 extern void syms_of_xml (void);
3542 extern void xml_cleanup_parser (void);
3546 /* Defined in (x|w32)fns.c, nsfns.m... */
3547 extern int have_menus_p (void);
3551 /* Defined in dbusbind.c. */
3552 void syms_of_dbusbind (void);
3556 /* Defined in profiler.c. */
3557 extern bool profiler_memory_running
;
3558 extern void malloc_probe (size_t);
3559 extern void syms_of_profiler (void);
3563 /* Defined in msdos.c, w32.c. */
3564 extern char *emacs_root_dir (void);
3567 /* True means Emacs has already been initialized.
3568 Used during startup to detect startup of dumped Emacs. */
3569 extern bool initialized
;
3571 extern int immediate_quit
; /* Nonzero means ^G can quit instantly. */
3573 extern void *xmalloc (size_t);
3574 extern void *xzalloc (size_t);
3575 extern void *xrealloc (void *, size_t);
3576 extern void xfree (void *);
3577 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3578 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3579 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3581 extern char *xstrdup (const char *);
3583 extern char *egetenv (const char *);
3585 /* Set up the name of the machine we're running on. */
3586 extern void init_system_name (void);
3588 /* We used to use `abs', but that clashes with system headers on some
3589 platforms, and using a name reserved by Standard C is a bad idea
3592 #define eabs(x) ((x) < 0 ? -(x) : (x))
3595 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3598 #define make_fixnum_or_float(val) \
3599 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3601 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3602 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3604 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3606 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3607 extern void *record_xmalloc (size_t);
3609 #define USE_SAFE_ALLOCA \
3610 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3612 /* SAFE_ALLOCA allocates a simple buffer. */
3614 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3616 : (sa_must_free = 1, record_xmalloc (size)))
3618 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3619 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3620 positive. The code is tuned for MULTIPLIER being a constant. */
3622 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3624 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3625 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3628 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3630 record_unwind_protect (safe_alloca_unwind, \
3631 make_save_value (buf, 0)); \
3635 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3637 #define SAFE_FREE() \
3639 if (sa_must_free) { \
3641 unbind_to (sa_count, Qnil); \
3646 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3648 #define SAFE_ALLOCA_LISP(buf, nelt) \
3650 if ((nelt) < MAX_ALLOCA / word_size) \
3651 buf = alloca ((nelt) * word_size); \
3652 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3655 buf = xmalloc ((nelt) * word_size); \
3656 arg_ = make_save_value (buf, nelt); \
3657 XSAVE_VALUE (arg_)->dogc = 1; \
3659 record_unwind_protect (safe_alloca_unwind, arg_); \
3662 memory_full (SIZE_MAX); \
3666 #include "globals.h"
3668 /* Check whether it's time for GC, and run it if so. */
3673 if ((consing_since_gc
> gc_cons_threshold
3674 && consing_since_gc
> gc_relative_threshold
)
3675 || (!NILP (Vmemory_full
)
3676 && consing_since_gc
> memory_full_cons_threshold
))
3677 Fgarbage_collect ();
3681 functionp (Lisp_Object object
)
3683 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3685 object
= Findirect_function (object
, Qt
);
3687 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3689 /* Autoloaded symbols are functions, except if they load
3690 macros or keymaps. */
3692 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3693 object
= XCDR (object
);
3695 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3700 return XSUBR (object
)->max_args
!= UNEVALLED
;
3701 else if (COMPILEDP (object
))
3703 else if (CONSP (object
))
3705 Lisp_Object car
= XCAR (object
);
3706 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3714 #endif /* EMACS_LISP_H */