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 Explicit freeing is discouraged for Lisp objects in general. But if
329 you really need to exploit this, use Lisp_Misc (check free_misc in
330 alloc.c to see why). There is no way to free a vectorlike object.
332 To add a new pseudovector type, extend the pvec_type enumeration;
333 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
335 For a Lisp_Misc, you will also need to add your entry to union
336 Lisp_Misc (but make sure the first word has the same structure as
337 the others, starting with a 16-bit member of the Lisp_Misc_Type
338 enumeration and a 1-bit GC markbit) and make sure the overall size
339 of the union is not increased by your addition.
341 For a new pseudovector, it's highly desirable to limit the size
342 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
343 Otherwise you will need to change sweep_vectors (also in alloc.c).
345 Then you will need to add switch branches in print.c (in
346 print_object, to print your object, and possibly also in
347 print_preprocess) and to alloc.c, to mark your object (in
348 mark_object) and to free it (in gc_sweep). The latter is also the
349 right place to call any code specific to your data type that needs
350 to run when the object is recycled -- e.g., free any additional
351 resources allocated for it that are not Lisp objects. You can even
352 make a pointer to the function that frees the resources a slot in
353 your object -- this way, the same object could be used to represent
354 several disparate C structures. */
356 #ifdef CHECK_LISP_OBJECT_TYPE
358 typedef struct { EMACS_INT i
; } Lisp_Object
;
361 LISP_INLINE Lisp_Object
364 Lisp_Object o
= { i
};
368 LISP_INLINE Lisp_Object
369 LISP_MAKE_RVALUE (Lisp_Object o
)
374 #define LISP_INITIALLY_ZERO {0}
376 #undef CHECK_LISP_OBJECT_TYPE
377 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
378 #else /* CHECK_LISP_OBJECT_TYPE */
380 /* If a struct type is not wanted, define Lisp_Object as just a number. */
382 typedef EMACS_INT Lisp_Object
;
385 #define LISP_MAKE_RVALUE(o) (0 + (o))
386 #define LISP_INITIALLY_ZERO 0
387 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
388 #endif /* CHECK_LISP_OBJECT_TYPE */
390 /* In the size word of a vector, this bit means the vector has been marked. */
392 static ptrdiff_t const ARRAY_MARK_FLAG
393 #define ARRAY_MARK_FLAG PTRDIFF_MIN
396 /* In the size word of a struct Lisp_Vector, this bit means it's really
397 some other vector-like object. */
398 static ptrdiff_t const PSEUDOVECTOR_FLAG
399 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
402 /* In a pseudovector, the size field actually contains a word with one
403 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
404 with PVEC_TYPE_MASK to indicate the actual type. */
416 PVEC_WINDOW_CONFIGURATION
,
419 /* These should be last, check internal_equal to see why. */
423 PVEC_FONT
/* Should be last because it's used for range checking. */
426 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
427 which were stored in a Lisp_Object. */
428 #ifndef DATA_SEG_BITS
429 # define DATA_SEG_BITS 0
431 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
436 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
438 /* For convenience, we also store the number of elements in these bits.
439 Note that this size is not necessarily the memory-footprint size, but
440 only the number of Lisp_Object fields (that need to be traced by GC).
441 The distinction is used, e.g., by Lisp_Process, which places extra
442 non-Lisp_Object fields at the end of the structure. */
443 PSEUDOVECTOR_SIZE_BITS
= 12,
444 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
446 /* To calculate the memory footprint of the pseudovector, it's useful
447 to store the size of non-Lisp area in word_size units here. */
448 PSEUDOVECTOR_REST_BITS
= 12,
449 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
450 << PSEUDOVECTOR_SIZE_BITS
),
452 /* Used to extract pseudovector subtype information. */
453 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
454 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
,
456 /* Number of bits to put in each character in the internal representation
457 of bool vectors. This should not vary across implementations. */
458 BOOL_VECTOR_BITS_PER_CHAR
= 8
461 /* These macros extract various sorts of values from a Lisp_Object.
462 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
463 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
469 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
472 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
473 #define XINT(a) (XLI (a) >> INTTYPEBITS)
474 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
475 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
476 #define make_lisp_ptr(ptr, type) \
477 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
478 XIL ((type) | (intptr_t) (ptr)))
480 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
481 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
483 #else /* not USE_LSB_TAG */
485 static EMACS_INT
const VALMASK
486 #define VALMASK VAL_MAX
489 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
491 /* For integers known to be positive, XFASTINT provides fast retrieval
492 and XSETFASTINT provides fast storage. This takes advantage of the
493 fact that Lisp integers have zero-bits in their tags. */
494 #define XFASTINT(a) (XLI (a) + 0)
495 #define XSETFASTINT(a, b) ((a) = XIL (b))
497 /* Extract the value of a Lisp_Object as a (un)signed integer. */
499 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
500 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
501 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
503 #define make_lisp_ptr(ptr, type) \
504 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
505 + ((intptr_t) (ptr) & VALMASK)))
508 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
509 which were stored in a Lisp_Object. */
510 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
512 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
515 #endif /* not USE_LSB_TAG */
517 /* Return a (Lisp-integer sized) hash of the Lisp_Object value. Happens to be
518 like XUINT right now, but XUINT should only be applied to objects we know
520 #define XHASH(a) XUINT (a)
522 /* For integers known to be positive, XFASTINT sometimes provides
523 faster retrieval and XSETFASTINT provides faster storage.
524 If not, fallback on the non-accelerated path. */
526 # define XFASTINT(a) (XINT (a))
527 # define XSETFASTINT(a, b) (XSETINT (a, b))
530 /* Extract the pointer value of the Lisp object A, under the
531 assumption that A's type is TYPE. This is a fallback
532 implementation if nothing faster is available. */
534 # define XUNTAG(a, type) XPNTR (a)
537 #define EQ(x, y) (XLI (x) == XLI (y))
539 /* Largest and smallest representable fixnum values. These are the C
540 values. They are macros for use in static initializers. */
541 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
542 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
544 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
545 written this way so that it also works if I is of unsigned
546 type or if I is a NaN. */
548 #define FIXNUM_OVERFLOW_P(i) \
549 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
551 LISP_INLINE
ptrdiff_t
552 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
554 return num
< lower
? lower
: num
<= upper
? num
: upper
;
557 /* Extract a value or address from a Lisp_Object. */
559 #define XCONS(a) (eassert (CONSP (a)), \
560 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
561 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
562 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
563 #define XSTRING(a) (eassert (STRINGP (a)), \
564 (struct Lisp_String *) XUNTAG (a, Lisp_String))
565 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
566 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
567 #define XFLOAT(a) (eassert (FLOATP (a)), \
568 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
572 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
573 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
574 #define XMISCTYPE(a) (XMISCANY (a)->type)
575 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
576 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
577 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
579 /* Forwarding object types. */
581 #define XFWDTYPE(a) (a->u_intfwd.type)
582 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
583 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
584 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
585 #define XBUFFER_OBJFWD(a) \
586 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
587 #define XKBOARD_OBJFWD(a) \
588 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
590 /* Pseudovector types. */
592 #define XPROCESS(a) (eassert (PROCESSP (a)), \
593 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
594 #define XWINDOW(a) (eassert (WINDOWP (a)), \
595 (struct window *) XUNTAG (a, Lisp_Vectorlike))
596 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
597 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
598 #define XSUBR(a) (eassert (SUBRP (a)), \
599 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
600 #define XBUFFER(a) (eassert (BUFFERP (a)), \
601 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
602 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
603 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
604 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
605 ((struct Lisp_Sub_Char_Table *) \
606 XUNTAG (a, Lisp_Vectorlike)))
607 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
608 ((struct Lisp_Bool_Vector *) \
609 XUNTAG (a, Lisp_Vectorlike)))
611 /* Construct a Lisp_Object from a value or address. */
613 #define XSETINT(a, b) ((a) = make_number (b))
614 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
615 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
616 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
617 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
618 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
622 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
623 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
625 /* Pseudovector types. */
627 #define XSETPVECTYPE(v, code) \
628 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
629 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
630 ((v)->header.size = (PSEUDOVECTOR_FLAG \
631 | ((code) << PSEUDOVECTOR_AREA_BITS) \
632 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
635 /* The cast to struct vectorlike_header * avoids aliasing issues. */
636 #define XSETPSEUDOVECTOR(a, b, code) \
637 XSETTYPED_PSEUDOVECTOR (a, b, \
638 (((struct vectorlike_header *) \
639 XUNTAG (a, Lisp_Vectorlike)) \
642 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
643 (XSETVECTOR (a, b), \
644 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
645 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
647 #define XSETWINDOW_CONFIGURATION(a, b) \
648 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
649 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
650 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
651 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
652 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
653 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
654 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
655 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
656 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
657 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
659 /* Convenience macros for dealing with Lisp arrays. */
661 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
662 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
663 #define ASET(ARRAY, IDX, VAL) \
664 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
665 XVECTOR (ARRAY)->contents[IDX] = (VAL))
667 /* Convenience macros for dealing with Lisp strings. */
669 #define SDATA(string) (XSTRING (string)->data + 0)
670 #define SREF(string, index) (SDATA (string)[index] + 0)
671 #define SSET(string, index, new) (SDATA (string)[index] = (new))
672 #define SCHARS(string) (XSTRING (string)->size + 0)
673 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
675 /* Avoid "differ in sign" warnings. */
676 #define SSDATA(x) ((char *) SDATA (x))
678 #define STRING_SET_CHARS(string, newsize) \
679 (XSTRING (string)->size = (newsize))
681 #define STRING_COPYIN(string, index, new, count) \
682 memcpy (SDATA (string) + index, new, count)
686 #define CHECK_TYPE(ok, Qxxxp, x) \
687 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
689 /* Deprecated and will be removed soon. */
691 #define INTERNAL_FIELD(field) field ## _
693 /* See the macros in intervals.h. */
695 typedef struct interval
*INTERVAL
;
697 /* Complain if object is not string or buffer type. */
698 #define CHECK_STRING_OR_BUFFER(x) \
699 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
703 /* Car of this cons cell. */
708 /* Cdr of this cons cell. */
711 /* Used to chain conses on a free list. */
712 struct Lisp_Cons
*chain
;
716 /* Take the car or cdr of something known to be a cons cell. */
717 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
718 of code that has to know what a cons cell looks like. Other code not
719 part of the basic lisp implementation should assume that the car and cdr
720 fields are not accessible as lvalues. (What if we want to switch to
721 a copying collector someday? Cached cons cell field addresses may be
722 invalidated at arbitrary points.) */
723 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
724 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
726 /* Use these from normal code. */
727 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
728 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
730 /* Use these to set the fields of a cons cell.
732 Note that both arguments may refer to the same object, so 'n'
733 should not be read after 'c' is first modified. Also, neither
734 argument should be evaluated more than once; side effects are
735 especially common in the second argument. */
736 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
737 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
739 /* Take the car or cdr of something whose type is not known. */
741 (CONSP ((c)) ? XCAR ((c)) \
742 : NILP ((c)) ? Qnil \
743 : wrong_type_argument (Qlistp, (c)))
746 (CONSP ((c)) ? XCDR ((c)) \
747 : NILP ((c)) ? Qnil \
748 : wrong_type_argument (Qlistp, (c)))
750 /* Take the car or cdr of something whose type is not known. */
751 #define CAR_SAFE(c) \
752 (CONSP ((c)) ? XCAR ((c)) : Qnil)
754 #define CDR_SAFE(c) \
755 (CONSP ((c)) ? XCDR ((c)) : Qnil)
757 /* True if STR is a multibyte string. */
758 #define STRING_MULTIBYTE(STR) \
759 (XSTRING (STR)->size_byte >= 0)
761 /* Return the length in bytes of STR. */
763 #ifdef GC_CHECK_STRING_BYTES
766 extern ptrdiff_t string_bytes (struct Lisp_String
*);
767 #define STRING_BYTES(S) string_bytes ((S))
769 #else /* not GC_CHECK_STRING_BYTES */
771 #define STRING_BYTES(STR) \
772 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
774 #endif /* not GC_CHECK_STRING_BYTES */
776 /* An upper bound on the number of bytes in a Lisp string, not
777 counting the terminating null. This a tight enough bound to
778 prevent integer overflow errors that would otherwise occur during
779 string size calculations. A string cannot contain more bytes than
780 a fixnum can represent, nor can it be so long that C pointer
781 arithmetic stops working on the string plus its terminating null.
782 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
783 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
784 would expose alloc.c internal details that we'd rather keep
787 This is a macro for use in static initializers, and a constant for
788 visibility to GDB. The cast to ptrdiff_t ensures that
789 the macro is signed. */
790 static ptrdiff_t const STRING_BYTES_BOUND
=
791 #define STRING_BYTES_BOUND \
792 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
795 /* Mark STR as a unibyte string. */
796 #define STRING_SET_UNIBYTE(STR) \
797 do { if (EQ (STR, empty_multibyte_string)) \
798 (STR) = empty_unibyte_string; \
799 else XSTRING (STR)->size_byte = -1; } while (0)
801 /* Mark STR as a multibyte string. Assure that STR contains only
802 ASCII characters in advance. */
803 #define STRING_SET_MULTIBYTE(STR) \
804 do { if (EQ (STR, empty_unibyte_string)) \
805 (STR) = empty_multibyte_string; \
806 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
808 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
814 INTERVAL intervals
; /* Text properties in this string. */
818 /* Header of vector-like objects. This documents the layout constraints on
819 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
820 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
821 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
822 because when two such pointers potentially alias, a compiler won't
823 incorrectly reorder loads and stores to their size fields. See
824 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
825 struct vectorlike_header
827 /* The only field contains various pieces of information:
828 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
829 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
830 vector (0) or a pseudovector (1).
831 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
832 of slots) of the vector.
833 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
834 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
835 - b) number of Lisp_Objects slots at the beginning of the object
836 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
838 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
839 measured in word_size units. Rest fields may also include
840 Lisp_Objects, but these objects usually needs some special treatment
842 There are some exceptions. For PVEC_FREE, b) is always zero. For
843 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
844 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
845 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
849 /* Regular vector is just a header plus array of Lisp_Objects. */
853 struct vectorlike_header header
;
854 Lisp_Object contents
[1];
857 /* A boolvector is a kind of vectorlike, with contents are like a string. */
859 struct Lisp_Bool_Vector
861 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
862 just the subtype information. */
863 struct vectorlike_header header
;
864 /* This is the size in bits. */
866 /* This contains the actual bits, packed into bytes. */
867 unsigned char data
[1];
870 /* Some handy constants for calculating sizes
871 and offsets, mostly of vectorlike objects. */
875 header_size
= offsetof (struct Lisp_Vector
, contents
),
876 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
877 word_size
= sizeof (Lisp_Object
)
880 /* If a struct is made to look like a vector, this macro returns the length
881 of the shortest vector that would hold that struct. */
883 #define VECSIZE(type) \
884 ((sizeof (type) - header_size + word_size - 1) / word_size)
886 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
887 at the end and we need to compute the number of Lisp_Object fields (the
888 ones that the GC needs to trace). */
890 #define PSEUDOVECSIZE(type, nonlispfield) \
891 ((offsetof (type, nonlispfield) - header_size) / word_size)
893 /* A char-table is a kind of vectorlike, with contents are like a
894 vector but with a few other slots. For some purposes, it makes
895 sense to handle a char-table with type struct Lisp_Vector. An
896 element of a char table can be any Lisp objects, but if it is a sub
897 char-table, we treat it a table that contains information of a
898 specific range of characters. A sub char-table has the same
899 structure as a vector. A sub char table appears only in an element
900 of a char-table, and there's no way to access it directly from
901 Emacs Lisp program. */
905 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
906 ({struct Lisp_Char_Table *_tbl = NULL; \
909 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
910 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
911 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
913 _val = _tbl->defalt; \
914 } while (NILP (_val) && ! NILP (_tbl->parent)); \
917 #else /* not __GNUC__ */
919 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
920 (! NILP (XCHAR_TABLE (CT)->ascii) \
921 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
922 ? XCHAR_TABLE (CT)->ascii \
923 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
924 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
925 : char_table_ref ((CT), (IDX))) \
926 : char_table_ref ((CT), (IDX)))
928 #endif /* not __GNUC__ */
930 /* Compute A OP B, using the unsigned comparison operator OP. A and B
931 should be integer expressions. This is not the same as
932 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
933 returns 1. For efficiency, prefer plain unsigned comparison if A
934 and B's sizes both fit (after integer promotion). */
935 #define UNSIGNED_CMP(a, op, b) \
936 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
937 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
938 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
940 /* Nonzero iff C is an ASCII character. */
941 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
943 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
944 characters. Do not check validity of CT. */
945 #define CHAR_TABLE_REF(CT, IDX) \
946 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
947 : char_table_ref ((CT), (IDX)))
949 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
950 8-bit European characters. Do not check validity of CT. */
951 #define CHAR_TABLE_SET(CT, IDX, VAL) \
952 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
953 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
954 : char_table_set (CT, IDX, VAL))
956 enum CHARTAB_SIZE_BITS
958 CHARTAB_SIZE_BITS_0
= 6,
959 CHARTAB_SIZE_BITS_1
= 4,
960 CHARTAB_SIZE_BITS_2
= 5,
961 CHARTAB_SIZE_BITS_3
= 7
964 extern const int chartab_size
[4];
966 struct Lisp_Char_Table
968 /* HEADER.SIZE is the vector's size field, which also holds the
969 pseudovector type information. It holds the size, too.
970 The size counts the defalt, parent, purpose, ascii,
971 contents, and extras slots. */
972 struct vectorlike_header header
;
974 /* This holds a default value,
975 which is used whenever the value for a specific character is nil. */
978 /* This points to another char table, which we inherit from when the
979 value for a specific character is nil. The `defalt' slot takes
980 precedence over this. */
983 /* This is a symbol which says what kind of use this char-table is
987 /* The bottom sub char-table for characters of the range 0..127. It
988 is nil if none of ASCII character has a specific value. */
991 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
993 /* These hold additional data. It is a vector. */
994 Lisp_Object extras
[1];
997 struct Lisp_Sub_Char_Table
999 /* HEADER.SIZE is the vector's size field, which also holds the
1000 pseudovector type information. It holds the size, too. */
1001 struct vectorlike_header header
;
1003 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1004 char-table of depth 1 contains 16 elements, and each element
1005 covers 4096 (128*32) characters. A sub char-table of depth 2
1006 contains 32 elements, and each element covers 128 characters. A
1007 sub char-table of depth 3 contains 128 elements, and each element
1008 is for one character. */
1011 /* Minimum character covered by the sub char-table. */
1012 Lisp_Object min_char
;
1014 /* Use set_sub_char_table_contents to set this. */
1015 Lisp_Object contents
[1];
1018 /* This structure describes a built-in function.
1019 It is generated by the DEFUN macro only.
1020 defsubr makes it into a Lisp object. */
1024 struct vectorlike_header header
;
1026 Lisp_Object (*a0
) (void);
1027 Lisp_Object (*a1
) (Lisp_Object
);
1028 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1029 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1030 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1031 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1032 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1033 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1034 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1035 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1036 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1038 short min_args
, max_args
;
1039 const char *symbol_name
;
1040 const char *intspec
;
1044 /* This is the number of slots that every char table must have. This
1045 counts the ordinary slots and the top, defalt, parent, and purpose
1047 enum CHAR_TABLE_STANDARD_SLOTS
1049 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1052 /* Return the number of "extra" slots in the char table CT. */
1054 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1055 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1058 /***********************************************************************
1060 ***********************************************************************/
1062 /* Interned state of a symbol. */
1064 enum symbol_interned
1066 SYMBOL_UNINTERNED
= 0,
1067 SYMBOL_INTERNED
= 1,
1068 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1071 enum symbol_redirect
1073 SYMBOL_PLAINVAL
= 4,
1074 SYMBOL_VARALIAS
= 1,
1075 SYMBOL_LOCALIZED
= 2,
1076 SYMBOL_FORWARDED
= 3
1081 unsigned gcmarkbit
: 1;
1083 /* Indicates where the value can be found:
1084 0 : it's a plain var, the value is in the `value' field.
1085 1 : it's a varalias, the value is really in the `alias' symbol.
1086 2 : it's a localized var, the value is in the `blv' object.
1087 3 : it's a forwarding variable, the value is in `forward'. */
1088 ENUM_BF (symbol_redirect
) redirect
: 3;
1090 /* Non-zero means symbol is constant, i.e. changing its value
1091 should signal an error. If the value is 3, then the var
1092 can be changed, but only by `defconst'. */
1093 unsigned constant
: 2;
1095 /* Interned state of the symbol. This is an enumerator from
1096 enum symbol_interned. */
1097 unsigned interned
: 2;
1099 /* Non-zero means that this variable has been explicitly declared
1100 special (with `defvar' etc), and shouldn't be lexically bound. */
1101 unsigned declared_special
: 1;
1103 /* The symbol's name, as a Lisp string. */
1106 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1107 union is used depends on the `redirect' field above. */
1110 struct Lisp_Symbol
*alias
;
1111 struct Lisp_Buffer_Local_Value
*blv
;
1112 union Lisp_Fwd
*fwd
;
1115 /* Function value of the symbol or Qnil if not fboundp. */
1116 Lisp_Object function
;
1118 /* The symbol's property list. */
1121 /* Next symbol in obarray bucket, if the symbol is interned. */
1122 struct Lisp_Symbol
*next
;
1125 /* Value is name of symbol. */
1127 #define SYMBOL_VAL(sym) \
1128 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1129 #define SYMBOL_ALIAS(sym) \
1130 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1131 #define SYMBOL_BLV(sym) \
1132 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1133 #define SYMBOL_FWD(sym) \
1134 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1135 #define SET_SYMBOL_VAL(sym, v) \
1136 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1137 #define SET_SYMBOL_ALIAS(sym, v) \
1138 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1139 #define SET_SYMBOL_BLV(sym, v) \
1140 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1141 #define SET_SYMBOL_FWD(sym, v) \
1142 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1144 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1146 /* Value is non-zero if SYM is an interned symbol. */
1148 #define SYMBOL_INTERNED_P(sym) \
1149 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1151 /* Value is non-zero if SYM is interned in initial_obarray. */
1153 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1154 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1156 /* Value is non-zero if symbol is considered a constant, i.e. its
1157 value cannot be changed (there is an exception for keyword symbols,
1158 whose value can be set to the keyword symbol itself). */
1160 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1162 #define DEFSYM(sym, name) \
1163 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1166 /***********************************************************************
1168 ***********************************************************************/
1170 /* The structure of a Lisp hash table. */
1172 struct hash_table_test
1174 /* Name of the function used to compare keys. */
1177 /* User-supplied hash function, or nil. */
1178 Lisp_Object user_hash_function
;
1180 /* User-supplied key comparison function, or nil. */
1181 Lisp_Object user_cmp_function
;
1183 /* C function to compare two keys. */
1184 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1186 /* C function to compute hash code. */
1187 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1190 struct Lisp_Hash_Table
1192 /* This is for Lisp; the hash table code does not refer to it. */
1193 struct vectorlike_header header
;
1195 /* Nil if table is non-weak. Otherwise a symbol describing the
1196 weakness of the table. */
1199 /* When the table is resized, and this is an integer, compute the
1200 new size by adding this to the old size. If a float, compute the
1201 new size by multiplying the old size with this factor. */
1202 Lisp_Object rehash_size
;
1204 /* Resize hash table when number of entries/ table size is >= this
1206 Lisp_Object rehash_threshold
;
1208 /* Vector of hash codes.. If hash[I] is nil, this means that that
1209 entry I is unused. */
1212 /* Vector used to chain entries. If entry I is free, next[I] is the
1213 entry number of the next free item. If entry I is non-free,
1214 next[I] is the index of the next entry in the collision chain. */
1217 /* Index of first free entry in free list. */
1218 Lisp_Object next_free
;
1220 /* Bucket vector. A non-nil entry is the index of the first item in
1221 a collision chain. This vector's size can be larger than the
1222 hash table size to reduce collisions. */
1225 /* Only the fields above are traced normally by the GC. The ones below
1226 `count' are special and are either ignored by the GC or traced in
1227 a special way (e.g. because of weakness). */
1229 /* Number of key/value entries in the table. */
1232 /* Vector of keys and values. The key of item I is found at index
1233 2 * I, the value is found at index 2 * I + 1.
1234 This is gc_marked specially if the table is weak. */
1235 Lisp_Object key_and_value
;
1237 /* The comparison and hash functions. */
1238 struct hash_table_test test
;
1240 /* Next weak hash table if this is a weak hash table. The head
1241 of the list is in weak_hash_tables. */
1242 struct Lisp_Hash_Table
*next_weak
;
1246 #define XHASH_TABLE(OBJ) \
1247 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1249 #define XSET_HASH_TABLE(VAR, PTR) \
1250 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1252 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1254 #define CHECK_HASH_TABLE(x) \
1255 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1257 /* Value is the key part of entry IDX in hash table H. */
1259 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1261 /* Value is the value part of entry IDX in hash table H. */
1263 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1265 /* Value is the index of the next entry following the one at IDX
1268 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1270 /* Value is the hash code computed for entry IDX in hash table H. */
1272 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1274 /* Value is the index of the element in hash table H that is the
1275 start of the collision list at index IDX in the index vector of H. */
1277 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1279 /* Value is the size of hash table H. */
1281 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1283 /* Default size for hash tables if not specified. */
1285 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1287 /* Default threshold specifying when to resize a hash table. The
1288 value gives the ratio of current entries in the hash table and the
1289 size of the hash table. */
1291 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1293 /* Default factor by which to increase the size of a hash table. */
1295 static double const DEFAULT_REHASH_SIZE
= 1.5;
1297 /* Combine two integers X and Y for hashing. The result might not fit
1298 into a Lisp integer. */
1300 LISP_INLINE EMACS_UINT
1301 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1303 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1306 /* These structures are used for various misc types. */
1308 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1310 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1311 unsigned gcmarkbit
: 1;
1317 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1318 unsigned gcmarkbit
: 1;
1320 /* This flag is temporarily used in the functions
1321 decode/encode_coding_object to record that the marker position
1322 must be adjusted after the conversion. */
1323 unsigned int need_adjustment
: 1;
1324 /* 1 means normal insertion at the marker's position
1325 leaves the marker after the inserted text. */
1326 unsigned int insertion_type
: 1;
1327 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1328 Note: a chain of markers can contain markers pointing into different
1329 buffers (the chain is per buffer_text rather than per buffer, so it's
1330 shared between indirect buffers). */
1331 /* This is used for (other than NULL-checking):
1333 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1334 - unchain_marker: to find the list from which to unchain.
1335 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1337 struct buffer
*buffer
;
1339 /* The remaining fields are meaningless in a marker that
1340 does not point anywhere. */
1342 /* For markers that point somewhere,
1343 this is used to chain of all the markers in a given buffer. */
1344 /* We could remove it and use an array in buffer_text instead.
1345 That would also allow to preserve it ordered. */
1346 struct Lisp_Marker
*next
;
1347 /* This is the char position where the marker points. */
1349 /* This is the byte position.
1350 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1351 used to implement the functionality of markers, but rather to (ab)use
1352 markers as a cache for char<->byte mappings). */
1356 /* START and END are markers in the overlay's buffer, and
1357 PLIST is the overlay's property list. */
1359 /* An overlay's real data content is:
1361 - buffer (really there are two buffer pointers, one per marker,
1362 and both points to the same buffer)
1363 - insertion type of both ends (per-marker fields)
1364 - start & start byte (of start marker)
1365 - end & end byte (of end marker)
1366 - next (singly linked list of overlays)
1367 - next fields of start and end markers (singly linked list of markers).
1368 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1371 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1372 unsigned gcmarkbit
: 1;
1374 struct Lisp_Overlay
*next
;
1380 /* Hold a C pointer for later use.
1381 This type of object is used in the arg to record_unwind_protect. */
1382 struct Lisp_Save_Value
1384 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1385 unsigned gcmarkbit
: 1;
1387 /* If DOGC is set, POINTER is the address of a memory
1388 area containing INTEGER potential Lisp_Objects. */
1389 unsigned int dogc
: 1;
1395 /* A miscellaneous object, when it's on the free list. */
1398 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1399 unsigned gcmarkbit
: 1;
1401 union Lisp_Misc
*chain
;
1404 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1405 It uses one of these struct subtypes to get the type field. */
1409 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1410 struct Lisp_Free u_free
;
1411 struct Lisp_Marker u_marker
;
1412 struct Lisp_Overlay u_overlay
;
1413 struct Lisp_Save_Value u_save_value
;
1416 /* Forwarding pointer to an int variable.
1417 This is allowed only in the value cell of a symbol,
1418 and it means that the symbol's value really lives in the
1419 specified int variable. */
1422 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1426 /* Boolean forwarding pointer to an int variable.
1427 This is like Lisp_Intfwd except that the ostensible
1428 "value" of the symbol is t if the int variable is nonzero,
1429 nil if it is zero. */
1432 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1436 /* Forwarding pointer to a Lisp_Object variable.
1437 This is allowed only in the value cell of a symbol,
1438 and it means that the symbol's value really lives in the
1439 specified variable. */
1442 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1443 Lisp_Object
*objvar
;
1446 /* Like Lisp_Objfwd except that value lives in a slot in the
1447 current buffer. Value is byte index of slot within buffer. */
1448 struct Lisp_Buffer_Objfwd
1450 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1452 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1455 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1456 the symbol has buffer-local or frame-local bindings. (Exception:
1457 some buffer-local variables are built-in, with their values stored
1458 in the buffer structure itself. They are handled differently,
1459 using struct Lisp_Buffer_Objfwd.)
1461 The `realvalue' slot holds the variable's current value, or a
1462 forwarding pointer to where that value is kept. This value is the
1463 one that corresponds to the loaded binding. To read or set the
1464 variable, you must first make sure the right binding is loaded;
1465 then you can access the value in (or through) `realvalue'.
1467 `buffer' and `frame' are the buffer and frame for which the loaded
1468 binding was found. If those have changed, to make sure the right
1469 binding is loaded it is necessary to find which binding goes with
1470 the current buffer and selected frame, then load it. To load it,
1471 first unload the previous binding, then copy the value of the new
1472 binding into `realvalue' (or through it). Also update
1473 LOADED-BINDING to point to the newly loaded binding.
1475 `local_if_set' indicates that merely setting the variable creates a
1476 local binding for the current buffer. Otherwise the latter, setting
1477 the variable does not do that; only make-local-variable does that. */
1479 struct Lisp_Buffer_Local_Value
1481 /* 1 means that merely setting the variable creates a local
1482 binding for the current buffer. */
1483 unsigned int local_if_set
: 1;
1484 /* 1 means this variable can have frame-local bindings, otherwise, it is
1485 can have buffer-local bindings. The two cannot be combined. */
1486 unsigned int frame_local
: 1;
1487 /* 1 means that the binding now loaded was found.
1488 Presumably equivalent to (defcell!=valcell). */
1489 unsigned int found
: 1;
1490 /* If non-NULL, a forwarding to the C var where it should also be set. */
1491 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1492 /* The buffer or frame for which the loaded binding was found. */
1494 /* A cons cell that holds the default value. It has the form
1495 (SYMBOL . DEFAULT-VALUE). */
1496 Lisp_Object defcell
;
1497 /* The cons cell from `where's parameter alist.
1498 It always has the form (SYMBOL . VALUE)
1499 Note that if `forward' is non-nil, VALUE may be out of date.
1500 Also if the currently loaded binding is the default binding, then
1501 this is `eq'ual to defcell. */
1502 Lisp_Object valcell
;
1505 /* Like Lisp_Objfwd except that value lives in a slot in the
1507 struct Lisp_Kboard_Objfwd
1509 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1515 struct Lisp_Intfwd u_intfwd
;
1516 struct Lisp_Boolfwd u_boolfwd
;
1517 struct Lisp_Objfwd u_objfwd
;
1518 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1519 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1522 /* Lisp floating point type. */
1528 struct Lisp_Float
*chain
;
1532 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1533 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1535 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1536 representations, have infinities and NaNs, and do not trap on
1537 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1538 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1539 wanted here, but is not quite right because Emacs does not require
1540 all the features of C11 Annex F (and does not require C11 at all,
1541 for that matter). */
1542 #define IEEE_FLOATING_POINT (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
1543 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
1545 /* A character, declared with the following typedef, is a member
1546 of some character set associated with the current buffer. */
1547 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1549 typedef unsigned char UCHAR
;
1552 /* Meanings of slots in a Lisp_Compiled: */
1556 COMPILED_ARGLIST
= 0,
1557 COMPILED_BYTECODE
= 1,
1558 COMPILED_CONSTANTS
= 2,
1559 COMPILED_STACK_DEPTH
= 3,
1560 COMPILED_DOC_STRING
= 4,
1561 COMPILED_INTERACTIVE
= 5
1564 /* Flag bits in a character. These also get used in termhooks.h.
1565 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1566 (MUlti-Lingual Emacs) might need 22 bits for the character value
1567 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1570 CHAR_ALT
= 0x0400000,
1571 CHAR_SUPER
= 0x0800000,
1572 CHAR_HYPER
= 0x1000000,
1573 CHAR_SHIFT
= 0x2000000,
1574 CHAR_CTL
= 0x4000000,
1575 CHAR_META
= 0x8000000,
1577 CHAR_MODIFIER_MASK
=
1578 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1580 /* Actually, the current Emacs uses 22 bits for the character value
1588 /* The glyph datatype, used to represent characters on the display.
1589 It consists of a char code and a face id. */
1596 /* Return a glyph's character code. */
1597 #define GLYPH_CHAR(glyph) ((glyph).ch)
1599 /* Return a glyph's face ID. */
1600 #define GLYPH_FACE(glyph) ((glyph).face_id)
1602 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1603 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1604 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1606 /* Return 1 if GLYPH contains valid character code. */
1607 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1610 /* Glyph Code from a display vector may either be an integer which
1611 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1612 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1614 #define GLYPH_CODE_P(gc) \
1616 ? (CHARACTERP (XCAR (gc)) \
1617 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1618 : (RANGED_INTEGERP \
1620 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1621 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1622 : TYPE_MAXIMUM (EMACS_INT)))))
1624 /* The following are valid only if GLYPH_CODE_P (gc). */
1626 #define GLYPH_CODE_CHAR(gc) \
1627 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1629 #define GLYPH_CODE_FACE(gc) \
1630 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1632 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1636 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1638 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1639 (XINT (gc) >> CHARACTERBITS)); \
1643 /* Structure to hold mouse highlight data. This is here because other
1644 header files need it for defining struct x_output etc. */
1646 /* These variables describe the range of text currently shown in its
1647 mouse-face, together with the window they apply to. As long as
1648 the mouse stays within this range, we need not redraw anything on
1649 its account. Rows and columns are glyph matrix positions in
1650 MOUSE_FACE_WINDOW. */
1651 int mouse_face_beg_row
, mouse_face_beg_col
;
1652 int mouse_face_beg_x
, mouse_face_beg_y
;
1653 int mouse_face_end_row
, mouse_face_end_col
;
1654 int mouse_face_end_x
, mouse_face_end_y
;
1655 Lisp_Object mouse_face_window
;
1656 int mouse_face_face_id
;
1657 Lisp_Object mouse_face_overlay
;
1659 /* FRAME and X, Y position of mouse when last checked for
1660 highlighting. X and Y can be negative or out of range for the frame. */
1661 struct frame
*mouse_face_mouse_frame
;
1662 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1664 /* Nonzero if part of the text currently shown in
1665 its mouse-face is beyond the window end. */
1666 unsigned mouse_face_past_end
: 1;
1668 /* Nonzero means defer mouse-motion highlighting. */
1669 unsigned mouse_face_defer
: 1;
1671 /* Nonzero means that the mouse highlight should not be shown. */
1672 unsigned mouse_face_hidden
: 1;
1675 /* Data type checking. */
1677 #define NILP(x) EQ (x, Qnil)
1679 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1680 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1682 #define RANGED_INTEGERP(lo, x, hi) \
1683 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1684 #define TYPE_RANGED_INTEGERP(type, x) \
1685 (TYPE_SIGNED (type) \
1686 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1687 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1689 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1690 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1691 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1692 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1693 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1694 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1696 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1697 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1698 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1699 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1700 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1702 #define AUTOLOADP(x) (CONSP (x) && EQ (Qautoload, XCAR (x)))
1704 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1705 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1706 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1707 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1708 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1710 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1711 vectorlike_header * avoids aliasing issues. */
1712 #define PSEUDOVECTORP(x, code) \
1713 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1715 #define PSEUDOVECTOR_TYPEP(v, code) \
1716 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1717 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS)))
1719 /* True if object X, with internal type struct T *, is a pseudovector whose
1721 #define TYPED_PSEUDOVECTORP(x, t, code) \
1723 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1725 /* Test for specific pseudovector types. */
1726 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1727 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1728 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1729 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1730 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1731 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1732 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1733 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1734 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1735 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1736 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1738 /* Test for image (image . spec) */
1739 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1744 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1746 #define CHECK_LIST(x) \
1747 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1749 #define CHECK_LIST_CONS(x, y) \
1750 CHECK_TYPE (CONSP (x), Qlistp, y)
1752 #define CHECK_LIST_END(x, y) \
1753 CHECK_TYPE (NILP (x), Qlistp, y)
1755 #define CHECK_STRING(x) \
1756 CHECK_TYPE (STRINGP (x), Qstringp, x)
1758 #define CHECK_STRING_CAR(x) \
1759 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1761 #define CHECK_CONS(x) \
1762 CHECK_TYPE (CONSP (x), Qconsp, x)
1764 #define CHECK_SYMBOL(x) \
1765 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1767 #define CHECK_CHAR_TABLE(x) \
1768 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1770 #define CHECK_VECTOR(x) \
1771 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1773 #define CHECK_VECTOR_OR_STRING(x) \
1774 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1776 #define CHECK_ARRAY(x, Qxxxp) \
1777 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1779 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1780 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1782 #define CHECK_BUFFER(x) \
1783 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1785 #define CHECK_WINDOW(x) \
1786 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1788 #define CHECK_WINDOW_CONFIGURATION(x) \
1789 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1791 #define CHECK_PROCESS(x) \
1792 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1794 #define CHECK_SUBR(x) \
1795 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1797 #define CHECK_NUMBER(x) \
1798 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1800 #define CHECK_NATNUM(x) \
1801 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1803 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1806 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1807 args_out_of_range_3 \
1809 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1810 ? MOST_NEGATIVE_FIXNUM \
1812 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1814 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1816 if (TYPE_SIGNED (type)) \
1817 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1819 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1822 #define CHECK_MARKER(x) \
1823 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1825 #define CHECK_NUMBER_COERCE_MARKER(x) \
1826 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1827 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1829 #define XFLOATINT(n) extract_float((n))
1831 #define CHECK_FLOAT(x) \
1832 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1834 #define CHECK_NUMBER_OR_FLOAT(x) \
1835 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1837 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1838 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1839 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1841 #define CHECK_OVERLAY(x) \
1842 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1844 /* Since we can't assign directly to the CAR or CDR fields of a cons
1845 cell, use these when checking that those fields contain numbers. */
1846 #define CHECK_NUMBER_CAR(x) \
1848 Lisp_Object tmp = XCAR (x); \
1849 CHECK_NUMBER (tmp); \
1850 XSETCAR ((x), tmp); \
1853 #define CHECK_NUMBER_CDR(x) \
1855 Lisp_Object tmp = XCDR (x); \
1856 CHECK_NUMBER (tmp); \
1857 XSETCDR ((x), tmp); \
1860 #define CHECK_NATNUM_CAR(x) \
1862 Lisp_Object tmp = XCAR (x); \
1863 CHECK_NATNUM (tmp); \
1864 XSETCAR ((x), tmp); \
1867 #define CHECK_NATNUM_CDR(x) \
1869 Lisp_Object tmp = XCDR (x); \
1870 CHECK_NATNUM (tmp); \
1871 XSETCDR ((x), tmp); \
1874 /* Define a built-in function for calling from Lisp.
1875 `lname' should be the name to give the function in Lisp,
1876 as a null-terminated C string.
1877 `fnname' should be the name of the function in C.
1878 By convention, it starts with F.
1879 `sname' should be the name for the C constant structure
1880 that records information on this function for internal use.
1881 By convention, it should be the same as `fnname' but with S instead of F.
1882 It's too bad that C macros can't compute this from `fnname'.
1883 `minargs' should be a number, the minimum number of arguments allowed.
1884 `maxargs' should be a number, the maximum number of arguments allowed,
1885 or else MANY or UNEVALLED.
1886 MANY means pass a vector of evaluated arguments,
1887 in the form of an integer number-of-arguments
1888 followed by the address of a vector of Lisp_Objects
1889 which contains the argument values.
1890 UNEVALLED means pass the list of unevaluated arguments
1891 `intspec' says how interactive arguments are to be fetched.
1892 If the string starts with a `(', `intspec' is evaluated and the resulting
1893 list is the list of arguments.
1894 If it's a string that doesn't start with `(', the value should follow
1895 the one of the doc string for `interactive'.
1896 A null string means call interactively with no arguments.
1897 `doc' is documentation for the user. */
1899 /* This version of DEFUN declares a function prototype with the right
1900 arguments, so we can catch errors with maxargs at compile-time. */
1902 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1903 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1904 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1905 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
1906 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
1907 { (Lisp_Object (__cdecl *)(void))fnname }, \
1908 minargs, maxargs, lname, intspec, 0}; \
1910 #else /* not _MSC_VER */
1911 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1912 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1913 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1914 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
1915 { .a ## maxargs = fnname }, \
1916 minargs, maxargs, lname, intspec, 0}; \
1920 /* Note that the weird token-substitution semantics of ANSI C makes
1921 this work for MANY and UNEVALLED. */
1922 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1923 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1924 #define DEFUN_ARGS_0 (void)
1925 #define DEFUN_ARGS_1 (Lisp_Object)
1926 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1927 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1928 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1929 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1931 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1932 Lisp_Object, Lisp_Object)
1933 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1934 Lisp_Object, Lisp_Object, Lisp_Object)
1935 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1936 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1938 /* Non-zero if OBJ is a Lisp function. */
1939 #define FUNCTIONP(OBJ) functionp(OBJ)
1942 is how we define the symbol for function `name' at start-up time. */
1943 extern void defsubr (struct Lisp_Subr
*);
1951 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1952 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1953 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1954 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1955 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1957 /* Macros we use to define forwarded Lisp variables.
1958 These are used in the syms_of_FILENAME functions.
1960 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1961 lisp variable is actually a field in `struct emacs_globals'. The
1962 field's name begins with "f_", which is a convention enforced by
1963 these macros. Each such global has a corresponding #define in
1964 globals.h; the plain name should be used in the code.
1966 E.g., the global "cons_cells_consed" is declared as "int
1967 f_cons_cells_consed" in globals.h, but there is a define:
1969 #define cons_cells_consed globals.f_cons_cells_consed
1971 All C code uses the `cons_cells_consed' name. This is all done
1972 this way to support indirection for multi-threaded Emacs. */
1974 #define DEFVAR_LISP(lname, vname, doc) \
1976 static struct Lisp_Objfwd o_fwd; \
1977 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1979 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1981 static struct Lisp_Objfwd o_fwd; \
1982 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1984 #define DEFVAR_BOOL(lname, vname, doc) \
1986 static struct Lisp_Boolfwd b_fwd; \
1987 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1989 #define DEFVAR_INT(lname, vname, doc) \
1991 static struct Lisp_Intfwd i_fwd; \
1992 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1995 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1997 static struct Lisp_Objfwd o_fwd; \
1998 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2001 #define DEFVAR_KBOARD(lname, vname, doc) \
2003 static struct Lisp_Kboard_Objfwd ko_fwd; \
2004 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2007 /* Save and restore the instruction and environment pointers,
2008 without affecting the signal mask. */
2011 typedef jmp_buf sys_jmp_buf
;
2012 # define sys_setjmp(j) _setjmp (j)
2013 # define sys_longjmp(j, v) _longjmp (j, v)
2014 #elif defined HAVE_SIGSETJMP
2015 typedef sigjmp_buf sys_jmp_buf
;
2016 # define sys_setjmp(j) sigsetjmp (j, 0)
2017 # define sys_longjmp(j, v) siglongjmp (j, v)
2019 /* A platform that uses neither _longjmp nor siglongjmp; assume
2020 longjmp does not affect the sigmask. */
2021 typedef jmp_buf sys_jmp_buf
;
2022 # define sys_setjmp(j) setjmp (j)
2023 # define sys_longjmp(j, v) longjmp (j, v)
2027 /* Structure for recording Lisp call stack for backtrace purposes. */
2029 /* The special binding stack holds the outer values of variables while
2030 they are bound by a function application or a let form, stores the
2031 code to be executed for Lisp unwind-protect forms, and stores the C
2032 functions to be called for record_unwind_protect.
2034 If func is non-zero, undoing this binding applies func to old_value;
2035 This implements record_unwind_protect.
2037 Otherwise, the element is a variable binding.
2039 If the symbol field is a symbol, it is an ordinary variable binding.
2041 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2042 which means having bound a local value while CURRENT-BUFFER was active.
2043 If WHERE is nil this means we saw the default value when binding SYMBOL.
2044 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2045 value. Other values of WHERE mean an internal error. */
2047 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2051 Lisp_Object symbol
, old_value
;
2052 specbinding_func func
;
2053 Lisp_Object unused
; /* Dividing by 16 is faster than by 12. */
2056 extern struct specbinding
*specpdl
;
2057 extern struct specbinding
*specpdl_ptr
;
2058 extern ptrdiff_t specpdl_size
;
2060 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2064 struct backtrace
*next
;
2065 Lisp_Object function
;
2066 Lisp_Object
*args
; /* Points to vector of args. */
2067 ptrdiff_t nargs
; /* Length of vector. */
2068 /* Nonzero means call value of debugger when done with this operation. */
2069 unsigned int debug_on_exit
: 1;
2072 extern struct backtrace
*backtrace_list
;
2074 /* Everything needed to describe an active condition case.
2076 Members are volatile if their values need to survive _longjmp when
2077 a 'struct handler' is a local variable. */
2080 /* The handler clauses and variable from the condition-case form. */
2081 /* For a handler set up in Lisp code, this is always a list.
2082 For an internal handler set up by internal_condition_case*,
2083 this can instead be the symbol t or `error'.
2084 t: handle all conditions.
2085 error: handle all conditions, and errors can run the debugger
2086 or display a backtrace. */
2087 Lisp_Object handler
;
2089 Lisp_Object
volatile var
;
2091 /* Fsignal stores here the condition-case clause that applies,
2092 and Fcondition_case thus knows which clause to run. */
2093 Lisp_Object
volatile chosen_clause
;
2095 /* Used to effect the longjump out to the handler. */
2096 struct catchtag
*tag
;
2098 /* The next enclosing handler. */
2099 struct handler
*next
;
2102 /* This structure helps implement the `catch' and `throw' control
2103 structure. A struct catchtag contains all the information needed
2104 to restore the state of the interpreter after a non-local jump.
2106 Handlers for error conditions (represented by `struct handler'
2107 structures) just point to a catch tag to do the cleanup required
2110 catchtag structures are chained together in the C calling stack;
2111 the `next' member points to the next outer catchtag.
2113 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2114 member is TAG, and then unbinds to it. The `val' member is used to
2115 hold VAL while the stack is unwound; `val' is returned as the value
2118 All the other members are concerned with restoring the interpreter
2121 Members are volatile if their values need to survive _longjmp when
2122 a 'struct catchtag' is a local variable. */
2126 Lisp_Object
volatile val
;
2127 struct catchtag
*volatile next
;
2128 struct gcpro
*gcpro
;
2130 struct backtrace
*backlist
;
2131 struct handler
*handlerlist
;
2132 EMACS_INT lisp_eval_depth
;
2133 ptrdiff_t volatile pdlcount
;
2134 int poll_suppress_count
;
2135 int interrupt_input_blocked
;
2136 struct byte_stack
*byte_stack
;
2139 extern Lisp_Object memory_signal_data
;
2141 /* An address near the bottom of the stack.
2142 Tells GC how to save a copy of the stack. */
2143 extern char *stack_bottom
;
2145 /* Check quit-flag and quit if it is non-nil.
2146 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2147 So the program needs to do QUIT at times when it is safe to quit.
2148 Every loop that might run for a long time or might not exit
2149 ought to do QUIT at least once, at a safe place.
2150 Unless that is impossible, of course.
2151 But it is very desirable to avoid creating loops where QUIT is impossible.
2153 Exception: if you set immediate_quit to nonzero,
2154 then the handler that responds to the C-g does the quit itself.
2155 This is a good thing to do around a loop that has no side effects
2156 and (in particular) cannot call arbitrary Lisp code.
2158 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2159 a request to exit Emacs when it is safe to do. */
2161 extern void process_pending_signals (void);
2162 extern bool volatile pending_signals
;
2164 extern void process_quit_flag (void);
2167 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2168 process_quit_flag (); \
2169 else if (pending_signals) \
2170 process_pending_signals (); \
2174 /* Nonzero if ought to quit now. */
2176 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2178 extern Lisp_Object Vascii_downcase_table
;
2179 extern Lisp_Object Vascii_canon_table
;
2181 /* Structure for recording stack slots that need marking. */
2183 /* This is a chain of structures, each of which points at a Lisp_Object
2184 variable whose value should be marked in garbage collection.
2185 Normally every link of the chain is an automatic variable of a function,
2186 and its `val' points to some argument or local variable of the function.
2187 On exit to the function, the chain is set back to the value it had on entry.
2188 This way, no link remains in the chain when the stack frame containing the
2191 Every function that can call Feval must protect in this fashion all
2192 Lisp_Object variables whose contents will be used again. */
2194 extern struct gcpro
*gcprolist
;
2200 /* Address of first protected variable. */
2201 volatile Lisp_Object
*var
;
2203 /* Number of consecutive protected variables. */
2211 /* Values of GC_MARK_STACK during compilation:
2213 0 Use GCPRO as before
2214 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2215 2 Mark the stack, and check that everything GCPRO'd is
2217 3 Mark using GCPRO's, mark stack last, and count how many
2218 dead objects are kept alive. */
2221 #define GC_USE_GCPROS_AS_BEFORE 0
2222 #define GC_MAKE_GCPROS_NOOPS 1
2223 #define GC_MARK_STACK_CHECK_GCPROS 2
2224 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2226 #ifndef GC_MARK_STACK
2227 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2230 /* Whether we do the stack marking manually. */
2231 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2232 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2235 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2237 /* Do something silly with gcproN vars just so gcc shuts up. */
2238 /* You get warnings from MIPSPro... */
2240 #define GCPRO1(varname) ((void) gcpro1)
2241 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2242 #define GCPRO3(varname1, varname2, varname3) \
2243 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2244 #define GCPRO4(varname1, varname2, varname3, varname4) \
2245 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2246 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2247 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2248 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2249 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2251 #define UNGCPRO ((void) 0)
2253 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2257 #define GCPRO1(varname) \
2258 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2259 gcprolist = &gcpro1; }
2261 #define GCPRO2(varname1, varname2) \
2262 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2263 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2264 gcprolist = &gcpro2; }
2266 #define GCPRO3(varname1, varname2, varname3) \
2267 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2268 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2269 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2270 gcprolist = &gcpro3; }
2272 #define GCPRO4(varname1, varname2, varname3, varname4) \
2273 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2274 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2275 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2276 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2277 gcprolist = &gcpro4; }
2279 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2280 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2281 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2282 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2283 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2284 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2285 gcprolist = &gcpro5; }
2287 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2288 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2289 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2290 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2291 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2292 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2293 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2294 gcprolist = &gcpro6; }
2296 #define UNGCPRO (gcprolist = gcpro1.next)
2300 extern int gcpro_level
;
2302 #define GCPRO1(varname) \
2303 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2304 gcpro1.level = gcpro_level++; \
2305 gcprolist = &gcpro1; }
2307 #define GCPRO2(varname1, varname2) \
2308 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2309 gcpro1.level = gcpro_level; \
2310 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2311 gcpro2.level = gcpro_level++; \
2312 gcprolist = &gcpro2; }
2314 #define GCPRO3(varname1, varname2, varname3) \
2315 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2316 gcpro1.level = gcpro_level; \
2317 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2318 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2319 gcpro3.level = gcpro_level++; \
2320 gcprolist = &gcpro3; }
2322 #define GCPRO4(varname1, varname2, varname3, varname4) \
2323 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2324 gcpro1.level = gcpro_level; \
2325 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2326 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2327 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2328 gcpro4.level = gcpro_level++; \
2329 gcprolist = &gcpro4; }
2331 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2332 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2333 gcpro1.level = gcpro_level; \
2334 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2335 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2336 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2337 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2338 gcpro5.level = gcpro_level++; \
2339 gcprolist = &gcpro5; }
2341 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2342 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2343 gcpro1.level = gcpro_level; \
2344 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2345 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2346 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2347 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2348 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2349 gcpro6.level = gcpro_level++; \
2350 gcprolist = &gcpro6; }
2353 ((--gcpro_level != gcpro1.level) \
2354 ? (emacs_abort (), 0) \
2355 : ((gcprolist = gcpro1.next), 0))
2357 #endif /* DEBUG_GCPRO */
2358 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2361 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2362 #define RETURN_UNGCPRO(expr) \
2365 Lisp_Object ret_ungc_val; \
2366 ret_ungc_val = (expr); \
2368 return ret_ungc_val; \
2372 /* Call staticpro (&var) to protect static variable `var'. */
2374 void staticpro (Lisp_Object
*);
2376 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2377 meaning as in the DEFUN macro, and is used to construct a prototype. */
2378 /* We can use the same trick as in the DEFUN macro to generate the
2379 appropriate prototype. */
2380 #define EXFUN(fnname, maxargs) \
2381 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2383 /* Forward declarations for prototypes. */
2387 /* Simple access functions. */
2389 LISP_INLINE Lisp_Object
*
2390 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2392 return & XVECTOR (array
)->contents
[idx
];
2396 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2398 /* Like ASET, but also can be used in the garbage collector:
2399 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2400 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2401 XVECTOR (array
)->contents
[idx
] = val
;
2404 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2407 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2409 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2410 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2413 /* Functions to modify hash tables. */
2416 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2418 h
->key_and_value
= key_and_value
;
2422 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2424 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2428 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2430 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2434 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2440 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2442 gc_aset (h
->next
, idx
, val
);
2446 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2452 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2454 gc_aset (h
->hash
, idx
, val
);
2458 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2464 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2466 gc_aset (h
->index
, idx
, val
);
2469 /* Use these functions to set Lisp_Object
2470 or pointer slots of struct Lisp_Symbol. */
2473 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2475 XSYMBOL (sym
)->name
= name
;
2479 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2481 XSYMBOL (sym
)->function
= function
;
2485 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2487 XSYMBOL (sym
)->plist
= plist
;
2491 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2493 XSYMBOL (sym
)->next
= next
;
2496 /* Buffer-local (also frame-local) variable access functions. */
2499 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2501 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2506 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2508 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2512 LISP_INLINE Lisp_Object
2513 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2515 return XCDR (blv
->valcell
);
2519 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2521 XSETCDR (blv
->valcell
, val
);
2525 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2531 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2537 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2542 /* Set overlay's property list. */
2545 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2547 XOVERLAY (overlay
)->plist
= plist
;
2550 /* Get text properties of S. */
2552 LISP_INLINE INTERVAL
2553 string_intervals (Lisp_Object s
)
2555 return XSTRING (s
)->intervals
;
2558 /* Set text properties of S to I. */
2561 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2563 XSTRING (s
)->intervals
= i
;
2566 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2567 of setting slots directly. */
2570 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2572 XCHAR_TABLE (table
)->ascii
= val
;
2575 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2577 XCHAR_TABLE (table
)->defalt
= val
;
2580 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2582 XCHAR_TABLE (table
)->parent
= val
;
2585 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2587 XCHAR_TABLE (table
)->purpose
= val
;
2590 /* Set different slots in (sub)character tables. */
2593 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2595 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2596 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2600 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2602 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2603 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2607 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2609 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2612 /* Defined in data.c. */
2613 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2614 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2615 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2616 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2617 extern Lisp_Object Qinvalid_read_syntax
;
2618 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2619 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2620 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2621 extern Lisp_Object Qtext_read_only
;
2622 extern Lisp_Object Qinteractive_form
;
2623 extern Lisp_Object Qcircular_list
;
2624 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2625 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2626 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2627 extern Lisp_Object Qbuffer_or_string_p
;
2628 extern Lisp_Object Qfboundp
;
2629 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2631 extern Lisp_Object Qcdr
;
2633 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2635 extern Lisp_Object Qfloatp
;
2636 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2638 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2640 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2642 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2644 /* Defined in data.c. */
2645 extern Lisp_Object
indirect_function (Lisp_Object
);
2646 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2648 /* Convert the integer I to an Emacs representation, either the integer
2649 itself, or a cons of two or three integers, or if all else fails a float.
2650 I should not have side effects. */
2651 #define INTEGER_TO_CONS(i) \
2652 (! FIXNUM_OVERFLOW_P (i) \
2654 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2655 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2656 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2657 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2658 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2659 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2660 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2661 ? Fcons (make_number ((i) >> 16 >> 24), \
2662 Fcons (make_number ((i) >> 16 & 0xffffff), \
2663 make_number ((i) & 0xffff))) \
2666 /* Convert the Emacs representation CONS back to an integer of type
2667 TYPE, storing the result the variable VAR. Signal an error if CONS
2668 is not a valid representation or is out of range for TYPE. */
2669 #define CONS_TO_INTEGER(cons, type, var) \
2670 (TYPE_SIGNED (type) \
2671 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2672 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2673 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2674 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2676 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2677 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2678 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2680 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2681 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2682 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2683 extern void syms_of_data (void);
2684 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2686 /* Defined in cmds.c */
2687 extern void syms_of_cmds (void);
2688 extern void keys_of_cmds (void);
2690 /* Defined in coding.c. */
2691 extern Lisp_Object Qcharset
;
2692 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2693 ptrdiff_t, bool, bool, Lisp_Object
);
2694 extern void init_coding (void);
2695 extern void init_coding_once (void);
2696 extern void syms_of_coding (void);
2698 /* Defined in character.c. */
2699 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2700 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2701 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2702 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2703 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2704 extern void syms_of_character (void);
2706 /* Defined in charset.c. */
2707 extern void init_charset (void);
2708 extern void init_charset_once (void);
2709 extern void syms_of_charset (void);
2710 /* Structure forward declarations. */
2713 /* Defined in composite.c. */
2714 extern void syms_of_composite (void);
2716 /* Defined in syntax.c. */
2717 extern void init_syntax_once (void);
2718 extern void syms_of_syntax (void);
2720 /* Defined in fns.c. */
2721 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2722 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2723 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2724 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2725 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2726 extern void sweep_weak_hash_tables (void);
2727 extern Lisp_Object Qcursor_in_echo_area
;
2728 extern Lisp_Object Qstring_lessp
;
2729 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
2730 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2731 EMACS_UINT
sxhash (Lisp_Object
, int);
2732 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
2733 Lisp_Object
, Lisp_Object
);
2734 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2735 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2737 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
2739 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2740 ptrdiff_t, ptrdiff_t);
2741 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2742 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2743 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2744 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2745 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2746 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2747 extern void clear_string_char_byte_cache (void);
2748 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2749 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2750 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2751 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2752 extern void syms_of_fns (void);
2754 /* Defined in floatfns.c. */
2755 extern double extract_float (Lisp_Object
);
2756 extern void syms_of_floatfns (void);
2757 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2759 /* Defined in fringe.c. */
2760 extern void syms_of_fringe (void);
2761 extern void init_fringe (void);
2762 #ifdef HAVE_WINDOW_SYSTEM
2763 extern void mark_fringe_data (void);
2764 extern void init_fringe_once (void);
2765 #endif /* HAVE_WINDOW_SYSTEM */
2767 /* Defined in image.c. */
2768 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2769 extern Lisp_Object QCconversion
;
2770 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2771 extern void reset_image_types (void);
2772 extern void syms_of_image (void);
2774 /* Defined in insdel.c. */
2775 extern Lisp_Object Qinhibit_modification_hooks
;
2776 extern void move_gap (ptrdiff_t);
2777 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2778 extern _Noreturn
void buffer_overflow (void);
2779 extern void make_gap (ptrdiff_t);
2780 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2781 ptrdiff_t, bool, bool);
2782 extern int count_combining_before (const unsigned char *,
2783 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2784 extern int count_combining_after (const unsigned char *,
2785 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2786 extern void insert (const char *, ptrdiff_t);
2787 extern void insert_and_inherit (const char *, ptrdiff_t);
2788 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2789 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2791 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2792 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2793 ptrdiff_t, ptrdiff_t, bool);
2794 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2795 extern void insert_char (int);
2796 extern void insert_string (const char *);
2797 extern void insert_before_markers (const char *, ptrdiff_t);
2798 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2799 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2800 ptrdiff_t, ptrdiff_t,
2802 extern void del_range (ptrdiff_t, ptrdiff_t);
2803 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2804 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2805 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2806 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2807 ptrdiff_t, ptrdiff_t, bool);
2808 extern void modify_region_1 (ptrdiff_t, ptrdiff_t, bool);
2809 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2810 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2811 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2812 ptrdiff_t, ptrdiff_t);
2813 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2814 ptrdiff_t, ptrdiff_t);
2815 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2816 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2817 const char *, ptrdiff_t, ptrdiff_t, bool);
2818 extern void syms_of_insdel (void);
2820 /* Defined in dispnew.c. */
2821 #if (defined PROFILING \
2822 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2823 _Noreturn
void __executable_start (void);
2825 extern Lisp_Object selected_frame
;
2826 extern Lisp_Object Vwindow_system
;
2827 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2828 extern void init_display (void);
2829 extern void syms_of_display (void);
2831 /* Defined in xdisp.c. */
2832 extern Lisp_Object Qinhibit_point_motion_hooks
;
2833 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2834 extern Lisp_Object Qmenu_bar_update_hook
;
2835 extern Lisp_Object Qwindow_scroll_functions
;
2836 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2837 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2838 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2839 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2840 extern Lisp_Object Qleft_margin
, Qright_margin
;
2841 extern Lisp_Object Qglyphless_char
;
2842 extern Lisp_Object QCdata
, QCfile
;
2843 extern Lisp_Object QCmap
;
2844 extern Lisp_Object Qrisky_local_variable
;
2845 extern struct frame
*last_glyphless_glyph_frame
;
2846 extern int last_glyphless_glyph_face_id
;
2847 extern int last_glyphless_glyph_merged_face_id
;
2848 extern int noninteractive_need_newline
;
2849 extern Lisp_Object echo_area_buffer
[2];
2850 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2851 extern void check_message_stack (void);
2852 extern void setup_echo_area_for_printing (int);
2853 extern bool push_message (void);
2854 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2855 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2856 extern void restore_message (void);
2857 extern Lisp_Object
current_message (void);
2858 extern void clear_message (int, int);
2859 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2860 extern void message1 (const char *);
2861 extern void message1_nolog (const char *);
2862 extern void message2 (const char *, ptrdiff_t, int);
2863 extern void message2_nolog (const char *, ptrdiff_t, int);
2864 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2865 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2866 extern void message_dolog (const char *, ptrdiff_t, int, int);
2867 extern void message_with_string (const char *, Lisp_Object
, int);
2868 extern void message_log_maybe_newline (void);
2869 extern void update_echo_area (void);
2870 extern void truncate_echo_area (ptrdiff_t);
2871 extern void redisplay (void);
2872 extern void redisplay_preserve_echo_area (int);
2873 extern void prepare_menu_bars (void);
2875 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2876 extern void syms_of_xdisp (void);
2877 extern void init_xdisp (void);
2878 extern Lisp_Object
safe_eval (Lisp_Object
);
2879 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2880 int *, int *, int *, int *, int *);
2882 /* Defined in xsettings.c. */
2883 extern void syms_of_xsettings (void);
2885 /* Defined in vm-limit.c. */
2886 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2888 /* Defined in alloc.c. */
2889 extern void check_pure_size (void);
2890 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2891 extern void malloc_warning (const char *);
2892 extern _Noreturn
void memory_full (size_t);
2893 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2894 extern bool survives_gc_p (Lisp_Object
);
2895 extern void mark_object (Lisp_Object
);
2896 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2897 extern void refill_memory_reserve (void);
2899 extern const char *pending_malloc_warning
;
2900 extern Lisp_Object zero_vector
;
2901 extern Lisp_Object
*stack_base
;
2902 extern EMACS_INT consing_since_gc
;
2903 extern EMACS_INT gc_relative_threshold
;
2904 extern EMACS_INT memory_full_cons_threshold
;
2905 extern Lisp_Object
list1 (Lisp_Object
);
2906 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2907 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2908 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2909 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2911 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2912 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2913 extern _Noreturn
void string_overflow (void);
2914 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2915 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2916 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2917 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2919 /* Make unibyte string from C string when the length isn't known. */
2921 LISP_INLINE Lisp_Object
2922 build_unibyte_string (const char *str
)
2924 return make_unibyte_string (str
, strlen (str
));
2927 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2928 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2929 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2930 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2931 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2932 extern Lisp_Object
make_specified_string (const char *,
2933 ptrdiff_t, ptrdiff_t, bool);
2934 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2935 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2937 /* Make a string allocated in pure space, use STR as string data. */
2939 LISP_INLINE Lisp_Object
2940 build_pure_c_string (const char *str
)
2942 return make_pure_c_string (str
, strlen (str
));
2945 /* Make a string from the data at STR, treating it as multibyte if the
2948 LISP_INLINE Lisp_Object
2949 build_string (const char *str
)
2951 return make_string (str
, strlen (str
));
2954 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2955 extern void make_byte_code (struct Lisp_Vector
*);
2956 extern Lisp_Object Qautomatic_gc
;
2957 extern Lisp_Object Qchar_table_extra_slots
;
2958 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2959 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
2960 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2962 allocate_pseudovector \
2963 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2964 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2965 extern struct window
*allocate_window (void);
2966 extern struct frame
*allocate_frame (void);
2967 extern struct Lisp_Process
*allocate_process (void);
2968 extern struct terminal
*allocate_terminal (void);
2969 extern bool gc_in_progress
;
2970 extern bool abort_on_gc
;
2971 extern Lisp_Object
make_float (double);
2972 extern void display_malloc_warning (void);
2973 extern ptrdiff_t inhibit_garbage_collection (void);
2974 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2975 extern void free_save_value (Lisp_Object
);
2976 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2977 extern void free_marker (Lisp_Object
);
2978 extern void free_cons (struct Lisp_Cons
*);
2979 extern void init_alloc_once (void);
2980 extern void init_alloc (void);
2981 extern void syms_of_alloc (void);
2982 extern struct buffer
* allocate_buffer (void);
2983 extern int valid_lisp_object_p (Lisp_Object
);
2984 #ifdef GC_CHECK_CONS_LIST
2985 extern void check_cons_list (void);
2987 #define check_cons_list() ((void) 0)
2991 /* Defined in ralloc.c. */
2992 extern void *r_alloc (void **, size_t);
2993 extern void r_alloc_free (void **);
2994 extern void *r_re_alloc (void **, size_t);
2995 extern void r_alloc_reset_variable (void **, void **);
2996 extern void r_alloc_inhibit_buffer_relocation (int);
2999 /* Defined in chartab.c. */
3000 extern Lisp_Object
copy_char_table (Lisp_Object
);
3001 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
3002 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3004 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3005 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3006 extern int char_table_translate (Lisp_Object
, int);
3007 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3009 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3010 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3011 Lisp_Object
, Lisp_Object
,
3012 Lisp_Object
, struct charset
*,
3013 unsigned, unsigned);
3014 extern Lisp_Object
uniprop_table (Lisp_Object
);
3015 extern void syms_of_chartab (void);
3017 /* Defined in print.c. */
3018 extern Lisp_Object Vprin1_to_string_buffer
;
3019 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3020 extern Lisp_Object Qstandard_output
;
3021 extern Lisp_Object Qexternal_debugging_output
;
3022 extern void temp_output_buffer_setup (const char *);
3023 extern int print_level
;
3024 extern Lisp_Object Qprint_escape_newlines
;
3025 extern void write_string (const char *, int);
3026 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3028 extern Lisp_Object internal_with_output_to_temp_buffer
3029 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3030 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3031 extern int float_to_string (char *, double);
3032 extern void syms_of_print (void);
3034 /* Defined in doprnt.c. */
3035 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3037 extern ptrdiff_t esprintf (char *, char const *, ...)
3038 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3039 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3041 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3042 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3043 char const *, va_list)
3044 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3046 /* Defined in lread.c. */
3047 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3048 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3049 extern Lisp_Object Qlexical_binding
;
3050 extern Lisp_Object
check_obarray (Lisp_Object
);
3051 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3052 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3053 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3054 #define LOADHIST_ATTACH(x) \
3056 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3058 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3059 Lisp_Object
*, Lisp_Object
);
3060 extern Lisp_Object
string_to_number (char const *, int, bool);
3061 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3063 extern void dir_warning (const char *, Lisp_Object
);
3064 extern void close_load_descs (void);
3065 extern void init_obarray (void);
3066 extern void init_lread (void);
3067 extern void syms_of_lread (void);
3069 LISP_INLINE Lisp_Object
3070 intern (const char *str
)
3072 return intern_1 (str
, strlen (str
));
3075 LISP_INLINE Lisp_Object
3076 intern_c_string (const char *str
)
3078 return intern_c_string_1 (str
, strlen (str
));
3081 /* Defined in eval.c. */
3082 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3083 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3084 extern Lisp_Object Qand_rest
;
3085 extern Lisp_Object Vautoload_queue
;
3086 extern Lisp_Object Vsignaling_function
;
3087 extern Lisp_Object inhibit_lisp_code
;
3089 extern struct catchtag
*catchlist
;
3090 extern struct handler
*handlerlist
;
3092 /* To run a normal hook, use the appropriate function from the list below.
3093 The calling convention:
3095 if (!NILP (Vrun_hooks))
3096 call1 (Vrun_hooks, Qmy_funny_hook);
3098 should no longer be used. */
3099 extern Lisp_Object Vrun_hooks
;
3100 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3101 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3102 Lisp_Object (*funcall
)
3103 (ptrdiff_t nargs
, Lisp_Object
*args
));
3104 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3105 extern _Noreturn
void xsignal0 (Lisp_Object
);
3106 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3107 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3108 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3110 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3111 extern Lisp_Object
eval_sub (Lisp_Object form
);
3112 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3113 extern Lisp_Object
call0 (Lisp_Object
);
3114 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3115 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3116 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3117 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3118 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3119 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3120 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3121 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3122 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3123 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3124 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3125 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3126 extern Lisp_Object internal_condition_case_n
3127 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3128 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3129 extern void specbind (Lisp_Object
, Lisp_Object
);
3130 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3131 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3132 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3133 extern _Noreturn
void verror (const char *, va_list)
3134 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3135 extern Lisp_Object
un_autoload (Lisp_Object
);
3136 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3137 extern void init_eval_once (void);
3138 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3139 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3140 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3141 extern void init_eval (void);
3143 extern void mark_backtrace (void);
3145 extern void syms_of_eval (void);
3147 /* Defined in editfns.c. */
3148 extern Lisp_Object Qfield
;
3149 extern void insert1 (Lisp_Object
);
3150 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3151 extern Lisp_Object
save_excursion_save (void);
3152 extern Lisp_Object
save_restriction_save (void);
3153 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3154 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3155 extern _Noreturn
void time_overflow (void);
3156 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3157 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3159 extern void init_editfns (void);
3160 extern void syms_of_editfns (void);
3161 extern void set_time_zone_rule (const char *);
3163 /* Defined in buffer.c. */
3164 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3165 extern _Noreturn
void nsberror (Lisp_Object
);
3166 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3167 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3168 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3169 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3170 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3171 extern bool overlay_touches_p (ptrdiff_t);
3172 extern Lisp_Object Vbuffer_alist
;
3173 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3174 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3175 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3176 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3177 extern void init_buffer_once (void);
3178 extern void init_buffer (void);
3179 extern void syms_of_buffer (void);
3180 extern void keys_of_buffer (void);
3182 /* Defined in marker.c. */
3184 extern ptrdiff_t marker_position (Lisp_Object
);
3185 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3186 extern void clear_charpos_cache (struct buffer
*);
3187 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3188 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3189 extern void unchain_marker (struct Lisp_Marker
*marker
);
3190 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3191 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3192 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3193 ptrdiff_t, ptrdiff_t);
3194 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3195 extern void syms_of_marker (void);
3197 /* Defined in fileio.c. */
3199 extern Lisp_Object Qfile_error
;
3200 extern Lisp_Object Qfile_exists_p
;
3201 extern Lisp_Object Qfile_directory_p
;
3202 extern Lisp_Object Qinsert_file_contents
;
3203 extern Lisp_Object Qfile_name_history
;
3204 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3205 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3206 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3207 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3208 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3209 extern bool internal_delete_file (Lisp_Object
);
3210 extern bool file_directory_p (const char *);
3211 extern bool file_accessible_directory_p (const char *);
3212 extern void syms_of_fileio (void);
3213 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3214 extern Lisp_Object Qdelete_file
;
3215 extern bool check_existing (const char *);
3217 /* Defined in search.c. */
3218 extern void shrink_regexp_cache (void);
3219 extern void restore_search_regs (void);
3220 extern void record_unwind_save_match_data (void);
3221 struct re_registers
;
3222 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3223 struct re_registers
*,
3224 Lisp_Object
, int, int);
3225 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3226 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3228 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3229 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3230 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3231 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3233 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3235 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3236 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3237 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3238 extern void syms_of_search (void);
3239 extern void clear_regexp_cache (void);
3241 /* Defined in minibuf.c. */
3243 extern Lisp_Object Qcompletion_ignore_case
;
3244 extern Lisp_Object Vminibuffer_list
;
3245 extern Lisp_Object last_minibuf_string
;
3246 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3247 extern void init_minibuf_once (void);
3248 extern void syms_of_minibuf (void);
3250 /* Defined in callint.c. */
3252 extern Lisp_Object Qminus
, Qplus
;
3253 extern Lisp_Object Qwhen
;
3254 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3255 extern void syms_of_callint (void);
3257 /* Defined in casefiddle.c. */
3259 extern Lisp_Object Qidentity
;
3260 extern void syms_of_casefiddle (void);
3261 extern void keys_of_casefiddle (void);
3263 /* Defined in casetab.c. */
3265 extern void init_casetab_once (void);
3266 extern void syms_of_casetab (void);
3268 /* Defined in keyboard.c. */
3270 extern Lisp_Object echo_message_buffer
;
3271 extern struct kboard
*echo_kboard
;
3272 extern void cancel_echoing (void);
3273 extern Lisp_Object Qdisabled
, QCfilter
;
3274 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3275 extern Lisp_Object Qtop
;
3276 extern Lisp_Object last_undo_boundary
;
3277 extern bool input_pending
;
3278 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3279 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3280 extern void discard_mouse_events (void);
3282 void handle_input_available_signal (int);
3284 extern Lisp_Object pending_funcalls
;
3285 extern bool detect_input_pending (void);
3286 extern bool detect_input_pending_ignore_squeezables (void);
3287 extern bool detect_input_pending_run_timers (bool);
3288 extern void safe_run_hooks (Lisp_Object
);
3289 extern void cmd_error_internal (Lisp_Object
, const char *);
3290 extern Lisp_Object
command_loop_1 (void);
3291 extern Lisp_Object
recursive_edit_1 (void);
3292 extern void record_auto_save (void);
3293 extern void force_auto_save_soon (void);
3294 extern void init_keyboard (void);
3295 extern void syms_of_keyboard (void);
3296 extern void keys_of_keyboard (void);
3298 /* Defined in indent.c. */
3299 extern ptrdiff_t current_column (void);
3300 extern void invalidate_current_column (void);
3301 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3302 extern void syms_of_indent (void);
3304 /* Defined in frame.c. */
3305 extern Lisp_Object Qonly
, Qnone
;
3306 extern Lisp_Object Qvisible
;
3307 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3308 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3309 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3311 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3313 extern void frames_discard_buffer (Lisp_Object
);
3314 extern void syms_of_frame (void);
3316 /* Defined in emacs.c. */
3317 extern char **initial_argv
;
3318 extern int initial_argc
;
3319 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3320 extern bool display_arg
;
3322 extern Lisp_Object
decode_env_path (const char *, const char *);
3323 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3324 extern Lisp_Object Qfile_name_handler_alist
;
3325 extern _Noreturn
void terminate_due_to_signal (int, int);
3326 extern Lisp_Object Qkill_emacs
;
3328 extern Lisp_Object Vlibrary_cache
;
3331 void fixup_locale (void);
3332 void synchronize_system_messages_locale (void);
3333 void synchronize_system_time_locale (void);
3335 #define setlocale(category, locale)
3336 #define fixup_locale()
3337 #define synchronize_system_messages_locale()
3338 #define synchronize_system_time_locale()
3340 extern void shut_down_emacs (int, Lisp_Object
);
3342 /* True means don't do interactive redisplay and don't change tty modes. */
3343 extern bool noninteractive
;
3345 /* True means remove site-lisp directories from load-path. */
3346 extern bool no_site_lisp
;
3348 /* Pipe used to send exit notification to the daemon parent at
3350 extern int daemon_pipe
[2];
3351 #define IS_DAEMON (daemon_pipe[1] != 0)
3353 /* True if handling a fatal error already. */
3354 extern bool fatal_error_in_progress
;
3356 /* True means don't do use window-system-specific display code. */
3357 extern bool inhibit_window_system
;
3358 /* True means that a filter or a sentinel is running. */
3359 extern bool running_asynch_code
;
3361 /* Defined in process.c. */
3362 extern Lisp_Object QCtype
, Qlocal
;
3363 extern Lisp_Object Qprocessp
;
3364 extern void kill_buffer_processes (Lisp_Object
);
3365 extern int wait_reading_process_output (intmax_t, int, int, bool,
3367 struct Lisp_Process
*,
3369 /* Max value for the first argument of wait_reading_process_output. */
3370 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3371 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3372 The bug merely causes a bogus warning, but the warning is annoying. */
3373 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3375 # define WAIT_READING_MAX INTMAX_MAX
3377 extern void add_keyboard_wait_descriptor (int);
3378 extern void delete_keyboard_wait_descriptor (int);
3380 extern void add_gpm_wait_descriptor (int);
3381 extern void delete_gpm_wait_descriptor (int);
3383 extern void close_process_descs (void);
3384 extern void init_process_emacs (void);
3385 extern void syms_of_process (void);
3386 extern void setup_process_coding_systems (Lisp_Object
);
3391 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3392 extern void init_callproc_1 (void);
3393 extern void init_callproc (void);
3394 extern void set_initial_environment (void);
3395 extern void syms_of_callproc (void);
3397 /* Defined in doc.c. */
3398 extern Lisp_Object Qfunction_documentation
;
3399 extern Lisp_Object
read_doc_string (Lisp_Object
);
3400 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3401 extern void syms_of_doc (void);
3402 extern int read_bytecode_char (bool);
3404 /* Defined in bytecode.c. */
3405 extern void syms_of_bytecode (void);
3406 extern struct byte_stack
*byte_stack_list
;
3408 extern void mark_byte_stack (void);
3410 extern void unmark_byte_stack (void);
3411 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3412 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3414 /* Defined in macros.c. */
3415 extern Lisp_Object Qexecute_kbd_macro
;
3416 extern void init_macros (void);
3417 extern void syms_of_macros (void);
3419 /* Defined in undo.c. */
3420 extern Lisp_Object Qapply
;
3421 extern Lisp_Object Qinhibit_read_only
;
3422 extern void truncate_undo_list (struct buffer
*);
3423 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3424 extern void record_insert (ptrdiff_t, ptrdiff_t);
3425 extern void record_delete (ptrdiff_t, Lisp_Object
);
3426 extern void record_first_change (void);
3427 extern void record_change (ptrdiff_t, ptrdiff_t);
3428 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3429 Lisp_Object
, Lisp_Object
,
3431 extern void syms_of_undo (void);
3432 /* Defined in textprop.c. */
3433 extern Lisp_Object Qfont
, Qmouse_face
;
3434 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3435 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3436 extern Lisp_Object Qminibuffer_prompt
;
3438 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3440 /* Defined in menu.c. */
3441 extern void syms_of_menu (void);
3443 /* Defined in xmenu.c. */
3444 extern void syms_of_xmenu (void);
3446 /* Defined in termchar.h. */
3447 struct tty_display_info
;
3449 /* Defined in termhooks.h. */
3452 /* Defined in sysdep.c. */
3453 #ifndef HAVE_GET_CURRENT_DIR_NAME
3454 extern char *get_current_dir_name (void);
3456 extern void stuff_char (char c
);
3457 extern void init_foreground_group (void);
3458 extern void init_sigio (int);
3459 extern void sys_subshell (void);
3460 extern void sys_suspend (void);
3461 extern void discard_tty_input (void);
3462 extern void init_sys_modes (struct tty_display_info
*);
3463 extern void reset_sys_modes (struct tty_display_info
*);
3464 extern void init_all_sys_modes (void);
3465 extern void reset_all_sys_modes (void);
3466 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3467 extern void child_setup_tty (int);
3468 extern void setup_pty (int);
3469 extern int set_window_size (int, int, int);
3470 extern EMACS_INT
get_random (void);
3471 extern void seed_random (void *, ptrdiff_t);
3472 extern void init_random (void);
3473 extern void emacs_backtrace (int);
3474 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3475 extern int emacs_open (const char *, int, int);
3476 extern int emacs_close (int);
3477 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3478 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3479 enum { READLINK_BUFSIZE
= 1024 };
3480 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3482 extern void unlock_all_files (void);
3483 extern void lock_file (Lisp_Object
);
3484 extern void unlock_file (Lisp_Object
);
3485 extern void unlock_buffer (struct buffer
*);
3486 extern void syms_of_filelock (void);
3488 /* Defined in sound.c. */
3489 extern void syms_of_sound (void);
3491 /* Defined in category.c. */
3492 extern void init_category_once (void);
3493 extern Lisp_Object
char_category_set (int);
3494 extern void syms_of_category (void);
3496 /* Defined in ccl.c. */
3497 extern void syms_of_ccl (void);
3499 /* Defined in dired.c. */
3500 extern void syms_of_dired (void);
3501 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3502 Lisp_Object
, Lisp_Object
,
3505 /* Defined in term.c. */
3506 extern int *char_ins_del_vector
;
3507 extern void syms_of_term (void);
3508 extern _Noreturn
void fatal (const char *msgid
, ...)
3509 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3511 /* Defined in terminal.c. */
3512 extern void syms_of_terminal (void);
3514 /* Defined in font.c. */
3515 extern void syms_of_font (void);
3516 extern void init_font (void);
3518 #ifdef HAVE_WINDOW_SYSTEM
3519 /* Defined in fontset.c. */
3520 extern void syms_of_fontset (void);
3522 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3523 extern Lisp_Object Qfont_param
;
3527 /* Defined on w32notify.c. */
3528 extern void syms_of_w32notify (void);
3531 /* Defined in inotify.c */
3533 extern void syms_of_inotify (void);
3536 /* Defined in xfaces.c. */
3537 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3538 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3539 extern Lisp_Object Qmode_line_inactive
;
3540 extern Lisp_Object Qface
;
3541 extern Lisp_Object Qnormal
;
3542 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3543 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3544 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3545 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3546 extern Lisp_Object Qoblique
, Qitalic
;
3547 extern Lisp_Object Vface_alternative_font_family_alist
;
3548 extern Lisp_Object Vface_alternative_font_registry_alist
;
3549 extern void syms_of_xfaces (void);
3551 #ifdef HAVE_X_WINDOWS
3552 /* Defined in xfns.c. */
3553 extern void syms_of_xfns (void);
3555 /* Defined in xsmfns.c. */
3556 extern void syms_of_xsmfns (void);
3558 /* Defined in xselect.c. */
3559 extern void syms_of_xselect (void);
3561 /* Defined in xterm.c. */
3562 extern void syms_of_xterm (void);
3563 #endif /* HAVE_X_WINDOWS */
3565 #ifdef HAVE_WINDOW_SYSTEM
3566 /* Defined in xterm.c, nsterm.m, w32term.c. */
3567 extern char *x_get_keysym_name (int);
3568 #endif /* HAVE_WINDOW_SYSTEM */
3571 /* Defined in xml.c. */
3572 extern void syms_of_xml (void);
3573 extern void xml_cleanup_parser (void);
3577 /* Defined in (x|w32)fns.c, nsfns.m... */
3578 extern int have_menus_p (void);
3582 /* Defined in dbusbind.c. */
3583 void syms_of_dbusbind (void);
3587 /* Defined in profiler.c. */
3588 extern bool profiler_memory_running
;
3589 extern void malloc_probe (size_t);
3590 extern void syms_of_profiler (void);
3594 /* Defined in msdos.c, w32.c. */
3595 extern char *emacs_root_dir (void);
3598 /* True means Emacs has already been initialized.
3599 Used during startup to detect startup of dumped Emacs. */
3600 extern bool initialized
;
3602 /* True means ^G can quit instantly. */
3603 extern bool immediate_quit
;
3605 extern void *xmalloc (size_t);
3606 extern void *xzalloc (size_t);
3607 extern void *xrealloc (void *, size_t);
3608 extern void xfree (void *);
3609 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3610 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3611 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3613 extern char *xstrdup (const char *);
3614 extern void xputenv (const char *);
3616 extern char *egetenv (const char *);
3618 /* Set up the name of the machine we're running on. */
3619 extern void init_system_name (void);
3621 /* We used to use `abs', but that clashes with system headers on some
3622 platforms, and using a name reserved by Standard C is a bad idea
3625 #define eabs(x) ((x) < 0 ? -(x) : (x))
3628 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3631 #define make_fixnum_or_float(val) \
3632 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3634 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3635 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3637 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3639 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3640 extern void *record_xmalloc (size_t);
3642 #define USE_SAFE_ALLOCA \
3643 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3645 /* SAFE_ALLOCA allocates a simple buffer. */
3647 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3649 : (sa_must_free = 1, record_xmalloc (size)))
3651 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3652 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3653 positive. The code is tuned for MULTIPLIER being a constant. */
3655 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3657 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3658 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3661 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3663 record_unwind_protect (safe_alloca_unwind, \
3664 make_save_value (buf, 0)); \
3668 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3670 #define SAFE_FREE() \
3672 if (sa_must_free) { \
3674 unbind_to (sa_count, Qnil); \
3679 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3681 #define SAFE_ALLOCA_LISP(buf, nelt) \
3683 if ((nelt) < MAX_ALLOCA / word_size) \
3684 buf = alloca ((nelt) * word_size); \
3685 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3688 buf = xmalloc ((nelt) * word_size); \
3689 arg_ = make_save_value (buf, nelt); \
3690 XSAVE_VALUE (arg_)->dogc = 1; \
3692 record_unwind_protect (safe_alloca_unwind, arg_); \
3695 memory_full (SIZE_MAX); \
3699 #include "globals.h"
3701 /* Check whether it's time for GC, and run it if so. */
3706 if ((consing_since_gc
> gc_cons_threshold
3707 && consing_since_gc
> gc_relative_threshold
)
3708 || (!NILP (Vmemory_full
)
3709 && consing_since_gc
> memory_full_cons_threshold
))
3710 Fgarbage_collect ();
3714 functionp (Lisp_Object object
)
3716 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3718 object
= Findirect_function (object
, Qt
);
3720 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3722 /* Autoloaded symbols are functions, except if they load
3723 macros or keymaps. */
3725 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3726 object
= XCDR (object
);
3728 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3733 return XSUBR (object
)->max_args
!= UNEVALLED
;
3734 else if (COMPILEDP (object
))
3736 else if (CONSP (object
))
3738 Lisp_Object car
= XCAR (object
);
3739 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3747 #endif /* EMACS_LISP_H */