1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
36 # define LISP_INLINE INLINE
39 /* The ubiquitous max and min macros. */
42 #define max(a, b) ((a) > (b) ? (a) : (b))
43 #define min(a, b) ((a) < (b) ? (a) : (b))
45 /* EMACS_INT - signed integer wide enough to hold an Emacs value
46 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
47 pI - printf length modifier for EMACS_INT
48 EMACS_UINT - unsigned variant of EMACS_INT */
50 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
51 typedef long long int EMACS_INT
;
52 typedef unsigned long long int EMACS_UINT
;
53 # define EMACS_INT_MAX LLONG_MAX
55 # elif INT_MAX < LONG_MAX
56 typedef long int EMACS_INT
;
57 typedef unsigned long int EMACS_UINT
;
58 # define EMACS_INT_MAX LONG_MAX
61 typedef int EMACS_INT
;
62 typedef unsigned int EMACS_UINT
;
63 # define EMACS_INT_MAX INT_MAX
68 /* Number of bits in some machine integer types. */
71 BITS_PER_CHAR
= CHAR_BIT
,
72 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
73 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
74 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
75 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
78 /* printmax_t and uprintmax_t are types for printing large integers.
79 These are the widest integers that are supported for printing.
80 pMd etc. are conversions for printing them.
81 On C99 hosts, there's no problem, as even the widest integers work.
82 Fall back on EMACS_INT on pre-C99 hosts. */
84 typedef intmax_t printmax_t
;
85 typedef uintmax_t uprintmax_t
;
89 typedef EMACS_INT printmax_t
;
90 typedef EMACS_UINT uprintmax_t
;
95 /* Use pD to format ptrdiff_t values, which suffice for indexes into
96 buffers and strings. Emacs never allocates objects larger than
97 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
98 In C99, pD can always be "t"; configure it here for the sake of
99 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
100 #if PTRDIFF_MAX == INT_MAX
102 #elif PTRDIFF_MAX == LONG_MAX
104 #elif PTRDIFF_MAX == LLONG_MAX
110 /* Extra internal type checking? */
112 /* Define an Emacs version of 'assert (COND)', since some
113 system-defined 'assert's are flaky. COND should be free of side
114 effects; it may or may not be evaluated. */
115 #ifndef ENABLE_CHECKING
116 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
117 #else /* ENABLE_CHECKING */
119 extern _Noreturn
void die (const char *, const char *, int);
121 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
122 it to 1 using a debugger to temporarily disable aborting on
123 detected internal inconsistencies or error conditions.
125 In some cases, a good compiler may be able to optimize away the
126 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
127 STRINGP (x), but a particular use of XSTRING is invoked only after
128 testing that STRINGP (x) is true, making the test redundant. */
129 extern bool suppress_checking EXTERNALLY_VISIBLE
;
131 # define eassert(cond) \
132 ((cond) || suppress_checking \
134 : die ("assertion failed: " # cond, __FILE__, __LINE__))
135 #endif /* ENABLE_CHECKING */
137 /* Use the configure flag --enable-check-lisp-object-type to make
138 Lisp_Object use a struct type instead of the default int. The flag
139 causes CHECK_LISP_OBJECT_TYPE to be defined. */
141 /***** Select the tagging scheme. *****/
142 /* The following option controls the tagging scheme:
143 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
144 always 0, and we can thus use them to hold tag bits, without
145 restricting our addressing space.
147 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
148 restricting our possible address range.
150 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
151 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
152 on the few static Lisp_Objects used: all the defsubr as well
153 as the two special buffers buffer_defaults and buffer_local_symbols. */
157 /* Number of bits in a Lisp_Object tag. This can be used in #if,
158 and for GDB's sake also as a regular symbol. */
163 /* 2**GCTYPEBITS. This must also be a macro that expands to a
164 literal integer constant, for MSVC. */
166 #define GCALIGNMENT 8
169 /* Number of bits in a Lisp_Object value, not counting the tag. */
170 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
172 /* Number of bits in a Lisp fixnum tag. */
173 INTTYPEBITS
= GCTYPEBITS
- 1,
175 /* Number of bits in a Lisp fixnum value, not counting the tag. */
176 FIXNUM_BITS
= VALBITS
+ 1
179 #if GCALIGNMENT != 1 << GCTYPEBITS
180 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
183 /* The maximum value that can be stored in a EMACS_INT, assuming all
184 bits other than the type bits contribute to a nonnegative signed value.
185 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
186 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
188 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
190 /* 1. We know malloc returns a multiple of 8. */
191 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
192 || defined DARWIN_OS || defined __sun)
193 /* 2. We can specify multiple-of-8 alignment on static variables. */
195 /* 3. Pointers-as-ints exceed VAL_MAX.
196 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
197 a. unnecessary, because the top bits of an EMACS_INT are unused, and
198 b. slower, because it typically requires extra masking.
199 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
200 # if VAL_MAX < UINTPTR_MAX
201 # define USE_LSB_TAG 1
208 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
209 # define USE_LSB_TAG 1
211 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
212 # define USE_LSB_TAG 0
216 # define alignas(alignment) /* empty */
218 # error "USE_LSB_TAG requires alignas"
223 /* Define the fundamental Lisp data structures. */
225 /* This is the set of Lisp data types. If you want to define a new
226 data type, read the comments after Lisp_Fwd_Type definition
229 /* Lisp integers use 2 tags, to give them one extra bit, thus
230 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
231 static EMACS_INT
const INTMASK
= EMACS_INT_MAX
>> (INTTYPEBITS
- 1);
232 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
233 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
235 /* Stolen from GDB. The only known compiler that doesn't support
236 enums in bitfields is MSVC. */
238 #define ENUM_BF(TYPE) unsigned int
240 #define ENUM_BF(TYPE) enum TYPE
246 /* Integer. XINT (obj) is the integer value. */
248 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
250 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
253 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
254 whose first member indicates the subtype. */
257 /* String. XSTRING (object) points to a struct Lisp_String.
258 The length of the string, and its contents, are stored therein. */
259 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
261 /* Vector of Lisp objects, or something resembling it.
262 XVECTOR (object) points to a struct Lisp_Vector, which contains
263 the size and contents. The size field also contains the type
264 information, if it's not a real vector object. */
267 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
273 /* This is the set of data types that share a common structure.
274 The first member of the structure is a type code from this set.
275 The enum values are arbitrary, but we'll use large numbers to make it
276 more likely that we'll spot the error if a random word in memory is
277 mistakenly interpreted as a Lisp_Misc. */
280 Lisp_Misc_Free
= 0x5eab,
283 Lisp_Misc_Save_Value
,
284 /* Currently floats are not a misc type,
285 but let's define this in case we want to change that. */
287 /* This is not a type code. It is for range checking. */
291 /* These are the types of forwarding objects used in the value slot
292 of symbols for special built-in variables whose value is stored in
296 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
297 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
298 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
299 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
300 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
303 /* If you want to define a new Lisp data type, here are some
304 instructions. See the thread at
305 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
308 First, there are already a couple of Lisp types that can be used if
309 your new type does not need to be exposed to Lisp programs nor
310 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
311 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
312 is suitable for temporarily stashing away pointers and integers in
313 a Lisp object (see the existing uses of make_save_value and
314 XSAVE_VALUE). The latter is useful for vector-like Lisp objects
315 that need to be used as part of other objects, but which are never
316 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
319 These two types don't look pretty when printed, so they are
320 unsuitable for Lisp objects that can be exposed to users.
322 To define a new data type, add one more Lisp_Misc subtype or one
323 more pseudovector subtype. Pseudovectors are more suitable for
324 objects with several slots that need to support fast random access,
325 while Lisp_Misc types are for everything else. A pseudovector object
326 provides one or more slots for Lisp objects, followed by struct
327 members that are accessible only from C. A Lisp_Misc object is a
328 wrapper for a C struct that can contain anything you like.
330 To add a new pseudovector type, extend the pvec_type enumeration;
331 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
333 For a Lisp_Misc, you will also need to add your entry to union
334 Lisp_Misc (but make sure the first word has the same structure as
335 the others, starting with a 16-bit member of the Lisp_Misc_Type
336 enumeration and a 1-bit GC markbit) and make sure the overall size
337 of the union is not increased by your addition.
339 Then you will need to add switch branches in print.c (in
340 print_object, to print your object, and possibly also in
341 print_preprocess) and to alloc.c, to mark your object (in
342 mark_object) and to free it (in gc_sweep). The latter is also the
343 right place to call any code specific to your data type that needs
344 to run when the object is recycled -- e.g., free any additional
345 resources allocated for it that are not Lisp objects. You can even
346 make a pointer to the function that frees the resources a slot in
347 your object -- this way, the same object could be used to represent
348 several disparate C structures. */
350 #ifdef CHECK_LISP_OBJECT_TYPE
352 typedef struct { EMACS_INT i
; } Lisp_Object
;
355 LISP_INLINE Lisp_Object
358 Lisp_Object o
= { i
};
362 LISP_INLINE Lisp_Object
363 LISP_MAKE_RVALUE (Lisp_Object o
)
368 #define LISP_INITIALLY_ZERO {0}
370 #undef CHECK_LISP_OBJECT_TYPE
371 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
372 #else /* CHECK_LISP_OBJECT_TYPE */
374 /* If a struct type is not wanted, define Lisp_Object as just a number. */
376 typedef EMACS_INT Lisp_Object
;
379 #define LISP_MAKE_RVALUE(o) (0 + (o))
380 #define LISP_INITIALLY_ZERO 0
381 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
382 #endif /* CHECK_LISP_OBJECT_TYPE */
384 /* In the size word of a vector, this bit means the vector has been marked. */
386 static ptrdiff_t const ARRAY_MARK_FLAG
387 #define ARRAY_MARK_FLAG PTRDIFF_MIN
390 /* In the size word of a struct Lisp_Vector, this bit means it's really
391 some other vector-like object. */
392 static ptrdiff_t const PSEUDOVECTOR_FLAG
393 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
396 /* In a pseudovector, the size field actually contains a word with one
397 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
398 with PVEC_TYPE_MASK to indicate the actual type. */
410 PVEC_WINDOW_CONFIGURATION
,
413 /* These last 4 are special because we OR them in fns.c:internal_equal,
414 so they have to use a disjoint bit pattern:
415 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
416 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
417 PVEC_COMPILED
= 0x10,
418 PVEC_CHAR_TABLE
= 0x20,
419 PVEC_SUB_CHAR_TABLE
= 0x30,
423 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
424 which were stored in a Lisp_Object. */
425 #ifndef DATA_SEG_BITS
426 # define DATA_SEG_BITS 0
428 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
433 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
435 /* For convenience, we also store the number of elements in these bits.
436 Note that this size is not necessarily the memory-footprint size, but
437 only the number of Lisp_Object fields (that need to be traced by GC).
438 The distinction is used, e.g., by Lisp_Process, which places extra
439 non-Lisp_Object fields at the end of the structure. */
440 PSEUDOVECTOR_SIZE_BITS
= 16,
441 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
442 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
444 /* Number of bits to put in each character in the internal representation
445 of bool vectors. This should not vary across implementations. */
446 BOOL_VECTOR_BITS_PER_CHAR
= 8
449 /* These macros extract various sorts of values from a Lisp_Object.
450 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
451 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
453 /* Return a perfect hash of the Lisp_Object representation. */
454 #define XHASH(a) XLI (a)
460 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
463 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
464 #define XINT(a) (XLI (a) >> INTTYPEBITS)
465 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
466 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
467 #define make_lisp_ptr(ptr, type) \
468 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
469 XIL ((type) | (intptr_t) (ptr)))
471 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
472 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
474 #else /* not USE_LSB_TAG */
476 static EMACS_INT
const VALMASK
477 #define VALMASK VAL_MAX
480 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
482 /* For integers known to be positive, XFASTINT provides fast retrieval
483 and XSETFASTINT provides fast storage. This takes advantage of the
484 fact that Lisp integers have zero-bits in their tags. */
485 #define XFASTINT(a) (XLI (a) + 0)
486 #define XSETFASTINT(a, b) ((a) = XIL (b))
488 /* Extract the value of a Lisp_Object as a (un)signed integer. */
490 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
491 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
492 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
494 #define make_lisp_ptr(ptr, type) \
495 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
496 + ((intptr_t) (ptr) & VALMASK)))
499 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
500 which were stored in a Lisp_Object. */
501 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
503 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
506 #endif /* not USE_LSB_TAG */
508 /* For integers known to be positive, XFASTINT sometimes provides
509 faster retrieval and XSETFASTINT provides faster storage.
510 If not, fallback on the non-accelerated path. */
512 # define XFASTINT(a) (XINT (a))
513 # define XSETFASTINT(a, b) (XSETINT (a, b))
516 /* Extract the pointer value of the Lisp object A, under the
517 assumption that A's type is TYPE. This is a fallback
518 implementation if nothing faster is available. */
520 # define XUNTAG(a, type) XPNTR (a)
523 #define EQ(x, y) (XHASH (x) == XHASH (y))
525 /* Largest and smallest representable fixnum values. These are the C
526 values. They are macros for use in static initializers, and
527 constants for visibility to GDB. */
528 static EMACS_INT
const MOST_POSITIVE_FIXNUM
=
529 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
530 MOST_POSITIVE_FIXNUM
;
531 static EMACS_INT
const MOST_NEGATIVE_FIXNUM
=
532 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
533 MOST_NEGATIVE_FIXNUM
;
535 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
536 written this way so that it also works if I is of unsigned
537 type or if I is a NaN. */
539 #define FIXNUM_OVERFLOW_P(i) \
540 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
542 LISP_INLINE
ptrdiff_t
543 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
545 return num
< lower
? lower
: num
<= upper
? num
: upper
;
548 /* Extract a value or address from a Lisp_Object. */
550 #define XCONS(a) (eassert (CONSP (a)), \
551 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
552 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
553 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
554 #define XSTRING(a) (eassert (STRINGP (a)), \
555 (struct Lisp_String *) XUNTAG (a, Lisp_String))
556 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
557 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
558 #define XFLOAT(a) (eassert (FLOATP (a)), \
559 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
563 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
564 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
565 #define XMISCTYPE(a) (XMISCANY (a)->type)
566 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
567 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
568 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
570 /* Forwarding object types. */
572 #define XFWDTYPE(a) (a->u_intfwd.type)
573 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
574 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
575 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
576 #define XBUFFER_OBJFWD(a) \
577 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
578 #define XKBOARD_OBJFWD(a) \
579 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
581 /* Pseudovector types. */
583 #define XPROCESS(a) (eassert (PROCESSP (a)), \
584 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
585 #define XWINDOW(a) (eassert (WINDOWP (a)), \
586 (struct window *) XUNTAG (a, Lisp_Vectorlike))
587 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
588 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
589 #define XSUBR(a) (eassert (SUBRP (a)), \
590 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
591 #define XBUFFER(a) (eassert (BUFFERP (a)), \
592 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
593 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
594 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
595 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
596 ((struct Lisp_Sub_Char_Table *) \
597 XUNTAG (a, Lisp_Vectorlike)))
598 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
599 ((struct Lisp_Bool_Vector *) \
600 XUNTAG (a, Lisp_Vectorlike)))
602 /* Construct a Lisp_Object from a value or address. */
604 #define XSETINT(a, b) ((a) = make_number (b))
605 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
606 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
607 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
608 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
609 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
613 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
614 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
616 /* Pseudovector types. */
618 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
619 #define XSETTYPED_PVECTYPE(v, size_member, code) \
620 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
621 #define XSETPVECTYPESIZE(v, code, sizeval) \
622 ((v)->header.size = (PSEUDOVECTOR_FLAG \
623 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
626 /* The cast to struct vectorlike_header * avoids aliasing issues. */
627 #define XSETPSEUDOVECTOR(a, b, code) \
628 XSETTYPED_PSEUDOVECTOR (a, b, \
629 (((struct vectorlike_header *) \
630 XUNTAG (a, Lisp_Vectorlike)) \
633 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
634 (XSETVECTOR (a, b), \
635 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
636 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
638 #define XSETWINDOW_CONFIGURATION(a, b) \
639 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
640 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
641 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
642 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
643 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
644 #define XSETSUBR(a, b) \
645 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
646 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
647 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
648 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
649 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
650 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
652 /* Convenience macros for dealing with Lisp arrays. */
654 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
655 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
656 #define ASET(ARRAY, IDX, VAL) \
657 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
658 XVECTOR (ARRAY)->contents[IDX] = (VAL))
660 /* Convenience macros for dealing with Lisp strings. */
662 #define SDATA(string) (XSTRING (string)->data + 0)
663 #define SREF(string, index) (SDATA (string)[index] + 0)
664 #define SSET(string, index, new) (SDATA (string)[index] = (new))
665 #define SCHARS(string) (XSTRING (string)->size + 0)
666 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
668 /* Avoid "differ in sign" warnings. */
669 #define SSDATA(x) ((char *) SDATA (x))
671 #define STRING_SET_CHARS(string, newsize) \
672 (XSTRING (string)->size = (newsize))
674 #define STRING_COPYIN(string, index, new, count) \
675 memcpy (SDATA (string) + index, new, count)
679 #define CHECK_TYPE(ok, Qxxxp, x) \
680 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
682 /* Deprecated and will be removed soon. */
684 #define INTERNAL_FIELD(field) field ## _
686 /* See the macros in intervals.h. */
688 typedef struct interval
*INTERVAL
;
690 /* Complain if object is not string or buffer type. */
691 #define CHECK_STRING_OR_BUFFER(x) \
692 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
696 /* Car of this cons cell. */
701 /* Cdr of this cons cell. */
704 /* Used to chain conses on a free list. */
705 struct Lisp_Cons
*chain
;
709 /* Take the car or cdr of something known to be a cons cell. */
710 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
711 of code that has to know what a cons cell looks like. Other code not
712 part of the basic lisp implementation should assume that the car and cdr
713 fields are not accessible as lvalues. (What if we want to switch to
714 a copying collector someday? Cached cons cell field addresses may be
715 invalidated at arbitrary points.) */
716 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
717 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
719 /* Use these from normal code. */
720 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
721 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
723 /* Use these to set the fields of a cons cell.
725 Note that both arguments may refer to the same object, so 'n'
726 should not be read after 'c' is first modified. Also, neither
727 argument should be evaluated more than once; side effects are
728 especially common in the second argument. */
729 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
730 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
732 /* Take the car or cdr of something whose type is not known. */
734 (CONSP ((c)) ? XCAR ((c)) \
735 : NILP ((c)) ? Qnil \
736 : wrong_type_argument (Qlistp, (c)))
739 (CONSP ((c)) ? XCDR ((c)) \
740 : NILP ((c)) ? Qnil \
741 : wrong_type_argument (Qlistp, (c)))
743 /* Take the car or cdr of something whose type is not known. */
744 #define CAR_SAFE(c) \
745 (CONSP ((c)) ? XCAR ((c)) : Qnil)
747 #define CDR_SAFE(c) \
748 (CONSP ((c)) ? XCDR ((c)) : Qnil)
750 /* True if STR is a multibyte string. */
751 #define STRING_MULTIBYTE(STR) \
752 (XSTRING (STR)->size_byte >= 0)
754 /* Return the length in bytes of STR. */
756 #ifdef GC_CHECK_STRING_BYTES
759 extern ptrdiff_t string_bytes (struct Lisp_String
*);
760 #define STRING_BYTES(S) string_bytes ((S))
762 #else /* not GC_CHECK_STRING_BYTES */
764 #define STRING_BYTES(STR) \
765 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
767 #endif /* not GC_CHECK_STRING_BYTES */
769 /* An upper bound on the number of bytes in a Lisp string, not
770 counting the terminating null. This a tight enough bound to
771 prevent integer overflow errors that would otherwise occur during
772 string size calculations. A string cannot contain more bytes than
773 a fixnum can represent, nor can it be so long that C pointer
774 arithmetic stops working on the string plus its terminating null.
775 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
776 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
777 would expose alloc.c internal details that we'd rather keep
780 This is a macro for use in static initializers, and a constant for
781 visibility to GDB. The cast to ptrdiff_t ensures that
782 the macro is signed. */
783 static ptrdiff_t const STRING_BYTES_BOUND
=
784 #define STRING_BYTES_BOUND \
785 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
788 /* Mark STR as a unibyte string. */
789 #define STRING_SET_UNIBYTE(STR) \
790 do { if (EQ (STR, empty_multibyte_string)) \
791 (STR) = empty_unibyte_string; \
792 else XSTRING (STR)->size_byte = -1; } while (0)
794 /* Mark STR as a multibyte string. Assure that STR contains only
795 ASCII characters in advance. */
796 #define STRING_SET_MULTIBYTE(STR) \
797 do { if (EQ (STR, empty_unibyte_string)) \
798 (STR) = empty_multibyte_string; \
799 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
801 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
807 INTERVAL intervals
; /* Text properties in this string. */
811 /* Header of vector-like objects. This documents the layout constraints on
812 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
813 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
814 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
815 because when two such pointers potentially alias, a compiler won't
816 incorrectly reorder loads and stores to their size fields. See
817 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
818 struct vectorlike_header
820 /* This field contains various pieces of information:
821 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
822 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
823 vector (0) or a pseudovector (1).
824 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
825 of slots) of the vector.
826 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
827 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
828 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
829 Lisp_Object slots at the beginning of the object that need to be
830 traced by the GC, tho some types use it slightly differently.
831 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
832 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
836 /* When the vector is allocated from a vector block, NBYTES is used
837 if the vector is not on a free list, and VECTOR is used otherwise.
838 For large vector-like objects, BUFFER or VECTOR is used as a pointer
839 to the next vector-like object. It is generally a buffer or a
840 Lisp_Vector alias, so for convenience it is a union instead of a
841 pointer: this way, one can write P->next.vector instead of ((struct
842 Lisp_Vector *) P->next). */
844 /* This is only needed for small vectors that are not free because the
845 `size' field only gives us the number of Lisp_Object slots, whereas we
846 need to know the total size, including non-Lisp_Object data.
847 FIXME: figure out a way to store this info elsewhere so we can
848 finally get rid of this extra word of overhead. */
850 struct buffer
*buffer
;
851 /* FIXME: This can be removed: For large vectors, this field could be
852 placed *before* the vector itself. And for small vectors on a free
853 list, this field could be stored in the vector's bytes, since the
854 empty vector is handled specially anyway. */
855 struct Lisp_Vector
*vector
;
859 /* Regular vector is just a header plus array of Lisp_Objects. */
863 struct vectorlike_header header
;
864 Lisp_Object contents
[1];
867 /* A boolvector is a kind of vectorlike, with contents are like a string. */
869 struct Lisp_Bool_Vector
871 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
872 just the subtype information. */
873 struct vectorlike_header header
;
874 /* This is the size in bits. */
876 /* This contains the actual bits, packed into bytes. */
877 unsigned char data
[1];
880 /* Some handy constants for calculating sizes
881 and offsets, mostly of vectorlike objects. */
885 header_size
= offsetof (struct Lisp_Vector
, contents
),
886 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
887 word_size
= sizeof (Lisp_Object
)
890 /* If a struct is made to look like a vector, this macro returns the length
891 of the shortest vector that would hold that struct. */
893 #define VECSIZE(type) \
894 ((sizeof (type) - header_size + word_size - 1) / word_size)
896 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
897 at the end and we need to compute the number of Lisp_Object fields (the
898 ones that the GC needs to trace). */
900 #define PSEUDOVECSIZE(type, nonlispfield) \
901 ((offsetof (type, nonlispfield) - header_size) / word_size)
903 /* A char-table is a kind of vectorlike, with contents are like a
904 vector but with a few other slots. For some purposes, it makes
905 sense to handle a char-table with type struct Lisp_Vector. An
906 element of a char table can be any Lisp objects, but if it is a sub
907 char-table, we treat it a table that contains information of a
908 specific range of characters. A sub char-table has the same
909 structure as a vector. A sub char table appears only in an element
910 of a char-table, and there's no way to access it directly from
911 Emacs Lisp program. */
915 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
916 ({struct Lisp_Char_Table *_tbl = NULL; \
919 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
920 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
921 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
923 _val = _tbl->defalt; \
924 } while (NILP (_val) && ! NILP (_tbl->parent)); \
927 #else /* not __GNUC__ */
929 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
930 (! NILP (XCHAR_TABLE (CT)->ascii) \
931 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
932 ? XCHAR_TABLE (CT)->ascii \
933 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
934 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
935 : char_table_ref ((CT), (IDX))) \
936 : char_table_ref ((CT), (IDX)))
938 #endif /* not __GNUC__ */
940 /* Compute A OP B, using the unsigned comparison operator OP. A and B
941 should be integer expressions. This is not the same as
942 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
943 returns 1. For efficiency, prefer plain unsigned comparison if A
944 and B's sizes both fit (after integer promotion). */
945 #define UNSIGNED_CMP(a, op, b) \
946 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
947 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
948 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
950 /* Nonzero iff C is an ASCII character. */
951 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
953 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
954 characters. Do not check validity of CT. */
955 #define CHAR_TABLE_REF(CT, IDX) \
956 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
957 : char_table_ref ((CT), (IDX)))
959 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
960 8-bit European characters. Do not check validity of CT. */
961 #define CHAR_TABLE_SET(CT, IDX, VAL) \
962 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
963 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
964 : char_table_set (CT, IDX, VAL))
966 enum CHARTAB_SIZE_BITS
968 CHARTAB_SIZE_BITS_0
= 6,
969 CHARTAB_SIZE_BITS_1
= 4,
970 CHARTAB_SIZE_BITS_2
= 5,
971 CHARTAB_SIZE_BITS_3
= 7
974 extern const int chartab_size
[4];
976 struct Lisp_Char_Table
978 /* HEADER.SIZE is the vector's size field, which also holds the
979 pseudovector type information. It holds the size, too.
980 The size counts the defalt, parent, purpose, ascii,
981 contents, and extras slots. */
982 struct vectorlike_header header
;
984 /* This holds a default value,
985 which is used whenever the value for a specific character is nil. */
988 /* This points to another char table, which we inherit from when the
989 value for a specific character is nil. The `defalt' slot takes
990 precedence over this. */
993 /* This is a symbol which says what kind of use this char-table is
997 /* The bottom sub char-table for characters of the range 0..127. It
998 is nil if none of ASCII character has a specific value. */
1001 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1003 /* These hold additional data. It is a vector. */
1004 Lisp_Object extras
[1];
1007 struct Lisp_Sub_Char_Table
1009 /* HEADER.SIZE is the vector's size field, which also holds the
1010 pseudovector type information. It holds the size, too. */
1011 struct vectorlike_header header
;
1013 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1014 char-table of depth 1 contains 16 elements, and each element
1015 covers 4096 (128*32) characters. A sub char-table of depth 2
1016 contains 32 elements, and each element covers 128 characters. A
1017 sub char-table of depth 3 contains 128 elements, and each element
1018 is for one character. */
1021 /* Minimum character covered by the sub char-table. */
1022 Lisp_Object min_char
;
1024 /* Use set_sub_char_table_contents to set this. */
1025 Lisp_Object contents
[1];
1028 /* This structure describes a built-in function.
1029 It is generated by the DEFUN macro only.
1030 defsubr makes it into a Lisp object.
1032 This type is treated in most respects as a pseudovector,
1033 but since we never dynamically allocate or free them,
1034 we don't need a struct vectorlike_header and its 'next' field. */
1040 Lisp_Object (*a0
) (void);
1041 Lisp_Object (*a1
) (Lisp_Object
);
1042 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1043 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1044 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1045 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1046 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1047 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1048 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1049 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1050 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1052 short min_args
, max_args
;
1053 const char *symbol_name
;
1054 const char *intspec
;
1058 /* This is the number of slots that every char table must have. This
1059 counts the ordinary slots and the top, defalt, parent, and purpose
1061 enum CHAR_TABLE_STANDARD_SLOTS
1063 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1066 /* Return the number of "extra" slots in the char table CT. */
1068 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1069 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1072 /***********************************************************************
1074 ***********************************************************************/
1076 /* Interned state of a symbol. */
1078 enum symbol_interned
1080 SYMBOL_UNINTERNED
= 0,
1081 SYMBOL_INTERNED
= 1,
1082 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1085 enum symbol_redirect
1087 SYMBOL_PLAINVAL
= 4,
1088 SYMBOL_VARALIAS
= 1,
1089 SYMBOL_LOCALIZED
= 2,
1090 SYMBOL_FORWARDED
= 3
1095 unsigned gcmarkbit
: 1;
1097 /* Indicates where the value can be found:
1098 0 : it's a plain var, the value is in the `value' field.
1099 1 : it's a varalias, the value is really in the `alias' symbol.
1100 2 : it's a localized var, the value is in the `blv' object.
1101 3 : it's a forwarding variable, the value is in `forward'. */
1102 ENUM_BF (symbol_redirect
) redirect
: 3;
1104 /* Non-zero means symbol is constant, i.e. changing its value
1105 should signal an error. If the value is 3, then the var
1106 can be changed, but only by `defconst'. */
1107 unsigned constant
: 2;
1109 /* Interned state of the symbol. This is an enumerator from
1110 enum symbol_interned. */
1111 unsigned interned
: 2;
1113 /* Non-zero means that this variable has been explicitly declared
1114 special (with `defvar' etc), and shouldn't be lexically bound. */
1115 unsigned declared_special
: 1;
1117 /* The symbol's name, as a Lisp string. */
1120 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1121 union is used depends on the `redirect' field above. */
1124 struct Lisp_Symbol
*alias
;
1125 struct Lisp_Buffer_Local_Value
*blv
;
1126 union Lisp_Fwd
*fwd
;
1129 /* Function value of the symbol or Qunbound if not fboundp. */
1130 Lisp_Object function
;
1132 /* The symbol's property list. */
1135 /* Next symbol in obarray bucket, if the symbol is interned. */
1136 struct Lisp_Symbol
*next
;
1139 /* Value is name of symbol. */
1141 #define SYMBOL_VAL(sym) \
1142 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1143 #define SYMBOL_ALIAS(sym) \
1144 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1145 #define SYMBOL_BLV(sym) \
1146 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1147 #define SYMBOL_FWD(sym) \
1148 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1149 #define SET_SYMBOL_VAL(sym, v) \
1150 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1151 #define SET_SYMBOL_ALIAS(sym, v) \
1152 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1153 #define SET_SYMBOL_BLV(sym, v) \
1154 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1155 #define SET_SYMBOL_FWD(sym, v) \
1156 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1158 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1160 /* Value is non-zero if SYM is an interned symbol. */
1162 #define SYMBOL_INTERNED_P(sym) \
1163 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1165 /* Value is non-zero if SYM is interned in initial_obarray. */
1167 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1168 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1170 /* Value is non-zero if symbol is considered a constant, i.e. its
1171 value cannot be changed (there is an exception for keyword symbols,
1172 whose value can be set to the keyword symbol itself). */
1174 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1176 #define DEFSYM(sym, name) \
1177 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1180 /***********************************************************************
1182 ***********************************************************************/
1184 /* The structure of a Lisp hash table. */
1186 struct Lisp_Hash_Table
1188 /* This is for Lisp; the hash table code does not refer to it. */
1189 struct vectorlike_header header
;
1191 /* Function used to compare keys. */
1194 /* Nil if table is non-weak. Otherwise a symbol describing the
1195 weakness of the table. */
1198 /* When the table is resized, and this is an integer, compute the
1199 new size by adding this to the old size. If a float, compute the
1200 new size by multiplying the old size with this factor. */
1201 Lisp_Object rehash_size
;
1203 /* Resize hash table when number of entries/ table size is >= this
1205 Lisp_Object rehash_threshold
;
1207 /* Vector of hash codes.. If hash[I] is nil, this means that that
1208 entry I is unused. */
1211 /* Vector used to chain entries. If entry I is free, next[I] is the
1212 entry number of the next free item. If entry I is non-free,
1213 next[I] is the index of the next entry in the collision chain. */
1216 /* Index of first free entry in free list. */
1217 Lisp_Object next_free
;
1219 /* Bucket vector. A non-nil entry is the index of the first item in
1220 a collision chain. This vector's size can be larger than the
1221 hash table size to reduce collisions. */
1224 /* User-supplied hash function, or nil. */
1225 Lisp_Object user_hash_function
;
1227 /* User-supplied key comparison function, or nil. */
1228 Lisp_Object user_cmp_function
;
1230 /* Only the fields above are traced normally by the GC. The ones below
1231 `count' are special and are either ignored by the GC or traced in
1232 a special way (e.g. because of weakness). */
1234 /* Number of key/value entries in the table. */
1237 /* Vector of keys and values. The key of item I is found at index
1238 2 * I, the value is found at index 2 * I + 1.
1239 This is gc_marked specially if the table is weak. */
1240 Lisp_Object key_and_value
;
1242 /* Next weak hash table if this is a weak hash table. The head
1243 of the list is in weak_hash_tables. */
1244 struct Lisp_Hash_Table
*next_weak
;
1246 /* C function to compare two keys. */
1247 bool (*cmpfn
) (struct Lisp_Hash_Table
*,
1248 Lisp_Object
, EMACS_UINT
,
1249 Lisp_Object
, EMACS_UINT
);
1251 /* C function to compute hash code. */
1252 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1256 #define XHASH_TABLE(OBJ) \
1257 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1259 #define XSET_HASH_TABLE(VAR, PTR) \
1260 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1262 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1264 #define CHECK_HASH_TABLE(x) \
1265 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1267 /* Value is the key part of entry IDX in hash table H. */
1269 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1271 /* Value is the value part of entry IDX in hash table H. */
1273 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1275 /* Value is the index of the next entry following the one at IDX
1278 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1280 /* Value is the hash code computed for entry IDX in hash table H. */
1282 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1284 /* Value is the index of the element in hash table H that is the
1285 start of the collision list at index IDX in the index vector of H. */
1287 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1289 /* Value is the size of hash table H. */
1291 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1293 /* Default size for hash tables if not specified. */
1295 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1297 /* Default threshold specifying when to resize a hash table. The
1298 value gives the ratio of current entries in the hash table and the
1299 size of the hash table. */
1301 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1303 /* Default factor by which to increase the size of a hash table. */
1305 static double const DEFAULT_REHASH_SIZE
= 1.5;
1307 /* These structures are used for various misc types. */
1309 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1311 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1312 unsigned gcmarkbit
: 1;
1318 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1319 unsigned gcmarkbit
: 1;
1321 /* This flag is temporarily used in the functions
1322 decode/encode_coding_object to record that the marker position
1323 must be adjusted after the conversion. */
1324 unsigned int need_adjustment
: 1;
1325 /* 1 means normal insertion at the marker's position
1326 leaves the marker after the inserted text. */
1327 unsigned int insertion_type
: 1;
1328 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1329 Note: a chain of markers can contain markers pointing into different
1330 buffers (the chain is per buffer_text rather than per buffer, so it's
1331 shared between indirect buffers). */
1332 /* This is used for (other than NULL-checking):
1334 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1335 - unchain_marker: to find the list from which to unchain.
1336 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1338 struct buffer
*buffer
;
1340 /* The remaining fields are meaningless in a marker that
1341 does not point anywhere. */
1343 /* For markers that point somewhere,
1344 this is used to chain of all the markers in a given buffer. */
1345 /* We could remove it and use an array in buffer_text instead.
1346 That would also allow to preserve it ordered. */
1347 struct Lisp_Marker
*next
;
1348 /* This is the char position where the marker points. */
1350 /* This is the byte position.
1351 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1352 used to implement the functionality of markers, but rather to (ab)use
1353 markers as a cache for char<->byte mappings). */
1357 /* START and END are markers in the overlay's buffer, and
1358 PLIST is the overlay's property list. */
1360 /* An overlay's real data content is:
1362 - buffer (really there are two buffer pointers, one per marker,
1363 and both points to the same buffer)
1364 - insertion type of both ends (per-marker fields)
1365 - start & start byte (of start marker)
1366 - end & end byte (of end marker)
1367 - next (singly linked list of overlays)
1368 - next fields of start and end markers (singly linked list of markers).
1369 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1372 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1373 unsigned gcmarkbit
: 1;
1375 struct Lisp_Overlay
*next
;
1381 /* Hold a C pointer for later use.
1382 This type of object is used in the arg to record_unwind_protect. */
1383 struct Lisp_Save_Value
1385 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1386 unsigned gcmarkbit
: 1;
1388 /* If DOGC is set, POINTER is the address of a memory
1389 area containing INTEGER potential Lisp_Objects. */
1390 unsigned int dogc
: 1;
1396 /* A miscellaneous object, when it's on the free list. */
1399 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1400 unsigned gcmarkbit
: 1;
1402 union Lisp_Misc
*chain
;
1405 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1406 It uses one of these struct subtypes to get the type field. */
1410 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1411 struct Lisp_Free u_free
;
1412 struct Lisp_Marker u_marker
;
1413 struct Lisp_Overlay u_overlay
;
1414 struct Lisp_Save_Value u_save_value
;
1417 /* Forwarding pointer to an int variable.
1418 This is allowed only in the value cell of a symbol,
1419 and it means that the symbol's value really lives in the
1420 specified int variable. */
1423 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1427 /* Boolean forwarding pointer to an int variable.
1428 This is like Lisp_Intfwd except that the ostensible
1429 "value" of the symbol is t if the int variable is nonzero,
1430 nil if it is zero. */
1433 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1437 /* Forwarding pointer to a Lisp_Object variable.
1438 This is allowed only in the value cell of a symbol,
1439 and it means that the symbol's value really lives in the
1440 specified variable. */
1443 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1444 Lisp_Object
*objvar
;
1447 /* Like Lisp_Objfwd except that value lives in a slot in the
1448 current buffer. Value is byte index of slot within buffer. */
1449 struct Lisp_Buffer_Objfwd
1451 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1453 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1456 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1457 the symbol has buffer-local or frame-local bindings. (Exception:
1458 some buffer-local variables are built-in, with their values stored
1459 in the buffer structure itself. They are handled differently,
1460 using struct Lisp_Buffer_Objfwd.)
1462 The `realvalue' slot holds the variable's current value, or a
1463 forwarding pointer to where that value is kept. This value is the
1464 one that corresponds to the loaded binding. To read or set the
1465 variable, you must first make sure the right binding is loaded;
1466 then you can access the value in (or through) `realvalue'.
1468 `buffer' and `frame' are the buffer and frame for which the loaded
1469 binding was found. If those have changed, to make sure the right
1470 binding is loaded it is necessary to find which binding goes with
1471 the current buffer and selected frame, then load it. To load it,
1472 first unload the previous binding, then copy the value of the new
1473 binding into `realvalue' (or through it). Also update
1474 LOADED-BINDING to point to the newly loaded binding.
1476 `local_if_set' indicates that merely setting the variable creates a
1477 local binding for the current buffer. Otherwise the latter, setting
1478 the variable does not do that; only make-local-variable does that. */
1480 struct Lisp_Buffer_Local_Value
1482 /* 1 means that merely setting the variable creates a local
1483 binding for the current buffer. */
1484 unsigned int local_if_set
: 1;
1485 /* 1 means this variable can have frame-local bindings, otherwise, it is
1486 can have buffer-local bindings. The two cannot be combined. */
1487 unsigned int frame_local
: 1;
1488 /* 1 means that the binding now loaded was found.
1489 Presumably equivalent to (defcell!=valcell). */
1490 unsigned int found
: 1;
1491 /* If non-NULL, a forwarding to the C var where it should also be set. */
1492 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1493 /* The buffer or frame for which the loaded binding was found. */
1495 /* A cons cell that holds the default value. It has the form
1496 (SYMBOL . DEFAULT-VALUE). */
1497 Lisp_Object defcell
;
1498 /* The cons cell from `where's parameter alist.
1499 It always has the form (SYMBOL . VALUE)
1500 Note that if `forward' is non-nil, VALUE may be out of date.
1501 Also if the currently loaded binding is the default binding, then
1502 this is `eq'ual to defcell. */
1503 Lisp_Object valcell
;
1506 /* Like Lisp_Objfwd except that value lives in a slot in the
1508 struct Lisp_Kboard_Objfwd
1510 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1516 struct Lisp_Intfwd u_intfwd
;
1517 struct Lisp_Boolfwd u_boolfwd
;
1518 struct Lisp_Objfwd u_objfwd
;
1519 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1520 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1523 /* Lisp floating point type. */
1529 struct Lisp_Float
*chain
;
1533 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1534 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1536 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1537 representations, have infinities and NaNs, and do not trap on
1538 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1539 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1540 wanted here, but is not quite right because Emacs does not require
1541 all the features of C11 Annex F (and does not require C11 at all,
1542 for that matter). */
1543 #define IEEE_FLOATING_POINT (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
1544 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
1546 /* A character, declared with the following typedef, is a member
1547 of some character set associated with the current buffer. */
1548 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1550 typedef unsigned char UCHAR
;
1553 /* Meanings of slots in a Lisp_Compiled: */
1557 COMPILED_ARGLIST
= 0,
1558 COMPILED_BYTECODE
= 1,
1559 COMPILED_CONSTANTS
= 2,
1560 COMPILED_STACK_DEPTH
= 3,
1561 COMPILED_DOC_STRING
= 4,
1562 COMPILED_INTERACTIVE
= 5
1565 /* Flag bits in a character. These also get used in termhooks.h.
1566 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1567 (MUlti-Lingual Emacs) might need 22 bits for the character value
1568 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1571 CHAR_ALT
= 0x0400000,
1572 CHAR_SUPER
= 0x0800000,
1573 CHAR_HYPER
= 0x1000000,
1574 CHAR_SHIFT
= 0x2000000,
1575 CHAR_CTL
= 0x4000000,
1576 CHAR_META
= 0x8000000,
1578 CHAR_MODIFIER_MASK
=
1579 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1581 /* Actually, the current Emacs uses 22 bits for the character value
1589 /* The glyph datatype, used to represent characters on the display.
1590 It consists of a char code and a face id. */
1597 /* Return a glyph's character code. */
1598 #define GLYPH_CHAR(glyph) ((glyph).ch)
1600 /* Return a glyph's face ID. */
1601 #define GLYPH_FACE(glyph) ((glyph).face_id)
1603 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1604 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1605 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1607 /* Return 1 if GLYPH contains valid character code. */
1608 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1611 /* Glyph Code from a display vector may either be an integer which
1612 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1613 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1615 #define GLYPH_CODE_P(gc) \
1617 ? (CHARACTERP (XCAR (gc)) \
1618 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1619 : (RANGED_INTEGERP \
1621 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1622 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1623 : TYPE_MAXIMUM (EMACS_INT)))))
1625 /* The following are valid only if GLYPH_CODE_P (gc). */
1627 #define GLYPH_CODE_CHAR(gc) \
1628 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1630 #define GLYPH_CODE_FACE(gc) \
1631 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1633 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1637 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1639 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1640 (XINT (gc) >> CHARACTERBITS)); \
1644 /* Structure to hold mouse highlight data. This is here because other
1645 header files need it for defining struct x_output etc. */
1647 /* These variables describe the range of text currently shown in its
1648 mouse-face, together with the window they apply to. As long as
1649 the mouse stays within this range, we need not redraw anything on
1650 its account. Rows and columns are glyph matrix positions in
1651 MOUSE_FACE_WINDOW. */
1652 int mouse_face_beg_row
, mouse_face_beg_col
;
1653 int mouse_face_beg_x
, mouse_face_beg_y
;
1654 int mouse_face_end_row
, mouse_face_end_col
;
1655 int mouse_face_end_x
, mouse_face_end_y
;
1656 int mouse_face_past_end
;
1657 Lisp_Object mouse_face_window
;
1658 int mouse_face_face_id
;
1659 Lisp_Object mouse_face_overlay
;
1661 /* 1 if a mouse motion event came and we didn't handle it right away because
1662 gc was in progress. */
1663 int mouse_face_deferred_gc
;
1665 /* FRAME and X, Y position of mouse when last checked for
1666 highlighting. X and Y can be negative or out of range for the frame. */
1667 struct frame
*mouse_face_mouse_frame
;
1668 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1670 /* Nonzero means defer mouse-motion highlighting. */
1671 int mouse_face_defer
;
1673 /* Nonzero means that the mouse highlight should not be shown. */
1674 int mouse_face_hidden
;
1676 int mouse_face_image_state
;
1679 /* Data type checking. */
1681 #define NILP(x) EQ (x, Qnil)
1683 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1684 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1686 #define RANGED_INTEGERP(lo, x, hi) \
1687 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1688 #define TYPE_RANGED_INTEGERP(type, x) \
1689 (TYPE_SIGNED (type) \
1690 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1691 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1693 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1694 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1695 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1696 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1697 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1698 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1700 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1701 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1702 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1703 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1704 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1706 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1707 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1708 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1709 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1710 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1712 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1713 vectorlike_header * avoids aliasing issues. */
1714 #define PSEUDOVECTORP(x, code) \
1715 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1717 #define PSEUDOVECTOR_TYPEP(v, code) \
1718 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1719 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1721 /* True if object X, with internal type struct T *, is a pseudovector whose
1723 #define TYPED_PSEUDOVECTORP(x, t, code) \
1725 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1727 /* Test for specific pseudovector types. */
1728 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1729 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1730 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1731 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1732 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1733 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1734 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1735 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1736 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1737 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1738 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1739 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1741 /* Test for image (image . spec) */
1742 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1747 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1749 #define CHECK_LIST(x) \
1750 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1752 #define CHECK_LIST_CONS(x, y) \
1753 CHECK_TYPE (CONSP (x), Qlistp, y)
1755 #define CHECK_LIST_END(x, y) \
1756 CHECK_TYPE (NILP (x), Qlistp, y)
1758 #define CHECK_STRING(x) \
1759 CHECK_TYPE (STRINGP (x), Qstringp, x)
1761 #define CHECK_STRING_CAR(x) \
1762 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1764 #define CHECK_CONS(x) \
1765 CHECK_TYPE (CONSP (x), Qconsp, x)
1767 #define CHECK_SYMBOL(x) \
1768 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1770 #define CHECK_CHAR_TABLE(x) \
1771 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1773 #define CHECK_VECTOR(x) \
1774 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1776 #define CHECK_VECTOR_OR_STRING(x) \
1777 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1779 #define CHECK_ARRAY(x, Qxxxp) \
1780 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1782 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1783 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1785 #define CHECK_BUFFER(x) \
1786 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1788 #define CHECK_WINDOW(x) \
1789 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1791 #define CHECK_WINDOW_CONFIGURATION(x) \
1792 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1794 #define CHECK_PROCESS(x) \
1795 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1797 #define CHECK_SUBR(x) \
1798 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1800 #define CHECK_NUMBER(x) \
1801 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1803 #define CHECK_NATNUM(x) \
1804 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1806 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1809 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1810 args_out_of_range_3 \
1812 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1813 ? MOST_NEGATIVE_FIXNUM \
1815 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1817 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1819 if (TYPE_SIGNED (type)) \
1820 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1822 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1825 #define CHECK_MARKER(x) \
1826 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1828 #define CHECK_NUMBER_COERCE_MARKER(x) \
1829 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1830 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1832 #define XFLOATINT(n) extract_float((n))
1834 #define CHECK_FLOAT(x) \
1835 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1837 #define CHECK_NUMBER_OR_FLOAT(x) \
1838 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1840 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1841 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1842 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1844 #define CHECK_OVERLAY(x) \
1845 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1847 /* Since we can't assign directly to the CAR or CDR fields of a cons
1848 cell, use these when checking that those fields contain numbers. */
1849 #define CHECK_NUMBER_CAR(x) \
1851 Lisp_Object tmp = XCAR (x); \
1852 CHECK_NUMBER (tmp); \
1853 XSETCAR ((x), tmp); \
1856 #define CHECK_NUMBER_CDR(x) \
1858 Lisp_Object tmp = XCDR (x); \
1859 CHECK_NUMBER (tmp); \
1860 XSETCDR ((x), tmp); \
1863 #define CHECK_NATNUM_CAR(x) \
1865 Lisp_Object tmp = XCAR (x); \
1866 CHECK_NATNUM (tmp); \
1867 XSETCAR ((x), tmp); \
1870 #define CHECK_NATNUM_CDR(x) \
1872 Lisp_Object tmp = XCDR (x); \
1873 CHECK_NATNUM (tmp); \
1874 XSETCDR ((x), tmp); \
1877 /* Define a built-in function for calling from Lisp.
1878 `lname' should be the name to give the function in Lisp,
1879 as a null-terminated C string.
1880 `fnname' should be the name of the function in C.
1881 By convention, it starts with F.
1882 `sname' should be the name for the C constant structure
1883 that records information on this function for internal use.
1884 By convention, it should be the same as `fnname' but with S instead of F.
1885 It's too bad that C macros can't compute this from `fnname'.
1886 `minargs' should be a number, the minimum number of arguments allowed.
1887 `maxargs' should be a number, the maximum number of arguments allowed,
1888 or else MANY or UNEVALLED.
1889 MANY means pass a vector of evaluated arguments,
1890 in the form of an integer number-of-arguments
1891 followed by the address of a vector of Lisp_Objects
1892 which contains the argument values.
1893 UNEVALLED means pass the list of unevaluated arguments
1894 `intspec' says how interactive arguments are to be fetched.
1895 If the string starts with a `(', `intspec' is evaluated and the resulting
1896 list is the list of arguments.
1897 If it's a string that doesn't start with `(', the value should follow
1898 the one of the doc string for `interactive'.
1899 A null string means call interactively with no arguments.
1900 `doc' is documentation for the user. */
1902 /* This version of DEFUN declares a function prototype with the right
1903 arguments, so we can catch errors with maxargs at compile-time. */
1905 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1906 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1907 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1908 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1909 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1910 { (Lisp_Object (__cdecl *)(void))fnname }, \
1911 minargs, maxargs, lname, intspec, 0}; \
1913 #else /* not _MSC_VER */
1914 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1915 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1916 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1917 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1918 { .a ## maxargs = fnname }, \
1919 minargs, maxargs, lname, intspec, 0}; \
1923 /* Note that the weird token-substitution semantics of ANSI C makes
1924 this work for MANY and UNEVALLED. */
1925 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1926 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1927 #define DEFUN_ARGS_0 (void)
1928 #define DEFUN_ARGS_1 (Lisp_Object)
1929 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1930 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1931 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1932 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1934 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1935 Lisp_Object, Lisp_Object)
1936 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1937 Lisp_Object, Lisp_Object, Lisp_Object)
1938 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1939 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1941 /* Non-zero if OBJ is a Lisp function. */
1942 #define FUNCTIONP(OBJ) functionp(OBJ)
1945 is how we define the symbol for function `name' at start-up time. */
1946 extern void defsubr (struct Lisp_Subr
*);
1954 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1955 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1956 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1957 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1958 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1960 /* Macros we use to define forwarded Lisp variables.
1961 These are used in the syms_of_FILENAME functions.
1963 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1964 lisp variable is actually a field in `struct emacs_globals'. The
1965 field's name begins with "f_", which is a convention enforced by
1966 these macros. Each such global has a corresponding #define in
1967 globals.h; the plain name should be used in the code.
1969 E.g., the global "cons_cells_consed" is declared as "int
1970 f_cons_cells_consed" in globals.h, but there is a define:
1972 #define cons_cells_consed globals.f_cons_cells_consed
1974 All C code uses the `cons_cells_consed' name. This is all done
1975 this way to support indirection for multi-threaded Emacs. */
1977 #define DEFVAR_LISP(lname, vname, doc) \
1979 static struct Lisp_Objfwd o_fwd; \
1980 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1982 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1984 static struct Lisp_Objfwd o_fwd; \
1985 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1987 #define DEFVAR_BOOL(lname, vname, doc) \
1989 static struct Lisp_Boolfwd b_fwd; \
1990 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1992 #define DEFVAR_INT(lname, vname, doc) \
1994 static struct Lisp_Intfwd i_fwd; \
1995 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1998 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2000 static struct Lisp_Objfwd o_fwd; \
2001 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2004 #define DEFVAR_KBOARD(lname, vname, doc) \
2006 static struct Lisp_Kboard_Objfwd ko_fwd; \
2007 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2010 /* Save and restore the instruction and environment pointers,
2011 without affecting the signal mask. */
2014 typedef jmp_buf sys_jmp_buf
;
2015 # define sys_setjmp(j) _setjmp (j)
2016 # define sys_longjmp(j, v) _longjmp (j, v)
2017 #elif defined HAVE_SIGSETJMP
2018 typedef sigjmp_buf sys_jmp_buf
;
2019 # define sys_setjmp(j) sigsetjmp (j, 0)
2020 # define sys_longjmp(j, v) siglongjmp (j, v)
2022 /* A platform that uses neither _longjmp nor siglongjmp; assume
2023 longjmp does not affect the sigmask. */
2024 typedef jmp_buf sys_jmp_buf
;
2025 # define sys_setjmp(j) setjmp (j)
2026 # define sys_longjmp(j, v) longjmp (j, v)
2030 /* Structure for recording Lisp call stack for backtrace purposes. */
2032 /* The special binding stack holds the outer values of variables while
2033 they are bound by a function application or a let form, stores the
2034 code to be executed for Lisp unwind-protect forms, and stores the C
2035 functions to be called for record_unwind_protect.
2037 If func is non-zero, undoing this binding applies func to old_value;
2038 This implements record_unwind_protect.
2040 Otherwise, the element is a variable binding.
2042 If the symbol field is a symbol, it is an ordinary variable binding.
2044 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2045 which means having bound a local value while CURRENT-BUFFER was active.
2046 If WHERE is nil this means we saw the default value when binding SYMBOL.
2047 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2048 value. Other values of WHERE mean an internal error. */
2050 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2054 Lisp_Object symbol
, old_value
;
2055 specbinding_func func
;
2056 Lisp_Object unused
; /* Dividing by 16 is faster than by 12. */
2059 extern struct specbinding
*specpdl
;
2060 extern struct specbinding
*specpdl_ptr
;
2061 extern ptrdiff_t specpdl_size
;
2063 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2067 struct backtrace
*next
;
2068 Lisp_Object function
;
2069 Lisp_Object
*args
; /* Points to vector of args. */
2070 ptrdiff_t nargs
; /* Length of vector. */
2071 /* Nonzero means call value of debugger when done with this operation. */
2072 unsigned int debug_on_exit
: 1;
2075 extern struct backtrace
*backtrace_list
;
2077 /* Everything needed to describe an active condition case.
2079 Members are volatile if their values need to survive _longjmp when
2080 a 'struct handler' is a local variable. */
2083 /* The handler clauses and variable from the condition-case form. */
2084 /* For a handler set up in Lisp code, this is always a list.
2085 For an internal handler set up by internal_condition_case*,
2086 this can instead be the symbol t or `error'.
2087 t: handle all conditions.
2088 error: handle all conditions, and errors can run the debugger
2089 or display a backtrace. */
2090 Lisp_Object handler
;
2092 Lisp_Object
volatile var
;
2094 /* Fsignal stores here the condition-case clause that applies,
2095 and Fcondition_case thus knows which clause to run. */
2096 Lisp_Object
volatile chosen_clause
;
2098 /* Used to effect the longjump out to the handler. */
2099 struct catchtag
*tag
;
2101 /* The next enclosing handler. */
2102 struct handler
*next
;
2105 /* This structure helps implement the `catch' and `throw' control
2106 structure. A struct catchtag contains all the information needed
2107 to restore the state of the interpreter after a non-local jump.
2109 Handlers for error conditions (represented by `struct handler'
2110 structures) just point to a catch tag to do the cleanup required
2113 catchtag structures are chained together in the C calling stack;
2114 the `next' member points to the next outer catchtag.
2116 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2117 member is TAG, and then unbinds to it. The `val' member is used to
2118 hold VAL while the stack is unwound; `val' is returned as the value
2121 All the other members are concerned with restoring the interpreter
2124 Members are volatile if their values need to survive _longjmp when
2125 a 'struct catchtag' is a local variable. */
2129 Lisp_Object
volatile val
;
2130 struct catchtag
*volatile next
;
2131 struct gcpro
*gcpro
;
2133 struct backtrace
*backlist
;
2134 struct handler
*handlerlist
;
2135 EMACS_INT lisp_eval_depth
;
2136 ptrdiff_t volatile pdlcount
;
2137 int poll_suppress_count
;
2138 int interrupt_input_blocked
;
2139 struct byte_stack
*byte_stack
;
2142 extern Lisp_Object memory_signal_data
;
2144 /* An address near the bottom of the stack.
2145 Tells GC how to save a copy of the stack. */
2146 extern char *stack_bottom
;
2148 /* Check quit-flag and quit if it is non-nil.
2149 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2150 So the program needs to do QUIT at times when it is safe to quit.
2151 Every loop that might run for a long time or might not exit
2152 ought to do QUIT at least once, at a safe place.
2153 Unless that is impossible, of course.
2154 But it is very desirable to avoid creating loops where QUIT is impossible.
2156 Exception: if you set immediate_quit to nonzero,
2157 then the handler that responds to the C-g does the quit itself.
2158 This is a good thing to do around a loop that has no side effects
2159 and (in particular) cannot call arbitrary Lisp code.
2161 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2162 a request to exit Emacs when it is safe to do. */
2164 extern void process_pending_signals (void);
2165 extern bool volatile pending_signals
;
2167 extern void process_quit_flag (void);
2170 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2171 process_quit_flag (); \
2172 else if (pending_signals) \
2173 process_pending_signals (); \
2177 /* Nonzero if ought to quit now. */
2179 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2181 extern Lisp_Object Vascii_downcase_table
;
2182 extern Lisp_Object Vascii_canon_table
;
2184 /* Structure for recording stack slots that need marking. */
2186 /* This is a chain of structures, each of which points at a Lisp_Object
2187 variable whose value should be marked in garbage collection.
2188 Normally every link of the chain is an automatic variable of a function,
2189 and its `val' points to some argument or local variable of the function.
2190 On exit to the function, the chain is set back to the value it had on entry.
2191 This way, no link remains in the chain when the stack frame containing the
2194 Every function that can call Feval must protect in this fashion all
2195 Lisp_Object variables whose contents will be used again. */
2197 extern struct gcpro
*gcprolist
;
2203 /* Address of first protected variable. */
2204 volatile Lisp_Object
*var
;
2206 /* Number of consecutive protected variables. */
2214 /* Values of GC_MARK_STACK during compilation:
2216 0 Use GCPRO as before
2217 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2218 2 Mark the stack, and check that everything GCPRO'd is
2220 3 Mark using GCPRO's, mark stack last, and count how many
2221 dead objects are kept alive. */
2224 #define GC_USE_GCPROS_AS_BEFORE 0
2225 #define GC_MAKE_GCPROS_NOOPS 1
2226 #define GC_MARK_STACK_CHECK_GCPROS 2
2227 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2229 #ifndef GC_MARK_STACK
2230 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2233 /* Whether we do the stack marking manually. */
2234 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2235 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2238 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2240 /* Do something silly with gcproN vars just so gcc shuts up. */
2241 /* You get warnings from MIPSPro... */
2243 #define GCPRO1(varname) ((void) gcpro1)
2244 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2245 #define GCPRO3(varname1, varname2, varname3) \
2246 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2247 #define GCPRO4(varname1, varname2, varname3, varname4) \
2248 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2249 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2250 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2251 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2252 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2254 #define UNGCPRO ((void) 0)
2256 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2260 #define GCPRO1(varname) \
2261 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2262 gcprolist = &gcpro1; }
2264 #define GCPRO2(varname1, varname2) \
2265 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2266 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2267 gcprolist = &gcpro2; }
2269 #define GCPRO3(varname1, varname2, varname3) \
2270 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2271 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2272 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2273 gcprolist = &gcpro3; }
2275 #define GCPRO4(varname1, varname2, varname3, varname4) \
2276 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2277 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2278 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2279 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2280 gcprolist = &gcpro4; }
2282 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2283 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2284 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2285 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2286 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2287 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2288 gcprolist = &gcpro5; }
2290 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2291 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2292 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2293 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2294 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2295 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2296 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2297 gcprolist = &gcpro6; }
2299 #define UNGCPRO (gcprolist = gcpro1.next)
2303 extern int gcpro_level
;
2305 #define GCPRO1(varname) \
2306 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2307 gcpro1.level = gcpro_level++; \
2308 gcprolist = &gcpro1; }
2310 #define GCPRO2(varname1, varname2) \
2311 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2312 gcpro1.level = gcpro_level; \
2313 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2314 gcpro2.level = gcpro_level++; \
2315 gcprolist = &gcpro2; }
2317 #define GCPRO3(varname1, varname2, varname3) \
2318 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2319 gcpro1.level = gcpro_level; \
2320 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2321 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2322 gcpro3.level = gcpro_level++; \
2323 gcprolist = &gcpro3; }
2325 #define GCPRO4(varname1, varname2, varname3, varname4) \
2326 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2327 gcpro1.level = gcpro_level; \
2328 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2329 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2330 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2331 gcpro4.level = gcpro_level++; \
2332 gcprolist = &gcpro4; }
2334 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2335 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2336 gcpro1.level = gcpro_level; \
2337 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2338 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2339 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2340 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2341 gcpro5.level = gcpro_level++; \
2342 gcprolist = &gcpro5; }
2344 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2345 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2346 gcpro1.level = gcpro_level; \
2347 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2348 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2349 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2350 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2351 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2352 gcpro6.level = gcpro_level++; \
2353 gcprolist = &gcpro6; }
2356 ((--gcpro_level != gcpro1.level) \
2357 ? (emacs_abort (), 0) \
2358 : ((gcprolist = gcpro1.next), 0))
2360 #endif /* DEBUG_GCPRO */
2361 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2364 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2365 #define RETURN_UNGCPRO(expr) \
2368 Lisp_Object ret_ungc_val; \
2369 ret_ungc_val = (expr); \
2371 return ret_ungc_val; \
2375 /* Call staticpro (&var) to protect static variable `var'. */
2377 void staticpro (Lisp_Object
*);
2379 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2380 meaning as in the DEFUN macro, and is used to construct a prototype. */
2381 /* We can use the same trick as in the DEFUN macro to generate the
2382 appropriate prototype. */
2383 #define EXFUN(fnname, maxargs) \
2384 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2386 /* Forward declarations for prototypes. */
2390 /* Simple access functions. */
2392 LISP_INLINE Lisp_Object
*
2393 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2395 return & XVECTOR (array
)->contents
[idx
];
2399 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2401 /* Like ASET, but also can be used in the garbage collector:
2402 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2403 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2404 XVECTOR (array
)->contents
[idx
] = val
;
2407 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2410 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2412 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2413 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2416 /* Functions to modify hash tables. */
2419 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2421 h
->key_and_value
= key_and_value
;
2425 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2427 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2431 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2433 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2437 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2443 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2445 gc_aset (h
->next
, idx
, val
);
2449 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2455 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2457 gc_aset (h
->hash
, idx
, val
);
2461 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2467 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2469 gc_aset (h
->index
, idx
, val
);
2472 /* Use these functions to set Lisp_Object
2473 or pointer slots of struct Lisp_Symbol. */
2476 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2478 XSYMBOL (sym
)->name
= name
;
2482 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2484 XSYMBOL (sym
)->function
= function
;
2488 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2490 XSYMBOL (sym
)->plist
= plist
;
2494 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2496 XSYMBOL (sym
)->next
= next
;
2499 /* Buffer-local (also frame-local) variable access functions. */
2502 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2504 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2509 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2511 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2515 LISP_INLINE Lisp_Object
2516 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2518 return XCDR (blv
->valcell
);
2522 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2524 XSETCDR (blv
->valcell
, val
);
2528 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2534 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2540 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2545 /* Set overlay's property list. */
2548 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2550 XOVERLAY (overlay
)->plist
= plist
;
2553 /* Get text properties of S. */
2555 LISP_INLINE INTERVAL
2556 string_intervals (Lisp_Object s
)
2558 return XSTRING (s
)->intervals
;
2561 /* Set text properties of S to I. */
2564 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2566 XSTRING (s
)->intervals
= i
;
2569 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2570 of setting slots directly. */
2573 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2575 XCHAR_TABLE (table
)->ascii
= val
;
2578 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2580 XCHAR_TABLE (table
)->defalt
= val
;
2583 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2585 XCHAR_TABLE (table
)->parent
= val
;
2588 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2590 XCHAR_TABLE (table
)->purpose
= val
;
2593 /* Set different slots in (sub)character tables. */
2596 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2598 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2599 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2603 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2605 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2606 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2610 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2612 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2615 /* Defined in data.c. */
2616 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2617 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2618 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2619 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2620 extern Lisp_Object Qinvalid_read_syntax
;
2621 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2622 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2623 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2624 extern Lisp_Object Qtext_read_only
;
2625 extern Lisp_Object Qinteractive_form
;
2626 extern Lisp_Object Qcircular_list
;
2627 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2628 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2629 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2630 extern Lisp_Object Qbuffer_or_string_p
;
2631 extern Lisp_Object Qfboundp
;
2632 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2634 extern Lisp_Object Qcdr
;
2636 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2638 extern Lisp_Object Qfloatp
;
2639 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2641 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2643 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2645 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2647 /* Defined in frame.c. */
2648 extern Lisp_Object Qframep
;
2650 /* Defined in data.c. */
2651 extern Lisp_Object
indirect_function (Lisp_Object
);
2652 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2654 /* Convert the integer I to an Emacs representation, either the integer
2655 itself, or a cons of two or three integers, or if all else fails a float.
2656 I should not have side effects. */
2657 #define INTEGER_TO_CONS(i) \
2658 (! FIXNUM_OVERFLOW_P (i) \
2660 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2661 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2662 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2663 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2664 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2665 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2666 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2667 ? Fcons (make_number ((i) >> 16 >> 24), \
2668 Fcons (make_number ((i) >> 16 & 0xffffff), \
2669 make_number ((i) & 0xffff))) \
2672 /* Convert the Emacs representation CONS back to an integer of type
2673 TYPE, storing the result the variable VAR. Signal an error if CONS
2674 is not a valid representation or is out of range for TYPE. */
2675 #define CONS_TO_INTEGER(cons, type, var) \
2676 (TYPE_SIGNED (type) \
2677 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2678 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2679 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2680 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2682 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2683 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2684 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2686 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2687 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2688 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2689 extern void syms_of_data (void);
2690 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2692 /* Defined in cmds.c */
2693 extern void syms_of_cmds (void);
2694 extern void keys_of_cmds (void);
2696 /* Defined in coding.c. */
2697 extern Lisp_Object Qcharset
;
2698 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2699 ptrdiff_t, bool, bool, Lisp_Object
);
2700 extern void init_coding (void);
2701 extern void init_coding_once (void);
2702 extern void syms_of_coding (void);
2704 /* Defined in character.c. */
2705 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2706 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2707 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2708 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2709 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2710 extern void syms_of_character (void);
2712 /* Defined in charset.c. */
2713 extern void init_charset (void);
2714 extern void init_charset_once (void);
2715 extern void syms_of_charset (void);
2716 /* Structure forward declarations. */
2719 /* Defined in composite.c. */
2720 extern void syms_of_composite (void);
2722 /* Defined in syntax.c. */
2723 extern void init_syntax_once (void);
2724 extern void syms_of_syntax (void);
2726 /* Defined in fns.c. */
2727 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2728 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2729 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2730 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2731 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2732 extern void sweep_weak_hash_tables (void);
2733 extern Lisp_Object Qcursor_in_echo_area
;
2734 extern Lisp_Object Qstring_lessp
;
2735 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2736 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2737 EMACS_UINT
sxhash (Lisp_Object
, int);
2738 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2739 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2741 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2742 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2745 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2746 ptrdiff_t, ptrdiff_t);
2747 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2748 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2749 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2750 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2751 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2752 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2753 extern void clear_string_char_byte_cache (void);
2754 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2755 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2756 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2757 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2758 extern void syms_of_fns (void);
2760 /* Defined in floatfns.c. */
2761 extern double extract_float (Lisp_Object
);
2762 extern void syms_of_floatfns (void);
2763 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2765 /* Defined in fringe.c. */
2766 extern void syms_of_fringe (void);
2767 extern void init_fringe (void);
2768 #ifdef HAVE_WINDOW_SYSTEM
2769 extern void mark_fringe_data (void);
2770 extern void init_fringe_once (void);
2771 #endif /* HAVE_WINDOW_SYSTEM */
2773 /* Defined in image.c. */
2774 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2775 extern Lisp_Object QCconversion
;
2776 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2777 extern void reset_image_types (void);
2778 extern void syms_of_image (void);
2780 /* Defined in insdel.c. */
2781 extern Lisp_Object Qinhibit_modification_hooks
;
2782 extern void move_gap (ptrdiff_t);
2783 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2784 extern _Noreturn
void buffer_overflow (void);
2785 extern void make_gap (ptrdiff_t);
2786 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2787 ptrdiff_t, bool, bool);
2788 extern int count_combining_before (const unsigned char *,
2789 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2790 extern int count_combining_after (const unsigned char *,
2791 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2792 extern void insert (const char *, ptrdiff_t);
2793 extern void insert_and_inherit (const char *, ptrdiff_t);
2794 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2795 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2797 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2798 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2799 ptrdiff_t, ptrdiff_t, bool);
2800 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2801 extern void insert_char (int);
2802 extern void insert_string (const char *);
2803 extern void insert_before_markers (const char *, ptrdiff_t);
2804 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2805 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2806 ptrdiff_t, ptrdiff_t,
2808 extern void del_range (ptrdiff_t, ptrdiff_t);
2809 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2810 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2811 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2812 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2813 ptrdiff_t, ptrdiff_t, bool);
2814 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2815 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2816 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2817 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2818 ptrdiff_t, ptrdiff_t);
2819 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2820 ptrdiff_t, ptrdiff_t);
2821 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2822 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2823 const char *, ptrdiff_t, ptrdiff_t, bool);
2824 extern void syms_of_insdel (void);
2826 /* Defined in dispnew.c. */
2827 #if (defined PROFILING \
2828 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2829 _Noreturn
void __executable_start (void);
2831 extern Lisp_Object selected_frame
;
2832 extern Lisp_Object Vwindow_system
;
2833 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2834 extern void init_display (void);
2835 extern void syms_of_display (void);
2837 /* Defined in xdisp.c. */
2838 extern Lisp_Object Qinhibit_point_motion_hooks
;
2839 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2840 extern Lisp_Object Qmenu_bar_update_hook
;
2841 extern Lisp_Object Qwindow_scroll_functions
;
2842 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2843 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2844 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2845 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2846 extern Lisp_Object Qleft_margin
, Qright_margin
;
2847 extern Lisp_Object Qglyphless_char
;
2848 extern Lisp_Object QCdata
, QCfile
;
2849 extern Lisp_Object QCmap
;
2850 extern Lisp_Object Qrisky_local_variable
;
2851 extern struct frame
*last_glyphless_glyph_frame
;
2852 extern int last_glyphless_glyph_face_id
;
2853 extern int last_glyphless_glyph_merged_face_id
;
2854 extern int noninteractive_need_newline
;
2855 extern Lisp_Object echo_area_buffer
[2];
2856 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2857 extern void check_message_stack (void);
2858 extern void setup_echo_area_for_printing (int);
2859 extern bool push_message (void);
2860 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2861 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2862 extern void restore_message (void);
2863 extern Lisp_Object
current_message (void);
2864 extern void clear_message (int, int);
2865 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2866 extern void message1 (const char *);
2867 extern void message1_nolog (const char *);
2868 extern void message2 (const char *, ptrdiff_t, int);
2869 extern void message2_nolog (const char *, ptrdiff_t, int);
2870 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2871 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2872 extern void message_dolog (const char *, ptrdiff_t, int, int);
2873 extern void message_with_string (const char *, Lisp_Object
, int);
2874 extern void message_log_maybe_newline (void);
2875 extern void update_echo_area (void);
2876 extern void truncate_echo_area (ptrdiff_t);
2877 extern void redisplay (void);
2878 extern void redisplay_preserve_echo_area (int);
2879 extern void prepare_menu_bars (void);
2881 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2882 extern void syms_of_xdisp (void);
2883 extern void init_xdisp (void);
2884 extern Lisp_Object
safe_eval (Lisp_Object
);
2885 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2886 int *, int *, int *, int *, int *);
2888 /* Defined in xsettings.c. */
2889 extern void syms_of_xsettings (void);
2891 /* Defined in vm-limit.c. */
2892 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2894 /* Defined in alloc.c. */
2895 extern void check_pure_size (void);
2896 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2897 extern void malloc_warning (const char *);
2898 extern _Noreturn
void memory_full (size_t);
2899 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2900 extern bool survives_gc_p (Lisp_Object
);
2901 extern void mark_object (Lisp_Object
);
2902 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2903 extern void refill_memory_reserve (void);
2905 extern const char *pending_malloc_warning
;
2906 extern Lisp_Object zero_vector
;
2907 extern Lisp_Object
*stack_base
;
2908 extern EMACS_INT consing_since_gc
;
2909 extern EMACS_INT gc_relative_threshold
;
2910 extern EMACS_INT memory_full_cons_threshold
;
2911 extern Lisp_Object
list1 (Lisp_Object
);
2912 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2913 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2914 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2915 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2917 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2918 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2919 extern _Noreturn
void string_overflow (void);
2920 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2921 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2922 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2923 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2925 /* Make unibyte string from C string when the length isn't known. */
2927 LISP_INLINE Lisp_Object
2928 build_unibyte_string (const char *str
)
2930 return make_unibyte_string (str
, strlen (str
));
2933 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2934 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2935 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2936 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2937 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2938 extern Lisp_Object
make_specified_string (const char *,
2939 ptrdiff_t, ptrdiff_t, bool);
2940 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2941 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2943 /* Make a string allocated in pure space, use STR as string data. */
2945 LISP_INLINE Lisp_Object
2946 build_pure_c_string (const char *str
)
2948 return make_pure_c_string (str
, strlen (str
));
2951 /* Make a string from the data at STR, treating it as multibyte if the
2954 LISP_INLINE Lisp_Object
2955 build_string (const char *str
)
2957 return make_string (str
, strlen (str
));
2960 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2961 extern void make_byte_code (struct Lisp_Vector
*);
2962 extern Lisp_Object Qautomatic_gc
;
2963 extern Lisp_Object Qchar_table_extra_slots
;
2964 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2965 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2966 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2968 allocate_pseudovector \
2969 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2970 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2971 extern struct window
*allocate_window (void);
2972 extern struct frame
*allocate_frame (void);
2973 extern struct Lisp_Process
*allocate_process (void);
2974 extern struct terminal
*allocate_terminal (void);
2975 extern bool gc_in_progress
;
2976 extern bool abort_on_gc
;
2977 extern Lisp_Object
make_float (double);
2978 extern void display_malloc_warning (void);
2979 extern ptrdiff_t inhibit_garbage_collection (void);
2980 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2981 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2982 extern void free_marker (Lisp_Object
);
2983 extern void free_cons (struct Lisp_Cons
*);
2984 extern void init_alloc_once (void);
2985 extern void init_alloc (void);
2986 extern void syms_of_alloc (void);
2987 extern struct buffer
* allocate_buffer (void);
2988 extern int valid_lisp_object_p (Lisp_Object
);
2989 #ifdef GC_CHECK_CONS_LIST
2990 extern void check_cons_list (void);
2992 #define check_cons_list() ((void) 0)
2996 /* Defined in ralloc.c. */
2997 extern void *r_alloc (void **, size_t);
2998 extern void r_alloc_free (void **);
2999 extern void *r_re_alloc (void **, size_t);
3000 extern void r_alloc_reset_variable (void **, void **);
3001 extern void r_alloc_inhibit_buffer_relocation (int);
3004 /* Defined in chartab.c. */
3005 extern Lisp_Object
copy_char_table (Lisp_Object
);
3006 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
3007 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3009 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3010 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3011 extern int char_table_translate (Lisp_Object
, int);
3012 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3014 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3015 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3016 Lisp_Object
, Lisp_Object
,
3017 Lisp_Object
, struct charset
*,
3018 unsigned, unsigned);
3019 extern Lisp_Object
uniprop_table (Lisp_Object
);
3020 extern void syms_of_chartab (void);
3022 /* Defined in print.c. */
3023 extern Lisp_Object Vprin1_to_string_buffer
;
3024 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3025 extern Lisp_Object Qstandard_output
;
3026 extern Lisp_Object Qexternal_debugging_output
;
3027 extern void temp_output_buffer_setup (const char *);
3028 extern int print_level
;
3029 extern Lisp_Object Qprint_escape_newlines
;
3030 extern void write_string (const char *, int);
3031 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3033 extern Lisp_Object internal_with_output_to_temp_buffer
3034 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3035 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3036 extern int float_to_string (char *, double);
3037 extern void syms_of_print (void);
3039 /* Defined in doprnt.c. */
3040 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3042 extern ptrdiff_t esprintf (char *, char const *, ...)
3043 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3044 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3046 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3047 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3048 char const *, va_list)
3049 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3051 /* Defined in lread.c. */
3052 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3053 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3054 extern Lisp_Object Qlexical_binding
;
3055 extern Lisp_Object
check_obarray (Lisp_Object
);
3056 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3057 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3058 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3059 #define LOADHIST_ATTACH(x) \
3061 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3063 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3064 Lisp_Object
*, Lisp_Object
);
3065 extern Lisp_Object
string_to_number (char const *, int, bool);
3066 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3068 extern void dir_warning (const char *, Lisp_Object
);
3069 extern void close_load_descs (void);
3070 extern void init_obarray (void);
3071 extern void init_lread (void);
3072 extern void syms_of_lread (void);
3074 LISP_INLINE Lisp_Object
3075 intern (const char *str
)
3077 return intern_1 (str
, strlen (str
));
3080 LISP_INLINE Lisp_Object
3081 intern_c_string (const char *str
)
3083 return intern_c_string_1 (str
, strlen (str
));
3086 /* Defined in eval.c. */
3087 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3088 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3089 extern Lisp_Object Qand_rest
;
3090 extern Lisp_Object Vautoload_queue
;
3091 extern Lisp_Object Vsignaling_function
;
3092 extern Lisp_Object inhibit_lisp_code
;
3094 extern struct catchtag
*catchlist
;
3095 extern struct handler
*handlerlist
;
3097 /* To run a normal hook, use the appropriate function from the list below.
3098 The calling convention:
3100 if (!NILP (Vrun_hooks))
3101 call1 (Vrun_hooks, Qmy_funny_hook);
3103 should no longer be used. */
3104 extern Lisp_Object Vrun_hooks
;
3105 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3106 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3107 Lisp_Object (*funcall
)
3108 (ptrdiff_t nargs
, Lisp_Object
*args
));
3109 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3110 extern _Noreturn
void xsignal0 (Lisp_Object
);
3111 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3112 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3113 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3115 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3116 extern Lisp_Object
eval_sub (Lisp_Object form
);
3117 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3118 extern Lisp_Object
call0 (Lisp_Object
);
3119 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3120 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3121 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3122 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3123 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3124 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3125 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3126 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3127 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3128 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3129 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3130 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3131 extern Lisp_Object internal_condition_case_n
3132 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3133 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3134 extern void specbind (Lisp_Object
, Lisp_Object
);
3135 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3136 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3137 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3138 extern _Noreturn
void verror (const char *, va_list)
3139 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3140 extern Lisp_Object
un_autoload (Lisp_Object
);
3141 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3142 extern void init_eval_once (void);
3143 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3144 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3145 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3146 extern void init_eval (void);
3148 extern void mark_backtrace (void);
3150 extern void syms_of_eval (void);
3152 /* Defined in editfns.c. */
3153 extern Lisp_Object Qfield
;
3154 extern void insert1 (Lisp_Object
);
3155 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3156 extern Lisp_Object
save_excursion_save (void);
3157 extern Lisp_Object
save_restriction_save (void);
3158 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3159 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3160 extern _Noreturn
void time_overflow (void);
3161 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3162 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3164 extern void init_editfns (void);
3165 extern void syms_of_editfns (void);
3166 extern void set_time_zone_rule (const char *);
3168 /* Defined in buffer.c. */
3169 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3170 extern _Noreturn
void nsberror (Lisp_Object
);
3171 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3172 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3173 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3174 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3175 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3176 extern bool overlay_touches_p (ptrdiff_t);
3177 extern Lisp_Object Vbuffer_alist
;
3178 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3179 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3180 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3181 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3182 extern void init_buffer_once (void);
3183 extern void init_buffer (void);
3184 extern void syms_of_buffer (void);
3185 extern void keys_of_buffer (void);
3187 /* Defined in marker.c. */
3189 extern ptrdiff_t marker_position (Lisp_Object
);
3190 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3191 extern void clear_charpos_cache (struct buffer
*);
3192 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3193 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3194 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3195 extern void unchain_marker (struct Lisp_Marker
*marker
);
3196 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3197 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3198 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3199 ptrdiff_t, ptrdiff_t);
3200 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3201 extern void syms_of_marker (void);
3203 /* Defined in fileio.c. */
3205 extern Lisp_Object Qfile_error
;
3206 extern Lisp_Object Qfile_exists_p
;
3207 extern Lisp_Object Qfile_directory_p
;
3208 extern Lisp_Object Qinsert_file_contents
;
3209 extern Lisp_Object Qfile_name_history
;
3210 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3211 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3212 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3213 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3214 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3215 extern void internal_delete_file (Lisp_Object
);
3216 extern void syms_of_fileio (void);
3217 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3218 extern Lisp_Object Qdelete_file
;
3219 extern bool check_existing (const char *);
3221 /* Defined in search.c. */
3222 extern void shrink_regexp_cache (void);
3223 extern void restore_search_regs (void);
3224 extern void record_unwind_save_match_data (void);
3225 struct re_registers
;
3226 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3227 struct re_registers
*,
3228 Lisp_Object
, int, int);
3229 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3230 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3232 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3233 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3234 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3235 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3237 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3239 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3240 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3241 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3242 extern void syms_of_search (void);
3243 extern void clear_regexp_cache (void);
3245 /* Defined in minibuf.c. */
3247 extern Lisp_Object Qcompletion_ignore_case
;
3248 extern Lisp_Object Vminibuffer_list
;
3249 extern Lisp_Object last_minibuf_string
;
3250 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3251 extern void init_minibuf_once (void);
3252 extern void syms_of_minibuf (void);
3254 /* Defined in callint.c. */
3256 extern Lisp_Object Qminus
, Qplus
;
3257 extern Lisp_Object Qwhen
;
3258 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3259 extern void syms_of_callint (void);
3261 /* Defined in casefiddle.c. */
3263 extern Lisp_Object Qidentity
;
3264 extern void syms_of_casefiddle (void);
3265 extern void keys_of_casefiddle (void);
3267 /* Defined in casetab.c. */
3269 extern void init_casetab_once (void);
3270 extern void syms_of_casetab (void);
3272 /* Defined in keyboard.c. */
3274 extern Lisp_Object echo_message_buffer
;
3275 extern struct kboard
*echo_kboard
;
3276 extern void cancel_echoing (void);
3277 extern Lisp_Object Qdisabled
, QCfilter
;
3278 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3279 extern Lisp_Object Qtop
;
3280 extern Lisp_Object last_undo_boundary
;
3281 extern bool input_pending
;
3282 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3283 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3284 extern void discard_mouse_events (void);
3286 void handle_input_available_signal (int);
3288 extern Lisp_Object pending_funcalls
;
3289 extern bool detect_input_pending (void);
3290 extern bool detect_input_pending_ignore_squeezables (void);
3291 extern bool detect_input_pending_run_timers (bool);
3292 extern void safe_run_hooks (Lisp_Object
);
3293 extern void cmd_error_internal (Lisp_Object
, const char *);
3294 extern Lisp_Object
command_loop_1 (void);
3295 extern Lisp_Object
recursive_edit_1 (void);
3296 extern void record_auto_save (void);
3297 extern void force_auto_save_soon (void);
3298 extern void init_keyboard (void);
3299 extern void syms_of_keyboard (void);
3300 extern void keys_of_keyboard (void);
3302 /* Defined in indent.c. */
3303 extern ptrdiff_t current_column (void);
3304 extern void invalidate_current_column (void);
3305 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3306 extern void syms_of_indent (void);
3308 /* Defined in frame.c. */
3309 extern Lisp_Object Qonly
, Qnone
;
3310 extern Lisp_Object Qvisible
;
3311 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3312 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3313 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3315 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3317 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
3318 extern void frames_discard_buffer (Lisp_Object
);
3319 extern void syms_of_frame (void);
3321 /* Defined in emacs.c. */
3322 extern char **initial_argv
;
3323 extern int initial_argc
;
3324 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3325 extern bool display_arg
;
3327 extern Lisp_Object
decode_env_path (const char *, const char *);
3328 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3329 extern Lisp_Object Qfile_name_handler_alist
;
3330 extern _Noreturn
void terminate_due_to_signal (int, int);
3331 extern Lisp_Object Qkill_emacs
;
3333 extern Lisp_Object Vlibrary_cache
;
3336 void fixup_locale (void);
3337 void synchronize_system_messages_locale (void);
3338 void synchronize_system_time_locale (void);
3340 #define setlocale(category, locale)
3341 #define fixup_locale()
3342 #define synchronize_system_messages_locale()
3343 #define synchronize_system_time_locale()
3345 extern void shut_down_emacs (int, Lisp_Object
);
3347 /* True means don't do interactive redisplay and don't change tty modes. */
3348 extern bool noninteractive
;
3350 /* True means remove site-lisp directories from load-path. */
3351 extern bool no_site_lisp
;
3353 /* Pipe used to send exit notification to the daemon parent at
3355 extern int daemon_pipe
[2];
3356 #define IS_DAEMON (daemon_pipe[1] != 0)
3358 /* True if handling a fatal error already. */
3359 extern bool fatal_error_in_progress
;
3361 /* True means don't do use window-system-specific display code. */
3362 extern bool inhibit_window_system
;
3363 /* True means that a filter or a sentinel is running. */
3364 extern bool running_asynch_code
;
3366 /* Defined in process.c. */
3367 extern Lisp_Object QCtype
, Qlocal
;
3368 extern Lisp_Object Qprocessp
;
3369 extern void kill_buffer_processes (Lisp_Object
);
3370 extern int wait_reading_process_output (intmax_t, int, int, bool,
3372 struct Lisp_Process
*,
3374 /* Max value for the first argument of wait_reading_process_output. */
3375 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3376 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3377 The bug merely causes a bogus warning, but the warning is annoying. */
3378 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3380 # define WAIT_READING_MAX INTMAX_MAX
3382 extern void add_keyboard_wait_descriptor (int);
3383 extern void delete_keyboard_wait_descriptor (int);
3385 extern void add_gpm_wait_descriptor (int);
3386 extern void delete_gpm_wait_descriptor (int);
3388 extern void close_process_descs (void);
3389 extern void init_process_emacs (void);
3390 extern void syms_of_process (void);
3391 extern void setup_process_coding_systems (Lisp_Object
);
3396 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3397 extern void init_callproc_1 (void);
3398 extern void init_callproc (void);
3399 extern void set_initial_environment (void);
3400 extern void syms_of_callproc (void);
3402 /* Defined in doc.c. */
3403 extern Lisp_Object Qfunction_documentation
;
3404 extern Lisp_Object
read_doc_string (Lisp_Object
);
3405 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3406 extern void syms_of_doc (void);
3407 extern int read_bytecode_char (bool);
3409 /* Defined in bytecode.c. */
3410 extern Lisp_Object Qbytecode
;
3411 extern void syms_of_bytecode (void);
3412 extern struct byte_stack
*byte_stack_list
;
3414 extern void mark_byte_stack (void);
3416 extern void unmark_byte_stack (void);
3417 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3418 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3420 /* Defined in macros.c. */
3421 extern Lisp_Object Qexecute_kbd_macro
;
3422 extern void init_macros (void);
3423 extern void syms_of_macros (void);
3425 /* Defined in undo.c. */
3426 extern Lisp_Object Qapply
;
3427 extern Lisp_Object Qinhibit_read_only
;
3428 extern void truncate_undo_list (struct buffer
*);
3429 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3430 extern void record_insert (ptrdiff_t, ptrdiff_t);
3431 extern void record_delete (ptrdiff_t, Lisp_Object
);
3432 extern void record_first_change (void);
3433 extern void record_change (ptrdiff_t, ptrdiff_t);
3434 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3435 Lisp_Object
, Lisp_Object
,
3437 extern void syms_of_undo (void);
3438 /* Defined in textprop.c. */
3439 extern Lisp_Object Qfont
, Qmouse_face
;
3440 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3441 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3442 extern Lisp_Object Qminibuffer_prompt
;
3444 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3446 /* Defined in menu.c. */
3447 extern void syms_of_menu (void);
3449 /* Defined in xmenu.c. */
3450 extern void syms_of_xmenu (void);
3452 /* Defined in termchar.h. */
3453 struct tty_display_info
;
3455 /* Defined in termhooks.h. */
3458 /* Defined in sysdep.c. */
3459 #ifndef HAVE_GET_CURRENT_DIR_NAME
3460 extern char *get_current_dir_name (void);
3462 extern void stuff_char (char c
);
3463 extern void init_foreground_group (void);
3464 extern void init_sigio (int);
3465 extern void sys_subshell (void);
3466 extern void sys_suspend (void);
3467 extern void discard_tty_input (void);
3468 extern void init_sys_modes (struct tty_display_info
*);
3469 extern void reset_sys_modes (struct tty_display_info
*);
3470 extern void init_all_sys_modes (void);
3471 extern void reset_all_sys_modes (void);
3472 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3473 extern void child_setup_tty (int);
3474 extern void setup_pty (int);
3475 extern int set_window_size (int, int, int);
3476 extern EMACS_INT
get_random (void);
3477 extern void seed_random (void *, ptrdiff_t);
3478 extern void init_random (void);
3479 extern void emacs_backtrace (int);
3480 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3481 extern int emacs_open (const char *, int, int);
3482 extern int emacs_close (int);
3483 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3484 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3485 enum { READLINK_BUFSIZE
= 1024 };
3486 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3488 extern void unlock_all_files (void);
3489 extern void lock_file (Lisp_Object
);
3490 extern void unlock_file (Lisp_Object
);
3491 extern void unlock_buffer (struct buffer
*);
3492 extern void syms_of_filelock (void);
3494 /* Defined in sound.c. */
3495 extern void syms_of_sound (void);
3497 /* Defined in category.c. */
3498 extern void init_category_once (void);
3499 extern Lisp_Object
char_category_set (int);
3500 extern void syms_of_category (void);
3502 /* Defined in ccl.c. */
3503 extern void syms_of_ccl (void);
3505 /* Defined in dired.c. */
3506 extern void syms_of_dired (void);
3507 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3508 Lisp_Object
, Lisp_Object
,
3511 /* Defined in term.c. */
3512 extern int *char_ins_del_vector
;
3513 extern void syms_of_term (void);
3514 extern _Noreturn
void fatal (const char *msgid
, ...)
3515 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3517 /* Defined in terminal.c. */
3518 extern void syms_of_terminal (void);
3520 /* Defined in font.c. */
3521 extern void syms_of_font (void);
3522 extern void init_font (void);
3524 #ifdef HAVE_WINDOW_SYSTEM
3525 /* Defined in fontset.c. */
3526 extern void syms_of_fontset (void);
3528 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3529 extern Lisp_Object Qfont_param
;
3532 /* Defined in xfaces.c. */
3533 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3534 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3535 extern Lisp_Object Qmode_line_inactive
;
3536 extern Lisp_Object Qface
;
3537 extern Lisp_Object Qnormal
;
3538 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3539 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3540 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3541 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3542 extern Lisp_Object Qoblique
, Qitalic
;
3543 extern Lisp_Object Vface_alternative_font_family_alist
;
3544 extern Lisp_Object Vface_alternative_font_registry_alist
;
3545 extern void syms_of_xfaces (void);
3547 #ifdef HAVE_X_WINDOWS
3548 /* Defined in xfns.c. */
3549 extern void syms_of_xfns (void);
3551 /* Defined in xsmfns.c. */
3552 extern void syms_of_xsmfns (void);
3554 /* Defined in xselect.c. */
3555 extern void syms_of_xselect (void);
3557 /* Defined in xterm.c. */
3558 extern void syms_of_xterm (void);
3559 #endif /* HAVE_X_WINDOWS */
3561 #ifdef HAVE_WINDOW_SYSTEM
3562 /* Defined in xterm.c, nsterm.m, w32term.c. */
3563 extern char *x_get_keysym_name (int);
3564 #endif /* HAVE_WINDOW_SYSTEM */
3567 /* Defined in xml.c. */
3568 extern void syms_of_xml (void);
3569 extern void xml_cleanup_parser (void);
3573 /* Defined in (x|w32)fns.c, nsfns.m... */
3574 extern int have_menus_p (void);
3578 /* Defined in dbusbind.c. */
3579 void syms_of_dbusbind (void);
3583 /* Defined in profiler.c. */
3584 extern bool profiler_memory_running
;
3585 extern void malloc_probe (size_t);
3586 extern void syms_of_profiler (void);
3590 /* Defined in msdos.c, w32.c. */
3591 extern char *emacs_root_dir (void);
3594 /* True means Emacs has already been initialized.
3595 Used during startup to detect startup of dumped Emacs. */
3596 extern bool initialized
;
3598 /* True means ^G can quit instantly. */
3599 extern bool immediate_quit
;
3601 extern void *xmalloc (size_t);
3602 extern void *xzalloc (size_t);
3603 extern void *xrealloc (void *, size_t);
3604 extern void xfree (void *);
3605 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3606 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3607 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3609 extern char *xstrdup (const char *);
3611 extern char *egetenv (const char *);
3613 /* Set up the name of the machine we're running on. */
3614 extern void init_system_name (void);
3616 /* We used to use `abs', but that clashes with system headers on some
3617 platforms, and using a name reserved by Standard C is a bad idea
3620 #define eabs(x) ((x) < 0 ? -(x) : (x))
3623 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3626 #define make_fixnum_or_float(val) \
3627 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3629 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3630 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3632 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3634 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3635 extern void *record_xmalloc (size_t);
3637 #define USE_SAFE_ALLOCA \
3638 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3640 /* SAFE_ALLOCA allocates a simple buffer. */
3642 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3644 : (sa_must_free = 1, record_xmalloc (size)))
3646 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3647 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3648 positive. The code is tuned for MULTIPLIER being a constant. */
3650 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3652 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3653 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3656 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3658 record_unwind_protect (safe_alloca_unwind, \
3659 make_save_value (buf, 0)); \
3663 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3665 #define SAFE_FREE() \
3667 if (sa_must_free) { \
3669 unbind_to (sa_count, Qnil); \
3674 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3676 #define SAFE_ALLOCA_LISP(buf, nelt) \
3678 if ((nelt) < MAX_ALLOCA / word_size) \
3679 buf = alloca ((nelt) * word_size); \
3680 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3683 buf = xmalloc ((nelt) * word_size); \
3684 arg_ = make_save_value (buf, nelt); \
3685 XSAVE_VALUE (arg_)->dogc = 1; \
3687 record_unwind_protect (safe_alloca_unwind, arg_); \
3690 memory_full (SIZE_MAX); \
3694 #include "globals.h"
3696 /* Check whether it's time for GC, and run it if so. */
3701 if ((consing_since_gc
> gc_cons_threshold
3702 && consing_since_gc
> gc_relative_threshold
)
3703 || (!NILP (Vmemory_full
)
3704 && consing_since_gc
> memory_full_cons_threshold
))
3705 Fgarbage_collect ();
3709 functionp (Lisp_Object object
)
3711 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3713 object
= Findirect_function (object
, Qt
);
3715 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3717 /* Autoloaded symbols are functions, except if they load
3718 macros or keymaps. */
3720 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3721 object
= XCDR (object
);
3723 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3728 return XSUBR (object
)->max_args
!= UNEVALLED
;
3729 else if (COMPILEDP (object
))
3731 else if (CONSP (object
))
3733 Lisp_Object car
= XCAR (object
);
3734 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3742 #endif /* EMACS_LISP_H */