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
,
368 /* These last 4 are special because we OR them in fns.c:internal_equal,
369 so they have to use a disjoint bit pattern:
370 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
371 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
372 PVEC_COMPILED
= 0x10,
373 PVEC_CHAR_TABLE
= 0x20,
374 PVEC_SUB_CHAR_TABLE
= 0x30,
378 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
379 which were stored in a Lisp_Object. */
380 #ifndef DATA_SEG_BITS
381 # define DATA_SEG_BITS 0
383 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
388 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
390 /* For convenience, we also store the number of elements in these bits.
391 Note that this size is not necessarily the memory-footprint size, but
392 only the number of Lisp_Object fields (that need to be traced by GC).
393 The distinction is used, e.g., by Lisp_Process, which places extra
394 non-Lisp_Object fields at the end of the structure. */
395 PSEUDOVECTOR_SIZE_BITS
= 16,
396 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
397 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
399 /* Number of bits to put in each character in the internal representation
400 of bool vectors. This should not vary across implementations. */
401 BOOL_VECTOR_BITS_PER_CHAR
= 8
404 /* These macros extract various sorts of values from a Lisp_Object.
405 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
406 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
408 /* Return a perfect hash of the Lisp_Object representation. */
409 #define XHASH(a) XLI (a)
415 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
418 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
419 #define XINT(a) (XLI (a) >> INTTYPEBITS)
420 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
421 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
422 #define make_lisp_ptr(ptr, type) \
423 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
424 XIL ((type) | (intptr_t) (ptr)))
426 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
427 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
429 #else /* not USE_LSB_TAG */
431 static EMACS_INT
const VALMASK
432 #define VALMASK VAL_MAX
435 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
437 /* For integers known to be positive, XFASTINT provides fast retrieval
438 and XSETFASTINT provides fast storage. This takes advantage of the
439 fact that Lisp integers have zero-bits in their tags. */
440 #define XFASTINT(a) (XLI (a) + 0)
441 #define XSETFASTINT(a, b) ((a) = XIL (b))
443 /* Extract the value of a Lisp_Object as a (un)signed integer. */
445 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
446 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
447 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
449 #define make_lisp_ptr(ptr, type) \
450 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
451 + ((intptr_t) (ptr) & VALMASK)))
454 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
455 which were stored in a Lisp_Object. */
456 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
458 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
461 #endif /* not USE_LSB_TAG */
463 /* For integers known to be positive, XFASTINT sometimes provides
464 faster retrieval and XSETFASTINT provides faster storage.
465 If not, fallback on the non-accelerated path. */
467 # define XFASTINT(a) (XINT (a))
468 # define XSETFASTINT(a, b) (XSETINT (a, b))
471 /* Extract the pointer value of the Lisp object A, under the
472 assumption that A's type is TYPE. This is a fallback
473 implementation if nothing faster is available. */
475 # define XUNTAG(a, type) XPNTR (a)
478 #define EQ(x, y) (XHASH (x) == XHASH (y))
480 /* Largest and smallest representable fixnum values. These are the C
481 values. They are macros for use in static initializers, and
482 constants for visibility to GDB. */
483 static EMACS_INT
const MOST_POSITIVE_FIXNUM
=
484 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
485 MOST_POSITIVE_FIXNUM
;
486 static EMACS_INT
const MOST_NEGATIVE_FIXNUM
=
487 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
488 MOST_NEGATIVE_FIXNUM
;
490 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
491 written this way so that it also works if I is of unsigned
492 type or if I is a NaN. */
494 #define FIXNUM_OVERFLOW_P(i) \
495 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
497 LISP_INLINE
ptrdiff_t
498 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
500 return num
< lower
? lower
: num
<= upper
? num
: upper
;
503 /* Extract a value or address from a Lisp_Object. */
505 #define XCONS(a) (eassert (CONSP (a)), \
506 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
507 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
508 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
509 #define XSTRING(a) (eassert (STRINGP (a)), \
510 (struct Lisp_String *) XUNTAG (a, Lisp_String))
511 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
512 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
513 #define XFLOAT(a) (eassert (FLOATP (a)), \
514 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
518 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
519 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
520 #define XMISCTYPE(a) (XMISCANY (a)->type)
521 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
522 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
523 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
525 /* Forwarding object types. */
527 #define XFWDTYPE(a) (a->u_intfwd.type)
528 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
529 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
530 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
531 #define XBUFFER_OBJFWD(a) \
532 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
533 #define XKBOARD_OBJFWD(a) \
534 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
536 /* Pseudovector types. */
538 #define XPROCESS(a) (eassert (PROCESSP (a)), \
539 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
540 #define XWINDOW(a) (eassert (WINDOWP (a)), \
541 (struct window *) XUNTAG (a, Lisp_Vectorlike))
542 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
543 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
544 #define XSUBR(a) (eassert (SUBRP (a)), \
545 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
546 #define XBUFFER(a) (eassert (BUFFERP (a)), \
547 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
548 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
549 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
550 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
551 ((struct Lisp_Sub_Char_Table *) \
552 XUNTAG (a, Lisp_Vectorlike)))
553 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
554 ((struct Lisp_Bool_Vector *) \
555 XUNTAG (a, Lisp_Vectorlike)))
557 /* Construct a Lisp_Object from a value or address. */
559 #define XSETINT(a, b) ((a) = make_number (b))
560 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
561 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
562 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
563 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
564 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
568 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
569 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
571 /* Pseudovector types. */
573 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
574 #define XSETTYPED_PVECTYPE(v, size_member, code) \
575 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
576 #define XSETPVECTYPESIZE(v, code, sizeval) \
577 ((v)->header.size = (PSEUDOVECTOR_FLAG \
578 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
581 /* The cast to struct vectorlike_header * avoids aliasing issues. */
582 #define XSETPSEUDOVECTOR(a, b, code) \
583 XSETTYPED_PSEUDOVECTOR (a, b, \
584 (((struct vectorlike_header *) \
585 XUNTAG (a, Lisp_Vectorlike)) \
588 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
589 (XSETVECTOR (a, b), \
590 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
591 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
593 #define XSETWINDOW_CONFIGURATION(a, b) \
594 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
595 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
596 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
597 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
598 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
599 #define XSETSUBR(a, b) \
600 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
601 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
602 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
603 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
604 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
605 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
607 /* Convenience macros for dealing with Lisp arrays. */
609 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
610 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
611 #define ASET(ARRAY, IDX, VAL) \
612 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
613 XVECTOR (ARRAY)->contents[IDX] = (VAL))
615 /* Convenience macros for dealing with Lisp strings. */
617 #define SDATA(string) (XSTRING (string)->data + 0)
618 #define SREF(string, index) (SDATA (string)[index] + 0)
619 #define SSET(string, index, new) (SDATA (string)[index] = (new))
620 #define SCHARS(string) (XSTRING (string)->size + 0)
621 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
623 /* Avoid "differ in sign" warnings. */
624 #define SSDATA(x) ((char *) SDATA (x))
626 #define STRING_SET_CHARS(string, newsize) \
627 (XSTRING (string)->size = (newsize))
629 #define STRING_COPYIN(string, index, new, count) \
630 memcpy (SDATA (string) + index, new, count)
634 #define CHECK_TYPE(ok, Qxxxp, x) \
635 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
637 /* Deprecated and will be removed soon. */
639 #define INTERNAL_FIELD(field) field ## _
641 /* See the macros in intervals.h. */
643 typedef struct interval
*INTERVAL
;
645 /* Complain if object is not string or buffer type. */
646 #define CHECK_STRING_OR_BUFFER(x) \
647 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
651 /* Car of this cons cell. */
656 /* Cdr of this cons cell. */
659 /* Used to chain conses on a free list. */
660 struct Lisp_Cons
*chain
;
664 /* Take the car or cdr of something known to be a cons cell. */
665 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
666 of code that has to know what a cons cell looks like. Other code not
667 part of the basic lisp implementation should assume that the car and cdr
668 fields are not accessible as lvalues. (What if we want to switch to
669 a copying collector someday? Cached cons cell field addresses may be
670 invalidated at arbitrary points.) */
671 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
672 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
674 /* Use these from normal code. */
675 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
676 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
678 /* Use these to set the fields of a cons cell.
680 Note that both arguments may refer to the same object, so 'n'
681 should not be read after 'c' is first modified. Also, neither
682 argument should be evaluated more than once; side effects are
683 especially common in the second argument. */
684 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
685 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
687 /* Take the car or cdr of something whose type is not known. */
689 (CONSP ((c)) ? XCAR ((c)) \
690 : NILP ((c)) ? Qnil \
691 : wrong_type_argument (Qlistp, (c)))
694 (CONSP ((c)) ? XCDR ((c)) \
695 : NILP ((c)) ? Qnil \
696 : wrong_type_argument (Qlistp, (c)))
698 /* Take the car or cdr of something whose type is not known. */
699 #define CAR_SAFE(c) \
700 (CONSP ((c)) ? XCAR ((c)) : Qnil)
702 #define CDR_SAFE(c) \
703 (CONSP ((c)) ? XCDR ((c)) : Qnil)
705 /* True if STR is a multibyte string. */
706 #define STRING_MULTIBYTE(STR) \
707 (XSTRING (STR)->size_byte >= 0)
709 /* Return the length in bytes of STR. */
711 #ifdef GC_CHECK_STRING_BYTES
714 extern ptrdiff_t string_bytes (struct Lisp_String
*);
715 #define STRING_BYTES(S) string_bytes ((S))
717 #else /* not GC_CHECK_STRING_BYTES */
719 #define STRING_BYTES(STR) \
720 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
722 #endif /* not GC_CHECK_STRING_BYTES */
724 /* An upper bound on the number of bytes in a Lisp string, not
725 counting the terminating null. This a tight enough bound to
726 prevent integer overflow errors that would otherwise occur during
727 string size calculations. A string cannot contain more bytes than
728 a fixnum can represent, nor can it be so long that C pointer
729 arithmetic stops working on the string plus its terminating null.
730 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
731 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
732 would expose alloc.c internal details that we'd rather keep
735 This is a macro for use in static initializers, and a constant for
736 visibility to GDB. The cast to ptrdiff_t ensures that
737 the macro is signed. */
738 static ptrdiff_t const STRING_BYTES_BOUND
=
739 #define STRING_BYTES_BOUND \
740 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
743 /* Mark STR as a unibyte string. */
744 #define STRING_SET_UNIBYTE(STR) \
745 do { if (EQ (STR, empty_multibyte_string)) \
746 (STR) = empty_unibyte_string; \
747 else XSTRING (STR)->size_byte = -1; } while (0)
749 /* Mark STR as a multibyte string. Assure that STR contains only
750 ASCII characters in advance. */
751 #define STRING_SET_MULTIBYTE(STR) \
752 do { if (EQ (STR, empty_unibyte_string)) \
753 (STR) = empty_multibyte_string; \
754 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
756 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
762 INTERVAL intervals
; /* Text properties in this string. */
766 /* Header of vector-like objects. This documents the layout constraints on
767 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
768 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
769 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
770 because when two such pointers potentially alias, a compiler won't
771 incorrectly reorder loads and stores to their size fields. See
772 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
773 struct vectorlike_header
775 /* This field contains various pieces of information:
776 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
777 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
778 vector (0) or a pseudovector (1).
779 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
780 of slots) of the vector.
781 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
782 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
783 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
784 Lisp_Object slots at the beginning of the object that need to be
785 traced by the GC, tho some types use it slightly differently.
786 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
787 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
791 /* When the vector is allocated from a vector block, NBYTES is used
792 if the vector is not on a free list, and VECTOR is used otherwise.
793 For large vector-like objects, BUFFER or VECTOR is used as a pointer
794 to the next vector-like object. It is generally a buffer or a
795 Lisp_Vector alias, so for convenience it is a union instead of a
796 pointer: this way, one can write P->next.vector instead of ((struct
797 Lisp_Vector *) P->next). */
799 /* This is only needed for small vectors that are not free because the
800 `size' field only gives us the number of Lisp_Object slots, whereas we
801 need to know the total size, including non-Lisp_Object data.
802 FIXME: figure out a way to store this info elsewhere so we can
803 finally get rid of this extra word of overhead. */
805 struct buffer
*buffer
;
806 /* FIXME: This can be removed: For large vectors, this field could be
807 placed *before* the vector itself. And for small vectors on a free
808 list, this field could be stored in the vector's bytes, since the
809 empty vector is handled specially anyway. */
810 struct Lisp_Vector
*vector
;
814 /* Regular vector is just a header plus array of Lisp_Objects. */
818 struct vectorlike_header header
;
819 Lisp_Object contents
[1];
822 /* A boolvector is a kind of vectorlike, with contents are like a string. */
824 struct Lisp_Bool_Vector
826 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
827 just the subtype information. */
828 struct vectorlike_header header
;
829 /* This is the size in bits. */
831 /* This contains the actual bits, packed into bytes. */
832 unsigned char data
[1];
835 /* Some handy constants for calculating sizes
836 and offsets, mostly of vectorlike objects. */
840 header_size
= offsetof (struct Lisp_Vector
, contents
),
841 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
842 word_size
= sizeof (Lisp_Object
)
845 /* If a struct is made to look like a vector, this macro returns the length
846 of the shortest vector that would hold that struct. */
848 #define VECSIZE(type) \
849 ((sizeof (type) - header_size + word_size - 1) / word_size)
851 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
852 at the end and we need to compute the number of Lisp_Object fields (the
853 ones that the GC needs to trace). */
855 #define PSEUDOVECSIZE(type, nonlispfield) \
856 ((offsetof (type, nonlispfield) - header_size) / word_size)
858 /* A char-table is a kind of vectorlike, with contents are like a
859 vector but with a few other slots. For some purposes, it makes
860 sense to handle a char-table with type struct Lisp_Vector. An
861 element of a char table can be any Lisp objects, but if it is a sub
862 char-table, we treat it a table that contains information of a
863 specific range of characters. A sub char-table has the same
864 structure as a vector. A sub char table appears only in an element
865 of a char-table, and there's no way to access it directly from
866 Emacs Lisp program. */
870 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
871 ({struct Lisp_Char_Table *_tbl = NULL; \
874 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
875 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
876 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
878 _val = _tbl->defalt; \
879 } while (NILP (_val) && ! NILP (_tbl->parent)); \
882 #else /* not __GNUC__ */
884 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
885 (! NILP (XCHAR_TABLE (CT)->ascii) \
886 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
887 ? XCHAR_TABLE (CT)->ascii \
888 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
889 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
890 : char_table_ref ((CT), (IDX))) \
891 : char_table_ref ((CT), (IDX)))
893 #endif /* not __GNUC__ */
895 /* Compute A OP B, using the unsigned comparison operator OP. A and B
896 should be integer expressions. This is not the same as
897 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
898 returns 1. For efficiency, prefer plain unsigned comparison if A
899 and B's sizes both fit (after integer promotion). */
900 #define UNSIGNED_CMP(a, op, b) \
901 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
902 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
903 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
905 /* Nonzero iff C is an ASCII character. */
906 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
908 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
909 characters. Do not check validity of CT. */
910 #define CHAR_TABLE_REF(CT, IDX) \
911 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
912 : char_table_ref ((CT), (IDX)))
914 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
915 8-bit European characters. Do not check validity of CT. */
916 #define CHAR_TABLE_SET(CT, IDX, VAL) \
917 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
918 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
919 : char_table_set (CT, IDX, VAL))
921 enum CHARTAB_SIZE_BITS
923 CHARTAB_SIZE_BITS_0
= 6,
924 CHARTAB_SIZE_BITS_1
= 4,
925 CHARTAB_SIZE_BITS_2
= 5,
926 CHARTAB_SIZE_BITS_3
= 7
929 extern const int chartab_size
[4];
931 struct Lisp_Char_Table
933 /* HEADER.SIZE is the vector's size field, which also holds the
934 pseudovector type information. It holds the size, too.
935 The size counts the defalt, parent, purpose, ascii,
936 contents, and extras slots. */
937 struct vectorlike_header header
;
939 /* This holds a default value,
940 which is used whenever the value for a specific character is nil. */
943 /* This points to another char table, which we inherit from when the
944 value for a specific character is nil. The `defalt' slot takes
945 precedence over this. */
948 /* This is a symbol which says what kind of use this char-table is
952 /* The bottom sub char-table for characters of the range 0..127. It
953 is nil if none of ASCII character has a specific value. */
956 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
958 /* These hold additional data. It is a vector. */
959 Lisp_Object extras
[1];
962 struct Lisp_Sub_Char_Table
964 /* HEADER.SIZE is the vector's size field, which also holds the
965 pseudovector type information. It holds the size, too. */
966 struct vectorlike_header header
;
968 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
969 char-table of depth 1 contains 16 elements, and each element
970 covers 4096 (128*32) characters. A sub char-table of depth 2
971 contains 32 elements, and each element covers 128 characters. A
972 sub char-table of depth 3 contains 128 elements, and each element
973 is for one character. */
976 /* Minimum character covered by the sub char-table. */
977 Lisp_Object min_char
;
979 /* Use set_sub_char_table_contents to set this. */
980 Lisp_Object contents
[1];
983 /* This structure describes a built-in function.
984 It is generated by the DEFUN macro only.
985 defsubr makes it into a Lisp object.
987 This type is treated in most respects as a pseudovector,
988 but since we never dynamically allocate or free them,
989 we don't need a struct vectorlike_header and its 'next' field. */
995 Lisp_Object (*a0
) (void);
996 Lisp_Object (*a1
) (Lisp_Object
);
997 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
998 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
999 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1000 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1001 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1002 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1003 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1004 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1005 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1007 short min_args
, max_args
;
1008 const char *symbol_name
;
1009 const char *intspec
;
1013 /* This is the number of slots that every char table must have. This
1014 counts the ordinary slots and the top, defalt, parent, and purpose
1016 enum CHAR_TABLE_STANDARD_SLOTS
1018 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1021 /* Return the number of "extra" slots in the char table CT. */
1023 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1024 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1027 /***********************************************************************
1029 ***********************************************************************/
1031 /* Interned state of a symbol. */
1033 enum symbol_interned
1035 SYMBOL_UNINTERNED
= 0,
1036 SYMBOL_INTERNED
= 1,
1037 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1040 enum symbol_redirect
1042 SYMBOL_PLAINVAL
= 4,
1043 SYMBOL_VARALIAS
= 1,
1044 SYMBOL_LOCALIZED
= 2,
1045 SYMBOL_FORWARDED
= 3
1050 unsigned gcmarkbit
: 1;
1052 /* Indicates where the value can be found:
1053 0 : it's a plain var, the value is in the `value' field.
1054 1 : it's a varalias, the value is really in the `alias' symbol.
1055 2 : it's a localized var, the value is in the `blv' object.
1056 3 : it's a forwarding variable, the value is in `forward'. */
1057 ENUM_BF (symbol_redirect
) redirect
: 3;
1059 /* Non-zero means symbol is constant, i.e. changing its value
1060 should signal an error. If the value is 3, then the var
1061 can be changed, but only by `defconst'. */
1062 unsigned constant
: 2;
1064 /* Interned state of the symbol. This is an enumerator from
1065 enum symbol_interned. */
1066 unsigned interned
: 2;
1068 /* Non-zero means that this variable has been explicitly declared
1069 special (with `defvar' etc), and shouldn't be lexically bound. */
1070 unsigned declared_special
: 1;
1072 /* The symbol's name, as a Lisp string. */
1075 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1076 union is used depends on the `redirect' field above. */
1079 struct Lisp_Symbol
*alias
;
1080 struct Lisp_Buffer_Local_Value
*blv
;
1081 union Lisp_Fwd
*fwd
;
1084 /* Function value of the symbol or Qunbound if not fboundp. */
1085 Lisp_Object function
;
1087 /* The symbol's property list. */
1090 /* Next symbol in obarray bucket, if the symbol is interned. */
1091 struct Lisp_Symbol
*next
;
1094 /* Value is name of symbol. */
1096 #define SYMBOL_VAL(sym) \
1097 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1098 #define SYMBOL_ALIAS(sym) \
1099 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1100 #define SYMBOL_BLV(sym) \
1101 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1102 #define SYMBOL_FWD(sym) \
1103 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1104 #define SET_SYMBOL_VAL(sym, v) \
1105 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1106 #define SET_SYMBOL_ALIAS(sym, v) \
1107 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1108 #define SET_SYMBOL_BLV(sym, v) \
1109 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1110 #define SET_SYMBOL_FWD(sym, v) \
1111 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1113 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1115 /* Value is non-zero if SYM is an interned symbol. */
1117 #define SYMBOL_INTERNED_P(sym) \
1118 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1120 /* Value is non-zero if SYM is interned in initial_obarray. */
1122 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1123 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1125 /* Value is non-zero if symbol is considered a constant, i.e. its
1126 value cannot be changed (there is an exception for keyword symbols,
1127 whose value can be set to the keyword symbol itself). */
1129 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1131 #define DEFSYM(sym, name) \
1132 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1135 /***********************************************************************
1137 ***********************************************************************/
1139 /* The structure of a Lisp hash table. */
1141 struct Lisp_Hash_Table
1143 /* This is for Lisp; the hash table code does not refer to it. */
1144 struct vectorlike_header header
;
1146 /* Function used to compare keys. */
1149 /* Nil if table is non-weak. Otherwise a symbol describing the
1150 weakness of the table. */
1153 /* When the table is resized, and this is an integer, compute the
1154 new size by adding this to the old size. If a float, compute the
1155 new size by multiplying the old size with this factor. */
1156 Lisp_Object rehash_size
;
1158 /* Resize hash table when number of entries/ table size is >= this
1160 Lisp_Object rehash_threshold
;
1162 /* Vector of hash codes.. If hash[I] is nil, this means that that
1163 entry I is unused. */
1166 /* Vector used to chain entries. If entry I is free, next[I] is the
1167 entry number of the next free item. If entry I is non-free,
1168 next[I] is the index of the next entry in the collision chain. */
1171 /* Index of first free entry in free list. */
1172 Lisp_Object next_free
;
1174 /* Bucket vector. A non-nil entry is the index of the first item in
1175 a collision chain. This vector's size can be larger than the
1176 hash table size to reduce collisions. */
1179 /* User-supplied hash function, or nil. */
1180 Lisp_Object user_hash_function
;
1182 /* User-supplied key comparison function, or nil. */
1183 Lisp_Object user_cmp_function
;
1185 /* Only the fields above are traced normally by the GC. The ones below
1186 `count' are special and are either ignored by the GC or traced in
1187 a special way (e.g. because of weakness). */
1189 /* Number of key/value entries in the table. */
1192 /* Vector of keys and values. The key of item I is found at index
1193 2 * I, the value is found at index 2 * I + 1.
1194 This is gc_marked specially if the table is weak. */
1195 Lisp_Object key_and_value
;
1197 /* Next weak hash table if this is a weak hash table. The head
1198 of the list is in weak_hash_tables. */
1199 struct Lisp_Hash_Table
*next_weak
;
1201 /* C function to compare two keys. */
1202 bool (*cmpfn
) (struct Lisp_Hash_Table
*,
1203 Lisp_Object
, EMACS_UINT
,
1204 Lisp_Object
, EMACS_UINT
);
1206 /* C function to compute hash code. */
1207 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1211 #define XHASH_TABLE(OBJ) \
1212 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1214 #define XSET_HASH_TABLE(VAR, PTR) \
1215 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1217 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1219 #define CHECK_HASH_TABLE(x) \
1220 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1222 /* Value is the key part of entry IDX in hash table H. */
1224 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1226 /* Value is the value part of entry IDX in hash table H. */
1228 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1230 /* Value is the index of the next entry following the one at IDX
1233 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1235 /* Value is the hash code computed for entry IDX in hash table H. */
1237 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1239 /* Value is the index of the element in hash table H that is the
1240 start of the collision list at index IDX in the index vector of H. */
1242 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1244 /* Value is the size of hash table H. */
1246 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1248 /* Default size for hash tables if not specified. */
1250 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1252 /* Default threshold specifying when to resize a hash table. The
1253 value gives the ratio of current entries in the hash table and the
1254 size of the hash table. */
1256 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1258 /* Default factor by which to increase the size of a hash table. */
1260 static double const DEFAULT_REHASH_SIZE
= 1.5;
1262 /* These structures are used for various misc types. */
1264 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1266 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1267 unsigned gcmarkbit
: 1;
1273 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1274 unsigned gcmarkbit
: 1;
1276 /* This flag is temporarily used in the functions
1277 decode/encode_coding_object to record that the marker position
1278 must be adjusted after the conversion. */
1279 unsigned int need_adjustment
: 1;
1280 /* 1 means normal insertion at the marker's position
1281 leaves the marker after the inserted text. */
1282 unsigned int insertion_type
: 1;
1283 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1284 Note: a chain of markers can contain markers pointing into different
1285 buffers (the chain is per buffer_text rather than per buffer, so it's
1286 shared between indirect buffers). */
1287 /* This is used for (other than NULL-checking):
1289 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1290 - unchain_marker: to find the list from which to unchain.
1291 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1293 struct buffer
*buffer
;
1295 /* The remaining fields are meaningless in a marker that
1296 does not point anywhere. */
1298 /* For markers that point somewhere,
1299 this is used to chain of all the markers in a given buffer. */
1300 /* We could remove it and use an array in buffer_text instead.
1301 That would also allow to preserve it ordered. */
1302 struct Lisp_Marker
*next
;
1303 /* This is the char position where the marker points. */
1305 /* This is the byte position.
1306 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1307 used to implement the functionality of markers, but rather to (ab)use
1308 markers as a cache for char<->byte mappings). */
1312 /* START and END are markers in the overlay's buffer, and
1313 PLIST is the overlay's property list. */
1315 /* An overlay's real data content is:
1317 - buffer (really there are two buffer pointers, one per marker,
1318 and both points to the same buffer)
1319 - insertion type of both ends (per-marker fields)
1320 - start & start byte (of start marker)
1321 - end & end byte (of end marker)
1322 - next (singly linked list of overlays)
1323 - next fields of start and end markers (singly linked list of markers).
1324 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1327 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1328 unsigned gcmarkbit
: 1;
1330 struct Lisp_Overlay
*next
;
1336 /* Hold a C pointer for later use.
1337 This type of object is used in the arg to record_unwind_protect. */
1338 struct Lisp_Save_Value
1340 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1341 unsigned gcmarkbit
: 1;
1343 /* If DOGC is set, POINTER is the address of a memory
1344 area containing INTEGER potential Lisp_Objects. */
1345 unsigned int dogc
: 1;
1351 /* A miscellaneous object, when it's on the free list. */
1354 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1355 unsigned gcmarkbit
: 1;
1357 union Lisp_Misc
*chain
;
1360 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1361 It uses one of these struct subtypes to get the type field. */
1365 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1366 struct Lisp_Free u_free
;
1367 struct Lisp_Marker u_marker
;
1368 struct Lisp_Overlay u_overlay
;
1369 struct Lisp_Save_Value u_save_value
;
1372 /* Forwarding pointer to an int variable.
1373 This is allowed only in the value cell of a symbol,
1374 and it means that the symbol's value really lives in the
1375 specified int variable. */
1378 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1382 /* Boolean forwarding pointer to an int variable.
1383 This is like Lisp_Intfwd except that the ostensible
1384 "value" of the symbol is t if the int variable is nonzero,
1385 nil if it is zero. */
1388 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1392 /* Forwarding pointer to a Lisp_Object variable.
1393 This is allowed only in the value cell of a symbol,
1394 and it means that the symbol's value really lives in the
1395 specified variable. */
1398 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1399 Lisp_Object
*objvar
;
1402 /* Like Lisp_Objfwd except that value lives in a slot in the
1403 current buffer. Value is byte index of slot within buffer. */
1404 struct Lisp_Buffer_Objfwd
1406 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1408 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1411 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1412 the symbol has buffer-local or frame-local bindings. (Exception:
1413 some buffer-local variables are built-in, with their values stored
1414 in the buffer structure itself. They are handled differently,
1415 using struct Lisp_Buffer_Objfwd.)
1417 The `realvalue' slot holds the variable's current value, or a
1418 forwarding pointer to where that value is kept. This value is the
1419 one that corresponds to the loaded binding. To read or set the
1420 variable, you must first make sure the right binding is loaded;
1421 then you can access the value in (or through) `realvalue'.
1423 `buffer' and `frame' are the buffer and frame for which the loaded
1424 binding was found. If those have changed, to make sure the right
1425 binding is loaded it is necessary to find which binding goes with
1426 the current buffer and selected frame, then load it. To load it,
1427 first unload the previous binding, then copy the value of the new
1428 binding into `realvalue' (or through it). Also update
1429 LOADED-BINDING to point to the newly loaded binding.
1431 `local_if_set' indicates that merely setting the variable creates a
1432 local binding for the current buffer. Otherwise the latter, setting
1433 the variable does not do that; only make-local-variable does that. */
1435 struct Lisp_Buffer_Local_Value
1437 /* 1 means that merely setting the variable creates a local
1438 binding for the current buffer. */
1439 unsigned int local_if_set
: 1;
1440 /* 1 means this variable can have frame-local bindings, otherwise, it is
1441 can have buffer-local bindings. The two cannot be combined. */
1442 unsigned int frame_local
: 1;
1443 /* 1 means that the binding now loaded was found.
1444 Presumably equivalent to (defcell!=valcell). */
1445 unsigned int found
: 1;
1446 /* If non-NULL, a forwarding to the C var where it should also be set. */
1447 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1448 /* The buffer or frame for which the loaded binding was found. */
1450 /* A cons cell that holds the default value. It has the form
1451 (SYMBOL . DEFAULT-VALUE). */
1452 Lisp_Object defcell
;
1453 /* The cons cell from `where's parameter alist.
1454 It always has the form (SYMBOL . VALUE)
1455 Note that if `forward' is non-nil, VALUE may be out of date.
1456 Also if the currently loaded binding is the default binding, then
1457 this is `eq'ual to defcell. */
1458 Lisp_Object valcell
;
1461 /* Like Lisp_Objfwd except that value lives in a slot in the
1463 struct Lisp_Kboard_Objfwd
1465 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1471 struct Lisp_Intfwd u_intfwd
;
1472 struct Lisp_Boolfwd u_boolfwd
;
1473 struct Lisp_Objfwd u_objfwd
;
1474 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1475 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1478 /* Lisp floating point type. */
1484 struct Lisp_Float
*chain
;
1488 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1489 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1491 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1492 representations, have infinities and NaNs, and do not trap on
1493 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1494 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1495 wanted here, but is not quite right because Emacs does not require
1496 all the features of C11 Annex F (and does not require C11 at all,
1497 for that matter). */
1498 #define IEEE_FLOATING_POINT (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
1499 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
1501 /* A character, declared with the following typedef, is a member
1502 of some character set associated with the current buffer. */
1503 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1505 typedef unsigned char UCHAR
;
1508 /* Meanings of slots in a Lisp_Compiled: */
1512 COMPILED_ARGLIST
= 0,
1513 COMPILED_BYTECODE
= 1,
1514 COMPILED_CONSTANTS
= 2,
1515 COMPILED_STACK_DEPTH
= 3,
1516 COMPILED_DOC_STRING
= 4,
1517 COMPILED_INTERACTIVE
= 5
1520 /* Flag bits in a character. These also get used in termhooks.h.
1521 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1522 (MUlti-Lingual Emacs) might need 22 bits for the character value
1523 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1526 CHAR_ALT
= 0x0400000,
1527 CHAR_SUPER
= 0x0800000,
1528 CHAR_HYPER
= 0x1000000,
1529 CHAR_SHIFT
= 0x2000000,
1530 CHAR_CTL
= 0x4000000,
1531 CHAR_META
= 0x8000000,
1533 CHAR_MODIFIER_MASK
=
1534 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1536 /* Actually, the current Emacs uses 22 bits for the character value
1544 /* The glyph datatype, used to represent characters on the display.
1545 It consists of a char code and a face id. */
1552 /* Return a glyph's character code. */
1553 #define GLYPH_CHAR(glyph) ((glyph).ch)
1555 /* Return a glyph's face ID. */
1556 #define GLYPH_FACE(glyph) ((glyph).face_id)
1558 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1559 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1560 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1562 /* Return 1 if GLYPH contains valid character code. */
1563 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1566 /* Glyph Code from a display vector may either be an integer which
1567 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1568 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1570 #define GLYPH_CODE_P(gc) \
1572 ? (CHARACTERP (XCAR (gc)) \
1573 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1574 : (RANGED_INTEGERP \
1576 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1577 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1578 : TYPE_MAXIMUM (EMACS_INT)))))
1580 /* The following are valid only if GLYPH_CODE_P (gc). */
1582 #define GLYPH_CODE_CHAR(gc) \
1583 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1585 #define GLYPH_CODE_FACE(gc) \
1586 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1588 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1592 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1594 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1595 (XINT (gc) >> CHARACTERBITS)); \
1599 /* Structure to hold mouse highlight data. This is here because other
1600 header files need it for defining struct x_output etc. */
1602 /* These variables describe the range of text currently shown in its
1603 mouse-face, together with the window they apply to. As long as
1604 the mouse stays within this range, we need not redraw anything on
1605 its account. Rows and columns are glyph matrix positions in
1606 MOUSE_FACE_WINDOW. */
1607 int mouse_face_beg_row
, mouse_face_beg_col
;
1608 int mouse_face_beg_x
, mouse_face_beg_y
;
1609 int mouse_face_end_row
, mouse_face_end_col
;
1610 int mouse_face_end_x
, mouse_face_end_y
;
1611 int mouse_face_past_end
;
1612 Lisp_Object mouse_face_window
;
1613 int mouse_face_face_id
;
1614 Lisp_Object mouse_face_overlay
;
1616 /* 1 if a mouse motion event came and we didn't handle it right away because
1617 gc was in progress. */
1618 int mouse_face_deferred_gc
;
1620 /* FRAME and X, Y position of mouse when last checked for
1621 highlighting. X and Y can be negative or out of range for the frame. */
1622 struct frame
*mouse_face_mouse_frame
;
1623 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1625 /* Nonzero means defer mouse-motion highlighting. */
1626 int mouse_face_defer
;
1628 /* Nonzero means that the mouse highlight should not be shown. */
1629 int mouse_face_hidden
;
1631 int mouse_face_image_state
;
1634 /* Data type checking. */
1636 #define NILP(x) EQ (x, Qnil)
1638 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1639 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1641 #define RANGED_INTEGERP(lo, x, hi) \
1642 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1643 #define TYPE_RANGED_INTEGERP(type, x) \
1644 (TYPE_SIGNED (type) \
1645 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1646 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1648 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1649 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1650 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1651 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1652 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1653 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1655 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1656 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1657 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1658 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1659 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1661 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1662 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1663 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1664 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1665 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1667 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1668 vectorlike_header * avoids aliasing issues. */
1669 #define PSEUDOVECTORP(x, code) \
1670 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1672 #define PSEUDOVECTOR_TYPEP(v, code) \
1673 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1674 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1676 /* True if object X, with internal type struct T *, is a pseudovector whose
1678 #define TYPED_PSEUDOVECTORP(x, t, code) \
1680 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1682 /* Test for specific pseudovector types. */
1683 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1684 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1685 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1686 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1687 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1688 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1689 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1690 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1691 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1692 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1693 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1694 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1696 /* Test for image (image . spec) */
1697 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1702 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1704 #define CHECK_LIST(x) \
1705 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1707 #define CHECK_LIST_CONS(x, y) \
1708 CHECK_TYPE (CONSP (x), Qlistp, y)
1710 #define CHECK_LIST_END(x, y) \
1711 CHECK_TYPE (NILP (x), Qlistp, y)
1713 #define CHECK_STRING(x) \
1714 CHECK_TYPE (STRINGP (x), Qstringp, x)
1716 #define CHECK_STRING_CAR(x) \
1717 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1719 #define CHECK_CONS(x) \
1720 CHECK_TYPE (CONSP (x), Qconsp, x)
1722 #define CHECK_SYMBOL(x) \
1723 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1725 #define CHECK_CHAR_TABLE(x) \
1726 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1728 #define CHECK_VECTOR(x) \
1729 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1731 #define CHECK_VECTOR_OR_STRING(x) \
1732 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1734 #define CHECK_ARRAY(x, Qxxxp) \
1735 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1737 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1738 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1740 #define CHECK_BUFFER(x) \
1741 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1743 #define CHECK_WINDOW(x) \
1744 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1746 #define CHECK_WINDOW_CONFIGURATION(x) \
1747 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1749 /* A window of any sort, leaf or interior, is "valid" if one of its
1750 buffer, vchild, or hchild members is non-nil. */
1751 #define CHECK_VALID_WINDOW(x) \
1752 CHECK_TYPE (WINDOWP (x) \
1753 && (!NILP (XWINDOW (x)->buffer) \
1754 || !NILP (XWINDOW (x)->vchild) \
1755 || !NILP (XWINDOW (x)->hchild)), \
1758 /* A window is "live" if and only if it shows a buffer. */
1759 #define CHECK_LIVE_WINDOW(x) \
1760 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), \
1763 #define CHECK_PROCESS(x) \
1764 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1766 #define CHECK_SUBR(x) \
1767 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1769 #define CHECK_NUMBER(x) \
1770 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1772 #define CHECK_NATNUM(x) \
1773 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1775 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1778 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1779 args_out_of_range_3 \
1781 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1782 ? MOST_NEGATIVE_FIXNUM \
1784 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1786 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1788 if (TYPE_SIGNED (type)) \
1789 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1791 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1794 #define CHECK_MARKER(x) \
1795 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1797 #define CHECK_NUMBER_COERCE_MARKER(x) \
1798 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1799 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1801 #define XFLOATINT(n) extract_float((n))
1803 #define CHECK_FLOAT(x) \
1804 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1806 #define CHECK_NUMBER_OR_FLOAT(x) \
1807 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1809 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1810 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1811 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1813 #define CHECK_OVERLAY(x) \
1814 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1816 /* Since we can't assign directly to the CAR or CDR fields of a cons
1817 cell, use these when checking that those fields contain numbers. */
1818 #define CHECK_NUMBER_CAR(x) \
1820 Lisp_Object tmp = XCAR (x); \
1821 CHECK_NUMBER (tmp); \
1822 XSETCAR ((x), tmp); \
1825 #define CHECK_NUMBER_CDR(x) \
1827 Lisp_Object tmp = XCDR (x); \
1828 CHECK_NUMBER (tmp); \
1829 XSETCDR ((x), tmp); \
1832 #define CHECK_NATNUM_CAR(x) \
1834 Lisp_Object tmp = XCAR (x); \
1835 CHECK_NATNUM (tmp); \
1836 XSETCAR ((x), tmp); \
1839 #define CHECK_NATNUM_CDR(x) \
1841 Lisp_Object tmp = XCDR (x); \
1842 CHECK_NATNUM (tmp); \
1843 XSETCDR ((x), tmp); \
1846 /* Define a built-in function for calling from Lisp.
1847 `lname' should be the name to give the function in Lisp,
1848 as a null-terminated C string.
1849 `fnname' should be the name of the function in C.
1850 By convention, it starts with F.
1851 `sname' should be the name for the C constant structure
1852 that records information on this function for internal use.
1853 By convention, it should be the same as `fnname' but with S instead of F.
1854 It's too bad that C macros can't compute this from `fnname'.
1855 `minargs' should be a number, the minimum number of arguments allowed.
1856 `maxargs' should be a number, the maximum number of arguments allowed,
1857 or else MANY or UNEVALLED.
1858 MANY means pass a vector of evaluated arguments,
1859 in the form of an integer number-of-arguments
1860 followed by the address of a vector of Lisp_Objects
1861 which contains the argument values.
1862 UNEVALLED means pass the list of unevaluated arguments
1863 `intspec' says how interactive arguments are to be fetched.
1864 If the string starts with a `(', `intspec' is evaluated and the resulting
1865 list is the list of arguments.
1866 If it's a string that doesn't start with `(', the value should follow
1867 the one of the doc string for `interactive'.
1868 A null string means call interactively with no arguments.
1869 `doc' is documentation for the user. */
1871 /* This version of DEFUN declares a function prototype with the right
1872 arguments, so we can catch errors with maxargs at compile-time. */
1874 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1875 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1876 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1877 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1878 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1879 { (Lisp_Object (__cdecl *)(void))fnname }, \
1880 minargs, maxargs, lname, intspec, 0}; \
1882 #else /* not _MSC_VER */
1883 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1884 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1885 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1886 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1887 { .a ## maxargs = fnname }, \
1888 minargs, maxargs, lname, intspec, 0}; \
1892 /* Note that the weird token-substitution semantics of ANSI C makes
1893 this work for MANY and UNEVALLED. */
1894 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1895 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1896 #define DEFUN_ARGS_0 (void)
1897 #define DEFUN_ARGS_1 (Lisp_Object)
1898 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1899 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1900 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1901 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1903 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1904 Lisp_Object, Lisp_Object)
1905 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1906 Lisp_Object, Lisp_Object, Lisp_Object)
1907 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1908 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1910 /* Non-zero if OBJ is a Lisp function. */
1911 #define FUNCTIONP(OBJ) functionp(OBJ)
1914 is how we define the symbol for function `name' at start-up time. */
1915 extern void defsubr (struct Lisp_Subr
*);
1923 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1924 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1925 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1926 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1927 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1929 /* Macros we use to define forwarded Lisp variables.
1930 These are used in the syms_of_FILENAME functions.
1932 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1933 lisp variable is actually a field in `struct emacs_globals'. The
1934 field's name begins with "f_", which is a convention enforced by
1935 these macros. Each such global has a corresponding #define in
1936 globals.h; the plain name should be used in the code.
1938 E.g., the global "cons_cells_consed" is declared as "int
1939 f_cons_cells_consed" in globals.h, but there is a define:
1941 #define cons_cells_consed globals.f_cons_cells_consed
1943 All C code uses the `cons_cells_consed' name. This is all done
1944 this way to support indirection for multi-threaded Emacs. */
1946 #define DEFVAR_LISP(lname, vname, doc) \
1948 static struct Lisp_Objfwd o_fwd; \
1949 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1951 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1953 static struct Lisp_Objfwd o_fwd; \
1954 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1956 #define DEFVAR_BOOL(lname, vname, doc) \
1958 static struct Lisp_Boolfwd b_fwd; \
1959 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1961 #define DEFVAR_INT(lname, vname, doc) \
1963 static struct Lisp_Intfwd i_fwd; \
1964 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1967 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1969 static struct Lisp_Objfwd o_fwd; \
1970 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1973 #define DEFVAR_KBOARD(lname, vname, doc) \
1975 static struct Lisp_Kboard_Objfwd ko_fwd; \
1976 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1979 /* Save and restore the instruction and environment pointers,
1980 without affecting the signal mask. */
1983 typedef jmp_buf sys_jmp_buf
;
1984 # define sys_setjmp(j) _setjmp (j)
1985 # define sys_longjmp(j, v) _longjmp (j, v)
1986 #elif defined HAVE_SIGSETJMP
1987 typedef sigjmp_buf sys_jmp_buf
;
1988 # define sys_setjmp(j) sigsetjmp (j, 0)
1989 # define sys_longjmp(j, v) siglongjmp (j, v)
1991 /* A platform that uses neither _longjmp nor siglongjmp; assume
1992 longjmp does not affect the sigmask. */
1993 typedef jmp_buf sys_jmp_buf
;
1994 # define sys_setjmp(j) setjmp (j)
1995 # define sys_longjmp(j, v) longjmp (j, v)
1999 /* Structure for recording Lisp call stack for backtrace purposes. */
2001 /* The special binding stack holds the outer values of variables while
2002 they are bound by a function application or a let form, stores the
2003 code to be executed for Lisp unwind-protect forms, and stores the C
2004 functions to be called for record_unwind_protect.
2006 If func is non-zero, undoing this binding applies func to old_value;
2007 This implements record_unwind_protect.
2009 Otherwise, the element is a variable binding.
2011 If the symbol field is a symbol, it is an ordinary variable binding.
2013 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2014 which means having bound a local value while CURRENT-BUFFER was active.
2015 If WHERE is nil this means we saw the default value when binding SYMBOL.
2016 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2017 value. Other values of WHERE mean an internal error. */
2019 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2023 Lisp_Object symbol
, old_value
;
2024 specbinding_func func
;
2025 Lisp_Object unused
; /* Dividing by 16 is faster than by 12. */
2028 extern struct specbinding
*specpdl
;
2029 extern struct specbinding
*specpdl_ptr
;
2030 extern ptrdiff_t specpdl_size
;
2032 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2034 /* Everything needed to describe an active condition case.
2036 Members are volatile if their values need to survive _longjmp when
2037 a 'struct handler' is a local variable. */
2040 /* The handler clauses and variable from the condition-case form. */
2041 /* For a handler set up in Lisp code, this is always a list.
2042 For an internal handler set up by internal_condition_case*,
2043 this can instead be the symbol t or `error'.
2044 t: handle all conditions.
2045 error: handle all conditions, and errors can run the debugger
2046 or display a backtrace. */
2047 Lisp_Object handler
;
2049 Lisp_Object
volatile var
;
2051 /* Fsignal stores here the condition-case clause that applies,
2052 and Fcondition_case thus knows which clause to run. */
2053 Lisp_Object
volatile chosen_clause
;
2055 /* Used to effect the longjump out to the handler. */
2056 struct catchtag
*tag
;
2058 /* The next enclosing handler. */
2059 struct handler
*next
;
2062 /* This structure helps implement the `catch' and `throw' control
2063 structure. A struct catchtag contains all the information needed
2064 to restore the state of the interpreter after a non-local jump.
2066 Handlers for error conditions (represented by `struct handler'
2067 structures) just point to a catch tag to do the cleanup required
2070 catchtag structures are chained together in the C calling stack;
2071 the `next' member points to the next outer catchtag.
2073 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2074 member is TAG, and then unbinds to it. The `val' member is used to
2075 hold VAL while the stack is unwound; `val' is returned as the value
2078 All the other members are concerned with restoring the interpreter
2081 Members are volatile if their values need to survive _longjmp when
2082 a 'struct catchtag' is a local variable. */
2086 Lisp_Object
volatile val
;
2087 struct catchtag
*volatile next
;
2088 struct gcpro
*gcpro
;
2090 struct backtrace
*backlist
;
2091 struct handler
*handlerlist
;
2092 EMACS_INT lisp_eval_depth
;
2093 ptrdiff_t volatile pdlcount
;
2094 int poll_suppress_count
;
2095 int interrupt_input_blocked
;
2096 struct byte_stack
*byte_stack
;
2099 extern Lisp_Object memory_signal_data
;
2101 /* An address near the bottom of the stack.
2102 Tells GC how to save a copy of the stack. */
2103 extern char *stack_bottom
;
2105 /* Check quit-flag and quit if it is non-nil.
2106 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2107 So the program needs to do QUIT at times when it is safe to quit.
2108 Every loop that might run for a long time or might not exit
2109 ought to do QUIT at least once, at a safe place.
2110 Unless that is impossible, of course.
2111 But it is very desirable to avoid creating loops where QUIT is impossible.
2113 Exception: if you set immediate_quit to nonzero,
2114 then the handler that responds to the C-g does the quit itself.
2115 This is a good thing to do around a loop that has no side effects
2116 and (in particular) cannot call arbitrary Lisp code.
2118 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2119 a request to exit Emacs when it is safe to do. */
2121 extern void process_pending_signals (void);
2122 extern int volatile pending_signals
;
2124 extern void process_quit_flag (void);
2127 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2128 process_quit_flag (); \
2129 else if (pending_signals) \
2130 process_pending_signals (); \
2134 /* Nonzero if ought to quit now. */
2136 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2138 extern Lisp_Object Vascii_downcase_table
;
2139 extern Lisp_Object Vascii_canon_table
;
2141 /* Structure for recording stack slots that need marking. */
2143 /* This is a chain of structures, each of which points at a Lisp_Object
2144 variable whose value should be marked in garbage collection.
2145 Normally every link of the chain is an automatic variable of a function,
2146 and its `val' points to some argument or local variable of the function.
2147 On exit to the function, the chain is set back to the value it had on entry.
2148 This way, no link remains in the chain when the stack frame containing the
2151 Every function that can call Feval must protect in this fashion all
2152 Lisp_Object variables whose contents will be used again. */
2154 extern struct gcpro
*gcprolist
;
2160 /* Address of first protected variable. */
2161 volatile Lisp_Object
*var
;
2163 /* Number of consecutive protected variables. */
2171 /* Values of GC_MARK_STACK during compilation:
2173 0 Use GCPRO as before
2174 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2175 2 Mark the stack, and check that everything GCPRO'd is
2177 3 Mark using GCPRO's, mark stack last, and count how many
2178 dead objects are kept alive. */
2181 #define GC_USE_GCPROS_AS_BEFORE 0
2182 #define GC_MAKE_GCPROS_NOOPS 1
2183 #define GC_MARK_STACK_CHECK_GCPROS 2
2184 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2186 #ifndef GC_MARK_STACK
2187 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2190 /* Whether we do the stack marking manually. */
2191 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2192 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2195 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2197 /* Do something silly with gcproN vars just so gcc shuts up. */
2198 /* You get warnings from MIPSPro... */
2200 #define GCPRO1(varname) ((void) gcpro1)
2201 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2202 #define GCPRO3(varname1, varname2, varname3) \
2203 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2204 #define GCPRO4(varname1, varname2, varname3, varname4) \
2205 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2206 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2207 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2208 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2209 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2211 #define UNGCPRO ((void) 0)
2213 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2217 #define GCPRO1(varname) \
2218 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2219 gcprolist = &gcpro1; }
2221 #define GCPRO2(varname1, varname2) \
2222 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2223 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2224 gcprolist = &gcpro2; }
2226 #define GCPRO3(varname1, varname2, varname3) \
2227 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2228 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2229 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2230 gcprolist = &gcpro3; }
2232 #define GCPRO4(varname1, varname2, varname3, varname4) \
2233 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2234 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2235 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2236 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2237 gcprolist = &gcpro4; }
2239 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2240 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2241 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2242 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2243 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2244 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2245 gcprolist = &gcpro5; }
2247 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2248 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2249 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2250 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2251 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2252 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2253 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2254 gcprolist = &gcpro6; }
2256 #define UNGCPRO (gcprolist = gcpro1.next)
2260 extern int gcpro_level
;
2262 #define GCPRO1(varname) \
2263 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2264 gcpro1.level = gcpro_level++; \
2265 gcprolist = &gcpro1; }
2267 #define GCPRO2(varname1, varname2) \
2268 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2269 gcpro1.level = gcpro_level; \
2270 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2271 gcpro2.level = gcpro_level++; \
2272 gcprolist = &gcpro2; }
2274 #define GCPRO3(varname1, varname2, varname3) \
2275 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2276 gcpro1.level = gcpro_level; \
2277 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2278 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2279 gcpro3.level = gcpro_level++; \
2280 gcprolist = &gcpro3; }
2282 #define GCPRO4(varname1, varname2, varname3, varname4) \
2283 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2284 gcpro1.level = gcpro_level; \
2285 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2286 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2287 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2288 gcpro4.level = gcpro_level++; \
2289 gcprolist = &gcpro4; }
2291 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
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 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2297 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2298 gcpro5.level = gcpro_level++; \
2299 gcprolist = &gcpro5; }
2301 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2302 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2303 gcpro1.level = gcpro_level; \
2304 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2305 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2306 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2307 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2308 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2309 gcpro6.level = gcpro_level++; \
2310 gcprolist = &gcpro6; }
2313 ((--gcpro_level != gcpro1.level) \
2314 ? (emacs_abort (), 0) \
2315 : ((gcprolist = gcpro1.next), 0))
2317 #endif /* DEBUG_GCPRO */
2318 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2321 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2322 #define RETURN_UNGCPRO(expr) \
2325 Lisp_Object ret_ungc_val; \
2326 ret_ungc_val = (expr); \
2328 return ret_ungc_val; \
2332 /* Call staticpro (&var) to protect static variable `var'. */
2334 void staticpro (Lisp_Object
*);
2336 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2337 meaning as in the DEFUN macro, and is used to construct a prototype. */
2338 /* We can use the same trick as in the DEFUN macro to generate the
2339 appropriate prototype. */
2340 #define EXFUN(fnname, maxargs) \
2341 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2343 /* Forward declarations for prototypes. */
2347 /* Simple access functions. */
2349 LISP_INLINE Lisp_Object
*
2350 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2352 return & XVECTOR (array
)->contents
[idx
];
2356 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2358 /* Like ASET, but also can be used in the garbage collector:
2359 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2360 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2361 XVECTOR (array
)->contents
[idx
] = val
;
2364 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2367 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2369 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2370 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2373 /* Functions to modify hash tables. */
2376 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2378 h
->key_and_value
= key_and_value
;
2382 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2384 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2388 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2390 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2394 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2400 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2402 gc_aset (h
->next
, idx
, val
);
2406 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2412 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2414 gc_aset (h
->hash
, idx
, val
);
2418 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2424 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2426 gc_aset (h
->index
, idx
, val
);
2429 /* Use these functions to set Lisp_Object
2430 or pointer slots of struct Lisp_Symbol. */
2433 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2435 XSYMBOL (sym
)->name
= name
;
2439 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2441 XSYMBOL (sym
)->function
= function
;
2445 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2447 XSYMBOL (sym
)->plist
= plist
;
2451 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2453 XSYMBOL (sym
)->next
= next
;
2456 /* Buffer-local (also frame-local) variable access functions. */
2459 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2461 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2466 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2468 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2472 LISP_INLINE Lisp_Object
2473 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2475 return XCDR (blv
->valcell
);
2479 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2481 XSETCDR (blv
->valcell
, val
);
2485 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2491 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2497 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2502 /* Set overlay's property list. */
2505 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2507 XOVERLAY (overlay
)->plist
= plist
;
2510 /* Get text properties of S. */
2512 LISP_INLINE INTERVAL
2513 string_intervals (Lisp_Object s
)
2515 return XSTRING (s
)->intervals
;
2518 /* Set text properties of S to I. */
2521 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2523 XSTRING (s
)->intervals
= i
;
2526 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2527 of setting slots directly. */
2530 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2532 XCHAR_TABLE (table
)->ascii
= val
;
2535 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2537 XCHAR_TABLE (table
)->defalt
= val
;
2540 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2542 XCHAR_TABLE (table
)->parent
= val
;
2545 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2547 XCHAR_TABLE (table
)->purpose
= val
;
2550 /* Set different slots in (sub)character tables. */
2553 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2555 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2556 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2560 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2562 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2563 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2567 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2569 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2572 /* Defined in data.c. */
2573 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2574 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2575 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2576 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2577 extern Lisp_Object Qinvalid_read_syntax
;
2578 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2579 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2580 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2581 extern Lisp_Object Qtext_read_only
;
2582 extern Lisp_Object Qinteractive_form
;
2583 extern Lisp_Object Qcircular_list
;
2584 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2585 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2586 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2587 extern Lisp_Object Qbuffer_or_string_p
;
2588 extern Lisp_Object Qfboundp
;
2589 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2591 extern Lisp_Object Qcdr
;
2593 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2595 extern Lisp_Object Qfloatp
;
2596 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2598 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2600 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2602 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2604 /* Defined in frame.c. */
2605 extern Lisp_Object Qframep
;
2607 /* Defined in data.c. */
2608 extern Lisp_Object
indirect_function (Lisp_Object
);
2609 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2611 /* Convert the integer I to an Emacs representation, either the integer
2612 itself, or a cons of two or three integers, or if all else fails a float.
2613 I should not have side effects. */
2614 #define INTEGER_TO_CONS(i) \
2615 (! FIXNUM_OVERFLOW_P (i) \
2617 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2618 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2619 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2620 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2621 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2622 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2623 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2624 ? Fcons (make_number ((i) >> 16 >> 24), \
2625 Fcons (make_number ((i) >> 16 & 0xffffff), \
2626 make_number ((i) & 0xffff))) \
2629 /* Convert the Emacs representation CONS back to an integer of type
2630 TYPE, storing the result the variable VAR. Signal an error if CONS
2631 is not a valid representation or is out of range for TYPE. */
2632 #define CONS_TO_INTEGER(cons, type, var) \
2633 (TYPE_SIGNED (type) \
2634 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2635 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2636 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2637 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2639 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2640 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2641 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2643 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2644 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2645 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2646 extern void syms_of_data (void);
2647 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2649 /* Defined in cmds.c */
2650 extern void syms_of_cmds (void);
2651 extern void keys_of_cmds (void);
2653 /* Defined in coding.c. */
2654 extern Lisp_Object Qcharset
;
2655 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2656 ptrdiff_t, bool, bool, Lisp_Object
);
2657 extern void init_coding (void);
2658 extern void init_coding_once (void);
2659 extern void syms_of_coding (void);
2661 /* Defined in character.c. */
2662 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2663 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2664 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2665 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2666 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2667 extern void syms_of_character (void);
2669 /* Defined in charset.c. */
2670 extern void init_charset (void);
2671 extern void init_charset_once (void);
2672 extern void syms_of_charset (void);
2673 /* Structure forward declarations. */
2676 /* Defined in composite.c. */
2677 extern void syms_of_composite (void);
2679 /* Defined in syntax.c. */
2680 extern void init_syntax_once (void);
2681 extern void syms_of_syntax (void);
2683 /* Defined in fns.c. */
2684 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2685 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2686 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2687 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2688 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2689 extern void sweep_weak_hash_tables (void);
2690 extern Lisp_Object Qcursor_in_echo_area
;
2691 extern Lisp_Object Qstring_lessp
;
2692 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2693 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2694 EMACS_UINT
sxhash (Lisp_Object
, int);
2695 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2696 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2698 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2699 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2702 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2703 ptrdiff_t, ptrdiff_t);
2704 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2705 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2706 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2707 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2708 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2709 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2710 extern void clear_string_char_byte_cache (void);
2711 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2712 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2713 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2714 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2715 extern void syms_of_fns (void);
2717 /* Defined in floatfns.c. */
2718 extern double extract_float (Lisp_Object
);
2719 extern void syms_of_floatfns (void);
2720 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2722 /* Defined in fringe.c. */
2723 extern void syms_of_fringe (void);
2724 extern void init_fringe (void);
2725 #ifdef HAVE_WINDOW_SYSTEM
2726 extern void mark_fringe_data (void);
2727 extern void init_fringe_once (void);
2728 #endif /* HAVE_WINDOW_SYSTEM */
2730 /* Defined in image.c. */
2731 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2732 extern Lisp_Object QCconversion
;
2733 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2734 extern void syms_of_image (void);
2736 /* Defined in insdel.c. */
2737 extern Lisp_Object Qinhibit_modification_hooks
;
2738 extern void move_gap (ptrdiff_t);
2739 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2740 extern _Noreturn
void buffer_overflow (void);
2741 extern void make_gap (ptrdiff_t);
2742 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2743 ptrdiff_t, bool, bool);
2744 extern int count_combining_before (const unsigned char *,
2745 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2746 extern int count_combining_after (const unsigned char *,
2747 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2748 extern void insert (const char *, ptrdiff_t);
2749 extern void insert_and_inherit (const char *, ptrdiff_t);
2750 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2751 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2753 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2754 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2755 ptrdiff_t, ptrdiff_t, bool);
2756 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2757 extern void insert_char (int);
2758 extern void insert_string (const char *);
2759 extern void insert_before_markers (const char *, ptrdiff_t);
2760 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2761 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2762 ptrdiff_t, ptrdiff_t,
2764 extern void del_range (ptrdiff_t, ptrdiff_t);
2765 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2766 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2767 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2768 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2769 ptrdiff_t, ptrdiff_t, bool);
2770 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2771 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2772 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2773 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2774 ptrdiff_t, ptrdiff_t);
2775 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2776 ptrdiff_t, ptrdiff_t);
2777 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2778 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2779 const char *, ptrdiff_t, ptrdiff_t, bool);
2780 extern void syms_of_insdel (void);
2782 /* Defined in dispnew.c. */
2783 #if (defined PROFILING \
2784 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2785 _Noreturn
void __executable_start (void);
2787 extern Lisp_Object selected_frame
;
2788 extern Lisp_Object Vwindow_system
;
2789 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2790 extern void init_display (void);
2791 extern void syms_of_display (void);
2793 /* Defined in xdisp.c. */
2794 extern Lisp_Object Qinhibit_point_motion_hooks
;
2795 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2796 extern Lisp_Object Qmenu_bar_update_hook
;
2797 extern Lisp_Object Qwindow_scroll_functions
;
2798 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2799 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2800 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2801 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2802 extern Lisp_Object Qleft_margin
, Qright_margin
;
2803 extern Lisp_Object Qglyphless_char
;
2804 extern Lisp_Object QCdata
, QCfile
;
2805 extern Lisp_Object QCmap
;
2806 extern Lisp_Object Qrisky_local_variable
;
2807 extern struct frame
*last_glyphless_glyph_frame
;
2808 extern int last_glyphless_glyph_face_id
;
2809 extern int last_glyphless_glyph_merged_face_id
;
2810 extern int noninteractive_need_newline
;
2811 extern Lisp_Object echo_area_buffer
[2];
2812 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2813 extern void check_message_stack (void);
2814 extern void setup_echo_area_for_printing (int);
2815 extern bool push_message (void);
2816 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2817 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2818 extern void restore_message (void);
2819 extern Lisp_Object
current_message (void);
2820 extern void clear_message (int, int);
2821 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2822 extern void message1 (const char *);
2823 extern void message1_nolog (const char *);
2824 extern void message2 (const char *, ptrdiff_t, int);
2825 extern void message2_nolog (const char *, ptrdiff_t, int);
2826 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2827 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2828 extern void message_dolog (const char *, ptrdiff_t, int, int);
2829 extern void message_with_string (const char *, Lisp_Object
, int);
2830 extern void message_log_maybe_newline (void);
2831 extern void update_echo_area (void);
2832 extern void truncate_echo_area (ptrdiff_t);
2833 extern void redisplay (void);
2834 extern void redisplay_preserve_echo_area (int);
2835 extern void prepare_menu_bars (void);
2837 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2838 extern void syms_of_xdisp (void);
2839 extern void init_xdisp (void);
2840 extern Lisp_Object
safe_eval (Lisp_Object
);
2841 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2842 int *, int *, int *, int *, int *);
2844 /* Defined in xsettings.c. */
2845 extern void syms_of_xsettings (void);
2847 /* Defined in vm-limit.c. */
2848 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2850 /* Defined in alloc.c. */
2851 extern void check_pure_size (void);
2852 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2853 extern void malloc_warning (const char *);
2854 extern _Noreturn
void memory_full (size_t);
2855 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2856 extern bool survives_gc_p (Lisp_Object
);
2857 extern void mark_object (Lisp_Object
);
2858 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2859 extern void refill_memory_reserve (void);
2861 extern const char *pending_malloc_warning
;
2862 extern Lisp_Object zero_vector
;
2863 extern Lisp_Object
*stack_base
;
2864 extern EMACS_INT consing_since_gc
;
2865 extern EMACS_INT gc_relative_threshold
;
2866 extern EMACS_INT memory_full_cons_threshold
;
2867 extern Lisp_Object
list1 (Lisp_Object
);
2868 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2869 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2870 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2871 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2873 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2874 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2875 extern _Noreturn
void string_overflow (void);
2876 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2877 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2878 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2879 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2881 /* Make unibyte string from C string when the length isn't known. */
2883 LISP_INLINE Lisp_Object
2884 build_unibyte_string (const char *str
)
2886 return make_unibyte_string (str
, strlen (str
));
2889 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2890 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2891 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2892 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2893 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2894 extern Lisp_Object
make_specified_string (const char *,
2895 ptrdiff_t, ptrdiff_t, bool);
2896 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2897 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2899 /* Make a string allocated in pure space, use STR as string data. */
2901 LISP_INLINE Lisp_Object
2902 build_pure_c_string (const char *str
)
2904 return make_pure_c_string (str
, strlen (str
));
2907 /* Make a string from the data at STR, treating it as multibyte if the
2910 LISP_INLINE Lisp_Object
2911 build_string (const char *str
)
2913 return make_string (str
, strlen (str
));
2916 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2917 extern void make_byte_code (struct Lisp_Vector
*);
2918 extern Lisp_Object Qchar_table_extra_slots
;
2919 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2920 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2921 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2923 allocate_pseudovector \
2924 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2925 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2926 extern struct window
*allocate_window (void);
2927 extern struct frame
*allocate_frame (void);
2928 extern struct Lisp_Process
*allocate_process (void);
2929 extern struct terminal
*allocate_terminal (void);
2930 extern bool gc_in_progress
;
2931 extern bool abort_on_gc
;
2932 extern Lisp_Object
make_float (double);
2933 extern void display_malloc_warning (void);
2934 extern ptrdiff_t inhibit_garbage_collection (void);
2935 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2936 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2937 extern void free_marker (Lisp_Object
);
2938 extern void free_cons (struct Lisp_Cons
*);
2939 extern void init_alloc_once (void);
2940 extern void init_alloc (void);
2941 extern void syms_of_alloc (void);
2942 extern struct buffer
* allocate_buffer (void);
2943 extern int valid_lisp_object_p (Lisp_Object
);
2944 #ifdef GC_CHECK_CONS_LIST
2945 extern void check_cons_list (void);
2947 #define check_cons_list() ((void) 0)
2951 /* Defined in ralloc.c. */
2952 extern void *r_alloc (void **, size_t);
2953 extern void r_alloc_free (void **);
2954 extern void *r_re_alloc (void **, size_t);
2955 extern void r_alloc_reset_variable (void **, void **);
2956 extern void r_alloc_inhibit_buffer_relocation (int);
2959 /* Defined in chartab.c. */
2960 extern Lisp_Object
copy_char_table (Lisp_Object
);
2961 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2962 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2964 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
2965 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
2966 extern int char_table_translate (Lisp_Object
, int);
2967 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2969 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2970 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2971 Lisp_Object
, Lisp_Object
,
2972 Lisp_Object
, struct charset
*,
2973 unsigned, unsigned);
2974 extern Lisp_Object
uniprop_table (Lisp_Object
);
2975 extern void syms_of_chartab (void);
2977 /* Defined in print.c. */
2978 extern Lisp_Object Vprin1_to_string_buffer
;
2979 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2980 extern Lisp_Object Qstandard_output
;
2981 extern Lisp_Object Qexternal_debugging_output
;
2982 extern void temp_output_buffer_setup (const char *);
2983 extern int print_level
;
2984 extern Lisp_Object Qprint_escape_newlines
;
2985 extern void write_string (const char *, int);
2986 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2988 extern Lisp_Object internal_with_output_to_temp_buffer
2989 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2990 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
2991 extern int float_to_string (char *, double);
2992 extern void syms_of_print (void);
2994 /* Defined in doprnt.c. */
2995 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2997 extern ptrdiff_t esprintf (char *, char const *, ...)
2998 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2999 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3001 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3002 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3003 char const *, va_list)
3004 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3006 /* Defined in lread.c. */
3007 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3008 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3009 extern Lisp_Object Qlexical_binding
;
3010 extern Lisp_Object
check_obarray (Lisp_Object
);
3011 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3012 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3013 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3014 #define LOADHIST_ATTACH(x) \
3016 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3018 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3019 Lisp_Object
*, Lisp_Object
);
3020 Lisp_Object
string_to_number (char const *, int, int);
3021 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3023 extern void dir_warning (const char *, Lisp_Object
);
3024 extern void close_load_descs (void);
3025 extern void init_obarray (void);
3026 extern void init_lread (void);
3027 extern void syms_of_lread (void);
3029 LISP_INLINE Lisp_Object
3030 intern (const char *str
)
3032 return intern_1 (str
, strlen (str
));
3035 LISP_INLINE Lisp_Object
3036 intern_c_string (const char *str
)
3038 return intern_c_string_1 (str
, strlen (str
));
3041 /* Defined in eval.c. */
3042 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3043 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3044 extern Lisp_Object Qand_rest
;
3045 extern Lisp_Object Vautoload_queue
;
3046 extern Lisp_Object Vsignaling_function
;
3047 extern Lisp_Object inhibit_lisp_code
;
3049 extern struct catchtag
*catchlist
;
3050 extern struct handler
*handlerlist
;
3052 /* To run a normal hook, use the appropriate function from the list below.
3053 The calling convention:
3055 if (!NILP (Vrun_hooks))
3056 call1 (Vrun_hooks, Qmy_funny_hook);
3058 should no longer be used. */
3059 extern Lisp_Object Vrun_hooks
;
3060 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3061 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3062 Lisp_Object (*funcall
)
3063 (ptrdiff_t nargs
, Lisp_Object
*args
));
3064 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3065 extern _Noreturn
void xsignal0 (Lisp_Object
);
3066 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3067 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3068 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3070 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3071 extern Lisp_Object
eval_sub (Lisp_Object form
);
3072 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3073 extern Lisp_Object
call0 (Lisp_Object
);
3074 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3075 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3076 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3077 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3078 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3079 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3080 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3081 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3082 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3083 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3084 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3085 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3086 extern Lisp_Object internal_condition_case_n
3087 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3088 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3089 extern void specbind (Lisp_Object
, Lisp_Object
);
3090 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3091 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3092 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3093 extern _Noreturn
void verror (const char *, va_list)
3094 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3095 extern Lisp_Object
un_autoload (Lisp_Object
);
3096 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3097 extern void init_eval_once (void);
3098 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3099 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3100 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3101 extern void init_eval (void);
3103 extern void mark_backtrace (void);
3105 extern void syms_of_eval (void);
3107 /* Defined in editfns.c. */
3108 extern Lisp_Object Qfield
;
3109 extern void insert1 (Lisp_Object
);
3110 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3111 extern Lisp_Object
save_excursion_save (void);
3112 extern Lisp_Object
save_restriction_save (void);
3113 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3114 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3115 extern _Noreturn
void time_overflow (void);
3116 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3117 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3119 extern void init_editfns (void);
3120 const char *get_system_name (void);
3121 extern void syms_of_editfns (void);
3122 extern void set_time_zone_rule (const char *);
3124 /* Defined in buffer.c. */
3125 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3126 extern _Noreturn
void nsberror (Lisp_Object
);
3127 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3128 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3129 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3130 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3131 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3132 extern bool overlay_touches_p (ptrdiff_t);
3133 extern Lisp_Object Vbuffer_alist
;
3134 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3135 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3136 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3137 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3138 extern void init_buffer_once (void);
3139 extern void init_buffer (void);
3140 extern void syms_of_buffer (void);
3141 extern void keys_of_buffer (void);
3143 /* Defined in marker.c. */
3145 extern ptrdiff_t marker_position (Lisp_Object
);
3146 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3147 extern void clear_charpos_cache (struct buffer
*);
3148 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3149 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3150 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3151 extern void unchain_marker (struct Lisp_Marker
*marker
);
3152 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3153 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3154 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3155 ptrdiff_t, ptrdiff_t);
3156 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3157 extern void syms_of_marker (void);
3159 /* Defined in fileio.c. */
3161 extern Lisp_Object Qfile_error
;
3162 extern Lisp_Object Qfile_exists_p
;
3163 extern Lisp_Object Qfile_directory_p
;
3164 extern Lisp_Object Qinsert_file_contents
;
3165 extern Lisp_Object Qfile_name_history
;
3166 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3167 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3168 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3169 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3170 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3171 extern void internal_delete_file (Lisp_Object
);
3172 extern void syms_of_fileio (void);
3173 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3174 extern Lisp_Object Qdelete_file
;
3176 /* Defined in search.c. */
3177 extern void shrink_regexp_cache (void);
3178 extern void restore_search_regs (void);
3179 extern void record_unwind_save_match_data (void);
3180 struct re_registers
;
3181 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3182 struct re_registers
*,
3183 Lisp_Object
, int, int);
3184 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3185 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3187 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3188 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3189 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3190 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3192 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3194 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3195 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3196 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3197 extern void syms_of_search (void);
3198 extern void clear_regexp_cache (void);
3200 /* Defined in minibuf.c. */
3202 extern Lisp_Object Qcompletion_ignore_case
;
3203 extern Lisp_Object Vminibuffer_list
;
3204 extern Lisp_Object last_minibuf_string
;
3205 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3206 extern void init_minibuf_once (void);
3207 extern void syms_of_minibuf (void);
3209 /* Defined in callint.c. */
3211 extern Lisp_Object Qminus
, Qplus
;
3212 extern Lisp_Object Qwhen
;
3213 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3214 extern void syms_of_callint (void);
3216 /* Defined in casefiddle.c. */
3218 extern Lisp_Object Qidentity
;
3219 extern void syms_of_casefiddle (void);
3220 extern void keys_of_casefiddle (void);
3222 /* Defined in casetab.c. */
3224 extern void init_casetab_once (void);
3225 extern void syms_of_casetab (void);
3227 /* Defined in keyboard.c. */
3229 extern Lisp_Object echo_message_buffer
;
3230 extern struct kboard
*echo_kboard
;
3231 extern void cancel_echoing (void);
3232 extern Lisp_Object Qdisabled
, QCfilter
;
3233 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3234 extern Lisp_Object Qtop
;
3235 extern Lisp_Object last_undo_boundary
;
3236 extern int input_pending
;
3237 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3238 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3239 extern void discard_mouse_events (void);
3241 void handle_input_available_signal (int);
3243 extern Lisp_Object pending_funcalls
;
3244 extern int detect_input_pending (void);
3245 extern int detect_input_pending_ignore_squeezables (void);
3246 extern int detect_input_pending_run_timers (int);
3247 extern void safe_run_hooks (Lisp_Object
);
3248 extern void cmd_error_internal (Lisp_Object
, const char *);
3249 extern Lisp_Object
command_loop_1 (void);
3250 extern Lisp_Object
recursive_edit_1 (void);
3251 extern void record_auto_save (void);
3252 extern void force_auto_save_soon (void);
3253 extern void init_keyboard (void);
3254 extern void syms_of_keyboard (void);
3255 extern void keys_of_keyboard (void);
3257 /* Defined in indent.c. */
3258 extern ptrdiff_t current_column (void);
3259 extern void invalidate_current_column (void);
3260 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3261 extern void syms_of_indent (void);
3263 /* Defined in frame.c. */
3264 extern Lisp_Object Qonly
, Qnone
;
3265 extern Lisp_Object Qvisible
;
3266 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3267 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3268 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3270 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3272 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3273 extern void frames_discard_buffer (Lisp_Object
);
3274 extern void syms_of_frame (void);
3276 /* Defined in emacs.c. */
3277 extern char **initial_argv
;
3278 extern int initial_argc
;
3279 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3280 extern bool display_arg
;
3282 extern Lisp_Object
decode_env_path (const char *, const char *);
3283 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3284 extern Lisp_Object Qfile_name_handler_alist
;
3285 extern _Noreturn
void terminate_due_to_signal (int, int);
3286 extern Lisp_Object Qkill_emacs
;
3288 void fixup_locale (void);
3289 void synchronize_system_messages_locale (void);
3290 void synchronize_system_time_locale (void);
3292 #define setlocale(category, locale)
3293 #define fixup_locale()
3294 #define synchronize_system_messages_locale()
3295 #define synchronize_system_time_locale()
3297 extern void shut_down_emacs (int, Lisp_Object
);
3299 /* True means don't do interactive redisplay and don't change tty modes. */
3300 extern bool noninteractive
;
3302 /* True means remove site-lisp directories from load-path. */
3303 extern bool no_site_lisp
;
3305 /* Pipe used to send exit notification to the daemon parent at
3307 extern int daemon_pipe
[2];
3308 #define IS_DAEMON (daemon_pipe[1] != 0)
3310 /* True if handling a fatal error already. */
3311 extern bool fatal_error_in_progress
;
3313 /* True means don't do use window-system-specific display code. */
3314 extern bool inhibit_window_system
;
3315 /* True means that a filter or a sentinel is running. */
3316 extern bool running_asynch_code
;
3318 /* Defined in process.c. */
3319 extern Lisp_Object QCtype
, Qlocal
;
3320 extern Lisp_Object Qprocessp
;
3321 extern void kill_buffer_processes (Lisp_Object
);
3322 extern int wait_reading_process_output (intmax_t, int, int, int,
3324 struct Lisp_Process
*,
3326 /* Max value for the first argument of wait_reading_process_output. */
3327 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3328 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3329 The bug merely causes a bogus warning, but the warning is annoying. */
3330 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3332 # define WAIT_READING_MAX INTMAX_MAX
3334 extern void add_keyboard_wait_descriptor (int);
3335 extern void delete_keyboard_wait_descriptor (int);
3337 extern void add_gpm_wait_descriptor (int);
3338 extern void delete_gpm_wait_descriptor (int);
3340 extern void close_process_descs (void);
3341 extern void init_process_emacs (void);
3342 extern void syms_of_process (void);
3343 extern void setup_process_coding_systems (Lisp_Object
);
3348 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3349 extern void init_callproc_1 (void);
3350 extern void init_callproc (void);
3351 extern void set_initial_environment (void);
3352 extern void syms_of_callproc (void);
3354 /* Defined in doc.c. */
3355 extern Lisp_Object Qfunction_documentation
;
3356 extern Lisp_Object
read_doc_string (Lisp_Object
);
3357 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3358 extern void syms_of_doc (void);
3359 extern int read_bytecode_char (bool);
3361 /* Defined in bytecode.c. */
3362 extern Lisp_Object Qbytecode
;
3363 extern void syms_of_bytecode (void);
3364 extern struct byte_stack
*byte_stack_list
;
3366 extern void mark_byte_stack (void);
3368 extern void unmark_byte_stack (void);
3369 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3370 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3372 /* Defined in macros.c. */
3373 extern Lisp_Object Qexecute_kbd_macro
;
3374 extern void init_macros (void);
3375 extern void syms_of_macros (void);
3377 /* Defined in undo.c. */
3378 extern Lisp_Object Qapply
;
3379 extern Lisp_Object Qinhibit_read_only
;
3380 extern void truncate_undo_list (struct buffer
*);
3381 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3382 extern void record_insert (ptrdiff_t, ptrdiff_t);
3383 extern void record_delete (ptrdiff_t, Lisp_Object
);
3384 extern void record_first_change (void);
3385 extern void record_change (ptrdiff_t, ptrdiff_t);
3386 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3387 Lisp_Object
, Lisp_Object
,
3389 extern void syms_of_undo (void);
3390 /* Defined in textprop.c. */
3391 extern Lisp_Object Qfont
, Qmouse_face
;
3392 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3393 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3394 extern Lisp_Object Qminibuffer_prompt
;
3396 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3398 /* Defined in menu.c. */
3399 extern void syms_of_menu (void);
3401 /* Defined in xmenu.c. */
3402 extern void syms_of_xmenu (void);
3404 /* Defined in termchar.h. */
3405 struct tty_display_info
;
3407 /* Defined in termhooks.h. */
3410 /* Defined in sysdep.c. */
3411 #ifndef HAVE_GET_CURRENT_DIR_NAME
3412 extern char *get_current_dir_name (void);
3414 extern void stuff_char (char c
);
3415 extern void init_sigio (int);
3416 extern void sys_subshell (void);
3417 extern void sys_suspend (void);
3418 extern void discard_tty_input (void);
3419 extern void init_sys_modes (struct tty_display_info
*);
3420 extern void reset_sys_modes (struct tty_display_info
*);
3421 extern void init_all_sys_modes (void);
3422 extern void reset_all_sys_modes (void);
3423 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3424 extern void child_setup_tty (int);
3425 extern void setup_pty (int);
3426 extern int set_window_size (int, int, int);
3427 extern EMACS_INT
get_random (void);
3428 extern void seed_random (void *, ptrdiff_t);
3429 extern void init_random (void);
3430 extern void emacs_backtrace (int);
3431 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3432 extern int emacs_open (const char *, int, int);
3433 extern int emacs_close (int);
3434 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3435 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3436 enum { READLINK_BUFSIZE
= 1024 };
3437 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3439 extern void unlock_all_files (void);
3440 extern void lock_file (Lisp_Object
);
3441 extern void unlock_file (Lisp_Object
);
3442 extern void unlock_buffer (struct buffer
*);
3443 extern void syms_of_filelock (void);
3445 /* Defined in sound.c. */
3446 extern void syms_of_sound (void);
3448 /* Defined in category.c. */
3449 extern void init_category_once (void);
3450 extern Lisp_Object
char_category_set (int);
3451 extern void syms_of_category (void);
3453 /* Defined in ccl.c. */
3454 extern void syms_of_ccl (void);
3456 /* Defined in dired.c. */
3457 extern void syms_of_dired (void);
3458 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3459 Lisp_Object
, Lisp_Object
,
3462 /* Defined in term.c. */
3463 extern int *char_ins_del_vector
;
3464 extern void syms_of_term (void);
3465 extern _Noreturn
void fatal (const char *msgid
, ...)
3466 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3468 /* Defined in terminal.c. */
3469 extern void syms_of_terminal (void);
3471 /* Defined in font.c. */
3472 extern void syms_of_font (void);
3473 extern void init_font (void);
3475 #ifdef HAVE_WINDOW_SYSTEM
3476 /* Defined in fontset.c. */
3477 extern void syms_of_fontset (void);
3479 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3480 extern Lisp_Object Qfont_param
;
3483 /* Defined in xfaces.c. */
3484 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3485 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3486 extern Lisp_Object Qmode_line_inactive
;
3487 extern Lisp_Object Qface
;
3488 extern Lisp_Object Qnormal
;
3489 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3490 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3491 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3492 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3493 extern Lisp_Object Qoblique
, Qitalic
;
3494 extern Lisp_Object Vface_alternative_font_family_alist
;
3495 extern Lisp_Object Vface_alternative_font_registry_alist
;
3496 extern void syms_of_xfaces (void);
3498 #ifdef HAVE_X_WINDOWS
3499 /* Defined in xfns.c. */
3500 extern void syms_of_xfns (void);
3502 /* Defined in xsmfns.c. */
3503 extern void syms_of_xsmfns (void);
3505 /* Defined in xselect.c. */
3506 extern void syms_of_xselect (void);
3508 /* Defined in xterm.c. */
3509 extern void syms_of_xterm (void);
3510 #endif /* HAVE_X_WINDOWS */
3512 #ifdef HAVE_WINDOW_SYSTEM
3513 /* Defined in xterm.c, nsterm.m, w32term.c. */
3514 extern char *x_get_keysym_name (int);
3515 #endif /* HAVE_WINDOW_SYSTEM */
3518 /* Defined in xml.c. */
3519 extern void syms_of_xml (void);
3520 extern void xml_cleanup_parser (void);
3524 /* Defined in (x|w32)fns.c, nsfns.m... */
3525 extern int have_menus_p (void);
3529 /* Defined in dbusbind.c. */
3530 void syms_of_dbusbind (void);
3534 /* Defined in msdos.c, w32.c. */
3535 extern char *emacs_root_dir (void);
3538 /* True means Emacs has already been initialized.
3539 Used during startup to detect startup of dumped Emacs. */
3540 extern bool initialized
;
3542 extern int immediate_quit
; /* Nonzero means ^G can quit instantly. */
3544 extern void *xmalloc (size_t);
3545 extern void *xzalloc (size_t);
3546 extern void *xrealloc (void *, size_t);
3547 extern void xfree (void *);
3548 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3549 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3550 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3552 extern char *xstrdup (const char *);
3554 extern char *egetenv (const char *);
3556 /* Set up the name of the machine we're running on. */
3557 extern void init_system_name (void);
3559 /* We used to use `abs', but that clashes with system headers on some
3560 platforms, and using a name reserved by Standard C is a bad idea
3563 #define eabs(x) ((x) < 0 ? -(x) : (x))
3566 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3569 #define make_fixnum_or_float(val) \
3570 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3572 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3573 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3575 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3577 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3578 extern void *record_xmalloc (size_t);
3580 #define USE_SAFE_ALLOCA \
3581 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3583 /* SAFE_ALLOCA allocates a simple buffer. */
3585 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3587 : (sa_must_free = 1, record_xmalloc (size)))
3589 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3590 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3591 positive. The code is tuned for MULTIPLIER being a constant. */
3593 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3595 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3596 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3599 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3601 record_unwind_protect (safe_alloca_unwind, \
3602 make_save_value (buf, 0)); \
3606 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3608 #define SAFE_FREE() \
3610 if (sa_must_free) { \
3612 unbind_to (sa_count, Qnil); \
3617 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3619 #define SAFE_ALLOCA_LISP(buf, nelt) \
3621 if ((nelt) < MAX_ALLOCA / word_size) \
3622 buf = alloca ((nelt) * word_size); \
3623 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3626 buf = xmalloc ((nelt) * word_size); \
3627 arg_ = make_save_value (buf, nelt); \
3628 XSAVE_VALUE (arg_)->dogc = 1; \
3630 record_unwind_protect (safe_alloca_unwind, arg_); \
3633 memory_full (SIZE_MAX); \
3637 #include "globals.h"
3639 /* Check whether it's time for GC, and run it if so. */
3644 if ((consing_since_gc
> gc_cons_threshold
3645 && consing_since_gc
> gc_relative_threshold
)
3646 || (!NILP (Vmemory_full
)
3647 && consing_since_gc
> memory_full_cons_threshold
))
3648 Fgarbage_collect ();
3652 functionp (Lisp_Object object
)
3654 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3656 object
= Findirect_function (object
, Qt
);
3658 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3660 /* Autoloaded symbols are functions, except if they load
3661 macros or keymaps. */
3663 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3664 object
= XCDR (object
);
3666 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3671 return XSUBR (object
)->max_args
!= UNEVALLED
;
3672 else if (COMPILEDP (object
))
3674 else if (CONSP (object
))
3676 Lisp_Object car
= XCAR (object
);
3677 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3685 #endif /* EMACS_LISP_H */