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