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. */
155 /* Number of bits in a Lisp_Object tag. This can be used in #if. */
158 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
159 integer constant, for MSVC. */
160 #define GCALIGNMENT 8
164 /* Number of bits in a Lisp_Object value, not counting the tag. */
165 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
167 /* Number of bits in a Lisp fixnum tag. */
168 INTTYPEBITS
= GCTYPEBITS
- 1,
170 /* Number of bits in a Lisp fixnum value, not counting the tag. */
171 FIXNUM_BITS
= VALBITS
+ 1
174 #if GCALIGNMENT != 1 << GCTYPEBITS
175 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
178 /* The maximum value that can be stored in a EMACS_INT, assuming all
179 bits other than the type bits contribute to a nonnegative signed value.
180 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
181 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
183 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
185 /* 1. We know malloc returns a multiple of 8. */
186 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
187 || defined DARWIN_OS || defined __sun)
188 /* 2. We can specify multiple-of-8 alignment on static variables. */
190 /* 3. Pointers-as-ints exceed VAL_MAX.
191 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
192 a. unnecessary, because the top bits of an EMACS_INT are unused, and
193 b. slower, because it typically requires extra masking.
194 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
195 # if VAL_MAX < UINTPTR_MAX
196 # define USE_LSB_TAG 1
203 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
204 # define USE_LSB_TAG 1
206 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
207 # define USE_LSB_TAG 0
211 # define alignas(alignment) /* empty */
213 # error "USE_LSB_TAG requires alignas"
218 /* Define the fundamental Lisp data structures. */
220 /* This is the set of Lisp data types. If you want to define a new
221 data type, read the comments after Lisp_Fwd_Type definition
224 /* Lisp integers use 2 tags, to give them one extra bit, thus
225 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
226 static EMACS_INT
const INTMASK
= EMACS_INT_MAX
>> (INTTYPEBITS
- 1);
227 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
228 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
230 /* Stolen from GDB. The only known compiler that doesn't support
231 enums in bitfields is MSVC. */
233 #define ENUM_BF(TYPE) unsigned int
235 #define ENUM_BF(TYPE) enum TYPE
241 /* Integer. XINT (obj) is the integer value. */
243 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
245 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
248 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
249 whose first member indicates the subtype. */
252 /* String. XSTRING (object) points to a struct Lisp_String.
253 The length of the string, and its contents, are stored therein. */
254 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
256 /* Vector of Lisp objects, or something resembling it.
257 XVECTOR (object) points to a struct Lisp_Vector, which contains
258 the size and contents. The size field also contains the type
259 information, if it's not a real vector object. */
262 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
268 /* This is the set of data types that share a common structure.
269 The first member of the structure is a type code from this set.
270 The enum values are arbitrary, but we'll use large numbers to make it
271 more likely that we'll spot the error if a random word in memory is
272 mistakenly interpreted as a Lisp_Misc. */
275 Lisp_Misc_Free
= 0x5eab,
278 Lisp_Misc_Save_Value
,
279 /* Currently floats are not a misc type,
280 but let's define this in case we want to change that. */
282 /* This is not a type code. It is for range checking. */
286 /* These are the types of forwarding objects used in the value slot
287 of symbols for special built-in variables whose value is stored in
291 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
292 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
293 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
294 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
295 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
298 /* If you want to define a new Lisp data type, here are some
299 instructions. See the thread at
300 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
303 First, there are already a couple of Lisp types that can be used if
304 your new type does not need to be exposed to Lisp programs nor
305 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
306 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
307 is suitable for temporarily stashing away pointers and integers in
308 a Lisp object (see the existing uses of make_save_value and
309 XSAVE_VALUE). The latter is useful for vector-like Lisp objects
310 that need to be used as part of other objects, but which are never
311 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
314 These two types don't look pretty when printed, so they are
315 unsuitable for Lisp objects that can be exposed to users.
317 To define a new data type, add one more Lisp_Misc subtype or one
318 more pseudovector subtype. Pseudovectors are more suitable for
319 objects with several slots that need to support fast random access,
320 while Lisp_Misc types are for everything else. A pseudovector object
321 provides one or more slots for Lisp objects, followed by struct
322 members that are accessible only from C. A Lisp_Misc object is a
323 wrapper for a C struct that can contain anything you like.
325 To add a new pseudovector type, extend the pvec_type enumeration;
326 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
328 For a Lisp_Misc, you will also need to add your entry to union
329 Lisp_Misc (but make sure the first word has the same structure as
330 the others, starting with a 16-bit member of the Lisp_Misc_Type
331 enumeration and a 1-bit GC markbit) and make sure the overall size
332 of the union is not increased by your addition.
334 Then you will need to add switch branches in print.c (in
335 print_object, to print your object, and possibly also in
336 print_preprocess) and to alloc.c, to mark your object (in
337 mark_object) and to free it (in gc_sweep). The latter is also the
338 right place to call any code specific to your data type that needs
339 to run when the object is recycled -- e.g., free any additional
340 resources allocated for it that are not Lisp objects. You can even
341 make a pointer to the function that frees the resources a slot in
342 your object -- this way, the same object could be used to represent
343 several disparate C structures. */
345 #ifdef CHECK_LISP_OBJECT_TYPE
347 typedef struct { EMACS_INT i
; } Lisp_Object
;
350 LISP_INLINE Lisp_Object
353 Lisp_Object o
= { i
};
357 LISP_INLINE Lisp_Object
358 LISP_MAKE_RVALUE (Lisp_Object o
)
363 #define LISP_INITIALLY_ZERO {0}
365 #undef CHECK_LISP_OBJECT_TYPE
366 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
367 #else /* CHECK_LISP_OBJECT_TYPE */
369 /* If a struct type is not wanted, define Lisp_Object as just a number. */
371 typedef EMACS_INT Lisp_Object
;
374 #define LISP_MAKE_RVALUE(o) (0 + (o))
375 #define LISP_INITIALLY_ZERO 0
376 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
377 #endif /* CHECK_LISP_OBJECT_TYPE */
379 /* In the size word of a vector, this bit means the vector has been marked. */
381 #define ARRAY_MARK_FLAG PTRDIFF_MIN
383 /* In the size word of a struct Lisp_Vector, this bit means it's really
384 some other vector-like object. */
385 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
387 /* In a pseudovector, the size field actually contains a word with one
388 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
389 with PVEC_TYPE_MASK to indicate the actual type. */
401 PVEC_WINDOW_CONFIGURATION
,
404 /* These last 4 are special because we OR them in fns.c:internal_equal,
405 so they have to use a disjoint bit pattern:
406 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
407 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
408 PVEC_COMPILED
= 0x10,
409 PVEC_CHAR_TABLE
= 0x20,
410 PVEC_SUB_CHAR_TABLE
= 0x30,
414 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
415 which were stored in a Lisp_Object. */
416 #ifndef DATA_SEG_BITS
417 # define DATA_SEG_BITS 0
419 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
424 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
426 /* For convenience, we also store the number of elements in these bits.
427 Note that this size is not necessarily the memory-footprint size, but
428 only the number of Lisp_Object fields (that need to be traced by GC).
429 The distinction is used, e.g., by Lisp_Process, which places extra
430 non-Lisp_Object fields at the end of the structure. */
431 PSEUDOVECTOR_SIZE_BITS
= 16,
432 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
433 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
435 /* Number of bits to put in each character in the internal representation
436 of bool vectors. This should not vary across implementations. */
437 BOOL_VECTOR_BITS_PER_CHAR
= 8
440 /* These macros extract various sorts of values from a Lisp_Object.
441 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
442 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
444 /* Return a perfect hash of the Lisp_Object representation. */
445 #define XHASH(a) XLI (a)
451 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
454 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
455 #define XINT(a) (XLI (a) >> INTTYPEBITS)
456 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
457 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
458 #define make_lisp_ptr(ptr, type) \
459 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
460 XIL ((type) | (intptr_t) (ptr)))
462 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
463 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
465 #else /* not USE_LSB_TAG */
467 #define VALMASK VAL_MAX
469 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
471 /* For integers known to be positive, XFASTINT provides fast retrieval
472 and XSETFASTINT provides fast storage. This takes advantage of the
473 fact that Lisp integers have zero-bits in their tags. */
474 #define XFASTINT(a) (XLI (a) + 0)
475 #define XSETFASTINT(a, b) ((a) = XIL (b))
477 /* Extract the value of a Lisp_Object as a (un)signed integer. */
479 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
480 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
481 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
483 #define make_lisp_ptr(ptr, type) \
484 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
485 + ((intptr_t) (ptr) & VALMASK)))
488 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
489 which were stored in a Lisp_Object. */
490 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
492 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
495 #endif /* not USE_LSB_TAG */
497 /* For integers known to be positive, XFASTINT sometimes provides
498 faster retrieval and XSETFASTINT provides faster storage.
499 If not, fallback on the non-accelerated path. */
501 # define XFASTINT(a) (XINT (a))
502 # define XSETFASTINT(a, b) (XSETINT (a, b))
505 /* Extract the pointer value of the Lisp object A, under the
506 assumption that A's type is TYPE. This is a fallback
507 implementation if nothing faster is available. */
509 # define XUNTAG(a, type) XPNTR (a)
512 #define EQ(x, y) (XHASH (x) == XHASH (y))
514 /* Largest and smallest representable fixnum values. These are the C
515 values. They are macros for use in static initializers. */
516 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
517 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
519 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
520 written this way so that it also works if I is of unsigned
521 type or if I is a NaN. */
523 #define FIXNUM_OVERFLOW_P(i) \
524 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
526 LISP_INLINE
ptrdiff_t
527 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
529 return num
< lower
? lower
: num
<= upper
? num
: upper
;
532 /* Extract a value or address from a Lisp_Object. */
534 #define XCONS(a) (eassert (CONSP (a)), \
535 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
536 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
537 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
538 #define XSTRING(a) (eassert (STRINGP (a)), \
539 (struct Lisp_String *) XUNTAG (a, Lisp_String))
540 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
541 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
542 #define XFLOAT(a) (eassert (FLOATP (a)), \
543 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
547 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
548 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
549 #define XMISCTYPE(a) (XMISCANY (a)->type)
550 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
551 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
552 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
554 /* Forwarding object types. */
556 #define XFWDTYPE(a) (a->u_intfwd.type)
557 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
558 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
559 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
560 #define XBUFFER_OBJFWD(a) \
561 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
562 #define XKBOARD_OBJFWD(a) \
563 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
565 /* Pseudovector types. */
567 #define XPROCESS(a) (eassert (PROCESSP (a)), \
568 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
569 #define XWINDOW(a) (eassert (WINDOWP (a)), \
570 (struct window *) XUNTAG (a, Lisp_Vectorlike))
571 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
572 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
573 #define XSUBR(a) (eassert (SUBRP (a)), \
574 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
575 #define XBUFFER(a) (eassert (BUFFERP (a)), \
576 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
577 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
578 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
579 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
580 ((struct Lisp_Sub_Char_Table *) \
581 XUNTAG (a, Lisp_Vectorlike)))
582 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
583 ((struct Lisp_Bool_Vector *) \
584 XUNTAG (a, Lisp_Vectorlike)))
586 /* Construct a Lisp_Object from a value or address. */
588 #define XSETINT(a, b) ((a) = make_number (b))
589 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
590 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
591 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
592 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
593 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
597 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
598 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
600 /* Pseudovector types. */
602 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
603 #define XSETTYPED_PVECTYPE(v, size_member, code) \
604 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
605 #define XSETPVECTYPESIZE(v, code, sizeval) \
606 ((v)->header.size = (PSEUDOVECTOR_FLAG \
607 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
610 /* The cast to struct vectorlike_header * avoids aliasing issues. */
611 #define XSETPSEUDOVECTOR(a, b, code) \
612 XSETTYPED_PSEUDOVECTOR (a, b, \
613 (((struct vectorlike_header *) \
614 XUNTAG (a, Lisp_Vectorlike)) \
617 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
618 (XSETVECTOR (a, b), \
619 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
620 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
622 #define XSETWINDOW_CONFIGURATION(a, b) \
623 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
624 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
625 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
626 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
627 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
628 #define XSETSUBR(a, b) \
629 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
630 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
631 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
632 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
633 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
634 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
636 /* Convenience macros for dealing with Lisp arrays. */
638 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
639 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
640 #define ASET(ARRAY, IDX, VAL) \
641 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
642 XVECTOR (ARRAY)->contents[IDX] = (VAL))
644 /* Convenience macros for dealing with Lisp strings. */
646 #define SDATA(string) (XSTRING (string)->data + 0)
647 #define SREF(string, index) (SDATA (string)[index] + 0)
648 #define SSET(string, index, new) (SDATA (string)[index] = (new))
649 #define SCHARS(string) (XSTRING (string)->size + 0)
650 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
652 /* Avoid "differ in sign" warnings. */
653 #define SSDATA(x) ((char *) SDATA (x))
655 #define STRING_SET_CHARS(string, newsize) \
656 (XSTRING (string)->size = (newsize))
658 #define STRING_COPYIN(string, index, new, count) \
659 memcpy (SDATA (string) + index, new, count)
663 #define CHECK_TYPE(ok, Qxxxp, x) \
664 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
666 /* Deprecated and will be removed soon. */
668 #define INTERNAL_FIELD(field) field ## _
670 /* See the macros in intervals.h. */
672 typedef struct interval
*INTERVAL
;
674 /* Complain if object is not string or buffer type. */
675 #define CHECK_STRING_OR_BUFFER(x) \
676 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
680 /* Car of this cons cell. */
685 /* Cdr of this cons cell. */
688 /* Used to chain conses on a free list. */
689 struct Lisp_Cons
*chain
;
693 /* Take the car or cdr of something known to be a cons cell. */
694 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
695 of code that has to know what a cons cell looks like. Other code not
696 part of the basic lisp implementation should assume that the car and cdr
697 fields are not accessible as lvalues. (What if we want to switch to
698 a copying collector someday? Cached cons cell field addresses may be
699 invalidated at arbitrary points.) */
700 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
701 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
703 /* Use these from normal code. */
704 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
705 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
707 /* Use these to set the fields of a cons cell.
709 Note that both arguments may refer to the same object, so 'n'
710 should not be read after 'c' is first modified. Also, neither
711 argument should be evaluated more than once; side effects are
712 especially common in the second argument. */
713 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
714 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
716 /* Take the car or cdr of something whose type is not known. */
718 (CONSP ((c)) ? XCAR ((c)) \
719 : NILP ((c)) ? Qnil \
720 : wrong_type_argument (Qlistp, (c)))
723 (CONSP ((c)) ? XCDR ((c)) \
724 : NILP ((c)) ? Qnil \
725 : wrong_type_argument (Qlistp, (c)))
727 /* Take the car or cdr of something whose type is not known. */
728 #define CAR_SAFE(c) \
729 (CONSP ((c)) ? XCAR ((c)) : Qnil)
731 #define CDR_SAFE(c) \
732 (CONSP ((c)) ? XCDR ((c)) : Qnil)
734 /* True if STR is a multibyte string. */
735 #define STRING_MULTIBYTE(STR) \
736 (XSTRING (STR)->size_byte >= 0)
738 /* Return the length in bytes of STR. */
740 #ifdef GC_CHECK_STRING_BYTES
743 extern ptrdiff_t string_bytes (struct Lisp_String
*);
744 #define STRING_BYTES(S) string_bytes ((S))
746 #else /* not GC_CHECK_STRING_BYTES */
748 #define STRING_BYTES(STR) \
749 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
751 #endif /* not GC_CHECK_STRING_BYTES */
753 /* An upper bound on the number of bytes in a Lisp string, not
754 counting the terminating null. This a tight enough bound to
755 prevent integer overflow errors that would otherwise occur during
756 string size calculations. A string cannot contain more bytes than
757 a fixnum can represent, nor can it be so long that C pointer
758 arithmetic stops working on the string plus its terminating null.
759 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
760 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
761 would expose alloc.c internal details that we'd rather keep
764 This is a macro for use in static initializers, and a constant for
765 visibility to GDB. The cast to ptrdiff_t ensures that
766 the macro is signed. */
767 static ptrdiff_t const STRING_BYTES_BOUND
=
768 #define STRING_BYTES_BOUND \
769 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
772 /* Mark STR as a unibyte string. */
773 #define STRING_SET_UNIBYTE(STR) \
774 do { if (EQ (STR, empty_multibyte_string)) \
775 (STR) = empty_unibyte_string; \
776 else XSTRING (STR)->size_byte = -1; } while (0)
778 /* Mark STR as a multibyte string. Assure that STR contains only
779 ASCII characters in advance. */
780 #define STRING_SET_MULTIBYTE(STR) \
781 do { if (EQ (STR, empty_unibyte_string)) \
782 (STR) = empty_multibyte_string; \
783 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
785 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
791 INTERVAL intervals
; /* Text properties in this string. */
795 /* Header of vector-like objects. This documents the layout constraints on
796 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
797 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
798 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
799 because when two such pointers potentially alias, a compiler won't
800 incorrectly reorder loads and stores to their size fields. See
801 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
802 struct vectorlike_header
804 /* This field contains various pieces of information:
805 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
806 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
807 vector (0) or a pseudovector (1).
808 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
809 of slots) of the vector.
810 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
811 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
812 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
813 Lisp_Object slots at the beginning of the object that need to be
814 traced by the GC, tho some types use it slightly differently.
815 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
816 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
820 /* When the vector is allocated from a vector block, NBYTES is used
821 if the vector is not on a free list, and VECTOR is used otherwise.
822 For large vector-like objects, BUFFER or VECTOR is used as a pointer
823 to the next vector-like object. It is generally a buffer or a
824 Lisp_Vector alias, so for convenience it is a union instead of a
825 pointer: this way, one can write P->next.vector instead of ((struct
826 Lisp_Vector *) P->next). */
828 /* This is only needed for small vectors that are not free because the
829 `size' field only gives us the number of Lisp_Object slots, whereas we
830 need to know the total size, including non-Lisp_Object data.
831 FIXME: figure out a way to store this info elsewhere so we can
832 finally get rid of this extra word of overhead. */
834 struct buffer
*buffer
;
835 /* FIXME: This can be removed: For large vectors, this field could be
836 placed *before* the vector itself. And for small vectors on a free
837 list, this field could be stored in the vector's bytes, since the
838 empty vector is handled specially anyway. */
839 struct Lisp_Vector
*vector
;
843 /* Regular vector is just a header plus array of Lisp_Objects. */
847 struct vectorlike_header header
;
848 Lisp_Object contents
[1];
851 /* A boolvector is a kind of vectorlike, with contents are like a string. */
853 struct Lisp_Bool_Vector
855 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
856 just the subtype information. */
857 struct vectorlike_header header
;
858 /* This is the size in bits. */
860 /* This contains the actual bits, packed into bytes. */
861 unsigned char data
[1];
864 /* Some handy constants for calculating sizes
865 and offsets, mostly of vectorlike objects. */
869 header_size
= offsetof (struct Lisp_Vector
, contents
),
870 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
871 word_size
= sizeof (Lisp_Object
)
874 /* If a struct is made to look like a vector, this macro returns the length
875 of the shortest vector that would hold that struct. */
877 #define VECSIZE(type) \
878 ((sizeof (type) - header_size + word_size - 1) / word_size)
880 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
881 at the end and we need to compute the number of Lisp_Object fields (the
882 ones that the GC needs to trace). */
884 #define PSEUDOVECSIZE(type, nonlispfield) \
885 ((offsetof (type, nonlispfield) - header_size) / word_size)
887 /* A char-table is a kind of vectorlike, with contents are like a
888 vector but with a few other slots. For some purposes, it makes
889 sense to handle a char-table with type struct Lisp_Vector. An
890 element of a char table can be any Lisp objects, but if it is a sub
891 char-table, we treat it a table that contains information of a
892 specific range of characters. A sub char-table has the same
893 structure as a vector. A sub char table appears only in an element
894 of a char-table, and there's no way to access it directly from
895 Emacs Lisp program. */
899 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
900 ({struct Lisp_Char_Table *_tbl = NULL; \
903 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
904 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
905 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
907 _val = _tbl->defalt; \
908 } while (NILP (_val) && ! NILP (_tbl->parent)); \
911 #else /* not __GNUC__ */
913 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
914 (! NILP (XCHAR_TABLE (CT)->ascii) \
915 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
916 ? XCHAR_TABLE (CT)->ascii \
917 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
918 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
919 : char_table_ref ((CT), (IDX))) \
920 : char_table_ref ((CT), (IDX)))
922 #endif /* not __GNUC__ */
924 /* Compute A OP B, using the unsigned comparison operator OP. A and B
925 should be integer expressions. This is not the same as
926 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
927 returns 1. For efficiency, prefer plain unsigned comparison if A
928 and B's sizes both fit (after integer promotion). */
929 #define UNSIGNED_CMP(a, op, b) \
930 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
931 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
932 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
934 /* Nonzero iff C is an ASCII character. */
935 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
937 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
938 characters. Do not check validity of CT. */
939 #define CHAR_TABLE_REF(CT, IDX) \
940 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
941 : char_table_ref ((CT), (IDX)))
943 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
944 8-bit European characters. Do not check validity of CT. */
945 #define CHAR_TABLE_SET(CT, IDX, VAL) \
946 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
947 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
948 : char_table_set (CT, IDX, VAL))
950 enum CHARTAB_SIZE_BITS
952 CHARTAB_SIZE_BITS_0
= 6,
953 CHARTAB_SIZE_BITS_1
= 4,
954 CHARTAB_SIZE_BITS_2
= 5,
955 CHARTAB_SIZE_BITS_3
= 7
958 extern const int chartab_size
[4];
960 struct Lisp_Char_Table
962 /* HEADER.SIZE is the vector's size field, which also holds the
963 pseudovector type information. It holds the size, too.
964 The size counts the defalt, parent, purpose, ascii,
965 contents, and extras slots. */
966 struct vectorlike_header header
;
968 /* This holds a default value,
969 which is used whenever the value for a specific character is nil. */
972 /* This points to another char table, which we inherit from when the
973 value for a specific character is nil. The `defalt' slot takes
974 precedence over this. */
977 /* This is a symbol which says what kind of use this char-table is
981 /* The bottom sub char-table for characters of the range 0..127. It
982 is nil if none of ASCII character has a specific value. */
985 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
987 /* These hold additional data. It is a vector. */
988 Lisp_Object extras
[1];
991 struct Lisp_Sub_Char_Table
993 /* HEADER.SIZE is the vector's size field, which also holds the
994 pseudovector type information. It holds the size, too. */
995 struct vectorlike_header header
;
997 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
998 char-table of depth 1 contains 16 elements, and each element
999 covers 4096 (128*32) characters. A sub char-table of depth 2
1000 contains 32 elements, and each element covers 128 characters. A
1001 sub char-table of depth 3 contains 128 elements, and each element
1002 is for one character. */
1005 /* Minimum character covered by the sub char-table. */
1006 Lisp_Object min_char
;
1008 /* Use set_sub_char_table_contents to set this. */
1009 Lisp_Object contents
[1];
1012 /* This structure describes a built-in function.
1013 It is generated by the DEFUN macro only.
1014 defsubr makes it into a Lisp object.
1016 This type is treated in most respects as a pseudovector,
1017 but since we never dynamically allocate or free them,
1018 we don't need a struct vectorlike_header and its 'next' field. */
1024 Lisp_Object (*a0
) (void);
1025 Lisp_Object (*a1
) (Lisp_Object
);
1026 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1027 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1028 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1029 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1030 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1031 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1032 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1033 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1034 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1036 short min_args
, max_args
;
1037 const char *symbol_name
;
1038 const char *intspec
;
1042 /* This is the number of slots that every char table must have. This
1043 counts the ordinary slots and the top, defalt, parent, and purpose
1045 enum CHAR_TABLE_STANDARD_SLOTS
1047 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1050 /* Return the number of "extra" slots in the char table CT. */
1052 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1053 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1056 /***********************************************************************
1058 ***********************************************************************/
1060 /* Interned state of a symbol. */
1062 enum symbol_interned
1064 SYMBOL_UNINTERNED
= 0,
1065 SYMBOL_INTERNED
= 1,
1066 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1069 enum symbol_redirect
1071 SYMBOL_PLAINVAL
= 4,
1072 SYMBOL_VARALIAS
= 1,
1073 SYMBOL_LOCALIZED
= 2,
1074 SYMBOL_FORWARDED
= 3
1079 unsigned gcmarkbit
: 1;
1081 /* Indicates where the value can be found:
1082 0 : it's a plain var, the value is in the `value' field.
1083 1 : it's a varalias, the value is really in the `alias' symbol.
1084 2 : it's a localized var, the value is in the `blv' object.
1085 3 : it's a forwarding variable, the value is in `forward'. */
1086 ENUM_BF (symbol_redirect
) redirect
: 3;
1088 /* Non-zero means symbol is constant, i.e. changing its value
1089 should signal an error. If the value is 3, then the var
1090 can be changed, but only by `defconst'. */
1091 unsigned constant
: 2;
1093 /* Interned state of the symbol. This is an enumerator from
1094 enum symbol_interned. */
1095 unsigned interned
: 2;
1097 /* Non-zero means that this variable has been explicitly declared
1098 special (with `defvar' etc), and shouldn't be lexically bound. */
1099 unsigned declared_special
: 1;
1101 /* The symbol's name, as a Lisp string. */
1104 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1105 union is used depends on the `redirect' field above. */
1108 struct Lisp_Symbol
*alias
;
1109 struct Lisp_Buffer_Local_Value
*blv
;
1110 union Lisp_Fwd
*fwd
;
1113 /* Function value of the symbol or Qunbound if not fboundp. */
1114 Lisp_Object function
;
1116 /* The symbol's property list. */
1119 /* Next symbol in obarray bucket, if the symbol is interned. */
1120 struct Lisp_Symbol
*next
;
1123 /* Value is name of symbol. */
1125 #define SYMBOL_VAL(sym) \
1126 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1127 #define SYMBOL_ALIAS(sym) \
1128 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1129 #define SYMBOL_BLV(sym) \
1130 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1131 #define SYMBOL_FWD(sym) \
1132 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1133 #define SET_SYMBOL_VAL(sym, v) \
1134 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1135 #define SET_SYMBOL_ALIAS(sym, v) \
1136 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1137 #define SET_SYMBOL_BLV(sym, v) \
1138 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1139 #define SET_SYMBOL_FWD(sym, v) \
1140 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1142 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1144 /* Value is non-zero if SYM is an interned symbol. */
1146 #define SYMBOL_INTERNED_P(sym) \
1147 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1149 /* Value is non-zero if SYM is interned in initial_obarray. */
1151 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1152 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1154 /* Value is non-zero if symbol is considered a constant, i.e. its
1155 value cannot be changed (there is an exception for keyword symbols,
1156 whose value can be set to the keyword symbol itself). */
1158 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1160 #define DEFSYM(sym, name) \
1161 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1164 /***********************************************************************
1166 ***********************************************************************/
1168 /* The structure of a Lisp hash table. */
1170 struct Lisp_Hash_Table
1172 /* This is for Lisp; the hash table code does not refer to it. */
1173 struct vectorlike_header header
;
1175 /* Function used to compare keys. */
1178 /* Nil if table is non-weak. Otherwise a symbol describing the
1179 weakness of the table. */
1182 /* When the table is resized, and this is an integer, compute the
1183 new size by adding this to the old size. If a float, compute the
1184 new size by multiplying the old size with this factor. */
1185 Lisp_Object rehash_size
;
1187 /* Resize hash table when number of entries/ table size is >= this
1189 Lisp_Object rehash_threshold
;
1191 /* Vector of hash codes.. If hash[I] is nil, this means that that
1192 entry I is unused. */
1195 /* Vector used to chain entries. If entry I is free, next[I] is the
1196 entry number of the next free item. If entry I is non-free,
1197 next[I] is the index of the next entry in the collision chain. */
1200 /* Index of first free entry in free list. */
1201 Lisp_Object next_free
;
1203 /* Bucket vector. A non-nil entry is the index of the first item in
1204 a collision chain. This vector's size can be larger than the
1205 hash table size to reduce collisions. */
1208 /* User-supplied hash function, or nil. */
1209 Lisp_Object user_hash_function
;
1211 /* User-supplied key comparison function, or nil. */
1212 Lisp_Object user_cmp_function
;
1214 /* Only the fields above are traced normally by the GC. The ones below
1215 `count' are special and are either ignored by the GC or traced in
1216 a special way (e.g. because of weakness). */
1218 /* Number of key/value entries in the table. */
1221 /* Vector of keys and values. The key of item I is found at index
1222 2 * I, the value is found at index 2 * I + 1.
1223 This is gc_marked specially if the table is weak. */
1224 Lisp_Object key_and_value
;
1226 /* Next weak hash table if this is a weak hash table. The head
1227 of the list is in weak_hash_tables. */
1228 struct Lisp_Hash_Table
*next_weak
;
1230 /* C function to compare two keys. */
1231 bool (*cmpfn
) (struct Lisp_Hash_Table
*,
1232 Lisp_Object
, EMACS_UINT
,
1233 Lisp_Object
, EMACS_UINT
);
1235 /* C function to compute hash code. */
1236 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1240 #define XHASH_TABLE(OBJ) \
1241 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1243 #define XSET_HASH_TABLE(VAR, PTR) \
1244 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1246 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1248 #define CHECK_HASH_TABLE(x) \
1249 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1251 /* Value is the key part of entry IDX in hash table H. */
1253 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1255 /* Value is the value part of entry IDX in hash table H. */
1257 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1259 /* Value is the index of the next entry following the one at IDX
1262 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1264 /* Value is the hash code computed for entry IDX in hash table H. */
1266 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1268 /* Value is the index of the element in hash table H that is the
1269 start of the collision list at index IDX in the index vector of H. */
1271 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1273 /* Value is the size of hash table H. */
1275 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1277 /* Default size for hash tables if not specified. */
1279 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1281 /* Default threshold specifying when to resize a hash table. The
1282 value gives the ratio of current entries in the hash table and the
1283 size of the hash table. */
1285 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1287 /* Default factor by which to increase the size of a hash table. */
1289 static double const DEFAULT_REHASH_SIZE
= 1.5;
1291 /* These structures are used for various misc types. */
1293 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1295 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1296 unsigned gcmarkbit
: 1;
1302 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1303 unsigned gcmarkbit
: 1;
1305 /* This flag is temporarily used in the functions
1306 decode/encode_coding_object to record that the marker position
1307 must be adjusted after the conversion. */
1308 unsigned int need_adjustment
: 1;
1309 /* 1 means normal insertion at the marker's position
1310 leaves the marker after the inserted text. */
1311 unsigned int insertion_type
: 1;
1312 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1313 Note: a chain of markers can contain markers pointing into different
1314 buffers (the chain is per buffer_text rather than per buffer, so it's
1315 shared between indirect buffers). */
1316 /* This is used for (other than NULL-checking):
1318 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1319 - unchain_marker: to find the list from which to unchain.
1320 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1322 struct buffer
*buffer
;
1324 /* The remaining fields are meaningless in a marker that
1325 does not point anywhere. */
1327 /* For markers that point somewhere,
1328 this is used to chain of all the markers in a given buffer. */
1329 /* We could remove it and use an array in buffer_text instead.
1330 That would also allow to preserve it ordered. */
1331 struct Lisp_Marker
*next
;
1332 /* This is the char position where the marker points. */
1334 /* This is the byte position.
1335 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1336 used to implement the functionality of markers, but rather to (ab)use
1337 markers as a cache for char<->byte mappings). */
1341 /* START and END are markers in the overlay's buffer, and
1342 PLIST is the overlay's property list. */
1344 /* An overlay's real data content is:
1346 - buffer (really there are two buffer pointers, one per marker,
1347 and both points to the same buffer)
1348 - insertion type of both ends (per-marker fields)
1349 - start & start byte (of start marker)
1350 - end & end byte (of end marker)
1351 - next (singly linked list of overlays)
1352 - next fields of start and end markers (singly linked list of markers).
1353 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1356 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1357 unsigned gcmarkbit
: 1;
1359 struct Lisp_Overlay
*next
;
1365 /* Hold a C pointer for later use.
1366 This type of object is used in the arg to record_unwind_protect. */
1367 struct Lisp_Save_Value
1369 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1370 unsigned gcmarkbit
: 1;
1372 /* If DOGC is set, POINTER is the address of a memory
1373 area containing INTEGER potential Lisp_Objects. */
1374 unsigned int dogc
: 1;
1380 /* A miscellaneous object, when it's on the free list. */
1383 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1384 unsigned gcmarkbit
: 1;
1386 union Lisp_Misc
*chain
;
1389 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1390 It uses one of these struct subtypes to get the type field. */
1394 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1395 struct Lisp_Free u_free
;
1396 struct Lisp_Marker u_marker
;
1397 struct Lisp_Overlay u_overlay
;
1398 struct Lisp_Save_Value u_save_value
;
1401 /* Forwarding pointer to an int variable.
1402 This is allowed only in the value cell of a symbol,
1403 and it means that the symbol's value really lives in the
1404 specified int variable. */
1407 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1411 /* Boolean forwarding pointer to an int variable.
1412 This is like Lisp_Intfwd except that the ostensible
1413 "value" of the symbol is t if the int variable is nonzero,
1414 nil if it is zero. */
1417 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1421 /* Forwarding pointer to a Lisp_Object variable.
1422 This is allowed only in the value cell of a symbol,
1423 and it means that the symbol's value really lives in the
1424 specified variable. */
1427 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1428 Lisp_Object
*objvar
;
1431 /* Like Lisp_Objfwd except that value lives in a slot in the
1432 current buffer. Value is byte index of slot within buffer. */
1433 struct Lisp_Buffer_Objfwd
1435 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1437 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1440 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1441 the symbol has buffer-local or frame-local bindings. (Exception:
1442 some buffer-local variables are built-in, with their values stored
1443 in the buffer structure itself. They are handled differently,
1444 using struct Lisp_Buffer_Objfwd.)
1446 The `realvalue' slot holds the variable's current value, or a
1447 forwarding pointer to where that value is kept. This value is the
1448 one that corresponds to the loaded binding. To read or set the
1449 variable, you must first make sure the right binding is loaded;
1450 then you can access the value in (or through) `realvalue'.
1452 `buffer' and `frame' are the buffer and frame for which the loaded
1453 binding was found. If those have changed, to make sure the right
1454 binding is loaded it is necessary to find which binding goes with
1455 the current buffer and selected frame, then load it. To load it,
1456 first unload the previous binding, then copy the value of the new
1457 binding into `realvalue' (or through it). Also update
1458 LOADED-BINDING to point to the newly loaded binding.
1460 `local_if_set' indicates that merely setting the variable creates a
1461 local binding for the current buffer. Otherwise the latter, setting
1462 the variable does not do that; only make-local-variable does that. */
1464 struct Lisp_Buffer_Local_Value
1466 /* 1 means that merely setting the variable creates a local
1467 binding for the current buffer. */
1468 unsigned int local_if_set
: 1;
1469 /* 1 means this variable can have frame-local bindings, otherwise, it is
1470 can have buffer-local bindings. The two cannot be combined. */
1471 unsigned int frame_local
: 1;
1472 /* 1 means that the binding now loaded was found.
1473 Presumably equivalent to (defcell!=valcell). */
1474 unsigned int found
: 1;
1475 /* If non-NULL, a forwarding to the C var where it should also be set. */
1476 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1477 /* The buffer or frame for which the loaded binding was found. */
1479 /* A cons cell that holds the default value. It has the form
1480 (SYMBOL . DEFAULT-VALUE). */
1481 Lisp_Object defcell
;
1482 /* The cons cell from `where's parameter alist.
1483 It always has the form (SYMBOL . VALUE)
1484 Note that if `forward' is non-nil, VALUE may be out of date.
1485 Also if the currently loaded binding is the default binding, then
1486 this is `eq'ual to defcell. */
1487 Lisp_Object valcell
;
1490 /* Like Lisp_Objfwd except that value lives in a slot in the
1492 struct Lisp_Kboard_Objfwd
1494 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1500 struct Lisp_Intfwd u_intfwd
;
1501 struct Lisp_Boolfwd u_boolfwd
;
1502 struct Lisp_Objfwd u_objfwd
;
1503 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1504 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1507 /* Lisp floating point type. */
1513 struct Lisp_Float
*chain
;
1517 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1518 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1520 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1521 representations, have infinities and NaNs, and do not trap on
1522 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1523 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1524 wanted here, but is not quite right because Emacs does not require
1525 all the features of C11 Annex F (and does not require C11 at all,
1526 for that matter). */
1527 #define IEEE_FLOATING_POINT (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
1528 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
1530 /* A character, declared with the following typedef, is a member
1531 of some character set associated with the current buffer. */
1532 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1534 typedef unsigned char UCHAR
;
1537 /* Meanings of slots in a Lisp_Compiled: */
1541 COMPILED_ARGLIST
= 0,
1542 COMPILED_BYTECODE
= 1,
1543 COMPILED_CONSTANTS
= 2,
1544 COMPILED_STACK_DEPTH
= 3,
1545 COMPILED_DOC_STRING
= 4,
1546 COMPILED_INTERACTIVE
= 5
1549 /* Flag bits in a character. These also get used in termhooks.h.
1550 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1551 (MUlti-Lingual Emacs) might need 22 bits for the character value
1552 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1555 CHAR_ALT
= 0x0400000,
1556 CHAR_SUPER
= 0x0800000,
1557 CHAR_HYPER
= 0x1000000,
1558 CHAR_SHIFT
= 0x2000000,
1559 CHAR_CTL
= 0x4000000,
1560 CHAR_META
= 0x8000000,
1562 CHAR_MODIFIER_MASK
=
1563 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1565 /* Actually, the current Emacs uses 22 bits for the character value
1573 /* The glyph datatype, used to represent characters on the display.
1574 It consists of a char code and a face id. */
1581 /* Return a glyph's character code. */
1582 #define GLYPH_CHAR(glyph) ((glyph).ch)
1584 /* Return a glyph's face ID. */
1585 #define GLYPH_FACE(glyph) ((glyph).face_id)
1587 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1588 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1589 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1591 /* Return 1 if GLYPH contains valid character code. */
1592 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1595 /* Glyph Code from a display vector may either be an integer which
1596 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1597 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1599 #define GLYPH_CODE_P(gc) \
1601 ? (CHARACTERP (XCAR (gc)) \
1602 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1603 : (RANGED_INTEGERP \
1605 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1606 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1607 : TYPE_MAXIMUM (EMACS_INT)))))
1609 /* The following are valid only if GLYPH_CODE_P (gc). */
1611 #define GLYPH_CODE_CHAR(gc) \
1612 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1614 #define GLYPH_CODE_FACE(gc) \
1615 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1617 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1621 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1623 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1624 (XINT (gc) >> CHARACTERBITS)); \
1628 /* Structure to hold mouse highlight data. This is here because other
1629 header files need it for defining struct x_output etc. */
1631 /* These variables describe the range of text currently shown in its
1632 mouse-face, together with the window they apply to. As long as
1633 the mouse stays within this range, we need not redraw anything on
1634 its account. Rows and columns are glyph matrix positions in
1635 MOUSE_FACE_WINDOW. */
1636 int mouse_face_beg_row
, mouse_face_beg_col
;
1637 int mouse_face_beg_x
, mouse_face_beg_y
;
1638 int mouse_face_end_row
, mouse_face_end_col
;
1639 int mouse_face_end_x
, mouse_face_end_y
;
1640 int mouse_face_past_end
;
1641 Lisp_Object mouse_face_window
;
1642 int mouse_face_face_id
;
1643 Lisp_Object mouse_face_overlay
;
1645 /* 1 if a mouse motion event came and we didn't handle it right away because
1646 gc was in progress. */
1647 int mouse_face_deferred_gc
;
1649 /* FRAME and X, Y position of mouse when last checked for
1650 highlighting. X and Y can be negative or out of range for the frame. */
1651 struct frame
*mouse_face_mouse_frame
;
1652 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1654 /* Nonzero means defer mouse-motion highlighting. */
1655 int mouse_face_defer
;
1657 /* Nonzero means that the mouse highlight should not be shown. */
1658 int mouse_face_hidden
;
1660 int mouse_face_image_state
;
1663 /* Data type checking. */
1665 #define NILP(x) EQ (x, Qnil)
1667 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1668 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1670 #define RANGED_INTEGERP(lo, x, hi) \
1671 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1672 #define TYPE_RANGED_INTEGERP(type, x) \
1673 (TYPE_SIGNED (type) \
1674 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1675 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1677 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1678 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1679 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1680 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1681 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1682 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1684 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1685 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1686 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1687 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1688 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1690 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1691 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1692 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1693 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1694 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1696 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1697 vectorlike_header * avoids aliasing issues. */
1698 #define PSEUDOVECTORP(x, code) \
1699 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1701 #define PSEUDOVECTOR_TYPEP(v, code) \
1702 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1703 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1705 /* True if object X, with internal type struct T *, is a pseudovector whose
1707 #define TYPED_PSEUDOVECTORP(x, t, code) \
1709 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1711 /* Test for specific pseudovector types. */
1712 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1713 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1714 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1715 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1716 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1717 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1718 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1719 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1720 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1721 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1722 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1723 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1725 /* Test for image (image . spec) */
1726 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1731 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1733 #define CHECK_LIST(x) \
1734 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1736 #define CHECK_LIST_CONS(x, y) \
1737 CHECK_TYPE (CONSP (x), Qlistp, y)
1739 #define CHECK_LIST_END(x, y) \
1740 CHECK_TYPE (NILP (x), Qlistp, y)
1742 #define CHECK_STRING(x) \
1743 CHECK_TYPE (STRINGP (x), Qstringp, x)
1745 #define CHECK_STRING_CAR(x) \
1746 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1748 #define CHECK_CONS(x) \
1749 CHECK_TYPE (CONSP (x), Qconsp, x)
1751 #define CHECK_SYMBOL(x) \
1752 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1754 #define CHECK_CHAR_TABLE(x) \
1755 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1757 #define CHECK_VECTOR(x) \
1758 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1760 #define CHECK_VECTOR_OR_STRING(x) \
1761 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1763 #define CHECK_ARRAY(x, Qxxxp) \
1764 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1766 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1767 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1769 #define CHECK_BUFFER(x) \
1770 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1772 #define CHECK_WINDOW(x) \
1773 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1775 #define CHECK_WINDOW_CONFIGURATION(x) \
1776 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1778 #define CHECK_PROCESS(x) \
1779 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1781 #define CHECK_SUBR(x) \
1782 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1784 #define CHECK_NUMBER(x) \
1785 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1787 #define CHECK_NATNUM(x) \
1788 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1790 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1793 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1794 args_out_of_range_3 \
1796 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1797 ? MOST_NEGATIVE_FIXNUM \
1799 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1801 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1803 if (TYPE_SIGNED (type)) \
1804 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1806 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1809 #define CHECK_MARKER(x) \
1810 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1812 #define CHECK_NUMBER_COERCE_MARKER(x) \
1813 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1814 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1816 #define XFLOATINT(n) extract_float((n))
1818 #define CHECK_FLOAT(x) \
1819 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1821 #define CHECK_NUMBER_OR_FLOAT(x) \
1822 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1824 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1825 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1826 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1828 #define CHECK_OVERLAY(x) \
1829 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1831 /* Since we can't assign directly to the CAR or CDR fields of a cons
1832 cell, use these when checking that those fields contain numbers. */
1833 #define CHECK_NUMBER_CAR(x) \
1835 Lisp_Object tmp = XCAR (x); \
1836 CHECK_NUMBER (tmp); \
1837 XSETCAR ((x), tmp); \
1840 #define CHECK_NUMBER_CDR(x) \
1842 Lisp_Object tmp = XCDR (x); \
1843 CHECK_NUMBER (tmp); \
1844 XSETCDR ((x), tmp); \
1847 #define CHECK_NATNUM_CAR(x) \
1849 Lisp_Object tmp = XCAR (x); \
1850 CHECK_NATNUM (tmp); \
1851 XSETCAR ((x), tmp); \
1854 #define CHECK_NATNUM_CDR(x) \
1856 Lisp_Object tmp = XCDR (x); \
1857 CHECK_NATNUM (tmp); \
1858 XSETCDR ((x), tmp); \
1861 /* Define a built-in function for calling from Lisp.
1862 `lname' should be the name to give the function in Lisp,
1863 as a null-terminated C string.
1864 `fnname' should be the name of the function in C.
1865 By convention, it starts with F.
1866 `sname' should be the name for the C constant structure
1867 that records information on this function for internal use.
1868 By convention, it should be the same as `fnname' but with S instead of F.
1869 It's too bad that C macros can't compute this from `fnname'.
1870 `minargs' should be a number, the minimum number of arguments allowed.
1871 `maxargs' should be a number, the maximum number of arguments allowed,
1872 or else MANY or UNEVALLED.
1873 MANY means pass a vector of evaluated arguments,
1874 in the form of an integer number-of-arguments
1875 followed by the address of a vector of Lisp_Objects
1876 which contains the argument values.
1877 UNEVALLED means pass the list of unevaluated arguments
1878 `intspec' says how interactive arguments are to be fetched.
1879 If the string starts with a `(', `intspec' is evaluated and the resulting
1880 list is the list of arguments.
1881 If it's a string that doesn't start with `(', the value should follow
1882 the one of the doc string for `interactive'.
1883 A null string means call interactively with no arguments.
1884 `doc' is documentation for the user. */
1886 /* This version of DEFUN declares a function prototype with the right
1887 arguments, so we can catch errors with maxargs at compile-time. */
1889 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1890 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1891 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1892 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1893 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1894 { (Lisp_Object (__cdecl *)(void))fnname }, \
1895 minargs, maxargs, lname, intspec, 0}; \
1897 #else /* not _MSC_VER */
1898 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1899 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1900 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1901 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1902 { .a ## maxargs = fnname }, \
1903 minargs, maxargs, lname, intspec, 0}; \
1907 /* Note that the weird token-substitution semantics of ANSI C makes
1908 this work for MANY and UNEVALLED. */
1909 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1910 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1911 #define DEFUN_ARGS_0 (void)
1912 #define DEFUN_ARGS_1 (Lisp_Object)
1913 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1914 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1915 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1916 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1918 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1919 Lisp_Object, Lisp_Object)
1920 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1921 Lisp_Object, Lisp_Object, Lisp_Object)
1922 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1923 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1925 /* Non-zero if OBJ is a Lisp function. */
1926 #define FUNCTIONP(OBJ) functionp(OBJ)
1929 is how we define the symbol for function `name' at start-up time. */
1930 extern void defsubr (struct Lisp_Subr
*);
1938 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1939 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1940 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1941 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1942 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1944 /* Macros we use to define forwarded Lisp variables.
1945 These are used in the syms_of_FILENAME functions.
1947 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1948 lisp variable is actually a field in `struct emacs_globals'. The
1949 field's name begins with "f_", which is a convention enforced by
1950 these macros. Each such global has a corresponding #define in
1951 globals.h; the plain name should be used in the code.
1953 E.g., the global "cons_cells_consed" is declared as "int
1954 f_cons_cells_consed" in globals.h, but there is a define:
1956 #define cons_cells_consed globals.f_cons_cells_consed
1958 All C code uses the `cons_cells_consed' name. This is all done
1959 this way to support indirection for multi-threaded Emacs. */
1961 #define DEFVAR_LISP(lname, vname, doc) \
1963 static struct Lisp_Objfwd o_fwd; \
1964 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1966 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1968 static struct Lisp_Objfwd o_fwd; \
1969 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1971 #define DEFVAR_BOOL(lname, vname, doc) \
1973 static struct Lisp_Boolfwd b_fwd; \
1974 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1976 #define DEFVAR_INT(lname, vname, doc) \
1978 static struct Lisp_Intfwd i_fwd; \
1979 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1982 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1984 static struct Lisp_Objfwd o_fwd; \
1985 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1988 #define DEFVAR_KBOARD(lname, vname, doc) \
1990 static struct Lisp_Kboard_Objfwd ko_fwd; \
1991 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1994 /* Save and restore the instruction and environment pointers,
1995 without affecting the signal mask. */
1998 typedef jmp_buf sys_jmp_buf
;
1999 # define sys_setjmp(j) _setjmp (j)
2000 # define sys_longjmp(j, v) _longjmp (j, v)
2001 #elif defined HAVE_SIGSETJMP
2002 typedef sigjmp_buf sys_jmp_buf
;
2003 # define sys_setjmp(j) sigsetjmp (j, 0)
2004 # define sys_longjmp(j, v) siglongjmp (j, v)
2006 /* A platform that uses neither _longjmp nor siglongjmp; assume
2007 longjmp does not affect the sigmask. */
2008 typedef jmp_buf sys_jmp_buf
;
2009 # define sys_setjmp(j) setjmp (j)
2010 # define sys_longjmp(j, v) longjmp (j, v)
2014 /* Structure for recording Lisp call stack for backtrace purposes. */
2016 /* The special binding stack holds the outer values of variables while
2017 they are bound by a function application or a let form, stores the
2018 code to be executed for Lisp unwind-protect forms, and stores the C
2019 functions to be called for record_unwind_protect.
2021 If func is non-zero, undoing this binding applies func to old_value;
2022 This implements record_unwind_protect.
2024 Otherwise, the element is a variable binding.
2026 If the symbol field is a symbol, it is an ordinary variable binding.
2028 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2029 which means having bound a local value while CURRENT-BUFFER was active.
2030 If WHERE is nil this means we saw the default value when binding SYMBOL.
2031 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2032 value. Other values of WHERE mean an internal error. */
2034 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2038 Lisp_Object symbol
, old_value
;
2039 specbinding_func func
;
2040 Lisp_Object unused
; /* Dividing by 16 is faster than by 12. */
2043 extern struct specbinding
*specpdl
;
2044 extern struct specbinding
*specpdl_ptr
;
2045 extern ptrdiff_t specpdl_size
;
2047 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2051 struct backtrace
*next
;
2052 Lisp_Object function
;
2053 Lisp_Object
*args
; /* Points to vector of args. */
2054 ptrdiff_t nargs
; /* Length of vector. */
2055 /* Nonzero means call value of debugger when done with this operation. */
2056 unsigned int debug_on_exit
: 1;
2059 extern struct backtrace
*backtrace_list
;
2061 /* Everything needed to describe an active condition case.
2063 Members are volatile if their values need to survive _longjmp when
2064 a 'struct handler' is a local variable. */
2067 /* The handler clauses and variable from the condition-case form. */
2068 /* For a handler set up in Lisp code, this is always a list.
2069 For an internal handler set up by internal_condition_case*,
2070 this can instead be the symbol t or `error'.
2071 t: handle all conditions.
2072 error: handle all conditions, and errors can run the debugger
2073 or display a backtrace. */
2074 Lisp_Object handler
;
2076 Lisp_Object
volatile var
;
2078 /* Fsignal stores here the condition-case clause that applies,
2079 and Fcondition_case thus knows which clause to run. */
2080 Lisp_Object
volatile chosen_clause
;
2082 /* Used to effect the longjump out to the handler. */
2083 struct catchtag
*tag
;
2085 /* The next enclosing handler. */
2086 struct handler
*next
;
2089 /* This structure helps implement the `catch' and `throw' control
2090 structure. A struct catchtag contains all the information needed
2091 to restore the state of the interpreter after a non-local jump.
2093 Handlers for error conditions (represented by `struct handler'
2094 structures) just point to a catch tag to do the cleanup required
2097 catchtag structures are chained together in the C calling stack;
2098 the `next' member points to the next outer catchtag.
2100 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2101 member is TAG, and then unbinds to it. The `val' member is used to
2102 hold VAL while the stack is unwound; `val' is returned as the value
2105 All the other members are concerned with restoring the interpreter
2108 Members are volatile if their values need to survive _longjmp when
2109 a 'struct catchtag' is a local variable. */
2113 Lisp_Object
volatile val
;
2114 struct catchtag
*volatile next
;
2115 struct gcpro
*gcpro
;
2117 struct backtrace
*backlist
;
2118 struct handler
*handlerlist
;
2119 EMACS_INT lisp_eval_depth
;
2120 ptrdiff_t volatile pdlcount
;
2121 int poll_suppress_count
;
2122 int interrupt_input_blocked
;
2123 struct byte_stack
*byte_stack
;
2126 extern Lisp_Object memory_signal_data
;
2128 /* An address near the bottom of the stack.
2129 Tells GC how to save a copy of the stack. */
2130 extern char *stack_bottom
;
2132 /* Check quit-flag and quit if it is non-nil.
2133 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2134 So the program needs to do QUIT at times when it is safe to quit.
2135 Every loop that might run for a long time or might not exit
2136 ought to do QUIT at least once, at a safe place.
2137 Unless that is impossible, of course.
2138 But it is very desirable to avoid creating loops where QUIT is impossible.
2140 Exception: if you set immediate_quit to nonzero,
2141 then the handler that responds to the C-g does the quit itself.
2142 This is a good thing to do around a loop that has no side effects
2143 and (in particular) cannot call arbitrary Lisp code.
2145 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2146 a request to exit Emacs when it is safe to do. */
2148 extern void process_pending_signals (void);
2149 extern bool volatile pending_signals
;
2151 extern void process_quit_flag (void);
2154 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2155 process_quit_flag (); \
2156 else if (pending_signals) \
2157 process_pending_signals (); \
2161 /* Nonzero if ought to quit now. */
2163 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2165 extern Lisp_Object Vascii_downcase_table
;
2166 extern Lisp_Object Vascii_canon_table
;
2168 /* Structure for recording stack slots that need marking. */
2170 /* This is a chain of structures, each of which points at a Lisp_Object
2171 variable whose value should be marked in garbage collection.
2172 Normally every link of the chain is an automatic variable of a function,
2173 and its `val' points to some argument or local variable of the function.
2174 On exit to the function, the chain is set back to the value it had on entry.
2175 This way, no link remains in the chain when the stack frame containing the
2178 Every function that can call Feval must protect in this fashion all
2179 Lisp_Object variables whose contents will be used again. */
2181 extern struct gcpro
*gcprolist
;
2187 /* Address of first protected variable. */
2188 volatile Lisp_Object
*var
;
2190 /* Number of consecutive protected variables. */
2198 /* Values of GC_MARK_STACK during compilation:
2200 0 Use GCPRO as before
2201 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2202 2 Mark the stack, and check that everything GCPRO'd is
2204 3 Mark using GCPRO's, mark stack last, and count how many
2205 dead objects are kept alive. */
2208 #define GC_USE_GCPROS_AS_BEFORE 0
2209 #define GC_MAKE_GCPROS_NOOPS 1
2210 #define GC_MARK_STACK_CHECK_GCPROS 2
2211 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2213 #ifndef GC_MARK_STACK
2214 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2217 /* Whether we do the stack marking manually. */
2218 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2219 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2222 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2224 /* Do something silly with gcproN vars just so gcc shuts up. */
2225 /* You get warnings from MIPSPro... */
2227 #define GCPRO1(varname) ((void) gcpro1)
2228 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2229 #define GCPRO3(varname1, varname2, varname3) \
2230 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2231 #define GCPRO4(varname1, varname2, varname3, varname4) \
2232 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2233 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2234 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2235 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2236 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2238 #define UNGCPRO ((void) 0)
2240 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2244 #define GCPRO1(varname) \
2245 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2246 gcprolist = &gcpro1; }
2248 #define GCPRO2(varname1, varname2) \
2249 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2250 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2251 gcprolist = &gcpro2; }
2253 #define GCPRO3(varname1, varname2, varname3) \
2254 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2255 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2256 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2257 gcprolist = &gcpro3; }
2259 #define GCPRO4(varname1, varname2, varname3, varname4) \
2260 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2261 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2262 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2263 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2264 gcprolist = &gcpro4; }
2266 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2267 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2268 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2269 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2270 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2271 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2272 gcprolist = &gcpro5; }
2274 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2275 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2276 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2277 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2278 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2279 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2280 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2281 gcprolist = &gcpro6; }
2283 #define UNGCPRO (gcprolist = gcpro1.next)
2287 extern int gcpro_level
;
2289 #define GCPRO1(varname) \
2290 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2291 gcpro1.level = gcpro_level++; \
2292 gcprolist = &gcpro1; }
2294 #define GCPRO2(varname1, varname2) \
2295 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2296 gcpro1.level = gcpro_level; \
2297 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2298 gcpro2.level = gcpro_level++; \
2299 gcprolist = &gcpro2; }
2301 #define GCPRO3(varname1, varname2, varname3) \
2302 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2303 gcpro1.level = gcpro_level; \
2304 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2305 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2306 gcpro3.level = gcpro_level++; \
2307 gcprolist = &gcpro3; }
2309 #define GCPRO4(varname1, varname2, varname3, varname4) \
2310 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2311 gcpro1.level = gcpro_level; \
2312 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2313 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2314 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2315 gcpro4.level = gcpro_level++; \
2316 gcprolist = &gcpro4; }
2318 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2319 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2320 gcpro1.level = gcpro_level; \
2321 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2322 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2323 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2324 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2325 gcpro5.level = gcpro_level++; \
2326 gcprolist = &gcpro5; }
2328 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2329 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2330 gcpro1.level = gcpro_level; \
2331 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2332 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2333 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2334 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2335 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2336 gcpro6.level = gcpro_level++; \
2337 gcprolist = &gcpro6; }
2340 ((--gcpro_level != gcpro1.level) \
2341 ? (emacs_abort (), 0) \
2342 : ((gcprolist = gcpro1.next), 0))
2344 #endif /* DEBUG_GCPRO */
2345 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2348 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2349 #define RETURN_UNGCPRO(expr) \
2352 Lisp_Object ret_ungc_val; \
2353 ret_ungc_val = (expr); \
2355 return ret_ungc_val; \
2359 /* Call staticpro (&var) to protect static variable `var'. */
2361 void staticpro (Lisp_Object
*);
2363 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2364 meaning as in the DEFUN macro, and is used to construct a prototype. */
2365 /* We can use the same trick as in the DEFUN macro to generate the
2366 appropriate prototype. */
2367 #define EXFUN(fnname, maxargs) \
2368 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2370 /* Forward declarations for prototypes. */
2374 /* Simple access functions. */
2376 LISP_INLINE Lisp_Object
*
2377 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2379 return & XVECTOR (array
)->contents
[idx
];
2383 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2385 /* Like ASET, but also can be used in the garbage collector:
2386 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2387 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2388 XVECTOR (array
)->contents
[idx
] = val
;
2391 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2394 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2396 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2397 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2400 /* Functions to modify hash tables. */
2403 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2405 h
->key_and_value
= key_and_value
;
2409 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2411 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2415 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2417 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2421 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2427 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2429 gc_aset (h
->next
, idx
, val
);
2433 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2439 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2441 gc_aset (h
->hash
, idx
, val
);
2445 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2451 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2453 gc_aset (h
->index
, idx
, val
);
2456 /* Use these functions to set Lisp_Object
2457 or pointer slots of struct Lisp_Symbol. */
2460 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2462 XSYMBOL (sym
)->name
= name
;
2466 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2468 XSYMBOL (sym
)->function
= function
;
2472 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2474 XSYMBOL (sym
)->plist
= plist
;
2478 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2480 XSYMBOL (sym
)->next
= next
;
2483 /* Buffer-local (also frame-local) variable access functions. */
2486 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2488 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2493 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2495 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2499 LISP_INLINE Lisp_Object
2500 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2502 return XCDR (blv
->valcell
);
2506 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2508 XSETCDR (blv
->valcell
, val
);
2512 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2518 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2524 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2529 /* Set overlay's property list. */
2532 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2534 XOVERLAY (overlay
)->plist
= plist
;
2537 /* Get text properties of S. */
2539 LISP_INLINE INTERVAL
2540 string_intervals (Lisp_Object s
)
2542 return XSTRING (s
)->intervals
;
2545 /* Set text properties of S to I. */
2548 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2550 XSTRING (s
)->intervals
= i
;
2553 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2554 of setting slots directly. */
2557 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2559 XCHAR_TABLE (table
)->ascii
= val
;
2562 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2564 XCHAR_TABLE (table
)->defalt
= val
;
2567 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2569 XCHAR_TABLE (table
)->parent
= val
;
2572 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2574 XCHAR_TABLE (table
)->purpose
= val
;
2577 /* Set different slots in (sub)character tables. */
2580 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2582 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2583 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2587 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2589 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2590 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2594 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2596 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2599 /* Defined in data.c. */
2600 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2601 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2602 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2603 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2604 extern Lisp_Object Qinvalid_read_syntax
;
2605 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2606 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2607 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2608 extern Lisp_Object Qtext_read_only
;
2609 extern Lisp_Object Qinteractive_form
;
2610 extern Lisp_Object Qcircular_list
;
2611 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2612 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2613 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2614 extern Lisp_Object Qbuffer_or_string_p
;
2615 extern Lisp_Object Qfboundp
;
2616 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2618 extern Lisp_Object Qcdr
;
2620 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2622 extern Lisp_Object Qfloatp
;
2623 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2625 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2627 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2629 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2631 /* Defined in data.c. */
2632 extern Lisp_Object
indirect_function (Lisp_Object
);
2633 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2635 /* Convert the integer I to an Emacs representation, either the integer
2636 itself, or a cons of two or three integers, or if all else fails a float.
2637 I should not have side effects. */
2638 #define INTEGER_TO_CONS(i) \
2639 (! FIXNUM_OVERFLOW_P (i) \
2641 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2642 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2643 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2644 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2645 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2646 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2647 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2648 ? Fcons (make_number ((i) >> 16 >> 24), \
2649 Fcons (make_number ((i) >> 16 & 0xffffff), \
2650 make_number ((i) & 0xffff))) \
2653 /* Convert the Emacs representation CONS back to an integer of type
2654 TYPE, storing the result the variable VAR. Signal an error if CONS
2655 is not a valid representation or is out of range for TYPE. */
2656 #define CONS_TO_INTEGER(cons, type, var) \
2657 (TYPE_SIGNED (type) \
2658 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2659 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2660 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2661 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2663 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2664 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2665 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2667 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2668 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2669 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2670 extern void syms_of_data (void);
2671 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2673 /* Defined in cmds.c */
2674 extern void syms_of_cmds (void);
2675 extern void keys_of_cmds (void);
2677 /* Defined in coding.c. */
2678 extern Lisp_Object Qcharset
;
2679 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2680 ptrdiff_t, bool, bool, Lisp_Object
);
2681 extern void init_coding (void);
2682 extern void init_coding_once (void);
2683 extern void syms_of_coding (void);
2685 /* Defined in character.c. */
2686 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2687 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2688 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2689 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2690 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2691 extern void syms_of_character (void);
2693 /* Defined in charset.c. */
2694 extern void init_charset (void);
2695 extern void init_charset_once (void);
2696 extern void syms_of_charset (void);
2697 /* Structure forward declarations. */
2700 /* Defined in composite.c. */
2701 extern void syms_of_composite (void);
2703 /* Defined in syntax.c. */
2704 extern void init_syntax_once (void);
2705 extern void syms_of_syntax (void);
2707 /* Defined in fns.c. */
2708 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2709 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2710 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2711 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2712 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2713 extern void sweep_weak_hash_tables (void);
2714 extern Lisp_Object Qcursor_in_echo_area
;
2715 extern Lisp_Object Qstring_lessp
;
2716 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2717 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2718 EMACS_UINT
sxhash (Lisp_Object
, int);
2719 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2720 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2722 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2723 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2726 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2727 ptrdiff_t, ptrdiff_t);
2728 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2729 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2730 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2731 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2732 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2733 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2734 extern void clear_string_char_byte_cache (void);
2735 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2736 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2737 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2738 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2739 extern void syms_of_fns (void);
2741 /* Defined in floatfns.c. */
2742 extern double extract_float (Lisp_Object
);
2743 extern void syms_of_floatfns (void);
2744 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2746 /* Defined in fringe.c. */
2747 extern void syms_of_fringe (void);
2748 extern void init_fringe (void);
2749 #ifdef HAVE_WINDOW_SYSTEM
2750 extern void mark_fringe_data (void);
2751 extern void init_fringe_once (void);
2752 #endif /* HAVE_WINDOW_SYSTEM */
2754 /* Defined in image.c. */
2755 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2756 extern Lisp_Object QCconversion
;
2757 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2758 extern void reset_image_types (void);
2759 extern void syms_of_image (void);
2761 /* Defined in insdel.c. */
2762 extern Lisp_Object Qinhibit_modification_hooks
;
2763 extern void move_gap (ptrdiff_t);
2764 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2765 extern _Noreturn
void buffer_overflow (void);
2766 extern void make_gap (ptrdiff_t);
2767 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2768 ptrdiff_t, bool, bool);
2769 extern int count_combining_before (const unsigned char *,
2770 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2771 extern int count_combining_after (const unsigned char *,
2772 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2773 extern void insert (const char *, ptrdiff_t);
2774 extern void insert_and_inherit (const char *, ptrdiff_t);
2775 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2776 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2778 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2779 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2780 ptrdiff_t, ptrdiff_t, bool);
2781 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2782 extern void insert_char (int);
2783 extern void insert_string (const char *);
2784 extern void insert_before_markers (const char *, ptrdiff_t);
2785 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2786 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2787 ptrdiff_t, ptrdiff_t,
2789 extern void del_range (ptrdiff_t, ptrdiff_t);
2790 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2791 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2792 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2793 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2794 ptrdiff_t, ptrdiff_t, bool);
2795 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2796 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2797 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2798 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2799 ptrdiff_t, ptrdiff_t);
2800 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2801 ptrdiff_t, ptrdiff_t);
2802 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2803 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2804 const char *, ptrdiff_t, ptrdiff_t, bool);
2805 extern void syms_of_insdel (void);
2807 /* Defined in dispnew.c. */
2808 #if (defined PROFILING \
2809 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2810 _Noreturn
void __executable_start (void);
2812 extern Lisp_Object selected_frame
;
2813 extern Lisp_Object Vwindow_system
;
2814 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2815 extern void init_display (void);
2816 extern void syms_of_display (void);
2818 /* Defined in xdisp.c. */
2819 extern Lisp_Object Qinhibit_point_motion_hooks
;
2820 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2821 extern Lisp_Object Qmenu_bar_update_hook
;
2822 extern Lisp_Object Qwindow_scroll_functions
;
2823 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2824 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2825 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2826 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2827 extern Lisp_Object Qleft_margin
, Qright_margin
;
2828 extern Lisp_Object Qglyphless_char
;
2829 extern Lisp_Object QCdata
, QCfile
;
2830 extern Lisp_Object QCmap
;
2831 extern Lisp_Object Qrisky_local_variable
;
2832 extern struct frame
*last_glyphless_glyph_frame
;
2833 extern int last_glyphless_glyph_face_id
;
2834 extern int last_glyphless_glyph_merged_face_id
;
2835 extern int noninteractive_need_newline
;
2836 extern Lisp_Object echo_area_buffer
[2];
2837 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2838 extern void check_message_stack (void);
2839 extern void setup_echo_area_for_printing (int);
2840 extern bool push_message (void);
2841 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2842 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2843 extern void restore_message (void);
2844 extern Lisp_Object
current_message (void);
2845 extern void clear_message (int, int);
2846 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2847 extern void message1 (const char *);
2848 extern void message1_nolog (const char *);
2849 extern void message2 (const char *, ptrdiff_t, int);
2850 extern void message2_nolog (const char *, ptrdiff_t, int);
2851 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2852 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2853 extern void message_dolog (const char *, ptrdiff_t, int, int);
2854 extern void message_with_string (const char *, Lisp_Object
, int);
2855 extern void message_log_maybe_newline (void);
2856 extern void update_echo_area (void);
2857 extern void truncate_echo_area (ptrdiff_t);
2858 extern void redisplay (void);
2859 extern void redisplay_preserve_echo_area (int);
2860 extern void prepare_menu_bars (void);
2862 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2863 extern void syms_of_xdisp (void);
2864 extern void init_xdisp (void);
2865 extern Lisp_Object
safe_eval (Lisp_Object
);
2866 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2867 int *, int *, int *, int *, int *);
2869 /* Defined in xsettings.c. */
2870 extern void syms_of_xsettings (void);
2872 /* Defined in vm-limit.c. */
2873 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2875 /* Defined in alloc.c. */
2876 extern void check_pure_size (void);
2877 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2878 extern void malloc_warning (const char *);
2879 extern _Noreturn
void memory_full (size_t);
2880 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2881 extern bool survives_gc_p (Lisp_Object
);
2882 extern void mark_object (Lisp_Object
);
2883 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2884 extern void refill_memory_reserve (void);
2886 extern const char *pending_malloc_warning
;
2887 extern Lisp_Object zero_vector
;
2888 extern Lisp_Object
*stack_base
;
2889 extern EMACS_INT consing_since_gc
;
2890 extern EMACS_INT gc_relative_threshold
;
2891 extern EMACS_INT memory_full_cons_threshold
;
2892 extern Lisp_Object
list1 (Lisp_Object
);
2893 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2894 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2895 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2896 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2898 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2899 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2900 extern _Noreturn
void string_overflow (void);
2901 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2902 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2903 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2904 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2906 /* Make unibyte string from C string when the length isn't known. */
2908 LISP_INLINE Lisp_Object
2909 build_unibyte_string (const char *str
)
2911 return make_unibyte_string (str
, strlen (str
));
2914 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2915 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2916 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2917 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2918 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2919 extern Lisp_Object
make_specified_string (const char *,
2920 ptrdiff_t, ptrdiff_t, bool);
2921 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2922 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2924 /* Make a string allocated in pure space, use STR as string data. */
2926 LISP_INLINE Lisp_Object
2927 build_pure_c_string (const char *str
)
2929 return make_pure_c_string (str
, strlen (str
));
2932 /* Make a string from the data at STR, treating it as multibyte if the
2935 LISP_INLINE Lisp_Object
2936 build_string (const char *str
)
2938 return make_string (str
, strlen (str
));
2941 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2942 extern void make_byte_code (struct Lisp_Vector
*);
2943 extern Lisp_Object Qautomatic_gc
;
2944 extern Lisp_Object Qchar_table_extra_slots
;
2945 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2946 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2947 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2949 allocate_pseudovector \
2950 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2951 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2952 extern struct window
*allocate_window (void);
2953 extern struct frame
*allocate_frame (void);
2954 extern struct Lisp_Process
*allocate_process (void);
2955 extern struct terminal
*allocate_terminal (void);
2956 extern bool gc_in_progress
;
2957 extern bool abort_on_gc
;
2958 extern Lisp_Object
make_float (double);
2959 extern void display_malloc_warning (void);
2960 extern ptrdiff_t inhibit_garbage_collection (void);
2961 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2962 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2963 extern void free_marker (Lisp_Object
);
2964 extern void free_cons (struct Lisp_Cons
*);
2965 extern void init_alloc_once (void);
2966 extern void init_alloc (void);
2967 extern void syms_of_alloc (void);
2968 extern struct buffer
* allocate_buffer (void);
2969 extern int valid_lisp_object_p (Lisp_Object
);
2970 #ifdef GC_CHECK_CONS_LIST
2971 extern void check_cons_list (void);
2973 #define check_cons_list() ((void) 0)
2977 /* Defined in ralloc.c. */
2978 extern void *r_alloc (void **, size_t);
2979 extern void r_alloc_free (void **);
2980 extern void *r_re_alloc (void **, size_t);
2981 extern void r_alloc_reset_variable (void **, void **);
2982 extern void r_alloc_inhibit_buffer_relocation (int);
2985 /* Defined in chartab.c. */
2986 extern Lisp_Object
copy_char_table (Lisp_Object
);
2987 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2988 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2990 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
2991 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
2992 extern int char_table_translate (Lisp_Object
, int);
2993 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2995 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2996 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2997 Lisp_Object
, Lisp_Object
,
2998 Lisp_Object
, struct charset
*,
2999 unsigned, unsigned);
3000 extern Lisp_Object
uniprop_table (Lisp_Object
);
3001 extern void syms_of_chartab (void);
3003 /* Defined in print.c. */
3004 extern Lisp_Object Vprin1_to_string_buffer
;
3005 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3006 extern Lisp_Object Qstandard_output
;
3007 extern Lisp_Object Qexternal_debugging_output
;
3008 extern void temp_output_buffer_setup (const char *);
3009 extern int print_level
;
3010 extern Lisp_Object Qprint_escape_newlines
;
3011 extern void write_string (const char *, int);
3012 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3014 extern Lisp_Object internal_with_output_to_temp_buffer
3015 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3016 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3017 extern int float_to_string (char *, double);
3018 extern void syms_of_print (void);
3020 /* Defined in doprnt.c. */
3021 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3023 extern ptrdiff_t esprintf (char *, char const *, ...)
3024 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3025 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3027 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3028 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3029 char const *, va_list)
3030 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3032 /* Defined in lread.c. */
3033 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3034 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3035 extern Lisp_Object Qlexical_binding
;
3036 extern Lisp_Object
check_obarray (Lisp_Object
);
3037 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3038 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3039 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3040 #define LOADHIST_ATTACH(x) \
3042 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3044 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3045 Lisp_Object
*, Lisp_Object
);
3046 extern Lisp_Object
string_to_number (char const *, int, bool);
3047 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3049 extern void dir_warning (const char *, Lisp_Object
);
3050 extern void close_load_descs (void);
3051 extern void init_obarray (void);
3052 extern void init_lread (void);
3053 extern void syms_of_lread (void);
3055 LISP_INLINE Lisp_Object
3056 intern (const char *str
)
3058 return intern_1 (str
, strlen (str
));
3061 LISP_INLINE Lisp_Object
3062 intern_c_string (const char *str
)
3064 return intern_c_string_1 (str
, strlen (str
));
3067 /* Defined in eval.c. */
3068 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3069 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3070 extern Lisp_Object Qand_rest
;
3071 extern Lisp_Object Vautoload_queue
;
3072 extern Lisp_Object Vsignaling_function
;
3073 extern Lisp_Object inhibit_lisp_code
;
3075 extern struct catchtag
*catchlist
;
3076 extern struct handler
*handlerlist
;
3078 /* To run a normal hook, use the appropriate function from the list below.
3079 The calling convention:
3081 if (!NILP (Vrun_hooks))
3082 call1 (Vrun_hooks, Qmy_funny_hook);
3084 should no longer be used. */
3085 extern Lisp_Object Vrun_hooks
;
3086 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3087 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3088 Lisp_Object (*funcall
)
3089 (ptrdiff_t nargs
, Lisp_Object
*args
));
3090 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3091 extern _Noreturn
void xsignal0 (Lisp_Object
);
3092 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3093 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3094 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3096 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3097 extern Lisp_Object
eval_sub (Lisp_Object form
);
3098 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3099 extern Lisp_Object
call0 (Lisp_Object
);
3100 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3101 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3102 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3103 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3104 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3105 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3106 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3107 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3108 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3109 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3110 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3111 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3112 extern Lisp_Object internal_condition_case_n
3113 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3114 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3115 extern void specbind (Lisp_Object
, Lisp_Object
);
3116 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3117 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3118 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3119 extern _Noreturn
void verror (const char *, va_list)
3120 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3121 extern Lisp_Object
un_autoload (Lisp_Object
);
3122 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3123 extern void init_eval_once (void);
3124 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3125 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3126 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3127 extern void init_eval (void);
3129 extern void mark_backtrace (void);
3131 extern void syms_of_eval (void);
3133 /* Defined in editfns.c. */
3134 extern Lisp_Object Qfield
;
3135 extern void insert1 (Lisp_Object
);
3136 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3137 extern Lisp_Object
save_excursion_save (void);
3138 extern Lisp_Object
save_restriction_save (void);
3139 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3140 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3141 extern _Noreturn
void time_overflow (void);
3142 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3143 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3145 extern void init_editfns (void);
3146 extern void syms_of_editfns (void);
3147 extern void set_time_zone_rule (const char *);
3149 /* Defined in buffer.c. */
3150 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3151 extern _Noreturn
void nsberror (Lisp_Object
);
3152 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3153 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3154 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3155 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3156 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3157 extern bool overlay_touches_p (ptrdiff_t);
3158 extern Lisp_Object Vbuffer_alist
;
3159 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3160 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3161 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3162 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3163 extern void init_buffer_once (void);
3164 extern void init_buffer (void);
3165 extern void syms_of_buffer (void);
3166 extern void keys_of_buffer (void);
3168 /* Defined in marker.c. */
3170 extern ptrdiff_t marker_position (Lisp_Object
);
3171 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3172 extern void clear_charpos_cache (struct buffer
*);
3173 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3174 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3175 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3176 extern void unchain_marker (struct Lisp_Marker
*marker
);
3177 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3178 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3179 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3180 ptrdiff_t, ptrdiff_t);
3181 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3182 extern void syms_of_marker (void);
3184 /* Defined in fileio.c. */
3186 extern Lisp_Object Qfile_error
;
3187 extern Lisp_Object Qfile_exists_p
;
3188 extern Lisp_Object Qfile_directory_p
;
3189 extern Lisp_Object Qinsert_file_contents
;
3190 extern Lisp_Object Qfile_name_history
;
3191 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3192 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3193 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3194 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3195 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3196 extern void internal_delete_file (Lisp_Object
);
3197 extern void syms_of_fileio (void);
3198 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3199 extern Lisp_Object Qdelete_file
;
3200 extern bool check_existing (const char *);
3202 /* Defined in search.c. */
3203 extern void shrink_regexp_cache (void);
3204 extern void restore_search_regs (void);
3205 extern void record_unwind_save_match_data (void);
3206 struct re_registers
;
3207 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3208 struct re_registers
*,
3209 Lisp_Object
, int, int);
3210 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3211 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3213 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3214 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3215 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3216 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3218 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3220 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3221 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3222 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3223 extern void syms_of_search (void);
3224 extern void clear_regexp_cache (void);
3226 /* Defined in minibuf.c. */
3228 extern Lisp_Object Qcompletion_ignore_case
;
3229 extern Lisp_Object Vminibuffer_list
;
3230 extern Lisp_Object last_minibuf_string
;
3231 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3232 extern void init_minibuf_once (void);
3233 extern void syms_of_minibuf (void);
3235 /* Defined in callint.c. */
3237 extern Lisp_Object Qminus
, Qplus
;
3238 extern Lisp_Object Qwhen
;
3239 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3240 extern void syms_of_callint (void);
3242 /* Defined in casefiddle.c. */
3244 extern Lisp_Object Qidentity
;
3245 extern void syms_of_casefiddle (void);
3246 extern void keys_of_casefiddle (void);
3248 /* Defined in casetab.c. */
3250 extern void init_casetab_once (void);
3251 extern void syms_of_casetab (void);
3253 /* Defined in keyboard.c. */
3255 extern Lisp_Object echo_message_buffer
;
3256 extern struct kboard
*echo_kboard
;
3257 extern void cancel_echoing (void);
3258 extern Lisp_Object Qdisabled
, QCfilter
;
3259 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3260 extern Lisp_Object Qtop
;
3261 extern Lisp_Object last_undo_boundary
;
3262 extern bool input_pending
;
3263 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3264 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3265 extern void discard_mouse_events (void);
3267 void handle_input_available_signal (int);
3269 extern Lisp_Object pending_funcalls
;
3270 extern bool detect_input_pending (void);
3271 extern bool detect_input_pending_ignore_squeezables (void);
3272 extern bool detect_input_pending_run_timers (bool);
3273 extern void safe_run_hooks (Lisp_Object
);
3274 extern void cmd_error_internal (Lisp_Object
, const char *);
3275 extern Lisp_Object
command_loop_1 (void);
3276 extern Lisp_Object
recursive_edit_1 (void);
3277 extern void record_auto_save (void);
3278 extern void force_auto_save_soon (void);
3279 extern void init_keyboard (void);
3280 extern void syms_of_keyboard (void);
3281 extern void keys_of_keyboard (void);
3283 /* Defined in indent.c. */
3284 extern ptrdiff_t current_column (void);
3285 extern void invalidate_current_column (void);
3286 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3287 extern void syms_of_indent (void);
3289 /* Defined in frame.c. */
3290 extern Lisp_Object Qonly
, Qnone
;
3291 extern Lisp_Object Qvisible
;
3292 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3293 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3294 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3296 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3298 extern void frames_discard_buffer (Lisp_Object
);
3299 extern void syms_of_frame (void);
3301 /* Defined in emacs.c. */
3302 extern char **initial_argv
;
3303 extern int initial_argc
;
3304 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3305 extern bool display_arg
;
3307 extern Lisp_Object
decode_env_path (const char *, const char *);
3308 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3309 extern Lisp_Object Qfile_name_handler_alist
;
3310 extern _Noreturn
void terminate_due_to_signal (int, int);
3311 extern Lisp_Object Qkill_emacs
;
3313 extern Lisp_Object Vlibrary_cache
;
3316 void fixup_locale (void);
3317 void synchronize_system_messages_locale (void);
3318 void synchronize_system_time_locale (void);
3320 #define setlocale(category, locale)
3321 #define fixup_locale()
3322 #define synchronize_system_messages_locale()
3323 #define synchronize_system_time_locale()
3325 extern void shut_down_emacs (int, Lisp_Object
);
3327 /* True means don't do interactive redisplay and don't change tty modes. */
3328 extern bool noninteractive
;
3330 /* True means remove site-lisp directories from load-path. */
3331 extern bool no_site_lisp
;
3333 /* Pipe used to send exit notification to the daemon parent at
3335 extern int daemon_pipe
[2];
3336 #define IS_DAEMON (daemon_pipe[1] != 0)
3338 /* True if handling a fatal error already. */
3339 extern bool fatal_error_in_progress
;
3341 /* True means don't do use window-system-specific display code. */
3342 extern bool inhibit_window_system
;
3343 /* True means that a filter or a sentinel is running. */
3344 extern bool running_asynch_code
;
3346 /* Defined in process.c. */
3347 extern Lisp_Object QCtype
, Qlocal
;
3348 extern Lisp_Object Qprocessp
;
3349 extern void kill_buffer_processes (Lisp_Object
);
3350 extern int wait_reading_process_output (intmax_t, int, int, bool,
3352 struct Lisp_Process
*,
3354 /* Max value for the first argument of wait_reading_process_output. */
3355 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3356 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3357 The bug merely causes a bogus warning, but the warning is annoying. */
3358 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3360 # define WAIT_READING_MAX INTMAX_MAX
3362 extern void add_keyboard_wait_descriptor (int);
3363 extern void delete_keyboard_wait_descriptor (int);
3365 extern void add_gpm_wait_descriptor (int);
3366 extern void delete_gpm_wait_descriptor (int);
3368 extern void close_process_descs (void);
3369 extern void init_process_emacs (void);
3370 extern void syms_of_process (void);
3371 extern void setup_process_coding_systems (Lisp_Object
);
3376 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3377 extern void init_callproc_1 (void);
3378 extern void init_callproc (void);
3379 extern void set_initial_environment (void);
3380 extern void syms_of_callproc (void);
3382 /* Defined in doc.c. */
3383 extern Lisp_Object Qfunction_documentation
;
3384 extern Lisp_Object
read_doc_string (Lisp_Object
);
3385 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3386 extern void syms_of_doc (void);
3387 extern int read_bytecode_char (bool);
3389 /* Defined in bytecode.c. */
3390 extern Lisp_Object Qbytecode
;
3391 extern void syms_of_bytecode (void);
3392 extern struct byte_stack
*byte_stack_list
;
3394 extern void mark_byte_stack (void);
3396 extern void unmark_byte_stack (void);
3397 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3398 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3400 /* Defined in macros.c. */
3401 extern Lisp_Object Qexecute_kbd_macro
;
3402 extern void init_macros (void);
3403 extern void syms_of_macros (void);
3405 /* Defined in undo.c. */
3406 extern Lisp_Object Qapply
;
3407 extern Lisp_Object Qinhibit_read_only
;
3408 extern void truncate_undo_list (struct buffer
*);
3409 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3410 extern void record_insert (ptrdiff_t, ptrdiff_t);
3411 extern void record_delete (ptrdiff_t, Lisp_Object
);
3412 extern void record_first_change (void);
3413 extern void record_change (ptrdiff_t, ptrdiff_t);
3414 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3415 Lisp_Object
, Lisp_Object
,
3417 extern void syms_of_undo (void);
3418 /* Defined in textprop.c. */
3419 extern Lisp_Object Qfont
, Qmouse_face
;
3420 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3421 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3422 extern Lisp_Object Qminibuffer_prompt
;
3424 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3426 /* Defined in menu.c. */
3427 extern void syms_of_menu (void);
3429 /* Defined in xmenu.c. */
3430 extern void syms_of_xmenu (void);
3432 /* Defined in termchar.h. */
3433 struct tty_display_info
;
3435 /* Defined in termhooks.h. */
3438 /* Defined in sysdep.c. */
3439 #ifndef HAVE_GET_CURRENT_DIR_NAME
3440 extern char *get_current_dir_name (void);
3442 extern void stuff_char (char c
);
3443 extern void init_foreground_group (void);
3444 extern void init_sigio (int);
3445 extern void sys_subshell (void);
3446 extern void sys_suspend (void);
3447 extern void discard_tty_input (void);
3448 extern void init_sys_modes (struct tty_display_info
*);
3449 extern void reset_sys_modes (struct tty_display_info
*);
3450 extern void init_all_sys_modes (void);
3451 extern void reset_all_sys_modes (void);
3452 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3453 extern void child_setup_tty (int);
3454 extern void setup_pty (int);
3455 extern int set_window_size (int, int, int);
3456 extern EMACS_INT
get_random (void);
3457 extern void seed_random (void *, ptrdiff_t);
3458 extern void init_random (void);
3459 extern void emacs_backtrace (int);
3460 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3461 extern int emacs_open (const char *, int, int);
3462 extern int emacs_close (int);
3463 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3464 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3465 enum { READLINK_BUFSIZE
= 1024 };
3466 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3468 extern void unlock_all_files (void);
3469 extern void lock_file (Lisp_Object
);
3470 extern void unlock_file (Lisp_Object
);
3471 extern void unlock_buffer (struct buffer
*);
3472 extern void syms_of_filelock (void);
3474 /* Defined in sound.c. */
3475 extern void syms_of_sound (void);
3477 /* Defined in category.c. */
3478 extern void init_category_once (void);
3479 extern Lisp_Object
char_category_set (int);
3480 extern void syms_of_category (void);
3482 /* Defined in ccl.c. */
3483 extern void syms_of_ccl (void);
3485 /* Defined in dired.c. */
3486 extern void syms_of_dired (void);
3487 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3488 Lisp_Object
, Lisp_Object
,
3491 /* Defined in term.c. */
3492 extern int *char_ins_del_vector
;
3493 extern void syms_of_term (void);
3494 extern _Noreturn
void fatal (const char *msgid
, ...)
3495 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3497 /* Defined in terminal.c. */
3498 extern void syms_of_terminal (void);
3500 /* Defined in font.c. */
3501 extern void syms_of_font (void);
3502 extern void init_font (void);
3504 #ifdef HAVE_WINDOW_SYSTEM
3505 /* Defined in fontset.c. */
3506 extern void syms_of_fontset (void);
3508 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3509 extern Lisp_Object Qfont_param
;
3512 /* Defined in xfaces.c. */
3513 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3514 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3515 extern Lisp_Object Qmode_line_inactive
;
3516 extern Lisp_Object Qface
;
3517 extern Lisp_Object Qnormal
;
3518 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3519 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3520 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3521 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3522 extern Lisp_Object Qoblique
, Qitalic
;
3523 extern Lisp_Object Vface_alternative_font_family_alist
;
3524 extern Lisp_Object Vface_alternative_font_registry_alist
;
3525 extern void syms_of_xfaces (void);
3527 #ifdef HAVE_X_WINDOWS
3528 /* Defined in xfns.c. */
3529 extern void syms_of_xfns (void);
3531 /* Defined in xsmfns.c. */
3532 extern void syms_of_xsmfns (void);
3534 /* Defined in xselect.c. */
3535 extern void syms_of_xselect (void);
3537 /* Defined in xterm.c. */
3538 extern void syms_of_xterm (void);
3539 #endif /* HAVE_X_WINDOWS */
3541 #ifdef HAVE_WINDOW_SYSTEM
3542 /* Defined in xterm.c, nsterm.m, w32term.c. */
3543 extern char *x_get_keysym_name (int);
3544 #endif /* HAVE_WINDOW_SYSTEM */
3547 /* Defined in xml.c. */
3548 extern void syms_of_xml (void);
3549 extern void xml_cleanup_parser (void);
3553 /* Defined in (x|w32)fns.c, nsfns.m... */
3554 extern int have_menus_p (void);
3558 /* Defined in dbusbind.c. */
3559 void syms_of_dbusbind (void);
3563 /* Defined in profiler.c. */
3564 extern bool profiler_memory_running
;
3565 extern void malloc_probe (size_t);
3566 extern void syms_of_profiler (void);
3570 /* Defined in msdos.c, w32.c. */
3571 extern char *emacs_root_dir (void);
3574 /* True means Emacs has already been initialized.
3575 Used during startup to detect startup of dumped Emacs. */
3576 extern bool initialized
;
3578 /* True means ^G can quit instantly. */
3579 extern bool immediate_quit
;
3581 extern void *xmalloc (size_t);
3582 extern void *xzalloc (size_t);
3583 extern void *xrealloc (void *, size_t);
3584 extern void xfree (void *);
3585 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3586 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3587 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3589 extern char *xstrdup (const char *);
3591 extern char *egetenv (const char *);
3593 /* Set up the name of the machine we're running on. */
3594 extern void init_system_name (void);
3596 /* We used to use `abs', but that clashes with system headers on some
3597 platforms, and using a name reserved by Standard C is a bad idea
3600 #define eabs(x) ((x) < 0 ? -(x) : (x))
3603 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3606 #define make_fixnum_or_float(val) \
3607 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3609 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3610 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3612 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3614 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3615 extern void *record_xmalloc (size_t);
3617 #define USE_SAFE_ALLOCA \
3618 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3620 /* SAFE_ALLOCA allocates a simple buffer. */
3622 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3624 : (sa_must_free = 1, record_xmalloc (size)))
3626 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3627 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3628 positive. The code is tuned for MULTIPLIER being a constant. */
3630 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3632 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3633 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3636 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3638 record_unwind_protect (safe_alloca_unwind, \
3639 make_save_value (buf, 0)); \
3643 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3645 #define SAFE_FREE() \
3647 if (sa_must_free) { \
3649 unbind_to (sa_count, Qnil); \
3654 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3656 #define SAFE_ALLOCA_LISP(buf, nelt) \
3658 if ((nelt) < MAX_ALLOCA / word_size) \
3659 buf = alloca ((nelt) * word_size); \
3660 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3663 buf = xmalloc ((nelt) * word_size); \
3664 arg_ = make_save_value (buf, nelt); \
3665 XSAVE_VALUE (arg_)->dogc = 1; \
3667 record_unwind_protect (safe_alloca_unwind, arg_); \
3670 memory_full (SIZE_MAX); \
3674 #include "globals.h"
3676 /* Check whether it's time for GC, and run it if so. */
3681 if ((consing_since_gc
> gc_cons_threshold
3682 && consing_since_gc
> gc_relative_threshold
)
3683 || (!NILP (Vmemory_full
)
3684 && consing_since_gc
> memory_full_cons_threshold
))
3685 Fgarbage_collect ();
3689 functionp (Lisp_Object object
)
3691 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3693 object
= Findirect_function (object
, Qt
);
3695 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3697 /* Autoloaded symbols are functions, except if they load
3698 macros or keymaps. */
3700 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3701 object
= XCDR (object
);
3703 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3708 return XSUBR (object
)->max_args
!= UNEVALLED
;
3709 else if (COMPILEDP (object
))
3711 else if (CONSP (object
))
3713 Lisp_Object car
= XCAR (object
);
3714 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3722 #endif /* EMACS_LISP_H */