1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
36 # define LISP_INLINE INLINE
39 /* The ubiquitous max and min macros. */
42 #define max(a, b) ((a) > (b) ? (a) : (b))
43 #define min(a, b) ((a) < (b) ? (a) : (b))
45 /* EMACS_INT - signed integer wide enough to hold an Emacs value
46 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
47 pI - printf length modifier for EMACS_INT
48 EMACS_UINT - unsigned variant of EMACS_INT */
50 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
51 typedef long long int EMACS_INT
;
52 typedef unsigned long long int EMACS_UINT
;
53 # define EMACS_INT_MAX LLONG_MAX
55 # elif INT_MAX < LONG_MAX
56 typedef long int EMACS_INT
;
57 typedef unsigned long int EMACS_UINT
;
58 # define EMACS_INT_MAX LONG_MAX
61 typedef int EMACS_INT
;
62 typedef unsigned int EMACS_UINT
;
63 # define EMACS_INT_MAX INT_MAX
68 /* Number of bits in some machine integer types. */
71 BITS_PER_CHAR
= CHAR_BIT
,
72 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
73 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
74 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
75 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
78 /* printmax_t and uprintmax_t are types for printing large integers.
79 These are the widest integers that are supported for printing.
80 pMd etc. are conversions for printing them.
81 On C99 hosts, there's no problem, as even the widest integers work.
82 Fall back on EMACS_INT on pre-C99 hosts. */
84 typedef intmax_t printmax_t
;
85 typedef uintmax_t uprintmax_t
;
89 typedef EMACS_INT printmax_t
;
90 typedef EMACS_UINT uprintmax_t
;
95 /* Use pD to format ptrdiff_t values, which suffice for indexes into
96 buffers and strings. Emacs never allocates objects larger than
97 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
98 In C99, pD can always be "t"; configure it here for the sake of
99 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
100 #if PTRDIFF_MAX == INT_MAX
102 #elif PTRDIFF_MAX == LONG_MAX
104 #elif PTRDIFF_MAX == LLONG_MAX
110 /* Extra internal type checking? */
112 /* Define an Emacs version of 'assert (COND)', since some
113 system-defined 'assert's are flaky. COND should be free of side
114 effects; it may or may not be evaluated. */
115 #ifndef ENABLE_CHECKING
116 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
117 #else /* ENABLE_CHECKING */
119 extern _Noreturn
void die (const char *, const char *, int);
121 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
122 it to 1 using a debugger to temporarily disable aborting on
123 detected internal inconsistencies or error conditions.
125 In some cases, a good compiler may be able to optimize away the
126 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
127 STRINGP (x), but a particular use of XSTRING is invoked only after
128 testing that STRINGP (x) is true, making the test redundant. */
129 extern bool suppress_checking EXTERNALLY_VISIBLE
;
131 # define eassert(cond) \
132 ((cond) || suppress_checking \
134 : die ("assertion failed: " # cond, __FILE__, __LINE__))
135 #endif /* ENABLE_CHECKING */
137 /* Use the configure flag --enable-check-lisp-object-type to make
138 Lisp_Object use a struct type instead of the default int. The flag
139 causes CHECK_LISP_OBJECT_TYPE to be defined. */
141 /***** Select the tagging scheme. *****/
142 /* The following option controls the tagging scheme:
143 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
144 always 0, and we can thus use them to hold tag bits, without
145 restricting our addressing space.
147 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
148 restricting our possible address range.
150 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
151 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
152 on the few static Lisp_Objects used: all the defsubr as well
153 as the two special buffers buffer_defaults and buffer_local_symbols. */
157 /* Number of bits in a Lisp_Object tag. This can be used in #if,
158 and for GDB's sake also as a regular symbol. */
163 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
164 integer constant, for MSVC. */
165 #define GCALIGNMENT 8
167 /* Number of bits in a Lisp_Object value, not counting the tag. */
168 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
170 /* Number of bits in a Lisp fixnum tag. */
171 INTTYPEBITS
= GCTYPEBITS
- 1,
173 /* Number of bits in a Lisp fixnum value, not counting the tag. */
174 FIXNUM_BITS
= VALBITS
+ 1
177 #if GCALIGNMENT != 1 << GCTYPEBITS
178 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
181 /* The maximum value that can be stored in a EMACS_INT, assuming all
182 bits other than the type bits contribute to a nonnegative signed value.
183 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
184 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
186 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
188 /* 1. We know malloc returns a multiple of 8. */
189 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
190 || defined DARWIN_OS || defined __sun)
191 /* 2. We can specify multiple-of-8 alignment on static variables. */
193 /* 3. Pointers-as-ints exceed VAL_MAX.
194 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
195 a. unnecessary, because the top bits of an EMACS_INT are unused, and
196 b. slower, because it typically requires extra masking.
197 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
198 # if VAL_MAX < UINTPTR_MAX
199 # define USE_LSB_TAG 1
206 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
207 # define USE_LSB_TAG 1
209 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
210 # define USE_LSB_TAG 0
214 # define alignas(alignment) /* empty */
216 # error "USE_LSB_TAG requires alignas"
221 /* Define the fundamental Lisp data structures. */
223 /* This is the set of Lisp data types. If you want to define a new
224 data type, read the comments after Lisp_Fwd_Type definition
227 /* Lisp integers use 2 tags, to give them one extra bit, thus
228 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
229 static EMACS_INT
const INTMASK
= EMACS_INT_MAX
>> (INTTYPEBITS
- 1);
230 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
231 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
233 /* Stolen from GDB. The only known compiler that doesn't support
234 enums in bitfields is MSVC. */
236 #define ENUM_BF(TYPE) unsigned int
238 #define ENUM_BF(TYPE) enum TYPE
244 /* Integer. XINT (obj) is the integer value. */
246 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
248 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
251 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
252 whose first member indicates the subtype. */
255 /* String. XSTRING (object) points to a struct Lisp_String.
256 The length of the string, and its contents, are stored therein. */
257 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
259 /* Vector of Lisp objects, or something resembling it.
260 XVECTOR (object) points to a struct Lisp_Vector, which contains
261 the size and contents. The size field also contains the type
262 information, if it's not a real vector object. */
265 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
271 /* This is the set of data types that share a common structure.
272 The first member of the structure is a type code from this set.
273 The enum values are arbitrary, but we'll use large numbers to make it
274 more likely that we'll spot the error if a random word in memory is
275 mistakenly interpreted as a Lisp_Misc. */
278 Lisp_Misc_Free
= 0x5eab,
281 Lisp_Misc_Save_Value
,
282 /* Currently floats are not a misc type,
283 but let's define this in case we want to change that. */
285 /* This is not a type code. It is for range checking. */
289 /* These are the types of forwarding objects used in the value slot
290 of symbols for special built-in variables whose value is stored in
294 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
295 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
296 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
297 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
298 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
301 /* If you want to define a new Lisp data type, here are some
302 instructions. See the thread at
303 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
306 First, there are already a couple of Lisp types that can be used if
307 your new type does not need to be exposed to Lisp programs nor
308 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
309 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
310 is suitable for temporarily stashing away pointers and integers in
311 a Lisp object (see the existing uses of make_save_value and
312 XSAVE_VALUE). The latter is useful for vector-like Lisp objects
313 that need to be used as part of other objects, but which are never
314 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
317 These two types don't look pretty when printed, so they are
318 unsuitable for Lisp objects that can be exposed to users.
320 To define a new data type, add one more Lisp_Misc subtype or one
321 more pseudovector subtype. Pseudovectors are more suitable for
322 objects with several slots that need to support fast random access,
323 while Lisp_Misc types are for everything else. A pseudovector object
324 provides one or more slots for Lisp objects, followed by struct
325 members that are accessible only from C. A Lisp_Misc object is a
326 wrapper for a C struct that can contain anything you like.
328 To add a new pseudovector type, extend the pvec_type enumeration;
329 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
331 For a Lisp_Misc, you will also need to add your entry to union
332 Lisp_Misc (but make sure the first word has the same structure as
333 the others, starting with a 16-bit member of the Lisp_Misc_Type
334 enumeration and a 1-bit GC markbit) and make sure the overall size
335 of the union is not increased by your addition.
337 Then you will need to add switch branches in print.c (in
338 print_object, to print your object, and possibly also in
339 print_preprocess) and to alloc.c, to mark your object (in
340 mark_object) and to free it (in gc_sweep). The latter is also the
341 right place to call any code specific to your data type that needs
342 to run when the object is recycled -- e.g., free any additional
343 resources allocated for it that are not Lisp objects. You can even
344 make a pointer to the function that frees the resources a slot in
345 your object -- this way, the same object could be used to represent
346 several disparate C structures. */
348 #ifdef CHECK_LISP_OBJECT_TYPE
350 typedef struct { EMACS_INT i
; } Lisp_Object
;
353 LISP_INLINE Lisp_Object
356 Lisp_Object o
= { i
};
360 LISP_INLINE Lisp_Object
361 LISP_MAKE_RVALUE (Lisp_Object o
)
366 #define LISP_INITIALLY_ZERO {0}
368 #undef CHECK_LISP_OBJECT_TYPE
369 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
370 #else /* CHECK_LISP_OBJECT_TYPE */
372 /* If a struct type is not wanted, define Lisp_Object as just a number. */
374 typedef EMACS_INT Lisp_Object
;
377 #define LISP_MAKE_RVALUE(o) (0 + (o))
378 #define LISP_INITIALLY_ZERO 0
379 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
380 #endif /* CHECK_LISP_OBJECT_TYPE */
382 /* In the size word of a vector, this bit means the vector has been marked. */
384 static ptrdiff_t const ARRAY_MARK_FLAG
385 #define ARRAY_MARK_FLAG PTRDIFF_MIN
388 /* In the size word of a struct Lisp_Vector, this bit means it's really
389 some other vector-like object. */
390 static ptrdiff_t const PSEUDOVECTOR_FLAG
391 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
394 /* In a pseudovector, the size field actually contains a word with one
395 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
396 with PVEC_TYPE_MASK to indicate the actual type. */
408 PVEC_WINDOW_CONFIGURATION
,
411 /* These should be last, check internal_equal to see why. */
415 PVEC_FONT
/* Should be last because it's used for range checking. */
418 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
419 which were stored in a Lisp_Object. */
420 #ifndef DATA_SEG_BITS
421 # define DATA_SEG_BITS 0
423 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
428 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
430 /* For convenience, we also store the number of elements in these bits.
431 Note that this size is not necessarily the memory-footprint size, but
432 only the number of Lisp_Object fields (that need to be traced by GC).
433 The distinction is used, e.g., by Lisp_Process, which places extra
434 non-Lisp_Object fields at the end of the structure. */
435 PSEUDOVECTOR_SIZE_BITS
= 12,
436 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
438 /* To calculate the memory footprint of the pseudovector, it's useful
439 to store the size of non-Lisp area in word_size units here. */
440 PSEUDOVECTOR_REST_BITS
= 12,
441 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
442 << PSEUDOVECTOR_SIZE_BITS
),
444 /* Used to extract pseudovector subtype information. */
445 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
446 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
,
448 /* Number of bits to put in each character in the internal representation
449 of bool vectors. This should not vary across implementations. */
450 BOOL_VECTOR_BITS_PER_CHAR
= 8
453 /* These macros extract various sorts of values from a Lisp_Object.
454 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
455 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
457 /* Return a perfect hash of the Lisp_Object representation. */
458 #define XHASH(a) XLI (a)
464 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
467 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
468 #define XINT(a) (XLI (a) >> INTTYPEBITS)
469 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
470 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
471 #define make_lisp_ptr(ptr, type) \
472 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
473 XIL ((type) | (intptr_t) (ptr)))
475 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
476 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
478 #else /* not USE_LSB_TAG */
480 static EMACS_INT
const VALMASK
481 #define VALMASK VAL_MAX
484 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
486 /* For integers known to be positive, XFASTINT provides fast retrieval
487 and XSETFASTINT provides fast storage. This takes advantage of the
488 fact that Lisp integers have zero-bits in their tags. */
489 #define XFASTINT(a) (XLI (a) + 0)
490 #define XSETFASTINT(a, b) ((a) = XIL (b))
492 /* Extract the value of a Lisp_Object as a (un)signed integer. */
494 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
495 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
496 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
498 #define make_lisp_ptr(ptr, type) \
499 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
500 + ((intptr_t) (ptr) & VALMASK)))
503 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
504 which were stored in a Lisp_Object. */
505 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
507 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
510 #endif /* not USE_LSB_TAG */
512 /* For integers known to be positive, XFASTINT sometimes provides
513 faster retrieval and XSETFASTINT provides faster storage.
514 If not, fallback on the non-accelerated path. */
516 # define XFASTINT(a) (XINT (a))
517 # define XSETFASTINT(a, b) (XSETINT (a, b))
520 /* Extract the pointer value of the Lisp object A, under the
521 assumption that A's type is TYPE. This is a fallback
522 implementation if nothing faster is available. */
524 # define XUNTAG(a, type) XPNTR (a)
527 #define EQ(x, y) (XHASH (x) == XHASH (y))
529 /* Largest and smallest representable fixnum values. These are the C
530 values. They are macros for use in static initializers. */
531 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
532 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
534 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
535 written this way so that it also works if I is of unsigned
536 type or if I is a NaN. */
538 #define FIXNUM_OVERFLOW_P(i) \
539 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
541 LISP_INLINE
ptrdiff_t
542 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
544 return num
< lower
? lower
: num
<= upper
? num
: upper
;
547 /* Extract a value or address from a Lisp_Object. */
549 #define XCONS(a) (eassert (CONSP (a)), \
550 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
551 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
552 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
553 #define XSTRING(a) (eassert (STRINGP (a)), \
554 (struct Lisp_String *) XUNTAG (a, Lisp_String))
555 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
556 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
557 #define XFLOAT(a) (eassert (FLOATP (a)), \
558 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
562 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
563 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
564 #define XMISCTYPE(a) (XMISCANY (a)->type)
565 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
566 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
567 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
569 /* Forwarding object types. */
571 #define XFWDTYPE(a) (a->u_intfwd.type)
572 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
573 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
574 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
575 #define XBUFFER_OBJFWD(a) \
576 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
577 #define XKBOARD_OBJFWD(a) \
578 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
580 /* Pseudovector types. */
582 #define XPROCESS(a) (eassert (PROCESSP (a)), \
583 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
584 #define XWINDOW(a) (eassert (WINDOWP (a)), \
585 (struct window *) XUNTAG (a, Lisp_Vectorlike))
586 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
587 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
588 #define XSUBR(a) (eassert (SUBRP (a)), \
589 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
590 #define XBUFFER(a) (eassert (BUFFERP (a)), \
591 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
592 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
593 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
594 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
595 ((struct Lisp_Sub_Char_Table *) \
596 XUNTAG (a, Lisp_Vectorlike)))
597 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
598 ((struct Lisp_Bool_Vector *) \
599 XUNTAG (a, Lisp_Vectorlike)))
601 /* Construct a Lisp_Object from a value or address. */
603 #define XSETINT(a, b) ((a) = make_number (b))
604 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
605 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
606 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
607 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
608 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
612 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
613 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
615 /* Pseudovector types. */
617 #define XSETPVECTYPE(v, code) \
618 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
619 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
620 ((v)->header.size = (PSEUDOVECTOR_FLAG \
621 | ((code) << PSEUDOVECTOR_AREA_BITS) \
622 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
625 /* The cast to struct vectorlike_header * avoids aliasing issues. */
626 #define XSETPSEUDOVECTOR(a, b, code) \
627 XSETTYPED_PSEUDOVECTOR (a, b, \
628 (((struct vectorlike_header *) \
629 XUNTAG (a, Lisp_Vectorlike)) \
632 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
633 (XSETVECTOR (a, b), \
634 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
635 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
637 #define XSETWINDOW_CONFIGURATION(a, b) \
638 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
639 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
640 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
641 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
642 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
643 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
644 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
645 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
646 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
647 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
649 /* Convenience macros for dealing with Lisp arrays. */
651 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
652 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
653 #define ASET(ARRAY, IDX, VAL) \
654 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
655 XVECTOR (ARRAY)->contents[IDX] = (VAL))
657 /* Convenience macros for dealing with Lisp strings. */
659 #define SDATA(string) (XSTRING (string)->data + 0)
660 #define SREF(string, index) (SDATA (string)[index] + 0)
661 #define SSET(string, index, new) (SDATA (string)[index] = (new))
662 #define SCHARS(string) (XSTRING (string)->size + 0)
663 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
665 /* Avoid "differ in sign" warnings. */
666 #define SSDATA(x) ((char *) SDATA (x))
668 #define STRING_SET_CHARS(string, newsize) \
669 (XSTRING (string)->size = (newsize))
671 #define STRING_COPYIN(string, index, new, count) \
672 memcpy (SDATA (string) + index, new, count)
676 #define CHECK_TYPE(ok, Qxxxp, x) \
677 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
679 /* Deprecated and will be removed soon. */
681 #define INTERNAL_FIELD(field) field ## _
683 /* See the macros in intervals.h. */
685 typedef struct interval
*INTERVAL
;
687 /* Complain if object is not string or buffer type. */
688 #define CHECK_STRING_OR_BUFFER(x) \
689 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
693 /* Car of this cons cell. */
698 /* Cdr of this cons cell. */
701 /* Used to chain conses on a free list. */
702 struct Lisp_Cons
*chain
;
706 /* Take the car or cdr of something known to be a cons cell. */
707 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
708 of code that has to know what a cons cell looks like. Other code not
709 part of the basic lisp implementation should assume that the car and cdr
710 fields are not accessible as lvalues. (What if we want to switch to
711 a copying collector someday? Cached cons cell field addresses may be
712 invalidated at arbitrary points.) */
713 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
714 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
716 /* Use these from normal code. */
717 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
718 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
720 /* Use these to set the fields of a cons cell.
722 Note that both arguments may refer to the same object, so 'n'
723 should not be read after 'c' is first modified. Also, neither
724 argument should be evaluated more than once; side effects are
725 especially common in the second argument. */
726 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
727 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
729 /* Take the car or cdr of something whose type is not known. */
731 (CONSP ((c)) ? XCAR ((c)) \
732 : NILP ((c)) ? Qnil \
733 : wrong_type_argument (Qlistp, (c)))
736 (CONSP ((c)) ? XCDR ((c)) \
737 : NILP ((c)) ? Qnil \
738 : wrong_type_argument (Qlistp, (c)))
740 /* Take the car or cdr of something whose type is not known. */
741 #define CAR_SAFE(c) \
742 (CONSP ((c)) ? XCAR ((c)) : Qnil)
744 #define CDR_SAFE(c) \
745 (CONSP ((c)) ? XCDR ((c)) : Qnil)
747 /* True if STR is a multibyte string. */
748 #define STRING_MULTIBYTE(STR) \
749 (XSTRING (STR)->size_byte >= 0)
751 /* Return the length in bytes of STR. */
753 #ifdef GC_CHECK_STRING_BYTES
756 extern ptrdiff_t string_bytes (struct Lisp_String
*);
757 #define STRING_BYTES(S) string_bytes ((S))
759 #else /* not GC_CHECK_STRING_BYTES */
761 #define STRING_BYTES(STR) \
762 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
764 #endif /* not GC_CHECK_STRING_BYTES */
766 /* An upper bound on the number of bytes in a Lisp string, not
767 counting the terminating null. This a tight enough bound to
768 prevent integer overflow errors that would otherwise occur during
769 string size calculations. A string cannot contain more bytes than
770 a fixnum can represent, nor can it be so long that C pointer
771 arithmetic stops working on the string plus its terminating null.
772 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
773 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
774 would expose alloc.c internal details that we'd rather keep
777 This is a macro for use in static initializers, and a constant for
778 visibility to GDB. The cast to ptrdiff_t ensures that
779 the macro is signed. */
780 static ptrdiff_t const STRING_BYTES_BOUND
=
781 #define STRING_BYTES_BOUND \
782 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
785 /* Mark STR as a unibyte string. */
786 #define STRING_SET_UNIBYTE(STR) \
787 do { if (EQ (STR, empty_multibyte_string)) \
788 (STR) = empty_unibyte_string; \
789 else XSTRING (STR)->size_byte = -1; } while (0)
791 /* Mark STR as a multibyte string. Assure that STR contains only
792 ASCII characters in advance. */
793 #define STRING_SET_MULTIBYTE(STR) \
794 do { if (EQ (STR, empty_unibyte_string)) \
795 (STR) = empty_multibyte_string; \
796 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
798 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
804 INTERVAL intervals
; /* Text properties in this string. */
808 /* Header of vector-like objects. This documents the layout constraints on
809 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
810 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
811 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
812 because when two such pointers potentially alias, a compiler won't
813 incorrectly reorder loads and stores to their size fields. See
814 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
815 struct vectorlike_header
817 /* The only field contains various pieces of information:
818 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
819 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
820 vector (0) or a pseudovector (1).
821 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
822 of slots) of the vector.
823 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
824 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
825 - b) number of Lisp_Objects slots at the beginning of the object
826 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
828 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
829 measured in word_size units. Rest fields may also include
830 Lisp_Objects, but these objects usually needs some special treatment
832 There are some exceptions. For PVEC_FREE, b) is always zero. For
833 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
834 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
835 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
839 /* Regular vector is just a header plus array of Lisp_Objects. */
843 struct vectorlike_header header
;
844 Lisp_Object contents
[1];
847 /* A boolvector is a kind of vectorlike, with contents are like a string. */
849 struct Lisp_Bool_Vector
851 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
852 just the subtype information. */
853 struct vectorlike_header header
;
854 /* This is the size in bits. */
856 /* This contains the actual bits, packed into bytes. */
857 unsigned char data
[1];
860 /* Some handy constants for calculating sizes
861 and offsets, mostly of vectorlike objects. */
865 header_size
= offsetof (struct Lisp_Vector
, contents
),
866 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
867 word_size
= sizeof (Lisp_Object
)
870 /* If a struct is made to look like a vector, this macro returns the length
871 of the shortest vector that would hold that struct. */
873 #define VECSIZE(type) \
874 ((sizeof (type) - header_size + word_size - 1) / word_size)
876 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
877 at the end and we need to compute the number of Lisp_Object fields (the
878 ones that the GC needs to trace). */
880 #define PSEUDOVECSIZE(type, nonlispfield) \
881 ((offsetof (type, nonlispfield) - header_size) / word_size)
883 /* A char-table is a kind of vectorlike, with contents are like a
884 vector but with a few other slots. For some purposes, it makes
885 sense to handle a char-table with type struct Lisp_Vector. An
886 element of a char table can be any Lisp objects, but if it is a sub
887 char-table, we treat it a table that contains information of a
888 specific range of characters. A sub char-table has the same
889 structure as a vector. A sub char table appears only in an element
890 of a char-table, and there's no way to access it directly from
891 Emacs Lisp program. */
895 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
896 ({struct Lisp_Char_Table *_tbl = NULL; \
899 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
900 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
901 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
903 _val = _tbl->defalt; \
904 } while (NILP (_val) && ! NILP (_tbl->parent)); \
907 #else /* not __GNUC__ */
909 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
910 (! NILP (XCHAR_TABLE (CT)->ascii) \
911 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
912 ? XCHAR_TABLE (CT)->ascii \
913 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
914 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
915 : char_table_ref ((CT), (IDX))) \
916 : char_table_ref ((CT), (IDX)))
918 #endif /* not __GNUC__ */
920 /* Compute A OP B, using the unsigned comparison operator OP. A and B
921 should be integer expressions. This is not the same as
922 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
923 returns 1. For efficiency, prefer plain unsigned comparison if A
924 and B's sizes both fit (after integer promotion). */
925 #define UNSIGNED_CMP(a, op, b) \
926 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
927 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
928 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
930 /* Nonzero iff C is an ASCII character. */
931 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
933 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
934 characters. Do not check validity of CT. */
935 #define CHAR_TABLE_REF(CT, IDX) \
936 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
937 : char_table_ref ((CT), (IDX)))
939 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
940 8-bit European characters. Do not check validity of CT. */
941 #define CHAR_TABLE_SET(CT, IDX, VAL) \
942 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
943 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
944 : char_table_set (CT, IDX, VAL))
946 enum CHARTAB_SIZE_BITS
948 CHARTAB_SIZE_BITS_0
= 6,
949 CHARTAB_SIZE_BITS_1
= 4,
950 CHARTAB_SIZE_BITS_2
= 5,
951 CHARTAB_SIZE_BITS_3
= 7
954 extern const int chartab_size
[4];
956 struct Lisp_Char_Table
958 /* HEADER.SIZE is the vector's size field, which also holds the
959 pseudovector type information. It holds the size, too.
960 The size counts the defalt, parent, purpose, ascii,
961 contents, and extras slots. */
962 struct vectorlike_header header
;
964 /* This holds a default value,
965 which is used whenever the value for a specific character is nil. */
968 /* This points to another char table, which we inherit from when the
969 value for a specific character is nil. The `defalt' slot takes
970 precedence over this. */
973 /* This is a symbol which says what kind of use this char-table is
977 /* The bottom sub char-table for characters of the range 0..127. It
978 is nil if none of ASCII character has a specific value. */
981 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
983 /* These hold additional data. It is a vector. */
984 Lisp_Object extras
[1];
987 struct Lisp_Sub_Char_Table
989 /* HEADER.SIZE is the vector's size field, which also holds the
990 pseudovector type information. It holds the size, too. */
991 struct vectorlike_header header
;
993 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
994 char-table of depth 1 contains 16 elements, and each element
995 covers 4096 (128*32) characters. A sub char-table of depth 2
996 contains 32 elements, and each element covers 128 characters. A
997 sub char-table of depth 3 contains 128 elements, and each element
998 is for one character. */
1001 /* Minimum character covered by the sub char-table. */
1002 Lisp_Object min_char
;
1004 /* Use set_sub_char_table_contents to set this. */
1005 Lisp_Object contents
[1];
1008 /* This structure describes a built-in function.
1009 It is generated by the DEFUN macro only.
1010 defsubr makes it into a Lisp object. */
1014 struct vectorlike_header header
;
1016 Lisp_Object (*a0
) (void);
1017 Lisp_Object (*a1
) (Lisp_Object
);
1018 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1019 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1020 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1021 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1022 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1023 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1024 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1025 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1026 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1028 short min_args
, max_args
;
1029 const char *symbol_name
;
1030 const char *intspec
;
1034 /* This is the number of slots that every char table must have. This
1035 counts the ordinary slots and the top, defalt, parent, and purpose
1037 enum CHAR_TABLE_STANDARD_SLOTS
1039 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1042 /* Return the number of "extra" slots in the char table CT. */
1044 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1045 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1048 /***********************************************************************
1050 ***********************************************************************/
1052 /* Interned state of a symbol. */
1054 enum symbol_interned
1056 SYMBOL_UNINTERNED
= 0,
1057 SYMBOL_INTERNED
= 1,
1058 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1061 enum symbol_redirect
1063 SYMBOL_PLAINVAL
= 4,
1064 SYMBOL_VARALIAS
= 1,
1065 SYMBOL_LOCALIZED
= 2,
1066 SYMBOL_FORWARDED
= 3
1071 unsigned gcmarkbit
: 1;
1073 /* Indicates where the value can be found:
1074 0 : it's a plain var, the value is in the `value' field.
1075 1 : it's a varalias, the value is really in the `alias' symbol.
1076 2 : it's a localized var, the value is in the `blv' object.
1077 3 : it's a forwarding variable, the value is in `forward'. */
1078 ENUM_BF (symbol_redirect
) redirect
: 3;
1080 /* Non-zero means symbol is constant, i.e. changing its value
1081 should signal an error. If the value is 3, then the var
1082 can be changed, but only by `defconst'. */
1083 unsigned constant
: 2;
1085 /* Interned state of the symbol. This is an enumerator from
1086 enum symbol_interned. */
1087 unsigned interned
: 2;
1089 /* Non-zero means that this variable has been explicitly declared
1090 special (with `defvar' etc), and shouldn't be lexically bound. */
1091 unsigned declared_special
: 1;
1093 /* The symbol's name, as a Lisp string. */
1096 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1097 union is used depends on the `redirect' field above. */
1100 struct Lisp_Symbol
*alias
;
1101 struct Lisp_Buffer_Local_Value
*blv
;
1102 union Lisp_Fwd
*fwd
;
1105 /* Function value of the symbol or Qunbound if not fboundp. */
1106 Lisp_Object function
;
1108 /* The symbol's property list. */
1111 /* Next symbol in obarray bucket, if the symbol is interned. */
1112 struct Lisp_Symbol
*next
;
1115 /* Value is name of symbol. */
1117 #define SYMBOL_VAL(sym) \
1118 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1119 #define SYMBOL_ALIAS(sym) \
1120 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1121 #define SYMBOL_BLV(sym) \
1122 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1123 #define SYMBOL_FWD(sym) \
1124 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1125 #define SET_SYMBOL_VAL(sym, v) \
1126 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1127 #define SET_SYMBOL_ALIAS(sym, v) \
1128 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1129 #define SET_SYMBOL_BLV(sym, v) \
1130 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1131 #define SET_SYMBOL_FWD(sym, v) \
1132 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1134 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1136 /* Value is non-zero if SYM is an interned symbol. */
1138 #define SYMBOL_INTERNED_P(sym) \
1139 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1141 /* Value is non-zero if SYM is interned in initial_obarray. */
1143 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1144 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1146 /* Value is non-zero if symbol is considered a constant, i.e. its
1147 value cannot be changed (there is an exception for keyword symbols,
1148 whose value can be set to the keyword symbol itself). */
1150 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1152 #define DEFSYM(sym, name) \
1153 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1156 /***********************************************************************
1158 ***********************************************************************/
1160 /* The structure of a Lisp hash table. */
1162 struct Lisp_Hash_Table
1164 /* This is for Lisp; the hash table code does not refer to it. */
1165 struct vectorlike_header header
;
1167 /* Function used to compare keys. */
1170 /* Nil if table is non-weak. Otherwise a symbol describing the
1171 weakness of the table. */
1174 /* When the table is resized, and this is an integer, compute the
1175 new size by adding this to the old size. If a float, compute the
1176 new size by multiplying the old size with this factor. */
1177 Lisp_Object rehash_size
;
1179 /* Resize hash table when number of entries/ table size is >= this
1181 Lisp_Object rehash_threshold
;
1183 /* Vector of hash codes.. If hash[I] is nil, this means that that
1184 entry I is unused. */
1187 /* Vector used to chain entries. If entry I is free, next[I] is the
1188 entry number of the next free item. If entry I is non-free,
1189 next[I] is the index of the next entry in the collision chain. */
1192 /* Index of first free entry in free list. */
1193 Lisp_Object next_free
;
1195 /* Bucket vector. A non-nil entry is the index of the first item in
1196 a collision chain. This vector's size can be larger than the
1197 hash table size to reduce collisions. */
1200 /* User-supplied hash function, or nil. */
1201 Lisp_Object user_hash_function
;
1203 /* User-supplied key comparison function, or nil. */
1204 Lisp_Object user_cmp_function
;
1206 /* Only the fields above are traced normally by the GC. The ones below
1207 `count' are special and are either ignored by the GC or traced in
1208 a special way (e.g. because of weakness). */
1210 /* Number of key/value entries in the table. */
1213 /* Vector of keys and values. The key of item I is found at index
1214 2 * I, the value is found at index 2 * I + 1.
1215 This is gc_marked specially if the table is weak. */
1216 Lisp_Object key_and_value
;
1218 /* Next weak hash table if this is a weak hash table. The head
1219 of the list is in weak_hash_tables. */
1220 struct Lisp_Hash_Table
*next_weak
;
1222 /* C function to compare two keys. */
1223 bool (*cmpfn
) (struct Lisp_Hash_Table
*,
1224 Lisp_Object
, EMACS_UINT
,
1225 Lisp_Object
, EMACS_UINT
);
1227 /* C function to compute hash code. */
1228 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1232 #define XHASH_TABLE(OBJ) \
1233 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1235 #define XSET_HASH_TABLE(VAR, PTR) \
1236 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1238 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1240 #define CHECK_HASH_TABLE(x) \
1241 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1243 /* Value is the key part of entry IDX in hash table H. */
1245 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1247 /* Value is the value part of entry IDX in hash table H. */
1249 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1251 /* Value is the index of the next entry following the one at IDX
1254 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1256 /* Value is the hash code computed for entry IDX in hash table H. */
1258 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1260 /* Value is the index of the element in hash table H that is the
1261 start of the collision list at index IDX in the index vector of H. */
1263 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1265 /* Value is the size of hash table H. */
1267 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1269 /* Default size for hash tables if not specified. */
1271 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1273 /* Default threshold specifying when to resize a hash table. The
1274 value gives the ratio of current entries in the hash table and the
1275 size of the hash table. */
1277 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1279 /* Default factor by which to increase the size of a hash table. */
1281 static double const DEFAULT_REHASH_SIZE
= 1.5;
1283 /* These structures are used for various misc types. */
1285 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1287 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1288 unsigned gcmarkbit
: 1;
1294 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1295 unsigned gcmarkbit
: 1;
1297 /* This flag is temporarily used in the functions
1298 decode/encode_coding_object to record that the marker position
1299 must be adjusted after the conversion. */
1300 unsigned int need_adjustment
: 1;
1301 /* 1 means normal insertion at the marker's position
1302 leaves the marker after the inserted text. */
1303 unsigned int insertion_type
: 1;
1304 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1305 Note: a chain of markers can contain markers pointing into different
1306 buffers (the chain is per buffer_text rather than per buffer, so it's
1307 shared between indirect buffers). */
1308 /* This is used for (other than NULL-checking):
1310 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1311 - unchain_marker: to find the list from which to unchain.
1312 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1314 struct buffer
*buffer
;
1316 /* The remaining fields are meaningless in a marker that
1317 does not point anywhere. */
1319 /* For markers that point somewhere,
1320 this is used to chain of all the markers in a given buffer. */
1321 /* We could remove it and use an array in buffer_text instead.
1322 That would also allow to preserve it ordered. */
1323 struct Lisp_Marker
*next
;
1324 /* This is the char position where the marker points. */
1326 /* This is the byte position.
1327 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1328 used to implement the functionality of markers, but rather to (ab)use
1329 markers as a cache for char<->byte mappings). */
1333 /* START and END are markers in the overlay's buffer, and
1334 PLIST is the overlay's property list. */
1336 /* An overlay's real data content is:
1338 - buffer (really there are two buffer pointers, one per marker,
1339 and both points to the same buffer)
1340 - insertion type of both ends (per-marker fields)
1341 - start & start byte (of start marker)
1342 - end & end byte (of end marker)
1343 - next (singly linked list of overlays)
1344 - next fields of start and end markers (singly linked list of markers).
1345 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1348 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1349 unsigned gcmarkbit
: 1;
1351 struct Lisp_Overlay
*next
;
1357 /* Hold a C pointer for later use.
1358 This type of object is used in the arg to record_unwind_protect. */
1359 struct Lisp_Save_Value
1361 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1362 unsigned gcmarkbit
: 1;
1364 /* If DOGC is set, POINTER is the address of a memory
1365 area containing INTEGER potential Lisp_Objects. */
1366 unsigned int dogc
: 1;
1372 /* A miscellaneous object, when it's on the free list. */
1375 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1376 unsigned gcmarkbit
: 1;
1378 union Lisp_Misc
*chain
;
1381 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1382 It uses one of these struct subtypes to get the type field. */
1386 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1387 struct Lisp_Free u_free
;
1388 struct Lisp_Marker u_marker
;
1389 struct Lisp_Overlay u_overlay
;
1390 struct Lisp_Save_Value u_save_value
;
1393 /* Forwarding pointer to an int variable.
1394 This is allowed only in the value cell of a symbol,
1395 and it means that the symbol's value really lives in the
1396 specified int variable. */
1399 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1403 /* Boolean forwarding pointer to an int variable.
1404 This is like Lisp_Intfwd except that the ostensible
1405 "value" of the symbol is t if the int variable is nonzero,
1406 nil if it is zero. */
1409 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1413 /* Forwarding pointer to a Lisp_Object variable.
1414 This is allowed only in the value cell of a symbol,
1415 and it means that the symbol's value really lives in the
1416 specified variable. */
1419 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1420 Lisp_Object
*objvar
;
1423 /* Like Lisp_Objfwd except that value lives in a slot in the
1424 current buffer. Value is byte index of slot within buffer. */
1425 struct Lisp_Buffer_Objfwd
1427 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1429 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1432 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1433 the symbol has buffer-local or frame-local bindings. (Exception:
1434 some buffer-local variables are built-in, with their values stored
1435 in the buffer structure itself. They are handled differently,
1436 using struct Lisp_Buffer_Objfwd.)
1438 The `realvalue' slot holds the variable's current value, or a
1439 forwarding pointer to where that value is kept. This value is the
1440 one that corresponds to the loaded binding. To read or set the
1441 variable, you must first make sure the right binding is loaded;
1442 then you can access the value in (or through) `realvalue'.
1444 `buffer' and `frame' are the buffer and frame for which the loaded
1445 binding was found. If those have changed, to make sure the right
1446 binding is loaded it is necessary to find which binding goes with
1447 the current buffer and selected frame, then load it. To load it,
1448 first unload the previous binding, then copy the value of the new
1449 binding into `realvalue' (or through it). Also update
1450 LOADED-BINDING to point to the newly loaded binding.
1452 `local_if_set' indicates that merely setting the variable creates a
1453 local binding for the current buffer. Otherwise the latter, setting
1454 the variable does not do that; only make-local-variable does that. */
1456 struct Lisp_Buffer_Local_Value
1458 /* 1 means that merely setting the variable creates a local
1459 binding for the current buffer. */
1460 unsigned int local_if_set
: 1;
1461 /* 1 means this variable can have frame-local bindings, otherwise, it is
1462 can have buffer-local bindings. The two cannot be combined. */
1463 unsigned int frame_local
: 1;
1464 /* 1 means that the binding now loaded was found.
1465 Presumably equivalent to (defcell!=valcell). */
1466 unsigned int found
: 1;
1467 /* If non-NULL, a forwarding to the C var where it should also be set. */
1468 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1469 /* The buffer or frame for which the loaded binding was found. */
1471 /* A cons cell that holds the default value. It has the form
1472 (SYMBOL . DEFAULT-VALUE). */
1473 Lisp_Object defcell
;
1474 /* The cons cell from `where's parameter alist.
1475 It always has the form (SYMBOL . VALUE)
1476 Note that if `forward' is non-nil, VALUE may be out of date.
1477 Also if the currently loaded binding is the default binding, then
1478 this is `eq'ual to defcell. */
1479 Lisp_Object valcell
;
1482 /* Like Lisp_Objfwd except that value lives in a slot in the
1484 struct Lisp_Kboard_Objfwd
1486 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1492 struct Lisp_Intfwd u_intfwd
;
1493 struct Lisp_Boolfwd u_boolfwd
;
1494 struct Lisp_Objfwd u_objfwd
;
1495 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1496 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1499 /* Lisp floating point type. */
1505 struct Lisp_Float
*chain
;
1509 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1510 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1512 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1513 representations, have infinities and NaNs, and do not trap on
1514 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1515 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1516 wanted here, but is not quite right because Emacs does not require
1517 all the features of C11 Annex F (and does not require C11 at all,
1518 for that matter). */
1519 #define IEEE_FLOATING_POINT (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
1520 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
1522 /* A character, declared with the following typedef, is a member
1523 of some character set associated with the current buffer. */
1524 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1526 typedef unsigned char UCHAR
;
1529 /* Meanings of slots in a Lisp_Compiled: */
1533 COMPILED_ARGLIST
= 0,
1534 COMPILED_BYTECODE
= 1,
1535 COMPILED_CONSTANTS
= 2,
1536 COMPILED_STACK_DEPTH
= 3,
1537 COMPILED_DOC_STRING
= 4,
1538 COMPILED_INTERACTIVE
= 5
1541 /* Flag bits in a character. These also get used in termhooks.h.
1542 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1543 (MUlti-Lingual Emacs) might need 22 bits for the character value
1544 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1547 CHAR_ALT
= 0x0400000,
1548 CHAR_SUPER
= 0x0800000,
1549 CHAR_HYPER
= 0x1000000,
1550 CHAR_SHIFT
= 0x2000000,
1551 CHAR_CTL
= 0x4000000,
1552 CHAR_META
= 0x8000000,
1554 CHAR_MODIFIER_MASK
=
1555 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1557 /* Actually, the current Emacs uses 22 bits for the character value
1565 /* The glyph datatype, used to represent characters on the display.
1566 It consists of a char code and a face id. */
1573 /* Return a glyph's character code. */
1574 #define GLYPH_CHAR(glyph) ((glyph).ch)
1576 /* Return a glyph's face ID. */
1577 #define GLYPH_FACE(glyph) ((glyph).face_id)
1579 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1580 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1581 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1583 /* Return 1 if GLYPH contains valid character code. */
1584 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1587 /* Glyph Code from a display vector may either be an integer which
1588 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1589 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1591 #define GLYPH_CODE_P(gc) \
1593 ? (CHARACTERP (XCAR (gc)) \
1594 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1595 : (RANGED_INTEGERP \
1597 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1598 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1599 : TYPE_MAXIMUM (EMACS_INT)))))
1601 /* The following are valid only if GLYPH_CODE_P (gc). */
1603 #define GLYPH_CODE_CHAR(gc) \
1604 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1606 #define GLYPH_CODE_FACE(gc) \
1607 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1609 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1613 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1615 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1616 (XINT (gc) >> CHARACTERBITS)); \
1620 /* Structure to hold mouse highlight data. This is here because other
1621 header files need it for defining struct x_output etc. */
1623 /* These variables describe the range of text currently shown in its
1624 mouse-face, together with the window they apply to. As long as
1625 the mouse stays within this range, we need not redraw anything on
1626 its account. Rows and columns are glyph matrix positions in
1627 MOUSE_FACE_WINDOW. */
1628 int mouse_face_beg_row
, mouse_face_beg_col
;
1629 int mouse_face_beg_x
, mouse_face_beg_y
;
1630 int mouse_face_end_row
, mouse_face_end_col
;
1631 int mouse_face_end_x
, mouse_face_end_y
;
1632 int mouse_face_past_end
;
1633 Lisp_Object mouse_face_window
;
1634 int mouse_face_face_id
;
1635 Lisp_Object mouse_face_overlay
;
1637 /* 1 if a mouse motion event came and we didn't handle it right away because
1638 gc was in progress. */
1639 int mouse_face_deferred_gc
;
1641 /* FRAME and X, Y position of mouse when last checked for
1642 highlighting. X and Y can be negative or out of range for the frame. */
1643 struct frame
*mouse_face_mouse_frame
;
1644 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1646 /* Nonzero means defer mouse-motion highlighting. */
1647 int mouse_face_defer
;
1649 /* Nonzero means that the mouse highlight should not be shown. */
1650 int mouse_face_hidden
;
1652 int mouse_face_image_state
;
1655 /* Data type checking. */
1657 #define NILP(x) EQ (x, Qnil)
1659 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1660 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1662 #define RANGED_INTEGERP(lo, x, hi) \
1663 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1664 #define TYPE_RANGED_INTEGERP(type, x) \
1665 (TYPE_SIGNED (type) \
1666 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1667 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1669 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1670 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1671 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1672 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1673 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1674 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1676 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1677 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1678 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1679 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1680 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1682 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1683 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1684 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1685 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1686 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1688 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1689 vectorlike_header * avoids aliasing issues. */
1690 #define PSEUDOVECTORP(x, code) \
1691 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1693 #define PSEUDOVECTOR_TYPEP(v, code) \
1694 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1695 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS)))
1697 /* True if object X, with internal type struct T *, is a pseudovector whose
1699 #define TYPED_PSEUDOVECTORP(x, t, code) \
1701 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1703 /* Test for specific pseudovector types. */
1704 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1705 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1706 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1707 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1708 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1709 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1710 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1711 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1712 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1713 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1714 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1716 /* Test for image (image . spec) */
1717 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1722 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1724 #define CHECK_LIST(x) \
1725 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1727 #define CHECK_LIST_CONS(x, y) \
1728 CHECK_TYPE (CONSP (x), Qlistp, y)
1730 #define CHECK_LIST_END(x, y) \
1731 CHECK_TYPE (NILP (x), Qlistp, y)
1733 #define CHECK_STRING(x) \
1734 CHECK_TYPE (STRINGP (x), Qstringp, x)
1736 #define CHECK_STRING_CAR(x) \
1737 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1739 #define CHECK_CONS(x) \
1740 CHECK_TYPE (CONSP (x), Qconsp, x)
1742 #define CHECK_SYMBOL(x) \
1743 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1745 #define CHECK_CHAR_TABLE(x) \
1746 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1748 #define CHECK_VECTOR(x) \
1749 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1751 #define CHECK_VECTOR_OR_STRING(x) \
1752 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1754 #define CHECK_ARRAY(x, Qxxxp) \
1755 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1757 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1758 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1760 #define CHECK_BUFFER(x) \
1761 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1763 #define CHECK_WINDOW(x) \
1764 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1766 #define CHECK_WINDOW_CONFIGURATION(x) \
1767 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1769 #define CHECK_PROCESS(x) \
1770 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1772 #define CHECK_SUBR(x) \
1773 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1775 #define CHECK_NUMBER(x) \
1776 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1778 #define CHECK_NATNUM(x) \
1779 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1781 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1784 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1785 args_out_of_range_3 \
1787 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1788 ? MOST_NEGATIVE_FIXNUM \
1790 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1792 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1794 if (TYPE_SIGNED (type)) \
1795 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1797 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1800 #define CHECK_MARKER(x) \
1801 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1803 #define CHECK_NUMBER_COERCE_MARKER(x) \
1804 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1805 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1807 #define XFLOATINT(n) extract_float((n))
1809 #define CHECK_FLOAT(x) \
1810 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1812 #define CHECK_NUMBER_OR_FLOAT(x) \
1813 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1815 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1816 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1817 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1819 #define CHECK_OVERLAY(x) \
1820 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1822 /* Since we can't assign directly to the CAR or CDR fields of a cons
1823 cell, use these when checking that those fields contain numbers. */
1824 #define CHECK_NUMBER_CAR(x) \
1826 Lisp_Object tmp = XCAR (x); \
1827 CHECK_NUMBER (tmp); \
1828 XSETCAR ((x), tmp); \
1831 #define CHECK_NUMBER_CDR(x) \
1833 Lisp_Object tmp = XCDR (x); \
1834 CHECK_NUMBER (tmp); \
1835 XSETCDR ((x), tmp); \
1838 #define CHECK_NATNUM_CAR(x) \
1840 Lisp_Object tmp = XCAR (x); \
1841 CHECK_NATNUM (tmp); \
1842 XSETCAR ((x), tmp); \
1845 #define CHECK_NATNUM_CDR(x) \
1847 Lisp_Object tmp = XCDR (x); \
1848 CHECK_NATNUM (tmp); \
1849 XSETCDR ((x), tmp); \
1852 /* Define a built-in function for calling from Lisp.
1853 `lname' should be the name to give the function in Lisp,
1854 as a null-terminated C string.
1855 `fnname' should be the name of the function in C.
1856 By convention, it starts with F.
1857 `sname' should be the name for the C constant structure
1858 that records information on this function for internal use.
1859 By convention, it should be the same as `fnname' but with S instead of F.
1860 It's too bad that C macros can't compute this from `fnname'.
1861 `minargs' should be a number, the minimum number of arguments allowed.
1862 `maxargs' should be a number, the maximum number of arguments allowed,
1863 or else MANY or UNEVALLED.
1864 MANY means pass a vector of evaluated arguments,
1865 in the form of an integer number-of-arguments
1866 followed by the address of a vector of Lisp_Objects
1867 which contains the argument values.
1868 UNEVALLED means pass the list of unevaluated arguments
1869 `intspec' says how interactive arguments are to be fetched.
1870 If the string starts with a `(', `intspec' is evaluated and the resulting
1871 list is the list of arguments.
1872 If it's a string that doesn't start with `(', the value should follow
1873 the one of the doc string for `interactive'.
1874 A null string means call interactively with no arguments.
1875 `doc' is documentation for the user. */
1877 /* This version of DEFUN declares a function prototype with the right
1878 arguments, so we can catch errors with maxargs at compile-time. */
1880 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1881 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1882 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1883 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
1884 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
1885 { (Lisp_Object (__cdecl *)(void))fnname }, \
1886 minargs, maxargs, lname, intspec, 0}; \
1888 #else /* not _MSC_VER */
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_AREA_BITS }, \
1893 { .a ## maxargs = fnname }, \
1894 minargs, maxargs, lname, intspec, 0}; \
1898 /* Note that the weird token-substitution semantics of ANSI C makes
1899 this work for MANY and UNEVALLED. */
1900 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1901 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1902 #define DEFUN_ARGS_0 (void)
1903 #define DEFUN_ARGS_1 (Lisp_Object)
1904 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1905 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1906 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1907 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1909 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1910 Lisp_Object, Lisp_Object)
1911 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1912 Lisp_Object, Lisp_Object, Lisp_Object)
1913 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1914 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1916 /* Non-zero if OBJ is a Lisp function. */
1917 #define FUNCTIONP(OBJ) functionp(OBJ)
1920 is how we define the symbol for function `name' at start-up time. */
1921 extern void defsubr (struct Lisp_Subr
*);
1929 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1930 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1931 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1932 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1933 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1935 /* Macros we use to define forwarded Lisp variables.
1936 These are used in the syms_of_FILENAME functions.
1938 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1939 lisp variable is actually a field in `struct emacs_globals'. The
1940 field's name begins with "f_", which is a convention enforced by
1941 these macros. Each such global has a corresponding #define in
1942 globals.h; the plain name should be used in the code.
1944 E.g., the global "cons_cells_consed" is declared as "int
1945 f_cons_cells_consed" in globals.h, but there is a define:
1947 #define cons_cells_consed globals.f_cons_cells_consed
1949 All C code uses the `cons_cells_consed' name. This is all done
1950 this way to support indirection for multi-threaded Emacs. */
1952 #define DEFVAR_LISP(lname, vname, doc) \
1954 static struct Lisp_Objfwd o_fwd; \
1955 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1957 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1959 static struct Lisp_Objfwd o_fwd; \
1960 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1962 #define DEFVAR_BOOL(lname, vname, doc) \
1964 static struct Lisp_Boolfwd b_fwd; \
1965 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1967 #define DEFVAR_INT(lname, vname, doc) \
1969 static struct Lisp_Intfwd i_fwd; \
1970 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1973 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1975 static struct Lisp_Objfwd o_fwd; \
1976 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1979 #define DEFVAR_KBOARD(lname, vname, doc) \
1981 static struct Lisp_Kboard_Objfwd ko_fwd; \
1982 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1985 /* Save and restore the instruction and environment pointers,
1986 without affecting the signal mask. */
1989 typedef jmp_buf sys_jmp_buf
;
1990 # define sys_setjmp(j) _setjmp (j)
1991 # define sys_longjmp(j, v) _longjmp (j, v)
1992 #elif defined HAVE_SIGSETJMP
1993 typedef sigjmp_buf sys_jmp_buf
;
1994 # define sys_setjmp(j) sigsetjmp (j, 0)
1995 # define sys_longjmp(j, v) siglongjmp (j, v)
1997 /* A platform that uses neither _longjmp nor siglongjmp; assume
1998 longjmp does not affect the sigmask. */
1999 typedef jmp_buf sys_jmp_buf
;
2000 # define sys_setjmp(j) setjmp (j)
2001 # define sys_longjmp(j, v) longjmp (j, v)
2005 /* Structure for recording Lisp call stack for backtrace purposes. */
2007 /* The special binding stack holds the outer values of variables while
2008 they are bound by a function application or a let form, stores the
2009 code to be executed for Lisp unwind-protect forms, and stores the C
2010 functions to be called for record_unwind_protect.
2012 If func is non-zero, undoing this binding applies func to old_value;
2013 This implements record_unwind_protect.
2015 Otherwise, the element is a variable binding.
2017 If the symbol field is a symbol, it is an ordinary variable binding.
2019 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2020 which means having bound a local value while CURRENT-BUFFER was active.
2021 If WHERE is nil this means we saw the default value when binding SYMBOL.
2022 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2023 value. Other values of WHERE mean an internal error. */
2025 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2029 Lisp_Object symbol
, old_value
;
2030 specbinding_func func
;
2031 Lisp_Object unused
; /* Dividing by 16 is faster than by 12. */
2034 extern struct specbinding
*specpdl
;
2035 extern struct specbinding
*specpdl_ptr
;
2036 extern ptrdiff_t specpdl_size
;
2038 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2042 struct backtrace
*next
;
2043 Lisp_Object function
;
2044 Lisp_Object
*args
; /* Points to vector of args. */
2045 ptrdiff_t nargs
; /* Length of vector. */
2046 /* Nonzero means call value of debugger when done with this operation. */
2047 unsigned int debug_on_exit
: 1;
2050 extern struct backtrace
*backtrace_list
;
2052 /* Everything needed to describe an active condition case.
2054 Members are volatile if their values need to survive _longjmp when
2055 a 'struct handler' is a local variable. */
2058 /* The handler clauses and variable from the condition-case form. */
2059 /* For a handler set up in Lisp code, this is always a list.
2060 For an internal handler set up by internal_condition_case*,
2061 this can instead be the symbol t or `error'.
2062 t: handle all conditions.
2063 error: handle all conditions, and errors can run the debugger
2064 or display a backtrace. */
2065 Lisp_Object handler
;
2067 Lisp_Object
volatile var
;
2069 /* Fsignal stores here the condition-case clause that applies,
2070 and Fcondition_case thus knows which clause to run. */
2071 Lisp_Object
volatile chosen_clause
;
2073 /* Used to effect the longjump out to the handler. */
2074 struct catchtag
*tag
;
2076 /* The next enclosing handler. */
2077 struct handler
*next
;
2080 /* This structure helps implement the `catch' and `throw' control
2081 structure. A struct catchtag contains all the information needed
2082 to restore the state of the interpreter after a non-local jump.
2084 Handlers for error conditions (represented by `struct handler'
2085 structures) just point to a catch tag to do the cleanup required
2088 catchtag structures are chained together in the C calling stack;
2089 the `next' member points to the next outer catchtag.
2091 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2092 member is TAG, and then unbinds to it. The `val' member is used to
2093 hold VAL while the stack is unwound; `val' is returned as the value
2096 All the other members are concerned with restoring the interpreter
2099 Members are volatile if their values need to survive _longjmp when
2100 a 'struct catchtag' is a local variable. */
2104 Lisp_Object
volatile val
;
2105 struct catchtag
*volatile next
;
2106 struct gcpro
*gcpro
;
2108 struct backtrace
*backlist
;
2109 struct handler
*handlerlist
;
2110 EMACS_INT lisp_eval_depth
;
2111 ptrdiff_t volatile pdlcount
;
2112 int poll_suppress_count
;
2113 int interrupt_input_blocked
;
2114 struct byte_stack
*byte_stack
;
2117 extern Lisp_Object memory_signal_data
;
2119 /* An address near the bottom of the stack.
2120 Tells GC how to save a copy of the stack. */
2121 extern char *stack_bottom
;
2123 /* Check quit-flag and quit if it is non-nil.
2124 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2125 So the program needs to do QUIT at times when it is safe to quit.
2126 Every loop that might run for a long time or might not exit
2127 ought to do QUIT at least once, at a safe place.
2128 Unless that is impossible, of course.
2129 But it is very desirable to avoid creating loops where QUIT is impossible.
2131 Exception: if you set immediate_quit to nonzero,
2132 then the handler that responds to the C-g does the quit itself.
2133 This is a good thing to do around a loop that has no side effects
2134 and (in particular) cannot call arbitrary Lisp code.
2136 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2137 a request to exit Emacs when it is safe to do. */
2139 extern void process_pending_signals (void);
2140 extern bool volatile pending_signals
;
2142 extern void process_quit_flag (void);
2145 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2146 process_quit_flag (); \
2147 else if (pending_signals) \
2148 process_pending_signals (); \
2152 /* Nonzero if ought to quit now. */
2154 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2156 extern Lisp_Object Vascii_downcase_table
;
2157 extern Lisp_Object Vascii_canon_table
;
2159 /* Structure for recording stack slots that need marking. */
2161 /* This is a chain of structures, each of which points at a Lisp_Object
2162 variable whose value should be marked in garbage collection.
2163 Normally every link of the chain is an automatic variable of a function,
2164 and its `val' points to some argument or local variable of the function.
2165 On exit to the function, the chain is set back to the value it had on entry.
2166 This way, no link remains in the chain when the stack frame containing the
2169 Every function that can call Feval must protect in this fashion all
2170 Lisp_Object variables whose contents will be used again. */
2172 extern struct gcpro
*gcprolist
;
2178 /* Address of first protected variable. */
2179 volatile Lisp_Object
*var
;
2181 /* Number of consecutive protected variables. */
2189 /* Values of GC_MARK_STACK during compilation:
2191 0 Use GCPRO as before
2192 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2193 2 Mark the stack, and check that everything GCPRO'd is
2195 3 Mark using GCPRO's, mark stack last, and count how many
2196 dead objects are kept alive. */
2199 #define GC_USE_GCPROS_AS_BEFORE 0
2200 #define GC_MAKE_GCPROS_NOOPS 1
2201 #define GC_MARK_STACK_CHECK_GCPROS 2
2202 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2204 #ifndef GC_MARK_STACK
2205 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2208 /* Whether we do the stack marking manually. */
2209 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2210 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2213 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2215 /* Do something silly with gcproN vars just so gcc shuts up. */
2216 /* You get warnings from MIPSPro... */
2218 #define GCPRO1(varname) ((void) gcpro1)
2219 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2220 #define GCPRO3(varname1, varname2, varname3) \
2221 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2222 #define GCPRO4(varname1, varname2, varname3, varname4) \
2223 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2224 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2225 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2226 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2227 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2229 #define UNGCPRO ((void) 0)
2231 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2235 #define GCPRO1(varname) \
2236 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2237 gcprolist = &gcpro1; }
2239 #define GCPRO2(varname1, varname2) \
2240 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2241 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2242 gcprolist = &gcpro2; }
2244 #define GCPRO3(varname1, varname2, varname3) \
2245 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2246 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2247 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2248 gcprolist = &gcpro3; }
2250 #define GCPRO4(varname1, varname2, varname3, varname4) \
2251 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2252 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2253 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2254 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2255 gcprolist = &gcpro4; }
2257 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2258 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2259 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2260 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2261 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2262 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2263 gcprolist = &gcpro5; }
2265 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2266 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2267 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2268 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2269 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2270 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2271 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2272 gcprolist = &gcpro6; }
2274 #define UNGCPRO (gcprolist = gcpro1.next)
2278 extern int gcpro_level
;
2280 #define GCPRO1(varname) \
2281 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2282 gcpro1.level = gcpro_level++; \
2283 gcprolist = &gcpro1; }
2285 #define GCPRO2(varname1, varname2) \
2286 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2287 gcpro1.level = gcpro_level; \
2288 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2289 gcpro2.level = gcpro_level++; \
2290 gcprolist = &gcpro2; }
2292 #define GCPRO3(varname1, varname2, varname3) \
2293 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2294 gcpro1.level = gcpro_level; \
2295 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2296 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2297 gcpro3.level = gcpro_level++; \
2298 gcprolist = &gcpro3; }
2300 #define GCPRO4(varname1, varname2, varname3, varname4) \
2301 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2302 gcpro1.level = gcpro_level; \
2303 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2304 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2305 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2306 gcpro4.level = gcpro_level++; \
2307 gcprolist = &gcpro4; }
2309 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
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 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2316 gcpro5.level = gcpro_level++; \
2317 gcprolist = &gcpro5; }
2319 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2320 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2321 gcpro1.level = gcpro_level; \
2322 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2323 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2324 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2325 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2326 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2327 gcpro6.level = gcpro_level++; \
2328 gcprolist = &gcpro6; }
2331 ((--gcpro_level != gcpro1.level) \
2332 ? (emacs_abort (), 0) \
2333 : ((gcprolist = gcpro1.next), 0))
2335 #endif /* DEBUG_GCPRO */
2336 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2339 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2340 #define RETURN_UNGCPRO(expr) \
2343 Lisp_Object ret_ungc_val; \
2344 ret_ungc_val = (expr); \
2346 return ret_ungc_val; \
2350 /* Call staticpro (&var) to protect static variable `var'. */
2352 void staticpro (Lisp_Object
*);
2354 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2355 meaning as in the DEFUN macro, and is used to construct a prototype. */
2356 /* We can use the same trick as in the DEFUN macro to generate the
2357 appropriate prototype. */
2358 #define EXFUN(fnname, maxargs) \
2359 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2361 /* Forward declarations for prototypes. */
2365 /* Simple access functions. */
2367 LISP_INLINE Lisp_Object
*
2368 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2370 return & XVECTOR (array
)->contents
[idx
];
2374 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2376 /* Like ASET, but also can be used in the garbage collector:
2377 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2378 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2379 XVECTOR (array
)->contents
[idx
] = val
;
2382 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2385 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2387 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2388 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2391 /* Functions to modify hash tables. */
2394 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2396 h
->key_and_value
= key_and_value
;
2400 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2402 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2406 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2408 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2412 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2418 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2420 gc_aset (h
->next
, idx
, val
);
2424 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2430 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2432 gc_aset (h
->hash
, idx
, val
);
2436 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2442 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2444 gc_aset (h
->index
, idx
, val
);
2447 /* Use these functions to set Lisp_Object
2448 or pointer slots of struct Lisp_Symbol. */
2451 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2453 XSYMBOL (sym
)->name
= name
;
2457 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2459 XSYMBOL (sym
)->function
= function
;
2463 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2465 XSYMBOL (sym
)->plist
= plist
;
2469 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2471 XSYMBOL (sym
)->next
= next
;
2474 /* Buffer-local (also frame-local) variable access functions. */
2477 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2479 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2484 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2486 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2490 LISP_INLINE Lisp_Object
2491 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2493 return XCDR (blv
->valcell
);
2497 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2499 XSETCDR (blv
->valcell
, val
);
2503 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2509 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2515 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2520 /* Set overlay's property list. */
2523 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2525 XOVERLAY (overlay
)->plist
= plist
;
2528 /* Get text properties of S. */
2530 LISP_INLINE INTERVAL
2531 string_intervals (Lisp_Object s
)
2533 return XSTRING (s
)->intervals
;
2536 /* Set text properties of S to I. */
2539 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2541 XSTRING (s
)->intervals
= i
;
2544 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2545 of setting slots directly. */
2548 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2550 XCHAR_TABLE (table
)->ascii
= val
;
2553 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2555 XCHAR_TABLE (table
)->defalt
= val
;
2558 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2560 XCHAR_TABLE (table
)->parent
= val
;
2563 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2565 XCHAR_TABLE (table
)->purpose
= val
;
2568 /* Set different slots in (sub)character tables. */
2571 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2573 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2574 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2578 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2580 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2581 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2585 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2587 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2590 /* Defined in data.c. */
2591 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2592 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2593 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2594 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2595 extern Lisp_Object Qinvalid_read_syntax
;
2596 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2597 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2598 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2599 extern Lisp_Object Qtext_read_only
;
2600 extern Lisp_Object Qinteractive_form
;
2601 extern Lisp_Object Qcircular_list
;
2602 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2603 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2604 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2605 extern Lisp_Object Qbuffer_or_string_p
;
2606 extern Lisp_Object Qfboundp
;
2607 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2609 extern Lisp_Object Qcdr
;
2611 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2613 extern Lisp_Object Qfloatp
;
2614 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2616 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2618 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2620 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2622 /* Defined in data.c. */
2623 extern Lisp_Object
indirect_function (Lisp_Object
);
2624 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2626 /* Convert the integer I to an Emacs representation, either the integer
2627 itself, or a cons of two or three integers, or if all else fails a float.
2628 I should not have side effects. */
2629 #define INTEGER_TO_CONS(i) \
2630 (! FIXNUM_OVERFLOW_P (i) \
2632 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2633 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2634 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2635 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2636 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2637 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2638 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2639 ? Fcons (make_number ((i) >> 16 >> 24), \
2640 Fcons (make_number ((i) >> 16 & 0xffffff), \
2641 make_number ((i) & 0xffff))) \
2644 /* Convert the Emacs representation CONS back to an integer of type
2645 TYPE, storing the result the variable VAR. Signal an error if CONS
2646 is not a valid representation or is out of range for TYPE. */
2647 #define CONS_TO_INTEGER(cons, type, var) \
2648 (TYPE_SIGNED (type) \
2649 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2650 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2651 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2652 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2654 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2655 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2656 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2658 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2659 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2660 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2661 extern void syms_of_data (void);
2662 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2664 /* Defined in cmds.c */
2665 extern void syms_of_cmds (void);
2666 extern void keys_of_cmds (void);
2668 /* Defined in coding.c. */
2669 extern Lisp_Object Qcharset
;
2670 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2671 ptrdiff_t, bool, bool, Lisp_Object
);
2672 extern void init_coding (void);
2673 extern void init_coding_once (void);
2674 extern void syms_of_coding (void);
2676 /* Defined in character.c. */
2677 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2678 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2679 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2680 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2681 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2682 extern void syms_of_character (void);
2684 /* Defined in charset.c. */
2685 extern void init_charset (void);
2686 extern void init_charset_once (void);
2687 extern void syms_of_charset (void);
2688 /* Structure forward declarations. */
2691 /* Defined in composite.c. */
2692 extern void syms_of_composite (void);
2694 /* Defined in syntax.c. */
2695 extern void init_syntax_once (void);
2696 extern void syms_of_syntax (void);
2698 /* Defined in fns.c. */
2699 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2700 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2701 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2702 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2703 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2704 extern void sweep_weak_hash_tables (void);
2705 extern Lisp_Object Qcursor_in_echo_area
;
2706 extern Lisp_Object Qstring_lessp
;
2707 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2708 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2709 EMACS_UINT
sxhash (Lisp_Object
, int);
2710 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2711 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2713 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2714 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2717 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2718 ptrdiff_t, ptrdiff_t);
2719 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2720 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2721 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2722 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2723 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2724 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2725 extern void clear_string_char_byte_cache (void);
2726 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2727 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2728 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2729 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2730 extern void syms_of_fns (void);
2732 /* Defined in floatfns.c. */
2733 extern double extract_float (Lisp_Object
);
2734 extern void syms_of_floatfns (void);
2735 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2737 /* Defined in fringe.c. */
2738 extern void syms_of_fringe (void);
2739 extern void init_fringe (void);
2740 #ifdef HAVE_WINDOW_SYSTEM
2741 extern void mark_fringe_data (void);
2742 extern void init_fringe_once (void);
2743 #endif /* HAVE_WINDOW_SYSTEM */
2745 /* Defined in image.c. */
2746 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2747 extern Lisp_Object QCconversion
;
2748 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2749 extern void reset_image_types (void);
2750 extern void syms_of_image (void);
2752 /* Defined in insdel.c. */
2753 extern Lisp_Object Qinhibit_modification_hooks
;
2754 extern void move_gap (ptrdiff_t);
2755 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2756 extern _Noreturn
void buffer_overflow (void);
2757 extern void make_gap (ptrdiff_t);
2758 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2759 ptrdiff_t, bool, bool);
2760 extern int count_combining_before (const unsigned char *,
2761 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2762 extern int count_combining_after (const unsigned char *,
2763 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2764 extern void insert (const char *, ptrdiff_t);
2765 extern void insert_and_inherit (const char *, ptrdiff_t);
2766 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2767 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2769 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2770 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2771 ptrdiff_t, ptrdiff_t, bool);
2772 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2773 extern void insert_char (int);
2774 extern void insert_string (const char *);
2775 extern void insert_before_markers (const char *, ptrdiff_t);
2776 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2777 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2778 ptrdiff_t, ptrdiff_t,
2780 extern void del_range (ptrdiff_t, ptrdiff_t);
2781 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2782 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2783 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2784 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2785 ptrdiff_t, ptrdiff_t, bool);
2786 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2787 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2788 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2789 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2790 ptrdiff_t, ptrdiff_t);
2791 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2792 ptrdiff_t, ptrdiff_t);
2793 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2794 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2795 const char *, ptrdiff_t, ptrdiff_t, bool);
2796 extern void syms_of_insdel (void);
2798 /* Defined in dispnew.c. */
2799 #if (defined PROFILING \
2800 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2801 _Noreturn
void __executable_start (void);
2803 extern Lisp_Object selected_frame
;
2804 extern Lisp_Object Vwindow_system
;
2805 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2806 extern void init_display (void);
2807 extern void syms_of_display (void);
2809 /* Defined in xdisp.c. */
2810 extern Lisp_Object Qinhibit_point_motion_hooks
;
2811 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2812 extern Lisp_Object Qmenu_bar_update_hook
;
2813 extern Lisp_Object Qwindow_scroll_functions
;
2814 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2815 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2816 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2817 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2818 extern Lisp_Object Qleft_margin
, Qright_margin
;
2819 extern Lisp_Object Qglyphless_char
;
2820 extern Lisp_Object QCdata
, QCfile
;
2821 extern Lisp_Object QCmap
;
2822 extern Lisp_Object Qrisky_local_variable
;
2823 extern struct frame
*last_glyphless_glyph_frame
;
2824 extern int last_glyphless_glyph_face_id
;
2825 extern int last_glyphless_glyph_merged_face_id
;
2826 extern int noninteractive_need_newline
;
2827 extern Lisp_Object echo_area_buffer
[2];
2828 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2829 extern void check_message_stack (void);
2830 extern void setup_echo_area_for_printing (int);
2831 extern bool push_message (void);
2832 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2833 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2834 extern void restore_message (void);
2835 extern Lisp_Object
current_message (void);
2836 extern void clear_message (int, int);
2837 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2838 extern void message1 (const char *);
2839 extern void message1_nolog (const char *);
2840 extern void message2 (const char *, ptrdiff_t, int);
2841 extern void message2_nolog (const char *, ptrdiff_t, int);
2842 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2843 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2844 extern void message_dolog (const char *, ptrdiff_t, int, int);
2845 extern void message_with_string (const char *, Lisp_Object
, int);
2846 extern void message_log_maybe_newline (void);
2847 extern void update_echo_area (void);
2848 extern void truncate_echo_area (ptrdiff_t);
2849 extern void redisplay (void);
2850 extern void redisplay_preserve_echo_area (int);
2851 extern void prepare_menu_bars (void);
2853 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2854 extern void syms_of_xdisp (void);
2855 extern void init_xdisp (void);
2856 extern Lisp_Object
safe_eval (Lisp_Object
);
2857 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2858 int *, int *, int *, int *, int *);
2860 /* Defined in xsettings.c. */
2861 extern void syms_of_xsettings (void);
2863 /* Defined in vm-limit.c. */
2864 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2866 /* Defined in alloc.c. */
2867 extern void check_pure_size (void);
2868 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2869 extern void malloc_warning (const char *);
2870 extern _Noreturn
void memory_full (size_t);
2871 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2872 extern bool survives_gc_p (Lisp_Object
);
2873 extern void mark_object (Lisp_Object
);
2874 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2875 extern void refill_memory_reserve (void);
2877 extern const char *pending_malloc_warning
;
2878 extern Lisp_Object zero_vector
;
2879 extern Lisp_Object
*stack_base
;
2880 extern EMACS_INT consing_since_gc
;
2881 extern EMACS_INT gc_relative_threshold
;
2882 extern EMACS_INT memory_full_cons_threshold
;
2883 extern Lisp_Object
list1 (Lisp_Object
);
2884 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2885 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2886 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2887 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2889 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2890 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2891 extern _Noreturn
void string_overflow (void);
2892 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2893 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2894 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2895 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2897 /* Make unibyte string from C string when the length isn't known. */
2899 LISP_INLINE Lisp_Object
2900 build_unibyte_string (const char *str
)
2902 return make_unibyte_string (str
, strlen (str
));
2905 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2906 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2907 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2908 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2909 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2910 extern Lisp_Object
make_specified_string (const char *,
2911 ptrdiff_t, ptrdiff_t, bool);
2912 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2913 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2915 /* Make a string allocated in pure space, use STR as string data. */
2917 LISP_INLINE Lisp_Object
2918 build_pure_c_string (const char *str
)
2920 return make_pure_c_string (str
, strlen (str
));
2923 /* Make a string from the data at STR, treating it as multibyte if the
2926 LISP_INLINE Lisp_Object
2927 build_string (const char *str
)
2929 return make_string (str
, strlen (str
));
2932 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2933 extern void make_byte_code (struct Lisp_Vector
*);
2934 extern Lisp_Object Qautomatic_gc
;
2935 extern Lisp_Object Qchar_table_extra_slots
;
2936 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2937 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
2938 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2940 allocate_pseudovector \
2941 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2942 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2943 extern struct window
*allocate_window (void);
2944 extern struct frame
*allocate_frame (void);
2945 extern struct Lisp_Process
*allocate_process (void);
2946 extern struct terminal
*allocate_terminal (void);
2947 extern bool gc_in_progress
;
2948 extern bool abort_on_gc
;
2949 extern Lisp_Object
make_float (double);
2950 extern void display_malloc_warning (void);
2951 extern ptrdiff_t inhibit_garbage_collection (void);
2952 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2953 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2954 extern void free_marker (Lisp_Object
);
2955 extern void free_cons (struct Lisp_Cons
*);
2956 extern void init_alloc_once (void);
2957 extern void init_alloc (void);
2958 extern void syms_of_alloc (void);
2959 extern struct buffer
* allocate_buffer (void);
2960 extern int valid_lisp_object_p (Lisp_Object
);
2961 #ifdef GC_CHECK_CONS_LIST
2962 extern void check_cons_list (void);
2964 #define check_cons_list() ((void) 0)
2968 /* Defined in ralloc.c. */
2969 extern void *r_alloc (void **, size_t);
2970 extern void r_alloc_free (void **);
2971 extern void *r_re_alloc (void **, size_t);
2972 extern void r_alloc_reset_variable (void **, void **);
2973 extern void r_alloc_inhibit_buffer_relocation (int);
2976 /* Defined in chartab.c. */
2977 extern Lisp_Object
copy_char_table (Lisp_Object
);
2978 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2979 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2981 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
2982 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
2983 extern int char_table_translate (Lisp_Object
, int);
2984 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2986 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2987 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2988 Lisp_Object
, Lisp_Object
,
2989 Lisp_Object
, struct charset
*,
2990 unsigned, unsigned);
2991 extern Lisp_Object
uniprop_table (Lisp_Object
);
2992 extern void syms_of_chartab (void);
2994 /* Defined in print.c. */
2995 extern Lisp_Object Vprin1_to_string_buffer
;
2996 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2997 extern Lisp_Object Qstandard_output
;
2998 extern Lisp_Object Qexternal_debugging_output
;
2999 extern void temp_output_buffer_setup (const char *);
3000 extern int print_level
;
3001 extern Lisp_Object Qprint_escape_newlines
;
3002 extern void write_string (const char *, int);
3003 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3005 extern Lisp_Object internal_with_output_to_temp_buffer
3006 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3007 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3008 extern int float_to_string (char *, double);
3009 extern void syms_of_print (void);
3011 /* Defined in doprnt.c. */
3012 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3014 extern ptrdiff_t esprintf (char *, char const *, ...)
3015 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3016 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3018 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3019 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3020 char const *, va_list)
3021 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3023 /* Defined in lread.c. */
3024 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3025 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3026 extern Lisp_Object Qlexical_binding
;
3027 extern Lisp_Object
check_obarray (Lisp_Object
);
3028 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3029 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3030 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3031 #define LOADHIST_ATTACH(x) \
3033 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3035 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3036 Lisp_Object
*, Lisp_Object
);
3037 extern Lisp_Object
string_to_number (char const *, int, bool);
3038 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3040 extern void dir_warning (const char *, Lisp_Object
);
3041 extern void close_load_descs (void);
3042 extern void init_obarray (void);
3043 extern void init_lread (void);
3044 extern void syms_of_lread (void);
3046 LISP_INLINE Lisp_Object
3047 intern (const char *str
)
3049 return intern_1 (str
, strlen (str
));
3052 LISP_INLINE Lisp_Object
3053 intern_c_string (const char *str
)
3055 return intern_c_string_1 (str
, strlen (str
));
3058 /* Defined in eval.c. */
3059 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3060 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3061 extern Lisp_Object Qand_rest
;
3062 extern Lisp_Object Vautoload_queue
;
3063 extern Lisp_Object Vsignaling_function
;
3064 extern Lisp_Object inhibit_lisp_code
;
3066 extern struct catchtag
*catchlist
;
3067 extern struct handler
*handlerlist
;
3069 /* To run a normal hook, use the appropriate function from the list below.
3070 The calling convention:
3072 if (!NILP (Vrun_hooks))
3073 call1 (Vrun_hooks, Qmy_funny_hook);
3075 should no longer be used. */
3076 extern Lisp_Object Vrun_hooks
;
3077 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3078 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3079 Lisp_Object (*funcall
)
3080 (ptrdiff_t nargs
, Lisp_Object
*args
));
3081 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3082 extern _Noreturn
void xsignal0 (Lisp_Object
);
3083 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3084 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3085 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3087 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3088 extern Lisp_Object
eval_sub (Lisp_Object form
);
3089 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3090 extern Lisp_Object
call0 (Lisp_Object
);
3091 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3092 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3093 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3094 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3095 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3096 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3097 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3098 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3099 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3100 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3101 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3102 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3103 extern Lisp_Object internal_condition_case_n
3104 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3105 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3106 extern void specbind (Lisp_Object
, Lisp_Object
);
3107 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3108 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3109 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3110 extern _Noreturn
void verror (const char *, va_list)
3111 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3112 extern Lisp_Object
un_autoload (Lisp_Object
);
3113 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3114 extern void init_eval_once (void);
3115 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3116 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3117 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3118 extern void init_eval (void);
3120 extern void mark_backtrace (void);
3122 extern void syms_of_eval (void);
3124 /* Defined in editfns.c. */
3125 extern Lisp_Object Qfield
;
3126 extern void insert1 (Lisp_Object
);
3127 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3128 extern Lisp_Object
save_excursion_save (void);
3129 extern Lisp_Object
save_restriction_save (void);
3130 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3131 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3132 extern _Noreturn
void time_overflow (void);
3133 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3134 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3136 extern void init_editfns (void);
3137 extern void syms_of_editfns (void);
3138 extern void set_time_zone_rule (const char *);
3140 /* Defined in buffer.c. */
3141 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3142 extern _Noreturn
void nsberror (Lisp_Object
);
3143 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3144 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3145 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3146 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3147 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3148 extern bool overlay_touches_p (ptrdiff_t);
3149 extern Lisp_Object Vbuffer_alist
;
3150 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3151 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3152 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3153 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3154 extern void init_buffer_once (void);
3155 extern void init_buffer (void);
3156 extern void syms_of_buffer (void);
3157 extern void keys_of_buffer (void);
3159 /* Defined in marker.c. */
3161 extern ptrdiff_t marker_position (Lisp_Object
);
3162 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3163 extern void clear_charpos_cache (struct buffer
*);
3164 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3165 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3166 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3167 extern void unchain_marker (struct Lisp_Marker
*marker
);
3168 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3169 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3170 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3171 ptrdiff_t, ptrdiff_t);
3172 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3173 extern void syms_of_marker (void);
3175 /* Defined in fileio.c. */
3177 extern Lisp_Object Qfile_error
;
3178 extern Lisp_Object Qfile_exists_p
;
3179 extern Lisp_Object Qfile_directory_p
;
3180 extern Lisp_Object Qinsert_file_contents
;
3181 extern Lisp_Object Qfile_name_history
;
3182 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3183 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3184 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3185 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3186 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3187 extern void internal_delete_file (Lisp_Object
);
3188 extern void syms_of_fileio (void);
3189 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3190 extern Lisp_Object Qdelete_file
;
3191 extern bool check_existing (const char *);
3193 /* Defined in search.c. */
3194 extern void shrink_regexp_cache (void);
3195 extern void restore_search_regs (void);
3196 extern void record_unwind_save_match_data (void);
3197 struct re_registers
;
3198 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3199 struct re_registers
*,
3200 Lisp_Object
, int, int);
3201 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3202 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3204 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3205 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3206 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3207 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3209 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3211 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3212 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3213 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3214 extern void syms_of_search (void);
3215 extern void clear_regexp_cache (void);
3217 /* Defined in minibuf.c. */
3219 extern Lisp_Object Qcompletion_ignore_case
;
3220 extern Lisp_Object Vminibuffer_list
;
3221 extern Lisp_Object last_minibuf_string
;
3222 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3223 extern void init_minibuf_once (void);
3224 extern void syms_of_minibuf (void);
3226 /* Defined in callint.c. */
3228 extern Lisp_Object Qminus
, Qplus
;
3229 extern Lisp_Object Qwhen
;
3230 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3231 extern void syms_of_callint (void);
3233 /* Defined in casefiddle.c. */
3235 extern Lisp_Object Qidentity
;
3236 extern void syms_of_casefiddle (void);
3237 extern void keys_of_casefiddle (void);
3239 /* Defined in casetab.c. */
3241 extern void init_casetab_once (void);
3242 extern void syms_of_casetab (void);
3244 /* Defined in keyboard.c. */
3246 extern Lisp_Object echo_message_buffer
;
3247 extern struct kboard
*echo_kboard
;
3248 extern void cancel_echoing (void);
3249 extern Lisp_Object Qdisabled
, QCfilter
;
3250 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3251 extern Lisp_Object Qtop
;
3252 extern Lisp_Object last_undo_boundary
;
3253 extern bool input_pending
;
3254 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3255 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3256 extern void discard_mouse_events (void);
3258 void handle_input_available_signal (int);
3260 extern Lisp_Object pending_funcalls
;
3261 extern bool detect_input_pending (void);
3262 extern bool detect_input_pending_ignore_squeezables (void);
3263 extern bool detect_input_pending_run_timers (bool);
3264 extern void safe_run_hooks (Lisp_Object
);
3265 extern void cmd_error_internal (Lisp_Object
, const char *);
3266 extern Lisp_Object
command_loop_1 (void);
3267 extern Lisp_Object
recursive_edit_1 (void);
3268 extern void record_auto_save (void);
3269 extern void force_auto_save_soon (void);
3270 extern void init_keyboard (void);
3271 extern void syms_of_keyboard (void);
3272 extern void keys_of_keyboard (void);
3274 /* Defined in indent.c. */
3275 extern ptrdiff_t current_column (void);
3276 extern void invalidate_current_column (void);
3277 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3278 extern void syms_of_indent (void);
3280 /* Defined in frame.c. */
3281 extern Lisp_Object Qonly
, Qnone
;
3282 extern Lisp_Object Qvisible
;
3283 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3284 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3285 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3287 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3289 extern void frames_discard_buffer (Lisp_Object
);
3290 extern void syms_of_frame (void);
3292 /* Defined in emacs.c. */
3293 extern char **initial_argv
;
3294 extern int initial_argc
;
3295 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3296 extern bool display_arg
;
3298 extern Lisp_Object
decode_env_path (const char *, const char *);
3299 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3300 extern Lisp_Object Qfile_name_handler_alist
;
3301 extern _Noreturn
void terminate_due_to_signal (int, int);
3302 extern Lisp_Object Qkill_emacs
;
3304 extern Lisp_Object Vlibrary_cache
;
3307 void fixup_locale (void);
3308 void synchronize_system_messages_locale (void);
3309 void synchronize_system_time_locale (void);
3311 #define setlocale(category, locale)
3312 #define fixup_locale()
3313 #define synchronize_system_messages_locale()
3314 #define synchronize_system_time_locale()
3316 extern void shut_down_emacs (int, Lisp_Object
);
3318 /* True means don't do interactive redisplay and don't change tty modes. */
3319 extern bool noninteractive
;
3321 /* True means remove site-lisp directories from load-path. */
3322 extern bool no_site_lisp
;
3324 /* Pipe used to send exit notification to the daemon parent at
3326 extern int daemon_pipe
[2];
3327 #define IS_DAEMON (daemon_pipe[1] != 0)
3329 /* True if handling a fatal error already. */
3330 extern bool fatal_error_in_progress
;
3332 /* True means don't do use window-system-specific display code. */
3333 extern bool inhibit_window_system
;
3334 /* True means that a filter or a sentinel is running. */
3335 extern bool running_asynch_code
;
3337 /* Defined in process.c. */
3338 extern Lisp_Object QCtype
, Qlocal
;
3339 extern Lisp_Object Qprocessp
;
3340 extern void kill_buffer_processes (Lisp_Object
);
3341 extern int wait_reading_process_output (intmax_t, int, int, bool,
3343 struct Lisp_Process
*,
3345 /* Max value for the first argument of wait_reading_process_output. */
3346 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3347 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3348 The bug merely causes a bogus warning, but the warning is annoying. */
3349 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3351 # define WAIT_READING_MAX INTMAX_MAX
3353 extern void add_keyboard_wait_descriptor (int);
3354 extern void delete_keyboard_wait_descriptor (int);
3356 extern void add_gpm_wait_descriptor (int);
3357 extern void delete_gpm_wait_descriptor (int);
3359 extern void close_process_descs (void);
3360 extern void init_process_emacs (void);
3361 extern void syms_of_process (void);
3362 extern void setup_process_coding_systems (Lisp_Object
);
3367 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3368 extern void init_callproc_1 (void);
3369 extern void init_callproc (void);
3370 extern void set_initial_environment (void);
3371 extern void syms_of_callproc (void);
3373 /* Defined in doc.c. */
3374 extern Lisp_Object Qfunction_documentation
;
3375 extern Lisp_Object
read_doc_string (Lisp_Object
);
3376 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3377 extern void syms_of_doc (void);
3378 extern int read_bytecode_char (bool);
3380 /* Defined in bytecode.c. */
3381 extern Lisp_Object Qbytecode
;
3382 extern void syms_of_bytecode (void);
3383 extern struct byte_stack
*byte_stack_list
;
3385 extern void mark_byte_stack (void);
3387 extern void unmark_byte_stack (void);
3388 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3389 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3391 /* Defined in macros.c. */
3392 extern Lisp_Object Qexecute_kbd_macro
;
3393 extern void init_macros (void);
3394 extern void syms_of_macros (void);
3396 /* Defined in undo.c. */
3397 extern Lisp_Object Qapply
;
3398 extern Lisp_Object Qinhibit_read_only
;
3399 extern void truncate_undo_list (struct buffer
*);
3400 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3401 extern void record_insert (ptrdiff_t, ptrdiff_t);
3402 extern void record_delete (ptrdiff_t, Lisp_Object
);
3403 extern void record_first_change (void);
3404 extern void record_change (ptrdiff_t, ptrdiff_t);
3405 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3406 Lisp_Object
, Lisp_Object
,
3408 extern void syms_of_undo (void);
3409 /* Defined in textprop.c. */
3410 extern Lisp_Object Qfont
, Qmouse_face
;
3411 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3412 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3413 extern Lisp_Object Qminibuffer_prompt
;
3415 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3417 /* Defined in menu.c. */
3418 extern void syms_of_menu (void);
3420 /* Defined in xmenu.c. */
3421 extern void syms_of_xmenu (void);
3423 /* Defined in termchar.h. */
3424 struct tty_display_info
;
3426 /* Defined in termhooks.h. */
3429 /* Defined in sysdep.c. */
3430 #ifndef HAVE_GET_CURRENT_DIR_NAME
3431 extern char *get_current_dir_name (void);
3433 extern void stuff_char (char c
);
3434 extern void init_foreground_group (void);
3435 extern void init_sigio (int);
3436 extern void sys_subshell (void);
3437 extern void sys_suspend (void);
3438 extern void discard_tty_input (void);
3439 extern void init_sys_modes (struct tty_display_info
*);
3440 extern void reset_sys_modes (struct tty_display_info
*);
3441 extern void init_all_sys_modes (void);
3442 extern void reset_all_sys_modes (void);
3443 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3444 extern void child_setup_tty (int);
3445 extern void setup_pty (int);
3446 extern int set_window_size (int, int, int);
3447 extern EMACS_INT
get_random (void);
3448 extern void seed_random (void *, ptrdiff_t);
3449 extern void init_random (void);
3450 extern void emacs_backtrace (int);
3451 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3452 extern int emacs_open (const char *, int, int);
3453 extern int emacs_close (int);
3454 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3455 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3456 enum { READLINK_BUFSIZE
= 1024 };
3457 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3459 extern void unlock_all_files (void);
3460 extern void lock_file (Lisp_Object
);
3461 extern void unlock_file (Lisp_Object
);
3462 extern void unlock_buffer (struct buffer
*);
3463 extern void syms_of_filelock (void);
3465 /* Defined in sound.c. */
3466 extern void syms_of_sound (void);
3468 /* Defined in category.c. */
3469 extern void init_category_once (void);
3470 extern Lisp_Object
char_category_set (int);
3471 extern void syms_of_category (void);
3473 /* Defined in ccl.c. */
3474 extern void syms_of_ccl (void);
3476 /* Defined in dired.c. */
3477 extern void syms_of_dired (void);
3478 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3479 Lisp_Object
, Lisp_Object
,
3482 /* Defined in term.c. */
3483 extern int *char_ins_del_vector
;
3484 extern void syms_of_term (void);
3485 extern _Noreturn
void fatal (const char *msgid
, ...)
3486 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3488 /* Defined in terminal.c. */
3489 extern void syms_of_terminal (void);
3491 /* Defined in font.c. */
3492 extern void syms_of_font (void);
3493 extern void init_font (void);
3495 #ifdef HAVE_WINDOW_SYSTEM
3496 /* Defined in fontset.c. */
3497 extern void syms_of_fontset (void);
3499 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3500 extern Lisp_Object Qfont_param
;
3503 /* Defined in xfaces.c. */
3504 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3505 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3506 extern Lisp_Object Qmode_line_inactive
;
3507 extern Lisp_Object Qface
;
3508 extern Lisp_Object Qnormal
;
3509 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3510 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3511 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3512 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3513 extern Lisp_Object Qoblique
, Qitalic
;
3514 extern Lisp_Object Vface_alternative_font_family_alist
;
3515 extern Lisp_Object Vface_alternative_font_registry_alist
;
3516 extern void syms_of_xfaces (void);
3518 #ifdef HAVE_X_WINDOWS
3519 /* Defined in xfns.c. */
3520 extern void syms_of_xfns (void);
3522 /* Defined in xsmfns.c. */
3523 extern void syms_of_xsmfns (void);
3525 /* Defined in xselect.c. */
3526 extern void syms_of_xselect (void);
3528 /* Defined in xterm.c. */
3529 extern void syms_of_xterm (void);
3530 #endif /* HAVE_X_WINDOWS */
3532 #ifdef HAVE_WINDOW_SYSTEM
3533 /* Defined in xterm.c, nsterm.m, w32term.c. */
3534 extern char *x_get_keysym_name (int);
3535 #endif /* HAVE_WINDOW_SYSTEM */
3538 /* Defined in xml.c. */
3539 extern void syms_of_xml (void);
3540 extern void xml_cleanup_parser (void);
3544 /* Defined in (x|w32)fns.c, nsfns.m... */
3545 extern int have_menus_p (void);
3549 /* Defined in dbusbind.c. */
3550 void syms_of_dbusbind (void);
3554 /* Defined in profiler.c. */
3555 extern bool profiler_memory_running
;
3556 extern void malloc_probe (size_t);
3557 extern void syms_of_profiler (void);
3561 /* Defined in msdos.c, w32.c. */
3562 extern char *emacs_root_dir (void);
3565 /* True means Emacs has already been initialized.
3566 Used during startup to detect startup of dumped Emacs. */
3567 extern bool initialized
;
3569 /* True means ^G can quit instantly. */
3570 extern bool immediate_quit
;
3572 extern void *xmalloc (size_t);
3573 extern void *xzalloc (size_t);
3574 extern void *xrealloc (void *, size_t);
3575 extern void xfree (void *);
3576 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3577 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3578 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3580 extern char *xstrdup (const char *);
3582 extern char *egetenv (const char *);
3584 /* Set up the name of the machine we're running on. */
3585 extern void init_system_name (void);
3587 /* We used to use `abs', but that clashes with system headers on some
3588 platforms, and using a name reserved by Standard C is a bad idea
3591 #define eabs(x) ((x) < 0 ? -(x) : (x))
3594 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3597 #define make_fixnum_or_float(val) \
3598 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3600 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3601 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3603 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3605 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3606 extern void *record_xmalloc (size_t);
3608 #define USE_SAFE_ALLOCA \
3609 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3611 /* SAFE_ALLOCA allocates a simple buffer. */
3613 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3615 : (sa_must_free = 1, record_xmalloc (size)))
3617 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3618 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3619 positive. The code is tuned for MULTIPLIER being a constant. */
3621 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3623 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3624 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3627 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3629 record_unwind_protect (safe_alloca_unwind, \
3630 make_save_value (buf, 0)); \
3634 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3636 #define SAFE_FREE() \
3638 if (sa_must_free) { \
3640 unbind_to (sa_count, Qnil); \
3645 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3647 #define SAFE_ALLOCA_LISP(buf, nelt) \
3649 if ((nelt) < MAX_ALLOCA / word_size) \
3650 buf = alloca ((nelt) * word_size); \
3651 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3654 buf = xmalloc ((nelt) * word_size); \
3655 arg_ = make_save_value (buf, nelt); \
3656 XSAVE_VALUE (arg_)->dogc = 1; \
3658 record_unwind_protect (safe_alloca_unwind, arg_); \
3661 memory_full (SIZE_MAX); \
3665 #include "globals.h"
3667 /* Check whether it's time for GC, and run it if so. */
3672 if ((consing_since_gc
> gc_cons_threshold
3673 && consing_since_gc
> gc_relative_threshold
)
3674 || (!NILP (Vmemory_full
)
3675 && consing_since_gc
> memory_full_cons_threshold
))
3676 Fgarbage_collect ();
3680 functionp (Lisp_Object object
)
3682 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3684 object
= Findirect_function (object
, Qt
);
3686 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3688 /* Autoloaded symbols are functions, except if they load
3689 macros or keymaps. */
3691 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3692 object
= XCDR (object
);
3694 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3699 return XSUBR (object
)->max_args
!= UNEVALLED
;
3700 else if (COMPILEDP (object
))
3702 else if (CONSP (object
))
3704 Lisp_Object car
= XCAR (object
);
3705 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3713 #endif /* EMACS_LISP_H */