* lisp/textmodes/table.el (table-insert): Don't use `symbol-name' on
[emacs.git] / src / lisp.h
blob3ec188b67c7d6dd554c4e026b952968ff8de4186
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/>. */
20 #ifndef EMACS_LISP_H
21 #define EMACS_LISP_H
23 #include <setjmp.h>
24 #include <stdalign.h>
25 #include <stdarg.h>
26 #include <stdbool.h>
27 #include <stddef.h>
28 #include <float.h>
29 #include <inttypes.h>
30 #include <limits.h>
32 #include <intprops.h>
34 INLINE_HEADER_BEGIN
35 #ifndef LISP_INLINE
36 # define LISP_INLINE INLINE
37 #endif
39 /* The ubiquitous max and min macros. */
40 #undef min
41 #undef max
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 */
49 #ifndef EMACS_INT_MAX
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
54 # define pI "ll"
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
59 # define pI "l"
60 # else
61 typedef int EMACS_INT;
62 typedef unsigned int EMACS_UINT;
63 # define EMACS_INT_MAX INT_MAX
64 # define pI ""
65 # endif
66 #endif
68 /* Number of bits in some machine integer types. */
69 enum
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. */
83 #ifdef PRIdMAX
84 typedef intmax_t printmax_t;
85 typedef uintmax_t uprintmax_t;
86 # define pMd PRIdMAX
87 # define pMu PRIuMAX
88 #else
89 typedef EMACS_INT printmax_t;
90 typedef EMACS_UINT uprintmax_t;
91 # define pMd pI"d"
92 # define pMu pI"u"
93 #endif
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
101 # define pD ""
102 #elif PTRDIFF_MAX == LONG_MAX
103 # define pD "l"
104 #elif PTRDIFF_MAX == LLONG_MAX
105 # define pD "ll"
106 #else
107 # define pD "t"
108 #endif
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 \
133 ? (void) 0 \
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. */
155 enum Lisp_Bits
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. */
159 GCTYPEBITS =
160 #define GCTYPEBITS 3
161 GCTYPEBITS,
163 /* 2**GCTYPEBITS. This must also be a macro that expands to a
164 literal integer constant, for MSVC. */
165 GCALIGNMENT =
166 #define GCALIGNMENT 8
167 GCALIGNMENT,
169 /* Number of bits in a Lisp_Object value, not counting the tag. */
170 VALBITS = BITS_PER_EMACS_INT - GCTYPEBITS,
172 /* Number of bits in a Lisp fixnum tag. */
173 INTTYPEBITS = GCTYPEBITS - 1,
175 /* Number of bits in a Lisp fixnum value, not counting the tag. */
176 FIXNUM_BITS = VALBITS + 1
179 #if GCALIGNMENT != 1 << GCTYPEBITS
180 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
181 #endif
183 /* The maximum value that can be stored in a EMACS_INT, assuming all
184 bits other than the type bits contribute to a nonnegative signed value.
185 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
186 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
188 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
189 #ifndef USE_LSB_TAG
190 /* 1. We know malloc returns a multiple of 8. */
191 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
192 || defined DARWIN_OS || defined __sun)
193 /* 2. We can specify multiple-of-8 alignment on static variables. */
194 # ifdef alignas
195 /* 3. Pointers-as-ints exceed VAL_MAX.
196 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
197 a. unnecessary, because the top bits of an EMACS_INT are unused, and
198 b. slower, because it typically requires extra masking.
199 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
200 # if VAL_MAX < UINTPTR_MAX
201 # define USE_LSB_TAG 1
202 # endif
203 # endif
204 # endif
205 #endif
206 #ifdef USE_LSB_TAG
207 # undef USE_LSB_TAG
208 enum enum_USE_LSB_TAG { USE_LSB_TAG = 1 };
209 # define USE_LSB_TAG 1
210 #else
211 enum enum_USE_LSB_TAG { USE_LSB_TAG = 0 };
212 # define USE_LSB_TAG 0
213 #endif
215 #ifndef alignas
216 # define alignas(alignment) /* empty */
217 # if USE_LSB_TAG
218 # error "USE_LSB_TAG requires alignas"
219 # endif
220 #endif
223 /* Define the fundamental Lisp data structures. */
225 /* This is the set of Lisp data types. If you want to define a new
226 data type, read the comments after Lisp_Fwd_Type definition
227 below. */
229 /* Lisp integers use 2 tags, to give them one extra bit, thus
230 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
231 static EMACS_INT const INTMASK = EMACS_INT_MAX >> (INTTYPEBITS - 1);
232 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
233 #define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
235 /* Stolen from GDB. The only known compiler that doesn't support
236 enums in bitfields is MSVC. */
237 #ifdef _MSC_VER
238 #define ENUM_BF(TYPE) unsigned int
239 #else
240 #define ENUM_BF(TYPE) enum TYPE
241 #endif
244 enum Lisp_Type
246 /* Integer. XINT (obj) is the integer value. */
247 Lisp_Int0 = 0,
248 Lisp_Int1 = USE_LSB_TAG ? 1 << INTTYPEBITS : 1,
250 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
251 Lisp_Symbol = 2,
253 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
254 whose first member indicates the subtype. */
255 Lisp_Misc = 3,
257 /* String. XSTRING (object) points to a struct Lisp_String.
258 The length of the string, and its contents, are stored therein. */
259 Lisp_String = USE_LSB_TAG ? 1 : 1 << INTTYPEBITS,
261 /* Vector of Lisp objects, or something resembling it.
262 XVECTOR (object) points to a struct Lisp_Vector, which contains
263 the size and contents. The size field also contains the type
264 information, if it's not a real vector object. */
265 Lisp_Vectorlike = 5,
267 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
268 Lisp_Cons = 6,
270 Lisp_Float = 7,
273 /* This is the set of data types that share a common structure.
274 The first member of the structure is a type code from this set.
275 The enum values are arbitrary, but we'll use large numbers to make it
276 more likely that we'll spot the error if a random word in memory is
277 mistakenly interpreted as a Lisp_Misc. */
278 enum Lisp_Misc_Type
280 Lisp_Misc_Free = 0x5eab,
281 Lisp_Misc_Marker,
282 Lisp_Misc_Overlay,
283 Lisp_Misc_Save_Value,
284 /* Currently floats are not a misc type,
285 but let's define this in case we want to change that. */
286 Lisp_Misc_Float,
287 /* This is not a type code. It is for range checking. */
288 Lisp_Misc_Limit
291 /* These are the types of forwarding objects used in the value slot
292 of symbols for special built-in variables whose value is stored in
293 C variables. */
294 enum Lisp_Fwd_Type
296 Lisp_Fwd_Int, /* Fwd to a C `int' variable. */
297 Lisp_Fwd_Bool, /* Fwd to a C boolean var. */
298 Lisp_Fwd_Obj, /* Fwd to a C Lisp_Object variable. */
299 Lisp_Fwd_Buffer_Obj, /* Fwd to a Lisp_Object field of buffers. */
300 Lisp_Fwd_Kboard_Obj, /* Fwd to a Lisp_Object field of kboards. */
303 /* If you want to define a new Lisp data type, here are some
304 instructions. See the thread at
305 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
306 for more info.
308 First, there are already a couple of Lisp types that can be used if
309 your new type does not need to be exposed to Lisp programs nor
310 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
311 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
312 is suitable for temporarily stashing away pointers and integers in
313 a Lisp object (see the existing uses of make_save_value and
314 XSAVE_VALUE). The latter is useful for vector-like Lisp objects
315 that need to be used as part of other objects, but which are never
316 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
317 an example).
319 These two types don't look pretty when printed, so they are
320 unsuitable for Lisp objects that can be exposed to users.
322 To define a new data type, add one more Lisp_Misc subtype or one
323 more pseudovector subtype. Pseudovectors are more suitable for
324 objects with several slots that need to support fast random access,
325 while Lisp_Misc types are for everything else. A pseudovector object
326 provides one or more slots for Lisp objects, followed by struct
327 members that are accessible only from C. A Lisp_Misc object is a
328 wrapper for a C struct that can contain anything you like.
330 To add a new pseudovector type, extend the pvec_type enumeration;
331 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
333 For a Lisp_Misc, you will also need to add your entry to union
334 Lisp_Misc (but make sure the first word has the same structure as
335 the others, starting with a 16-bit member of the Lisp_Misc_Type
336 enumeration and a 1-bit GC markbit) and make sure the overall size
337 of the union is not increased by your addition.
339 Then you will need to add switch branches in print.c (in
340 print_object, to print your object, and possibly also in
341 print_preprocess) and to alloc.c, to mark your object (in
342 mark_object) and to free it (in gc_sweep). The latter is also the
343 right place to call any code specific to your data type that needs
344 to run when the object is recycled -- e.g., free any additional
345 resources allocated for it that are not Lisp objects. You can even
346 make a pointer to the function that frees the resources a slot in
347 your object -- this way, the same object could be used to represent
348 several disparate C structures. */
350 #ifdef CHECK_LISP_OBJECT_TYPE
352 typedef struct { EMACS_INT i; } Lisp_Object;
354 #define XLI(o) (o).i
355 LISP_INLINE Lisp_Object
356 XIL (EMACS_INT i)
358 Lisp_Object o = { i };
359 return o;
362 LISP_INLINE Lisp_Object
363 LISP_MAKE_RVALUE (Lisp_Object o)
365 return o;
368 #define LISP_INITIALLY_ZERO {0}
370 #undef CHECK_LISP_OBJECT_TYPE
371 enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = 1 };
372 #else /* CHECK_LISP_OBJECT_TYPE */
374 /* If a struct type is not wanted, define Lisp_Object as just a number. */
376 typedef EMACS_INT Lisp_Object;
377 #define XLI(o) (o)
378 #define XIL(i) (i)
379 #define LISP_MAKE_RVALUE(o) (0 + (o))
380 #define LISP_INITIALLY_ZERO 0
381 enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = 0 };
382 #endif /* CHECK_LISP_OBJECT_TYPE */
384 /* In the size word of a vector, this bit means the vector has been marked. */
386 static ptrdiff_t const ARRAY_MARK_FLAG
387 #define ARRAY_MARK_FLAG PTRDIFF_MIN
388 = ARRAY_MARK_FLAG;
390 /* In the size word of a struct Lisp_Vector, this bit means it's really
391 some other vector-like object. */
392 static ptrdiff_t const PSEUDOVECTOR_FLAG
393 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
394 = PSEUDOVECTOR_FLAG;
396 /* In a pseudovector, the size field actually contains a word with one
397 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
398 with PVEC_TYPE_MASK to indicate the actual type. */
399 enum pvec_type
401 PVEC_NORMAL_VECTOR,
402 PVEC_FREE,
403 PVEC_PROCESS,
404 PVEC_FRAME,
405 PVEC_WINDOW,
406 PVEC_BOOL_VECTOR,
407 PVEC_BUFFER,
408 PVEC_HASH_TABLE,
409 PVEC_TERMINAL,
410 PVEC_WINDOW_CONFIGURATION,
411 PVEC_SUBR,
412 PVEC_OTHER,
413 /* These last 4 are special because we OR them in fns.c:internal_equal,
414 so they have to use a disjoint bit pattern:
415 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
416 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
417 PVEC_COMPILED = 0x10,
418 PVEC_CHAR_TABLE = 0x20,
419 PVEC_SUB_CHAR_TABLE = 0x30,
420 PVEC_FONT = 0x40
423 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
424 which were stored in a Lisp_Object. */
425 #ifndef DATA_SEG_BITS
426 # define DATA_SEG_BITS 0
427 #endif
428 enum { gdb_DATA_SEG_BITS = DATA_SEG_BITS };
429 #undef DATA_SEG_BITS
431 enum More_Lisp_Bits
433 DATA_SEG_BITS = gdb_DATA_SEG_BITS,
435 /* For convenience, we also store the number of elements in these bits.
436 Note that this size is not necessarily the memory-footprint size, but
437 only the number of Lisp_Object fields (that need to be traced by GC).
438 The distinction is used, e.g., by Lisp_Process, which places extra
439 non-Lisp_Object fields at the end of the structure. */
440 PSEUDOVECTOR_SIZE_BITS = 16,
441 PSEUDOVECTOR_SIZE_MASK = (1 << PSEUDOVECTOR_SIZE_BITS) - 1,
442 PVEC_TYPE_MASK = 0x0fff << PSEUDOVECTOR_SIZE_BITS,
444 /* Number of bits to put in each character in the internal representation
445 of bool vectors. This should not vary across implementations. */
446 BOOL_VECTOR_BITS_PER_CHAR = 8
449 /* These macros extract various sorts of values from a Lisp_Object.
450 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
451 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
453 /* Return a perfect hash of the Lisp_Object representation. */
454 #define XHASH(a) XLI (a)
456 #if USE_LSB_TAG
458 enum lsb_bits
460 TYPEMASK = (1 << GCTYPEBITS) - 1,
461 VALMASK = ~ TYPEMASK
463 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
464 #define XINT(a) (XLI (a) >> INTTYPEBITS)
465 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
466 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
467 #define make_lisp_ptr(ptr, type) \
468 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
469 XIL ((type) | (intptr_t) (ptr)))
471 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
472 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
474 #else /* not USE_LSB_TAG */
476 static EMACS_INT const VALMASK
477 #define VALMASK VAL_MAX
478 = VALMASK;
480 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
482 /* For integers known to be positive, XFASTINT provides fast retrieval
483 and XSETFASTINT provides fast storage. This takes advantage of the
484 fact that Lisp integers have zero-bits in their tags. */
485 #define XFASTINT(a) (XLI (a) + 0)
486 #define XSETFASTINT(a, b) ((a) = XIL (b))
488 /* Extract the value of a Lisp_Object as a (un)signed integer. */
490 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
491 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
492 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
494 #define make_lisp_ptr(ptr, type) \
495 (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
496 + ((intptr_t) (ptr) & VALMASK)))
498 #if DATA_SEG_BITS
499 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
500 which were stored in a Lisp_Object. */
501 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
502 #else
503 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
504 #endif
506 #endif /* not USE_LSB_TAG */
508 /* For integers known to be positive, XFASTINT sometimes provides
509 faster retrieval and XSETFASTINT provides faster storage.
510 If not, fallback on the non-accelerated path. */
511 #ifndef XFASTINT
512 # define XFASTINT(a) (XINT (a))
513 # define XSETFASTINT(a, b) (XSETINT (a, b))
514 #endif
516 /* Extract the pointer value of the Lisp object A, under the
517 assumption that A's type is TYPE. This is a fallback
518 implementation if nothing faster is available. */
519 #ifndef XUNTAG
520 # define XUNTAG(a, type) XPNTR (a)
521 #endif
523 #define EQ(x, y) (XHASH (x) == XHASH (y))
525 /* Largest and smallest representable fixnum values. These are the C
526 values. They are macros for use in static initializers, and
527 constants for visibility to GDB. */
528 static EMACS_INT const MOST_POSITIVE_FIXNUM =
529 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
530 MOST_POSITIVE_FIXNUM;
531 static EMACS_INT const MOST_NEGATIVE_FIXNUM =
532 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
533 MOST_NEGATIVE_FIXNUM;
535 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
536 written this way so that it also works if I is of unsigned
537 type or if I is a NaN. */
539 #define FIXNUM_OVERFLOW_P(i) \
540 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
542 LISP_INLINE ptrdiff_t
543 clip_to_bounds (ptrdiff_t lower, EMACS_INT num, ptrdiff_t upper)
545 return num < lower ? lower : num <= upper ? num : upper;
548 /* Extract a value or address from a Lisp_Object. */
550 #define XCONS(a) (eassert (CONSP (a)), \
551 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
552 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
553 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
554 #define XSTRING(a) (eassert (STRINGP (a)), \
555 (struct Lisp_String *) XUNTAG (a, Lisp_String))
556 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
557 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
558 #define XFLOAT(a) (eassert (FLOATP (a)), \
559 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
561 /* Misc types. */
563 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
564 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
565 #define XMISCTYPE(a) (XMISCANY (a)->type)
566 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
567 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
568 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
570 /* Forwarding object types. */
572 #define XFWDTYPE(a) (a->u_intfwd.type)
573 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
574 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
575 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
576 #define XBUFFER_OBJFWD(a) \
577 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
578 #define XKBOARD_OBJFWD(a) \
579 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
581 /* Pseudovector types. */
583 #define XPROCESS(a) (eassert (PROCESSP (a)), \
584 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
585 #define XWINDOW(a) (eassert (WINDOWP (a)), \
586 (struct window *) XUNTAG (a, Lisp_Vectorlike))
587 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
588 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
589 #define XSUBR(a) (eassert (SUBRP (a)), \
590 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
591 #define XBUFFER(a) (eassert (BUFFERP (a)), \
592 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
593 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
594 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
595 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
596 ((struct Lisp_Sub_Char_Table *) \
597 XUNTAG (a, Lisp_Vectorlike)))
598 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
599 ((struct Lisp_Bool_Vector *) \
600 XUNTAG (a, Lisp_Vectorlike)))
602 /* Construct a Lisp_Object from a value or address. */
604 #define XSETINT(a, b) ((a) = make_number (b))
605 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
606 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
607 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
608 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
609 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
611 /* Misc types. */
613 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
614 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
616 /* Pseudovector types. */
618 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
619 #define XSETTYPED_PVECTYPE(v, size_member, code) \
620 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
621 #define XSETPVECTYPESIZE(v, code, sizeval) \
622 ((v)->header.size = (PSEUDOVECTOR_FLAG \
623 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
624 | (sizeval)))
626 /* The cast to struct vectorlike_header * avoids aliasing issues. */
627 #define XSETPSEUDOVECTOR(a, b, code) \
628 XSETTYPED_PSEUDOVECTOR (a, b, \
629 (((struct vectorlike_header *) \
630 XUNTAG (a, Lisp_Vectorlike)) \
631 ->size), \
632 code)
633 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
634 (XSETVECTOR (a, b), \
635 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
636 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
638 #define XSETWINDOW_CONFIGURATION(a, b) \
639 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
640 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
641 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
642 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
643 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
644 #define XSETSUBR(a, b) \
645 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
646 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
647 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
648 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
649 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
650 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
652 /* Convenience macros for dealing with Lisp arrays. */
654 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
655 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
656 #define ASET(ARRAY, IDX, VAL) \
657 (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)), \
658 XVECTOR (ARRAY)->contents[IDX] = (VAL))
660 /* Convenience macros for dealing with Lisp strings. */
662 #define SDATA(string) (XSTRING (string)->data + 0)
663 #define SREF(string, index) (SDATA (string)[index] + 0)
664 #define SSET(string, index, new) (SDATA (string)[index] = (new))
665 #define SCHARS(string) (XSTRING (string)->size + 0)
666 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
668 /* Avoid "differ in sign" warnings. */
669 #define SSDATA(x) ((char *) SDATA (x))
671 #define STRING_SET_CHARS(string, newsize) \
672 (XSTRING (string)->size = (newsize))
674 #define STRING_COPYIN(string, index, new, count) \
675 memcpy (SDATA (string) + index, new, count)
677 /* Type checking. */
679 #define CHECK_TYPE(ok, Qxxxp, x) \
680 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
682 /* Deprecated and will be removed soon. */
684 #define INTERNAL_FIELD(field) field ## _
686 /* See the macros in intervals.h. */
688 typedef struct interval *INTERVAL;
690 /* Complain if object is not string or buffer type. */
691 #define CHECK_STRING_OR_BUFFER(x) \
692 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
694 struct Lisp_Cons
696 /* Car of this cons cell. */
697 Lisp_Object car;
699 union
701 /* Cdr of this cons cell. */
702 Lisp_Object cdr;
704 /* Used to chain conses on a free list. */
705 struct Lisp_Cons *chain;
706 } u;
709 /* Take the car or cdr of something known to be a cons cell. */
710 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
711 of code that has to know what a cons cell looks like. Other code not
712 part of the basic lisp implementation should assume that the car and cdr
713 fields are not accessible as lvalues. (What if we want to switch to
714 a copying collector someday? Cached cons cell field addresses may be
715 invalidated at arbitrary points.) */
716 #define XCAR_AS_LVALUE(c) (XCONS (c)->car)
717 #define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
719 /* Use these from normal code. */
720 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
721 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
723 /* Use these to set the fields of a cons cell.
725 Note that both arguments may refer to the same object, so 'n'
726 should not be read after 'c' is first modified. Also, neither
727 argument should be evaluated more than once; side effects are
728 especially common in the second argument. */
729 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
730 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
732 /* Take the car or cdr of something whose type is not known. */
733 #define CAR(c) \
734 (CONSP ((c)) ? XCAR ((c)) \
735 : NILP ((c)) ? Qnil \
736 : wrong_type_argument (Qlistp, (c)))
738 #define CDR(c) \
739 (CONSP ((c)) ? XCDR ((c)) \
740 : NILP ((c)) ? Qnil \
741 : wrong_type_argument (Qlistp, (c)))
743 /* Take the car or cdr of something whose type is not known. */
744 #define CAR_SAFE(c) \
745 (CONSP ((c)) ? XCAR ((c)) : Qnil)
747 #define CDR_SAFE(c) \
748 (CONSP ((c)) ? XCDR ((c)) : Qnil)
750 /* True if STR is a multibyte string. */
751 #define STRING_MULTIBYTE(STR) \
752 (XSTRING (STR)->size_byte >= 0)
754 /* Return the length in bytes of STR. */
756 #ifdef GC_CHECK_STRING_BYTES
758 struct Lisp_String;
759 extern ptrdiff_t string_bytes (struct Lisp_String *);
760 #define STRING_BYTES(S) string_bytes ((S))
762 #else /* not GC_CHECK_STRING_BYTES */
764 #define STRING_BYTES(STR) \
765 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
767 #endif /* not GC_CHECK_STRING_BYTES */
769 /* An upper bound on the number of bytes in a Lisp string, not
770 counting the terminating null. This a tight enough bound to
771 prevent integer overflow errors that would otherwise occur during
772 string size calculations. A string cannot contain more bytes than
773 a fixnum can represent, nor can it be so long that C pointer
774 arithmetic stops working on the string plus its terminating null.
775 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
776 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
777 would expose alloc.c internal details that we'd rather keep
778 private.
780 This is a macro for use in static initializers, and a constant for
781 visibility to GDB. The cast to ptrdiff_t ensures that
782 the macro is signed. */
783 static ptrdiff_t const STRING_BYTES_BOUND =
784 #define STRING_BYTES_BOUND \
785 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
786 STRING_BYTES_BOUND;
788 /* Mark STR as a unibyte string. */
789 #define STRING_SET_UNIBYTE(STR) \
790 do { if (EQ (STR, empty_multibyte_string)) \
791 (STR) = empty_unibyte_string; \
792 else XSTRING (STR)->size_byte = -1; } while (0)
794 /* Mark STR as a multibyte string. Assure that STR contains only
795 ASCII characters in advance. */
796 #define STRING_SET_MULTIBYTE(STR) \
797 do { if (EQ (STR, empty_unibyte_string)) \
798 (STR) = empty_multibyte_string; \
799 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
801 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
803 struct Lisp_String
805 ptrdiff_t size;
806 ptrdiff_t size_byte;
807 INTERVAL intervals; /* Text properties in this string. */
808 unsigned char *data;
811 /* Header of vector-like objects. This documents the layout constraints on
812 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
813 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
814 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
815 because when two such pointers potentially alias, a compiler won't
816 incorrectly reorder loads and stores to their size fields. See
817 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
818 struct vectorlike_header
820 /* This field contains various pieces of information:
821 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
822 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
823 vector (0) or a pseudovector (1).
824 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
825 of slots) of the vector.
826 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
827 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
828 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
829 Lisp_Object slots at the beginning of the object that need to be
830 traced by the GC, tho some types use it slightly differently.
831 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
832 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
833 in bytes. */
834 ptrdiff_t size;
836 /* When the vector is allocated from a vector block, NBYTES is used
837 if the vector is not on a free list, and VECTOR is used otherwise.
838 For large vector-like objects, BUFFER or VECTOR is used as a pointer
839 to the next vector-like object. It is generally a buffer or a
840 Lisp_Vector alias, so for convenience it is a union instead of a
841 pointer: this way, one can write P->next.vector instead of ((struct
842 Lisp_Vector *) P->next). */
843 union {
844 /* This is only needed for small vectors that are not free because the
845 `size' field only gives us the number of Lisp_Object slots, whereas we
846 need to know the total size, including non-Lisp_Object data.
847 FIXME: figure out a way to store this info elsewhere so we can
848 finally get rid of this extra word of overhead. */
849 ptrdiff_t nbytes;
850 struct buffer *buffer;
851 /* FIXME: This can be removed: For large vectors, this field could be
852 placed *before* the vector itself. And for small vectors on a free
853 list, this field could be stored in the vector's bytes, since the
854 empty vector is handled specially anyway. */
855 struct Lisp_Vector *vector;
856 } next;
859 /* Regular vector is just a header plus array of Lisp_Objects. */
861 struct Lisp_Vector
863 struct vectorlike_header header;
864 Lisp_Object contents[1];
867 /* A boolvector is a kind of vectorlike, with contents are like a string. */
869 struct Lisp_Bool_Vector
871 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
872 just the subtype information. */
873 struct vectorlike_header header;
874 /* This is the size in bits. */
875 EMACS_INT size;
876 /* This contains the actual bits, packed into bytes. */
877 unsigned char data[1];
880 /* Some handy constants for calculating sizes
881 and offsets, mostly of vectorlike objects. */
883 enum
885 header_size = offsetof (struct Lisp_Vector, contents),
886 bool_header_size = offsetof (struct Lisp_Bool_Vector, data),
887 word_size = sizeof (Lisp_Object)
890 /* If a struct is made to look like a vector, this macro returns the length
891 of the shortest vector that would hold that struct. */
893 #define VECSIZE(type) \
894 ((sizeof (type) - header_size + word_size - 1) / word_size)
896 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
897 at the end and we need to compute the number of Lisp_Object fields (the
898 ones that the GC needs to trace). */
900 #define PSEUDOVECSIZE(type, nonlispfield) \
901 ((offsetof (type, nonlispfield) - header_size) / word_size)
903 /* A char-table is a kind of vectorlike, with contents are like a
904 vector but with a few other slots. For some purposes, it makes
905 sense to handle a char-table with type struct Lisp_Vector. An
906 element of a char table can be any Lisp objects, but if it is a sub
907 char-table, we treat it a table that contains information of a
908 specific range of characters. A sub char-table has the same
909 structure as a vector. A sub char table appears only in an element
910 of a char-table, and there's no way to access it directly from
911 Emacs Lisp program. */
913 #ifdef __GNUC__
915 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
916 ({struct Lisp_Char_Table *_tbl = NULL; \
917 Lisp_Object _val; \
918 do { \
919 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
920 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
921 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
922 if (NILP (_val)) \
923 _val = _tbl->defalt; \
924 } while (NILP (_val) && ! NILP (_tbl->parent)); \
925 _val; })
927 #else /* not __GNUC__ */
929 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
930 (! NILP (XCHAR_TABLE (CT)->ascii) \
931 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
932 ? XCHAR_TABLE (CT)->ascii \
933 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
934 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
935 : char_table_ref ((CT), (IDX))) \
936 : char_table_ref ((CT), (IDX)))
938 #endif /* not __GNUC__ */
940 /* Compute A OP B, using the unsigned comparison operator OP. A and B
941 should be integer expressions. This is not the same as
942 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
943 returns 1. For efficiency, prefer plain unsigned comparison if A
944 and B's sizes both fit (after integer promotion). */
945 #define UNSIGNED_CMP(a, op, b) \
946 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
947 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
948 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
950 /* Nonzero iff C is an ASCII character. */
951 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
953 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
954 characters. Do not check validity of CT. */
955 #define CHAR_TABLE_REF(CT, IDX) \
956 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
957 : char_table_ref ((CT), (IDX)))
959 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
960 8-bit European characters. Do not check validity of CT. */
961 #define CHAR_TABLE_SET(CT, IDX, VAL) \
962 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
963 ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL) \
964 : char_table_set (CT, IDX, VAL))
966 enum CHARTAB_SIZE_BITS
968 CHARTAB_SIZE_BITS_0 = 6,
969 CHARTAB_SIZE_BITS_1 = 4,
970 CHARTAB_SIZE_BITS_2 = 5,
971 CHARTAB_SIZE_BITS_3 = 7
974 extern const int chartab_size[4];
976 struct Lisp_Char_Table
978 /* HEADER.SIZE is the vector's size field, which also holds the
979 pseudovector type information. It holds the size, too.
980 The size counts the defalt, parent, purpose, ascii,
981 contents, and extras slots. */
982 struct vectorlike_header header;
984 /* This holds a default value,
985 which is used whenever the value for a specific character is nil. */
986 Lisp_Object defalt;
988 /* This points to another char table, which we inherit from when the
989 value for a specific character is nil. The `defalt' slot takes
990 precedence over this. */
991 Lisp_Object parent;
993 /* This is a symbol which says what kind of use this char-table is
994 meant for. */
995 Lisp_Object purpose;
997 /* The bottom sub char-table for characters of the range 0..127. It
998 is nil if none of ASCII character has a specific value. */
999 Lisp_Object ascii;
1001 Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)];
1003 /* These hold additional data. It is a vector. */
1004 Lisp_Object extras[1];
1007 struct Lisp_Sub_Char_Table
1009 /* HEADER.SIZE is the vector's size field, which also holds the
1010 pseudovector type information. It holds the size, too. */
1011 struct vectorlike_header header;
1013 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1014 char-table of depth 1 contains 16 elements, and each element
1015 covers 4096 (128*32) characters. A sub char-table of depth 2
1016 contains 32 elements, and each element covers 128 characters. A
1017 sub char-table of depth 3 contains 128 elements, and each element
1018 is for one character. */
1019 Lisp_Object depth;
1021 /* Minimum character covered by the sub char-table. */
1022 Lisp_Object min_char;
1024 /* Use set_sub_char_table_contents to set this. */
1025 Lisp_Object contents[1];
1028 /* This structure describes a built-in function.
1029 It is generated by the DEFUN macro only.
1030 defsubr makes it into a Lisp object.
1032 This type is treated in most respects as a pseudovector,
1033 but since we never dynamically allocate or free them,
1034 we don't need a struct vectorlike_header and its 'next' field. */
1036 struct Lisp_Subr
1038 ptrdiff_t size;
1039 union {
1040 Lisp_Object (*a0) (void);
1041 Lisp_Object (*a1) (Lisp_Object);
1042 Lisp_Object (*a2) (Lisp_Object, Lisp_Object);
1043 Lisp_Object (*a3) (Lisp_Object, Lisp_Object, Lisp_Object);
1044 Lisp_Object (*a4) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1045 Lisp_Object (*a5) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1046 Lisp_Object (*a6) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1047 Lisp_Object (*a7) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1048 Lisp_Object (*a8) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1049 Lisp_Object (*aUNEVALLED) (Lisp_Object args);
1050 Lisp_Object (*aMANY) (ptrdiff_t, Lisp_Object *);
1051 } function;
1052 short min_args, max_args;
1053 const char *symbol_name;
1054 const char *intspec;
1055 const char *doc;
1058 /* This is the number of slots that every char table must have. This
1059 counts the ordinary slots and the top, defalt, parent, and purpose
1060 slots. */
1061 enum CHAR_TABLE_STANDARD_SLOTS
1063 CHAR_TABLE_STANDARD_SLOTS = VECSIZE (struct Lisp_Char_Table) - 1
1066 /* Return the number of "extra" slots in the char table CT. */
1068 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
1069 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
1072 /***********************************************************************
1073 Symbols
1074 ***********************************************************************/
1076 /* Interned state of a symbol. */
1078 enum symbol_interned
1080 SYMBOL_UNINTERNED = 0,
1081 SYMBOL_INTERNED = 1,
1082 SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
1085 enum symbol_redirect
1087 SYMBOL_PLAINVAL = 4,
1088 SYMBOL_VARALIAS = 1,
1089 SYMBOL_LOCALIZED = 2,
1090 SYMBOL_FORWARDED = 3
1093 struct Lisp_Symbol
1095 unsigned gcmarkbit : 1;
1097 /* Indicates where the value can be found:
1098 0 : it's a plain var, the value is in the `value' field.
1099 1 : it's a varalias, the value is really in the `alias' symbol.
1100 2 : it's a localized var, the value is in the `blv' object.
1101 3 : it's a forwarding variable, the value is in `forward'. */
1102 ENUM_BF (symbol_redirect) redirect : 3;
1104 /* Non-zero means symbol is constant, i.e. changing its value
1105 should signal an error. If the value is 3, then the var
1106 can be changed, but only by `defconst'. */
1107 unsigned constant : 2;
1109 /* Interned state of the symbol. This is an enumerator from
1110 enum symbol_interned. */
1111 unsigned interned : 2;
1113 /* Non-zero means that this variable has been explicitly declared
1114 special (with `defvar' etc), and shouldn't be lexically bound. */
1115 unsigned declared_special : 1;
1117 /* The symbol's name, as a Lisp string. */
1118 Lisp_Object name;
1120 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1121 union is used depends on the `redirect' field above. */
1122 union {
1123 Lisp_Object value;
1124 struct Lisp_Symbol *alias;
1125 struct Lisp_Buffer_Local_Value *blv;
1126 union Lisp_Fwd *fwd;
1127 } val;
1129 /* Function value of the symbol or Qunbound if not fboundp. */
1130 Lisp_Object function;
1132 /* The symbol's property list. */
1133 Lisp_Object plist;
1135 /* Next symbol in obarray bucket, if the symbol is interned. */
1136 struct Lisp_Symbol *next;
1139 /* Value is name of symbol. */
1141 #define SYMBOL_VAL(sym) \
1142 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), sym->val.value)
1143 #define SYMBOL_ALIAS(sym) \
1144 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1145 #define SYMBOL_BLV(sym) \
1146 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1147 #define SYMBOL_FWD(sym) \
1148 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1149 #define SET_SYMBOL_VAL(sym, v) \
1150 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1151 #define SET_SYMBOL_ALIAS(sym, v) \
1152 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1153 #define SET_SYMBOL_BLV(sym, v) \
1154 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1155 #define SET_SYMBOL_FWD(sym, v) \
1156 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1158 #define SYMBOL_NAME(sym) XSYMBOL (sym)->name
1160 /* Value is non-zero if SYM is an interned symbol. */
1162 #define SYMBOL_INTERNED_P(sym) \
1163 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1165 /* Value is non-zero if SYM is interned in initial_obarray. */
1167 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1168 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1170 /* Value is non-zero if symbol is considered a constant, i.e. its
1171 value cannot be changed (there is an exception for keyword symbols,
1172 whose value can be set to the keyword symbol itself). */
1174 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1176 #define DEFSYM(sym, name) \
1177 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1180 /***********************************************************************
1181 Hash Tables
1182 ***********************************************************************/
1184 /* The structure of a Lisp hash table. */
1186 struct Lisp_Hash_Table
1188 /* This is for Lisp; the hash table code does not refer to it. */
1189 struct vectorlike_header header;
1191 /* Function used to compare keys. */
1192 Lisp_Object test;
1194 /* Nil if table is non-weak. Otherwise a symbol describing the
1195 weakness of the table. */
1196 Lisp_Object weak;
1198 /* When the table is resized, and this is an integer, compute the
1199 new size by adding this to the old size. If a float, compute the
1200 new size by multiplying the old size with this factor. */
1201 Lisp_Object rehash_size;
1203 /* Resize hash table when number of entries/ table size is >= this
1204 ratio, a float. */
1205 Lisp_Object rehash_threshold;
1207 /* Vector of hash codes.. If hash[I] is nil, this means that that
1208 entry I is unused. */
1209 Lisp_Object hash;
1211 /* Vector used to chain entries. If entry I is free, next[I] is the
1212 entry number of the next free item. If entry I is non-free,
1213 next[I] is the index of the next entry in the collision chain. */
1214 Lisp_Object next;
1216 /* Index of first free entry in free list. */
1217 Lisp_Object next_free;
1219 /* Bucket vector. A non-nil entry is the index of the first item in
1220 a collision chain. This vector's size can be larger than the
1221 hash table size to reduce collisions. */
1222 Lisp_Object index;
1224 /* User-supplied hash function, or nil. */
1225 Lisp_Object user_hash_function;
1227 /* User-supplied key comparison function, or nil. */
1228 Lisp_Object user_cmp_function;
1230 /* Only the fields above are traced normally by the GC. The ones below
1231 `count' are special and are either ignored by the GC or traced in
1232 a special way (e.g. because of weakness). */
1234 /* Number of key/value entries in the table. */
1235 ptrdiff_t count;
1237 /* Vector of keys and values. The key of item I is found at index
1238 2 * I, the value is found at index 2 * I + 1.
1239 This is gc_marked specially if the table is weak. */
1240 Lisp_Object key_and_value;
1242 /* Next weak hash table if this is a weak hash table. The head
1243 of the list is in weak_hash_tables. */
1244 struct Lisp_Hash_Table *next_weak;
1246 /* C function to compare two keys. */
1247 bool (*cmpfn) (struct Lisp_Hash_Table *,
1248 Lisp_Object, EMACS_UINT,
1249 Lisp_Object, EMACS_UINT);
1251 /* C function to compute hash code. */
1252 EMACS_UINT (*hashfn) (struct Lisp_Hash_Table *, Lisp_Object);
1256 #define XHASH_TABLE(OBJ) \
1257 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1259 #define XSET_HASH_TABLE(VAR, PTR) \
1260 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1262 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1264 #define CHECK_HASH_TABLE(x) \
1265 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1267 /* Value is the key part of entry IDX in hash table H. */
1269 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1271 /* Value is the value part of entry IDX in hash table H. */
1273 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1275 /* Value is the index of the next entry following the one at IDX
1276 in hash table H. */
1278 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1280 /* Value is the hash code computed for entry IDX in hash table H. */
1282 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1284 /* Value is the index of the element in hash table H that is the
1285 start of the collision list at index IDX in the index vector of H. */
1287 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1289 /* Value is the size of hash table H. */
1291 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1293 /* Default size for hash tables if not specified. */
1295 enum DEFAULT_HASH_SIZE { DEFAULT_HASH_SIZE = 65 };
1297 /* Default threshold specifying when to resize a hash table. The
1298 value gives the ratio of current entries in the hash table and the
1299 size of the hash table. */
1301 static double const DEFAULT_REHASH_THRESHOLD = 0.8;
1303 /* Default factor by which to increase the size of a hash table. */
1305 static double const DEFAULT_REHASH_SIZE = 1.5;
1307 /* These structures are used for various misc types. */
1309 struct Lisp_Misc_Any /* Supertype of all Misc types. */
1311 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_??? */
1312 unsigned gcmarkbit : 1;
1313 int spacer : 15;
1316 struct Lisp_Marker
1318 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Marker */
1319 unsigned gcmarkbit : 1;
1320 int spacer : 13;
1321 /* This flag is temporarily used in the functions
1322 decode/encode_coding_object to record that the marker position
1323 must be adjusted after the conversion. */
1324 unsigned int need_adjustment : 1;
1325 /* 1 means normal insertion at the marker's position
1326 leaves the marker after the inserted text. */
1327 unsigned int insertion_type : 1;
1328 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1329 Note: a chain of markers can contain markers pointing into different
1330 buffers (the chain is per buffer_text rather than per buffer, so it's
1331 shared between indirect buffers). */
1332 /* This is used for (other than NULL-checking):
1333 - Fmarker_buffer
1334 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1335 - unchain_marker: to find the list from which to unchain.
1336 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1338 struct buffer *buffer;
1340 /* The remaining fields are meaningless in a marker that
1341 does not point anywhere. */
1343 /* For markers that point somewhere,
1344 this is used to chain of all the markers in a given buffer. */
1345 /* We could remove it and use an array in buffer_text instead.
1346 That would also allow to preserve it ordered. */
1347 struct Lisp_Marker *next;
1348 /* This is the char position where the marker points. */
1349 ptrdiff_t charpos;
1350 /* This is the byte position.
1351 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1352 used to implement the functionality of markers, but rather to (ab)use
1353 markers as a cache for char<->byte mappings). */
1354 ptrdiff_t bytepos;
1357 /* START and END are markers in the overlay's buffer, and
1358 PLIST is the overlay's property list. */
1359 struct Lisp_Overlay
1360 /* An overlay's real data content is:
1361 - plist
1362 - buffer (really there are two buffer pointers, one per marker,
1363 and both points to the same buffer)
1364 - insertion type of both ends (per-marker fields)
1365 - start & start byte (of start marker)
1366 - end & end byte (of end marker)
1367 - next (singly linked list of overlays)
1368 - next fields of start and end markers (singly linked list of markers).
1369 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1372 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Overlay */
1373 unsigned gcmarkbit : 1;
1374 int spacer : 15;
1375 struct Lisp_Overlay *next;
1376 Lisp_Object start;
1377 Lisp_Object end;
1378 Lisp_Object plist;
1381 /* Hold a C pointer for later use.
1382 This type of object is used in the arg to record_unwind_protect. */
1383 struct Lisp_Save_Value
1385 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Save_Value */
1386 unsigned gcmarkbit : 1;
1387 int spacer : 14;
1388 /* If DOGC is set, POINTER is the address of a memory
1389 area containing INTEGER potential Lisp_Objects. */
1390 unsigned int dogc : 1;
1391 void *pointer;
1392 ptrdiff_t integer;
1396 /* A miscellaneous object, when it's on the free list. */
1397 struct Lisp_Free
1399 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Free */
1400 unsigned gcmarkbit : 1;
1401 int spacer : 15;
1402 union Lisp_Misc *chain;
1405 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1406 It uses one of these struct subtypes to get the type field. */
1408 union Lisp_Misc
1410 struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */
1411 struct Lisp_Free u_free;
1412 struct Lisp_Marker u_marker;
1413 struct Lisp_Overlay u_overlay;
1414 struct Lisp_Save_Value u_save_value;
1417 /* Forwarding pointer to an int variable.
1418 This is allowed only in the value cell of a symbol,
1419 and it means that the symbol's value really lives in the
1420 specified int variable. */
1421 struct Lisp_Intfwd
1423 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Int */
1424 EMACS_INT *intvar;
1427 /* Boolean forwarding pointer to an int variable.
1428 This is like Lisp_Intfwd except that the ostensible
1429 "value" of the symbol is t if the int variable is nonzero,
1430 nil if it is zero. */
1431 struct Lisp_Boolfwd
1433 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Bool */
1434 bool *boolvar;
1437 /* Forwarding pointer to a Lisp_Object variable.
1438 This is allowed only in the value cell of a symbol,
1439 and it means that the symbol's value really lives in the
1440 specified variable. */
1441 struct Lisp_Objfwd
1443 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Obj */
1444 Lisp_Object *objvar;
1447 /* Like Lisp_Objfwd except that value lives in a slot in the
1448 current buffer. Value is byte index of slot within buffer. */
1449 struct Lisp_Buffer_Objfwd
1451 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Buffer_Obj */
1452 int offset;
1453 Lisp_Object slottype; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1456 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1457 the symbol has buffer-local or frame-local bindings. (Exception:
1458 some buffer-local variables are built-in, with their values stored
1459 in the buffer structure itself. They are handled differently,
1460 using struct Lisp_Buffer_Objfwd.)
1462 The `realvalue' slot holds the variable's current value, or a
1463 forwarding pointer to where that value is kept. This value is the
1464 one that corresponds to the loaded binding. To read or set the
1465 variable, you must first make sure the right binding is loaded;
1466 then you can access the value in (or through) `realvalue'.
1468 `buffer' and `frame' are the buffer and frame for which the loaded
1469 binding was found. If those have changed, to make sure the right
1470 binding is loaded it is necessary to find which binding goes with
1471 the current buffer and selected frame, then load it. To load it,
1472 first unload the previous binding, then copy the value of the new
1473 binding into `realvalue' (or through it). Also update
1474 LOADED-BINDING to point to the newly loaded binding.
1476 `local_if_set' indicates that merely setting the variable creates a
1477 local binding for the current buffer. Otherwise the latter, setting
1478 the variable does not do that; only make-local-variable does that. */
1480 struct Lisp_Buffer_Local_Value
1482 /* 1 means that merely setting the variable creates a local
1483 binding for the current buffer. */
1484 unsigned int local_if_set : 1;
1485 /* 1 means this variable can have frame-local bindings, otherwise, it is
1486 can have buffer-local bindings. The two cannot be combined. */
1487 unsigned int frame_local : 1;
1488 /* 1 means that the binding now loaded was found.
1489 Presumably equivalent to (defcell!=valcell). */
1490 unsigned int found : 1;
1491 /* If non-NULL, a forwarding to the C var where it should also be set. */
1492 union Lisp_Fwd *fwd; /* Should never be (Buffer|Kboard)_Objfwd. */
1493 /* The buffer or frame for which the loaded binding was found. */
1494 Lisp_Object where;
1495 /* A cons cell that holds the default value. It has the form
1496 (SYMBOL . DEFAULT-VALUE). */
1497 Lisp_Object defcell;
1498 /* The cons cell from `where's parameter alist.
1499 It always has the form (SYMBOL . VALUE)
1500 Note that if `forward' is non-nil, VALUE may be out of date.
1501 Also if the currently loaded binding is the default binding, then
1502 this is `eq'ual to defcell. */
1503 Lisp_Object valcell;
1506 /* Like Lisp_Objfwd except that value lives in a slot in the
1507 current kboard. */
1508 struct Lisp_Kboard_Objfwd
1510 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Kboard_Obj */
1511 int offset;
1514 union Lisp_Fwd
1516 struct Lisp_Intfwd u_intfwd;
1517 struct Lisp_Boolfwd u_boolfwd;
1518 struct Lisp_Objfwd u_objfwd;
1519 struct Lisp_Buffer_Objfwd u_buffer_objfwd;
1520 struct Lisp_Kboard_Objfwd u_kboard_objfwd;
1523 /* Lisp floating point type. */
1524 struct Lisp_Float
1526 union
1528 double data;
1529 struct Lisp_Float *chain;
1530 } u;
1533 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1534 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1536 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1537 representations, have infinities and NaNs, and do not trap on
1538 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1539 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1540 wanted here, but is not quite right because Emacs does not require
1541 all the features of C11 Annex F (and does not require C11 at all,
1542 for that matter). */
1543 #define IEEE_FLOATING_POINT (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
1544 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
1546 /* A character, declared with the following typedef, is a member
1547 of some character set associated with the current buffer. */
1548 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1549 #define _UCHAR_T
1550 typedef unsigned char UCHAR;
1551 #endif
1553 /* Meanings of slots in a Lisp_Compiled: */
1555 enum Lisp_Compiled
1557 COMPILED_ARGLIST = 0,
1558 COMPILED_BYTECODE = 1,
1559 COMPILED_CONSTANTS = 2,
1560 COMPILED_STACK_DEPTH = 3,
1561 COMPILED_DOC_STRING = 4,
1562 COMPILED_INTERACTIVE = 5
1565 /* Flag bits in a character. These also get used in termhooks.h.
1566 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1567 (MUlti-Lingual Emacs) might need 22 bits for the character value
1568 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1569 enum char_bits
1571 CHAR_ALT = 0x0400000,
1572 CHAR_SUPER = 0x0800000,
1573 CHAR_HYPER = 0x1000000,
1574 CHAR_SHIFT = 0x2000000,
1575 CHAR_CTL = 0x4000000,
1576 CHAR_META = 0x8000000,
1578 CHAR_MODIFIER_MASK =
1579 CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META,
1581 /* Actually, the current Emacs uses 22 bits for the character value
1582 itself. */
1583 CHARACTERBITS = 22
1589 /* The glyph datatype, used to represent characters on the display.
1590 It consists of a char code and a face id. */
1592 typedef struct {
1593 int ch;
1594 int face_id;
1595 } GLYPH;
1597 /* Return a glyph's character code. */
1598 #define GLYPH_CHAR(glyph) ((glyph).ch)
1600 /* Return a glyph's face ID. */
1601 #define GLYPH_FACE(glyph) ((glyph).face_id)
1603 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1604 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1605 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1607 /* Return 1 if GLYPH contains valid character code. */
1608 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1611 /* Glyph Code from a display vector may either be an integer which
1612 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1613 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1615 #define GLYPH_CODE_P(gc) \
1616 (CONSP (gc) \
1617 ? (CHARACTERP (XCAR (gc)) \
1618 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1619 : (RANGED_INTEGERP \
1620 (0, gc, \
1621 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1622 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1623 : TYPE_MAXIMUM (EMACS_INT)))))
1625 /* The following are valid only if GLYPH_CODE_P (gc). */
1627 #define GLYPH_CODE_CHAR(gc) \
1628 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1630 #define GLYPH_CODE_FACE(gc) \
1631 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1633 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1634 do \
1636 if (CONSP (gc)) \
1637 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1638 else \
1639 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1640 (XINT (gc) >> CHARACTERBITS)); \
1642 while (0)
1644 /* Structure to hold mouse highlight data. This is here because other
1645 header files need it for defining struct x_output etc. */
1646 typedef struct {
1647 /* These variables describe the range of text currently shown in its
1648 mouse-face, together with the window they apply to. As long as
1649 the mouse stays within this range, we need not redraw anything on
1650 its account. Rows and columns are glyph matrix positions in
1651 MOUSE_FACE_WINDOW. */
1652 int mouse_face_beg_row, mouse_face_beg_col;
1653 int mouse_face_beg_x, mouse_face_beg_y;
1654 int mouse_face_end_row, mouse_face_end_col;
1655 int mouse_face_end_x, mouse_face_end_y;
1656 int mouse_face_past_end;
1657 Lisp_Object mouse_face_window;
1658 int mouse_face_face_id;
1659 Lisp_Object mouse_face_overlay;
1661 /* 1 if a mouse motion event came and we didn't handle it right away because
1662 gc was in progress. */
1663 int mouse_face_deferred_gc;
1665 /* FRAME and X, Y position of mouse when last checked for
1666 highlighting. X and Y can be negative or out of range for the frame. */
1667 struct frame *mouse_face_mouse_frame;
1668 int mouse_face_mouse_x, mouse_face_mouse_y;
1670 /* Nonzero means defer mouse-motion highlighting. */
1671 int mouse_face_defer;
1673 /* Nonzero means that the mouse highlight should not be shown. */
1674 int mouse_face_hidden;
1676 int mouse_face_image_state;
1677 } Mouse_HLInfo;
1679 /* Data type checking. */
1681 #define NILP(x) EQ (x, Qnil)
1683 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1684 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1686 #define RANGED_INTEGERP(lo, x, hi) \
1687 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1688 #define TYPE_RANGED_INTEGERP(type, x) \
1689 (TYPE_SIGNED (type) \
1690 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1691 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1693 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1694 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1695 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1696 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1697 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1698 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1700 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1701 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1702 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1703 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1704 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1706 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1707 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1708 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1709 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1710 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1712 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1713 vectorlike_header * avoids aliasing issues. */
1714 #define PSEUDOVECTORP(x, code) \
1715 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1717 #define PSEUDOVECTOR_TYPEP(v, code) \
1718 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1719 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1721 /* True if object X, with internal type struct T *, is a pseudovector whose
1722 code is CODE. */
1723 #define TYPED_PSEUDOVECTORP(x, t, code) \
1724 (VECTORLIKEP (x) \
1725 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1727 /* Test for specific pseudovector types. */
1728 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1729 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1730 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1731 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1732 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1733 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1734 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1735 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1736 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1737 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1738 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1739 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1741 /* Test for image (image . spec) */
1742 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1744 /* Array types. */
1746 #define ARRAYP(x) \
1747 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1749 #define CHECK_LIST(x) \
1750 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1752 #define CHECK_LIST_CONS(x, y) \
1753 CHECK_TYPE (CONSP (x), Qlistp, y)
1755 #define CHECK_LIST_END(x, y) \
1756 CHECK_TYPE (NILP (x), Qlistp, y)
1758 #define CHECK_STRING(x) \
1759 CHECK_TYPE (STRINGP (x), Qstringp, x)
1761 #define CHECK_STRING_CAR(x) \
1762 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1764 #define CHECK_CONS(x) \
1765 CHECK_TYPE (CONSP (x), Qconsp, x)
1767 #define CHECK_SYMBOL(x) \
1768 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1770 #define CHECK_CHAR_TABLE(x) \
1771 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1773 #define CHECK_VECTOR(x) \
1774 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1776 #define CHECK_VECTOR_OR_STRING(x) \
1777 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1779 #define CHECK_ARRAY(x, Qxxxp) \
1780 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1782 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1783 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1785 #define CHECK_BUFFER(x) \
1786 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1788 #define CHECK_WINDOW(x) \
1789 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1791 #define CHECK_WINDOW_CONFIGURATION(x) \
1792 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1794 /* A window of any sort, leaf or interior, is "valid" if one of its
1795 buffer, vchild, or hchild members is non-nil. */
1796 #define CHECK_VALID_WINDOW(x) \
1797 CHECK_TYPE (WINDOWP (x) \
1798 && (!NILP (XWINDOW (x)->buffer) \
1799 || !NILP (XWINDOW (x)->vchild) \
1800 || !NILP (XWINDOW (x)->hchild)), \
1801 Qwindow_valid_p, x)
1803 /* A window is "live" if and only if it shows a buffer. */
1804 #define CHECK_LIVE_WINDOW(x) \
1805 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), \
1806 Qwindow_live_p, x)
1808 #define CHECK_PROCESS(x) \
1809 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1811 #define CHECK_SUBR(x) \
1812 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1814 #define CHECK_NUMBER(x) \
1815 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1817 #define CHECK_NATNUM(x) \
1818 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1820 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1821 do { \
1822 CHECK_NUMBER (x); \
1823 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1824 args_out_of_range_3 \
1825 (x, \
1826 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1827 ? MOST_NEGATIVE_FIXNUM \
1828 : (lo)), \
1829 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1830 } while (0)
1831 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1832 do { \
1833 if (TYPE_SIGNED (type)) \
1834 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1835 else \
1836 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1837 } while (0)
1839 #define CHECK_MARKER(x) \
1840 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1842 #define CHECK_NUMBER_COERCE_MARKER(x) \
1843 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1844 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1846 #define XFLOATINT(n) extract_float((n))
1848 #define CHECK_FLOAT(x) \
1849 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1851 #define CHECK_NUMBER_OR_FLOAT(x) \
1852 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1854 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1855 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1856 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1858 #define CHECK_OVERLAY(x) \
1859 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1861 /* Since we can't assign directly to the CAR or CDR fields of a cons
1862 cell, use these when checking that those fields contain numbers. */
1863 #define CHECK_NUMBER_CAR(x) \
1864 do { \
1865 Lisp_Object tmp = XCAR (x); \
1866 CHECK_NUMBER (tmp); \
1867 XSETCAR ((x), tmp); \
1868 } while (0)
1870 #define CHECK_NUMBER_CDR(x) \
1871 do { \
1872 Lisp_Object tmp = XCDR (x); \
1873 CHECK_NUMBER (tmp); \
1874 XSETCDR ((x), tmp); \
1875 } while (0)
1877 #define CHECK_NATNUM_CAR(x) \
1878 do { \
1879 Lisp_Object tmp = XCAR (x); \
1880 CHECK_NATNUM (tmp); \
1881 XSETCAR ((x), tmp); \
1882 } while (0)
1884 #define CHECK_NATNUM_CDR(x) \
1885 do { \
1886 Lisp_Object tmp = XCDR (x); \
1887 CHECK_NATNUM (tmp); \
1888 XSETCDR ((x), tmp); \
1889 } while (0)
1891 /* Define a built-in function for calling from Lisp.
1892 `lname' should be the name to give the function in Lisp,
1893 as a null-terminated C string.
1894 `fnname' should be the name of the function in C.
1895 By convention, it starts with F.
1896 `sname' should be the name for the C constant structure
1897 that records information on this function for internal use.
1898 By convention, it should be the same as `fnname' but with S instead of F.
1899 It's too bad that C macros can't compute this from `fnname'.
1900 `minargs' should be a number, the minimum number of arguments allowed.
1901 `maxargs' should be a number, the maximum number of arguments allowed,
1902 or else MANY or UNEVALLED.
1903 MANY means pass a vector of evaluated arguments,
1904 in the form of an integer number-of-arguments
1905 followed by the address of a vector of Lisp_Objects
1906 which contains the argument values.
1907 UNEVALLED means pass the list of unevaluated arguments
1908 `intspec' says how interactive arguments are to be fetched.
1909 If the string starts with a `(', `intspec' is evaluated and the resulting
1910 list is the list of arguments.
1911 If it's a string that doesn't start with `(', the value should follow
1912 the one of the doc string for `interactive'.
1913 A null string means call interactively with no arguments.
1914 `doc' is documentation for the user. */
1916 /* This version of DEFUN declares a function prototype with the right
1917 arguments, so we can catch errors with maxargs at compile-time. */
1918 #ifdef _MSC_VER
1919 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1920 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1921 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1922 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1923 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1924 { (Lisp_Object (__cdecl *)(void))fnname }, \
1925 minargs, maxargs, lname, intspec, 0}; \
1926 Lisp_Object fnname
1927 #else /* not _MSC_VER */
1928 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1929 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1930 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1931 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1932 { .a ## maxargs = fnname }, \
1933 minargs, maxargs, lname, intspec, 0}; \
1934 Lisp_Object fnname
1935 #endif
1937 /* Note that the weird token-substitution semantics of ANSI C makes
1938 this work for MANY and UNEVALLED. */
1939 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1940 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1941 #define DEFUN_ARGS_0 (void)
1942 #define DEFUN_ARGS_1 (Lisp_Object)
1943 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1944 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1945 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1946 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1947 Lisp_Object)
1948 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1949 Lisp_Object, Lisp_Object)
1950 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1951 Lisp_Object, Lisp_Object, Lisp_Object)
1952 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1953 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1955 /* Non-zero if OBJ is a Lisp function. */
1956 #define FUNCTIONP(OBJ) functionp(OBJ)
1958 /* defsubr (Sname);
1959 is how we define the symbol for function `name' at start-up time. */
1960 extern void defsubr (struct Lisp_Subr *);
1962 enum maxargs
1964 MANY = -2,
1965 UNEVALLED = -1
1968 extern void defvar_lisp (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1969 extern void defvar_lisp_nopro (struct Lisp_Objfwd *, const char *, Lisp_Object *);
1970 extern void defvar_bool (struct Lisp_Boolfwd *, const char *, bool *);
1971 extern void defvar_int (struct Lisp_Intfwd *, const char *, EMACS_INT *);
1972 extern void defvar_kboard (struct Lisp_Kboard_Objfwd *, const char *, int);
1974 /* Macros we use to define forwarded Lisp variables.
1975 These are used in the syms_of_FILENAME functions.
1977 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1978 lisp variable is actually a field in `struct emacs_globals'. The
1979 field's name begins with "f_", which is a convention enforced by
1980 these macros. Each such global has a corresponding #define in
1981 globals.h; the plain name should be used in the code.
1983 E.g., the global "cons_cells_consed" is declared as "int
1984 f_cons_cells_consed" in globals.h, but there is a define:
1986 #define cons_cells_consed globals.f_cons_cells_consed
1988 All C code uses the `cons_cells_consed' name. This is all done
1989 this way to support indirection for multi-threaded Emacs. */
1991 #define DEFVAR_LISP(lname, vname, doc) \
1992 do { \
1993 static struct Lisp_Objfwd o_fwd; \
1994 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1995 } while (0)
1996 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1997 do { \
1998 static struct Lisp_Objfwd o_fwd; \
1999 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2000 } while (0)
2001 #define DEFVAR_BOOL(lname, vname, doc) \
2002 do { \
2003 static struct Lisp_Boolfwd b_fwd; \
2004 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2005 } while (0)
2006 #define DEFVAR_INT(lname, vname, doc) \
2007 do { \
2008 static struct Lisp_Intfwd i_fwd; \
2009 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2010 } while (0)
2012 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2013 do { \
2014 static struct Lisp_Objfwd o_fwd; \
2015 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2016 } while (0)
2018 #define DEFVAR_KBOARD(lname, vname, doc) \
2019 do { \
2020 static struct Lisp_Kboard_Objfwd ko_fwd; \
2021 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2022 } while (0)
2024 /* Save and restore the instruction and environment pointers,
2025 without affecting the signal mask. */
2027 #ifdef HAVE__SETJMP
2028 typedef jmp_buf sys_jmp_buf;
2029 # define sys_setjmp(j) _setjmp (j)
2030 # define sys_longjmp(j, v) _longjmp (j, v)
2031 #elif defined HAVE_SIGSETJMP
2032 typedef sigjmp_buf sys_jmp_buf;
2033 # define sys_setjmp(j) sigsetjmp (j, 0)
2034 # define sys_longjmp(j, v) siglongjmp (j, v)
2035 #else
2036 /* A platform that uses neither _longjmp nor siglongjmp; assume
2037 longjmp does not affect the sigmask. */
2038 typedef jmp_buf sys_jmp_buf;
2039 # define sys_setjmp(j) setjmp (j)
2040 # define sys_longjmp(j, v) longjmp (j, v)
2041 #endif
2044 /* Structure for recording Lisp call stack for backtrace purposes. */
2046 /* The special binding stack holds the outer values of variables while
2047 they are bound by a function application or a let form, stores the
2048 code to be executed for Lisp unwind-protect forms, and stores the C
2049 functions to be called for record_unwind_protect.
2051 If func is non-zero, undoing this binding applies func to old_value;
2052 This implements record_unwind_protect.
2054 Otherwise, the element is a variable binding.
2056 If the symbol field is a symbol, it is an ordinary variable binding.
2058 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2059 which means having bound a local value while CURRENT-BUFFER was active.
2060 If WHERE is nil this means we saw the default value when binding SYMBOL.
2061 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2062 value. Other values of WHERE mean an internal error. */
2064 typedef Lisp_Object (*specbinding_func) (Lisp_Object);
2066 struct specbinding
2068 Lisp_Object symbol, old_value;
2069 specbinding_func func;
2070 Lisp_Object unused; /* Dividing by 16 is faster than by 12. */
2073 extern struct specbinding *specpdl;
2074 extern struct specbinding *specpdl_ptr;
2075 extern ptrdiff_t specpdl_size;
2077 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
2079 struct backtrace
2081 struct backtrace *next;
2082 Lisp_Object function;
2083 Lisp_Object *args; /* Points to vector of args. */
2084 ptrdiff_t nargs; /* Length of vector. */
2085 /* Nonzero means call value of debugger when done with this operation. */
2086 unsigned int debug_on_exit : 1;
2089 extern struct backtrace *backtrace_list;
2091 /* Everything needed to describe an active condition case.
2093 Members are volatile if their values need to survive _longjmp when
2094 a 'struct handler' is a local variable. */
2095 struct handler
2097 /* The handler clauses and variable from the condition-case form. */
2098 /* For a handler set up in Lisp code, this is always a list.
2099 For an internal handler set up by internal_condition_case*,
2100 this can instead be the symbol t or `error'.
2101 t: handle all conditions.
2102 error: handle all conditions, and errors can run the debugger
2103 or display a backtrace. */
2104 Lisp_Object handler;
2106 Lisp_Object volatile var;
2108 /* Fsignal stores here the condition-case clause that applies,
2109 and Fcondition_case thus knows which clause to run. */
2110 Lisp_Object volatile chosen_clause;
2112 /* Used to effect the longjump out to the handler. */
2113 struct catchtag *tag;
2115 /* The next enclosing handler. */
2116 struct handler *next;
2119 /* This structure helps implement the `catch' and `throw' control
2120 structure. A struct catchtag contains all the information needed
2121 to restore the state of the interpreter after a non-local jump.
2123 Handlers for error conditions (represented by `struct handler'
2124 structures) just point to a catch tag to do the cleanup required
2125 for their jumps.
2127 catchtag structures are chained together in the C calling stack;
2128 the `next' member points to the next outer catchtag.
2130 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2131 member is TAG, and then unbinds to it. The `val' member is used to
2132 hold VAL while the stack is unwound; `val' is returned as the value
2133 of the catch form.
2135 All the other members are concerned with restoring the interpreter
2136 state.
2138 Members are volatile if their values need to survive _longjmp when
2139 a 'struct catchtag' is a local variable. */
2140 struct catchtag
2142 Lisp_Object tag;
2143 Lisp_Object volatile val;
2144 struct catchtag *volatile next;
2145 struct gcpro *gcpro;
2146 sys_jmp_buf jmp;
2147 struct backtrace *backlist;
2148 struct handler *handlerlist;
2149 EMACS_INT lisp_eval_depth;
2150 ptrdiff_t volatile pdlcount;
2151 int poll_suppress_count;
2152 int interrupt_input_blocked;
2153 struct byte_stack *byte_stack;
2156 extern Lisp_Object memory_signal_data;
2158 /* An address near the bottom of the stack.
2159 Tells GC how to save a copy of the stack. */
2160 extern char *stack_bottom;
2162 /* Check quit-flag and quit if it is non-nil.
2163 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2164 So the program needs to do QUIT at times when it is safe to quit.
2165 Every loop that might run for a long time or might not exit
2166 ought to do QUIT at least once, at a safe place.
2167 Unless that is impossible, of course.
2168 But it is very desirable to avoid creating loops where QUIT is impossible.
2170 Exception: if you set immediate_quit to nonzero,
2171 then the handler that responds to the C-g does the quit itself.
2172 This is a good thing to do around a loop that has no side effects
2173 and (in particular) cannot call arbitrary Lisp code.
2175 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2176 a request to exit Emacs when it is safe to do. */
2178 extern void process_pending_signals (void);
2179 extern bool volatile pending_signals;
2181 extern void process_quit_flag (void);
2182 #define QUIT \
2183 do { \
2184 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2185 process_quit_flag (); \
2186 else if (pending_signals) \
2187 process_pending_signals (); \
2188 } while (0)
2191 /* Nonzero if ought to quit now. */
2193 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2195 extern Lisp_Object Vascii_downcase_table;
2196 extern Lisp_Object Vascii_canon_table;
2198 /* Structure for recording stack slots that need marking. */
2200 /* This is a chain of structures, each of which points at a Lisp_Object
2201 variable whose value should be marked in garbage collection.
2202 Normally every link of the chain is an automatic variable of a function,
2203 and its `val' points to some argument or local variable of the function.
2204 On exit to the function, the chain is set back to the value it had on entry.
2205 This way, no link remains in the chain when the stack frame containing the
2206 link disappears.
2208 Every function that can call Feval must protect in this fashion all
2209 Lisp_Object variables whose contents will be used again. */
2211 extern struct gcpro *gcprolist;
2213 struct gcpro
2215 struct gcpro *next;
2217 /* Address of first protected variable. */
2218 volatile Lisp_Object *var;
2220 /* Number of consecutive protected variables. */
2221 ptrdiff_t nvars;
2223 #ifdef DEBUG_GCPRO
2224 int level;
2225 #endif
2228 /* Values of GC_MARK_STACK during compilation:
2230 0 Use GCPRO as before
2231 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2232 2 Mark the stack, and check that everything GCPRO'd is
2233 marked.
2234 3 Mark using GCPRO's, mark stack last, and count how many
2235 dead objects are kept alive. */
2238 #define GC_USE_GCPROS_AS_BEFORE 0
2239 #define GC_MAKE_GCPROS_NOOPS 1
2240 #define GC_MARK_STACK_CHECK_GCPROS 2
2241 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2243 #ifndef GC_MARK_STACK
2244 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2245 #endif
2247 /* Whether we do the stack marking manually. */
2248 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2249 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2252 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2254 /* Do something silly with gcproN vars just so gcc shuts up. */
2255 /* You get warnings from MIPSPro... */
2257 #define GCPRO1(varname) ((void) gcpro1)
2258 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2259 #define GCPRO3(varname1, varname2, varname3) \
2260 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2261 #define GCPRO4(varname1, varname2, varname3, varname4) \
2262 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2263 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2264 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2265 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2266 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2267 (void) gcpro1)
2268 #define UNGCPRO ((void) 0)
2270 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2272 #ifndef DEBUG_GCPRO
2274 #define GCPRO1(varname) \
2275 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2276 gcprolist = &gcpro1; }
2278 #define GCPRO2(varname1, varname2) \
2279 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2280 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2281 gcprolist = &gcpro2; }
2283 #define GCPRO3(varname1, varname2, varname3) \
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 gcprolist = &gcpro3; }
2289 #define GCPRO4(varname1, varname2, varname3, varname4) \
2290 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2291 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2292 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2293 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2294 gcprolist = &gcpro4; }
2296 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2297 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2298 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2299 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2300 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2301 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2302 gcprolist = &gcpro5; }
2304 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2305 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2306 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2307 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2308 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2309 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2310 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2311 gcprolist = &gcpro6; }
2313 #define UNGCPRO (gcprolist = gcpro1.next)
2315 #else
2317 extern int gcpro_level;
2319 #define GCPRO1(varname) \
2320 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2321 gcpro1.level = gcpro_level++; \
2322 gcprolist = &gcpro1; }
2324 #define GCPRO2(varname1, varname2) \
2325 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2326 gcpro1.level = gcpro_level; \
2327 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2328 gcpro2.level = gcpro_level++; \
2329 gcprolist = &gcpro2; }
2331 #define GCPRO3(varname1, varname2, varname3) \
2332 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2333 gcpro1.level = gcpro_level; \
2334 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2335 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2336 gcpro3.level = gcpro_level++; \
2337 gcprolist = &gcpro3; }
2339 #define GCPRO4(varname1, varname2, varname3, varname4) \
2340 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2341 gcpro1.level = gcpro_level; \
2342 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2343 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2344 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2345 gcpro4.level = gcpro_level++; \
2346 gcprolist = &gcpro4; }
2348 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2349 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2350 gcpro1.level = gcpro_level; \
2351 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2352 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2353 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2354 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2355 gcpro5.level = gcpro_level++; \
2356 gcprolist = &gcpro5; }
2358 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2359 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2360 gcpro1.level = gcpro_level; \
2361 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2362 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2363 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2364 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2365 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2366 gcpro6.level = gcpro_level++; \
2367 gcprolist = &gcpro6; }
2369 #define UNGCPRO \
2370 ((--gcpro_level != gcpro1.level) \
2371 ? (emacs_abort (), 0) \
2372 : ((gcprolist = gcpro1.next), 0))
2374 #endif /* DEBUG_GCPRO */
2375 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2378 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2379 #define RETURN_UNGCPRO(expr) \
2380 do \
2382 Lisp_Object ret_ungc_val; \
2383 ret_ungc_val = (expr); \
2384 UNGCPRO; \
2385 return ret_ungc_val; \
2387 while (0)
2389 /* Call staticpro (&var) to protect static variable `var'. */
2391 void staticpro (Lisp_Object *);
2393 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2394 meaning as in the DEFUN macro, and is used to construct a prototype. */
2395 /* We can use the same trick as in the DEFUN macro to generate the
2396 appropriate prototype. */
2397 #define EXFUN(fnname, maxargs) \
2398 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2400 /* Forward declarations for prototypes. */
2401 struct window;
2402 struct frame;
2404 /* Simple access functions. */
2406 LISP_INLINE Lisp_Object *
2407 aref_addr (Lisp_Object array, ptrdiff_t idx)
2409 return & XVECTOR (array)->contents[idx];
2412 LISP_INLINE void
2413 gc_aset (Lisp_Object array, ptrdiff_t idx, Lisp_Object val)
2415 /* Like ASET, but also can be used in the garbage collector:
2416 sweep_weak_table calls set_hash_key etc. while the table is marked. */
2417 eassert (0 <= idx && idx < (ASIZE (array) & ~ARRAY_MARK_FLAG));
2418 XVECTOR (array)->contents[idx] = val;
2421 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2423 LISP_INLINE void
2424 vcopy (Lisp_Object v, ptrdiff_t offset, Lisp_Object *args, ptrdiff_t count)
2426 eassert (0 <= offset && 0 <= count && offset + count <= ASIZE (v));
2427 memcpy (XVECTOR (v)->contents + offset, args, count * sizeof *args);
2430 /* Functions to modify hash tables. */
2432 LISP_INLINE void
2433 set_hash_key_and_value (struct Lisp_Hash_Table *h, Lisp_Object key_and_value)
2435 h->key_and_value = key_and_value;
2438 LISP_INLINE void
2439 set_hash_key_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val)
2441 gc_aset (h->key_and_value, 2 * idx, val);
2444 LISP_INLINE void
2445 set_hash_value_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val)
2447 gc_aset (h->key_and_value, 2 * idx + 1, val);
2450 LISP_INLINE void
2451 set_hash_next (struct Lisp_Hash_Table *h, Lisp_Object next)
2453 h->next = next;
2456 LISP_INLINE void
2457 set_hash_next_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val)
2459 gc_aset (h->next, idx, val);
2462 LISP_INLINE void
2463 set_hash_hash (struct Lisp_Hash_Table *h, Lisp_Object hash)
2465 h->hash = hash;
2468 LISP_INLINE void
2469 set_hash_hash_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val)
2471 gc_aset (h->hash, idx, val);
2474 LISP_INLINE void
2475 set_hash_index (struct Lisp_Hash_Table *h, Lisp_Object index)
2477 h->index = index;
2480 LISP_INLINE void
2481 set_hash_index_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val)
2483 gc_aset (h->index, idx, val);
2486 /* Use these functions to set Lisp_Object
2487 or pointer slots of struct Lisp_Symbol. */
2489 LISP_INLINE void
2490 set_symbol_name (Lisp_Object sym, Lisp_Object name)
2492 XSYMBOL (sym)->name = name;
2495 LISP_INLINE void
2496 set_symbol_function (Lisp_Object sym, Lisp_Object function)
2498 XSYMBOL (sym)->function = function;
2501 LISP_INLINE void
2502 set_symbol_plist (Lisp_Object sym, Lisp_Object plist)
2504 XSYMBOL (sym)->plist = plist;
2507 LISP_INLINE void
2508 set_symbol_next (Lisp_Object sym, struct Lisp_Symbol *next)
2510 XSYMBOL (sym)->next = next;
2513 /* Buffer-local (also frame-local) variable access functions. */
2515 LISP_INLINE int
2516 blv_found (struct Lisp_Buffer_Local_Value *blv)
2518 eassert (blv->found == !EQ (blv->defcell, blv->valcell));
2519 return blv->found;
2522 LISP_INLINE void
2523 set_blv_found (struct Lisp_Buffer_Local_Value *blv, int found)
2525 eassert (found == !EQ (blv->defcell, blv->valcell));
2526 blv->found = found;
2529 LISP_INLINE Lisp_Object
2530 blv_value (struct Lisp_Buffer_Local_Value *blv)
2532 return XCDR (blv->valcell);
2535 LISP_INLINE void
2536 set_blv_value (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
2538 XSETCDR (blv->valcell, val);
2541 LISP_INLINE void
2542 set_blv_where (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
2544 blv->where = val;
2547 LISP_INLINE void
2548 set_blv_defcell (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
2550 blv->defcell = val;
2553 LISP_INLINE void
2554 set_blv_valcell (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
2556 blv->valcell = val;
2559 /* Set overlay's property list. */
2561 LISP_INLINE void
2562 set_overlay_plist (Lisp_Object overlay, Lisp_Object plist)
2564 XOVERLAY (overlay)->plist = plist;
2567 /* Get text properties of S. */
2569 LISP_INLINE INTERVAL
2570 string_intervals (Lisp_Object s)
2572 return XSTRING (s)->intervals;
2575 /* Set text properties of S to I. */
2577 LISP_INLINE void
2578 set_string_intervals (Lisp_Object s, INTERVAL i)
2580 XSTRING (s)->intervals = i;
2583 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2584 of setting slots directly. */
2586 LISP_INLINE void
2587 set_char_table_ascii (Lisp_Object table, Lisp_Object val)
2589 XCHAR_TABLE (table)->ascii = val;
2591 LISP_INLINE void
2592 set_char_table_defalt (Lisp_Object table, Lisp_Object val)
2594 XCHAR_TABLE (table)->defalt = val;
2596 LISP_INLINE void
2597 set_char_table_parent (Lisp_Object table, Lisp_Object val)
2599 XCHAR_TABLE (table)->parent = val;
2601 LISP_INLINE void
2602 set_char_table_purpose (Lisp_Object table, Lisp_Object val)
2604 XCHAR_TABLE (table)->purpose = val;
2607 /* Set different slots in (sub)character tables. */
2609 LISP_INLINE void
2610 set_char_table_extras (Lisp_Object table, ptrdiff_t idx, Lisp_Object val)
2612 eassert (0 <= idx && idx < CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table)));
2613 XCHAR_TABLE (table)->extras[idx] = val;
2616 LISP_INLINE void
2617 set_char_table_contents (Lisp_Object table, ptrdiff_t idx, Lisp_Object val)
2619 eassert (0 <= idx && idx < (1 << CHARTAB_SIZE_BITS_0));
2620 XCHAR_TABLE (table)->contents[idx] = val;
2623 LISP_INLINE void
2624 set_sub_char_table_contents (Lisp_Object table, ptrdiff_t idx, Lisp_Object val)
2626 XSUB_CHAR_TABLE (table)->contents[idx] = val;
2629 /* Defined in data.c. */
2630 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qunbound;
2631 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
2632 extern Lisp_Object Qerror, Qquit, Qargs_out_of_range;
2633 extern Lisp_Object Qvoid_variable, Qvoid_function;
2634 extern Lisp_Object Qinvalid_read_syntax;
2635 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
2636 extern Lisp_Object Quser_error, Qend_of_file, Qarith_error, Qmark_inactive;
2637 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
2638 extern Lisp_Object Qtext_read_only;
2639 extern Lisp_Object Qinteractive_form;
2640 extern Lisp_Object Qcircular_list;
2641 extern Lisp_Object Qintegerp, Qwholenump, Qsymbolp, Qlistp, Qconsp;
2642 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
2643 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
2644 extern Lisp_Object Qbuffer_or_string_p;
2645 extern Lisp_Object Qfboundp;
2646 extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
2648 extern Lisp_Object Qcdr;
2650 extern Lisp_Object Qrange_error, Qoverflow_error;
2652 extern Lisp_Object Qfloatp;
2653 extern Lisp_Object Qnumberp, Qnumber_or_marker_p;
2655 extern Lisp_Object Qbuffer, Qinteger, Qsymbol;
2657 extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
2659 EXFUN (Fbyteorder, 0) ATTRIBUTE_CONST;
2661 /* Defined in frame.c. */
2662 extern Lisp_Object Qframep;
2664 /* Defined in data.c. */
2665 extern Lisp_Object indirect_function (Lisp_Object);
2666 extern Lisp_Object find_symbol_value (Lisp_Object);
2668 /* Convert the integer I to an Emacs representation, either the integer
2669 itself, or a cons of two or three integers, or if all else fails a float.
2670 I should not have side effects. */
2671 #define INTEGER_TO_CONS(i) \
2672 (! FIXNUM_OVERFLOW_P (i) \
2673 ? make_number (i) \
2674 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2675 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2676 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2677 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2678 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2679 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2680 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2681 ? Fcons (make_number ((i) >> 16 >> 24), \
2682 Fcons (make_number ((i) >> 16 & 0xffffff), \
2683 make_number ((i) & 0xffff))) \
2684 : make_float (i))
2686 /* Convert the Emacs representation CONS back to an integer of type
2687 TYPE, storing the result the variable VAR. Signal an error if CONS
2688 is not a valid representation or is out of range for TYPE. */
2689 #define CONS_TO_INTEGER(cons, type, var) \
2690 (TYPE_SIGNED (type) \
2691 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2692 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2693 extern intmax_t cons_to_signed (Lisp_Object, intmax_t, intmax_t);
2694 extern uintmax_t cons_to_unsigned (Lisp_Object, uintmax_t);
2696 extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *);
2697 extern _Noreturn void args_out_of_range (Lisp_Object, Lisp_Object);
2698 extern _Noreturn void args_out_of_range_3 (Lisp_Object, Lisp_Object,
2699 Lisp_Object);
2700 extern _Noreturn Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object);
2701 extern Lisp_Object do_symval_forwarding (union Lisp_Fwd *);
2702 extern void set_internal (Lisp_Object, Lisp_Object, Lisp_Object, bool);
2703 extern void syms_of_data (void);
2704 extern void swap_in_global_binding (struct Lisp_Symbol *);
2706 /* Defined in cmds.c */
2707 extern void syms_of_cmds (void);
2708 extern void keys_of_cmds (void);
2710 /* Defined in coding.c. */
2711 extern Lisp_Object Qcharset;
2712 extern Lisp_Object detect_coding_system (const unsigned char *, ptrdiff_t,
2713 ptrdiff_t, bool, bool, Lisp_Object);
2714 extern void init_coding (void);
2715 extern void init_coding_once (void);
2716 extern void syms_of_coding (void);
2718 /* Defined in character.c. */
2719 EXFUN (Fmax_char, 0) ATTRIBUTE_CONST;
2720 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2721 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2722 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST;
2723 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST;
2724 extern void syms_of_character (void);
2726 /* Defined in charset.c. */
2727 extern void init_charset (void);
2728 extern void init_charset_once (void);
2729 extern void syms_of_charset (void);
2730 /* Structure forward declarations. */
2731 struct charset;
2733 /* Defined in composite.c. */
2734 extern void syms_of_composite (void);
2736 /* Defined in syntax.c. */
2737 extern void init_syntax_once (void);
2738 extern void syms_of_syntax (void);
2740 /* Defined in fns.c. */
2741 extern Lisp_Object QCrehash_size, QCrehash_threshold;
2742 enum { NEXT_ALMOST_PRIME_LIMIT = 11 };
2743 EXFUN (Fidentity, 1) ATTRIBUTE_CONST;
2744 extern EMACS_INT next_almost_prime (EMACS_INT) ATTRIBUTE_CONST;
2745 extern Lisp_Object larger_vector (Lisp_Object, ptrdiff_t, ptrdiff_t);
2746 extern void sweep_weak_hash_tables (void);
2747 extern Lisp_Object Qcursor_in_echo_area;
2748 extern Lisp_Object Qstring_lessp;
2749 extern Lisp_Object QCsize, QCtest, QCweakness, Qequal, Qeq, Qeql;
2750 EMACS_UINT hash_string (char const *, ptrdiff_t);
2751 EMACS_UINT sxhash (Lisp_Object, int);
2752 Lisp_Object make_hash_table (Lisp_Object, Lisp_Object, Lisp_Object,
2753 Lisp_Object, Lisp_Object, Lisp_Object,
2754 Lisp_Object);
2755 ptrdiff_t hash_lookup (struct Lisp_Hash_Table *, Lisp_Object, EMACS_UINT *);
2756 ptrdiff_t hash_put (struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
2757 EMACS_UINT);
2759 extern Lisp_Object substring_both (Lisp_Object, ptrdiff_t, ptrdiff_t,
2760 ptrdiff_t, ptrdiff_t);
2761 extern Lisp_Object do_yes_or_no_p (Lisp_Object);
2762 extern Lisp_Object concat2 (Lisp_Object, Lisp_Object);
2763 extern Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2764 extern Lisp_Object nconc2 (Lisp_Object, Lisp_Object);
2765 extern Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object);
2766 extern Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object);
2767 extern void clear_string_char_byte_cache (void);
2768 extern ptrdiff_t string_char_to_byte (Lisp_Object, ptrdiff_t);
2769 extern ptrdiff_t string_byte_to_char (Lisp_Object, ptrdiff_t);
2770 extern Lisp_Object string_to_multibyte (Lisp_Object);
2771 extern Lisp_Object string_make_unibyte (Lisp_Object);
2772 extern void syms_of_fns (void);
2774 /* Defined in floatfns.c. */
2775 extern double extract_float (Lisp_Object);
2776 extern void syms_of_floatfns (void);
2777 extern Lisp_Object fmod_float (Lisp_Object x, Lisp_Object y);
2779 /* Defined in fringe.c. */
2780 extern void syms_of_fringe (void);
2781 extern void init_fringe (void);
2782 #ifdef HAVE_WINDOW_SYSTEM
2783 extern void mark_fringe_data (void);
2784 extern void init_fringe_once (void);
2785 #endif /* HAVE_WINDOW_SYSTEM */
2787 /* Defined in image.c. */
2788 extern Lisp_Object QCascent, QCmargin, QCrelief;
2789 extern Lisp_Object QCconversion;
2790 extern int x_bitmap_mask (struct frame *, ptrdiff_t);
2791 extern void reset_image_types (void);
2792 extern void syms_of_image (void);
2794 /* Defined in insdel.c. */
2795 extern Lisp_Object Qinhibit_modification_hooks;
2796 extern void move_gap (ptrdiff_t);
2797 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2798 extern _Noreturn void buffer_overflow (void);
2799 extern void make_gap (ptrdiff_t);
2800 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2801 ptrdiff_t, bool, bool);
2802 extern int count_combining_before (const unsigned char *,
2803 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2804 extern int count_combining_after (const unsigned char *,
2805 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2806 extern void insert (const char *, ptrdiff_t);
2807 extern void insert_and_inherit (const char *, ptrdiff_t);
2808 extern void insert_1 (const char *, ptrdiff_t, bool, bool, bool);
2809 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2810 bool, bool, bool);
2811 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2812 extern void insert_from_string (Lisp_Object, ptrdiff_t, ptrdiff_t,
2813 ptrdiff_t, ptrdiff_t, bool);
2814 extern void insert_from_buffer (struct buffer *, ptrdiff_t, ptrdiff_t, bool);
2815 extern void insert_char (int);
2816 extern void insert_string (const char *);
2817 extern void insert_before_markers (const char *, ptrdiff_t);
2818 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2819 extern void insert_from_string_before_markers (Lisp_Object, ptrdiff_t,
2820 ptrdiff_t, ptrdiff_t,
2821 ptrdiff_t, bool);
2822 extern void del_range (ptrdiff_t, ptrdiff_t);
2823 extern Lisp_Object del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
2824 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
2825 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
2826 extern Lisp_Object del_range_2 (ptrdiff_t, ptrdiff_t,
2827 ptrdiff_t, ptrdiff_t, bool);
2828 extern void modify_region (struct buffer *, ptrdiff_t, ptrdiff_t, bool);
2829 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2830 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2831 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2832 ptrdiff_t, ptrdiff_t);
2833 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2834 ptrdiff_t, ptrdiff_t);
2835 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object, bool, bool, bool);
2836 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2837 const char *, ptrdiff_t, ptrdiff_t, bool);
2838 extern void syms_of_insdel (void);
2840 /* Defined in dispnew.c. */
2841 #if (defined PROFILING \
2842 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2843 _Noreturn void __executable_start (void);
2844 #endif
2845 extern Lisp_Object selected_frame;
2846 extern Lisp_Object Vwindow_system;
2847 extern Lisp_Object sit_for (Lisp_Object, bool, int);
2848 extern void init_display (void);
2849 extern void syms_of_display (void);
2851 /* Defined in xdisp.c. */
2852 extern Lisp_Object Qinhibit_point_motion_hooks;
2853 extern Lisp_Object Qinhibit_redisplay, Qdisplay;
2854 extern Lisp_Object Qmenu_bar_update_hook;
2855 extern Lisp_Object Qwindow_scroll_functions;
2856 extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
2857 extern Lisp_Object Qimage, Qtext, Qboth, Qboth_horiz, Qtext_image_horiz;
2858 extern Lisp_Object Qspace, Qcenter, QCalign_to;
2859 extern Lisp_Object Qbar, Qhbar, Qbox, Qhollow;
2860 extern Lisp_Object Qleft_margin, Qright_margin;
2861 extern Lisp_Object Qglyphless_char;
2862 extern Lisp_Object QCdata, QCfile;
2863 extern Lisp_Object QCmap;
2864 extern Lisp_Object Qrisky_local_variable;
2865 extern struct frame *last_glyphless_glyph_frame;
2866 extern int last_glyphless_glyph_face_id;
2867 extern int last_glyphless_glyph_merged_face_id;
2868 extern int noninteractive_need_newline;
2869 extern Lisp_Object echo_area_buffer[2];
2870 extern void add_to_log (const char *, Lisp_Object, Lisp_Object);
2871 extern void check_message_stack (void);
2872 extern void setup_echo_area_for_printing (int);
2873 extern bool push_message (void);
2874 extern Lisp_Object pop_message_unwind (Lisp_Object);
2875 extern Lisp_Object restore_message_unwind (Lisp_Object);
2876 extern void restore_message (void);
2877 extern Lisp_Object current_message (void);
2878 extern void clear_message (int, int);
2879 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2880 extern void message1 (const char *);
2881 extern void message1_nolog (const char *);
2882 extern void message2 (const char *, ptrdiff_t, int);
2883 extern void message2_nolog (const char *, ptrdiff_t, int);
2884 extern void message3 (Lisp_Object, ptrdiff_t, int);
2885 extern void message3_nolog (Lisp_Object, ptrdiff_t, int);
2886 extern void message_dolog (const char *, ptrdiff_t, int, int);
2887 extern void message_with_string (const char *, Lisp_Object, int);
2888 extern void message_log_maybe_newline (void);
2889 extern void update_echo_area (void);
2890 extern void truncate_echo_area (ptrdiff_t);
2891 extern void redisplay (void);
2892 extern void redisplay_preserve_echo_area (int);
2893 extern void prepare_menu_bars (void);
2895 void set_frame_cursor_types (struct frame *, Lisp_Object);
2896 extern void syms_of_xdisp (void);
2897 extern void init_xdisp (void);
2898 extern Lisp_Object safe_eval (Lisp_Object);
2899 extern int pos_visible_p (struct window *, ptrdiff_t, int *,
2900 int *, int *, int *, int *, int *);
2902 /* Defined in xsettings.c. */
2903 extern void syms_of_xsettings (void);
2905 /* Defined in vm-limit.c. */
2906 extern void memory_warnings (void *, void (*warnfun) (const char *));
2908 /* Defined in alloc.c. */
2909 extern void check_pure_size (void);
2910 extern void allocate_string_data (struct Lisp_String *, EMACS_INT, EMACS_INT);
2911 extern void malloc_warning (const char *);
2912 extern _Noreturn void memory_full (size_t);
2913 extern _Noreturn void buffer_memory_full (ptrdiff_t);
2914 extern bool survives_gc_p (Lisp_Object);
2915 extern void mark_object (Lisp_Object);
2916 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2917 extern void refill_memory_reserve (void);
2918 #endif
2919 extern const char *pending_malloc_warning;
2920 extern Lisp_Object zero_vector;
2921 extern Lisp_Object *stack_base;
2922 extern EMACS_INT consing_since_gc;
2923 extern EMACS_INT gc_relative_threshold;
2924 extern EMACS_INT memory_full_cons_threshold;
2925 extern Lisp_Object list1 (Lisp_Object);
2926 extern Lisp_Object list2 (Lisp_Object, Lisp_Object);
2927 extern Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object);
2928 extern Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2929 extern Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2930 Lisp_Object);
2931 enum constype {CONSTYPE_HEAP, CONSTYPE_PURE};
2932 extern Lisp_Object listn (enum constype, ptrdiff_t, Lisp_Object, ...);
2933 extern _Noreturn void string_overflow (void);
2934 extern Lisp_Object make_string (const char *, ptrdiff_t);
2935 extern Lisp_Object make_formatted_string (char *, const char *, ...)
2936 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2937 extern Lisp_Object make_unibyte_string (const char *, ptrdiff_t);
2939 /* Make unibyte string from C string when the length isn't known. */
2941 LISP_INLINE Lisp_Object
2942 build_unibyte_string (const char *str)
2944 return make_unibyte_string (str, strlen (str));
2947 extern Lisp_Object make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2948 extern Lisp_Object make_event_array (int, Lisp_Object *);
2949 extern Lisp_Object make_uninit_string (EMACS_INT);
2950 extern Lisp_Object make_uninit_multibyte_string (EMACS_INT, EMACS_INT);
2951 extern Lisp_Object make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2952 extern Lisp_Object make_specified_string (const char *,
2953 ptrdiff_t, ptrdiff_t, bool);
2954 extern Lisp_Object make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
2955 extern Lisp_Object make_pure_c_string (const char *, ptrdiff_t);
2957 /* Make a string allocated in pure space, use STR as string data. */
2959 LISP_INLINE Lisp_Object
2960 build_pure_c_string (const char *str)
2962 return make_pure_c_string (str, strlen (str));
2965 /* Make a string from the data at STR, treating it as multibyte if the
2966 data warrants. */
2968 LISP_INLINE Lisp_Object
2969 build_string (const char *str)
2971 return make_string (str, strlen (str));
2974 extern Lisp_Object pure_cons (Lisp_Object, Lisp_Object);
2975 extern void make_byte_code (struct Lisp_Vector *);
2976 extern Lisp_Object Qautomatic_gc;
2977 extern Lisp_Object Qchar_table_extra_slots;
2978 extern struct Lisp_Vector *allocate_vector (EMACS_INT);
2979 extern struct Lisp_Vector *allocate_pseudovector (int memlen, int lisplen, int tag);
2980 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2981 ((typ*) \
2982 allocate_pseudovector \
2983 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2984 extern struct Lisp_Hash_Table *allocate_hash_table (void);
2985 extern struct window *allocate_window (void);
2986 extern struct frame *allocate_frame (void);
2987 extern struct Lisp_Process *allocate_process (void);
2988 extern struct terminal *allocate_terminal (void);
2989 extern bool gc_in_progress;
2990 extern bool abort_on_gc;
2991 extern Lisp_Object make_float (double);
2992 extern void display_malloc_warning (void);
2993 extern ptrdiff_t inhibit_garbage_collection (void);
2994 extern Lisp_Object make_save_value (void *, ptrdiff_t);
2995 extern Lisp_Object build_overlay (Lisp_Object, Lisp_Object, Lisp_Object);
2996 extern void free_marker (Lisp_Object);
2997 extern void free_cons (struct Lisp_Cons *);
2998 extern void init_alloc_once (void);
2999 extern void init_alloc (void);
3000 extern void syms_of_alloc (void);
3001 extern struct buffer * allocate_buffer (void);
3002 extern int valid_lisp_object_p (Lisp_Object);
3003 #ifdef GC_CHECK_CONS_LIST
3004 extern void check_cons_list (void);
3005 #else
3006 #define check_cons_list() ((void) 0)
3007 #endif
3009 #ifdef REL_ALLOC
3010 /* Defined in ralloc.c. */
3011 extern void *r_alloc (void **, size_t);
3012 extern void r_alloc_free (void **);
3013 extern void *r_re_alloc (void **, size_t);
3014 extern void r_alloc_reset_variable (void **, void **);
3015 extern void r_alloc_inhibit_buffer_relocation (int);
3016 #endif
3018 /* Defined in chartab.c. */
3019 extern Lisp_Object copy_char_table (Lisp_Object);
3020 extern Lisp_Object char_table_ref (Lisp_Object, int);
3021 extern Lisp_Object char_table_ref_and_range (Lisp_Object, int,
3022 int *, int *);
3023 extern void char_table_set (Lisp_Object, int, Lisp_Object);
3024 extern void char_table_set_range (Lisp_Object, int, int, Lisp_Object);
3025 extern int char_table_translate (Lisp_Object, int);
3026 extern void map_char_table (void (*) (Lisp_Object, Lisp_Object,
3027 Lisp_Object),
3028 Lisp_Object, Lisp_Object, Lisp_Object);
3029 extern void map_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object),
3030 Lisp_Object, Lisp_Object,
3031 Lisp_Object, struct charset *,
3032 unsigned, unsigned);
3033 extern Lisp_Object uniprop_table (Lisp_Object);
3034 extern void syms_of_chartab (void);
3036 /* Defined in print.c. */
3037 extern Lisp_Object Vprin1_to_string_buffer;
3038 extern void debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
3039 extern Lisp_Object Qstandard_output;
3040 extern Lisp_Object Qexternal_debugging_output;
3041 extern void temp_output_buffer_setup (const char *);
3042 extern int print_level;
3043 extern Lisp_Object Qprint_escape_newlines;
3044 extern void write_string (const char *, int);
3045 extern void print_error_message (Lisp_Object, Lisp_Object, const char *,
3046 Lisp_Object);
3047 extern Lisp_Object internal_with_output_to_temp_buffer
3048 (const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object);
3049 enum FLOAT_TO_STRING_BUFSIZE { FLOAT_TO_STRING_BUFSIZE = 350 };
3050 extern int float_to_string (char *, double);
3051 extern void syms_of_print (void);
3053 /* Defined in doprnt.c. */
3054 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3055 va_list);
3056 extern ptrdiff_t esprintf (char *, char const *, ...)
3057 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3058 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3059 char const *, ...)
3060 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3061 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3062 char const *, va_list)
3063 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3065 /* Defined in lread.c. */
3066 extern Lisp_Object Qvariable_documentation, Qstandard_input;
3067 extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
3068 extern Lisp_Object Qlexical_binding;
3069 extern Lisp_Object check_obarray (Lisp_Object);
3070 extern Lisp_Object intern_1 (const char *, ptrdiff_t);
3071 extern Lisp_Object intern_c_string_1 (const char *, ptrdiff_t);
3072 extern Lisp_Object oblookup (Lisp_Object, const char *, ptrdiff_t, ptrdiff_t);
3073 #define LOADHIST_ATTACH(x) \
3074 do { \
3075 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
3076 } while (0)
3077 extern int openp (Lisp_Object, Lisp_Object, Lisp_Object,
3078 Lisp_Object *, Lisp_Object);
3079 extern Lisp_Object string_to_number (char const *, int, bool);
3080 extern void map_obarray (Lisp_Object, void (*) (Lisp_Object, Lisp_Object),
3081 Lisp_Object);
3082 extern void dir_warning (const char *, Lisp_Object);
3083 extern void close_load_descs (void);
3084 extern void init_obarray (void);
3085 extern void init_lread (void);
3086 extern void syms_of_lread (void);
3088 LISP_INLINE Lisp_Object
3089 intern (const char *str)
3091 return intern_1 (str, strlen (str));
3094 LISP_INLINE Lisp_Object
3095 intern_c_string (const char *str)
3097 return intern_c_string_1 (str, strlen (str));
3100 /* Defined in eval.c. */
3101 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qmacro;
3102 extern Lisp_Object Qinhibit_quit, Qinternal_interpreter_environment, Qclosure;
3103 extern Lisp_Object Qand_rest;
3104 extern Lisp_Object Vautoload_queue;
3105 extern Lisp_Object Vsignaling_function;
3106 extern Lisp_Object inhibit_lisp_code;
3107 #if BYTE_MARK_STACK
3108 extern struct catchtag *catchlist;
3109 extern struct handler *handlerlist;
3110 #endif
3111 /* To run a normal hook, use the appropriate function from the list below.
3112 The calling convention:
3114 if (!NILP (Vrun_hooks))
3115 call1 (Vrun_hooks, Qmy_funny_hook);
3117 should no longer be used. */
3118 extern Lisp_Object Vrun_hooks;
3119 extern void run_hook_with_args_2 (Lisp_Object, Lisp_Object, Lisp_Object);
3120 extern Lisp_Object run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args,
3121 Lisp_Object (*funcall)
3122 (ptrdiff_t nargs, Lisp_Object *args));
3123 extern _Noreturn void xsignal (Lisp_Object, Lisp_Object);
3124 extern _Noreturn void xsignal0 (Lisp_Object);
3125 extern _Noreturn void xsignal1 (Lisp_Object, Lisp_Object);
3126 extern _Noreturn void xsignal2 (Lisp_Object, Lisp_Object, Lisp_Object);
3127 extern _Noreturn void xsignal3 (Lisp_Object, Lisp_Object, Lisp_Object,
3128 Lisp_Object);
3129 extern _Noreturn void signal_error (const char *, Lisp_Object);
3130 extern Lisp_Object eval_sub (Lisp_Object form);
3131 extern Lisp_Object apply1 (Lisp_Object, Lisp_Object);
3132 extern Lisp_Object call0 (Lisp_Object);
3133 extern Lisp_Object call1 (Lisp_Object, Lisp_Object);
3134 extern Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object);
3135 extern Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3136 extern Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3137 extern Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3138 extern Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3139 extern Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3140 extern Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object);
3141 extern Lisp_Object internal_lisp_condition_case (Lisp_Object, Lisp_Object, Lisp_Object);
3142 extern Lisp_Object internal_condition_case (Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object));
3143 extern Lisp_Object internal_condition_case_1 (Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
3144 extern Lisp_Object internal_condition_case_2 (Lisp_Object (*) (Lisp_Object, Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
3145 extern Lisp_Object internal_condition_case_n
3146 (Lisp_Object (*) (ptrdiff_t, Lisp_Object *), ptrdiff_t, Lisp_Object *,
3147 Lisp_Object, Lisp_Object (*) (Lisp_Object, ptrdiff_t, Lisp_Object *));
3148 extern void specbind (Lisp_Object, Lisp_Object);
3149 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object), Lisp_Object);
3150 extern Lisp_Object unbind_to (ptrdiff_t, Lisp_Object);
3151 extern _Noreturn void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3152 extern _Noreturn void verror (const char *, va_list)
3153 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3154 extern Lisp_Object un_autoload (Lisp_Object);
3155 extern Lisp_Object call_debugger (Lisp_Object arg);
3156 extern void init_eval_once (void);
3157 extern Lisp_Object safe_call (ptrdiff_t, Lisp_Object, ...);
3158 extern Lisp_Object safe_call1 (Lisp_Object, Lisp_Object);
3159 extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object);
3160 extern void init_eval (void);
3161 #if BYTE_MARK_STACK
3162 extern void mark_backtrace (void);
3163 #endif
3164 extern void syms_of_eval (void);
3166 /* Defined in editfns.c. */
3167 extern Lisp_Object Qfield;
3168 extern void insert1 (Lisp_Object);
3169 extern Lisp_Object format2 (const char *, Lisp_Object, Lisp_Object);
3170 extern Lisp_Object save_excursion_save (void);
3171 extern Lisp_Object save_restriction_save (void);
3172 extern Lisp_Object save_excursion_restore (Lisp_Object);
3173 extern Lisp_Object save_restriction_restore (Lisp_Object);
3174 extern _Noreturn void time_overflow (void);
3175 extern Lisp_Object make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3176 extern Lisp_Object make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3177 ptrdiff_t, bool);
3178 extern void init_editfns (void);
3179 extern void syms_of_editfns (void);
3180 extern void set_time_zone_rule (const char *);
3182 /* Defined in buffer.c. */
3183 extern bool mouse_face_overlay_overlaps (Lisp_Object);
3184 extern _Noreturn void nsberror (Lisp_Object);
3185 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3186 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3187 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3188 extern void report_overlay_modification (Lisp_Object, Lisp_Object, bool,
3189 Lisp_Object, Lisp_Object, Lisp_Object);
3190 extern bool overlay_touches_p (ptrdiff_t);
3191 extern Lisp_Object Vbuffer_alist;
3192 extern Lisp_Object set_buffer_if_live (Lisp_Object);
3193 extern Lisp_Object other_buffer_safely (Lisp_Object);
3194 extern Lisp_Object Qpriority, Qwindow, Qbefore_string, Qafter_string;
3195 extern Lisp_Object get_truename_buffer (Lisp_Object);
3196 extern void init_buffer_once (void);
3197 extern void init_buffer (void);
3198 extern void syms_of_buffer (void);
3199 extern void keys_of_buffer (void);
3201 /* Defined in marker.c. */
3203 extern ptrdiff_t marker_position (Lisp_Object);
3204 extern ptrdiff_t marker_byte_position (Lisp_Object);
3205 extern void clear_charpos_cache (struct buffer *);
3206 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
3207 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer *, ptrdiff_t);
3208 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer *, ptrdiff_t);
3209 extern void unchain_marker (struct Lisp_Marker *marker);
3210 extern Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object);
3211 extern Lisp_Object set_marker_both (Lisp_Object, Lisp_Object, ptrdiff_t, ptrdiff_t);
3212 extern Lisp_Object set_marker_restricted_both (Lisp_Object, Lisp_Object,
3213 ptrdiff_t, ptrdiff_t);
3214 extern Lisp_Object build_marker (struct buffer *, ptrdiff_t, ptrdiff_t);
3215 extern void syms_of_marker (void);
3217 /* Defined in fileio.c. */
3219 extern Lisp_Object Qfile_error;
3220 extern Lisp_Object Qfile_exists_p;
3221 extern Lisp_Object Qfile_directory_p;
3222 extern Lisp_Object Qinsert_file_contents;
3223 extern Lisp_Object Qfile_name_history;
3224 extern Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object);
3225 EXFUN (Fread_file_name, 6); /* Not a normal DEFUN. */
3226 extern Lisp_Object close_file_unwind (Lisp_Object);
3227 extern Lisp_Object restore_point_unwind (Lisp_Object);
3228 extern _Noreturn void report_file_error (const char *, Lisp_Object);
3229 extern void internal_delete_file (Lisp_Object);
3230 extern void syms_of_fileio (void);
3231 extern Lisp_Object make_temp_name (Lisp_Object, bool);
3232 extern Lisp_Object Qdelete_file;
3233 extern bool check_existing (const char *);
3235 /* Defined in search.c. */
3236 extern void shrink_regexp_cache (void);
3237 extern void restore_search_regs (void);
3238 extern void record_unwind_save_match_data (void);
3239 struct re_registers;
3240 extern struct re_pattern_buffer *compile_pattern (Lisp_Object,
3241 struct re_registers *,
3242 Lisp_Object, int, int);
3243 extern ptrdiff_t fast_string_match (Lisp_Object, Lisp_Object);
3244 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object, const char *,
3245 ptrdiff_t);
3246 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object, Lisp_Object);
3247 extern ptrdiff_t fast_looking_at (Lisp_Object, ptrdiff_t, ptrdiff_t,
3248 ptrdiff_t, ptrdiff_t, Lisp_Object);
3249 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3250 ptrdiff_t *, bool);
3251 extern EMACS_INT scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3252 EMACS_INT, bool);
3253 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
3254 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
3255 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3256 extern void syms_of_search (void);
3257 extern void clear_regexp_cache (void);
3259 /* Defined in minibuf.c. */
3261 extern Lisp_Object Qcompletion_ignore_case;
3262 extern Lisp_Object Vminibuffer_list;
3263 extern Lisp_Object last_minibuf_string;
3264 extern Lisp_Object get_minibuffer (EMACS_INT);
3265 extern void init_minibuf_once (void);
3266 extern void syms_of_minibuf (void);
3268 /* Defined in callint.c. */
3270 extern Lisp_Object Qminus, Qplus;
3271 extern Lisp_Object Qwhen;
3272 extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
3273 extern void syms_of_callint (void);
3275 /* Defined in casefiddle.c. */
3277 extern Lisp_Object Qidentity;
3278 extern void syms_of_casefiddle (void);
3279 extern void keys_of_casefiddle (void);
3281 /* Defined in casetab.c. */
3283 extern void init_casetab_once (void);
3284 extern void syms_of_casetab (void);
3286 /* Defined in keyboard.c. */
3288 extern Lisp_Object echo_message_buffer;
3289 extern struct kboard *echo_kboard;
3290 extern void cancel_echoing (void);
3291 extern Lisp_Object Qdisabled, QCfilter;
3292 extern Lisp_Object Qup, Qdown, Qbottom;
3293 extern Lisp_Object Qtop;
3294 extern Lisp_Object last_undo_boundary;
3295 extern bool input_pending;
3296 extern Lisp_Object menu_bar_items (Lisp_Object);
3297 extern Lisp_Object tool_bar_items (Lisp_Object, int *);
3298 extern void discard_mouse_events (void);
3299 #ifdef USABLE_SIGIO
3300 void handle_input_available_signal (int);
3301 #endif
3302 extern Lisp_Object pending_funcalls;
3303 extern bool detect_input_pending (void);
3304 extern bool detect_input_pending_ignore_squeezables (void);
3305 extern bool detect_input_pending_run_timers (bool);
3306 extern void safe_run_hooks (Lisp_Object);
3307 extern void cmd_error_internal (Lisp_Object, const char *);
3308 extern Lisp_Object command_loop_1 (void);
3309 extern Lisp_Object recursive_edit_1 (void);
3310 extern void record_auto_save (void);
3311 extern void force_auto_save_soon (void);
3312 extern void init_keyboard (void);
3313 extern void syms_of_keyboard (void);
3314 extern void keys_of_keyboard (void);
3316 /* Defined in indent.c. */
3317 extern ptrdiff_t current_column (void);
3318 extern void invalidate_current_column (void);
3319 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT);
3320 extern void syms_of_indent (void);
3322 /* Defined in frame.c. */
3323 extern Lisp_Object Qonly, Qnone;
3324 extern Lisp_Object Qvisible;
3325 extern void store_frame_param (struct frame *, Lisp_Object, Lisp_Object);
3326 extern void store_in_alist (Lisp_Object *, Lisp_Object, Lisp_Object);
3327 extern Lisp_Object do_switch_frame (Lisp_Object, int, int, Lisp_Object);
3328 #if HAVE_NS
3329 extern Lisp_Object get_frame_param (struct frame *, Lisp_Object);
3330 #endif
3331 extern Lisp_Object frame_buffer_predicate (Lisp_Object);
3332 extern void frames_discard_buffer (Lisp_Object);
3333 extern void syms_of_frame (void);
3335 /* Defined in emacs.c. */
3336 extern char **initial_argv;
3337 extern int initial_argc;
3338 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3339 extern bool display_arg;
3340 #endif
3341 extern Lisp_Object decode_env_path (const char *, const char *);
3342 extern Lisp_Object empty_unibyte_string, empty_multibyte_string;
3343 extern Lisp_Object Qfile_name_handler_alist;
3344 extern _Noreturn void terminate_due_to_signal (int, int);
3345 extern Lisp_Object Qkill_emacs;
3346 #ifdef WINDOWSNT
3347 extern Lisp_Object Vlibrary_cache;
3348 #endif
3349 #if HAVE_SETLOCALE
3350 void fixup_locale (void);
3351 void synchronize_system_messages_locale (void);
3352 void synchronize_system_time_locale (void);
3353 #else
3354 #define setlocale(category, locale)
3355 #define fixup_locale()
3356 #define synchronize_system_messages_locale()
3357 #define synchronize_system_time_locale()
3358 #endif
3359 extern void shut_down_emacs (int, Lisp_Object);
3361 /* True means don't do interactive redisplay and don't change tty modes. */
3362 extern bool noninteractive;
3364 /* True means remove site-lisp directories from load-path. */
3365 extern bool no_site_lisp;
3367 /* Pipe used to send exit notification to the daemon parent at
3368 startup. */
3369 extern int daemon_pipe[2];
3370 #define IS_DAEMON (daemon_pipe[1] != 0)
3372 /* True if handling a fatal error already. */
3373 extern bool fatal_error_in_progress;
3375 /* True means don't do use window-system-specific display code. */
3376 extern bool inhibit_window_system;
3377 /* True means that a filter or a sentinel is running. */
3378 extern bool running_asynch_code;
3380 /* Defined in process.c. */
3381 extern Lisp_Object QCtype, Qlocal;
3382 extern Lisp_Object Qprocessp;
3383 extern void kill_buffer_processes (Lisp_Object);
3384 extern int wait_reading_process_output (intmax_t, int, int, bool,
3385 Lisp_Object,
3386 struct Lisp_Process *,
3387 int);
3388 /* Max value for the first argument of wait_reading_process_output. */
3389 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3390 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3391 The bug merely causes a bogus warning, but the warning is annoying. */
3392 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3393 #else
3394 # define WAIT_READING_MAX INTMAX_MAX
3395 #endif
3396 extern void add_keyboard_wait_descriptor (int);
3397 extern void delete_keyboard_wait_descriptor (int);
3398 #ifdef HAVE_GPM
3399 extern void add_gpm_wait_descriptor (int);
3400 extern void delete_gpm_wait_descriptor (int);
3401 #endif
3402 extern void close_process_descs (void);
3403 extern void init_process_emacs (void);
3404 extern void syms_of_process (void);
3405 extern void setup_process_coding_systems (Lisp_Object);
3407 #ifndef DOS_NT
3408 _Noreturn
3409 #endif
3410 extern int child_setup (int, int, int, char **, bool, Lisp_Object);
3411 extern void init_callproc_1 (void);
3412 extern void init_callproc (void);
3413 extern void set_initial_environment (void);
3414 extern void syms_of_callproc (void);
3416 /* Defined in doc.c. */
3417 extern Lisp_Object Qfunction_documentation;
3418 extern Lisp_Object read_doc_string (Lisp_Object);
3419 extern Lisp_Object get_doc_string (Lisp_Object, bool, bool);
3420 extern void syms_of_doc (void);
3421 extern int read_bytecode_char (bool);
3423 /* Defined in bytecode.c. */
3424 extern Lisp_Object Qbytecode;
3425 extern void syms_of_bytecode (void);
3426 extern struct byte_stack *byte_stack_list;
3427 #if BYTE_MARK_STACK
3428 extern void mark_byte_stack (void);
3429 #endif
3430 extern void unmark_byte_stack (void);
3431 extern Lisp_Object exec_byte_code (Lisp_Object, Lisp_Object, Lisp_Object,
3432 Lisp_Object, ptrdiff_t, Lisp_Object *);
3434 /* Defined in macros.c. */
3435 extern Lisp_Object Qexecute_kbd_macro;
3436 extern void init_macros (void);
3437 extern void syms_of_macros (void);
3439 /* Defined in undo.c. */
3440 extern Lisp_Object Qapply;
3441 extern Lisp_Object Qinhibit_read_only;
3442 extern void truncate_undo_list (struct buffer *);
3443 extern void record_marker_adjustment (Lisp_Object, ptrdiff_t);
3444 extern void record_insert (ptrdiff_t, ptrdiff_t);
3445 extern void record_delete (ptrdiff_t, Lisp_Object);
3446 extern void record_first_change (void);
3447 extern void record_change (ptrdiff_t, ptrdiff_t);
3448 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3449 Lisp_Object, Lisp_Object,
3450 Lisp_Object);
3451 extern void syms_of_undo (void);
3452 /* Defined in textprop.c. */
3453 extern Lisp_Object Qfont, Qmouse_face;
3454 extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
3455 extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
3456 extern Lisp_Object Qminibuffer_prompt;
3458 extern void report_interval_modification (Lisp_Object, Lisp_Object);
3460 /* Defined in menu.c. */
3461 extern void syms_of_menu (void);
3463 /* Defined in xmenu.c. */
3464 extern void syms_of_xmenu (void);
3466 /* Defined in termchar.h. */
3467 struct tty_display_info;
3469 /* Defined in termhooks.h. */
3470 struct terminal;
3472 /* Defined in sysdep.c. */
3473 #ifndef HAVE_GET_CURRENT_DIR_NAME
3474 extern char *get_current_dir_name (void);
3475 #endif
3476 extern void stuff_char (char c);
3477 extern void init_foreground_group (void);
3478 extern void init_sigio (int);
3479 extern void sys_subshell (void);
3480 extern void sys_suspend (void);
3481 extern void discard_tty_input (void);
3482 extern void init_sys_modes (struct tty_display_info *);
3483 extern void reset_sys_modes (struct tty_display_info *);
3484 extern void init_all_sys_modes (void);
3485 extern void reset_all_sys_modes (void);
3486 extern void flush_pending_output (int) ATTRIBUTE_CONST;
3487 extern void child_setup_tty (int);
3488 extern void setup_pty (int);
3489 extern int set_window_size (int, int, int);
3490 extern EMACS_INT get_random (void);
3491 extern void seed_random (void *, ptrdiff_t);
3492 extern void init_random (void);
3493 extern void emacs_backtrace (int);
3494 extern _Noreturn void emacs_abort (void) NO_INLINE;
3495 extern int emacs_open (const char *, int, int);
3496 extern int emacs_close (int);
3497 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3498 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3499 enum { READLINK_BUFSIZE = 1024 };
3500 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE]);
3502 extern void unlock_all_files (void);
3503 extern void lock_file (Lisp_Object);
3504 extern void unlock_file (Lisp_Object);
3505 extern void unlock_buffer (struct buffer *);
3506 extern void syms_of_filelock (void);
3508 /* Defined in sound.c. */
3509 extern void syms_of_sound (void);
3511 /* Defined in category.c. */
3512 extern void init_category_once (void);
3513 extern Lisp_Object char_category_set (int);
3514 extern void syms_of_category (void);
3516 /* Defined in ccl.c. */
3517 extern void syms_of_ccl (void);
3519 /* Defined in dired.c. */
3520 extern void syms_of_dired (void);
3521 extern Lisp_Object directory_files_internal (Lisp_Object, Lisp_Object,
3522 Lisp_Object, Lisp_Object,
3523 bool, Lisp_Object);
3525 /* Defined in term.c. */
3526 extern int *char_ins_del_vector;
3527 extern void syms_of_term (void);
3528 extern _Noreturn void fatal (const char *msgid, ...)
3529 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3531 /* Defined in terminal.c. */
3532 extern void syms_of_terminal (void);
3534 /* Defined in font.c. */
3535 extern void syms_of_font (void);
3536 extern void init_font (void);
3538 #ifdef HAVE_WINDOW_SYSTEM
3539 /* Defined in fontset.c. */
3540 extern void syms_of_fontset (void);
3542 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3543 extern Lisp_Object Qfont_param;
3544 #endif
3546 /* Defined in xfaces.c. */
3547 extern Lisp_Object Qdefault, Qtool_bar, Qfringe;
3548 extern Lisp_Object Qheader_line, Qscroll_bar, Qcursor;
3549 extern Lisp_Object Qmode_line_inactive;
3550 extern Lisp_Object Qface;
3551 extern Lisp_Object Qnormal;
3552 extern Lisp_Object QCfamily, QCweight, QCslant;
3553 extern Lisp_Object QCheight, QCname, QCwidth, QCforeground, QCbackground;
3554 extern Lisp_Object Qextra_light, Qlight, Qsemi_light, Qsemi_bold;
3555 extern Lisp_Object Qbold, Qextra_bold, Qultra_bold;
3556 extern Lisp_Object Qoblique, Qitalic;
3557 extern Lisp_Object Vface_alternative_font_family_alist;
3558 extern Lisp_Object Vface_alternative_font_registry_alist;
3559 extern void syms_of_xfaces (void);
3561 #ifdef HAVE_X_WINDOWS
3562 /* Defined in xfns.c. */
3563 extern void syms_of_xfns (void);
3565 /* Defined in xsmfns.c. */
3566 extern void syms_of_xsmfns (void);
3568 /* Defined in xselect.c. */
3569 extern void syms_of_xselect (void);
3571 /* Defined in xterm.c. */
3572 extern void syms_of_xterm (void);
3573 #endif /* HAVE_X_WINDOWS */
3575 #ifdef HAVE_WINDOW_SYSTEM
3576 /* Defined in xterm.c, nsterm.m, w32term.c. */
3577 extern char *x_get_keysym_name (int);
3578 #endif /* HAVE_WINDOW_SYSTEM */
3580 #ifdef HAVE_LIBXML2
3581 /* Defined in xml.c. */
3582 extern void syms_of_xml (void);
3583 extern void xml_cleanup_parser (void);
3584 #endif
3586 #ifdef HAVE_MENUS
3587 /* Defined in (x|w32)fns.c, nsfns.m... */
3588 extern int have_menus_p (void);
3589 #endif
3591 #ifdef HAVE_DBUS
3592 /* Defined in dbusbind.c. */
3593 void syms_of_dbusbind (void);
3594 #endif
3597 /* Defined in profiler.c. */
3598 extern bool profiler_memory_running;
3599 extern void malloc_probe (size_t);
3600 extern void syms_of_profiler (void);
3603 #ifdef DOS_NT
3604 /* Defined in msdos.c, w32.c. */
3605 extern char *emacs_root_dir (void);
3606 #endif /* DOS_NT */
3608 /* True means Emacs has already been initialized.
3609 Used during startup to detect startup of dumped Emacs. */
3610 extern bool initialized;
3612 /* True means ^G can quit instantly. */
3613 extern bool immediate_quit;
3615 extern void *xmalloc (size_t);
3616 extern void *xzalloc (size_t);
3617 extern void *xrealloc (void *, size_t);
3618 extern void xfree (void *);
3619 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3620 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3621 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3623 extern char *xstrdup (const char *);
3625 extern char *egetenv (const char *);
3627 /* Set up the name of the machine we're running on. */
3628 extern void init_system_name (void);
3630 /* We used to use `abs', but that clashes with system headers on some
3631 platforms, and using a name reserved by Standard C is a bad idea
3632 anyway. */
3633 #if !defined (eabs)
3634 #define eabs(x) ((x) < 0 ? -(x) : (x))
3635 #endif
3637 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3638 fixnum. */
3640 #define make_fixnum_or_float(val) \
3641 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3643 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3644 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3646 enum MAX_ALLOCA { MAX_ALLOCA = 16 * 1024 };
3648 extern Lisp_Object safe_alloca_unwind (Lisp_Object);
3649 extern void *record_xmalloc (size_t);
3651 #define USE_SAFE_ALLOCA \
3652 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
3654 /* SAFE_ALLOCA allocates a simple buffer. */
3656 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3657 ? alloca (size) \
3658 : (sa_must_free = 1, record_xmalloc (size)))
3660 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3661 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3662 positive. The code is tuned for MULTIPLIER being a constant. */
3664 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3665 do { \
3666 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3667 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3668 else \
3670 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3671 sa_must_free = 1; \
3672 record_unwind_protect (safe_alloca_unwind, \
3673 make_save_value (buf, 0)); \
3675 } while (0)
3677 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3679 #define SAFE_FREE() \
3680 do { \
3681 if (sa_must_free) { \
3682 sa_must_free = 0; \
3683 unbind_to (sa_count, Qnil); \
3685 } while (0)
3688 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3690 #define SAFE_ALLOCA_LISP(buf, nelt) \
3691 do { \
3692 if ((nelt) < MAX_ALLOCA / word_size) \
3693 buf = alloca ((nelt) * word_size); \
3694 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3696 Lisp_Object arg_; \
3697 buf = xmalloc ((nelt) * word_size); \
3698 arg_ = make_save_value (buf, nelt); \
3699 XSAVE_VALUE (arg_)->dogc = 1; \
3700 sa_must_free = 1; \
3701 record_unwind_protect (safe_alloca_unwind, arg_); \
3703 else \
3704 memory_full (SIZE_MAX); \
3705 } while (0)
3708 #include "globals.h"
3710 /* Check whether it's time for GC, and run it if so. */
3712 LISP_INLINE void
3713 maybe_gc (void)
3715 if ((consing_since_gc > gc_cons_threshold
3716 && consing_since_gc > gc_relative_threshold)
3717 || (!NILP (Vmemory_full)
3718 && consing_since_gc > memory_full_cons_threshold))
3719 Fgarbage_collect ();
3722 LISP_INLINE int
3723 functionp (Lisp_Object object)
3725 if (SYMBOLP (object) && !NILP (Ffboundp (object)))
3727 object = Findirect_function (object, Qt);
3729 if (CONSP (object) && EQ (XCAR (object), Qautoload))
3731 /* Autoloaded symbols are functions, except if they load
3732 macros or keymaps. */
3733 int i;
3734 for (i = 0; i < 4 && CONSP (object); i++)
3735 object = XCDR (object);
3737 return ! (CONSP (object) && !NILP (XCAR (object)));
3741 if (SUBRP (object))
3742 return XSUBR (object)->max_args != UNEVALLED;
3743 else if (COMPILEDP (object))
3744 return 1;
3745 else if (CONSP (object))
3747 Lisp_Object car = XCAR (object);
3748 return EQ (car, Qlambda) || EQ (car, Qclosure);
3750 else
3751 return 0;
3754 INLINE_HEADER_END
3756 #endif /* EMACS_LISP_H */