1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 # define LISP_INLINE INLINE
40 /* The ubiquitous max and min macros. */
43 #define max(a, b) ((a) > (b) ? (a) : (b))
44 #define min(a, b) ((a) < (b) ? (a) : (b))
46 /* EMACS_INT - signed integer wide enough to hold an Emacs value
47 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
48 pI - printf length modifier for EMACS_INT
49 EMACS_UINT - unsigned variant of EMACS_INT */
51 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
52 typedef long long int EMACS_INT
;
53 typedef unsigned long long int EMACS_UINT
;
54 # define EMACS_INT_MAX LLONG_MAX
56 # elif INT_MAX < LONG_MAX
57 typedef long int EMACS_INT
;
58 typedef unsigned long int EMACS_UINT
;
59 # define EMACS_INT_MAX LONG_MAX
62 typedef int EMACS_INT
;
63 typedef unsigned int EMACS_UINT
;
64 # define EMACS_INT_MAX INT_MAX
69 /* Number of bits in some machine integer types. */
72 BITS_PER_CHAR
= CHAR_BIT
,
73 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
74 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
75 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
76 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
79 /* printmax_t and uprintmax_t are types for printing large integers.
80 These are the widest integers that are supported for printing.
81 pMd etc. are conversions for printing them.
82 On C99 hosts, there's no problem, as even the widest integers work.
83 Fall back on EMACS_INT on pre-C99 hosts. */
85 typedef intmax_t printmax_t
;
86 typedef uintmax_t uprintmax_t
;
90 typedef EMACS_INT printmax_t
;
91 typedef EMACS_UINT uprintmax_t
;
96 /* Use pD to format ptrdiff_t values, which suffice for indexes into
97 buffers and strings. Emacs never allocates objects larger than
98 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
99 In C99, pD can always be "t"; configure it here for the sake of
100 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
101 #if PTRDIFF_MAX == INT_MAX
103 #elif PTRDIFF_MAX == LONG_MAX
105 #elif PTRDIFF_MAX == LLONG_MAX
111 /* Extra internal type checking? */
113 /* Define an Emacs version of 'assert (COND)', since some
114 system-defined 'assert's are flaky. COND should be free of side
115 effects; it may or may not be evaluated. */
116 #ifndef ENABLE_CHECKING
117 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
118 #else /* ENABLE_CHECKING */
120 extern _Noreturn
void die (const char *, const char *, int);
122 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
123 it to 1 using a debugger to temporarily disable aborting on
124 detected internal inconsistencies or error conditions.
126 In some cases, a good compiler may be able to optimize away the
127 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
128 STRINGP (x), but a particular use of XSTRING is invoked only after
129 testing that STRINGP (x) is true, making the test redundant. */
130 extern bool suppress_checking EXTERNALLY_VISIBLE
;
132 # define eassert(cond) \
133 ((cond) || suppress_checking \
135 : die ("assertion failed: " # cond, __FILE__, __LINE__))
136 #endif /* ENABLE_CHECKING */
138 /* Use the configure flag --enable-check-lisp-object-type to make
139 Lisp_Object use a struct type instead of the default int. The flag
140 causes CHECK_LISP_OBJECT_TYPE to be defined. */
142 /***** Select the tagging scheme. *****/
143 /* The following option controls the tagging scheme:
144 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
145 always 0, and we can thus use them to hold tag bits, without
146 restricting our addressing space.
148 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
149 restricting our possible address range.
151 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
152 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
153 on the few static Lisp_Objects used: all the defsubr as well
154 as the two special buffers buffer_defaults and buffer_local_symbols. */
158 /* Number of bits in a Lisp_Object tag. This can be used in #if,
159 and for GDB's sake also as a regular symbol. */
164 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
165 integer constant, for MSVC. */
166 #define GCALIGNMENT 8
168 /* Number of bits in a Lisp_Object value, not counting the tag. */
169 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
171 /* Number of bits in a Lisp fixnum tag. */
172 INTTYPEBITS
= GCTYPEBITS
- 1,
174 /* Number of bits in a Lisp fixnum value, not counting the tag. */
175 FIXNUM_BITS
= VALBITS
+ 1
178 #if GCALIGNMENT != 1 << GCTYPEBITS
179 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
182 /* The maximum value that can be stored in a EMACS_INT, assuming all
183 bits other than the type bits contribute to a nonnegative signed value.
184 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
185 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
187 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
189 /* 1. We know malloc returns a multiple of 8. */
190 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
191 || defined DARWIN_OS || defined __sun)
192 /* 2. We can specify multiple-of-8 alignment on static variables. */
194 /* 3. Pointers-as-ints exceed VAL_MAX.
195 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
196 a. unnecessary, because the top bits of an EMACS_INT are unused, and
197 b. slower, because it typically requires extra masking.
198 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
199 # if VAL_MAX < UINTPTR_MAX
200 # define USE_LSB_TAG 1
207 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
208 # define USE_LSB_TAG 1
210 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
211 # define USE_LSB_TAG 0
215 # define alignas(alignment) /* empty */
217 # error "USE_LSB_TAG requires alignas"
222 /* Define the fundamental Lisp data structures. */
224 /* This is the set of Lisp data types. If you want to define a new
225 data type, read the comments after Lisp_Fwd_Type definition
228 /* Lisp integers use 2 tags, to give them one extra bit, thus
229 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
230 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
231 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
232 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
234 /* Stolen from GDB. The only known compiler that doesn't support
235 enums in bitfields is MSVC. */
237 #define ENUM_BF(TYPE) unsigned int
239 #define ENUM_BF(TYPE) enum TYPE
245 /* Integer. XINT (obj) is the integer value. */
247 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
249 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
252 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
253 whose first member indicates the subtype. */
256 /* String. XSTRING (object) points to a struct Lisp_String.
257 The length of the string, and its contents, are stored therein. */
258 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
260 /* Vector of Lisp objects, or something resembling it.
261 XVECTOR (object) points to a struct Lisp_Vector, which contains
262 the size and contents. The size field also contains the type
263 information, if it's not a real vector object. */
266 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
272 /* This is the set of data types that share a common structure.
273 The first member of the structure is a type code from this set.
274 The enum values are arbitrary, but we'll use large numbers to make it
275 more likely that we'll spot the error if a random word in memory is
276 mistakenly interpreted as a Lisp_Misc. */
279 Lisp_Misc_Free
= 0x5eab,
282 Lisp_Misc_Save_Value
,
283 /* Currently floats are not a misc type,
284 but let's define this in case we want to change that. */
286 /* This is not a type code. It is for range checking. */
290 /* These are the types of forwarding objects used in the value slot
291 of symbols for special built-in variables whose value is stored in
295 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
296 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
297 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
298 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
299 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
302 /* If you want to define a new Lisp data type, here are some
303 instructions. See the thread at
304 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
307 First, there are already a couple of Lisp types that can be used if
308 your new type does not need to be exposed to Lisp programs nor
309 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
310 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
311 is suitable for temporarily stashing away pointers and integers in
312 a Lisp object (see the existing uses of make_save_value and
313 XSAVE_VALUE). The latter is useful for vector-like Lisp objects
314 that need to be used as part of other objects, but which are never
315 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
318 These two types don't look pretty when printed, so they are
319 unsuitable for Lisp objects that can be exposed to users.
321 To define a new data type, add one more Lisp_Misc subtype or one
322 more pseudovector subtype. Pseudovectors are more suitable for
323 objects with several slots that need to support fast random access,
324 while Lisp_Misc types are for everything else. A pseudovector object
325 provides one or more slots for Lisp objects, followed by struct
326 members that are accessible only from C. A Lisp_Misc object is a
327 wrapper for a C struct that can contain anything you like.
329 Explicit freeing is discouraged for Lisp objects in general. But if
330 you really need to exploit this, use Lisp_Misc (check free_misc in
331 alloc.c to see why). There is no way to free a vectorlike object.
333 To add a new pseudovector type, extend the pvec_type enumeration;
334 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
336 For a Lisp_Misc, you will also need to add your entry to union
337 Lisp_Misc (but make sure the first word has the same structure as
338 the others, starting with a 16-bit member of the Lisp_Misc_Type
339 enumeration and a 1-bit GC markbit) and make sure the overall size
340 of the union is not increased by your addition.
342 For a new pseudovector, it's highly desirable to limit the size
343 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
344 Otherwise you will need to change sweep_vectors (also in alloc.c).
346 Then you will need to add switch branches in print.c (in
347 print_object, to print your object, and possibly also in
348 print_preprocess) and to alloc.c, to mark your object (in
349 mark_object) and to free it (in gc_sweep). The latter is also the
350 right place to call any code specific to your data type that needs
351 to run when the object is recycled -- e.g., free any additional
352 resources allocated for it that are not Lisp objects. You can even
353 make a pointer to the function that frees the resources a slot in
354 your object -- this way, the same object could be used to represent
355 several disparate C structures. */
357 #ifdef CHECK_LISP_OBJECT_TYPE
359 typedef struct { EMACS_INT i
; } Lisp_Object
;
362 LISP_INLINE Lisp_Object
365 Lisp_Object o
= { i
};
369 LISP_INLINE Lisp_Object
370 LISP_MAKE_RVALUE (Lisp_Object o
)
375 #define LISP_INITIALLY_ZERO {0}
377 #undef CHECK_LISP_OBJECT_TYPE
378 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
379 #else /* CHECK_LISP_OBJECT_TYPE */
381 /* If a struct type is not wanted, define Lisp_Object as just a number. */
383 typedef EMACS_INT Lisp_Object
;
386 #define LISP_MAKE_RVALUE(o) (0 + (o))
387 #define LISP_INITIALLY_ZERO 0
388 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
389 #endif /* CHECK_LISP_OBJECT_TYPE */
391 /* In the size word of a vector, this bit means the vector has been marked. */
393 static ptrdiff_t const ARRAY_MARK_FLAG
394 #define ARRAY_MARK_FLAG PTRDIFF_MIN
397 /* In the size word of a struct Lisp_Vector, this bit means it's really
398 some other vector-like object. */
399 static ptrdiff_t const PSEUDOVECTOR_FLAG
400 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
403 /* In a pseudovector, the size field actually contains a word with one
404 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
405 with PVEC_TYPE_MASK to indicate the actual type. */
417 PVEC_WINDOW_CONFIGURATION
,
420 /* These should be last, check internal_equal to see why. */
424 PVEC_FONT
/* Should be last because it's used for range checking. */
427 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
428 which were stored in a Lisp_Object. */
429 #ifndef DATA_SEG_BITS
430 # define DATA_SEG_BITS 0
432 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
437 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
439 /* For convenience, we also store the number of elements in these bits.
440 Note that this size is not necessarily the memory-footprint size, but
441 only the number of Lisp_Object fields (that need to be traced by GC).
442 The distinction is used, e.g., by Lisp_Process, which places extra
443 non-Lisp_Object fields at the end of the structure. */
444 PSEUDOVECTOR_SIZE_BITS
= 12,
445 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
447 /* To calculate the memory footprint of the pseudovector, it's useful
448 to store the size of non-Lisp area in word_size units here. */
449 PSEUDOVECTOR_REST_BITS
= 12,
450 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
451 << PSEUDOVECTOR_SIZE_BITS
),
453 /* Used to extract pseudovector subtype information. */
454 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
455 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
,
457 /* Number of bits to put in each character in the internal representation
458 of bool vectors. This should not vary across implementations. */
459 BOOL_VECTOR_BITS_PER_CHAR
= 8
462 /* These macros extract various sorts of values from a Lisp_Object.
463 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
464 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
470 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
473 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
474 #define XINT(a) (XLI (a) >> INTTYPEBITS)
475 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
476 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
477 #define make_lisp_ptr(ptr, type) \
478 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
479 XIL ((type) | (intptr_t) (ptr)))
481 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
482 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
484 #else /* not USE_LSB_TAG */
486 static EMACS_INT
const VALMASK
487 #define VALMASK VAL_MAX
490 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
492 /* For integers known to be positive, XFASTINT provides fast retrieval
493 and XSETFASTINT provides fast storage. This takes advantage of the
494 fact that Lisp integers have zero-bits in their tags. */
495 #define XFASTINT(a) (XLI (a) + 0)
496 #define XSETFASTINT(a, b) ((a) = XIL (b))
498 /* Extract the value of a Lisp_Object as a (un)signed integer. */
500 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
501 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
502 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
504 #define make_lisp_ptr(ptr, type) \
505 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
506 + ((intptr_t) (ptr) & VALMASK)))
509 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
510 which were stored in a Lisp_Object. */
511 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
513 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
516 #endif /* not USE_LSB_TAG */
518 /* Return a (Lisp-integer sized) hash of the Lisp_Object value. Happens to be
519 like XUINT right now, but XUINT should only be applied to objects we know
521 #define XHASH(a) XUINT (a)
523 /* For integers known to be positive, XFASTINT sometimes provides
524 faster retrieval and XSETFASTINT provides faster storage.
525 If not, fallback on the non-accelerated path. */
527 # define XFASTINT(a) (XINT (a))
528 # define XSETFASTINT(a, b) (XSETINT (a, b))
531 /* Extract the pointer value of the Lisp object A, under the
532 assumption that A's type is TYPE. This is a fallback
533 implementation if nothing faster is available. */
535 # define XUNTAG(a, type) XPNTR (a)
538 #define EQ(x, y) (XLI (x) == XLI (y))
540 /* Largest and smallest representable fixnum values. These are the C
541 values. They are macros for use in static initializers. */
542 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
543 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
545 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
546 written this way so that it also works if I is of unsigned
547 type or if I is a NaN. */
549 #define FIXNUM_OVERFLOW_P(i) \
550 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
552 LISP_INLINE
ptrdiff_t
553 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
555 return num
< lower
? lower
: num
<= upper
? num
: upper
;
558 /* Extract a value or address from a Lisp_Object. */
560 #define XCONS(a) (eassert (CONSP (a)), \
561 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
562 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
563 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
564 #define XSTRING(a) (eassert (STRINGP (a)), \
565 (struct Lisp_String *) XUNTAG (a, Lisp_String))
566 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
567 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
568 #define XFLOAT(a) (eassert (FLOATP (a)), \
569 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
573 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
574 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
575 #define XMISCTYPE(a) (XMISCANY (a)->type)
576 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
577 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
578 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
580 /* Forwarding object types. */
582 #define XFWDTYPE(a) (a->u_intfwd.type)
583 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
584 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
585 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
586 #define XBUFFER_OBJFWD(a) \
587 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
588 #define XKBOARD_OBJFWD(a) \
589 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
591 /* Pseudovector types. */
593 #define XPROCESS(a) (eassert (PROCESSP (a)), \
594 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
595 #define XWINDOW(a) (eassert (WINDOWP (a)), \
596 (struct window *) XUNTAG (a, Lisp_Vectorlike))
597 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
598 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
599 #define XSUBR(a) (eassert (SUBRP (a)), \
600 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
601 #define XBUFFER(a) (eassert (BUFFERP (a)), \
602 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
603 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
604 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
605 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
606 ((struct Lisp_Sub_Char_Table *) \
607 XUNTAG (a, Lisp_Vectorlike)))
608 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
609 ((struct Lisp_Bool_Vector *) \
610 XUNTAG (a, Lisp_Vectorlike)))
612 /* Construct a Lisp_Object from a value or address. */
614 #define XSETINT(a, b) ((a) = make_number (b))
615 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
616 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
617 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
618 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
619 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
623 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
624 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
626 /* Pseudovector types. */
628 #define XSETPVECTYPE(v, code) \
629 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
630 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
631 ((v)->header.size = (PSEUDOVECTOR_FLAG \
632 | ((code) << PSEUDOVECTOR_AREA_BITS) \
633 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
636 /* The cast to struct vectorlike_header * avoids aliasing issues. */
637 #define XSETPSEUDOVECTOR(a, b, code) \
638 XSETTYPED_PSEUDOVECTOR (a, b, \
639 (((struct vectorlike_header *) \
640 XUNTAG (a, Lisp_Vectorlike)) \
643 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
644 (XSETVECTOR (a, b), \
645 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
646 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
648 #define XSETWINDOW_CONFIGURATION(a, b) \
649 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
650 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
651 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
652 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
653 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
654 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
655 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
656 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
657 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
658 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
660 /* Convenience macros for dealing with Lisp arrays. */
662 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
663 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
664 #define ASET(ARRAY, IDX, VAL) \
665 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
666 XVECTOR (ARRAY)->contents[IDX] = (VAL))
668 /* Convenience macros for dealing with Lisp strings. */
670 #define SDATA(string) (XSTRING (string)->data + 0)
671 #define SREF(string, index) (SDATA (string)[index] + 0)
672 #define SSET(string, index, new) (SDATA (string)[index] = (new))
673 #define SCHARS(string) (XSTRING (string)->size + 0)
674 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
676 /* Avoid "differ in sign" warnings. */
677 #define SSDATA(x) ((char *) SDATA (x))
679 #define STRING_SET_CHARS(string, newsize) \
680 (XSTRING (string)->size = (newsize))
682 #define STRING_COPYIN(string, index, new, count) \
683 memcpy (SDATA (string) + index, new, count)
687 #define CHECK_TYPE(ok, Qxxxp, x) \
688 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
690 /* Deprecated and will be removed soon. */
692 #define INTERNAL_FIELD(field) field ## _
694 /* See the macros in intervals.h. */
696 typedef struct interval
*INTERVAL
;
698 /* Complain if object is not string or buffer type. */
699 #define CHECK_STRING_OR_BUFFER(x) \
700 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
704 /* Car of this cons cell. */
709 /* Cdr of this cons cell. */
712 /* Used to chain conses on a free list. */
713 struct Lisp_Cons
*chain
;
717 /* Take the car or cdr of something known to be a cons cell. */
718 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
719 of code that has to know what a cons cell looks like. Other code not
720 part of the basic lisp implementation should assume that the car and cdr
721 fields are not accessible as lvalues. (What if we want to switch to
722 a copying collector someday? Cached cons cell field addresses may be
723 invalidated at arbitrary points.) */
724 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
725 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
727 /* Use these from normal code. */
728 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
729 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
731 /* Use these to set the fields of a cons cell.
733 Note that both arguments may refer to the same object, so 'n'
734 should not be read after 'c' is first modified. Also, neither
735 argument should be evaluated more than once; side effects are
736 especially common in the second argument. */
737 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
738 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
740 /* Take the car or cdr of something whose type is not known. */
742 (CONSP ((c)) ? XCAR ((c)) \
743 : NILP ((c)) ? Qnil \
744 : wrong_type_argument (Qlistp, (c)))
747 (CONSP ((c)) ? XCDR ((c)) \
748 : NILP ((c)) ? Qnil \
749 : wrong_type_argument (Qlistp, (c)))
751 /* Take the car or cdr of something whose type is not known. */
752 #define CAR_SAFE(c) \
753 (CONSP ((c)) ? XCAR ((c)) : Qnil)
755 #define CDR_SAFE(c) \
756 (CONSP ((c)) ? XCDR ((c)) : Qnil)
758 /* True if STR is a multibyte string. */
759 #define STRING_MULTIBYTE(STR) \
760 (XSTRING (STR)->size_byte >= 0)
762 /* Return the length in bytes of STR. */
764 #ifdef GC_CHECK_STRING_BYTES
767 extern ptrdiff_t string_bytes (struct Lisp_String
*);
768 #define STRING_BYTES(S) string_bytes ((S))
770 #else /* not GC_CHECK_STRING_BYTES */
772 #define STRING_BYTES(STR) \
773 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
775 #endif /* not GC_CHECK_STRING_BYTES */
777 /* An upper bound on the number of bytes in a Lisp string, not
778 counting the terminating null. This a tight enough bound to
779 prevent integer overflow errors that would otherwise occur during
780 string size calculations. A string cannot contain more bytes than
781 a fixnum can represent, nor can it be so long that C pointer
782 arithmetic stops working on the string plus its terminating null.
783 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
784 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
785 would expose alloc.c internal details that we'd rather keep
788 This is a macro for use in static initializers, and a constant for
789 visibility to GDB. The cast to ptrdiff_t ensures that
790 the macro is signed. */
791 static ptrdiff_t const STRING_BYTES_BOUND
=
792 #define STRING_BYTES_BOUND \
793 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
796 /* Mark STR as a unibyte string. */
797 #define STRING_SET_UNIBYTE(STR) \
798 do { if (EQ (STR, empty_multibyte_string)) \
799 (STR) = empty_unibyte_string; \
800 else XSTRING (STR)->size_byte = -1; } while (0)
802 /* Mark STR as a multibyte string. Assure that STR contains only
803 ASCII characters in advance. */
804 #define STRING_SET_MULTIBYTE(STR) \
805 do { if (EQ (STR, empty_unibyte_string)) \
806 (STR) = empty_multibyte_string; \
807 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
809 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
815 INTERVAL intervals
; /* Text properties in this string. */
819 /* Header of vector-like objects. This documents the layout constraints on
820 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
821 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
822 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
823 because when two such pointers potentially alias, a compiler won't
824 incorrectly reorder loads and stores to their size fields. See
825 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
826 struct vectorlike_header
828 /* The only field contains various pieces of information:
829 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
830 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
831 vector (0) or a pseudovector (1).
832 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
833 of slots) of the vector.
834 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
835 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
836 - b) number of Lisp_Objects slots at the beginning of the object
837 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
839 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
840 measured in word_size units. Rest fields may also include
841 Lisp_Objects, but these objects usually needs some special treatment
843 There are some exceptions. For PVEC_FREE, b) is always zero. For
844 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
845 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
846 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
850 /* Regular vector is just a header plus array of Lisp_Objects. */
854 struct vectorlike_header header
;
855 Lisp_Object contents
[1];
858 /* A boolvector is a kind of vectorlike, with contents are like a string. */
860 struct Lisp_Bool_Vector
862 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
863 just the subtype information. */
864 struct vectorlike_header header
;
865 /* This is the size in bits. */
867 /* This contains the actual bits, packed into bytes. */
868 unsigned char data
[1];
871 /* Some handy constants for calculating sizes
872 and offsets, mostly of vectorlike objects. */
876 header_size
= offsetof (struct Lisp_Vector
, contents
),
877 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
878 word_size
= sizeof (Lisp_Object
)
881 /* If a struct is made to look like a vector, this macro returns the length
882 of the shortest vector that would hold that struct. */
884 #define VECSIZE(type) \
885 ((sizeof (type) - header_size + word_size - 1) / word_size)
887 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
888 at the end and we need to compute the number of Lisp_Object fields (the
889 ones that the GC needs to trace). */
891 #define PSEUDOVECSIZE(type, nonlispfield) \
892 ((offsetof (type, nonlispfield) - header_size) / word_size)
894 /* A char-table is a kind of vectorlike, with contents are like a
895 vector but with a few other slots. For some purposes, it makes
896 sense to handle a char-table with type struct Lisp_Vector. An
897 element of a char table can be any Lisp objects, but if it is a sub
898 char-table, we treat it a table that contains information of a
899 specific range of characters. A sub char-table has the same
900 structure as a vector. A sub char table appears only in an element
901 of a char-table, and there's no way to access it directly from
902 Emacs Lisp program. */
906 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
907 ({struct Lisp_Char_Table *_tbl = NULL; \
910 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
911 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
912 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
914 _val = _tbl->defalt; \
915 } while (NILP (_val) && ! NILP (_tbl->parent)); \
918 #else /* not __GNUC__ */
920 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
921 (! NILP (XCHAR_TABLE (CT)->ascii) \
922 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
923 ? XCHAR_TABLE (CT)->ascii \
924 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
925 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
926 : char_table_ref ((CT), (IDX))) \
927 : char_table_ref ((CT), (IDX)))
929 #endif /* not __GNUC__ */
931 /* Compute A OP B, using the unsigned comparison operator OP. A and B
932 should be integer expressions. This is not the same as
933 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
934 returns 1. For efficiency, prefer plain unsigned comparison if A
935 and B's sizes both fit (after integer promotion). */
936 #define UNSIGNED_CMP(a, op, b) \
937 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
938 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
939 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
941 /* Nonzero iff C is an ASCII character. */
942 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
944 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
945 characters. Do not check validity of CT. */
946 #define CHAR_TABLE_REF(CT, IDX) \
947 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
948 : char_table_ref ((CT), (IDX)))
950 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
951 8-bit European characters. Do not check validity of CT. */
952 #define CHAR_TABLE_SET(CT, IDX, VAL) \
953 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
954 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
955 : char_table_set (CT, IDX, VAL))
957 enum CHARTAB_SIZE_BITS
959 CHARTAB_SIZE_BITS_0
= 6,
960 CHARTAB_SIZE_BITS_1
= 4,
961 CHARTAB_SIZE_BITS_2
= 5,
962 CHARTAB_SIZE_BITS_3
= 7
965 extern const int chartab_size
[4];
967 struct Lisp_Char_Table
969 /* HEADER.SIZE is the vector's size field, which also holds the
970 pseudovector type information. It holds the size, too.
971 The size counts the defalt, parent, purpose, ascii,
972 contents, and extras slots. */
973 struct vectorlike_header header
;
975 /* This holds a default value,
976 which is used whenever the value for a specific character is nil. */
979 /* This points to another char table, which we inherit from when the
980 value for a specific character is nil. The `defalt' slot takes
981 precedence over this. */
984 /* This is a symbol which says what kind of use this char-table is
988 /* The bottom sub char-table for characters of the range 0..127. It
989 is nil if none of ASCII character has a specific value. */
992 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
994 /* These hold additional data. It is a vector. */
995 Lisp_Object extras
[1];
998 struct Lisp_Sub_Char_Table
1000 /* HEADER.SIZE is the vector's size field, which also holds the
1001 pseudovector type information. It holds the size, too. */
1002 struct vectorlike_header header
;
1004 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1005 char-table of depth 1 contains 16 elements, and each element
1006 covers 4096 (128*32) characters. A sub char-table of depth 2
1007 contains 32 elements, and each element covers 128 characters. A
1008 sub char-table of depth 3 contains 128 elements, and each element
1009 is for one character. */
1012 /* Minimum character covered by the sub char-table. */
1013 Lisp_Object min_char
;
1015 /* Use set_sub_char_table_contents to set this. */
1016 Lisp_Object contents
[1];
1019 /* This structure describes a built-in function.
1020 It is generated by the DEFUN macro only.
1021 defsubr makes it into a Lisp object. */
1025 struct vectorlike_header header
;
1027 Lisp_Object (*a0
) (void);
1028 Lisp_Object (*a1
) (Lisp_Object
);
1029 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1030 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1031 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1032 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1033 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1034 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1035 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1036 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1037 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1039 short min_args
, max_args
;
1040 const char *symbol_name
;
1041 const char *intspec
;
1045 /* This is the number of slots that every char table must have. This
1046 counts the ordinary slots and the top, defalt, parent, and purpose
1048 enum CHAR_TABLE_STANDARD_SLOTS
1050 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1053 /* Return the number of "extra" slots in the char table CT. */
1055 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1056 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1059 /***********************************************************************
1061 ***********************************************************************/
1063 /* Interned state of a symbol. */
1065 enum symbol_interned
1067 SYMBOL_UNINTERNED
= 0,
1068 SYMBOL_INTERNED
= 1,
1069 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1072 enum symbol_redirect
1074 SYMBOL_PLAINVAL
= 4,
1075 SYMBOL_VARALIAS
= 1,
1076 SYMBOL_LOCALIZED
= 2,
1077 SYMBOL_FORWARDED
= 3
1082 unsigned gcmarkbit
: 1;
1084 /* Indicates where the value can be found:
1085 0 : it's a plain var, the value is in the `value' field.
1086 1 : it's a varalias, the value is really in the `alias' symbol.
1087 2 : it's a localized var, the value is in the `blv' object.
1088 3 : it's a forwarding variable, the value is in `forward'. */
1089 ENUM_BF (symbol_redirect
) redirect
: 3;
1091 /* Non-zero means symbol is constant, i.e. changing its value
1092 should signal an error. If the value is 3, then the var
1093 can be changed, but only by `defconst'. */
1094 unsigned constant
: 2;
1096 /* Interned state of the symbol. This is an enumerator from
1097 enum symbol_interned. */
1098 unsigned interned
: 2;
1100 /* Non-zero means that this variable has been explicitly declared
1101 special (with `defvar' etc), and shouldn't be lexically bound. */
1102 unsigned declared_special
: 1;
1104 /* The symbol's name, as a Lisp string. */
1107 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1108 union is used depends on the `redirect' field above. */
1111 struct Lisp_Symbol
*alias
;
1112 struct Lisp_Buffer_Local_Value
*blv
;
1113 union Lisp_Fwd
*fwd
;
1116 /* Function value of the symbol or Qnil if not fboundp. */
1117 Lisp_Object function
;
1119 /* The symbol's property list. */
1122 /* Next symbol in obarray bucket, if the symbol is interned. */
1123 struct Lisp_Symbol
*next
;
1126 /* Value is name of symbol. */
1128 #define SYMBOL_VAL(sym) \
1129 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1130 #define SYMBOL_ALIAS(sym) \
1131 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1132 #define SYMBOL_BLV(sym) \
1133 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1134 #define SYMBOL_FWD(sym) \
1135 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1136 #define SET_SYMBOL_VAL(sym, v) \
1137 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1138 #define SET_SYMBOL_ALIAS(sym, v) \
1139 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1140 #define SET_SYMBOL_BLV(sym, v) \
1141 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1142 #define SET_SYMBOL_FWD(sym, v) \
1143 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1145 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1147 /* Value is non-zero if SYM is an interned symbol. */
1149 #define SYMBOL_INTERNED_P(sym) \
1150 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1152 /* Value is non-zero if SYM is interned in initial_obarray. */
1154 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1155 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1157 /* Value is non-zero if symbol is considered a constant, i.e. its
1158 value cannot be changed (there is an exception for keyword symbols,
1159 whose value can be set to the keyword symbol itself). */
1161 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1163 #define DEFSYM(sym, name) \
1164 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1167 /***********************************************************************
1169 ***********************************************************************/
1171 /* The structure of a Lisp hash table. */
1173 struct hash_table_test
1175 /* Name of the function used to compare keys. */
1178 /* User-supplied hash function, or nil. */
1179 Lisp_Object user_hash_function
;
1181 /* User-supplied key comparison function, or nil. */
1182 Lisp_Object user_cmp_function
;
1184 /* C function to compare two keys. */
1185 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1187 /* C function to compute hash code. */
1188 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1191 struct Lisp_Hash_Table
1193 /* This is for Lisp; the hash table code does not refer to it. */
1194 struct vectorlike_header header
;
1196 /* Nil if table is non-weak. Otherwise a symbol describing the
1197 weakness of the table. */
1200 /* When the table is resized, and this is an integer, compute the
1201 new size by adding this to the old size. If a float, compute the
1202 new size by multiplying the old size with this factor. */
1203 Lisp_Object rehash_size
;
1205 /* Resize hash table when number of entries/ table size is >= this
1207 Lisp_Object rehash_threshold
;
1209 /* Vector of hash codes.. If hash[I] is nil, this means that that
1210 entry I is unused. */
1213 /* Vector used to chain entries. If entry I is free, next[I] is the
1214 entry number of the next free item. If entry I is non-free,
1215 next[I] is the index of the next entry in the collision chain. */
1218 /* Index of first free entry in free list. */
1219 Lisp_Object next_free
;
1221 /* Bucket vector. A non-nil entry is the index of the first item in
1222 a collision chain. This vector's size can be larger than the
1223 hash table size to reduce collisions. */
1226 /* Only the fields above are traced normally by the GC. The ones below
1227 `count' are special and are either ignored by the GC or traced in
1228 a special way (e.g. because of weakness). */
1230 /* Number of key/value entries in the table. */
1233 /* Vector of keys and values. The key of item I is found at index
1234 2 * I, the value is found at index 2 * I + 1.
1235 This is gc_marked specially if the table is weak. */
1236 Lisp_Object key_and_value
;
1238 /* The comparison and hash functions. */
1239 struct hash_table_test test
;
1241 /* Next weak hash table if this is a weak hash table. The head
1242 of the list is in weak_hash_tables. */
1243 struct Lisp_Hash_Table
*next_weak
;
1247 #define XHASH_TABLE(OBJ) \
1248 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1250 #define XSET_HASH_TABLE(VAR, PTR) \
1251 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1253 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1255 #define CHECK_HASH_TABLE(x) \
1256 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1258 /* Value is the key part of entry IDX in hash table H. */
1260 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1262 /* Value is the value part of entry IDX in hash table H. */
1264 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1266 /* Value is the index of the next entry following the one at IDX
1269 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1271 /* Value is the hash code computed for entry IDX in hash table H. */
1273 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1275 /* Value is the index of the element in hash table H that is the
1276 start of the collision list at index IDX in the index vector of H. */
1278 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1280 /* Value is the size of hash table H. */
1282 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1284 /* Default size for hash tables if not specified. */
1286 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1288 /* Default threshold specifying when to resize a hash table. The
1289 value gives the ratio of current entries in the hash table and the
1290 size of the hash table. */
1292 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1294 /* Default factor by which to increase the size of a hash table. */
1296 static double const DEFAULT_REHASH_SIZE
= 1.5;
1298 /* Combine two integers X and Y for hashing. The result might not fit
1299 into a Lisp integer. */
1301 LISP_INLINE EMACS_UINT
1302 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1304 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1307 /* Hash X, returning a value that fits into a fixnum. */
1309 LISP_INLINE EMACS_UINT
1310 SXHASH_REDUCE (EMACS_UINT x
)
1312 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1315 /* These structures are used for various misc types. */
1317 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1319 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1320 unsigned gcmarkbit
: 1;
1326 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1327 unsigned gcmarkbit
: 1;
1329 /* This flag is temporarily used in the functions
1330 decode/encode_coding_object to record that the marker position
1331 must be adjusted after the conversion. */
1332 unsigned int need_adjustment
: 1;
1333 /* 1 means normal insertion at the marker's position
1334 leaves the marker after the inserted text. */
1335 unsigned int insertion_type
: 1;
1336 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1337 Note: a chain of markers can contain markers pointing into different
1338 buffers (the chain is per buffer_text rather than per buffer, so it's
1339 shared between indirect buffers). */
1340 /* This is used for (other than NULL-checking):
1342 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1343 - unchain_marker: to find the list from which to unchain.
1344 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1346 struct buffer
*buffer
;
1348 /* The remaining fields are meaningless in a marker that
1349 does not point anywhere. */
1351 /* For markers that point somewhere,
1352 this is used to chain of all the markers in a given buffer. */
1353 /* We could remove it and use an array in buffer_text instead.
1354 That would also allow to preserve it ordered. */
1355 struct Lisp_Marker
*next
;
1356 /* This is the char position where the marker points. */
1358 /* This is the byte position.
1359 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1360 used to implement the functionality of markers, but rather to (ab)use
1361 markers as a cache for char<->byte mappings). */
1365 /* START and END are markers in the overlay's buffer, and
1366 PLIST is the overlay's property list. */
1368 /* An overlay's real data content is:
1370 - buffer (really there are two buffer pointers, one per marker,
1371 and both points to the same buffer)
1372 - insertion type of both ends (per-marker fields)
1373 - start & start byte (of start marker)
1374 - end & end byte (of end marker)
1375 - next (singly linked list of overlays)
1376 - next fields of start and end markers (singly linked list of markers).
1377 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1380 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1381 unsigned gcmarkbit
: 1;
1383 struct Lisp_Overlay
*next
;
1389 /* Types of data which may be saved in a Lisp_Save_Value. */
1399 /* Special object used to hold a different values for later use.
1401 This is mostly used to package C integers and pointers to call
1402 record_unwind_protect. Typical task is to pass just one C pointer
1403 to unwind function. You should pack pointer with make_save_pointer
1404 and then get it back with XSAVE_POINTER, e.g.:
1407 struct my_data *md = get_my_data ();
1408 record_unwind_protect (my_unwind, make_save_pointer (md));
1411 Lisp_Object my_unwind (Lisp_Object arg)
1413 struct my_data *md = XSAVE_POINTER (arg, 0);
1417 If yon need to pass more than just one C pointer, you should
1418 use make_save_value. This function allows you to pack up to
1419 4 integers, pointers or Lisp_Objects and conveniently get them
1420 back with XSAVE_POINTER, XSAVE_INTEGER and XSAVE_OBJECT macros:
1423 struct my_data *md = get_my_data ();
1424 ptrdiff_t my_offset = get_my_offset ();
1425 Lisp_Object my_object = get_my_object ();
1426 record_unwind_protect
1427 (my_unwind, make_save_value ("pio", md, my_offset, my_object));
1430 Lisp_Object my_unwind (Lisp_Object arg)
1432 struct my_data *md = XSAVE_POINTER (arg, 0);
1433 ptrdiff_t my_offset = XSAVE_INTEGER (arg, 1);
1434 Lisp_Object my_object = XSAVE_OBJECT (arg, 2);
1438 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1439 saved objects and raise eassert if type of the saved object doesn't match
1440 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1441 or XSAVE_OBJECT (arg, 1) are wrong because integer was saved in slot 1 and
1442 Lisp_Object was saved in slot 2 of ARG. */
1444 struct Lisp_Save_Value
1446 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1447 unsigned gcmarkbit
: 1;
1449 /* If `area' is nonzero, `data[0].pointer' is the address of a memory area
1450 containing `data[1].integer' potential Lisp_Objects. The rest of `data'
1451 fields are unused. */
1453 /* If `area' is zero, `data[N]' may hold different objects which type is
1454 encoded in `typeN' fields as described by the anonymous enum above.
1455 E.g. if `type0' is SAVE_INTEGER, `data[0].integer' is in use. */
1467 /* Macro to set and extract Nth saved pointer. Type
1468 checking is ugly because it's used as an lvalue. */
1470 #define XSAVE_POINTER(obj, n) \
1471 XSAVE_VALUE (obj)->data[(eassert (XSAVE_VALUE (obj)->type \
1472 ## n == SAVE_POINTER), n)].pointer
1474 /* Likewise for the saved integer. */
1476 #define XSAVE_INTEGER(obj, n) \
1477 XSAVE_VALUE (obj)->data[(eassert (XSAVE_VALUE (obj)->type \
1478 ## n == SAVE_INTEGER), n)].integer
1480 /* Macro to extract Nth saved object. This is never used as
1481 an lvalue, so we can do more convenient type checking. */
1483 #define XSAVE_OBJECT(obj, n) \
1484 (eassert (XSAVE_VALUE (obj)->type ## n == SAVE_OBJECT), \
1485 XSAVE_VALUE (obj)->data[n].object)
1487 /* A miscellaneous object, when it's on the free list. */
1490 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1491 unsigned gcmarkbit
: 1;
1493 union Lisp_Misc
*chain
;
1496 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1497 It uses one of these struct subtypes to get the type field. */
1501 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1502 struct Lisp_Free u_free
;
1503 struct Lisp_Marker u_marker
;
1504 struct Lisp_Overlay u_overlay
;
1505 struct Lisp_Save_Value u_save_value
;
1508 /* Forwarding pointer to an int variable.
1509 This is allowed only in the value cell of a symbol,
1510 and it means that the symbol's value really lives in the
1511 specified int variable. */
1514 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1518 /* Boolean forwarding pointer to an int variable.
1519 This is like Lisp_Intfwd except that the ostensible
1520 "value" of the symbol is t if the int variable is nonzero,
1521 nil if it is zero. */
1524 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1528 /* Forwarding pointer to a Lisp_Object variable.
1529 This is allowed only in the value cell of a symbol,
1530 and it means that the symbol's value really lives in the
1531 specified variable. */
1534 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1535 Lisp_Object
*objvar
;
1538 /* Like Lisp_Objfwd except that value lives in a slot in the
1539 current buffer. Value is byte index of slot within buffer. */
1540 struct Lisp_Buffer_Objfwd
1542 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1544 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
1545 Lisp_Object predicate
;
1548 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1549 the symbol has buffer-local or frame-local bindings. (Exception:
1550 some buffer-local variables are built-in, with their values stored
1551 in the buffer structure itself. They are handled differently,
1552 using struct Lisp_Buffer_Objfwd.)
1554 The `realvalue' slot holds the variable's current value, or a
1555 forwarding pointer to where that value is kept. This value is the
1556 one that corresponds to the loaded binding. To read or set the
1557 variable, you must first make sure the right binding is loaded;
1558 then you can access the value in (or through) `realvalue'.
1560 `buffer' and `frame' are the buffer and frame for which the loaded
1561 binding was found. If those have changed, to make sure the right
1562 binding is loaded it is necessary to find which binding goes with
1563 the current buffer and selected frame, then load it. To load it,
1564 first unload the previous binding, then copy the value of the new
1565 binding into `realvalue' (or through it). Also update
1566 LOADED-BINDING to point to the newly loaded binding.
1568 `local_if_set' indicates that merely setting the variable creates a
1569 local binding for the current buffer. Otherwise the latter, setting
1570 the variable does not do that; only make-local-variable does that. */
1572 struct Lisp_Buffer_Local_Value
1574 /* 1 means that merely setting the variable creates a local
1575 binding for the current buffer. */
1576 unsigned int local_if_set
: 1;
1577 /* 1 means this variable can have frame-local bindings, otherwise, it is
1578 can have buffer-local bindings. The two cannot be combined. */
1579 unsigned int frame_local
: 1;
1580 /* 1 means that the binding now loaded was found.
1581 Presumably equivalent to (defcell!=valcell). */
1582 unsigned int found
: 1;
1583 /* If non-NULL, a forwarding to the C var where it should also be set. */
1584 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1585 /* The buffer or frame for which the loaded binding was found. */
1587 /* A cons cell that holds the default value. It has the form
1588 (SYMBOL . DEFAULT-VALUE). */
1589 Lisp_Object defcell
;
1590 /* The cons cell from `where's parameter alist.
1591 It always has the form (SYMBOL . VALUE)
1592 Note that if `forward' is non-nil, VALUE may be out of date.
1593 Also if the currently loaded binding is the default binding, then
1594 this is `eq'ual to defcell. */
1595 Lisp_Object valcell
;
1598 /* Like Lisp_Objfwd except that value lives in a slot in the
1600 struct Lisp_Kboard_Objfwd
1602 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1608 struct Lisp_Intfwd u_intfwd
;
1609 struct Lisp_Boolfwd u_boolfwd
;
1610 struct Lisp_Objfwd u_objfwd
;
1611 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1612 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1615 /* Lisp floating point type. */
1621 struct Lisp_Float
*chain
;
1625 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1626 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1628 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1629 representations, have infinities and NaNs, and do not trap on
1630 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1631 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1632 wanted here, but is not quite right because Emacs does not require
1633 all the features of C11 Annex F (and does not require C11 at all,
1634 for that matter). */
1635 #define IEEE_FLOATING_POINT (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
1636 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
1638 /* A character, declared with the following typedef, is a member
1639 of some character set associated with the current buffer. */
1640 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1642 typedef unsigned char UCHAR
;
1645 /* Meanings of slots in a Lisp_Compiled: */
1649 COMPILED_ARGLIST
= 0,
1650 COMPILED_BYTECODE
= 1,
1651 COMPILED_CONSTANTS
= 2,
1652 COMPILED_STACK_DEPTH
= 3,
1653 COMPILED_DOC_STRING
= 4,
1654 COMPILED_INTERACTIVE
= 5
1657 /* Flag bits in a character. These also get used in termhooks.h.
1658 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1659 (MUlti-Lingual Emacs) might need 22 bits for the character value
1660 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1663 CHAR_ALT
= 0x0400000,
1664 CHAR_SUPER
= 0x0800000,
1665 CHAR_HYPER
= 0x1000000,
1666 CHAR_SHIFT
= 0x2000000,
1667 CHAR_CTL
= 0x4000000,
1668 CHAR_META
= 0x8000000,
1670 CHAR_MODIFIER_MASK
=
1671 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1673 /* Actually, the current Emacs uses 22 bits for the character value
1681 /* The glyph datatype, used to represent characters on the display.
1682 It consists of a char code and a face id. */
1689 /* Return a glyph's character code. */
1690 #define GLYPH_CHAR(glyph) ((glyph).ch)
1692 /* Return a glyph's face ID. */
1693 #define GLYPH_FACE(glyph) ((glyph).face_id)
1695 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1696 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1697 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1699 /* Return 1 if GLYPH contains valid character code. */
1700 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1703 /* Glyph Code from a display vector may either be an integer which
1704 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1705 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1707 #define GLYPH_CODE_P(gc) \
1709 ? (CHARACTERP (XCAR (gc)) \
1710 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1711 : (RANGED_INTEGERP \
1713 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1714 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1715 : TYPE_MAXIMUM (EMACS_INT)))))
1717 /* The following are valid only if GLYPH_CODE_P (gc). */
1719 #define GLYPH_CODE_CHAR(gc) \
1720 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1722 #define GLYPH_CODE_FACE(gc) \
1723 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1725 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1729 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1731 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1732 (XINT (gc) >> CHARACTERBITS)); \
1736 /* Structure to hold mouse highlight data. This is here because other
1737 header files need it for defining struct x_output etc. */
1739 /* These variables describe the range of text currently shown in its
1740 mouse-face, together with the window they apply to. As long as
1741 the mouse stays within this range, we need not redraw anything on
1742 its account. Rows and columns are glyph matrix positions in
1743 MOUSE_FACE_WINDOW. */
1744 int mouse_face_beg_row
, mouse_face_beg_col
;
1745 int mouse_face_beg_x
, mouse_face_beg_y
;
1746 int mouse_face_end_row
, mouse_face_end_col
;
1747 int mouse_face_end_x
, mouse_face_end_y
;
1748 Lisp_Object mouse_face_window
;
1749 int mouse_face_face_id
;
1750 Lisp_Object mouse_face_overlay
;
1752 /* FRAME and X, Y position of mouse when last checked for
1753 highlighting. X and Y can be negative or out of range for the frame. */
1754 struct frame
*mouse_face_mouse_frame
;
1755 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1757 /* Nonzero if part of the text currently shown in
1758 its mouse-face is beyond the window end. */
1759 unsigned mouse_face_past_end
: 1;
1761 /* Nonzero means defer mouse-motion highlighting. */
1762 unsigned mouse_face_defer
: 1;
1764 /* Nonzero means that the mouse highlight should not be shown. */
1765 unsigned mouse_face_hidden
: 1;
1768 /* Data type checking. */
1770 #define NILP(x) EQ (x, Qnil)
1772 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1773 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1775 #define RANGED_INTEGERP(lo, x, hi) \
1776 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1777 #define TYPE_RANGED_INTEGERP(type, x) \
1778 (TYPE_SIGNED (type) \
1779 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1780 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1782 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1783 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1784 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1785 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1786 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1787 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1789 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1790 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1791 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1792 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1793 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1795 #define AUTOLOADP(x) (CONSP (x) && EQ (Qautoload, XCAR (x)))
1797 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1798 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1799 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1800 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1801 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1803 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1804 vectorlike_header * avoids aliasing issues. */
1805 #define PSEUDOVECTORP(x, code) \
1806 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1808 #define PSEUDOVECTOR_TYPEP(v, code) \
1809 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1810 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS)))
1812 /* True if object X, with internal type struct T *, is a pseudovector whose
1814 #define TYPED_PSEUDOVECTORP(x, t, code) \
1816 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1818 /* Test for specific pseudovector types. */
1819 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1820 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1821 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1822 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1823 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1824 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1825 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1826 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1827 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1828 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1829 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1831 /* Test for image (image . spec) */
1832 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1837 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1839 #define CHECK_LIST(x) \
1840 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1842 #define CHECK_LIST_CONS(x, y) \
1843 CHECK_TYPE (CONSP (x), Qlistp, y)
1845 #define CHECK_LIST_END(x, y) \
1846 CHECK_TYPE (NILP (x), Qlistp, y)
1848 #define CHECK_STRING(x) \
1849 CHECK_TYPE (STRINGP (x), Qstringp, x)
1851 #define CHECK_STRING_CAR(x) \
1852 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1854 #define CHECK_CONS(x) \
1855 CHECK_TYPE (CONSP (x), Qconsp, x)
1857 #define CHECK_SYMBOL(x) \
1858 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1860 #define CHECK_CHAR_TABLE(x) \
1861 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1863 #define CHECK_VECTOR(x) \
1864 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1866 #define CHECK_VECTOR_OR_STRING(x) \
1867 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1869 #define CHECK_ARRAY(x, Qxxxp) \
1870 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1872 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1873 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1875 #define CHECK_BUFFER(x) \
1876 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1878 #define CHECK_WINDOW(x) \
1879 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1881 #define CHECK_WINDOW_CONFIGURATION(x) \
1882 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1884 #define CHECK_PROCESS(x) \
1885 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1887 #define CHECK_SUBR(x) \
1888 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1890 #define CHECK_NUMBER(x) \
1891 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1893 #define CHECK_NATNUM(x) \
1894 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1896 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1899 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1900 args_out_of_range_3 \
1902 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1903 ? MOST_NEGATIVE_FIXNUM \
1905 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1907 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1909 if (TYPE_SIGNED (type)) \
1910 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1912 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1915 #define CHECK_MARKER(x) \
1916 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1918 #define CHECK_NUMBER_COERCE_MARKER(x) \
1919 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1920 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1922 #define XFLOATINT(n) extract_float((n))
1924 #define CHECK_FLOAT(x) \
1925 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1927 #define CHECK_NUMBER_OR_FLOAT(x) \
1928 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1930 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1931 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1932 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1934 #define CHECK_OVERLAY(x) \
1935 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1937 /* Since we can't assign directly to the CAR or CDR fields of a cons
1938 cell, use these when checking that those fields contain numbers. */
1939 #define CHECK_NUMBER_CAR(x) \
1941 Lisp_Object tmp = XCAR (x); \
1942 CHECK_NUMBER (tmp); \
1943 XSETCAR ((x), tmp); \
1946 #define CHECK_NUMBER_CDR(x) \
1948 Lisp_Object tmp = XCDR (x); \
1949 CHECK_NUMBER (tmp); \
1950 XSETCDR ((x), tmp); \
1953 #define CHECK_NATNUM_CAR(x) \
1955 Lisp_Object tmp = XCAR (x); \
1956 CHECK_NATNUM (tmp); \
1957 XSETCAR ((x), tmp); \
1960 #define CHECK_NATNUM_CDR(x) \
1962 Lisp_Object tmp = XCDR (x); \
1963 CHECK_NATNUM (tmp); \
1964 XSETCDR ((x), tmp); \
1967 /* Define a built-in function for calling from Lisp.
1968 `lname' should be the name to give the function in Lisp,
1969 as a null-terminated C string.
1970 `fnname' should be the name of the function in C.
1971 By convention, it starts with F.
1972 `sname' should be the name for the C constant structure
1973 that records information on this function for internal use.
1974 By convention, it should be the same as `fnname' but with S instead of F.
1975 It's too bad that C macros can't compute this from `fnname'.
1976 `minargs' should be a number, the minimum number of arguments allowed.
1977 `maxargs' should be a number, the maximum number of arguments allowed,
1978 or else MANY or UNEVALLED.
1979 MANY means pass a vector of evaluated arguments,
1980 in the form of an integer number-of-arguments
1981 followed by the address of a vector of Lisp_Objects
1982 which contains the argument values.
1983 UNEVALLED means pass the list of unevaluated arguments
1984 `intspec' says how interactive arguments are to be fetched.
1985 If the string starts with a `(', `intspec' is evaluated and the resulting
1986 list is the list of arguments.
1987 If it's a string that doesn't start with `(', the value should follow
1988 the one of the doc string for `interactive'.
1989 A null string means call interactively with no arguments.
1990 `doc' is documentation for the user. */
1992 /* This version of DEFUN declares a function prototype with the right
1993 arguments, so we can catch errors with maxargs at compile-time. */
1995 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1996 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1997 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1998 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
1999 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2000 { (Lisp_Object (__cdecl *)(void))fnname }, \
2001 minargs, maxargs, lname, intspec, 0}; \
2003 #else /* not _MSC_VER */
2004 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2005 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2006 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2007 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2008 { .a ## maxargs = fnname }, \
2009 minargs, maxargs, lname, intspec, 0}; \
2013 /* Note that the weird token-substitution semantics of ANSI C makes
2014 this work for MANY and UNEVALLED. */
2015 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2016 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2017 #define DEFUN_ARGS_0 (void)
2018 #define DEFUN_ARGS_1 (Lisp_Object)
2019 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2020 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2021 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2022 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2024 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2025 Lisp_Object, Lisp_Object)
2026 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2027 Lisp_Object, Lisp_Object, Lisp_Object)
2028 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2029 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2031 /* Non-zero if OBJ is a Lisp function. */
2032 #define FUNCTIONP(OBJ) functionp(OBJ)
2035 is how we define the symbol for function `name' at start-up time. */
2036 extern void defsubr (struct Lisp_Subr
*);
2044 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2045 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2046 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2047 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2048 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2050 /* Macros we use to define forwarded Lisp variables.
2051 These are used in the syms_of_FILENAME functions.
2053 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2054 lisp variable is actually a field in `struct emacs_globals'. The
2055 field's name begins with "f_", which is a convention enforced by
2056 these macros. Each such global has a corresponding #define in
2057 globals.h; the plain name should be used in the code.
2059 E.g., the global "cons_cells_consed" is declared as "int
2060 f_cons_cells_consed" in globals.h, but there is a define:
2062 #define cons_cells_consed globals.f_cons_cells_consed
2064 All C code uses the `cons_cells_consed' name. This is all done
2065 this way to support indirection for multi-threaded Emacs. */
2067 #define DEFVAR_LISP(lname, vname, doc) \
2069 static struct Lisp_Objfwd o_fwd; \
2070 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2072 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2074 static struct Lisp_Objfwd o_fwd; \
2075 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2077 #define DEFVAR_BOOL(lname, vname, doc) \
2079 static struct Lisp_Boolfwd b_fwd; \
2080 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2082 #define DEFVAR_INT(lname, vname, doc) \
2084 static struct Lisp_Intfwd i_fwd; \
2085 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2088 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2090 static struct Lisp_Objfwd o_fwd; \
2091 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2094 #define DEFVAR_KBOARD(lname, vname, doc) \
2096 static struct Lisp_Kboard_Objfwd ko_fwd; \
2097 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2100 /* Save and restore the instruction and environment pointers,
2101 without affecting the signal mask. */
2104 typedef jmp_buf sys_jmp_buf
;
2105 # define sys_setjmp(j) _setjmp (j)
2106 # define sys_longjmp(j, v) _longjmp (j, v)
2107 #elif defined HAVE_SIGSETJMP
2108 typedef sigjmp_buf sys_jmp_buf
;
2109 # define sys_setjmp(j) sigsetjmp (j, 0)
2110 # define sys_longjmp(j, v) siglongjmp (j, v)
2112 /* A platform that uses neither _longjmp nor siglongjmp; assume
2113 longjmp does not affect the sigmask. */
2114 typedef jmp_buf sys_jmp_buf
;
2115 # define sys_setjmp(j) setjmp (j)
2116 # define sys_longjmp(j, v) longjmp (j, v)
2120 /* Structure for recording Lisp call stack for backtrace purposes. */
2122 /* The special binding stack holds the outer values of variables while
2123 they are bound by a function application or a let form, stores the
2124 code to be executed for Lisp unwind-protect forms, and stores the C
2125 functions to be called for record_unwind_protect.
2127 If func is non-zero, undoing this binding applies func to old_value;
2128 This implements record_unwind_protect.
2130 Otherwise, the element is a variable binding.
2132 If the symbol field is a symbol, it is an ordinary variable binding.
2134 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2135 which means having bound a local value while CURRENT-BUFFER was active.
2136 If WHERE is nil this means we saw the default value when binding SYMBOL.
2137 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2138 value. Other values of WHERE mean an internal error. */
2140 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2144 Lisp_Object symbol
, old_value
;
2145 specbinding_func func
;
2146 Lisp_Object unused
; /* Dividing by 16 is faster than by 12. */
2149 extern struct specbinding
*specpdl
;
2150 extern struct specbinding
*specpdl_ptr
;
2151 extern ptrdiff_t specpdl_size
;
2153 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2157 struct backtrace
*next
;
2158 Lisp_Object function
;
2159 Lisp_Object
*args
; /* Points to vector of args. */
2160 ptrdiff_t nargs
; /* Length of vector. */
2161 /* Nonzero means call value of debugger when done with this operation. */
2162 unsigned int debug_on_exit
: 1;
2165 extern struct backtrace
*backtrace_list
;
2167 /* Everything needed to describe an active condition case.
2169 Members are volatile if their values need to survive _longjmp when
2170 a 'struct handler' is a local variable. */
2173 /* The handler clauses and variable from the condition-case form. */
2174 /* For a handler set up in Lisp code, this is always a list.
2175 For an internal handler set up by internal_condition_case*,
2176 this can instead be the symbol t or `error'.
2177 t: handle all conditions.
2178 error: handle all conditions, and errors can run the debugger
2179 or display a backtrace. */
2180 Lisp_Object handler
;
2182 Lisp_Object
volatile var
;
2184 /* Fsignal stores here the condition-case clause that applies,
2185 and Fcondition_case thus knows which clause to run. */
2186 Lisp_Object
volatile chosen_clause
;
2188 /* Used to effect the longjump out to the handler. */
2189 struct catchtag
*tag
;
2191 /* The next enclosing handler. */
2192 struct handler
*next
;
2195 /* This structure helps implement the `catch' and `throw' control
2196 structure. A struct catchtag contains all the information needed
2197 to restore the state of the interpreter after a non-local jump.
2199 Handlers for error conditions (represented by `struct handler'
2200 structures) just point to a catch tag to do the cleanup required
2203 catchtag structures are chained together in the C calling stack;
2204 the `next' member points to the next outer catchtag.
2206 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2207 member is TAG, and then unbinds to it. The `val' member is used to
2208 hold VAL while the stack is unwound; `val' is returned as the value
2211 All the other members are concerned with restoring the interpreter
2214 Members are volatile if their values need to survive _longjmp when
2215 a 'struct catchtag' is a local variable. */
2219 Lisp_Object
volatile val
;
2220 struct catchtag
*volatile next
;
2221 struct gcpro
*gcpro
;
2223 struct backtrace
*backlist
;
2224 struct handler
*handlerlist
;
2225 EMACS_INT lisp_eval_depth
;
2226 ptrdiff_t volatile pdlcount
;
2227 int poll_suppress_count
;
2228 int interrupt_input_blocked
;
2229 struct byte_stack
*byte_stack
;
2232 extern Lisp_Object memory_signal_data
;
2234 /* An address near the bottom of the stack.
2235 Tells GC how to save a copy of the stack. */
2236 extern char *stack_bottom
;
2238 /* Check quit-flag and quit if it is non-nil.
2239 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2240 So the program needs to do QUIT at times when it is safe to quit.
2241 Every loop that might run for a long time or might not exit
2242 ought to do QUIT at least once, at a safe place.
2243 Unless that is impossible, of course.
2244 But it is very desirable to avoid creating loops where QUIT is impossible.
2246 Exception: if you set immediate_quit to nonzero,
2247 then the handler that responds to the C-g does the quit itself.
2248 This is a good thing to do around a loop that has no side effects
2249 and (in particular) cannot call arbitrary Lisp code.
2251 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2252 a request to exit Emacs when it is safe to do. */
2254 extern void process_pending_signals (void);
2255 extern bool volatile pending_signals
;
2257 extern void process_quit_flag (void);
2260 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2261 process_quit_flag (); \
2262 else if (pending_signals) \
2263 process_pending_signals (); \
2267 /* Nonzero if ought to quit now. */
2269 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2271 extern Lisp_Object Vascii_downcase_table
;
2272 extern Lisp_Object Vascii_canon_table
;
2274 /* Structure for recording stack slots that need marking. */
2276 /* This is a chain of structures, each of which points at a Lisp_Object
2277 variable whose value should be marked in garbage collection.
2278 Normally every link of the chain is an automatic variable of a function,
2279 and its `val' points to some argument or local variable of the function.
2280 On exit to the function, the chain is set back to the value it had on entry.
2281 This way, no link remains in the chain when the stack frame containing the
2284 Every function that can call Feval must protect in this fashion all
2285 Lisp_Object variables whose contents will be used again. */
2287 extern struct gcpro
*gcprolist
;
2293 /* Address of first protected variable. */
2294 volatile Lisp_Object
*var
;
2296 /* Number of consecutive protected variables. */
2304 /* Values of GC_MARK_STACK during compilation:
2306 0 Use GCPRO as before
2307 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2308 2 Mark the stack, and check that everything GCPRO'd is
2310 3 Mark using GCPRO's, mark stack last, and count how many
2311 dead objects are kept alive.
2313 Formerly, method 0 was used. Currently, method 1 is used unless
2314 otherwise specified by hand when building, e.g.,
2315 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
2316 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
2318 #define GC_USE_GCPROS_AS_BEFORE 0
2319 #define GC_MAKE_GCPROS_NOOPS 1
2320 #define GC_MARK_STACK_CHECK_GCPROS 2
2321 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2323 #ifndef GC_MARK_STACK
2324 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2327 /* Whether we do the stack marking manually. */
2328 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2329 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2332 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2334 /* Do something silly with gcproN vars just so gcc shuts up. */
2335 /* You get warnings from MIPSPro... */
2337 #define GCPRO1(varname) ((void) gcpro1)
2338 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2339 #define GCPRO3(varname1, varname2, varname3) \
2340 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2341 #define GCPRO4(varname1, varname2, varname3, varname4) \
2342 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2343 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2344 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2345 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2346 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2348 #define UNGCPRO ((void) 0)
2350 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2354 #define GCPRO1(varname) \
2355 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2356 gcprolist = &gcpro1; }
2358 #define GCPRO2(varname1, varname2) \
2359 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2360 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2361 gcprolist = &gcpro2; }
2363 #define GCPRO3(varname1, varname2, varname3) \
2364 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2365 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2366 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2367 gcprolist = &gcpro3; }
2369 #define GCPRO4(varname1, varname2, varname3, varname4) \
2370 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2371 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2372 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2373 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2374 gcprolist = &gcpro4; }
2376 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2377 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2378 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2379 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2380 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2381 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2382 gcprolist = &gcpro5; }
2384 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2385 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2386 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2387 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2388 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2389 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2390 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2391 gcprolist = &gcpro6; }
2393 #define UNGCPRO (gcprolist = gcpro1.next)
2397 extern int gcpro_level
;
2399 #define GCPRO1(varname) \
2400 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2401 gcpro1.level = gcpro_level++; \
2402 gcprolist = &gcpro1; }
2404 #define GCPRO2(varname1, varname2) \
2405 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2406 gcpro1.level = gcpro_level; \
2407 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2408 gcpro2.level = gcpro_level++; \
2409 gcprolist = &gcpro2; }
2411 #define GCPRO3(varname1, varname2, varname3) \
2412 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2413 gcpro1.level = gcpro_level; \
2414 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2415 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2416 gcpro3.level = gcpro_level++; \
2417 gcprolist = &gcpro3; }
2419 #define GCPRO4(varname1, varname2, varname3, varname4) \
2420 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2421 gcpro1.level = gcpro_level; \
2422 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2423 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2424 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2425 gcpro4.level = gcpro_level++; \
2426 gcprolist = &gcpro4; }
2428 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2429 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2430 gcpro1.level = gcpro_level; \
2431 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2432 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2433 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2434 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2435 gcpro5.level = gcpro_level++; \
2436 gcprolist = &gcpro5; }
2438 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2439 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2440 gcpro1.level = gcpro_level; \
2441 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2442 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2443 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2444 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2445 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2446 gcpro6.level = gcpro_level++; \
2447 gcprolist = &gcpro6; }
2450 ((--gcpro_level != gcpro1.level) \
2451 ? (emacs_abort (), 0) \
2452 : ((gcprolist = gcpro1.next), 0))
2454 #endif /* DEBUG_GCPRO */
2455 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2458 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2459 #define RETURN_UNGCPRO(expr) \
2462 Lisp_Object ret_ungc_val; \
2463 ret_ungc_val = (expr); \
2465 return ret_ungc_val; \
2469 /* Call staticpro (&var) to protect static variable `var'. */
2471 void staticpro (Lisp_Object
*);
2473 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2474 meaning as in the DEFUN macro, and is used to construct a prototype. */
2475 /* We can use the same trick as in the DEFUN macro to generate the
2476 appropriate prototype. */
2477 #define EXFUN(fnname, maxargs) \
2478 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2480 /* Forward declarations for prototypes. */
2484 /* Simple access functions. */
2486 LISP_INLINE Lisp_Object
*
2487 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2489 return & XVECTOR (array
)->contents
[idx
];
2493 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2495 /* Like ASET, but also can be used in the garbage collector:
2496 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2497 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2498 XVECTOR (array
)->contents
[idx
] = val
;
2501 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2504 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2506 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2507 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2510 /* Functions to modify hash tables. */
2513 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2515 h
->key_and_value
= key_and_value
;
2519 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2521 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2525 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2527 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2531 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2537 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2539 gc_aset (h
->next
, idx
, val
);
2543 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2549 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2551 gc_aset (h
->hash
, idx
, val
);
2555 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2561 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2563 gc_aset (h
->index
, idx
, val
);
2566 /* Use these functions to set Lisp_Object
2567 or pointer slots of struct Lisp_Symbol. */
2570 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2572 XSYMBOL (sym
)->name
= name
;
2576 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2578 XSYMBOL (sym
)->function
= function
;
2582 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2584 XSYMBOL (sym
)->plist
= plist
;
2588 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2590 XSYMBOL (sym
)->next
= next
;
2593 /* Buffer-local (also frame-local) variable access functions. */
2596 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2598 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2603 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2605 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2609 LISP_INLINE Lisp_Object
2610 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2612 return XCDR (blv
->valcell
);
2616 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2618 XSETCDR (blv
->valcell
, val
);
2622 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2628 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2634 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2639 /* Set overlay's property list. */
2642 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2644 XOVERLAY (overlay
)->plist
= plist
;
2647 /* Get text properties of S. */
2649 LISP_INLINE INTERVAL
2650 string_intervals (Lisp_Object s
)
2652 return XSTRING (s
)->intervals
;
2655 /* Set text properties of S to I. */
2658 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2660 XSTRING (s
)->intervals
= i
;
2663 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2664 of setting slots directly. */
2667 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2669 XCHAR_TABLE (table
)->ascii
= val
;
2672 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2674 XCHAR_TABLE (table
)->defalt
= val
;
2677 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2679 XCHAR_TABLE (table
)->parent
= val
;
2682 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2684 XCHAR_TABLE (table
)->purpose
= val
;
2687 /* Set different slots in (sub)character tables. */
2690 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2692 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2693 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2697 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2699 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2700 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2704 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2706 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2709 /* Defined in data.c. */
2710 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2711 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2712 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2713 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2714 extern Lisp_Object Qinvalid_read_syntax
;
2715 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2716 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2717 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2718 extern Lisp_Object Qtext_read_only
;
2719 extern Lisp_Object Qinteractive_form
;
2720 extern Lisp_Object Qcircular_list
;
2721 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2722 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2723 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2724 extern Lisp_Object Qbuffer_or_string_p
;
2725 extern Lisp_Object Qfboundp
;
2726 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2728 extern Lisp_Object Qcdr
;
2730 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2732 extern Lisp_Object Qfloatp
;
2733 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2735 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2737 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2739 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2741 /* Defined in data.c. */
2742 extern Lisp_Object
indirect_function (Lisp_Object
);
2743 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2745 /* Convert the integer I to an Emacs representation, either the integer
2746 itself, or a cons of two or three integers, or if all else fails a float.
2747 I should not have side effects. */
2748 #define INTEGER_TO_CONS(i) \
2749 (! FIXNUM_OVERFLOW_P (i) \
2751 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2752 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2753 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2754 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2755 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2756 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2757 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2758 ? Fcons (make_number ((i) >> 16 >> 24), \
2759 Fcons (make_number ((i) >> 16 & 0xffffff), \
2760 make_number ((i) & 0xffff))) \
2763 /* Convert the Emacs representation CONS back to an integer of type
2764 TYPE, storing the result the variable VAR. Signal an error if CONS
2765 is not a valid representation or is out of range for TYPE. */
2766 #define CONS_TO_INTEGER(cons, type, var) \
2767 (TYPE_SIGNED (type) \
2768 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2769 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2770 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2771 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2773 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2774 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2775 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2777 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2778 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2779 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2780 extern void syms_of_data (void);
2781 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2783 /* Defined in cmds.c */
2784 extern void syms_of_cmds (void);
2785 extern void keys_of_cmds (void);
2787 /* Defined in coding.c. */
2788 extern Lisp_Object Qcharset
;
2789 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2790 ptrdiff_t, bool, bool, Lisp_Object
);
2791 extern void init_coding (void);
2792 extern void init_coding_once (void);
2793 extern void syms_of_coding (void);
2795 /* Defined in character.c. */
2796 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2797 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2798 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2799 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2800 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2801 extern void syms_of_character (void);
2803 /* Defined in charset.c. */
2804 extern void init_charset (void);
2805 extern void init_charset_once (void);
2806 extern void syms_of_charset (void);
2807 /* Structure forward declarations. */
2810 /* Defined in composite.c. */
2811 extern void syms_of_composite (void);
2813 /* Defined in syntax.c. */
2814 extern void init_syntax_once (void);
2815 extern void syms_of_syntax (void);
2817 /* Defined in fns.c. */
2818 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2819 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2820 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2821 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2822 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2823 extern void sweep_weak_hash_tables (void);
2824 extern Lisp_Object Qcursor_in_echo_area
;
2825 extern Lisp_Object Qstring_lessp
;
2826 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
2827 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2828 EMACS_UINT
sxhash (Lisp_Object
, int);
2829 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
2830 Lisp_Object
, Lisp_Object
);
2831 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2832 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2834 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
2836 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2837 ptrdiff_t, ptrdiff_t);
2838 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2839 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2840 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2841 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2842 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2843 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2844 extern void clear_string_char_byte_cache (void);
2845 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2846 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2847 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2848 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2849 extern void syms_of_fns (void);
2851 /* Defined in floatfns.c. */
2852 extern double extract_float (Lisp_Object
);
2853 extern void syms_of_floatfns (void);
2854 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2856 /* Defined in fringe.c. */
2857 extern void syms_of_fringe (void);
2858 extern void init_fringe (void);
2859 #ifdef HAVE_WINDOW_SYSTEM
2860 extern void mark_fringe_data (void);
2861 extern void init_fringe_once (void);
2862 #endif /* HAVE_WINDOW_SYSTEM */
2864 /* Defined in image.c. */
2865 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2866 extern Lisp_Object QCconversion
;
2867 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2868 extern void reset_image_types (void);
2869 extern void syms_of_image (void);
2871 /* Defined in insdel.c. */
2872 extern Lisp_Object Qinhibit_modification_hooks
;
2873 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2874 extern _Noreturn
void buffer_overflow (void);
2875 extern void make_gap (ptrdiff_t);
2876 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
2877 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2878 ptrdiff_t, bool, bool);
2879 extern int count_combining_before (const unsigned char *,
2880 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2881 extern int count_combining_after (const unsigned char *,
2882 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2883 extern void insert (const char *, ptrdiff_t);
2884 extern void insert_and_inherit (const char *, ptrdiff_t);
2885 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2887 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2888 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2889 ptrdiff_t, ptrdiff_t, bool);
2890 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2891 extern void insert_char (int);
2892 extern void insert_string (const char *);
2893 extern void insert_before_markers (const char *, ptrdiff_t);
2894 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2895 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2896 ptrdiff_t, ptrdiff_t,
2898 extern void del_range (ptrdiff_t, ptrdiff_t);
2899 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2900 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2901 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2902 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2903 ptrdiff_t, ptrdiff_t, bool);
2904 extern void modify_region_1 (ptrdiff_t, ptrdiff_t, bool);
2905 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2906 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2907 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2908 ptrdiff_t, ptrdiff_t);
2909 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2910 ptrdiff_t, ptrdiff_t);
2911 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2912 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2913 const char *, ptrdiff_t, ptrdiff_t, bool);
2914 extern void syms_of_insdel (void);
2916 /* Defined in dispnew.c. */
2917 #if (defined PROFILING \
2918 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2919 _Noreturn
void __executable_start (void);
2921 extern Lisp_Object selected_frame
;
2922 extern Lisp_Object Vwindow_system
;
2923 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2924 extern void init_display (void);
2925 extern void syms_of_display (void);
2927 /* Defined in xdisp.c. */
2928 extern Lisp_Object Qinhibit_point_motion_hooks
;
2929 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2930 extern Lisp_Object Qmenu_bar_update_hook
;
2931 extern Lisp_Object Qwindow_scroll_functions
;
2932 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2933 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2934 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2935 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2936 extern Lisp_Object Qleft_margin
, Qright_margin
;
2937 extern Lisp_Object Qglyphless_char
;
2938 extern Lisp_Object QCdata
, QCfile
;
2939 extern Lisp_Object QCmap
;
2940 extern Lisp_Object Qrisky_local_variable
;
2941 extern struct frame
*last_glyphless_glyph_frame
;
2942 extern int last_glyphless_glyph_face_id
;
2943 extern int last_glyphless_glyph_merged_face_id
;
2944 extern int noninteractive_need_newline
;
2945 extern Lisp_Object echo_area_buffer
[2];
2946 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2947 extern void check_message_stack (void);
2948 extern void setup_echo_area_for_printing (int);
2949 extern bool push_message (void);
2950 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2951 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2952 extern void restore_message (void);
2953 extern Lisp_Object
current_message (void);
2954 extern void clear_message (int, int);
2955 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2956 extern void message1 (const char *);
2957 extern void message1_nolog (const char *);
2958 extern void message3 (Lisp_Object
);
2959 extern void message3_nolog (Lisp_Object
);
2960 extern void message_dolog (const char *, ptrdiff_t, int, int);
2961 extern void message_with_string (const char *, Lisp_Object
, int);
2962 extern void message_log_maybe_newline (void);
2963 extern void update_echo_area (void);
2964 extern void truncate_echo_area (ptrdiff_t);
2965 extern void redisplay (void);
2966 extern void redisplay_preserve_echo_area (int);
2967 extern void prepare_menu_bars (void);
2969 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2970 extern void syms_of_xdisp (void);
2971 extern void init_xdisp (void);
2972 extern Lisp_Object
safe_eval (Lisp_Object
);
2973 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2974 int *, int *, int *, int *, int *);
2976 /* Defined in xsettings.c. */
2977 extern void syms_of_xsettings (void);
2979 /* Defined in vm-limit.c. */
2980 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2982 /* Defined in alloc.c. */
2983 extern void check_pure_size (void);
2984 extern void free_misc (Lisp_Object
);
2985 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2986 extern void malloc_warning (const char *);
2987 extern _Noreturn
void memory_full (size_t);
2988 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2989 extern bool survives_gc_p (Lisp_Object
);
2990 extern void mark_object (Lisp_Object
);
2991 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2992 extern void refill_memory_reserve (void);
2994 extern const char *pending_malloc_warning
;
2995 extern Lisp_Object zero_vector
;
2996 extern Lisp_Object
*stack_base
;
2997 extern EMACS_INT consing_since_gc
;
2998 extern EMACS_INT gc_relative_threshold
;
2999 extern EMACS_INT memory_full_cons_threshold
;
3000 extern Lisp_Object
list1 (Lisp_Object
);
3001 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3002 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3003 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3004 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3006 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3007 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3008 extern _Noreturn
void string_overflow (void);
3009 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3010 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3011 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3012 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3014 /* Make unibyte string from C string when the length isn't known. */
3016 LISP_INLINE Lisp_Object
3017 build_unibyte_string (const char *str
)
3019 return make_unibyte_string (str
, strlen (str
));
3022 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3023 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
3024 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3025 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3026 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3027 extern Lisp_Object
make_specified_string (const char *,
3028 ptrdiff_t, ptrdiff_t, bool);
3029 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3030 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3032 /* Make a string allocated in pure space, use STR as string data. */
3034 LISP_INLINE Lisp_Object
3035 build_pure_c_string (const char *str
)
3037 return make_pure_c_string (str
, strlen (str
));
3040 /* Make a string from the data at STR, treating it as multibyte if the
3043 LISP_INLINE Lisp_Object
3044 build_string (const char *str
)
3046 return make_string (str
, strlen (str
));
3049 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3050 extern void make_byte_code (struct Lisp_Vector
*);
3051 extern Lisp_Object Qautomatic_gc
;
3052 extern Lisp_Object Qchar_table_extra_slots
;
3053 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3055 /* Make an unitialized vector for SIZE objects. NOTE: you must
3056 be sure that GC cannot happen until the vector is completely
3057 initialized. E.g. the following code is likely to crash:
3059 v = make_uninit_vector (3);
3061 ASET (v, 1, Ffunction_can_gc ());
3062 ASET (v, 2, obj1); */
3064 LISP_INLINE Lisp_Object
3065 make_uninit_vector (ptrdiff_t size
)
3068 struct Lisp_Vector
*p
;
3070 p
= allocate_vector (size
);
3075 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3076 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3078 allocate_pseudovector \
3079 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3080 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3081 extern struct window
*allocate_window (void);
3082 extern struct frame
*allocate_frame (void);
3083 extern struct Lisp_Process
*allocate_process (void);
3084 extern struct terminal
*allocate_terminal (void);
3085 extern bool gc_in_progress
;
3086 extern bool abort_on_gc
;
3087 extern Lisp_Object
make_float (double);
3088 extern void display_malloc_warning (void);
3089 extern ptrdiff_t inhibit_garbage_collection (void);
3090 extern Lisp_Object
make_save_value (const char *, ...);
3091 extern Lisp_Object
make_save_pointer (void *);
3092 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3093 extern void free_marker (Lisp_Object
);
3094 extern void free_cons (struct Lisp_Cons
*);
3095 extern void init_alloc_once (void);
3096 extern void init_alloc (void);
3097 extern void syms_of_alloc (void);
3098 extern struct buffer
* allocate_buffer (void);
3099 extern int valid_lisp_object_p (Lisp_Object
);
3100 #ifdef GC_CHECK_CONS_LIST
3101 extern void check_cons_list (void);
3103 #define check_cons_list() ((void) 0)
3107 /* Defined in ralloc.c. */
3108 extern void *r_alloc (void **, size_t);
3109 extern void r_alloc_free (void **);
3110 extern void *r_re_alloc (void **, size_t);
3111 extern void r_alloc_reset_variable (void **, void **);
3112 extern void r_alloc_inhibit_buffer_relocation (int);
3115 /* Defined in chartab.c. */
3116 extern Lisp_Object
copy_char_table (Lisp_Object
);
3117 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
3118 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3120 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3121 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3122 extern int char_table_translate (Lisp_Object
, int);
3123 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3125 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3126 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3127 Lisp_Object
, Lisp_Object
,
3128 Lisp_Object
, struct charset
*,
3129 unsigned, unsigned);
3130 extern Lisp_Object
uniprop_table (Lisp_Object
);
3131 extern void syms_of_chartab (void);
3133 /* Defined in print.c. */
3134 extern Lisp_Object Vprin1_to_string_buffer
;
3135 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3136 extern Lisp_Object Qstandard_output
;
3137 extern Lisp_Object Qexternal_debugging_output
;
3138 extern void temp_output_buffer_setup (const char *);
3139 extern int print_level
;
3140 extern Lisp_Object Qprint_escape_newlines
;
3141 extern void write_string (const char *, int);
3142 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3144 extern Lisp_Object internal_with_output_to_temp_buffer
3145 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3146 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3147 extern int float_to_string (char *, double);
3148 extern void syms_of_print (void);
3150 /* Defined in doprnt.c. */
3151 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3153 extern ptrdiff_t esprintf (char *, char const *, ...)
3154 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3155 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3157 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3158 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3159 char const *, va_list)
3160 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3162 /* Defined in lread.c. */
3163 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3164 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3165 extern Lisp_Object Qlexical_binding
;
3166 extern Lisp_Object
check_obarray (Lisp_Object
);
3167 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3168 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3169 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3170 #define LOADHIST_ATTACH(x) \
3172 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3174 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3175 Lisp_Object
*, Lisp_Object
);
3176 extern Lisp_Object
string_to_number (char const *, int, bool);
3177 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3179 extern void dir_warning (const char *, Lisp_Object
);
3180 extern void close_load_descs (void);
3181 extern void init_obarray (void);
3182 extern void init_lread (void);
3183 extern void syms_of_lread (void);
3185 LISP_INLINE Lisp_Object
3186 intern (const char *str
)
3188 return intern_1 (str
, strlen (str
));
3191 LISP_INLINE Lisp_Object
3192 intern_c_string (const char *str
)
3194 return intern_c_string_1 (str
, strlen (str
));
3197 /* Defined in eval.c. */
3198 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3199 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3200 extern Lisp_Object Qand_rest
;
3201 extern Lisp_Object Vautoload_queue
;
3202 extern Lisp_Object Vsignaling_function
;
3203 extern Lisp_Object inhibit_lisp_code
;
3205 extern struct catchtag
*catchlist
;
3206 extern struct handler
*handlerlist
;
3208 /* To run a normal hook, use the appropriate function from the list below.
3209 The calling convention:
3211 if (!NILP (Vrun_hooks))
3212 call1 (Vrun_hooks, Qmy_funny_hook);
3214 should no longer be used. */
3215 extern Lisp_Object Vrun_hooks
;
3216 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3217 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3218 Lisp_Object (*funcall
)
3219 (ptrdiff_t nargs
, Lisp_Object
*args
));
3220 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3221 extern _Noreturn
void xsignal0 (Lisp_Object
);
3222 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3223 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3224 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3226 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3227 extern Lisp_Object
eval_sub (Lisp_Object form
);
3228 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3229 extern Lisp_Object
call0 (Lisp_Object
);
3230 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3231 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3232 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3233 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3234 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3235 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3236 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3237 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3238 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3239 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3240 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3241 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3242 extern Lisp_Object internal_condition_case_n
3243 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3244 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3245 extern void specbind (Lisp_Object
, Lisp_Object
);
3246 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3247 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3248 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3249 extern _Noreturn
void verror (const char *, va_list)
3250 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3251 extern Lisp_Object
un_autoload (Lisp_Object
);
3252 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3253 extern void init_eval_once (void);
3254 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3255 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3256 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3257 extern void init_eval (void);
3259 extern void mark_backtrace (void);
3261 extern void syms_of_eval (void);
3263 /* Defined in editfns.c. */
3264 extern Lisp_Object Qfield
;
3265 extern void insert1 (Lisp_Object
);
3266 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3267 extern Lisp_Object
save_excursion_save (void);
3268 extern Lisp_Object
save_restriction_save (void);
3269 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3270 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3271 extern _Noreturn
void time_overflow (void);
3272 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3273 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3275 extern void init_editfns (void);
3276 extern void syms_of_editfns (void);
3277 extern void set_time_zone_rule (const char *);
3279 /* Defined in buffer.c. */
3280 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3281 extern _Noreturn
void nsberror (Lisp_Object
);
3282 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3283 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3284 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3285 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3286 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3287 extern bool overlay_touches_p (ptrdiff_t);
3288 extern Lisp_Object Vbuffer_alist
;
3289 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3290 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3291 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3292 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3293 extern void init_buffer_once (void);
3294 extern void init_buffer (void);
3295 extern void syms_of_buffer (void);
3296 extern void keys_of_buffer (void);
3298 /* Defined in marker.c. */
3300 extern ptrdiff_t marker_position (Lisp_Object
);
3301 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3302 extern void clear_charpos_cache (struct buffer
*);
3303 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3304 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3305 extern void unchain_marker (struct Lisp_Marker
*marker
);
3306 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3307 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3308 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3309 ptrdiff_t, ptrdiff_t);
3310 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3311 extern void syms_of_marker (void);
3313 /* Defined in fileio.c. */
3315 extern Lisp_Object Qfile_error
;
3316 extern Lisp_Object Qfile_exists_p
;
3317 extern Lisp_Object Qfile_directory_p
;
3318 extern Lisp_Object Qinsert_file_contents
;
3319 extern Lisp_Object Qfile_name_history
;
3320 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3321 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3322 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3323 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3324 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3325 extern bool internal_delete_file (Lisp_Object
);
3326 extern Lisp_Object
emacs_readlinkat (int, const char *);
3327 extern bool file_directory_p (const char *);
3328 extern bool file_accessible_directory_p (const char *);
3329 extern void init_fileio (void);
3330 extern void syms_of_fileio (void);
3331 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3332 extern Lisp_Object Qdelete_file
;
3333 extern bool check_existing (const char *);
3335 /* Defined in search.c. */
3336 extern void shrink_regexp_cache (void);
3337 extern void restore_search_regs (void);
3338 extern void record_unwind_save_match_data (void);
3339 struct re_registers
;
3340 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3341 struct re_registers
*,
3342 Lisp_Object
, int, int);
3343 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3344 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3346 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3347 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3348 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3349 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3351 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3353 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3354 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3355 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3356 extern void syms_of_search (void);
3357 extern void clear_regexp_cache (void);
3359 /* Defined in minibuf.c. */
3361 extern Lisp_Object Qcompletion_ignore_case
;
3362 extern Lisp_Object Vminibuffer_list
;
3363 extern Lisp_Object last_minibuf_string
;
3364 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3365 extern void init_minibuf_once (void);
3366 extern void syms_of_minibuf (void);
3368 /* Defined in callint.c. */
3370 extern Lisp_Object Qminus
, Qplus
;
3371 extern Lisp_Object Qwhen
;
3372 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3373 extern void syms_of_callint (void);
3375 /* Defined in casefiddle.c. */
3377 extern Lisp_Object Qidentity
;
3378 extern void syms_of_casefiddle (void);
3379 extern void keys_of_casefiddle (void);
3381 /* Defined in casetab.c. */
3383 extern void init_casetab_once (void);
3384 extern void syms_of_casetab (void);
3386 /* Defined in keyboard.c. */
3388 extern Lisp_Object echo_message_buffer
;
3389 extern struct kboard
*echo_kboard
;
3390 extern void cancel_echoing (void);
3391 extern Lisp_Object Qdisabled
, QCfilter
;
3392 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3393 extern Lisp_Object Qtop
;
3394 extern Lisp_Object last_undo_boundary
;
3395 extern bool input_pending
;
3396 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3397 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3398 extern void discard_mouse_events (void);
3400 void handle_input_available_signal (int);
3402 extern Lisp_Object pending_funcalls
;
3403 extern bool detect_input_pending (void);
3404 extern bool detect_input_pending_ignore_squeezables (void);
3405 extern bool detect_input_pending_run_timers (bool);
3406 extern void safe_run_hooks (Lisp_Object
);
3407 extern void cmd_error_internal (Lisp_Object
, const char *);
3408 extern Lisp_Object
command_loop_1 (void);
3409 extern Lisp_Object
recursive_edit_1 (void);
3410 extern void record_auto_save (void);
3411 extern void force_auto_save_soon (void);
3412 extern void init_keyboard (void);
3413 extern void syms_of_keyboard (void);
3414 extern void keys_of_keyboard (void);
3416 /* Defined in indent.c. */
3417 extern ptrdiff_t current_column (void);
3418 extern void invalidate_current_column (void);
3419 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3420 extern void syms_of_indent (void);
3422 /* Defined in frame.c. */
3423 extern Lisp_Object Qonly
, Qnone
;
3424 extern Lisp_Object Qvisible
;
3425 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3426 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3427 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3429 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3431 extern void frames_discard_buffer (Lisp_Object
);
3432 extern void syms_of_frame (void);
3434 /* Defined in emacs.c. */
3435 extern char **initial_argv
;
3436 extern int initial_argc
;
3437 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3438 extern bool display_arg
;
3440 extern Lisp_Object
decode_env_path (const char *, const char *);
3441 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3442 extern Lisp_Object Qfile_name_handler_alist
;
3443 extern _Noreturn
void terminate_due_to_signal (int, int);
3444 extern Lisp_Object Qkill_emacs
;
3446 extern Lisp_Object Vlibrary_cache
;
3449 void fixup_locale (void);
3450 void synchronize_system_messages_locale (void);
3451 void synchronize_system_time_locale (void);
3453 #define setlocale(category, locale)
3454 #define fixup_locale()
3455 #define synchronize_system_messages_locale()
3456 #define synchronize_system_time_locale()
3458 extern void shut_down_emacs (int, Lisp_Object
);
3460 /* True means don't do interactive redisplay and don't change tty modes. */
3461 extern bool noninteractive
;
3463 /* True means remove site-lisp directories from load-path. */
3464 extern bool no_site_lisp
;
3466 /* Pipe used to send exit notification to the daemon parent at
3468 extern int daemon_pipe
[2];
3469 #define IS_DAEMON (daemon_pipe[1] != 0)
3471 /* True if handling a fatal error already. */
3472 extern bool fatal_error_in_progress
;
3474 /* True means don't do use window-system-specific display code. */
3475 extern bool inhibit_window_system
;
3476 /* True means that a filter or a sentinel is running. */
3477 extern bool running_asynch_code
;
3479 /* Defined in process.c. */
3480 extern Lisp_Object QCtype
, Qlocal
;
3481 extern Lisp_Object Qprocessp
;
3482 extern void kill_buffer_processes (Lisp_Object
);
3483 extern int wait_reading_process_output (intmax_t, int, int, bool,
3485 struct Lisp_Process
*,
3487 /* Max value for the first argument of wait_reading_process_output. */
3488 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3489 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3490 The bug merely causes a bogus warning, but the warning is annoying. */
3491 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3493 # define WAIT_READING_MAX INTMAX_MAX
3495 extern void add_keyboard_wait_descriptor (int);
3496 extern void delete_keyboard_wait_descriptor (int);
3498 extern void add_gpm_wait_descriptor (int);
3499 extern void delete_gpm_wait_descriptor (int);
3501 extern void close_process_descs (void);
3502 extern void init_process_emacs (void);
3503 extern void syms_of_process (void);
3504 extern void setup_process_coding_systems (Lisp_Object
);
3509 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3510 extern void init_callproc_1 (void);
3511 extern void init_callproc (void);
3512 extern void set_initial_environment (void);
3513 extern void syms_of_callproc (void);
3515 /* Defined in doc.c. */
3516 extern Lisp_Object Qfunction_documentation
;
3517 extern Lisp_Object
read_doc_string (Lisp_Object
);
3518 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3519 extern void syms_of_doc (void);
3520 extern int read_bytecode_char (bool);
3522 /* Defined in bytecode.c. */
3523 extern void syms_of_bytecode (void);
3524 extern struct byte_stack
*byte_stack_list
;
3526 extern void mark_byte_stack (void);
3528 extern void unmark_byte_stack (void);
3529 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3530 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3532 /* Defined in macros.c. */
3533 extern Lisp_Object Qexecute_kbd_macro
;
3534 extern void init_macros (void);
3535 extern void syms_of_macros (void);
3537 /* Defined in undo.c. */
3538 extern Lisp_Object Qapply
;
3539 extern Lisp_Object Qinhibit_read_only
;
3540 extern void truncate_undo_list (struct buffer
*);
3541 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3542 extern void record_insert (ptrdiff_t, ptrdiff_t);
3543 extern void record_delete (ptrdiff_t, Lisp_Object
);
3544 extern void record_first_change (void);
3545 extern void record_change (ptrdiff_t, ptrdiff_t);
3546 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3547 Lisp_Object
, Lisp_Object
,
3549 extern void syms_of_undo (void);
3550 /* Defined in textprop.c. */
3551 extern Lisp_Object Qfont
, Qmouse_face
;
3552 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3553 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3554 extern Lisp_Object Qminibuffer_prompt
;
3556 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3558 /* Defined in menu.c. */
3559 extern void syms_of_menu (void);
3561 /* Defined in xmenu.c. */
3562 extern void syms_of_xmenu (void);
3564 /* Defined in termchar.h. */
3565 struct tty_display_info
;
3567 /* Defined in termhooks.h. */
3570 /* Defined in sysdep.c. */
3571 #ifndef HAVE_GET_CURRENT_DIR_NAME
3572 extern char *get_current_dir_name (void);
3574 extern void stuff_char (char c
);
3575 extern void init_foreground_group (void);
3576 extern void init_sigio (int);
3577 extern void sys_subshell (void);
3578 extern void sys_suspend (void);
3579 extern void discard_tty_input (void);
3580 extern void block_tty_out_signal (void);
3581 extern void unblock_tty_out_signal (void);
3582 extern void init_sys_modes (struct tty_display_info
*);
3583 extern void reset_sys_modes (struct tty_display_info
*);
3584 extern void init_all_sys_modes (void);
3585 extern void reset_all_sys_modes (void);
3586 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3587 extern void child_setup_tty (int);
3588 extern void setup_pty (int);
3589 extern int set_window_size (int, int, int);
3590 extern EMACS_INT
get_random (void);
3591 extern void seed_random (void *, ptrdiff_t);
3592 extern void init_random (void);
3593 extern void emacs_backtrace (int);
3594 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3595 extern int emacs_open (const char *, int, int);
3596 extern int emacs_close (int);
3597 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3598 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3600 extern void unlock_all_files (void);
3601 extern void lock_file (Lisp_Object
);
3602 extern void unlock_file (Lisp_Object
);
3603 extern void unlock_buffer (struct buffer
*);
3604 extern void syms_of_filelock (void);
3606 /* Defined in sound.c. */
3607 extern void syms_of_sound (void);
3609 /* Defined in category.c. */
3610 extern void init_category_once (void);
3611 extern Lisp_Object
char_category_set (int);
3612 extern void syms_of_category (void);
3614 /* Defined in ccl.c. */
3615 extern void syms_of_ccl (void);
3617 /* Defined in dired.c. */
3618 extern void syms_of_dired (void);
3619 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3620 Lisp_Object
, Lisp_Object
,
3623 /* Defined in term.c. */
3624 extern int *char_ins_del_vector
;
3625 extern void syms_of_term (void);
3626 extern _Noreturn
void fatal (const char *msgid
, ...)
3627 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3629 /* Defined in terminal.c. */
3630 extern void syms_of_terminal (void);
3632 /* Defined in font.c. */
3633 extern void syms_of_font (void);
3634 extern void init_font (void);
3636 #ifdef HAVE_WINDOW_SYSTEM
3637 /* Defined in fontset.c. */
3638 extern void syms_of_fontset (void);
3640 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3641 extern Lisp_Object Qfont_param
;
3645 /* Defined on w32notify.c. */
3646 extern void syms_of_w32notify (void);
3649 /* Defined in inotify.c */
3651 extern void syms_of_inotify (void);
3654 /* Defined in xfaces.c. */
3655 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3656 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3657 extern Lisp_Object Qmode_line_inactive
;
3658 extern Lisp_Object Qface
;
3659 extern Lisp_Object Qnormal
;
3660 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3661 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3662 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3663 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3664 extern Lisp_Object Qoblique
, Qitalic
;
3665 extern Lisp_Object Vface_alternative_font_family_alist
;
3666 extern Lisp_Object Vface_alternative_font_registry_alist
;
3667 extern void syms_of_xfaces (void);
3669 #ifdef HAVE_X_WINDOWS
3670 /* Defined in xfns.c. */
3671 extern void syms_of_xfns (void);
3673 /* Defined in xsmfns.c. */
3674 extern void syms_of_xsmfns (void);
3676 /* Defined in xselect.c. */
3677 extern void syms_of_xselect (void);
3679 /* Defined in xterm.c. */
3680 extern void syms_of_xterm (void);
3681 #endif /* HAVE_X_WINDOWS */
3683 #ifdef HAVE_WINDOW_SYSTEM
3684 /* Defined in xterm.c, nsterm.m, w32term.c. */
3685 extern char *x_get_keysym_name (int);
3686 #endif /* HAVE_WINDOW_SYSTEM */
3689 /* Defined in xml.c. */
3690 extern void syms_of_xml (void);
3691 extern void xml_cleanup_parser (void);
3695 /* Defined in (x|w32)fns.c, nsfns.m... */
3696 extern int have_menus_p (void);
3700 /* Defined in dbusbind.c. */
3701 void syms_of_dbusbind (void);
3705 /* Defined in profiler.c. */
3706 extern bool profiler_memory_running
;
3707 extern void malloc_probe (size_t);
3708 extern void syms_of_profiler (void);
3712 /* Defined in msdos.c, w32.c. */
3713 extern char *emacs_root_dir (void);
3716 /* True means Emacs has already been initialized.
3717 Used during startup to detect startup of dumped Emacs. */
3718 extern bool initialized
;
3720 /* True means ^G can quit instantly. */
3721 extern bool immediate_quit
;
3723 extern void *xmalloc (size_t);
3724 extern void *xzalloc (size_t);
3725 extern void *xrealloc (void *, size_t);
3726 extern void xfree (void *);
3727 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3728 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3729 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3731 extern char *xstrdup (const char *);
3732 extern void xputenv (const char *);
3734 extern char *egetenv (const char *);
3736 /* Set up the name of the machine we're running on. */
3737 extern void init_system_name (void);
3739 /* Return the absolute value of X. X should be a signed integer
3740 expression without side effects, and X's absolute value should not
3741 exceed the maximum for its promoted type. This is called 'eabs'
3742 because 'abs' is reserved by the C standard. */
3743 #define eabs(x) ((x) < 0 ? -(x) : (x))
3745 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3748 #define make_fixnum_or_float(val) \
3749 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3751 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3752 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3754 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3756 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3757 extern void *record_xmalloc (size_t);
3759 #define USE_SAFE_ALLOCA \
3760 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3762 /* SAFE_ALLOCA allocates a simple buffer. */
3764 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3766 : (sa_must_free = 1, record_xmalloc (size)))
3768 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3769 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3770 positive. The code is tuned for MULTIPLIER being a constant. */
3772 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3774 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3775 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3778 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3780 record_unwind_protect (safe_alloca_unwind, \
3781 make_save_pointer (buf)); \
3785 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3787 #define SAFE_FREE() \
3789 if (sa_must_free) { \
3791 unbind_to (sa_count, Qnil); \
3796 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3798 #define SAFE_ALLOCA_LISP(buf, nelt) \
3800 if ((nelt) < MAX_ALLOCA / word_size) \
3801 buf = alloca ((nelt) * word_size); \
3802 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3805 buf = xmalloc ((nelt) * word_size); \
3806 arg_ = make_save_value ("pi", buf, nelt); \
3807 XSAVE_VALUE (arg_)->area = 1; \
3809 record_unwind_protect (safe_alloca_unwind, arg_); \
3812 memory_full (SIZE_MAX); \
3816 #include "globals.h"
3818 /* Check whether it's time for GC, and run it if so. */
3823 if ((consing_since_gc
> gc_cons_threshold
3824 && consing_since_gc
> gc_relative_threshold
)
3825 || (!NILP (Vmemory_full
)
3826 && consing_since_gc
> memory_full_cons_threshold
))
3827 Fgarbage_collect ();
3831 functionp (Lisp_Object object
)
3833 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3835 object
= Findirect_function (object
, Qt
);
3837 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3839 /* Autoloaded symbols are functions, except if they load
3840 macros or keymaps. */
3842 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3843 object
= XCDR (object
);
3845 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3850 return XSUBR (object
)->max_args
!= UNEVALLED
;
3851 else if (COMPILEDP (object
))
3853 else if (CONSP (object
))
3855 Lisp_Object car
= XCAR (object
);
3856 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3864 #endif /* EMACS_LISP_H */