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/>. */
34 # define LISP_INLINE INLINE
37 /* The ubiquitous max and min macros. */
40 #define max(a, b) ((a) > (b) ? (a) : (b))
41 #define min(a, b) ((a) < (b) ? (a) : (b))
43 /* EMACS_INT - signed integer wide enough to hold an Emacs value
44 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
45 pI - printf length modifier for EMACS_INT
46 EMACS_UINT - unsigned variant of EMACS_INT */
48 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
49 typedef long long int EMACS_INT
;
50 typedef unsigned long long int EMACS_UINT
;
51 # define EMACS_INT_MAX LLONG_MAX
53 # elif INT_MAX < LONG_MAX
54 typedef long int EMACS_INT
;
55 typedef unsigned long int EMACS_UINT
;
56 # define EMACS_INT_MAX LONG_MAX
59 typedef int EMACS_INT
;
60 typedef unsigned int EMACS_UINT
;
61 # define EMACS_INT_MAX INT_MAX
66 /* Number of bits in some machine integer types. */
69 BITS_PER_CHAR
= CHAR_BIT
,
70 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
71 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
72 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
73 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
76 /* printmax_t and uprintmax_t are types for printing large integers.
77 These are the widest integers that are supported for printing.
78 pMd etc. are conversions for printing them.
79 On C99 hosts, there's no problem, as even the widest integers work.
80 Fall back on EMACS_INT on pre-C99 hosts. */
82 typedef intmax_t printmax_t
;
83 typedef uintmax_t uprintmax_t
;
87 typedef EMACS_INT printmax_t
;
88 typedef EMACS_UINT uprintmax_t
;
93 /* Use pD to format ptrdiff_t values, which suffice for indexes into
94 buffers and strings. Emacs never allocates objects larger than
95 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
96 In C99, pD can always be "t"; configure it here for the sake of
97 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
98 #if PTRDIFF_MAX == INT_MAX
100 #elif PTRDIFF_MAX == LONG_MAX
102 #elif PTRDIFF_MAX == LLONG_MAX
108 /* Extra internal type checking? */
110 /* Define an Emacs version of 'assert (COND)', since some
111 system-defined 'assert's are flaky. COND should be free of side
112 effects; it may or may not be evaluated. */
113 #ifndef ENABLE_CHECKING
114 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
115 #else /* ENABLE_CHECKING */
117 extern _Noreturn
void die (const char *, const char *, int);
119 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
120 it to 1 using a debugger to temporarily disable aborting on
121 detected internal inconsistencies or error conditions.
123 In some cases, a good compiler may be able to optimize away the
124 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
125 STRINGP (x), but a particular use of XSTRING is invoked only after
126 testing that STRINGP (x) is true, making the test redundant. */
127 extern bool suppress_checking EXTERNALLY_VISIBLE
;
129 # define eassert(cond) \
130 ((cond) || suppress_checking \
132 : die ("assertion failed: " # cond, __FILE__, __LINE__))
133 #endif /* ENABLE_CHECKING */
135 /* Use the configure flag --enable-check-lisp-object-type to make
136 Lisp_Object use a struct type instead of the default int. The flag
137 causes CHECK_LISP_OBJECT_TYPE to be defined. */
139 /***** Select the tagging scheme. *****/
140 /* The following option controls the tagging scheme:
141 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
142 always 0, and we can thus use them to hold tag bits, without
143 restricting our addressing space.
145 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
146 restricting our possible address range.
148 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
149 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
150 on the few static Lisp_Objects used: all the defsubr as well
151 as the two special buffers buffer_defaults and buffer_local_symbols. */
155 /* Number of bits in a Lisp_Object tag. This can be used in #if,
156 and for GDB's sake also as a regular symbol. */
161 /* 2**GCTYPEBITS. This must also be a macro that expands to a
162 literal integer constant, for MSVC. */
164 #define GCALIGNMENT 8
167 /* Number of bits in a Lisp_Object value, not counting the tag. */
168 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
170 /* Number of bits in a Lisp fixnum tag. */
171 INTTYPEBITS
= GCTYPEBITS
- 1,
173 /* Number of bits in a Lisp fixnum value, not counting the tag. */
174 FIXNUM_BITS
= VALBITS
+ 1
177 #if GCALIGNMENT != 1 << GCTYPEBITS
178 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
181 /* The maximum value that can be stored in a EMACS_INT, assuming all
182 bits other than the type bits contribute to a nonnegative signed value.
183 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
184 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
186 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
188 /* 1. We know malloc returns a multiple of 8. */
189 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
190 || defined DARWIN_OS || defined __sun)
191 /* 2. We can specify multiple-of-8 alignment on static variables. */
193 /* 3. Pointers-as-ints exceed VAL_MAX.
194 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
195 a. unnecessary, because the top bits of an EMACS_INT are unused, and
196 b. slower, because it typically requires extra masking.
197 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
198 # if VAL_MAX < UINTPTR_MAX
199 # define USE_LSB_TAG 1
206 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
207 # define USE_LSB_TAG 1
209 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
210 # define USE_LSB_TAG 0
214 # define alignas(alignment) /* empty */
216 # error "USE_LSB_TAG requires alignas"
221 /* Define the fundamental Lisp data structures. */
223 /* This is the set of Lisp data types. */
225 /* Lisp integers use 2 tags, to give them one extra bit, thus
226 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
227 static EMACS_INT
const INTMASK
= EMACS_INT_MAX
>> (INTTYPEBITS
- 1);
228 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
229 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
231 /* Stolen from GDB. The only known compiler that doesn't support
232 enums in bitfields is MSVC. */
234 #define ENUM_BF(TYPE) unsigned int
236 #define ENUM_BF(TYPE) enum TYPE
242 /* Integer. XINT (obj) is the integer value. */
244 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
246 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
249 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
250 whose first member indicates the subtype. */
253 /* String. XSTRING (object) points to a struct Lisp_String.
254 The length of the string, and its contents, are stored therein. */
255 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
257 /* Vector of Lisp objects, or something resembling it.
258 XVECTOR (object) points to a struct Lisp_Vector, which contains
259 the size and contents. The size field also contains the type
260 information, if it's not a real vector object. */
263 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
269 /* This is the set of data types that share a common structure.
270 The first member of the structure is a type code from this set.
271 The enum values are arbitrary, but we'll use large numbers to make it
272 more likely that we'll spot the error if a random word in memory is
273 mistakenly interpreted as a Lisp_Misc. */
276 Lisp_Misc_Free
= 0x5eab,
279 Lisp_Misc_Save_Value
,
280 /* Currently floats are not a misc type,
281 but let's define this in case we want to change that. */
283 /* This is not a type code. It is for range checking. */
287 /* These are the types of forwarding objects used in the value slot
288 of symbols for special built-in variables whose value is stored in
292 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
293 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
294 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
295 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
296 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
299 #ifdef CHECK_LISP_OBJECT_TYPE
301 typedef struct { EMACS_INT i
; } Lisp_Object
;
304 LISP_INLINE Lisp_Object
307 Lisp_Object o
= { i
};
311 LISP_INLINE Lisp_Object
312 LISP_MAKE_RVALUE (Lisp_Object o
)
317 #define LISP_INITIALLY_ZERO {0}
319 #undef CHECK_LISP_OBJECT_TYPE
320 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
321 #else /* CHECK_LISP_OBJECT_TYPE */
323 /* If a struct type is not wanted, define Lisp_Object as just a number. */
325 typedef EMACS_INT Lisp_Object
;
328 #define LISP_MAKE_RVALUE(o) (0+(o))
329 #define LISP_INITIALLY_ZERO 0
330 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
331 #endif /* CHECK_LISP_OBJECT_TYPE */
333 /* In the size word of a vector, this bit means the vector has been marked. */
335 static ptrdiff_t const ARRAY_MARK_FLAG
336 #define ARRAY_MARK_FLAG PTRDIFF_MIN
339 /* In the size word of a struct Lisp_Vector, this bit means it's really
340 some other vector-like object. */
341 static ptrdiff_t const PSEUDOVECTOR_FLAG
342 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
345 /* In a pseudovector, the size field actually contains a word with one
346 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
347 indicate the actual type.
348 We use a bitset, even tho only one of the bits can be set at any
349 particular time just so as to be able to use micro-optimizations such as
350 testing membership of a particular subset of pseudovectors in Fequal.
351 It is not crucial, but there are plenty of bits here, so why not do it? */
354 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
363 PVEC_WINDOW_CONFIGURATION
,
366 /* These last 4 are special because we OR them in fns.c:internal_equal,
367 so they have to use a disjoint bit pattern:
368 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
369 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
370 PVEC_COMPILED
= 0x10,
371 PVEC_CHAR_TABLE
= 0x20,
372 PVEC_SUB_CHAR_TABLE
= 0x30,
376 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
377 which were stored in a Lisp_Object. */
378 #ifndef DATA_SEG_BITS
379 # define DATA_SEG_BITS 0
381 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
386 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
388 /* For convenience, we also store the number of elements in these bits.
389 Note that this size is not necessarily the memory-footprint size, but
390 only the number of Lisp_Object fields (that need to be traced by GC).
391 The distinction is used, e.g., by Lisp_Process, which places extra
392 non-Lisp_Object fields at the end of the structure. */
393 PSEUDOVECTOR_SIZE_BITS
= 16,
394 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
395 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
397 /* Number of bits to put in each character in the internal representation
398 of bool vectors. This should not vary across implementations. */
399 BOOL_VECTOR_BITS_PER_CHAR
= 8
402 /* These macros extract various sorts of values from a Lisp_Object.
403 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
404 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
406 /* Return a perfect hash of the Lisp_Object representation. */
407 #define XHASH(a) XLI (a)
413 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
416 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
417 #define XINT(a) (XLI (a) >> INTTYPEBITS)
418 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
419 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
420 #define XSET(var, type, ptr) \
421 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
422 (var) = XIL ((type) | (intptr_t) (ptr)))
424 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
425 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
427 #else /* not USE_LSB_TAG */
429 static EMACS_INT
const VALMASK
430 #define VALMASK VAL_MAX
433 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
435 /* For integers known to be positive, XFASTINT provides fast retrieval
436 and XSETFASTINT provides fast storage. This takes advantage of the
437 fact that Lisp integers have zero-bits in their tags. */
438 #define XFASTINT(a) (XLI (a) + 0)
439 #define XSETFASTINT(a, b) ((a) = XIL (b))
441 /* Extract the value of a Lisp_Object as a (un)signed integer. */
443 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
444 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
445 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
447 #define XSET(var, type, ptr) \
448 ((var) = XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
449 + ((intptr_t) (ptr) & VALMASK)))
452 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
453 which were stored in a Lisp_Object */
454 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
456 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
459 #endif /* not USE_LSB_TAG */
461 /* For integers known to be positive, XFASTINT sometimes provides
462 faster retrieval and XSETFASTINT provides faster storage.
463 If not, fallback on the non-accelerated path. */
465 # define XFASTINT(a) (XINT (a))
466 # define XSETFASTINT(a, b) (XSETINT (a, b))
469 /* Extract the pointer value of the Lisp object A, under the
470 assumption that A's type is TYPE. This is a fallback
471 implementation if nothing faster is available. */
473 # define XUNTAG(a, type) XPNTR (a)
476 #define EQ(x, y) (XHASH (x) == XHASH (y))
478 /* Largest and smallest representable fixnum values. These are the C
479 values. They are macros for use in static initializers, and
480 constants for visibility to GDB. */
481 static EMACS_INT
const MOST_POSITIVE_FIXNUM
=
482 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
483 MOST_POSITIVE_FIXNUM
;
484 static EMACS_INT
const MOST_NEGATIVE_FIXNUM
=
485 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
486 MOST_NEGATIVE_FIXNUM
;
488 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
489 written this way so that it also works if I is of unsigned
490 type or if I is a NaN. */
492 #define FIXNUM_OVERFLOW_P(i) \
493 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
495 LISP_INLINE
ptrdiff_t
496 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
498 return num
< lower
? lower
: num
<= upper
? num
: upper
;
501 /* Extract a value or address from a Lisp_Object. */
503 #define XCONS(a) (eassert (CONSP (a)), \
504 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
505 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
506 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
507 #define XSTRING(a) (eassert (STRINGP (a)), \
508 (struct Lisp_String *) XUNTAG (a, Lisp_String))
509 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
510 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
511 #define XFLOAT(a) (eassert (FLOATP (a)), \
512 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
516 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
517 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
518 #define XMISCTYPE(a) (XMISCANY (a)->type)
519 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
520 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
521 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
523 /* Forwarding object types. */
525 #define XFWDTYPE(a) (a->u_intfwd.type)
526 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
527 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
528 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
529 #define XBUFFER_OBJFWD(a) \
530 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
531 #define XKBOARD_OBJFWD(a) \
532 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
534 /* Pseudovector types. */
536 #define XPROCESS(a) (eassert (PROCESSP (a)), \
537 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
538 #define XWINDOW(a) (eassert (WINDOWP (a)), \
539 (struct window *) XUNTAG (a, Lisp_Vectorlike))
540 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
541 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
542 #define XSUBR(a) (eassert (SUBRP (a)), \
543 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
544 #define XBUFFER(a) (eassert (BUFFERP (a)), \
545 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
546 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
547 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
548 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
549 ((struct Lisp_Sub_Char_Table *) \
550 XUNTAG (a, Lisp_Vectorlike)))
551 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
552 ((struct Lisp_Bool_Vector *) \
553 XUNTAG (a, Lisp_Vectorlike)))
555 /* Construct a Lisp_Object from a value or address. */
557 #define XSETINT(a, b) (a) = make_number (b)
558 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
559 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
560 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
561 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
562 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
566 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
567 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
569 /* Pseudovector types. */
571 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
572 #define XSETTYPED_PVECTYPE(v, size_member, code) \
573 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
574 #define XSETPVECTYPESIZE(v, code, sizeval) \
575 ((v)->header.size = (PSEUDOVECTOR_FLAG \
576 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
579 /* The cast to struct vectorlike_header * avoids aliasing issues. */
580 #define XSETPSEUDOVECTOR(a, b, code) \
581 XSETTYPED_PSEUDOVECTOR (a, b, \
582 (((struct vectorlike_header *) \
583 XUNTAG (a, Lisp_Vectorlike)) \
586 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
587 (XSETVECTOR (a, b), \
588 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
589 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
591 #define XSETWINDOW_CONFIGURATION(a, b) \
592 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
593 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
594 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
595 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
596 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
597 #define XSETSUBR(a, b) \
598 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
599 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
600 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
601 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
602 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
603 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
605 /* Convenience macros for dealing with Lisp arrays. */
607 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
608 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
609 #define ASET(ARRAY, IDX, VAL) \
610 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
611 XVECTOR (ARRAY)->contents[IDX] = (VAL))
613 /* Convenience macros for dealing with Lisp strings. */
615 #define SDATA(string) (XSTRING (string)->data + 0)
616 #define SREF(string, index) (SDATA (string)[index] + 0)
617 #define SSET(string, index, new) (SDATA (string)[index] = (new))
618 #define SCHARS(string) (XSTRING (string)->size + 0)
619 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
621 /* Avoid "differ in sign" warnings. */
622 #define SSDATA(x) ((char *) SDATA (x))
624 #define STRING_SET_CHARS(string, newsize) \
625 (XSTRING (string)->size = (newsize))
627 #define STRING_COPYIN(string, index, new, count) \
628 memcpy (SDATA (string) + index, new, count)
632 #define CHECK_TYPE(ok, Qxxxp, x) \
633 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
635 /* Deprecated and will be removed soon. */
637 #define INTERNAL_FIELD(field) field ## _
639 /* See the macros in intervals.h. */
641 typedef struct interval
*INTERVAL
;
643 /* Complain if object is not string or buffer type. */
644 #define CHECK_STRING_OR_BUFFER(x) \
645 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
649 /* Car of this cons cell. */
654 /* Cdr of this cons cell. */
657 /* Used to chain conses on a free list. */
658 struct Lisp_Cons
*chain
;
662 /* Take the car or cdr of something known to be a cons cell. */
663 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
664 of code that has to know what a cons cell looks like. Other code not
665 part of the basic lisp implementation should assume that the car and cdr
666 fields are not accessible as lvalues. (What if we want to switch to
667 a copying collector someday? Cached cons cell field addresses may be
668 invalidated at arbitrary points.) */
669 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
670 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
672 /* Use these from normal code. */
673 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
674 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
676 /* Use these to set the fields of a cons cell.
678 Note that both arguments may refer to the same object, so 'n'
679 should not be read after 'c' is first modified. Also, neither
680 argument should be evaluated more than once; side effects are
681 especially common in the second argument. */
682 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
683 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
685 /* Take the car or cdr of something whose type is not known. */
687 (CONSP ((c)) ? XCAR ((c)) \
688 : NILP ((c)) ? Qnil \
689 : wrong_type_argument (Qlistp, (c)))
692 (CONSP ((c)) ? XCDR ((c)) \
693 : NILP ((c)) ? Qnil \
694 : wrong_type_argument (Qlistp, (c)))
696 /* Take the car or cdr of something whose type is not known. */
697 #define CAR_SAFE(c) \
698 (CONSP ((c)) ? XCAR ((c)) : Qnil)
700 #define CDR_SAFE(c) \
701 (CONSP ((c)) ? XCDR ((c)) : Qnil)
703 /* True if STR is a multibyte string. */
704 #define STRING_MULTIBYTE(STR) \
705 (XSTRING (STR)->size_byte >= 0)
707 /* Return the length in bytes of STR. */
709 #ifdef GC_CHECK_STRING_BYTES
712 extern ptrdiff_t string_bytes (struct Lisp_String
*);
713 #define STRING_BYTES(S) string_bytes ((S))
715 #else /* not GC_CHECK_STRING_BYTES */
717 #define STRING_BYTES(STR) \
718 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
720 #endif /* not GC_CHECK_STRING_BYTES */
722 /* An upper bound on the number of bytes in a Lisp string, not
723 counting the terminating null. This a tight enough bound to
724 prevent integer overflow errors that would otherwise occur during
725 string size calculations. A string cannot contain more bytes than
726 a fixnum can represent, nor can it be so long that C pointer
727 arithmetic stops working on the string plus its terminating null.
728 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
729 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
730 would expose alloc.c internal details that we'd rather keep
733 This is a macro for use in static initializers, and a constant for
734 visibility to GDB. The cast to ptrdiff_t ensures that
735 the macro is signed. */
736 static ptrdiff_t const STRING_BYTES_BOUND
=
737 #define STRING_BYTES_BOUND \
738 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
741 /* Mark STR as a unibyte string. */
742 #define STRING_SET_UNIBYTE(STR) \
743 do { if (EQ (STR, empty_multibyte_string)) \
744 (STR) = empty_unibyte_string; \
745 else XSTRING (STR)->size_byte = -1; } while (0)
747 /* Mark STR as a multibyte string. Assure that STR contains only
748 ASCII characters in advance. */
749 #define STRING_SET_MULTIBYTE(STR) \
750 do { if (EQ (STR, empty_unibyte_string)) \
751 (STR) = empty_multibyte_string; \
752 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
754 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
760 INTERVAL intervals
; /* Text properties in this string. */
764 /* Header of vector-like objects. This documents the layout constraints on
765 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
766 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
767 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
768 because when two such pointers potentially alias, a compiler won't
769 incorrectly reorder loads and stores to their size fields. See
770 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
771 struct vectorlike_header
773 /* This field contains various pieces of information:
774 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
775 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
776 vector (0) or a pseudovector (1).
777 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
778 of slots) of the vector.
779 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
780 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
781 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
782 Lisp_Object slots at the beginning of the object that need to be
783 traced by the GC, tho some types use it slightly differently.
784 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
785 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
789 /* When the vector is allocated from a vector block, NBYTES is used
790 if the vector is not on a free list, and VECTOR is used otherwise.
791 For large vector-like objects, BUFFER or VECTOR is used as a pointer
792 to the next vector-like object. It is generally a buffer or a
793 Lisp_Vector alias, so for convenience it is a union instead of a
794 pointer: this way, one can write P->next.vector instead of ((struct
795 Lisp_Vector *) P->next). */
797 /* This is only needed for small vectors that are not free because the
798 `size' field only gives us the number of Lisp_Object slots, whereas we
799 need to know the total size, including non-Lisp_Object data.
800 FIXME: figure out a way to store this info elsewhere so we can
801 finally get rid of this extra word of overhead. */
803 struct buffer
*buffer
;
804 /* FIXME: This can be removed: For large vectors, this field could be
805 placed *before* the vector itself. And for small vectors on a free
806 list, this field could be stored in the vector's bytes, since the
807 empty vector is handled specially anyway. */
808 struct Lisp_Vector
*vector
;
812 /* Regular vector is just a header plus array of Lisp_Objects. */
816 struct vectorlike_header header
;
817 Lisp_Object contents
[1];
820 /* A boolvector is a kind of vectorlike, with contents are like a string. */
822 struct Lisp_Bool_Vector
824 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
825 just the subtype information. */
826 struct vectorlike_header header
;
827 /* This is the size in bits. */
829 /* This contains the actual bits, packed into bytes. */
830 unsigned char data
[1];
833 /* Some handy constants for calculating sizes
834 and offsets, mostly of vectorlike objects. */
838 header_size
= offsetof (struct Lisp_Vector
, contents
),
839 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
840 word_size
= sizeof (Lisp_Object
)
843 /* If a struct is made to look like a vector, this macro returns the length
844 of the shortest vector that would hold that struct. */
846 #define VECSIZE(type) \
847 ((sizeof (type) - header_size + word_size - 1) / word_size)
849 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
850 at the end and we need to compute the number of Lisp_Object fields (the
851 ones that the GC needs to trace). */
853 #define PSEUDOVECSIZE(type, nonlispfield) \
854 ((offsetof (type, nonlispfield) - header_size) / word_size)
856 /* A char-table is a kind of vectorlike, with contents are like a
857 vector but with a few other slots. For some purposes, it makes
858 sense to handle a char-table with type struct Lisp_Vector. An
859 element of a char table can be any Lisp objects, but if it is a sub
860 char-table, we treat it a table that contains information of a
861 specific range of characters. A sub char-table has the same
862 structure as a vector. A sub char table appears only in an element
863 of a char-table, and there's no way to access it directly from
864 Emacs Lisp program. */
868 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
869 ({struct Lisp_Char_Table *_tbl = NULL; \
872 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
873 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
874 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
876 _val = _tbl->defalt; \
877 } while (NILP (_val) && ! NILP (_tbl->parent)); \
880 #else /* not __GNUC__ */
882 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
883 (! NILP (XCHAR_TABLE (CT)->ascii) \
884 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
885 ? XCHAR_TABLE (CT)->ascii \
886 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
887 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
888 : char_table_ref ((CT), (IDX))) \
889 : char_table_ref ((CT), (IDX)))
891 #endif /* not __GNUC__ */
893 /* Compute A OP B, using the unsigned comparison operator OP. A and B
894 should be integer expressions. This is not the same as
895 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
896 returns 1. For efficiency, prefer plain unsigned comparison if A
897 and B's sizes both fit (after integer promotion). */
898 #define UNSIGNED_CMP(a, op, b) \
899 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
900 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
901 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
903 /* Nonzero iff C is an ASCII character. */
904 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
906 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
907 characters. Do not check validity of CT. */
908 #define CHAR_TABLE_REF(CT, IDX) \
909 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
910 : char_table_ref ((CT), (IDX)))
912 /* Almost equivalent to Faref (CT, IDX). However, if the result is
913 not a character, return IDX.
915 For these characters, do not check validity of CT
916 and do not follow parent. */
917 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
918 char_table_translate (CT, IDX)
920 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
921 8-bit European characters. Do not check validity of CT. */
922 #define CHAR_TABLE_SET(CT, IDX, VAL) \
923 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
924 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
925 : char_table_set (CT, IDX, VAL))
927 enum CHARTAB_SIZE_BITS
929 CHARTAB_SIZE_BITS_0
= 6,
930 CHARTAB_SIZE_BITS_1
= 4,
931 CHARTAB_SIZE_BITS_2
= 5,
932 CHARTAB_SIZE_BITS_3
= 7
935 extern const int chartab_size
[4];
937 struct Lisp_Char_Table
939 /* HEADER.SIZE is the vector's size field, which also holds the
940 pseudovector type information. It holds the size, too.
941 The size counts the defalt, parent, purpose, ascii,
942 contents, and extras slots. */
943 struct vectorlike_header header
;
945 /* This holds a default value,
946 which is used whenever the value for a specific character is nil. */
949 /* This points to another char table, which we inherit from when the
950 value for a specific character is nil. The `defalt' slot takes
951 precedence over this. */
954 /* This is a symbol which says what kind of use this char-table is
958 /* The bottom sub char-table for characters of the range 0..127. It
959 is nil if none of ASCII character has a specific value. */
962 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
964 /* These hold additional data. It is a vector. */
965 Lisp_Object extras
[1];
968 struct Lisp_Sub_Char_Table
970 /* HEADER.SIZE is the vector's size field, which also holds the
971 pseudovector type information. It holds the size, too. */
972 struct vectorlike_header header
;
974 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
975 char-table of depth 1 contains 16 elements, and each element
976 covers 4096 (128*32) characters. A sub char-table of depth 2
977 contains 32 elements, and each element covers 128 characters. A
978 sub char-table of depth 3 contains 128 elements, and each element
979 is for one character. */
982 /* Minimum character covered by the sub char-table. */
983 Lisp_Object min_char
;
985 /* Use set_sub_char_table_contents to set this. */
986 Lisp_Object contents
[1];
989 /* This structure describes a built-in function.
990 It is generated by the DEFUN macro only.
991 defsubr makes it into a Lisp object.
993 This type is treated in most respects as a pseudovector,
994 but since we never dynamically allocate or free them,
995 we don't need a struct vectorlike_header and its 'next' field. */
1001 Lisp_Object (*a0
) (void);
1002 Lisp_Object (*a1
) (Lisp_Object
);
1003 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1004 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1005 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1006 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1007 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1008 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1009 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1010 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1011 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1013 short min_args
, max_args
;
1014 const char *symbol_name
;
1015 const char *intspec
;
1019 /* This is the number of slots that every char table must have. This
1020 counts the ordinary slots and the top, defalt, parent, and purpose
1022 enum CHAR_TABLE_STANDARD_SLOTS
1024 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1027 /* Return the number of "extra" slots in the char table CT. */
1029 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1030 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1033 /***********************************************************************
1035 ***********************************************************************/
1037 /* Interned state of a symbol. */
1039 enum symbol_interned
1041 SYMBOL_UNINTERNED
= 0,
1042 SYMBOL_INTERNED
= 1,
1043 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1046 enum symbol_redirect
1048 SYMBOL_PLAINVAL
= 4,
1049 SYMBOL_VARALIAS
= 1,
1050 SYMBOL_LOCALIZED
= 2,
1051 SYMBOL_FORWARDED
= 3
1056 unsigned gcmarkbit
: 1;
1058 /* Indicates where the value can be found:
1059 0 : it's a plain var, the value is in the `value' field.
1060 1 : it's a varalias, the value is really in the `alias' symbol.
1061 2 : it's a localized var, the value is in the `blv' object.
1062 3 : it's a forwarding variable, the value is in `forward'. */
1063 ENUM_BF (symbol_redirect
) redirect
: 3;
1065 /* Non-zero means symbol is constant, i.e. changing its value
1066 should signal an error. If the value is 3, then the var
1067 can be changed, but only by `defconst'. */
1068 unsigned constant
: 2;
1070 /* Interned state of the symbol. This is an enumerator from
1071 enum symbol_interned. */
1072 unsigned interned
: 2;
1074 /* Non-zero means that this variable has been explicitly declared
1075 special (with `defvar' etc), and shouldn't be lexically bound. */
1076 unsigned declared_special
: 1;
1078 /* The symbol's name, as a Lisp string. */
1081 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1082 union is used depends on the `redirect' field above. */
1085 struct Lisp_Symbol
*alias
;
1086 struct Lisp_Buffer_Local_Value
*blv
;
1087 union Lisp_Fwd
*fwd
;
1090 /* Function value of the symbol or Qunbound if not fboundp. */
1091 Lisp_Object function
;
1093 /* The symbol's property list. */
1096 /* Next symbol in obarray bucket, if the symbol is interned. */
1097 struct Lisp_Symbol
*next
;
1100 /* Value is name of symbol. */
1102 #define SYMBOL_VAL(sym) \
1103 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1104 #define SYMBOL_ALIAS(sym) \
1105 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1106 #define SYMBOL_BLV(sym) \
1107 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1108 #define SYMBOL_FWD(sym) \
1109 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1110 #define SET_SYMBOL_VAL(sym, v) \
1111 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1112 #define SET_SYMBOL_ALIAS(sym, v) \
1113 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1114 #define SET_SYMBOL_BLV(sym, v) \
1115 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1116 #define SET_SYMBOL_FWD(sym, v) \
1117 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1119 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1121 /* Value is non-zero if SYM is an interned symbol. */
1123 #define SYMBOL_INTERNED_P(sym) \
1124 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1126 /* Value is non-zero if SYM is interned in initial_obarray. */
1128 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1129 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1131 /* Value is non-zero if symbol is considered a constant, i.e. its
1132 value cannot be changed (there is an exception for keyword symbols,
1133 whose value can be set to the keyword symbol itself). */
1135 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1137 #define DEFSYM(sym, name) \
1138 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1141 /***********************************************************************
1143 ***********************************************************************/
1145 /* The structure of a Lisp hash table. */
1147 struct Lisp_Hash_Table
1149 /* This is for Lisp; the hash table code does not refer to it. */
1150 struct vectorlike_header header
;
1152 /* Function used to compare keys. */
1155 /* Nil if table is non-weak. Otherwise a symbol describing the
1156 weakness of the table. */
1159 /* When the table is resized, and this is an integer, compute the
1160 new size by adding this to the old size. If a float, compute the
1161 new size by multiplying the old size with this factor. */
1162 Lisp_Object rehash_size
;
1164 /* Resize hash table when number of entries/ table size is >= this
1166 Lisp_Object rehash_threshold
;
1168 /* Vector of hash codes.. If hash[I] is nil, this means that that
1169 entry I is unused. */
1172 /* Vector used to chain entries. If entry I is free, next[I] is the
1173 entry number of the next free item. If entry I is non-free,
1174 next[I] is the index of the next entry in the collision chain. */
1177 /* Index of first free entry in free list. */
1178 Lisp_Object next_free
;
1180 /* Bucket vector. A non-nil entry is the index of the first item in
1181 a collision chain. This vector's size can be larger than the
1182 hash table size to reduce collisions. */
1185 /* User-supplied hash function, or nil. */
1186 Lisp_Object user_hash_function
;
1188 /* User-supplied key comparison function, or nil. */
1189 Lisp_Object user_cmp_function
;
1191 /* Only the fields above are traced normally by the GC. The ones below
1192 `count' are special and are either ignored by the GC or traced in
1193 a special way (e.g. because of weakness). */
1195 /* Number of key/value entries in the table. */
1198 /* Vector of keys and values. The key of item I is found at index
1199 2 * I, the value is found at index 2 * I + 1.
1200 This is gc_marked specially if the table is weak. */
1201 Lisp_Object key_and_value
;
1203 /* Next weak hash table if this is a weak hash table. The head
1204 of the list is in weak_hash_tables. */
1205 struct Lisp_Hash_Table
*next_weak
;
1207 /* C function to compare two keys. */
1208 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1209 Lisp_Object
, EMACS_UINT
,
1210 Lisp_Object
, EMACS_UINT
);
1212 /* C function to compute hash code. */
1213 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1217 #define XHASH_TABLE(OBJ) \
1218 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1220 #define XSET_HASH_TABLE(VAR, PTR) \
1221 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1223 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1225 #define CHECK_HASH_TABLE(x) \
1226 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1228 /* Value is the key part of entry IDX in hash table H. */
1230 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1232 /* Value is the value part of entry IDX in hash table H. */
1234 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1236 /* Value is the index of the next entry following the one at IDX
1239 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1241 /* Value is the hash code computed for entry IDX in hash table H. */
1243 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1245 /* Value is the index of the element in hash table H that is the
1246 start of the collision list at index IDX in the index vector of H. */
1248 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1250 /* Value is the size of hash table H. */
1252 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1254 /* Default size for hash tables if not specified. */
1256 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1258 /* Default threshold specifying when to resize a hash table. The
1259 value gives the ratio of current entries in the hash table and the
1260 size of the hash table. */
1262 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1264 /* Default factor by which to increase the size of a hash table. */
1266 static double const DEFAULT_REHASH_SIZE
= 1.5;
1268 /* These structures are used for various misc types. */
1270 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1272 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1273 unsigned gcmarkbit
: 1;
1279 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1280 unsigned gcmarkbit
: 1;
1282 /* This flag is temporarily used in the functions
1283 decode/encode_coding_object to record that the marker position
1284 must be adjusted after the conversion. */
1285 unsigned int need_adjustment
: 1;
1286 /* 1 means normal insertion at the marker's position
1287 leaves the marker after the inserted text. */
1288 unsigned int insertion_type
: 1;
1289 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1290 Note: a chain of markers can contain markers pointing into different
1291 buffers (the chain is per buffer_text rather than per buffer, so it's
1292 shared between indirect buffers). */
1293 /* This is used for (other than NULL-checking):
1295 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1296 - unchain_marker: to find the list from which to unchain.
1297 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1299 struct buffer
*buffer
;
1301 /* The remaining fields are meaningless in a marker that
1302 does not point anywhere. */
1304 /* For markers that point somewhere,
1305 this is used to chain of all the markers in a given buffer. */
1306 /* We could remove it and use an array in buffer_text instead.
1307 That would also allow to preserve it ordered. */
1308 struct Lisp_Marker
*next
;
1309 /* This is the char position where the marker points. */
1311 /* This is the byte position.
1312 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1313 used to implement the functionality of markers, but rather to (ab)use
1314 markers as a cache for char<->byte mappings). */
1318 /* START and END are markers in the overlay's buffer, and
1319 PLIST is the overlay's property list. */
1321 /* An overlay's real data content is:
1323 - buffer (really there are two buffer pointers, one per marker,
1324 and both points to the same buffer)
1325 - insertion type of both ends (per-marker fields)
1326 - start & start byte (of start marker)
1327 - end & end byte (of end marker)
1328 - next (singly linked list of overlays)
1329 - next fields of start and end markers (singly linked list of markers).
1330 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1333 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1334 unsigned gcmarkbit
: 1;
1336 struct Lisp_Overlay
*next
;
1342 /* Hold a C pointer for later use.
1343 This type of object is used in the arg to record_unwind_protect. */
1344 struct Lisp_Save_Value
1346 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1347 unsigned gcmarkbit
: 1;
1349 /* If DOGC is set, POINTER is the address of a memory
1350 area containing INTEGER potential Lisp_Objects. */
1351 unsigned int dogc
: 1;
1357 /* A miscellaneous object, when it's on the free list. */
1360 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1361 unsigned gcmarkbit
: 1;
1363 union Lisp_Misc
*chain
;
1366 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1367 It uses one of these struct subtypes to get the type field. */
1371 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1372 struct Lisp_Free u_free
;
1373 struct Lisp_Marker u_marker
;
1374 struct Lisp_Overlay u_overlay
;
1375 struct Lisp_Save_Value u_save_value
;
1378 /* Forwarding pointer to an int variable.
1379 This is allowed only in the value cell of a symbol,
1380 and it means that the symbol's value really lives in the
1381 specified int variable. */
1384 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1388 /* Boolean forwarding pointer to an int variable.
1389 This is like Lisp_Intfwd except that the ostensible
1390 "value" of the symbol is t if the int variable is nonzero,
1391 nil if it is zero. */
1394 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1398 /* Forwarding pointer to a Lisp_Object variable.
1399 This is allowed only in the value cell of a symbol,
1400 and it means that the symbol's value really lives in the
1401 specified variable. */
1404 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1405 Lisp_Object
*objvar
;
1408 /* Like Lisp_Objfwd except that value lives in a slot in the
1409 current buffer. Value is byte index of slot within buffer. */
1410 struct Lisp_Buffer_Objfwd
1412 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1414 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1417 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1418 the symbol has buffer-local or frame-local bindings. (Exception:
1419 some buffer-local variables are built-in, with their values stored
1420 in the buffer structure itself. They are handled differently,
1421 using struct Lisp_Buffer_Objfwd.)
1423 The `realvalue' slot holds the variable's current value, or a
1424 forwarding pointer to where that value is kept. This value is the
1425 one that corresponds to the loaded binding. To read or set the
1426 variable, you must first make sure the right binding is loaded;
1427 then you can access the value in (or through) `realvalue'.
1429 `buffer' and `frame' are the buffer and frame for which the loaded
1430 binding was found. If those have changed, to make sure the right
1431 binding is loaded it is necessary to find which binding goes with
1432 the current buffer and selected frame, then load it. To load it,
1433 first unload the previous binding, then copy the value of the new
1434 binding into `realvalue' (or through it). Also update
1435 LOADED-BINDING to point to the newly loaded binding.
1437 `local_if_set' indicates that merely setting the variable creates a
1438 local binding for the current buffer. Otherwise the latter, setting
1439 the variable does not do that; only make-local-variable does that. */
1441 struct Lisp_Buffer_Local_Value
1443 /* 1 means that merely setting the variable creates a local
1444 binding for the current buffer. */
1445 unsigned int local_if_set
: 1;
1446 /* 1 means this variable can have frame-local bindings, otherwise, it is
1447 can have buffer-local bindings. The two cannot be combined. */
1448 unsigned int frame_local
: 1;
1449 /* 1 means that the binding now loaded was found.
1450 Presumably equivalent to (defcell!=valcell). */
1451 unsigned int found
: 1;
1452 /* If non-NULL, a forwarding to the C var where it should also be set. */
1453 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1454 /* The buffer or frame for which the loaded binding was found. */
1456 /* A cons cell that holds the default value. It has the form
1457 (SYMBOL . DEFAULT-VALUE). */
1458 Lisp_Object defcell
;
1459 /* The cons cell from `where's parameter alist.
1460 It always has the form (SYMBOL . VALUE)
1461 Note that if `forward' is non-nil, VALUE may be out of date.
1462 Also if the currently loaded binding is the default binding, then
1463 this is `eq'ual to defcell. */
1464 Lisp_Object valcell
;
1467 /* Like Lisp_Objfwd except that value lives in a slot in the
1469 struct Lisp_Kboard_Objfwd
1471 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1477 struct Lisp_Intfwd u_intfwd
;
1478 struct Lisp_Boolfwd u_boolfwd
;
1479 struct Lisp_Objfwd u_objfwd
;
1480 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1481 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1484 /* Lisp floating point type. */
1490 struct Lisp_Float
*chain
;
1494 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1495 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1497 /* A character, declared with the following typedef, is a member
1498 of some character set associated with the current buffer. */
1499 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1501 typedef unsigned char UCHAR
;
1504 /* Meanings of slots in a Lisp_Compiled: */
1508 COMPILED_ARGLIST
= 0,
1509 COMPILED_BYTECODE
= 1,
1510 COMPILED_CONSTANTS
= 2,
1511 COMPILED_STACK_DEPTH
= 3,
1512 COMPILED_DOC_STRING
= 4,
1513 COMPILED_INTERACTIVE
= 5
1516 /* Flag bits in a character. These also get used in termhooks.h.
1517 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1518 (MUlti-Lingual Emacs) might need 22 bits for the character value
1519 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1522 CHAR_ALT
= 0x0400000,
1523 CHAR_SUPER
= 0x0800000,
1524 CHAR_HYPER
= 0x1000000,
1525 CHAR_SHIFT
= 0x2000000,
1526 CHAR_CTL
= 0x4000000,
1527 CHAR_META
= 0x8000000,
1529 CHAR_MODIFIER_MASK
=
1530 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1532 /* Actually, the current Emacs uses 22 bits for the character value
1540 /* The glyph datatype, used to represent characters on the display.
1541 It consists of a char code and a face id. */
1548 /* Return a glyph's character code. */
1549 #define GLYPH_CHAR(glyph) ((glyph).ch)
1551 /* Return a glyph's face ID. */
1552 #define GLYPH_FACE(glyph) ((glyph).face_id)
1554 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1555 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1556 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1558 /* Return 1 if GLYPH contains valid character code. */
1559 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1562 /* Glyph Code from a display vector may either be an integer which
1563 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1564 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1566 #define GLYPH_CODE_P(gc) \
1568 ? (CHARACTERP (XCAR (gc)) \
1569 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1570 : (RANGED_INTEGERP \
1572 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1573 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1574 : TYPE_MAXIMUM (EMACS_INT)))))
1576 /* The following are valid only if GLYPH_CODE_P (gc). */
1578 #define GLYPH_CODE_CHAR(gc) \
1579 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1581 #define GLYPH_CODE_FACE(gc) \
1582 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1584 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1588 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1590 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1591 (XINT (gc) >> CHARACTERBITS)); \
1595 /* Structure to hold mouse highlight data. This is here because other
1596 header files need it for defining struct x_output etc. */
1598 /* These variables describe the range of text currently shown in its
1599 mouse-face, together with the window they apply to. As long as
1600 the mouse stays within this range, we need not redraw anything on
1601 its account. Rows and columns are glyph matrix positions in
1602 MOUSE_FACE_WINDOW. */
1603 int mouse_face_beg_row
, mouse_face_beg_col
;
1604 int mouse_face_beg_x
, mouse_face_beg_y
;
1605 int mouse_face_end_row
, mouse_face_end_col
;
1606 int mouse_face_end_x
, mouse_face_end_y
;
1607 int mouse_face_past_end
;
1608 Lisp_Object mouse_face_window
;
1609 int mouse_face_face_id
;
1610 Lisp_Object mouse_face_overlay
;
1612 /* 1 if a mouse motion event came and we didn't handle it right away because
1613 gc was in progress. */
1614 int mouse_face_deferred_gc
;
1616 /* FRAME and X, Y position of mouse when last checked for
1617 highlighting. X and Y can be negative or out of range for the frame. */
1618 struct frame
*mouse_face_mouse_frame
;
1619 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1621 /* Nonzero means defer mouse-motion highlighting. */
1622 int mouse_face_defer
;
1624 /* Nonzero means that the mouse highlight should not be shown. */
1625 int mouse_face_hidden
;
1627 int mouse_face_image_state
;
1630 /* Data type checking */
1632 #define NILP(x) EQ (x, Qnil)
1634 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1635 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1637 #define RANGED_INTEGERP(lo, x, hi) \
1638 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1639 #define TYPE_RANGED_INTEGERP(type, x) \
1640 (TYPE_SIGNED (type) \
1641 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1642 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1644 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1645 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1646 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1647 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1648 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1649 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1651 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1652 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1653 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1654 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1655 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1657 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1658 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1659 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1660 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1661 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1663 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1664 vectorlike_header * avoids aliasing issues. */
1665 #define PSEUDOVECTORP(x, code) \
1666 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1668 #define PSEUDOVECTOR_TYPEP(v, code) \
1669 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1670 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1672 /* True if object X, with internal type struct T *, is a pseudovector whose
1674 #define TYPED_PSEUDOVECTORP(x, t, code) \
1676 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1678 /* Test for specific pseudovector types. */
1679 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1680 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1681 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1682 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1683 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1684 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1685 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1686 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1687 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1688 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1689 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1690 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1692 /* Test for image (image . spec) */
1693 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1698 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1700 #define CHECK_LIST(x) \
1701 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1703 #define CHECK_LIST_CONS(x, y) \
1704 CHECK_TYPE (CONSP (x), Qlistp, y)
1706 #define CHECK_LIST_END(x, y) \
1707 CHECK_TYPE (NILP (x), Qlistp, y)
1709 #define CHECK_STRING(x) \
1710 CHECK_TYPE (STRINGP (x), Qstringp, x)
1712 #define CHECK_STRING_CAR(x) \
1713 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1715 #define CHECK_CONS(x) \
1716 CHECK_TYPE (CONSP (x), Qconsp, x)
1718 #define CHECK_SYMBOL(x) \
1719 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1721 #define CHECK_CHAR_TABLE(x) \
1722 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1724 #define CHECK_VECTOR(x) \
1725 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1727 #define CHECK_VECTOR_OR_STRING(x) \
1728 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1730 #define CHECK_ARRAY(x, Qxxxp) \
1731 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1733 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1734 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1736 #define CHECK_BUFFER(x) \
1737 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1739 #define CHECK_WINDOW(x) \
1740 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1742 #define CHECK_WINDOW_CONFIGURATION(x) \
1743 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1745 /* A window of any sort, leaf or interior, is "valid" if one of its
1746 buffer, vchild, or hchild members is non-nil. */
1747 #define CHECK_VALID_WINDOW(x) \
1748 CHECK_TYPE (WINDOWP (x) \
1749 && (!NILP (XWINDOW (x)->buffer) \
1750 || !NILP (XWINDOW (x)->vchild) \
1751 || !NILP (XWINDOW (x)->hchild)), \
1754 /* A window is "live" if and only if it shows a buffer. */
1755 #define CHECK_LIVE_WINDOW(x) \
1756 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), \
1759 #define CHECK_PROCESS(x) \
1760 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1762 #define CHECK_SUBR(x) \
1763 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1765 #define CHECK_NUMBER(x) \
1766 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1768 #define CHECK_NATNUM(x) \
1769 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1771 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1774 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1775 args_out_of_range_3 \
1777 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1778 ? MOST_NEGATIVE_FIXNUM \
1780 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1782 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1784 if (TYPE_SIGNED (type)) \
1785 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1787 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1790 #define CHECK_MARKER(x) \
1791 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1793 #define CHECK_NUMBER_COERCE_MARKER(x) \
1794 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1795 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1797 #define XFLOATINT(n) extract_float((n))
1799 #define CHECK_FLOAT(x) \
1800 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1802 #define CHECK_NUMBER_OR_FLOAT(x) \
1803 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1805 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1806 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1807 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1809 #define CHECK_OVERLAY(x) \
1810 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1812 /* Since we can't assign directly to the CAR or CDR fields of a cons
1813 cell, use these when checking that those fields contain numbers. */
1814 #define CHECK_NUMBER_CAR(x) \
1816 Lisp_Object tmp = XCAR (x); \
1817 CHECK_NUMBER (tmp); \
1818 XSETCAR ((x), tmp); \
1821 #define CHECK_NUMBER_CDR(x) \
1823 Lisp_Object tmp = XCDR (x); \
1824 CHECK_NUMBER (tmp); \
1825 XSETCDR ((x), tmp); \
1828 #define CHECK_NATNUM_CAR(x) \
1830 Lisp_Object tmp = XCAR (x); \
1831 CHECK_NATNUM (tmp); \
1832 XSETCAR ((x), tmp); \
1835 #define CHECK_NATNUM_CDR(x) \
1837 Lisp_Object tmp = XCDR (x); \
1838 CHECK_NATNUM (tmp); \
1839 XSETCDR ((x), tmp); \
1842 /* Define a built-in function for calling from Lisp.
1843 `lname' should be the name to give the function in Lisp,
1844 as a null-terminated C string.
1845 `fnname' should be the name of the function in C.
1846 By convention, it starts with F.
1847 `sname' should be the name for the C constant structure
1848 that records information on this function for internal use.
1849 By convention, it should be the same as `fnname' but with S instead of F.
1850 It's too bad that C macros can't compute this from `fnname'.
1851 `minargs' should be a number, the minimum number of arguments allowed.
1852 `maxargs' should be a number, the maximum number of arguments allowed,
1853 or else MANY or UNEVALLED.
1854 MANY means pass a vector of evaluated arguments,
1855 in the form of an integer number-of-arguments
1856 followed by the address of a vector of Lisp_Objects
1857 which contains the argument values.
1858 UNEVALLED means pass the list of unevaluated arguments
1859 `intspec' says how interactive arguments are to be fetched.
1860 If the string starts with a `(', `intspec' is evaluated and the resulting
1861 list is the list of arguments.
1862 If it's a string that doesn't start with `(', the value should follow
1863 the one of the doc string for `interactive'.
1864 A null string means call interactively with no arguments.
1865 `doc' is documentation for the user. */
1867 /* This version of DEFUN declares a function prototype with the right
1868 arguments, so we can catch errors with maxargs at compile-time. */
1870 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1871 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1872 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1873 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1874 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1875 { (Lisp_Object (__cdecl *)(void))fnname }, \
1876 minargs, maxargs, lname, intspec, 0}; \
1878 #else /* not _MSC_VER */
1879 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1880 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1881 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1882 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1883 { .a ## maxargs = fnname }, \
1884 minargs, maxargs, lname, intspec, 0}; \
1888 /* Note that the weird token-substitution semantics of ANSI C makes
1889 this work for MANY and UNEVALLED. */
1890 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1891 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1892 #define DEFUN_ARGS_0 (void)
1893 #define DEFUN_ARGS_1 (Lisp_Object)
1894 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1895 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1896 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1897 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1899 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1900 Lisp_Object, Lisp_Object)
1901 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1902 Lisp_Object, Lisp_Object, Lisp_Object)
1903 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1904 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1906 /* Non-zero if OBJ is a Lisp function. */
1907 #define FUNCTIONP(OBJ) functionp(OBJ)
1910 is how we define the symbol for function `name' at start-up time. */
1911 extern void defsubr (struct Lisp_Subr
*);
1919 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1920 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1921 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1922 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1923 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1925 /* Macros we use to define forwarded Lisp variables.
1926 These are used in the syms_of_FILENAME functions.
1928 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1929 lisp variable is actually a field in `struct emacs_globals'. The
1930 field's name begins with "f_", which is a convention enforced by
1931 these macros. Each such global has a corresponding #define in
1932 globals.h; the plain name should be used in the code.
1934 E.g., the global "cons_cells_consed" is declared as "int
1935 f_cons_cells_consed" in globals.h, but there is a define:
1937 #define cons_cells_consed globals.f_cons_cells_consed
1939 All C code uses the `cons_cells_consed' name. This is all done
1940 this way to support indirection for multi-threaded Emacs. */
1942 #define DEFVAR_LISP(lname, vname, doc) \
1944 static struct Lisp_Objfwd o_fwd; \
1945 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1947 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1949 static struct Lisp_Objfwd o_fwd; \
1950 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1952 #define DEFVAR_BOOL(lname, vname, doc) \
1954 static struct Lisp_Boolfwd b_fwd; \
1955 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1957 #define DEFVAR_INT(lname, vname, doc) \
1959 static struct Lisp_Intfwd i_fwd; \
1960 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1963 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1965 static struct Lisp_Objfwd o_fwd; \
1966 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1969 #define DEFVAR_KBOARD(lname, vname, doc) \
1971 static struct Lisp_Kboard_Objfwd ko_fwd; \
1972 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1977 /* Structure for recording Lisp call stack for backtrace purposes. */
1979 /* The special binding stack holds the outer values of variables while
1980 they are bound by a function application or a let form, stores the
1981 code to be executed for Lisp unwind-protect forms, and stores the C
1982 functions to be called for record_unwind_protect.
1984 If func is non-zero, undoing this binding applies func to old_value;
1985 This implements record_unwind_protect.
1987 Otherwise, the element is a variable binding.
1989 If the symbol field is a symbol, it is an ordinary variable binding.
1991 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
1992 which means having bound a local value while CURRENT-BUFFER was active.
1993 If WHERE is nil this means we saw the default value when binding SYMBOL.
1994 WHERE being a buffer or frame means we saw a buffer-local or frame-local
1995 value. Other values of WHERE mean an internal error. */
1997 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2001 Lisp_Object symbol
, old_value
;
2002 specbinding_func func
;
2003 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
2006 extern struct specbinding
*specpdl
;
2007 extern struct specbinding
*specpdl_ptr
;
2008 extern ptrdiff_t specpdl_size
;
2010 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2012 /* Everything needed to describe an active condition case. */
2015 /* The handler clauses and variable from the condition-case form. */
2016 /* For a handler set up in Lisp code, this is always a list.
2017 For an internal handler set up by internal_condition_case*,
2018 this can instead be the symbol t or `error'.
2019 t: handle all conditions.
2020 error: handle all conditions, and errors can run the debugger
2021 or display a backtrace. */
2022 Lisp_Object handler
;
2024 /* Fsignal stores here the condition-case clause that applies,
2025 and Fcondition_case thus knows which clause to run. */
2026 Lisp_Object chosen_clause
;
2028 /* Used to effect the longjump out to the handler. */
2029 struct catchtag
*tag
;
2031 /* The next enclosing handler. */
2032 struct handler
*next
;
2035 /* This structure helps implement the `catch' and `throw' control
2036 structure. A struct catchtag contains all the information needed
2037 to restore the state of the interpreter after a non-local jump.
2039 Handlers for error conditions (represented by `struct handler'
2040 structures) just point to a catch tag to do the cleanup required
2043 catchtag structures are chained together in the C calling stack;
2044 the `next' member points to the next outer catchtag.
2046 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2047 member is TAG, and then unbinds to it. The `val' member is used to
2048 hold VAL while the stack is unwound; `val' is returned as the value
2051 All the other members are concerned with restoring the interpreter
2058 struct catchtag
*next
;
2059 struct gcpro
*gcpro
;
2061 struct backtrace
*backlist
;
2062 struct handler
*handlerlist
;
2063 EMACS_INT lisp_eval_depth
;
2065 int poll_suppress_count
;
2066 int interrupt_input_blocked
;
2067 struct byte_stack
*byte_stack
;
2070 extern Lisp_Object memory_signal_data
;
2072 /* An address near the bottom of the stack.
2073 Tells GC how to save a copy of the stack. */
2074 extern char *stack_bottom
;
2076 /* Check quit-flag and quit if it is non-nil.
2077 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2078 So the program needs to do QUIT at times when it is safe to quit.
2079 Every loop that might run for a long time or might not exit
2080 ought to do QUIT at least once, at a safe place.
2081 Unless that is impossible, of course.
2082 But it is very desirable to avoid creating loops where QUIT is impossible.
2084 Exception: if you set immediate_quit to nonzero,
2085 then the handler that responds to the C-g does the quit itself.
2086 This is a good thing to do around a loop that has no side effects
2087 and (in particular) cannot call arbitrary Lisp code.
2089 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2090 a request to exit Emacs when it is safe to do. */
2093 extern void process_pending_signals (void);
2094 extern int pending_signals
;
2095 #define ELSE_PENDING_SIGNALS \
2096 else if (pending_signals) \
2097 process_pending_signals ();
2098 #else /* not SYNC_INPUT */
2099 #define ELSE_PENDING_SIGNALS
2100 #endif /* not SYNC_INPUT */
2102 extern void process_quit_flag (void);
2105 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2106 process_quit_flag (); \
2107 ELSE_PENDING_SIGNALS \
2111 /* Nonzero if ought to quit now. */
2113 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2115 extern Lisp_Object Vascii_downcase_table
;
2116 extern Lisp_Object Vascii_canon_table
;
2118 /* Structure for recording stack slots that need marking. */
2120 /* This is a chain of structures, each of which points at a Lisp_Object
2121 variable whose value should be marked in garbage collection.
2122 Normally every link of the chain is an automatic variable of a function,
2123 and its `val' points to some argument or local variable of the function.
2124 On exit to the function, the chain is set back to the value it had on entry.
2125 This way, no link remains in the chain when the stack frame containing the
2128 Every function that can call Feval must protect in this fashion all
2129 Lisp_Object variables whose contents will be used again. */
2131 extern struct gcpro
*gcprolist
;
2137 /* Address of first protected variable. */
2138 volatile Lisp_Object
*var
;
2140 /* Number of consecutive protected variables. */
2148 /* Values of GC_MARK_STACK during compilation:
2150 0 Use GCPRO as before
2151 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2152 2 Mark the stack, and check that everything GCPRO'd is
2154 3 Mark using GCPRO's, mark stack last, and count how many
2155 dead objects are kept alive. */
2158 #define GC_USE_GCPROS_AS_BEFORE 0
2159 #define GC_MAKE_GCPROS_NOOPS 1
2160 #define GC_MARK_STACK_CHECK_GCPROS 2
2161 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2163 #ifndef GC_MARK_STACK
2164 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2167 /* Whether we do the stack marking manually. */
2168 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2169 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2172 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2174 /* Do something silly with gcproN vars just so gcc shuts up. */
2175 /* You get warnings from MIPSPro... */
2177 #define GCPRO1(varname) ((void) gcpro1)
2178 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2179 #define GCPRO3(varname1, varname2, varname3) \
2180 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2181 #define GCPRO4(varname1, varname2, varname3, varname4) \
2182 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2183 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2184 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2185 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2186 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2188 #define UNGCPRO ((void) 0)
2190 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2194 #define GCPRO1(varname) \
2195 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2196 gcprolist = &gcpro1; }
2198 #define GCPRO2(varname1, varname2) \
2199 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2200 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2201 gcprolist = &gcpro2; }
2203 #define GCPRO3(varname1, varname2, varname3) \
2204 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2205 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2206 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2207 gcprolist = &gcpro3; }
2209 #define GCPRO4(varname1, varname2, varname3, varname4) \
2210 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2211 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2212 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2213 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2214 gcprolist = &gcpro4; }
2216 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2217 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2218 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2219 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2220 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2221 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2222 gcprolist = &gcpro5; }
2224 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2225 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2226 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2227 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2228 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2229 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2230 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2231 gcprolist = &gcpro6; }
2233 #define UNGCPRO (gcprolist = gcpro1.next)
2237 extern int gcpro_level
;
2239 #define GCPRO1(varname) \
2240 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2241 gcpro1.level = gcpro_level++; \
2242 gcprolist = &gcpro1; }
2244 #define GCPRO2(varname1, varname2) \
2245 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2246 gcpro1.level = gcpro_level; \
2247 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2248 gcpro2.level = gcpro_level++; \
2249 gcprolist = &gcpro2; }
2251 #define GCPRO3(varname1, varname2, varname3) \
2252 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2253 gcpro1.level = gcpro_level; \
2254 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2255 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2256 gcpro3.level = gcpro_level++; \
2257 gcprolist = &gcpro3; }
2259 #define GCPRO4(varname1, varname2, varname3, varname4) \
2260 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2261 gcpro1.level = gcpro_level; \
2262 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2263 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2264 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2265 gcpro4.level = gcpro_level++; \
2266 gcprolist = &gcpro4; }
2268 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2269 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2270 gcpro1.level = gcpro_level; \
2271 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2272 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2273 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2274 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2275 gcpro5.level = gcpro_level++; \
2276 gcprolist = &gcpro5; }
2278 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2279 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2280 gcpro1.level = gcpro_level; \
2281 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2282 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2283 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2284 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2285 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2286 gcpro6.level = gcpro_level++; \
2287 gcprolist = &gcpro6; }
2290 ((--gcpro_level != gcpro1.level) \
2291 ? (emacs_abort (), 0) \
2292 : ((gcprolist = gcpro1.next), 0))
2294 #endif /* DEBUG_GCPRO */
2295 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2298 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2299 #define RETURN_UNGCPRO(expr) \
2302 Lisp_Object ret_ungc_val; \
2303 ret_ungc_val = (expr); \
2305 return ret_ungc_val; \
2309 /* Call staticpro (&var) to protect static variable `var'. */
2311 void staticpro (Lisp_Object
*);
2313 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2314 meaning as in the DEFUN macro, and is used to construct a prototype. */
2315 /* We can use the same trick as in the DEFUN macro to generate the
2316 appropriate prototype. */
2317 #define EXFUN(fnname, maxargs) \
2318 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2320 /* Forward declarations for prototypes. */
2324 /* Simple access functions. */
2326 LISP_INLINE Lisp_Object
*
2327 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2329 return & XVECTOR (array
)->contents
[idx
];
2333 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2335 /* Like ASET, but also can be used in the garbage collector:
2336 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2337 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2338 XVECTOR (array
)->contents
[idx
] = val
;
2341 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2344 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2346 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2347 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2350 /* Functions to modify hash tables. */
2353 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2355 h
->key_and_value
= key_and_value
;
2359 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2361 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2365 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2367 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2371 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2377 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2379 gc_aset (h
->next
, idx
, val
);
2383 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2389 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2391 gc_aset (h
->hash
, idx
, val
);
2395 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2401 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2403 gc_aset (h
->index
, idx
, val
);
2406 /* Use these functions to set Lisp_Object
2407 or pointer slots of struct Lisp_Symbol. */
2410 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2412 XSYMBOL (sym
)->name
= name
;
2416 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2418 XSYMBOL (sym
)->function
= function
;
2422 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2424 XSYMBOL (sym
)->plist
= plist
;
2428 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2430 XSYMBOL (sym
)->next
= next
;
2433 /* Buffer-local (also frame-local) variable access functions. */
2436 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2438 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2443 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2445 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2449 LISP_INLINE Lisp_Object
2450 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2452 return XCDR (blv
->valcell
);
2456 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2458 XSETCDR (blv
->valcell
, val
);
2462 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2468 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2474 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2479 /* Set overlay's property list. */
2482 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2484 XOVERLAY (overlay
)->plist
= plist
;
2487 /* Get text properties of S. */
2489 LISP_INLINE INTERVAL
2490 string_intervals (Lisp_Object s
)
2492 return XSTRING (s
)->intervals
;
2495 /* Set text properties of S to I. */
2498 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2500 XSTRING (s
)->intervals
= i
;
2503 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2504 of setting slots directly. */
2507 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2509 XCHAR_TABLE (table
)->ascii
= val
;
2512 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2514 XCHAR_TABLE (table
)->defalt
= val
;
2517 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2519 XCHAR_TABLE (table
)->parent
= val
;
2522 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2524 XCHAR_TABLE (table
)->purpose
= val
;
2527 /* Set different slots in (sub)character tables. */
2530 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2532 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2533 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2537 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2539 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2540 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2544 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2546 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2549 /* Defined in data.c. */
2550 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2551 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2552 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2553 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2554 extern Lisp_Object Qinvalid_read_syntax
;
2555 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2556 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2557 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2558 extern Lisp_Object Qtext_read_only
;
2559 extern Lisp_Object Qinteractive_form
;
2560 extern Lisp_Object Qcircular_list
;
2561 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2562 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2563 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2564 extern Lisp_Object Qbuffer_or_string_p
;
2565 extern Lisp_Object Qfboundp
;
2566 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2568 extern Lisp_Object Qcdr
;
2570 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2571 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2573 extern Lisp_Object Qfloatp
;
2574 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2576 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2578 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2580 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2582 /* Defined in frame.c */
2583 extern Lisp_Object Qframep
;
2585 /* Defined in data.c */
2586 extern Lisp_Object
indirect_function (Lisp_Object
);
2587 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2589 /* Convert the integer I to an Emacs representation, either the integer
2590 itself, or a cons of two or three integers, or if all else fails a float.
2591 I should not have side effects. */
2592 #define INTEGER_TO_CONS(i) \
2593 (! FIXNUM_OVERFLOW_P (i) \
2595 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2596 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2597 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2598 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2599 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2600 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2601 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2602 ? Fcons (make_number ((i) >> 16 >> 24), \
2603 Fcons (make_number ((i) >> 16 & 0xffffff), \
2604 make_number ((i) & 0xffff))) \
2607 /* Convert the Emacs representation CONS back to an integer of type
2608 TYPE, storing the result the variable VAR. Signal an error if CONS
2609 is not a valid representation or is out of range for TYPE. */
2610 #define CONS_TO_INTEGER(cons, type, var) \
2611 (TYPE_SIGNED (type) \
2612 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2613 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2614 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2615 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2617 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2618 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2619 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2621 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2622 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2623 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2624 extern void syms_of_data (void);
2625 extern void init_data (void);
2626 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2628 /* Defined in cmds.c */
2629 extern void syms_of_cmds (void);
2630 extern void keys_of_cmds (void);
2632 /* Defined in coding.c */
2633 extern Lisp_Object Qcharset
;
2634 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2635 ptrdiff_t, bool, bool, Lisp_Object
);
2636 extern void init_coding (void);
2637 extern void init_coding_once (void);
2638 extern void syms_of_coding (void);
2640 /* Defined in character.c */
2641 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2642 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2643 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2644 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2645 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2646 extern void syms_of_character (void);
2648 /* Defined in charset.c */
2649 extern void init_charset (void);
2650 extern void init_charset_once (void);
2651 extern void syms_of_charset (void);
2652 /* Structure forward declarations. */
2655 /* Defined in composite.c */
2656 extern void syms_of_composite (void);
2658 /* Defined in syntax.c */
2659 extern void init_syntax_once (void);
2660 extern void syms_of_syntax (void);
2662 /* Defined in fns.c */
2663 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2664 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2665 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2666 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2667 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2668 extern void sweep_weak_hash_tables (void);
2669 extern Lisp_Object Qcursor_in_echo_area
;
2670 extern Lisp_Object Qstring_lessp
;
2671 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2672 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2673 EMACS_UINT
sxhash (Lisp_Object
, int);
2674 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2675 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2677 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2678 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2681 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2682 ptrdiff_t, ptrdiff_t);
2683 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2684 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2685 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2686 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2687 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2688 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2689 extern void clear_string_char_byte_cache (void);
2690 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2691 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2692 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2693 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2694 extern void syms_of_fns (void);
2696 /* Defined in floatfns.c */
2697 extern double extract_float (Lisp_Object
);
2698 extern void init_floatfns (void);
2699 extern void syms_of_floatfns (void);
2700 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2702 /* Defined in fringe.c */
2703 extern void syms_of_fringe (void);
2704 extern void init_fringe (void);
2705 #ifdef HAVE_WINDOW_SYSTEM
2706 extern void mark_fringe_data (void);
2707 extern void init_fringe_once (void);
2708 #endif /* HAVE_WINDOW_SYSTEM */
2710 /* Defined in image.c */
2711 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2712 extern Lisp_Object QCconversion
;
2713 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2714 extern void syms_of_image (void);
2716 /* Defined in insdel.c */
2717 extern Lisp_Object Qinhibit_modification_hooks
;
2718 extern void move_gap (ptrdiff_t);
2719 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2720 extern _Noreturn
void buffer_overflow (void);
2721 extern void make_gap (ptrdiff_t);
2722 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2723 ptrdiff_t, bool, bool);
2724 extern int count_combining_before (const unsigned char *,
2725 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2726 extern int count_combining_after (const unsigned char *,
2727 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2728 extern void insert (const char *, ptrdiff_t);
2729 extern void insert_and_inherit (const char *, ptrdiff_t);
2730 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2731 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2733 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2734 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2735 ptrdiff_t, ptrdiff_t, bool);
2736 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2737 extern void insert_char (int);
2738 extern void insert_string (const char *);
2739 extern void insert_before_markers (const char *, ptrdiff_t);
2740 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2741 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2742 ptrdiff_t, ptrdiff_t,
2744 extern void del_range (ptrdiff_t, ptrdiff_t);
2745 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2746 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2747 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2748 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2749 ptrdiff_t, ptrdiff_t, bool);
2750 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2751 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2752 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2753 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2754 ptrdiff_t, ptrdiff_t);
2755 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2756 ptrdiff_t, ptrdiff_t);
2757 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2758 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2759 const char *, ptrdiff_t, ptrdiff_t, bool);
2760 extern void syms_of_insdel (void);
2762 /* Defined in dispnew.c */
2763 #if (defined PROFILING \
2764 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2765 _Noreturn
void __executable_start (void);
2767 extern Lisp_Object selected_frame
;
2768 extern Lisp_Object Vwindow_system
;
2769 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2770 extern void init_display (void);
2771 extern void syms_of_display (void);
2773 /* Defined in xdisp.c */
2774 extern Lisp_Object Qinhibit_point_motion_hooks
;
2775 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2776 extern Lisp_Object Qmenu_bar_update_hook
;
2777 extern Lisp_Object Qwindow_scroll_functions
;
2778 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2779 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2780 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2781 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2782 extern Lisp_Object Qleft_margin
, Qright_margin
;
2783 extern Lisp_Object Qglyphless_char
;
2784 extern Lisp_Object QCdata
, QCfile
;
2785 extern Lisp_Object QCmap
;
2786 extern Lisp_Object Qrisky_local_variable
;
2787 extern struct frame
*last_glyphless_glyph_frame
;
2788 extern int last_glyphless_glyph_face_id
;
2789 extern int last_glyphless_glyph_merged_face_id
;
2790 extern int noninteractive_need_newline
;
2791 extern Lisp_Object echo_area_buffer
[2];
2792 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2793 extern void check_message_stack (void);
2794 extern void setup_echo_area_for_printing (int);
2795 extern bool push_message (void);
2796 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2797 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2798 extern void restore_message (void);
2799 extern Lisp_Object
current_message (void);
2800 extern void clear_message (int, int);
2801 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2802 extern void message1 (const char *);
2803 extern void message1_nolog (const char *);
2804 extern void message2 (const char *, ptrdiff_t, int);
2805 extern void message2_nolog (const char *, ptrdiff_t, int);
2806 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2807 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2808 extern void message_dolog (const char *, ptrdiff_t, int, int);
2809 extern void message_with_string (const char *, Lisp_Object
, int);
2810 extern void message_log_maybe_newline (void);
2811 extern void update_echo_area (void);
2812 extern void truncate_echo_area (ptrdiff_t);
2813 extern void redisplay (void);
2814 extern void redisplay_preserve_echo_area (int);
2815 extern void prepare_menu_bars (void);
2817 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2818 extern void syms_of_xdisp (void);
2819 extern void init_xdisp (void);
2820 extern Lisp_Object
safe_eval (Lisp_Object
);
2821 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2822 int *, int *, int *, int *, int *);
2824 /* Defined in xsettings.c */
2825 extern void syms_of_xsettings (void);
2827 /* Defined in vm-limit.c. */
2828 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2830 /* Defined in alloc.c */
2831 extern void check_pure_size (void);
2832 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2833 extern void reset_malloc_hooks (void);
2834 extern void uninterrupt_malloc (void);
2835 extern void malloc_warning (const char *);
2836 extern _Noreturn
void memory_full (size_t);
2837 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2838 extern bool survives_gc_p (Lisp_Object
);
2839 extern void mark_object (Lisp_Object
);
2840 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2841 extern void refill_memory_reserve (void);
2843 extern const char *pending_malloc_warning
;
2844 extern Lisp_Object zero_vector
;
2845 extern Lisp_Object
*stack_base
;
2846 extern EMACS_INT consing_since_gc
;
2847 extern EMACS_INT gc_relative_threshold
;
2848 extern EMACS_INT memory_full_cons_threshold
;
2849 extern Lisp_Object
list1 (Lisp_Object
);
2850 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2851 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2852 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2853 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2855 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2856 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2857 extern _Noreturn
void string_overflow (void);
2858 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2859 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2860 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2861 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2863 /* Make unibyte string from C string when the length isn't known. */
2865 LISP_INLINE Lisp_Object
2866 build_unibyte_string (const char *str
)
2868 return make_unibyte_string (str
, strlen (str
));
2871 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2872 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2873 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2874 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2875 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2876 extern Lisp_Object
make_specified_string (const char *,
2877 ptrdiff_t, ptrdiff_t, bool);
2878 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2879 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2881 /* Make a string allocated in pure space, use STR as string data. */
2883 LISP_INLINE Lisp_Object
2884 build_pure_c_string (const char *str
)
2886 return make_pure_c_string (str
, strlen (str
));
2889 /* Make a string from the data at STR, treating it as multibyte if the
2892 LISP_INLINE Lisp_Object
2893 build_string (const char *str
)
2895 return make_string (str
, strlen (str
));
2898 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2899 extern void make_byte_code (struct Lisp_Vector
*);
2900 extern Lisp_Object Qchar_table_extra_slots
;
2901 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2902 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2903 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2905 allocate_pseudovector \
2906 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2907 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2908 extern struct window
*allocate_window (void);
2909 extern struct frame
*allocate_frame (void);
2910 extern struct Lisp_Process
*allocate_process (void);
2911 extern struct terminal
*allocate_terminal (void);
2912 extern bool gc_in_progress
;
2913 extern bool abort_on_gc
;
2914 extern Lisp_Object
make_float (double);
2915 extern void display_malloc_warning (void);
2916 extern ptrdiff_t inhibit_garbage_collection (void);
2917 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2918 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2919 extern void free_marker (Lisp_Object
);
2920 extern void free_cons (struct Lisp_Cons
*);
2921 extern void init_alloc_once (void);
2922 extern void init_alloc (void);
2923 extern void syms_of_alloc (void);
2924 extern struct buffer
* allocate_buffer (void);
2925 extern int valid_lisp_object_p (Lisp_Object
);
2926 #ifdef GC_CHECK_CONS_LIST
2927 extern void check_cons_list (void);
2929 #define check_cons_list() ((void) 0)
2933 /* Defined in ralloc.c */
2934 extern void *r_alloc (void **, size_t);
2935 extern void r_alloc_free (void **);
2936 extern void *r_re_alloc (void **, size_t);
2937 extern void r_alloc_reset_variable (void **, void **);
2938 extern void r_alloc_inhibit_buffer_relocation (int);
2941 /* Defined in chartab.c */
2942 extern Lisp_Object
copy_char_table (Lisp_Object
);
2943 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2944 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2946 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
2947 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
2948 extern int char_table_translate (Lisp_Object
, int);
2949 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2951 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2952 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2953 Lisp_Object
, Lisp_Object
,
2954 Lisp_Object
, struct charset
*,
2955 unsigned, unsigned);
2956 extern Lisp_Object
uniprop_table (Lisp_Object
);
2957 extern void syms_of_chartab (void);
2959 /* Defined in print.c */
2960 extern Lisp_Object Vprin1_to_string_buffer
;
2961 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2962 extern Lisp_Object Qstandard_output
;
2963 extern Lisp_Object Qexternal_debugging_output
;
2964 extern void temp_output_buffer_setup (const char *);
2965 extern int print_level
;
2966 extern Lisp_Object Qprint_escape_newlines
;
2967 extern void write_string (const char *, int);
2968 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2970 extern Lisp_Object internal_with_output_to_temp_buffer
2971 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2972 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
2973 extern int float_to_string (char *, double);
2974 extern void syms_of_print (void);
2976 /* Defined in doprnt.c */
2977 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2979 extern ptrdiff_t esprintf (char *, char const *, ...)
2980 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2981 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2983 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2984 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2985 char const *, va_list)
2986 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2988 /* Defined in lread.c. */
2989 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2990 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2991 extern Lisp_Object Qlexical_binding
;
2992 extern Lisp_Object
check_obarray (Lisp_Object
);
2993 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
2994 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
2995 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
2996 #define LOADHIST_ATTACH(x) \
2998 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3000 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3001 Lisp_Object
*, Lisp_Object
);
3002 Lisp_Object
string_to_number (char const *, int, int);
3003 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3005 extern void dir_warning (const char *, Lisp_Object
);
3006 extern void close_load_descs (void);
3007 extern void init_obarray (void);
3008 extern void init_lread (void);
3009 extern void syms_of_lread (void);
3011 LISP_INLINE Lisp_Object
3012 intern (const char *str
)
3014 return intern_1 (str
, strlen (str
));
3017 LISP_INLINE Lisp_Object
3018 intern_c_string (const char *str
)
3020 return intern_c_string_1 (str
, strlen (str
));
3023 /* Defined in eval.c. */
3024 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3025 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3026 extern Lisp_Object Qand_rest
;
3027 extern Lisp_Object Vautoload_queue
;
3028 extern Lisp_Object Vsignaling_function
;
3029 extern Lisp_Object inhibit_lisp_code
;
3030 extern int handling_signal
;
3032 extern struct catchtag
*catchlist
;
3033 extern struct handler
*handlerlist
;
3035 /* To run a normal hook, use the appropriate function from the list below.
3036 The calling convention:
3038 if (!NILP (Vrun_hooks))
3039 call1 (Vrun_hooks, Qmy_funny_hook);
3041 should no longer be used. */
3042 extern Lisp_Object Vrun_hooks
;
3043 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3044 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3045 Lisp_Object (*funcall
)
3046 (ptrdiff_t nargs
, Lisp_Object
*args
));
3047 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3048 extern _Noreturn
void xsignal0 (Lisp_Object
);
3049 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3050 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3051 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3053 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3054 extern Lisp_Object
eval_sub (Lisp_Object form
);
3055 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3056 extern Lisp_Object
call0 (Lisp_Object
);
3057 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3058 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3059 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3060 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3061 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3062 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3063 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3064 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3065 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3066 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3067 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3068 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3069 extern Lisp_Object internal_condition_case_n
3070 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3071 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3072 extern void specbind (Lisp_Object
, Lisp_Object
);
3073 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3074 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3075 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3076 extern _Noreturn
void verror (const char *, va_list)
3077 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3078 extern Lisp_Object
un_autoload (Lisp_Object
);
3079 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3080 extern void init_eval_once (void);
3081 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3082 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3083 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3084 extern void init_eval (void);
3086 extern void mark_backtrace (void);
3088 extern void syms_of_eval (void);
3090 /* Defined in editfns.c. */
3091 extern Lisp_Object Qfield
;
3092 extern void insert1 (Lisp_Object
);
3093 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3094 extern Lisp_Object
save_excursion_save (void);
3095 extern Lisp_Object
save_restriction_save (void);
3096 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3097 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3098 extern _Noreturn
void time_overflow (void);
3099 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3100 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3102 extern void init_editfns (void);
3103 const char *get_system_name (void);
3104 extern void syms_of_editfns (void);
3105 extern void set_time_zone_rule (const char *);
3107 /* Defined in buffer.c. */
3108 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3109 extern _Noreturn
void nsberror (Lisp_Object
);
3110 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3111 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3112 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3113 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3114 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3115 extern bool overlay_touches_p (ptrdiff_t);
3116 extern Lisp_Object Vbuffer_alist
;
3117 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3118 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3119 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3120 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3121 extern void init_buffer_once (void);
3122 extern void init_buffer (void);
3123 extern void syms_of_buffer (void);
3124 extern void keys_of_buffer (void);
3126 /* Defined in marker.c. */
3128 extern ptrdiff_t marker_position (Lisp_Object
);
3129 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3130 extern void clear_charpos_cache (struct buffer
*);
3131 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3132 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3133 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3134 extern void unchain_marker (struct Lisp_Marker
*marker
);
3135 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3136 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3137 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3138 ptrdiff_t, ptrdiff_t);
3139 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3140 extern void syms_of_marker (void);
3142 /* Defined in fileio.c */
3144 extern Lisp_Object Qfile_error
;
3145 extern Lisp_Object Qfile_exists_p
;
3146 extern Lisp_Object Qfile_directory_p
;
3147 extern Lisp_Object Qinsert_file_contents
;
3148 extern Lisp_Object Qfile_name_history
;
3149 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3150 EXFUN (Fread_file_name
, 6); /* not a normal DEFUN */
3151 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3152 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3153 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3154 extern int internal_delete_file (Lisp_Object
);
3155 extern void syms_of_fileio (void);
3156 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
3157 extern Lisp_Object Qdelete_file
;
3159 /* Defined in search.c */
3160 extern void shrink_regexp_cache (void);
3161 extern void restore_search_regs (void);
3162 extern void record_unwind_save_match_data (void);
3163 struct re_registers
;
3164 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3165 struct re_registers
*,
3166 Lisp_Object
, int, int);
3167 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3168 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3170 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3171 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3172 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3173 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3175 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3177 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3178 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3179 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3180 extern void syms_of_search (void);
3181 extern void clear_regexp_cache (void);
3183 /* Defined in minibuf.c. */
3185 extern Lisp_Object Qcompletion_ignore_case
;
3186 extern Lisp_Object Vminibuffer_list
;
3187 extern Lisp_Object last_minibuf_string
;
3188 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3189 extern void init_minibuf_once (void);
3190 extern void syms_of_minibuf (void);
3192 /* Defined in callint.c. */
3194 extern Lisp_Object Qminus
, Qplus
;
3195 extern Lisp_Object Qwhen
;
3196 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3197 extern void syms_of_callint (void);
3199 /* Defined in casefiddle.c. */
3201 extern Lisp_Object Qidentity
;
3202 extern void syms_of_casefiddle (void);
3203 extern void keys_of_casefiddle (void);
3205 /* Defined in casetab.c. */
3207 extern void init_casetab_once (void);
3208 extern void syms_of_casetab (void);
3210 /* Defined in keyboard.c. */
3212 extern Lisp_Object echo_message_buffer
;
3213 extern struct kboard
*echo_kboard
;
3214 extern void cancel_echoing (void);
3215 extern Lisp_Object Qdisabled
, QCfilter
;
3216 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3217 extern Lisp_Object Qtop
;
3218 extern Lisp_Object last_undo_boundary
;
3219 extern int input_pending
;
3220 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3221 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3222 extern void discard_mouse_events (void);
3223 extern Lisp_Object pending_funcalls
;
3224 extern int detect_input_pending (void);
3225 extern int detect_input_pending_ignore_squeezables (void);
3226 extern int detect_input_pending_run_timers (int);
3227 extern void safe_run_hooks (Lisp_Object
);
3228 extern void cmd_error_internal (Lisp_Object
, const char *);
3229 extern Lisp_Object
command_loop_1 (void);
3230 extern Lisp_Object
recursive_edit_1 (void);
3231 extern void record_auto_save (void);
3233 extern void force_auto_save_soon (void);
3235 extern void init_keyboard (void);
3236 extern void syms_of_keyboard (void);
3237 extern void keys_of_keyboard (void);
3239 /* Defined in indent.c. */
3240 extern ptrdiff_t current_column (void);
3241 extern void invalidate_current_column (void);
3242 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3243 extern void syms_of_indent (void);
3245 /* Defined in frame.c. */
3246 extern Lisp_Object Qonly
, Qnone
;
3247 extern Lisp_Object Qvisible
;
3248 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3249 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3250 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3252 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3254 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3255 extern void frames_discard_buffer (Lisp_Object
);
3256 extern void syms_of_frame (void);
3258 /* Defined in emacs.c. */
3259 extern char **initial_argv
;
3260 extern int initial_argc
;
3261 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3262 extern bool display_arg
;
3264 extern Lisp_Object
decode_env_path (const char *, const char *);
3265 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3266 extern Lisp_Object Qfile_name_handler_alist
;
3267 #ifdef FLOAT_CATCH_SIGILL
3268 extern void fatal_error_signal (int);
3270 extern _Noreturn
void fatal_error_backtrace (int, int);
3271 extern Lisp_Object Qkill_emacs
;
3273 void fixup_locale (void);
3274 void synchronize_system_messages_locale (void);
3275 void synchronize_system_time_locale (void);
3277 #define setlocale(category, locale)
3278 #define fixup_locale()
3279 #define synchronize_system_messages_locale()
3280 #define synchronize_system_time_locale()
3282 extern void shut_down_emacs (int, Lisp_Object
);
3284 /* True means don't do interactive redisplay and don't change tty modes. */
3285 extern bool noninteractive
;
3287 /* True means remove site-lisp directories from load-path. */
3288 extern bool no_site_lisp
;
3290 /* Pipe used to send exit notification to the daemon parent at
3292 extern int daemon_pipe
[2];
3293 #define IS_DAEMON (daemon_pipe[1] != 0)
3295 /* True if handling a fatal error already. */
3296 extern bool fatal_error_in_progress
;
3298 /* True means don't do use window-system-specific display code. */
3299 extern bool inhibit_window_system
;
3300 /* True means that a filter or a sentinel is running. */
3301 extern bool running_asynch_code
;
3303 /* Defined in process.c. */
3304 extern Lisp_Object QCtype
, Qlocal
;
3305 extern Lisp_Object Qprocessp
;
3306 extern void kill_buffer_processes (Lisp_Object
);
3307 extern int wait_reading_process_output (intmax_t, int, int, int,
3309 struct Lisp_Process
*,
3311 /* Max value for the first argument of wait_reading_process_output. */
3312 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3313 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3314 The bug merely causes a bogus warning, but the warning is annoying. */
3315 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3317 # define WAIT_READING_MAX INTMAX_MAX
3319 extern void add_keyboard_wait_descriptor (int);
3320 extern void delete_keyboard_wait_descriptor (int);
3322 extern void add_gpm_wait_descriptor (int);
3323 extern void delete_gpm_wait_descriptor (int);
3325 extern void close_process_descs (void);
3326 extern void init_process_emacs (void);
3327 extern void syms_of_process (void);
3328 extern void setup_process_coding_systems (Lisp_Object
);
3333 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3334 extern void init_callproc_1 (void);
3335 extern void init_callproc (void);
3336 extern void set_initial_environment (void);
3337 extern void syms_of_callproc (void);
3339 /* Defined in doc.c */
3340 extern Lisp_Object Qfunction_documentation
;
3341 extern Lisp_Object
read_doc_string (Lisp_Object
);
3342 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3343 extern void syms_of_doc (void);
3344 extern int read_bytecode_char (bool);
3346 /* Defined in bytecode.c */
3347 extern Lisp_Object Qbytecode
;
3348 extern void syms_of_bytecode (void);
3349 extern struct byte_stack
*byte_stack_list
;
3351 extern void mark_byte_stack (void);
3353 extern void unmark_byte_stack (void);
3354 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3355 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3357 /* Defined in macros.c */
3358 extern Lisp_Object Qexecute_kbd_macro
;
3359 extern void init_macros (void);
3360 extern void syms_of_macros (void);
3362 /* Defined in undo.c */
3363 extern Lisp_Object Qapply
;
3364 extern Lisp_Object Qinhibit_read_only
;
3365 extern void truncate_undo_list (struct buffer
*);
3366 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3367 extern void record_insert (ptrdiff_t, ptrdiff_t);
3368 extern void record_delete (ptrdiff_t, Lisp_Object
);
3369 extern void record_first_change (void);
3370 extern void record_change (ptrdiff_t, ptrdiff_t);
3371 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3372 Lisp_Object
, Lisp_Object
,
3374 extern void syms_of_undo (void);
3375 /* Defined in textprop.c */
3376 extern Lisp_Object Qfont
, Qmouse_face
;
3377 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3378 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3379 extern Lisp_Object Qminibuffer_prompt
;
3381 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3383 /* Defined in menu.c */
3384 extern void syms_of_menu (void);
3386 /* Defined in xmenu.c */
3387 extern void syms_of_xmenu (void);
3389 /* Defined in termchar.h */
3390 struct tty_display_info
;
3392 /* Defined in termhooks.h */
3395 /* Defined in sysdep.c */
3396 #ifndef HAVE_GET_CURRENT_DIR_NAME
3397 extern char *get_current_dir_name (void);
3399 extern void stuff_char (char c
);
3400 extern void init_sigio (int);
3401 extern void sys_subshell (void);
3402 extern void sys_suspend (void);
3403 extern void discard_tty_input (void);
3404 extern void init_sys_modes (struct tty_display_info
*);
3405 extern void reset_sys_modes (struct tty_display_info
*);
3406 extern void init_all_sys_modes (void);
3407 extern void reset_all_sys_modes (void);
3408 extern void wait_for_termination (pid_t
);
3409 extern void interruptible_wait_for_termination (pid_t
);
3410 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3411 extern void child_setup_tty (int);
3412 extern void setup_pty (int);
3413 extern int set_window_size (int, int, int);
3414 extern EMACS_INT
get_random (void);
3415 extern void seed_random (void *, ptrdiff_t);
3416 extern void init_random (void);
3417 extern void emacs_backtrace (int);
3418 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3419 extern int emacs_open (const char *, int, int);
3420 extern int emacs_close (int);
3421 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3422 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3423 enum { READLINK_BUFSIZE
= 1024 };
3424 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3426 extern void unlock_all_files (void);
3427 extern void lock_file (Lisp_Object
);
3428 extern void unlock_file (Lisp_Object
);
3429 extern void unlock_buffer (struct buffer
*);
3430 extern void syms_of_filelock (void);
3432 /* Defined in sound.c */
3433 extern void syms_of_sound (void);
3435 /* Defined in category.c */
3436 extern void init_category_once (void);
3437 extern Lisp_Object
char_category_set (int);
3438 extern void syms_of_category (void);
3440 /* Defined in ccl.c */
3441 extern void syms_of_ccl (void);
3443 /* Defined in dired.c */
3444 extern void syms_of_dired (void);
3445 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3446 Lisp_Object
, Lisp_Object
,
3449 /* Defined in term.c */
3450 extern int *char_ins_del_vector
;
3451 extern void syms_of_term (void);
3452 extern _Noreturn
void fatal (const char *msgid
, ...)
3453 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3455 /* Defined in terminal.c */
3456 extern void syms_of_terminal (void);
3458 /* Defined in font.c */
3459 extern void syms_of_font (void);
3460 extern void init_font (void);
3462 #ifdef HAVE_WINDOW_SYSTEM
3463 /* Defined in fontset.c */
3464 extern void syms_of_fontset (void);
3466 /* Defined in xfns.c, w32fns.c, or macfns.c */
3467 extern Lisp_Object Qfont_param
;
3470 /* Defined in xfaces.c */
3471 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3472 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3473 extern Lisp_Object Qmode_line_inactive
;
3474 extern Lisp_Object Qface
;
3475 extern Lisp_Object Qnormal
;
3476 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3477 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3478 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3479 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3480 extern Lisp_Object Qoblique
, Qitalic
;
3481 extern Lisp_Object Vface_alternative_font_family_alist
;
3482 extern Lisp_Object Vface_alternative_font_registry_alist
;
3483 extern void syms_of_xfaces (void);
3485 #ifdef HAVE_X_WINDOWS
3486 /* Defined in xfns.c */
3487 extern void syms_of_xfns (void);
3489 /* Defined in xsmfns.c */
3490 extern void syms_of_xsmfns (void);
3492 /* Defined in xselect.c */
3493 extern void syms_of_xselect (void);
3495 /* Defined in xterm.c */
3496 extern void syms_of_xterm (void);
3497 #endif /* HAVE_X_WINDOWS */
3499 #ifdef HAVE_WINDOW_SYSTEM
3500 /* Defined in xterm.c, nsterm.m, w32term.c */
3501 extern char *x_get_keysym_name (int);
3502 #endif /* HAVE_WINDOW_SYSTEM */
3505 /* Defined in xml.c */
3506 extern void syms_of_xml (void);
3507 extern void xml_cleanup_parser (void);
3511 /* Defined in (x|w32)fns.c, nsfns.m... */
3512 extern int have_menus_p (void);
3516 /* Defined in dbusbind.c */
3517 void syms_of_dbusbind (void);
3521 /* Defined in msdos.c, w32.c */
3522 extern char *emacs_root_dir (void);
3525 /* True means Emacs has already been initialized.
3526 Used during startup to detect startup of dumped Emacs. */
3527 extern bool initialized
;
3529 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3531 extern void *xmalloc (size_t);
3532 extern void *xzalloc (size_t);
3533 extern void *xrealloc (void *, size_t);
3534 extern void xfree (void *);
3535 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3536 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3537 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3539 extern char *xstrdup (const char *);
3541 extern char *egetenv (const char *);
3543 /* Set up the name of the machine we're running on. */
3544 extern void init_system_name (void);
3546 /* We used to use `abs', but that clashes with system headers on some
3547 platforms, and using a name reserved by Standard C is a bad idea
3550 #define eabs(x) ((x) < 0 ? -(x) : (x))
3553 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3556 #define make_fixnum_or_float(val) \
3557 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3560 /* Checks the `cycle check' variable CHECK to see if it indicates that
3561 EL is part of a cycle; CHECK must be either Qnil or a value returned
3562 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3563 elements after which a cycle might be suspected; after that many
3564 elements, this macro begins consing in order to keep more precise
3567 Returns nil if a cycle was detected, otherwise a new value for CHECK
3570 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3571 the caller should make sure that's ok. */
3573 #define CYCLE_CHECK(check, el, suspicious) \
3576 : (INTEGERP (check) \
3577 ? (XFASTINT (check) < (suspicious) \
3578 ? make_number (XFASTINT (check) + 1) \
3579 : Fcons (el, Qnil)) \
3580 : (!NILP (Fmemq ((el), (check))) \
3582 : Fcons ((el), (check)))))
3585 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3586 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3588 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16*1024 };
3590 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3591 extern void *record_xmalloc (size_t);
3593 #define USE_SAFE_ALLOCA \
3594 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3596 /* SAFE_ALLOCA allocates a simple buffer. */
3598 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3600 : (sa_must_free = 1, record_xmalloc (size)))
3602 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3603 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3604 positive. The code is tuned for MULTIPLIER being a constant. */
3606 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3608 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3609 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3612 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3614 record_unwind_protect (safe_alloca_unwind, \
3615 make_save_value (buf, 0)); \
3619 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3621 #define SAFE_FREE() \
3623 if (sa_must_free) { \
3625 unbind_to (sa_count, Qnil); \
3630 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3632 #define SAFE_ALLOCA_LISP(buf, nelt) \
3634 if ((nelt) < MAX_ALLOCA / word_size) \
3635 buf = alloca ((nelt) * word_size); \
3636 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3639 buf = xmalloc ((nelt) * word_size); \
3640 arg_ = make_save_value (buf, nelt); \
3641 XSAVE_VALUE (arg_)->dogc = 1; \
3643 record_unwind_protect (safe_alloca_unwind, arg_); \
3646 memory_full (SIZE_MAX); \
3650 #include "globals.h"
3652 /* Check whether it's time for GC, and run it if so. */
3657 if ((consing_since_gc
> gc_cons_threshold
3658 && consing_since_gc
> gc_relative_threshold
)
3659 || (!NILP (Vmemory_full
)
3660 && consing_since_gc
> memory_full_cons_threshold
))
3661 Fgarbage_collect ();
3665 functionp (Lisp_Object object
)
3667 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3669 object
= Findirect_function (object
, Qt
);
3671 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3673 /* Autoloaded symbols are functions, except if they load
3674 macros or keymaps. */
3676 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3677 object
= XCDR (object
);
3679 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3684 return XSUBR (object
)->max_args
!= UNEVALLED
;
3685 else if (COMPILEDP (object
))
3687 else if (CONSP (object
))
3689 Lisp_Object car
= XCAR (object
);
3690 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3698 #endif /* EMACS_LISP_H */