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 last 4 are special because we OR them in fns.c:internal_equal,
412 so they have to use a disjoint bit pattern:
413 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
414 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
415 PVEC_COMPILED
= 0x10,
416 PVEC_CHAR_TABLE
= 0x20,
417 PVEC_SUB_CHAR_TABLE
= 0x30,
421 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
422 which were stored in a Lisp_Object. */
423 #ifndef DATA_SEG_BITS
424 # define DATA_SEG_BITS 0
426 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
431 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
433 /* For convenience, we also store the number of elements in these bits.
434 Note that this size is not necessarily the memory-footprint size, but
435 only the number of Lisp_Object fields (that need to be traced by GC).
436 The distinction is used, e.g., by Lisp_Process, which places extra
437 non-Lisp_Object fields at the end of the structure. */
438 PSEUDOVECTOR_SIZE_BITS
= 16,
439 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
440 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
442 /* Number of bits to put in each character in the internal representation
443 of bool vectors. This should not vary across implementations. */
444 BOOL_VECTOR_BITS_PER_CHAR
= 8
447 /* These macros extract various sorts of values from a Lisp_Object.
448 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
449 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
451 /* Return a perfect hash of the Lisp_Object representation. */
452 #define XHASH(a) XLI (a)
458 TYPEMASK
= (1 << GCTYPEBITS
) - 1,
461 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
462 #define XINT(a) (XLI (a) >> INTTYPEBITS)
463 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
464 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
465 #define make_lisp_ptr(ptr, type) \
466 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
467 XIL ((type) | (intptr_t) (ptr)))
469 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
470 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
472 #else /* not USE_LSB_TAG */
474 static EMACS_INT
const VALMASK
475 #define VALMASK VAL_MAX
478 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
480 /* For integers known to be positive, XFASTINT provides fast retrieval
481 and XSETFASTINT provides fast storage. This takes advantage of the
482 fact that Lisp integers have zero-bits in their tags. */
483 #define XFASTINT(a) (XLI (a) + 0)
484 #define XSETFASTINT(a, b) ((a) = XIL (b))
486 /* Extract the value of a Lisp_Object as a (un)signed integer. */
488 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
489 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
490 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
492 #define make_lisp_ptr(ptr, type) \
493 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
494 + ((intptr_t) (ptr) & VALMASK)))
497 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
498 which were stored in a Lisp_Object. */
499 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
501 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
504 #endif /* not USE_LSB_TAG */
506 /* For integers known to be positive, XFASTINT sometimes provides
507 faster retrieval and XSETFASTINT provides faster storage.
508 If not, fallback on the non-accelerated path. */
510 # define XFASTINT(a) (XINT (a))
511 # define XSETFASTINT(a, b) (XSETINT (a, b))
514 /* Extract the pointer value of the Lisp object A, under the
515 assumption that A's type is TYPE. This is a fallback
516 implementation if nothing faster is available. */
518 # define XUNTAG(a, type) XPNTR (a)
521 #define EQ(x, y) (XHASH (x) == XHASH (y))
523 /* Largest and smallest representable fixnum values. These are the C
524 values. They are macros for use in static initializers. */
525 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
526 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
528 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
529 written this way so that it also works if I is of unsigned
530 type or if I is a NaN. */
532 #define FIXNUM_OVERFLOW_P(i) \
533 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
535 LISP_INLINE
ptrdiff_t
536 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
538 return num
< lower
? lower
: num
<= upper
? num
: upper
;
541 /* Extract a value or address from a Lisp_Object. */
543 #define XCONS(a) (eassert (CONSP (a)), \
544 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
545 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
546 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
547 #define XSTRING(a) (eassert (STRINGP (a)), \
548 (struct Lisp_String *) XUNTAG (a, Lisp_String))
549 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
550 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
551 #define XFLOAT(a) (eassert (FLOATP (a)), \
552 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
556 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
557 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
558 #define XMISCTYPE(a) (XMISCANY (a)->type)
559 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
560 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
561 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
563 /* Forwarding object types. */
565 #define XFWDTYPE(a) (a->u_intfwd.type)
566 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
567 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
568 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
569 #define XBUFFER_OBJFWD(a) \
570 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
571 #define XKBOARD_OBJFWD(a) \
572 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
574 /* Pseudovector types. */
576 #define XPROCESS(a) (eassert (PROCESSP (a)), \
577 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
578 #define XWINDOW(a) (eassert (WINDOWP (a)), \
579 (struct window *) XUNTAG (a, Lisp_Vectorlike))
580 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
581 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
582 #define XSUBR(a) (eassert (SUBRP (a)), \
583 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
584 #define XBUFFER(a) (eassert (BUFFERP (a)), \
585 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
586 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
587 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
588 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
589 ((struct Lisp_Sub_Char_Table *) \
590 XUNTAG (a, Lisp_Vectorlike)))
591 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
592 ((struct Lisp_Bool_Vector *) \
593 XUNTAG (a, Lisp_Vectorlike)))
595 /* Construct a Lisp_Object from a value or address. */
597 #define XSETINT(a, b) ((a) = make_number (b))
598 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
599 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
600 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
601 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
602 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
606 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
607 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
609 /* Pseudovector types. */
611 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
612 #define XSETTYPED_PVECTYPE(v, size_member, code) \
613 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
614 #define XSETPVECTYPESIZE(v, code, sizeval) \
615 ((v)->header.size = (PSEUDOVECTOR_FLAG \
616 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
619 /* The cast to struct vectorlike_header * avoids aliasing issues. */
620 #define XSETPSEUDOVECTOR(a, b, code) \
621 XSETTYPED_PSEUDOVECTOR (a, b, \
622 (((struct vectorlike_header *) \
623 XUNTAG (a, Lisp_Vectorlike)) \
626 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
627 (XSETVECTOR (a, b), \
628 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
629 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
631 #define XSETWINDOW_CONFIGURATION(a, b) \
632 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
633 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
634 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
635 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
636 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
637 #define XSETSUBR(a, b) \
638 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
639 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
640 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
641 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
642 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
643 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
645 /* Convenience macros for dealing with Lisp arrays. */
647 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
648 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
649 #define ASET(ARRAY, IDX, VAL) \
650 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
651 XVECTOR (ARRAY)->contents[IDX] = (VAL))
653 /* Convenience macros for dealing with Lisp strings. */
655 #define SDATA(string) (XSTRING (string)->data + 0)
656 #define SREF(string, index) (SDATA (string)[index] + 0)
657 #define SSET(string, index, new) (SDATA (string)[index] = (new))
658 #define SCHARS(string) (XSTRING (string)->size + 0)
659 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
661 /* Avoid "differ in sign" warnings. */
662 #define SSDATA(x) ((char *) SDATA (x))
664 #define STRING_SET_CHARS(string, newsize) \
665 (XSTRING (string)->size = (newsize))
667 #define STRING_COPYIN(string, index, new, count) \
668 memcpy (SDATA (string) + index, new, count)
672 #define CHECK_TYPE(ok, Qxxxp, x) \
673 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
675 /* Deprecated and will be removed soon. */
677 #define INTERNAL_FIELD(field) field ## _
679 /* See the macros in intervals.h. */
681 typedef struct interval
*INTERVAL
;
683 /* Complain if object is not string or buffer type. */
684 #define CHECK_STRING_OR_BUFFER(x) \
685 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
689 /* Car of this cons cell. */
694 /* Cdr of this cons cell. */
697 /* Used to chain conses on a free list. */
698 struct Lisp_Cons
*chain
;
702 /* Take the car or cdr of something known to be a cons cell. */
703 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
704 of code that has to know what a cons cell looks like. Other code not
705 part of the basic lisp implementation should assume that the car and cdr
706 fields are not accessible as lvalues. (What if we want to switch to
707 a copying collector someday? Cached cons cell field addresses may be
708 invalidated at arbitrary points.) */
709 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
710 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
712 /* Use these from normal code. */
713 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
714 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
716 /* Use these to set the fields of a cons cell.
718 Note that both arguments may refer to the same object, so 'n'
719 should not be read after 'c' is first modified. Also, neither
720 argument should be evaluated more than once; side effects are
721 especially common in the second argument. */
722 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
723 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
725 /* Take the car or cdr of something whose type is not known. */
727 (CONSP ((c)) ? XCAR ((c)) \
728 : NILP ((c)) ? Qnil \
729 : wrong_type_argument (Qlistp, (c)))
732 (CONSP ((c)) ? XCDR ((c)) \
733 : NILP ((c)) ? Qnil \
734 : wrong_type_argument (Qlistp, (c)))
736 /* Take the car or cdr of something whose type is not known. */
737 #define CAR_SAFE(c) \
738 (CONSP ((c)) ? XCAR ((c)) : Qnil)
740 #define CDR_SAFE(c) \
741 (CONSP ((c)) ? XCDR ((c)) : Qnil)
743 /* True if STR is a multibyte string. */
744 #define STRING_MULTIBYTE(STR) \
745 (XSTRING (STR)->size_byte >= 0)
747 /* Return the length in bytes of STR. */
749 #ifdef GC_CHECK_STRING_BYTES
752 extern ptrdiff_t string_bytes (struct Lisp_String
*);
753 #define STRING_BYTES(S) string_bytes ((S))
755 #else /* not GC_CHECK_STRING_BYTES */
757 #define STRING_BYTES(STR) \
758 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
760 #endif /* not GC_CHECK_STRING_BYTES */
762 /* An upper bound on the number of bytes in a Lisp string, not
763 counting the terminating null. This a tight enough bound to
764 prevent integer overflow errors that would otherwise occur during
765 string size calculations. A string cannot contain more bytes than
766 a fixnum can represent, nor can it be so long that C pointer
767 arithmetic stops working on the string plus its terminating null.
768 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
769 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
770 would expose alloc.c internal details that we'd rather keep
773 This is a macro for use in static initializers, and a constant for
774 visibility to GDB. The cast to ptrdiff_t ensures that
775 the macro is signed. */
776 static ptrdiff_t const STRING_BYTES_BOUND
=
777 #define STRING_BYTES_BOUND \
778 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
781 /* Mark STR as a unibyte string. */
782 #define STRING_SET_UNIBYTE(STR) \
783 do { if (EQ (STR, empty_multibyte_string)) \
784 (STR) = empty_unibyte_string; \
785 else XSTRING (STR)->size_byte = -1; } while (0)
787 /* Mark STR as a multibyte string. Assure that STR contains only
788 ASCII characters in advance. */
789 #define STRING_SET_MULTIBYTE(STR) \
790 do { if (EQ (STR, empty_unibyte_string)) \
791 (STR) = empty_multibyte_string; \
792 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
794 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
800 INTERVAL intervals
; /* Text properties in this string. */
804 /* Header of vector-like objects. This documents the layout constraints on
805 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
806 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
807 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
808 because when two such pointers potentially alias, a compiler won't
809 incorrectly reorder loads and stores to their size fields. See
810 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
811 struct vectorlike_header
813 /* This field contains various pieces of information:
814 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
815 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
816 vector (0) or a pseudovector (1).
817 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
818 of slots) of the vector.
819 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
820 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
821 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
822 Lisp_Object slots at the beginning of the object that need to be
823 traced by the GC, tho some types use it slightly differently.
824 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
825 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
829 /* When the vector is allocated from a vector block, NBYTES is used
830 if the vector is not on a free list, and VECTOR is used otherwise.
831 For large vector-like objects, BUFFER or VECTOR is used as a pointer
832 to the next vector-like object. It is generally a buffer or a
833 Lisp_Vector alias, so for convenience it is a union instead of a
834 pointer: this way, one can write P->next.vector instead of ((struct
835 Lisp_Vector *) P->next). */
837 /* This is only needed for small vectors that are not free because the
838 `size' field only gives us the number of Lisp_Object slots, whereas we
839 need to know the total size, including non-Lisp_Object data.
840 FIXME: figure out a way to store this info elsewhere so we can
841 finally get rid of this extra word of overhead. */
843 struct buffer
*buffer
;
844 /* FIXME: This can be removed: For large vectors, this field could be
845 placed *before* the vector itself. And for small vectors on a free
846 list, this field could be stored in the vector's bytes, since the
847 empty vector is handled specially anyway. */
848 struct Lisp_Vector
*vector
;
852 /* Regular vector is just a header plus array of Lisp_Objects. */
856 struct vectorlike_header header
;
857 Lisp_Object contents
[1];
860 /* A boolvector is a kind of vectorlike, with contents are like a string. */
862 struct Lisp_Bool_Vector
864 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
865 just the subtype information. */
866 struct vectorlike_header header
;
867 /* This is the size in bits. */
869 /* This contains the actual bits, packed into bytes. */
870 unsigned char data
[1];
873 /* Some handy constants for calculating sizes
874 and offsets, mostly of vectorlike objects. */
878 header_size
= offsetof (struct Lisp_Vector
, contents
),
879 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
880 word_size
= sizeof (Lisp_Object
)
883 /* If a struct is made to look like a vector, this macro returns the length
884 of the shortest vector that would hold that struct. */
886 #define VECSIZE(type) \
887 ((sizeof (type) - header_size + word_size - 1) / word_size)
889 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
890 at the end and we need to compute the number of Lisp_Object fields (the
891 ones that the GC needs to trace). */
893 #define PSEUDOVECSIZE(type, nonlispfield) \
894 ((offsetof (type, nonlispfield) - header_size) / word_size)
896 /* A char-table is a kind of vectorlike, with contents are like a
897 vector but with a few other slots. For some purposes, it makes
898 sense to handle a char-table with type struct Lisp_Vector. An
899 element of a char table can be any Lisp objects, but if it is a sub
900 char-table, we treat it a table that contains information of a
901 specific range of characters. A sub char-table has the same
902 structure as a vector. A sub char table appears only in an element
903 of a char-table, and there's no way to access it directly from
904 Emacs Lisp program. */
908 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
909 ({struct Lisp_Char_Table *_tbl = NULL; \
912 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
913 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
914 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
916 _val = _tbl->defalt; \
917 } while (NILP (_val) && ! NILP (_tbl->parent)); \
920 #else /* not __GNUC__ */
922 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
923 (! NILP (XCHAR_TABLE (CT)->ascii) \
924 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
925 ? XCHAR_TABLE (CT)->ascii \
926 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
927 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
928 : char_table_ref ((CT), (IDX))) \
929 : char_table_ref ((CT), (IDX)))
931 #endif /* not __GNUC__ */
933 /* Compute A OP B, using the unsigned comparison operator OP. A and B
934 should be integer expressions. This is not the same as
935 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
936 returns 1. For efficiency, prefer plain unsigned comparison if A
937 and B's sizes both fit (after integer promotion). */
938 #define UNSIGNED_CMP(a, op, b) \
939 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
940 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
941 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
943 /* Nonzero iff C is an ASCII character. */
944 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
946 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
947 characters. Do not check validity of CT. */
948 #define CHAR_TABLE_REF(CT, IDX) \
949 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
950 : char_table_ref ((CT), (IDX)))
952 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
953 8-bit European characters. Do not check validity of CT. */
954 #define CHAR_TABLE_SET(CT, IDX, VAL) \
955 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
956 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
957 : char_table_set (CT, IDX, VAL))
959 enum CHARTAB_SIZE_BITS
961 CHARTAB_SIZE_BITS_0
= 6,
962 CHARTAB_SIZE_BITS_1
= 4,
963 CHARTAB_SIZE_BITS_2
= 5,
964 CHARTAB_SIZE_BITS_3
= 7
967 extern const int chartab_size
[4];
969 struct Lisp_Char_Table
971 /* HEADER.SIZE is the vector's size field, which also holds the
972 pseudovector type information. It holds the size, too.
973 The size counts the defalt, parent, purpose, ascii,
974 contents, and extras slots. */
975 struct vectorlike_header header
;
977 /* This holds a default value,
978 which is used whenever the value for a specific character is nil. */
981 /* This points to another char table, which we inherit from when the
982 value for a specific character is nil. The `defalt' slot takes
983 precedence over this. */
986 /* This is a symbol which says what kind of use this char-table is
990 /* The bottom sub char-table for characters of the range 0..127. It
991 is nil if none of ASCII character has a specific value. */
994 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
996 /* These hold additional data. It is a vector. */
997 Lisp_Object extras
[1];
1000 struct Lisp_Sub_Char_Table
1002 /* HEADER.SIZE is the vector's size field, which also holds the
1003 pseudovector type information. It holds the size, too. */
1004 struct vectorlike_header header
;
1006 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1007 char-table of depth 1 contains 16 elements, and each element
1008 covers 4096 (128*32) characters. A sub char-table of depth 2
1009 contains 32 elements, and each element covers 128 characters. A
1010 sub char-table of depth 3 contains 128 elements, and each element
1011 is for one character. */
1014 /* Minimum character covered by the sub char-table. */
1015 Lisp_Object min_char
;
1017 /* Use set_sub_char_table_contents to set this. */
1018 Lisp_Object contents
[1];
1021 /* This structure describes a built-in function.
1022 It is generated by the DEFUN macro only.
1023 defsubr makes it into a Lisp object.
1025 This type is treated in most respects as a pseudovector,
1026 but since we never dynamically allocate or free them,
1027 we don't need a struct vectorlike_header and its 'next' field. */
1033 Lisp_Object (*a0
) (void);
1034 Lisp_Object (*a1
) (Lisp_Object
);
1035 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1036 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1037 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1038 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1039 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1040 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1041 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1042 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1043 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1045 short min_args
, max_args
;
1046 const char *symbol_name
;
1047 const char *intspec
;
1051 /* This is the number of slots that every char table must have. This
1052 counts the ordinary slots and the top, defalt, parent, and purpose
1054 enum CHAR_TABLE_STANDARD_SLOTS
1056 CHAR_TABLE_STANDARD_SLOTS
= VECSIZE (struct Lisp_Char_Table
) - 1
1059 /* Return the number of "extra" slots in the char table CT. */
1061 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1062 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1065 /***********************************************************************
1067 ***********************************************************************/
1069 /* Interned state of a symbol. */
1071 enum symbol_interned
1073 SYMBOL_UNINTERNED
= 0,
1074 SYMBOL_INTERNED
= 1,
1075 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1078 enum symbol_redirect
1080 SYMBOL_PLAINVAL
= 4,
1081 SYMBOL_VARALIAS
= 1,
1082 SYMBOL_LOCALIZED
= 2,
1083 SYMBOL_FORWARDED
= 3
1088 unsigned gcmarkbit
: 1;
1090 /* Indicates where the value can be found:
1091 0 : it's a plain var, the value is in the `value' field.
1092 1 : it's a varalias, the value is really in the `alias' symbol.
1093 2 : it's a localized var, the value is in the `blv' object.
1094 3 : it's a forwarding variable, the value is in `forward'. */
1095 ENUM_BF (symbol_redirect
) redirect
: 3;
1097 /* Non-zero means symbol is constant, i.e. changing its value
1098 should signal an error. If the value is 3, then the var
1099 can be changed, but only by `defconst'. */
1100 unsigned constant
: 2;
1102 /* Interned state of the symbol. This is an enumerator from
1103 enum symbol_interned. */
1104 unsigned interned
: 2;
1106 /* Non-zero means that this variable has been explicitly declared
1107 special (with `defvar' etc), and shouldn't be lexically bound. */
1108 unsigned declared_special
: 1;
1110 /* The symbol's name, as a Lisp string. */
1113 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1114 union is used depends on the `redirect' field above. */
1117 struct Lisp_Symbol
*alias
;
1118 struct Lisp_Buffer_Local_Value
*blv
;
1119 union Lisp_Fwd
*fwd
;
1122 /* Function value of the symbol or Qunbound if not fboundp. */
1123 Lisp_Object function
;
1125 /* The symbol's property list. */
1128 /* Next symbol in obarray bucket, if the symbol is interned. */
1129 struct Lisp_Symbol
*next
;
1132 /* Value is name of symbol. */
1134 #define SYMBOL_VAL(sym) \
1135 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1136 #define SYMBOL_ALIAS(sym) \
1137 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1138 #define SYMBOL_BLV(sym) \
1139 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1140 #define SYMBOL_FWD(sym) \
1141 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1142 #define SET_SYMBOL_VAL(sym, v) \
1143 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1144 #define SET_SYMBOL_ALIAS(sym, v) \
1145 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1146 #define SET_SYMBOL_BLV(sym, v) \
1147 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1148 #define SET_SYMBOL_FWD(sym, v) \
1149 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1151 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1153 /* Value is non-zero if SYM is an interned symbol. */
1155 #define SYMBOL_INTERNED_P(sym) \
1156 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1158 /* Value is non-zero if SYM is interned in initial_obarray. */
1160 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1161 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1163 /* Value is non-zero if symbol is considered a constant, i.e. its
1164 value cannot be changed (there is an exception for keyword symbols,
1165 whose value can be set to the keyword symbol itself). */
1167 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1169 #define DEFSYM(sym, name) \
1170 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1173 /***********************************************************************
1175 ***********************************************************************/
1177 /* The structure of a Lisp hash table. */
1179 struct Lisp_Hash_Table
1181 /* This is for Lisp; the hash table code does not refer to it. */
1182 struct vectorlike_header header
;
1184 /* Function used to compare keys. */
1187 /* Nil if table is non-weak. Otherwise a symbol describing the
1188 weakness of the table. */
1191 /* When the table is resized, and this is an integer, compute the
1192 new size by adding this to the old size. If a float, compute the
1193 new size by multiplying the old size with this factor. */
1194 Lisp_Object rehash_size
;
1196 /* Resize hash table when number of entries/ table size is >= this
1198 Lisp_Object rehash_threshold
;
1200 /* Vector of hash codes.. If hash[I] is nil, this means that that
1201 entry I is unused. */
1204 /* Vector used to chain entries. If entry I is free, next[I] is the
1205 entry number of the next free item. If entry I is non-free,
1206 next[I] is the index of the next entry in the collision chain. */
1209 /* Index of first free entry in free list. */
1210 Lisp_Object next_free
;
1212 /* Bucket vector. A non-nil entry is the index of the first item in
1213 a collision chain. This vector's size can be larger than the
1214 hash table size to reduce collisions. */
1217 /* User-supplied hash function, or nil. */
1218 Lisp_Object user_hash_function
;
1220 /* User-supplied key comparison function, or nil. */
1221 Lisp_Object user_cmp_function
;
1223 /* Only the fields above are traced normally by the GC. The ones below
1224 `count' are special and are either ignored by the GC or traced in
1225 a special way (e.g. because of weakness). */
1227 /* Number of key/value entries in the table. */
1230 /* Vector of keys and values. The key of item I is found at index
1231 2 * I, the value is found at index 2 * I + 1.
1232 This is gc_marked specially if the table is weak. */
1233 Lisp_Object key_and_value
;
1235 /* Next weak hash table if this is a weak hash table. The head
1236 of the list is in weak_hash_tables. */
1237 struct Lisp_Hash_Table
*next_weak
;
1239 /* C function to compare two keys. */
1240 bool (*cmpfn
) (struct Lisp_Hash_Table
*,
1241 Lisp_Object
, EMACS_UINT
,
1242 Lisp_Object
, EMACS_UINT
);
1244 /* C function to compute hash code. */
1245 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1249 #define XHASH_TABLE(OBJ) \
1250 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1252 #define XSET_HASH_TABLE(VAR, PTR) \
1253 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1255 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1257 #define CHECK_HASH_TABLE(x) \
1258 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1260 /* Value is the key part of entry IDX in hash table H. */
1262 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1264 /* Value is the value part of entry IDX in hash table H. */
1266 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1268 /* Value is the index of the next entry following the one at IDX
1271 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1273 /* Value is the hash code computed for entry IDX in hash table H. */
1275 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1277 /* Value is the index of the element in hash table H that is the
1278 start of the collision list at index IDX in the index vector of H. */
1280 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1282 /* Value is the size of hash table H. */
1284 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1286 /* Default size for hash tables if not specified. */
1288 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1290 /* Default threshold specifying when to resize a hash table. The
1291 value gives the ratio of current entries in the hash table and the
1292 size of the hash table. */
1294 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1296 /* Default factor by which to increase the size of a hash table. */
1298 static double const DEFAULT_REHASH_SIZE
= 1.5;
1300 /* These structures are used for various misc types. */
1302 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1304 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1305 unsigned gcmarkbit
: 1;
1311 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1312 unsigned gcmarkbit
: 1;
1314 /* This flag is temporarily used in the functions
1315 decode/encode_coding_object to record that the marker position
1316 must be adjusted after the conversion. */
1317 unsigned int need_adjustment
: 1;
1318 /* 1 means normal insertion at the marker's position
1319 leaves the marker after the inserted text. */
1320 unsigned int insertion_type
: 1;
1321 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1322 Note: a chain of markers can contain markers pointing into different
1323 buffers (the chain is per buffer_text rather than per buffer, so it's
1324 shared between indirect buffers). */
1325 /* This is used for (other than NULL-checking):
1327 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1328 - unchain_marker: to find the list from which to unchain.
1329 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1331 struct buffer
*buffer
;
1333 /* The remaining fields are meaningless in a marker that
1334 does not point anywhere. */
1336 /* For markers that point somewhere,
1337 this is used to chain of all the markers in a given buffer. */
1338 /* We could remove it and use an array in buffer_text instead.
1339 That would also allow to preserve it ordered. */
1340 struct Lisp_Marker
*next
;
1341 /* This is the char position where the marker points. */
1343 /* This is the byte position.
1344 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1345 used to implement the functionality of markers, but rather to (ab)use
1346 markers as a cache for char<->byte mappings). */
1350 /* START and END are markers in the overlay's buffer, and
1351 PLIST is the overlay's property list. */
1353 /* An overlay's real data content is:
1355 - buffer (really there are two buffer pointers, one per marker,
1356 and both points to the same buffer)
1357 - insertion type of both ends (per-marker fields)
1358 - start & start byte (of start marker)
1359 - end & end byte (of end marker)
1360 - next (singly linked list of overlays)
1361 - next fields of start and end markers (singly linked list of markers).
1362 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1365 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1366 unsigned gcmarkbit
: 1;
1368 struct Lisp_Overlay
*next
;
1374 /* Hold a C pointer for later use.
1375 This type of object is used in the arg to record_unwind_protect. */
1376 struct Lisp_Save_Value
1378 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1379 unsigned gcmarkbit
: 1;
1381 /* If DOGC is set, POINTER is the address of a memory
1382 area containing INTEGER potential Lisp_Objects. */
1383 unsigned int dogc
: 1;
1389 /* A miscellaneous object, when it's on the free list. */
1392 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1393 unsigned gcmarkbit
: 1;
1395 union Lisp_Misc
*chain
;
1398 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1399 It uses one of these struct subtypes to get the type field. */
1403 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1404 struct Lisp_Free u_free
;
1405 struct Lisp_Marker u_marker
;
1406 struct Lisp_Overlay u_overlay
;
1407 struct Lisp_Save_Value u_save_value
;
1410 /* Forwarding pointer to an int variable.
1411 This is allowed only in the value cell of a symbol,
1412 and it means that the symbol's value really lives in the
1413 specified int variable. */
1416 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1420 /* Boolean forwarding pointer to an int variable.
1421 This is like Lisp_Intfwd except that the ostensible
1422 "value" of the symbol is t if the int variable is nonzero,
1423 nil if it is zero. */
1426 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1430 /* Forwarding pointer to a Lisp_Object variable.
1431 This is allowed only in the value cell of a symbol,
1432 and it means that the symbol's value really lives in the
1433 specified variable. */
1436 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1437 Lisp_Object
*objvar
;
1440 /* Like Lisp_Objfwd except that value lives in a slot in the
1441 current buffer. Value is byte index of slot within buffer. */
1442 struct Lisp_Buffer_Objfwd
1444 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1446 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1449 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1450 the symbol has buffer-local or frame-local bindings. (Exception:
1451 some buffer-local variables are built-in, with their values stored
1452 in the buffer structure itself. They are handled differently,
1453 using struct Lisp_Buffer_Objfwd.)
1455 The `realvalue' slot holds the variable's current value, or a
1456 forwarding pointer to where that value is kept. This value is the
1457 one that corresponds to the loaded binding. To read or set the
1458 variable, you must first make sure the right binding is loaded;
1459 then you can access the value in (or through) `realvalue'.
1461 `buffer' and `frame' are the buffer and frame for which the loaded
1462 binding was found. If those have changed, to make sure the right
1463 binding is loaded it is necessary to find which binding goes with
1464 the current buffer and selected frame, then load it. To load it,
1465 first unload the previous binding, then copy the value of the new
1466 binding into `realvalue' (or through it). Also update
1467 LOADED-BINDING to point to the newly loaded binding.
1469 `local_if_set' indicates that merely setting the variable creates a
1470 local binding for the current buffer. Otherwise the latter, setting
1471 the variable does not do that; only make-local-variable does that. */
1473 struct Lisp_Buffer_Local_Value
1475 /* 1 means that merely setting the variable creates a local
1476 binding for the current buffer. */
1477 unsigned int local_if_set
: 1;
1478 /* 1 means this variable can have frame-local bindings, otherwise, it is
1479 can have buffer-local bindings. The two cannot be combined. */
1480 unsigned int frame_local
: 1;
1481 /* 1 means that the binding now loaded was found.
1482 Presumably equivalent to (defcell!=valcell). */
1483 unsigned int found
: 1;
1484 /* If non-NULL, a forwarding to the C var where it should also be set. */
1485 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1486 /* The buffer or frame for which the loaded binding was found. */
1488 /* A cons cell that holds the default value. It has the form
1489 (SYMBOL . DEFAULT-VALUE). */
1490 Lisp_Object defcell
;
1491 /* The cons cell from `where's parameter alist.
1492 It always has the form (SYMBOL . VALUE)
1493 Note that if `forward' is non-nil, VALUE may be out of date.
1494 Also if the currently loaded binding is the default binding, then
1495 this is `eq'ual to defcell. */
1496 Lisp_Object valcell
;
1499 /* Like Lisp_Objfwd except that value lives in a slot in the
1501 struct Lisp_Kboard_Objfwd
1503 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1509 struct Lisp_Intfwd u_intfwd
;
1510 struct Lisp_Boolfwd u_boolfwd
;
1511 struct Lisp_Objfwd u_objfwd
;
1512 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1513 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1516 /* Lisp floating point type. */
1522 struct Lisp_Float
*chain
;
1526 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1527 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1529 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1530 representations, have infinities and NaNs, and do not trap on
1531 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1532 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1533 wanted here, but is not quite right because Emacs does not require
1534 all the features of C11 Annex F (and does not require C11 at all,
1535 for that matter). */
1536 #define IEEE_FLOATING_POINT (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
1537 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
1539 /* A character, declared with the following typedef, is a member
1540 of some character set associated with the current buffer. */
1541 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1543 typedef unsigned char UCHAR
;
1546 /* Meanings of slots in a Lisp_Compiled: */
1550 COMPILED_ARGLIST
= 0,
1551 COMPILED_BYTECODE
= 1,
1552 COMPILED_CONSTANTS
= 2,
1553 COMPILED_STACK_DEPTH
= 3,
1554 COMPILED_DOC_STRING
= 4,
1555 COMPILED_INTERACTIVE
= 5
1558 /* Flag bits in a character. These also get used in termhooks.h.
1559 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1560 (MUlti-Lingual Emacs) might need 22 bits for the character value
1561 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1564 CHAR_ALT
= 0x0400000,
1565 CHAR_SUPER
= 0x0800000,
1566 CHAR_HYPER
= 0x1000000,
1567 CHAR_SHIFT
= 0x2000000,
1568 CHAR_CTL
= 0x4000000,
1569 CHAR_META
= 0x8000000,
1571 CHAR_MODIFIER_MASK
=
1572 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1574 /* Actually, the current Emacs uses 22 bits for the character value
1582 /* The glyph datatype, used to represent characters on the display.
1583 It consists of a char code and a face id. */
1590 /* Return a glyph's character code. */
1591 #define GLYPH_CHAR(glyph) ((glyph).ch)
1593 /* Return a glyph's face ID. */
1594 #define GLYPH_FACE(glyph) ((glyph).face_id)
1596 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1597 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1598 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1600 /* Return 1 if GLYPH contains valid character code. */
1601 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1604 /* Glyph Code from a display vector may either be an integer which
1605 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1606 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1608 #define GLYPH_CODE_P(gc) \
1610 ? (CHARACTERP (XCAR (gc)) \
1611 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1612 : (RANGED_INTEGERP \
1614 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1615 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1616 : TYPE_MAXIMUM (EMACS_INT)))))
1618 /* The following are valid only if GLYPH_CODE_P (gc). */
1620 #define GLYPH_CODE_CHAR(gc) \
1621 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1623 #define GLYPH_CODE_FACE(gc) \
1624 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1626 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1630 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1632 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1633 (XINT (gc) >> CHARACTERBITS)); \
1637 /* Structure to hold mouse highlight data. This is here because other
1638 header files need it for defining struct x_output etc. */
1640 /* These variables describe the range of text currently shown in its
1641 mouse-face, together with the window they apply to. As long as
1642 the mouse stays within this range, we need not redraw anything on
1643 its account. Rows and columns are glyph matrix positions in
1644 MOUSE_FACE_WINDOW. */
1645 int mouse_face_beg_row
, mouse_face_beg_col
;
1646 int mouse_face_beg_x
, mouse_face_beg_y
;
1647 int mouse_face_end_row
, mouse_face_end_col
;
1648 int mouse_face_end_x
, mouse_face_end_y
;
1649 int mouse_face_past_end
;
1650 Lisp_Object mouse_face_window
;
1651 int mouse_face_face_id
;
1652 Lisp_Object mouse_face_overlay
;
1654 /* 1 if a mouse motion event came and we didn't handle it right away because
1655 gc was in progress. */
1656 int mouse_face_deferred_gc
;
1658 /* FRAME and X, Y position of mouse when last checked for
1659 highlighting. X and Y can be negative or out of range for the frame. */
1660 struct frame
*mouse_face_mouse_frame
;
1661 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1663 /* Nonzero means defer mouse-motion highlighting. */
1664 int mouse_face_defer
;
1666 /* Nonzero means that the mouse highlight should not be shown. */
1667 int mouse_face_hidden
;
1669 int mouse_face_image_state
;
1672 /* Data type checking. */
1674 #define NILP(x) EQ (x, Qnil)
1676 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1677 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1679 #define RANGED_INTEGERP(lo, x, hi) \
1680 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1681 #define TYPE_RANGED_INTEGERP(type, x) \
1682 (TYPE_SIGNED (type) \
1683 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1684 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1686 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1687 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1688 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1689 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1690 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1691 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1693 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1694 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1695 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1696 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1697 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1699 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1700 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1701 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1702 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1703 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1705 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1706 vectorlike_header * avoids aliasing issues. */
1707 #define PSEUDOVECTORP(x, code) \
1708 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1710 #define PSEUDOVECTOR_TYPEP(v, code) \
1711 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1712 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1714 /* True if object X, with internal type struct T *, is a pseudovector whose
1716 #define TYPED_PSEUDOVECTORP(x, t, code) \
1718 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1720 /* Test for specific pseudovector types. */
1721 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1722 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1723 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1724 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1725 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1726 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1727 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1728 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1729 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1730 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1731 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1732 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1734 /* Test for image (image . spec) */
1735 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1740 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1742 #define CHECK_LIST(x) \
1743 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1745 #define CHECK_LIST_CONS(x, y) \
1746 CHECK_TYPE (CONSP (x), Qlistp, y)
1748 #define CHECK_LIST_END(x, y) \
1749 CHECK_TYPE (NILP (x), Qlistp, y)
1751 #define CHECK_STRING(x) \
1752 CHECK_TYPE (STRINGP (x), Qstringp, x)
1754 #define CHECK_STRING_CAR(x) \
1755 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1757 #define CHECK_CONS(x) \
1758 CHECK_TYPE (CONSP (x), Qconsp, x)
1760 #define CHECK_SYMBOL(x) \
1761 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1763 #define CHECK_CHAR_TABLE(x) \
1764 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1766 #define CHECK_VECTOR(x) \
1767 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1769 #define CHECK_VECTOR_OR_STRING(x) \
1770 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1772 #define CHECK_ARRAY(x, Qxxxp) \
1773 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1775 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1776 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1778 #define CHECK_BUFFER(x) \
1779 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1781 #define CHECK_WINDOW(x) \
1782 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1784 #define CHECK_WINDOW_CONFIGURATION(x) \
1785 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1787 #define CHECK_PROCESS(x) \
1788 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1790 #define CHECK_SUBR(x) \
1791 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1793 #define CHECK_NUMBER(x) \
1794 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1796 #define CHECK_NATNUM(x) \
1797 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1799 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1802 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1803 args_out_of_range_3 \
1805 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1806 ? MOST_NEGATIVE_FIXNUM \
1808 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1810 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1812 if (TYPE_SIGNED (type)) \
1813 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1815 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1818 #define CHECK_MARKER(x) \
1819 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1821 #define CHECK_NUMBER_COERCE_MARKER(x) \
1822 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1823 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1825 #define XFLOATINT(n) extract_float((n))
1827 #define CHECK_FLOAT(x) \
1828 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1830 #define CHECK_NUMBER_OR_FLOAT(x) \
1831 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1833 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1834 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1835 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1837 #define CHECK_OVERLAY(x) \
1838 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1840 /* Since we can't assign directly to the CAR or CDR fields of a cons
1841 cell, use these when checking that those fields contain numbers. */
1842 #define CHECK_NUMBER_CAR(x) \
1844 Lisp_Object tmp = XCAR (x); \
1845 CHECK_NUMBER (tmp); \
1846 XSETCAR ((x), tmp); \
1849 #define CHECK_NUMBER_CDR(x) \
1851 Lisp_Object tmp = XCDR (x); \
1852 CHECK_NUMBER (tmp); \
1853 XSETCDR ((x), tmp); \
1856 #define CHECK_NATNUM_CAR(x) \
1858 Lisp_Object tmp = XCAR (x); \
1859 CHECK_NATNUM (tmp); \
1860 XSETCAR ((x), tmp); \
1863 #define CHECK_NATNUM_CDR(x) \
1865 Lisp_Object tmp = XCDR (x); \
1866 CHECK_NATNUM (tmp); \
1867 XSETCDR ((x), tmp); \
1870 /* Define a built-in function for calling from Lisp.
1871 `lname' should be the name to give the function in Lisp,
1872 as a null-terminated C string.
1873 `fnname' should be the name of the function in C.
1874 By convention, it starts with F.
1875 `sname' should be the name for the C constant structure
1876 that records information on this function for internal use.
1877 By convention, it should be the same as `fnname' but with S instead of F.
1878 It's too bad that C macros can't compute this from `fnname'.
1879 `minargs' should be a number, the minimum number of arguments allowed.
1880 `maxargs' should be a number, the maximum number of arguments allowed,
1881 or else MANY or UNEVALLED.
1882 MANY means pass a vector of evaluated arguments,
1883 in the form of an integer number-of-arguments
1884 followed by the address of a vector of Lisp_Objects
1885 which contains the argument values.
1886 UNEVALLED means pass the list of unevaluated arguments
1887 `intspec' says how interactive arguments are to be fetched.
1888 If the string starts with a `(', `intspec' is evaluated and the resulting
1889 list is the list of arguments.
1890 If it's a string that doesn't start with `(', the value should follow
1891 the one of the doc string for `interactive'.
1892 A null string means call interactively with no arguments.
1893 `doc' is documentation for the user. */
1895 /* This version of DEFUN declares a function prototype with the right
1896 arguments, so we can catch errors with maxargs at compile-time. */
1898 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1899 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1900 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1901 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1902 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1903 { (Lisp_Object (__cdecl *)(void))fnname }, \
1904 minargs, maxargs, lname, intspec, 0}; \
1906 #else /* not _MSC_VER */
1907 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1908 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1909 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1910 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1911 { .a ## maxargs = fnname }, \
1912 minargs, maxargs, lname, intspec, 0}; \
1916 /* Note that the weird token-substitution semantics of ANSI C makes
1917 this work for MANY and UNEVALLED. */
1918 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1919 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1920 #define DEFUN_ARGS_0 (void)
1921 #define DEFUN_ARGS_1 (Lisp_Object)
1922 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1923 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1924 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1925 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1927 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1928 Lisp_Object, Lisp_Object)
1929 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1930 Lisp_Object, Lisp_Object, Lisp_Object)
1931 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1932 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1934 /* Non-zero if OBJ is a Lisp function. */
1935 #define FUNCTIONP(OBJ) functionp(OBJ)
1938 is how we define the symbol for function `name' at start-up time. */
1939 extern void defsubr (struct Lisp_Subr
*);
1947 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1948 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1949 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
1950 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1951 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1953 /* Macros we use to define forwarded Lisp variables.
1954 These are used in the syms_of_FILENAME functions.
1956 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1957 lisp variable is actually a field in `struct emacs_globals'. The
1958 field's name begins with "f_", which is a convention enforced by
1959 these macros. Each such global has a corresponding #define in
1960 globals.h; the plain name should be used in the code.
1962 E.g., the global "cons_cells_consed" is declared as "int
1963 f_cons_cells_consed" in globals.h, but there is a define:
1965 #define cons_cells_consed globals.f_cons_cells_consed
1967 All C code uses the `cons_cells_consed' name. This is all done
1968 this way to support indirection for multi-threaded Emacs. */
1970 #define DEFVAR_LISP(lname, vname, doc) \
1972 static struct Lisp_Objfwd o_fwd; \
1973 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1975 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1977 static struct Lisp_Objfwd o_fwd; \
1978 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1980 #define DEFVAR_BOOL(lname, vname, doc) \
1982 static struct Lisp_Boolfwd b_fwd; \
1983 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1985 #define DEFVAR_INT(lname, vname, doc) \
1987 static struct Lisp_Intfwd i_fwd; \
1988 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1991 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1993 static struct Lisp_Objfwd o_fwd; \
1994 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1997 #define DEFVAR_KBOARD(lname, vname, doc) \
1999 static struct Lisp_Kboard_Objfwd ko_fwd; \
2000 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2003 /* Save and restore the instruction and environment pointers,
2004 without affecting the signal mask. */
2007 typedef jmp_buf sys_jmp_buf
;
2008 # define sys_setjmp(j) _setjmp (j)
2009 # define sys_longjmp(j, v) _longjmp (j, v)
2010 #elif defined HAVE_SIGSETJMP
2011 typedef sigjmp_buf sys_jmp_buf
;
2012 # define sys_setjmp(j) sigsetjmp (j, 0)
2013 # define sys_longjmp(j, v) siglongjmp (j, v)
2015 /* A platform that uses neither _longjmp nor siglongjmp; assume
2016 longjmp does not affect the sigmask. */
2017 typedef jmp_buf sys_jmp_buf
;
2018 # define sys_setjmp(j) setjmp (j)
2019 # define sys_longjmp(j, v) longjmp (j, v)
2023 /* Structure for recording Lisp call stack for backtrace purposes. */
2025 /* The special binding stack holds the outer values of variables while
2026 they are bound by a function application or a let form, stores the
2027 code to be executed for Lisp unwind-protect forms, and stores the C
2028 functions to be called for record_unwind_protect.
2030 If func is non-zero, undoing this binding applies func to old_value;
2031 This implements record_unwind_protect.
2033 Otherwise, the element is a variable binding.
2035 If the symbol field is a symbol, it is an ordinary variable binding.
2037 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2038 which means having bound a local value while CURRENT-BUFFER was active.
2039 If WHERE is nil this means we saw the default value when binding SYMBOL.
2040 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2041 value. Other values of WHERE mean an internal error. */
2043 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2047 Lisp_Object symbol
, old_value
;
2048 specbinding_func func
;
2049 Lisp_Object unused
; /* Dividing by 16 is faster than by 12. */
2052 extern struct specbinding
*specpdl
;
2053 extern struct specbinding
*specpdl_ptr
;
2054 extern ptrdiff_t specpdl_size
;
2056 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2060 struct backtrace
*next
;
2061 Lisp_Object function
;
2062 Lisp_Object
*args
; /* Points to vector of args. */
2063 ptrdiff_t nargs
; /* Length of vector. */
2064 /* Nonzero means call value of debugger when done with this operation. */
2065 unsigned int debug_on_exit
: 1;
2068 extern struct backtrace
*backtrace_list
;
2070 /* Everything needed to describe an active condition case.
2072 Members are volatile if their values need to survive _longjmp when
2073 a 'struct handler' is a local variable. */
2076 /* The handler clauses and variable from the condition-case form. */
2077 /* For a handler set up in Lisp code, this is always a list.
2078 For an internal handler set up by internal_condition_case*,
2079 this can instead be the symbol t or `error'.
2080 t: handle all conditions.
2081 error: handle all conditions, and errors can run the debugger
2082 or display a backtrace. */
2083 Lisp_Object handler
;
2085 Lisp_Object
volatile var
;
2087 /* Fsignal stores here the condition-case clause that applies,
2088 and Fcondition_case thus knows which clause to run. */
2089 Lisp_Object
volatile chosen_clause
;
2091 /* Used to effect the longjump out to the handler. */
2092 struct catchtag
*tag
;
2094 /* The next enclosing handler. */
2095 struct handler
*next
;
2098 /* This structure helps implement the `catch' and `throw' control
2099 structure. A struct catchtag contains all the information needed
2100 to restore the state of the interpreter after a non-local jump.
2102 Handlers for error conditions (represented by `struct handler'
2103 structures) just point to a catch tag to do the cleanup required
2106 catchtag structures are chained together in the C calling stack;
2107 the `next' member points to the next outer catchtag.
2109 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2110 member is TAG, and then unbinds to it. The `val' member is used to
2111 hold VAL while the stack is unwound; `val' is returned as the value
2114 All the other members are concerned with restoring the interpreter
2117 Members are volatile if their values need to survive _longjmp when
2118 a 'struct catchtag' is a local variable. */
2122 Lisp_Object
volatile val
;
2123 struct catchtag
*volatile next
;
2124 struct gcpro
*gcpro
;
2126 struct backtrace
*backlist
;
2127 struct handler
*handlerlist
;
2128 EMACS_INT lisp_eval_depth
;
2129 ptrdiff_t volatile pdlcount
;
2130 int poll_suppress_count
;
2131 int interrupt_input_blocked
;
2132 struct byte_stack
*byte_stack
;
2135 extern Lisp_Object memory_signal_data
;
2137 /* An address near the bottom of the stack.
2138 Tells GC how to save a copy of the stack. */
2139 extern char *stack_bottom
;
2141 /* Check quit-flag and quit if it is non-nil.
2142 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2143 So the program needs to do QUIT at times when it is safe to quit.
2144 Every loop that might run for a long time or might not exit
2145 ought to do QUIT at least once, at a safe place.
2146 Unless that is impossible, of course.
2147 But it is very desirable to avoid creating loops where QUIT is impossible.
2149 Exception: if you set immediate_quit to nonzero,
2150 then the handler that responds to the C-g does the quit itself.
2151 This is a good thing to do around a loop that has no side effects
2152 and (in particular) cannot call arbitrary Lisp code.
2154 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2155 a request to exit Emacs when it is safe to do. */
2157 extern void process_pending_signals (void);
2158 extern bool volatile pending_signals
;
2160 extern void process_quit_flag (void);
2163 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2164 process_quit_flag (); \
2165 else if (pending_signals) \
2166 process_pending_signals (); \
2170 /* Nonzero if ought to quit now. */
2172 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2174 extern Lisp_Object Vascii_downcase_table
;
2175 extern Lisp_Object Vascii_canon_table
;
2177 /* Structure for recording stack slots that need marking. */
2179 /* This is a chain of structures, each of which points at a Lisp_Object
2180 variable whose value should be marked in garbage collection.
2181 Normally every link of the chain is an automatic variable of a function,
2182 and its `val' points to some argument or local variable of the function.
2183 On exit to the function, the chain is set back to the value it had on entry.
2184 This way, no link remains in the chain when the stack frame containing the
2187 Every function that can call Feval must protect in this fashion all
2188 Lisp_Object variables whose contents will be used again. */
2190 extern struct gcpro
*gcprolist
;
2196 /* Address of first protected variable. */
2197 volatile Lisp_Object
*var
;
2199 /* Number of consecutive protected variables. */
2207 /* Values of GC_MARK_STACK during compilation:
2209 0 Use GCPRO as before
2210 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2211 2 Mark the stack, and check that everything GCPRO'd is
2213 3 Mark using GCPRO's, mark stack last, and count how many
2214 dead objects are kept alive. */
2217 #define GC_USE_GCPROS_AS_BEFORE 0
2218 #define GC_MAKE_GCPROS_NOOPS 1
2219 #define GC_MARK_STACK_CHECK_GCPROS 2
2220 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2222 #ifndef GC_MARK_STACK
2223 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2226 /* Whether we do the stack marking manually. */
2227 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2228 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2231 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2233 /* Do something silly with gcproN vars just so gcc shuts up. */
2234 /* You get warnings from MIPSPro... */
2236 #define GCPRO1(varname) ((void) gcpro1)
2237 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2238 #define GCPRO3(varname1, varname2, varname3) \
2239 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2240 #define GCPRO4(varname1, varname2, varname3, varname4) \
2241 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2242 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2243 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2244 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2245 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2247 #define UNGCPRO ((void) 0)
2249 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2253 #define GCPRO1(varname) \
2254 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2255 gcprolist = &gcpro1; }
2257 #define GCPRO2(varname1, varname2) \
2258 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2259 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2260 gcprolist = &gcpro2; }
2262 #define GCPRO3(varname1, varname2, varname3) \
2263 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2264 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2265 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2266 gcprolist = &gcpro3; }
2268 #define GCPRO4(varname1, varname2, varname3, varname4) \
2269 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2270 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2271 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2272 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2273 gcprolist = &gcpro4; }
2275 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2276 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2277 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2278 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2279 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2280 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2281 gcprolist = &gcpro5; }
2283 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2284 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2285 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2286 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2287 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2288 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2289 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2290 gcprolist = &gcpro6; }
2292 #define UNGCPRO (gcprolist = gcpro1.next)
2296 extern int gcpro_level
;
2298 #define GCPRO1(varname) \
2299 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2300 gcpro1.level = gcpro_level++; \
2301 gcprolist = &gcpro1; }
2303 #define GCPRO2(varname1, varname2) \
2304 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2305 gcpro1.level = gcpro_level; \
2306 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2307 gcpro2.level = gcpro_level++; \
2308 gcprolist = &gcpro2; }
2310 #define GCPRO3(varname1, varname2, varname3) \
2311 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2312 gcpro1.level = gcpro_level; \
2313 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2314 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2315 gcpro3.level = gcpro_level++; \
2316 gcprolist = &gcpro3; }
2318 #define GCPRO4(varname1, varname2, varname3, varname4) \
2319 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2320 gcpro1.level = gcpro_level; \
2321 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2322 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2323 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2324 gcpro4.level = gcpro_level++; \
2325 gcprolist = &gcpro4; }
2327 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2328 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2329 gcpro1.level = gcpro_level; \
2330 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2331 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2332 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2333 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2334 gcpro5.level = gcpro_level++; \
2335 gcprolist = &gcpro5; }
2337 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2338 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2339 gcpro1.level = gcpro_level; \
2340 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2341 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2342 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2343 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2344 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2345 gcpro6.level = gcpro_level++; \
2346 gcprolist = &gcpro6; }
2349 ((--gcpro_level != gcpro1.level) \
2350 ? (emacs_abort (), 0) \
2351 : ((gcprolist = gcpro1.next), 0))
2353 #endif /* DEBUG_GCPRO */
2354 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2357 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2358 #define RETURN_UNGCPRO(expr) \
2361 Lisp_Object ret_ungc_val; \
2362 ret_ungc_val = (expr); \
2364 return ret_ungc_val; \
2368 /* Call staticpro (&var) to protect static variable `var'. */
2370 void staticpro (Lisp_Object
*);
2372 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2373 meaning as in the DEFUN macro, and is used to construct a prototype. */
2374 /* We can use the same trick as in the DEFUN macro to generate the
2375 appropriate prototype. */
2376 #define EXFUN(fnname, maxargs) \
2377 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2379 /* Forward declarations for prototypes. */
2383 /* Simple access functions. */
2385 LISP_INLINE Lisp_Object
*
2386 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
2388 return & XVECTOR (array
)->contents
[idx
];
2392 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
2394 /* Like ASET, but also can be used in the garbage collector:
2395 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2396 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
2397 XVECTOR (array
)->contents
[idx
] = val
;
2400 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2403 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2405 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2406 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2409 /* Functions to modify hash tables. */
2412 set_hash_key_and_value (struct Lisp_Hash_Table
*h
, Lisp_Object key_and_value
)
2414 h
->key_and_value
= key_and_value
;
2418 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2420 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2424 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2426 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2430 set_hash_next (struct Lisp_Hash_Table
*h
, Lisp_Object next
)
2436 set_hash_next_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2438 gc_aset (h
->next
, idx
, val
);
2442 set_hash_hash (struct Lisp_Hash_Table
*h
, Lisp_Object hash
)
2448 set_hash_hash_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2450 gc_aset (h
->hash
, idx
, val
);
2454 set_hash_index (struct Lisp_Hash_Table
*h
, Lisp_Object index
)
2460 set_hash_index_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2462 gc_aset (h
->index
, idx
, val
);
2465 /* Use these functions to set Lisp_Object
2466 or pointer slots of struct Lisp_Symbol. */
2469 set_symbol_name (Lisp_Object sym
, Lisp_Object name
)
2471 XSYMBOL (sym
)->name
= name
;
2475 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2477 XSYMBOL (sym
)->function
= function
;
2481 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2483 XSYMBOL (sym
)->plist
= plist
;
2487 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2489 XSYMBOL (sym
)->next
= next
;
2492 /* Buffer-local (also frame-local) variable access functions. */
2495 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2497 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2502 set_blv_found (struct Lisp_Buffer_Local_Value
*blv
, int found
)
2504 eassert (found
== !EQ (blv
->defcell
, blv
->valcell
));
2508 LISP_INLINE Lisp_Object
2509 blv_value (struct Lisp_Buffer_Local_Value
*blv
)
2511 return XCDR (blv
->valcell
);
2515 set_blv_value (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2517 XSETCDR (blv
->valcell
, val
);
2521 set_blv_where (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2527 set_blv_defcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2533 set_blv_valcell (struct Lisp_Buffer_Local_Value
*blv
, Lisp_Object val
)
2538 /* Set overlay's property list. */
2541 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2543 XOVERLAY (overlay
)->plist
= plist
;
2546 /* Get text properties of S. */
2548 LISP_INLINE INTERVAL
2549 string_intervals (Lisp_Object s
)
2551 return XSTRING (s
)->intervals
;
2554 /* Set text properties of S to I. */
2557 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2559 XSTRING (s
)->intervals
= i
;
2562 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2563 of setting slots directly. */
2566 set_char_table_ascii (Lisp_Object table
, Lisp_Object val
)
2568 XCHAR_TABLE (table
)->ascii
= val
;
2571 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2573 XCHAR_TABLE (table
)->defalt
= val
;
2576 set_char_table_parent (Lisp_Object table
, Lisp_Object val
)
2578 XCHAR_TABLE (table
)->parent
= val
;
2581 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2583 XCHAR_TABLE (table
)->purpose
= val
;
2586 /* Set different slots in (sub)character tables. */
2589 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2591 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2592 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2596 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2598 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2599 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2603 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2605 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2608 /* Defined in data.c. */
2609 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2610 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2611 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2612 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2613 extern Lisp_Object Qinvalid_read_syntax
;
2614 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2615 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2616 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2617 extern Lisp_Object Qtext_read_only
;
2618 extern Lisp_Object Qinteractive_form
;
2619 extern Lisp_Object Qcircular_list
;
2620 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2621 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2622 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2623 extern Lisp_Object Qbuffer_or_string_p
;
2624 extern Lisp_Object Qfboundp
;
2625 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2627 extern Lisp_Object Qcdr
;
2629 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2631 extern Lisp_Object Qfloatp
;
2632 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2634 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2636 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2638 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2640 /* Defined in data.c. */
2641 extern Lisp_Object
indirect_function (Lisp_Object
);
2642 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2644 /* Convert the integer I to an Emacs representation, either the integer
2645 itself, or a cons of two or three integers, or if all else fails a float.
2646 I should not have side effects. */
2647 #define INTEGER_TO_CONS(i) \
2648 (! FIXNUM_OVERFLOW_P (i) \
2650 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2651 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2652 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2653 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2654 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2655 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2656 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2657 ? Fcons (make_number ((i) >> 16 >> 24), \
2658 Fcons (make_number ((i) >> 16 & 0xffffff), \
2659 make_number ((i) & 0xffff))) \
2662 /* Convert the Emacs representation CONS back to an integer of type
2663 TYPE, storing the result the variable VAR. Signal an error if CONS
2664 is not a valid representation or is out of range for TYPE. */
2665 #define CONS_TO_INTEGER(cons, type, var) \
2666 (TYPE_SIGNED (type) \
2667 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2668 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2669 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2670 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2672 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2673 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2674 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2676 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2677 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2678 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2679 extern void syms_of_data (void);
2680 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2682 /* Defined in cmds.c */
2683 extern void syms_of_cmds (void);
2684 extern void keys_of_cmds (void);
2686 /* Defined in coding.c. */
2687 extern Lisp_Object Qcharset
;
2688 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2689 ptrdiff_t, bool, bool, Lisp_Object
);
2690 extern void init_coding (void);
2691 extern void init_coding_once (void);
2692 extern void syms_of_coding (void);
2694 /* Defined in character.c. */
2695 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2696 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2697 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2698 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2699 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2700 extern void syms_of_character (void);
2702 /* Defined in charset.c. */
2703 extern void init_charset (void);
2704 extern void init_charset_once (void);
2705 extern void syms_of_charset (void);
2706 /* Structure forward declarations. */
2709 /* Defined in composite.c. */
2710 extern void syms_of_composite (void);
2712 /* Defined in syntax.c. */
2713 extern void init_syntax_once (void);
2714 extern void syms_of_syntax (void);
2716 /* Defined in fns.c. */
2717 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2718 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2719 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2720 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2721 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2722 extern void sweep_weak_hash_tables (void);
2723 extern Lisp_Object Qcursor_in_echo_area
;
2724 extern Lisp_Object Qstring_lessp
;
2725 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2726 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2727 EMACS_UINT
sxhash (Lisp_Object
, int);
2728 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2729 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2731 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2732 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2735 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2736 ptrdiff_t, ptrdiff_t);
2737 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2738 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2739 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2740 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2741 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2742 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2743 extern void clear_string_char_byte_cache (void);
2744 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2745 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2746 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2747 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2748 extern void syms_of_fns (void);
2750 /* Defined in floatfns.c. */
2751 extern double extract_float (Lisp_Object
);
2752 extern void syms_of_floatfns (void);
2753 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2755 /* Defined in fringe.c. */
2756 extern void syms_of_fringe (void);
2757 extern void init_fringe (void);
2758 #ifdef HAVE_WINDOW_SYSTEM
2759 extern void mark_fringe_data (void);
2760 extern void init_fringe_once (void);
2761 #endif /* HAVE_WINDOW_SYSTEM */
2763 /* Defined in image.c. */
2764 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2765 extern Lisp_Object QCconversion
;
2766 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2767 extern void reset_image_types (void);
2768 extern void syms_of_image (void);
2770 /* Defined in insdel.c. */
2771 extern Lisp_Object Qinhibit_modification_hooks
;
2772 extern void move_gap (ptrdiff_t);
2773 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2774 extern _Noreturn
void buffer_overflow (void);
2775 extern void make_gap (ptrdiff_t);
2776 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2777 ptrdiff_t, bool, bool);
2778 extern int count_combining_before (const unsigned char *,
2779 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2780 extern int count_combining_after (const unsigned char *,
2781 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2782 extern void insert (const char *, ptrdiff_t);
2783 extern void insert_and_inherit (const char *, ptrdiff_t);
2784 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2785 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2787 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2788 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2789 ptrdiff_t, ptrdiff_t, bool);
2790 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2791 extern void insert_char (int);
2792 extern void insert_string (const char *);
2793 extern void insert_before_markers (const char *, ptrdiff_t);
2794 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2795 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2796 ptrdiff_t, ptrdiff_t,
2798 extern void del_range (ptrdiff_t, ptrdiff_t);
2799 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2800 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2801 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2802 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2803 ptrdiff_t, ptrdiff_t, bool);
2804 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
2805 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2806 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2807 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2808 ptrdiff_t, ptrdiff_t);
2809 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2810 ptrdiff_t, ptrdiff_t);
2811 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
2812 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2813 const char *, ptrdiff_t, ptrdiff_t, bool);
2814 extern void syms_of_insdel (void);
2816 /* Defined in dispnew.c. */
2817 #if (defined PROFILING \
2818 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2819 _Noreturn
void __executable_start (void);
2821 extern Lisp_Object selected_frame
;
2822 extern Lisp_Object Vwindow_system
;
2823 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
2824 extern void init_display (void);
2825 extern void syms_of_display (void);
2827 /* Defined in xdisp.c. */
2828 extern Lisp_Object Qinhibit_point_motion_hooks
;
2829 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2830 extern Lisp_Object Qmenu_bar_update_hook
;
2831 extern Lisp_Object Qwindow_scroll_functions
;
2832 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2833 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2834 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2835 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2836 extern Lisp_Object Qleft_margin
, Qright_margin
;
2837 extern Lisp_Object Qglyphless_char
;
2838 extern Lisp_Object QCdata
, QCfile
;
2839 extern Lisp_Object QCmap
;
2840 extern Lisp_Object Qrisky_local_variable
;
2841 extern struct frame
*last_glyphless_glyph_frame
;
2842 extern int last_glyphless_glyph_face_id
;
2843 extern int last_glyphless_glyph_merged_face_id
;
2844 extern int noninteractive_need_newline
;
2845 extern Lisp_Object echo_area_buffer
[2];
2846 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2847 extern void check_message_stack (void);
2848 extern void setup_echo_area_for_printing (int);
2849 extern bool push_message (void);
2850 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2851 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2852 extern void restore_message (void);
2853 extern Lisp_Object
current_message (void);
2854 extern void clear_message (int, int);
2855 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2856 extern void message1 (const char *);
2857 extern void message1_nolog (const char *);
2858 extern void message2 (const char *, ptrdiff_t, int);
2859 extern void message2_nolog (const char *, ptrdiff_t, int);
2860 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2861 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2862 extern void message_dolog (const char *, ptrdiff_t, int, int);
2863 extern void message_with_string (const char *, Lisp_Object
, int);
2864 extern void message_log_maybe_newline (void);
2865 extern void update_echo_area (void);
2866 extern void truncate_echo_area (ptrdiff_t);
2867 extern void redisplay (void);
2868 extern void redisplay_preserve_echo_area (int);
2869 extern void prepare_menu_bars (void);
2871 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2872 extern void syms_of_xdisp (void);
2873 extern void init_xdisp (void);
2874 extern Lisp_Object
safe_eval (Lisp_Object
);
2875 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2876 int *, int *, int *, int *, int *);
2878 /* Defined in xsettings.c. */
2879 extern void syms_of_xsettings (void);
2881 /* Defined in vm-limit.c. */
2882 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2884 /* Defined in alloc.c. */
2885 extern void check_pure_size (void);
2886 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2887 extern void malloc_warning (const char *);
2888 extern _Noreturn
void memory_full (size_t);
2889 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2890 extern bool survives_gc_p (Lisp_Object
);
2891 extern void mark_object (Lisp_Object
);
2892 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2893 extern void refill_memory_reserve (void);
2895 extern const char *pending_malloc_warning
;
2896 extern Lisp_Object zero_vector
;
2897 extern Lisp_Object
*stack_base
;
2898 extern EMACS_INT consing_since_gc
;
2899 extern EMACS_INT gc_relative_threshold
;
2900 extern EMACS_INT memory_full_cons_threshold
;
2901 extern Lisp_Object
list1 (Lisp_Object
);
2902 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2903 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2904 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2905 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2907 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2908 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2909 extern _Noreturn
void string_overflow (void);
2910 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2911 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2912 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2913 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2915 /* Make unibyte string from C string when the length isn't known. */
2917 LISP_INLINE Lisp_Object
2918 build_unibyte_string (const char *str
)
2920 return make_unibyte_string (str
, strlen (str
));
2923 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2924 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2925 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2926 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2927 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2928 extern Lisp_Object
make_specified_string (const char *,
2929 ptrdiff_t, ptrdiff_t, bool);
2930 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2931 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2933 /* Make a string allocated in pure space, use STR as string data. */
2935 LISP_INLINE Lisp_Object
2936 build_pure_c_string (const char *str
)
2938 return make_pure_c_string (str
, strlen (str
));
2941 /* Make a string from the data at STR, treating it as multibyte if the
2944 LISP_INLINE Lisp_Object
2945 build_string (const char *str
)
2947 return make_string (str
, strlen (str
));
2950 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2951 extern void make_byte_code (struct Lisp_Vector
*);
2952 extern Lisp_Object Qautomatic_gc
;
2953 extern Lisp_Object Qchar_table_extra_slots
;
2954 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2955 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2956 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2958 allocate_pseudovector \
2959 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2960 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2961 extern struct window
*allocate_window (void);
2962 extern struct frame
*allocate_frame (void);
2963 extern struct Lisp_Process
*allocate_process (void);
2964 extern struct terminal
*allocate_terminal (void);
2965 extern bool gc_in_progress
;
2966 extern bool abort_on_gc
;
2967 extern Lisp_Object
make_float (double);
2968 extern void display_malloc_warning (void);
2969 extern ptrdiff_t inhibit_garbage_collection (void);
2970 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2971 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2972 extern void free_marker (Lisp_Object
);
2973 extern void free_cons (struct Lisp_Cons
*);
2974 extern void init_alloc_once (void);
2975 extern void init_alloc (void);
2976 extern void syms_of_alloc (void);
2977 extern struct buffer
* allocate_buffer (void);
2978 extern int valid_lisp_object_p (Lisp_Object
);
2979 #ifdef GC_CHECK_CONS_LIST
2980 extern void check_cons_list (void);
2982 #define check_cons_list() ((void) 0)
2986 /* Defined in ralloc.c. */
2987 extern void *r_alloc (void **, size_t);
2988 extern void r_alloc_free (void **);
2989 extern void *r_re_alloc (void **, size_t);
2990 extern void r_alloc_reset_variable (void **, void **);
2991 extern void r_alloc_inhibit_buffer_relocation (int);
2994 /* Defined in chartab.c. */
2995 extern Lisp_Object
copy_char_table (Lisp_Object
);
2996 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2997 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2999 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3000 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3001 extern int char_table_translate (Lisp_Object
, int);
3002 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3004 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3005 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3006 Lisp_Object
, Lisp_Object
,
3007 Lisp_Object
, struct charset
*,
3008 unsigned, unsigned);
3009 extern Lisp_Object
uniprop_table (Lisp_Object
);
3010 extern void syms_of_chartab (void);
3012 /* Defined in print.c. */
3013 extern Lisp_Object Vprin1_to_string_buffer
;
3014 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3015 extern Lisp_Object Qstandard_output
;
3016 extern Lisp_Object Qexternal_debugging_output
;
3017 extern void temp_output_buffer_setup (const char *);
3018 extern int print_level
;
3019 extern Lisp_Object Qprint_escape_newlines
;
3020 extern void write_string (const char *, int);
3021 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3023 extern Lisp_Object internal_with_output_to_temp_buffer
3024 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3025 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3026 extern int float_to_string (char *, double);
3027 extern void syms_of_print (void);
3029 /* Defined in doprnt.c. */
3030 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3032 extern ptrdiff_t esprintf (char *, char const *, ...)
3033 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3034 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3036 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3037 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3038 char const *, va_list)
3039 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3041 /* Defined in lread.c. */
3042 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3043 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3044 extern Lisp_Object Qlexical_binding
;
3045 extern Lisp_Object
check_obarray (Lisp_Object
);
3046 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3047 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3048 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3049 #define LOADHIST_ATTACH(x) \
3051 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3053 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3054 Lisp_Object
*, Lisp_Object
);
3055 extern Lisp_Object
string_to_number (char const *, int, bool);
3056 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3058 extern void dir_warning (const char *, Lisp_Object
);
3059 extern void close_load_descs (void);
3060 extern void init_obarray (void);
3061 extern void init_lread (void);
3062 extern void syms_of_lread (void);
3064 LISP_INLINE Lisp_Object
3065 intern (const char *str
)
3067 return intern_1 (str
, strlen (str
));
3070 LISP_INLINE Lisp_Object
3071 intern_c_string (const char *str
)
3073 return intern_c_string_1 (str
, strlen (str
));
3076 /* Defined in eval.c. */
3077 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3078 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3079 extern Lisp_Object Qand_rest
;
3080 extern Lisp_Object Vautoload_queue
;
3081 extern Lisp_Object Vsignaling_function
;
3082 extern Lisp_Object inhibit_lisp_code
;
3084 extern struct catchtag
*catchlist
;
3085 extern struct handler
*handlerlist
;
3087 /* To run a normal hook, use the appropriate function from the list below.
3088 The calling convention:
3090 if (!NILP (Vrun_hooks))
3091 call1 (Vrun_hooks, Qmy_funny_hook);
3093 should no longer be used. */
3094 extern Lisp_Object Vrun_hooks
;
3095 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3096 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3097 Lisp_Object (*funcall
)
3098 (ptrdiff_t nargs
, Lisp_Object
*args
));
3099 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3100 extern _Noreturn
void xsignal0 (Lisp_Object
);
3101 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3102 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3103 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3105 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3106 extern Lisp_Object
eval_sub (Lisp_Object form
);
3107 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3108 extern Lisp_Object
call0 (Lisp_Object
);
3109 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3110 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3111 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3112 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3113 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3114 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3115 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3116 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3117 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3118 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3119 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3120 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3121 extern Lisp_Object internal_condition_case_n
3122 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3123 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3124 extern void specbind (Lisp_Object
, Lisp_Object
);
3125 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3126 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3127 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3128 extern _Noreturn
void verror (const char *, va_list)
3129 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3130 extern Lisp_Object
un_autoload (Lisp_Object
);
3131 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3132 extern void init_eval_once (void);
3133 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3134 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3135 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3136 extern void init_eval (void);
3138 extern void mark_backtrace (void);
3140 extern void syms_of_eval (void);
3142 /* Defined in editfns.c. */
3143 extern Lisp_Object Qfield
;
3144 extern void insert1 (Lisp_Object
);
3145 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3146 extern Lisp_Object
save_excursion_save (void);
3147 extern Lisp_Object
save_restriction_save (void);
3148 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3149 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3150 extern _Noreturn
void time_overflow (void);
3151 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3152 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3154 extern void init_editfns (void);
3155 extern void syms_of_editfns (void);
3156 extern void set_time_zone_rule (const char *);
3158 /* Defined in buffer.c. */
3159 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3160 extern _Noreturn
void nsberror (Lisp_Object
);
3161 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3162 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3163 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3164 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3165 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3166 extern bool overlay_touches_p (ptrdiff_t);
3167 extern Lisp_Object Vbuffer_alist
;
3168 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3169 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3170 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3171 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3172 extern void init_buffer_once (void);
3173 extern void init_buffer (void);
3174 extern void syms_of_buffer (void);
3175 extern void keys_of_buffer (void);
3177 /* Defined in marker.c. */
3179 extern ptrdiff_t marker_position (Lisp_Object
);
3180 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3181 extern void clear_charpos_cache (struct buffer
*);
3182 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3183 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3184 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3185 extern void unchain_marker (struct Lisp_Marker
*marker
);
3186 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3187 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3188 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3189 ptrdiff_t, ptrdiff_t);
3190 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3191 extern void syms_of_marker (void);
3193 /* Defined in fileio.c. */
3195 extern Lisp_Object Qfile_error
;
3196 extern Lisp_Object Qfile_exists_p
;
3197 extern Lisp_Object Qfile_directory_p
;
3198 extern Lisp_Object Qinsert_file_contents
;
3199 extern Lisp_Object Qfile_name_history
;
3200 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3201 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3202 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3203 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3204 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3205 extern void internal_delete_file (Lisp_Object
);
3206 extern void syms_of_fileio (void);
3207 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3208 extern Lisp_Object Qdelete_file
;
3209 extern bool check_existing (const char *);
3211 /* Defined in search.c. */
3212 extern void shrink_regexp_cache (void);
3213 extern void restore_search_regs (void);
3214 extern void record_unwind_save_match_data (void);
3215 struct re_registers
;
3216 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3217 struct re_registers
*,
3218 Lisp_Object
, int, int);
3219 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3220 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3222 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3223 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3224 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3225 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3227 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3229 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3230 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3231 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3232 extern void syms_of_search (void);
3233 extern void clear_regexp_cache (void);
3235 /* Defined in minibuf.c. */
3237 extern Lisp_Object Qcompletion_ignore_case
;
3238 extern Lisp_Object Vminibuffer_list
;
3239 extern Lisp_Object last_minibuf_string
;
3240 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3241 extern void init_minibuf_once (void);
3242 extern void syms_of_minibuf (void);
3244 /* Defined in callint.c. */
3246 extern Lisp_Object Qminus
, Qplus
;
3247 extern Lisp_Object Qwhen
;
3248 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
3249 extern void syms_of_callint (void);
3251 /* Defined in casefiddle.c. */
3253 extern Lisp_Object Qidentity
;
3254 extern void syms_of_casefiddle (void);
3255 extern void keys_of_casefiddle (void);
3257 /* Defined in casetab.c. */
3259 extern void init_casetab_once (void);
3260 extern void syms_of_casetab (void);
3262 /* Defined in keyboard.c. */
3264 extern Lisp_Object echo_message_buffer
;
3265 extern struct kboard
*echo_kboard
;
3266 extern void cancel_echoing (void);
3267 extern Lisp_Object Qdisabled
, QCfilter
;
3268 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3269 extern Lisp_Object Qtop
;
3270 extern Lisp_Object last_undo_boundary
;
3271 extern bool input_pending
;
3272 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3273 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3274 extern void discard_mouse_events (void);
3276 void handle_input_available_signal (int);
3278 extern Lisp_Object pending_funcalls
;
3279 extern bool detect_input_pending (void);
3280 extern bool detect_input_pending_ignore_squeezables (void);
3281 extern bool detect_input_pending_run_timers (bool);
3282 extern void safe_run_hooks (Lisp_Object
);
3283 extern void cmd_error_internal (Lisp_Object
, const char *);
3284 extern Lisp_Object
command_loop_1 (void);
3285 extern Lisp_Object
recursive_edit_1 (void);
3286 extern void record_auto_save (void);
3287 extern void force_auto_save_soon (void);
3288 extern void init_keyboard (void);
3289 extern void syms_of_keyboard (void);
3290 extern void keys_of_keyboard (void);
3292 /* Defined in indent.c. */
3293 extern ptrdiff_t current_column (void);
3294 extern void invalidate_current_column (void);
3295 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3296 extern void syms_of_indent (void);
3298 /* Defined in frame.c. */
3299 extern Lisp_Object Qonly
, Qnone
;
3300 extern Lisp_Object Qvisible
;
3301 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3302 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3303 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3305 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3307 extern void frames_discard_buffer (Lisp_Object
);
3308 extern void syms_of_frame (void);
3310 /* Defined in emacs.c. */
3311 extern char **initial_argv
;
3312 extern int initial_argc
;
3313 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3314 extern bool display_arg
;
3316 extern Lisp_Object
decode_env_path (const char *, const char *);
3317 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3318 extern Lisp_Object Qfile_name_handler_alist
;
3319 extern _Noreturn
void terminate_due_to_signal (int, int);
3320 extern Lisp_Object Qkill_emacs
;
3322 extern Lisp_Object Vlibrary_cache
;
3325 void fixup_locale (void);
3326 void synchronize_system_messages_locale (void);
3327 void synchronize_system_time_locale (void);
3329 #define setlocale(category, locale)
3330 #define fixup_locale()
3331 #define synchronize_system_messages_locale()
3332 #define synchronize_system_time_locale()
3334 extern void shut_down_emacs (int, Lisp_Object
);
3336 /* True means don't do interactive redisplay and don't change tty modes. */
3337 extern bool noninteractive
;
3339 /* True means remove site-lisp directories from load-path. */
3340 extern bool no_site_lisp
;
3342 /* Pipe used to send exit notification to the daemon parent at
3344 extern int daemon_pipe
[2];
3345 #define IS_DAEMON (daemon_pipe[1] != 0)
3347 /* True if handling a fatal error already. */
3348 extern bool fatal_error_in_progress
;
3350 /* True means don't do use window-system-specific display code. */
3351 extern bool inhibit_window_system
;
3352 /* True means that a filter or a sentinel is running. */
3353 extern bool running_asynch_code
;
3355 /* Defined in process.c. */
3356 extern Lisp_Object QCtype
, Qlocal
;
3357 extern Lisp_Object Qprocessp
;
3358 extern void kill_buffer_processes (Lisp_Object
);
3359 extern int wait_reading_process_output (intmax_t, int, int, bool,
3361 struct Lisp_Process
*,
3363 /* Max value for the first argument of wait_reading_process_output. */
3364 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3365 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3366 The bug merely causes a bogus warning, but the warning is annoying. */
3367 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3369 # define WAIT_READING_MAX INTMAX_MAX
3371 extern void add_keyboard_wait_descriptor (int);
3372 extern void delete_keyboard_wait_descriptor (int);
3374 extern void add_gpm_wait_descriptor (int);
3375 extern void delete_gpm_wait_descriptor (int);
3377 extern void close_process_descs (void);
3378 extern void init_process_emacs (void);
3379 extern void syms_of_process (void);
3380 extern void setup_process_coding_systems (Lisp_Object
);
3385 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3386 extern void init_callproc_1 (void);
3387 extern void init_callproc (void);
3388 extern void set_initial_environment (void);
3389 extern void syms_of_callproc (void);
3391 /* Defined in doc.c. */
3392 extern Lisp_Object Qfunction_documentation
;
3393 extern Lisp_Object
read_doc_string (Lisp_Object
);
3394 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3395 extern void syms_of_doc (void);
3396 extern int read_bytecode_char (bool);
3398 /* Defined in bytecode.c. */
3399 extern Lisp_Object Qbytecode
;
3400 extern void syms_of_bytecode (void);
3401 extern struct byte_stack
*byte_stack_list
;
3403 extern void mark_byte_stack (void);
3405 extern void unmark_byte_stack (void);
3406 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3407 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3409 /* Defined in macros.c. */
3410 extern Lisp_Object Qexecute_kbd_macro
;
3411 extern void init_macros (void);
3412 extern void syms_of_macros (void);
3414 /* Defined in undo.c. */
3415 extern Lisp_Object Qapply
;
3416 extern Lisp_Object Qinhibit_read_only
;
3417 extern void truncate_undo_list (struct buffer
*);
3418 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3419 extern void record_insert (ptrdiff_t, ptrdiff_t);
3420 extern void record_delete (ptrdiff_t, Lisp_Object
);
3421 extern void record_first_change (void);
3422 extern void record_change (ptrdiff_t, ptrdiff_t);
3423 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3424 Lisp_Object
, Lisp_Object
,
3426 extern void syms_of_undo (void);
3427 /* Defined in textprop.c. */
3428 extern Lisp_Object Qfont
, Qmouse_face
;
3429 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3430 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3431 extern Lisp_Object Qminibuffer_prompt
;
3433 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3435 /* Defined in menu.c. */
3436 extern void syms_of_menu (void);
3438 /* Defined in xmenu.c. */
3439 extern void syms_of_xmenu (void);
3441 /* Defined in termchar.h. */
3442 struct tty_display_info
;
3444 /* Defined in termhooks.h. */
3447 /* Defined in sysdep.c. */
3448 #ifndef HAVE_GET_CURRENT_DIR_NAME
3449 extern char *get_current_dir_name (void);
3451 extern void stuff_char (char c
);
3452 extern void init_foreground_group (void);
3453 extern void init_sigio (int);
3454 extern void sys_subshell (void);
3455 extern void sys_suspend (void);
3456 extern void discard_tty_input (void);
3457 extern void init_sys_modes (struct tty_display_info
*);
3458 extern void reset_sys_modes (struct tty_display_info
*);
3459 extern void init_all_sys_modes (void);
3460 extern void reset_all_sys_modes (void);
3461 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3462 extern void child_setup_tty (int);
3463 extern void setup_pty (int);
3464 extern int set_window_size (int, int, int);
3465 extern EMACS_INT
get_random (void);
3466 extern void seed_random (void *, ptrdiff_t);
3467 extern void init_random (void);
3468 extern void emacs_backtrace (int);
3469 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3470 extern int emacs_open (const char *, int, int);
3471 extern int emacs_close (int);
3472 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3473 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3474 enum { READLINK_BUFSIZE
= 1024 };
3475 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3477 extern void unlock_all_files (void);
3478 extern void lock_file (Lisp_Object
);
3479 extern void unlock_file (Lisp_Object
);
3480 extern void unlock_buffer (struct buffer
*);
3481 extern void syms_of_filelock (void);
3483 /* Defined in sound.c. */
3484 extern void syms_of_sound (void);
3486 /* Defined in category.c. */
3487 extern void init_category_once (void);
3488 extern Lisp_Object
char_category_set (int);
3489 extern void syms_of_category (void);
3491 /* Defined in ccl.c. */
3492 extern void syms_of_ccl (void);
3494 /* Defined in dired.c. */
3495 extern void syms_of_dired (void);
3496 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3497 Lisp_Object
, Lisp_Object
,
3500 /* Defined in term.c. */
3501 extern int *char_ins_del_vector
;
3502 extern void syms_of_term (void);
3503 extern _Noreturn
void fatal (const char *msgid
, ...)
3504 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3506 /* Defined in terminal.c. */
3507 extern void syms_of_terminal (void);
3509 /* Defined in font.c. */
3510 extern void syms_of_font (void);
3511 extern void init_font (void);
3513 #ifdef HAVE_WINDOW_SYSTEM
3514 /* Defined in fontset.c. */
3515 extern void syms_of_fontset (void);
3517 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3518 extern Lisp_Object Qfont_param
;
3521 /* Defined in xfaces.c. */
3522 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3523 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3524 extern Lisp_Object Qmode_line_inactive
;
3525 extern Lisp_Object Qface
;
3526 extern Lisp_Object Qnormal
;
3527 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3528 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3529 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3530 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3531 extern Lisp_Object Qoblique
, Qitalic
;
3532 extern Lisp_Object Vface_alternative_font_family_alist
;
3533 extern Lisp_Object Vface_alternative_font_registry_alist
;
3534 extern void syms_of_xfaces (void);
3536 #ifdef HAVE_X_WINDOWS
3537 /* Defined in xfns.c. */
3538 extern void syms_of_xfns (void);
3540 /* Defined in xsmfns.c. */
3541 extern void syms_of_xsmfns (void);
3543 /* Defined in xselect.c. */
3544 extern void syms_of_xselect (void);
3546 /* Defined in xterm.c. */
3547 extern void syms_of_xterm (void);
3548 #endif /* HAVE_X_WINDOWS */
3550 #ifdef HAVE_WINDOW_SYSTEM
3551 /* Defined in xterm.c, nsterm.m, w32term.c. */
3552 extern char *x_get_keysym_name (int);
3553 #endif /* HAVE_WINDOW_SYSTEM */
3556 /* Defined in xml.c. */
3557 extern void syms_of_xml (void);
3558 extern void xml_cleanup_parser (void);
3562 /* Defined in (x|w32)fns.c, nsfns.m... */
3563 extern int have_menus_p (void);
3567 /* Defined in dbusbind.c. */
3568 void syms_of_dbusbind (void);
3572 /* Defined in profiler.c. */
3573 extern bool profiler_memory_running
;
3574 extern void malloc_probe (size_t);
3575 extern void syms_of_profiler (void);
3579 /* Defined in msdos.c, w32.c. */
3580 extern char *emacs_root_dir (void);
3583 /* True means Emacs has already been initialized.
3584 Used during startup to detect startup of dumped Emacs. */
3585 extern bool initialized
;
3587 /* True means ^G can quit instantly. */
3588 extern bool immediate_quit
;
3590 extern void *xmalloc (size_t);
3591 extern void *xzalloc (size_t);
3592 extern void *xrealloc (void *, size_t);
3593 extern void xfree (void *);
3594 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3595 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3596 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3598 extern char *xstrdup (const char *);
3600 extern char *egetenv (const char *);
3602 /* Set up the name of the machine we're running on. */
3603 extern void init_system_name (void);
3605 /* We used to use `abs', but that clashes with system headers on some
3606 platforms, and using a name reserved by Standard C is a bad idea
3609 #define eabs(x) ((x) < 0 ? -(x) : (x))
3612 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3615 #define make_fixnum_or_float(val) \
3616 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3618 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3619 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3621 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3623 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3624 extern void *record_xmalloc (size_t);
3626 #define USE_SAFE_ALLOCA \
3627 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3629 /* SAFE_ALLOCA allocates a simple buffer. */
3631 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3633 : (sa_must_free = 1, record_xmalloc (size)))
3635 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3636 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3637 positive. The code is tuned for MULTIPLIER being a constant. */
3639 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3641 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3642 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3645 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3647 record_unwind_protect (safe_alloca_unwind, \
3648 make_save_value (buf, 0)); \
3652 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3654 #define SAFE_FREE() \
3656 if (sa_must_free) { \
3658 unbind_to (sa_count, Qnil); \
3663 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3665 #define SAFE_ALLOCA_LISP(buf, nelt) \
3667 if ((nelt) < MAX_ALLOCA / word_size) \
3668 buf = alloca ((nelt) * word_size); \
3669 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3672 buf = xmalloc ((nelt) * word_size); \
3673 arg_ = make_save_value (buf, nelt); \
3674 XSAVE_VALUE (arg_)->dogc = 1; \
3676 record_unwind_protect (safe_alloca_unwind, arg_); \
3679 memory_full (SIZE_MAX); \
3683 #include "globals.h"
3685 /* Check whether it's time for GC, and run it if so. */
3690 if ((consing_since_gc
> gc_cons_threshold
3691 && consing_since_gc
> gc_relative_threshold
)
3692 || (!NILP (Vmemory_full
)
3693 && consing_since_gc
> memory_full_cons_threshold
))
3694 Fgarbage_collect ();
3698 functionp (Lisp_Object object
)
3700 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3702 object
= Findirect_function (object
, Qt
);
3704 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3706 /* Autoloaded symbols are functions, except if they load
3707 macros or keymaps. */
3709 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3710 object
= XCDR (object
);
3712 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3717 return XSUBR (object
)->max_args
!= UNEVALLED
;
3718 else if (COMPILEDP (object
))
3720 else if (CONSP (object
))
3722 Lisp_Object car
= XCAR (object
);
3723 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3731 #endif /* EMACS_LISP_H */