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/>. */
31 /* EMACS_INT - signed integer wide enough to hold an Emacs value
32 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
33 pI - printf length modifier for EMACS_INT
34 EMACS_UINT - unsigned variant of EMACS_INT */
36 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
37 typedef long long int EMACS_INT
;
38 typedef unsigned long long int EMACS_UINT
;
39 # define EMACS_INT_MAX LLONG_MAX
41 # elif INT_MAX < LONG_MAX
42 typedef long int EMACS_INT
;
43 typedef unsigned long int EMACS_UINT
;
44 # define EMACS_INT_MAX LONG_MAX
47 typedef int EMACS_INT
;
48 typedef unsigned int EMACS_UINT
;
49 # define EMACS_INT_MAX INT_MAX
54 /* Number of bits in some machine integer types. */
57 BITS_PER_CHAR
= CHAR_BIT
,
58 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
59 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
60 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
61 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
64 /* printmax_t and uprintmax_t are types for printing large integers.
65 These are the widest integers that are supported for printing.
66 pMd etc. are conversions for printing them.
67 On C99 hosts, there's no problem, as even the widest integers work.
68 Fall back on EMACS_INT on pre-C99 hosts. */
70 typedef intmax_t printmax_t
;
71 typedef uintmax_t uprintmax_t
;
75 typedef EMACS_INT printmax_t
;
76 typedef EMACS_UINT uprintmax_t
;
81 /* Use pD to format ptrdiff_t values, which suffice for indexes into
82 buffers and strings. Emacs never allocates objects larger than
83 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
84 In C99, pD can always be "t"; configure it here for the sake of
85 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
86 #if PTRDIFF_MAX == INT_MAX
88 #elif PTRDIFF_MAX == LONG_MAX
90 #elif PTRDIFF_MAX == LLONG_MAX
96 /* Extra internal type checking? */
98 /* Define an Emacs version of 'assert (COND)', since some
99 system-defined 'assert's are flaky. COND should be free of side
100 effects; it may or may not be evaluated. */
101 #ifndef ENABLE_CHECKING
102 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
103 #else /* ENABLE_CHECKING */
105 extern _Noreturn
void die (const char *, const char *, int);
107 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
108 it to 1 using a debugger to temporarily disable aborting on
109 detected internal inconsistencies or error conditions.
111 In some cases, a good compiler may be able to optimize away the
112 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
113 STRINGP (x), but a particular use of XSTRING is invoked only after
114 testing that STRINGP (x) is true, making the test redundant. */
115 extern int suppress_checking EXTERNALLY_VISIBLE
;
117 # define eassert(cond) \
118 ((cond) || suppress_checking \
120 : die ("assertion failed: " # cond, __FILE__, __LINE__))
121 #endif /* ENABLE_CHECKING */
123 /* Use the configure flag --enable-check-lisp-object-type to make
124 Lisp_Object use a struct type instead of the default int. The flag
125 causes CHECK_LISP_OBJECT_TYPE to be defined. */
127 /***** Select the tagging scheme. *****/
128 /* The following option controls the tagging scheme:
129 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
130 always 0, and we can thus use them to hold tag bits, without
131 restricting our addressing space.
133 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
134 restricting our possible address range.
136 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
137 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
138 on the few static Lisp_Objects used: all the defsubr as well
139 as the two special buffers buffer_defaults and buffer_local_symbols. */
143 /* Number of bits in a Lisp_Object tag. This can be used in #if,
144 and for GDB's sake also as a regular symbol. */
149 /* 2**GCTYPEBITS. This must also be a macro that expands to a
150 literal integer constant, for MSVC. */
152 #define GCALIGNMENT 8
155 /* Number of bits in a Lisp_Object value, not counting the tag. */
156 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
158 /* Number of bits in a Lisp fixnum tag. */
159 INTTYPEBITS
= GCTYPEBITS
- 1,
161 /* Number of bits in a Lisp fixnum value, not counting the tag. */
162 FIXNUM_BITS
= VALBITS
+ 1
165 #if GCALIGNMENT != 1 << GCTYPEBITS
166 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
169 /* The maximum value that can be stored in a EMACS_INT, assuming all
170 bits other than the type bits contribute to a nonnegative signed value.
171 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
172 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
174 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
176 /* 1. We know malloc returns a multiple of 8. */
177 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
178 || defined DARWIN_OS || defined __sun)
179 /* 2. We can specify multiple-of-8 alignment on static variables. */
181 /* 3. Pointers-as-ints exceed VAL_MAX.
182 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
183 a. unnecessary, because the top bits of an EMACS_INT are unused, and
184 b. slower, because it typically requires extra masking.
185 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
186 # if VAL_MAX < UINTPTR_MAX
187 # define USE_LSB_TAG 1
194 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
195 # define USE_LSB_TAG 1
197 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
198 # define USE_LSB_TAG 0
202 # define alignas(alignment) /* empty */
204 # error "USE_LSB_TAG requires alignas"
209 /* Define the fundamental Lisp data structures. */
211 /* This is the set of Lisp data types. */
213 /* Lisp integers use 2 tags, to give them one extra bit, thus
214 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
215 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
216 #define LISP_INT_TAG Lisp_Int0
217 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
218 #define LISP_INT1_TAG (USE_LSB_TAG ? 1 << INTTYPEBITS : 1)
219 #define LISP_STRING_TAG (5 - LISP_INT1_TAG)
220 #define LISP_INT_TAG_P(x) (((x) & ~LISP_INT1_TAG) == 0)
222 /* Stolen from GDB. The only known compiler that doesn't support
223 enums in bitfields is MSVC. */
225 #define ENUM_BF(TYPE) unsigned int
227 #define ENUM_BF(TYPE) enum TYPE
233 /* Integer. XINT (obj) is the integer value. */
235 Lisp_Int1
= LISP_INT1_TAG
,
237 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
240 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
241 whose first member indicates the subtype. */
244 /* String. XSTRING (object) points to a struct Lisp_String.
245 The length of the string, and its contents, are stored therein. */
246 Lisp_String
= LISP_STRING_TAG
,
248 /* Vector of Lisp objects, or something resembling it.
249 XVECTOR (object) points to a struct Lisp_Vector, which contains
250 the size and contents. The size field also contains the type
251 information, if it's not a real vector object. */
254 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
260 /* This is the set of data types that share a common structure.
261 The first member of the structure is a type code from this set.
262 The enum values are arbitrary, but we'll use large numbers to make it
263 more likely that we'll spot the error if a random word in memory is
264 mistakenly interpreted as a Lisp_Misc. */
267 Lisp_Misc_Free
= 0x5eab,
270 Lisp_Misc_Save_Value
,
271 /* Currently floats are not a misc type,
272 but let's define this in case we want to change that. */
274 /* This is not a type code. It is for range checking. */
278 /* These are the types of forwarding objects used in the value slot
279 of symbols for special built-in variables whose value is stored in
283 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
284 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
285 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
286 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
287 Lisp_Fwd_Kboard_Obj
, /* Fwd to a Lisp_Object field of kboards. */
290 #ifdef CHECK_LISP_OBJECT_TYPE
292 typedef struct { EMACS_INT i
; } Lisp_Object
;
295 static inline Lisp_Object
298 Lisp_Object o
= { i
};
302 static inline Lisp_Object
303 LISP_MAKE_RVALUE (Lisp_Object o
)
308 #define LISP_INITIALLY_ZERO {0}
310 #undef CHECK_LISP_OBJECT_TYPE
311 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
312 #else /* CHECK_LISP_OBJECT_TYPE */
314 /* If a struct type is not wanted, define Lisp_Object as just a number. */
316 typedef EMACS_INT Lisp_Object
;
319 #define LISP_MAKE_RVALUE(o) (0+(o))
320 #define LISP_INITIALLY_ZERO 0
321 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
322 #endif /* CHECK_LISP_OBJECT_TYPE */
324 /* In the size word of a vector, this bit means the vector has been marked. */
326 #define ARRAY_MARK_FLAG PTRDIFF_MIN
328 /* In the size word of a struct Lisp_Vector, this bit means it's really
329 some other vector-like object. */
330 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
332 /* In a pseudovector, the size field actually contains a word with one
333 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
334 indicate the actual type.
335 We use a bitset, even tho only one of the bits can be set at any
336 particular time just so as to be able to use micro-optimizations such as
337 testing membership of a particular subset of pseudovectors in Fequal.
338 It is not crucial, but there are plenty of bits here, so why not do it? */
341 PVEC_NORMAL_VECTOR
= 0, /* Unused! */
350 PVEC_WINDOW_CONFIGURATION
,
353 /* These last 4 are special because we OR them in fns.c:internal_equal,
354 so they have to use a disjoint bit pattern:
355 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
356 | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
357 PVEC_COMPILED
= 0x10,
358 PVEC_CHAR_TABLE
= 0x20,
359 PVEC_SUB_CHAR_TABLE
= 0x30,
363 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
364 which were stored in a Lisp_Object. */
365 #ifndef DATA_SEG_BITS
366 # define DATA_SEG_BITS 0
368 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
373 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
375 /* For convenience, we also store the number of elements in these bits.
376 Note that this size is not necessarily the memory-footprint size, but
377 only the number of Lisp_Object fields (that need to be traced by GC).
378 The distinction is used, e.g., by Lisp_Process, which places extra
379 non-Lisp_Object fields at the end of the structure. */
380 PSEUDOVECTOR_SIZE_BITS
= 16,
381 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
382 PVEC_TYPE_MASK
= 0x0fff << PSEUDOVECTOR_SIZE_BITS
,
384 /* Number of bits to put in each character in the internal representation
385 of bool vectors. This should not vary across implementations. */
386 BOOL_VECTOR_BITS_PER_CHAR
= 8
389 /* These macros extract various sorts of values from a Lisp_Object.
390 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
391 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
393 /* Return a perfect hash of the Lisp_Object representation. */
394 #define XHASH(a) XLI (a)
398 #define VALMASK (-1 << GCTYPEBITS)
399 #define TYPEMASK ((1 << GCTYPEBITS) - 1)
400 #define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
401 #define XINT(a) (XLI (a) >> INTTYPEBITS)
402 #define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
403 #define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
404 #define XSET(var, type, ptr) \
405 (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment. */ \
406 (var) = XIL ((type) | (intptr_t) (ptr)))
408 #define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
409 #define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
411 #else /* not USE_LSB_TAG */
413 #define VALMASK VAL_MAX
415 #define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
417 /* For integers known to be positive, XFASTINT provides fast retrieval
418 and XSETFASTINT provides fast storage. This takes advantage of the
419 fact that Lisp integers have zero-bits in their tags. */
420 #define XFASTINT(a) (XLI (a) + 0)
421 #define XSETFASTINT(a, b) ((a) = XIL (b))
423 /* Extract the value of a Lisp_Object as a (un)signed integer. */
425 #define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
426 #define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
427 #define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
429 #define XSET(var, type, ptr) \
430 ((var) = XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
431 + ((intptr_t) (ptr) & VALMASK)))
434 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
435 which were stored in a Lisp_Object */
436 #define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
438 #define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
441 #endif /* not USE_LSB_TAG */
443 /* For integers known to be positive, XFASTINT sometimes provides
444 faster retrieval and XSETFASTINT provides faster storage.
445 If not, fallback on the non-accelerated path. */
447 # define XFASTINT(a) (XINT (a))
448 # define XSETFASTINT(a, b) (XSETINT (a, b))
451 /* Extract the pointer value of the Lisp object A, under the
452 assumption that A's type is TYPE. This is a fallback
453 implementation if nothing faster is available. */
455 # define XUNTAG(a, type) XPNTR (a)
458 #define EQ(x, y) (XHASH (x) == XHASH (y))
460 /* Largest and smallest representable fixnum values. These are the C
462 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
463 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
465 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
466 written this way so that it also works if I is of unsigned
467 type or if I is a NaN. */
469 #define FIXNUM_OVERFLOW_P(i) \
470 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
472 static inline ptrdiff_t
473 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
475 return num
< lower
? lower
: num
<= upper
? num
: upper
;
478 /* Extract a value or address from a Lisp_Object. */
480 #define XCONS(a) (eassert (CONSP (a)), \
481 (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
482 #define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
483 (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
484 #define XSTRING(a) (eassert (STRINGP (a)), \
485 (struct Lisp_String *) XUNTAG (a, Lisp_String))
486 #define XSYMBOL(a) (eassert (SYMBOLP (a)), \
487 (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
488 #define XFLOAT(a) (eassert (FLOATP (a)), \
489 (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
493 #define XMISC(a) ((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
494 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC (a)->u_any))
495 #define XMISCTYPE(a) (XMISCANY (a)->type)
496 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC (a)->u_marker))
497 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC (a)->u_overlay))
498 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC (a)->u_save_value))
500 /* Forwarding object types. */
502 #define XFWDTYPE(a) (a->u_intfwd.type)
503 #define XINTFWD(a) (eassert (INTFWDP (a)), &((a)->u_intfwd))
504 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
505 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &((a)->u_objfwd))
506 #define XBUFFER_OBJFWD(a) \
507 (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
508 #define XKBOARD_OBJFWD(a) \
509 (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
511 /* Pseudovector types. */
513 #define XPROCESS(a) (eassert (PROCESSP (a)), \
514 (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
515 #define XWINDOW(a) (eassert (WINDOWP (a)), \
516 (struct window *) XUNTAG (a, Lisp_Vectorlike))
517 #define XTERMINAL(a) (eassert (TERMINALP (a)), \
518 (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
519 #define XSUBR(a) (eassert (SUBRP (a)), \
520 (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
521 #define XBUFFER(a) (eassert (BUFFERP (a)), \
522 (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
523 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
524 (struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
525 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
526 ((struct Lisp_Sub_Char_Table *) \
527 XUNTAG (a, Lisp_Vectorlike)))
528 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
529 ((struct Lisp_Bool_Vector *) \
530 XUNTAG (a, Lisp_Vectorlike)))
532 /* Construct a Lisp_Object from a value or address. */
534 #define XSETINT(a, b) (a) = make_number (b)
535 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
536 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
537 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
538 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
539 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
543 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
544 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
546 /* Pseudovector types. */
548 #define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
549 #define XSETTYPED_PVECTYPE(v, size_member, code) \
550 ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
551 #define XSETPVECTYPESIZE(v, code, sizeval) \
552 ((v)->header.size = (PSEUDOVECTOR_FLAG \
553 | ((code) << PSEUDOVECTOR_SIZE_BITS) \
556 /* The cast to struct vectorlike_header * avoids aliasing issues. */
557 #define XSETPSEUDOVECTOR(a, b, code) \
558 XSETTYPED_PSEUDOVECTOR (a, b, \
559 (((struct vectorlike_header *) \
560 XUNTAG (a, Lisp_Vectorlike)) \
563 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
564 (XSETVECTOR (a, b), \
565 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
566 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
568 #define XSETWINDOW_CONFIGURATION(a, b) \
569 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
570 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
571 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
572 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
573 /* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header. */
574 #define XSETSUBR(a, b) \
575 XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
576 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
577 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
578 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
579 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
580 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
582 /* Convenience macros for dealing with Lisp arrays. */
584 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
585 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->header.size
586 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
587 #define ASET(ARRAY, IDX, VAL) \
588 (eassert ((IDX) == (IDX)), \
589 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
590 AREF ((ARRAY), (IDX)) = (VAL))
592 /* Convenience macros for dealing with Lisp strings. */
594 #define SDATA(string) (XSTRING (string)->data + 0)
595 #define SREF(string, index) (SDATA (string)[index] + 0)
596 #define SSET(string, index, new) (SDATA (string)[index] = (new))
597 #define SCHARS(string) (XSTRING (string)->size + 0)
598 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
600 /* Avoid "differ in sign" warnings. */
601 #define SSDATA(x) ((char *) SDATA (x))
603 #define STRING_SET_CHARS(string, newsize) \
604 (XSTRING (string)->size = (newsize))
606 #define STRING_COPYIN(string, index, new, count) \
607 memcpy (SDATA (string) + index, new, count)
611 #define CHECK_TYPE(ok, Qxxxp, x) \
612 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
616 /* See the macros in intervals.h. */
618 typedef struct interval
*INTERVAL
;
620 /* Complain if object is not string or buffer type */
621 #define CHECK_STRING_OR_BUFFER(x) \
622 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
625 /* In a cons, the markbit of the car is the gc mark bit */
629 /* Please do not use the names of these elements in code other
630 than the core lisp implementation. Use XCAR and XCDR below. */
635 struct Lisp_Cons
*chain
;
639 /* Take the car or cdr of something known to be a cons cell. */
640 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
641 of code that has to know what a cons cell looks like. Other code not
642 part of the basic lisp implementation should assume that the car and cdr
643 fields are not accessible as lvalues. (What if we want to switch to
644 a copying collector someday? Cached cons cell field addresses may be
645 invalidated at arbitrary points.) */
646 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
647 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
649 /* Use these from normal code. */
650 #define XCAR(c) LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
651 #define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
653 /* Use these to set the fields of a cons cell.
655 Note that both arguments may refer to the same object, so 'n'
656 should not be read after 'c' is first modified. Also, neither
657 argument should be evaluated more than once; side effects are
658 especially common in the second argument. */
659 #define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
660 #define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
662 /* Take the car or cdr of something whose type is not known. */
664 (CONSP ((c)) ? XCAR ((c)) \
665 : NILP ((c)) ? Qnil \
666 : wrong_type_argument (Qlistp, (c)))
669 (CONSP ((c)) ? XCDR ((c)) \
670 : NILP ((c)) ? Qnil \
671 : wrong_type_argument (Qlistp, (c)))
673 /* Take the car or cdr of something whose type is not known. */
674 #define CAR_SAFE(c) \
675 (CONSP ((c)) ? XCAR ((c)) : Qnil)
677 #define CDR_SAFE(c) \
678 (CONSP ((c)) ? XCDR ((c)) : Qnil)
680 /* Nonzero if STR is a multibyte string. */
681 #define STRING_MULTIBYTE(STR) \
682 (XSTRING (STR)->size_byte >= 0)
684 /* Return the length in bytes of STR. */
686 #ifdef GC_CHECK_STRING_BYTES
689 extern ptrdiff_t string_bytes (struct Lisp_String
*);
690 #define STRING_BYTES(S) string_bytes ((S))
692 #else /* not GC_CHECK_STRING_BYTES */
694 #define STRING_BYTES(STR) \
695 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
697 #endif /* not GC_CHECK_STRING_BYTES */
699 /* An upper bound on the number of bytes in a Lisp string, not
700 counting the terminating null. This a tight enough bound to
701 prevent integer overflow errors that would otherwise occur during
702 string size calculations. A string cannot contain more bytes than
703 a fixnum can represent, nor can it be so long that C pointer
704 arithmetic stops working on the string plus its terminating null.
705 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
706 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
707 would expose alloc.c internal details that we'd rather keep
708 private. The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is
710 #define STRING_BYTES_BOUND \
711 min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1)
713 /* Mark STR as a unibyte string. */
714 #define STRING_SET_UNIBYTE(STR) \
715 do { if (EQ (STR, empty_multibyte_string)) \
716 (STR) = empty_unibyte_string; \
717 else XSTRING (STR)->size_byte = -1; } while (0)
719 /* Mark STR as a multibyte string. Assure that STR contains only
720 ASCII characters in advance. */
721 #define STRING_SET_MULTIBYTE(STR) \
722 do { if (EQ (STR, empty_unibyte_string)) \
723 (STR) = empty_multibyte_string; \
724 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
726 /* Get text properties. */
727 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
729 /* Set text properties. */
730 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
732 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
738 INTERVAL intervals
; /* Text properties in this string. */
742 /* Header of vector-like objects. This documents the layout constraints on
743 vectors and pseudovectors other than struct Lisp_Subr. It also prevents
744 compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
745 and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
746 because when two such pointers potentially alias, a compiler won't
747 incorrectly reorder loads and stores to their size fields. See
748 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
749 struct vectorlike_header
751 /* This field contains various pieces of information:
752 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
753 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
754 vector (0) or a pseudovector (1).
755 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
756 of slots) of the vector.
757 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
758 a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
759 PSEUDOVECTOR_SIZE_BITS. That size normally indicates the number of
760 Lisp_Object slots at the beginning of the object that need to be
761 traced by the GC, tho some types use it slightly differently.
762 - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
763 vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
767 /* When the vector is allocated from a vector block, NBYTES is used
768 if the vector is not on a free list, and VECTOR is used otherwise.
769 For large vector-like objects, BUFFER or VECTOR is used as a pointer
770 to the next vector-like object. It is generally a buffer or a
771 Lisp_Vector alias, so for convenience it is a union instead of a
772 pointer: this way, one can write P->next.vector instead of ((struct
773 Lisp_Vector *) P->next). */
775 /* This is only needed for small vectors that are not free because the
776 `size' field only gives us the number of Lisp_Object slots, whereas we
777 need to know the total size, including non-Lisp_Object data.
778 FIXME: figure out a way to store this info elsewhere so we can
779 finally get rid of this extra word of overhead. */
781 struct buffer
*buffer
;
782 /* FIXME: This can be removed: For large vectors, this field could be
783 placed *before* the vector itself. And for small vectors on a free
784 list, this field could be stored in the vector's bytes, since the
785 empty vector is handled specially anyway. */
786 struct Lisp_Vector
*vector
;
792 struct vectorlike_header header
;
793 Lisp_Object contents
[1];
796 /* If a struct is made to look like a vector, this macro returns the length
797 of the shortest vector that would hold that struct. */
798 #define VECSIZE(type) ((sizeof (type) \
799 - offsetof (struct Lisp_Vector, contents[0]) \
800 + sizeof (Lisp_Object) - 1) /* Round up. */ \
801 / sizeof (Lisp_Object))
803 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
804 at the end and we need to compute the number of Lisp_Object fields (the
805 ones that the GC needs to trace). */
806 #define PSEUDOVECSIZE(type, nonlispfield) \
807 ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \
808 / sizeof (Lisp_Object))
810 /* A char-table is a kind of vectorlike, with contents are like a
811 vector but with a few other slots. For some purposes, it makes
812 sense to handle a char-table with type struct Lisp_Vector. An
813 element of a char table can be any Lisp objects, but if it is a sub
814 char-table, we treat it a table that contains information of a
815 specific range of characters. A sub char-table has the same
816 structure as a vector. A sub char table appears only in an element
817 of a char-table, and there's no way to access it directly from
818 Emacs Lisp program. */
820 /* This is the number of slots that every char table must have. This
821 counts the ordinary slots and the top, defalt, parent, and purpose
823 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
825 /* Return the number of "extra" slots in the char table CT. */
827 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
828 (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
832 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
833 ({struct Lisp_Char_Table *_tbl = NULL; \
836 _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT); \
837 _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii \
838 : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]); \
840 _val = _tbl->defalt; \
841 } while (NILP (_val) && ! NILP (_tbl->parent)); \
844 #else /* not __GNUC__ */
846 #define CHAR_TABLE_REF_ASCII(CT, IDX) \
847 (! NILP (XCHAR_TABLE (CT)->ascii) \
848 ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
849 ? XCHAR_TABLE (CT)->ascii \
850 : ! NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]) \
851 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
852 : char_table_ref ((CT), (IDX))) \
853 : char_table_ref ((CT), (IDX)))
855 #endif /* not __GNUC__ */
857 /* Compute A OP B, using the unsigned comparison operator OP. A and B
858 should be integer expressions. This is not the same as
859 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
860 returns 1. For efficiency, prefer plain unsigned comparison if A
861 and B's sizes both fit (after integer promotion). */
862 #define UNSIGNED_CMP(a, op, b) \
863 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
864 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
865 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
867 /* Nonzero iff C is an ASCII character. */
868 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
870 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
871 characters. Do not check validity of CT. */
872 #define CHAR_TABLE_REF(CT, IDX) \
873 (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX)) \
874 : char_table_ref ((CT), (IDX)))
876 /* Almost equivalent to Faref (CT, IDX). However, if the result is
877 not a character, return IDX.
879 For these characters, do not check validity of CT
880 and do not follow parent. */
881 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
882 char_table_translate (CT, IDX)
884 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
885 8-bit European characters. Do not check validity of CT. */
886 #define CHAR_TABLE_SET(CT, IDX, VAL) \
887 (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
888 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
889 : char_table_set (CT, IDX, VAL))
891 #define CHARTAB_SIZE_BITS_0 6
892 #define CHARTAB_SIZE_BITS_1 4
893 #define CHARTAB_SIZE_BITS_2 5
894 #define CHARTAB_SIZE_BITS_3 7
896 extern const int chartab_size
[4];
898 struct Lisp_Sub_Char_Table
;
900 struct Lisp_Char_Table
902 /* HEADER.SIZE is the vector's size field, which also holds the
903 pseudovector type information. It holds the size, too.
904 The size counts the defalt, parent, purpose, ascii,
905 contents, and extras slots. */
906 struct vectorlike_header header
;
908 /* This holds a default value,
909 which is used whenever the value for a specific character is nil. */
912 /* This points to another char table, which we inherit from when the
913 value for a specific character is nil. The `defalt' slot takes
914 precedence over this. */
917 /* This is a symbol which says what kind of use this char-table is
921 /* The bottom sub char-table for characters of the range 0..127. It
922 is nil if none of ASCII character has a specific value. */
925 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
927 /* These hold additional data. It is a vector. */
928 Lisp_Object extras
[1];
931 struct Lisp_Sub_Char_Table
933 /* HEADER.SIZE is the vector's size field, which also holds the
934 pseudovector type information. It holds the size, too. */
935 struct vectorlike_header header
;
937 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
938 char-table of depth 1 contains 16 elements, and each element
939 covers 4096 (128*32) characters. A sub char-table of depth 2
940 contains 32 elements, and each element covers 128 characters. A
941 sub char-table of depth 3 contains 128 elements, and each element
942 is for one character. */
945 /* Minimum character covered by the sub char-table. */
946 Lisp_Object min_char
;
948 Lisp_Object contents
[1];
951 /* A boolvector is a kind of vectorlike, with contents are like a string. */
952 struct Lisp_Bool_Vector
954 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
955 just the subtype information. */
956 struct vectorlike_header header
;
957 /* This is the size in bits. */
959 /* This contains the actual bits, packed into bytes. */
960 unsigned char data
[1];
963 /* This structure describes a built-in function.
964 It is generated by the DEFUN macro only.
965 defsubr makes it into a Lisp object.
967 This type is treated in most respects as a pseudovector,
968 but since we never dynamically allocate or free them,
969 we don't need a struct vectorlike_header and its 'next' field. */
975 Lisp_Object (*a0
) (void);
976 Lisp_Object (*a1
) (Lisp_Object
);
977 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
978 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
979 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
980 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
981 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
982 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
983 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
984 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
985 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
987 short min_args
, max_args
;
988 const char *symbol_name
;
994 /***********************************************************************
996 ***********************************************************************/
998 /* Interned state of a symbol. */
1000 enum symbol_interned
1002 SYMBOL_UNINTERNED
= 0,
1003 SYMBOL_INTERNED
= 1,
1004 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1007 enum symbol_redirect
1009 SYMBOL_PLAINVAL
= 4,
1010 SYMBOL_VARALIAS
= 1,
1011 SYMBOL_LOCALIZED
= 2,
1012 SYMBOL_FORWARDED
= 3
1017 unsigned gcmarkbit
: 1;
1019 /* Indicates where the value can be found:
1020 0 : it's a plain var, the value is in the `value' field.
1021 1 : it's a varalias, the value is really in the `alias' symbol.
1022 2 : it's a localized var, the value is in the `blv' object.
1023 3 : it's a forwarding variable, the value is in `forward'. */
1024 ENUM_BF (symbol_redirect
) redirect
: 3;
1026 /* Non-zero means symbol is constant, i.e. changing its value
1027 should signal an error. If the value is 3, then the var
1028 can be changed, but only by `defconst'. */
1029 unsigned constant
: 2;
1031 /* Interned state of the symbol. This is an enumerator from
1032 enum symbol_interned. */
1033 unsigned interned
: 2;
1035 /* Non-zero means that this variable has been explicitly declared
1036 special (with `defvar' etc), and shouldn't be lexically bound. */
1037 unsigned declared_special
: 1;
1039 /* The symbol's name, as a Lisp string.
1040 The name "xname" is used to intentionally break code referring to
1041 the old field "name" of type pointer to struct Lisp_String. */
1044 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1045 union is used depends on the `redirect' field above. */
1048 struct Lisp_Symbol
*alias
;
1049 struct Lisp_Buffer_Local_Value
*blv
;
1050 union Lisp_Fwd
*fwd
;
1053 /* Function value of the symbol or Qunbound if not fboundp. */
1054 Lisp_Object function
;
1056 /* The symbol's property list. */
1059 /* Next symbol in obarray bucket, if the symbol is interned. */
1060 struct Lisp_Symbol
*next
;
1063 /* Value is name of symbol. */
1065 #define SYMBOL_VAL(sym) \
1066 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
1067 #define SYMBOL_ALIAS(sym) \
1068 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias)
1069 #define SYMBOL_BLV(sym) \
1070 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv)
1071 #define SYMBOL_FWD(sym) \
1072 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd)
1073 #define SET_SYMBOL_VAL(sym, v) \
1074 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
1075 #define SET_SYMBOL_ALIAS(sym, v) \
1076 (eassert ((sym)->redirect == SYMBOL_VARALIAS), (sym)->val.alias = (v))
1077 #define SET_SYMBOL_BLV(sym, v) \
1078 (eassert ((sym)->redirect == SYMBOL_LOCALIZED), (sym)->val.blv = (v))
1079 #define SET_SYMBOL_FWD(sym, v) \
1080 (eassert ((sym)->redirect == SYMBOL_FORWARDED), (sym)->val.fwd = (v))
1082 #define SYMBOL_NAME(sym) \
1083 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
1085 /* Value is non-zero if SYM is an interned symbol. */
1087 #define SYMBOL_INTERNED_P(sym) \
1088 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
1090 /* Value is non-zero if SYM is interned in initial_obarray. */
1092 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
1093 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
1095 /* Value is non-zero if symbol is considered a constant, i.e. its
1096 value cannot be changed (there is an exception for keyword symbols,
1097 whose value can be set to the keyword symbol itself). */
1099 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
1101 #define DEFSYM(sym, name) \
1102 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1105 /***********************************************************************
1107 ***********************************************************************/
1109 /* The structure of a Lisp hash table. */
1111 struct Lisp_Hash_Table
1113 /* This is for Lisp; the hash table code does not refer to it. */
1114 struct vectorlike_header header
;
1116 /* Function used to compare keys. */
1119 /* Nil if table is non-weak. Otherwise a symbol describing the
1120 weakness of the table. */
1123 /* When the table is resized, and this is an integer, compute the
1124 new size by adding this to the old size. If a float, compute the
1125 new size by multiplying the old size with this factor. */
1126 Lisp_Object rehash_size
;
1128 /* Resize hash table when number of entries/ table size is >= this
1130 Lisp_Object rehash_threshold
;
1132 /* Vector of hash codes.. If hash[I] is nil, this means that that
1133 entry I is unused. */
1136 /* Vector used to chain entries. If entry I is free, next[I] is the
1137 entry number of the next free item. If entry I is non-free,
1138 next[I] is the index of the next entry in the collision chain. */
1141 /* Index of first free entry in free list. */
1142 Lisp_Object next_free
;
1144 /* Bucket vector. A non-nil entry is the index of the first item in
1145 a collision chain. This vector's size can be larger than the
1146 hash table size to reduce collisions. */
1149 /* User-supplied hash function, or nil. */
1150 Lisp_Object user_hash_function
;
1152 /* User-supplied key comparison function, or nil. */
1153 Lisp_Object user_cmp_function
;
1155 /* Only the fields above are traced normally by the GC. The ones below
1156 `count' are special and are either ignored by the GC or traced in
1157 a special way (e.g. because of weakness). */
1159 /* Number of key/value entries in the table. */
1162 /* Vector of keys and values. The key of item I is found at index
1163 2 * I, the value is found at index 2 * I + 1.
1164 This is gc_marked specially if the table is weak. */
1165 Lisp_Object key_and_value
;
1167 /* Next weak hash table if this is a weak hash table. The head
1168 of the list is in weak_hash_tables. */
1169 struct Lisp_Hash_Table
*next_weak
;
1171 /* C function to compare two keys. */
1172 int (*cmpfn
) (struct Lisp_Hash_Table
*,
1173 Lisp_Object
, EMACS_UINT
,
1174 Lisp_Object
, EMACS_UINT
);
1176 /* C function to compute hash code. */
1177 EMACS_UINT (*hashfn
) (struct Lisp_Hash_Table
*, Lisp_Object
);
1181 #define XHASH_TABLE(OBJ) \
1182 ((struct Lisp_Hash_Table *) XUNTAG (OBJ, Lisp_Vectorlike))
1184 #define XSET_HASH_TABLE(VAR, PTR) \
1185 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1187 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1189 #define CHECK_HASH_TABLE(x) \
1190 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1192 /* Value is the key part of entry IDX in hash table H. */
1194 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1196 /* Value is the value part of entry IDX in hash table H. */
1198 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1200 /* Value is the index of the next entry following the one at IDX
1203 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1205 /* Value is the hash code computed for entry IDX in hash table H. */
1207 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1209 /* Value is the index of the element in hash table H that is the
1210 start of the collision list at index IDX in the index vector of H. */
1212 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1214 /* Value is the size of hash table H. */
1216 #define HASH_TABLE_SIZE(H) ASIZE ((H)->next)
1218 /* Default size for hash tables if not specified. */
1220 #define DEFAULT_HASH_SIZE 65
1222 /* Default threshold specifying when to resize a hash table. The
1223 value gives the ratio of current entries in the hash table and the
1224 size of the hash table. */
1226 #define DEFAULT_REHASH_THRESHOLD 0.8
1228 /* Default factor by which to increase the size of a hash table. */
1230 #define DEFAULT_REHASH_SIZE 1.5
1233 /* These structures are used for various misc types. */
1235 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1237 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1238 unsigned gcmarkbit
: 1;
1244 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1245 unsigned gcmarkbit
: 1;
1247 /* This flag is temporarily used in the functions
1248 decode/encode_coding_object to record that the marker position
1249 must be adjusted after the conversion. */
1250 unsigned int need_adjustment
: 1;
1251 /* 1 means normal insertion at the marker's position
1252 leaves the marker after the inserted text. */
1253 unsigned int insertion_type
: 1;
1254 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1255 Note: a chain of markers can contain markers pointing into different
1256 buffers (the chain is per buffer_text rather than per buffer, so it's
1257 shared between indirect buffers). */
1258 /* This is used for (other than NULL-checking):
1260 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1261 - unchain_marker: to find the list from which to unchain.
1262 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1264 struct buffer
*buffer
;
1266 /* The remaining fields are meaningless in a marker that
1267 does not point anywhere. */
1269 /* For markers that point somewhere,
1270 this is used to chain of all the markers in a given buffer. */
1271 /* We could remove it and use an array in buffer_text instead.
1272 That would also allow to preserve it ordered. */
1273 struct Lisp_Marker
*next
;
1274 /* This is the char position where the marker points. */
1276 /* This is the byte position.
1277 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1278 used to implement the functionality of markers, but rather to (ab)use
1279 markers as a cache for char<->byte mappings). */
1283 /* START and END are markers in the overlay's buffer, and
1284 PLIST is the overlay's property list. */
1286 /* An overlay's real data content is:
1288 - buffer (really there are two buffer pointers, one per marker,
1289 and both points to the same buffer)
1290 - insertion type of both ends (per-marker fields)
1291 - start & start byte (of start marker)
1292 - end & end byte (of end marker)
1293 - next (singly linked list of overlays)
1294 - next fields of start and end markers (singly linked list of markers).
1295 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1298 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1299 unsigned gcmarkbit
: 1;
1301 struct Lisp_Overlay
*next
;
1302 Lisp_Object start
, end
, plist
;
1305 /* Hold a C pointer for later use.
1306 This type of object is used in the arg to record_unwind_protect. */
1307 struct Lisp_Save_Value
1309 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1310 unsigned gcmarkbit
: 1;
1312 /* If DOGC is set, POINTER is the address of a memory
1313 area containing INTEGER potential Lisp_Objects. */
1314 unsigned int dogc
: 1;
1320 /* A miscellaneous object, when it's on the free list. */
1323 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1324 unsigned gcmarkbit
: 1;
1326 union Lisp_Misc
*chain
;
1329 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1330 It uses one of these struct subtypes to get the type field. */
1334 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1335 struct Lisp_Free u_free
;
1336 struct Lisp_Marker u_marker
;
1337 struct Lisp_Overlay u_overlay
;
1338 struct Lisp_Save_Value u_save_value
;
1341 /* Forwarding pointer to an int variable.
1342 This is allowed only in the value cell of a symbol,
1343 and it means that the symbol's value really lives in the
1344 specified int variable. */
1347 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1351 /* Boolean forwarding pointer to an int variable.
1352 This is like Lisp_Intfwd except that the ostensible
1353 "value" of the symbol is t if the int variable is nonzero,
1354 nil if it is zero. */
1357 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1361 /* Forwarding pointer to a Lisp_Object variable.
1362 This is allowed only in the value cell of a symbol,
1363 and it means that the symbol's value really lives in the
1364 specified variable. */
1367 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1368 Lisp_Object
*objvar
;
1371 /* Like Lisp_Objfwd except that value lives in a slot in the
1372 current buffer. Value is byte index of slot within buffer. */
1373 struct Lisp_Buffer_Objfwd
1375 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1377 Lisp_Object slottype
; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1380 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1381 the symbol has buffer-local or frame-local bindings. (Exception:
1382 some buffer-local variables are built-in, with their values stored
1383 in the buffer structure itself. They are handled differently,
1384 using struct Lisp_Buffer_Objfwd.)
1386 The `realvalue' slot holds the variable's current value, or a
1387 forwarding pointer to where that value is kept. This value is the
1388 one that corresponds to the loaded binding. To read or set the
1389 variable, you must first make sure the right binding is loaded;
1390 then you can access the value in (or through) `realvalue'.
1392 `buffer' and `frame' are the buffer and frame for which the loaded
1393 binding was found. If those have changed, to make sure the right
1394 binding is loaded it is necessary to find which binding goes with
1395 the current buffer and selected frame, then load it. To load it,
1396 first unload the previous binding, then copy the value of the new
1397 binding into `realvalue' (or through it). Also update
1398 LOADED-BINDING to point to the newly loaded binding.
1400 `local_if_set' indicates that merely setting the variable creates a
1401 local binding for the current buffer. Otherwise the latter, setting
1402 the variable does not do that; only make-local-variable does that. */
1404 struct Lisp_Buffer_Local_Value
1406 /* 1 means that merely setting the variable creates a local
1407 binding for the current buffer. */
1408 unsigned int local_if_set
: 1;
1409 /* 1 means this variable can have frame-local bindings, otherwise, it is
1410 can have buffer-local bindings. The two cannot be combined. */
1411 unsigned int frame_local
: 1;
1412 /* 1 means that the binding now loaded was found.
1413 Presumably equivalent to (defcell!=valcell). */
1414 unsigned int found
: 1;
1415 /* If non-NULL, a forwarding to the C var where it should also be set. */
1416 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1417 /* The buffer or frame for which the loaded binding was found. */
1419 /* A cons cell that holds the default value. It has the form
1420 (SYMBOL . DEFAULT-VALUE). */
1421 Lisp_Object defcell
;
1422 /* The cons cell from `where's parameter alist.
1423 It always has the form (SYMBOL . VALUE)
1424 Note that if `forward' is non-nil, VALUE may be out of date.
1425 Also if the currently loaded binding is the default binding, then
1426 this is `eq'ual to defcell. */
1427 Lisp_Object valcell
;
1430 #define BLV_FOUND(blv) \
1431 (eassert ((blv)->found == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found)
1432 #define SET_BLV_FOUND(blv, v) \
1433 (eassert ((v) == !EQ ((blv)->defcell, (blv)->valcell)), (blv)->found = (v))
1435 #define BLV_VALUE(blv) (XCDR ((blv)->valcell))
1436 #define SET_BLV_VALUE(blv, v) (XSETCDR ((blv)->valcell, v))
1438 /* Like Lisp_Objfwd except that value lives in a slot in the
1440 struct Lisp_Kboard_Objfwd
1442 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1448 struct Lisp_Intfwd u_intfwd
;
1449 struct Lisp_Boolfwd u_boolfwd
;
1450 struct Lisp_Objfwd u_objfwd
;
1451 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1452 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1455 /* Lisp floating point type. */
1461 struct Lisp_Float
*chain
;
1465 #define XFLOAT_DATA(f) (0 ? XFLOAT (f)->u.data : XFLOAT (f)->u.data)
1466 #define XFLOAT_INIT(f, n) (XFLOAT (f)->u.data = (n))
1468 /* A character, declared with the following typedef, is a member
1469 of some character set associated with the current buffer. */
1470 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1472 typedef unsigned char UCHAR
;
1475 /* Meanings of slots in a Lisp_Compiled: */
1477 #define COMPILED_ARGLIST 0
1478 #define COMPILED_BYTECODE 1
1479 #define COMPILED_CONSTANTS 2
1480 #define COMPILED_STACK_DEPTH 3
1481 #define COMPILED_DOC_STRING 4
1482 #define COMPILED_INTERACTIVE 5
1484 /* Flag bits in a character. These also get used in termhooks.h.
1485 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1486 (MUlti-Lingual Emacs) might need 22 bits for the character value
1487 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1488 #define CHAR_ALT (0x0400000)
1489 #define CHAR_SUPER (0x0800000)
1490 #define CHAR_HYPER (0x1000000)
1491 #define CHAR_SHIFT (0x2000000)
1492 #define CHAR_CTL (0x4000000)
1493 #define CHAR_META (0x8000000)
1495 #define CHAR_MODIFIER_MASK \
1496 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1499 /* Actually, the current Emacs uses 22 bits for the character value
1501 #define CHARACTERBITS 22
1504 /* The glyph datatype, used to represent characters on the display.
1505 It consists of a char code and a face id. */
1512 /* Return a glyph's character code. */
1513 #define GLYPH_CHAR(glyph) ((glyph).ch)
1515 /* Return a glyph's face ID. */
1516 #define GLYPH_FACE(glyph) ((glyph).face_id)
1518 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1519 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1520 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1522 /* Return 1 if GLYPH contains valid character code. */
1523 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph))
1526 /* Glyph Code from a display vector may either be an integer which
1527 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1528 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1530 #define GLYPH_CODE_P(gc) \
1532 ? (CHARACTERP (XCAR (gc)) \
1533 && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) \
1534 : (RANGED_INTEGERP \
1536 (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS \
1537 ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR \
1538 : TYPE_MAXIMUM (EMACS_INT)))))
1540 /* The following are valid only if GLYPH_CODE_P (gc). */
1542 #define GLYPH_CODE_CHAR(gc) \
1543 (CONSP (gc) ? XINT (XCAR (gc)) : XINT (gc) & ((1 << CHARACTERBITS) - 1))
1545 #define GLYPH_CODE_FACE(gc) \
1546 (CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS)
1548 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1552 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1554 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1555 (XINT (gc) >> CHARACTERBITS)); \
1559 /* The ID of the mode line highlighting face. */
1560 #define GLYPH_MODE_LINE_FACE 1
1562 /* Structure to hold mouse highlight data. This is here because other
1563 header files need it for defining struct x_output etc. */
1565 /* These variables describe the range of text currently shown in its
1566 mouse-face, together with the window they apply to. As long as
1567 the mouse stays within this range, we need not redraw anything on
1568 its account. Rows and columns are glyph matrix positions in
1569 MOUSE_FACE_WINDOW. */
1570 int mouse_face_beg_row
, mouse_face_beg_col
;
1571 int mouse_face_beg_x
, mouse_face_beg_y
;
1572 int mouse_face_end_row
, mouse_face_end_col
;
1573 int mouse_face_end_x
, mouse_face_end_y
;
1574 int mouse_face_past_end
;
1575 Lisp_Object mouse_face_window
;
1576 int mouse_face_face_id
;
1577 Lisp_Object mouse_face_overlay
;
1579 /* 1 if a mouse motion event came and we didn't handle it right away because
1580 gc was in progress. */
1581 int mouse_face_deferred_gc
;
1583 /* FRAME and X, Y position of mouse when last checked for
1584 highlighting. X and Y can be negative or out of range for the frame. */
1585 struct frame
*mouse_face_mouse_frame
;
1586 int mouse_face_mouse_x
, mouse_face_mouse_y
;
1588 /* Nonzero means defer mouse-motion highlighting. */
1589 int mouse_face_defer
;
1591 /* Nonzero means that the mouse highlight should not be shown. */
1592 int mouse_face_hidden
;
1594 int mouse_face_image_state
;
1597 /* Data type checking */
1599 #define NILP(x) EQ (x, Qnil)
1601 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1602 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1604 #define RANGED_INTEGERP(lo, x, hi) \
1605 (INTEGERP (x) && (lo) <= XINT (x) && XINT (x) <= (hi))
1606 #define TYPE_RANGED_INTEGERP(type, x) \
1607 (TYPE_SIGNED (type) \
1608 ? RANGED_INTEGERP (TYPE_MINIMUM (type), x, TYPE_MAXIMUM (type)) \
1609 : RANGED_INTEGERP (0, x, TYPE_MAXIMUM (type)))
1611 #define INTEGERP(x) (LISP_INT_TAG_P (XTYPE ((x))))
1612 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1613 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1614 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1615 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1616 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1618 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1619 #define VECTORP(x) (VECTORLIKEP (x) && !(ASIZE (x) & PSEUDOVECTOR_FLAG))
1620 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1621 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1622 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1624 #define INTFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Int)
1625 #define BOOLFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Bool)
1626 #define OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Obj)
1627 #define BUFFER_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Buffer_Obj)
1628 #define KBOARD_OBJFWDP(x) (XFWDTYPE (x) == Lisp_Fwd_Kboard_Obj)
1630 /* True if object X is a pseudovector whose code is CODE. The cast to struct
1631 vectorlike_header * avoids aliasing issues. */
1632 #define PSEUDOVECTORP(x, code) \
1633 TYPED_PSEUDOVECTORP (x, vectorlike_header, code)
1635 #define PSEUDOVECTOR_TYPEP(v, code) \
1636 (((v)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1637 == (PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS)))
1639 /* True if object X, with internal type struct T *, is a pseudovector whose
1641 #define TYPED_PSEUDOVECTORP(x, t, code) \
1643 && PSEUDOVECTOR_TYPEP ((struct t *) XUNTAG (x, Lisp_Vectorlike), code))
1645 /* Test for specific pseudovector types. */
1646 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1647 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1648 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1649 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1650 /* SUBRP is special since Lisp_Subr lacks struct vectorlike_header. */
1651 #define SUBRP(x) TYPED_PSEUDOVECTORP (x, Lisp_Subr, PVEC_SUBR)
1652 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1653 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1654 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1655 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1656 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1657 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1659 /* Test for image (image . spec) */
1660 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1665 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1667 #define CHECK_LIST(x) \
1668 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1670 #define CHECK_LIST_CONS(x, y) \
1671 CHECK_TYPE (CONSP (x), Qlistp, y)
1673 #define CHECK_LIST_END(x, y) \
1674 CHECK_TYPE (NILP (x), Qlistp, y)
1676 #define CHECK_STRING(x) \
1677 CHECK_TYPE (STRINGP (x), Qstringp, x)
1679 #define CHECK_STRING_CAR(x) \
1680 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1682 #define CHECK_CONS(x) \
1683 CHECK_TYPE (CONSP (x), Qconsp, x)
1685 #define CHECK_SYMBOL(x) \
1686 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1688 #define CHECK_CHAR_TABLE(x) \
1689 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1691 #define CHECK_VECTOR(x) \
1692 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1694 #define CHECK_VECTOR_OR_STRING(x) \
1695 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1697 #define CHECK_ARRAY(x, Qxxxp) \
1698 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1700 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1701 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1703 #define CHECK_BUFFER(x) \
1704 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1706 #define CHECK_WINDOW(x) \
1707 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1709 #define CHECK_WINDOW_CONFIGURATION(x) \
1710 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1712 /* This macro rejects windows on the interior of the window tree as
1713 "dead", which is what we want; this is an argument-checking macro, and
1714 the user should never get access to interior windows.
1716 A window of any sort, leaf or interior, is dead if the buffer,
1717 vchild, and hchild members are all nil. */
1719 #define CHECK_LIVE_WINDOW(x) \
1720 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1722 #define CHECK_PROCESS(x) \
1723 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1725 #define CHECK_SUBR(x) \
1726 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1728 #define CHECK_NUMBER(x) \
1729 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1731 #define CHECK_NATNUM(x) \
1732 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1734 #define CHECK_RANGED_INTEGER(x, lo, hi) \
1737 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
1738 args_out_of_range_3 \
1740 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
1741 ? MOST_NEGATIVE_FIXNUM \
1743 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
1745 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
1747 if (TYPE_SIGNED (type)) \
1748 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
1750 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
1753 #define CHECK_MARKER(x) \
1754 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1756 #define CHECK_NUMBER_COERCE_MARKER(x) \
1757 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1758 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1760 #define XFLOATINT(n) extract_float((n))
1762 #define CHECK_FLOAT(x) \
1763 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1765 #define CHECK_NUMBER_OR_FLOAT(x) \
1766 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1768 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1769 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1770 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1772 #define CHECK_OVERLAY(x) \
1773 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1775 /* Since we can't assign directly to the CAR or CDR fields of a cons
1776 cell, use these when checking that those fields contain numbers. */
1777 #define CHECK_NUMBER_CAR(x) \
1779 Lisp_Object tmp = XCAR (x); \
1780 CHECK_NUMBER (tmp); \
1781 XSETCAR ((x), tmp); \
1784 #define CHECK_NUMBER_CDR(x) \
1786 Lisp_Object tmp = XCDR (x); \
1787 CHECK_NUMBER (tmp); \
1788 XSETCDR ((x), tmp); \
1791 #define CHECK_NATNUM_CAR(x) \
1793 Lisp_Object tmp = XCAR (x); \
1794 CHECK_NATNUM (tmp); \
1795 XSETCAR ((x), tmp); \
1798 #define CHECK_NATNUM_CDR(x) \
1800 Lisp_Object tmp = XCDR (x); \
1801 CHECK_NATNUM (tmp); \
1802 XSETCDR ((x), tmp); \
1805 /* Define a built-in function for calling from Lisp.
1806 `lname' should be the name to give the function in Lisp,
1807 as a null-terminated C string.
1808 `fnname' should be the name of the function in C.
1809 By convention, it starts with F.
1810 `sname' should be the name for the C constant structure
1811 that records information on this function for internal use.
1812 By convention, it should be the same as `fnname' but with S instead of F.
1813 It's too bad that C macros can't compute this from `fnname'.
1814 `minargs' should be a number, the minimum number of arguments allowed.
1815 `maxargs' should be a number, the maximum number of arguments allowed,
1816 or else MANY or UNEVALLED.
1817 MANY means pass a vector of evaluated arguments,
1818 in the form of an integer number-of-arguments
1819 followed by the address of a vector of Lisp_Objects
1820 which contains the argument values.
1821 UNEVALLED means pass the list of unevaluated arguments
1822 `intspec' says how interactive arguments are to be fetched.
1823 If the string starts with a `(', `intspec' is evaluated and the resulting
1824 list is the list of arguments.
1825 If it's a string that doesn't start with `(', the value should follow
1826 the one of the doc string for `interactive'.
1827 A null string means call interactively with no arguments.
1828 `doc' is documentation for the user. */
1830 /* This version of DEFUN declares a function prototype with the right
1831 arguments, so we can catch errors with maxargs at compile-time. */
1833 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1834 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1835 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1836 { (PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS) \
1837 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1838 { (Lisp_Object (__cdecl *)(void))fnname }, \
1839 minargs, maxargs, lname, intspec, 0}; \
1841 #else /* not _MSC_VER */
1842 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1843 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1844 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
1845 { PVEC_SUBR << PSEUDOVECTOR_SIZE_BITS, \
1846 { .a ## maxargs = fnname }, \
1847 minargs, maxargs, lname, intspec, 0}; \
1851 /* Note that the weird token-substitution semantics of ANSI C makes
1852 this work for MANY and UNEVALLED. */
1853 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
1854 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1855 #define DEFUN_ARGS_0 (void)
1856 #define DEFUN_ARGS_1 (Lisp_Object)
1857 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1858 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1859 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1860 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1862 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1863 Lisp_Object, Lisp_Object)
1864 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1865 Lisp_Object, Lisp_Object, Lisp_Object)
1866 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1867 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1869 /* Non-zero if OBJ is a Lisp function. */
1870 #define FUNCTIONP(OBJ) \
1871 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1872 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1873 || COMPILEDP (OBJ) \
1877 is how we define the symbol for function `name' at start-up time. */
1878 extern void defsubr (struct Lisp_Subr
*);
1881 #define UNEVALLED -1
1883 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1884 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
1885 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, int *);
1886 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
1887 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
1889 /* Macros we use to define forwarded Lisp variables.
1890 These are used in the syms_of_FILENAME functions.
1892 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
1893 lisp variable is actually a field in `struct emacs_globals'. The
1894 field's name begins with "f_", which is a convention enforced by
1895 these macros. Each such global has a corresponding #define in
1896 globals.h; the plain name should be used in the code.
1898 E.g., the global "cons_cells_consed" is declared as "int
1899 f_cons_cells_consed" in globals.h, but there is a define:
1901 #define cons_cells_consed globals.f_cons_cells_consed
1903 All C code uses the `cons_cells_consed' name. This is all done
1904 this way to support indirection for multi-threaded Emacs. */
1906 #define DEFVAR_LISP(lname, vname, doc) \
1908 static struct Lisp_Objfwd o_fwd; \
1909 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
1911 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
1913 static struct Lisp_Objfwd o_fwd; \
1914 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
1916 #define DEFVAR_BOOL(lname, vname, doc) \
1918 static struct Lisp_Boolfwd b_fwd; \
1919 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
1921 #define DEFVAR_INT(lname, vname, doc) \
1923 static struct Lisp_Intfwd i_fwd; \
1924 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
1927 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
1929 static struct Lisp_Objfwd o_fwd; \
1930 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
1933 #define DEFVAR_KBOARD(lname, vname, doc) \
1935 static struct Lisp_Kboard_Objfwd ko_fwd; \
1936 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
1941 /* Structure for recording Lisp call stack for backtrace purposes. */
1943 /* The special binding stack holds the outer values of variables while
1944 they are bound by a function application or a let form, stores the
1945 code to be executed for Lisp unwind-protect forms, and stores the C
1946 functions to be called for record_unwind_protect.
1948 If func is non-zero, undoing this binding applies func to old_value;
1949 This implements record_unwind_protect.
1951 Otherwise, the element is a variable binding.
1953 If the symbol field is a symbol, it is an ordinary variable binding.
1955 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
1956 which means having bound a local value while CURRENT-BUFFER was active.
1957 If WHERE is nil this means we saw the default value when binding SYMBOL.
1958 WHERE being a buffer or frame means we saw a buffer-local or frame-local
1959 value. Other values of WHERE mean an internal error. */
1961 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
1965 Lisp_Object symbol
, old_value
;
1966 specbinding_func func
;
1967 Lisp_Object unused
; /* Dividing by 16 is faster than by 12 */
1970 extern struct specbinding
*specpdl
;
1971 extern struct specbinding
*specpdl_ptr
;
1972 extern ptrdiff_t specpdl_size
;
1974 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
1976 /* Everything needed to describe an active condition case. */
1979 /* The handler clauses and variable from the condition-case form. */
1980 /* For a handler set up in Lisp code, this is always a list.
1981 For an internal handler set up by internal_condition_case*,
1982 this can instead be the symbol t or `error'.
1983 t: handle all conditions.
1984 error: handle all conditions, and errors can run the debugger
1985 or display a backtrace. */
1986 Lisp_Object handler
;
1988 /* Fsignal stores here the condition-case clause that applies,
1989 and Fcondition_case thus knows which clause to run. */
1990 Lisp_Object chosen_clause
;
1992 /* Used to effect the longjump out to the handler. */
1993 struct catchtag
*tag
;
1995 /* The next enclosing handler. */
1996 struct handler
*next
;
1999 /* This structure helps implement the `catch' and `throw' control
2000 structure. A struct catchtag contains all the information needed
2001 to restore the state of the interpreter after a non-local jump.
2003 Handlers for error conditions (represented by `struct handler'
2004 structures) just point to a catch tag to do the cleanup required
2007 catchtag structures are chained together in the C calling stack;
2008 the `next' member points to the next outer catchtag.
2010 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2011 member is TAG, and then unbinds to it. The `val' member is used to
2012 hold VAL while the stack is unwound; `val' is returned as the value
2015 All the other members are concerned with restoring the interpreter
2022 struct catchtag
*next
;
2023 struct gcpro
*gcpro
;
2025 struct backtrace
*backlist
;
2026 struct handler
*handlerlist
;
2027 EMACS_INT lisp_eval_depth
;
2029 int poll_suppress_count
;
2030 int interrupt_input_blocked
;
2031 struct byte_stack
*byte_stack
;
2034 extern Lisp_Object memory_signal_data
;
2036 /* An address near the bottom of the stack.
2037 Tells GC how to save a copy of the stack. */
2038 extern char *stack_bottom
;
2040 /* Check quit-flag and quit if it is non-nil.
2041 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2042 So the program needs to do QUIT at times when it is safe to quit.
2043 Every loop that might run for a long time or might not exit
2044 ought to do QUIT at least once, at a safe place.
2045 Unless that is impossible, of course.
2046 But it is very desirable to avoid creating loops where QUIT is impossible.
2048 Exception: if you set immediate_quit to nonzero,
2049 then the handler that responds to the C-g does the quit itself.
2050 This is a good thing to do around a loop that has no side effects
2051 and (in particular) cannot call arbitrary Lisp code.
2053 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2054 a request to exit Emacs when it is safe to do. */
2057 extern void process_pending_signals (void);
2058 extern int pending_signals
;
2059 #define ELSE_PENDING_SIGNALS \
2060 else if (pending_signals) \
2061 process_pending_signals ();
2062 #else /* not SYNC_INPUT */
2063 #define ELSE_PENDING_SIGNALS
2064 #endif /* not SYNC_INPUT */
2066 extern void process_quit_flag (void);
2069 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2070 process_quit_flag (); \
2071 ELSE_PENDING_SIGNALS \
2075 /* Nonzero if ought to quit now. */
2077 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2079 extern Lisp_Object Vascii_downcase_table
;
2080 extern Lisp_Object Vascii_canon_table
;
2082 /* Structure for recording stack slots that need marking. */
2084 /* This is a chain of structures, each of which points at a Lisp_Object
2085 variable whose value should be marked in garbage collection.
2086 Normally every link of the chain is an automatic variable of a function,
2087 and its `val' points to some argument or local variable of the function.
2088 On exit to the function, the chain is set back to the value it had on entry.
2089 This way, no link remains in the chain when the stack frame containing the
2092 Every function that can call Feval must protect in this fashion all
2093 Lisp_Object variables whose contents will be used again. */
2095 extern struct gcpro
*gcprolist
;
2101 /* Address of first protected variable. */
2102 volatile Lisp_Object
*var
;
2104 /* Number of consecutive protected variables. */
2112 /* Values of GC_MARK_STACK during compilation:
2114 0 Use GCPRO as before
2115 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2116 2 Mark the stack, and check that everything GCPRO'd is
2118 3 Mark using GCPRO's, mark stack last, and count how many
2119 dead objects are kept alive. */
2122 #define GC_USE_GCPROS_AS_BEFORE 0
2123 #define GC_MAKE_GCPROS_NOOPS 1
2124 #define GC_MARK_STACK_CHECK_GCPROS 2
2125 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2127 #ifndef GC_MARK_STACK
2128 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2131 /* Whether we do the stack marking manually. */
2132 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2133 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2136 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2138 /* Do something silly with gcproN vars just so gcc shuts up. */
2139 /* You get warnings from MIPSPro... */
2141 #define GCPRO1(varname) ((void) gcpro1)
2142 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2143 #define GCPRO3(varname1, varname2, varname3) \
2144 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2145 #define GCPRO4(varname1, varname2, varname3, varname4) \
2146 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2147 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2148 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2149 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2150 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2152 #define UNGCPRO ((void) 0)
2154 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2158 #define GCPRO1(varname) \
2159 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2160 gcprolist = &gcpro1; }
2162 #define GCPRO2(varname1, varname2) \
2163 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2164 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2165 gcprolist = &gcpro2; }
2167 #define GCPRO3(varname1, varname2, varname3) \
2168 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2169 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2170 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2171 gcprolist = &gcpro3; }
2173 #define GCPRO4(varname1, varname2, varname3, varname4) \
2174 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2175 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2176 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2177 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2178 gcprolist = &gcpro4; }
2180 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2181 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2182 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2183 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2184 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2185 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2186 gcprolist = &gcpro5; }
2188 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2189 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2190 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2191 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2192 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2193 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2194 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2195 gcprolist = &gcpro6; }
2197 #define UNGCPRO (gcprolist = gcpro1.next)
2201 extern int gcpro_level
;
2203 #define GCPRO1(varname) \
2204 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2205 gcpro1.level = gcpro_level++; \
2206 gcprolist = &gcpro1; }
2208 #define GCPRO2(varname1, varname2) \
2209 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2210 gcpro1.level = gcpro_level; \
2211 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2212 gcpro2.level = gcpro_level++; \
2213 gcprolist = &gcpro2; }
2215 #define GCPRO3(varname1, varname2, varname3) \
2216 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2217 gcpro1.level = gcpro_level; \
2218 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2219 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2220 gcpro3.level = gcpro_level++; \
2221 gcprolist = &gcpro3; }
2223 #define GCPRO4(varname1, varname2, varname3, varname4) \
2224 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2225 gcpro1.level = gcpro_level; \
2226 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2227 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2228 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2229 gcpro4.level = gcpro_level++; \
2230 gcprolist = &gcpro4; }
2232 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2233 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2234 gcpro1.level = gcpro_level; \
2235 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2236 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2237 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2238 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2239 gcpro5.level = gcpro_level++; \
2240 gcprolist = &gcpro5; }
2242 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2243 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2244 gcpro1.level = gcpro_level; \
2245 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2246 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2247 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2248 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2249 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2250 gcpro6.level = gcpro_level++; \
2251 gcprolist = &gcpro6; }
2254 ((--gcpro_level != gcpro1.level) \
2256 : ((gcprolist = gcpro1.next), 0))
2258 #endif /* DEBUG_GCPRO */
2259 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2262 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2263 #define RETURN_UNGCPRO(expr) \
2266 Lisp_Object ret_ungc_val; \
2267 ret_ungc_val = (expr); \
2269 return ret_ungc_val; \
2273 /* Call staticpro (&var) to protect static variable `var'. */
2275 void staticpro (Lisp_Object
*);
2277 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2278 meaning as in the DEFUN macro, and is used to construct a prototype. */
2279 /* We can use the same trick as in the DEFUN macro to generate the
2280 appropriate prototype. */
2281 #define EXFUN(fnname, maxargs) \
2282 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2284 /* Forward declarations for prototypes. */
2288 /* Defined in data.c. */
2289 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
2290 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2291 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2292 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2293 extern Lisp_Object Qinvalid_read_syntax
;
2294 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2295 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2296 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2297 extern Lisp_Object Qtext_read_only
;
2298 extern Lisp_Object Qinteractive_form
;
2299 extern Lisp_Object Qcircular_list
;
2300 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
2301 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
2302 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
2303 extern Lisp_Object Qbuffer_or_string_p
;
2304 extern Lisp_Object Qfboundp
;
2305 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
2307 extern Lisp_Object Qcdr
;
2309 extern Lisp_Object Qrange_error
, Qdomain_error
, Qsingularity_error
;
2310 extern Lisp_Object Qoverflow_error
, Qunderflow_error
;
2312 extern Lisp_Object Qfloatp
;
2313 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
2315 extern Lisp_Object Qinteger
, Qinterval
, Qsymbol
, Qstring
;
2316 extern Lisp_Object Qmisc
, Qvector
, Qfloat
, Qcons
, Qbuffer
;
2318 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
2320 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
2322 /* Defined in frame.c */
2323 extern Lisp_Object Qframep
;
2325 /* Defined in data.c */
2326 extern Lisp_Object
indirect_function (Lisp_Object
);
2327 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2329 /* Convert the integer I to an Emacs representation, either the integer
2330 itself, or a cons of two or three integers, or if all else fails a float.
2331 I should not have side effects. */
2332 #define INTEGER_TO_CONS(i) \
2333 (! FIXNUM_OVERFLOW_P (i) \
2335 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2336 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2337 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2338 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2339 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2340 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2341 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2342 ? Fcons (make_number ((i) >> 16 >> 24), \
2343 Fcons (make_number ((i) >> 16 & 0xffffff), \
2344 make_number ((i) & 0xffff))) \
2347 /* Convert the Emacs representation CONS back to an integer of type
2348 TYPE, storing the result the variable VAR. Signal an error if CONS
2349 is not a valid representation or is out of range for TYPE. */
2350 #define CONS_TO_INTEGER(cons, type, var) \
2351 (TYPE_SIGNED (type) \
2352 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2353 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2354 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2355 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2357 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2358 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2359 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2361 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
2362 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2363 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, int);
2364 extern void syms_of_data (void);
2365 extern void init_data (void);
2366 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2368 /* Defined in cmds.c */
2369 extern void syms_of_cmds (void);
2370 extern void keys_of_cmds (void);
2372 /* Defined in coding.c */
2373 extern Lisp_Object Qcharset
;
2374 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2375 ptrdiff_t, int, int, Lisp_Object
);
2376 extern void init_coding (void);
2377 extern void init_coding_once (void);
2378 extern void syms_of_coding (void);
2380 /* Defined in character.c */
2381 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
2382 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2383 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2384 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
2385 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
2386 extern void syms_of_character (void);
2388 /* Defined in charset.c */
2389 extern void init_charset (void);
2390 extern void init_charset_once (void);
2391 extern void syms_of_charset (void);
2392 /* Structure forward declarations. */
2395 /* Defined in composite.c */
2396 extern void syms_of_composite (void);
2398 /* Defined in syntax.c */
2399 extern void init_syntax_once (void);
2400 extern void syms_of_syntax (void);
2402 /* Defined in fns.c */
2403 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2404 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2405 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
2406 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2407 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2408 extern void sweep_weak_hash_tables (void);
2409 extern Lisp_Object Qcursor_in_echo_area
;
2410 extern Lisp_Object Qstring_lessp
;
2411 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
, Qeql
;
2412 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2413 EMACS_UINT
sxhash (Lisp_Object
, int);
2414 Lisp_Object
make_hash_table (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2415 Lisp_Object
, Lisp_Object
, Lisp_Object
,
2417 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2418 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2421 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2422 ptrdiff_t, ptrdiff_t);
2423 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2424 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2425 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2426 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2427 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2428 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2429 extern void clear_string_char_byte_cache (void);
2430 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2431 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2432 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2433 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2434 extern void syms_of_fns (void);
2436 /* Defined in floatfns.c */
2437 extern double extract_float (Lisp_Object
);
2438 extern void init_floatfns (void);
2439 extern void syms_of_floatfns (void);
2440 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2442 /* Defined in fringe.c */
2443 extern void syms_of_fringe (void);
2444 extern void init_fringe (void);
2445 #ifdef HAVE_WINDOW_SYSTEM
2446 extern void mark_fringe_data (void);
2447 extern void init_fringe_once (void);
2448 #endif /* HAVE_WINDOW_SYSTEM */
2450 /* Defined in image.c */
2451 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2452 extern Lisp_Object QCconversion
;
2453 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2454 extern void syms_of_image (void);
2456 /* Defined in insdel.c */
2457 extern Lisp_Object Qinhibit_modification_hooks
;
2458 extern void move_gap (ptrdiff_t);
2459 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2460 extern _Noreturn
void buffer_overflow (void);
2461 extern void make_gap (ptrdiff_t);
2462 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2463 ptrdiff_t, int, int);
2464 extern int count_combining_before (const unsigned char *,
2465 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2466 extern int count_combining_after (const unsigned char *,
2467 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2468 extern void insert (const char *, ptrdiff_t);
2469 extern void insert_and_inherit (const char *, ptrdiff_t);
2470 extern void insert_1 (const char *, ptrdiff_t, int, int, int);
2471 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2473 extern void insert_from_gap (ptrdiff_t, ptrdiff_t);
2474 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2475 ptrdiff_t, ptrdiff_t, int);
2476 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2477 extern void insert_char (int);
2478 extern void insert_string (const char *);
2479 extern void insert_before_markers (const char *, ptrdiff_t);
2480 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
2481 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
2482 ptrdiff_t, ptrdiff_t,
2484 extern void del_range (ptrdiff_t, ptrdiff_t);
2485 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, int, int);
2486 extern void del_range_byte (ptrdiff_t, ptrdiff_t, int);
2487 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, int);
2488 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
2489 ptrdiff_t, ptrdiff_t, int);
2490 extern void modify_region (struct buffer
*, ptrdiff_t, ptrdiff_t, int);
2491 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
2492 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2493 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2494 ptrdiff_t, ptrdiff_t);
2495 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
2496 ptrdiff_t, ptrdiff_t);
2497 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, int, int, int);
2498 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2499 const char *, ptrdiff_t, ptrdiff_t, int);
2500 extern void syms_of_insdel (void);
2502 /* Defined in dispnew.c */
2503 #if (defined PROFILING \
2504 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
2505 _Noreturn
void __executable_start (void);
2507 extern Lisp_Object selected_frame
;
2508 extern Lisp_Object Vwindow_system
;
2509 void duration_to_sec_usec (double, int *, int *);
2510 extern Lisp_Object
sit_for (Lisp_Object
, int, int);
2511 extern void init_display (void);
2512 extern void syms_of_display (void);
2514 /* Defined in xdisp.c */
2515 extern Lisp_Object Qinhibit_point_motion_hooks
;
2516 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
2517 extern Lisp_Object Qmenu_bar_update_hook
;
2518 extern Lisp_Object Qwindow_scroll_functions
;
2519 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
2520 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
2521 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
2522 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
2523 extern Lisp_Object Qleft_margin
, Qright_margin
;
2524 extern Lisp_Object Qglyphless_char
;
2525 extern Lisp_Object QCdata
, QCfile
;
2526 extern Lisp_Object QCmap
;
2527 extern Lisp_Object Qrisky_local_variable
;
2528 extern struct frame
*last_glyphless_glyph_frame
;
2529 extern int last_glyphless_glyph_face_id
;
2530 extern int last_glyphless_glyph_merged_face_id
;
2531 extern int noninteractive_need_newline
;
2532 extern Lisp_Object echo_area_buffer
[2];
2533 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
2534 extern void check_message_stack (void);
2535 extern void setup_echo_area_for_printing (int);
2536 extern int push_message (void);
2537 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
2538 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
2539 extern void restore_message (void);
2540 extern Lisp_Object
current_message (void);
2541 extern void clear_message (int, int);
2542 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2543 extern void message1 (const char *);
2544 extern void message1_nolog (const char *);
2545 extern void message2 (const char *, ptrdiff_t, int);
2546 extern void message2_nolog (const char *, ptrdiff_t, int);
2547 extern void message3 (Lisp_Object
, ptrdiff_t, int);
2548 extern void message3_nolog (Lisp_Object
, ptrdiff_t, int);
2549 extern void message_dolog (const char *, ptrdiff_t, int, int);
2550 extern void message_with_string (const char *, Lisp_Object
, int);
2551 extern void message_log_maybe_newline (void);
2552 extern void update_echo_area (void);
2553 extern void truncate_echo_area (ptrdiff_t);
2554 extern void redisplay (void);
2555 extern void redisplay_preserve_echo_area (int);
2556 extern void prepare_menu_bars (void);
2558 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
2559 extern void syms_of_xdisp (void);
2560 extern void init_xdisp (void);
2561 extern Lisp_Object
safe_eval (Lisp_Object
);
2562 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
2563 int *, int *, int *, int *, int *);
2565 /* Defined in xsettings.c */
2566 extern void syms_of_xsettings (void);
2568 /* Defined in vm-limit.c. */
2569 extern void memory_warnings (void *, void (*warnfun
) (const char *));
2571 /* Defined in alloc.c */
2572 extern void check_pure_size (void);
2573 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
2574 extern void reset_malloc_hooks (void);
2575 extern void uninterrupt_malloc (void);
2576 extern void malloc_warning (const char *);
2577 extern _Noreturn
void memory_full (size_t);
2578 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
2579 extern int survives_gc_p (Lisp_Object
);
2580 extern void mark_object (Lisp_Object
);
2581 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
2582 extern void refill_memory_reserve (void);
2584 extern const char *pending_malloc_warning
;
2585 extern Lisp_Object zero_vector
;
2586 extern Lisp_Object
*stack_base
;
2587 extern EMACS_INT consing_since_gc
;
2588 extern EMACS_INT gc_relative_threshold
;
2589 extern EMACS_INT memory_full_cons_threshold
;
2590 extern Lisp_Object
list1 (Lisp_Object
);
2591 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
2592 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2593 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2594 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
2596 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
2597 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
2598 extern _Noreturn
void string_overflow (void);
2599 extern Lisp_Object
make_string (const char *, ptrdiff_t);
2600 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
2601 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2602 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
2604 /* Make unibyte string from C string when the length isn't known. */
2606 static inline Lisp_Object
2607 build_unibyte_string (const char *str
)
2609 return make_unibyte_string (str
, strlen (str
));
2612 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
2613 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
2614 extern Lisp_Object
make_uninit_string (EMACS_INT
);
2615 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
2616 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
2617 extern Lisp_Object
make_specified_string (const char *,
2618 ptrdiff_t, ptrdiff_t, int);
2619 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, int);
2620 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
2622 /* Make a string allocated in pure space, use STR as string data. */
2624 static inline Lisp_Object
2625 build_pure_c_string (const char *str
)
2627 return make_pure_c_string (str
, strlen (str
));
2630 /* Make a string from the data at STR, treating it as multibyte if the
2633 static inline Lisp_Object
2634 build_string (const char *str
)
2636 return make_string (str
, strlen (str
));
2639 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
2640 extern void make_byte_code (struct Lisp_Vector
*);
2641 extern Lisp_Object Qchar_table_extra_slots
;
2642 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
2643 extern struct Lisp_Vector
*allocate_pseudovector (int memlen
, int lisplen
, int tag
);
2644 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2646 allocate_pseudovector \
2647 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2648 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
2649 extern struct window
*allocate_window (void);
2650 extern struct frame
*allocate_frame (void);
2651 extern struct Lisp_Process
*allocate_process (void);
2652 extern struct terminal
*allocate_terminal (void);
2653 extern int gc_in_progress
;
2654 extern int abort_on_gc
;
2655 extern Lisp_Object
make_float (double);
2656 extern void display_malloc_warning (void);
2657 extern ptrdiff_t inhibit_garbage_collection (void);
2658 extern Lisp_Object
make_save_value (void *, ptrdiff_t);
2659 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2660 extern void free_marker (Lisp_Object
);
2661 extern void free_cons (struct Lisp_Cons
*);
2662 extern void init_alloc_once (void);
2663 extern void init_alloc (void);
2664 extern void syms_of_alloc (void);
2665 extern struct buffer
* allocate_buffer (void);
2666 extern int valid_lisp_object_p (Lisp_Object
);
2667 #ifdef GC_CHECK_CONS_LIST
2668 extern void check_cons_list (void);
2670 #define check_cons_list() ((void) 0)
2674 /* Defined in ralloc.c */
2675 extern void *r_alloc (void **, size_t);
2676 extern void r_alloc_free (void **);
2677 extern void *r_re_alloc (void **, size_t);
2678 extern void r_alloc_reset_variable (void **, void **);
2679 extern void r_alloc_inhibit_buffer_relocation (int);
2682 /* Defined in chartab.c */
2683 extern Lisp_Object
copy_char_table (Lisp_Object
);
2684 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
2685 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
2687 extern Lisp_Object
char_table_set (Lisp_Object
, int, Lisp_Object
);
2688 extern Lisp_Object
char_table_set_range (Lisp_Object
, int, int,
2690 extern int char_table_translate (Lisp_Object
, int);
2691 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
2693 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2694 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
2695 Lisp_Object
, Lisp_Object
,
2696 Lisp_Object
, struct charset
*,
2697 unsigned, unsigned);
2698 extern Lisp_Object
uniprop_table (Lisp_Object
);
2699 extern void syms_of_chartab (void);
2701 /* Defined in print.c */
2702 extern Lisp_Object Vprin1_to_string_buffer
;
2703 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
2704 extern Lisp_Object Qstandard_output
;
2705 extern Lisp_Object Qexternal_debugging_output
;
2706 extern void temp_output_buffer_setup (const char *);
2707 extern int print_level
;
2708 extern Lisp_Object Qprint_escape_newlines
;
2709 extern void write_string (const char *, int);
2710 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
2712 extern Lisp_Object internal_with_output_to_temp_buffer
2713 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2714 #define FLOAT_TO_STRING_BUFSIZE 350
2715 extern int float_to_string (char *, double);
2716 extern void syms_of_print (void);
2718 /* Defined in doprnt.c */
2719 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
2721 extern ptrdiff_t esprintf (char *, char const *, ...)
2722 ATTRIBUTE_FORMAT_PRINTF (2, 3);
2723 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2725 ATTRIBUTE_FORMAT_PRINTF (5, 6);
2726 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
2727 char const *, va_list)
2728 ATTRIBUTE_FORMAT_PRINTF (5, 0);
2730 /* Defined in lread.c. */
2731 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
2732 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
2733 extern Lisp_Object
check_obarray (Lisp_Object
);
2734 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
2735 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
2736 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
2737 #define LOADHIST_ATTACH(x) \
2739 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); \
2741 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2742 Lisp_Object
*, Lisp_Object
);
2743 Lisp_Object
string_to_number (char const *, int, int);
2744 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
2746 extern void dir_warning (const char *, Lisp_Object
);
2747 extern void close_load_descs (void);
2748 extern void init_obarray (void);
2749 extern void init_lread (void);
2750 extern void syms_of_lread (void);
2752 static inline Lisp_Object
2753 intern (const char *str
)
2755 return intern_1 (str
, strlen (str
));
2758 static inline Lisp_Object
2759 intern_c_string (const char *str
)
2761 return intern_c_string_1 (str
, strlen (str
));
2764 /* Defined in eval.c. */
2765 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
2766 extern Lisp_Object Qinhibit_quit
, Qclosure
;
2767 extern Lisp_Object Qand_rest
;
2768 extern Lisp_Object Vautoload_queue
;
2769 extern Lisp_Object Vsignaling_function
;
2770 extern Lisp_Object inhibit_lisp_code
;
2771 extern int handling_signal
;
2773 extern struct catchtag
*catchlist
;
2774 extern struct handler
*handlerlist
;
2776 /* To run a normal hook, use the appropriate function from the list below.
2777 The calling convention:
2779 if (!NILP (Vrun_hooks))
2780 call1 (Vrun_hooks, Qmy_funny_hook);
2782 should no longer be used. */
2783 extern Lisp_Object Vrun_hooks
;
2784 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2785 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2786 Lisp_Object (*funcall
)
2787 (ptrdiff_t nargs
, Lisp_Object
*args
));
2788 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
2789 extern _Noreturn
void xsignal0 (Lisp_Object
);
2790 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
2791 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2792 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2794 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
2795 extern Lisp_Object
eval_sub (Lisp_Object form
);
2796 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
2797 extern Lisp_Object
call0 (Lisp_Object
);
2798 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
2799 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2800 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2801 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2802 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2803 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2804 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
2805 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2806 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2807 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2808 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2809 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2810 extern Lisp_Object
internal_condition_case_n (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
2811 extern void specbind (Lisp_Object
, Lisp_Object
);
2812 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
2813 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
2814 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
2815 extern _Noreturn
void verror (const char *, va_list)
2816 ATTRIBUTE_FORMAT_PRINTF (1, 0);
2817 extern Lisp_Object
un_autoload (Lisp_Object
);
2818 extern void init_eval_once (void);
2819 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
*);
2820 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
2821 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2822 extern void init_eval (void);
2824 extern void mark_backtrace (void);
2826 extern void syms_of_eval (void);
2828 /* Defined in editfns.c. */
2829 extern Lisp_Object Qfield
;
2830 extern void insert1 (Lisp_Object
);
2831 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
2832 extern Lisp_Object
save_excursion_save (void);
2833 extern Lisp_Object
save_restriction_save (void);
2834 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
2835 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
2836 extern _Noreturn
void time_overflow (void);
2837 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, int);
2838 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
2840 extern void init_editfns (void);
2841 const char *get_system_name (void);
2842 extern void syms_of_editfns (void);
2843 extern void set_time_zone_rule (const char *);
2845 /* Defined in buffer.c. */
2846 extern int mouse_face_overlay_overlaps (Lisp_Object
);
2847 extern _Noreturn
void nsberror (Lisp_Object
);
2848 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
2849 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
2850 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
2851 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, int,
2852 Lisp_Object
, Lisp_Object
, Lisp_Object
);
2853 extern int overlay_touches_p (ptrdiff_t);
2854 extern Lisp_Object Vbuffer_alist
;
2855 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
2856 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
2857 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
2858 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
2859 extern void init_buffer_once (void);
2860 extern void init_buffer (void);
2861 extern void syms_of_buffer (void);
2862 extern void keys_of_buffer (void);
2864 /* Defined in marker.c. */
2866 extern ptrdiff_t marker_position (Lisp_Object
);
2867 extern ptrdiff_t marker_byte_position (Lisp_Object
);
2868 extern void clear_charpos_cache (struct buffer
*);
2869 extern ptrdiff_t charpos_to_bytepos (ptrdiff_t);
2870 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
2871 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
2872 extern void unchain_marker (struct Lisp_Marker
*marker
);
2873 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2874 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
2875 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
2876 ptrdiff_t, ptrdiff_t);
2877 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
2878 extern void syms_of_marker (void);
2880 /* Defined in fileio.c */
2882 extern Lisp_Object Qfile_error
;
2883 extern Lisp_Object Qfile_exists_p
;
2884 extern Lisp_Object Qfile_directory_p
;
2885 extern Lisp_Object Qinsert_file_contents
;
2886 extern Lisp_Object Qfile_name_history
;
2887 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
2888 EXFUN (Fread_file_name
, 6); /* not a normal DEFUN */
2889 extern Lisp_Object
close_file_unwind (Lisp_Object
);
2890 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
2891 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
2892 extern int internal_delete_file (Lisp_Object
);
2893 extern void syms_of_fileio (void);
2894 extern Lisp_Object
make_temp_name (Lisp_Object
, int);
2895 extern Lisp_Object Qdelete_file
;
2897 /* Defined in search.c */
2898 extern void shrink_regexp_cache (void);
2899 extern void restore_search_regs (void);
2900 extern void record_unwind_save_match_data (void);
2901 struct re_registers
;
2902 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
2903 struct re_registers
*,
2904 Lisp_Object
, int, int);
2905 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
2906 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
2908 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
2909 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2910 ptrdiff_t, ptrdiff_t, Lisp_Object
);
2911 extern ptrdiff_t scan_buffer (int, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2913 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
2915 extern ptrdiff_t find_next_newline (ptrdiff_t, int);
2916 extern ptrdiff_t find_next_newline_no_quit (ptrdiff_t, ptrdiff_t);
2917 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t);
2918 extern void syms_of_search (void);
2919 extern void clear_regexp_cache (void);
2921 /* Defined in minibuf.c. */
2923 extern Lisp_Object Qcompletion_ignore_case
;
2924 extern Lisp_Object Vminibuffer_list
;
2925 extern Lisp_Object last_minibuf_string
;
2926 extern Lisp_Object
get_minibuffer (EMACS_INT
);
2927 extern void init_minibuf_once (void);
2928 extern void syms_of_minibuf (void);
2930 /* Defined in callint.c. */
2932 extern Lisp_Object Qminus
, Qplus
;
2933 extern Lisp_Object Qwhen
;
2934 extern Lisp_Object Qcall_interactively
, Qmouse_leave_buffer_hook
;
2935 extern void syms_of_callint (void);
2937 /* Defined in casefiddle.c. */
2939 extern Lisp_Object Qidentity
;
2940 extern void syms_of_casefiddle (void);
2941 extern void keys_of_casefiddle (void);
2943 /* Defined in casetab.c. */
2945 extern void init_casetab_once (void);
2946 extern void syms_of_casetab (void);
2948 /* Defined in keyboard.c. */
2950 extern Lisp_Object echo_message_buffer
;
2951 extern struct kboard
*echo_kboard
;
2952 extern void cancel_echoing (void);
2953 extern Lisp_Object Qdisabled
, QCfilter
;
2954 extern Lisp_Object Qup
, Qdown
, Qbottom
;
2955 extern Lisp_Object Qtop
;
2956 extern Lisp_Object last_undo_boundary
;
2957 extern int input_pending
;
2958 extern Lisp_Object
menu_bar_items (Lisp_Object
);
2959 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
2960 extern void discard_mouse_events (void);
2961 extern Lisp_Object pending_funcalls
;
2962 extern int detect_input_pending (void);
2963 extern int detect_input_pending_ignore_squeezables (void);
2964 extern int detect_input_pending_run_timers (int);
2965 extern void safe_run_hooks (Lisp_Object
);
2966 extern void cmd_error_internal (Lisp_Object
, const char *);
2967 extern Lisp_Object
command_loop_1 (void);
2968 extern Lisp_Object
recursive_edit_1 (void);
2969 extern void record_auto_save (void);
2971 extern void force_auto_save_soon (void);
2973 extern void init_keyboard (void);
2974 extern void syms_of_keyboard (void);
2975 extern void keys_of_keyboard (void);
2977 /* Defined in indent.c. */
2978 extern ptrdiff_t current_column (void);
2979 extern void invalidate_current_column (void);
2980 extern int indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
2981 extern void syms_of_indent (void);
2983 /* Defined in frame.c. */
2984 extern Lisp_Object Qonly
;
2985 extern Lisp_Object Qvisible
;
2986 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
2987 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
2988 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
2990 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
2992 extern Lisp_Object
frame_buffer_predicate (Lisp_Object
);
2993 extern void frames_discard_buffer (Lisp_Object
);
2994 extern void syms_of_frame (void);
2996 /* Defined in emacs.c. */
2997 extern char **initial_argv
;
2998 extern int initial_argc
;
2999 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3000 extern int display_arg
;
3002 extern Lisp_Object
decode_env_path (const char *, const char *);
3003 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3004 extern Lisp_Object Qfile_name_handler_alist
;
3005 #ifdef FLOAT_CATCH_SIGILL
3006 extern void fatal_error_signal (int);
3008 extern Lisp_Object Qkill_emacs
;
3010 void fixup_locale (void);
3011 void synchronize_system_messages_locale (void);
3012 void synchronize_system_time_locale (void);
3014 #define setlocale(category, locale)
3015 #define fixup_locale()
3016 #define synchronize_system_messages_locale()
3017 #define synchronize_system_time_locale()
3019 void shut_down_emacs (int, int, Lisp_Object
);
3020 /* Nonzero means don't do interactive redisplay and don't change tty modes. */
3021 extern int noninteractive
;
3023 /* Nonzero means remove site-lisp directories from load-path. */
3024 extern int no_site_lisp
;
3026 /* Pipe used to send exit notification to the daemon parent at
3028 extern int daemon_pipe
[2];
3029 #define IS_DAEMON (daemon_pipe[1] != 0)
3031 /* Nonzero means don't do use window-system-specific display code. */
3032 extern int inhibit_window_system
;
3033 /* Nonzero means that a filter or a sentinel is running. */
3034 extern int running_asynch_code
;
3036 /* Defined in process.c. */
3037 extern Lisp_Object QCtype
, Qlocal
;
3038 extern Lisp_Object Qprocessp
;
3039 extern void kill_buffer_processes (Lisp_Object
);
3040 extern int wait_reading_process_output (intmax_t, int, int, int,
3042 struct Lisp_Process
*,
3044 /* Max value for the first argument of wait_reading_process_output. */
3045 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3046 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3047 The bug merely causes a bogus warning, but the warning is annoying. */
3048 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3050 # define WAIT_READING_MAX INTMAX_MAX
3052 extern void add_keyboard_wait_descriptor (int);
3053 extern void delete_keyboard_wait_descriptor (int);
3055 extern void add_gpm_wait_descriptor (int);
3056 extern void delete_gpm_wait_descriptor (int);
3058 extern void close_process_descs (void);
3059 extern void init_process_emacs (void);
3060 extern void syms_of_process (void);
3061 extern void setup_process_coding_systems (Lisp_Object
);
3066 extern int child_setup (int, int, int, char **, int, Lisp_Object
);
3067 extern void init_callproc_1 (void);
3068 extern void init_callproc (void);
3069 extern void set_initial_environment (void);
3070 extern void syms_of_callproc (void);
3072 /* Defined in doc.c */
3073 extern Lisp_Object Qfunction_documentation
;
3074 extern Lisp_Object
read_doc_string (Lisp_Object
);
3075 extern Lisp_Object
get_doc_string (Lisp_Object
, int, int);
3076 extern void syms_of_doc (void);
3077 extern int read_bytecode_char (int);
3079 /* Defined in bytecode.c */
3080 extern Lisp_Object Qbytecode
;
3081 extern void syms_of_bytecode (void);
3082 extern struct byte_stack
*byte_stack_list
;
3084 extern void mark_byte_stack (void);
3086 extern void unmark_byte_stack (void);
3087 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3088 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3090 /* Defined in macros.c */
3091 extern Lisp_Object Qexecute_kbd_macro
;
3092 extern void init_macros (void);
3093 extern void syms_of_macros (void);
3095 /* Defined in undo.c */
3096 extern Lisp_Object Qapply
;
3097 extern Lisp_Object Qinhibit_read_only
;
3098 extern void truncate_undo_list (struct buffer
*);
3099 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
3100 extern void record_insert (ptrdiff_t, ptrdiff_t);
3101 extern void record_delete (ptrdiff_t, Lisp_Object
);
3102 extern void record_first_change (void);
3103 extern void record_change (ptrdiff_t, ptrdiff_t);
3104 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3105 Lisp_Object
, Lisp_Object
,
3107 extern void syms_of_undo (void);
3108 /* Defined in textprop.c */
3109 extern Lisp_Object Qfont
, Qmouse_face
;
3110 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3111 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
3112 extern Lisp_Object Qminibuffer_prompt
;
3114 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3116 /* Defined in menu.c */
3117 extern void syms_of_menu (void);
3119 /* Defined in xmenu.c */
3120 extern void syms_of_xmenu (void);
3122 /* Defined in termchar.h */
3123 struct tty_display_info
;
3125 /* Defined in termhooks.h */
3128 /* Defined in sysdep.c */
3129 #ifndef HAVE_GET_CURRENT_DIR_NAME
3130 extern char *get_current_dir_name (void);
3132 extern void stuff_char (char c
);
3133 extern void init_sigio (int);
3134 extern void sys_subshell (void);
3135 extern void sys_suspend (void);
3136 extern void discard_tty_input (void);
3137 extern void init_sys_modes (struct tty_display_info
*);
3138 extern void reset_sys_modes (struct tty_display_info
*);
3139 extern void init_all_sys_modes (void);
3140 extern void reset_all_sys_modes (void);
3141 extern void wait_for_termination (pid_t
);
3142 extern void interruptible_wait_for_termination (pid_t
);
3143 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
3144 extern void child_setup_tty (int);
3145 extern void setup_pty (int);
3146 extern int set_window_size (int, int, int);
3147 extern EMACS_INT
get_random (void);
3148 extern void seed_random (long);
3149 extern int emacs_open (const char *, int, int);
3150 extern int emacs_close (int);
3151 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
3152 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
3153 enum { READLINK_BUFSIZE
= 1024 };
3154 extern char *emacs_readlink (const char *, char [READLINK_BUFSIZE
]);
3156 extern void unlock_all_files (void);
3157 extern void lock_file (Lisp_Object
);
3158 extern void unlock_file (Lisp_Object
);
3159 extern void unlock_buffer (struct buffer
*);
3160 extern void syms_of_filelock (void);
3162 /* Defined in sound.c */
3163 extern void syms_of_sound (void);
3165 /* Defined in category.c */
3166 extern void init_category_once (void);
3167 extern Lisp_Object
char_category_set (int);
3168 extern void syms_of_category (void);
3170 /* Defined in ccl.c */
3171 extern void syms_of_ccl (void);
3173 /* Defined in dired.c */
3174 extern void syms_of_dired (void);
3175 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3176 Lisp_Object
, Lisp_Object
,
3179 /* Defined in term.c */
3180 extern int *char_ins_del_vector
;
3181 extern void mark_ttys (void);
3182 extern void syms_of_term (void);
3183 extern _Noreturn
void fatal (const char *msgid
, ...)
3184 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3186 /* Defined in terminal.c */
3187 extern void syms_of_terminal (void);
3189 /* Defined in font.c */
3190 extern void syms_of_font (void);
3191 extern void init_font (void);
3193 #ifdef HAVE_WINDOW_SYSTEM
3194 /* Defined in fontset.c */
3195 extern void syms_of_fontset (void);
3197 /* Defined in xfns.c, w32fns.c, or macfns.c */
3198 extern Lisp_Object Qfont_param
;
3201 /* Defined in xfaces.c */
3202 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
3203 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
3204 extern Lisp_Object Qmode_line_inactive
;
3205 extern Lisp_Object Qface
;
3206 extern Lisp_Object Qnormal
;
3207 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3208 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3209 extern Lisp_Object Vface_alternative_font_family_alist
;
3210 extern Lisp_Object Vface_alternative_font_registry_alist
;
3211 extern void syms_of_xfaces (void);
3213 #ifdef HAVE_X_WINDOWS
3214 /* Defined in xfns.c */
3215 extern void syms_of_xfns (void);
3217 /* Defined in xsmfns.c */
3218 extern void syms_of_xsmfns (void);
3220 /* Defined in xselect.c */
3221 extern void syms_of_xselect (void);
3223 /* Defined in xterm.c */
3224 extern void syms_of_xterm (void);
3225 #endif /* HAVE_X_WINDOWS */
3227 #ifdef HAVE_WINDOW_SYSTEM
3228 /* Defined in xterm.c, nsterm.m, w32term.c */
3229 extern char *x_get_keysym_name (int);
3230 #endif /* HAVE_WINDOW_SYSTEM */
3233 /* Defined in xml.c */
3234 extern void syms_of_xml (void);
3235 extern void xml_cleanup_parser (void);
3239 /* Defined in (x|w32)fns.c, nsfns.m... */
3240 extern int have_menus_p (void);
3244 /* Defined in dbusbind.c */
3245 void syms_of_dbusbind (void);
3249 /* Defined in msdos.c, w32.c */
3250 extern char *emacs_root_dir (void);
3253 /* Nonzero means Emacs has already been initialized.
3254 Used during startup to detect startup of dumped Emacs. */
3255 extern int initialized
;
3257 extern int immediate_quit
; /* Nonzero means ^G can quit instantly */
3259 extern void *xmalloc (size_t);
3260 extern void *xzalloc (size_t);
3261 extern void *xrealloc (void *, size_t);
3262 extern void xfree (void *);
3263 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
3264 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
3265 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3267 extern char *xstrdup (const char *);
3269 extern char *egetenv (const char *);
3271 /* Set up the name of the machine we're running on. */
3272 extern void init_system_name (void);
3274 /* Some systems (e.g., NT) use a different path separator than Unix,
3275 in addition to a device separator. Set the path separator
3276 to '/', and don't test for a device separator in IS_ANY_SEP. */
3278 #define DIRECTORY_SEP '/'
3279 #ifndef IS_DIRECTORY_SEP
3280 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3282 #ifndef IS_DEVICE_SEP
3284 #define IS_DEVICE_SEP(_c_) 0
3286 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3290 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3293 #define SWITCH_ENUM_CAST(x) (x)
3295 /* Use this to suppress gcc's warnings. */
3298 /* Use CODE only if lint checking is in effect. */
3299 # define IF_LINT(Code) Code
3301 /* Assume that the expression COND is true. This differs in intent
3302 from 'assert', as it is a message from the programmer to the compiler. */
3303 # define lint_assume(cond) ((cond) ? (void) 0 : abort ())
3306 # define IF_LINT(Code) /* empty */
3307 # define lint_assume(cond) ((void) (0 && (cond)))
3310 /* The ubiquitous min and max macros. */
3316 #define min(a, b) ((a) < (b) ? (a) : (b))
3317 #define max(a, b) ((a) > (b) ? (a) : (b))
3319 /* We used to use `abs', but that clashes with system headers on some
3320 platforms, and using a name reserved by Standard C is a bad idea
3323 #define eabs(x) ((x) < 0 ? -(x) : (x))
3326 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3329 #define make_fixnum_or_float(val) \
3330 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3333 /* Checks the `cycle check' variable CHECK to see if it indicates that
3334 EL is part of a cycle; CHECK must be either Qnil or a value returned
3335 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3336 elements after which a cycle might be suspected; after that many
3337 elements, this macro begins consing in order to keep more precise
3340 Returns nil if a cycle was detected, otherwise a new value for CHECK
3343 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3344 the caller should make sure that's ok. */
3346 #define CYCLE_CHECK(check, el, suspicious) \
3349 : (INTEGERP (check) \
3350 ? (XFASTINT (check) < (suspicious) \
3351 ? make_number (XFASTINT (check) + 1) \
3352 : Fcons (el, Qnil)) \
3353 : (!NILP (Fmemq ((el), (check))) \
3355 : Fcons ((el), (check)))))
3358 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3359 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3361 #define MAX_ALLOCA 16*1024
3363 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
3365 #define USE_SAFE_ALLOCA \
3366 ptrdiff_t sa_count = SPECPDL_INDEX (); int sa_must_free = 0
3368 /* SAFE_ALLOCA allocates a simple buffer. */
3370 #define SAFE_ALLOCA(buf, type, size) \
3372 if ((size) < MAX_ALLOCA) \
3373 buf = (type) alloca (size); \
3376 buf = xmalloc (size); \
3378 record_unwind_protect (safe_alloca_unwind, \
3379 make_save_value (buf, 0)); \
3383 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3384 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3385 positive. The code is tuned for MULTIPLIER being a constant. */
3387 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3389 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3390 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3393 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3395 record_unwind_protect (safe_alloca_unwind, \
3396 make_save_value (buf, 0)); \
3400 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3402 #define SAFE_FREE() \
3404 if (sa_must_free) { \
3406 unbind_to (sa_count, Qnil); \
3411 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3413 #define SAFE_ALLOCA_LISP(buf, nelt) \
3415 if ((nelt) < MAX_ALLOCA / sizeof (Lisp_Object)) \
3416 buf = (Lisp_Object *) alloca ((nelt) * sizeof (Lisp_Object)); \
3417 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)) \
3420 buf = xmalloc ((nelt) * sizeof (Lisp_Object)); \
3421 arg_ = make_save_value (buf, nelt); \
3422 XSAVE_VALUE (arg_)->dogc = 1; \
3424 record_unwind_protect (safe_alloca_unwind, arg_); \
3427 memory_full (SIZE_MAX); \
3431 #include "globals.h"
3433 /* Check whether it's time for GC, and run it if so. */
3438 if ((consing_since_gc
> gc_cons_threshold
3439 && consing_since_gc
> gc_relative_threshold
)
3440 || (!NILP (Vmemory_full
)
3441 && consing_since_gc
> memory_full_cons_threshold
))
3442 Fgarbage_collect ();
3445 #endif /* EMACS_LISP_H */