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/>. */
30 /* Use the configure flag --enable-checking[=LIST] to enable various
31 types of run time checks for Lisp objects. */
33 #ifdef GC_CHECK_CONS_LIST
34 extern void check_cons_list (void);
35 #define CHECK_CONS_LIST() check_cons_list ()
37 #define CHECK_CONS_LIST() ((void) 0)
40 /* Temporarily disable wider-than-pointer integers until they're tested more.
41 Build with CFLAGS='-DWIDE_EMACS_INT' to try them out. */
42 /* #undef WIDE_EMACS_INT */
44 /* EMACS_INT - signed integer wide enough to hold an Emacs value
45 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
46 pI - printf length modifier for EMACS_INT
47 EMACS_UINT - unsigned variant of EMACS_INT */
49 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
50 # define EMACS_INT long long
51 # define EMACS_INT_MAX LLONG_MAX
53 # elif INT_MAX < LONG_MAX
54 # define EMACS_INT long
55 # define EMACS_INT_MAX LONG_MAX
58 # define EMACS_INT int
59 # define EMACS_INT_MAX INT_MAX
63 #define EMACS_UINT unsigned EMACS_INT
65 /* Number of bits in some machine integer types. */
68 BITS_PER_CHAR
= CHAR_BIT
,
69 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
70 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
71 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
72 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
75 /* printmax_t and uprintmax_t are types for printing large integers.
76 These are the widest integers that are supported for printing.
77 pMd etc. are conversions for printing them.
78 On C99 hosts, there's no problem, as even the widest integers work.
79 Fall back on EMACS_INT on pre-C99 hosts. */
81 typedef intmax_t printmax_t
;
82 typedef uintmax_t uprintmax_t
;
86 typedef EMACS_INT printmax_t
;
87 typedef EMACS_UINT uprintmax_t
;
92 /* Use pD to format ptrdiff_t values, which suffice for indexes into
93 buffers and strings. Emacs never allocates objects larger than
94 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
95 In C99, pD can always be "t"; configure it here for the sake of
96 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
97 #if PTRDIFF_MAX == INT_MAX
99 #elif PTRDIFF_MAX == LONG_MAX
101 #elif PTRDIFF_MAX == LLONG_MAX
107 /* Extra internal type checking? */
109 /* Define an Emacs version of 'assert (COND)', since some
110 system-defined 'assert's are flaky. COND should be free of side
111 effects; it may or may not be evaluated. */
112 #ifndef ENABLE_CHECKING
113 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
114 #else /* ENABLE_CHECKING */
116 extern _Noreturn
void die (const char *, const char *, int);
118 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
119 it to 1 using a debugger to temporarily disable aborting on
120 detected internal inconsistencies or error conditions.
122 In some cases, a good compiler may be able to optimize away the
123 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
124 STRINGP (x), but a particular use of XSTRING is invoked only after
125 testing that STRINGP (x) is true, making the test redundant. */
126 extern int suppress_checking EXTERNALLY_VISIBLE
;
128 # define eassert(cond) \
129 ((cond) || suppress_checking \
131 : die ("assertion failed: " # cond, __FILE__, __LINE__))
132 #endif /* ENABLE_CHECKING */
134 /* Use the configure flag --enable-check-lisp-object-type to make
135 Lisp_Object use a struct type instead of the default int. The flag
136 causes CHECK_LISP_OBJECT_TYPE to be defined. */
138 /***** Select the tagging scheme. *****/
139 /* The following option controls the tagging scheme:
140 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
141 always 0, and we can thus use them to hold tag bits, without
142 restricting our addressing space.
144 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
145 restricting our possible address range.
147 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
148 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
149 on the few static Lisp_Objects used: all the defsubr as well
150 as the two special buffers buffer_defaults and buffer_local_symbols. */
152 /* First, try and define DECL_ALIGN(type,var) which declares a static
153 variable VAR of type TYPE with the added requirement that it be
157 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
159 /* The maximum value that can be stored in a EMACS_INT, assuming all
160 bits other than the type bits contribute to a nonnegative signed value.
161 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
162 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
164 #ifndef NO_DECL_ALIGN
166 # if HAVE_ATTRIBUTE_ALIGNED
167 # define DECL_ALIGN(type, var) \
168 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
169 # elif defined(_MSC_VER)
170 # define ALIGN_GCTYPEBITS 8
171 # if (1 << GCTYPEBITS) != ALIGN_GCTYPEBITS
172 # error ALIGN_GCTYPEBITS is wrong!
174 # define DECL_ALIGN(type, var) \
175 type __declspec(align(ALIGN_GCTYPEBITS)) var
177 /* What directives do other compilers use? */
182 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
184 /* 1. We know malloc returns a multiple of 8. */
185 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
186 || defined DARWIN_OS || defined __sun)
187 /* 2. We can specify multiple-of-8 alignment on static variables. */
189 /* 3. Pointers-as-ints exceed VAL_MAX.
190 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
191 a. unnecessary, because the top bits of an EMACS_INT are unused, and
192 b. slower, because it typically requires extra masking.
193 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
194 # if VAL_MAX < UINTPTR_MAX
195 # define USE_LSB_TAG 1
201 # define USE_LSB_TAG 0
204 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
207 # error "USE_LSB_TAG used without defining DECL_ALIGN"
209 # define DECL_ALIGN(type, var) type var
213 /* Define the fundamental Lisp data structures. */
215 /* This is the set of Lisp data types. */
217 /* Lisp integers use 2 tags, to give them one extra bit, thus
218 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
219 #define INTTYPEBITS (GCTYPEBITS - 1)
220 #define FIXNUM_BITS (VALBITS + 1)
221 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
222 #define LISP_INT_TAG Lisp_Int0
223 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
224 #define LISP_INT1_TAG (USE_LSB_TAG ? 1 << INTTYPEBITS : 1)
225 #define LISP_STRING_TAG (5 - LISP_INT1_TAG)
226 #define LISP_INT_TAG_P(x) (((x) & ~LISP_INT1_TAG) == 0)
228 /* Stolen from GDB. The only known compiler that doesn't support
229 enums in bitfields is MSVC. */
231 #define ENUM_BF(TYPE) unsigned int
233 #define ENUM_BF(TYPE) enum TYPE
239 /* Integer. XINT (obj) is the integer value. */
241 Lisp_Int1
= LISP_INT1_TAG
,
243 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
246 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
247 whose first member indicates the subtype. */
250 /* String. XSTRING (object) points to a struct Lisp_String.
251 The length of the string, and its contents, are stored therein. */
252 Lisp_String
= LISP_STRING_TAG
,
254 /* Vector of Lisp objects, or something resembling it.
255 XVECTOR (object) points to a struct Lisp_Vector, which contains
256 the size and contents. The size field also contains the type
257 information, if it's not a real vector object. */
260 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
266 /* This is the set of data types that share a common structure.
267 The first member of the structure is a type code from this set.
268 The enum values are arbitrary, but we'll use large numbers to make it
269 more likely that we'll spot the error if a random word in memory is
270 mistakenly interpreted as a Lisp_Misc. */
273 Lisp_Misc_Free
= 0x5eab,
276 Lisp_Misc_Save_Value
,
277 /* Currently floats are not a misc type,
278 but let's define this in case we want to change that. */
280 /* This is not a type code. It is for range checking. */
284 /* These are the types of forwarding objects used in the value slot
285 of symbols for special built-in variables whose value is stored in
289 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
290 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
291 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
292 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
293 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
296 #ifdef CHECK_LISP_OBJECT_TYPE
298 typedef struct { EMACS_INT i
; } Lisp_Object
;
301 static inline Lisp_Object
304 Lisp_Object o
= { i
};
308 static inline Lisp_Object
309 LISP_MAKE_RVALUE (Lisp_Object o
)
314 #define LISP_INITIALLY_ZERO {0}
316 #else /* CHECK_LISP_OBJECT_TYPE */
318 /* If a struct type is not wanted, define Lisp_Object as just a number. */
320 typedef EMACS_INT Lisp_Object
;
323 #define LISP_MAKE_RVALUE(o) (0+(o))
324 #define LISP_INITIALLY_ZERO 0
325 #endif /* CHECK_LISP_OBJECT_TYPE */
327 /* In the size word of a vector, this bit means the vector has been marked. */
329 #define ARRAY_MARK_FLAG PTRDIFF_MIN
331 /* In the size word of a struct Lisp_Vector, this bit means it's really
332 some other vector-like object. */
333 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
335 /* In a pseudovector, the size field actually contains a word with one
336 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
337 indicate the actual type.
338 We use a bitset, even tho only one of the bits can be set at any
339 particular time just so as to be able to use micro-optimizations such as
340 testing membership of a particular subset of pseudovectors in Fequal.
341 It is not crucial, but there are plenty of bits here, so why not do it? */
344 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
353 PVEC_WINDOW_CONFIGURATION
,
356 /* These last 4 are special because we OR them in fns.c:internal_equal,
357 so they have to use a disjoint bit pattern:
358 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
359 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
360 PVEC_COMPILED
= 0x10,
361 PVEC_CHAR_TABLE
= 0x20,
362 PVEC_SUB_CHAR_TABLE
= 0x30,
366 /* For convenience, we also store the number of elements in these bits.
367 Note that this size is not necessarily the memory-footprint size, but
368 only the number of Lisp_Object fields (that need to be traced by the GC).
369 The distinction is used e.g. by Lisp_Process which places extra
370 non-Lisp_Object fields at the end of the structure. */
371 #define PSEUDOVECTOR_SIZE_BITS 16
372 #define PSEUDOVECTOR_SIZE_MASK ((1 << PSEUDOVECTOR_SIZE_BITS) - 1)
373 #define PVEC_TYPE_MASK (0x0fff << PSEUDOVECTOR_SIZE_BITS)
375 /* Number of bits to put in each character in the internal representation
376 of bool vectors. This should not vary across implementations. */
377 #define BOOL_VECTOR_BITS_PER_CHAR 8
379 /* These macros extract various sorts of values from a Lisp_Object.
380 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
381 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
383 /* Return a perfect hash of the Lisp_Object representation. */
384 #define XHASH(a) XLI (a)
388 #define TYPEMASK ((1 << GCTYPEBITS) - 1)
389 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
390 #define XINT(a) (XLI (a) >> INTTYPEBITS)
391 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
392 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
393 #define XSET(var, type, ptr) \
394 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
395 (var) = XIL ((type) | (intptr_t) (ptr)))
397 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
398 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
400 #else /* not USE_LSB_TAG */
402 #define VALMASK VAL_MAX
404 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
406 /* For integers known to be positive, XFASTINT provides fast retrieval
407 and XSETFASTINT provides fast storage. This takes advantage of the
408 fact that Lisp integers have zero-bits in their tags. */
409 #define XFASTINT(a) (XLI (a) + 0)
410 #define XSETFASTINT(a, b) ((a) = XIL (b))
412 /* Extract the value of a Lisp_Object as a (un)signed integer. */
414 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
415 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
416 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
418 #define XSET(var, type, ptr) \
419 ((var) = XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
420 + ((intptr_t) (ptr) & VALMASK)))
423 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
424 which were stored in a Lisp_Object */
425 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
427 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
430 #endif /* not USE_LSB_TAG */
432 /* For integers known to be positive, XFASTINT sometimes provides
433 faster retrieval and XSETFASTINT provides faster storage.
434 If not, fallback on the non-accelerated path. */
436 # define XFASTINT(a) (XINT (a))
437 # define XSETFASTINT(a, b) (XSETINT (a, b))
440 /* Extract the pointer value of the Lisp object A, under the
441 assumption that A's type is TYPE. This is a fallback
442 implementation if nothing faster is available. */
444 # define XUNTAG(a, type) XPNTR (a)
447 #define EQ(x, y) (XHASH (x) == XHASH (y))
449 /* Largest and smallest representable fixnum values. These are the C
451 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
452 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
454 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
455 written this way so that it also works if I is of unsigned
456 type or if I is a NaN. */
458 #define FIXNUM_OVERFLOW_P(i) \
459 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
461 static inline ptrdiff_t
462 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
464 return num
< lower
? lower
: num
<= upper
? num
: upper
;
467 /* Extract a value or address from a Lisp_Object. */
469 #define XCONS(a) (eassert (CONSP (a)), \
470 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
471 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
472 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
473 #define XSTRING(a) (eassert (STRINGP (a)), \
474 (struct Lisp_String *) XUNTAG (a, Lisp_String))
475 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
476 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
477 #define XFLOAT(a) (eassert (FLOATP (a)), \
478 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
482 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
483 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
484 #define XMISCTYPE(a) (XMISCANY (a)->type)
485 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
486 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
487 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
489 /* Forwarding object types. */
491 #define XFWDTYPE(a) (a->u_intfwd.type)
492 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
493 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
494 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
495 #define XBUFFER_OBJFWD(a) \
496 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
497 #define XKBOARD_OBJFWD(a) \
498 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
500 /* Pseudovector types. */
502 #define XPROCESS(a) (eassert (PROCESSP (a)), \
503 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
504 #define XWINDOW(a) (eassert (WINDOWP (a)), \
505 (struct window *) XUNTAG (a, Lisp_Vectorlike))
506 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
507 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
508 #define XSUBR(a) (eassert (SUBRP (a)), \
509 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
510 #define XBUFFER(a) (eassert (BUFFERP (a)), \
511 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
512 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
513 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
514 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
515 ((struct Lisp_Sub_Char_Table *) \
516 XUNTAG (a, Lisp_Vectorlike)))
517 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
518 ((struct Lisp_Bool_Vector *) \
519 XUNTAG (a, Lisp_Vectorlike)))
521 /* Construct a Lisp_Object from a value or address. */
523 #define XSETINT(a, b) (a) = make_number (b)
524 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
525 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
526 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
527 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
528 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
532 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
533 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
535 /* Pseudovector types. */
537 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
538 #define XSETTYPED_PVECTYPE(v, size_member, code) \
539 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
540 #define XSETPVECTYPESIZE(v, code, sizeval) \
541 ((v)->header.size = (PSEUDOVECTOR_FLAG \
542 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
545 /* The cast to struct vectorlike_header * avoids aliasing issues. */
546 #define XSETPSEUDOVECTOR(a, b, code) \
547 XSETTYPED_PSEUDOVECTOR (a, b, \
548 (((struct vectorlike_header *) \
549 XUNTAG (a, Lisp_Vectorlike)) \
552 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
553 (XSETVECTOR (a, b), \
554 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
555 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
557 #define XSETWINDOW_CONFIGURATION(a, b) \
558 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
559 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
560 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
561 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
562 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
563 #define XSETSUBR(a, b) \
564 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
565 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
566 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
567 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
568 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
569 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
571 /* Convenience macros for dealing with Lisp arrays. */
573 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
574 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
575 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
576 #define ASET(ARRAY, IDX, VAL) \
577 (eassert ((IDX) == (IDX)), \
578 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
579 AREF ((ARRAY), (IDX)) = (VAL))
581 /* Convenience macros for dealing with Lisp strings. */
583 #define SDATA(string) (XSTRING (string)->data + 0)
584 #define SREF(string, index) (SDATA (string)[index] + 0)
585 #define SSET(string, index, new) (SDATA (string)[index] = (new))
586 #define SCHARS(string) (XSTRING (string)->size + 0)
587 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
589 /* Avoid "differ in sign" warnings. */
590 #define SSDATA(x) ((char *) SDATA (x))
592 #define STRING_SET_CHARS(string, newsize) \
593 (XSTRING (string)->size = (newsize))
595 #define STRING_COPYIN(string, index, new, count) \
596 memcpy (SDATA (string) + index, new, count)
600 #define CHECK_TYPE(ok, Qxxxp, x) \
601 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
605 /* See the macros in intervals.h. */
607 typedef struct interval
*INTERVAL
;
609 /* Complain if object is not string or buffer type */
610 #define CHECK_STRING_OR_BUFFER(x) \
611 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
614 /* In a cons, the markbit of the car is the gc mark bit */
618 /* Please do not use the names of these elements in code other
619 than the core lisp implementation. Use XCAR and XCDR below. */
620 #ifdef HIDE_LISP_IMPLEMENTATION
625 struct Lisp_Cons
*chain
;
632 struct Lisp_Cons
*chain
;
637 /* Take the car or cdr of something known to be a cons cell. */
638 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
639 of code that has to know what a cons cell looks like. Other code not
640 part of the basic lisp implementation should assume that the car and cdr
641 fields are not accessible as lvalues. (What if we want to switch to
642 a copying collector someday? Cached cons cell field addresses may be
643 invalidated at arbitrary points.) */
644 #ifdef HIDE_LISP_IMPLEMENTATION
645 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
646 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
648 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
649 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
652 /* Use these from normal code. */
653 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
654 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
656 /* Use these to set the fields of a cons cell.
658 Note that both arguments may refer to the same object, so 'n'
659 should not be read after 'c' is first modified. Also, neither
660 argument should be evaluated more than once; side effects are
661 especially common in the second argument. */
662 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
663 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
665 /* Take the car or cdr of something whose type is not known. */
667 (CONSP ((c)) ? XCAR ((c)) \
668 : NILP ((c)) ? Qnil \
669 : wrong_type_argument (Qlistp, (c)))
672 (CONSP ((c)) ? XCDR ((c)) \
673 : NILP ((c)) ? Qnil \
674 : wrong_type_argument (Qlistp, (c)))
676 /* Take the car or cdr of something whose type is not known. */
677 #define CAR_SAFE(c) \
678 (CONSP ((c)) ? XCAR ((c)) : Qnil)
680 #define CDR_SAFE(c) \
681 (CONSP ((c)) ? XCDR ((c)) : Qnil)
683 /* Nonzero if STR is a multibyte string. */
684 #define STRING_MULTIBYTE(STR) \
685 (XSTRING (STR)->size_byte >= 0)
687 /* Return the length in bytes of STR. */
689 #ifdef GC_CHECK_STRING_BYTES
692 extern ptrdiff_t string_bytes (struct Lisp_String
*);
693 #define STRING_BYTES(S) string_bytes ((S))
695 #else /* not GC_CHECK_STRING_BYTES */
697 #define STRING_BYTES(STR) \
698 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
700 #endif /* not GC_CHECK_STRING_BYTES */
702 /* An upper bound on the number of bytes in a Lisp string, not
703 counting the terminating null. This a tight enough bound to
704 prevent integer overflow errors that would otherwise occur during
705 string size calculations. A string cannot contain more bytes than
706 a fixnum can represent, nor can it be so long that C pointer
707 arithmetic stops working on the string plus its terminating null.
708 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
709 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
710 would expose alloc.c internal details that we'd rather keep
711 private. The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is
713 #define STRING_BYTES_BOUND \
714 min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1)
716 /* Mark STR as a unibyte string. */
717 #define STRING_SET_UNIBYTE(STR) \
718 do { if (EQ (STR, empty_multibyte_string)) \
719 (STR) = empty_unibyte_string; \
720 else XSTRING (STR)->size_byte = -1; } while (0)
722 /* Mark STR as a multibyte string. Assure that STR contains only
723 ASCII characters in advance. */
724 #define STRING_SET_MULTIBYTE(STR) \
725 do { if (EQ (STR, empty_unibyte_string)) \
726 (STR) = empty_multibyte_string; \
727 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
729 /* Get text properties. */
730 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
732 /* Set text properties. */
733 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
735 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
741 INTERVAL intervals
; /* Text properties in this string. */
745 /* Header of vector-like objects. This documents the layout constraints on
746 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
747 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
748 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
749 because when two such pointers potentially alias, a compiler won't
750 incorrectly reorder loads and stores to their size fields. See
751 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
752 struct vectorlike_header
754 /* This field contains various pieces of information:
755 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
756 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
757 vector (0) or a pseudovector (1).
758 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
759 of slots) of the vector.
760 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
761 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
762 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
763 Lisp_Object slots at the beginning of the object that need to be
764 traced by the GC, tho some types use it slightly differently.
765 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
766 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
770 /* When the vector is allocated from a vector block, NBYTES is used
771 if the vector is not on a free list, and VECTOR is used otherwise.
772 For large vector-like objects, BUFFER or VECTOR is used as a pointer
773 to the next vector-like object. It is generally a buffer or a
774 Lisp_Vector alias, so for convenience it is a union instead of a
775 pointer: this way, one can write P->next.vector instead of ((struct
776 Lisp_Vector *) P->next). */
778 /* This is only needed for small vectors that are not free because the
779 `size' field only gives us the number of Lisp_Object slots, whereas we
780 need to know the total size, including non-Lisp_Object data.
781 FIXME: figure out a way to store this info elsewhere so we can
782 finally get rid of this extra word of overhead. */
784 struct buffer
*buffer
;
785 /* FIXME: This can be removed: For large vectors, this field could be
786 placed *before* the vector itself. And for small vectors on a free
787 list, this field could be stored in the vector's bytes, since the
788 empty vector is handled specially anyway. */
789 struct Lisp_Vector
*vector
;
795 struct vectorlike_header header
;
796 Lisp_Object contents
[1];
799 /* If a struct is made to look like a vector, this macro returns the length
800 of the shortest vector that would hold that struct. */
801 #define VECSIZE(type) ((sizeof (type) \
802 - offsetof (struct Lisp_Vector, contents[0]) \
803 + sizeof (Lisp_Object) - 1) /* Round up. */ \
804 / sizeof (Lisp_Object))
806 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
807 at the end and we need to compute the number of Lisp_Object fields (the
808 ones that the GC needs to trace). */
809 #define PSEUDOVECSIZE(type, nonlispfield) \
810 ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \
811 / sizeof (Lisp_Object))
813 /* A char-table is a kind of vectorlike, with contents are like a
814 vector but with a few other slots. For some purposes, it makes
815 sense to handle a char-table with type struct Lisp_Vector. An
816 element of a char table can be any Lisp objects, but if it is a sub
817 char-table, we treat it a table that contains information of a
818 specific range of characters. A sub char-table has the same
819 structure as a vector. A sub char table appears only in an element
820 of a char-table, and there's no way to access it directly from
821 Emacs Lisp program. */
823 /* This is the number of slots that every char table must have. This
824 counts the ordinary slots and the top, defalt, parent, and purpose
826 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
828 /* Return the number of "extra" slots in the char table CT. */
830 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
831 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
835 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
836 ({struct Lisp_Char_Table *_tbl = NULL; \
839 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
840 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
841 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
843 _val = _tbl->defalt; \
844 } while (NILP (_val) && ! NILP (_tbl->parent)); \
847 #else /* not __GNUC__ */
849 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
850 (! NILP (XCHAR_TABLE (CT)->ascii) \
851 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
852 ? XCHAR_TABLE (CT)->ascii \
853 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
854 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
855 : char_table_ref ((CT), (IDX))) \
856 : char_table_ref ((CT), (IDX)))
858 #endif /* not __GNUC__ */
860 /* Compute A OP B, using the unsigned comparison operator OP. A and B
861 should be integer expressions. This is not the same as
862 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
863 returns 1. For efficiency, prefer plain unsigned comparison if A
864 and B's sizes both fit (after integer promotion). */
865 #define UNSIGNED_CMP(a, op, b) \
866 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
867 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
868 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
870 /* Nonzero iff C is an ASCII character. */
871 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
873 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
874 characters. Do not check validity of CT. */
875 #define CHAR_TABLE_REF(CT, IDX) \
876 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
877 : char_table_ref ((CT), (IDX)))
879 /* Almost equivalent to Faref (CT, IDX). However, if the result is
880 not a character, return IDX.
882 For these characters, do not check validity of CT
883 and do not follow parent. */
884 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
885 char_table_translate (CT, IDX)
887 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
888 8-bit European characters. Do not check validity of CT. */
889 #define CHAR_TABLE_SET(CT, IDX, VAL) \
890 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
891 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
892 : char_table_set (CT, IDX, VAL))
894 #define CHARTAB_SIZE_BITS_0 6
895 #define CHARTAB_SIZE_BITS_1 4
896 #define CHARTAB_SIZE_BITS_2 5
897 #define CHARTAB_SIZE_BITS_3 7
899 extern const int chartab_size
[4];
901 struct Lisp_Sub_Char_Table
;
903 struct Lisp_Char_Table
905 /* HEADER.SIZE is the vector's size field, which also holds the
906 pseudovector type information. It holds the size, too.
907 The size counts the defalt, parent, purpose, ascii,
908 contents, and extras slots. */
909 struct vectorlike_header header
;
911 /* This holds a default value,
912 which is used whenever the value for a specific character is nil. */
915 /* This points to another char table, which we inherit from when the
916 value for a specific character is nil. The `defalt' slot takes
917 precedence over this. */
920 /* This is a symbol which says what kind of use this char-table is
924 /* The bottom sub char-table for characters of the range 0..127. It
925 is nil if none of ASCII character has a specific value. */
928 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
930 /* These hold additional data. It is a vector. */
931 Lisp_Object extras
[1];
934 struct Lisp_Sub_Char_Table
936 /* HEADER.SIZE is the vector's size field, which also holds the
937 pseudovector type information. It holds the size, too. */
938 struct vectorlike_header header
;
940 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
941 char-table of depth 1 contains 16 elements, and each element
942 covers 4096 (128*32) characters. A sub char-table of depth 2
943 contains 32 elements, and each element covers 128 characters. A
944 sub char-table of depth 3 contains 128 elements, and each element
945 is for one character. */
948 /* Minimum character covered by the sub char-table. */
949 Lisp_Object min_char
;
951 Lisp_Object contents
[1];
954 /* A boolvector is a kind of vectorlike, with contents are like a string. */
955 struct Lisp_Bool_Vector
957 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
958 just the subtype information. */
959 struct vectorlike_header header
;
960 /* This is the size in bits. */
962 /* This contains the actual bits, packed into bytes. */
963 unsigned char data
[1];
966 /* This structure describes a built-in function.
967 It is generated by the DEFUN macro only.
968 defsubr makes it into a Lisp object.
970 This type is treated in most respects as a pseudovector,
971 but since we never dynamically allocate or free them,
972 we don't need a struct vectorlike_header and its 'next' field. */
978 Lisp_Object (*a0
) (void);
979 Lisp_Object (*a1
) (Lisp_Object
);
980 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
981 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
982 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
983 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
984 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
985 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
986 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
987 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
988 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
990 short min_args
, max_args
;
991 const char *symbol_name
;
997 /***********************************************************************
999 ***********************************************************************/
1001 /* Interned state of a symbol. */
1003 enum symbol_interned
1005 SYMBOL_UNINTERNED
= 0,
1006 SYMBOL_INTERNED
= 1,
1007 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1010 enum symbol_redirect
1012 SYMBOL_PLAINVAL
= 4,
1013 SYMBOL_VARALIAS
= 1,
1014 SYMBOL_LOCALIZED
= 2,
1015 SYMBOL_FORWARDED
= 3
1020 unsigned gcmarkbit
: 1;
1022 /* Indicates where the value can be found:
1023 0 : it's a plain var, the value is in the `value' field.
1024 1 : it's a varalias, the value is really in the `alias' symbol.
1025 2 : it's a localized var, the value is in the `blv' object.
1026 3 : it's a forwarding variable, the value is in `forward'. */
1027 ENUM_BF (symbol_redirect
) redirect
: 3;
1029 /* Non-zero means symbol is constant, i.e. changing its value
1030 should signal an error. If the value is 3, then the var
1031 can be changed, but only by `defconst'. */
1032 unsigned constant
: 2;
1034 /* Interned state of the symbol. This is an enumerator from
1035 enum symbol_interned. */
1036 unsigned interned
: 2;
1038 /* Non-zero means that this variable has been explicitly declared
1039 special (with `defvar' etc), and shouldn't be lexically bound. */
1040 unsigned declared_special
: 1;
1042 /* The symbol's name, as a Lisp string.
1043 The name "xname" is used to intentionally break code referring to
1044 the old field "name" of type pointer to struct Lisp_String. */
1047 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1048 union is used depends on the `redirect' field above. */
1051 struct Lisp_Symbol
*alias
;
1052 struct Lisp_Buffer_Local_Value
*blv
;
1053 union Lisp_Fwd
*fwd
;
1056 /* Function value of the symbol or Qunbound if not fboundp. */
1057 Lisp_Object function
;
1059 /* The symbol's property list. */
1062 /* Next symbol in obarray bucket, if the symbol is interned. */
1063 struct Lisp_Symbol
*next
;
1066 /* Value is name of symbol. */
1068 #define SYMBOL_VAL(sym) \
1069 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1070 #define SYMBOL_ALIAS(sym) \
1071 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1072 #define SYMBOL_BLV(sym) \
1073 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1074 #define SYMBOL_FWD(sym) \
1075 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1076 #define SET_SYMBOL_VAL(sym, v) \
1077 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1078 #define SET_SYMBOL_ALIAS(sym, v) \
1079 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1080 #define SET_SYMBOL_BLV(sym, v) \
1081 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1082 #define SET_SYMBOL_FWD(sym, v) \
1083 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1085 #define SYMBOL_NAME(sym) \
1086 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1088 /* Value is non-zero if SYM is an interned symbol. */
1090 #define SYMBOL_INTERNED_P(sym) \
1091 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1093 /* Value is non-zero if SYM is interned in initial_obarray. */
1095 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1096 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1098 /* Value is non-zero if symbol is considered a constant, i.e. its
1099 value cannot be changed (there is an exception for keyword symbols,
1100 whose value can be set to the keyword symbol itself). */
1102 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1104 #define DEFSYM(sym, name) \
1105 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1108 /***********************************************************************
1110 ***********************************************************************/
1112 /* The structure of a Lisp hash table. */
1114 struct Lisp_Hash_Table
1116 /* This is for Lisp; the hash table code does not refer to it. */
1117 struct vectorlike_header header
;
1119 /* Function used to compare keys. */
1122 /* Nil if table is non-weak. Otherwise a symbol describing the
1123 weakness of the table. */
1126 /* When the table is resized, and this is an integer, compute the
1127 new size by adding this to the old size. If a float, compute the
1128 new size by multiplying the old size with this factor. */
1129 Lisp_Object rehash_size
;
1131 /* Resize hash table when number of entries/ table size is >= this
1133 Lisp_Object rehash_threshold
;
1135 /* Vector of hash codes.. If hash[I] is nil, this means that that
1136 entry I is unused. */
1139 /* Vector used to chain entries. If entry I is free, next[I] is the
1140 entry number of the next free item. If entry I is non-free,
1141 next[I] is the index of the next entry in the collision chain. */
1144 /* Index of first free entry in free list. */
1145 Lisp_Object next_free
;
1147 /* Bucket vector. A non-nil entry is the index of the first item in
1148 a collision chain. This vector's size can be larger than the
1149 hash table size to reduce collisions. */
1152 /* User-supplied hash function, or nil. */
1153 Lisp_Object user_hash_function
;
1155 /* User-supplied key comparison function, or nil. */
1156 Lisp_Object user_cmp_function
;
1158 /* Only the fields above are traced normally by the GC. The ones below
1159 `count' are special and are either ignored by the GC or traced in
1160 a special way (e.g. because of weakness). */
1162 /* Number of key/value entries in the table. */
1165 /* Vector of keys and values. The key of item I is found at index
1166 2 * I, the value is found at index 2 * I + 1.
1167 This is gc_marked specially if the table is weak. */
1168 Lisp_Object key_and_value
;
1170 /* Next weak hash table if this is a weak hash table. The head
1171 of the list is in weak_hash_tables. */
1172 struct Lisp_Hash_Table
*next_weak
;
1174 /* C function to compare two keys. */
1175 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1176 Lisp_Object
, EMACS_UINT
,
1177 Lisp_Object
, EMACS_UINT
);
1179 /* C function to compute hash code. */
1180 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1184 #define XHASH_TABLE(OBJ) \
1185 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1187 #define XSET_HASH_TABLE(VAR, PTR) \
1188 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1190 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1192 #define CHECK_HASH_TABLE(x) \
1193 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1195 /* Value is the key part of entry IDX in hash table H. */
1197 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1199 /* Value is the value part of entry IDX in hash table H. */
1201 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1203 /* Value is the index of the next entry following the one at IDX
1206 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1208 /* Value is the hash code computed for entry IDX in hash table H. */
1210 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1212 /* Value is the index of the element in hash table H that is the
1213 start of the collision list at index IDX in the index vector of H. */
1215 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1217 /* Value is the size of hash table H. */
1219 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1221 /* Default size for hash tables if not specified. */
1223 #define DEFAULT_HASH_SIZE 65
1225 /* Default threshold specifying when to resize a hash table. The
1226 value gives the ratio of current entries in the hash table and the
1227 size of the hash table. */
1229 #define DEFAULT_REHASH_THRESHOLD 0.8
1231 /* Default factor by which to increase the size of a hash table. */
1233 #define DEFAULT_REHASH_SIZE 1.5
1236 /* These structures are used for various misc types. */
1238 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1240 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1241 unsigned gcmarkbit
: 1;
1247 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1248 unsigned gcmarkbit
: 1;
1250 /* This flag is temporarily used in the functions
1251 decode/encode_coding_object to record that the marker position
1252 must be adjusted after the conversion. */
1253 unsigned int need_adjustment
: 1;
1254 /* 1 means normal insertion at the marker's position
1255 leaves the marker after the inserted text. */
1256 unsigned int insertion_type
: 1;
1257 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1258 Note: a chain of markers can contain markers pointing into different
1259 buffers (the chain is per buffer_text rather than per buffer, so it's
1260 shared between indirect buffers). */
1261 /* This is used for (other than NULL-checking):
1263 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1264 - unchain_marker: to find the list from which to unchain.
1265 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1267 struct buffer
*buffer
;
1269 /* The remaining fields are meaningless in a marker that
1270 does not point anywhere. */
1272 /* For markers that point somewhere,
1273 this is used to chain of all the markers in a given buffer. */
1274 /* We could remove it and use an array in buffer_text instead.
1275 That would also allow to preserve it ordered. */
1276 struct Lisp_Marker
*next
;
1277 /* This is the char position where the marker points. */
1279 /* This is the byte position.
1280 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1281 used to implement the functionality of markers, but rather to (ab)use
1282 markers as a cache for char<->byte mappings). */
1286 /* START and END are markers in the overlay's buffer, and
1287 PLIST is the overlay's property list. */
1289 /* An overlay's real data content is:
1292 - insertion type of both ends
1293 - start & start_byte
1295 - next (singly linked list of overlays).
1296 - start_next and end_next (singly linked list of markers).
1297 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1300 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1301 unsigned gcmarkbit
: 1;
1303 struct Lisp_Overlay
*next
;
1304 Lisp_Object start
, end
, plist
;
1307 /* Hold a C pointer for later use.
1308 This type of object is used in the arg to record_unwind_protect. */
1309 struct Lisp_Save_Value
1311 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1312 unsigned gcmarkbit
: 1;
1314 /* If DOGC is set, POINTER is the address of a memory
1315 area containing INTEGER potential Lisp_Objects. */
1316 unsigned int dogc
: 1;
1322 /* A miscellaneous object, when it's on the free list. */
1325 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1326 unsigned gcmarkbit
: 1;
1328 union Lisp_Misc
*chain
;
1331 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1332 It uses one of these struct subtypes to get the type field. */
1336 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1337 struct Lisp_Free u_free
;
1338 struct Lisp_Marker u_marker
;
1339 struct Lisp_Overlay u_overlay
;
1340 struct Lisp_Save_Value u_save_value
;
1343 /* Forwarding pointer to an int variable.
1344 This is allowed only in the value cell of a symbol,
1345 and it means that the symbol's value really lives in the
1346 specified int variable. */
1349 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1353 /* Boolean forwarding pointer to an int variable.
1354 This is like Lisp_Intfwd except that the ostensible
1355 "value" of the symbol is t if the int variable is nonzero,
1356 nil if it is zero. */
1359 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1363 /* Forwarding pointer to a Lisp_Object variable.
1364 This is allowed only in the value cell of a symbol,
1365 and it means that the symbol's value really lives in the
1366 specified variable. */
1369 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1370 Lisp_Object
*objvar
;
1373 /* Like Lisp_Objfwd except that value lives in a slot in the
1374 current buffer. Value is byte index of slot within buffer. */
1375 struct Lisp_Buffer_Objfwd
1377 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1379 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1382 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1383 the symbol has buffer-local or frame-local bindings. (Exception:
1384 some buffer-local variables are built-in, with their values stored
1385 in the buffer structure itself. They are handled differently,
1386 using struct Lisp_Buffer_Objfwd.)
1388 The `realvalue' slot holds the variable's current value, or a
1389 forwarding pointer to where that value is kept. This value is the
1390 one that corresponds to the loaded binding. To read or set the
1391 variable, you must first make sure the right binding is loaded;
1392 then you can access the value in (or through) `realvalue'.
1394 `buffer' and `frame' are the buffer and frame for which the loaded
1395 binding was found. If those have changed, to make sure the right
1396 binding is loaded it is necessary to find which binding goes with
1397 the current buffer and selected frame, then load it. To load it,
1398 first unload the previous binding, then copy the value of the new
1399 binding into `realvalue' (or through it). Also update
1400 LOADED-BINDING to point to the newly loaded binding.
1402 `local_if_set' indicates that merely setting the variable creates a
1403 local binding for the current buffer. Otherwise the latter, setting
1404 the variable does not do that; only make-local-variable does that. */
1406 struct Lisp_Buffer_Local_Value
1408 /* 1 means that merely setting the variable creates a local
1409 binding for the current buffer. */
1410 unsigned int local_if_set
: 1;
1411 /* 1 means this variable can have frame-local bindings, otherwise, it is
1412 can have buffer-local bindings. The two cannot be combined. */
1413 unsigned int frame_local
: 1;
1414 /* 1 means that the binding now loaded was found.
1415 Presumably equivalent to (defcell!=valcell). */
1416 unsigned int found
: 1;
1417 /* If non-NULL, a forwarding to the C var where it should also be set. */
1418 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1419 /* The buffer or frame for which the loaded binding was found. */
1421 /* A cons cell that holds the default value. It has the form
1422 (SYMBOL . DEFAULT-VALUE). */
1423 Lisp_Object defcell
;
1424 /* The cons cell from `where's parameter alist.
1425 It always has the form (SYMBOL . VALUE)
1426 Note that if `forward' is non-nil, VALUE may be out of date.
1427 Also if the currently loaded binding is the default binding, then
1428 this is `eq'ual to defcell. */
1429 Lisp_Object valcell
;
1432 #define BLV_FOUND(blv) \
1433 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1434 #define SET_BLV_FOUND(blv, v) \
1435 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1437 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1438 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1440 /* Like Lisp_Objfwd except that value lives in a slot in the
1442 struct Lisp_Kboard_Objfwd
1444 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1450 struct Lisp_Intfwd u_intfwd
;
1451 struct Lisp_Boolfwd u_boolfwd
;
1452 struct Lisp_Objfwd u_objfwd
;
1453 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1454 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1457 /* Lisp floating point type. */
1462 #ifdef HIDE_LISP_IMPLEMENTATION
1467 struct Lisp_Float
*chain
;
1471 #ifdef HIDE_LISP_IMPLEMENTATION
1472 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data_ : XFLOAT (f)->u.data_)
1474 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1475 /* This should be used only in alloc.c, which always disables
1476 HIDE_LISP_IMPLEMENTATION. */
1477 #define XFLOAT_INIT(f,n) (XFLOAT (f)->u.data = (n))
1480 /* A character, declared with the following typedef, is a member
1481 of some character set associated with the current buffer. */
1482 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1484 typedef unsigned char UCHAR
;
1487 /* Meanings of slots in a Lisp_Compiled: */
1489 #define COMPILED_ARGLIST 0
1490 #define COMPILED_BYTECODE 1
1491 #define COMPILED_CONSTANTS 2
1492 #define COMPILED_STACK_DEPTH 3
1493 #define COMPILED_DOC_STRING 4
1494 #define COMPILED_INTERACTIVE 5
1496 /* Flag bits in a character. These also get used in termhooks.h.
1497 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1498 (MUlti-Lingual Emacs) might need 22 bits for the character value
1499 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1500 #define CHAR_ALT (0x0400000)
1501 #define CHAR_SUPER (0x0800000)
1502 #define CHAR_HYPER (0x1000000)
1503 #define CHAR_SHIFT (0x2000000)
1504 #define CHAR_CTL (0x4000000)
1505 #define CHAR_META (0x8000000)
1507 #define CHAR_MODIFIER_MASK \
1508 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1511 /* Actually, the current Emacs uses 22 bits for the character value
1513 #define CHARACTERBITS 22
1516 /* The glyph datatype, used to represent characters on the display.
1517 It consists of a char code and a face id. */
1524 /* Return a glyph's character code. */
1525 #define GLYPH_CHAR(glyph) ((glyph).ch)
1527 /* Return a glyph's face ID. */
1528 #define GLYPH_FACE(glyph) ((glyph).face_id)
1530 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1531 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1532 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1534 /* Return 1 if GLYPH contains valid character code. */
1535 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1538 /* Glyph Code from a display vector may either be an integer which
1539 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1540 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1542 #define GLYPH_CODE_P(gc) \
1544 ? (CHARACTERP (XCAR (gc)) \
1545 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1546 : (RANGED_INTEGERP \
1548 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1549 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1550 : TYPE_MAXIMUM (EMACS_INT)))))
1552 /* The following are valid only if GLYPH_CODE_P (gc). */
1554 #define GLYPH_CODE_CHAR(gc) \
1555 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1557 #define GLYPH_CODE_FACE(gc) \
1558 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1560 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1564 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1566 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1567 (XINT (gc) >> CHARACTERBITS)); \
1571 /* The ID of the mode line highlighting face. */
1572 #define GLYPH_MODE_LINE_FACE 1
1574 /* Structure to hold mouse highlight data. This is here because other
1575 header files need it for defining struct x_output etc. */
1577 /* These variables describe the range of text currently shown in its
1578 mouse-face, together with the window they apply to. As long as
1579 the mouse stays within this range, we need not redraw anything on
1580 its account. Rows and columns are glyph matrix positions in
1581 MOUSE_FACE_WINDOW. */
1582 int mouse_face_beg_row
, mouse_face_beg_col
;
1583 int mouse_face_beg_x
, mouse_face_beg_y
;
1584 int mouse_face_end_row
, mouse_face_end_col
;
1585 int mouse_face_end_x
, mouse_face_end_y
;
1586 int mouse_face_past_end
;
1587 Lisp_Object mouse_face_window
;
1588 int mouse_face_face_id
;
1589 Lisp_Object mouse_face_overlay
;
1591 /* 1 if a mouse motion event came and we didn't handle it right away because
1592 gc was in progress. */
1593 int mouse_face_deferred_gc
;
1595 /* FRAME and X, Y position of mouse when last checked for
1596 highlighting. X and Y can be negative or out of range for the frame. */
1597 struct frame
*mouse_face_mouse_frame
;
1598 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1600 /* Nonzero means defer mouse-motion highlighting. */
1601 int mouse_face_defer
;
1603 /* Nonzero means that the mouse highlight should not be shown. */
1604 int mouse_face_hidden
;
1606 int mouse_face_image_state
;
1609 /* Data type checking */
1611 #define NILP(x) EQ (x, Qnil)
1613 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1614 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1616 #define RANGED_INTEGERP(lo, x, hi) \
1617 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1618 #define TYPE_RANGED_INTEGERP(type, x) \
1619 (TYPE_SIGNED (type) \
1620 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1621 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1623 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1624 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1625 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1626 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1627 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1628 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1630 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1631 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1632 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1633 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1634 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1636 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1637 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1638 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1639 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1640 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1642 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1643 vectorlike_header * avoids aliasing issues. */
1644 #define PSEUDOVECTORP(x, code) \
1645 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1647 #define PSEUDOVECTOR_TYPEP(v, code) \
1648 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1649 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1651 /* True if object X, with internal type struct T *, is a pseudovector whose
1653 #define TYPED_PSEUDOVECTORP(x, t, code) \
1655 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1657 /* Test for specific pseudovector types. */
1658 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1659 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1660 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1661 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1662 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1663 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1664 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1665 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1666 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1667 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1668 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1669 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1671 /* Test for image (image . spec) */
1672 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1677 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1679 #define CHECK_LIST(x) \
1680 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1682 #define CHECK_LIST_CONS(x, y) \
1683 CHECK_TYPE (CONSP (x), Qlistp, y)
1685 #define CHECK_LIST_END(x, y) \
1686 CHECK_TYPE (NILP (x), Qlistp, y)
1688 #define CHECK_STRING(x) \
1689 CHECK_TYPE (STRINGP (x), Qstringp, x)
1691 #define CHECK_STRING_CAR(x) \
1692 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1694 #define CHECK_CONS(x) \
1695 CHECK_TYPE (CONSP (x), Qconsp, x)
1697 #define CHECK_SYMBOL(x) \
1698 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1700 #define CHECK_CHAR_TABLE(x) \
1701 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1703 #define CHECK_VECTOR(x) \
1704 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1706 #define CHECK_VECTOR_OR_STRING(x) \
1707 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1709 #define CHECK_ARRAY(x, Qxxxp) \
1710 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1712 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1713 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1715 #define CHECK_BUFFER(x) \
1716 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1718 #define CHECK_WINDOW(x) \
1719 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1721 #define CHECK_WINDOW_CONFIGURATION(x) \
1722 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1724 /* This macro rejects windows on the interior of the window tree as
1725 "dead", which is what we want; this is an argument-checking macro, and
1726 the user should never get access to interior windows.
1728 A window of any sort, leaf or interior, is dead if the buffer,
1729 vchild, and hchild members are all nil. */
1731 #define CHECK_LIVE_WINDOW(x) \
1732 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1734 #define CHECK_PROCESS(x) \
1735 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1737 #define CHECK_SUBR(x) \
1738 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1740 #define CHECK_NUMBER(x) \
1741 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1743 #define CHECK_NATNUM(x) \
1744 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1746 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1749 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1750 args_out_of_range_3 \
1752 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1753 ? MOST_NEGATIVE_FIXNUM \
1755 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1757 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1759 if (TYPE_SIGNED (type)) \
1760 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1762 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1765 #define CHECK_MARKER(x) \
1766 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1768 #define CHECK_NUMBER_COERCE_MARKER(x) \
1769 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1770 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1772 #define XFLOATINT(n) extract_float((n))
1774 #define CHECK_FLOAT(x) \
1775 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1777 #define CHECK_NUMBER_OR_FLOAT(x) \
1778 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1780 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1781 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1782 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1784 #define CHECK_OVERLAY(x) \
1785 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1787 /* Since we can't assign directly to the CAR or CDR fields of a cons
1788 cell, use these when checking that those fields contain numbers. */
1789 #define CHECK_NUMBER_CAR(x) \
1791 Lisp_Object tmp = XCAR (x); \
1792 CHECK_NUMBER (tmp); \
1793 XSETCAR ((x), tmp); \
1796 #define CHECK_NUMBER_CDR(x) \
1798 Lisp_Object tmp = XCDR (x); \
1799 CHECK_NUMBER (tmp); \
1800 XSETCDR ((x), tmp); \
1803 #define CHECK_NATNUM_CAR(x) \
1805 Lisp_Object tmp = XCAR (x); \
1806 CHECK_NATNUM (tmp); \
1807 XSETCAR ((x), tmp); \
1810 #define CHECK_NATNUM_CDR(x) \
1812 Lisp_Object tmp = XCDR (x); \
1813 CHECK_NATNUM (tmp); \
1814 XSETCDR ((x), tmp); \
1817 /* Define a built-in function for calling from Lisp.
1818 `lname' should be the name to give the function in Lisp,
1819 as a null-terminated C string.
1820 `fnname' should be the name of the function in C.
1821 By convention, it starts with F.
1822 `sname' should be the name for the C constant structure
1823 that records information on this function for internal use.
1824 By convention, it should be the same as `fnname' but with S instead of F.
1825 It's too bad that C macros can't compute this from `fnname'.
1826 `minargs' should be a number, the minimum number of arguments allowed.
1827 `maxargs' should be a number, the maximum number of arguments allowed,
1828 or else MANY or UNEVALLED.
1829 MANY means pass a vector of evaluated arguments,
1830 in the form of an integer number-of-arguments
1831 followed by the address of a vector of Lisp_Objects
1832 which contains the argument values.
1833 UNEVALLED means pass the list of unevaluated arguments
1834 `intspec' says how interactive arguments are to be fetched.
1835 If the string starts with a `(', `intspec' is evaluated and the resulting
1836 list is the list of arguments.
1837 If it's a string that doesn't start with `(', the value should follow
1838 the one of the doc string for `interactive'.
1839 A null string means call interactively with no arguments.
1840 `doc' is documentation for the user. */
1842 /* This version of DEFUN declares a function prototype with the right
1843 arguments, so we can catch errors with maxargs at compile-time. */
1845 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1846 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1847 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1848 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1849 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1850 { (Lisp_Object (__cdecl *)(void))fnname }, \
1851 minargs, maxargs, lname, intspec, 0}; \
1853 #else /* not _MSC_VER */
1854 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1855 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1856 static DECL_ALIGN (struct Lisp_Subr, sname) = \
1857 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1858 { .a ## maxargs = fnname }, \
1859 minargs, maxargs, lname, intspec, 0}; \
1863 /* Note that the weird token-substitution semantics of ANSI C makes
1864 this work for MANY and UNEVALLED. */
1865 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1866 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1867 #define DEFUN_ARGS_0 (void)
1868 #define DEFUN_ARGS_1 (Lisp_Object)
1869 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1870 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1871 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1872 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1874 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1875 Lisp_Object, Lisp_Object)
1876 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1877 Lisp_Object, Lisp_Object, Lisp_Object)
1878 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1879 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1881 /* Non-zero if OBJ is a Lisp function. */
1882 #define FUNCTIONP(OBJ) \
1883 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1884 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1885 || COMPILEDP (OBJ) \
1889 is how we define the symbol for function `name' at start-up time. */
1890 extern void defsubr (struct Lisp_Subr
*);
1893 #define UNEVALLED -1
1895 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1896 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1897 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1898 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1899 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1901 /* Macros we use to define forwarded Lisp variables.
1902 These are used in the syms_of_FILENAME functions.
1904 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1905 lisp variable is actually a field in `struct emacs_globals'. The
1906 field's name begins with "f_", which is a convention enforced by
1907 these macros. Each such global has a corresponding #define in
1908 globals.h; the plain name should be used in the code.
1910 E.g., the global "cons_cells_consed" is declared as "int
1911 f_cons_cells_consed" in globals.h, but there is a define:
1913 #define cons_cells_consed globals.f_cons_cells_consed
1915 All C code uses the `cons_cells_consed' name. This is all done
1916 this way to support indirection for multi-threaded Emacs. */
1918 #define DEFVAR_LISP(lname, vname, doc) \
1920 static struct Lisp_Objfwd o_fwd; \
1921 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1923 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1925 static struct Lisp_Objfwd o_fwd; \
1926 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1928 #define DEFVAR_BOOL(lname, vname, doc) \
1930 static struct Lisp_Boolfwd b_fwd; \
1931 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1933 #define DEFVAR_INT(lname, vname, doc) \
1935 static struct Lisp_Intfwd i_fwd; \
1936 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1939 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1941 static struct Lisp_Objfwd o_fwd; \
1942 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1945 #define DEFVAR_KBOARD(lname, vname, doc) \
1947 static struct Lisp_Kboard_Objfwd ko_fwd; \
1948 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1953 /* Structure for recording Lisp call stack for backtrace purposes. */
1955 /* The special binding stack holds the outer values of variables while
1956 they are bound by a function application or a let form, stores the
1957 code to be executed for Lisp unwind-protect forms, and stores the C
1958 functions to be called for record_unwind_protect.
1960 If func is non-zero, undoing this binding applies func to old_value;
1961 This implements record_unwind_protect.
1963 Otherwise, the element is a variable binding.
1965 If the symbol field is a symbol, it is an ordinary variable binding.
1967 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
1968 which means having bound a local value while CURRENT-BUFFER was active.
1969 If WHERE is nil this means we saw the default value when binding SYMBOL.
1970 WHERE being a buffer or frame means we saw a buffer-local or frame-local
1971 value. Other values of WHERE mean an internal error. */
1973 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
1977 Lisp_Object symbol
, old_value
;
1978 specbinding_func func
;
1979 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
1982 extern struct specbinding
*specpdl
;
1983 extern struct specbinding
*specpdl_ptr
;
1984 extern ptrdiff_t specpdl_size
;
1986 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
1988 /* Everything needed to describe an active condition case. */
1991 /* The handler clauses and variable from the condition-case form. */
1992 /* For a handler set up in Lisp code, this is always a list.
1993 For an internal handler set up by internal_condition_case*,
1994 this can instead be the symbol t or `error'.
1995 t: handle all conditions.
1996 error: handle all conditions, and errors can run the debugger
1997 or display a backtrace. */
1998 Lisp_Object handler
;
2000 /* Fsignal stores here the condition-case clause that applies,
2001 and Fcondition_case thus knows which clause to run. */
2002 Lisp_Object chosen_clause
;
2004 /* Used to effect the longjump out to the handler. */
2005 struct catchtag
*tag
;
2007 /* The next enclosing handler. */
2008 struct handler
*next
;
2011 /* This structure helps implement the `catch' and `throw' control
2012 structure. A struct catchtag contains all the information needed
2013 to restore the state of the interpreter after a non-local jump.
2015 Handlers for error conditions (represented by `struct handler'
2016 structures) just point to a catch tag to do the cleanup required
2019 catchtag structures are chained together in the C calling stack;
2020 the `next' member points to the next outer catchtag.
2022 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2023 member is TAG, and then unbinds to it. The `val' member is used to
2024 hold VAL while the stack is unwound; `val' is returned as the value
2027 All the other members are concerned with restoring the interpreter
2034 struct catchtag
*next
;
2035 struct gcpro
*gcpro
;
2037 struct backtrace
*backlist
;
2038 struct handler
*handlerlist
;
2039 EMACS_INT lisp_eval_depth
;
2041 int poll_suppress_count
;
2042 int interrupt_input_blocked
;
2043 struct byte_stack
*byte_stack
;
2046 extern Lisp_Object memory_signal_data
;
2048 /* An address near the bottom of the stack.
2049 Tells GC how to save a copy of the stack. */
2050 extern char *stack_bottom
;
2052 /* Check quit-flag and quit if it is non-nil.
2053 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2054 So the program needs to do QUIT at times when it is safe to quit.
2055 Every loop that might run for a long time or might not exit
2056 ought to do QUIT at least once, at a safe place.
2057 Unless that is impossible, of course.
2058 But it is very desirable to avoid creating loops where QUIT is impossible.
2060 Exception: if you set immediate_quit to nonzero,
2061 then the handler that responds to the C-g does the quit itself.
2062 This is a good thing to do around a loop that has no side effects
2063 and (in particular) cannot call arbitrary Lisp code.
2065 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2066 a request to exit Emacs when it is safe to do. */
2069 extern void process_pending_signals (void);
2070 extern int pending_signals
;
2071 #define ELSE_PENDING_SIGNALS \
2072 else if (pending_signals) \
2073 process_pending_signals ();
2074 #else /* not SYNC_INPUT */
2075 #define ELSE_PENDING_SIGNALS
2076 #endif /* not SYNC_INPUT */
2078 extern void process_quit_flag (void);
2081 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2082 process_quit_flag (); \
2083 ELSE_PENDING_SIGNALS \
2087 /* Nonzero if ought to quit now. */
2089 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2091 extern Lisp_Object Vascii_downcase_table
;
2092 extern Lisp_Object Vascii_canon_table
;
2094 /* Number of bytes of structure consed since last GC. */
2096 extern EMACS_INT consing_since_gc
;
2098 extern EMACS_INT gc_relative_threshold
;
2100 extern EMACS_INT memory_full_cons_threshold
;
2102 /* Structure for recording stack slots that need marking. */
2104 /* This is a chain of structures, each of which points at a Lisp_Object
2105 variable whose value should be marked in garbage collection.
2106 Normally every link of the chain is an automatic variable of a function,
2107 and its `val' points to some argument or local variable of the function.
2108 On exit to the function, the chain is set back to the value it had on entry.
2109 This way, no link remains in the chain when the stack frame containing the
2112 Every function that can call Feval must protect in this fashion all
2113 Lisp_Object variables whose contents will be used again. */
2115 extern struct gcpro
*gcprolist
;
2121 /* Address of first protected variable. */
2122 volatile Lisp_Object
*var
;
2124 /* Number of consecutive protected variables. */
2132 /* Values of GC_MARK_STACK during compilation:
2134 0 Use GCPRO as before
2135 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2136 2 Mark the stack, and check that everything GCPRO'd is
2138 3 Mark using GCPRO's, mark stack last, and count how many
2139 dead objects are kept alive. */
2142 #define GC_USE_GCPROS_AS_BEFORE 0
2143 #define GC_MAKE_GCPROS_NOOPS 1
2144 #define GC_MARK_STACK_CHECK_GCPROS 2
2145 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2147 #ifndef GC_MARK_STACK
2148 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2151 /* Whether we do the stack marking manually. */
2152 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2153 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2156 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2158 /* Do something silly with gcproN vars just so gcc shuts up. */
2159 /* You get warnings from MIPSPro... */
2161 #define GCPRO1(varname) ((void) gcpro1)
2162 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2163 #define GCPRO3(varname1, varname2, varname3) \
2164 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2165 #define GCPRO4(varname1, varname2, varname3, varname4) \
2166 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2167 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2168 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2169 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2170 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2172 #define UNGCPRO ((void) 0)
2174 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2178 #define GCPRO1(varname) \
2179 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2180 gcprolist = &gcpro1; }
2182 #define GCPRO2(varname1, varname2) \
2183 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2184 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2185 gcprolist = &gcpro2; }
2187 #define GCPRO3(varname1, varname2, varname3) \
2188 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2189 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2190 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2191 gcprolist = &gcpro3; }
2193 #define GCPRO4(varname1, varname2, varname3, varname4) \
2194 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2195 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2196 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2197 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2198 gcprolist = &gcpro4; }
2200 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2201 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2202 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2203 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2204 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2205 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2206 gcprolist = &gcpro5; }
2208 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2209 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2210 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2211 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2212 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2213 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2214 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2215 gcprolist = &gcpro6; }
2217 #define UNGCPRO (gcprolist = gcpro1.next)
2221 extern int gcpro_level
;
2223 #define GCPRO1(varname) \
2224 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2225 gcpro1.level = gcpro_level++; \
2226 gcprolist = &gcpro1; }
2228 #define GCPRO2(varname1, varname2) \
2229 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2230 gcpro1.level = gcpro_level; \
2231 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2232 gcpro2.level = gcpro_level++; \
2233 gcprolist = &gcpro2; }
2235 #define GCPRO3(varname1, varname2, varname3) \
2236 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2237 gcpro1.level = gcpro_level; \
2238 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2239 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2240 gcpro3.level = gcpro_level++; \
2241 gcprolist = &gcpro3; }
2243 #define GCPRO4(varname1, varname2, varname3, varname4) \
2244 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2245 gcpro1.level = gcpro_level; \
2246 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2247 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2248 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2249 gcpro4.level = gcpro_level++; \
2250 gcprolist = &gcpro4; }
2252 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2253 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2254 gcpro1.level = gcpro_level; \
2255 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2256 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2257 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2258 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2259 gcpro5.level = gcpro_level++; \
2260 gcprolist = &gcpro5; }
2262 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2263 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2264 gcpro1.level = gcpro_level; \
2265 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2266 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2267 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2268 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2269 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2270 gcpro6.level = gcpro_level++; \
2271 gcprolist = &gcpro6; }
2274 ((--gcpro_level != gcpro1.level) \
2276 : ((gcprolist = gcpro1.next), 0))
2278 #endif /* DEBUG_GCPRO */
2279 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2282 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2283 #define RETURN_UNGCPRO(expr) \
2286 Lisp_Object ret_ungc_val; \
2287 ret_ungc_val = (expr); \
2289 return ret_ungc_val; \
2293 /* Call staticpro (&var) to protect static variable `var'. */
2295 void staticpro (Lisp_Object
*);
2297 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2298 meaning as in the DEFUN macro, and is used to construct a prototype. */
2299 /* We can use the same trick as in the DEFUN macro to generate the
2300 appropriate prototype. */
2301 #define EXFUN(fnname, maxargs) \
2302 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2304 /* Forward declarations for prototypes. */
2308 /* Defined in data.c. */
2309 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2310 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2311 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2312 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2313 extern Lisp_Object Qinvalid_read_syntax
;
2314 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2315 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2316 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2317 extern Lisp_Object Qtext_read_only
;
2318 extern Lisp_Object Qinteractive_form
;
2319 extern Lisp_Object Qcircular_list
;
2320 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2321 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2322 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2323 extern Lisp_Object Qbuffer_or_string_p
;
2324 extern Lisp_Object Qfboundp
;
2325 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2327 extern Lisp_Object Qcdr
;
2329 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2330 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2332 extern Lisp_Object Qfloatp
;
2333 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2335 extern Lisp_Object Qinteger
;
2337 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2339 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2341 /* Defined in frame.c */
2342 extern Lisp_Object Qframep
;
2344 /* Defined in data.c */
2345 extern Lisp_Object
indirect_function (Lisp_Object
);
2346 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2348 /* Convert the integer I to an Emacs representation, either the integer
2349 itself, or a cons of two or three integers, or if all else fails a float.
2350 I should not have side effects. */
2351 #define INTEGER_TO_CONS(i) \
2352 (! FIXNUM_OVERFLOW_P (i) \
2354 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2355 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2356 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2357 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2358 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2359 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2360 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2361 ? Fcons (make_number ((i) >> 16 >> 24), \
2362 Fcons (make_number ((i) >> 16 & 0xffffff), \
2363 make_number ((i) & 0xffff))) \
2366 /* Convert the Emacs representation CONS back to an integer of type
2367 TYPE, storing the result the variable VAR. Signal an error if CONS
2368 is not a valid representation or is out of range for TYPE. */
2369 #define CONS_TO_INTEGER(cons, type, var) \
2370 (TYPE_SIGNED (type) \
2371 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2372 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2373 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2374 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2376 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2377 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2378 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2380 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2381 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2382 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2383 extern void syms_of_data (void);
2384 extern void init_data (void);
2385 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2387 /* Defined in cmds.c */
2388 extern void syms_of_cmds (void);
2389 extern void keys_of_cmds (void);
2391 /* Defined in coding.c */
2392 extern Lisp_Object Qcharset
;
2393 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2394 ptrdiff_t, int, int, Lisp_Object
);
2395 extern void init_coding (void);
2396 extern void init_coding_once (void);
2397 extern void syms_of_coding (void);
2399 /* Defined in character.c */
2400 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2401 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2402 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2403 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2404 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2405 extern void init_character_once (void) ATTRIBUTE_CONST
;
2406 extern void syms_of_character (void);
2408 /* Defined in charset.c */
2409 extern void init_charset (void);
2410 extern void init_charset_once (void);
2411 extern void syms_of_charset (void);
2412 /* Structure forward declarations. */
2415 /* Defined in composite.c */
2416 extern void syms_of_composite (void);
2418 /* Defined in syntax.c */
2419 extern void init_syntax_once (void);
2420 extern void syms_of_syntax (void);
2422 /* Defined in fns.c */
2423 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2424 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2425 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2426 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2427 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2428 extern void sweep_weak_hash_tables (void);
2429 extern Lisp_Object Qcursor_in_echo_area
;
2430 extern Lisp_Object Qstring_lessp
;
2431 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2432 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2433 EMACS_UINT
sxhash (Lisp_Object
, int);
2434 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2435 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2437 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2438 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2440 void init_weak_hash_tables (void);
2441 extern void init_fns (void) ATTRIBUTE_CONST
;
2443 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2444 ptrdiff_t, ptrdiff_t);
2445 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2446 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2447 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2448 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2449 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2450 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2451 extern void clear_string_char_byte_cache (void);
2452 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2453 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2454 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2455 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2456 extern void syms_of_fns (void);
2458 /* Defined in floatfns.c */
2459 extern double extract_float (Lisp_Object
);
2460 extern void init_floatfns (void);
2461 extern void syms_of_floatfns (void);
2462 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2464 /* Defined in fringe.c */
2465 extern void syms_of_fringe (void);
2466 extern void init_fringe (void);
2467 #ifdef HAVE_WINDOW_SYSTEM
2468 extern void mark_fringe_data (void);
2469 extern void init_fringe_once (void);
2470 #endif /* HAVE_WINDOW_SYSTEM */
2472 /* Defined in image.c */
2473 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2474 extern Lisp_Object QCconversion
;
2475 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2476 extern void syms_of_image (void);
2477 extern void init_image (void) ATTRIBUTE_CONST
;
2479 /* Defined in insdel.c */
2480 extern Lisp_Object Qinhibit_modification_hooks
;
2481 extern void move_gap (ptrdiff_t);
2482 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2483 extern _Noreturn
void buffer_overflow (void);
2484 extern void make_gap (ptrdiff_t);
2485 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2486 ptrdiff_t, int, int);
2487 extern int count_combining_before (const unsigned char *,
2488 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2489 extern int count_combining_after (const unsigned char *,
2490 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2491 extern void insert (const char *, ptrdiff_t);
2492 extern void insert_and_inherit (const char *, ptrdiff_t);
2493 extern void insert_1 (const char *, ptrdiff_t, int, int, int);
2494 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2496 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2497 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2498 ptrdiff_t, ptrdiff_t, int);
2499 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2500 extern void insert_char (int);
2501 extern void insert_string (const char *);
2502 extern void insert_before_markers (const char *, ptrdiff_t);
2503 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2504 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2505 ptrdiff_t, ptrdiff_t,
2507 extern void del_range (ptrdiff_t, ptrdiff_t);
2508 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, int, int);
2509 extern void del_range_byte (ptrdiff_t, ptrdiff_t, int);
2510 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int);
2511 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2512 ptrdiff_t, ptrdiff_t, int);
2513 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2514 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2515 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2516 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2517 ptrdiff_t, ptrdiff_t);
2518 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2519 ptrdiff_t, ptrdiff_t);
2520 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, int, int, int);
2521 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2522 const char *, ptrdiff_t, ptrdiff_t, int);
2523 extern void syms_of_insdel (void);
2525 /* Defined in dispnew.c */
2526 #if (defined PROFILING \
2527 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2528 _Noreturn
void __executable_start (void);
2530 extern Lisp_Object selected_frame
;
2531 extern Lisp_Object Vwindow_system
;
2532 void duration_to_sec_usec (double, int *, int *);
2533 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2534 extern void init_display (void);
2535 extern void syms_of_display (void);
2537 /* Defined in xdisp.c */
2538 extern Lisp_Object Qinhibit_point_motion_hooks
;
2539 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2540 extern Lisp_Object Qmenu_bar_update_hook
;
2541 extern Lisp_Object Qwindow_scroll_functions
;
2542 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2543 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2544 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2545 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2546 extern Lisp_Object Qleft_margin
, Qright_margin
;
2547 extern Lisp_Object Qglyphless_char
;
2548 extern Lisp_Object QCdata
, QCfile
;
2549 extern Lisp_Object QCmap
;
2550 extern Lisp_Object Qrisky_local_variable
;
2551 extern struct frame
*last_glyphless_glyph_frame
;
2552 extern int last_glyphless_glyph_face_id
;
2553 extern int last_glyphless_glyph_merged_face_id
;
2554 extern int noninteractive_need_newline
;
2555 extern Lisp_Object echo_area_buffer
[2];
2556 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2557 extern void check_message_stack (void);
2558 extern void setup_echo_area_for_printing (int);
2559 extern int push_message (void);
2560 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2561 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2562 extern void restore_message (void);
2563 extern Lisp_Object
current_message (void);
2564 extern void clear_message (int, int);
2565 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2566 extern void message1 (const char *);
2567 extern void message1_nolog (const char *);
2568 extern void message2 (const char *, ptrdiff_t, int);
2569 extern void message2_nolog (const char *, ptrdiff_t, int);
2570 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2571 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2572 extern void message_dolog (const char *, ptrdiff_t, int, int);
2573 extern void message_with_string (const char *, Lisp_Object
, int);
2574 extern void message_log_maybe_newline (void);
2575 extern void update_echo_area (void);
2576 extern void truncate_echo_area (ptrdiff_t);
2577 extern void redisplay (void);
2578 extern void redisplay_preserve_echo_area (int);
2579 extern void prepare_menu_bars (void);
2581 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2582 extern void syms_of_xdisp (void);
2583 extern void init_xdisp (void);
2584 extern Lisp_Object
safe_eval (Lisp_Object
);
2585 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2586 int *, int *, int *, int *, int *);
2588 /* Defined in xsettings.c */
2589 extern void syms_of_xsettings (void);
2591 /* Defined in vm-limit.c. */
2592 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2594 /* Defined in alloc.c */
2595 extern void check_pure_size (void);
2596 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2597 extern void reset_malloc_hooks (void);
2598 extern void uninterrupt_malloc (void);
2599 extern void malloc_warning (const char *);
2600 extern _Noreturn
void memory_full (size_t);
2601 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2602 extern int survives_gc_p (Lisp_Object
);
2603 extern void mark_object (Lisp_Object
);
2604 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2605 extern void refill_memory_reserve (void);
2607 extern const char *pending_malloc_warning
;
2608 extern Lisp_Object
*stack_base
;
2609 extern Lisp_Object
list1 (Lisp_Object
);
2610 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2611 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2612 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2613 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2615 extern Lisp_Object
allocate_misc (void);
2616 extern _Noreturn
void string_overflow (void);
2617 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2618 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2619 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2620 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2621 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2622 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2623 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2624 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2625 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2626 extern Lisp_Object
make_specified_string (const char *,
2627 ptrdiff_t, ptrdiff_t, int);
2628 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, int);
2629 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2631 /* Make a string allocated in pure space, use STR as string data. */
2633 static inline Lisp_Object
2634 build_pure_c_string (const char *str
)
2636 return make_pure_c_string (str
, strlen (str
));
2639 /* Make a string from the data at STR, treating it as multibyte if the
2642 static inline Lisp_Object
2643 build_string (const char *str
)
2645 return make_string (str
, strlen (str
));
2648 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2649 extern void make_byte_code (struct Lisp_Vector
*);
2650 extern Lisp_Object Qchar_table_extra_slots
;
2651 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2652 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2653 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2655 allocate_pseudovector \
2656 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2657 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2658 extern struct window
*allocate_window (void);
2659 extern struct frame
*allocate_frame (void);
2660 extern struct Lisp_Process
*allocate_process (void);
2661 extern struct terminal
*allocate_terminal (void);
2662 extern int gc_in_progress
;
2663 extern int abort_on_gc
;
2664 extern Lisp_Object
make_float (double);
2665 extern void display_malloc_warning (void);
2666 extern ptrdiff_t inhibit_garbage_collection (void);
2667 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2668 extern void free_marker (Lisp_Object
);
2669 extern void free_cons (struct Lisp_Cons
*);
2670 extern void init_alloc_once (void);
2671 extern void init_alloc (void);
2672 extern void syms_of_alloc (void);
2673 extern struct buffer
* allocate_buffer (void);
2674 extern int valid_lisp_object_p (Lisp_Object
);
2677 /* Defined in ralloc.c */
2678 extern void *r_alloc (void **, size_t);
2679 extern void r_alloc_free (void **);
2680 extern void *r_re_alloc (void **, size_t);
2681 extern void r_alloc_reset_variable (void **, void **);
2682 extern void r_alloc_inhibit_buffer_relocation (int);
2685 /* Defined in chartab.c */
2686 extern Lisp_Object
copy_char_table (Lisp_Object
);
2687 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2688 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2690 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2691 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2693 extern int char_table_translate (Lisp_Object
, int);
2694 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2696 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2697 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2698 Lisp_Object
, Lisp_Object
,
2699 Lisp_Object
, struct charset
*,
2700 unsigned, unsigned);
2701 extern Lisp_Object
uniprop_table (Lisp_Object
);
2702 extern void syms_of_chartab (void);
2704 /* Defined in print.c */
2705 extern Lisp_Object Vprin1_to_string_buffer
;
2706 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2707 extern Lisp_Object Qstandard_output
;
2708 extern Lisp_Object Qexternal_debugging_output
;
2709 extern void temp_output_buffer_setup (const char *);
2710 extern int print_level
;
2711 extern Lisp_Object Qprint_escape_newlines
;
2712 extern void write_string (const char *, int);
2713 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2715 extern Lisp_Object internal_with_output_to_temp_buffer
2716 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2717 #define FLOAT_TO_STRING_BUFSIZE 350
2718 extern int float_to_string (char *, double);
2719 extern void syms_of_print (void);
2721 /* Defined in doprnt.c */
2722 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2724 extern ptrdiff_t esprintf (char *, char const *, ...)
2725 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2726 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2728 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2729 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2730 char const *, va_list)
2731 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2733 /* Defined in lread.c. */
2734 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2735 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2736 extern Lisp_Object
check_obarray (Lisp_Object
);
2737 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
2738 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
2739 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
2740 #define LOADHIST_ATTACH(x) \
2742 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2744 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2745 Lisp_Object
*, Lisp_Object
);
2746 Lisp_Object
string_to_number (char const *, int, int);
2747 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2749 extern void dir_warning (const char *, Lisp_Object
);
2750 extern void close_load_descs (void);
2751 extern void init_obarray (void);
2752 extern void init_lread (void);
2753 extern void syms_of_lread (void);
2755 static inline Lisp_Object
2756 intern (const char *str
)
2758 return intern_1 (str
, strlen (str
));
2761 static inline Lisp_Object
2762 intern_c_string (const char *str
)
2764 return intern_c_string_1 (str
, strlen (str
));
2767 /* Defined in eval.c. */
2768 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
2769 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2770 extern Lisp_Object Qand_rest
;
2771 extern Lisp_Object Vautoload_queue
;
2772 extern Lisp_Object Vsignaling_function
;
2773 extern Lisp_Object inhibit_lisp_code
;
2774 extern int handling_signal
;
2776 extern struct catchtag
*catchlist
;
2777 extern struct handler
*handlerlist
;
2779 /* To run a normal hook, use the appropriate function from the list below.
2780 The calling convention:
2782 if (!NILP (Vrun_hooks))
2783 call1 (Vrun_hooks, Qmy_funny_hook);
2785 should no longer be used. */
2786 extern Lisp_Object Vrun_hooks
;
2787 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2788 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2789 Lisp_Object (*funcall
)
2790 (ptrdiff_t nargs
, Lisp_Object
*args
));
2791 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
2792 extern _Noreturn
void xsignal0 (Lisp_Object
);
2793 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
2794 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2795 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2797 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
2798 extern Lisp_Object
eval_sub (Lisp_Object form
);
2799 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2800 extern Lisp_Object
call0 (Lisp_Object
);
2801 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2802 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2803 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2804 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2805 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2806 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2807 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2808 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2809 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2810 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2811 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2812 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2813 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2814 extern void specbind (Lisp_Object
, Lisp_Object
);
2815 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2816 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
2817 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2818 extern _Noreturn
void verror (const char *, va_list)
2819 ATTRIBUTE_FORMAT_PRINTF (1, 0);
2820 extern void do_autoload (Lisp_Object
, Lisp_Object
);
2821 extern Lisp_Object
un_autoload (Lisp_Object
);
2822 extern void init_eval_once (void);
2823 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
*);
2824 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
2825 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2826 extern void init_eval (void);
2828 extern void mark_backtrace (void);
2830 extern void syms_of_eval (void);
2832 /* Defined in editfns.c */
2833 extern Lisp_Object Qfield
;
2834 extern void insert1 (Lisp_Object
);
2835 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
2836 extern Lisp_Object
save_excursion_save (void);
2837 extern Lisp_Object
save_restriction_save (void);
2838 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
2839 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
2840 extern _Noreturn
void time_overflow (void);
2841 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, int);
2842 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2844 extern void init_editfns (void);
2845 const char *get_system_name (void);
2846 extern void syms_of_editfns (void);
2847 extern void set_time_zone_rule (const char *);
2849 /* Defined in buffer.c */
2850 extern int mouse_face_overlay_overlaps (Lisp_Object
);
2851 extern _Noreturn
void nsberror (Lisp_Object
);
2852 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
2853 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
2854 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
2855 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
2856 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2857 extern int overlay_touches_p (ptrdiff_t);
2858 extern Lisp_Object Vbuffer_alist
;
2859 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
2860 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
2861 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
2862 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
2863 extern struct buffer
*all_buffers
;
2864 extern void init_buffer_once (void);
2865 extern void init_buffer (void);
2866 extern void syms_of_buffer (void);
2867 extern void keys_of_buffer (void);
2869 /* Defined in marker.c */
2871 extern ptrdiff_t marker_position (Lisp_Object
);
2872 extern ptrdiff_t marker_byte_position (Lisp_Object
);
2873 extern void clear_charpos_cache (struct buffer
*);
2874 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
2875 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
2876 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
2877 extern void unchain_marker (struct Lisp_Marker
*marker
);
2878 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2879 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
2880 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
2881 ptrdiff_t, ptrdiff_t);
2882 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
2883 extern void syms_of_marker (void);
2885 /* Defined in fileio.c */
2887 extern Lisp_Object Qfile_error
;
2888 extern Lisp_Object Qfile_exists_p
;
2889 extern Lisp_Object Qfile_directory_p
;
2890 extern Lisp_Object Qinsert_file_contents
;
2891 extern Lisp_Object Qfile_name_history
;
2892 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
2893 EXFUN (Fread_file_name
, 6); /* not a normal DEFUN */
2894 extern Lisp_Object
close_file_unwind (Lisp_Object
);
2895 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
2896 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
2897 extern int internal_delete_file (Lisp_Object
);
2898 extern void syms_of_fileio (void);
2899 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
2900 extern Lisp_Object Qdelete_file
;
2902 /* Defined in search.c */
2903 extern void shrink_regexp_cache (void);
2904 extern void restore_search_regs (void);
2905 extern void record_unwind_save_match_data (void);
2906 struct re_registers
;
2907 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
2908 struct re_registers
*,
2909 Lisp_Object
, int, int);
2910 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
2911 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
2913 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
2914 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2915 ptrdiff_t, ptrdiff_t, Lisp_Object
);
2916 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2918 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2920 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
2921 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
2922 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2923 extern void syms_of_search (void);
2924 extern void clear_regexp_cache (void);
2926 /* Defined in minibuf.c */
2928 extern Lisp_Object Qcompletion_ignore_case
;
2929 extern Lisp_Object Vminibuffer_list
;
2930 extern Lisp_Object last_minibuf_string
;
2931 extern Lisp_Object
get_minibuffer (EMACS_INT
);
2932 extern void init_minibuf_once (void);
2933 extern void syms_of_minibuf (void);
2935 /* Defined in callint.c */
2937 extern Lisp_Object Qminus
, Qplus
;
2938 extern Lisp_Object Qwhen
;
2939 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
2940 extern void syms_of_callint (void);
2942 /* Defined in casefiddle.c */
2944 extern Lisp_Object Qidentity
;
2945 extern void syms_of_casefiddle (void);
2946 extern void keys_of_casefiddle (void);
2948 /* Defined in casetab.c */
2950 extern void init_casetab_once (void);
2951 extern void syms_of_casetab (void);
2953 /* Defined in keyboard.c */
2955 extern Lisp_Object echo_message_buffer
;
2956 extern struct kboard
*echo_kboard
;
2957 extern void cancel_echoing (void);
2958 extern Lisp_Object Qdisabled
, QCfilter
;
2959 extern Lisp_Object Qup
, Qdown
, Qbottom
;
2960 extern Lisp_Object Qtop
;
2961 extern int input_pending
;
2962 extern Lisp_Object
menu_bar_items (Lisp_Object
);
2963 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
2964 extern void discard_mouse_events (void);
2965 extern Lisp_Object pending_funcalls
;
2966 extern int detect_input_pending (void);
2967 extern int detect_input_pending_ignore_squeezables (void);
2968 extern int detect_input_pending_run_timers (int);
2969 extern void safe_run_hooks (Lisp_Object
);
2970 extern void cmd_error_internal (Lisp_Object
, const char *);
2971 extern Lisp_Object
command_loop_1 (void);
2972 extern Lisp_Object
recursive_edit_1 (void);
2973 extern void record_auto_save (void);
2975 extern void force_auto_save_soon (void);
2977 extern void init_keyboard (void);
2978 extern void syms_of_keyboard (void);
2979 extern void keys_of_keyboard (void);
2981 /* Defined in indent.c */
2982 extern ptrdiff_t current_column (void);
2983 extern void invalidate_current_column (void);
2984 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
2985 extern void syms_of_indent (void);
2987 /* Defined in frame.c */
2988 extern Lisp_Object Qonly
;
2989 extern Lisp_Object Qvisible
;
2990 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
2991 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
2992 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
2994 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
2996 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
2997 extern void frames_discard_buffer (Lisp_Object
);
2998 extern void syms_of_frame (void);
3000 /* Defined in emacs.c */
3001 extern char **initial_argv
;
3002 extern int initial_argc
;
3003 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3004 extern int display_arg
;
3006 extern Lisp_Object
decode_env_path (const char *, const char *);
3007 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3008 extern Lisp_Object Qfile_name_handler_alist
;
3009 #ifdef FLOAT_CATCH_SIGILL
3010 extern void fatal_error_signal (int);
3012 extern Lisp_Object Qkill_emacs
;
3014 void fixup_locale (void);
3015 void synchronize_system_messages_locale (void);
3016 void synchronize_system_time_locale (void);
3018 #define setlocale(category, locale)
3019 #define fixup_locale()
3020 #define synchronize_system_messages_locale()
3021 #define synchronize_system_time_locale()
3023 void shut_down_emacs (int, int, Lisp_Object
);
3024 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3025 extern int noninteractive
;
3027 /* Nonzero means remove site-lisp directories from load-path. */
3028 extern int no_site_lisp
;
3030 /* Pipe used to send exit notification to the daemon parent at
3032 extern int daemon_pipe
[2];
3033 #define IS_DAEMON (daemon_pipe[1] != 0)
3035 /* Nonzero means don't do use window-system-specific display code. */
3036 extern int inhibit_window_system
;
3037 /* Nonzero means that a filter or a sentinel is running. */
3038 extern int running_asynch_code
;
3040 /* Defined in process.c. */
3041 extern Lisp_Object QCtype
, Qlocal
;
3042 extern Lisp_Object Qprocessp
;
3043 extern void kill_buffer_processes (Lisp_Object
);
3044 extern int wait_reading_process_output (intmax_t, int, int, int,
3046 struct Lisp_Process
*,
3048 /* Max value for the first argument of wait_reading_process_output. */
3049 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3050 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3051 The bug merely causes a bogus warning, but the warning is annoying. */
3052 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3054 # define WAIT_READING_MAX INTMAX_MAX
3056 extern void add_keyboard_wait_descriptor (int);
3057 extern void delete_keyboard_wait_descriptor (int);
3059 extern void add_gpm_wait_descriptor (int);
3060 extern void delete_gpm_wait_descriptor (int);
3062 extern void close_process_descs (void);
3063 extern void init_process_emacs (void);
3064 extern void syms_of_process (void);
3065 extern void setup_process_coding_systems (Lisp_Object
);
3070 extern int child_setup (int, int, int, char **, int, Lisp_Object
);
3071 extern void init_callproc_1 (void);
3072 extern void init_callproc (void);
3073 extern void set_initial_environment (void);
3074 extern void syms_of_callproc (void);
3076 /* Defined in doc.c */
3077 extern Lisp_Object Qfunction_documentation
;
3078 extern Lisp_Object
read_doc_string (Lisp_Object
);
3079 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3080 extern void syms_of_doc (void);
3081 extern int read_bytecode_char (int);
3083 /* Defined in bytecode.c */
3084 extern Lisp_Object Qbytecode
;
3085 extern void syms_of_bytecode (void);
3086 extern struct byte_stack
*byte_stack_list
;
3088 extern void mark_byte_stack (void);
3090 extern void unmark_byte_stack (void);
3091 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3092 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3094 /* Defined in macros.c */
3095 extern Lisp_Object Qexecute_kbd_macro
;
3096 extern void init_macros (void);
3097 extern void syms_of_macros (void);
3099 /* Defined in undo.c */
3100 extern Lisp_Object Qapply
;
3101 extern Lisp_Object Qinhibit_read_only
;
3102 extern void truncate_undo_list (struct buffer
*);
3103 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3104 extern void record_insert (ptrdiff_t, ptrdiff_t);
3105 extern void record_delete (ptrdiff_t, Lisp_Object
);
3106 extern void record_first_change (void);
3107 extern void record_change (ptrdiff_t, ptrdiff_t);
3108 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3109 Lisp_Object
, Lisp_Object
,
3111 extern void syms_of_undo (void);
3112 /* Defined in textprop.c */
3113 extern Lisp_Object Qfont
, Qmouse_face
;
3114 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3115 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3116 extern Lisp_Object Qminibuffer_prompt
;
3118 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3120 /* Defined in menu.c */
3121 extern void syms_of_menu (void);
3123 /* Defined in xmenu.c */
3124 extern void syms_of_xmenu (void);
3126 /* Defined in termchar.h */
3127 struct tty_display_info
;
3129 /* Defined in termhooks.h */
3132 /* Defined in sysdep.c */
3133 #ifndef HAVE_GET_CURRENT_DIR_NAME
3134 extern char *get_current_dir_name (void);
3136 extern void stuff_char (char c
);
3137 extern void init_sigio (int);
3138 extern void sys_subshell (void);
3139 extern void sys_suspend (void);
3140 extern void discard_tty_input (void);
3141 extern void init_sys_modes (struct tty_display_info
*);
3142 extern void reset_sys_modes (struct tty_display_info
*);
3143 extern void init_all_sys_modes (void);
3144 extern void reset_all_sys_modes (void);
3145 extern void wait_for_termination (pid_t
);
3146 extern void interruptible_wait_for_termination (pid_t
);
3147 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3148 extern void child_setup_tty (int);
3149 extern void setup_pty (int);
3150 extern int set_window_size (int, int, int);
3151 extern EMACS_INT
get_random (void);
3152 extern void seed_random (long);
3153 extern int emacs_open (const char *, int, int);
3154 extern int emacs_close (int);
3155 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3156 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3157 enum { READLINK_BUFSIZE
= 1024 };
3158 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3160 extern void unlock_all_files (void);
3161 extern void lock_file (Lisp_Object
);
3162 extern void unlock_file (Lisp_Object
);
3163 extern void unlock_buffer (struct buffer
*);
3164 extern void syms_of_filelock (void);
3165 extern void init_filelock (void);
3167 /* Defined in sound.c */
3168 extern void syms_of_sound (void);
3169 extern void init_sound (void) ATTRIBUTE_CONST
;
3171 /* Defined in category.c */
3172 extern void init_category_once (void);
3173 extern Lisp_Object
char_category_set (int);
3174 extern void syms_of_category (void);
3176 /* Defined in ccl.c */
3177 extern void syms_of_ccl (void);
3179 /* Defined in dired.c */
3180 extern void syms_of_dired (void);
3181 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3182 Lisp_Object
, Lisp_Object
,
3185 /* Defined in term.c */
3186 extern int *char_ins_del_vector
;
3187 extern void mark_ttys (void);
3188 extern void syms_of_term (void);
3189 extern _Noreturn
void fatal (const char *msgid
, ...)
3190 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3192 /* Defined in terminal.c */
3193 extern void syms_of_terminal (void);
3195 /* Defined in font.c */
3196 extern void syms_of_font (void);
3197 extern void init_font (void);
3199 #ifdef HAVE_WINDOW_SYSTEM
3200 /* Defined in fontset.c */
3201 extern void syms_of_fontset (void);
3203 /* Defined in xfns.c, w32fns.c, or macfns.c */
3204 extern Lisp_Object Qfont_param
;
3207 /* Defined in xfaces.c */
3208 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3209 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3210 extern Lisp_Object Qmode_line_inactive
;
3211 extern Lisp_Object Qface
;
3212 extern Lisp_Object Qnormal
;
3213 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3214 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3215 extern Lisp_Object Vface_alternative_font_family_alist
;
3216 extern Lisp_Object Vface_alternative_font_registry_alist
;
3217 extern void syms_of_xfaces (void);
3219 #ifdef HAVE_X_WINDOWS
3220 /* Defined in xfns.c */
3221 extern void syms_of_xfns (void);
3223 /* Defined in xsmfns.c */
3224 extern void syms_of_xsmfns (void);
3226 /* Defined in xselect.c */
3227 extern void syms_of_xselect (void);
3229 /* Defined in xterm.c */
3230 extern void syms_of_xterm (void);
3231 #endif /* HAVE_X_WINDOWS */
3233 #ifdef HAVE_WINDOW_SYSTEM
3234 /* Defined in xterm.c, nsterm.m, w32term.c */
3235 extern char *x_get_keysym_name (int);
3236 #endif /* HAVE_WINDOW_SYSTEM */
3239 /* Defined in xml.c */
3240 extern void syms_of_xml (void);
3241 extern void xml_cleanup_parser (void);
3245 /* Defined in (x|w32)fns.c, nsfns.m... */
3246 extern int have_menus_p (void);
3250 /* Defined in dbusbind.c */
3251 void syms_of_dbusbind (void);
3255 /* Defined in msdos.c, w32.c */
3256 extern char *emacs_root_dir (void);
3259 /* Nonzero means Emacs has already been initialized.
3260 Used during startup to detect startup of dumped Emacs. */
3261 extern int initialized
;
3263 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3265 extern void *xmalloc (size_t);
3266 extern void *xzalloc (size_t);
3267 extern void *xrealloc (void *, size_t);
3268 extern void xfree (void *);
3269 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3270 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3271 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3273 extern char *xstrdup (const char *);
3275 extern char *egetenv (const char *);
3277 /* Set up the name of the machine we're running on. */
3278 extern void init_system_name (void);
3280 /* Some systems (e.g., NT) use a different path separator than Unix,
3281 in addition to a device separator. Set the path separator
3282 to '/', and don't test for a device separator in IS_ANY_SEP. */
3284 #define DIRECTORY_SEP '/'
3285 #ifndef IS_DIRECTORY_SEP
3286 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3288 #ifndef IS_DEVICE_SEP
3290 #define IS_DEVICE_SEP(_c_) 0
3292 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3296 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3299 #define SWITCH_ENUM_CAST(x) (x)
3301 /* Use this to suppress gcc's warnings. */
3304 /* Use CODE only if lint checking is in effect. */
3305 # define IF_LINT(Code) Code
3307 /* Assume that the expression COND is true. This differs in intent
3308 from 'assert', as it is a message from the programmer to the compiler. */
3309 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3312 # define IF_LINT(Code) /* empty */
3313 # define lint_assume(cond) ((void) (0 && (cond)))
3316 /* The ubiquitous min and max macros. */
3322 #define min(a, b) ((a) < (b) ? (a) : (b))
3323 #define max(a, b) ((a) > (b) ? (a) : (b))
3325 /* We used to use `abs', but that clashes with system headers on some
3326 platforms, and using a name reserved by Standard C is a bad idea
3329 #define eabs(x) ((x) < 0 ? -(x) : (x))
3332 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3335 #define make_fixnum_or_float(val) \
3336 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3339 /* Checks the `cycle check' variable CHECK to see if it indicates that
3340 EL is part of a cycle; CHECK must be either Qnil or a value returned
3341 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3342 elements after which a cycle might be suspected; after that many
3343 elements, this macro begins consing in order to keep more precise
3346 Returns nil if a cycle was detected, otherwise a new value for CHECK
3349 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3350 the caller should make sure that's ok. */
3352 #define CYCLE_CHECK(check, el, suspicious) \
3355 : (INTEGERP (check) \
3356 ? (XFASTINT (check) < (suspicious) \
3357 ? make_number (XFASTINT (check) + 1) \
3358 : Fcons (el, Qnil)) \
3359 : (!NILP (Fmemq ((el), (check))) \
3361 : Fcons ((el), (check)))))
3364 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3365 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3367 #define MAX_ALLOCA 16*1024
3369 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3371 #define USE_SAFE_ALLOCA \
3372 ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0
3374 /* SAFE_ALLOCA allocates a simple buffer. */
3376 #define SAFE_ALLOCA(buf, type, size) \
3378 if ((size) < MAX_ALLOCA) \
3379 buf = (type) alloca (size); \
3382 buf = xmalloc (size); \
3384 record_unwind_protect (safe_alloca_unwind, \
3385 make_save_value (buf, 0)); \
3389 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3390 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3391 positive. The code is tuned for MULTIPLIER being a constant. */
3393 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3395 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3396 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3399 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3401 record_unwind_protect (safe_alloca_unwind, \
3402 make_save_value (buf, 0)); \
3406 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3408 #define SAFE_FREE() \
3410 if (sa_must_free) { \
3412 unbind_to (sa_count, Qnil); \
3417 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3419 #define SAFE_ALLOCA_LISP(buf, nelt) \
3421 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3422 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3423 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3426 buf = xmalloc ((nelt) * sizeof (Lisp_Object)); \
3427 arg_ = make_save_value (buf, nelt); \
3428 XSAVE_VALUE (arg_)->dogc = 1; \
3430 record_unwind_protect (safe_alloca_unwind, arg_); \
3433 memory_full (SIZE_MAX); \
3437 #include "globals.h"
3439 #endif /* EMACS_LISP_H */